New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
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.
|
|
webfilter_override
-
|
Default: null
|
Configure FortiGuard Web Filter administrative overrides.
|
|
expires
-
|
Override expiration date and time, from 5 minutes to 365 from now (format: yyyy/mm/dd hh:mm:ss).
|
||
id
-
/ required
|
Override rule ID.
|
||
initiator
-
|
Initiating user of override (read-only setting).
|
||
ip
-
|
IPv4 address which the override applies.
|
||
ip6
-
|
IPv6 address which the override applies.
|
||
new-profile
-
|
Name of the new web filter profile used by the override. Source webfilter.profile.name.
|
||
old-profile
-
|
Name of the web filter profile which the override applies. Source webfilter.profile.name.
|
||
scope
-
|
|
Override either the specific user, user group, IPv4 address, or IPv6 address.
|
|
state
-
|
|
Indicates whether to create or remove the object
|
|
status
-
|
|
Enable/disable override rule.
|
|
user
-
|
Name of the user which the override applies.
|
||
user-group
-
|
Specify the user group for which the override applies. Source user.group.name.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure FortiGuard Web Filter administrative overrides.
fortios_webfilter_override:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
webfilter_override:
state: "present"
expires: "<your_own_value>"
id: "4"
initiator: "<your_own_value>"
ip: "<your_own_value>"
ip6: "<your_own_value>"
new-profile: "<your_own_value> (source webfilter.profile.name)"
old-profile: "<your_own_value> (source webfilter.profile.name)"
scope: "user"
status: "enable"
user: "<your_own_value>"
user-group: "<your_own_value> (source user.group.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:
key1
|
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.