fortinet.fortios.fortios_authentication_rule – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_authentication_rule
.
New in version 2.10: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
authentication_rule dictionary | Configure Authentication Rules. | |||
active_auth_method string | Select an active authentication method. Source authentication.scheme.name. | |||
comments string | Comment. | |||
dstaddr list / elements=string | Select an IPv4 destination address from available options. Required for web proxy authentication. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. | |||
dstaddr6 list / elements=string | Select an IPv6 destination address from available options. Required for web proxy authentication. | |||
name string / required | Address name. Source firewall.address6.name firewall.addrgrp6.name. | |||
ip_based string |
| Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. | ||
name string / required | Authentication rule name. | |||
protocol string |
| Select the protocol to use for authentication . Users connect to the FortiGate using this protocol and are asked to authenticate. | ||
srcaddr list / elements=string | Select an IPv4 source address from available options. Required for web proxy authentication. | |||
name string / required | Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name. | |||
srcaddr6 list / elements=string | Select an IPv6 source address. Required for web proxy authentication. | |||
name string / required | Address name. Source firewall.address6.name firewall.addrgrp6.name. | |||
srcintf list / elements=string | Incoming (ingress) interface. | |||
name string / required | Interface name. Source system.interface.name system.zone.name. | |||
sso_auth_method string | Select a single-sign on (SSO) authentication method. Source authentication.scheme.name. | |||
status string |
| Enable/disable this authentication rule. | ||
transaction_based string |
| Enable/disable transaction based authentication . | ||
web_auth_cookie string |
| Enable/disable Web authentication cookies . | ||
web_portal string |
| Enable/disable web portal for proxy transparent policy . | ||
enable_log boolean |
| Enable/Disable logging for task. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure Authentication Rules. 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>" dstaddr: - name: "default_name_6 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name)" dstaddr6: - name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)" ip_based: "enable" name: "default_name_10" protocol: "http" srcaddr: - name: "default_name_13 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)" srcaddr6: - name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)" srcintf: - name: "default_name_17 (source system.interface.name system.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 here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_authentication_rule_module.html