List Host Transport Nodes

Returns information about all host transport nodes along with underlying host details.
A transport node is a host that contains hostswitches.
A hostswitch can have virtual machines connected to them.

Because each transport node has hostswitches, transport nodes can also have
virtual tunnel endpoints, which means that they can be part of the overlay.
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

Request Headers:

n/a

Query Parameters:

HostTransportNodeListParameters+

HostTransportNodeListParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
discovered_node_id	discovered node id This property can be used by itself or along with 'transport_zone_path'. This applies only to vCenter Managed hosts. For Unmanaged hosts use node_ip instead. These hosts are discovered by Nsx manager after adding a vCenter as Compute Manager. Refer to fabric discovered-nodes api to get discoverednode_id. eg. 6ab2278f-951d-471b-8d0f-510c825945f1:host-14	string
in_maintenance_mode	maintenance mode flag If the flag is true, transport node with 'ENABLED' or 'FORCE_ENABLED' desired state will be returned, otherwise transport nodes in 'DISABLED' will be returned.	boolean
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
node_ip	Transport node IP address This property can only be used alone. It can not be combined with other filtering properties.	string
node_types	a list of node types separated by comma or a single type Specify types from [HostNode, EdgeNode, PublicCloudGatewayNode]. If a list of node types is given, all transport nodes of given types will be returned.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
transport_zone_path	Transport zone path This property can be used along with 'node_id'. Valid Policy Tz path should be given, eg. /infra/sites/default/enforcement-points/default/transport-zones/web-tz1	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites//enforcement-points//host-transport-nodes

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

HostTransportNodeListResult+

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	Host TransportNode Results	array of HostTransportNode	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:

{ "results": [ { "host_switch_spec": { "host_switches": [ { "host_switch_name": "nsxvswitch1", "host_switch_id": "25a26485-c9fa-4d19-a141-45cfcb8b5554", "host_switch_type": "nvds", "host_switch_mode": "standard", "host_switch_profile_ids": [ { "key": "uplinkhostswitchprofile", "value": "0a26d126-7116-11e5-9d70-feff819cdc9f" }, { "key": "niocprofile", "value": "8cb3de94-2834-414c-b07d-c034d878db56" }, { "key": "lldphostswitchprofile", "value": "9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb" } ], "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink-1" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "assignedbydhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "a95c914d-748d-497c-94ab-10d4647daeba", "transport_zone_profile_ids": [ { "resource_type": "bfdhealthmonitoringprofile", "profile_id": "52035bb3-ab02-4a08-9884-18631312e50a" } ] }, { "transport_zone_id": "f9f39e61-85da-4704-97c6-d23e46bcd08d", "transport_zone_profile_ids": [ { "resource_type": "bfdhealthmonitoringprofile", "profile_id": "52035bb3-ab02-4a08-9884-18631312e50a" } ] } ], "vmk_install_migration": [], "pnics_uninstall_migration": [], "vmk_uninstall_migration": [], "not_ready": false }, { "host_switch_name": "dvs1", "host_switch_id": "50 21 0c 52 94 22 aa 20-b7 f0 0b da 1c 7c 29 ea", "host_switch_type": "VDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "0a26d126-7116-11e5-9d70-feff819cdc9f" } ], "pnics": [], "uplinks": [ { "vds_uplink_name": "Uplink 1", "uplink_name": "uplink-1" }, { "vds_uplink_name": "Uplink 2", "uplink_name": "uplink-2" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "AssignedByDhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "1b3a2f36-bfd1-443e-a0f6-4de01abc963e", "transport_zone_profile_ids": [ { "resource_type": "BfdHealthMonitoringProfile", "profile_id": "52035bb3-ab02-4a08-9884-18631312e50a" } ] }, { "transport_zone_id": "3f9dcf09-d6dd-45ca-a144-540d5817c1de", "transport_zone_profile_ids": [ { "resource_type": "BfdHealthMonitoringProfile", "profile_id": "52035bb3-ab02-4a08-9884-18631312e50a" } ] } ], "vmk_install_migration": [], "pnics_uninstall_migration": [], "vmk_uninstall_migration": [], "not_ready": false } ], "resource_type": "StandardHostSwitchSpec" }, "maintenance_mode": "DISABLED", "node_deployment_info": { "os_type": "ESXI", "os_version": "7.0.0", "managed_by_server": "10.161.7.82", "discovered_node_id": "0031e94d-b40a-4f53-ba3f-f30e6937180e:host-44", "fqdn": "sc-rdops-vm11-dhcp-68-92.eng.vmware.com", "ip_addresses": [ "10.161.68.92" ], "discovered_ip_addresses": [ "10.161.68.92", "172.16.223.211", "169.254.102.88", "172.16.223.210", "172.16.223.175", "169.254.1.1", "169.253.1.1" ], }, "is_overridden": false, "resource_type": "HostTransportNode", "description": "DemoTransportNode1", "tags": [], "id": "HostTn1", "display_name": "HostTn1", "path": "/infra/sites/default/enforcement-points/default/host-transport-nodes/HostTn1", "relative_path": "HostTn1", "parent_path": "/infra/sites/default/enforcement-points/default/", "unique_id": "009b32f1-a361-4cfc-8d4f-f8886f7c2321", "marked_for_delete": false, "_create_user": "admin", "_create_time": 1582059023196, "_last_modified_user": "admin", "_last_modified_time": 1582849668528, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 2 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

List Host Transport Nodes

Request:

HostTransportNodeListParameters (schema)

Example Request:

Successful Response:

HostTransportNodeListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: