Try SpotterConfigure the FortiGuard run parameters.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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 the FortiGuard run parameters.
fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting:
# 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, ...]
fmupdate_webspam_fgdsetting:
as_cache: <integer>
as_log: <value in [disable, nospam, all]>
as_preload: <value in [disable, enable]>
av_cache: <integer>
av_log: <value in [disable, novirus, all]>
av_preload: <value in [disable, enable]>
av2_cache: <integer>
av2_log: <value in [disable, noav2, all]>
av2_preload: <value in [disable, enable]>
eventlog_query: <value in [disable, enable]>
fgd_pull_interval: <integer>
fq_cache: <integer>
fq_log: <value in [disable, nofilequery, all]>
fq_preload: <value in [disable, enable]>
linkd_log: <value in [emergency, alert, critical, ...]>
max_client_worker: <integer>
max_log_quota: <integer>
max_unrated_site: <integer>
restrict_as1_dbver: <string>
restrict_as2_dbver: <string>
restrict_as4_dbver: <string>
restrict_av_dbver: <string>
restrict_av2_dbver: <string>
restrict_fq_dbver: <string>
restrict_wf_dbver: <string>
server_override:
servlist:
-
id: <integer>
ip: <string>
ip6: <string>
port: <integer>
service_type: # <list or string>
- fgd
- fgc
- fsa
- fgfq
- geoip
- iot-collect
status: <value in [disable, enable]>
stat_log_interval: <integer>
stat_sync_interval: <integer>
update_interval: <integer>
update_log: <value in [disable, enable]>
wf_cache: <integer>
wf_dn_cache_expire_time: <integer>
wf_dn_cache_max_number: <integer>
wf_log: <value in [disable, nourl, all]>
wf_preload: <value in [disable, enable]>
iot_cache: <integer>
iot_log: <value in [disable, nofilequery, all]>
iot_preload: <value in [disable, enable]>
restrict_iots_dbver: <string>
stat_log: <value in [emergency, alert, critical, ...]>
iotv_preload: <value in [disable, enable]>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
fmupdate_webspam_fgdsetting:
description: The top level parameters set.
required: false
suboptions:
as-cache:
description: Deprecated, please rename it to as_cache. Antispam service maximum
memory usage in megabytes
type: int
as-log:
choices:
- disable
- nospam
- all
description:
- Deprecated, please rename it to as_log.
- Antispam log setting
- disable - Disable spam log.
- nospam - Log non-spam events.
- all - Log all spam lookups.
type: str
as-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to as_preload.
- Enable/disable preloading antispam database to memory
- disable - Disable antispam database preload.
- enable - Enable antispam database preload.
type: str
av-cache:
description: Deprecated, please rename it to av_cache. Antivirus service maximum
memory usage, in megabytes
type: int
av-log:
choices:
- disable
- novirus
- all
description:
- Deprecated, please rename it to av_log.
- Antivirus log setting
- disable - Disable virus log.
- novirus - Log non-virus events.
- all - Log all virus lookups.
type: str
av-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to av_preload.
- Enable/disable preloading antivirus database to memory
- disable - Disable antivirus database preload.
- enable - Enable antivirus database preload.
type: str
av2-cache:
description: Deprecated, please rename it to av2_cache. Antispam service maximum
memory usage in megabytes
type: int
av2-log:
choices:
- disable
- noav2
- all
description:
- Deprecated, please rename it to av2_log.
- Outbreak prevention log setting
- disable - Disable av2 log.
- noav2 - Log non-av2 events.
- all - Log all av2 lookups.
type: str
av2-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to av2_preload.
- Enable/disable preloading outbreak prevention database to memory
- disable - Disable outbreak prevention database preload.
- enable - Enable outbreak prevention database preload.
type: str
eventlog-query:
choices:
- disable
- enable
description:
- Deprecated, please rename it to eventlog_query.
- Enable/disable record query to event-log besides fgd-log
- disable - Record query to event-log besides fgd-log.
- enable - Do not log to event-log.
type: str
fgd-pull-interval:
description: Deprecated, please rename it to fgd_pull_interval. Fgd pull interval
setting, in minutes
type: int
fq-cache:
description: Deprecated, please rename it to fq_cache. File query service maximum
memory usage, in megabytes
type: int
fq-log:
choices:
- disable
- nofilequery
- all
description:
- Deprecated, please rename it to fq_log.
- File query log setting
- disable - Disable file query log.
- nofilequery - Log non-file query events.
- all - Log all file query events.
type: str
fq-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fq_preload.
- Enable/disable preloading file query database to memory
- disable - Disable file query db preload.
- enable - Enable file query db preload.
type: str
iot-cache:
description: Deprecated, please rename it to iot_cache. IoT service maximum memory
usage, in megabytes
type: int
iot-log:
choices:
- disable
- nofilequery
- all
description:
- Deprecated, please rename it to iot_log.
- IoT log setting
- disable - Disable IoT log.
- nofilequery - Log non-IoT events.
- all - Log all IoT events.
type: str
iot-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to iot_preload.
- Enable/disable preloading IoT database to memory
- disable - Disable IoT db preload.
- enable - Enable IoT db preload.
type: str
iotv-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to iotv_preload.
- Enable/disable preloading IoT-Vulnerability database to memory
- disable - Disable IoT-Vulnerability db preload.
- enable - Enable IoT-Vulnerability db preload.
type: str
linkd-log:
choices:
- emergency
- alert
- critical
- error
- warn
- notice
- info
- debug
- disable
description:
- Deprecated, please rename it to linkd_log.
- Linkd log setting
- emergency - The unit is unusable.
- alert - Immediate action is required
- critical - Functionality is affected.
- error - Functionality is probably affected.
- warn - Functionality might be affected.
- notice - Information about normal events.
- info - General information.
- debug - Debug information.
- disable - Linkd logging is disabled.
type: str
max-client-worker:
description: Deprecated, please rename it to max_client_worker. Max worker for
tcp client connection
type: int
max-log-quota:
description: Deprecated, please rename it to max_log_quota. Maximum log quota
setting, in megabytes
type: int
max-unrated-site:
description: Deprecated, please rename it to max_unrated_site. Maximum number
of unrated site in memory, in kilobytes
type: int
restrict-as1-dbver:
description: Deprecated, please rename it to restrict_as1_dbver. Restrict system
update to indicated antispam
type: str
restrict-as2-dbver:
description: Deprecated, please rename it to restrict_as2_dbver. Restrict system
update to indicated antispam
type: str
restrict-as4-dbver:
description: Deprecated, please rename it to restrict_as4_dbver. Restrict system
update to indicated antispam
type: str
restrict-av-dbver:
description: Deprecated, please rename it to restrict_av_dbver. Restrict system
update to indicated antivirus database version
type: str
restrict-av2-dbver:
description: Deprecated, please rename it to restrict_av2_dbver. Restrict system
update to indicated outbreak prevention database version
type: str
restrict-fq-dbver:
description: Deprecated, please rename it to restrict_fq_dbver. Restrict system
update to indicated file query database version
type: str
restrict-iots-dbver:
description: Deprecated, please rename it to restrict_iots_dbver. Restrict system
update to indicated file query database version
type: str
restrict-wf-dbver:
description: Deprecated, please rename it to restrict_wf_dbver. Restrict system
update to indicated web filter database version
type: str
server-override:
description: Deprecated, please rename it to server_override.
suboptions:
servlist:
description: Servlist.
elements: dict
suboptions:
id:
description: Override server ID
type: int
ip:
description: IPv4 address of the override server.
type: str
ip6:
description: IPv6 address of the override server.
type: str
port:
description: Port number to use when contacting FortiGuard
type: int
service-type:
choices:
- fgd
- fgc
- fsa
- fgfq
- geoip
- iot-collect
description:
- (list or str)
- Deprecated, please rename it to service_type.
- Override service type.
- fgd - Server override config for fgd
- fgc - Server override config for fgc
- fsa - Server override config for fsa
type: raw
type: list
status:
choices:
- disable
- enable
description:
- Override status.
- disable - Disable setting.
- enable - Enable setting.
type: str
type: dict
stat-log:
choices:
- emergency
- alert
- critical
- error
- warn
- notice
- info
- debug
- disable
description:
- Deprecated, please rename it to stat_log.
- stat log setting
- emergency - The unit is unusable
- alert - Immediate action is required
- critical - Functionality is affected
- error - Functionality is probably affected
- warn - Functionality might be affected
- notice - Information about normal events
- info - General information
- debug - Debug information
- disable - Linkd logging is disabled.
type: str
stat-log-interval:
description: Deprecated, please rename it to stat_log_interval. Statistic log
interval setting, in minutes
type: int
stat-sync-interval:
description: Deprecated, please rename it to stat_sync_interval. Synchronization
interval for statistic of unrated site in minutes
type: int
update-interval:
description: Deprecated, please rename it to update_interval. FortiGuard database
update wait time if not enough delta files, in hours
type: int
update-log:
choices:
- disable
- enable
description:
- Deprecated, please rename it to update_log.
- Enable/disable update log setting
- disable - Disable update log.
- enable - Enable update log.
type: str
wf-cache:
description: Deprecated, please rename it to wf_cache. Web filter service maximum
memory usage, in megabytes
type: int
wf-dn-cache-expire-time:
description: Deprecated, please rename it to wf_dn_cache_expire_time. Web filter
DN cache expire time, in minutes
type: int
wf-dn-cache-max-number:
description: Deprecated, please rename it to wf_dn_cache_max_number. Maximum number
of Web filter DN cache
type: int
wf-log:
choices:
- disable
- nourl
- all
description:
- Deprecated, please rename it to wf_log.
- Web filter log setting
- disable - Disable URL log.
- nourl - Log non-URL events.
- all - Log all URL lookups.
type: str
wf-preload:
choices:
- disable
- enable
description:
- Deprecated, please rename it to wf_preload.
- Enable/disable preloading the web filter database into memory
- disable - Disable web filter database preload.
- enable - Enable web filter database preload.
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list