Product Documentation

aaa

Sep 08, 2016

Statistics for aaa.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
aaaauthsuccess
<Double>
Read-only
Count of authentication successes.
aaaauthsuccessrate
<Double>
Read-only
Rate (/s) counter for aaaauthsuccess
aaaauthfail
<Double>
Read-only
Count of authentication failures.
aaaauthfailrate
<Double>
Read-only
Rate (/s) counter for aaaauthfail
aaaauthonlyhttpsuccess
<Double>
Read-only
Count of HTTP connections that succeeded authorization.
aaaauthonlyhttpsuccessrate
<Double>
Read-only
Rate (/s) counter for aaaauthonlyhttpsuccess
aaaauthonlyhttpfail
<Double>
Read-only
Count of HTTP connections that failed authorization.
aaaauthonlyhttpfailrate
<Double>
Read-only
Rate (/s) counter for aaaauthonlyhttpfail
aaaauthnonhttpsuccess
<Double>
Read-only
Count of non HTTP connections that succeeded authorization.
aaaauthnonhttpsuccessrate
<Double>
Read-only
Rate (/s) counter for aaaauthnonhttpsuccess
aaaauthnonhttpfail
<Double>
Read-only
Count of non HTTP connections that failed authorization.
aaaauthnonhttpfailrate
<Double>
Read-only
Rate (/s) counter for aaaauthnonhttpfail
aaacursessions
<Double>
Read-only
Count of current AAA sessions.
aaacursessionsrate
<Double>
Read-only
Rate (/s) counter for aaacursessions
aaatotsessions
<Double>
Read-only
Count of all AAA sessions.
aaasessionsrate
<Double>
Read-only
Rate (/s) counter for aaatotsessions
aaatotsessiontimeout
<Double>
Read-only
Count of AAA sessions that have timed out.
aaasessiontimeoutrate
<Double>
Read-only
Rate (/s) counter for aaatotsessiontimeout
aaacuricasessions
<Double>
Read-only
Count of current ICA only sessions.
aaacuricasessionsrate
<Double>
Read-only
Rate (/s) counter for aaacuricasessions
aaacuricaonlyconn
<Double>
Read-only
Count of current ICA only connections.
aaacuricaonlyconnrate
<Double>
Read-only
Rate (/s) counter for aaacuricaonlyconn
aaacuricaconn
<Double>
Read-only
Count of current ICA connections.
aaacuricaconnrate
<Double>
Read-only
Rate (/s) counter for aaacuricaconn
aaacurtmsessions
<Double>
Read-only
Count of current AAATM sessions.
aaacurtmsessionsrate
<Double>
Read-only
Rate (/s) counter for aaacurtmsessions
aaatottmsessions
<Double>
Read-only
Count of all AAATM sessions.
aaatmsessionsrate
<Double>
Read-only
Rate (/s) counter for aaatottmsessions

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/aaa

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/aaa?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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:

{ "aaa": [ {
      "aaatotsessiontimeout":<Double_value>,
      "aaaauthfail":<Double_value>,
      "aaaauthsuccess":<Double_value>,
      "aaatottmsessions":<Double_value>,
      "aaaauthonlyhttpfailrate":<Double_value>,
      "aaaauthnonhttpsuccess":<Double_value>,
      "aaacuricaonlyconnrate":<Double_value>,
      "aaaauthonlyhttpsuccessrate":<Double_value>,
      "aaacurtmsessions":<Double_value>,
      "aaacuricasessions":<Double_value>,
      "aaatotsessions":<Double_value>,
      "aaaauthonlyhttpfail":<Double_value>,
      "aaacuricaonlyconn":<Double_value>,
      "aaatmsessionsrate":<Double_value>,
      "aaaauthfailrate":<Double_value>,
      "aaacursessionsrate":<Double_value>,
      "aaaauthnonhttpsuccessrate":<Double_value>,
      "aaacuricaconn":<Double_value>,
      "aaaauthnonhttpfailrate":<Double_value>,
      "aaaauthnonhttpfail":<Double_value>,
      "aaacuricaconnrate":<Double_value>,
      "aaaauthsuccessrate":<Double_value>,
      "aaaauthonlyhttpsuccess":<Double_value>,
      "aaacurtmsessionsrate":<Double_value>,
      "aaasessiontimeoutrate":<Double_value>,
      "aaacuricasessionsrate":<Double_value>,
      "aaacursessions":<Double_value>,
      "aaasessionsrate":<Double_value>
}]}