Post Switchover

Post Switchover

The entire URL for the task is returned in the Location header of the response.

  • Note: The switchover action requires all nodes in the HA cluster to be healthy. Switchover causes the VMware Cloud Director database to be unavailable for 30–60 seconds. To avoid unexpected task failures, quiesce the activity on all cells in the cluster before the switchover.
Refer to taskStatus API's Response Example tab for an example of switchover task
Request
URI
POST
https://{api_host}/api/1.0.0/nodes/{node-name}/switchover
COPY
Path Parameters
string
node-name
Required

name of the node which is being switched from standby to primary role

Authentication
This operation uses the following authentication methods.
Responses
202

Response Body is empty. Response includes Location header with URL to related task-id. Note: cell-type appliance nodes will give this response, but the spawned task will always fail on these nodes.

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>


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/1.0.0/nodes/{node-name}/switchover
Availability
Added in 34
On This Page
Switchover Operations
POST
Post Switchover