NSX-T Data Center REST API

Get ARP table from segment interface (downlink)

Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
interface (downlink) attaching segment to tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table

Request Headers:

n/a

Query Parameters:

ArpTableRequestParameters+

ArpTableRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge node Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
host_transport_node_path	Policy path of host transport node Policy path of host transport node. In case of API used from Global Manager, use the HostTransportNode path from Local Manager.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/segments/web-app-seg/arp-table?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

InterfaceArpTable+

InterfaceArpTable (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
edge_path	Policy path of edge node Policy path of edge node.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point.	string
interface_path	The ID of the logical router port	string	Required
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of InterfaceArpEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "displayName", "result_count": 3, "interface_path": "/infra/realized-state/enforcement-points/default/logical-ports/t1-web-app-seg-dlrp", "enforcement_point_path": "/infra/sites/default/enforcement-points/default", "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7", example_response: | "results": [ { "mac_address": "00:50:56:8e:b4:21", "ip": "172.16.10.21" }, { "mac_address": "02:50:56:56:44:52", "ip": "172.16.10.1" }, { "mac_address": "00:50:56:8e:91:12", "ip": "172.16.10.11" } ] }