lsngroup
Statistics for LSN group resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| groupname |
|
Read-write | Name of the LSN Group.
Minimum length = 1 Maximum length = 127 |
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| lsngrpcursessions |
|
Read-only | Number of Current Sessions for LSN group |
| lsngrpcursessionsrate |
|
Read-only | Rate (/s) counter for lsngrpcursessions |
| lsngrptottranslbytes |
|
Read-only | Number of Translated Bytes for LSN group |
| lsngrptranslbytesrate |
|
Read-only | Rate (/s) counter for lsngrptottranslbytes |
| lsngrptottranslpkts |
|
Read-only | Number of Translated Pkts for LSN group |
| lsngrptranslpktsrate |
|
Read-only | Rate (/s) counter for lsngrptottranslpkts |
| lsngrptottcptranslpkts |
|
Read-only | Number of TCP Translated Pkts for LSN group |
| lsngrptcptranslpktsrate |
|
Read-only | Rate (/s) counter for lsngrptottcptranslpkts |
| lsngrptottcptranslbytes |
|
Read-only | Number of TCP Translated Bytes for LSN group |
| lsngrptcptranslbytesrate |
|
Read-only | Rate (/s) counter for lsngrptottcptranslbytes |
| lsngrptottcpdrppkts |
|
Read-only | Number of TCP Dropped Pkts for LSN group |
| lsngrptcpdrppktsrate |
|
Read-only | Rate (/s) counter for lsngrptottcpdrppkts |
| lsngrpcurtcpsessions |
|
Read-only | Number of TCP Current Sessions for LSN group |
| lsngrpcurtcpsessionsrate |
|
Read-only | Rate (/s) counter for lsngrpcurtcpsessions |
| lsngrptotudptranslpkts |
|
Read-only | Number of UDP Translated Pkts for LSN group |
| lsngrpudptranslpktsrate |
|
Read-only | Rate (/s) counter for lsngrptotudptranslpkts |
| lsngrptotudptranslbytes |
|
Read-only | Number of UDP Translated Bytes for LSN group |
| lsngrpudptranslbytesrate |
|
Read-only | Rate (/s) counter for lsngrptotudptranslbytes |
| lsngrptotudpdrppkts |
|
Read-only | Number of UDP Dropped Pkts for LSN group |
| lsngrpudpdrppktsrate |
|
Read-only | Rate (/s) counter for lsngrptotudpdrppkts |
| lsngrpcurudpsessions |
|
Read-only | Number of UDP Current Sessions for LSN group |
| lsngrpcurudpsessionsrate |
|
Read-only | Rate (/s) counter for lsngrpcurudpsessions |
| lsngrptoticmptranslpkts |
|
Read-only | Number of ICMP Translated Pkts for LSN group |
| lsngrpicmptranslpktsrate |
|
Read-only | Rate (/s) counter for lsngrptoticmptranslpkts |
| lsngrptoticmptranslbytes |
|
Read-only | Number of ICMP Translated Bytes for LSN group |
| lsngrpicmptranslbytesrate |
|
Read-only | Rate (/s) counter for lsngrptoticmptranslbytes |
| lsngrptoticmpdrppkts |
|
Read-only | Number of ICMP Dropped Pkts for LSN group |
| lsngrpicmpdrppktsrate |
|
Read-only | Rate (/s) counter for lsngrptoticmpdrppkts |
| lsngrpcuricmpsessions |
|
Read-only | Number of ICMP Current Sessions for LSN group |
| lsngrpcuricmpsessionsrate |
|
Read-only | Rate (/s) counter for lsngrpcuricmpsessions |
| lsngrpcursubscribers |
|
Read-only | Number of ICMP Current Sessions for LSN group |
| lsngrpcursubscribersrate |
|
Read-only | Rate (/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 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/lsngroup Query-parameters: args http:// <netscaler-ip-address> /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.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/lsngroup? 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:
{ "lsngroup": [ {
"groupname":<String_value>,
"lsngrptottranslpkts":<Double_value>,
"lsngrpcurtcpsessions":<Double_value>,
"lsngrptotudptranslpkts":<Double_value>,
"lsngrptoticmptranslbytes":<Double_value>,
"lsngrptottranslbytes":<Double_value>,
"lsngrpcuricmpsessionsrate":<Double_value>,
"lsngrpcuricmpsessions":<Double_value>,
"lsngrpcurtcpsessionsrate":<Double_value>,
"lsngrpcurudpsessionsrate":<Double_value>,
"lsngrptranslpktsrate":<Double_value>,
"lsngrpcursessions":<Double_value>,
"lsngrptcptranslbytesrate":<Double_value>,
"lsngrptoticmptranslpkts":<Double_value>,
"lsngrpcursubscribersrate":<Double_value>,
"lsngrpudptranslpktsrate":<Double_value>,
"lsngrpudptranslbytesrate":<Double_value>,
"lsngrpcurudpsessions":<Double_value>,
"lsngrpicmptranslpktsrate":<Double_value>,
"lsngrptotudpdrppkts":<Double_value>,
"lsngrpudpdrppktsrate":<Double_value>,
"lsngrpicmptranslbytesrate":<Double_value>,
"lsngrptottcpdrppkts":<Double_value>,
"lsngrptotudptranslbytes":<Double_value>,
"lsngrptottcptranslpkts":<Double_value>,
"lsngrpicmpdrppktsrate":<Double_value>,
"lsngrpcursessionsrate":<Double_value>,
"lsngrptranslbytesrate":<Double_value>,
"lsngrptoticmpdrppkts":<Double_value>,
"lsngrptcptranslpktsrate":<Double_value>,
"lsngrpcursubscribers":<Double_value>,
"lsngrptottcptranslbytes":<Double_value>,
"lsngrptcpdrppktsrate":<Double_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "lsngroup": [ {
"groupname":<String_value>,
"lsngrptottranslpkts":<Double_value>,
"lsngrpcurtcpsessions":<Double_value>,
"lsngrptotudptranslpkts":<Double_value>,
"lsngrptoticmptranslbytes":<Double_value>,
"lsngrptottranslbytes":<Double_value>,
"lsngrpcuricmpsessionsrate":<Double_value>,
"lsngrpcuricmpsessions":<Double_value>,
"lsngrpcurtcpsessionsrate":<Double_value>,
"lsngrpcurudpsessionsrate":<Double_value>,
"lsngrptranslpktsrate":<Double_value>,
"lsngrpcursessions":<Double_value>,
"lsngrptcptranslbytesrate":<Double_value>,
"lsngrptoticmptranslpkts":<Double_value>,
"lsngrpcursubscribersrate":<Double_value>,
"lsngrpudptranslpktsrate":<Double_value>,
"lsngrpudptranslbytesrate":<Double_value>,
"lsngrpcurudpsessions":<Double_value>,
"lsngrpicmptranslpktsrate":<Double_value>,
"lsngrptotudpdrppkts":<Double_value>,
"lsngrpudpdrppktsrate":<Double_value>,
"lsngrpicmptranslbytesrate":<Double_value>,
"lsngrptottcpdrppkts":<Double_value>,
"lsngrptotudptranslbytes":<Double_value>,
"lsngrptottcptranslpkts":<Double_value>,
"lsngrpicmpdrppktsrate":<Double_value>,
"lsngrpcursessionsrate":<Double_value>,
"lsngrptranslbytesrate":<Double_value>,
"lsngrptoticmpdrppkts":<Double_value>,
"lsngrptcptranslpktsrate":<Double_value>,
"lsngrpcursubscribers":<Double_value>,
"lsngrptottcptranslbytes":<Double_value>,
"lsngrptcpdrppktsrate":<Double_value>
}]}
<!--NeedCopy-->