failover.update

Update failover configuration.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Updated failover configuration data.

 No Additional Properties

Disabled

Type: boolean

When true, HA will be administratively disabled.

Master

Type: boolean

Marks the particular node in the chassis as the master node. The standby node will have the opposite value.

Timeout

Type: integer

The time to WAIT (in seconds) until a failover occurs when a network event occurs on an interface that is marked critical for failover AND HA is enabled and working appropriately. The default time to wait is 2 seconds.

Maximum is 120 seconds. This value is used to derive the VRRPv3 advertisement interval, which cannot exceed 40.95 seconds (RFC 5798 section 5.2.7).

NOTE: This setting does NOT effect the disabled or master parameters.

Value must be greater or equal to 0 and lesser or equal to 120

FailoverEntry

Type: object

The updated failover configuration.

 No Additional Properties

Id

Type: integer

Unique identifier for the failover configuration.

Disabled

Type: boolean

When true, HA will be administratively disabled.

Master

Type: boolean

Marks the particular node in the chassis as the master node. The standby node will have the opposite value.

Timeout

Type: integer

The time to WAIT (in seconds) until a failover occurs when a network event occurs on an interface that is marked critical for failover AND HA is enabled and working appropriately. The default time to wait is 2 seconds.

NOTE: This setting does NOT effect the disabled or master parameters.


Required roles: FAILOVER_WRITE