authenticationtacacsaction
Configuration for TACACS action resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name for the TACACS+ profile (action).
Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after TACACS profile is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my authentication action" or 'y authentication action').
Minimum length = 1
|
| serverip | <String> | Read-write | IP address assigned to the TACACS+ server.
Minimum length = 1
|
| serverport | <Integer> | Read-write | Port number on which the TACACS+ server listens for connections.
Default value: 49
Minimum value = 1
|
| authtimeout | <Double> | Read-write | Number of seconds the Citrix ADC waits for a response from the TACACS+ server.
Default value: 3
Minimum value = 1
|
| tacacssecret | <String> | Read-write | Key shared between the TACACS+ server and the Citrix ADC.
Required for allowing the Citrix ADC to communicate with the TACACS+ server.
Minimum length = 1
|
| authorization | <String> | Read-write | Use streaming authorization on the TACACS+ server.
Possible values = ON, OFF
|
| accounting | <String> | Read-write | Whether the TACACS+ server is currently accepting accounting messages.
Possible values = ON, OFF
|
| auditfailedcmds | <String> | Read-write | The state of the TACACS+ server that will receive accounting messages.
Possible values = ON, OFF
|
| groupattrname | <String> | Read-write | TACACS+ group attribute name.
Used for group extraction on the TACACS+ server.
|
| defaultauthenticationgroup | <String> | Read-write | This is the default group that is chosen when the authentication succeeds in addition to extracted groups. |
| attribute1 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '1' (where '1' changes for each attribute). |
| attribute2 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '2' (where '2' changes for each attribute). |
| attribute3 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '3' (where '3' changes for each attribute). |
| attribute4 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '4' (where '4' changes for each attribute). |
| attribute5 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '5' (where '5' changes for each attribute). |
| attribute6 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '6' (where '6' changes for each attribute). |
| attribute7 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '7' (where '7' changes for each attribute). |
| attribute8 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '8' (where '8' changes for each attribute). |
| attribute9 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '9' (where '9' changes for each attribute). |
| attribute10 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '10' (where '10' changes for each attribute). |
| attribute11 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '11' (where '11' changes for each attribute). |
| attribute12 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '12' (where '12' changes for each attribute). |
| attribute13 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '13' (where '13' changes for each attribute). |
| attribute14 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '14' (where '14' changes for each attribute). |
| attribute15 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '15' (where '15' changes for each attribute). |
| attribute16 | <String> | Read-write | Name of the custom attribute to be extracted from server and stored at index '16' (where '16' changes for each attribute). |
| attributes | <String> | Read-write | List of attribute names separated by ',' which needs to be fetched from tacacs server.
Note that preceeding and trailing spaces will be removed.
Attribute name can be 127 bytes and total length of this string should not cross 2047 bytes.
These attributes have multi-value support separated by ',' and stored as key-value pair in AAA session.
|
| success | <Double> | Read-only | . |
| failure | <Double> | Read-only | . |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- GET (ALL)
- GET
- COUNT
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=yesIf 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
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationtacacsaction":{
<b>"name":<String_value>,
</b>"serverip":true,
"serverport":true,
"authtimeout":true,
"tacacssecret":true,
"authorization":true,
"accounting":true,
"auditfailedcmds":true,
"groupattrname":true,
"defaultauthenticationgroup":true,
"attribute1":true,
"attribute2":true,
"attribute3":true,
"attribute4":true,
"attribute5":true,
"attribute6":true,
"attribute7":true,
"attribute8":true,
"attribute9":true,
"attribute10":true,
"attribute11":true,
"attribute12":true,
"attribute13":true,
"attribute14":true,
"attribute15":true,
"attribute16":true,
"attributes":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
delete
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction/ name_value<String> HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
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
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationtacacsaction":{
<b>"name":<String_value>,
</b>"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>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attributes":<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
add
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationtacacsaction":{
<b>"name":<String_value>,
</b>"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>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attributes":<String_value>
}}
Response: HTTP Status Code on Success: 201 Created
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/authenticationtacacsaction Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of authenticationtacacsaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? view=summary
Use this query-parameter to get the summary output of authenticationtacacsaction resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? pagesize=#no;pageno=#no
Use this query-parameter to get the authenticationtacacsaction resources in chunks.
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:
{ "authenticationtacacsaction": [ {
"name":<String_value>,
"serverip":<String_value>,
"serverport":<Integer_value>,
"authtimeout":<Double_value>,
"tacacssecret":<String_value>,
"authorization":<String_value>,
"accounting":<String_value>,
"auditfailedcmds":<String_value>,
"groupattrname":<String_value>,
"success":<Double_value>,
"failure":<Double_value>,
"defaultauthenticationgroup":<String_value>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attributes":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of authenticationtacacsaction resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:
{ "authenticationtacacsaction": [ {
"name":<String_value>,
"serverip":<String_value>,
"serverport":<Integer_value>,
"authtimeout":<Double_value>,
"tacacssecret":<String_value>,
"authorization":<String_value>,
"accounting":<String_value>,
"auditfailedcmds":<String_value>,
"groupattrname":<String_value>,
"success":<Double_value>,
"failure":<Double_value>,
"defaultauthenticationgroup":<String_value>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attributes":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationtacacsaction? count=yes 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:
{ "authenticationtacacsaction": [ { "__count": "#no"} ] }