NSX-T Data Center REST API

Get the counter values for cached datapath statistics. (Experimental)

Get the counter values for cached datapath statistics. Support multiple types in one query.
Query types should be declared inside query parameters. By default the query type is packet_stats.

Request:

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

Successful Response:

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

Example Response:

{ "fast_path_sys_stats": { "host_enhanced_fastpath": { "num_flow_tables": 0, "flow_table_size": 65536, "num_flows": 0, "num_flows_created": 0, "hits": 0, "miss": 0, "slowpath": 0, "insertion_errors": 0, "flow_table_occupancy_95_pct": 0, "flow_table_occupancy_90_pct": 0, "flow_table_occupancy_75_pct": 0, "flow_table_occupancy_50_pct": 0, "flow_table_occupancy_25_pct": 0, "flow_table_occupancy_0_pct": 0 }, "host_standard_fastpath": { "num_flow_tables": 1, "flow_table_size": 65536, "num_flows": 0, "num_flows_created": 0, "hits": 0, "miss": 0, "slowpath": 0, "insertion_errors": 0, "flow_table_occupancy_95_pct": 0, "flow_table_occupancy_90_pct": 0, "flow_table_occupancy_75_pct": 0, "flow_table_occupancy_50_pct": 0, "flow_table_occupancy_25_pct": 0, "flow_table_occupancy_0_pct": 1 }, "last_update_timestamp": 1706048050 }, "packet_stats": { "number_of_vnics": 6, "local_workloads_transmitted_received_packets": { "vnic_txpps": 18.0, "vnic_rxpps": 18917.0, "vnic_txmbps": 0.0, "vnic_rxmbps": 9.0, "vnic_txeps": 0.0, "vnic_rxeps": 0.0 }, "number_of_pnics": 2, "pnics_transmitted_received_packets": { "pnic_txpps": 178.0, "pnic_rxpps": 3988.0, "pnic_txmbps": 1.0, "pnic_rxmbps": 3.0, "pnic_txeps": 0.0, "pnic_rxeps": 0.0 }, "local_workloads_transmitted_received_broadcast_packets": { "broadcast_txpps": 0.0, "broadcast_rxpps": 0.0 }, "local_workloads_transmitted_received_multicast_packets": { "multicast_txpps": 0.0, "multicast_rxpps": 0.0 }, "datapath_system_error_packet_drops": 0, "datapath_total_packet_drops_pps": 0.0, "datapath_packet_drops": { "hostswitch_received_forged_mac_packet_drops": 0, "hostswitch_network_mismatch_packet_drops": 0, "overlay_received_packet_drops": 0, "overlay_transmitted_packet_drops": 0, "overlay_uplink_received_packet_drops": 0, "overlay_uplink_transmitted_packet_drops": 0, "l3_reverse_path_forwarding_packet_drops": 0, "l3_no_route_packet_drops": 0, "l3_neighbor_unreachable_packet_drops": 0, "l3_hop_limit_packet_drops": 0, "broadcast_rate_limiting_packet_drops": 0, "workload_dhcp_not_allowed_packet_drops": 0, "spoof_guard_packet_drops": 0, "workload_ipv6_ra_guard_packet_drops": 0, "workload_bpdu_filter_packet_drops": 0, "firewall_total_packet_drops": 0, "firewall_packet_rejects": 0, "firewall_malformed_packet_drops": 0, "firewall_internal_error_packet_drops": 0, "firewall_state_table_full_packet_drops": 0, "firewall_rule_received_packet_drops": 0, "firewall_rule_transmitted_packet_drops": 0, "firewall_state_check_packet_drops": 0, "firewall_flood_limit_packet_drops": 0, "fastpath_packet_drops": 0, "packet_parsing_error_drops": 0 }, "unicast_packet_flooding": { "hostswitch_unknown_l2_unicast_to_uplink_txpps": 0.0, "hostswitch_unknown_l2_unicast_from_uplink_rxpps": 0.0, "overlay_flooded_l2_unicast_to_uplink_txpps": 0.0 }, "packet_processing_efficiency_watch": { "overlay_unsuccessful_control_plane_assisted_neighbor_resolution_rxpps": 0.0, "overlay_unsuccessful_mac_learning_due_to_table_full_rxpps": 0.0, "overlay_unsuccessful_mac_learning_due_to_unknown_tunnel_endpoint_rxpps": 0.0, "fastpath_flow_hit_pps": 0.0, "fastpath_flow_miss_pps": 0.0, "fastpath_slowpath_only_pps": 0.0 }, "last_update_timestamp": 1706048050 }, "platform_cpu_usage_stats": { "host_net_thread_all": { "num_threads": 19, "min_cpu": 0.0, "max_cpu": 0.61, "total_cpu": 0.7, "hist_99_pct": 0, "hist_97_pct": 0, "hist_95_pct": 0, "hist_90_pct": 0, "hist_85_pct": 0, "hist_80_pct": 0, "hist_70_pct": 0, "hist_50_pct": 0, "hist_25_pct": 0, "hist_0_pct": 19 }, "host_pcpu": { "total_cpu": 35.6, "hist_95_pct": 0, "hist_90_pct": 0, "hist_85_pct": 0, "hist_75_pct": 0, "hist_50_pct": 0, "hist_0_pct": 4 }, "host_vcpu": { "total_cpu": 12.34, "hist_95_pct": 0, "hist_90_pct": 0, "hist_85_pct": 0, "hist_75_pct": 0, "hist_50_pct": 0, "hist_0_pct": 7 }, "last_update_timestamp": 1706048050 }, "platform_packet_stats": { "host_vnic": { "num_vnics": 6, "txpps": 18.0, "txmbps": 0.0, "txeps": 0.0, "rxpps": 18917.0, "rxmbps": 9.0, "rxeps": 0.0 }, "host_uplink": { "num_pnics": 2, "txpps": 178.0, "txmbps": 1.0, "txeps": 0.0, "rxpps": 3988.0, "rxmbps": 3.0, "rxeps": 0.0, "rx_missed": 0, "rx_error_total": 0 }, "last_update_timestamp": 1706048050 }, "fast_path_lcore_usage_stats": { "lcore_rank_01_lcore_id": 0, "lcore_rank_01_lcore_usage": 0.0, "lcore_rank_02_lcore_id": 0, "lcore_rank_02_lcore_usage": 0.0, "lcore_rank_03_lcore_id": 0, "lcore_rank_03_lcore_usage": 0.0, "lcore_rank_04_lcore_id": 0, "lcore_rank_04_lcore_usage": 0.0, "lcore_rank_05_lcore_id": 0, "lcore_rank_05_lcore_usage": 0.0, "lcore_rank_06_lcore_id": 0, "lcore_rank_06_lcore_usage": 0.0, "lcore_rank_07_lcore_id": 0, "lcore_rank_07_lcore_usage": 0.0, "lcore_rank_08_lcore_id": 0, "lcore_rank_08_lcore_usage": 0.0, "lcore_rank_09_lcore_id": 0, "lcore_rank_09_lcore_usage": 0.0, "lcore_rank_10_lcore_id": 0, "lcore_rank_10_lcore_usage": 0.0, "lcore_rank_11_lcore_id": 0, "lcore_rank_11_lcore_usage": 0.0, "lcore_rank_12_lcore_id": 0, "lcore_rank_12_lcore_usage": 0.0, "lcore_rank_13_lcore_id": 0, "lcore_rank_13_lcore_usage": 0.0, "lcore_rank_14_lcore_id": 0, "lcore_rank_14_lcore_usage": 0.0, "lcore_rank_15_lcore_id": 0, "lcore_rank_15_lcore_usage": 0.0, "lcore_rank_16_lcore_id": 0, "lcore_rank_16_lcore_usage": 0.0, "number_of_lcores": 16, "last_update_timestamp": 1706048050 } }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: