VchaClusterInfo

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


Properties

Required Property Name Type Description
optional auto_failover_allowed boolean

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

optional config_state VchaClusterConfigState Enum

Configuration state of the VCHA cluster. The active node’s management vCenter server credentials are not required to populate this field. If unset, then the information is unavailable.

optional health_exception array of StdLocalizableMessage

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

optional health_state VchaClusterClusterState Enum

Last known state of the VCHA Cluster. If unset, then the information is unavailable or the node is not cloned yet.

optional health_warnings array of VchaClusterErrorCondition

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

optional manual_failover_allowed boolean

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

optional mode VchaClusterClusterMode Enum

Operational mode of the VCHA Cluster. If unset, then the information is unavailable or the node is not cloned yet.

optional node1 VchaClusterNodeInfo

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

optional node2 VchaClusterNodeInfo

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

optional witness VchaClusterWitnessInfo

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": "enum",
    "health_state": "enum",
    "health_warnings": [
        {}
    ],
    "manual_failover_allowed": false,
    "mode": "enum",
    "node1": {
        "failover_ip": {
            "gateway_ip": "string",
            "ip_family": "enum",
            "ipv4": {
                "address": "string",
                "prefix": 0,
                "subnet_mask": "string"
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            }
        },
        "ha_ip": {
            "gateway_ip": "string",
            "ip_family": "enum",
            "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": "enum",
                "host": "string",
                "host_name": "string",
                "management_network": "string",
                "management_network_name": "string",
                "management_network_type": "enum",
                "management_vcenter_name": "string",
                "management_vcenter_server_guid": "string",
                "storage": {
                    "datastore": "string",
                    "datastore_name": "string"
                },
                "vm_name": "string"
            },
            "role": "enum",
            "state": "enum"
        }
    },
    "node2": {
        "failover_ip": {
            "gateway_ip": "string",
            "ip_family": "enum",
            "ipv4": {
                "address": "string",
                "prefix": 0,
                "subnet_mask": "string"
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            }
        },
        "ha_ip": {
            "gateway_ip": "string",
            "ip_family": "enum",
            "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": "enum",
                "host": "string",
                "host_name": "string",
                "management_network": "string",
                "management_network_name": "string",
                "management_network_type": "enum",
                "management_vcenter_name": "string",
                "management_vcenter_server_guid": "string",
                "storage": {
                    "datastore": "string",
                    "datastore_name": "string"
                },
                "vm_name": "string"
            },
            "role": "enum",
            "state": "enum"
        }
    },
    "witness": {
        "ha_ip": {
            "gateway_ip": "string",
            "ip_family": "enum",
            "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": "enum",
                "host": "string",
                "host_name": "string",
                "management_network": "string",
                "management_network_name": "string",
                "management_network_type": "enum",
                "management_vcenter_name": "string",
                "management_vcenter_server_guid": "string",
                "storage": {
                    "datastore": "string",
                    "datastore_name": "string"
                },
                "vm_name": "string"
            },
            "role": "enum",
            "state": "enum"
        }
    }
}
Feedback

Was this page helpful?