GetByScopeId method of the PS_DhcpServerv4Lease class

Gets one or more lease records from the DHCP server.

Syntax

uint32 GetByScopeId(
  [in]  string            ComputerName,
  [in]  string            ScopeId,
  [in]  boolean           AllLeases,
  [out] DhcpServerv4Lease cmdletOutput[]
);

Parameters

ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

ScopeId [in]

Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved

AllLeases [in]

If specified, all the IP address leases regardless of address state are returned. If not specified, only active leases are returned

cmdletOutput [out]

An embedded instance of the DhcpServerv4Lease class.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\DHCP
MOF	DhcpServerPsProvider.mof
DLL	DhcpServerPsProvider.dll

See also

PS_DhcpServerv4Lease