List Logical Ports

List Logical Ports

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.

This api is now deprecated. Please use new api - /infra/segments/<segment-id>/ports

Request

URI

GET

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

COPY

Query Parameters

string

attachment_id

Optional

Logical Port attachment Id

string

attachment_type

Optional

Type of attachment for logical port; for query only.

Possible values are : VIF, LOGICALROUTER, BRIDGEENDPOINT, DHCP_SERVICE, METADATA_PROXY, L2VPN_SESSION, NONE,

string

bridge_cluster_id

Optional

Bridge Cluster identifier

boolean

container_ports_only

Optional

Constraints: default: false

Only container VIF logical ports will be returned if true

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

diagnostic

Optional

Constraints: default: false

Flag to enable showing of transit logical port.

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

logical_switch_id

Optional

Logical Switch identifier

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

string

parent_vif_id

Optional

ID of the VIF of type PARENT

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

switching_profile_id

Optional

Network Profile identifier

string

transport_node_id

Optional

Transport node identifier

string

transport_zone_id

Optional

Transport zone identifier

Authentication

This operation uses the following authentication methods.

Responses

200

OK

Returns LogicalPortListResult of type(s) application/json

This response body class contains all of the following: InlineLogicalPortListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "admin_state": "string",
            "attachment": {
                "attachment_type": "string",
                "context": {
                    "allocate_addresses": "string",
                    "resource_type": "string"
                },
                "id": "string"
            },
            "extra_configs": [
                {
                    "config_pair": {
                        "key": "string",
                        "value": "string"
                    }
                }
            ],
            "ignore_address_bindings": [
                {
                    "ip_address": "string",
                    "mac_address": "string",
                    "vlan": 0
                }
            ],
            "init_state": "string",
            "internal_id": "string",
            "logical_switch_id": "string",
            "origin_id": "string",
            "switching_profile_ids": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure

500

Returns InternalServerError of type(s) application/json

Operation doesn't return any data structure

503

Returns ServiceUnavailable of type(s) application/json

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/logical-ports

Deprecated

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Management Plane Api Operations

List Bridge Endpoint Profiles

Create Bridge Endpoint Profile

Delete Bridge Endpoint Profile

Get Bridge Endpoint Profile

Update Bridge Endpoint Profile

List Bridge Endpoints

Create Bridge Endpoint

Delete Bridge Endpoint

Get Bridge Endpoint

Update Bridge Endpoint

Get Bridge Endpoint Statistics

Get Bridge Endpoint Status

List Dhcp Relay Profiles

Create Dhcp Relay Profile

Delete Dhcp Relay Profile

Read Dhcp Relay Profile

Update Dhcp Relay Profile

List Dhcp Relays

Create Dhcp Relay

Delete Dhcp Relay

Read Dhcp Relay

Update Dhcp Relay

List Dhcp Profiles

Create Dhcp Profile

Delete Dhcp Profile

Read Dhcp Profile

Update Dhcp Profile

Reallocate Dhcp Profile Edge Cluster

List Dhcp Servers

Create Dhcp Server

Delete Dhcp Server

Read Dhcp Server

Update Dhcp Server

List Dhcp Ip Pools

Create Dhcp Ip Pool

Delete Dhcp Ip Pool

Read Dhcp Ip Pool

Update Dhcp Ip Pool

Get Dhcp Ip Pool State

List Dhcp V6 Ip Pools

Create Dhcp V6 Ip Pool

Delete Dhcp V6 Ip Pool

Read Dhcp V6 Ip Pool

Update Dhcp V6 Ip Pool

List Dhcp V6 Static Bindings

Create Dhcp V6 Static Binding

Delete Dhcp V6 Static Binding

Read Dhcp V6 Static Binding

Update Dhcp V6 Static Binding

Delete A Dhcp Lease

Get Dhcp Lease Info

Get Dhcp Server State

List Dhcp Static Bindings

Create Dhcp Static Binding

Delete Dhcp Static Binding

Read Dhcp Static Binding

Update Dhcp Static Binding

Get Dhcp Static Binding State

Get Dhcp Statistics

Get Dhcp Status

List Dns Forwaders

Create Dns Forwader

Delete Dns Forwarder

Read Dns Forwader

Update Dns Forwarder

Get Failed Dns Queries

Get Dns Forwarder State

Get Dns Forwarder Statistics

Get Dns Forwarder Status

Clear Dns Forwarder Cache

Disable Dns Forwarder

Enable Dns Forwarder

List DAD Profiles

Create DAD Profile

Delete DAD Profile

Read DAD Profile

Update DAD Profile

List NDRA Profiles

Create NDRA Profile

Delete NDRA Profile

Read NDRA Profile

Update NDRA Profile

List Load Balancer Application Profiles

Create Load Balancer Application Profile

Delete Load Balancer Application Profile

Read Load Balancer Application Profile

Update Load Balancer Application Profile

List Load Balancer Client Ssl Profiles

Create Load Balancer Client Ssl Profile

Delete Load Balancer Client Ssl Profile

Read Load Balancer Client Ssl Profile

Update Load Balancer Client Ssl Profile

List Load Balancer Monitors

Create Load Balancer Monitor

Delete Load Balancer Monitor

Read Load Balancer Monitor

Update Load Balancer Monitor

Read Load Balancer Node Usage Summary

List Load Balancer Persistence Profiles

Create Load Balancer Persistence Profile

Delete Load Balancer Persistence Profile

Read Load Balancer Persistence Profile

Update Load Balancer Persistence Profile

List Load Balancer Pools

Create Load Balancer Pool

Delete Load Balancer Pool

Read Load Balancer Pool

Perform Pool Member Action

Update Load Balancer Pool

List Load Balancer Rules

Create Load Balancer Rule

Delete Load Balancer Rule

Read Load Balancer Rule

Update Load Balancer Rule

List Load Balancer Server Ssl Profiles

Create Load Balancer Server Ssl Profile

Delete Load Balancer Server Ssl Profile

Read Load Balancer Server Ssl Profile

Update Load Balancer Server Ssl Profile

List Load Balancer Services

Create Load Balancer Service

Delete Load Balancer Service

Read Load Balancer Service

Update Load Balancer Service

Read Load Balancer Service Debug Info

List Load Balancer Pool Statistics

List Load Balancer Pool Statuses

Get Load Balancer Pool Statistics

Get Load Balancer Pool Status

Get Load Balancer Service Statistics

Get Load Balancer Service Status

Read Load Balancer Service Usage

List Load Balancer Virtual Servers Statistics

List Load Balancer Virtual Server Statuses

Get Load Balancer Virtual Server Statistics

Get Load Balancer Virtual Server Status

List Load Balancer Ssl Ciphers And Protocols

Read Load Balancer Node Usage

List Load Balancer Virtual Servers

Create Load Balancer Virtual Server

Delete Load Balancer Virtual Server

Read Load Balancer Virtual Server

Update Load Balancer Virtual Server

Update Load Balancer Virtual Server With Rules

Create Load Balancer Virtual Server With Rules

List Logical Ports

Create Logical Port

Get Logical Port Status Summary

Delete Logical Port

Get Logical Port

Update Logical Port

Get Logical Port Mac Table

Get Logical Port Mac Table In Csv Format

Get Logical Port State

Get Logical Port Statistics

Get Logical Port Operational Status

List Logical Router Ports

Create Logical Router Port

Delete Logical Router Port

Read Logical Router Port

Update Logical Router Port

Get Logical Router Port Arp Table

Get Logical Router Port Arp Table In Csv Format

Get Logical Router Port State

Get Logical Router Port Statistics

Get Logical Router Port Statistics Summary

List Logical Routers

Create Logical Router

Delete Logical Router

Read Logical Router

Update Logical Router

Read Debug Info

Get Nat Statistics Per Logical Router

Delete Nat Rule

Update Nat Rule

Get Nat Statistics Per Rule

Read Routing Config

Update Routing Config

Read Advertisement Config

Update Advertisement Config

Read Advertise Rule List

Update Advertise Rule List

Read Routing Bfd Config

Update Routing Bfd Config

Read Bgp Config

Update Bgp Config

List BGP Community Lists

Create BGP Community List

Delete BGP Community List

Read BGP Community List

Update BGP Community List

Update BGP Community List Old

List Bgp Neighbors

Add Bgp Neighbor

Get Bgp Neighbors Status

Delete Bgp Neighbor

Read Bgp Neighbor

Un Set Password On Bgp Neighbor

Update Bgp Neighbor

Read Bgp Neighbor With Password

Get Bgp Neighbor Advertised Routes

