Set method of the PS_DhcpServerv4Failover class

Modifies the properties of an existing failover relationship.


uint32 Set(
  [in]  string               ComputerName,
  [in]  string               Name,
  [in]  boolean              AutoStateTransition,
  [in]  datetime             MaxClientLeadTime,
  [in]  string               SharedSecret,
  [in]  datetime             StateSwitchInterval,
  [in]  boolean              PartnerDown,
  [in]  boolean              Force,
  [in]  uint32               LoadBalancePercent,
  [in]  uint32               ReservePercent,
  [in]  boolean              PassThru,
  [in]  string               Mode,
  [out] DhcpServerv4Failover cmdletOutput


ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

Name [in]

Name of failover relationship whose properties need to be modified.

AutoStateTransition [in]

Enable/Disable automatic state transition from COMMUNICATION INTERRUPTED state to PARTNER DOWN state based on expiry of the timer (Safe Period) while in COMMUNICATION INTERRUPTED state. Valid values are True, False. Default value is False; however, this will be set to True if safe period is specified.

MaxClientLeadTime [in]

Maximum Client Lead time for the failover relationship.

SharedSecret [in]

Shared secret to be used for message authentication. To turn off message authentication, set the shared secret value to Null.

StateSwitchInterval [in]

Time interval for which the server should continue to operate in COMMUNICATION INTERRUPTED state before transitioning to PARTNER DOWN state.

PartnerDown [in]

Changes the state of the server from Communication Interrupted to Partner Down

Force [in]

If shared secret is specified, user confirmation is sought since shared secret specified may be transferred in clear text transport in case of remote management.

LoadBalancePercent [in]

Percentage of DHCP client requests which should be served by the local server. The remaining requests would be served by the partner server.

ReservePercent [in]

Percentage of free IP address pool of the scope which should be reserved on the standby server. In case of a failover, IP addresses from this reserved pool on the standby server will be leased to new DHCP clients.

PassThru [in]

If this parameter is specified, the cmdlet returns the PowerShell object which is modified.

Mode [in]

Mode of the failover relationship.

HotStandby ("HotStandby")

LoadBalance ("LoadBalance")

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

cmdletOutput [out]

An embedded instance of a DhcpServerv4Failover object.


Minimum supported client

None supported

Minimum supported server

Windows Server 2012







See also