New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
authentication_rule
-
|
Default: null
|
Configure Authentication Rules.
|
||
active-auth-method
-
|
Select an active authentication method. Source authentication.scheme.name.
|
|||
comments
-
|
Comment.
|
|||
ip-based
-
|
|
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed.
|
||
name
-
/ required
|
Authentication rule name.
|
|||
protocol
-
|
|
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate.
|
||
srcaddr
-
|
Select an IPv4 source address from available options. Required for web proxy authentication.
|
|||
name
-
/ required
|
Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name.
|
|||
srcaddr6
-
|
Select an IPv6 source address. Required for web proxy authentication.
|
|||
name
-
/ required
|
Address name. Source firewall.address6.name firewall.addrgrp6.name.
|
|||
sso-auth-method
-
|
Select a single-sign on (SSO) authentication method. Source authentication.scheme.name.
|
|||
state
-
|
|
Indicates whether to create or remove the object
|
||
status
-
|
|
Enable/disable this authentication rule.
|
||
transaction-based
-
|
|
Enable/disable transaction based authentication (default = disable).
|
||
web-auth-cookie
-
|
|
Enable/disable Web authentication cookies (default = disable).
|
||
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 Rules.
fortios_authentication_rule:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
authentication_rule:
state: "present"
active-auth-method: "<your_own_value> (source authentication.scheme.name)"
comments: "<your_own_value>"
ip-based: "enable"
name: "default_name_6"
protocol: "http"
srcaddr:
-
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
srcaddr6:
-
name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
sso-auth-method: "<your_own_value> (source authentication.scheme.name)"
status: "enable"
transaction-based: "enable"
web-auth-cookie: "enable"
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.