fortinet.fortios.fortios_system_fortiguard module – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.5).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_fortiguard.
New in fortinet.fortios 2.0.0
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.14
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:
|
|
Configure FortiGuard services. |
|
Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance. Choices:
|
|
Maximum percentage of FortiGate memory the antispam cache is allowed to use (1 - 15). |
|
Maximum permille of FortiGate memory the antispam cache is allowed to use (1 - 150). |
|
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. |
|
Expiration date of the FortiGuard antispam contract. |
|
Enable/disable turning off the FortiGuard antispam service. Choices:
|
|
Interval of time between license checks for the FortiGuard antispam contract. |
|
Antispam query time out (1 - 30 sec). |
|
IP address of the FortiGuard anycast DNS rating server. |
|
Port to connect to on the FortiGuard anycast DNS rating server. |
|
Enable/disable automatic patch-level firmware upgrade from FortiGuard. The FortiGate unit searches for new patches only in the same major and minor version. Choices:
|
|
Allowed day(s) of the week to install an automatic patch-level firmware upgrade from FortiGuard . Disallow any day of the week to use auto-firmware-upgrade-delay instead, which waits for designated days before installing an automatic patch-level firmware upgrade. Choices:
|
|
Delay of day(s) before installing an automatic patch-level firmware upgrade from FortiGuard of the week for installing an automatic patch-level firmware upgrade. |
|
End time in the designated time window for automatic patch-level firmware upgrade from FortiGuard in 24 hour time (0 ~ 23). When the end time is smaller than the start time, the end time is interpreted as the next day. The actual upgrade time is selected randomly within the time window. |
|
Start time in the designated time window for automatic patch-level firmware upgrade from FortiGuard in 24 hour time (0 ~ 23). The actual upgrade time is selected randomly within the time window. |
|
Automatically connect to and login to FortiCloud. Choices:
|
|
IP address of the FortiDDNS server. |
|
IPv6 address of the FortiDDNS server. |
|
Port used to communicate with FortiDDNS servers. |
|
Threshold for number of days before FortiGuard license expiration to generate license expiring event log (1 - 100 days). |
|
Enable/disable use of FortiGuard”s Anycast network. Choices:
|
|
Configure which of Fortinet”s servers to provide FortiGuard services in FortiGuard”s anycast network. Default is Fortinet. Choices:
|
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Number of servers to alternate between as first FortiGuard option. |
|
Enable/disable FortiGuard Virus Outbreak Prevention cache. Choices:
|
|
Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%). |
|
Maximum permille of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 150 permille). |
|
Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec). |
|
Expiration date of FortiGuard Virus Outbreak Prevention contract. |
|
Turn off FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract. |
|
FortiGuard Virus Outbreak Prevention time out (1 - 30 sec). |
|
Enable/disable use of persistent connection to receive update notification from FortiGuard. Choices:
|
|
Port used to communicate with the FortiGuard servers. Choices:
|
|
Protocol used to communicate with the FortiGuard servers. Choices:
|
|
Proxy user password. |
|
Hostname or IPv4 address of the proxy server. |
|
Port used to communicate with the proxy server. |
|
Proxy user name. |
|
Enable/disable FortiCloud Sandbox inline-scan. Choices:
|
|
FortiCloud Sandbox region. |
|
Customization options for the FortiGuard DNS service. Choices:
|
|
IP address of the FortiGuard DNS rating server. |
|
Port to connect to on the FortiGuard DNS rating server. |
|
Service account ID. |
|
Source IPv4 address used to communicate with FortiGuard. |
|
Source IPv6 address used to communicate with FortiGuard. |
|
Enable/disable proxy dictionary rebuild. Choices:
|
|
Enable/disable DLP signature update. Choices:
|
|
Enable/disable external resource update. Choices:
|
|
Enable/disable Internet Service Database update. Choices:
|
|
Location from which to receive FortiGuard updates. Choices:
|
|
Enable/disable allowlist update. Choices:
|
|
FortiGuard Service virtual domain name. Source system.vdom.name. |
|
Expiration date of the FortiGuard video filter contract. |
|
Interval of time between license checks for the FortiGuard video filter contract. |
|
Enable/disable FortiGuard web filter caching. Choices:
|
|
Time-to-live for web filter cache entries in seconds (300 - 86400). |
|
Expiration date of the FortiGuard web filter contract. |
|
Enable/disable turning off the FortiGuard web filtering service. Choices:
|
|
Interval of time between license checks for the FortiGuard web filter contract. |
|
Web filter query time out (1 - 30 sec). |
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure FortiGuard services.
fortinet.fortios.fortios_system_fortiguard:
vdom: "{{ vdom }}"
system_fortiguard:
antispam_cache: "enable"
antispam_cache_mpercent: "2"
antispam_cache_mpermille: "1"
antispam_cache_ttl: "1800"
antispam_expiration: "0"
antispam_force_off: "enable"
antispam_license: "4294967295"
antispam_timeout: "7"
anycast_sdns_server_ip: "<your_own_value>"
anycast_sdns_server_port: "853"
auto_firmware_upgrade: "enable"
auto_firmware_upgrade_day: "sunday"
auto_firmware_upgrade_delay: "3"
auto_firmware_upgrade_end_hour: "4"
auto_firmware_upgrade_start_hour: "1"
auto_join_forticloud: "enable"
ddns_server_ip: "<your_own_value>"
ddns_server_ip6: "<your_own_value>"
ddns_server_port: "443"
FDS_license_expiring_days: "15"
fortiguard_anycast: "enable"
fortiguard_anycast_source: "fortinet"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
load_balance_servers: "1"
outbreak_prevention_cache: "enable"
outbreak_prevention_cache_mpercent: "2"
outbreak_prevention_cache_mpermille: "1"
outbreak_prevention_cache_ttl: "300"
outbreak_prevention_expiration: "0"
outbreak_prevention_force_off: "enable"
outbreak_prevention_license: "4294967295"
outbreak_prevention_timeout: "7"
persistent_connection: "enable"
port: "8888"
protocol: "udp"
proxy_password: "<your_own_value>"
proxy_server_ip: "<your_own_value>"
proxy_server_port: "0"
proxy_username: "<your_own_value>"
sandbox_inline_scan: "enable"
sandbox_region: "<your_own_value>"
sdns_options: "include-question-section"
sdns_server_ip: "<your_own_value>"
sdns_server_port: "53"
service_account_id: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
update_build_proxy: "enable"
update_dldb: "enable"
update_extdb: "enable"
update_ffdb: "enable"
update_server_location: "automatic"
update_uwdb: "enable"
vdom: "<your_own_value> (source system.vdom.name)"
videofilter_expiration: "0"
videofilter_license: "4294967295"
webfilter_cache: "enable"
webfilter_cache_ttl: "3600"
webfilter_expiration: "0"
webfilter_force_off: "enable"
webfilter_license: "4294967295"
webfilter_timeout: "15"
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: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |