vcenter vcha cluster: active spec
The
active_spec structure contains the deploy specification for the Active Node of the VCHA cluster. This structure was added in vSphere API 6.7.1.Representation:
{
"ha_network_type" : "STANDARD_PORTGROUP",
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_network" : "obj-103"
}
"ha_network_type" : "STANDARD_PORTGROUP",
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_network" : "obj-103"
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| ha_ip | ip_spec | IP specification for the HA network. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ip_family | string | Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1. |
| ha_ip.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| ha_ip.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| Optional | ||
| ha_network_type | string | The type of the Network object used by the HA network. If the vcenter.vcha.cluster.active_spec.ha_network field is set, then the vcenter.vcha.cluster.active_spec.ha_network_type field must be set. If the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the vcenter.vcha.cluster.active_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the second NIC is assumed to be already configured. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is set, then an error is reported. |
| ha_network | string | The identifier of the Network object used for the HA network. If the vcenter.vcha.cluster.active_spec.ha_network field is set, then the vcenter.vcha.cluster.active_spec.ha_network_type field must be set. If the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the vcenter.vcha.cluster.active_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.cluster.active_spec.ha_network_type field is unset, then the second NIC is assumed to be already configured. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is set, then an error is reported.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. |
| ha_ip.ipv4 | ipv4_spec | If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4. |
| ha_ip.ipv4.subnet_mask | string | The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the prefix field is unset, then an error will be reported.If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| ha_ip.ipv4.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the subnet_mask field is unset, this an error will be reported.If unset and the subnet_mask field is set, then the subnet_mask field will be used.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| ha_ip.ipv6 | ipv6_spec | If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6. |
| ha_ip.default_gateway | string | The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface. |
| ha_ip.dns_servers | string[] | The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface. |