Citrix ADC 12.1 NITRO API Reference

lsndslite

August 17, 2023

Contributed by:

Read/write properties

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
lsntotdsliterxpkts	Read-only	Total number of LSN DS-Lite rx pkts.
lsndsliterxpktsrate	Read-only	Rate (/s) counter for lsntotdsliterxpkts
lsntotdsliterxbytes	Read-only	Total number of LSN DS-Lite rx bytes.
lsndsliterxbytesrate	Read-only	Rate (/s) counter for lsntotdsliterxbytes
lsntotdslitetxpkts	Read-only	Total number of LSN DS-Lite tx pkts.
lsndslitetxpktsrate	Read-only	Rate (/s) counter for lsntotdslitetxpkts
lsntotdslitetxbytes	Read-only	Total number of LSN DS-Lite tx bytes.
lsndslitetxbytesrate	Read-only	Rate (/s) counter for lsntotdslitetxbytes
lsntotdslitetcprxpkts	Read-only	Number of LSN DS-Lite TCP Received packets.
lsndslitetcprxpktsrate	Read-only	Rate (/s) counter for lsntotdslitetcprxpkts
lsntotdslitetcprxbytes	Read-only	Number of LSN DS-Lite TCP Received bytes.
lsndslitetcprxbytesrate	Read-only	Rate (/s) counter for lsntotdslitetcprxbytes
lsntotdslitetcptxpkts	Read-only	Number of LSN DS-Lite TCP Transmitted packets.
lsndslitetcptxpktsrate	Read-only	Rate (/s) counter for lsntotdslitetcptxpkts
lsntotdslitetcptxbytes	Read-only	Number of LSN DS-Lite TCP Transmitted bytes.
lsndslitetcptxbytesrate	Read-only	Rate (/s) counter for lsntotdslitetcptxbytes
lsntotdslitetcpdrppkts	Read-only	Number of LSN DS-Lite TCP Dropped packets.
lsndslitetcpdrppktsrate	Read-only	Rate (/s) counter for lsntotdslitetcpdrppkts
lsncurdslitetcpsessions	Read-only	Number of LSN DS-Lite TCP Current Sessions.
lsncurdslitetcpsessionsrate	Read-only	Rate (/s) counter for lsncurdslitetcpsessions
lsntotdsliteudprxpkts	Read-only	Number of LSN DS-Lite UDP Received packets.
lsndsliteudprxpktsrate	Read-only	Rate (/s) counter for lsntotdsliteudprxpkts
lsntotdsliteudprxbytes	Read-only	Number of LSN DS-Lite UDP Received bytes.
lsndsliteudprxbytesrate	Read-only	Rate (/s) counter for lsntotdsliteudprxbytes
lsntotdsliteudptxpkts	Read-only	Number of LSN DS-Lite UDP Transmitted packets.
lsndsliteudptxpktsrate	Read-only	Rate (/s) counter for lsntotdsliteudptxpkts
lsntotdsliteudptxbytes	Read-only	Number of LSN DS-Lite UDP Transmitted bytes.
lsndsliteudptxbytesrate	Read-only	Rate (/s) counter for lsntotdsliteudptxbytes
lsntotdsliteudpdrppkts	Read-only	Number of LSN DS-Lite UDP Dropped packets.
lsndsliteudpdrppktsrate	Read-only	Rate (/s) counter for lsntotdsliteudpdrppkts
lsncurdsliteudpsessions	Read-only	Number of LSN DS-Lite UDP Current Sessions.
lsncurdsliteudpsessionsrate	Read-only	Rate (/s) counter for lsncurdsliteudpsessions
lsntotdsliteicmprxpkts	Read-only	Number of LSN DS-Lite ICMP Received packets.
lsndsliteicmprxpktsrate	Read-only	Rate (/s) counter for lsntotdsliteicmprxpkts
lsntotdsliteicmprxbytes	Read-only	Number of LSN DS-Lite ICMP Received bytes.
lsndsliteicmprxbytesrate	Read-only	Rate (/s) counter for lsntotdsliteicmprxbytes
lsntotdsliteicmptxpkts	Read-only	Number of LSN DS-Lite ICMP Transmitted packets.
lsndsliteicmptxpktsrate	Read-only	Rate (/s) counter for lsntotdsliteicmptxpkts
lsntotdsliteicmptxbytes	Read-only	Number of LSN DS-Lite ICMP Transmitted bytes.
lsndsliteicmptxbytesrate	Read-only	Rate (/s) counter for lsntotdsliteicmptxbytes
lsntotdsliteicmpdrppkts	Read-only	Number of LSN DS-Lite ICMP Dropped packets.
lsndsliteicmpdrppktsrate	Read-only	Rate (/s) counter for lsntotdsliteicmpdrppkts
lsncurdsliteicmpsessions	Read-only	Number of LSN DS-Lite ICMP Current Sessions.
lsncurdsliteicmpsessionsrate	Read-only	Rate (/s) counter for lsncurdsliteicmpsessions
lsncurdslitesessions	Read-only	Current number of LSN DS-Lite sessions.
lsncurdslitesessionsrate	Read-only	Rate (/s) counter for lsncurdslitesessions
lsndslitecursubscribers	Read-only	Current number of LSN DS-Lite subscribers.
lsndslitecursubscribersrate	Read-only	Rate (/s) counter for lsndslitecursubscribers

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

