NSX-T Data Center REST API

Get Status Summary of All Logical Switches in the System

Returns Operational status of all logical switches.
The query parameter "source=realtime" is not supported.

Request:

Method:
GET
URI Path(s):
/api/v1/logical-switches/status
Request Headers:
n/a
Query Parameters:
LogicalSwitchListWithSourceParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-switches/status

Successful Response:

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

Example Response:

{ "total_switches": 6, "fully_realized_switches": 6 }

Required Permissions:

read

Feature:

aggregation_service_health_monitoring

Additional Errors: