NSX-T Data Center REST API

Get infra segment port state

Returns infra segment port state on enforcement point

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/state
/policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/state
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/state
Request Headers:
n/a
Query Parameters:
PolicyRuntimeRequestParameters+
Request Body:
n/a

Example Request:

https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/ports/default:d03f67f8-efd0-491b-955e-82d8323cffa0/state

Successful Response:

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

Example Response:

{ "transport_node_ids": [ "01b3242e-a7c8-11ea-9a01-278a0b44b8c9" ], "discovered_bindings": [ { "source": "VM_TOOLS", "binding": { "ip_address": "192.168.100.162", "mac_address": "00:0c:29:46:b0:72", "vlan": 0 }, "binding_timestamp": 1591432722000 }, { "source": "ARP_SNOOPING", "binding": { "ip_address": "192.168.100.162", "mac_address": "00:0c:29:46:b0:72", "vlan": 0 }, "binding_timestamp": 1591853619530 } ], "realized_bindings": [ { "source": "VM_TOOLS", "binding": { "ip_address": "192.168.100.162", "mac_address": "00:0c:29:46:b0:72", "vlan": 0 }, "binding_timestamp": 1591432722000 }, { "source": "ARP_SNOOPING", "binding": { "ip_address": "192.168.100.162", "mac_address": "00:0c:29:46:b0:72", "vlan": 0 }, "binding_timestamp": 1591434843090 } ], "duplicate_bindings": [], "attachment": { "id": "ef25f3f5-f19a-4aa2-9c6a-842e44d5297b", "state": "ATTACHED", "attachers": [ { "host": "01b3242e-a7c8-11ea-9a01-278a0b44b8c9", "entity": "/vmfs/volumes/5edb3cde-ed7a2d43-f9d3-0200637d79e5/32-vm_Client_VM_Ubuntu_1404-local-1700/32-vm_Client_VM_Ubuntu_1404-local-1700.vmx" } ] } }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: