Update Logical Switch
Modifies attributes of an existing logical switch. Modifiable attributes include admin_state, replication_mode, switching_profile_ids and VLAN spec. You cannot modify the original transport_zone_id.
Request
URI
PUT
https://nsxmanager.your.domain/api/v1/logical-switches/{lswitch-id}
COPY
Path Parameters
string
lswitch-id
Required
lswitch-id
Request Body
LogicalSwitch of type(s) application/json
Optional
{
"_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"
}
]
}
Responses
200
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
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
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
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
Not Found
Operation doesn't return any data structure
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
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
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
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
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 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