Query Tunnels
List of tunnels
Request
URI
GET
https://nsxmanager.your.domain/api/v1/transport-nodes/{node-id}/tunnels
COPY
Path Parameters
string
node-id
Required
ID of transport node
Query Parameters
string
bfd_diagnostic_code
Optional
BFD diagnostic code of Tunnel as defined in RFC 5880
Possible values are : 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,
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included to result of query
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
string
remote_node_id
Optional
remote_node_id
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
string
source
Optional
Data source type.
Possible values are : realtime, cached,
string
status
Optional
Tunnel status
Possible values are : UP, DOWN,
Responses
200
Success
Returns TunnelList of type(s) application/json
This response body class contains all of the following: ListResult , InlineTunnelList1
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"cursor": "string",
"sort_ascending": false,
"sort_by": "string",
"result_count": 0,
"tunnels": [
{
"_self": {
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"status": "string",
"egress_interface": "string",
"remote_node_id": "string",
"encap": "string",
"bfd": {
"active": false,
"state": "string",
"remote_state": "string",
"remote_diagnostic": "string",
"forwarding": false,
"diagnostic": "string"
},
"name": "string",
"local_ip": "string",
"last_updated_time": 0,
"remote_ip": "string"
}
]
}
412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure
500
Operation doesn't return any data structure
503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure