New-NBToken
Since
v4.4.10.0
SYNOPSIS
Creates a new API token in Netbox.
SYNTAX
New-NBToken [-User] <UInt64> [[-Description] <String>] [[-Expires] <DateTime>] [[-Key] <SecureString>]
[[-Write_Enabled] <Boolean>] [[-Allowed_Ips] <String[]>] [[-Enabled] <Boolean>] [[-Tags] <Object[]>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new API token in Netbox Users module.
EXAMPLES
EXAMPLE 1
New-NBToken -User 1 -Description "API automation"
PARAMETERS
-User
User ID for the token.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Description
Description of the token.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Expires
Expiration date (datetime).
```yaml Type: DateTime Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Key
Custom token key (auto-generated if not provided).
```yaml Type: SecureString Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Write_Enabled
Whether write operations are enabled.
```yaml Type: Boolean Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Allowed_Ips
Array of allowed IP addresses/networks.
```yaml Type: String[] Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Enabled
Whether the token is enabled (Netbox 4.5+ only). Defaults to true.
```yaml Type: Boolean Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: Object[] Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False 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.PSObject
NOTES
AddedInVersion: v4.4.10.0