Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nslimitsessions

August 17, 2023
Contributed by: 
C

Configuration for limit sessions resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
limitidentifier Read-write Name of the rate limit identifier for which to display the sessions.

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

Operations

(click to see Properties )

  • GET (ALL)
  • COUNT
  • CLEAR

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

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":{
<b>      "limitidentifier":<String_value>
</b>}}

<!--NeedCopy-->

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

Use this query-parameter to get the summary output of nslimitsessions resources configured on NetScaler.

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 Header:

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>
}]}

<!--NeedCopy-->

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 Header:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
nslimitsessions
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.