Skip to content

lsnpool

Statistics for LSN pool resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
poolname<String>Read-writeName of the LSN Pool.
Minimum length = 1
Maximum length = 127
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
lsnpoolotherportusagepercen<Double>Read-onlyOther protocols ports usage percentage in this pool.
lsnpooltcpportusagepercen<Double>Read-onlyTCP ports usage percentage in this pool.
lsnpoolcurportalloctcp<Double>Read-onlyCurrent port allocation for tcp in this pool.
lsnpoolcurportalloctcprate<Double>Read-onlyRate (/s) counter for lsnpoolcurportalloctcp
lsnpoolcurportallocother<Double>Read-onlyCurrent port allocation for other protocols in this pool.
lsnpoolcurportallocotherrate<Double>Read-onlyRate (/s) counter for lsnpoolcurportallocother
lsnpooltotips<Double>Read-onlyTotal IPs in this pool.

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

Query-parameters:

args

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

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

{ "lsnpool": [ {
"poolname":<String_value>,
"lsnpooltotips":<Double_value>,
"lsnpoolcurportallocother":<Double_value>,
"lsnpoolcurportalloctcp":<Double_value>,
"lsnpooltcpportusagepercen":<Double_value>,
"lsnpoolcurportalloctcprate":<Double_value>,
"lsnpoolotherportusagepercen":<Double_value>,
"lsnpoolcurportallocotherrate":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/lsnpool/poolname_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:

{ "lsnpool": [ {
"poolname":<String_value>,
"lsnpooltotips":<Double_value>,
"lsnpoolcurportallocother":<Double_value>,
"lsnpoolcurportalloctcp":<Double_value>,
"lsnpooltcpportusagepercen":<Double_value>,
"lsnpoolcurportalloctcprate":<Double_value>,
"lsnpoolotherportusagepercen":<Double_value>,
"lsnpoolcurportallocotherrate":<Double_value>
}]}