nxos_install_os – Установка операционной системы с настройкой параметров загрузки, образа kickstart и ISSU

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Установка операционной системы с настройкой параметров загрузки, включая образ загрузки и образ kickstart, и, по желанию, установка с помощью ISSU (In Server Software Upgrade).

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
issu - добавлен в 2.5		Варианты: required desired yes no ←	Обновление с помощью In Service Software Upgrade (ISSU). (Поддерживается на платформах N5k, N7k, N9k) Выбор «required» или «yes» означает, что обновления будут продолжены только если коммутатор поддерживает ISSU. Выбор «desired» означает, что обновления будут использовать ISSU, если возможно, но вернутся к прерывистому обновлению при необходимости. Выбор «no» означает, что ISSU не используется. Принудительное прерывистое обновление.
kickstart_image_file -			Имя файла образа kickstart на флэш-памяти. (Не требуется на всех платформах Nexus)
provider dictionary			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Этот параметр необходим только если используется NX-API. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект типа dict, содержащий данные подключения.
	auth_pass string добавлен в 2.5.3		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 2.5.3	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host string / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port integer	По умолчанию: "0 (использовать общий порт)"	Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует общему порту для транспорта, если не указано в задаче. (cli=22, http=80, https=443).
	ssh_keyfile string		Указывает SSH ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
	transport string / обязательно	Варианты: cli ← nxapi	Настройка транспорта для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настройка транспорта transport для использования SSL, если значение равно `yes`, только при `transport=nxapi`, в противном случае это значение игнорируется.
	username string		Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
system_image_file - / обязательно			Имя файла системного (или комбинированного) образа на флэш-памяти.

Примечания

Примечание

Тестировалось на следующих платформах и образах - N9k 7.0(3)I4(6), 7.0(3)I5(3), 7.0(3)I6(1), 7.0(3)I7(1), 7.0(3)F2(2), 7.0(3)F3(2) - N3k 6.0(2)A8(6), 6.0(2)A8(8), 7.0(3)I6(1), 7.0(3)I7(1) - N7k 7.3(0)D1(1), 8.0(1), 8.1(1), 8.2(1)
Для этого модуля необходимо установить таймеры ANSIBLE_PERSISTENT_CONNECT_TIMEOUT и ANSIBLE_PERSISTENT_COMMAND_TIMEOUT на 600 секунд или более. Модуль завершится, если таймеры не установлены должным образом.
При использовании подключения local, ANSIBLE_PERSISTENT_CONNECT_TIMEOUT и ANSIBLE_PERSISTENT_COMMAND_TIMEOUT могут быть установлены только с помощью переменных среды или файла ansible.cfg.
Не указывайте полные пути к файлам, используйте только имена файлов, хранящиеся в корневом каталоге флэш-памяти.
Этот модуль пытается установить программное обеспечение немедленно, что может вызвать перезагрузку.
В режиме проверки модуль укажет, требуется ли обновление и является ли обновление прерывистым или непрерывистым (ISSU).
Для информации о работе с CLI и NX-API обратитесь к руководству NXOS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, обратитесь к руководству Ansible Network Guide
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, посетите страницу интеграции Cisco Cisco integration page.

Примеры

- name: Install OS on N9k
  check_mode: no
  nxos_install_os:
    system_image_file: nxos.7.0.3.I6.1.bin
    issu: desired

- name: Wait for device to come back up with new image
  wait_for:
    port: 22
    state: started
    timeout: 500
    delay: 60
    host: "{{ inventory_hostname }}"

- name: Check installed OS for newly installed version
  nxos_command:
    commands: ['show version | json']
    provider: "{{ connection }}"
  register: output
- assert:
    that:
    - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I6(1)'

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

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

Ключ	Возвращаемое значение	Описание
install_state словарь	всегда	Информация об установке и загрузке. Пример: {'install_state': ['Проверка совместимости завершена:', 'Загрузка модуля Влияние на установку Тип установки Причина', '------ -------- -------------- ------------ ------', ' 1 да нет перезапуска ', 'Изображения будут обновлены в соответствии со следующей таблицей:', 'Модуль Изображение Текущая версия(приоритет:альтернатива) Новая версия Требуется обновление', '------ ---------- ---------------------------------------- -------------------- ------------', ' 1 nxos 7.0(3)I6(1) 7.0(3)I7(1) да', ' 1 bios v4.4.0(07/12/2017) v4.4.0(07/12/2017) нет']}

Статус

Для этого модуля не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

Jason Edelman (@jedelman8)
Gabriele Gerbibo (@GGabriele)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_install_os_module.html