Get tier-1 segment port state

Returns tier-1 segment port state on enforcement point

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state

Request Headers:

n/a

Query Parameters:

PolicyRuntimeRequestParameters+

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/TIER1_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+

Name	Description	Type	Notes
attachment	Segment port attachment state	SegmentPortAttachmentState	Readonly
discovered_bindings	Segment port bindings discovered automatically Contains the list of address bindings for a segment port that were automatically dicovered using various snooping methods like ARP, DHCP etc.	array of AddressBindingEntry
duplicate_bindings	Duplicate segment port address bindings If any address binding discovered on the port is also found on other port on the same segment, then it is included in the duplicate bindings list along with the ID of the port with which it conflicts.	array of DuplicateAddressBindingEntry
realized_bindings	Realized segment port bindings List of segment port bindings that are realized. This list may be populated from the discovered bindings or manual user specified bindings. This binding configuration can be used by features such as firewall, spoof-guard, traceflow etc.	array of AddressBindingEntry
transport_node_ids	Identifiers of the transport nodes where the port is located	array of string

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" } ] } }

Get tier-1 segment port state

Request:

PolicyRuntimeRequestParameters (schema)

Example Request:

Successful Response:

SegmentPortState (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: