Skip to content

Set-NBIPAMAddressRange

Since

v4.4.7

SYNOPSIS

Updates an existing IPAM AddressRange in Netbox IPAM module.

SYNTAX

Set-NBIPAMAddressRange [-Id] <UInt64> [[-Start_Address] <String>] [[-End_Address] <String>] [[-Status] <String>] [[-Tenant] <UInt64>] [[-VRF] <UInt64>] [[-Role] <UInt64>] [[-Custom_Fields] <Hashtable>] [[-Description] <String>] [[-Comments] <String>] [[-Tags] <Object[]>] [[-Mark_Utilized] <Boolean>] [[-Mark_Populated] <Boolean>] [-Force] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing IPAM AddressRange in Netbox IPAM module. Supports pipeline input for Id parameter where applicable.

EXAMPLES

EXAMPLE 1

Set-NBIPAMAddressRange

Updates an existing IPAM Address Range 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 ```

-Start_Address

{{ Fill Start_Address Description }}

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

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

-End_Address

{{ Fill End_Address Description }}

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

Required: False Position: 3 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: 4 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: 5 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: 6 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: 7 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: 8 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: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Comments

{{ Fill Comments Description }}

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

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

-Tags

{{ Fill Tags Description }}

```yaml Type: Object[] Parameter Sets: (All) Aliases:

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

-Mark_Utilized

{{ Fill Mark_Utilized Description }}

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

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

-Mark_Populated

{{ Fill Mark_Populated Description }}

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

Required: False Position: 13 Default value: False 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 ```

-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: v4.4.7

Common parameters

common request params

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