faz_cli_system_admin_tacacs – TACACS+ server entry configuration.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_system_admin_tacacs yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • cli_system_admin_tacacs - TACACS+ server entry configuration. type: dict
    • authen-type - Authentication type. type: str choices: [auto, ascii, pap, chap, mschap] default: auto more...
    • authorization - Enable/disable TACACS+ authorization. type: str choices: [disable, enable] default: disable more...
    • key - No description for the parameter type: str more...
    • name - TACACS+ server entry name. type: str more...
    • port - Port number of TACACS+ server. type: int default: 49 more...
    • secondary-key - No description for the parameter type: str more...
    • secondary-server - {} secondary server domain name or IP. type: str more...
    • server - {} server domain name or IP. type: str more...
    • tertiary-key - No description for the parameter type: str more...
    • tertiary-server - {} tertiary server domain name or IP. type: str more...

Notes

Note

  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_admin_tacacs:
      cli_system_admin_tacacs:
        authen-type: auto
        authorization: enable
        key: fookey
        name: footacacs
        port: 10443
        server: 192.100.23.45
      state: present
    name: TACACS+ server entry configuration.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.