Модуль 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.

Для использования в playbook, укажите: dellemc.enterprise_sonic.sonic_image_management.

Новое в dellemc.enterprise_sonic 2.4.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Управление установкой образа Enterprise SONiC, программного патча и средства обновления прошивки.

Параметры

Параметр	Комментарии
firmware dictionary	Управление установкой средства обновления прошивки
command string / required	Указывает операцию управления средством обновления прошивки, которая должна быть выполнена. `install` - Подготовка средства обновления прошивки, указанного в path. `cancel` - Отмена ожидающего обновления прошивки. `get-list` - Получение сведений о ожидающем обновлении прошивки и результате установленного обновления прошивки. `get-status` - Получение состояния подготовки средства обновления прошивки. Варианты: `"install"` `"cancel"` `"get-list"` `"get-status"`
path string	Когда command=install, указывает путь к средству обновления прошивки, которое должно быть подготовлено. Путь может быть файлом на устройстве (file://filepath) или URL (http:// или https://).
image dictionary	Управление установкой образа Enterprise SONiC.
command string / required	Указывает операцию управления образом, которая должна быть выполнена. `install` - Установка образа, указанного в path. `cancel` - Отмена установки образа. `remove` - Удаление образа, указанного в name. `set-default` - Установка образа, указанного в name, в качестве образа загрузки по умолчанию. `get-list` - Получение списка установленных образов. `get-status` - Получение состояния установки образа. Варианты: `"install"` `"cancel"` `"remove"` `"set-default"` `"get-list"` `"get-status"`
name string	Когда command=remove или command=set-default, указывает имя образа. Когда command=remove, имя может быть указано как `all` для удаления всех образов, которые не являются текущими или следующими.
path string	Когда command=install, указывает путь к образу, который должен быть установлен. Путь может быть файлом на устройстве (file://filepath) или URL (http:// или https://).
patch dictionary	Управление установкой программного патча.
command string / required	Указывает операцию управления патчем, которая должна быть выполнена. `install` - Установка патча, указанного в path. `rollback` - Удаление установленного патча, указанного в name. `get-history` - Получение истории примененных/откаченных патчей. `get-list` - Получение списка установленных патчей. `get-status` - Получение состояния установки/удаления патча. Варианты: `"install"` `"rollback"` `"get-history"` `"get-list"` `"get-status"`
name string	Когда command=rollback, указывает имя патча.
path string	Когда 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 словарь	Подробности, возвращаемые указанной операцией получения. Возвращается: при 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"}`
status строка	Статус выполненной операции. Возвращается: когда command не `get-status`, `get-list` и `get-history` Пример: `"SUCCESS"`

Ключ

Описание

info

словарь

Подробности, возвращаемые указанной операцией получения.

Возвращается: при 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"}

status

строка

Статус выполненной операции.

Возвращается: когда command не get-status, get-list и get-history

Пример: "SUCCESS"

Авторы

Arun Saravanan Balachandran (@ArunSaravananBalachandran)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_image_management_module.html