Get Inter Site Edge Node Bgp Summary

Get Inter Site Edge Node Bgp Summary

Returns BGP summary for all configured neighbors in tunnel VRF on the given egde node. It always returns realtime response.



Please use below Policy API.
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<tier0-locale-service>/inter-site/bgp-summary
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<tier1-locale-service>/inter-site/bgp-summary
Request
URI
GET
https://nsxmanager.your.domain/api/v1/transport-nodes/{edge-node-id}/inter-site/bgp/summary
COPY
Path Parameters
string
edge-node-id
Required

edge-node-id


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns InterSiteBgpSummary of type(s) application/json
{
    "last_update_timestamp": 0,
    "neighbor_status": [
        {
            "address_families": [
                {
                    "in_prefix_count": 0,
                    "out_prefix_count": 0,
                    "type": "string"
                }
            ],
            "announced_capabilities": [
                "string"
            ],
            "connection_drop_count": 0,
            "connection_state": "string",
            "established_connection_count": 0,
            "graceful_restart": false,
            "graceful_restart_mode": "string",
            "hold_time": 0,
            "intent_path": "string",
            "keep_alive_interval": 0,
            "local_port": 0,
            "lr_component_id": "string",
            "messages_received": 0,
            "messages_sent": 0,
            "negotiated_capability": [
                "string"
            ],
            "neighbor_address": "string",
            "neighbor_edge_node": "string",
            "neighbor_router_id": "string",
            "remote_as_number": "string",
            "remote_port": 0,
            "remote_site": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "source_address": "string",
            "time_since_established": 0,
            "total_in_prefix_count": 0,
            "total_out_prefix_count": 0,
            "transport_node": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "type": "string"
        }
    ],
    "transport_node_id": "string"
}
integer As int64 As int64
last_update_timestamp
Optional

Timestamp when the inter-site IBgp neighbors status was last updated.

array of object
neighbor_status
Optional

Status of all inter-site IBgp neighbors.

string
transport_node_id
Optional

Edge node id whose status is being reported.


400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/transport-nodes/{edge-node-id}/inter-site/bgp/summary