New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
authentication_setting
-
|
Default: null
|
Configure authentication setting.
|
|
active-auth-scheme
-
|
Active authentication method (scheme name). Source authentication.scheme.name.
|
||
captive-portal
-
|
Captive portal host name. Source firewall.address.name.
|
||
captive-portal-ip
-
|
Captive portal IP address.
|
||
captive-portal-ip6
-
|
Captive portal IPv6 address.
|
||
captive-portal-port
-
|
Captive portal port number (1 - 65535, default = 0).
|
||
captive-portal-type
-
|
|
Captive portal type.
|
|
captive-portal6
-
|
IPv6 captive portal host name. Source firewall.address6.name.
|
||
sso-auth-scheme
-
|
Single-Sign-On authentication method (scheme name). Source authentication.scheme.name.
|
||
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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"
tasks:
- name: Configure authentication setting.
fortios_authentication_setting:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
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.