NSX-T Data Center REST API

List Transport Nodes

Returns information about all transport nodes along with underlying host or
edge details. A transport node is a host or edge 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.

Request:

Method:
GET
URI Path(s):
/api/v1/transport-nodes
Request Headers:
n/a
Query Parameters:
TransportNodeListParameters+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TransportNodeListResult+

Example Response:

{ "results": [ { "node_id": "e305ffb8-71db-11ec-85b8-020018d87cf3", "host_switch_spec": { "host_switches": [ { "host_switch_name": "nsxHostSwitch", "host_switch_id": "5d893a94-93b6-442a-b66c-fa6504c870d2", "host_switch_type": "NVDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "cf324632-1d0b-11e8-b322-6f20be6de3bc" }, { "key": "LldpHostSwitchProfile", "value": "9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb" } ], "pnics": [ { "device_name": "fp-eth0", "uplink_name": "uplink-1" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "ip_list": [ "10.12.113.2", "10.12.113.126" ], "default_gateway": "10.12.113.100", "subnet_mask": "255.255.253.0", "resource_type": "StaticIpListSpec" }, "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" } ] } ], "pnics_uninstall_migration": [], "vmk_uninstall_migration": [], "not_ready": false } ], "resource_type": "StandardHostSwitchSpec" }, "maintenance_mode": "ENABLED", "node_deployment_info": { "deployment_type": "VIRTUAL_MACHINE", "node_settings": { "hostname": "edge", "enable_ssh": true, "allow_ssh_root_login": true }, "resource_type": "EdgeNode", "external_id": "e305ffb8-71db-11ec-85b8-020018d87cf3", "ip_addresses": [ "10.168.113.108" ], "id": "e305ffb8-71db-11ec-85b8-020018d87cf3", "display_name": "edge", "_revision": 8 }, "is_overridden": false, "resource_type": "TransportNode", "id": "e305ffb8-71db-11ec-85b8-020018d87cf3", "display_name": "edge", "_create_time": 1641794978659, "_create_user": "admin", "_last_modified_time": 1642005190321, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 8 }, { "node_id": "55120a1a-51c6-4c20-b4a3-6f59662c9f6a", "host_switch_spec": { "host_switches": [ { "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" }, "transport_zone_endpoints": [], "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", "resource_type": "HostNode", "id": "55120a1a-51c6-4c20-b4a3-6f59662c9f6a", "display_name": "10.161.68.92", "external_id": "55120a1a-51c6-4c20-b4a3-6f59662c9f6a", "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" ], "_create_user": "admin", "_create_time": 1582059020923, "_last_modified_user": "admin", "_last_modified_time": 1582857396435, "_protection": "NOT_PROTECTED", "_revision": 2 }, "is_overridden": false, "resource_type": "TransportNode", "id": "55120a1a-51c6-4c20-b4a3-6f59662c9f6a", "display_name": "TN1", "description": "DemoTransportNode1", "tags": [], "_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: