fortinet.fortimanager.fmgr_fmupdate_fdssetting 模块 – 配置 FortiGuard 设置。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_fmupdate_fdssetting。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
连接 fds 服务器的 SSL 协议版本 sslv3 - 设置 SSLv3 为客户端版本。 tlsv1. tlsv1. tlsv1. 选项
|
|
接收 fgt 连接的 SSL 协议版本 sslv3 - 设置 SSLv3 为最低版本。 tlsv1. tlsv1. tlsv1. 选项
|
|
fmtr 日志级别 emergency - 日志级别 - emergency alert - 日志级别 - alert critical - 日志级别 - critical error - 日志级别 - error warn - 日志级别 - warn notice - 日志级别 - notice info - 日志级别 - info debug - 日志级别 - debug disable - 禁用 linkd 日志 选项
|
|
启用/禁用使用 FortiGuard 的 anycast 网络 disable - 禁用设置。 enable - 启用设置。 选项
|
|
配置 Fortinet 的哪个服务器在 FortiGuard 的 anycast 网络中提供 FortiGuard 服务。 fortinet - 使用 Fortinet 的服务器在 FortiGuard 的 anycast 网络中提供 FortiGuard 服务。 aws - 使用 Fortinet 的 AWS 服务器在 FortiGuard 的 anycast 网络中提供 FortiGuard 服务。 选项
|
|
linkd 日志级别 emergency - 日志级别 - emergency alert - 日志级别 - alert critical - 日志级别 - critical error - 日志级别 - error warn - 日志级别 - warn notice - 日志级别 - notice info - 日志级别 - info debug - 日志级别 - debug disable - 禁用 linkd 日志 选项
|
|
可下载的完整版 AV/IPS 软件包的最大数量 |
|
处理下载请求的工作程序最大数量 |
|
推送覆盖。 |
|
将推送消息转发到 FortiManager 单元的 NAT 设备的外部或虚拟 IP 地址。 |
|
NAT 设备上的接收端口号 |
|
启用/禁用客户端的推送更新 disable - 禁用设置。 enable - 启用设置。 选项
|
|
向客户端推送覆盖。 |
|
公告 IP。 |
|
公告 IP 地址的 ID |
|
公告 IPv4 地址。 |
|
公告 IP 端口 |
|
启用/禁用推送更新 disable - 禁用设置。 enable - 启用设置。 选项
|
|
将报告/fssi 发送到 fds 服务器。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
将设置转发到 fds 服务器。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
服务器覆盖。 |
|
Servlist。 |
|
覆盖服务器 ID |
|
覆盖服务器的 IPv4 地址。 |
|
覆盖服务器的 IPv6 地址。 |
|
联系 FortiGuard 时使用的端口号。 |
|
(列表或字符串) 覆盖服务类型。 fds - FDS 的服务器覆盖配置 fct - FCT 的服务器覆盖配置 选项
|
|
覆盖状态。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
支持的 FortiNDR 版本。 选项
|
|
支持的 FortiAnalyzer 版本。 选项
|
|
支持的 FortiClient 版本。 选项
|
|
支持的 FortiDeceptor 版本。 选项
|
|
支持的 FortiOS 版本。 选项
|
|
支持的 FortiIsolator 版本。 选项
|
|
支持的 FortiMail 版本。 选项
|
|
支持的 FortiSandbox 版本。 选项
|
|
支持的 FortiSwitch 版本。 选项
|
|
支持的 FortiTester 版本。 选项
|
|
um_service 日志级别。 emergency - 日志级别 - emergency alert - 日志级别 - alert critical - 日志级别 - critical error - 日志级别 - error warn - 日志级别 - warn notice - 日志级别 - notice info - 日志级别 - info debug - 日志级别 - debug disable - 禁用 linkd 日志 选项
|
|
设置注销设备的选项。 ignore - 忽略所有未注册的设备。 svc-only - 允许更新请求，但不添加设备。 add-service - 添加未注册的设备并允许更新请求。 选项
|
|
更新计划。 |
|
如果频率是每周，则配置更新将发生的那一天。 Sunday - 每周日更新。 Monday - 每周一更新。 Tuesday - 每周二更新。 Wednesday - 每周三更新。 Thursday - 每周四更新。 Friday - 每周五更新。 Saturday - 每周六更新。 选项
|
|
配置更新频率。 every - 时间间隔。 daily - 每天。 weekly - 每周。 选项
|
|
启用/禁用计划更新。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
(列表) 更新之间的时间间隔，或更新发生的小时和分钟。 |
|
配置用户代理字符串。 |
|
公网IP查询模式。 disable - 不查询公网IP。 ipify - 通过 https 获取公网 IP。 选项
|
|
使用 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 FortiGuard settings.
fortinet.fortimanager.fmgr_fmupdate_fdssetting:
# 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_fdssetting:
User_Agent: <string>
fds_clt_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
fds_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
fmtr_log: <value in [emergency, alert, critical, ...]>
linkd_log: <value in [emergency, alert, critical, ...]>
max_av_ips_version: <integer>
max_work: <integer>
push_override:
ip: <string>
port: <integer>
status: <value in [disable, enable]>
push_override_to_client:
announce_ip:
-
id: <integer>
ip: <string>
port: <integer>
status: <value in [disable, enable]>
send_report: <value in [disable, enable]>
send_setup: <value in [disable, enable]>
server_override:
servlist:
-
id: <integer>
ip: <string>
ip6: <string>
port: <integer>
service_type: # <list or string>
- "fds"
- "fct"
- "fai"
status: <value in [disable, enable]>
system_support_fct:
- "4.x"
- "5.0"
- "5.2"
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
system_support_fgt:
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
- "7.4"
- "7.6"
system_support_fml:
- "4.x"
- "5.x"
- "6.x"
- "6.0"
- "6.2"
- "6.4"
- "7.0"
- "7.2"
- "7.x"
system_support_fsa:
- "1.x"
- "2.x"
- "3.x"
- "4.x"
- "3.0"
- "3.1"
- "3.2"
system_support_fsw:
- "5.4"
- "5.6"
- "6.0"
- "6.2"
- "4.x"
- "5.0"
- "5.2"
- "6.4"
umsvc_log: <value in [emergency, alert, critical, ...]>
unreg_dev_option: <value in [ignore, svc-only, add-service]>
update_schedule:
day: <value in [Sunday, Monday, Tuesday, ...]>
frequency: <value in [every, daily, weekly]>
status: <value in [disable, enable]>
time: <list or string>
wanip_query_mode: <value in [disable, ipify]>
fortiguard_anycast: <value in [disable, enable]>
fortiguard_anycast_source: <value in [fortinet, aws]>
system_support_fdc:
- "3.x"
- "4.x"
- "5.x"
- "6.x"
system_support_fts:
- "3.x"
- "4.x"
- "7.x"
system_support_faz:
- "6.x"
- "7.x"
system_support_fis:
- "1.x"
- "2.x"
system_support_fai:
- "7.x"
返回值
常见返回值已在 此处 记录，以下是此模块独有的字段。
键 |
描述 |
|---|---|
请求的结果。 返回值: 始终 |
|
请求的完整 URL。 返回值: 始终 示例: |
|
API 请求的状态。 返回值: 始终 示例: |
|
API 响应。 返回值: 始终 |
|
API 响应的描述性消息。 返回值: 始终 示例: |
|
目标系统的信息。 返回值: 始终 |
|
请求的状态。 返回值: 始终 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值: 复杂类型 |