List Logical Switches

Returns information about all configured logical switches.
This api is now deprecated. Please use new api - /infra/segments

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

Constraints: default: false

Flag to enable showing of transit logical switch.

string

included_fields

Optional

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

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

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

switch_type

Optional

Logical Switch type

Possible values are : DEFAULT, SERVICE_PLANE, DHCP_RELAY, GLOBAL, INTER_ROUTER, EVPN, DVPG,

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

string

uplink_teaming_policy_name

Optional

The logical switch's uplink teaming policy name

integer

vlan

Optional

Constraints: minimum: 0 maximum: 4094

Virtual Local Area Network Identifier

integer

vni

Optional

VNI of the OVERLAY LogicalSwitch(es) to return.

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalSwitchListResult of type(s) application/json

This response body class contains all of the following: InlineLogicalSwitchListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "admin_state": "string",
            "extra_configs": [
                {
                    "config_pair": {
                        "key": "string",
                        "value": "string"
                    }
                }
            ],
            "global_vni": 0,
            "hybrid": false,
            "ip_pool_id": "string",
            "mac_pool_id": "string",
            "node_local_switch": false,
            "origin_id": "string",
            "origin_type": "string",
            "replication_mode": "string",
            "span": [
                "string"
            ],
            "switch_type": "string",
            "switching_profile_ids": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "transport_zone_id": "string",
            "uplink_teaming_policy_name": "string",
            "vlan": 0,
            "vlan_trunk_spec": {
                "vlan_ranges": [
                    {
                        "end": 0,
                        "start": 0
                    }
                ]
            },
            "vni": 0
        }
    ]
}

400

Returns BadRequest of type(s) application/json