Product Documentation

lldp

Sep 08, 2016

Statistics for lldp.

Properties (click to see Operations)

Name Data Type Permissions Description
ifnum
<String>
Read-write
LLDP Statistics per interfaces.
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
rxportframestotal
<Double>
Read-only
Total LLDP Packets received.
rxportframesrate
<Double>
Read-only
Rate (/s) counter for rxportframestotal
rxportbytestotal
<Double>
Read-only
Total LLDP bytes received
rxportbytesrate
<Double>
Read-only
Rate (/s) counter for rxportbytestotal
txportframestotal
<Double>
Read-only
Total LLDP Packets transmitted
txportframesrate
<Double>
Read-only
Rate (/s) counter for txportframestotal
txportbytestotal
<Double>
Read-only
Total LLDP bytes transmitted.
txportbytesrate
<Double>
Read-only
Rate (/s) counter for txportbytestotal
rxportframeserrors
<Double>
Read-only
Total errors in LLDP packets.
rxportframeserrorsrate
<Double>
Read-only
Rate (/s) counter for rxportframeserrors
rxporttlvsdiscardedtotal
<Double>
Read-only
Total discarded LLDP packets.
rxporttlvsdiscardedrate
<Double>
Read-only
Rate (/s) counter for rxporttlvsdiscardedtotal
rxporttlvsunrecognizedtotal
<Double>
Read-only
Total TLVs not Recognised.
rxporttlvsunrecognizedrate
<Double>
Read-only
Rate (/s) counter for rxporttlvsunrecognizedtotal

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/lldp

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/lldp?args=ifnum:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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 Headers:

Content-Type:application/json

Response Payload:

{ "lldp": [ {
      "ifnum":<String_value>,
      "rxporttlvsdiscardedtotal":<Double_value>,
      "rxportframeserrors":<Double_value>,
      "rxportframeserrorsrate":<Double_value>,
      "rxportframestotal":<Double_value>,
      "txportbytestotal":<Double_value>,
      "txportframestotal":<Double_value>,
      "rxporttlvsunrecognizedtotal":<Double_value>,
      "rxportbytesrate":<Double_value>,
      "rxportbytestotal":<Double_value>,
      "rxporttlvsdiscardedrate":<Double_value>,
      "txportbytesrate":<Double_value>,
      "rxporttlvsunrecognizedrate":<Double_value>,
      "rxportframesrate":<Double_value>,
      "txportframesrate":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/lldp/ifnum_value><String>

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 Headers:

Content-Type:application/json

Response Payload:

{ "lldp": [ {
      "ifnum":<String_value>,
      "rxporttlvsdiscardedtotal":<Double_value>,
      "rxportframeserrors":<Double_value>,
      "rxportframeserrorsrate":<Double_value>,
      "rxportframestotal":<Double_value>,
      "txportbytestotal":<Double_value>,
      "txportframestotal":<Double_value>,
      "rxporttlvsunrecognizedtotal":<Double_value>,
      "rxportbytesrate":<Double_value>,
      "rxportbytestotal":<Double_value>,
      "rxporttlvsdiscardedrate":<Double_value>,
      "txportbytesrate":<Double_value>,
      "rxporttlvsunrecognizedrate":<Double_value>,
      "rxportframesrate":<Double_value>,
      "txportframesrate":<Double_value>
}]}