Undeploy Task Cluster
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Destroys 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
https://{api_host}/rest/vcenter/vcha/cluster?action=undeploy&vmw-task=true
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains 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"
}
}
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VchaClusterUndeploySpec |
Contains the undeploy specification for a VCHA cluster. |
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterUndeployTaskResponseBody
of type application/json
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"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Identifier for the task created by this API invocation. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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"}}}}' https://{api_host}/rest/vcenter/vcha/cluster?action=undeploy&vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : If the passive virtual machine is not managed by the specified vCenter server. If the witness virtual machine is not managed by the specified vCenter server. | com.vmware.vapi.std.errors.error : If any other error occurs. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node's management vCenter server are invalid. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege. |
| 403 | ErrorRest | com.vmware.vapi.std.errors.unverified_peer : If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of Error will be a structure that contains all the fields defined in CertificateInfo. |
