fortinet.fortios.fortios_system_federated_upgrade 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中的安全结构内协调联合升级。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：fortinet.fortios.fortios_system_federated_upgrade。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 federated_upgrade 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

system_federated_upgrade

字典

在安全结构内协调联合升级。

failure_device

字符串

要包含的节点的序列号。

failure_reason

字符串

升级失败的原因。

选项

  • "none"

  • "internal"

  • "timeout"

  • "device-type-unsupported"

  • "download-failed"

  • "device-missing"

  • "version-unavailable"

  • "staging-failed"

  • "reboot-failed"

  • "device-not-reconnected"

  • "node-not-ready"

  • "no-final-confirmation"

  • "no-confirmation-query"

  • "config-error-log-nonempty"

  • "csf-tree-not-supported"

  • "node-failed"

ha_reboot_controller

字符串

将控制 HA 集群联合升级重启过程的 FortiGate 单元的序列号。

ignore_signing_errors

字符串

允许/拒绝使用未签名的 FortiGate 固件镜像。

选项

  • "enable"

  • "disable"

known_ha_members

列表 / 元素=字典

HA 集群的已知成员。如果在升级时缺少成员，则会取消升级。

serial

字符串 / 必需

HA 成员的序列号

next_path_index

整数

要升级到的下一个镜像的索引。

node_list

列表 / 元素=字典

将包含在升级中的节点。

coordinating_fortigate

字符串

控制此设备的 FortiGate 单元的序列号。

device_type

字符串

Fortinet 设备类型。

选项

  • "fortigate"

  • "fortiswitch"

  • "fortiap"

  • "fortiextender"

maximum_minutes

整数

允许立即升级准备工作的最长时间（分钟）。

serial

字符串 / 必需

要包含的节点的序列号。

setup_time

字符串

升级准备开始时间（UTC）（hh:mm yyyy/mm/dd UTC）。

time

字符串

计划的升级执行时间（UTC）（hh:mm yyyy/mm/dd UTC）。

timing

字符串

立即运行或在计划时间运行。

选项

  • "immediate"

  • "scheduled"

upgrade_path

字符串

要升级到的 Fortinet OS 镜像版本，采用 major-minor-patch 格式，例如 7-0-4。

source

字符串

设置联合升级配置的来源。

选项

  • "user"

  • "auto-firmware-upgrade"

status

字符串

升级的当前状态。

选项

  • "disabled"

  • "initialized"

  • "downloading"

  • "device-disconnected"

  • "ready"

  • "coordinating"

  • "staging"

  • "final-check"

  • "upgrade-devices"

  • "cancelled"

  • "confirmed"

  • "done"

  • "dry-run-done"

  • "failed"

  • "download-failed"

upgrade_id

整数

此升级的唯一标识符。

vdom

字符串

在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式

示例

- name: Coordinate federated upgrades within the Security Fabric.
  fortinet.fortios.fortios_system_federated_upgrade:
      vdom: "{{ vdom }}"
      system_federated_upgrade:
          failure_device: "<your_own_value>"
          failure_reason: "none"
          ha_reboot_controller: "<your_own_value>"
          ignore_signing_errors: "enable"
          known_ha_members:
              -
                  serial: "<your_own_value>"
          next_path_index: "0"
          node_list:
              -
                  coordinating_fortigate: "<your_own_value>"
                  device_type: "fortigate"
                  maximum_minutes: "15"
                  serial: "<your_own_value>"
                  setup_time: "<your_own_value>"
                  time: "<your_own_value>"
                  timing: "immediate"
                  upgrade_path: "<your_own_value>"
          source: "user"
          status: "disabled"
          upgrade_id: "0"

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

build

字符串

FortiGate 镜像的内部版本号

返回：始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回：始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回：始终

示例： "200"

mkey

字符串

在上次对 FortiGate 的调用中使用的主密钥 (id)

返回：成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回：始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回：始终

示例： "webfilter"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

单元的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

版本

字符串

FortiGate 版本

返回：始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪滨 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)