DHCPV4_FAILOVER_CLIENT_INFO structure (dhcpsapi.h)

The DHCPV4_FAILOVER_CLIENT_INFO structure defines DHCP server scope statistics that are part of a failover relationship.

Syntax

typedef struct _DHCPV4_FAILOVER_CLIENT_INFO {
  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;
  DWORD            SentPotExpTime;
  DWORD            AckPotExpTime;
  DWORD            RecvPotExpTime;
  DWORD            StartTime;
  DWORD            CltLastTransTime;
  DWORD            LastBndUpdTime;
  DWORD            BndMsgStatus;
  LPWSTR           PolicyName;
  BYTE             Flags;
} DHCPV4_FAILOVER_CLIENT_INFO, *LPDHCPV4_FAILOVER_CLIENT_INFO;

Members

ClientIpAddress

DHCP_IP_ADDRESS structure that contains the DHCPv4 client IPv4 address.

SubnetMask

DHCP_IP_MASK structure that contains the DHCPv4 client IPv4 subnet mask.

ClientHardwareAddress

DHCP_CLIENT_UID structure that contains the hardware address (MAC address) of the DHCPv4 client.

ClientName

Pointer to a null-terminated Unicode string that represents the DHCPv4 client machine name.

ClientComment

Pointer to a null-terminated Unicode string that represents the description of 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) that provided a lease to the DHCPv4 client.

bClientType

Value that specifies the DHCPv4 client type. The possible values are below.

AddressState

Value that specifies various states of the IPv4 address. The LSB is bit 0 and the MSB is bit 7. The possible values are below.

BIT 0 and BIT 1 signify the DHCPv4 client IPv4 address state, as shown in the following table.

BIT 2 and BIT 3 signify information related to Name Protection for the leased IPv4 address, as shown in the following table.

BIT 4, BIT 5, BIT 6, and BIT 7 specify information related to DNS, as shown in the following table.

Status

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

ProbationEnds

DATE_TIME structure that contains the probation end time if the DHCPv4 client is on probation. The DHCPv4 client has full access to the network for this time period. This is UTC time represented in the FILETIME format.

QuarantineCapable

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

SentPotExpTime

Time, in seconds, of potential-expiration-time sent to the partner server.

AckPotExpTime

Time, in seconds, of potential-expiration-time acknowledged by the partner server.

RecvPotExpTime

Time, in seconds, of potential-expiration-time received from the partner server.

StartTime

Time, in seconds, since the client lease first entered into its current state.

CltLastTransTime

Time, in seconds, since the client-last-transaction-time.

LastBndUpdTime

Time, in seconds, since the partner server last updated the DHCPv4 client lease.

BndMsgStatus

Reserved. Do not use.

PolicyName

Pointer to a null-terminated Unicode string that represents the DHCP server policy name that resulted in the IPv4 address assignment to the DHCPv4 client in the lease.

Flags

Reserved. Do not use.

Requirements

See also

DHCPV4_FAILOVER_CLIENT_INFO_ARRAY