netscaler.adc.authenticationtacacsaction module – Configuration for TACACS action resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.authenticationtacacsaction.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for TACACS action resource.

Parameters

Parameter

Comments

accounting

any

Whether the TACACS+ server is currently accepting accounting messages.

Choices:

  • "ON"

  • "OFF"

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

attribute1

any

Name of the custom attribute to be extracted from server and stored at index ‘1’ (where ‘1’ changes for each attribute)

attribute10

any

Name of the custom attribute to be extracted from server and stored at index ‘10’ (where ‘10’ changes for each attribute)

attribute11

any

Name of the custom attribute to be extracted from server and stored at index ‘11’ (where ‘11’ changes for each attribute)

attribute12

any

Name of the custom attribute to be extracted from server and stored at index ‘12’ (where ‘12’ changes for each attribute)

attribute13

any

Name of the custom attribute to be extracted from server and stored at index ‘13’ (where ‘13’ changes for each attribute)

attribute14

any

Name of the custom attribute to be extracted from server and stored at index ‘14’ (where ‘14’ changes for each attribute)

attribute15

any

Name of the custom attribute to be extracted from server and stored at index ‘15’ (where ‘15’ changes for each attribute)

attribute16

any

Name of the custom attribute to be extracted from server and stored at index ‘16’ (where ‘16’ changes for each attribute)

attribute2

any

Name of the custom attribute to be extracted from server and stored at index ‘2’ (where ‘2’ changes for each attribute)

attribute3

any

Name of the custom attribute to be extracted from server and stored at index ‘3’ (where ‘3’ changes for each attribute)

attribute4

any

Name of the custom attribute to be extracted from server and stored at index ‘4’ (where ‘4’ changes for each attribute)

attribute5

any

Name of the custom attribute to be extracted from server and stored at index ‘5’ (where ‘5’ changes for each attribute)

attribute6

any

Name of the custom attribute to be extracted from server and stored at index ‘6’ (where ‘6’ changes for each attribute)

attribute7

any

Name of the custom attribute to be extracted from server and stored at index ‘7’ (where ‘7’ changes for each attribute)

attribute8

any

Name of the custom attribute to be extracted from server and stored at index ‘8’ (where ‘8’ changes for each attribute)

attribute9

any

Name of the custom attribute to be extracted from server and stored at index ‘9’ (where ‘9’ changes for each attribute)

attributes

any

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

auditfailedcmds

any

The state of the TACACS+ server that will receive accounting messages.

Choices:

  • "ON"

  • "OFF"

authorization

any

Use streaming authorization on the TACACS+ server.

Choices:

  • "ON"

  • "OFF"

authtimeout

any

Number of seconds the Citrix ADC waits for a response from the TACACS+ server.

defaultauthenticationgroup

any

This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

groupattrname

any

TACACS+ group attribute name.

Used for group extraction on the TACACS+ server.

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

name

any

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

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

serverip

any

IP address assigned to the TACACS+ server.

serverport

any

Port number on which the TACACS+ server listens for connections.

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

tacacssecret

any

Key shared between the TACACS+ server and the Citrix ADC.

Required for allowing the Citrix ADC to communicate with the TACACS+ server.

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)