Share via

FindIpamFreeAddress method of the MSFT_IPAM_Address class

  • Article

Retrieves an array of IP addresses from a range of IP addresses in IPAM that are not assigned to a device.

Syntax

uint32 FindIpamFreeAddress(
  [in]  MSFT_IPAM_Range       Range,
  [in]  uint32                NumAddress,
  [in]  boolean               TestReachability,
  [out] MSFT_IPAM_FreeAddress FreeIPAddresses[]
);

Parameters

Range [in]

The IPAM range from which to retrieve the IP addresses.

NumAddress [in]

The number of IP addresses to retrieve.

TestReachability [in]

True to test the reachability of the IP addresses; otherwise, false.

FreeIPAddresses [out]

When this method returns, this parameter contains the array of retrieved IP addresses.

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