FindIpamFreeRange method of the MSFT_IPAM_Range class

  • Article

Retrieves unassigned IP address ranges from IPAM.

Syntax

uint32 FindIpamFreeRange(
  [in]  MSFT_IPAM_Subnet    Subnet,
  [in]  uint32              NumberOfAddresses,
  [in]  uint32              NumberofRanges,
  [out] MSFT_IPAM_FreeRange FreeIPRanges[]
);

Parameters

Subnet [in]

The subnet that contains the ranges.

NumberOfAddresses [in]

The number of IP addresses to retrieve.

NumberofRanges [in]

The number of ranges to retrieve.

FreeIPRanges [out]

This method returns an array of embedded MSFT_IPAM_FreeRange instances containing the retrieved ranges.

Return value

Returns 0 on success, otherwise returns a WMI error code.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2016
Namespace
 Root\Microsoft\IPAM
MOF
IPAMServerPSProvider.mof
DLL
IPAMServerPSProvider.dll

See also

MSFT_IPAM_Range