AddByHotStandby method of the PS_DhcpServerv4Failover class

Adds a new IPv4 failover relationship on the server.

Syntax

uint32 AddByHotStandby(
  [in]   string ComputerName,
  [in]   string Name,
  [in]   string PartnerServer,
  [in]   string ScopeId[],
  [in]   datetime MaxClientLeadTime,
  [in]   boolean AutoStateTransition,
  [in]   datetime StateSwitchInterval,
  [in]   boolean Force,
  [in]   string SharedSecret,
  [in]   boolean PassThru,
  [in]   uint32 ReservePercent,
  [in]   string ServerRole,
  [out]  string cmdletOutput
);

Parameters

ComputerName [in]

TBD

Name [in]

Name of the failover relationship to be created

PartnerServer [in]

IP address or hostname of the partner server

ScopeId [in]

Scope identifiers (in IPv4 address format) which are to be added to the failover relationship.

MaxClientLeadTime [in]

Maximum Client Lead time for the failover relationship. Default is 1 hour.

AutoStateTransition [in]

Enable or 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.

StateSwitchInterval [in]

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

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.

SharedSecret [in]

Shared secret to be used for message digest authentication. If not specified, message digest authentication is turned off.

PassThru [in]

TBD

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 address from this reserved pool on the standby server will be leased to new DHCP clients. Default is 5%.

ServerRole [in]

Role of the local server in the hot standby mode. Valid values are Active, Standby. Default role is Active for the local server i.e. the partner server specified will be a standby server.

Active (Active)

Standby (Standby )

cmdletOutput [out]

TBD

Requirements

See also

PS_DhcpServerv4Failover

Build date: 12/6/2012