Set-NBIPAMPrefix
Since
v1.0.4
SYNOPSIS
Updates an existing IPAM Prefix in Netbox IPAM module.
SYNTAX
Set-NBIPAMPrefix [-Id] <UInt64> [[-Prefix] <String>] [[-Status] <String>] [[-Tenant] <UInt64>]
[[-Scope_Type] <String>] [[-Scope_Id] <UInt64>] [[-VRF] <UInt64>] [[-VLAN] <UInt64>] [[-Role] <UInt64>]
[[-Custom_Fields] <Hashtable>] [[-Description] <String>] [[-Is_Pool] <Boolean>] [[-Owner] <UInt64>] [-Force]
[[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing IPAM Prefix in Netbox IPAM module. Supports pipeline input for Id parameter where applicable.
EXAMPLES
EXAMPLE 1
Set-NBIPAMPrefix
Updates an existing IPAM Prefix object.
PARAMETERS
-Id
{{ Fill Id Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Prefix
{{ Fill Prefix Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Status
{{ Fill Status Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tenant
{{ Fill Tenant Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Scope_Type
{{ Fill Scope_Type Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Scope_Id
{{ Fill Scope_Id Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-VRF
{{ Fill VRF Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-VLAN
{{ Fill VLAN Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Role
{{ Fill Role Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
{{ Fill Custom_Fields Description }}
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
{{ Fill Description Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Is_Pool
{{ Fill Is_Pool Description }}
```yaml Type: Boolean Parameter Sets: (All) Aliases:
Required: False Position: 12 Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Owner
{{ Fill Owner Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 13 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Force
{{ Fill Force Description }}
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named 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: 14 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response instead of the results array.
```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: v1.0.4