Create Logical Switch

Creates a new logical switch. The request must include the transport_zone_id, display_name, and admin_state (UP or DOWN). The replication_mode (MTEP or SOURCE) is required for overlay logical switches, but not for VLAN-based logical switches. A vlan needs to be provided for VLAN-based logical switches

Request

URI

POST

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

COPY

Request Body

LogicalSwitch of type(s) application/json

Optional

This request body class requires all of the following: ManagedResource , InlineLogicalSwitch1

{
    "_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"
}

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

201

Resource created successfully

Returns LogicalSwitch of type(s) application/json

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

{
    "_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

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Logical Switching Operations

POST

Create Logical Port

POST

Create Logical Switch

POST

Create Switching Profile

DELETE

Delete Logical Port