Spec-Zone.ru › Ansible

Модуль dellemc.enterprise_sonic.sonic_image_management — управление установкой образа Enterprise SONiC, исправлений ПО и средства обновления микропрограммы

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Эта коллекция может быть уже установлена, если вы используете пакет 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

dictionary

Управление установкой средства обновления микропрограммы

command

string / обязательный

Задает выполняемую операцию управления средством обновления микропрограммы.

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 / обязательный

Задает выполняемую операцию управления образом.

install — установить образ, указанный в path.

cancel — отменить установку образа.

remove — удалить образ, указанный в name.

set-default — задать образ, указанный в name, как образ, загружаемый по умолчанию.

get-list — получить список установленных образов.

get-status — получить состояние установки образа.

gpg-key — установить ключ GPG.

verify — проверить образ, указанный в path, с помощью метода GPG или PKI.

Допустимые значения:

  • "install"
  • "cancel"
  • "remove"
  • "set-default"
  • "get-list"
  • "get-status"
  • "gpg-key"
  • "verify"

keyserver

string

добавлено в dellemc.enterprise_sonic 3.0.0

URL сервера ключей GPG.

Обязательный параметр, если command=gpg-key.

name

string

Если command=remove или command=set-default, задает имя образа.

Если command=remove, в качестве имени можно указать all, чтобы удалить все образы, кроме текущего и следующего.

path

string

Если command=install или command=verify, задает путь к образу, который нужно установить.

Путь может указывать на файл на устройстве (file://filepath) или URL (http:// или https://).

pubkeyfilename

string

добавлено в dellemc.enterprise_sonic 3.0.0

Задает сертификат для файла подписи.

Обязательный параметр, если command=verify и verifymethod=pki.

pubkeyid

string

добавлено в dellemc.enterprise_sonic 3.0.0

Идентификатор устанавливаемого ключа GPG.

Обязательный параметр, если command=gpg-key.

signaturefile

string

добавлено в dellemc.enterprise_sonic 3.0.0

Файл GPG/PKI для проверки.

Обязательный параметр, если command=verify.

verifymethod

string

добавлено в dellemc.enterprise_sonic 3.0.0

Метод проверки образа: GPG или PKI

Обязательный параметр, если command=verify.

Допустимые значения:

  • "gpg"
  • "pki"

patch

dictionary

Управление установкой исправлений ПО.

command

string / обязательный

Задает выполняемую операцию управления исправлением.

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'

- name: Install GPG Key for image verification
  dellemc.enterprise_sonic.sonic_image_management:
    image:
      command: gpg-key
      keyserver: 'hkp://keyserver.ubuntu.com:80'
      pubkeyid: 'DAFWQGEW12345678'

- name: Verify Enterprise SONiC image
  dellemc.enterprise_sonic.sonic_image_management:
    image:
      command: verify
      path: 'home://sonic.bin'
      verifymethod: 'gpg'
      signaturefile: 'sign.gpg'

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

info

dictionary

Сведения, возвращаемые указанной операцией получения данных.

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

string

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

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

Пример: "SUCCESS"

Авторы

  • Arun Saravanan Balachandran (@ArunSaravananBalachandran), Aravind Mani (@aravindmani-1)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API