Undeploy Cluster Task
Released in v6.7.1Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed. If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.
Request
URLURL
Header Parameters
Header Parameters
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
VchaClusterUndeploytaskRequestBody of type application/json (required){
"spec": {
"force_delete": false,
"vc_spec": {
"active_location": {
"hostname": "string",
"password": "string",
"port": 0,
"ssl_thumbprint": "string",
"username": "string"
}
},
"vms": {
"passive": {
"bios_uuid": "string",
"vm": "string"
},
"witness": {
"bios_uuid": "string",
"vm": "string"
}
}
}
}
Response
Response BodyResponse Body
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
{
"value": "string"
}
Identifier for the task created by this API invocation.