NSX-T Data Center REST API

Get Operational Status for Logical Port of a Given Port ID (lport-id) (Deprecated)

Returns operational status of a specified logical port. Deprecated:
This api is deprecated from 3.2.2. Please use policy api -
/infra/segments/<segment-id>/ports/<segment-port-id>/status

Request:

Method:

GET

URI Path(s):

/api/v1/logical-ports/{lport-id}/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

DataSourceParameters (schema)

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalPortOperationalStatus+

LogicalPortOperationalStatus (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_port_id	The id of the logical port	string	Required Readonly
status	The Operational status of the logical port	string	Required Enum: UP, DOWN, UNKNOWN

Example Response:

{ "logical_port_id": "04efc498-b872-40fc-83f8-ebf9317a2766", "last_update_timestamp": 1453764613211, "status": "UP" }

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