ADC NITRO APIs

aaasession

Configuration for active connection resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
username Read-write Name of the AAA user.

Minimum length = 1
groupname Read-write Name of the AAA group.

Minimum length = 1
iip Read-write IP address or the first address in the intranet IP range.

Minimum length = 1
netmask Read-write Subnet mask for the intranet IP range.

Minimum length = 1
sessionkey Read-write Show aaa session associated with given session key.

Minimum length = 1

Maximum length = 127
nodeid Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
all Read-write Terminate all active AAA-TM/VPN sessions.
publicip Read-only Client’s public IP address.
publicport Read-only Client’s public port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
ipaddress Read-only Citrix ADC’s IP address.
port Read-only Citrix ADC’s port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
privateip Read-only Client’s private/mapped IP address.
privateport Read-only Client’s private/mapped port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
destip Read-only Destination IP address.
destport Read-only Destination port.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
intranetip Read-only Specifies the Intranet IP.
intranetip6 Read-only Specifies the Intranet IP6.
peid Read-only Core id of the session owner.
__count Read-only count parameter

Operations

(click to see Properties )

  • GET (ALL)
  • 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/aaasession? action=kill HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"aaasession":{ "username":<String_value>, "groupname":<String_value>, "iip":<String_value>, "netmask":<String_value>, "sessionkey":<String_value>, "all":<Boolean_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/aaasession Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/aaasession? args=username: <String_value> ,groupname: <String_value> ,iip: <String_value> ,netmask: <String_value> ,sessionkey: <String_value> ,nodeid: <Double_value>

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

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

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

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

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

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

{ "aaasession": [ { username:<String_value>,groupname:<String_value>,iip:<String_value>,netmask:<String_value>,sessionkey:<String_value>,nodeid:<Double_value>"publicip":<String_value>, "publicport":<Integer_value>, "ipaddress":<String_value>, "port":<Integer_value>, "privateip":<String_value>, "privateport":<Integer_value>, "destip":<String_value>, "destport":<Integer_value>, "intranetip":<String_value>, "intranetip6":<String_value>, "peid":<Double_value> }]}

count

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

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