Snapservice.ClusterPairs.Info

The Snapservice.ClusterPairs.Info schema contains details regarding the cluster pair.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "local_cluster": {
        "site": "string",
        "vcenter": "string",
        "cluster": "string",
        "cluster_name": "string"
    },
    "peer_cluster": {
        "site": "string",
        "vcenter": "string",
        "cluster": "string",
        "cluster_name": "string"
    },
    "connection_status": "string",
    "connection_state_updated_at": "string",
    "connection_warnings": [
        {
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi.Std.NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ],
    "connection_errors": [
        {
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi.Std.NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ],
    "in_use": false
}

local_cluster

Required

First member of the cluster pair. Cluster from the local site that is a member of the cluster pair.

This property was added in vSphere API 9.0.0.0.

peer_cluster

Required

Second member of the cluster pair. Peer cluster that is a member of the clutser pair.

This property was added in vSphere API 9.0.0.0.

string

connection_status

Required

Connection status of the cluster pairing.

Possible values:

OK: Cluster pair is in a healthy state
WARNING: There are some warnings related to the cluster pair.
ERROR: Cluter pair has critical issues.

For more information see: Snapservice.ClusterPairs.ConnectionStatus.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time

connection_state_updated_at

Optional

Time at which the cluster pair connection state is checked.

This property was added in vSphere API 9.0.0.0.

is missing or null if there is no check cluster pair connection state

array of Snapservice.Reason

connection_warnings

Optional

List of localized warnings associated with the cluster pair.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of connection_status is one of Snapservice.ClusterPairs.ConnectionStatus.WARNING or Snapservice.ClusterPairs.ConnectionStatus.ERROR.

array of Snapservice.Reason

connection_errors

Optional

List of localized errors associated with the cluster pair.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of connection_status is Snapservice.ClusterPairs.ConnectionStatus.ERROR.

boolean

in_use

Required

Cluster pair is in use for replication.

This property was added in vSphere API 9.0.0.0.