fortinet.fortios.fortios_webfilter_fortiguard – Configure FortiGuard Web Filter service in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_webfilter_fortiguard
.
New in version 2.10: of fortinet.fortios
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9.0
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: “root” |
|
Configure FortiGuard Web Filter service. |
|
Maximum percentage of available memory allocated to caching (1 - 15%). |
|
Cache entry expiration mode. Choices:
|
|
Enable/disable prefix matching in the cache. Choices:
|
|
Close ports used for HTTP/HTTPS override authentication and disable user overrides. Choices:
|
|
Enable/disable use of HTTPS for override authentication. Choices:
|
|
Port to use for FortiGuard Web Filter override authentication. |
|
Port to use for FortiGuard Web Filter HTTP override authentication |
|
Port to use for FortiGuard Web Filter HTTPS override authentication. |
|
Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode. |
|
Port to use for FortiGuard Web Filter Warning override authentication. |
|
Limit size of URL request packets sent to FortiGuard server (0 for default). |
|
Enable/disable use of HTTPS for warning and authentication. Choices:
|
Examples
- collections:
- fortinet.fortios
connection: httpapi
hosts: fortigate01
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
vdom: root
tasks:
- name: fortios_webfilter_fortiguard
fortios_webfilter_fortiguard:
vdom: root
webfilter_fortiguard:
cache_mem_percent: 2
cache_mode: ttl
cache_prefix_match: enable
close_ports: disable
ovrd_auth_https: enable
ovrd_auth_port: 8008
ovrd_auth_port_http: 8008
ovrd_auth_port_https: 8010
ovrd_auth_port_https_flow: 8015
ovrd_auth_port_warning: 8020
request_packet_size_limit: 0
warn_auth_https: enable
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always Sample: “v5.6.3” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)