Share via


ImportAddress method of the MSFT_IPAM_Address class

Imports a set of IP addresses from a CSV file to IPAM.

Syntax

uint32 ImportAddress(
  [in]  string Path,
  [in]  string ErrorPath,
  [in]  uint16 AddressFamily = 1,
  [in]  string ManagedByService,
  [in]  string ServiceInstance,
  [in]  string NetworkID,
  [in]  string StartAddress,
  [in]  string EndAddress,
  [in]  uint16 NetworkType,
  [in]  string AddressSpace,
  [out] string Output
);

Parameters

Path [in]

The path and name of the CSV file to import.

ErrorPath [in]

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

AddressFamily [in]

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

The possible values are:

0

Other

1

IPv4

2

IPv6

ManagedByService [in]

The name of the service that manages the IP addresses to import.

ServiceInstance [in]

The name of the service instance that manages the IP addresses to import.

NetworkID [in]

The network address and prefix length of the IP addresses to import.

StartAddress [in]

The starting IP address of the IP address range that contains the IP addresses to import.

EndAddress [in]

The ending IP address of the IP address range that contains the IP addresses to import.

NetworkType [in]

Indicates whether the IP addresses are virtual addresses.

The possible values are:

NonVirtualized (1)

Provider (2)

Customer (4)

AddressSpace [in]

The address space of the IP addresses to import.

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_Address