Skip to content

aaa

Statistics for aaa.

Properties

(click to see Operations)

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

Operations

(click to see Properties)

GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/aaa

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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>
}]}