Vcha_Cluster_Info

Vcha_Cluster_Info
Vcha_Cluster_Info

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

JSON Example
{
    "config_state": "string",
    "node1": {
        "failover_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "gateway_ip": "string"
        },
        "ha_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "gateway_ip": "string"
        },
        "runtime": {
            "state": "string",
            "role": "string",
            "placement": {
                "management_vcenter_name": "string",
                "management_vcenter_server_guid": "string",
                "vm_name": "string",
                "datacenter": "string",
                "datacenter_name": "string",
                "host": "string",
                "host_name": "string",
                "cluster": "string",
                "cluster_name": "string",
                "ha_network": "string",
                "ha_network_name": "string",
                "ha_network_type": "string",
                "management_network": "string",
                "management_network_name": "string",
                "management_network_type": "string",
                "storage": {
                    "datastore": "string",
                    "datastore_name": "string"
                },
                "bios_uuid": "string"
            }
        }
    },
    "node2": {
        "failover_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "gateway_ip": "string"
        },
        "ha_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "gateway_ip": "string"
        },
        "runtime": {
            "state": "string",
            "role": "string",
            "placement": {
                "management_vcenter_name": "string",
                "management_vcenter_server_guid": "string",
                "vm_name": "string",
                "datacenter": "string",
                "datacenter_name": "string",
                "host": "string",
                "host_name": "string",
                "cluster": "string",
                "cluster_name": "string",
                "ha_network": "string",
                "ha_network_name": "string",
                "ha_network_type": "string",
                "management_network": "string",
                "management_network_name": "string",
                "management_network_type": "string",
                "storage": {
                    "datastore": "string",
                    "datastore_name": "string"
                },
                "bios_uuid": "string"
            }
        }
    },
    "witness": {
        "ha_ip": "Vcha_Cluster_IpInfo Object",
        "runtime": "Vcha_Cluster_NodeRuntimeInfo Object"
    },
    "mode": "string",
    "health_state": "string",
    "health_exception": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "health_warnings": [
        {
            "error": "Std_LocalizableMessage Object",
            "recommendation": "Std_LocalizableMessage Object"
        }
    ],
    "manual_failover_allowed": false,
    "auto_failover_allowed": false
}
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.

node1
Optional

The Cluster.NodeInfo structure defines the configuration information for the active and passive nodes in the cluster.

node2
Optional

The Cluster.NodeInfo structure defines the configuration information for the active and passive nodes in the cluster.

witness
Optional

The Cluster.WitnessInfo structure defines the configuration and runtime information for the witness node in the cluster.

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.

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.
health_exception
Optional

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

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.

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.