ADC NITRO APIs

lsn

Statistics for lsn.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
lsntottcprxpkts Read-only Number of LSN TCP Received packets.
lsntcprxpktsrate Read-only Rate (/s) counter for lsntottcprxpkts
lsntottcprxbytes Read-only Number of LSN TCP Received bytes.
lsntcprxbytesrate Read-only Rate (/s) counter for lsntottcprxbytes
lsntottcptxpkts Read-only Number of LSN TCP Transmitted packets.
lsntcptxpktsrate Read-only Rate (/s) counter for lsntottcptxpkts
lsntottcptxbytes Read-only Number of LSN TCP Transmitted bytes.
lsntcptxbytesrate Read-only Rate (/s) counter for lsntottcptxbytes
lsntottcpdrppkts Read-only Number of LSN TCP Dropped packets.
lsntcpdrppktsrate Read-only Rate (/s) counter for lsntottcpdrppkts
lsncurtcpsessions Read-only Number of LSN TCP Current Sessions.
lsncurtcpsessionsrate Read-only Rate (/s) counter for lsncurtcpsessions
lsntotudprxpkts Read-only Number of LSN UDP Received packets.
lsnudprxpktsrate Read-only Rate (/s) counter for lsntotudprxpkts
lsntotudprxbytes Read-only Number of LSN UDP Received bytes.
lsnudprxbytesrate Read-only Rate (/s) counter for lsntotudprxbytes
lsntotudptxpkts Read-only Number of LSN UDP Transmitted packets.
lsnudptxpktsrate Read-only Rate (/s) counter for lsntotudptxpkts
lsntotudptxbytes Read-only Number of LSN UDP Transmitted bytes.
lsnudptxbytesrate Read-only Rate (/s) counter for lsntotudptxbytes
lsntotudpdrppkts Read-only Number of LSN UDP Dropped packets.
lsnudpdrppktsrate Read-only Rate (/s) counter for lsntotudpdrppkts
lsncurudpsessions Read-only Number of LSN UDP Current Sessions.
lsncurudpsessionsrate Read-only Rate (/s) counter for lsncurudpsessions
lsntoticmprxpkts Read-only Number of LSN ICMP Received packets.
lsnicmprxpktsrate Read-only Rate (/s) counter for lsntoticmprxpkts
lsntoticmprxbytes Read-only Number of LSN ICMP Received bytes.
lsnicmprxbytesrate Read-only Rate (/s) counter for lsntoticmprxbytes
lsntoticmptxpkts Read-only Number of LSN ICMP Transmitted packets.
lsnicmptxpktsrate Read-only Rate (/s) counter for lsntoticmptxpkts
lsntoticmptxbytes Read-only Number of LSN ICMP Transmitted bytes.
lsnicmptxbytesrate Read-only Rate (/s) counter for lsntoticmptxbytes
lsntoticmpdrppkts Read-only Number of LSN ICMP Dropped packets.
lsnicmpdrppktsrate Read-only Rate (/s) counter for lsntoticmpdrppkts
lsncuricmpsessions Read-only Number of LSN ICMP Current Sessions.
lsncuricmpsessionsrate Read-only Rate (/s) counter for lsncuricmpsessions
lsncursessions Read-only Current number of LSN sessions.
lsncursessionsrate Read-only Rate (/s) counter for lsncursessions
lsncursubscribers Read-only Current number of LSN subscribers.
lsncursubscribersrate Read-only Rate (/s) counter for lsncursubscribers

Operations

(click to see Properties )

  • GET (ALL)

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

get (all)

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

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

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

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

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:

{  "lsn": [ {
"lsncursubscribersrate":<Double_value>,
"lsntotudptxbytes":<Double_value>,
"lsncuricmpsessionsrate":<Double_value>,
"lsncursessions":<Double_value>,
"lsntottcptxbytes":<Double_value>,
"lsnudptxbytesrate":<Double_value>,
"lsntotudpdrppkts":<Double_value>,
"lsntottcpdrppkts":<Double_value>,
"lsntoticmptxpkts":<Double_value>,
"lsntcptxbytesrate":<Double_value>,
"lsnudprxbytesrate":<Double_value>,
"lsntcpdrppktsrate":<Double_value>,
"lsntotudprxbytes":<Double_value>,
"lsnicmpdrppktsrate":<Double_value>,
"lsntottcprxbytes":<Double_value>,
"lsntoticmptxbytes":<Double_value>,
"lsntoticmprxpkts":<Double_value>,
"lsnicmptxpktsrate":<Double_value>,
"lsnicmprxbytesrate":<Double_value>,
"lsntoticmpdrppkts":<Double_value>,
"lsntcprxpktsrate":<Double_value>,
"lsntottcptxpkts":<Double_value>,
"lsncurtcpsessionsrate":<Double_value>,
"lsncursubscribers":<Double_value>,
"lsncurudpsessionsrate":<Double_value>,
"lsnudptxpktsrate":<Double_value>,
"lsntottcprxpkts":<Double_value>,
"lsnicmptxbytesrate":<Double_value>,
"lsntotudprxpkts":<Double_value>,
"lsncursessionsrate":<Double_value>,
"lsntcptxpktsrate":<Double_value>,
"lsnudprxpktsrate":<Double_value>,
"lsntotudptxpkts":<Double_value>,
"lsncurudpsessions":<Double_value>,
"lsnudpdrppktsrate":<Double_value>,
"lsntoticmprxbytes":<Double_value>,
"lsncuricmpsessions":<Double_value>,
"lsncurtcpsessions":<Double_value>,
"lsntcprxbytesrate":<Double_value>,
"lsnicmprxpktsrate":<Double_value>
}]}

<!--NeedCopy-->
lsn