fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting 模块 – 配置 FortiGuard 运行参数。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前根据数据源调整的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
反垃圾邮件服务的最大内存使用量（兆字节） |
|
反垃圾邮件日志设置 disable - 禁用垃圾邮件日志。 nospam - 记录非垃圾邮件事件。 all - 记录所有垃圾邮件查找。 选项
|
|
启用/禁用将反垃圾邮件数据库预加载到内存中 disable - 禁用反垃圾邮件数据库预加载。 enable - 启用反垃圾邮件数据库预加载。 选项
|
|
反垃圾邮件服务的最大内存使用量（兆字节） |
|
病毒爆发防护日志设置 disable - 禁用 av2 日志。 noav2 - 记录非 av2 事件。 all - 记录所有 av2 查询。 选项
|
|
启用/禁用将病毒爆发防护数据库预加载到内存中 disable - 禁用病毒爆发防护数据库预加载。 enable - 启用病毒爆发防护数据库预加载。 选项
|
|
反病毒服务的最大内存使用量（兆字节） |
|
反病毒日志设置 disable - 禁用病毒日志。 novirus - 记录非病毒事件。 all - 记录所有病毒查找。 选项
|
|
启用/禁用将反病毒数据库预加载到内存中 disable - 禁用反病毒数据库预加载。 enable - 启用反病毒数据库预加载。 选项
|
|
除了 fgd-log 之外，启用/禁用对事件日志的记录查询 disable - 除了 fgd-log 之外，对事件日志进行记录查询。 enable - 不记录到事件日志。 选项
|
|
Fgd 拉取间隔设置（分钟） |
|
文件查询服务的最大内存使用量（兆字节） |
|
文件查询日志设置 disable - 禁用文件查询日志。 nofilequery - 记录非文件查询事件。 all - 记录所有文件查询事件。 选项
|
|
启用/禁用将文件查询数据库预加载到内存中 disable - 禁用文件查询数据库预加载。 enable - 启用文件查询数据库预加载。 选项
|
|
物联网服务的最大内存使用量（兆字节） |
|
物联网日志设置 disable - 禁用物联网日志。 nofilequery - 记录非物联网事件。 all - 记录所有物联网事件。 选项
|
|
启用/禁用将 IoT 数据库预加载到内存中 disable - 禁用 IoT 数据库预加载。 enable - 启用 IoT 数据库预加载。 选项
|
|
启用/禁用将 IoT 漏洞数据库预加载到内存中 disable - 禁用 IoT 漏洞数据库预加载。 enable - 启用 IoT 漏洞数据库预加载。 选项
|
|
Linkd 日志设置 emergency - 单位不可用。 alert - 需要立即采取行动 critical - 功能受影响。 error - 功能可能受影响。 warn - 功能可能受影响。 notice - 关于正常事件的信息。 info - 一般信息。 debug - 调试信息。 disable - Linkd 日志记录已禁用。 选项
|
|
TCP 客户端连接的最大工作线程数 |
|
最大日志配额设置，单位为兆字节 |
|
内存中未评级站点的最大数量，单位为千字节 |
|
将系统更新限制为指定的反垃圾邮件数据库版本 |
|
将系统更新限制为指定的反垃圾邮件数据库版本 |
|
将系统更新限制为指定的反垃圾邮件数据库版本 |
|
将系统更新限制为指定的病毒爆发防护数据库版本 |
|
将系统更新限制为指定的防病毒数据库版本 |
|
将系统更新限制为指定的文档查询数据库版本 |
|
将系统更新限制为指定的文档查询数据库版本 |
|
将系统更新限制为指定的网页过滤数据库版本 |
|
服务器覆盖。 |
|
服务器列表。 |
|
覆盖服务器 ID |
|
覆盖服务器的 IPv4 地址。 |
|
覆盖服务器的 IPv6 地址。 |
|
联系 FortiGuard 时使用的端口号 |
|
(列表或字符串) 覆盖服务类型。 fgd - fgd 的服务器覆盖配置 fgc - fgc 的服务器覆盖配置 fsa - fsa 的服务器覆盖配置 选项
|
|
覆盖状态。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
统计日志设置 emergency - 单位不可用 alert - 需要立即采取行动 critical - 功能受影响 error - 功能可能受影响 warn - 功能可能受影响 notice - 关于正常事件的信息 info - 一般信息 debug - 调试信息 disable - Linkd 日志记录已禁用。 选项
|
|
统计日志间隔设置，单位为分钟 |
|
未评级站点的统计信息同步间隔，单位为分钟 |
|
如果 delta 文件不足，FortiGuard 数据库更新等待时间，单位为小时 |
|
启用/禁用更新日志设置 disable - 禁用更新日志。 enable - 启用更新日志。 选项
|
|
网页过滤服务的最大内存使用量，单位为兆字节 |
|
网页过滤 DN 缓存过期时间，单位为分钟 |
|
网页过滤 DN 缓存的最大数量 |
|
网页过滤日志设置 disable - 禁用 URL 日志。 nourl - 记录非 URL 事件。 all - 记录所有 URL 查询。 选项
|
|
启用/禁用将网页过滤数据库预加载到内存中 disable - 禁用网页过滤数据库预加载。 enable - 启用网页过滤数据库预加载。 选项
|
|
使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是 global 和其他包括 root。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认值： |
注释
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。
示例
- 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]>
返回值
常用返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果在剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回： complex |