Edit

Share via

FSM_STATE enumeration (dhcpsapi.h)

  • Article

The FSM_STATE enumeration defines the set of possible failover relationship states on a DHCPv4 server.

Syntax

typedef enum _FSM_STATE {
  NO_STATE = 0,
  INIT,
  STARTUP,
  NORMAL,
  COMMUNICATION_INT,
  PARTNER_DOWN,
  POTENTIAL_CONFLICT,
  CONFLICT_DONE,
  RESOLUTION_INT,
  RECOVER,
  RECOVER_WAIT,
  RECOVER_DONE,
  PAUSED,
  SHUTDOWN
} FSM_STATE;

Constants

 
NO_STATE
Value: 0
Indicates that no state is configured for the DHCPv4 failover relationship.
INIT
Indicates that the failover relationship on the DHCPv4 server is in the initialization state.
STARTUP
Indicates that each server participating in the failover relationship can probe its partner server before starting the DHCP client service. A DHCPv4 server moves into the STARTUP state after INIT.
NORMAL
Indicates that each server in the failover relationship can service DHCPDISCOVER messages and all other DHCP requests as defined in RFC2131. DHCPv4 servers in the NORMAL state can not service DHCPREQUEST/RENEWAL or DHCPREQUEST/REBINDING requests from the client set defined according to the load balancing algorithm in RFC3074. However, each server can service DHCPREQUEST/RENEWAL or DHCPDISCOVER/REBINDING requests from any client.
COMMUNICATION_INT
Indicates that each server in a failover relationship is operating independently, but neither assumes that their partner is not operating. The partner server might be operating and simply unable to communicate with this server, or it might not be operating at all.
PARTNER_DOWN
Indicates that a server assumes its partner is not currently operating.
POTENTIAL_CONFLICT
Indicates that a failover relationship between two DHCPv4 servers is attempting to reestablish itself.
CONFLICT_DONE
Indicates that the primary server has received all updates from the secondary server during the failover relationship reintegration process.
RESOLUTION_INT
Indicates that two servers in the POTENTIAL_CONFLICT state were attempting to reintegrate their failover relationship with each other, but communications between them failed prior to completion of the reintegration.
RECOVER
Indicates that a server in a failover relationship has no information in its stable storage facility or that it is reintegrating with a server in the PARTNER_DOWN state.
RECOVER_WAIT
Indicates that the DHCPv4 server should wait for a time period equal to Maximum Client Lead Time (MCLT) before moving to the RECOVER_DONE state. The MCLT is the maximum time, in seconds, that one server can extend a lease for a client beyond the lease time known by the partner server.
RECOVER_DONE
This value enables an interlocked transition of one server from the RECOVER state and another server from the PARTNER_DOWN or COMMUNICATION-INT state to the NORMAL state.
PAUSED
Reserved. Do not use.
SHUTDOWN
Reserved. Do not use.

Remarks

These states are in conformance with the states described in the IETF Failover Protocol draft: http://tools.ietf.org/html/draft-ietf-dhc-failover-12

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