NSX-T Data Center REST API

Get Operational Status Summary of All Logical Ports in the System

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.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-ports/status

Request Headers:

n/a

Query Parameters:

LogicalPortListWithSourceParameters+

LogicalPortListWithSourceParameters (schema)

Name	Description	Type	Notes
attachment_id	Logical Port attachment Id	string
attachment_type	Type of attachment for logical port; NONE means no attachment.	AttachmentTypeQueryString
bridge_cluster_id	Bridge Cluster identifier	string
container_ports_only	Only container VIF logical ports will be returned if true	boolean	Default: "False"
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
diagnostic	Flag to enable showing of transit logical port.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
logical_switch_id	Logical Switch identifier	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
parent_vif_id	ID of the VIF of type PARENT Get logical ports that have CHILD VIF attachment of given PARENT VIF.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
switching_profile_id	Network Profile identifier	string
transport_node_id	Transport node identifier Get logical ports on the transport node; it can not be given together with other parameters except container_ports_only and attachment_type VIF.	string
transport_zone_id	Transport zone identifier	string

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalPortStatusSummary+

Name	Description	Type	Notes
filters	The filters used to find the logical ports- TransportZone id, LogicalSwitch id or LogicalSwitchProfile id	array of Filter
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
total_ports	The total number of logical ports.	integer	Required
up_ports	The number of logical ports whose Operational status is UP	integer	Required

Example Response:

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

Required Permissions:

read

Feature:

aggregation_service_health_monitoring