NSX-T Data Center REST API

Get Operational Status Summary of All Logical Ports in the System (Deprecated)

Returns operational status of all logical ports.
The query parameter "source=realtime" is not supported.
Pagination is not supported for this API.
The query parameters "cursor", "sort_ascending", "sort_by", "page_size" and "included_fields"
will be ignored.
Deprecated:
This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

Request:

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

Successful Response:

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

Example Response:

{ "up_ports": 6, "total_ports": 6 }

Required Permissions:

read

Feature:

aggregation_service_health_monitoring

Additional Errors: