fortinet.fortios.fortios_system_fortiguard – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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_system_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 system 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 | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|
| system_fortiguard
dictionary
|
Configure FortiGuard services.
|
||
| antispam_cache
string
|
|
Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance.
|
|
| antispam_cache_mpercent
integer
|
Maximum percent of FortiGate memory the antispam cache is allowed to use (1 - 15%).
|
||
| antispam_cache_ttl
integer
|
Time-to-live for antispam cache entries in seconds (300 - 86400). Lower times reduce the cache size. Higher times may improve performance since the cache will have more entries.
|
||
| antispam_expiration
integer
|
Expiration date of the FortiGuard antispam contract.
|
||
| antispam_force_off
string
|
|
Enable/disable turning off the FortiGuard antispam service.
|
|
| antispam_license
integer
|
Interval of time between license checks for the FortiGuard antispam contract.
|
||
| antispam_timeout
integer
|
Antispam query time out (1 - 30 sec).
|
||
| anycast_sdns_server_ip
string
|
IP address of the FortiGuard anycast DNS rating server.
|
||
| anycast_sdns_server_port
integer
|
Port to connect to on the FortiGuard anycast DNS rating server.
|
||
| auto_join_forticloud
string
|
|
Automatically connect to and login to FortiCloud.
|
|
| ddns_server_ip
string
|
IP address of the FortiDDNS server.
|
||
| ddns_server_port
integer
|
Port used to communicate with FortiDDNS servers.
|
||
| fortiguard_anycast
string
|
|
Enable/disable use of FortiGuard"s anycast network.
|
|
| fortiguard_anycast_source
string
|
|
Configure which of Fortinet"s servers to provide FortiGuard services in FortiGuard"s anycast network. Default is Fortinet.
|
|
| interface
string
|
Specify outgoing interface to reach server. Source system.interface.name.
|
||
| interface_select_method
string
|
|
Specify how to select outgoing interface to reach server.
|
|
| load_balance_servers
integer
|
Number of servers to alternate between as first FortiGuard option.
|
||
| outbreak_prevention_cache
string
|
|
Enable/disable FortiGuard Virus Outbreak Prevention cache.
|
|
| outbreak_prevention_cache_mpercent
integer
|
Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%).
|
||
| outbreak_prevention_cache_ttl
integer
|
Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec).
|
||
| outbreak_prevention_expiration
integer
|
Expiration date of FortiGuard Virus Outbreak Prevention contract.
|
||
| outbreak_prevention_force_off
string
|
|
Turn off FortiGuard Virus Outbreak Prevention service.
|
|
| outbreak_prevention_license
integer
|
Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract.
|
||
| outbreak_prevention_timeout
integer
|
FortiGuard Virus Outbreak Prevention time out (1 - 30 sec).
|
||
| persistent_connection
string
|
|
Enable/disable use of persistent connection to receive update notification from FortiGuard.
|
|
| port
string
|
|
Port used to communicate with the FortiGuard servers.
|
|
| protocol
string
|
|
Protocol used to communicate with the FortiGuard servers.
|
|
| proxy_password
string
|
Proxy user password.
|
||
| proxy_server_ip
string
|
IP address of the proxy server.
|
||
| proxy_server_port
integer
|
Port used to communicate with the proxy server.
|
||
| proxy_username
string
|
Proxy user name.
|
||
| sandbox_region
string
|
Cloud sandbox region.
|
||
| sdns_options
list / elements=string
|
|
Customization options for the FortiGuard DNS service.
|
|
| sdns_server_ip
string
|
IP address of the FortiDNS server.
|
||
| sdns_server_port
integer
|
Port used to communicate with FortiDNS servers.
|
||
| service_account_id
string
|
Service account ID.
|
||
| source_ip
string
|
Source IPv4 address used to communicate with FortiGuard.
|
||
| source_ip6
string
|
Source IPv6 address used to communicate with FortiGuard.
|
||
| update_build_proxy
string
|
|
Enable/disable proxy dictionary rebuild.
|
|
| update_extdb
string
|
|
Enable/disable external resource update.
|
|
| update_ffdb
string
|
|
Enable/disable Internet Service Database update.
|
|
| update_server_location
string
|
|
Signature update server location.
|
|
| update_uwdb
string
|
|
Enable/disable allowlist update.
|
|
| videofilter_expiration
integer
|
Expiration date of the FortiGuard video filter contract.
|
||
| videofilter_license
integer
|
Interval of time between license checks for the FortiGuard video filter contract.
|
||
| webfilter_cache
string
|
|
Enable/disable FortiGuard web filter caching.
|
|
| webfilter_cache_ttl
integer
|
Time-to-live for web filter cache entries in seconds (300 - 86400).
|
||
| webfilter_expiration
integer
|
Expiration date of the FortiGuard web filter contract.
|
||
| webfilter_force_off
string
|
|
Enable/disable turning off the FortiGuard web filtering service.
|
|
| webfilter_license
integer
|
Interval of time between license checks for the FortiGuard web filter contract.
|
||
| webfilter_timeout
integer
|
Web filter query time out (1 - 30 sec).
|
||
| vdom
string
|
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.
|
|
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiGuard services.
fortios_system_fortiguard:
vdom: "{{ vdom }}"
system_fortiguard:
antispam_cache: "enable"
antispam_cache_mpercent: "4"
antispam_cache_ttl: "5"
antispam_expiration: "6"
antispam_force_off: "enable"
antispam_license: "8"
antispam_timeout: "9"
anycast_sdns_server_ip: "<your_own_value>"
anycast_sdns_server_port: "11"
auto_join_forticloud: "enable"
ddns_server_ip: "<your_own_value>"
ddns_server_port: "14"
fortiguard_anycast: "enable"
fortiguard_anycast_source: "fortinet"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
load_balance_servers: "19"
outbreak_prevention_cache: "enable"
outbreak_prevention_cache_mpercent: "21"
outbreak_prevention_cache_ttl: "22"
outbreak_prevention_expiration: "23"
outbreak_prevention_force_off: "enable"
outbreak_prevention_license: "25"
outbreak_prevention_timeout: "26"
persistent_connection: "enable"
port: "8888"
protocol: "udp"
proxy_password: "<your_own_value>"
proxy_server_ip: "<your_own_value>"
proxy_server_port: "32"
proxy_username: "<your_own_value>"
sandbox_region: "<your_own_value>"
sdns_options: "include-question-section"
sdns_server_ip: "<your_own_value>"
sdns_server_port: "37"
service_account_id: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
update_build_proxy: "enable"
update_extdb: "enable"
update_ffdb: "enable"
update_server_location: "usa"
update_uwdb: "enable"
videofilter_expiration: "46"
videofilter_license: "47"
webfilter_cache: "enable"
webfilter_cache_ttl: "49"
webfilter_expiration: "50"
webfilter_force_off: "enable"
webfilter_license: "52"
webfilter_timeout: "53"
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:
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
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_fortiguard_module.html