Skip to content

lsngroup

Statistics for LSN group resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
groupname<String>Read-writeName of the LSN Group.
Minimum length = 1
Maximum length = 127
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
lsngrpcursessions<Double>Read-onlyNumber of Current Sessions for LSN group
lsngrpcursessionsrate<Double>Read-onlyRate (/s) counter for lsngrpcursessions
lsngrptottranslbytes<Double>Read-onlyNumber of Translated Bytes for LSN group
lsngrptranslbytesrate<Double>Read-onlyRate (/s) counter for lsngrptottranslbytes
lsngrptottranslpkts<Double>Read-onlyNumber of Translated Pkts for LSN group
lsngrptranslpktsrate<Double>Read-onlyRate (/s) counter for lsngrptottranslpkts
lsngrptottcptranslpkts<Double>Read-onlyNumber of TCP Translated Pkts for LSN group
lsngrptcptranslpktsrate<Double>Read-onlyRate (/s) counter for lsngrptottcptranslpkts
lsngrptottcptranslbytes<Double>Read-onlyNumber of TCP Translated Bytes for LSN group
lsngrptcptranslbytesrate<Double>Read-onlyRate (/s) counter for lsngrptottcptranslbytes
lsngrptottcpdrppkts<Double>Read-onlyNumber of TCP Dropped Pkts for LSN group
lsngrptcpdrppktsrate<Double>Read-onlyRate (/s) counter for lsngrptottcpdrppkts
lsngrpcurtcpsessions<Double>Read-onlyNumber of TCP Current Sessions for LSN group
lsngrpcurtcpsessionsrate<Double>Read-onlyRate (/s) counter for lsngrpcurtcpsessions
lsngrptotudptranslpkts<Double>Read-onlyNumber of UDP Translated Pkts for LSN group
lsngrpudptranslpktsrate<Double>Read-onlyRate (/s) counter for lsngrptotudptranslpkts
lsngrptotudptranslbytes<Double>Read-onlyNumber of UDP Translated Bytes for LSN group
lsngrpudptranslbytesrate<Double>Read-onlyRate (/s) counter for lsngrptotudptranslbytes
lsngrptotudpdrppkts<Double>Read-onlyNumber of UDP Dropped Pkts for LSN group
lsngrpudpdrppktsrate<Double>Read-onlyRate (/s) counter for lsngrptotudpdrppkts
lsngrpcurudpsessions<Double>Read-onlyNumber of UDP Current Sessions for LSN group
lsngrpcurudpsessionsrate<Double>Read-onlyRate (/s) counter for lsngrpcurudpsessions
lsngrptoticmptranslpkts<Double>Read-onlyNumber of ICMP Translated Pkts for LSN group
lsngrpicmptranslpktsrate<Double>Read-onlyRate (/s) counter for lsngrptoticmptranslpkts
lsngrptoticmptranslbytes<Double>Read-onlyNumber of ICMP Translated Bytes for LSN group
lsngrpicmptranslbytesrate<Double>Read-onlyRate (/s) counter for lsngrptoticmptranslbytes
lsngrptoticmpdrppkts<Double>Read-onlyNumber of ICMP Dropped Pkts for LSN group
lsngrpicmpdrppktsrate<Double>Read-onlyRate (/s) counter for lsngrptoticmpdrppkts
lsngrpcuricmpsessions<Double>Read-onlyNumber of ICMP Current Sessions for LSN group
lsngrpcuricmpsessionsrate<Double>Read-onlyRate (/s) counter for lsngrpcuricmpsessions
lsngrpcursubscribers<Double>Read-onlyNumber of ICMP Current Sessions for LSN group
lsngrpcursubscribersrate<Double>Read-onlyRate (/s) counter for lsngrpcursubscribers

Operations

(click to see Properties)

GET (ALL)| GET

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/lsngroup

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/lsngroup?args=groupname:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get lsngroup 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:

