fortios_system_fortiguard – Configure FortiGuard services in Fortinet’s FortiOS and FortiGate

New in version 2.9.

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.5

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments
host
string
FortiOS or FortiGate IP address.
https
boolean
    Choices:
  • no
  • yes ←
Indicates if the requests towards FortiGate must use HTTPS protocol.
password
string
Default:
""
FortiOS or FortiGate password.
ssl_verify
boolean
    Choices:
  • no
  • yes ←
Ensures FortiGate certificate must be verified by a proper CA.
system_fortiguard
dictionary
Default:
null
Configure FortiGuard services.
antispam_cache
string
    Choices:
  • enable
  • disable
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
    Choices:
  • enable
  • disable
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).
auto_join_forticloud
string
    Choices:
  • enable
  • disable
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.
load_balance_servers
integer
Number of servers to alternate between as first FortiGuard option.
outbreak_prevention_cache
string
    Choices:
  • enable
  • disable
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
    Choices:
  • enable
  • disable
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).
port
string
    Choices:
  • 53
  • 8888
  • 80
Port used to communicate with the FortiGuard servers.
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_server_location
string
    Choices:
  • usa
  • any
Signature update server location.
webfilter_cache
string
    Choices:
  • enable
  • disable
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
    Choices:
  • enable
  • disable
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).
username
string
FortiOS or FortiGate username.
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

  • 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"
   ssl_verify: "False"
  tasks:
  - name: Configure FortiGuard services.
    fortios_system_fortiguard:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      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"
        auto_join_forticloud: "enable"
        ddns_server_ip: "<your_own_value>"
        ddns_server_port: "12"
        load_balance_servers: "13"
        outbreak_prevention_cache: "enable"
        outbreak_prevention_cache_mpercent: "15"
        outbreak_prevention_cache_ttl: "16"
        outbreak_prevention_expiration: "17"
        outbreak_prevention_force_off: "enable"
        outbreak_prevention_license: "19"
        outbreak_prevention_timeout: "20"
        port: "53"
        sdns_server_ip: "<your_own_value>"
        sdns_server_port: "23"
        service_account_id: "<your_own_value>"
        source_ip: "84.230.14.43"
        source_ip6: "<your_own_value>"
        update_server_location: "usa"
        webfilter_cache: "enable"
        webfilter_cache_ttl: "29"
        webfilter_expiration: "30"
        webfilter_force_off: "enable"
        webfilter_license: "32"
        webfilter_timeout: "33"

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


Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.