FindIpamFreeSubnet method of the MSFT_IPAM_Subnet class

  • Article

Retrieves unassigned IP subnets from IPAM.

Syntax

uint32 FindIpamFreeSubnet(
  [in]  MSFT_IPAM_Block      Block,
  [in]  uint32               SubnetPrefix,
  [in]  uint32               NumberOfSubnets,
  [out] MSFT_IPAM_FreeSubnet FreeIPSubnets[]
);

Parameters

Block [in]

The block that contains the subnets.

SubnetPrefix [in]

The prefix of the subnets to retrieve.

NumberOfSubnets [in]

The number of subnets to retrieve.

FreeIPSubnets [out]

When this method returns, this parameter contains an instance of MSFT_IPAM_FreeSubnet that contains the retrieved subnets.

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_Subnet