Get Bgp Neighbor Advertised Routes In Csv Format

Get Bgp Neighbor Routes

Get Bgp Neighbor Routes In Csv Format

Get Logical Router Forwarding Table

Get Logical Router Forwarding Table In Csv Format

List IP Prefix Lists

Add IP Prefix List

Delete IP Prefix List

Read IP Prefix List

Update IP Prefix List

Read Redistribution Config

Update Redistribution Config

Read Redistribution Rule List

Update Redistribution Rule List

List Route Maps

Delete Route Map

Update Route Map

Get Logical Router Route Table

Get Logical Router Route Table In Csv Format

Get Logical Router Routing Table

Get Logical Router Routing Table In Csv Format

List Static Routes

Add Static Route

List Static Hop Bfd Peers

Create Static Hop Bfd Peer

Delete Static Hop Bfd Peer

Read Static Hop Bfd Peer

Update Static Hop Bfd Peer

Delete Static Route

Read Static Route

Update Static Route

Get Logical Service Router Cluster State

Get Logical Router State

Get Logical Router Status

Re Allocate Service Routers

Re Process Logical Router

List Logical Switches

Create Logical Switch

List Logical Switches By State

Get Logical Switch Status Summary

Delete Logical Switch

Get Logical Switch

Update Logical Switch

Get Logical Switch Mac Table

Get Logical Switch Mac Table In Csv Format

Get Logical Switch State

Get Logical Switch Statistics

Get Logical Switch Status

Get Logical Switch Vtep Table

Get Logical Switch Vtep Table In Csv Format

List Metadata Proxy

Create Metadata Proxy

Delete Metadata Proxy

Read Metadata Proxy

Update Metadata Proxy

Get Metadata Proxy Statistics

Get Metadata Proxy Status

List Switching Profiles

Create Switching Profile

Delete Switching Profile

Get Switching Profile

Update Switching Profile

Get Switching Profile Status

Get Nat Statistics Per Transport Node

List IP Sec VPNDPD Profiles

Create IP Sec VPNDPD Profile

Delete IP Sec VPNDPD Profile

Get IP Sec VPNDPD Profile

Update IP Sec VPNDPD Profile

List IP Sec VPNIKE Profiles

Create IP Sec VPNIKE Profile

Delete IP Sec VPNIKE Profile

Get IP Sec VPNIKE Profile

Update IP Sec VPNIKE Profile

List IP Sec VPN Local Endpoints

Create IP Sec VPN Local Endpoint

Delete IP Sec VPN Local Endpoint

Get IP Sec VPN Local Endpoint

Update IP Sec VPN Local Endpoint

List IP Sec VPN Peer Endpoints

Create IP Sec VPN Peer End Point

Delete IP Sec VPN Peer Endpoint

Get IP Sec VPN Peer Endpoint

Update IP Sec VPN Peer Endpoint

Get IP Sec VPN Peer Endpoint With PSK

List IP Sec VPN Services

Create IP Sec VPN Service

Delete IP Sec VPN Service

Get IP Sec VPN Service

Update IP Sec VPN Service

List IP Sec VPN Sessions

Create IP Sec VPN Session

Get IP Sec VPN Session Summary

Delete IP Sec VPN Session

Get IP Sec VPN Session

Update IP Sec VPN Session

Get Peer Config

Get IP Sec VPN Session State

Get IP Sec VPN Session Statistics

Reset IP Sec VPN Session Statistics

Get IP Sec VPNIKE Session Status

List IP Sec VPN Tunnel Profiles

Create IP Sec VPN Tunnel Profile

Delete IP Sec VPN Tunnel Profile

Get IP Sec VPN Tunnel Profile

Update IP Sec VPN Tunnel Profile

List L2 Vpn Services

Create L2 Vpn Service

Delete L2 Vpn Service

Get L2 Vpn Service

Update L2 Vpn Service

List L2 Vpn Sessions

Create L2 Vpn Session

Get L2VPN Session Summary

Delete L2 Vpn Session

Get L2 Vpn Session

Update L2 Vpn Session

Get L2 Vpn Session Peer Codes

Get L2VPN Session Remote Macs For LS

Get L2VPN Session Statistics

Get L2VPN Session Status

Get IP Sec VPNIKE Service

Node: apidepo-liferay-dxp-v1-be-w-0:8080: