Add-IpamAddressSpace
Add-IpamAddressSpace
Adds an address space to IPAM.
Syntax
Parameter Set: ProviderAddressSpace
Add-IpamAddressSpace -Name <String> -ProviderAddressSpace [-AsJob] [-CimSession <CimSession[]> ] [-CustomConfiguration <String> ] [-Description <String> ] [-Owner <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: CustomerAddressSpace
Add-IpamAddressSpace -AssociatedProviderAddressSpace <String> -CustomerAddressSpace -IsolationMethod <String> -Name <String> [-AsJob] [-CimSession <CimSession[]> ] [-CustomConfiguration <String> ] [-Description <String> ] [-Force] [-Owner <String> ] [-PassThru] [-Tenant <String> ] [-ThrottleLimit <Int32> ] [-VmNetwork <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-IpamAddressSpace cmdlet adds an address space to IP Address Management (IPAM). A set of connected networks forms an address space. In IPAM, all IP blocks, IP subnets, IP ranges, and IP addresses in a set of connected networks are grouped in an address space container. To support network virtualization, IPAM provides two types of address spaces: provider and customer. By default, all IPAM entities reside in the built-in address space called Default. Non-virtualized network entities, such as a subnet or an IP address range, reside in the Default address space.
Parameters
-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 |
none |
Required? |
true |
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 |
-CustomConfiguration<String>
Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address space.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CustomerAddressSpace
Indicates that the type of address space that you add is a customer address space.
Aliases |
CA |
Required? |
true |
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 |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name for the address space.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
-ProviderAddressSpace
Indicates that the type of address space that you add is a provider address space.
Aliases |
PA |
Required? |
true |
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 compatible 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 machine 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
Object that represents an address space in IPAM.
Examples
Example 1: Add a provider address space
This command adds a provider address space named ProviderAddSpace01 to IPAM.
PS C:\> Add-IpamAddressSpace -Name "ProviderAddSpace01" -ProviderAddressSpace -Description "Provider address space for Contoso"
Example 2: Add a customer address space
This command adds a customer address space named CustomerAddSpace01 to IPAM. The command specifies that the provider address space named ProviderAddSpace01 is associated with the customer address space. The command specifies the Network Virtualization using Generic Routing Encapsulation (NVGRE) network virtualization mechanism for the address space.
PS C:\> Add-IpamAddressSpace -Name "CustomerAddSpace01" -CustomerAddressSpace -AssociatedProviderAddressSpace "ProviderAddSpace01" -IsolationMethod NVGRE -PassThru