AddRange method of the MSFT_IPAM_Range class

Adds a new IP address range to IPAM.

Syntax

uint32 AddRange(
  [in]  string          NetworkID,
  [in]  uint16          NetworkType,
  [in]  string          AddressSpace,
  [in]  string          StartAddress,
  [in]  string          EndAddress,
  [in]  string          ManagedByService,
  [in]  string          ServiceInstance,
  [in]  uint16          UtilizationCalculation,
  [in]  real64          UtilizedAddresses,
  [in]  string          Description,
  [in]  string          Owner,
  [in]  uint16          AssignmentType,
  [in]  datetime        AssignmentDate,
  [in]  string          ReservedIPAddresses[],
  [in]  string          DnsServers[],
  [in]  string          DnsSuffixes[],
  [in]  string          ConnectionSpecificDnsSuffix,
  [in]  string          WinsServers[],
  [in]  string          VIP[],
  [in]  string          Gateway[],
  [in]  string          CustomConfiguration,
  [in]  string          AssociatedReverseLookupZone,
  [out] MSFT_IPAM_Range OutputRange
);

Parameters

NetworkID [in]

The network type of the address range.

The possible values are:

1

NonVirtualized

2

Provider

3

Customer

NetworkType [in]

The network type of the address range.

The possible values are:

1

NonVirtualized

2

Provider

3

Customer

AddressSpace [in]

The name of the address space associated with the address range.

StartAddress [in]

The starting IP address of the address range.

EndAddress [in]

The ending IP address of the address range.

ManagedByService [in]

The service that manages the address range.

ServiceInstance [in]

The instance of Managed By Service that manages the address range.

UtilizationCalculation [in]

Indicates whether the utilization thresholds are set by the user.

The possible values are:

1

Auto

2

Static

UtilizedAddresses [in]

The number of used IP addresses in the address range.

Description [in]

The description of the address range.

Owner [in]

The owner of the address range.

AssignmentType [in]

The format of the IP address assignment.

The possible values are:

0

None

1

Static

2

Dynamic

3

Auto

4

VIP

5

Reserved

AssignmentDate [in]

The date when addresses were assigned to the address range.

ReservedIPAddresses [in]

An array that contains the reserved IP addresses in the address range.

Note

These IP addresses are excluded from queries, when searching for free IP addresses.

DnsServers [in]

An array that contains the names of the DNS servers that are associated with the address range.

DnsSuffixes [in]

An array that contains the DNS search suffixes that are associated with the address range. These search suffixes are used to resolve a DNS query.

ConnectionSpecificDnsSuffix [in]

The Connection specific DNS suffix that is associated with the address range.

WinsServers [in]

An array that contains the WINS servers associated with the address range.

VIP [in]

An array that contains the virtual IP addresses in the address range.

Note

These IP addresses are excluded from queries, when searching for free IP addresses.

Gateway [in]

An array that contains the names of gateway servers and corresponding metrics associated with the address range.

CustomConfiguration [in]

The custom data associated with the address range. This is formatted as semi-colon separated name=value pairs.

AssociatedReverseLookupZone [in]

The associated reverse lookup zone name for this range.

Windows Server 2012 R2: This parameter not supported before Windows Server 2016.

OutputRange [out]

When this method returns, this parameter contains the new address range 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
IPAMServerPSProvider.mof
DLL
IPAMServerPSProvider.dll

See also

MSFT_IPAM_Range