fortinet.fortimanager.fmgr_system_fortiguard module – Configure FortiGuard services.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_fortiguard.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

system_fortiguard

dictionary

The top level parameters set.

antispam-cache

string

Deprecated, please rename it to antispam_cache. Enable/disable FortiGuard antispam request caching.

Choices:

  • "disable"

  • "enable"

antispam-cache-mpercent

integer

Deprecated, please rename it to antispam_cache_mpercent. Maximum percent of FortiGate memory the antispam cache is allowed…

antispam-cache-mpermille

integer

Deprecated, please rename it to antispam_cache_mpermille. Maximum permille of FortiGate memory the antispam cache is allow…

antispam-cache-ttl

integer

Deprecated, please rename it to antispam_cache_ttl. Time-to-live for antispam cache entries in seconds

antispam-expiration

integer

Deprecated, please rename it to antispam_expiration. Antispam-Expiration.

antispam-force-off

string

Deprecated, please rename it to antispam_force_off. Enable/disable turning off the FortiGuard antispam service.

Choices:

  • "disable"

  • "enable"

antispam-license

integer

Deprecated, please rename it to antispam_license. Antispam-License.

antispam-timeout

integer

Deprecated, please rename it to antispam_timeout. Antispam query time out

anycast-sdns-server-ip

string

Deprecated, please rename it to anycast_sdns_server_ip. IP address of the FortiGuard anycast DNS rating server.

anycast-sdns-server-port

integer

Deprecated, please rename it to anycast_sdns_server_port. Port to connect to on the FortiGuard anycast DNS rating server.

auto-firmware-upgrade

string

Deprecated, please rename it to auto_firmware_upgrade. Enable/disable automatic patch-level firmware upgrade from FortiGuard.

Choices:

  • "disable"

  • "enable"

auto-firmware-upgrade-day

list / elements=string

Deprecated, please rename it to auto_firmware_upgrade_day.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

auto-firmware-upgrade-delay

integer

Deprecated, please rename it to auto_firmware_upgrade_delay. Delay of day

auto-firmware-upgrade-end-hour

integer

Deprecated, please rename it to auto_firmware_upgrade_end_hour. End time in the designated time window for automatic patch…

auto-firmware-upgrade-start-hour

integer

Deprecated, please rename it to auto_firmware_upgrade_start_hour. Start time in the designated time window for automatic p…

auto-join-forticloud

string

Deprecated, please rename it to auto_join_forticloud. Automatically connect to and login to FortiCloud.

Choices:

  • "disable"

  • "enable"

avquery-cache

string

Deprecated, please rename it to avquery_cache. Enable/disable the FortiGuard antivirus cache.

Choices:

  • "disable"

  • "enable"

avquery-cache-mpercent

integer

Deprecated, please rename it to avquery_cache_mpercent. Maximum percent of memory the antivirus cache can use

avquery-cache-ttl

integer

Deprecated, please rename it to avquery_cache_ttl. Time-to-live for antivirus cache entries

avquery-force-off

string

Deprecated, please rename it to avquery_force_off. Turn off the FortiGuard antivirus service.

Choices:

  • "disable"

  • "enable"

avquery-license

integer

Deprecated, please rename it to avquery_license. Interval of time between license checks for the FortiGuard antivirus cont…

avquery-timeout

integer

Deprecated, please rename it to avquery_timeout. Antivirus query time out

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. IP address of the FortiDDNS server.

ddns-server-ip6

string

Deprecated, please rename it to ddns_server_ip6. IPv6 address of the FortiDDNS server.

ddns-server-port

integer

Deprecated, please rename it to ddns_server_port. Port used to communicate with FortiDDNS servers.

FDS-license-expiring-days

integer

Deprecated, please rename it to FDS_license_expiring_days. Threshold for number of days before FortiGuard license expirati…

fortiguard-anycast

string

Deprecated, please rename it to fortiguard_anycast. Enable/disable use of FortiGuards anycast network.

Choices:

  • "disable"

  • "enable"

fortiguard-anycast-source

string

Deprecated, please rename it to fortiguard_anycast_source. Configure which of Fortinets servers to provide FortiGuard serv…

Choices:

  • "fortinet"

  • "aws"

  • "debug"

gui-prompt-auto-upgrade

string

Deprecated, please rename it to gui_prompt_auto_upgrade. Enable/disable prompting of automatic patch-level firmware upgrad…

