NSX-T Data Center REST API

Get Statistics for Logical Switch of the Given ID (lswitch-id). (Deprecated)

Returns statistics of a specified logical switch. For real time statistics source, transport_node_id and stats_type are mandatory.
Deprecated: This API is now deprecated. Please use new API - GET policy/api/v1/infra/segments/<segment-id>/statistics

Request:

Method:

GET

URI Path(s):

/api/v1/logical-switches/{lswitch-id}/statistics

Request Headers:

n/a

Query Parameters:

LogicalSwitchStatisticsParameters+

LogicalSwitchStatisticsParameters (schema)

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
stats_type	Logical switch statistics type.	string	Enum: DATAPATH_STATS
transport_node_id	TransportNode Id	string

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalSwitchStatistics+

LogicalSwitchStatistics (schema)

Name	Description	Type	Notes
dropped_by_firewall_packets		DfwDropCounters	Readonly
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_switch_id	The id of the logical Switch	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
nsxt_fp	ENS/FC module for DP packet processing	FpCounters	Readonly
nsxt_swsec	Switch Security provides stateless L2 and L3 security by checking, traffic to the logical switch and dropping unauthorized packets sent, from VMs	SwsecCounters	Readonly
nsxt_vdl2	Overlay Layer-2 module responsible for workload connectivity	Vdl2Counters	Readonly
nsxt_vdrb	Virtual Distributed Routing (VDR) routes packets on every ESX	VdrbCounters	Readonly
nsxt_vsip	VSIP provides Distributed Firewall capability	VsipCounters	Readonly
nsxt_vswitch	Virtual Switch is responsible for providing switching functionality	VswitchCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

Example Response:

{ "tx_packets": { "total": 18, "dropped": 0, "multicast_broadcast": 0 }, "rx_bytes": { "total": 22358, "multicast_broadcast": 11473 }, "tx_bytes": { "total": 1068, "multicast_broadcast": 0 }, "rx_packets": { "total": 98, "dropped": 42, "multicast_broadcast": 56 }, "logical_switch_id": "2bcc9f42-0fb8-4a30-b4a6-db6d4abedf5a" }

Required Permissions:

read

Feature:

aggregation_service_health_monitoring

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable