Post Set Failover Mode

Post Set Failover Mode

Valid values are:

  • automatic
  • manual
The entire URL for the task is returned in the Location header of the response.
Refer to taskStatus API's Response Example tab for an example of failover mode task

Request
URI
POST
https://{api_host}/api/1.0.0/nodes/failover/{desired-mode}
COPY
Path Parameters
string
desired-mode
Required

Name of the desired failover mode.

Authentication
This operation uses the following authentication methods.
Responses
202

Response Body is empty. Response includes Location header with URL to related task-id.

Operation doesn't return any data structure

Response Headers

string
Location

Task URL. Example: https://<vcd-appliance-ip>:5480/api/1.0.0/tasks/<task-id>


404

API not applicable for cell-type appliances

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/1.0.0/nodes/failover/{desired-mode}
Availability
Added in 34
On This Page
Failover Mode Operations
POST
Post Set Failover Mode