List Transport Node collections

Returns all Transport Node collections

Request:

Method:

GET

URI Path(s):

/api/v1/transport-node-collections

Request Headers:

n/a

Query Parameters:

TransportNodeCollectionListRequestParameters+

Name	Description	Type
cluster_moid	Managed object ID of cluster in VC Managed object ID of cluster in VC. vc_instance_uuid has to be provided along with this parameter otherwise it will return empty list.	string
compute_collection_id	Compute collection id Compute collection id against which the serach will be done. If this parameter is provided then other parameters will be ignored.	string
vc_instance_uuid	UUID for VC deployment This is UUID of VC deployment as seen in managed objects of VC as "instanceUuid". cluster_moid has to be provided along with this parameter otherwise it will return empty list.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-node-collections

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNodeCollectionListResult+

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 collection results	array of TransportNodeCollection	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:

{ "result_count" : 1, "results": [{ "resource_type": "TransportNodeCollection", "description": "TransportNodeCollection 1", "id": "46ea1ae3-b067-4985-bd9e-6e1d4b1b2ec1", "display_name": "TransportNodeCollection-1", "compute_collection_id": "33dbf426-c282-42a0-9ae2-5e924b8a78b4:domain-c38", "transport_node_profile_id": "0840e9c6-3c7b-46a9-aea7-82bb1190709d", "_create_user": "admin", "_create_time": 1495147708462, "_last_modified_user": "admin", "_last_modified_time": 1495147708462, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }] }

List Transport Node collections

Request:

TransportNodeCollectionListRequestParameters (schema)

Example Request:

Successful Response:

TransportNodeCollectionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: