System Administration >
Configuration
>
Fabric
>
Nodes
>
Transport Nodes
List transport nodes by realized state
Returns a list of transport node states that have realized state as provided
as query parameter
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.
Request:
Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/state
Request Headers:
n/a
Query Parameters:
TransportNodeStateParameters
+
TransportNodeStateParameters
(
schema
)
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>/policy/api/v1/infra/sites/
/enforcement-points/
/host-transport-nodes/state?status=IN_PROGRESS
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TransportNodeStateListResult
+
TransportNodeStateListResult
(
schema
)
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" } ] }
Required Permissions:
read
Feature:
nodes_transport_nodes
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