Get Logical Switch

• Logical Switching

Returns information about the specified logical switch Id.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-switches/{lswitch-id}

COPY

Path Parameters

string

lswitch-id

Required

lswitch-id

---

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Hide Details

OK

Returns LogicalSwitch of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineLogicalSwitch1

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

400

Hide Details

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403

Hide Details

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404

Hide Details

Not Found

Operation doesn't return any data structure

412

Hide Details

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500

Hide Details

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503

Hide Details

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

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 Mac Table

GET

Get Logical Port Mac Table In Csv Format Csv

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 Csv

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 Csv

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