vcenter vcha cluster active: info
The
info structure contains the network and placement information of the active node of a VCHA Cluster. This structure was added in vSphere API 6.7.1.Representation:
{
"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"
}
}
"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"
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| management | ip_spec | IP specification for the Management network. This attribute was added in vSphere API 6.7.1. |
| 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. |
| management.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| management.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| management.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| 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. |
| ha.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| ha.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| ha.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| 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. |
| placement.vm_name | string | The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| placement.datacenter_name | string | The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| placement.host_name | string | The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| 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. |
| 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. |
| placement.storage | disk_info | The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1. |
| 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. |
| placement.storage.datastore_name | string | The name of the datastore. This attribute was added in vSphere API 6.7.1. |
| Optional | ||
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |