Vcha_Cluster_UndeploySpec

Vcha_Cluster_UndeploySpec
Vcha_Cluster_UndeploySpec

The Cluster.UndeploySpec structure contains the undeploy specification for a VCHA cluster.

JSON Example 
{
    "vc_spec": {
        "active_location": {
            "hostname": "string",
            "port": 0,
            "ssl_thumbprint": "string",
            "username": "string",
            "password": "string"
        }
    },
    "force_delete": false,
    "vms": {
        "passive": {
            "vm": "string",
            "bios_uuid": "string"
        },
        "witness": {
            "vm": "string",
            "bios_uuid": "string"
        }
    }
}
Vcha_CredentialsSpec
vc_spec
Optional

The CredentialsSpec structure contains information to connect to the vCenter server managing the VCHA nodes.

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.
Vcha_Cluster_VmInfo
vms
Optional

The Cluster.VmInfo structure contains information to describe the Virtual Machines of passive and witness nodes of a VCHA cluster.

Parameter To