AddAddress method of the MSFT_IPAM_Address class
Adds a new IP Address to IPAM.
Syntax
uint32 AddAddress(
[in] string Address,
[in] uint16 NetworkType,
[in] string AddressSpace,
[in] string ManagedByService,
[in] string ServiceInstance,
[in] string DeviceType = Host,
[in] string IPAddressState,
[in] uint16 AssignmentType = Static,
[in] string MacAddress,
[in] datetime AssignmentDate,
[in] datetime ExpiryDate,
[in] string Description,
[in] string Owner,
[in] string AssetTag,
[in] string SerialNumber,
[in] string ClientID,
[in] string Duid,
[in] uint32 Iaid,
[in] string ReservationServer,
[in] string ReservationName,
[in] uint16 ReservationType,
[in] string ReservationDescription,
[in] string DeviceName,
[in] string ForwardLookupZone,
[in] string ForwardLookupPrimaryServer,
[in] string ReverseLookupZone,
[in] string ReverseLookupPrimaryServer,
[in] string CustomConfiguration,
[out] MSFT_IPAM_Address OutputAddress
);
Parameters
-
Address [in]
-
The new IP address to add.
-
NetworkType [in]
-
The network type of the address.
The possible values are:
-
Provider (1)
-
Customer (2)
-
NonVirtualized (4)
AddressSpace [in]
The address space that is associated with the IP address.
ManagedByService [in]
The name of the service that manages the IP address.
ServiceInstance [in]
The instance of the service that manages the IP address.
DeviceType [in]
The type of device to which you assigned the address. The default value is "Host".
The possible values are:
VM
A virtual machine.
Host
A host device.
IPAddressState [in]
The usage state of the IP address. By default, the address is set to "In-Use". You can specify a valid custom value for this parameter.
AssignmentType [in]
The type of address assignment used by IPAM to assign the IP address.
The possible values are:
Static (0)
Dynamic (1)
Auto (2)
VIP (3)
Reserved (4)
MacAddress [in]
The media access control (MAC) address of the device to which the address is assigned.
AssignmentDate [in]
The date on which the IP address was assigned to a device.
ExpiryDate [in]
Specifies an expiration date for the address.
Description [in]
A description of the IP address assignment for a device.
Owner [in]
The name of the owner of the IP address.
AssetTag [in]
The asset tag associated with the IP address.
SerialNumber [in]
The serial number of the device that is associated with the IP address.
ClientID [in]
The ID of the client.
Duid [in]
The DHCP device unique identifier (DUID) for the client. Clients use the DUID to get an IP address from a DHCPv6 server.
Iaid [in]
The identity association ID (IAID) of an IPv6 address.
ReservationServer [in]
The name of the DHCP server on which the DHCP reservation is assigned.
ReservationName [in]
The name of the DHCP reservation on the DHCP server for the device.
ReservationType [in]
This specifies the protocols supported by the DHCP reservation.
The possible values are:
DHCP (0)
BootP (1)
DHCP and BootPr (2)
ReservationDescription [in]
A description for the DHCP reservation.
DeviceName [in]
The name of the device to which the IP address is assigned.
ForwardLookupZone [in]
The name of the forward lookup zone that contains a mapping of host names to IP addresses.
ForwardLookupPrimaryServer [in]
The name of the DNS server that IPAM uses to resolve host names to IP addresses.
ReverseLookupZone [in]
The reverse lookup zone that contains the mapping from IP addresses to fully qualified domain names (FQDNs).
ReverseLookupPrimaryServer [in]
The DNS server that IPAM uses to resolve IP addresses to host names.
CustomConfiguration [in]
A set of custom metadata for the IP address. The metadata is formatted with semicolon-separated name/value pairs.
OutputAddress [out]
When this method returns, this parameter receives the IP address object.
Return value
Returns 0 on success, otherwise returns a WMI error code.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\IPAM |
| MOF |
|
| DLL |
|