Skip to content

Latest commit

 

History

History
377 lines (333 loc) · 16.3 KB

fortios_user_tacacsplus.rst

File metadata and controls

377 lines (333 loc) · 16.3 KB
Raw
source:fortios_user_tacacsplus.py
orphan:

fortios_user_tacacsplus -- Configure TACACS+ server entries in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and tacacsplus category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_user_tacacsplus v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • user_tacacsplus - Configure TACACS+ server entries. type: dict more...
    Supported Version Ranges
    user_tacacsplus v6.0.0 -> latest
    • authen_type - Allowed authentication protocols/methods. type: str choices: mschap, chap, pap, ascii, auto more...
      Supported Version Ranges
      authen_type v6.0.0 -> latest
      [mschap] v6.0.0 -> latest
      [chap] v6.0.0 -> latest
      [pap] v6.0.0 -> latest
      [ascii] v6.0.0 -> latest
      [auto] v6.0.0 -> latest
    • authorization - Enable/disable TACACS+ authorization. type: str choices: enable, disable more...
      Supported Version Ranges
      authorization v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.2.0 -> v6.2.0 v6.2.5 -> latest
    • interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
      Supported Version Ranges
      interface_select_method v6.2.0 -> v6.2.0 v6.2.5 -> latest
      [auto] v6.0.0 -> latest
      [sdwan] v6.0.0 -> latest
      [specify] v6.0.0 -> latest
    • key - Key to access the primary server. type: str more...
      Supported Version Ranges
      key v6.0.0 -> latest
    • name - TACACS+ server entry name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • port - Port number of the TACACS+ server. type: int more...
      Supported Version Ranges
      port v6.0.0 -> latest
    • secondary_key - Key to access the secondary server. type: str more...
      Supported Version Ranges
      secondary_key v6.0.0 -> latest
    • secondary_server - Secondary TACACS+ server CN domain name or IP address. type: str more...
      Supported Version Ranges
      secondary_server v6.0.0 -> latest
    • server - Primary TACACS+ server CN domain name or IP address. type: str more...
      Supported Version Ranges
      server v6.0.0 -> latest
    • source_ip - Source IP address for communications to TACACS+ server. type: str more...
      Supported Version Ranges
      source_ip v6.0.0 -> latest
    • tertiary_key - Key to access the tertiary server. type: str more...
      Supported Version Ranges
      tertiary_key v6.0.0 -> latest
    • tertiary_server - Tertiary TACACS+ server CN domain name or IP address. type: str more...
      Supported Version Ranges
      tertiary_server v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure TACACS+ server entries.
  fortinet.fortios.fortios_user_tacacsplus:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_tacacsplus:
          authen_type: "mschap"
          authorization: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          key: "<your_own_value>"
          name: "default_name_8"
          port: "49"
          secondary_key: "<your_own_value>"
          secondary_server: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          tertiary_key: "<your_own_value>"
          tertiary_server: "<your_own_value>"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

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