{ "lsngroup": [ {
"groupname":<String_value>,
"lsngrptcptranslbytesrate":<Double_value>,
"lsngrptottranslpkts":<Double_value>,
"lsngrptoticmptranslpkts":<Double_value>,
"lsngrpcurtcpsessions":<Double_value>,
"lsngrpicmptranslbytesrate":<Double_value>,
"lsngrptotudptranslpkts":<Double_value>,
"lsngrptottcpdrppkts":<Double_value>,
"lsngrptranslbytesrate":<Double_value>,
"lsngrptotudptranslbytes":<Double_value>,
"lsngrptoticmptranslbytes":<Double_value>,
"lsngrpcursubscribersrate":<Double_value>,
"lsngrptottranslbytes":<Double_value>,
"lsngrptoticmpdrppkts":<Double_value>,
"lsngrptcptranslpktsrate":<Double_value>,
"lsngrpudptranslpktsrate":<Double_value>,
"lsngrpcursubscribers":<Double_value>,
"lsngrpudptranslbytesrate":<Double_value>,
"lsngrpcuricmpsessionsrate":<Double_value>,
"lsngrpcurudpsessions":<Double_value>,
"lsngrptottcptranslpkts":<Double_value>,
"lsngrptotudpdrppkts":<Double_value>,
"lsngrpicmptranslpktsrate":<Double_value>,
"lsngrpcuricmpsessions":<Double_value>,
"lsngrpcurtcpsessionsrate":<Double_value>,
"lsngrpcurudpsessionsrate":<Double_value>,
"lsngrptranslpktsrate":<Double_value>,
"lsngrptottcptranslbytes":<Double_value>,
"lsngrpicmpdrppktsrate":<Double_value>,
"lsngrpcursessionsrate":<Double_value>,
"lsngrpudpdrppktsrate":<Double_value>,
"lsngrptcpdrppktsrate":<Double_value>,
"lsngrpcursessions":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/lsngroup/groupname_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lsngroup": [ {
"groupname":<String_value>,
"lsngrptcptranslbytesrate":<Double_value>,
"lsngrptottranslpkts":<Double_value>,
"lsngrptoticmptranslpkts":<Double_value>,
"lsngrpcurtcpsessions":<Double_value>,
"lsngrpicmptranslbytesrate":<Double_value>,
"lsngrptotudptranslpkts":<Double_value>,
"lsngrptottcpdrppkts":<Double_value>,
"lsngrptranslbytesrate":<Double_value>,
"lsngrptotudptranslbytes":<Double_value>,
"lsngrptoticmptranslbytes":<Double_value>,
"lsngrpcursubscribersrate":<Double_value>,
"lsngrptottranslbytes":<Double_value>,
"lsngrptoticmpdrppkts":<Double_value>,
"lsngrptcptranslpktsrate":<Double_value>,
"lsngrpudptranslpktsrate":<Double_value>,
"lsngrpcursubscribers":<Double_value>,
"lsngrpudptranslbytesrate":<Double_value>,
"lsngrpcuricmpsessionsrate":<Double_value>,
"lsngrpcurudpsessions":<Double_value>,
"lsngrptottcptranslpkts":<Double_value>,
"lsngrptotudpdrppkts":<Double_value>,
"lsngrpicmptranslpktsrate":<Double_value>,
"lsngrpcuricmpsessions":<Double_value>,
"lsngrpcurtcpsessionsrate":<Double_value>,
"lsngrpcurudpsessionsrate":<Double_value>,
"lsngrptranslpktsrate":<Double_value>,
"lsngrptottcptranslbytes":<Double_value>,
"lsngrpicmpdrppktsrate":<Double_value>,
"lsngrpcursessionsrate":<Double_value>,
"lsngrpudpdrppktsrate":<Double_value>,
"lsngrptcpdrppktsrate":<Double_value>,
"lsngrpcursessions":<Double_value>
}]}