Share via


DhcpServerv4Failover class

Dhcp Server v4 Failover.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[ClassVersion("1.0.0"), dynamic, provider("DhcpServerPSProvider"), AMENDMENT]
class DhcpServerv4Failover
{
  string   Name;
  string   PartnerServer;
  string   Mode;
  string   ServerRole;
  uint32   LoadBalancePercent;
  uint32   ReservePercent;
  string   ScopeId[];
  Datetime MaxClientLeadTime;
  boolean  AutoStateTransition;
  Datetime StateSwitchInterval;
  string   State;
  boolean  EnableAuth;
  string   PrimaryServerIP;
  string   SecondaryServerIP;
  string   PrimaryServerName;
  string   SecondaryServerName;
  string   ServerType;
};

Members

The DhcpServerv4Failover class has these types of members:

Properties

The DhcpServerv4Failover class has these properties.

AutoStateTransition

Data type: boolean

Access type: Read/write

Enables or disables the automatic transition from CommunicationInterrupted state to PartnerDown state.

EnableAuth

Data type: boolean

Access type: Read/write

Enables or disables the message authentication.

LoadBalancePercent

Data type: uint32

Access type: Read/write

If FailoverMode is LoadBalance, this is the percent of load distribution else NA.

MaxClientLeadTime

Data type: Datetime

Access type: Read/write

Maximum amount of time that a server can extend a client's binding lease over the lease time.

Mode

Data type: string

Access type: Read/write

Mode of the Failover Relationship.

HotStandby ("HotStandby")

LoadBalance ("LoadBalance")

Name

Data type: string

Access type: Read/write

Name for the failover relationship.

PartnerServer

Data type: string

Access type: Read/write

IP Address or host name of the partner server.

PrimaryServerIP

Data type: string

Access type: Read-only

IP address of Primary Server.

Windows Server 2012: This value is supported beginning with Windows Server 2012 R2.

PrimaryServerName

Data type: string

Access type: Read-only

Name of Primary Server.

Windows Server 2012: This value is supported beginning with Windows Server 2012 R2.

ReservePercent

Data type: uint32

Access type: Read/write

If Mode is HotStandby, this is the percent of addresses reserved on standby server.

ScopeId

Data type: string array

Access type: Read/write

IP Addresses of one or more Scopes that are part of the failover relationship.

SecondaryServerIP

Data type: string

Access type: Read-only

IP addresses of Secondary Server.

Windows Server 2012: This value is supported beginning with Windows Server 2012 R2.

SecondaryServerName

Data type: string

Access type: Read-only

Name of Secondary Server.

Windows Server 2012: This value is supported beginning with Windows Server 2012 R2.

ServerRole

Data type: string

Access type: Read/write

If Mode is HotStandby, this is the role of this server.

Active ("Active")

Standby ("Standby")

ServerType

Data type: string

Access type: Read-only

Indicates if server is primary or secondary.

PrimaryServer ("PrimaryServer")

SecondaryServer ("SecondaryServer")

Windows Server 2012: This value is supported beginning with Windows Server 2012 R2.

State

Data type: string

Access type: Read/write

Mode of the failover relationship.

NoState ("NoState")

Normal ("Normal")

Init ("Init")

CommunicationInterrupted ("CommunicationInterrupted")

PartnerDown ("PartnerDown")

PotentialConflict ("PotentialConflict")

Startup ("Startup")

ResolutionInterrupted ("ResolutionInterrupted")

ConflictDone ("ConflictDone")

Recover ("Recover")

RecoverWait ("RecoverWait")

RecoverDone ("RecoverDone")

StateSwitchInterval

Data type: Datetime

Access type: Read/write

Time period that the server will stay in CommunicationInterrupted state before auto transitioning into PartnerDown state.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\DHCP
MOF
DhcpServerPsProvider.mof
DLL
DhcpServerPsProvider.dll