fortinet.fortios.fortios_authentication_setting module – Configure authentication setting in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.2.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_authentication_setting.
New in fortinet.fortios 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 setting 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure authentication setting. |
|
Active authentication method (scheme name). Source authentication.scheme.name. |
|
Enable/disable redirecting HTTP user authentication to HTTPS. Choices:
|
|
Captive portal host name. Source firewall.address.name. |
|
IPv6 captive portal host name. Source firewall.address6.name. |
|
Captive portal IP address. |
|
Captive portal IPv6 address. |
|
Captive portal port number (1 - 65535). |
|
Captive portal SSL port number (1 - 65535). |
|
Captive portal type. Choices:
|
|
Enable/disable redirecting certificate authentication to HTTPS portal. Choices:
|
|
Certificate captive portal host name. Source firewall.address.name. |
|
Certificate captive portal IP address. |
|
Certificate captive portal port number (1 - 65535). |
|
Persistent web portal cookie maximum age in minutes (30 - 10080 (1 week)). |
|
Refresh rate divider of persistent web portal cookie . Refresh value = cookie-max-age/cookie-refresh-div. |
|
Address range for the IP based device query. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
Enable/disable persistent cookie on IP based web portal authentication . Choices:
|
|
Enable/disable persistent cookie on web portal authentication . Choices:
|
|
Single-Sign-On authentication method (scheme name). Source authentication.scheme.name. |
|
Time of the last update. |
|
CA certificate used for client certificate verification. |
|
CA certificate list. Source vpn.certificate.ca.name. |
|
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:
|
|
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: |
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 setting.
fortios_authentication_setting:
vdom: "{{ vdom }}"
authentication_setting:
active_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
auth_https: "enable"
captive_portal: "<your_own_value> (source firewall.address.name)"
captive_portal_ip: "<your_own_value>"
captive_portal_ip6: "<your_own_value>"
captive_portal_port: "7830"
captive_portal_ssl_port: "7831"
captive_portal_type: "fqdn"
captive_portal6: "<your_own_value> (source firewall.address6.name)"
cert_auth: "enable"
cert_captive_portal: "<your_own_value> (source firewall.address.name)"
cert_captive_portal_ip: "<your_own_value>"
cert_captive_portal_port: "7832"
cookie_max_age: "480"
cookie_refresh_div: "2"
dev_range:
-
name: "default_name_19 (source firewall.address.name firewall.addrgrp.name)"
ip_auth_cookie: "enable"
persistent_cookie: "enable"
sso_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
update_time: "<your_own_value>"
user_cert_ca:
-
name: "default_name_25 (source vpn.certificate.ca.name)"
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: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |