fortinet.fortios.fortios_system_fortiguard 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiGuard 服务。
注意
此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_fortiguard。
在 fortinet.fortios 2.0.0 中新增
概要
此模块能够通过允许用户设置和修改系统功能和 fortiguard 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值需要在使用前调整到数据源。使用 FOS v6.0.0 测试。
要求
在执行此模块的主机上需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选择
|
|
要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 用 member_path 标记的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选择
|
|
配置 FortiGuard 服务。 |
|
启用/禁用 FortiGuard 反垃圾邮件请求缓存。使用少量内存，但提高了性能。 选择
|
|
反垃圾邮件缓存允许使用的 FortiGate 内存的最大百分比 (1 - 15)。 |
|
反垃圾邮件缓存允许使用的 FortiGate 内存的最大千分比 (1 - 150)。 |
|
反垃圾邮件缓存条目的生存时间（以秒为单位）（300 - 86400）。较低的时间会减少缓存大小。较高的时间可能会提高性能，因为缓存将有更多条目。 |
|
FortiGuard 反垃圾邮件合约的到期日期。 |
|
启用/禁用关闭 FortiGuard 反垃圾邮件服务。 选择
|
|
FortiGuard 反垃圾邮件合约的许可证检查之间的时间间隔。 |
|
反垃圾邮件查询超时（1 - 30 秒）。 |
|
FortiGuard 任播 DNS 评级服务器的 IP 地址。 |
|
连接到 FortiGuard 任播 DNS 评级服务器的端口。 |
|
启用/禁用从 FortiGuard 自动进行补丁级别的固件升级。FortiGate 设备仅在相同的主要和次要版本中搜索新补丁。 选择
|
|
允许从 FortiGuard 安装自动补丁级别固件升级的一周中的日期。不允许一周中的任何一天使用 auto-firmware-upgrade-delay，它会在指定的日期后等待安装自动补丁级别固件升级。 选择
|
|
在一周内安装自动补丁级别固件升级之前，从 FortiGuard 延迟的天数，用于安装自动补丁级别固件升级。 |
|
从 FortiGuard 自动进行补丁级别固件升级的指定时间窗口中的结束时间（24 小时制，0 ~ 23）。当结束时间小于开始时间时，结束时间将被解释为第二天。实际升级时间在时间窗口内随机选择。 |
|
从 FortiGuard 自动进行补丁级别固件升级的指定时间窗口中的开始时间（24 小时制，0 ~ 23）。实际升级时间在时间窗口内随机选择。 |
|
自动连接并登录到 FortiCloud。 选择
|
|
FortiDDNS 服务器的 IP 地址。 |
|
FortiDDNS 服务器的 IPv6 地址。 |
|
用于与 FortiDDNS 服务器通信的端口。 |
|
FortiGuard 许可证过期前生成许可证过期事件日志的天数阈值（1 - 100 天）。 |
|
启用/禁用使用 FortiGuard 的任播网络。 选择
|
|
配置 Fortinet 的哪个服务器在 FortiGuard 的任播网络中提供 FortiGuard 服务。默认为 Fortinet。 选择
|
|
指定到达服务器的传出接口。源 system.interface.name。 |
|
指定如何选择到达服务器的传出接口。 选择
|
|
作为第一个 FortiGuard 选项在之间交替的服务器数量。 |
|
启用/禁用 FortiGuard 病毒爆发预防缓存。 选择
|
|
FortiGuard 病毒爆发预防缓存可以使用的最大内存百分比 (1 - 15%)。 |
|
FortiGuard 病毒爆发预防缓存可以使用的最大内存千分比（1 - 150 千分比）。 |
|
FortiGuard 病毒爆发预防缓存条目的生存时间（300 - 86400 秒）。 |
|
FortiGuard 病毒爆发预防合约的到期日期。 |
|
关闭 FortiGuard 病毒爆发预防服务。 选择
|
|
FortiGuard 病毒爆发预防合约的许可证检查之间的时间间隔。 |
|
FortiGuard 病毒爆发预防超时（1 - 30 秒）。 |
|
启用/禁用使用持久连接来接收来自 FortiGuard 的更新通知。 选择
|
|
用于与 FortiGuard 服务器通信的端口。 选择
|
|
用于与 FortiGuard 服务器通信的协议。 选择
|
|
代理用户密码。 |
|
代理服务器的主机名或 IPv4 地址。 |
|
用于与代理服务器通信的端口。 |
|
代理用户名。 |
|
启用/禁用 FortiCloud 沙箱内联扫描。 选择
|
|
FortiCloud 沙箱区域。 |
|
FortiGuard DNS 服务的自定义选项。 选择
|
|
FortiGuard DNS 评级服务器的 IP 地址。 |
|
连接到 FortiGuard DNS 评级服务器的端口。 |
|
服务帐户 ID。 |
|
用于与 FortiGuard 通信的源 IPv4 地址。 |
|
用于与 FortiGuard 通信的源 IPv6 地址。 |
|
启用/禁用代理字典重建。 选择
|
|
启用/禁用 DLP 签名更新。 选择
|
|
启用/禁用外部资源更新。 选择
|
|
启用/禁用互联网服务数据库更新。 选择
|
|
接收 FortiGuard 更新的位置。 选择
|
|
启用/禁用允许列表更新。 选择
|
|
FortiGuard 服务虚拟域名称。源 system.vdom.name。 |
|
FortiGuard 视频过滤合同的到期日期。 |
|
FortiGuard 视频过滤合同的许可证检查之间的间隔时间。 |
|
启用/禁用 FortiGuard Web 过滤器缓存。 选择
|
|
Web 过滤器缓存条目的生存时间（以秒为单位）（300 - 86400）。 |
|
FortiGuard Web 过滤器合同的到期日期。 |
|
启用/禁用关闭 FortiGuard Web 过滤服务。 选择
|
|
FortiGuard Web 过滤器合同的许可证检查之间的间隔时间。 |
|
Web 过滤器查询超时时间（1 - 30 秒）。 |
|
先前定义的虚拟域。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： |
注释
注意
传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式
示例
- name: Configure FortiGuard services.
fortinet.fortios.fortios_system_fortiguard:
vdom: "{{ vdom }}"
system_fortiguard:
antispam_cache: "enable"
antispam_cache_mpercent: "2"
antispam_cache_mpermille: "1"
antispam_cache_ttl: "1800"
antispam_expiration: "0"
antispam_force_off: "enable"
antispam_license: "4294967295"
antispam_timeout: "7"
anycast_sdns_server_ip: "<your_own_value>"
anycast_sdns_server_port: "853"
auto_firmware_upgrade: "enable"
auto_firmware_upgrade_day: "sunday"
auto_firmware_upgrade_delay: "3"
auto_firmware_upgrade_end_hour: "4"
auto_firmware_upgrade_start_hour: "1"
auto_join_forticloud: "enable"
ddns_server_ip: "<your_own_value>"
ddns_server_ip6: "<your_own_value>"
ddns_server_port: "443"
FDS_license_expiring_days: "15"
fortiguard_anycast: "enable"
fortiguard_anycast_source: "fortinet"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
load_balance_servers: "1"
outbreak_prevention_cache: "enable"
outbreak_prevention_cache_mpercent: "2"
outbreak_prevention_cache_mpermille: "1"
outbreak_prevention_cache_ttl: "300"
outbreak_prevention_expiration: "0"
outbreak_prevention_force_off: "enable"
outbreak_prevention_license: "4294967295"
outbreak_prevention_timeout: "7"
persistent_connection: "enable"
port: "8888"
protocol: "udp"
proxy_password: "<your_own_value>"
proxy_server_ip: "<your_own_value>"
proxy_server_port: "0"
proxy_username: "<your_own_value>"
sandbox_inline_scan: "enable"
sandbox_region: "<your_own_value>"
sdns_options: "include-question-section"
sdns_server_ip: "<your_own_value>"
sdns_server_port: "53"
service_account_id: "<your_own_value>"
source_ip: "84.230.14.43"
source_ip6: "<your_own_value>"
update_build_proxy: "enable"
update_dldb: "enable"
update_extdb: "enable"
update_ffdb: "enable"
update_server_location: "automatic"
update_uwdb: "enable"
vdom: "<your_own_value> (source system.vdom.name)"
videofilter_expiration: "0"
videofilter_license: "4294967295"
webfilter_cache: "enable"
webfilter_cache_ttl: "3600"
webfilter_expiration: "0"
webfilter_force_off: "enable"
webfilter_license: "4294967295"
webfilter_timeout: "15"
返回值
通用返回值记录在此处 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
Fortigate 镜像的版本号 返回：始终 示例： |
|
最后一次用于将内容配置到 FortiGate 的方法 返回：始终 示例： |
|
FortiGate 在上次应用操作时给出的最后结果 返回：始终 示例： |
|
上次调用 FortiGate 时使用的主键 (id) 返回：成功 示例： |
|
用于满足请求的表的名称 返回：始终 示例： |
|
用于满足请求的表的路径 返回：始终 示例： |
|
内部修订号 返回：始终 示例： |
|
设备的序列号 返回：始终 示例： |
|
操作结果的指示 返回：始终 示例： |
|
使用的虚拟域 返回：始终 示例： |
|
FortiGate 的版本 返回：始终 示例： |