NSX-T Data Center REST API

Get a Policy EdgeTransport Node's State info under an Enforcement Point

Returns information about the current state of the edge transport node
configuration and information about the associated edge tn switches.

Request:

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

Example Request:

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

Successful Response:

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

Example Response:

{ "results": [ { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/d542ad6f-d069-4415-bd0d-27d9588c5e3d", "switch_states": [ { "switch_name": "nsxHostSwitch", "tunnel_endpoints": [ { "device_name": "vtep-0", "mac": "00:50:56:ab:17:c9", "label": 77825, "tep_group_label": 0, "realized_ips": [ { "ip": "172.20.10.17", "subnet_mask": "255.255.255.0" } ] } ] } ], "maintenance_mode_state": "DISABLED", "management_interface_state": { "realized_ips": [ { "ip": "10.160.244.135", "default_gateway": "10.160.240.1", "prefix_length": "21" } ] }, "appliance_state": { "allow_ssh_root_login": false, "enable_ssh": true, "enable_upt_mode": false }, "vm_placement_state": { "host_moref": "host-14" }, "edge_tn_state": { "deployment_state": { "state": "NODE_READY", "details": [ ], "failure_message": "", "failure_code": 0 }, "transport_node_state": { "state": "success", "failure_code": 0 }, "consolidated_status": "SUCCESS", "progress_state": { "progress": 100, "current_step_title": "Configuration complete" } } }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/5616e1db-1955-49ef-8990-892b213a60e2", "switch_states": [ { "switch_name": "nsxHostSwitch", "tunnel_endpoints": [ { "device_name": "vtep-0", "mac": "00:50:56:ab:ae:a3", "label": 13313, "tep_group_label": 0, "realized_ips": [ { "ip": "172.20.10.19", "subnet_mask": "255.255.255.0" } ] } ] } ], "maintenance_mode_state": "DISABLED", "management_interface_state": { "realized_ips": [ { "ip": "10.160.244.223", "default_gateway": "10.160.240.1", "prefix_length": "21" } ] }, "appliance_state": { "allow_ssh_root_login": false, "enable_ssh": true, "enable_upt_mode": false }, "vm_placement_state": { "host_moref": "host-14" }, "edge_tn_state": { "deployment_state": { "state": "NODE_READY", "details": [ ], "failure_message": "", "failure_code": 0 }, "transport_node_state": { "state": "success", "failure_code": 0 }, "consolidated_status": "SUCCESS", "progress_state": { "progress": 100, "current_step_title": "Configuration complete" } } }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/62684fc2-9704-11ef-8ae2-020037f1d7e5", "switch_states": [ { "switch_name": "nsxvswitch", "tunnel_endpoints": [ { "device_name": "vtep-0", "mac": "02:00:37:e4:fd:ff", "label": 111617, "tep_group_label": 0, "realized_ips": [ { "ip": "172.20.10.14", "subnet_mask": "255.255.255.0" } ] } ], "remote_tunnel_endpoints": [ { "device_name": "fp-eth1", "mac": "02:00:37:e4:fd:ff", "vlan": 500, "realized_ips": [ { "ip": "172.20.10.15", "subnet_mask": "255.255.255.0" } ] } ] } ], "maintenance_mode_state": "DISABLED", "management_interface_state": { "realized_ips": [ { "ip": "10.160.245.160", "default_gateway": "10.160.240.1", "prefix_length": "21" } ] }, "appliance_state": { "ntp_servers": [ "ntp.broadcom.net" ], "allow_ssh_root_login": false, "enable_ssh": true, "enable_upt_mode": false }, "edge_tn_state": { "deployment_state": { "state": "NODE_READY", "details": [ ] }, "transport_node_state": { "state": "success", "failure_code": 0 }, "consolidated_status": "SUCCESS", "progress_state": { "progress": 100, "current_step_title": "Configuration complete" } } } ], "result_count": 3 }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors: