Get Edge Cluster Inter Site Status

Returns the aggregated status for the Edge cluster along with status of all edge nodes in the cluster. It always returns cached response.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/edge-clusters/{edge-cluster-id}/inter-site/status

COPY

Path Parameters

string

edge-cluster-id

Required

edge-cluster-id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns EdgeClusterInterSiteStatus of type(s) application/json

{
    "edge_cluster_id": "string",
    "edge_cluster_name": "string",
    "last_update_timestamp": 0,
    "member_status": [
        {
            "established_bgp_sessions": 0,
            "neighbor_status": [
                {
                    "connection_state": "string",
                    "neighbor_address": "string",
                    "remote_site": {
                        "is_valid": false,
                        "target_display_name": "string",
                        "target_id": "string",
                        "target_type": "string"
                    },
                    "source_address": "string"
                }
            ],
            "status": "string",
            "total_bgp_sessions": 0,
            "transport_node": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            }
        }
    ],
    "overall_status": "string"
}

string

edge_cluster_id

Optional

Id of the edge cluster whose status is being reported.

string

edge_cluster_name

Optional

Name of the edge cluster whose status is being reported.

integer As int64 As int64

last_update_timestamp

Optional

Timestamp when the edge cluster inter-site status was last updated.

array of object

member_status

Optional

Per edge node inter-site status.

string

overall_status

Optional

Overall status of all edge nodes IBGP status in the edge cluster.

Possible values are : UP, DOWN, DEGRADED, UNKNOWN, CONFIGURED,

400

Returns BadRequest of type(s) application/json