dellemc.enterprise_sonic.sonic_image_management 模块 – 管理 Enterprise SONiC 镜像、软件补丁和固件更新程序的安装

注意

此模块是 dellemc.enterprise_sonic 集合 (版本 2.5.1) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install dellemc.enterprise_sonic。

要在剧本中使用它，请指定： dellemc.enterprise_sonic.sonic_image_management。

dellemc.enterprise_sonic 2.4.0 中的新增功能

概要

• 管理 Enterprise SONiC 镜像、软件补丁和固件更新程序的安装。

参数

参数	注释
firmware 字典	管理固件更新程序的安装
command 字符串 / 必需	指定要执行的固件更新程序管理操作。 install - 暂存由 path 指定的固件更新程序。 cancel - 取消挂起的固件更新程序。 get-list - 检索挂起的固件更新程序的详细信息以及已安装固件更新程序的结果。 get-status - 检索固件更新程序暂存状态。 选项 "install" "cancel" "get-list" "get-status"
path 字符串	当 command=install 时，指定要暂存的固件更新程序的路径。 路径可以是设备中的文件 (file://filepath) 或 URL (http:// 或 https://)。
image 字典	管理 Enterprise SONiC 镜像的安装。
command 字符串 / 必需	指定要执行的镜像管理操作。 install - 安装由 path 指定的镜像。 cancel - 取消镜像安装。 remove - 删除由 name 指定的镜像。 set-default - 将由 name 指定的镜像设置为默认引导镜像。 get-list - 检索已安装镜像的列表。 get-status - 检索镜像安装状态。 选项 "install" "cancel" "remove" "set-default" "get-list" "get-status"
name 字符串	当 command=remove 或 command=set-default 时，指定镜像的名称。 当 command=remove 时，name 可以指定为 all 以删除所有不是当前或下一个的镜像。
path 字符串	当 command=install 时，指定要安装的镜像的路径。 路径可以是设备中的文件 (file://filepath) 或 URL (http:// 或 https://)。
patch 字典	管理软件补丁的安装。
command 字符串 / 必需	指定要执行的补丁管理操作。 install - 安装由 path 指定的补丁。 rollback - 删除由 name 指定的已安装补丁。 get-history - 检索已应用/回滚的补丁的历史记录。 get-list - 检索已安装补丁的列表。 get-status - 检索补丁安装/删除状态。 选项 "install" "rollback" "get-history" "get-list" "get-status"
name 字符串	当 command=rollback 时，指定补丁的名称。
path 字符串	当 command=install 时，指定要安装的补丁的路径。 路径可以是设备中的文件 (file://filepath) 或 URL (http:// 或 https://)。

示例

- name: Install Enterprise SONiC image
  dellemc.enterprise_sonic.sonic_image_management:
    image:
      command: install
      path: 'file://home/admin/sonic.bin'

- name: Get image installation status
  dellemc.enterprise_sonic.sonic_image_management:
    image:
      command: get-status

- name: Get list of installed images
  dellemc.enterprise_sonic.sonic_image_management:
    image:
      command: get-list

- name: Stage a firmware updater
  dellemc.enterprise_sonic.sonic_image_management:
    firmware:
      command: install
      path: 'file://home/admin/onie-update-full.bin'

返回值

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

键	描述
info 字典	由指定的 get 操作返回的详细信息。 返回：当 command=get-status 或 command=get-list 或 command=get-history 时 示例： {"file-download-speed": "106200", "file-progress": 100, "file-size": "1304997870", "file-transfer-bytes": "1304997870", "install-end-time": "1695714740", "install-start-time": "1695714698", "install-status": "INSTALL_STATE_SUCCESS", "install-status-detail": "Image install success", "operation-status": "GLOBAL_STATE_SUCCESS", "transfer-end-time": "1695714669", "transfer-start-time": "1695714657", "transfer-status": "TRANSFER_STATE_SUCCESS", "transfer-status-detail": "DOWNLOADING IMAGE"}
状态 字符串	执行操作的状态。 返回值：当命令不是get-status、get-list和get-history时 示例： "SUCCESS"

作者

• Arun Saravanan Balachandran (@ArunSaravananBalachandran)

资源链接

• 问题跟踪器
• 代码仓库