Product Documentation

nslimitsessions

Sep 07, 2016

Configuration for limit sessions resource.

Properties (click to see Operations)

Name Data Type Permissions Description
limitidentifier
<String>
Read-write
Name of the rate limit identifier for which to display the sessions.
Minimum length = 1
detail
<Boolean>
Read-write
Show the individual hash values.
timeout
<Double>
Read-only
The 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-only
The number of times this entry was hit.
drop
<Double>
Read-only
The number of times action was taken.
number
<Double[]>
Read-only
The hash of the matched selectlets.
name
<String>
Read-only
The string formed by gathering selectlet values.
unit
<Double>
Read-only
Total computed hash of the matched selectlets.
flags
<Double>
Read-only
Used internally to identify ip addresses.
referencecount
<Double>
Read-only
Total number of transactions pointing to this entry. Its the sum total of the connection and bandwidth references.
maxbandwidth
<Double>
Read-only
The current bandwidth.
selectoripv61
<String>
Read-only
First IPV6 address gathered.
selectoripv62
<String>
Read-only
Second IPV6 address gathered.
flag
<Double>
Read-only
Used internally to identify ipv6 addresses.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

clear

URL: http://<netscaler-ip-address>/nitro/v1/config/nslimitsessions?action=clear

HTTP Method: POST

Request Headers:

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

Request Payload:

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

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/nslimitsessions

Query-parameters:

args

http://<netscaler-ip-address>/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://<netscaler-ip-address>/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://<netscaler-ip-address>/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 NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/nslimitsessions?view=summary

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

pagination

http://<netscaler-ip-address>/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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "nslimitsessions": [ {
limitidentifier:<String_value>,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://<netscaler-ip-address>/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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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