Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)

Returns the virtual tunnel endpoint table of a specified logical switch
from the given transport node if a transport node id is given in the
query parameter, from the Central Controller Plane.
The query parameter "source=cached" is not supported.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-switches/<lswitch-id>/vtep-table

Request Headers:

n/a

Query Parameters:

ListByNodeIdParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	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
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	TransportNode Id	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-switches/<lswitch-id>/vtep-table?source=realtime

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VtepListResult+

VtepListResult (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
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_switch_id	The id of the logical Switch	string	Required Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of VtepTableEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
transport_node_id	Transport node identifier	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "displayName", "result_count": 2, "logical_switch_id": "2bcc9f42-0fb8-4a30-b4a6-db6d4abedf5a", "results": [ { "vtep_mac_address": "00:50:56:6b:e9:b5", "vtep_label": 10241, "vtep_ip": "159.213.45.33", "segment_id": "159.213.45.0" }, { "vtep_mac_address": "04:00:9f:d5:2d:23", "vtep_label": 57345, "vtep_ip": "159.213.45.35", "segment_id": "159.213.45.0" } ] }

Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)

Request:

ListByNodeIdParameters (schema)

Example Request:

Successful Response:

VtepListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: