vcenter vcha cluster: undeploy spec
The
undeploy_spec structure contains the undeploy specification for a VCHA cluster. This structure was added in vSphere API 6.7.1.Representation:
{
"vc_spec" : {
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
},
"force_delete" : true,
"vms" : {
"witness" : {
"vm" : "obj-103",
"bios_uuid" : "string"
},
"passive" : {
"vm" : "obj-103",
"bios_uuid" : "string"
}
}
}
"vc_spec" : {
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
},
"force_delete" : true,
"vms" : {
"witness" : {
"vm" : "obj-103",
"bios_uuid" : "string"
},
"passive" : {
"vm" : "obj-103",
"bios_uuid" : "string"
}
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| vc_spec.active_location | connection_spec | Connection information for the management vCenter Server of the Active Node in a VCHA Cluster. This attribute was added in vSphere API 6.7.1. |
| vc_spec.active_location.hostname | string | IP Address or DNS of the vCenter. This attribute was added in vSphere API 6.7.1. |
| vms.passive | node_vm_info | The virtual machine information of the passive node. This attribute was added in vSphere API 6.7.1. |
| vms.passive.vm | string | The identifier of the virtual machine of the VCHA node. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine:VCenter. |
| vms.passive.bios_uuid | string | BIOS UUID for the node. This attribute was added in vSphere API 6.7.1. |
| vms.witness | node_vm_info | The virtual machine information of the witness node. This attribute was added in vSphere API 6.7.1. |
| vms.witness.vm | string | The identifier of the virtual machine of the VCHA node. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine:VCenter. |
| vms.witness.bios_uuid | string | BIOS UUID for the node. This attribute was added in vSphere API 6.7.1. |
| Optional | ||
| vc_spec | credentials_spec | Contains the active node's management vCenter server credentials. This attribute was added in vSphere API 6.7.1. Optional. 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. |
| vc_spec.active_location.port | long | Port number. This attribute was added in vSphere API 6.7.1. Optional. If unset, port 443 will be used. |
| vc_spec.active_location.ssl_thumbprint | string | SHA1 hash of the server SSL certificate. This attribute was added in vSphere API 6.7.1. Optional. If unset, empty ssl thumbprint is assumed. |
| vc_spec.active_location.username | string | Username to access the server. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an error is returned. In the future, if this field is unset, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail. |
| vc_spec.active_location.password | secret | Password for the specified user. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an empty password is assumed. In the future, if this field is unset, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail. |
| force_delete | boolean | 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.
|
| vms | vm_info | 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.undeploy_spec.force_delete field controls whether this information is validated.
|