NSX-T Data Center REST API

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

Get the counter values for realtime 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/debug
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:
ObservabilityCounterDebugQueryResult+

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": 1706048000 }, "packet_stats": { "overlay_datapath_l2": { "nd_proxy_req_fail_drops": 0, "uplink_rx_skip_mac_learn": 0, "mac_tbl_update_full": 0, "leaf_tx_drops": 0, "leaf_rx_system_err_drops": 0, "leaf_rx_ref_port_not_found_drops": 0, "leaf_rx_drops": 0, "uplink_rx_guest_vlan_drops": 0, "uplink_rx_system_err_drops": 0, "uplink_rx_drops": 0, "uplink_tx_drops": 0, "uplink_tx_teaming_drops": 0, "uplink_tx_invalid_state_drops": 0, "uplink_tx_invalid_frame_drops": 0, "uplink_tx_nested_tn_repl_drops": 0, "arp_proxy_resp_drops": 0, "nd_proxy_resp_drops": 0, "nested_tn_mcast_proxy_same_vlan_tx_drops": 0, "nested_tn_mcast_proxy_diff_vlan_tx_drops": 0, "mcast_proxy_rx_drops": 0, "mcast_proxy_tx_drops": 0, "uplink_rx_wrong_dest_drops": 0, "uplink_rx_invalid_encap_drops": 0, "arp_proxy_req_fail_drops": 0, "uplink_tx_ucast_flood": 0, "mac_tbl_lookup_flood": 0, "uplink_rx_mcast_invalid_druplink_drops": 0, "mac_tbl_lookup_full": 0, "arp_proxy_resp_unknown": 0, "nd_proxy_resp_unknown": 0 }, "datapath_l3": { "tx_dispatch_queue_too_long_drops": 0, "rx_pkt_parsing_error_drops": 0, "pkt_attr_error_drops": 0, "ttl_ipv4_drops": 0, "drop_route_ipv4_drops": 0, "arp_hold_pkt_drops": 0, "rpf_ipv4_drops": 0, "no_route_ipv4_drops": 0, "ttl_ipv6_drops": 0, "drop_route_ipv6_drops": 0, "ns_hold_pkt_drops": 0, "rpf_ipv6_drops": 0, "no_route_ipv6_drops": 0 }, "switch_security": { "nd_parse_errors": 0, "dhcp_client_block_ipv6_drops": 0, "dhcp_server_block_ipv6_drops": 0, "dhcp_client_block_ipv4_drops": 0, "dhcp_server_block_ipv4_drops": 0, "dhcp_client_validate_ipv4_drops": 0, "spoof_guard_ipv4_drops": 0, "spoof_guard_arp_drops": 0, "spoof_guard_ipv6_drops": 0, "spoof_guard_nd_drops": 0, "spoof_guard_non_ip_drops": 0, "bpdu_filter_drops": 0, "rx_rate_limit_bcast_drops": 0, "rx_rate_limit_mcast_drops": 0, "tx_rate_limit_bcast_drops": 0, "tx_rate_limit_mcast_drops": 0, "ra_guard_drops": 0, "rx_bcast_pkts": 0, "tx_bcast_pkts": 0, "rx_mcast_pkts": 0, "tx_mcast_pkts": 0 }, "virtual_switch": { "unknown_unicast_rx_uplink_pkts": 0, "unknown_unicast_tx_uplink_pkts": 0, "forged_transmit_rx_drops": 0, "vlan_tag_mismatch_rx": 0, "vlan_tag_mismatch_tx": 0, "vni_tag_mismatch_tx": 0, "vlan_tag_mismatch_rx_mcast": 0, "vlan_tag_mismatch_tx_mcast": 0, "vni_tag_mismatch_tx_mcast": 0 }, "distributed_firewall": { "rx_ipv4_drop_pkts": 0, "tx_ipv4_drop_pkts": 0, "rx_ipv6_drop_pkts": 0, "tx_ipv6_drop_pkts": 0, "rx_ipv4_reject_pkts": 0, "tx_ipv4_reject_pkts": 0, "rx_ipv6_reject_pkts": 0, "tx_ipv6_reject_pkts": 0, "rx_l2_drop_pkts": 0, "tx_l2_drop_pkts": 0, "bad_offset_drops": 0, "fragment_drops": 0, "short_drops": 0, "normalize_drops": 0, "memory_drops": 0, "bad_timestamp_drops": 0, "congestion_drops": 0, "ip_option_drops": 0, "proto_cksum_drops": 0, "state_insert_drops": 0, "state_limit_drops": 0, "syn_proxy_drops": 0, "spoof_guard_drops": 0, "icmp_err_pkt_drops": 0, "l7_alert_drops": 0, "alg_handler_drops": 0, "strict_no_syn_drops": 0, "icmp_error_drops": 0, "udp_flood_overlimit_drops": 0, "icmp_flood_overlimit_drops": 0, "tcp_flood_overlimit_drops": 0, "other_flood_overlimit_drops": 0, "syn_expected_drops": 0, "lb_reject_drops": 0, "l7_attr_error_drops": 0, "state_mismatch_drops": 0, "handshake_error_drops": 0, "seqno_outside_window_drops": 0, "seqno_old_retrans_drops": 0, "seqno_old_ack_drops": 0, "seqno_bad_ack_drops": 0, "seqno_gt_max_ack_drops": 0, "seqno_lt_minack_drops": 0, "ignored_offloaded_fpdrops": 0, "ignored_offloaded_spdrops": 0, "match_drop_rule_rx_drops": 0, "match_drop_rule_tx_drops": 0, "pkts_frag_queued_v4_misc": 0, "pkts_frag_queued_v6_misc": 0, "src_limit_misc": 0, "l7_pending_misc": 0 }, "fastpath": { "rx_drops": 0, "tx_drops": 0, "rx_drops_uplink": 0, "tx_drops_uplink": 0, "rx_drops_sp": 0, "tx_drops_sp": 0 }, "last_update_timestamp": 1706048000 }, "platform_cpu_usage_stats": { "host_net_thread_tx": { "num_threads": 11, "min_cpu": 0.0, "max_cpu": 0.01, "total_cpu": 0.01, "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": 11 }, "host_net_thread_rx": { "num_threads": 8, "min_cpu": 0.0, "max_cpu": 0.6, "total_cpu": 0.69, "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": 8 }, "host_net_thread_nioc": { "num_threads": 0, "min_cpu": 0.0, "max_cpu": 0.0, "total_cpu": 0.0, "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": 0 }, "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": 1706048000 }, "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": 1706048000 }, "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": 1706048000 } }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: