Enabling and Disabling Auto-Failover
Auto-failover is enabled and disabled by means of the POST /settings/autoFailover
HTTP method and URI.
Description
The POST /settings/autoFailover
HTTP method and URI can be used to enable and disable auto-failover.
Auto-failover settings are global, and therefore apply to all nodes in the cluster. The Full Admin, Cluster Admin, or Backup Full Admin role is required, to establish the settings.
Curl Syntax
curl -X POST http://<ip-address-or-hostname>:8091/settings/autoFailover
-u <username>:<password>
-d timeout=<number-of-seconds>
-d maxCount=<number-of-nodes>
-d failoverOnDataDiskIssues[enabled]=[true|false]
-d failoverOnDataDiskIssues[timePeriod]=<number-of-seconds>
-d canAbortRebalance=[true|false]
The parameters are as follows:
-
enabled=[true|false]
. Enables or disables automatic failover. Default setting istrue
. Settingenabled
tofalse
automatically setsfailoverOnDataDiskIssues[enabled]
tofalse
. Note that whenenabled
is set tofalse
, the values supplied for any additional parameters (includingfailoverOnDataDiskIssues[enabled]
andcanAbortRebalance
) are ignored. Theenabled
parameter is required. Settingenabled
totrue
requires that thetimeout
parameter also be specified. -
timeout=<number-of-seconds>
. Integer between 5 and 3600. Specifies the number of seconds that must elapse, with a node unavailable, before automatic failover is triggered. Default setting is 120. Thetimeout
parameter can only be specified whenenabled
is set totrue
. This parameter and its values are ignored if the value for theenabled
parameter isfalse
. -
maxCount=<number-of-nodes>
. Specifies the maximum number of nodes to be automatically failed over before administrator-intervention is required The maximum value can be up to the number of configured nodes. The default value is 1. This parameter is optional, and is only supported by Couchbase Server Enterprise Edition. This parameter and its values are ignored if the value for theenabled
parameter isfalse
. -
failoverOnDataDiskIssues[enabled]=[true|false]
Allows the triggering of auto-failover when disk read-write attempts have failed continuously throughout at least 60% of the specified time-period. The default value forfailoverOnDataDiskIssues[enabled]
isfalse
. A value forfailoverOnDataDiskIssues[timePeriod]
must be specified whenfailoverOnDataDiskIssues[enabled]
istrue
. -
failoverOnDataDiskIssues[timePeriod]=<number-of-seconds>
. The specified value should be an integer between 5 and 3600. The default value (which is maintained whilefailoverOnDataDiskIssues[enabled]
isfalse
) is 120; but iffailoverOnDataDiskIssues[enabled]
is set totrue
, a value forfailoverOnDataDiskIssues[timePeriod]
must nevertheless be explicitly specified.If
failoverOnDataDiskIssues[enabled]
is not specified, butfailoverOnDataDiskIssues[timePeriod]
is specified, the following error message is generated:The value of "failoverOnDataDiskIssues[enabled]" must be true or false
.If
failoverOnDataDiskIssues[enabled]
isfalse
, butfailoverOnDataDiskIssues[timePeriod]
is specified, the value specified forfailoverOnDataDiskIssues[timePeriod]
is ignored.These parameters are optional, and are only supported by Couchbase Server Enterprise Edition. These parameters and their values are ignored, if
enabled
is set tofalse
. -
canAbortRebalance
. Whether or not auto-failover can be triggered if a rebalance is in progress. This parameter is optional, and is only available in Couchbase Enterprise Edition. The value can be eithertrue
(the default) orfalse
. The parameter and its value are ignored, ifenabled
is set tofalse
.
Responses
Success returns 200 OK
.
Incorrectly specified values are handled as follows:
-
If the value of
enabled
is neithertrue
norfalse
,400 Bad Request
is returned, with the messageThe value of "enabled" must be true or false
. -
If the value of
timeout
is incorrectly specified,400 Bad Request
is returned, with the messageThe value of "timeout" must be a positive integer in a range from 5 to 3600
. -
If the value of
timePeriod
is incorrectly specified,400 Bad Request
is returned, with the messageThe value of "failoverOnDataDiskIssues[timePeriod]" must be a positive integer in a range from 5 to 3600
.
Failure to authenticate returns 401 Unauthorized
.
Example
The following example enables auto-failover for the cluster, with a timeout
of 72 seconds, and a maxCount
of 2
.
It also enabled auto-failover on disk issues, and establishes the corresponding time period as 89
seconds.
curl -X POST -u Administrator:password \
http://10.144.231.101:8091/settings/autoFailover \
-d 'enabled=true' \
-d 'timeout=72' \
-d 'maxCount=2' \
-d 'failoverOnDataDiskIssues[enabled]=true' \
-d 'failoverOnDataDiskIssues[timePeriod]=89'
See Also
For information on retrieving the current auto-failover parameter-values with the REST API, see Retrieving Auto-Failover Settings.
The Couchbase CLI allows auto-failover to be managed by means of the setting-autofailover command. For information on managing auto-failover with Couchbase Web Console, see Node Availability.
A full description of auto-failover is provided in Automatic Failover.