ImportRange method of the MSFT_IPAM_Range class

Imports a set of IP address ranges into IPAM from a CSV file.

Syntax

uint32 ImportRange(
  [in]  string  Path,
  [in]  string  ErrorPath,
  [in]  uint16  AddressFamily,
  [in]  string  ManagedByService,
  [in]  string  ServiceInstance,
  [in]  boolean AddManagedByService,
  [in]  boolean AddServiceInstance,
  [in]  boolean DeleteMappedAddresses,
  [in]  boolean CreateSubnetIfNotFound,
  [out] string  Output
);

Parameters

Path [in]

The literal path and filename of the CSV file.

ErrorPath [in]

The path of the error files that IPAM generates if one or more IP address ranges fails to import.

AddressFamily [in]

The address family of the IP addresses in the import file.

The possible values are:

0

Other

1

IPv4

2

IPv6

ManagedByService [in]

The name of the service that manages the address ranges to import.

Note

The import of MS DHCP ranges is not supported by IPAM.

ServiceInstance [in]

An array of service instances that manage the address ranges to import.

AddManagedByService [in]

True to manage the imported address ranges with the service that manage the address ranges in the CSV file; otherwise, false.

AddServiceInstance [in]

True to manage the imported address ranges with the service instance that manage the address ranges in the CSV file; otherwise, false.

DeleteMappedAddresses [in]

True delete mapped IP addresses from the imported address ranges; otherwise, false.

CreateSubnetIfNotFound [in]

True to create a parent subnet for the imported address ranges when no parent subnet exists; otherwise, false.

Output [out]

When this method returns, this parameter contains the status of the import operation.

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