Query-parameters:

args

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

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

{ "lsndslite": [ {
"lsntotdsliteudpdrppkts":<Double_value>,
"lsndsliteudprxpktsrate":<Double_value>,
"lsntotdsliterxpkts":<Double_value>,
"lsntotdslitetxbytes":<Double_value>,
"lsncurdsliteicmpsessionsrate":<Double_value>,
"lsntotdsliteudptxbytes":<Double_value>,
"lsntotdsliteicmptxpkts":<Double_value>,
"lsndslitetxpktsrate":<Double_value>,
"lsntotdsliteicmptxbytes":<Double_value>,
"lsntotdsliterxbytes":<Double_value>,
"lsntotdsliteicmpdrppkts":<Double_value>,
"lsncurdslitetcpsessionsrate":<Double_value>,
"lsndsliteudptxbytesrate":<Double_value>,
"lsntotdsliteudprxbytes":<Double_value>,
"lsndsliterxbytesrate":<Double_value>,
"lsncurdsliteicmpsessions":<Double_value>,
"lsndsliteicmprxbytesrate":<Double_value>,
"lsndsliteudpdrppktsrate":<Double_value>,
"lsntotdslitetcpdrppkts":<Double_value>,
"lsntotdsliteicmprxbytes":<Double_value>,
"lsncurdslitesessionsrate":<Double_value>,
"lsntotdsliteicmprxpkts":<Double_value>,
"lsntotdslitetxpkts":<Double_value>,
"lsncurdsliteudpsessionsrate":<Double_value>,
"lsndslitetcptxpktsrate":<Double_value>,
"lsntotdslitetcptxpkts":<Double_value>,
"lsndsliteicmptxpktsrate":<Double_value>,
"lsndsliteicmpdrppktsrate":<Double_value>,
"lsntotdsliteudprxpkts":<Double_value>,
"lsncurdslitetcpsessions":<Double_value>,
"lsndslitetxbytesrate":<Double_value>,
"lsntotdslitetcprxbytes":<Double_value>,
"lsndsliteicmptxbytesrate":<Double_value>,
"lsndsliteicmprxpktsrate":<Double_value>,
"lsncurdslitesessions":<Double_value>,
"lsndslitetcprxbytesrate":<Double_value>,
"lsndslitecursubscribers":<Double_value>,
"lsntotdslitetcprxpkts":<Double_value>,
"lsndsliterxpktsrate":<Double_value>,
"lsncurdsliteudpsessions":<Double_value>,
"lsndslitetcprxpktsrate":<Double_value>,
"lsntotdsliteudptxpkts":<Double_value>,
"lsntotdslitetcptxbytes":<Double_value>,
"lsndslitetcpdrppktsrate":<Double_value>,
"lsndslitetcptxbytesrate":<Double_value>,
"lsndsliteudprxbytesrate":<Double_value>,
"lsndsliteudptxpktsrate":<Double_value>,
"lsndslitecursubscribersrate":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

lsndslite

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

lsndslite

Properties

Operations

get (all)

In this article