fortinet.fortios.fortios_system_device_upgrade 模块 – Fortinet FortiOS 和 FortiGate 中托管设备的独立升级。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_device_upgrade。

在 fortinet.fortios 2.0.0 中新增

概要

  • 此模块能够通过允许用户设置和修改系统特性和 device_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"

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

system_device_upgrade

字典

托管设备的独立升级。

device_type

字符串

Fortinet 设备类型。

选择

  • "fortigate"

  • "fortiswitch"

  • "fortiap"

  • "fortiextender"

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 设备的序列号。

known_ha_members

列表 / 元素=字典

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

serial

字符串 / 必需

HA 成员的序列号

maximum_minutes

整数

允许立即升级准备的最大分钟数。

next_path_index

整数

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

serial

字符串 / 必需

要包含的节点的序列号。

setup_time

字符串

UTC 格式的升级准备开始时间 (hh:mm yyyy/mm/dd UTC)。

status

字符串

升级的当前状态。

选择

  • "disabled"

  • "initialized"

  • "downloading"

  • "device-disconnected"

  • "ready"

  • "coordinating"

  • "staging"

  • "final-check"

  • "upgrade-devices"

  • "cancelled"

  • "confirmed"

  • "done"

  • "dry-run-done"

  • "failed"

time

字符串

UTC 格式的计划升级执行时间 (hh:mm yyyy/mm/dd UTC)。

timing

字符串

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

选择

  • "immediate"

  • "scheduled"

upgrade_path

字符串

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

vdom

字符串

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

默认值： "root"

注释

注意

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

示例

- name: Independent upgrades for managed devices.
  fortinet.fortios.fortios_system_device_upgrade:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_device_upgrade:
          device_type: "fortigate"
          failure_reason: "none"
          ha_reboot_controller: "<your_own_value>"
          known_ha_members:
              -
                  serial: "<your_own_value>"
          maximum_minutes: "15"
          next_path_index: "0"
          serial: "<your_own_value>"
          setup_time: "<your_own_value>"
          status: "disabled"
          time: "<your_own_value>"
          timing: "immediate"
          upgrade_path: "<your_own_value>"

返回值

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

键

描述

build

字符串

FortiGate 映像的内部版本号

返回：始终

示例： "1547"

http_method

字符串

用于将内容提供到 FortiGate 的最后使用的方法

返回：始终

示例： "PUT"

http_status

字符串

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

返回：始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥（id）

返回：成功

示例： "id"

name

字符串

用于满足请求的表名称

返回：始终

示例： "urlfilter"

path

字符串

用于满足请求的表路径

返回：始终

示例: "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)