This API has a deprecated equivalent from v7.0U1.
Undeploy Cluster Task
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}/api/vcenter/vcha/cluster?action=undeploy&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VchaClusterUndeploySpec of mimetype application/json
Required
Contains the undeploy specification for a VCHA cluster.
{
"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"
}
}
}
boolean
force_delete
Optional
Flag controlling in what circumstances the virtual machines will be deleted. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment. - If true, the Cluster.UndeploySpec.vms field will be ignored, the VCHA cluster specific information is removed, and the passive and witness virtual machines will be deleted. - If false, the Cluster.UndeploySpec.vms field contains the information identifying the passive and witness virtual machines.
= If the Cluster.UndeploySpec.vms field is set, then it will be validated prior to deleting the passive and witness virtual machines and VCHA cluster specific information is removed.
= If the Cluster.UndeploySpec.vms field is unset, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
If unset, the Cluster.UndeploySpec.vms field contains the information identifying the passive and witness virtual machines. - If the Cluster.UndeploySpec.vms field is set, then it will be validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed. - If the Cluster.UndeploySpec.vms field is unset, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
vc_spec
Optional
Contains the active node’s management vCenter server credentials. If unset, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
vms
Optional
Contains virtual machine information for the passive and witness virtual machines. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment. If set, the Cluster.UndeploySpec.force-delete field controls whether this information is validated.
- If the Cluster.UndeploySpec.force-delete field is true, then this information is ignored, VCHA cluster specific information is removed and the passive and witness virtual machines will be deleted.
- If the Cluster.UndeploySpec.force-delete field is unset or false, then this information is validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.
If unset, the Cluster.UndeploySpec.force-delete field controls the deletion of the passive and witness virtual machines. - If the Cluster.UndeploySpec.force-delete field is true, then the passive and witness virtual machines will be deleted. VCHA cluster specific information is removed. - If the Cluster.UndeploySpec.force-delete field is unset or false, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
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.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node’s management vCenter server are invalid. | 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.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
404
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VchaConnectionSpec = Initialize-VchaConnectionSpec -Hostname "MyHostname" -Port 0 -SslThumbprint "MySslThumbprint" -Username "MyUsername" -Password "MyPassword"
$VchaCredentialsSpec = Initialize-VchaCredentialsSpec -ActiveLocation $VchaConnectionSpec
$VchaClusterNodeVmInfo = Initialize-VchaClusterNodeVmInfo -Vm "MyVm" -BiosUuid "MyBiosUuid"
$VchaClusterVmInfo = Initialize-VchaClusterVmInfo -Passive $VchaClusterNodeVmInfo -Witness $VchaClusterNodeVmInfo
$VchaClusterUndeploySpec = Initialize-VchaClusterUndeploySpec -VcSpec $VchaCredentialsSpec -ForceDelete $false -Vms $VchaClusterVmInfo
Invoke-UndeployVchaClusterAsync -VchaClusterUndeploySpec $VchaClusterUndeploySpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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}/api/vcenter/vcha/cluster?action=undeploy&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster?action=undeploy&vmw-task=true
x-vmw-doc-operation: undeploy_task
Availability
Added in 7.0U2
