NSX Autonomous Edge REST API

List Ports

Returns information about all logical ports.

Request:

Method:

GET

URI Path(s):

/ports

Request Headers:

n/a

Query Parameters:

LogicalPortListParameters+

LogicalPortListParameters (schema)

Name	Description	Type	Notes
l2_extension_id	Id of a specified l2vpn session List all of the logical ports that are extended via the specified l2vpn session id.	string
port_type	Type of logical port If routed, list all of the routed logical ports. If extended, list all of the extended logial ports. If none, list all pure l2 logical ports (not routed and extended).	string	Enum: routed, extended, none

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalPortListResult+

LogicalPortListResult (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	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
page_cursor	Opaque cursor for next page of results, (not set on last page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Logical port list results	array of LogicalPort (Abstract type: pass one of the following concrete types) LogicalRouterIPTunnelPort LogicalRouterLoopbackPort LogicalRouterPort	Required

Example Response:

{ "_self": { "href": "/api/v1/ports", "rel": "self" }, "result_count": 1, "results": [ { "subnets": [ { "ip_addresses": [ "192.168.1.1" ], "prefix_length": 24 } ], "display_name": "lrport_1", "urpf_mode": "STRICT", "vlan_id": 10, "exit_interface": "eth2", "mac_address": "00:50:56:bc:af:45", "id": "48e5f449-153f-4d31-9e98-64a3f1ecc3fc", "resource_type": "LogicalRouterPort" } ], "_schema": "LogicalPortListResult" }

Required Permissions:

read

Feature:

routing_routers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable