Skip to content

tacacs_server

Configuration for TACACS Server configuration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
tacacs_key<String>Read-writeKey shared between the TACACS+ server and clients.
Minimum length = 1
Maximum length = 64
auth_timeout<Integer>Read-writeThe maximum number of seconds the system will wait for a response from the TACACS server.
Minimum value = 1
Maximum value =
name<String>Read-writeName of TACACS server.
Minimum length = 1
Maximum length = 128
port<Integer>Read-writeport number of TACACS server.
Minimum value = 1
Maximum value =
id<String>Read-writeId is system generated key for all the TACACS servers.
ip_address<String>Read-writeIP Address of TACACS server.
Minimum length = 1
Maximum length = 64
accounting<Boolean>Read-writeEnable accounting in the tacacs server.
address_type<Integer>Read-onlyConfiguration Type. Values: 0: IPv4, 1: IPv6.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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

add

URL: https://<MGMT-IP>/nitro/v1/config/tacacs_server?onerror=<String_value>

HTTP Method: null

Request Payload:

{tacacs_server: {
<b>"tacacs_key":<String_value></b>,
<b>"name":<String_value></b>,
<b>"ip_address":<String_value></b>,
"auth_timeout":<Integer_value>,
"id":<String_value>,
"port":<Integer_value>,
"accounting":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tacacs_server":[{
"tacacs_key":<String_value>,
"auth_timeout":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/tacacs_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/tacacs_server

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tacacs_server":[{
"tacacs_key":<String_value>,
"auth_timeout":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/tacacs_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tacacs_server":[{
"tacacs_key":<String_value>,
"auth_timeout":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/tacacs_server/id_value<String>

HTTP Method: null

Request Payload:

{tacacs_server:{
<b>"name":<String_value></b>,
<b>"id":<String_value></b>,
<b>"ip_address":<String_value></b>,
"auth_timeout":<Integer_value>,
"tacacs_key":<String_value>,
"port":<Integer_value>,
"accounting":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tacacs_server":[{
"tacacs_key":<String_value>,
"auth_timeout":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}