Developer Documentation
Undeploy Task Cluster
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
https://{api_host}/rest/vcenter/vcha/cluster?action=undeploy&vmw-task=true
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=undeploy |
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Request Body
Request Body
Contains
UndeploytaskRequestBody
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 | ClusterUndeploySpec |
Contains the undeploy specification for a VCHA cluster. |
Response
Response
Response BodyResponse Body
200 OK returns
UndeployTaskResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains:
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string | Not available |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node's management vCenter server are invalid. |
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege. |
| 403 | Error | 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. |
| 404 | Error | 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 | Error | Not available |
