NSX-T Data Center REST API

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+
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+

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 }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors: