NSX-T Data Center REST API

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

This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/remote-transport-node-status
Request Headers:
n/a
Query Parameters:
RemoteTransportNodeStatusParametersWithDataSource+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1/remote-transport-node-status

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TransportNodeStatusListResult+

Example Response:

{ "result_count": 1, "results": [ { "control_connection_status": { "degraded_count": 0, "down_count": 0, "up_count": 1, "status": "UP" }, "tunnel_status": { "down_count": 0, "up_count": 1, "status": "UP", "bfd_status": { "bfd_admin_down_count": 0, "bfd_up_count": 1, "bfd_init_count": 0, "bfd_down_count": 0 }, "bfd_diagnostic": { "echo_function_failed_count": 0, "no_diagnostic_count": 1, "path_down_count": 0, "administratively_down_count": 0, "control_detection_time_expired_count": 0, "forwarding_plane_reset_count": 0, "reverse_concatenated_path_down_count": 0, "neighbor_signaled_session_down_count": 0, "concatenated_path_down_count": 0 } }, "pnic_status": { "degraded_count": 0, "down_count": 0, "up_count": 2, "status": "UP" }, "threat_status": { "status": "NORMAL" }, "agent_status": { "status": "UP", "up_count: 2 "down_count": 0, "agents": [ { "name": "NSX_AGENT", "stauts": "UP" }, { "name": "NSX_NESTDB", "stauts": "UP" } ] }, "node_status": { "last_heartbeat_timestamp": 1446675283540, "lcp_connectivity_status": "UP", "mpa_connectivity_status": "UP", "system_status": { "mem_used": 2551264, "system_time": 1446649452000, "file_systems": [ { "file_system": "root", "total": 32768, "used": 476, "type": "ramdisk", "mount": "/" }, { "file_system": "etc", "total": 28672, "used": 220, "type": "ramdisk", "mount": "/etc" }, { "file_system": "opt", "total": 32768, "used": 1040, "type": "ramdisk", "mount": "/opt" }, { "file_system": "var", "total": 49152, "used": 1196, "type": "ramdisk", "mount": "/var" }, { "file_system": "tmp", "total": 262144, "used": 24136, "type": "ramdisk", "mount": "/tmp" }, { "file_system": "hostdstats", "total": 302080, "used": 2072, "type": "ramdisk", "mount": "/var/lib/vmware/hostd/stats" } ], "load_average": [ 0.17000000178813934, 0.17000000178813934, 0.15000000596046448 ], "swap_total": 0, "mem_cache": 0, "cpu_cores": 16, "source": "cached", "mem_total": 25119208, "swap_used": 0, "uptime": 7213000 }, "last_sync_time": 1473837914408, "mpa_connectivity_status_details": "Client is responding to heartbeats", "software_version": "1.1.0.0.0.3195008", "host_node_deployment_status": "INSTALL_SUCCESSFUL", "lcp_connectivity_status_details": [ { "control_node_ip": "192.168.110.34", "failure_status": "UNKNOWN_FAILURE_STATUS", "status": "UP" } ], "inventory_sync_paused": false }, "mgmt_connection_status": "UP", "node_uuid": "e8d0d75c-4f39-11e7-b9d7-5d1bfa96a140", "status": "UP" } ] }

Required Permissions:

read

Feature:

tools_heatmap

Additional Errors: