Get Transport Node Status

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

Returns TransportNodeStatus of type(s) application/json

{
    "agent_status": {
        "agents": [
            {
                "components": [
                    {
                        "name": "string",
                        "status": "string",
                        "status_description": "string"
                    }
                ],
                "last_status_changed_time": 0,
                "name": "string",
                "resource_usage": {
                    "memory_total": 0,
                    "memory_used": 0
                },
                "status": "string",
                "status_description": "string"
            }
        ],
        "degraded_count": 0,
        "down_count": 0,
        "last_status_changed_time": 0,
        "smartnic_agents": [
            {
                "node_id": "string",
                "statuses": [
                    {
                        "components": [
                            {
                                "name": "string",
                                "status": "string",
                                "status_description": "string"
                            }
                        ],
                        "last_status_changed_time": 0,
                        "name": "string",
                        "resource_usage": {
                            "memory_total": 0,
                            "memory_used": 0
                        },
                        "status": "string",
                        "status_description": "string"
                    }
                ]
            }
        ],
        "status": "string",
        "up_count": 0
    },
    "control_connection_status": {
        "degraded_count": 0,
        "down_count": 0,
        "down_pnics": [
            {
                "bond_pnics": [
                    {
                        "name": "string",
                        "status": "string",
                        "type": "string"
                    }
                ],
                "name": "string",
                "nsx_type": "string",
                "status": "string",
                "type": "string"
            }
        ],
        "last_status_changed_time": 0,
        "status": "string",
        "status_description": "string",
        "up_count": 0
    },
    "evpn_tunnel_status": {
        "bfd_diagnostic": {
            "administratively_down_count": 0,
            "concatenated_path_down_count": 0,
            "control_detection_time_expired_count": 0,
            "echo_function_failed_count": 0,
            "forwarding_plane_reset_count": 0,
            "neighbor_signaled_session_down_count": 0,
            "no_diagnostic_count": 0,
            "path_down_count": 0,
            "reverse_concatenated_path_down_count": 0
        },
        "bfd_status": {
            "bfd_admin_down_count": 0,
            "bfd_down_count": 0,
            "bfd_init_count": 0,
            "bfd_up_count": 0
        }
    },
    "last_aggsvc_heartbeat": 0,
    "last_status_changed_time": 0,
    "mgmt_connection_status": "string",
    "node_display_name": "string",
    "node_path": "string",
    "node_status": {
        "external_id": "string",
        "host_node_deployment_status": "string",
        "inventory_sync_paused": false,
        "inventory_sync_reenable_time": 0,
        "last_heartbeat_timestamp": 0,
        "last_sync_time": 0,
        "lcp_connectivity_status": "string",
        "lcp_connectivity_status_details": [
            {
                "control_node_ip": "string",
                "failure_status": "string",
                "status": "string"
            }
        ],
        "maintenance_mode": "string",
        "mpa_connectivity_status": "string",
        "mpa_connectivity_status_details": "string",
        "software_version": "string",
        "system_status": {
            "cpu_cores": 0,
            "cpu_sockets": 0,
            "cpu_usage": {
                "avg_cpu_core_usage_dpdk": "number",
                "avg_cpu_core_usage_non_dpdk": "number",
                "highest_cpu_core_usage_dpdk": "number",
                "highest_cpu_core_usage_non_dpdk": "number"
            },
            "dfw_heap_memory_usage": [
                {
                    "description": "string",
                    "name": "string",
                    "total_mb": 0,
                    "usage_pct": "number",
                    "used_mb": 0
                }
            ],
            "disk_space_total": 0,
            "disk_space_used": 0,
            "dpdk_cpu_cores": 0,
            "dpus": [
                {
                    "cpu_cores": 0,
                    "dpu_alias": "string",
                    "dpu_id": "string",
                    "load_average": [
                        "number"
                    ],
                    "mem_cache": 0,
                    "mem_total": 0,
                    "mem_used": 0
                }
            ],
            "edge_mem_usage": {
                "cache_usage": "number",
                "datapath_mem_usage_details": {
                    "datapath_heap_usage": "number",
                    "datapath_mem_pools_usage": [
                        {
                            "description": "string",
                            "name": "string",
                            "usage": "number"
                        }
                    ],
                    "highest_datapath_mem_pool_usage": "number",
                    "highest_datapath_mem_pool_usage_names": [
                        "string"
                    ]
                },
                "datapath_total_usage": "number",
                "swap_usage": "number",
                "system_mem_usage": "number"
            },
            "file_systems": [
                {
                    "file_system": "string",
                    "mount": "string",
                    "total": 0,
                    "type": "string",
                    "used": 0
                }
            ],
            "hostname": "string",
            "load_average": [
                "number"
            ],
            "mem_cache": 0,
            "mem_total": 0,
            "mem_used": 0,
            "non_dpdk_cpu_cores": 0,
            "remote_logging_server_configured": false,
            "source": "string",
            "swap_total": 0,
            "swap_used": 0,
            "system_time": 0,
            "uptime": 0
        }
    },
    "node_uuid": "string",
    "pnic_status": {
        "degraded_count": 0,
        "down_count": 0,
        "down_pnics": [
            {
                "bond_pnics": [
                    {
                        "name": "string",
                        "status": "string",
                        "type": "string"
                    }
                ],
                "name": "string",
                "nsx_type": "string",
                "status": "string",
                "type": "string"
            }
        ],
        "last_status_changed_time": 0,
        "status": "string",
        "status_description": "string",
        "up_count": 0
    },
    "status": "string",
    "status_description": "string",
    "threat_status": {
        "status": "string"
    },
    "tunnel_status": {
        "bfd_diagnostic": {
            "administratively_down_count": 0,
            "concatenated_path_down_count": 0,
            "control_detection_time_expired_count": 0,
            "echo_function_failed_count": 0,
            "forwarding_plane_reset_count": 0,
            "neighbor_signaled_session_down_count": 0,
            "no_diagnostic_count": 0,
            "path_down_count": 0,
            "reverse_concatenated_path_down_count": 0
        },
        "bfd_status": {
            "bfd_admin_down_count": 0,
            "bfd_down_count": 0,
            "bfd_init_count": 0,
            "bfd_up_count": 0
        }
    },
    "vm_uuid": "string"
}

object

agent_status

Optional

agent_status

object

control_connection_status

Optional

control_connection_status

evpn_tunnel_status

Optional

evpn_tunnel_status

integer As int64 As int64

last_aggsvc_heartbeat

Optional

Timestamp of the last agg-service heartbeat, in epoch milliseconds.

integer As int64 As int64

last_status_changed_time

Optional

Timestamp of the last status change, in epoch milliseconds.

string

mgmt_connection_status

Optional

Management connection status

Possible values are : UP, DOWN,

string

node_display_name

Optional

Transport node display name

string

node_path

Optional

Transport node path

object

node_status

Optional

Runtime status information of the fabric node.

string

node_uuid

Optional

Transport node uuid

object

pnic_status

Optional

pnic_status

string

status

Optional

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

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

string

status_description

Optional

Describe what makes the status not UP

object

threat_status

Optional

threat_status

tunnel_status

Optional

tunnel_status

string

vm_uuid

Optional

Edge node virtual machine unique identifier. This is reported only for Edge Virtual Machine Type deployed on NSX configured host nodes.

400

Returns BadRequest of type(s) application/json