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

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和联合升级类别来配置 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

字典

协调安全 Fabric 内的联合升级。

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

列表 / elements=字典

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

serial

字符串 / 必需

HA 成员的序列号

next_path_index

整数

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

node_list

列表 / elements=字典

将包含在升级中的节点。

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 是运行 Playbook 的首选方式

示例

- 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"

路径

字符串

用于满足请求的表路径

已返回: 始终

示例： "webfilter"

修订版本

字符串

内部修订号

已返回: 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

已返回: 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

已返回: 始终

示例： "success"

vdom

字符串

使用的虚拟域

已返回: 始终

示例： "root"

版本

字符串

FortiGate 的版本

已返回: 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)