Update Logical Port | NSX-T Data Center REST API

Update Logical Port

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.

Request

URI

PUT

https://nsxmanager.your.domain/api/v1/logical-ports/{lport-id}

COPY

Path Parameters

string

lport-id

Required

lport-id

Request Body

LogicalPort of type(s) application/json

Optional

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

{
    "_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",
    "logical_switch_id": "string",
    "switching_profile_ids": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "attachment": {
        "attachment_type": "string",
        "id": "string"
    },
    "admin_state": "string",
    "address_bindings": [
        {
            "vlan": 0,
            "ip_address": "string",
            "mac_address": "string"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns LogicalPort of type(s) application/json

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

{
    "_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",
    "logical_switch_id": "string",
    "switching_profile_ids": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "attachment": {
        "attachment_type": "string",
        "id": "string"
    },
    "admin_state": "string",
    "address_bindings": [
        {
            "vlan": 0,
            "ip_address": "string",
            "mac_address": "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

Path Parameters

Request Body

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