List All Logical Ports

Returns information about all configured logical switch ports. Logical
switch ports connect to VM virtual network interface cards (NICs). Each
logical port is associated with one logical switch.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-ports

Request Headers:

n/a

Query Parameters:

LogicalPortListParameters+

LogicalPortListParameters (schema)

Name	Description	Type	Notes
attachment_id	Logical Port attachment Id	string
attachment_type	Type of attachment for logical port; NONE means no attachment.	AttachmentTypeQueryString
bridge_cluster_id	Bridge Cluster identifier	string
container_ports_only	Only container VIF logical ports will be returned if true	boolean	Default: "False"
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
diagnostic	Flag to enable showing of transit logical port.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
logical_switch_id	Logical Switch identifier	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
parent_vif_id	ID of the VIF of type PARENT Get logical ports that have CHILD VIF attachment of given PARENT VIF.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
switching_profile_id	Network Profile identifier	string
transport_node_id	Transport node identifier Get logical ports on the transport node; it can not be given together with other parameters except container_ports_only and attachment_type VIF.	string
transport_zone_id	Transport zone identifier	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-ports

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalPortListResult+

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
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	LogicalPort Results	array of LogicalPort	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 2, "results": [ { "id": "2f904690-355a-4900-841e-645b3d7fee91", "display_name": "2f904690-355a-4900-841e-645b3d7fee91", "resource_type": "LogicalPort", "address_bindings": [], "logical_switch_id": "849e339e-64b7-47cb-9480-33068f70dc5a", "admin_state": "UP", "attachment": { "id": "f941da72-2b4a-4212-9183-74029d41377e", "attachment_type": "VIF" }, "switching_profile_ids": [ { "value": "49781ebb-6f76-464a-9a7e-c365ba26128b", "key": "IpDiscoverySwitchingProfile" }, { "value": "fad98876-d7ff-11e4-b9d6-1681e6b88ec1", "key": "SpoofGuardSwitchingProfile" }, { "value": "93b4b7e8-f116-415d-a50c-3364611b5d09", "key": "PortMirroringSwitchingProfile" }, { "value": "fbc4fb17-83d9-4b53-a286-ccdf04301888", "key": "SwitchSecuritySwitchingProfile" }, { "value": "f313290b-eba8-4262-bd93-fab5026e9495", "key": "QosSwitchingProfile" } ], "_last_modified_user": "system", "_last_modified_time": 1435282553271, "_create_time": 1435282553249, "_system_owned": true, "_create_user": "system", "_revision": 1 }, { "id": "9467676a-aeae-46f7-90f1-c771e02d1669", "display_name": "9467676a-aeae-46f7-90f1-c771e02d1669", "resource_type": "LogicalPort", "address_bindings": [], "logical_switch_id": "849e339e-64b7-47cb-9480-33068f70dc5a", "admin_state": "UP", "attachment": { "id": "65332f8d-efa2-4dd9-9c92-39ca0bfb1966", "attachment_type": "VIF" }, "switching_profile_ids": [ { "value": "49781ebb-6f76-464a-9a7e-c365ba26128b", "key": "IpDiscoverySwitchingProfile" }, { "value": "fad98876-d7ff-11e4-b9d6-1681e6b88ec1", "key": "SpoofGuardSwitchingProfile" }, { "value": "93b4b7e8-f116-415d-a50c-3364611b5d09", "key": "PortMirroringSwitchingProfile" }, { "value": "fbc4fb17-83d9-4b53-a286-ccdf04301888", "key": "SwitchSecuritySwitchingProfile" }, { "value": "f313290b-eba8-4262-bd93-fab5026e9495", "key": "QosSwitchingProfile" } ], "_last_modified_user": "system", "_last_modified_time": 1435282426932, "_create_time": 1435282426867, "_system_owned": true, "_create_user": "system", "_revision": 1 } ] }

List All Logical Ports

Request:

LogicalPortListParameters (schema)

Example Request:

Successful Response:

LogicalPortListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: