fmgr_user_tacacs – Configure TACACS+ server entries.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager 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

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
user_tacacs yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: 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 FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • 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
  • adom - The parameter in requested url type: str required: true
  • user_tacacs - no description type: dict
    • authen-type - Allowed authentication protocols/methods. type: str choices: [auto, ascii, pap, chap, mschap] more...
    • authorization - Enable/disable TACACS+ authorization. type: str choices: [disable, enable] more...
    • dynamic_mapping - Dynamic_Mapping. type: array more...
      • _scope - _Scope. type: array more...
        • name - Name. type: str more...
        • vdom - Vdom. type: str more...
      • authen-type - Allowed authentication protocols/methods. type: str choices: [auto, ascii, pap, chap, mschap] more...
      • authorization - Enable/disable TACACS+ authorization. type: str choices: [disable, enable] more...
      • key - Key to access the primary server. type: str more...
      • port - Port number of the TACACS+ server. type: int more...
      • secondary-key - Key to access the secondary server. type: str more...
      • secondary-server - Secondary TACACS+ server CN domain name or IP address. type: str more...
      • server - Primary TACACS+ server CN domain name or IP address. type: str more...
      • source-ip - source IP for communications to TACACS+ server. type: str more...
      • tertiary-key - Key to access the tertiary server. type: str more...
      • tertiary-server - Tertiary TACACS+ server CN domain name or IP address. type: str more...
      • interface - Specify outgoing interface to reach server. type: str more...
      • interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
    • key - Key to access the primary server. type: str more...
    • name - TACACS+ server entry name. type: str more...
    • port - Port number of the TACACS+ server. type: int more...
    • secondary-key - Key to access the secondary server. type: str more...
    • secondary-server - Secondary TACACS+ server CN domain name or IP address. type: str more...
    • server - Primary TACACS+ server CN domain name or IP address. type: str more...
    • source-ip - source IP for communications to TACACS+ server. type: str more...
    • tertiary-key - Key to access the tertiary server. type: str more...
    • tertiary-server - Tertiary TACACS+ server CN domain name or IP address. type: str more...
    • interface - Specify outgoing interface to reach server. type: str more...
    • interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_user_tacacs:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        user_tacacs:
           authen-type: <value in [auto, ascii, pap, ...]>
           authorization: <value in [disable, enable]>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 authen-type: <value in [auto, ascii, pap, ...]>
                 authorization: <value in [disable, enable]>
                 key: <value of string>
                 port: <value of integer>
                 secondary-key: <value of string>
                 secondary-server: <value of string>
                 server: <value of string>
                 source-ip: <value of string>
                 tertiary-key: <value of string>
                 tertiary-server: <value of string>
                 interface: <value of string>
                 interface-select-method: <value in [auto, sdwan, specify]>
           key: <value of string>
           name: <value of string>
           port: <value of integer>
           secondary-key: <value of string>
           secondary-server: <value of string>
           server: <value of string>
           source-ip: <value of string>
           tertiary-key: <value of string>
           tertiary-server: <value of string>
           interface: <value of string>
           interface-select-method: <value in [auto, sdwan, specify]>

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.