fortinet.fortios.fortios_authentication_rule module – Configure Authentication Rules in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
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.0.0: 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 |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure Authentication Rules. |
|
Select an active authentication method. Source authentication.scheme.name. |
|
Comment. |
|
Select an IPv4 destination address from available options. Required for web proxy authentication. |
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. |
|
Select an IPv6 destination address from available options. Required for web proxy authentication. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
Enable/disable IP-based authentication. When enabled, previously authenticated users from the same IP address will be exempted. Choices:
|
|
Authentication rule name. |
|
Authentication is required for the selected protocol . Choices:
|
|
Authentication is required for the selected IPv4 source address. |
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. |
|
Authentication is required for the selected IPv6 source address. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
Incoming (ingress) interface. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Select a single-sign on (SSO) authentication method. Source authentication.scheme.name. |
|
Enable/disable this authentication rule. Choices:
|
|
Enable/disable transaction based authentication . Choices:
|
|
Enable/disable Web authentication cookies . Choices:
|
|
Enable/disable web portal for proxy transparent policy . Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: “root” |
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 system
.external-resource.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 |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)