Export (0) Print
Expand All
Expand Minimize

Add-IpamAddress

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-IpamAddress

Adds an IP address to IPAM.

Syntax

Parameter Set: AddAddress0
Add-IpamAddress [-IpAddress] <IPAddress> [[-ManagedByService] <String> ] [[-ServiceInstance] <String> ] [-AddressSpace <String> ] [-AsJob] [-AssetTag <String> ] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ClientId <String> ] [-CustomConfiguration <String> ] [-Description <String> ] [-DeviceName <String> ] [-DeviceType <String> ] [-Duid <String> ] [-ExpiryDate <DateTime> ] [-ForwardLookupPrimaryServer <String> ] [-ForwardLookupZone <String> ] [-Iaid <UInt32> ] [-IpAddressState <String> ] [-MacAddress <String> ] [-NetworkType <VirtualizationType> ] [-Owner <String> ] [-PassThru] [-ReservationDescription <String> ] [-ReservationName <String> ] [-ReservationServer <String> ] [-ReservationType <DhcpReservationType> ] [-ReverseLookupPrimaryServer <String> ] [-ReverseLookupZone <String> ] [-SerialNumber <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

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.

Parameters

-AddressSpace<String>

Specifies the address space that is associated with the IP address. The default value is Default.


Aliases

none

Required?

false

Position?

named

Default Value

Default

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AssetTag<String>

Specifies the asset tag associated with the IP address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AssignmentDate<DateTime>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns this address. The acceptable values for this parameter are: 

-- Static
-- Dynamic
-- Auto
-- VIP
-- Reserved

The default value is Static.


Aliases

none

Required?

false

Position?

named

Default Value

Static

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

-ClientId<String>

Specifies the ID of the client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CustomConfiguration<String>

Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description of the IP address assignment for a device.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceName<String>

Specifies the name of the device to which you assigned the address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceType<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

Host

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Duid<String>

Specifies the DHCP device unique identifier (DUID) for the client. Clients use the DUID to get an IP address from a DHCPv6 server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ExpiryDate<DateTime>

Specifies an expiry date for the address. IPAM alerts the administrator when the IP address expires. IPAM does not reclaim expired addresses automatically.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForwardLookupPrimaryServer<String>

Specifies the name of the DNS server that IPAM uses to resolve host names to IP addresses.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForwardLookupZone<String>

Specifies the name of the forward lookup zone that contains a mapping of host names to IP addresses.


Aliases

FwdLookupZone

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Iaid<UInt32>

Specifies the identity association ID (IAID) of an IPv6 address.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IpAddress<IPAddress>

Specifies an IP address. The cmdlet adds the IP address to IPAM.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IpAddressState<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

In-Use

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MacAddress<String>

Specifies the media access control (MAC) address of the device to which the address is assigned.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ManagedByService<String>

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.


Aliases

MB

Required?

false

Position?

3

Default Value

IPAM

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NetworkType<VirtualizationType>

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.


Aliases

none

Required?

false

Position?

named

Default Value

NonVirtualized

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Owner<String>

Specifies the name of the owner of the address.


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

-ReservationDescription<String>

Specifies a description for the DHCP reservation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReservationName<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReservationServer<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReservationType<DhcpReservationType>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReverseLookupPrimaryServer<String>

Specifies the DNS server that IPAM uses to resolve IP addresses to host names.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReverseLookupZone<String>

Specifies the reverse lookup zone that contains the mapping from IP addresses to fully qualified domain names (FQDNs).


Aliases

RevLookupZone

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SerialNumber<String>

Specifies the serial number of the device that is associated with the IP address.


Aliases

SN

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ServiceInstance<String>

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.


Aliases

SI

Required?

false

Position?

4

Default Value

Localhost

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

-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.

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.

  • IpamAddress



    Represents an IP address on the IPAM 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


PS C:\> Add-IpamAddress -IpAddress 10.12.3.5 -PassThru
IpAddress        : 10.12.3.5

Type : NonVirtualized

Duplicate : False

ExpiryStatus : Not Expired

MacAddress :

ManagedByService : IPAM

ServiceInstance : Localhost

DeviceName :

DeviceType : Host

IpAddressState : In-Use

AssignmentType : Static

Example 2: Assign a dynamic IP address to a virtual machine

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.


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

Example 3: Add a provider IP address to the IPAM server

This command adds the provider IP address 172.16.10.16 (which the current instance of IPAM manages) to the default address space.


PS C:\> Add-IpamAddress -NetworkType Provider -IpAddress 172.16.10.16 -PassThru
IpAddress         : 172.16.10.16

NetworkType : Provider

Duplicate : False

ExpiryStatus : Not Expired

MacAddress :

ManagedByService : IPAM

ServiceInstance : Localhost

DeviceName :

DeviceType : Host

IpAddressState : In-Use

AssignmentType : Static

Example 4: Add a provider IP address that Virtual Machine Manager manages

This command adds a provider IP address that is managed by System Center 2012 R2 Virtual Machine Manager and belongs to the provider address space named Datacenter01. Virtual Machine Manager statically manages the address assignment. Because this address is in a different address space, IPAM does not mark it as a duplicate.


PS C:\> Add-IpamAddress -IpAddress 172.16.10.16 -AddressSpace "Datacenter01" -ManagedByService VMM -ServiceInstance "vmm1.contoso.com" -PassThru
IpAddress         : 172.16.10.16

NetworkType : Provider

Duplicate : False

ExpiryStatus : Not Expired

MacAddress :

ManagedByService : VMM

ServiceInstance : vmm1.contoso.com

DeviceName :

DeviceType : Host

IpAddressState : In-Use

AssignmentType : Static

Example 5: Add a customer IP address that a Virtual Machine Manager instance manages

This command adds a customer IP address that the System Center 2012 R2 Virtual Machine Manager instance vmm01.contoso.com manages. The address is added to the customer address space for the tenant named Datacenter01.


PS C:\> Add-IpamAddress -IpAddress 172.16.10.16 -Virtual -AddressSpace "Datacenter01" -ManagedByService VMM -ServiceInstance "vmm01.contoso.com" -DeviceType VM
IpAddress         : 172.16.10.16

NetworkType : Customer

Duplicate : False

ExpiryStatus : Not Expired

MacAddress :

ManagedByService : VMM

ServiceInstance : vmm01.contoso.com

DeviceName :

DeviceType : VM

IpAddressState : In-Use

AssignmentType : Static

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft