NSX-T Data Center REST API

Get policy Tunnel status for given tunnel-id

Get policy Tunnel status for given tunnel-id This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/status
Request Headers:
n/a
Query Parameters:
L2L3RuntimeRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//tunnels//status

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
GreTunnelStatus+
TunnelStatus+

Example Response:

{ "destination": "44.44.44.10", "endpoint_status_per_edge_node": [ { "last_update_timestamp": 1689829155850, "source": "40.40.40.1", "tunnel_port_id": "4aaaf496-e99d-41f6-8d67-f9a919210eb6", "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0", "runtime_status": "UP", "tunnel_up_count": 0, "tunnel_last_up_time": 0, "tunnel_down_count": 0, "tunnel_last_down_time": 0, "keepalive_status": "KEEPALIVE_STATUS_DISABLED", "keepalive_interval": 10, "keepalive_dead_multiplier": 3, "keepalive_tx_count": 0, "keepalive_last_tx_time": 0, "keepalive_rx_count": 0, "keepalive_last_rx_time": 0, "keepalive_ack": "KEEPALIVE_STATUS_ENABLED", "keepalive_ack_sent_count": 0, "keepalive_last_ack_time": 0, "keepalive_admin_state": "DISABLED" }, { "last_update_timestamp": 1689829155915, "source": "40.40.40.2", "tunnel_port_id": "418c4d6f-9061-4460-b374-f9a7a74c94de", "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1", "runtime_status": "UP", "tunnel_up_count": 0, "tunnel_last_up_time": 0, "tunnel_down_count": 0, "tunnel_last_down_time": 0, "keepalive_status": "KEEPALIVE_STATUS_DISABLED", "keepalive_interval": 10, "keepalive_dead_multiplier": 3, "keepalive_tx_count": 0, "keepalive_last_tx_time": 0, "keepalive_rx_count": 0, "keepalive_last_rx_time": 0, "keepalive_ack": "KEEPALIVE_STATUS_ENABLED", "keepalive_ack_sent_count": 0, "keepalive_last_ack_time": 0, "keepalive_admin_state": "DISABLED" } ], "resource_type": "TUNNEL" }

Required Permissions:

read

Feature:

policy_t0

Additional Errors: