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": {
        "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"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

201

Created

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

Returns BadRequest of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Returns NotFound of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

412

Returns PreconditionFailed of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

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

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error