VchaClusterInfo

The Cluster.Info structure contains the configuration and health information of the three nodes in a VCHA Cluster.


Properties

boolean
auto_failover_allowed Optional

Specifies if automatic failover is allowed. If unset, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.


config_state Optional

The Cluster.ConfigState enumerated type defines the VCHA configuration state.
CONFIGURED : VCHA cluster is configured.
NOTCONFIGURED : VCHA cluster is not configured.
INVALID : VCHA cluster is in an invalid/dirty state.
PREPARED : vCenter server appliance has been prepared for VCHA cluster configuration.

Possible values are: CONFIGUREDNOTCONFIGUREDINVALIDPREPARED


health_exception Optional

Health warning messages if the health information is unavailable. If unset, then the cluster is in a healthy state.


health_state Optional

The Cluster.ClusterState enumerated type defines the possible for a VCHA Cluster.
HEALTHY : All three nodes in a VCHA Cluster are healthy and connected. State replication between Active and Passive node is working and both nodes are in sync.
DEGRADED : A VCHA Cluster is said to be in a degraded state for either or all of the following reasons: - There is a node loss. - State replication between the Active and Passive node fails.
ISOLATED : All three nodes are isolated from each other.

Possible values are: HEALTHYDEGRADEDISOLATED


health_warnings Optional

A collection of messages describing the reason for a non-healthy Cluster. If unset, then the cluster is in a healthy state.


boolean
manual_failover_allowed Optional

Specifies if manual failover is allowed. If unset, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.


mode Optional

The Cluster.ClusterMode enumerated type defines the possible modes for a VCHA Cluster.
ENABLED : VCHA Cluster is enabled. State replication between the Active and Passive node is enabled and automatic failover is allowed.
DISABLED : VCHA Cluster is disabled. State replication between the Active and Passive node is disabled and automatic failover is not allowed.
MAINTENANCE : VCHA Cluster is in maintenance mode. State replication between the Active and Passive node is enabled but automatic failover is not allowed.

Possible values are: ENABLEDDISABLEDMAINTENANCE


node1 Optional

Node configuration information for the VCHA cluster. If unset, then the information is unavailable.


node2 Optional

Node configuration information for the VCHA cluster. If unset, then the information is unavailable or the node is not cloned yet.


witness Optional

Node configuration information for the VCHA cluster. If unset, then the information is unavailable or the node is not cloned yet.

JSON Example

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

Feedback

Was this page helpful?