New in version 2.8.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| authentication_setting dictionary | Default: null | Configure authentication setting. | |
| active_auth_scheme string | Active authentication method (scheme name). Source authentication.scheme.name. | ||
| captive_portal string | Captive portal host name. Source firewall.address.name. | ||
| captive_portal6 string | IPv6 captive portal host name. Source firewall.address6.name. | ||
| captive_portal_ip string | Captive portal IP address. | ||
| captive_portal_ip6 string | Captive portal IPv6 address. | ||
| captive_portal_port integer | Captive portal port number (1 - 65535). | ||
| captive_portal_type string |
| Captive portal type. | |
| sso_auth_scheme string | Single-Sign-On authentication method (scheme name). Source authentication.scheme.name. | ||
| host string | FortiOS or FortiGate IP address. | ||
| https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
| password string | Default: "" | FortiOS or FortiGate password. | |
| ssl_verify boolean added in 2.9 |
| Ensures FortiGate certificate must be verified by a proper CA. | |
| username string | FortiOS or FortiGate username. | ||
| 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. | |
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure authentication setting.
fortios_authentication_setting:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
authentication_setting:
active_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
captive_portal: "<your_own_value> (source firewall.address.name)"
captive_portal_ip: "<your_own_value>"
captive_portal_ip6: "<your_own_value>"
captive_portal_port: "7"
captive_portal_type: "fqdn"
captive_portal6: "<your_own_value> (source firewall.address6.name)"
sso_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
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 |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_authentication_setting_module.html