Edit

DHCP_FAILOVER_RELATIONSHIP structure (dhcpsapi.h)

  • Article

The DHCP_FAILOVER_RELATIONSHIP structure defines information about a DHCPv4 server failover relationship.

Syntax

typedef struct _DHCP_FAILOVER_RELATIONSHIP {
  DHCP_IP_ADDRESS      PrimaryServer;
  DHCP_IP_ADDRESS      SecondaryServer;
  DHCP_FAILOVER_MODE   Mode;
  DHCP_FAILOVER_SERVER ServerType;
  FSM_STATE            State;
  FSM_STATE            PrevState;
  DWORD                Mclt;
  DWORD                SafePeriod;
  LPWSTR               RelationshipName;
  LPWSTR               PrimaryServerName;
  LPWSTR               SecondaryServerName;
  LPDHCP_IP_ARRAY      pScopes;
  BYTE                 Percentage;
  LPWSTR               SharedSecret;
} DHCP_FAILOVER_RELATIONSHIP, *LPDHCP_FAILOVER_RELATIONSHIP;

Members

PrimaryServer

DHCP_IP_ADDRESS structure that contains the primary server IP address.

SecondaryServer

DHCP_IP_ADDRESS structure that contains the secondary server IP address.

Mode

DHCP_FAILOVER_MODE enumeration that specifies the failover relationship mode.

ServerType

DHCP_FAILOVER_SERVER enumeration that specifies if the server is the primary or secondary server in the failover relationship

State

FSM_STATE enumeration that specifies the state of the failover relationship.

PrevState

FSM_STATE enumeration that specifies the previous state of the failover relationship.

Mclt

A value that specifies the Maximum Client Lead Time (MCLT) in seconds. The MCLT is the maximum time that one server can extend a lease for a client beyond the lease time known by the partner server.

SafePeriod

The time, in seconds, a server will wait before transitioning from the COMMUNICATION-INT state to a PARTNER-DOWN state. The timer begins when the server enters the COMMUNICATION-INT state.

RelationshipName

Pointer to a null-terminated Unicode string that represents the unique failover relationship name.

PrimaryServerName

Pointer to a null-terminated Unicode string that represents the primary server hostname.

SecondaryServerName

Pointer to a null-terminated Unicode string that represents the secondary server hostname.

pScopes

A pointer to an LPDHCP_IP_ARRAY structure that contains the list of IPv4 subnet addresses that are part of the failover relationship and define its scope.

Percentage

Value that specifies the ratio of the client load shared by the primary server in the failover relationship.

SharedSecret

A pointer to a null-terminated Unicode string that represents the shared secret key associated with the failover relationship.

Requirements

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

See also

DHCP_FAILOVER_RELATIONSHIP_ARRAY

DhcpV4FailoverAddScopeToRelationship

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteScopeFromRelationship

DhcpV4FailoverGetRelationship

DhcpV4FailoverGetScopeRelationship

DhcpV4FailoverSetRelationship