Skip to content

nslimitsessions

Configuration for limit sessions resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
limitidentifier<String>Read-writeName of the rate limit identifier for which to display the sessions.
Minimum length = 1
detail<Boolean>Read-writeShow the individual hash values.
timeout<Double>Read-onlyThe time remaining on the session before a flush can be attempted. If active transactions are present the session will not be flushed.
hits<Double>Read-onlyThe number of times this entry was hit.
drop<Double>Read-onlyThe number of times action was taken.
number<Double[]>Read-onlyThe hash of the matched selectlets.
name<String>Read-onlyThe string formed by gathering selectlet values.
unit<Double>Read-onlyTotal computed hash of the matched selectlets.
flags<Double>Read-onlyUsed internally to identify ip addresses.
referencecount<Double>Read-onlyTotal number of transactions pointing to this entry. Its the sum total of the connection and bandwidth references.
maxbandwidth<Double>Read-onlyThe current bandwidth.
selectoripv61<String>Read-onlyFirst IPV6 address gathered.
selectoripv62<String>Read-onlySecond IPV6 address gathered.
flag<Double>Read-onlyUsed internally to identify ipv6 addresses.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

CLEAR| GET (ALL)| COUNT

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>.

clear

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?action=clear

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nslimitsessions":{
<b>"limitidentifier":<String_value>
</b>}}

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 error

get (all)

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

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?args=limitidentifier:<String_value>,detail:<Boolean_value>

Use this query-parameter to get nslimitsessions resources based on additional properties.

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nslimitsessions resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?pagesize=#no;pageno=#no

Use this query-parameter to get the nslimitsessions resources in chunks.

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:

{ "nslimitsessions": [ {
<b>limitidentifier:<String_value>,</b>detail:<Boolean_value>"timeout":<Double_value>,
"hits":<Double_value>,
"drop":<Double_value>,
"number":<Double[]_value>,
"name":<String_value>,
"unit":<Double_value>,
"flags":<Double_value>,
"referencecount":<Double_value>,
"maxbandwidth":<Double_value>,
"selectoripv61":<String_value>,
"selectoripv62":<String_value>,
"flag":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslimitsessions?args=limitidentifier:<String_value>,detail:<Boolean_value>;count=yes

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:

{ "nslimitsessions": [ { "__count": "#no"} ] }