List Transport Node Status

List Transport Node Status

Read status of all the transport nodes

Request
URI
GET
https://nsxmanager.your.domain/api/v1/transport-zones/transport-node-status
COPY
Query Parameters
string
status
Optional

Transport node

Possible values are : UP, DOWN, DEGRADED,
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
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


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