Add-IpamRange
Add-IpamRange
Adds an IP address range to the configuration of an IPAM server.
Syntax
Parameter Set: AddRange0
Add-IpamRange [-NetworkId] <String> [[-StartIPAddress] <IPAddress> ] [[-EndIPAddress] <IPAddress> ] [-AddressSpace <String> ] [-AsJob] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ConnectionSpecificDnsSuffix <String> ] [-CreateSubnetIfNotFound] [-CustomConfiguration <String> ] [-Description <String> ] [-DnsServer <IPAddress[]> ] [-DnsSuffix <String[]> ] [-Gateway <String[]> ] [-ManagedByService <String> ] [-NetworkType <VirtualizationType> ] [-Owner <String> ] [-PassThru] [-ReservedAddress <String[]> ] [-ServiceInstance <String> ] [-ThrottleLimit <Int32> ] [-UtilizationCalculation <UtilizationCalculation> ] [-UtilizedAddresses <Double> ] [-VIP <String[]> ] [-WinsServer <IPAddress[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detaillierte Beschreibung
The Add-IpamRange cmdlet adds an IP address range to the configuration of an IP Address Management (IPAM) server. Use this cmdlet to add a Non-Virtualized, Provider, or a Customer IP address range in IPAM. If the network type is Provider or NonVirtualized, the range will be added to default address space if you do not specify an address space. If the network type is Customer, you must specify an address space.
Parameter
-AddressSpace<String>
Specifies an address space to which this IP address range belongs. An address space contains IP subnets, IP ranges, and IP addresses. If you do not specify this parameter, the default address space is assumed. The default address space is the Provider address space.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Default |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-AsJob
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-AssignmentDate<DateTime>
Specifies a date on which to assign addresses in this range.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-AssignmentType<AddressAssignment>
Specifies how IPAM assigns the addresses. Die folgenden Werte für diesen Parameter sind zulässig:
-- Static
-- Dynamic
-- Auto
-- VIP
-- Reserved
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Static |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-CimSession<CimSession[]>
Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.
Aliasse |
Session |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-ConnectionSpecificDnsSuffix<String>
Specifies the connection-specific DNS suffix to associate with this range.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-CreateSubnetIfNotFound
Indicates that the cmdlet creates a parent subnet for this range of addresses. If you specify this parameter, the cmdlet automatically creates a parent subnet for this range, if no parent subnet exists.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-CustomConfiguration<String>
Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address space.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Description<String>
Specifies a description for the range.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-DnsServer<IPAddress[]>
Specifies an array of DNS servers to associate with this range. Specify the names of the DNS servers in the order of preference, highest to lowest.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-DnsSuffix<String[]>
Specifies an array of search suffixes to associate with the given range.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-EndIPAddress<IPAddress>
Specifies an IP address. For this parameter, the address represents the high end of the range to add.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
4 |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Gateway<String[]>
Specifies an array of gateway servers, imported from a DHCP Scope, to associate with a range in IPAM. Specify the names of the gateway servers in the order of preference, highest to lowest. The format for specification is <ipaddress>\<metric>. To specify the Automatic metric, use the format <Ipaddress>\Automatic.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ManagedByService<String>
Specifies the value of the managing service of the IP address ranges being added.
Aliasse |
MB |
Erforderlich? |
false |
Position? |
named |
Standardwert |
IPAM |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-NetworkId<String>
Specifies the network and the prefix for the given range. Specify the network ID in Classless Interdomain Routing (CIDR) notation in the format Network/Prefix.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-NetworkType<VirtualizationType>
Specifies an array of network types for the addresses to be added. Die folgenden Werte für diesen Parameter sind zulässig:
-- Provider
-- Customer
-- NonVirtualized
If the value of the AddressSpace parameter is Default, then this parameter can take the value Provider or NonVirtualized. If the value of the AddressSpace parameter is Provider, then the value of this parameter, if specified, must be Provider. Specifying any other value for this parameter will result in an error. Similarly, if the value of the AddressSpace parameter is Customer, then the value of this parameter, if specified, must be Customer. Specifying any other value for this parameter will result in an error.
If you do not specify this parameter, network type defaults to NonVirtualized.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
NonVirtualized |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Owner<String>
Specifies the name of an owner for an address range.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PassThru
Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-ReservedAddress<String[]>
Specifies the reserved addresses in the range. Specify the reserved addresses as a list, in descending order of precedence.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ServiceInstance<String>
Specifies the service instance that manages the address ranges to add. The value specified for this field should be present in the set of values defined for the ServiceInstance custom field in IPAM. The cmdlet will report an error if this is not found to be a valid value for the ServiceInstance custom field. The user can edit the associated custom field to add or delete values.
Aliasse |
SI |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Localhost |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-StartIPAddress<IPAddress>
Specifies an IP address. For this parameter, the address represents the low end of the range to add.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
3 |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ThrottleLimit<Int32>
Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0
eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-UtilizationCalculation<UtilizationCalculation>
Specifies the utilization information type that will be automatically calculated by IPAM or specified by the user.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Automatic |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-UtilizedAddresses<Double>
Specifies the number of addresses to utilize from the pool of IP addresses.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-VIP<String[]>
Specifies an array of virtual IP addresses that are usually set aside for load balancers. Specify the VIPs as a list, in descending order of precedence.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-WinsServer<IPAddress[]>
Specifies an array of Windows Internet Name Service (WINS) servers to associate with this range. Specify the WINS servers in decreasing order of precedence.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Confirm
Sie werden vor dem Ausführen des Cmdlets zur Bestätigung aufgefordert.
Erforderlich? |
false |
Position? |
named |
Standardwert |
falsch |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-WhatIf
Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Erforderlich? |
false |
Position? |
named |
Standardwert |
falsch |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Eingaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.
Ausgaben
Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.
CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range
IP address range object added to IPAM data store.
Beispiele
Example 1: Add an IP address range
This command adds an IP address range that is managed by the current instance of IPAM server. This range is added to the default address space.
PS C:\> Add-IpamRange -NetworkId 10.13.0.0/16 -PassThru
Example 2: Add an IP address range by using a network ID
This command adds an IP address range with network id 172.16.10.0/24. IPAM does not allow creation of a range for which a corresponding subnet does not exist.
PS C:\> Add-IpamRange -NetworkId 172.16.10.0/24
Example 3: Add an IP address range by using a network ID and create a subnet
This command adds an IP address range with network id 172.16.10.0/24. The command uses the CreateSubnetIfNotFound to automatically create the corresponding subnet, and adds WINS and Gateway servers to the range. Gateway servers are specified in the format <IP Address>/<Metric>.
PS C:\> Add-IpamRange -NetworkId 172.16.10.0/24 -CreateSubnetIfNotFound -WinsServer 10.10.1.1, 10.10.1.2 -Gateway "10.10.5.1/Automatic","10.10.5.2/4"|Format-List Overlapping, NetworkID, StartAddress,EndAddress, ManagedByService, ServiceInstance, WinsServers, Gateway
Example 4: Add a provider IP address range to an existing IPAM configuration
This command adds a provider IP address range that is managed by current instance of IPAM. The range will be added to default address space.
PS C:\> Add-IpamRange -NetworkId 172.16.19.0/24 -StartIPAddress 172.16.19.10 -EndIPAddress 172.16.19.110 -NetworkType Provider -CreateSubnetIfNotFound -PassThru
Example 5: Add a range of provider IP addresses
This command adds a provider IP range 172.16.19.0/24 with start and end IP addresses 172.16.19.10 and 172.16.19.110. The command adds the range to a provider address space named ContosoDataCenter. Since this range is in a different address space, IPAM will not mark it as overlapping.
PS C:\> Add-IpamRange -NetworkId 172.16.19.0/24 -StartIPAddress 172.16.19.10 -EndIPAddress 172.16.19.110 -NetworkType Provider -AddressSpace ContosoDataCenter -PassThru -CreateSubnetIfNotFound