REST API - redeploy-task
  1. Operations
  2. vcenter
  3. vcha
  4. cluster
  5. witness

vcenter vcha cluster witness: redeploy-task

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

POST https://{server}/rest/vcenter/vcha/cluster/witness?vmw-task=true&action=redeploy

Request Body Structure:

{
    "spec" : {
        "vc_spec" : {
            "active_location" : {
                "hostname" : "string",
                "password" : "secret string",
                "port" : 1,
                "ssl_thumbprint" : "string",
                "username" : "string"
            }
        },
        "ha_ip" : {
            "ip_family" : "IPV4",
            "default_gateway" : "string",
            "ipv4" : {
                "address" : "string",
                "prefix" : 1,
                "subnet_mask" : "string"
            },
            "ipv6" : {
                "address" : "string",
                "prefix" : 1
            },
            "dns_servers" : [
                "string",
                "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"
        }
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec redeploy_spec Contains the witness node's redeploy specification.
spec.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.
spec.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.
spec.vc_spec.active_location.hostname string IP Address or DNS of the vCenter. This attribute was added in vSphere API 6.7.1.
spec.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.
spec.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.
spec.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.
spec.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.
spec.placement placement_spec Contains the node's placement information. This attribute was added in vSphere API 6.7.1.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.ha_ip ip_spec Contains the VCHA HA network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the stored network configuration for the VCHA HA network for the witness node will be used.
spec.ha_ip.ip_family string Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1.

Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of:
IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1.
IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1.
spec.ha_ip.ipv4 ipv4_spec If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1.

Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4.
spec.ha_ip.ipv4.address string IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
spec.ha_ip.ipv4.subnet_mask string The subnet mask for the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the prefix field is unset, then an error will be reported.
If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.
If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported.
spec.ha_ip.ipv4.prefix long The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset and the subnet_mask field is unset, this an error will be reported.
If unset and the subnet_mask field is set, then the subnet_mask field will be used.
If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported.
spec.ha_ip.ipv6 ipv6_spec If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1.

Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6.
spec.ha_ip.ipv6.address string IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
spec.ha_ip.ipv6.prefix long The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.
spec.ha_ip.default_gateway string The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset, gateway will not be used for the network interface.
spec.ha_ip.dns_servers string[] The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1.

Optional. If unset, DNS servers will not be used for the network interface.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : "obj-103"
}

Response Type:

Name Type Description
bold = required
value string

Errors:

HTTP Status Code Type Description
400 invalid_argument If the credentials provided for authentincating with the active node's management vCenter server are invalid.
403 unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
400 unverified_peer If the SSL certificate of the management vCenter server cannot be validated.
The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in vcenter.vcha.certificate_info.
500 error If any other error occurs.