Note
This plugin is part of the fortinet.fortios collection.
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.9: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| host string | FortiOS or FortiGate IP address. | ||
| https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
| password string | Default: "" | FortiOS or FortiGate password. | |
| ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | |
| 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). | ||
| 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 |
| 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). | ||
| port string |
| 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 |
| Signature update server location. | |
| 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). | ||
| 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. | |
Note
- 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"
ddns_server_ip: "<your_own_value>"
ddns_server_port: "11"
load_balance_servers: "12"
outbreak_prevention_cache: "enable"
outbreak_prevention_cache_mpercent: "14"
outbreak_prevention_cache_ttl: "15"
outbreak_prevention_expiration: "16"
outbreak_prevention_force_off: "enable"
outbreak_prevention_license: "18"
outbreak_prevention_timeout: "19"
port: "53"
sdns_server_ip: "<your_own_value>"
sdns_server_port: "22"
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: "28"
webfilter_expiration: "29"
webfilter_force_off: "enable"
webfilter_license: "31"
webfilter_timeout: "32"
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 |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_fortiguard_module.html