Creates a status json report of transport nodes in a transport zone

Request:

Method:

GET

URI Path(s):

/api/v1/transport-zones/{zone-id}/transport-node-status-report-json

Request Headers:

n/a

Query Parameters:

TransportNodeReportParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
status	Transport node	string	Enum: UP, DOWN, DEGRADED

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-zones/4971383d-f792-4b36-8854-e78a79853948/transport-node-status-report-json

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNodeStatusReportListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of transport node status report	array of TransportNodeStatusReport
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results" : [ { "node_uuid" : "b038df0e-c489-11ed-94de-064541e54f04", "control_connection_status" : "UP", "pnic_status" : "UP", "mgmt_connection_status" : "UP", "tunnel_status" : "UP", "agent_status" : "UP", "up_tunnel_count" : 2, "down_tunnel_count" : 0, "up_agent_count" : 1, "down_agent_count" : 0 }, { "node_uuid" : "d1409fa8-dfb4-4101-abd0-068bd3aa620f", "control_connection_status" : "UP", "pnic_status" : "UP", "mgmt_connection_status" : "UP", "tunnel_status" : "UP", "agent_status" : "UP", "up_tunnel_count" : 2, "down_tunnel_count" : 0, "up_agent_count" : 3, "down_agent_count" : 0 }], "result_count" : 2 }

Creates a status json report of transport nodes in a transport zone

Request:

TransportNodeReportParameters (schema)

Example Request:

Successful Response:

TransportNodeStatusReportListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: