vcenter vcha cluster: node info
The
node_info structure defines the configuration information for the active and passive nodes in the cluster. This structure was added in vSphere API 6.7.1.Representation:
{
"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"
}
}
"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"
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| 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. |
| failover_ip.ipv4.address | string | IP address of the configured network interface. This attribute was added in vSphere API 6.7.1. |
| failover_ip.ipv4.subnet_mask | string | The subnet mask of the interface. This attribute was added in vSphere API 6.7.1. |
| failover_ip.ipv6.address | string | IP address of the configured network interface. This attribute was added in vSphere API 6.7.1. |
| failover_ip.ipv6.prefix | long | The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1. |
| 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. |
| 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. |
| ha_ip.ipv4.address | string | IP address of the configured network interface. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ipv4.subnet_mask | string | The subnet mask of the interface. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ipv6.address | string | IP address of the configured network interface. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ipv6.prefix | long | The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1. |
| 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. |
| runtime.placement.vm_name | string | The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| runtime.placement.datacenter_name | string | The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| runtime.placement.host_name | string | The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| 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. |
| 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. |
| runtime.placement.storage | disk_info | The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| runtime.placement.storage.datastore_name | string | The name of the datastore. This attribute was added in vSphere API 6.7.1. |
| Optional | ||
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |