Set-IpamAddressSpace
Set-IpamAddressSpace
Modifies address spaces in IPAM.
Syntax
Parameter Set: ByName
Set-IpamAddressSpace [-Name] <String[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssociatedProviderAddressSpace <String> ] [-CimSession <CimSession[]> ] [-Description <String> ] [-IsolationMethod <String> ] [-NewName <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-Tenant <String> ] [-ThrottleLimit <Int32> ] [-VmNetwork <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Set-IpamAddressSpace -InputObject <CimInstance[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssociatedProviderAddressSpace <String> ] [-CimSession <CimSession[]> ] [-Description <String> ] [-IsolationMethod <String> ] [-NewName <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-Tenant <String> ] [-ThrottleLimit <Int32> ] [-VmNetwork <String> ] [-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
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
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
Prompts you for confirmation before running the cmdlet.
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.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
IpamAddressSpace
An object that represents an address space in IPAM.
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
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