Get Logical Port State

Returns transport node id for a specified logical port. Also returns information about all address bindings of the specified logical port. This includes address bindings discovered via various snooping methods like ARP snooping, DHCP snooping etc. and addressing bindings that are realized based on user configuration.

Request

URI

GET

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

COPY

Path Parameters

string

lport-id

Required

lport-id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LogicalPortState of type(s) application/json

{
    "transport_node_ids": [
        "string"
    ],
    "discovered_bindings": [
        {
            "source": "string",
            "binding": {
                "vlan": 0,
                "ip_address": "string",
                "mac_address": "string"
            },
            "binding_timestamp": 0
        }
    ],
    "id": "string",
    "realized_bindings": [
        {
            "source": "string",
            "binding": {
                "vlan": 0,
                "ip_address": "string",
                "mac_address": "string"
            },
            "binding_timestamp": 0
        }
    ]
}

array of string

transport_node_ids

Optional

Identifiers of the transport node where the port is located

array of AddressBindingEntry

discovered_bindings

Optional

Logical port bindings discovered automatically

string

Required

Id of the logical port

array of AddressBindingEntry

realized_bindings

Optional

Realized logical port bindings

400

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

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

403

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

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

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

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

500

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

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

503

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

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

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Logical Switching Operations

POST

Create Logical Port

POST