NSX-T Data Center REST API

Get a Policy EdgeTransport Node's status info under an Enforcement Point

Returns information about the current status of the edge transport node.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id/status

Successful Response:

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

Example Response:

{ "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id", "edge_transport_node_display_name": "mashish-svc.nsxedge-ob-21766245-1-Issues7", "status": "UP", "pnic_status": { "status": "UP", "up_count": 2, "down_count": 0, "degraded_count": 0, "last_status_changed_time": 1684158497178 }, "mgmt_connection_status": "UP", "control_connection_status": { "status": "UP", "up_count": 1, "down_count": 0, "degraded_count": 0, "last_status_changed_time": 1684158497178 }, "tunnel_status": { "bfd_status": { "bfd_admin_down_count": 0, "bfd_down_count": 0, "bfd_init_count": 0, "bfd_up_count": 2 }, "bfd_diagnostic": { "no_diagnostic_count": 2, "control_detection_time_expired_count": 0, "echo_function_failed_count": 0, "forwarding_plane_reset_count": 0, "path_down_count": 0, "concatenated_path_down_count": 0, "administratively_down_count": 0, "reverse_concatenated_path_down_count": 0, "neighbor_signaled_session_down_count": 0 }, "status": "UP", "up_count": 2, "down_count": 0, "last_status_changed_time": 1684158675848 }, "agent_status": { "status": "UP", "up_count": 1, "down_count": 0, "agents": [ { "status": "UP", "name": "NSX_OPSAGENT", "last_status_changed_time": 1684158586190, "components": [ { "status": "UP", "name": "opsagent-proxy-connection" } ] } ], "last_status_changed_time": 1684158586190, "degraded_count": 0 }, "node_status": { "last_heartbeat_timestamp": 1684158495956, "mpa_connectivity_status": "UP", "mpa_connectivity_status_details": "Client is responding to heartbeats", "lcp_connectivity_status": "UP", "lcp_connectivity_status_details": [ { "control_node_ip": "10.168.197.204", "status": "UP" } ], "host_node_deployment_status": "NODE_READY", "software_version": "4.2.0.0.0.21766255", "system_status": { "cpu_cores": 4, "dpdk_cpu_cores": 2, "non_dpdk_cpu_cores": 2, "disk_space_total": 200809668, "disk_space_used": 11349552, "file_systems": [ { "file_system": "/dev/sda2", "mount": "/", "total": 19509484, "type": "ext4", "used": 6632136 }, { "file_system": "/dev/sda1", "mount": "/boot", "total": 964900, "type": "ext4", "used": 7244 }, { "file_system": "/dev/mapper/nsx-config", "mount": "/config", "total": 19506412, "type": "ext4", "used": 5856 }, { "file_system": "/dev/mapper/nsx-var+log", "mount": "/var/log", "total": 40002896, "type": "ext4", "used": 4704080 }, { "file_system": "/dev/mapper/nsx-tmp", "mount": "/tmp", "total": 3853768, "type": "ext4", "used": 84 }, { "file_system": "/dev/mapper/nsx-image", "mount": "/image", "total": 19506412, "type": "ext4", "used": 80 }, { "file_system": "/dev/mapper/nsx-var+dump", "mount": "/var/dump", "total": 58449900, "type": "ext4", "used": 24 } ], "load_average": [ 2.7699999809265137, 2.440000057220459, 2.140000104904175 ], "cpu_usage": { "highest_cpu_core_usage_dpdk": 0.029999999329447746, "avg_cpu_core_usage_dpdk": 0.019999999552965164, "highest_cpu_core_usage_non_dpdk": 99.52999877929688, "avg_cpu_core_usage_non_dpdk": 68.37999725341797 }, "edge_mem_usage": { "system_mem_usage": 64.32, "swap_usage": 0.0, "cache_usage": 27.46, "datapath_total_usage": 54.53, "datapath_mem_usage_details": { "datapath_heap_usage": 0.0, "highest_datapath_mem_pool_usage": 44.39, "highest_datapath_mem_pool_usage_names": [ "mbuf_pool_socket_0" ], "datapath_mem_pools_usage": [ { "name": "mbuf_pool_socket_0", "description": "Packet Pool on Socket 0", "usage": 44.39 }, { "name": "jumbo_mbuf_pool", "description": "Packet Pool for Jumbo Frame Used by Ipsec Crypto Device", "usage": 0.0 }, { "name": "sess_mp_0", "description": "session private mempool for crypto device used by ipsec", "usage": 0.0 }, { "name": "sess_priv_mp_0", "description": "session mempool for crypto device used by ipsec", "usage": 0.0 }, { "name": "sp_pktmbuf_pool", "description": "Datapath Slowpath Packet Pool", "usage": 0.0 }, { "name": "fw_mon_msg", "description": "Stateful Service Sync Message Pool", "usage": 0.0 }, { "name": "pfstatepl3", "description": "Stateful Service State Pool", "usage": 0.0 }, { "name": "pffqdnippl", "description": "Stateful Service FQDN to IP Map Pool", "usage": 0.0 }, { "name": "pffqdnsyncpl", "description": "Stateful Service FQDN SYNC Pool", "usage": 0.0 }, { "name": "pffqdndnpl", "description": "Stateful Service FQDN Internal Pool", "usage": 0.0 }, { "name": "pfdnsdnpl", "description": "Stateful Service FQDN DNS Pool", "usage": 0.0 }, { "name": "pffrentpl3", "description": "Stateful Service Fragmented Entry Pool", "usage": 0.0 }, { "name": "pfpktpl3", "description": "Stateful Service Fragmented Packet Pool", "usage": 0.0 }, { "name": "pfsyncmbufpl3", "description": "Stateful Service SYNC Pool", "usage": 0.0 }, { "name": "pf_fp_rule_node", "description": "Stateful Service Rule Node Pool", "usage": 0.0 }, { "name": "pf_fp_root_rule_node", "description": "Stateful Service Fastpath Root Rule Node Pool", "usage": 0.0 }, { "name": "pf_tb_root_rule_node", "description": "Stateful Service TB Root Rule Node Pool", "usage": 0.0 }, { "name": "pf_url_node", "description": "URL or SNI request string", "usage": 0.0 }, { "name": "pf_dpi_conn_node", "description": "pf_dpi_conn ", "usage": 0.0 }, { "name": "pfa_intattr_pl3", "description": "Stateful Service Integer Attribute Pool", "usage": 0.0 }, { "name": "pfa_attrconn_pl3", "description": "Stateful Service Attribute Connection Pool", "usage": 0.0 }, { "name": "pf_snat_pl3", "description": "SNAT Port Hash Pool", "usage": 0.0 }, { "name": "pfa_ctx_pl3", "description": "Stateful Service Context Pool", "usage": 0.0 }, { "name": "pfa_key_ace_pl3", "description": "Stateful Service Integer Attribute Key Pool", "usage": 0.0 }, { "name": "pfa_value_ace_pl3", "description": "Stateful Service Integer Attribute Value Pool", "usage": 0.0 }, { "name": "pf_hsid_pl3", "description": "L7 Custom Url HSDB Pool", "usage": 0.0 }, { "name": "lb_pkt_pl3", "description": "Load Balancer Temp Packet Cache Pool", "usage": 0.0 } ] } }, "mem_cache": 2171376, "mem_total": 7907728, "mem_used": 5086612, "source": "cached", "swap_total": 0, "swap_used": 0, "system_time": 1685010084000, "uptime": 853736000, "cpu_sockets": 4 }, "maintenance_mode": "DISABLED" }, "last_aggsvc_heartbeat": 1685010074310, "last_status_changed_time": 1684158586190 }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors: