REST API - get
  1. Operations
  2. vcenter
  3. vcha
  4. cluster

vcenter vcha cluster: get

Retrieves the status of a VCHA cluster. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

POST https://{server}/rest/vcenter/vcha/cluster?action=get

Request Body Structure:

{
    "vc_spec" : {
        "active_location" : {
            "hostname" : "string",
            "password" : "secret string",
            "port" : 1,
            "ssl_thumbprint" : "string",
            "username" : "string"
        }
    },
    "partial" : true
}

Request Body Parameters:

Name Type Description
bold = required
vc_spec credentials_spec Optional. Contains active node's management vCenter server credentials.
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.
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.
partial boolean Optional. If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "mode" : "ENABLED",
        "witness" : {
            "runtime" : {
                "role" : "ACTIVE",
                "state" : "UP",
                "placement" : {
                    "cluster" : "obj-103",
                    "cluster_name" : "string",
                    "management_network_type" : "STANDARD_PORTGROUP",
                    "datacenter" : "obj-103",
                    "management_network" : "obj-103",
                    "storage" : {
                        "datastore" : "obj-103",
                        "datastore_name" : "string"
                    },
                    "management_vcenter_server_guid" : "string",
                    "ha_network_type" : "STANDARD_PORTGROUP",
                    "management_network_name" : "string",
                    "host" : "obj-103",
                    "management_vcenter_name" : "string",
                    "ha_network" : "obj-103",
                    "ha_network_name" : "string",
                    "vm_name" : "string",
                    "host_name" : "string",
                    "datacenter_name" : "string",
                    "bios_uuid" : "string"
                }
            },
            "ha_ip" : {
                "ip_family" : "IPV4",
                "ipv4" : {
                    "address" : "string",
                    "prefix" : 1,
                    "subnet_mask" : "string"
                },
                "ipv6" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway_ip" : "string"
            }
        },
        "health_state" : "HEALTHY",
        "node2" : {
            "failover_ip" : {
                "ip_family" : "IPV4",
                "ipv4" : {
                    "address" : "string",
                    "prefix" : 1,
                    "subnet_mask" : "string"
                },
                "ipv6" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway_ip" : "string"
            },
            "runtime" : {
                "role" : "ACTIVE",
                "state" : "UP",
                "placement" : {
                    "cluster" : "obj-103",
                    "cluster_name" : "string",
                    "management_network_type" : "STANDARD_PORTGROUP",
                    "datacenter" : "obj-103",
                    "management_network" : "obj-103",
                    "storage" : {
                        "datastore" : "obj-103",
                        "datastore_name" : "string"
                    },
                    "management_vcenter_server_guid" : "string",
                    "ha_network_type" : "STANDARD_PORTGROUP",
                    "management_network_name" : "string",
                    "host" : "obj-103",
                    "management_vcenter_name" : "string",
                    "ha_network" : "obj-103",
                    "ha_network_name" : "string",
                    "vm_name" : "string",
                    "host_name" : "string",
                    "datacenter_name" : "string",
                    "bios_uuid" : "string"
                }
            },
            "ha_ip" : {
                "ip_family" : "IPV4",
                "ipv4" : {
                    "address" : "string",
                    "prefix" : 1,
                    "subnet_mask" : "string"
                },
                "ipv6" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway_ip" : "string"
            }
        },
        "manual_failover_allowed" : true,
        "config_state" : "CONFIGURED",
        "health_exception" : [
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            },
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            }
        ],
        "auto_failover_allowed" : true,
        "node1" : {
            "failover_ip" : {
                "ip_family" : "IPV4",
                "ipv4" : {
                    "address" : "string",
                    "prefix" : 1,
                    "subnet_mask" : "string"
                },
                "ipv6" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway_ip" : "string"
            },
            "runtime" : {
                "role" : "ACTIVE",
                "state" : "UP",
                "placement" : {
                    "cluster" : "obj-103",
                    "cluster_name" : "string",
                    "management_network_type" : "STANDARD_PORTGROUP",
                    "datacenter" : "obj-103",
                    "management_network" : "obj-103",
                    "storage" : {
                        "datastore" : "obj-103",
                        "datastore_name" : "string"
                    },
                    "management_vcenter_server_guid" : "string",
                    "ha_network_type" : "STANDARD_PORTGROUP",
                    "management_network_name" : "string",
                    "host" : "obj-103",
                    "management_vcenter_name" : "string",
                    "ha_network" : "obj-103",
                    "ha_network_name" : "string",
                    "vm_name" : "string",
                    "host_name" : "string",
                    "datacenter_name" : "string",
                    "bios_uuid" : "string"
                }
            },
            "ha_ip" : {
                "ip_family" : "IPV4",
                "ipv4" : {
                    "address" : "string",
                    "prefix" : 1,
                    "subnet_mask" : "string"
                },
                "ipv6" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway_ip" : "string"
            }
        },
        "health_warnings" : [
            {
                "recommendation" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "error" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                }
            },
            {
                "recommendation" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "error" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                }
            }
        ]
    }
}

Response Type:

Name Type Description
bold = required
value info Info structure containing the VCHA configuration and health information.
value.config_state string Configuration state of the VCHA cluster.
The active node's management vCenter server credentials are not required to populate this field. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable.
value.node1 node_info Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable.
value.node1.failover_ip ip_info Failover IP address that this node will assume after the failover to serve client requests. Each failover node can have a different failover IP address.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_info.failover_ip. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then it will assume the public IP address of the Active vCenter Server.
value.node1.failover_ip.ip_family string Family of the ip. 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.
value.node1.failover_ip.ipv4 ipv4_info If the type of the ip family 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.
value.node1.failover_ip.ipv4.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node1.failover_ip.ipv4.subnet_mask string The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
value.node1.failover_ip.ipv4.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset , then the subnet mask is invalid.
value.node1.failover_ip.ipv6 ipv6_info If the type of the ip family 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.
value.node1.failover_ip.ipv6.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node1.failover_ip.ipv6.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.
value.node1.failover_ip.gateway_ip string Gateway IP address. This attribute was added in vSphere API 6.7.1.

Optional. If unset, no gateway is specified.
value.node1.ha_ip ip_info VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network.
The active node's management vCenter server credentials are not required to populate this vcenter.vcha.cluster.node_info.ha_ip. This attribute was added in vSphere API 6.7.1.
value.node1.ha_ip.ip_family string Family of the ip. 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.
value.node1.ha_ip.ipv4 ipv4_info If the type of the ip family 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.
value.node1.ha_ip.ipv4.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node1.ha_ip.ipv4.subnet_mask string The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
value.node1.ha_ip.ipv4.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset , then the subnet mask is invalid.
value.node1.ha_ip.ipv6 ipv6_info If the type of the ip family 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.
value.node1.ha_ip.ipv6.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node1.ha_ip.ipv6.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.
value.node1.ha_ip.gateway_ip string Gateway IP address. This attribute was added in vSphere API 6.7.1.

Optional. If unset, no gateway is specified.
value.node1.runtime node_runtime_info Runtime information for the node in the VCHA Cluster.
The active node's management vCenter server credentials are required to populate some fields of vcenter.vcha.cluster.node_info.runtime. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet.
value.node1.runtime.state string Last known state of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.state. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.node1.runtime.role string Last known role of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.role. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.node1.runtime.placement placement_info Placement information of the node.
The active node's management vCenter server credentials are required to populate most fields of vcenter.vcha.cluster.node_runtime_info.placement. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet or the VCHA cluster was deployed in a manual fashion.
value.node1.runtime.placement.management_vcenter_name string The hostname of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.management_vcenter_server_guid string The unique identifier of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 7.0.0.1.

Optional. This field is optional because it was added in a newer version than its parent node.
value.node1.runtime.placement.vm_name string The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.datacenter string The identifier of the datacenter 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: Datacenter:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter:VCenter.
value.node1.runtime.placement.datacenter_name string The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.host string The identifier of the host 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: 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.
value.node1.runtime.placement.host_name string The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.cluster string The identifier of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource:VCenter.
value.node1.runtime.placement.cluster_name string The name of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.
value.node1.runtime.placement.ha_network string The identifier of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.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.
value.node1.runtime.placement.ha_network_name string The name of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.node1.runtime.placement.ha_network_type string The type of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.node1.runtime.placement.management_network string The identifier of the Network object used for the Management network. 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: 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.
value.node1.runtime.placement.management_network_name string The name of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.management_network_type string The type of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.

Defines the type of a vCenter Server network. This enumeration was added in vSphere API 6.7.1. Value is one of:
STANDARD_PORTGROUP: vSphere standard portgroup network. This constant was added in vSphere API 6.7.1.
DISTRIBUTED_PORTGROUP: Distributed virtual switch. This constant was added in vSphere API 6.7.1.
value.node1.runtime.placement.storage disk_info The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.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.

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.
value.node1.runtime.placement.storage.datastore_name string The name of the datastore. This attribute was added in vSphere API 6.7.1.
value.node1.runtime.placement.bios_uuid string BIOS UUID for the node. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable.
value.node2 node_info Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the node is not cloned yet.
value.node2.failover_ip ip_info Failover IP address that this node will assume after the failover to serve client requests. Each failover node can have a different failover IP address.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_info.failover_ip. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then it will assume the public IP address of the Active vCenter Server.
value.node2.failover_ip.ip_family string Family of the ip. 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.
value.node2.failover_ip.ipv4 ipv4_info If the type of the ip family 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.
value.node2.failover_ip.ipv4.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node2.failover_ip.ipv4.subnet_mask string The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
value.node2.failover_ip.ipv4.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset , then the subnet mask is invalid.
value.node2.failover_ip.ipv6 ipv6_info If the type of the ip family 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.
value.node2.failover_ip.ipv6.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node2.failover_ip.ipv6.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.
value.node2.failover_ip.gateway_ip string Gateway IP address. This attribute was added in vSphere API 6.7.1.

Optional. If unset, no gateway is specified.
value.node2.ha_ip ip_info VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network.
The active node's management vCenter server credentials are not required to populate this vcenter.vcha.cluster.node_info.ha_ip. This attribute was added in vSphere API 6.7.1.
value.node2.ha_ip.ip_family string Family of the ip. 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.
value.node2.ha_ip.ipv4 ipv4_info If the type of the ip family 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.
value.node2.ha_ip.ipv4.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node2.ha_ip.ipv4.subnet_mask string The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
value.node2.ha_ip.ipv4.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset , then the subnet mask is invalid.
value.node2.ha_ip.ipv6 ipv6_info If the type of the ip family 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.
value.node2.ha_ip.ipv6.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.node2.ha_ip.ipv6.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.
value.node2.ha_ip.gateway_ip string Gateway IP address. This attribute was added in vSphere API 6.7.1.

Optional. If unset, no gateway is specified.
value.node2.runtime node_runtime_info Runtime information for the node in the VCHA Cluster.
The active node's management vCenter server credentials are required to populate some fields of vcenter.vcha.cluster.node_info.runtime. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet.
value.node2.runtime.state string Last known state of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.state. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.node2.runtime.role string Last known role of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.role. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.node2.runtime.placement placement_info Placement information of the node.
The active node's management vCenter server credentials are required to populate most fields of vcenter.vcha.cluster.node_runtime_info.placement. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet or the VCHA cluster was deployed in a manual fashion.
value.node2.runtime.placement.management_vcenter_name string The hostname of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.management_vcenter_server_guid string The unique identifier of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 7.0.0.1.

Optional. This field is optional because it was added in a newer version than its parent node.
value.node2.runtime.placement.vm_name string The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.datacenter string The identifier of the datacenter 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: Datacenter:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter:VCenter.
value.node2.runtime.placement.datacenter_name string The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.host string The identifier of the host 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: 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.
value.node2.runtime.placement.host_name string The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.cluster string The identifier of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource:VCenter.
value.node2.runtime.placement.cluster_name string The name of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.
value.node2.runtime.placement.ha_network string The identifier of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.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.
value.node2.runtime.placement.ha_network_name string The name of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.node2.runtime.placement.ha_network_type string The type of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.node2.runtime.placement.management_network string The identifier of the Network object used for the Management network. 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: 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.
value.node2.runtime.placement.management_network_name string The name of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.management_network_type string The type of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.

Defines the type of a vCenter Server network. This enumeration was added in vSphere API 6.7.1. Value is one of:
STANDARD_PORTGROUP: vSphere standard portgroup network. This constant was added in vSphere API 6.7.1.
DISTRIBUTED_PORTGROUP: Distributed virtual switch. This constant was added in vSphere API 6.7.1.
value.node2.runtime.placement.storage disk_info The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.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.

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.
value.node2.runtime.placement.storage.datastore_name string The name of the datastore. This attribute was added in vSphere API 6.7.1.
value.node2.runtime.placement.bios_uuid string BIOS UUID for the node. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable.
value.witness witness_info Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the node is not cloned yet.
value.witness.ha_ip ip_info VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.witness_info.ha_ip. This attribute was added in vSphere API 6.7.1.
value.witness.ha_ip.ip_family string Family of the ip. 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.
value.witness.ha_ip.ipv4 ipv4_info If the type of the ip family 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.
value.witness.ha_ip.ipv4.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.witness.ha_ip.ipv4.subnet_mask string The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
value.witness.ha_ip.ipv4.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

