1. Types
  2. vcenter
  3. vcha
  4. cluster
  5. witness

vcenter vcha cluster witness: check spec

The check_spec structure contains placement information for validation. 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"
        }
    },
    "placement" : {
        "ha_network_type" : "STANDARD_PORTGROUP",
        "folder" : "obj-103",
        "name" : "string",
        "host" : "obj-103",
        "management_network_type" : "STANDARD_PORTGROUP",
        "management_network" : "obj-103",
        "storage" : {
            "datastore" : "obj-103"
        },
        "resource_pool" : "obj-103",
        "ha_network" : "obj-103"
    }
}

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.
placement placement_spec Contains the node's placement information for validation. This attribute was added in vSphere API 6.7.1.
placement.name string The name of the VCHA node to be used for the virtual machine name. This attribute was added in vSphere API 6.7.1.
placement.folder string The identifier of the folder to deploy the VCHA node to. 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: Folder:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder:VCenter.
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.
placement.host string The identifier of the host to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1.

Optional. If unset, see vim.vm.RelocateSpec.host.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem:VCenter.
placement.resource_pool string The identifier of the resource pool to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the active node's resource pool will be used.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool:VCenter.
placement.ha_network_type string The type of the Network object used by the HA network.
If the vcenter.vcha.placement_spec.ha_network field is set, then the vcenter.vcha.placement_spec.ha_network_type field must be set.
If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the vcenter.vcha.placement_spec.ha_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If unset and the vcenter.vcha.placement_spec.ha_network field is set, then an error is reported.
placement.ha_network string The identifier of the Network object used for the HA network.
If the vcenter.vcha.placement_spec.ha_network field is set, then the {#link #haNetworkType} field must be set.
If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the vcenter.vcha.placement_spec.ha_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network:VCenter.
placement.management_network_type string The type of the Network object used by the Management network.
If the vcenter.vcha.placement_spec.management_network field is set, then the {#link #managementNetworkType} field must be set.
If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the vcenter.vcha.placement_spec.management_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If unset and the vcenter.vcha.placement_spec.management_network field is set, then an error is reported.
placement.management_network string The identifier of the Network object used for the Management network. If the vcenter.vcha.placement_spec.management_network field is set, then the vcenter.vcha.placement_spec.management_network_type field must be set.
If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the vcenter.vcha.placement_spec.management_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network:VCenter.
placement.storage disk_spec The storage specification to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1.

Optional. If unset, see vim.vm.RelocateSpec.datastore.
placement.storage.datastore string The identifier of the datastore to put all the virtual disks on. This attribute was added in vSphere API 6.7.1.

Optional. This field needs to be set. If unset, then see vim.vm.RelocateSpec.datastore.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datastore:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datastore:VCenter.