List Logical Switches

Returns information about all configured logical switches.

Request

URI

GET

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

COPY

Query Parameters

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 switch.

string

included_fields

Optional

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

integer

page_size

Optional

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

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

switching_profile_id

Optional

Switching Profile identifier

string

transport_type

Optional

Mode of transport supported in the transport zone for this logical switch

Possible values are : OVERLAY, VLAN,

string

transport_zone_id

Optional

Transport zone identifier

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns LogicalSwitchListResult of type(s) application/json

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

{
    "_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",
            "replication_mode": "string",
            "admin_state": "string",
            "address_bindings": [
                {
                    "vlan": 0,
                    "ip_address": "string",
                    "mac_address": "string"
                }
            ],
            "transport_zone_id": "string",
            "ip_pool_id": "string",
            "vlan": 0,
            "switching_profile_ids": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "mac_pool_id": "string",
            "vni": 0
        }
    ]
}

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