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
status
Optional
Tunnel status
Possible values are : UP, DOWN,
string
included_fields
Optional
Comma separated list of fields that should be included to result of query
string
remote_node_id
Optional
remote_node_id
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,
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
string
sort_by
Optional
Field by which records are sorted
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
source
Optional
Data source type.
Possible values are : realtime, cached,
boolean
sort_ascending
Optional
sort_ascending
Responses
200
Success
Returns TunnelList of type(s) application/json
This response body class contains all of the following: ListResult , InlineTunnelList1
{
"_self": {
"rel": "string"
},
"cursor": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"sort_ascending": false,
"result_count": 0,
"_schema": "string",
"sort_by": "string",
"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": {
"remote_state": "string",
"remote_diagnostic": "string",
"diagnostic": "string",
"state": "string",
"active": false,
"forwarding": false
},
"name": "string",
"local_ip": "string",
"remote_ip": "string"
}
]
}
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code