Snapservice.Sites.ConnectionState

The Snapservice.Sites.ConnectionState schema contains information regarding connection status from local to remote site.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "connection_status": "string",
    "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"
                }
            ]
        }
    ],
    "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"
                }
            ]
        }
    ]
}

string

connection_status

Required

Connection status for the site and service. For site, connection status represents that no errors are observed for various services for both sites. For service, connection status represents that no errors are observed for the service in question.

Possible values:

CONNECTED: Paired site have healthy connection with the local site.
ERROR: Paired site have connection issues with the local site.

For more information see: Snapservice.Sites.ConnectionStatus.

This property was added in vSphere API 9.0.0.0.

array of Snapservice.Reason

errors

Optional

List of errors reported for the service or the paired sites.

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.Sites.ConnectionStatus.ERROR.

array of Snapservice.Reason

warnings

Optional

List of warnings reported for the service or the paired sites.

This property was added in vSphere API 9.0.0.0.

If missing or null, there are no warnings reported for the service or the paired sites.