ADC NITRO APIs

systemsession

Configuration for system session resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
sid Read-write ID of the system session about which to display information.

Minimum value = 1
all Read-write Terminate all the system sessions except the current session.
username Read-only user name of the session.
logintime Read-only logged-in time of this session.
logintimelocal Read-only logged-in time (in local ADC timezone) of this session.
lastactivitytime Read-only last activity time of this session.
lastactivitytimelocal Read-only last activity time (in local ADC timezone) of this session.
expirytime Read-only Time left in expire the session in seconds.
numofconnections Read-only number of connection using this token.
currentconn Read-only True if the token is used for current session.
clienttype Read-only client type of the session.

Possible values = CLI, CONSOLE, API, GUI
partitionname Read-only Name of the partition where the user is currently present.
clientipaddress Read-only IP address of client connecting to ADC.
__count Read-only count parameter

Operations

(click to see Properties )

  • GET (ALL)
  • GET
  • COUNT
  • KILL

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

kill

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemsession? action=kill HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemsession":{
"sid":<Double_value>,
"all":<Boolean_value>
}}

<!--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/systemsession Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/systemsession? 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/systemsession? filter=property-name1:property-val1,property-name2:property-val2

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

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

Use this query-parameter to get the summary output of systemsession 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/systemsession? pagesize=#no;pageno=#no

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

{ "systemsession": [ {
"sid":<Double_value>,
"username":<String_value>,
"logintime":<String_value>,
"logintimelocal":<String_value>,
"lastactivitytime":<String_value>,
"lastactivitytimelocal":<String_value>,
"expirytime":<Integer_value>,
"numofconnections":<Double_value>,
"currentconn":<Boolean_value>,
"clienttype":<String_value>,
"partitionname":<String_value>,
"clientipaddress":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemsession/ sid_value<Double> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/systemsession/ sid_value<Double> ? attrs=property-name1,property-name2

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

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

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

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

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:

{  "systemsession": [ {
"sid":<Double_value>,
"username":<String_value>,
"logintime":<String_value>,
"logintimelocal":<String_value>,
"lastactivitytime":<String_value>,
"lastactivitytimelocal":<String_value>,
"expirytime":<Integer_value>,
"numofconnections":<Double_value>,
"currentconn":<Boolean_value>,
"clienttype":<String_value>,
"partitionname":<String_value>,
"clientipaddress":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemsession? 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:

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

<!--NeedCopy-->
systemsession