NSX-T Data Center REST API

Read LLDP Neighbor Properties of transport node by Interface Name

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/lldp/interfaces/<interface-name>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/f55ff9ec-3f91-11e7-8441-000c29ee2825/lldp/interfaces/vmnic1

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

InterfaceNeighborProperties+

InterfaceNeighborProperties (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ifindex	Interface index	integer	Required Readonly
mac	Interface MAC address	string	Required Readonly Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
name	Interface Name	string	Required Readonly
neighbors	Neighbor properties	array of NeighborProperties	Readonly
resource_type	Must be set to the value InterfaceNeighborProperties	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "neighbors": [ { "mgmt_addr": "192.168.1.2", "capabilities": "Bridge, Router", "system_name": "vpodswitch.corp.local", "name": "Gi1/22", "system_desc": "unknown", "port_desc": "GigabitEthernet1/22", "enabled_capabilities": "Bridge, Router", "mac": "68:ef:bd:4e:98:55" } ], "name": "vmnic1", "mac": "54:9f:35:0b:d0:86", "_schema": "/v1/schema/InterfaceNeighborProperties" }

Required Permissions:

read

Feature:

policy_ops

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable