List Remote Transport Node Status

List Remote Transport Node Status

Read status of all transport nodes with tunnel connections to transport node

Request
URI
GET
https://nsxmanager.your.domain/api/v1/transport-nodes/{node-id}/remote-transport-node-status
COPY
Path Parameters
string
node-id
Required

ID of transport node

Query Parameters
string
included_fields
Optional

Comma separated list of fields that should be included to result of query

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

string
tunnel_status
Optional

Tunnel Status

Possible values are : UP, DOWN,
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns TransportNodeStatusListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineTransportNodeStatusListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "status": "string",
            "node_uuid": "string",
            "mgmt_connection_status": "string",
            "control_connection_status": {
                "status": "string",
                "degraded_count": 0,
                "down_count": 0,
                "up_count": 0
            },
            "pnic_status": {
                "status": "string",
                "degraded_count": 0,
                "down_count": 0,
                "up_count": 0
            },
            "tunnel_status": {
                "bfd_diagnostic": {
                    "reverse_concatenated_path_down_count": 0,
                    "neighbor_signaled_session_down_count": 0,
                    "echo_function_failed_count": 0,
                    "forwarding_plane_reset_count": 0,
                    "concatenated_path_down_count": 0,
                    "administratively_down_count": 0,
                    "no_diagnostic_count": 0,
                    "path_down_count": 0,
                    "control_detection_time_expired_count": 0
                },
                "bfd_status": {
                    "bfd_admin_down_count": 0,
                    "bfd_up_count": 0,
                    "bfd_down_count": 0,
                    "bfd_init_count": 0
                }
            }
        }
    ]
}

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


On This Page
Troubleshooting And Monitoring Operations
POST
Create Port Mirroring Sessions
POST
Create Traceflow
DELETE
Delete Port Mirroring Session
DELETE
Delete Traceflow
GET
Get Forwarding Path
GET
Get Heatmap Transport Zone Status
GET
Get Ipfix Obs Points
GET
Get Port Mirroring Session
GET
Get Switch Ipfix Config
GET
Get Traceflow
GET
Get Traceflow Observations
GET
Get Transport Node Report
GET
Get Transport Node Report For A Transport Zone
GET
Get Transport Node Status
GET
List Node Logs
GET
List Port Mirroring Session
GET
List Remote Transport Node Status
GET
List Traceflows
GET
List Transport Node Status
GET
List Transport Node Status For Transport Zone
GET
Read Node Log
GET
Read Node Log Data
PUT
Update Port Mirroring Session
PUT
Update Switch Ipfix Config
POST
Verify Port Mirroring Session