fortinet.fortimanager.fmgr_fmupdate_fwmsetting 模块 – 配置固件管理设置。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_fmupdate_fwmsetting。
fortinet.fortimanager 2.1.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前根据数据源调整的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构差异时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
如有需要，自动扫描 FGT 磁盘。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
升级镜像前检查 FGT 磁盘。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
使用 FMG 本地镜像文件，从 FDS 下载失败时使用。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
FGT 从 FortiGuard 下载镜像的计时器 |
|
升级后执行健康检查 disable - 禁用设置。 enable - 启用设置。 选项
|
|
配置要用于选择升级补丁的 IMMX 文件。 fmg - 使用 FortiManager 的 IMMX 文件 fgt - 使用 FortiGate 的 IMMX 文件 cloud - 使用 FortiCloud 的 IMMX 文件 选项
|
|
配置 fwm 守护程序的日志设置 fwm - FWM 守护程序日志 fwm_dm - FWM 和部署服务日志 fwm_dm_json - FWM 和部署服务日志，包含 FMG 和 FGT 之间的 JSON 数据 选项
|
|
设备升级报告的最大数量 |
|
FGT 从 FDS 下载失败时的重试次数 |
|
配置文件升级报告的最大数量 |
|
多次升级步骤之间的等待时间 |
|
升级后执行检索 disable - 禁用设置。 enable - 启用设置。 选项
|
|
向设备重新发送请求的等待时间 |
|
最大重试次数 |
|
升级后计算差异脚本 disable - 禁用设置。 enable - 启用设置。 选项
|
|
发送镜像失败时重试 |
|
升级镜像时跳过磁盘检查。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
升级超时。 |
|
隧道建立后检查状态的超时。 |
|
请求升级后检查 fap/fsw/fext 状态的超时。 |
|
等待设备从 FortiGuard 获取 fap/fsw/fext 镜像的超时。 |
|
等待 HA 同步的超时。 |
|
等待检索的超时。 |
|
等待 FortiGate 检查许可证的超时。 |
|
准备镜像的超时。 |
|
等待设备从 FortiGuard 获取镜像的超时。 |
|
等待通过隧道发送镜像的超时。 |
|
等待FortiGate重启的超时时间。 |
|
镜像升级后等待FortiGate重启的超时时间。 |
|
等待检索的超时。 |
|
等待FortiGate RPC响应的超时时间。 |
|
整个FortiGate升级的超时时间。 |
|
使用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 firmware management settings.
fortinet.fortimanager.fmgr_fmupdate_fwmsetting:
# 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_fwmsetting:
fds_image_timeout: <integer>
max_fds_retry: <integer>
multiple_steps_interval: <integer>
skip_disk_check: <value in [disable, enable]>
auto_scan_fgt_disk: <value in [disable, enable]>
check_fgt_disk: <value in [disable, enable]>
fds_failover_fmg: <value in [disable, enable]>
immx_source: <value in [fmg, fgt, cloud]>
log: <value in [fwm, fwm_dm, fwm_dm_json]>
upgrade_timeout:
check_status_timeout: <integer>
ctrl_check_status_timeout: <integer>
ctrl_put_image_by_fds_timeout: <integer>
ha_sync_timeout: <integer>
license_check_timeout: <integer>
prepare_image_timeout: <integer>
put_image_by_fds_timeout: <integer>
put_image_timeout: <integer>
reboot_of_fsck_timeout: <integer>
reboot_of_upgrade_timeout: <integer>
retrieve_timeout: <integer>
rpc_timeout: <integer>
total_timeout: <integer>
health_check_timeout: <integer>
retry_interval: <integer>
retry_max: <integer>
health_check: <value in [disable, enable]>
max_device_history: <integer>
max_profile_history: <integer>
retrieve: <value in [disable, enable]>
revision_diff: <value in [disable, enable]>
send_image_retry: <integer>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整URL。 返回：始终 示例： |
|
API请求的状态。 返回：始终 示例： |
|
API响应。 返回：始终 |
|
API响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂类型 |