Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-IpamAddressSpace

Set-IpamAddressSpace

ipamaddressspace.cdxml

Synopsis

Modifies address spaces in IPAM.

Syntax

Set-IpamAddressSpace [-AddCustomConfiguration] [-AsJob] [-AssociatedProviderAddressSpace] [-CimSession] [-Description] [-IsolationMethod] [-NewName] [-Owner] [-PassThru] [-RemoveCustomConfiguration] [-Tenant] [-ThrottleLimit] [-VmNetwork] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-IpamAddressSpace [-Name] [-AddCustomConfiguration] [-AsJob] [-AssociatedProviderAddressSpace] [-CimSession] [-Description] [-IsolationMethod] [-NewName] [-Owner] [-PassThru] [-RemoveCustomConfiguration] [-Tenant] [-ThrottleLimit] [-VmNetwork] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-IpamAddressSpace cmdlet modifies address spaces in IP Address Management (IPAM). Specify the address spaces to modify, or use the InputObject parameter to specify an IpamAddressSpace object to modify. You must specify at least one optional parameter in addition to the Name parameter or InputObject parameter.

Parameters

-AddCustomConfiguration <String>

Specifies semi-colon separated name/value pairs. This parameter specifies custom metadata that are associated with the address space.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AssociatedProviderAddressSpace <String>

Specifies the provider address space that is associated with the customer address space. Customer address spaces in IPAM belong to a single provider address space.

Aliases

PA

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Description <String>

Specifies a description of the address space.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-IsolationMethod <String>

Specifies the network virtualization mechanism for the address space. The acceptable values for this parameter are:  -- NVGRE -- IPRewrite

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String[]>

Specifies an array of names of the address spaces. The cmdlet modifies the address spaces.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NewName <String>

Specifies a new name for the address space.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Owner <String>

Specifies the owner of the address space.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RemoveCustomConfiguration <String>

Specifies a semi-colon separated string of custom field names. The cmdlet removes the custom field names from the address spaces.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Tenant <String>

Specifies the tenant ID, as a string, that is associated with the customer address space. You must specify a tenant ID that is associated with the virtual machine network that you specify for the VmNetwork parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-VmNetwork <String>

Specifies the name of the virtual machine network for the customer address space. You must specify a virtual network that is associated with the tenant that you specify for the Tenant parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamAddressSpace

Notes

None

Examples

Example 1: Rename an address space

This command renames the address space named OneDataCenter to MainDataCenter.

PS C:\> Set-IpamAddressSpace -Name "OneDataCenter" -NewName "MainDataCenter" -PassThru
Name                           : MainDataCenter

Type                           : ProviderAddressSpace

Owner                          :

Description                    :

AssociatedProviderAddressSpace :

Tenant                         :

VMNetwork                      :

IsolationMethod                :

Ipv4PercentageUtilized         : 66.8888888888889

Ipv6PercentageUtilized         : 0

CustomConfiguration            :

Example 2: Change the provider address space for a customer address space

This command changes the provider address space that is associated with a customer address space. The command uses the Get-IpamAddressSpace cmdlet to get an IpamAddressSpace object that contains the customer address space named WoodgroveAddSpace. The command passes the object to the Set-IpamAddressSpace cmdlet by using the pipeline operator. The command sets the provider address space named MainDataCenter for the customer address space stored in the IpamAddressSpace object.

PS C:\>Get-IpamAddressSpace -Name "WoodgroveAddSpace" | Set-IpamAddressSpace -AssociatedProviderAddressSpace "MainDataCenter" -PassThru


Name                           : WoodgroveAddSpace

Type                           : CustomerAddressSpace

Owner                          :

Description                    : Equities and Mutual funds business

AssociatedProviderAddressSpace : MainDatacenter

Tenant                         : 5001

VMNetwork                      : WoodgroveBank_Network

IsolationMethod                : NVGRE

Ipv4PercentageUtilized         : 38.3838383838384

Ipv6PercentageUtilized         : 0

CustomConfiguration            :

Online Version
Get-IpamAddressSpace
Add-IpamAddressSpace
Remove-IpamAddressSpace