fortios_webfilter_fortiguard – Configure FortiGuard Web Filter service
fortios_webfilter_fortiguard – Configure FortiGuard Web Filter service
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS by allowing the user to configure webfilter feature and fortiguard category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
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_fortiguard - |
Default: null |
Configure FortiGuard Web Filter service. | |
cache-mem-percent - |
Maximum percentage of available memory allocated to caching (1 - 15%). | ||
cache-mode - |
|
Cache entry expiration mode. | |
cache-prefix-match - |
|
Enable/disable prefix matching in the cache. | |
close-ports - |
|
Close ports used for HTTP/HTTPS override authentication and disable user overrides. | |
ovrd-auth-https - |
|
Enable/disable use of HTTPS for override authentication. | |
ovrd-auth-port - |
Port to use for FortiGuard Web Filter override authentication. | ||
ovrd-auth-port-http - |
Port to use for FortiGuard Web Filter HTTP override authentication | ||
ovrd-auth-port-https - |
Port to use for FortiGuard Web Filter HTTPS override authentication. | ||
ovrd-auth-port-warning - |
Port to use for FortiGuard Web Filter Warning override authentication. | ||
request-packet-size-limit - |
Limit size of URL request packets sent to FortiGuard server (0 for default). | ||
warn-auth-https - |
|
Enable/disable use of HTTPS for warning and authentication. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure FortiGuard Web Filter service.
fortios_webfilter_fortiguard:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
webfilter_fortiguard:
cache-mem-percent: "3"
cache-mode: "ttl"
cache-prefix-match: "enable"
close-ports: "enable"
ovrd-auth-https: "enable"
ovrd-auth-port: "8"
ovrd-auth-port-http: "9"
ovrd-auth-port-https: "10"
ovrd-auth-port-warning: "11"
request-packet-size-limit: "12"
warn-auth-https: "enable"
Return Values
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 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_webfilter_fortiguard_module.html