List Logical Ports | NSX-T Data Center REST API

List 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

URI

GET

https://nsxmanager.your.domain/api/v1/logical-ports

COPY

Query Parameters

string

attachment_id

Optional

Logical Port attachment Id

string

attachment_type

Optional

Type of attachment for logical port; for query only.

Possible values are : VIF, LOGICALROUTER, BRIDGEENDPOINT, DHCP_SERVICE, METADATA_PROXY, NONE,

string

bridge_cluster_id

Optional

Bridge Cluster identifier

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

diagnostic

Optional

Flag to enable showing of transit logical port.

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

string

logical_switch_id

Optional

Logical Switch identifier

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

parent_vif_id

Optional

ID of the VIF of type PARENT

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

switching_profile_id

Optional

Network Profile identifier

string

transport_node_id

Optional

Transport node identifier

string

transport_zone_id

Optional

Transport zone identifier

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns LogicalPortListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineLogicalPortListResult1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_create_time": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_last_modified_time": 0,
            "_create_user": "string",
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "logical_switch_id": "string",
            "switching_profile_ids": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "attachment": {
                "attachment_type": "string",
                "context": {
                    "allocate_addresses": "string",
                    "resource_type": "string"
                },
                "id": "string"
            },
            "admin_state": "string",
            "address_bindings": [
                {
                    "vlan": 0,
                    "ip_address": "string",
                    "mac_address": "string"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure