REST API - get

vcenter vcha cluster active: get

Retrieves information about the active node of a VCHA cluster. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

POST https://{server}/rest/vcenter/vcha/cluster/active?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" : {
        "management" : {
            "ip_family" : "IPV4",
            "default_gateway" : "string",
            "ipv4" : {
                "address" : "string",
                "prefix" : 1,
                "subnet_mask" : "string"
            },
            "ipv6" : {
                "address" : "string",
                "prefix" : 1
            },
            "dns_servers" : [
                "string",
                "string"
            ]
        },
        "ha" : {
            "ip_family" : "IPV4",
            "default_gateway" : "string",
            "ipv4" : {
                "address" : "string",
                "prefix" : 1,
                "subnet_mask" : "string"
            },
            "ipv6" : {
                "address" : "string",
                "prefix" : 1
            },
            "dns_servers" : [
                "string",
                "string"
            ]
        },
        "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"
        }
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Info Information about the VCHA network and placement of the active node.
value.management	ip_spec	IP specification for the Management network. This attribute was added in vSphere API 6.7.1.
value.management.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.
value.management.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.
value.management.ipv4.address	string	IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
value.management.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.
value.management.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.
value.management.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.
value.management.ipv6.address	string	IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
value.management.ipv6.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.
value.management.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.
value.management.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.
value.ha	ip_spec	IP specification for the HA network. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the second NIC of the Active Node of the VCHA cluster is not configured.
value.ha.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.
value.ha.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.
value.ha.ipv4.address	string	IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
value.ha.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.
value.ha.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.
value.ha.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.
value.ha.ipv6.address	string	IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
value.ha.ipv6.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.
value.ha.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.
value.ha.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.
value.placement	placement_info	Contains the placement information of the active node. This attribute was added in vSphere API 6.7.1. Optional. If unset, the request specified that placement information of the active node should not be included.
value.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.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.placement.vm_name	string	The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.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.placement.datacenter_name	string	The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.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.placement.host_name	string	The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.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.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.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.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.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.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.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.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.placement.storage	disk_info	The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
value.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.placement.storage.datastore_name	string	The name of the datastore. This attribute was added in vSphere API 6.7.1.
value.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.

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. 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.
400	invalid_element_configuration	If the active node is on more than one datastore.
404	not_found	If the active virtual machine is not managed by the specified vCenter server for the active node.
500	error	If the management interface IP address assignment is not static.