Share via


DhcpServerv4Lease class

Dhcp Server v4 Client Lease.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[ClassVersion("1.0.0"), dynamic, provider("DhcpServerPSProvider"), AMENDMENT]
class DhcpServerv4Lease
{
  string   AddressState;
  string   IPAddress;
  string   ScopeId;
  string   Description;
  string   ClientId;
  string   HostName;
  string   ClientType;
  DateTime LeaseExpiryTime;
  boolean  NapCapable;
  string   NapStatus;
  DateTime ProbationEnds;
  string   PolicyName;
  string   DnsRR;
  string   DnsRegistration;
  string   ServerIP;
};

Members

The DhcpServerv4Lease class has these types of members:

Properties

The DhcpServerv4Lease class has these properties.

AddressState

Data type: string

Access type: Read/write

Address state of the client.

Offered (Offered)

Active ("Active")

Declined ("Declined")

Expired ("Expired")

ActiveReservation ("ActiveReservation")

InactiveReservation ("InactiveReservation")

ClientId

Data type: string

Access type: Read/write

Client unique identifier for lease.

ClientType

Data type: string

Access type: Read/write

Client type {UnSpecified, Dhcp, BootP, None}.

UnSpecified ("UnSpecified")

Dhcp ("Dhcp")

BootP ("BootP")

None ("None")

Description

Data type: string

Access type: Read/write

Description for the client.

DnsRegistration

Data type: string

Access type: Read/write

Indicates status of the DNS registration of the lease.

Complete ("Complete")

Pending ("Pending")

NotApplicable ("NotApplicable")

DnsRR

Data type: string

Access type: Read/write

Indicates the type of DNS record to be registered by the DHCP server for the lease.

A ("A")

PTR ("PTR")

AandPTR ("AandPTR")

NoRegistration ("NoRegistration")

Windows Server 2012: This value A is supported beginning with Windows Server 2012 R2.

HostName

Data type: string

Access type: Read/write

Client name.

IPAddress

Data type: string

Access type: Read/write

Client IP Address.

LeaseExpiryTime

Data type: DateTime

Access type: Read/write

Lease Expiry Time

NapCapable

Data type: boolean

Access type: Read/write

Indicates if the client is NAP capable or not.

NapStatus

Data type: string

Access type: Read/write

NAP Status of the client.

FullAccess ("FullAccess")

RestrictedAccess ("RestrictedAccess")

DropPacket ("DropPacket")

InProbation ("InProbation")

Exempt ("Exempt")

DefaultQuarantineSetting ("DefaultQuarantineSetting")

NoQuarantineInfo ("NoQuarantineInfo")

PolicyName

Data type: string

Access type: Read/write

Name of the Policy based on which this IP address was leased.

ProbationEnds

Data type: DateTime

Access type: Read/write

End-time of probation if the client is in probation.

ScopeId

Data type: string

Access type: Read/write

Subnet address to which the client belongs.

ServerIP

Data type: string

Access type: Read-only

Server IP Address which indicates the server that has leased or renewed the IP address lease in a DHCP failover deployment.

Requirements

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