Choices:

  • "disable"

  • "enable"

interface

string

Specify outgoing interface to reach server.

interface-select-method

string

Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

load-balance-servers

integer

Deprecated, please rename it to load_balance_servers. Number of servers to alternate between as first FortiGuard option.

outbreak-prevention-cache

string

Deprecated, please rename it to outbreak_prevention_cache. Enable/disable FortiGuard Virus Outbreak Prevention cache.

Choices:

  • "disable"

  • "enable"

outbreak-prevention-cache-mpercent

integer

Deprecated, please rename it to outbreak_prevention_cache_mpercent. Maximum percent of memory FortiGuard Virus Outbreak Pr…

outbreak-prevention-cache-mpermille

integer

Deprecated, please rename it to outbreak_prevention_cache_mpermille. Maximum permille of memory FortiGuard Virus Outbreak …

outbreak-prevention-cache-ttl

integer

Deprecated, please rename it to outbreak_prevention_cache_ttl. Time-to-live for FortiGuard Virus Outbreak Prevention cache…

outbreak-prevention-expiration

integer

Deprecated, please rename it to outbreak_prevention_expiration. Outbreak-Prevention-Expiration.

outbreak-prevention-force-off

string

Deprecated, please rename it to outbreak_prevention_force_off. Turn off FortiGuard Virus Outbreak Prevention service.

Choices:

  • "disable"

  • "enable"

outbreak-prevention-license

integer

Deprecated, please rename it to outbreak_prevention_license. Outbreak-Prevention-License.

outbreak-prevention-timeout

integer

Deprecated, please rename it to outbreak_prevention_timeout. FortiGuard Virus Outbreak Prevention time out

persistent-connection

string

Deprecated, please rename it to persistent_connection. Enable/disable use of persistent connection to receive update notif…

Choices:

  • "disable"

  • "enable"

port

string

Port used to communicate with the FortiGuard servers.

Choices:

  • "53"

  • "80"

  • "8888"

  • "443"

protocol

string

Protocol used to communicate with the FortiGuard servers.

Choices:

  • "udp"

  • "http"

  • "https"

proxy-password

any

(list) Deprecated, please rename it to proxy_password. Proxy user password.

proxy-server-ip

string

Deprecated, please rename it to proxy_server_ip. IP address of the proxy server.

proxy-server-port

integer

Deprecated, please rename it to proxy_server_port. Port used to communicate with the proxy server.

proxy-username

string

Deprecated, please rename it to proxy_username. Proxy user name.

sandbox-inline-scan

string

Deprecated, please rename it to sandbox_inline_scan. Enable/disable FortiCloud Sandbox inline-scan.

Choices:

  • "disable"

  • "enable"

sandbox-region

string

Deprecated, please rename it to sandbox_region. Cloud sandbox region.

sdns-options

list / elements=string

Deprecated, please rename it to sdns_options. Customization options for the FortiGuard DNS service.

Choices:

  • "include-question-section"

sdns-server-ip

any

(list) Deprecated, please rename it to sdns_server_ip. IP address of the FortiDNS server.

sdns-server-port

integer

Deprecated, please rename it to sdns_server_port. Port used to communicate with FortiDNS servers.

service-account-id

string

Deprecated, please rename it to service_account_id. Service account ID.

source-ip

string

Deprecated, please rename it to source_ip. Source IPv4 address used to communicate with FortiGuard.

source-ip6

string

Deprecated, please rename it to source_ip6. Source IPv6 address used to communicate with FortiGuard.

update-build-proxy

string

Deprecated, please rename it to update_build_proxy. Enable/disable proxy dictionary rebuild.

Choices:

  • "disable"

  • "enable"

update-dldb

string

Deprecated, please rename it to update_dldb. Enable/disable DLP signature update.

Choices:

  • "disable"

  • "enable"

update-extdb

string

Deprecated, please rename it to update_extdb. Enable/disable external resource update.

Choices:

  • "disable"

  • "enable"

update-ffdb

string

Deprecated, please rename it to update_ffdb. Enable/disable Internet Service Database update.

Choices:

  • "disable"

  • "enable"

update-server-location

string

Deprecated, please rename it to update_server_location. Signature update server location.

Choices:

  • "any"

  • "usa"

  • "automatic"

  • "eu"

update-uwdb

string

