Management Plane API >
Networking
>
Logical Switching
>
Logical Switches
Get Logical Switch runtime status info for a given logical switch
Returns the number of ports assigned to a logical switch.
Request:
Method:
GET
URI Path(s):
/api/v1/logical-switches/<lswitch-id>/summary
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/logical-switches/cc5ff938-6f09-4841-8f0f-294e86415472/summary
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LogicalSwitchStatus
+
LogicalSwitchStatus
(
schema
)
Name
Description
Type
Notes
logical_switch_id
Unique ID identifying the the Logical Switch
string
Readonly
num_logical_ports
Count of Logical Ports belonging to this switch
int
Readonly
Example Response:
{ "logical_switch_id": "cc5ff938-6f09-4841-8f0f-294e86415472", "num_logical_ports": 0 }
Required Permissions:
read
Feature:
switching_switches
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable