NSX-T Data Center REST API

Tunnel properties

This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/tunnels/<tunnel-name>
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1/tunnels/stt3232299620

Successful Response:

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

Example Response:

{ "local_ip": "192.168.250.101", "bfd": { "remote_state": "DOWN", "remote_diagnostic": "CONTROL_DETECTION_TIME_EXPIRED", "active": true, "state": "INIT", "forwarding": false, "diagnostic": "NEIGHBOR_SIGNALED_SESSION_DOWN" }, "remote_ip": "192.168.250.100", "egress_interface": "vmk10", "name": "stt3232299620", "encap": "STT", "status": "DOWN", "remote_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a" }

Required Permissions:

read

Feature:

nodes_tunnels

Additional Errors: