Product Documentation

authenticationtacacsaction

Sep 01, 2016

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 NetScaler 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 NetScaler appliance 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 NetScaler appliance.
Required for allowing the NetScaler appliance 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
defaultauthenticationgroup
<String>
Read-write
This is the default group that is chosen when the authentication succeeds in addition to extracted groups.
success
<Double>
Read-only
.
failure
<Double>
Read-only
.
__count
<Double>
Read-only
count parameter

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

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":{
      "name":<String_value>,
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "tacacssecret":<String_value>,
      "authorization":<String_value>,
      "accounting":<String_value>,
      "auditfailedcmds":<String_value>,
      "defaultauthenticationgroup":<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

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":{
      "name":<String_value>,
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "tacacssecret":<String_value>,
      "authorization":<String_value>,
      "accounting":<String_value>,
      "auditfailedcmds":<String_value>,
      "defaultauthenticationgroup":<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/authenticationtacacsaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"authenticationtacacsaction":{
      "name":<String_value>,
      "serverip":true,
      "serverport":true,
      "authtimeout":true,
      "tacacssecret":true,
      "authorization":true,
      "accounting":true,
      "auditfailedcmds":true,
      "defaultauthenticationgroup":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/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

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 Headers:

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>,
      "success":<Double_value>,
      "failure":<Double_value>,
      "defaultauthenticationgroup":<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

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 Headers:

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>,
      "success":<Double_value>,
      "failure":<Double_value>,
      "defaultauthenticationgroup":<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 Headers:

Content-Type:application/json

Response Payload:

{ "authenticationtacacsaction": [ { "__count": "#no"} ] }