Edit

DHCPV4_FAILOVER_CLIENT_INFO structure (dhcpsapi.h)

  • Article

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.

Value Meaning
CLIENT_TYPE_UNSPECIFIED
0x00
 The DHCPv4 client is not defined in the server database.
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 supports 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

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.

Value Meaning
ADDRESS_STATE_OFFERED
0x0
 The DHCPv4 client is offered this IPv4 address.
ADDRESS_STATE_ACTIVE
0x1
 The IPv4 address is active and has an active DHCPv4 client lease record.
ADDRESS_STATE_DECLINED
0x2
 The IPv4 address request is declined by the DHCPv4 client; hence, it is a bad IPv4 address.
ADDRESS_STATE_DOOM
0x3
 The IPv4 address is in DOOMED state and is due to be deleted.
 

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

Value Meaning
ADDRESS_BIT_NO_DHCID
0x0
 The address is leased to the DHCPv4 client without DHCID as defined in sections 3 and 3.5 of RFC4701.
ADDRESS_BIT_DHCID_NO_CLIENTIDOPTION
0x1
 The address is leased to the DHCPv4 client with DHCID but without the client ID option as defined in sections 3 and 3.5 of RFC4701.
ADDRESS_BIT_DHCID_WITH_CLIENTIDOPTION
0x2
 The address is leased to the DHCPv4 client with DHCID and the client ID option as defined in sections 3 and 3.5 of RFC4701.
ADDRESS_BIT_DHCID_WITH_DUID
0x3
 The address is leased to the DHCPv4 client with DHCID and the client DUID and as defined in sections 3 and 3.5 of RFC4701.
 

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

Value Meaning
ADDRESS_BIT_CLEANUP
0x1
 The DNS update for the DHCPv4 client lease record needs to be deleted from the DNS server when the lease is deleted.
ADDRESS_BIT_BOTH_REC
0x2
 The DNS update needs to be sent for both DNS_A_DATA and DNS_PTR_DATA type resource records.
ADDRESS_BIT_UNREGISTERED
0x4
 The DNS update is not complete for the lease record.
ADDRESS_BIT_DELETED
0x8
 The address lease is expired, but the DNS updates for the lease record have not been deleted from the DNS server.

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

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Header dhcpsapi.h

See also

DHCPV4_FAILOVER_CLIENT_INFO_ARRAY