Vcenter Vcha Cluster undeploy$Task

Vcenter Vcha Cluster undeploy$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.

This operation was added in vSphere API 6.7.1.

Request
URI
POST
https://{api_host}/api/vcenter/vcha/cluster?action=undeploy&vmw-task=true
COPY
Request Body

Contains the undeploy specification for a VCHA cluster.

Vcenter Vcha Cluster UndeploySpec of type(s) application/json
Required 
{
    "vc_spec": {
        "active_location": {
            "hostname": "string",
            "port": 0,
            "ssl_thumbprint": "string",
            "ssl_certificate": "string",
            "username": "string",
            "password": "string"
        }
    },
    "force_delete": false,
    "vms": {
        "passive": {
            "vm": "string",
            "bios_uuid": "string"
        },
        "witness": {
            "vm": "string",
            "bios_uuid": "string"
        }
    }
}
vc_spec
Optional

Contains the active node's management vCenter server credentials.

This property was added in vSphere API 6.7.1.

If missing or null, 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.

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 Vcenter Vcha Cluster UndeploySpec.vms property will be ignored, the VCHA cluster specific information is removed, and the passive and witness virtual machines will be deleted.
  • If false, the Vcenter Vcha Cluster UndeploySpec.vms property contains the information identifying the passive and witness virtual machines.
 -  If the *Vcenter Vcha Cluster UndeploySpec.vms* property 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 *Vcenter Vcha Cluster UndeploySpec.vms* property is missing or `null`, 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.

This property was added in vSphere API 6.7.1.

If missing or null, the Vcenter Vcha Cluster UndeploySpec.vms property contains the information identifying the passive and witness virtual machines.

  • If the Vcenter Vcha Cluster UndeploySpec.vms property is set, then it will be validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.
  • If the Vcenter Vcha Cluster UndeploySpec.vms property is missing or null, 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.
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 Vcenter Vcha Cluster UndeploySpec.force_delete property controls whether this information is validated.

  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property 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 Vcenter Vcha Cluster UndeploySpec.force_delete property is missing or null or false, then this information is validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.

This property was added in vSphere API 6.7.1.

If missing or null, the Vcenter Vcha Cluster UndeploySpec.force_delete property controls the deletion of the passive and witness virtual machines.

  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is true, then the passive and witness virtual machines will be deleted. VCHA cluster specific information is removed.
  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is missing or null 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.
Responses
202

Success!

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument If the credentials provided for authenticating with the active node's management vCenter server are invalid.

Vapi Std Errors UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Vapi Std Errors Error will be a schema that contains all the properties defined in Vcenter Vcha CertificateInfo.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


403

If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

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.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

If any other error occurs.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/vcha/cluster?action=undeploy&vmw-task=true
On This Page
Vcenter Operations
POST
Vcenter Vcha Cluster get
POST
Vcenter Vcha Cluster deploy$Task
POST
Vcenter Vcha Cluster failover$Task
POST
Vcenter Vcha Cluster undeploy$Task