Get Transport Node Status

• Troubleshooting And Monitoring

Read status of a transport node

Request

URI

GET

https://nsxmanager.your.domain/api/v1/transport-nodes/{node-id}/status

COPY

Path Parameters

string

node-id

Required

ID of transport node

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

---

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Hide Details

OK

Returns TransportNodeStatus of type(s) application/json

{
    "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
    },
    "node_display_name": "string",
    "tunnel_status": {
        "bfd_diagnostic": {
            "concatenated_path_down_count": 0,
            "administratively_down_count": 0,
            "no_diagnostic_count": 0,
            "path_down_count": 0,
            "reverse_concatenated_path_down_count": 0,
            "neighbor_signaled_session_down_count": 0,
            "control_detection_time_expired_count": 0,
            "echo_function_failed_count": 0,
            "forwarding_plane_reset_count": 0
        },
        "bfd_status": {
            "bfd_admin_down_count": 0,
            "bfd_up_count": 0,
            "bfd_down_count": 0,
            "bfd_init_count": 0
        }
    }
}

string

status

Optional

Roll-up status of pNIC, management connection, control connection, tunnel status

Possible values are : UP, DOWN, DEGRADED, UNKNOWN,

string

node_uuid

Optional

Transport node uuid

string

mgmt_connection_status

Optional

Management connection status

Possible values are : UP, DOWN,

StatusCount

control_connection_status

Optional

control_connection_status

StatusCount

pnic_status

Optional

pnic_status

string

node_display_name

Optional

Transport node display name

TunnelStatusCount

tunnel_status

Optional

tunnel_status

400

Hide Details

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403

Hide Details

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404

Hide Details

Not Found

Operation doesn't return any data structure

412

Hide Details

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500

Hide Details

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503

Hide Details

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Troubleshooting And Monitoring Operations

POST

Create Packet Capture Session

POST

Create Port Mirroring Sessions

POST

Create Traceflow

POST

Delete All Capture Sessions Delete

POST

Delete Packet Capture Session Delete

DELETE

Delete Port Mirroring Session

DELETE

Delete Traceflow

GET

Get All Transport Nodes Status

GET

Get All Transport Zone Status

GET

Get Forwarding Path

GET

Get Heatmap Transport Zone Status

GET

Get Ipfix Obs Points

GET

Get Pnic Statuses For Transport Node

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 Packet Capture Sessions

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

GET

Read Packet Capture Session

POST

Terminate Packet Capture Session Terminate

PUT

Update Port Mirroring Session

PUT

Update Switch Ipfix Config

POST

Verify Port Mirroring Session Verify