Skip to content

lsn

Statistics for lsn.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
lsntottcprxpkts<Double>Read-onlyNumber of LSN TCP Received packets.
lsntcprxpktsrate<Double>Read-onlyRate (/s) counter for lsntottcprxpkts
lsntottcprxbytes<Double>Read-onlyNumber of LSN TCP Received bytes.
lsntcprxbytesrate<Double>Read-onlyRate (/s) counter for lsntottcprxbytes
lsntottcptxpkts<Double>Read-onlyNumber of LSN TCP Transmitted packets.
lsntcptxpktsrate<Double>Read-onlyRate (/s) counter for lsntottcptxpkts
lsntottcptxbytes<Double>Read-onlyNumber of LSN TCP Transmitted bytes.
lsntcptxbytesrate<Double>Read-onlyRate (/s) counter for lsntottcptxbytes
lsntottcpdrppkts<Double>Read-onlyNumber of LSN TCP Dropped packets.
lsntcpdrppktsrate<Double>Read-onlyRate (/s) counter for lsntottcpdrppkts
lsncurtcpsessions<Double>Read-onlyNumber of LSN TCP Current Sessions.
lsncurtcpsessionsrate<Double>Read-onlyRate (/s) counter for lsncurtcpsessions
lsntotudprxpkts<Double>Read-onlyNumber of LSN UDP Received packets.
lsnudprxpktsrate<Double>Read-onlyRate (/s) counter for lsntotudprxpkts
lsntotudprxbytes<Double>Read-onlyNumber of LSN UDP Received bytes.
lsnudprxbytesrate<Double>Read-onlyRate (/s) counter for lsntotudprxbytes
lsntotudptxpkts<Double>Read-onlyNumber of LSN UDP Transmitted packets.
lsnudptxpktsrate<Double>Read-onlyRate (/s) counter for lsntotudptxpkts
lsntotudptxbytes<Double>Read-onlyNumber of LSN UDP Transmitted bytes.
lsnudptxbytesrate<Double>Read-onlyRate (/s) counter for lsntotudptxbytes
lsntotudpdrppkts<Double>Read-onlyNumber of LSN UDP Dropped packets.
lsnudpdrppktsrate<Double>Read-onlyRate (/s) counter for lsntotudpdrppkts
lsncurudpsessions<Double>Read-onlyNumber of LSN UDP Current Sessions.
lsncurudpsessionsrate<Double>Read-onlyRate (/s) counter for lsncurudpsessions
lsntoticmprxpkts<Double>Read-onlyNumber of LSN ICMP Received packets.
lsnicmprxpktsrate<Double>Read-onlyRate (/s) counter for lsntoticmprxpkts
lsntoticmprxbytes<Double>Read-onlyNumber of LSN ICMP Received bytes.
lsnicmprxbytesrate<Double>Read-onlyRate (/s) counter for lsntoticmprxbytes
lsntoticmptxpkts<Double>Read-onlyNumber of LSN ICMP Transmitted packets.
lsnicmptxpktsrate<Double>Read-onlyRate (/s) counter for lsntoticmptxpkts
lsntoticmptxbytes<Double>Read-onlyNumber of LSN ICMP Transmitted bytes.
lsnicmptxbytesrate<Double>Read-onlyRate (/s) counter for lsntoticmptxbytes
lsntoticmpdrppkts<Double>Read-onlyNumber of LSN ICMP Dropped packets.
lsnicmpdrppktsrate<Double>Read-onlyRate (/s) counter for lsntoticmpdrppkts
lsncuricmpsessions<Double>Read-onlyNumber of LSN ICMP Current Sessions.
lsncuricmpsessionsrate<Double>Read-onlyRate (/s) counter for lsncuricmpsessions
lsncursessions<Double>Read-onlyCurrent number of LSN sessions.
lsncursessionsrate<Double>Read-onlyRate (/s) counter for lsncursessions
lsncursubscribers<Double>Read-onlyCurrent number of LSN subscribers.
lsncursubscribersrate<Double>Read-onlyRate (/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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/lsn

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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>
}]}