fortios_authentication_rule – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and rule 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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
  • authentication_rule - Configure Authentication Rules. type: dict more...
    • active_auth_method - Select an active authentication method. Source authentication.scheme.name. type: str more...
    • comments - Comment. type: str more...
    • cors_depth - Depth to allow CORS access . type: int more...
    • cors_stateful - Enable/disable allowance of CORS access . type: str choices: enable, disable more...
    • dstaddr - Select an IPv4 destination address from available options. Required for web proxy authentication. type: list member_path: dstaddr:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. type: str required: true more...
    • dstaddr6 - Select an IPv6 destination address from available options. Required for web proxy authentication. type: list member_path: dstaddr6:name more...
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
    • ip_based - Enable/disable IP-based authentication. When enabled, previously authenticated users from the same IP address will be exempted. type: str choices: enable, disable more...
    • name - Authentication rule name. type: str required: true more...
    • protocol - Authentication is required for the selected protocol . type: str choices: http, ftp, socks, ssh more...
    • srcaddr - Authentication is required for the selected IPv4 source address. type: list member_path: srcaddr:name more...
      • name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. type: str required: true more...
    • srcaddr6 - Authentication is required for the selected IPv6 source address. type: list member_path: srcaddr6:name more...
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
    • srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name more...
      • name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...
    • sso_auth_method - Select a single-sign on (SSO) authentication method. Source authentication.scheme.name. type: str more...
    • status - Enable/disable this authentication rule. type: str choices: enable, disable more...
    • transaction_based - Enable/disable transaction based authentication . type: str choices: enable, disable more...
    • web_auth_cookie - Enable/disable Web authentication cookies . type: str choices: enable, disable more...
    • web_portal - Enable/disable web portal for proxy transparent policy . type: str choices: enable, disable more...

Notes

Note

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

Examples

- name: Configure Authentication Rules.
  fortinet.fortios.fortios_authentication_rule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_rule:
          active_auth_method: "<your_own_value> (source authentication.scheme.name)"
          comments: "<your_own_value>"
          cors_depth: "3"
          cors_stateful: "enable"
          dstaddr:
              -
                  name: "default_name_8 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          dstaddr6:
              -
                  name: "default_name_10 (source firewall.address6.name firewall.addrgrp6.name)"
          ip_based: "enable"
          name: "default_name_12"
          protocol: "http"
          srcaddr:
              -
                  name: "default_name_15 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          srcaddr6:
              -
                  name: "default_name_17 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_19 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
          status: "enable"
          transaction_based: "enable"
          web_auth_cookie: "enable"
          web_portal: "enable"

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.