ADC NITRO APIs

lldpneighbors

Configuration for lldp neighbors resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ifnum <String> Read-write Interface Name.
nodeid <Double> Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
chassisidsubtype <String> Read-only Chassis id sub type.

Possible values = NONE, Component, Interface Alias, Port Component, MAC Address, Network Address, Interface Name, Locally Assigned
chassisid <String> Read-only Chassis Id.
portidsubtype <String> Read-only Port id subtype.

Possible values = NONE, Interface Alias, Port Component, MAC Address, Network Address, Interface Name, Agent Circuit ID, Locally Assigned
portid <String> Read-only Port Id.
ttl <Double> Read-only Time to Live.
portdescription <String> Read-only Port Description.
sys <String> Read-only System Name.
sysdesc <String> Read-only System Description.
mgmtaddresssubtype <String> Read-only Management Address Type.

Possible values = OTHER, IPv4, IPv6
mgmtaddress <String> Read-only Management Address.
iftype <String> Read-only Interface subtype.

Possible values = UNKNOWN, ifIndex, system port number
ifnumber <Double> Read-only Interface Number.
vlan <String> Read-only vlan name.
vlanid <Double> Read-only Vlan Id.
portprotosupported <Double> Read-only Flag to show Port Protocol Support.
portprotoenabled <Double> Read-only Flag to show Port Protocol support enabled.
portprotoid <Double> Read-only Port Protocol ID.
portvlanid <Double> Read-only Port Vlan Id.
protocolid <String> Read-only port vlan id name.
linkaggrcapable <String> Read-only Is neighbor Link Aggregation Capable.

Possible values = NO, YES
linkaggrenabled <String> Read-only Is link aggregation Enabled.

Possible values = NO, YES
linkaggrid <Double> Read-only Link Aggregation Id.
flag <Double> Read-only .
syscapabilities <String> Read-only Acronyms for remote system capabilities:

OT : Other.

RE : Repeater(IETF RFC 2108).

BR : MAC Bridge(IEEE Std 802.1D).

WL : WLAN Access Point(IEEE Std 802.11 MIB).

RO : ROuter(IETF RFC 1812).

TE : Telephone(IETF RFC 4293).

DO : DOCSIS cable device(IETF RFC 4639 and IETF RFC 4546).

ST : STation only(IETF RFC 4293).

CV : C-VLAN component of a VLAN Bridge(IEEE Std 802.1Q).

SV : S-VLAN component of a VLAN Bridge(IEEE Std 802.1Q).

MR : Two port MAC Relay(IEEE Std 802.1Q).
syscapenabled <String> Read-only Acronyms for remote system enabled capabilities:

OT : Other.

RE : Repeater(IETF RFC 2108).

BR : MAC Bridge(IEEE Std 802.1D).

WL : WLAN Access Point(IEEE Std 802.11 MIB).

RO : ROuter(IETF RFC 1812).

TE : Telephone(IETF RFC 4293).

DO : DOCSIS cable device(IETF RFC 4639 and IETF RFC 4546).

ST : STation only(IETF RFC 4293).

CV : C-VLAN component of a VLAN Bridge(IEEE Std 802.1Q).

SV : S-VLAN component of a VLAN Bridge(IEEE Std 802.1Q).

MR : Two port MAC Relay(IEEE Std 802.1Q).
autonegsupport <String> Read-only MAC/PHY autonegotiation support.

Possible values = NO, YES
autonegenabled <String> Read-only MAC/PHY autonegotiation enabled.

Possible values = NO, YES
autonegadvertised <String> Read-only MAC/PHY autonegotiation advetised.
autonegmautype <String> Read-only MAC/PHY Medium Attachment Unit (MAU) type of the port. Description listed below:

AUI - no internal MAU, view from AUI

10Base5 - thick coax MAU

Foirl - FOIRL MAU

10Base2 - thin coax MAU

10BaseT - UTP MAU

10BaseFP - passive fiber MAU

10BaseFB - sync fiber MAU

10BaseFL - async fiber MAU

10Broad36 - broadband DTE MAU

10BaseTHD - UTP MAU, half duplex mode

10BaseTFD - UTP MAU, full duplex mode

10BaseFLHD - async fiber MAU, half duplex mode

10BaseFLDF - async fiber MAU, full duplex mode

10BaseT4 - 4 pair category 3 UTP

100BaseTXHD - 2 pair category 5 UTP, half duplex mode

100BaseTXFD - 2 pair category 5 UTP, full duplex mode

100BaseFXHD - X fiber over PMT, half duplex mode

100BaseFXFD - X fiber over PMT, full duplex mode

100BaseT2HD - 2 pair category 3 UTP, half duplex mode

100BaseT2DF - 2 pair category 3 UTP, full duplex mode

1000BaseXHD - PCS/PMA, unknown PMD, half duplex mode

1000BaseXFD - PCS/PMA, unknown PMD, full duplex mode

1000BaseLXHD - Fiber over long-wavelength laser, half duplex mode

1000BaseLXFD - Fiber over long-wavelength laser, full duplex mode

1000BaseSXHD - Fiber over short-wavelength laser, half duplex mode

1000BaseSXFD - Fiber over short-wavelength laser, full duplex mode

1000BaseCXHD - Copper over 150-Ohm balanced cable, half duplex mode

1000BaseCXFD - Copper over 150-Ohm balanced cable, full duplex mode

1000BaseTHD - Four-pair Category 5 UTP, half duplex mode

1000BaseTFD - Four-pair Category 5 UTP, full duplex mode

10GigBaseX - X PCS/PMA, unknown PMD

10GigBaseLX4 - X fiber over WWDM optics

10GigBaseR - R PCS/PMA, unknown PMD

10GigBaseER - R fiber over 1550 nm optics

10GigBaseLR - R fiber over 1310 nm optics

10GigBaseSR - R fiber over 850 nm optics

10GigBaseW - W PCS/PMA, unknown PMD

10GigBaseEW - W fiber over 1550 nm optics

10GigBaseLW - W fiber over 1310 nm optics

10GigBaseSW - W fiber over 850 nm optics.

Possible values = Not Recieved, AUI, 10Base5, Foirl, 10Base2, 10BaseT, 10BaseFP, 10BaseFB, 10BaseFL, 10Broad36, 10BaseTHD, 10BaseTFD, 10BaseFLHD, 10BaseFLDF, 10BaseT4, 100BaseTXHD, 100BaseTXFD, 100BaseFXHD, 100BaseFXFD, 100BaseT2HD, 100BaseT2DF, 1000BaseXHD, 1000BaseXFD, 1000BaseLXHD, 1000BaseLXFD, 1000BaseSXHD, 1000BaseSXFD, 1000BaseCXHD, 1000BaseCXFD, 1000BaseTHD, 1000BaseTFD, 10GigBaseX, 10GigBaseLX4, 10GigBaseR, 10GigBaseER, 10GigBaseLR, 10GigBaseSR, 10GigBaseW, 10GigBaseEW, 10GigBaseLW, 10GigBaseSW
mtu <Double> Read-only MTU of Remote Device.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • GET (ALL)
  • GET
  • COUNT
  • CLEAR

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

clear

URL: http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? action=clear HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lldpneighbors":{
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? args=ifnum: <String_value> ,nodeid: <Double_value>

Use this query-parameter to get lldpneighbors resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of lldpneighbors resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? view=summary

Use this query-parameter to get the summary output of lldpneighbors resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? pagesize=#no;pageno=#no

Use this query-parameter to get the lldpneighbors resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "lldpneighbors": [ {
ifnum:<String_value>,nodeid:<Double_value>"chassisidsubtype":<String_value>,
"chassisid":<String_value>,
"portidsubtype":<String_value>,
"portid":<String_value>,
"ttl":<Double_value>,
"portdescription":<String_value>,
"sys":<String_value>,
"sysdesc":<String_value>,
"mgmtaddresssubtype":<String_value>,
"mgmtaddress":<String_value>,
"iftype":<String_value>,
"ifnumber":<Double_value>,
"vlan":<String_value>,
"vlanid":<Double_value>,
"portprotosupported":<Double_value>,
"portprotoenabled":<Double_value>,
"portprotoid":<Double_value>,
"portvlanid":<Double_value>,
"protocolid":<String_value>,
"linkaggrcapable":<String_value>,
"linkaggrenabled":<String_value>,
"linkaggrid":<Double_value>,
"flag":<Double_value>,
"syscapabilities":<String_value>,
"syscapenabled":<String_value>,
"autonegsupport":<String_value>,
"autonegenabled":<String_value>,
"autonegadvertised":<String_value>,
"autonegmautype":<String_value>,
"mtu":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors/ ifnum_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors/ ifnum_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors/ ifnum_value<String> ? view=summary

Use this query-parameter to get the summary output of lldpneighbors resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "lldpneighbors": [ {
ifnum:<String_value>,nodeid:<Double_value>"chassisidsubtype":<String_value>,
"chassisid":<String_value>,
"portidsubtype":<String_value>,
"portid":<String_value>,
"ttl":<Double_value>,
"portdescription":<String_value>,
"sys":<String_value>,
"sysdesc":<String_value>,
"mgmtaddresssubtype":<String_value>,
"mgmtaddress":<String_value>,
"iftype":<String_value>,
"ifnumber":<Double_value>,
"vlan":<String_value>,
"vlanid":<Double_value>,
"portprotosupported":<Double_value>,
"portprotoenabled":<Double_value>,
"portprotoid":<Double_value>,
"portvlanid":<Double_value>,
"protocolid":<String_value>,
"linkaggrcapable":<String_value>,
"linkaggrenabled":<String_value>,
"linkaggrid":<Double_value>,
"flag":<Double_value>,
"syscapabilities":<String_value>,
"syscapenabled":<String_value>,
"autonegsupport":<String_value>,
"autonegenabled":<String_value>,
"autonegadvertised":<String_value>,
"autonegmautype":<String_value>,
"mtu":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/lldpneighbors? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "lldpneighbors": [ { "__count": "#no"} ] }

<!--NeedCopy-->
lldpneighbors