Citrix ADC 12.1 NITRO API Reference

aaa

August 17, 2023

Contributed by:

Statistics for aaa.

Properties

(click to see Operations)

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

aaa

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

aaa

Properties

Operations

get (all)

In this article