community.network.cnos_image – Выполнение обновления/загрузки прошивки с удаленного сервера на устройствах с Lenovo CNOS

Примечание

Этот плагин входит в состав коллекции community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в playbook, укажите: community.network.cnos_image.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет работать с изображениями прошивки коммутатора. Он предоставляет способ загрузки изображения прошивки на сетевое устройство с удаленного сервера с использованием FTP, SFTP, TFTP или SCP. Первым шагом является создание каталога, откуда можно получить доступ к удаленному серверу. Следующим шагом является указание полного пути к файлу изображения. Также необходимо указать данные аутентификации, требуемые удаленным сервером. По умолчанию этот метод делает загруженное изображение прошивки активным, которое будет использоваться коммутатором во время следующей перезагрузки. Этот модуль использует SSH для управления конфигурацией сетевого устройства. Результаты операции будут помещены в каталог с именем «results», который должен быть создан пользователем в локальном каталоге, где выполняется playbook.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
deviceType строка / обязательно	Варианты: g8272_cnos g8296_cnos g8332_cnos NE0152T NE1072T NE1032 NE1032T NE10032 NE2572	Указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены начиная с Ansible 2.4. Вариант NE0152T добавлен начиная с 2.8
enablePassword строка		Настраивает пароль, используемый для входа в режим глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться.
host строка / обязательно		Это переменная, используемая для поиска файла hosts в /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применена конфигурация. Обычно в playbook используется Ansible-ключевое слово {{ inventory_hostname }} в качестве абстракции группы сетевых элементов, которые необходимо настроить.
imgpath строка / обязательно		Указывает полный путь к изображению на удаленном сервере. Если используется относительный путь, необходимо указать корневую папку пользователя на сервере.
imgtype строка / обязательно	Варианты: all boot os onie	Указывает тип изображения прошивки для загрузки
outputfile строка / обязательно		Указывает путь к файлу, где сохраняется вывод каждой команды. Здесь сохраняются каждая команда из объединенного файла шаблона и каждый ответ устройства. Обычно это папка results, но вы можете выбрать другое местоположение в зависимости от прав записи.
password строка / обязательно		Настраивает пароль, используемый для аутентификации подключения к удаленному устройству. Значение параметра password используется для аутентификации SSH-сессии. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться.
protocol строка / обязательно	Варианты: SFTP SCP FTP TFTP	Указывает протокол, используемый сетевым устройством для взаимодействия с удаленным сервером, откуда будет загружена прошивка. Доступные варианты: FTP, SFTP, TFTP или SCP. Любые другие протоколы приведут к ошибке. Если этот параметр не указан, значение по умолчанию не используется.
serverip строка / обязательно		Указывает IP-адрес удаленного сервера, откуда будет загружена прошивка.
serverpassword строка		Укажите пароль для сервера, относящегося к используемому протоколу
serverusername строка / обязательно		Укажите имя пользователя для сервера, относящегося к используемому протоколу
username строка / обязательно		Настраивает имя пользователя, используемый для аутентификации подключения к удаленному устройству. Значение параметра username используется для аутентификации SSH-сессии. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Lenovo см. на https://www.ansible.com/ansible-lenovo.

Примеры

Tasks : The following are examples of using the module cnos_image. These are
  written in the main.yml file of the tasks directory.
---
- name: Test Image transfer
  community.network.cnos_image:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_image_{{ inventory_hostname }}_output.txt"
      protocol: "sftp"
      serverip: "10.241.106.118"
      imgpath: "/root/cnos_images/G8272-10.1.0.112.img"
      imgtype: "os"
      serverusername: "root"
      serverpassword: "root123"

- name: Test Image tftp
  community.network.cnos_image:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_image_{{ inventory_hostname }}_output.txt"
      protocol: "tftp"
      serverip: "10.241.106.118"
      imgpath: "/anil/G8272-10.2.0.34.img"
      imgtype: "os"
      serverusername: "root"
      serverpassword: "root123"

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

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

Ключ	Возвращаемое значение	Описание
msg строка	всегда	Сообщение об успехе или ошибке Пример: Файл изображения передан на устройство

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_image_module.html