Get Transport Node collection by id

Returns transport node collection by id

Request:

Method:

GET

URI Path(s):

/api/v1/transport-node-collections/{transport-node-collection-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-node-collections/46ea1ae3-b067-4985-bd9e-6e1d4b1b2ec1

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNodeCollection+

TransportNodeCollection (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
compute_collection_id	Compute collection id	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
has_nvds	Flag indicating if applied profile has NVDS	boolean	Deprecated
id	Unique identifier of this resource	string	Sortable
install_mode	Flag indicating security status of Transport Node Collection	string	Readonly Enum: MICROSEG, NORMAL
resource_type	Must be set to the value TransportNodeCollection	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_node_profile_id	Transport Node Profile ID	string	Required

Example Response:

{ "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 }

Get Transport Node collection by id

Request:

Example Request:

Successful Response:

TransportNodeCollection (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: