DHCP_CLIENT_INFO_VQ structure

The DHCP_CLIENT_INFO_VQ structure defines information about the DHCPv4 client.

Syntax


typedef struct _DHCP_CLIENT_INFO_VQ {
  DHCP_IP_ADDRESS  ClientIpAddress;
  DHCP_IP_MASK     SubnetMask;
  DHCP_CLIENT_UID  ClientHardwareAddress;
  LPWSTR           ClientName;
  LPWSTR           ClientComment;
  DATE_TIME        ClientLeaseExpires;
  DHCP_HOST_INFO   OwnerHost;
  BYTE             bClientType;
  BYTE             AddressState;
  QuarantineStatus Status;
  DATE_TIME        ProbationEnds;
  BOOL             QuarantineCapable;
} DHCP_CLIENT_INFO_VQ, *PDHCP_CLIENT_INFO_VQ;

Members

ClientIpAddress

DHCP_IP_ADDRESStype value that contains the DHCPv4 client's IPv4 address.

SubnetMask

DHCP IP_MASK type value that contains the DHCPv4 client's IPv4 subnet mask address.

ClientHardwareAddress

GUID value that contains the hardware address (MAC address) of the DHCPv4 client.

ClientName

Ppointer to a null-terminated Unicode string that represents the DHCPv4 client's machine name.

ClientComment

Pointer to a null-terminated Unicode string that represents the description given to the DHCPv4 client.

ClientLeaseExpires

DATE_TIME structure that contains the lease expiry time for the DHCPv4 client. This is UTC time represented in the FILETIME format.

OwnerHost

DHCP_HOST_INFO structure that contains information about the host machine (DHCPv4 server machine) that has provided a lease to the DHCPv4 client.

bClientType

Possible types of the DHCPv4 client. The possible values are shown in the following table.

ValueMeaning
CLIENT_TYPE_UNSPECIFIED
0x00

A DHCPv4 client other than ones defined in this table.

CLIENT_TYPE_DHCP
0x01

The DHCPv4 client supports the DHCP protocol.

CLIENT_TYPE_BOOTP
0x02

The DHCPv4 client supports the BOOTP protocol.

CLIENT_TYPE_BOTH
0x03

The DHCPv4 client understands both the DHCPv4 and the BOOTP protocols.

CLIENT_TYPE_RESERVATION_FLAG
0x04

There is an IPv4 reservation created for the DHCPv4 client.

CLIENT_TYPE_NONE
0x64

Backward compatibility for manual addressing.

 

AddressState

Possible states of the IPv4 address given to the DHCPv4 client. The following table represents the different values and their meanings.

ValueMeaning
ADDRESS_STATE_OFFERED
0x00

The DHCPv4 client has been offered this IPv4 address.

ADDRESS_STATE_ACTIVE
0x01

The IPv4 address is active and has an active DHCPv4 client lease record.

ADDRESS_STATE_DECLINED
0x02

The IPv4 address request was declined by the DHCPv4 client; hence, it is a bad IPv4 address.

ADDRESS_STATE_DOOM
0x03

The IPv4 address is in DOOMED state and is due to be deleted.

 

Status

QuarantineStatus enumeration that specifies possible health status values for the DHCPv4 client, as validated at the NAP server.

ProbationEnds

This is of type DATE_TIME, containing the end time of the probation if the DHCPv4 client is on probation. For this time period, the DHCPv4 client has full access to the network.

QuarantineCapable

If TRUE, the DHCPv4 client is quarantine-enabled; if FALSE, it is not.

Remarks

DHCP_CLIENT_INFO_VQ augments the DHCP_CLIENT_INFO_V5 structure by including information relating to the NAP settings of the DHCPv4 client.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

See also

DHCP Server Management Type Definitions
DHCP_HOST_INFO

 

 

Show: