List transport nodes by realized state

Returns a list of transport node states that have realized state as provided
as query parameter.
If this API is called multiple times in parallel then it
will fail with error indicating that another request is already in progress.
In such case, try the API on another NSX manager instance (if exists) or try
again after some time.

Request:

Method:

GET

URI Path(s):

/api/v1/transport-nodes/state

Request Headers:

n/a

Query Parameters:

TransportNodeStateParameters+

Name	Description	Type	Notes
mm_state	Realized maintenance node state	MaintenanceModeState
status	Realized state of transport nodes	string	Enum: PENDING, IN_PROGRESS, SUCCESS, PARTIAL_SUCCESS, FAILED, ORPHANED
vtep_ip	Virtual tunnel endpoint ip address of transport node	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-nodes/state?status=IN_PROGRESS

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNodeStateListResult+

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	Transport Node State Results	array of TransportNodeState	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "state" : "in_progress", "node_deployment_state": "success", "transport_node_id" : "366048ba-89d9-435e-ac2e-2c7cf6ed0f33", "host_switch_states" : [ { "state" : "in_progress", "host_switch_id" : "58 20 ca 9e ff da 40 19-86 06 39 d2 0c 0a d7 c5", "endpoints" : [ { "subnet_mask" : "255.255.255.224", "device_name" : "vmk10", "label" : 593280, "default_gateway" : "", "ip" : "169.254.177.12" } ], "host_switch_name" : "opaque-switch-1" } ] }

List transport nodes by realized state

Request:

TransportNodeStateParameters (schema)

Example Request:

Successful Response:

TransportNodeStateListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: