Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

aaatacacsparams

August 17, 2023
Contributed by: 
C

Configuration for tacacs parameters resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
serverip Read-write IP address of your TACACS+ server.

Minimum length = 1
serverport Read-write Port number on which the TACACS+ server listens for connections.

Default value: 49

Minimum value = 1
authtimeout Read-write Maximum number of seconds that the Citrix ADC waits for a response from the TACACS+ server.

Default value: 3

Minimum value = 1
tacacssecret Read-write Key shared between the TACACS+ server and clients. Required for allowing the Citrix ADC to communicate with the TACACS+ server.

Minimum length = 1
authorization Read-write Use streaming authorization on the TACACS+ server.

Possible values = ON, OFF
accounting Read-write Send accounting messages to the TACACS+ server.

Possible values = ON, OFF
auditfailedcmds Read-write The option for sending accounting messages to the TACACS+ server.

Possible values = ON, OFF
groupattrname Read-write TACACS+ group attribute name.Used for group extraction on the TACACS+ server.
defaultauthenticationgroup Read-write This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

Maximum length = 64
builtin <String[]> Read-only Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature Read-only The feature to be checked while applying this config.

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • 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 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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"aaatacacsparams":{
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "tacacssecret":<String_value>,
      "authorization":<String_value>,
      "accounting":<String_value>,
      "auditfailedcmds":<String_value>,
      "groupattrname":<String_value>,
      "defaultauthenticationgroup":<String_value>
}}

<!--NeedCopy-->

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/aaatacacsparams? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"aaatacacsparams":{
      "serverip":true,
      "serverport":true,
      "authtimeout":true,
      "tacacssecret":true,
      "authorization":true,
      "accounting":true,
      "auditfailedcmds":true,
      "groupattrname":true,
      "defaultauthenticationgroup":true
}}

<!--NeedCopy-->

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

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: 


{ "aaatacacsparams": [ {
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "tacacssecret":<String_value>,
      "authorization":<String_value>,
      "accounting":<String_value>,
      "auditfailedcmds":<String_value>,
      "groupattrname":<String_value>,
      "defaultauthenticationgroup":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->
aaatacacsparams
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.