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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- system_fortiguard - Configure FortiGuard services. type: dict
- antispam_cache - Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance. type: str choices: enable, disable
- antispam_cache_mpercent - Maximum percent of FortiGate memory the antispam cache is allowed to use (1 - 15%). type: int
- antispam_cache_ttl - 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. type: int
- antispam_expiration - Expiration date of the FortiGuard antispam contract. type: int
- antispam_force_off - Enable/disable turning off the FortiGuard antispam service. type: str choices: enable, disable
- antispam_license - Interval of time between license checks for the FortiGuard antispam contract. type: int
- antispam_timeout - Antispam query time out (1 - 30 sec). type: int
- ddns_server_ip - IP address of the FortiDDNS server. type: str
- ddns_server_port - Port used to communicate with FortiDDNS servers. type: int
- load_balance_servers - Number of servers to alternate between as first FortiGuard option. type: int
- outbreak_prevention_cache - Enable/disable FortiGuard Virus Outbreak Prevention cache. type: str choices: enable, disable
- outbreak_prevention_cache_mpercent - Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%). type: int
- outbreak_prevention_cache_ttl - Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec). type: int
- outbreak_prevention_expiration - Expiration date of FortiGuard Virus Outbreak Prevention contract. type: int
- outbreak_prevention_force_off - Turn off FortiGuard Virus Outbreak Prevention service. type: str choices: enable, disable
- outbreak_prevention_license - Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract. type: int
- outbreak_prevention_timeout - FortiGuard Virus Outbreak Prevention time out (1 - 30 sec). type: int
- port - Port used to communicate with the FortiGuard servers. type: str choices: 53, 8888, 80
- sdns_server_ip - IP address of the FortiDNS server. type: str
- sdns_server_port - Port used to communicate with FortiDNS servers. type: int
- service_account_id - Service account ID. type: str
- source_ip - Source IPv4 address used to communicate with FortiGuard. type: str
- source_ip6 - Source IPv6 address used to communicate with FortiGuard. type: str
- update_server_location - Signature update server location. type: str choices: usa, any
- webfilter_cache - Enable/disable FortiGuard web filter caching. type: str choices: enable, disable
- webfilter_cache_ttl - Time-to-live for web filter cache entries in seconds (300 - 86400). type: int
- webfilter_expiration - Expiration date of the FortiGuard web filter contract. type: int
- webfilter_force_off - Enable/disable turning off the FortiGuard web filtering service. type: str choices: enable, disable
- webfilter_license - Interval of time between license checks for the FortiGuard web filter contract. type: int
- webfilter_timeout - Web filter query time out (1 - 30 sec). type: int
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"
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"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3