The Add-IpamAddress cmdlet adds an IP address to IP Address Management (IPAM).
You can use the cmdlet to associate the Dynamic Host Configuration Protocol (DHCP) reservation properties with the IP address.
The cmdlet does not create a reservation on the DHCP server.
You can use Windows PowerShell for DHCP Server to create a reservation on the DHCP server.
Examples
Example 1: Add a physical IP address to the IPAM server
This command adds the physical IP address 10.12.3.5 to the default address space that the current instance of the IPAM server manages.
The command uses the following default values for the address:
ManagedByService parameter uses the default value IPAM
ServiceInstance parameter uses the default value Localhost
DeviceType parameter uses the default value Host
AssignmentType parameter uses the default value Static
Example 2: Assign a dynamic IP address to a virtual machine
PS C:\> Add-IpamAddress -IpAddress 10.12.4.9 -ManagedByService "TSQA DHCP" -ServiceInstance "dhcp1.contoso.com" -AssignmentType Dynamic -DeviceType VM -ExpiryDate $TwoWeeksFromNow -PassThru
IpAddress : 10.12.4.9
Type : NonVirtualized
Duplicate : False
ExpiryStatus : Not Expired
MacAddress :
ManagedByService : MS DHCP
ServiceInstance : dhcp1.contoso.com
DeviceName :
DeviceType : VM
IpAddressState : In-Use
AssignmentType : Dynamic
This command assigns the IP address 10.12.4.8 to a virtual machine.
The command specifies that the DHCP server named dhcp1.contoso.com manages the address.
The command specifies that the address expires in two weeks, at which time you can reclaim it.
Example 3: Add a provider IP address to the IPAM server
This command adds a provider IP address that is managed by vmmblue_1 and belongs to the provider address space named Datacenter01.
vmmblue_2 statically manages the address assignment.
Because this address is in a different address space, IPAM does not mark it as a duplicate.
Example 5: Add a customer IP address that a Virtual Machine Manager instance manages
This command adds a customer IP address that the vmmblue_1 instance vmm01.contoso.com manages.
The address is added to the customer address space for the tenant named Datacenter01.
Parameters
-AddressSpace
Specifies the address space that is associated with the IP address.
The default value is Default.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AsJob
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AssetTag
Specifies the asset tag associated with the IP address.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AssignmentDate
Specifies the date on which you assigned the IP address to a device.
To obtain a DateTime object, use the Get-Date cmdlet.
For more information, type Get-Help Get-Date.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AssignmentType
Specifies how IPAM assigns this address.
The acceptable values for this parameter are:
Static
Dynamic
Auto
VIP
Reserved
The default value is Static.
Parameter properties
Type:
AddressAssignment
Default value:
None
Accepted values:
Static, Dynamic, Auto, VIP, Reserved
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-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.
Parameter properties
Type:
CimSession[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Session
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ClientId
Specifies the ID of the client.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CustomConfiguration
Specifies semicolon-separated name/value pairs.
This parameter specifies custom metadata that is associated with the address.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Description
Specifies a description of the IP address assignment for a device.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-DeviceName
Specifies the name of the device to which you assigned the address.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-DeviceType
Specifies the type of device to which you assigned the address.
Specify a value that exists in the built-in DeviceType custom field.
The acceptable values for this parameter are:
VM
Host
The default value is Host.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Duid
Specifies the DHCP device unique identifier (DUID) for the client.
Clients use the DUID to get an IP address from a DHCPv6 server.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ExpiryDate
Specifies an expiry date for the address.
IPAM alerts the administrator when the IP address expires.
IPAM does not reclaim expired addresses automatically.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ForwardLookupPrimaryServer
Specifies the name of the DNS server that IPAM uses to resolve host names to IP addresses.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ForwardLookupZone
Specifies the name of the forward lookup zone that contains a mapping of host names to IP addresses.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
FwdLookupZone
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Iaid
Specifies the identity association ID (IAID) of an IPv6 address.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-IpAddress
Specifies an IP address that this cmdlet adds to IPAM.
Parameter properties
Type:
IPAddress
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-IpAddressState
Specifies the usage state of the IP address.
By default, the cmdlet sets the address as In-Use.
You can specify a valid custom value for this parameter.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-MacAddress
Specifies the media access control (MAC) address of the device to which the address is assigned.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ManagedByService
Specifies the name of the service that manages the IP address.
The value that you specify for this parameter must exist in the set of values that you defined for the ManagedByService custom field in IPAM.
You can use the Add-IpamCustomValue cmdlet to add a value to the ManagedByService custom field in IPAM.
You can use the Remove-IpamCustomValue cmdlet to remove a value from the ManagedByService custom field in IPAM.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
MB
Parameter sets
(All)
Position:
2
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NetworkType
Specifies the network type of the address.
The acceptable values for this parameter are:
Provider
Customer
NonVirtualized
The default value is NonVirtualized.
If you specify Default for the AddressSpace parameter, the valid values for this parameter are Provider and NonVirtualized.
If you specify a provider type of address space for the AddressSpace parameter, you must specify Provider for this parameter.
If you specify a customer type of address space for the AddressSpace parameter, you must specify Customer for this parameter.
Parameter properties
Type:
VirtualizationType
Default value:
None
Accepted values:
NonVirtualized, Provider, Customer
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Owner
Specifies the name of the owner of the address.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-PassThru
Returns an object representing the item with which you are working.
By default, this cmdlet does not generate any output.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ReservationDescription
Specifies a description for the DHCP reservation.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReservationName
Specifies the name of the reservation on the DHCP server for the device.
You must specify a value for this parameter if you specify the ReservationServer parameter.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReservationServer
Specifies the DHCP server on which the reservation is assigned.
The cmdlet stores the reservation data in IPAM.
The cmdlet does not create a reservation on the DHCP server.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReservationType
Specifies the protocols that the reservation supports.
You must specify a value for this parameter if you specify the ReservationServer parameter.
The acceptable values for this parameter are:
DHCP
BootPr
DHCP and BootPr
Parameter properties
Type:
DhcpReservationType
Default value:
None
Accepted values:
None, Dhcp, Bootp, Both
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReverseLookupPrimaryServer
Specifies the DNS server that IPAM uses to resolve IP addresses to host names.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ReverseLookupZone
Specifies the reverse lookup zone that contains the mapping from IP addresses to fully qualified ___domain names (FQDNs).
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
RevLookupZone
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-SerialNumber
Specifies the serial number of the device that is associated with the IP address.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SN
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ServiceInstance
Specifies the instance of the service that manages the IP address.
Specify the instance of the service that you specified for the ManagedByService parameter.
The value that you specify for this parameter must exist in the set of values that you defined for the ServiceInstance custom field in IPAM.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SI
Parameter sets
(All)
Position:
3
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ThrottleLimit
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.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.