Deprecated, please rename it to update_uwdb. Enable/disable allowlist update.

Choices:

  • "disable"

  • "enable"

vdom

string

FortiGuard Service virtual domain name.

videofilter-expiration

integer

Deprecated, please rename it to videofilter_expiration. Videofilter-Expiration.

videofilter-license

integer

Deprecated, please rename it to videofilter_license. Videofilter-License.

webfilter-cache

string

Deprecated, please rename it to webfilter_cache. Enable/disable FortiGuard web filter caching.

Choices:

  • "disable"

  • "enable"

webfilter-cache-ttl

integer

Deprecated, please rename it to webfilter_cache_ttl. Time-to-live for web filter cache entries in seconds

webfilter-expiration

integer

Deprecated, please rename it to webfilter_expiration. Webfilter-Expiration.

webfilter-force-off

string

Deprecated, please rename it to webfilter_force_off. Enable/disable turning off the FortiGuard web filtering service.

Choices:

  • "disable"

  • "enable"

webfilter-license

integer

Deprecated, please rename it to webfilter_license. Webfilter-License.

webfilter-timeout

integer

Deprecated, please rename it to webfilter_timeout. Web filter query time out

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiGuard services.
      fortinet.fortimanager.fmgr_system_fortiguard:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        system_fortiguard:
          antispam_cache: <value in [disable, enable]>
          antispam_cache_mpercent: <integer>
          antispam_cache_ttl: <integer>
          antispam_expiration: <integer>
          antispam_force_off: <value in [disable, enable]>
          antispam_license: <integer>
          antispam_timeout: <integer>
          auto_join_forticloud: <value in [disable, enable]>
          ddns_server_ip: <string>
          ddns_server_port: <integer>
          load_balance_servers: <integer>
          outbreak_prevention_cache: <value in [disable, enable]>
          outbreak_prevention_cache_mpercent: <integer>
          outbreak_prevention_cache_ttl: <integer>
          outbreak_prevention_expiration: <integer>
          outbreak_prevention_force_off: <value in [disable, enable]>
          outbreak_prevention_license: <integer>
          outbreak_prevention_timeout: <integer>
          port: <value in [53, 80, 8888, ...]>
          sdns_server_ip: <list or string>
          sdns_server_port: <integer>
          service_account_id: <string>
          source_ip: <string>
          source_ip6: <string>
          update_server_location: <value in [any, usa, automatic, ...]>
          webfilter_cache: <value in [disable, enable]>
          webfilter_cache_ttl: <integer>
          webfilter_expiration: <integer>
          webfilter_force_off: <value in [disable, enable]>
          webfilter_license: <integer>
          webfilter_timeout: <integer>
          protocol: <value in [udp, http, https]>
          proxy_password: <list or string>
          proxy_server_ip: <string>
          proxy_server_port: <integer>
          proxy_username: <string>
          sandbox_region: <string>
          avquery_cache_ttl: <integer>
          avquery_timeout: <integer>
          avquery_cache: <value in [disable, enable]>
          avquery_cache_mpercent: <integer>
          avquery_license: <integer>
          avquery_force_off: <value in [disable, enable]>
          fortiguard_anycast: <value in [disable, enable]>
          fortiguard_anycast_source: <value in [fortinet, aws, debug]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          sdns_options:
            - include-question-section
          anycast_sdns_server_ip: <string>
          anycast_sdns_server_port: <integer>
          persistent_connection: <value in [disable, enable]>
          update_build_proxy: <value in [disable, enable]>
          update_extdb: <value in [disable, enable]>
          update_ffdb: <value in [disable, enable]>
          update_uwdb: <value in [disable, enable]>
          videofilter_expiration: <integer>
          videofilter_license: <integer>
          ddns_server_ip6: <string>
          vdom: <string>
          auto_firmware_upgrade: <value in [disable, enable]>
          auto_firmware_upgrade_day:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          auto_firmware_upgrade_end_hour: <integer>
          auto_firmware_upgrade_start_hour: <integer>
          sandbox_inline_scan: <value in [disable, enable]>
          auto_firmware_upgrade_delay: <integer>
          gui_prompt_auto_upgrade: <value in [disable, enable]>
          FDS_license_expiring_days: <integer>
          antispam_cache_mpermille: <integer>
          outbreak_prevention_cache_mpermille: <integer>
          update_dldb: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)