Optional. If unset , then the subnet mask is invalid.
value.witness.ha_ip.ipv6 ipv6_info If the type of the ip family 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.
value.witness.ha_ip.ipv6.address string IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
value.witness.ha_ip.ipv6.prefix long The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.
value.witness.ha_ip.gateway_ip string Gateway IP address. This attribute was added in vSphere API 6.7.1.

Optional. If unset, no gateway is specified.
value.witness.runtime node_runtime_info Runtime information for the node in the VCHA Cluster.
The active node's management vCenter server credentials are required to populate some fields of vcenter.vcha.cluster.witness_info.runtime. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the node is not cloned yet.
value.witness.runtime.state string Last known state of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.state. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.witness.runtime.role string Last known role of the node.
The active node's management vCenter server credentials are not required to populate vcenter.vcha.cluster.node_runtime_info.role. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then information is unavailable or the passive and witness nodes are not cloned yet.
value.witness.runtime.placement placement_info Placement information of the node.
The active node's management vCenter server credentials are required to populate most fields of vcenter.vcha.cluster.node_runtime_info.placement. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet or the VCHA cluster was deployed in a manual fashion.
value.witness.runtime.placement.management_vcenter_name string The hostname of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.management_vcenter_server_guid string The unique identifier of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 7.0.0.1.

Optional. This field is optional because it was added in a newer version than its parent node.
value.witness.runtime.placement.vm_name string The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.datacenter string The identifier of the datacenter 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: Datacenter:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter:VCenter.
value.witness.runtime.placement.datacenter_name string The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.host string The identifier of the host 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: 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.
value.witness.runtime.placement.host_name string The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.cluster string The identifier of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource:VCenter.
value.witness.runtime.placement.cluster_name string The name of the cluster of which host is member. This attribute was added in vSphere API 6.7.1.

Optional. If unset, host is a standalone host.
value.witness.runtime.placement.ha_network string The identifier of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.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.
value.witness.runtime.placement.ha_network_name string The name of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.witness.runtime.placement.ha_network_type string The type of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
value.witness.runtime.placement.management_network string The identifier of the Network object used for the Management network. 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: 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.
value.witness.runtime.placement.management_network_name string The name of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.management_network_type string The type of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.

Defines the type of a vCenter Server network. This enumeration was added in vSphere API 6.7.1. Value is one of:
STANDARD_PORTGROUP: vSphere standard portgroup network. This constant was added in vSphere API 6.7.1.
DISTRIBUTED_PORTGROUP: Distributed virtual switch. This constant was added in vSphere API 6.7.1.
value.witness.runtime.placement.storage disk_info The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.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.

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.
value.witness.runtime.placement.storage.datastore_name string The name of the datastore. This attribute was added in vSphere API 6.7.1.
value.witness.runtime.placement.bios_uuid string BIOS UUID for the node. This attribute was added in vSphere API 6.7.1.

Optional. If unset, the information is currently unavailable.
value.mode string Operational mode of the VCHA Cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the node is not cloned yet.
value.health_state string Last known state of the VCHA Cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the information is unavailable or the node is not cloned yet.
value.health_exception localizable_message[] Health warning messages if the health information is unavailable. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the cluster is in a healthy state.
value.health_warnings error_condition[] A collection of messages describing the reason for a non-healthy Cluster. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the cluster is in a healthy state.
value.manual_failover_allowed boolean Specifies if manual failover is allowed. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.
value.auto_failover_allowed boolean Specifies if automatic failover is allowed. This attribute was added in vSphere API 6.7.1.

Optional. If unset, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.

Errors:

HTTP Status Code Type Description
400 invalid_argument If the credentials provided for authenticating with the active node's management vCenter server are invalid.
403 unauthorized If the user has insufficient privilege to perform the operation.
  • If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
  • If partial is true, then the operation execution requires the System.Read 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.