List Logical Switches

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
switching_profile_id
Optional

Switching Profile identifier

string
included_fields
Optional

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

string
transport_zone_id
Optional

Transport zone identifier

integer
page_size
Optional

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

boolean
diagnostic
Optional

Flag to enable showing of transit logical switch.

string
cursor
Optional

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

string
transport_type
Optional

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

Possible values are : OVERLAY, VLAN,
boolean
sort_ascending
Optional

sort_ascending

string
sort_by
Optional

Field by which records are sorted

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns LogicalSwitchListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineLogicalSwitchListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_revision": 0,
            "_create_user": "string",
            "_schema": "string",
            "_create_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "switching_profile_ids": [
                {
                    "value": "string",
                    "key": "string"
                }
            ],
            "admin_state": "string",
            "address_bindings": [
                {
                    "vlan": 0,
                    "ip_address": "string",
                    "mac_address": "string"
                }
            ],
            "transport_zone_id": "string",
            "vlan": 0,
            "vni": 0,
            "replication_mode": "string"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Logical Switching Operations
POST
Create Logical Port
POST
Create Logical Switch
POST
Create Switching Profile
DELETE
Delete Logical Port
DELETE
Delete Logical Switch
DELETE
Delete Switching Profile
GET
Get Logical Port
GET
Get Logical Port Operational Status
GET
Get Logical Port State
GET
Get Logical Port Statistics
GET
Get Logical Port Status Summary
GET
Get Logical Switch
GET
Get Logical Switch Mac Table
GET
Get Logical Switch Mac Table In Csv Format
GET
Get Logical Switch State
GET
Get Logical Switch Statistics
GET
Get Logical Switch Status
GET
Get Logical Switch Status Summary
GET
Get Logical Switch Vtep Table
GET
Get Logical Switch Vtep Table In Csv Format
GET
Get Switching Profile
GET
Get Switching Profile Status
GET
List Logical Ports
GET
List Logical Switches
GET
List Logical Switches By State
GET
List Switching Profiles
PUT
Update Logical Port
PUT
Update Logical Switch
PUT
Update Switching Profile