Product Documentation

aaaparameter

Sep 01, 2016

Configuration for AAA parameter resource.

Properties (click to see Operations)

Name Data Type Permissions Description
enablestaticpagecaching
<String>
Read-write
The default state of VPN Static Page caching. If nothing is specified, the default value is set to YES.
Default value: YES
Possible values = YES, NO
enableenhancedauthfeedback
<String>
Read-write
Enhanced auth feedback provides more information to the end user about the reason for an authentication failure. The default value is set to NO.
Default value: NO
Possible values = YES, NO
defaultauthtype
<String>
Read-write
The default authentication server type.
Default value: LOCAL
Possible values = LOCAL, LDAP, RADIUS, TACACS, CERT
maxaaausers
<Double>
Read-write
Maximum number of concurrent users allowed to log on to VPN simultaneously.
Minimum value = 1
maxloginattempts
<Double>
Read-write
Maximum Number of login Attempts.
Minimum value = 1
failedlogintimeout
<Double>
Read-write
Number of minutes an account will be locked if user exceeds maximum permissible attempts.
Minimum value = 1
aaadnatip
<String>
Read-write
Source IP address to use for traffic that is sent to the authentication server.
enablesessionstickiness
<String>
Read-write
Enables/Disables stickiness to authentication servers.
Default value: NO
Possible values = YES, NO
aaasessionloglevel
<String>
Read-write
Audit log level, which specifies the types of events to log for cli executed commands.
Available values function as follows:
* EMERGENCY - Events that indicate an immediate crisis on the server.
* ALERT - Events that might require action.
* CRITICAL - Events that indicate an imminent server crisis.
* ERROR - Events that indicate some type of error.
* WARNING - Events that require action in the near future.
* NOTICE - Events that the administrator should know about.
* INFORMATIONAL - All but low-level events.
* DEBUG - All events, in extreme detail.
Default value: DEFAULT_LOGLEVEL_AAA
Possible values = EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG
dynaddr
<String>
Read-write
Set by the DHCP client when the IP address was fetched dynamically.
Default value: OFF
Possible values = ON, OFF
ftmode
<String>
Read-write
First time user mode determines which configuration options are shown by default when logging in to the GUI. This setting is controlled by the GUI.
Default value: ON
Possible values = ON, HA, OFF

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

update

URL: http://<netscaler-ip-address>/nitro/v1/config/aaaparameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"aaaparameter":{
      "enablestaticpagecaching":<String_value>,
      "enableenhancedauthfeedback":<String_value>,
      "defaultauthtype":<String_value>,
      "maxaaausers":<Double_value>,
      "maxloginattempts":<Double_value>,
      "failedlogintimeout":<Double_value>,
      "aaadnatip":<String_value>,
      "enablesessionstickiness":<String_value>,
      "aaasessionloglevel":<String_value>,
      "dynaddr":<String_value>,
      "ftmode":<String_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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/aaaparameter?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"aaaparameter":{
      "enablestaticpagecaching":true,
      "enableenhancedauthfeedback":true,
      "defaultauthtype":true,
      "maxaaausers":true,
      "aaadnatip":true,
      "maxloginattempts":true,
      "enablesessionstickiness":true,
      "aaasessionloglevel":true,
      "dynaddr":true,
      "ftmode":true
}}

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/aaaparameter

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:

{ "aaaparameter": [ {
      "enablestaticpagecaching":<String_value>,
      "enableenhancedauthfeedback":<String_value>,
      "defaultauthtype":<String_value>,
      "maxaaausers":<Double_value>,
      "aaadnatip":<String_value>,
      "maxloginattempts":<Double_value>,
      "failedlogintimeout":<Double_value>,
      "enablesessionstickiness":<String_value>,
      "aaasessionloglevel":<String_value>,
      "dynaddr":<String_value>,
      "ftmode":<String_value>
}]}