netscaler.adc.authenticationtacacsaction (2.5.1) — module

Configuration for TACACS action resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1


Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for TACACS action resource.

Inputs

    
name:
    description:
    - 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').
    type: str

nsip:
    description:
    - 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.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    - unset
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

serverip:
    description:
    - IP address assigned to the TACACS+ server.
    type: str

accounting:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Whether the TACACS+ server is currently accepting accounting messages.
    type: str

attribute1:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '1'
      (where '1' changes for each attribute)
    type: str

attribute2:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '2'
      (where '2' changes for each attribute)
    type: str

attribute3:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '3'
      (where '3' changes for each attribute)
    type: str

attribute4:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '4'
      (where '4' changes for each attribute)
    type: str

attribute5:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '5'
      (where '5' changes for each attribute)
    type: str

attribute6:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '6'
      (where '6' changes for each attribute)
    type: str

attribute7:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '7'
      (where '7' changes for each attribute)
    type: str

attribute8:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '8'
      (where '8' changes for each attribute)
    type: str

attribute9:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '9'
      (where '9' changes for each attribute)
    type: str

attributes:
    description:
    - 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
    type: str

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

serverport:
    description:
    - Port number on which the TACACS+ server listens for connections.
    type: int

attribute10:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '10'
      (where '10' changes for each attribute)
    type: str

attribute11:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '11'
      (where '11' changes for each attribute)
    type: str

attribute12:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '12'
      (where '12' changes for each attribute)
    type: str

attribute13:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '13'
      (where '13' changes for each attribute)
    type: str

attribute14:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '14'
      (where '14' changes for each attribute)
    type: str

attribute15:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '15'
      (where '15' changes for each attribute)
    type: str

attribute16:
    description:
    - Name of the custom attribute to be extracted from server and stored at index '16'
      (where '16' changes for each attribute)
    type: str

authtimeout:
    description:
    - Number of seconds the Citrix ADC waits for a response from the TACACS+ server.
    type: float

save_config:
    default: false
    description:
    - If C(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.
    type: bool

tacacssecret:
    description:
    - Key shared between the TACACS+ server and the Citrix ADC.
    - Required for allowing the Citrix ADC to communicate with the TACACS+ server.
    type: str

authorization:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Use streaming authorization on the TACACS+ server.
    type: str

groupattrname:
    description:
    - TACACS+ group attribute name.
    - Used for group extraction on the TACACS+ server.
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

auditfailedcmds:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - The state of the TACACS+ server that will receive accounting messages.
    type: str

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

defaultauthenticationgroup:
    description:
    - This is the default group that is chosen when the authentication succeeds in addition
      to extracted groups.
    type: str

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: 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'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list