NSX-T Data Center REST API

Read an Edge Transport Node under an Enforcement Point

Read an Edge Transport Node under an Enforcement Point

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id

Successful Response:

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

Example Response:

{ "display_name": "Edge-TN", "description": "Admin!23Admin", "resource_type": "EdgeTransportNode", "id": "my-edge-tn-id", "unique_id": "3bc1e3b0-1cd4-4339-86c8-f76baddbaafb", "failure_domain_path": "/infra/sites/default/enforcement-points/default/failure-domains/4fc1e3b0-1cd4-4339-86c8-f76baddbaafb", "deployment_type": "VIRTUAL_MACHINE", "form_factor": "SMALL", "tags": [], "hostname": "edge-hostname.com", "vm_deployment_config": { "placement_type": "VsphereDeploymentConfig", "vc_id": "8a54189e-c657-4ab3-9e30-412bb701e4a6", "compute_id": "`resgroup-10", "host_id": "host_id_value", "compute_folder_id": "compute_folder_id_value", "resource_pool_id": "resource_pool_id_value", "storage_id": "datastore-14", "edge_host_affinity_config": { "host_group_name" : "host-1" }, "reservation_info": { "memory_reservation": { "reservation_percentage": 40 }, "cpu_reservation": { "reservation_in_shares": "EXTRA_HIGH_PRIORITY", "reservation_in_mhz": 75 } } }, "appliance_config": { "search_domains": [ "search-domain.com" ], "ntp_servers": [ "ntp-server.com" ], "dns_servers": [ "10.191.197.65" ], "syslog_servers": [], "enable_ssh": true, "allow_ssh_root_login": true, "enable_upt_mode": true }, "credentials": { "root_password": "Admin!23Admin", "cli_password": "Admin!23Admin", "cli_username": "admin", "audit_username": "root", "audit_password": "Admin!23Admin" }, "management_interface": { "network_id": "network-16", "ip_assignment_specs": [ { "assignment_type": "STATICV4", "management_port_subnet": { "ip_addresses": [ "10.161.128.83" ], "prefix_length": "24" }, "default_gateway": "10.161.159.253" }, { "assignment_type": "STATICV6", "management_port_subnet": { "ip_addresses": [ "fd00::5:e20" ], "prefix_length": "64" }, "default_gateway": "fd00::5:e50" } ] }, "switch_spec": { "switches": [ { "switch_name": "nsxHostSwitch", "switch_profile_paths": [ { "type": "UplinkHostSwitchProfile", "path": "/infra/host-switch-profiles/uplinkProfile1" } ], "overlay_transport_zone_paths": [ "/infra/sites/default/enforcement-points/default/transport-zones/overlay-tz1" ], "vlan_transport_zone_paths": [ "/infra/sites/default/enforcement-points/default/transport-zones/vlan-tz1", "/infra/sites/default/enforcement-points/default/transport-zones/vlan-tz2" ], "tunnel_endpoints": [ { "device_name": "device-name", "ip_assignment_specs": [ { "assignment_type": "STATICV6POOL", "ip_pool": "/infra/ip-pools/Ipv6-pool" }, { "assignment_type": "STATICV4", "static_ips": [ "153.243.242.83" ], "default_gateway": "10.161.159.253", "subnet_mask": "255.255.255.0" } ] } ], "remote_tunnel_endpoint": [ { "named_teaming_policy": "named_teaming_policy_name", "ip_assignment_specs": [ { "assignment_type": "STATICV4POOL", "ip_pool": "/infra/ip-pools/Ipv4-rtep-pool" } ], "vlan": 500, "device_name": "device-name" } ], "pnics": [ { "device_name": "fb-eth0", "datapath_network_id": "dvportgroup-59", "uplink_name": "uplink-1" } ] } ] }, "create_user": "admin", "_create_time": 1517262573524, "_last_modified_user": "admin", "_last_modified_time": 1517262753660, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } PUT https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id { "failure_domain_path": "/infra/sites/default/enforcement-points/default/failure-domains/my-policy-failure-domain-id", "deployment_type": "VIRTUAL_MACHINE", "node_type": "EDGE_NODE", "form_factor": "SMALL", "hostname": "my-edge-tn-id-host.com", "vm_deployment_config": { "vc_id": "2bab11cd-ee62-407c-948c-1ff3f1e6c397", "compute_id": "domain-c18", "storage_id": "datastore-15", "edge_host_affinity_config": { "host_group_name" : "host-1" }, "reservation_info": { "memory_reservation": { "reservation_percentage": 10 }, "cpu_reservation": { "reservation_in_shares": "LOW_PRIORITY", "reservation_in_mhz": 10 } }, "placement_type": "PolicyVsphereDeploymentConfig" }, "appliance_config": { "search_domains": [ "123.1.1.1" ], "ntp_servers": [ "times.com" ], "allow_ssh_root_login": true, "dns_servers": [ "123.23.2.2", "123.4.5.5" ], "enable_ssh": true, "enable_upt_mode": false }, "credentials": { "cli_password": "Admin!23Admin", "root_password": "Admin!23Admin", "cli_username": "admin", "audit_username": "audit", "audit_password": "Admin!23Admin" }, "management_interface": { "ip_assignment_specs": [ { "management_port_subnets": [ { "ip_addresses": [ "fc7e:f206:db42:0:0:0:0:2" ], "prefix_length": 48 } ], "default_gateway": [ "fc7e:f206:db42:0:0:0:0:1" ], "ip_assignment_type": "StaticIpv6" }, { "ip_assignment_type": "Dhcpv4" } ], "network_id": "dvportgroup-48" }, "switch_spec": { "switches": [ { "switch_name": "nsxHostSwitch", "profile_paths": [ { "key": "UplinkHostSwitchProfile", "value": "/infra/host-switch-profiles/my-uplink-profile-id" } ], "overlay_transport_zone_paths": [ "/infra/sites/default/enforcement-points/default/transport-zones/my-transport-zone-overlay-id" ], "vlan_transport_zone_paths": [ "/infra/sites/default/enforcement-points/default/transport-zones/my-transport-zone-vlan-id" ], "pnics": [ { "device_name": "fp-eth0", "uplink_name": "uplink1", "datapath_network_id": "dvportgroup-48" } ], "tunnel_endpoints": [ { "ip_assignment_specs": [ { "ip_pool": "/infra/ip-pools/ippool-policy-ipv4", "ip_assignment_type": "StaticIpv4Pool" } ] } ] } ] } }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors: