Set-NBCredential

Since

v1.0.4

SYNOPSIS

Sets the credential for Netbox API authentication.

SYNTAX

CredsObject (Default)

Set-NBCredential -Credential <PSCredential> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

UserPass

Set-NBCredential -Token <SecureString> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets the credential for Netbox API authentication.

EXAMPLES

EXAMPLE 1

Set-NBCredential

Sets the Netbox API credential.

PARAMETERS

-Credential

{{ Fill Credential Description }}

```yaml Type: PSCredential Parameter Sets: CredsObject Aliases:

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

-Token

{{ Fill Token Description }}

```yaml Type: SecureString Parameter Sets: UserPass Aliases:

Required: True Position: Named Default value: None 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.Management.Automation.PSCredential

NOTES

AddedInVersion: v1.0.4

Common parameters

common request params

RELATED LINKS

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