Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Performing Hard Failover

  • reference
Hard failover can be used to take a node out of a cluster, when the node has become unresponsive.

HTTP Method and URI

POST /controller/failOver

Description

When a node has become unresponsive, hard failover should be used to take the unresponsive node out of the cluster.

When hard failover is complete, the failed-over node no longer takes part in the work of the Analytics Service, but the node has not yet been fully taken out of the cluster. The cluster is at this point considered to be in a degraded state, in terms of availability, and may lack resources for handling a further node-outage. Rebalance should therefore be performed.

Hard failover should not be used as part of regular, planned maintenance activities that can be conducted with all cluster-nodes available. For information, see Failover.

Curl Syntax

curl -v -X POST -u <username>:<password>
  http://<ip-address-or-hostname>:<port>/controller/failOver
  -d [otpNode=node_1@<hostname>]
  -d allowUnsafe=< true | false >

The value of each specified otpNode parameter must be the name of a node that will be hard-failed over.

The value of allowUnsafe must be either true or false (which is the default); indicating whether or not hard failover should be attempted in unsafe mode. For information, see Failover of Multiple Unresponsive Nodes.

Responses

Success returns 200 OK.

Incorrectly specifying the target cluster returns Failed to connect. Incorrectly specifying the URI returns a 404 Object Not Found error, and a Requested resource not found notification.

Specifying an unknown server to be failed over returns a 400 Bad Request notification, and an error message such as the following: Unknown server given: ["ns_1@10.143.201.106"].

Failure to authenticate returns a 401 Unauthorized notification.

Examples

The following curl statement performs a hard failover of node 10.142.180.102 from a cluster identified as 10.142.180.1.

curl -v -X POST -u Administrator:password \
http://10.142.180.1:8091/controller/failOver \
-d 'otpNode=ns_1@10.142.180.102'

The following performs a hard failover of nodes 10.142.180.102 and 10.142.180.103 from a cluster identified as 10.142.180.1. Note that multi-node failover is always hard failover.

curl -v -X POST -u Administrator:password \
http://10.142.180.1:8091/controller/failOver \
-d 'otpNode=ns_1@10.142.180.102' \
-d 'otpNode=ns_1@10.142.180.103'

The following performs an unsafe, hard failover of nodes 10.142.180.102 and 10.142.180.103 from a cluster identified as 10.142.180.1.

curl -v -X POST -u Administrator:password \
http://10.142.180.1:8091/controller/failOver \
-d otpNode=ns_1%4010.142.180.102\&otpNode=ns_1%4010.142.180.103 \
-d allowUnsafe=true

See Also

For information about managing failover with the UI, CLI, and the REST API, see Fail a Node Over and Rebalance. For information about unsafe hard failover, see Failover of Multiple Unresponsive Nodes. For information about recovering a failed-over node, see Recover a Node and Rebalance.