Skip to content

Set-NBHostScheme

Since

v1.3.3

SYNOPSIS

Sets the HTTP scheme (http/https) for Netbox API connections.

SYNTAX

Set-NBHostScheme [[-Scheme] <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets the HTTP scheme (http/https) for Netbox API connections.

EXAMPLES

EXAMPLE 1

Set-NBHostScheme -Scheme 'https'

Sets the Netbox API host scheme (http or https).

PARAMETERS

-Scheme

{{ Fill Scheme Description }}

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 1 Default value: Https Accept pipeline input: False Accept wildcard characters: False ```

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi

Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Confirm

Prompts you for confirmation before running the cmdlet.

```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf

Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-ProgressAction

{{ Fill ProgressAction Description }}

```yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga

Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

NOTES

AddedInVersion: v1.3.3

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/rest-api/overview/