List of tunnels

Request:

Method:

GET

URI Path(s):

/api/v1/transport-nodes/{node-id}/tunnels

Request Headers:

n/a

Query Parameters:

QueryTunnelParameters+

QueryTunnelParameters (schema)

Name	Description	Type	Notes
bfd_diagnostic_code	BFD diagnostic code of Tunnel as defined in RFC 5880	string	Enum: 0, NO_DIAGNOSTIC, 1, CONTROL_DETECTION_TIME_EXPIRED, 2, ECHO_FUNCTION_FAILED, 3, NEIGHBOR_SIGNALED_SESSION_DOWN, 4, FORWARDING_PLANE_RESET, 5, PATH_DOWN, 6, CONCATENATED_PATH_DOWN, 7, ADMINISTRATIVELY_DOWN, 8, REVERSE_CONCATENATED_PATH_DOWN
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
encap	Tunnel encapsulation type The encapsulation type of tunnel. VXLAN - tunnel with VXLAN encapsulation GENEVE - tunnel with GENEVE encapsulation UNKNOWN_ENCAP - tunnel with unknown encapsulation	string	Enum: UNKNOWN_ENCAP, GENEVE, VXLAN
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
remote_node_id		string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
status	Tunnel status	string	Enum: UP, DOWN

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-nodes/9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f/tunnels

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TunnelList+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
tunnels	List of transport node tunnels	array of TunnelProperties	Readonly

Example Response:

{ "cursor": "00011", "result_count": 1, "tunnels": [ { "local_ip": "192.168.250.101", "bfd": { "remote_state": "UP", "remote_diagnostic": "CONTROL_DETECTION_TIME_EXPIRED", "active": true, "state": "UP", "forwarding": true, "diagnostic": "NEIGHBOR_SIGNALED_SESSION_DOWN" }, "remote_ip": "192.168.250.100", "egress_interface": "vmk10", "name": "stt3232299620", "encap": "STT", "status": "UP", "remote_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a" } ] }

List of tunnels

Request:

QueryTunnelParameters (schema)

Example Request:

Successful Response:

TunnelList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: