Create Logical Port | NSX-T Data Center REST API

Create Logical Port

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.

Request

URI

POST

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

COPY

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

201

Resource created successfully

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

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