List Logical Router Ports

Returns information about all logical router ports. Information includes the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); logical_router_id (the router to which each logical router port is assigned); and any service_bindings (such as DHCP relay service). The GET request can include a query parameter (logical_router_id or logical_switch_id).

Request

URI

GET

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

COPY

Query Parameters

string

cursor

Optional

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

string

included_fields

Optional

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

string

logical_router_id

Optional

Logical Router identifier

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

resource_type

Optional

Resource types of logical router port

Possible values are : LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPortOnTIER0, LogicalRouterLinkPortOnTIER1, LogicalRouterLoopbackPort, LogicalRouterIPTunnelPort, LogicalRouterCentralizedServicePort,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalRouterPortListResult of type(s) application/json

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

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_create_user": "string",
            "_protection": "string",
            "_create_time": 0,
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "logical_router_id": "string",
            "service_bindings": [
                {
                    "service_id": {
                        "target_display_name": "string",
                        "is_valid": false,
                        "target_id": "string",
                        "target_type": "string"
                    }
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json