cisco.nxos.nxos_reboot – Перезагрузка сетевого устройства.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_reboot.
Новое в версии 1.0.0: модуля cisco.nxos
Обзор
- Перезагрузить сетевое устройство.
Примечание
Этот модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| confirm
boolean
|
|
Защитное логическое значение. Установите в значение true, если вы уверены, что хотите перезагрузить устройство. | |
| provider
словарь
|
Устаревший
Начиная с Ansible 2.5 рекомендуется использовать
connection: network_cli. Начиная с Ansible 2.6 рекомендуется использовать
connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01.
Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options.
Объект словаря, содержащий сведения о подключении.
|
||
| auth_pass
строка
|
Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. |
||
| authorize
boolean
|
|
Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| host
строка
|
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password
строка
|
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. |
||
| port
целое число
|
Указывает порт для использования при создании подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile
строка
|
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| timeout
целое число
|
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | ||
| transport
строка
|
|
Настраивает транспортное соединение для использования при подключении к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy
boolean
|
|
Если no, переменные среды http_proxy и https_proxy будут игнорироваться. |
|
| use_ssl
boolean
|
|
Настраивает transport для использования SSL, если установлено значение yes, только при transport=nxapi, в противном случае это значение игнорируется. |
|
| username
строка
|
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. |
||
| validate_certs
boolean
|
|
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. |
|
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершит работу из-за проблем с таймаутом, но перезагрузка все равно выполнится.
- Дополнительную информацию по использованию CLI и NX-API см. в руководстве NXOS Platform Options.
- Дополнительную информацию по использованию Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- cisco.nxos.nxos_reboot:
confirm: true
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| rebooted
boolean
|
успешно |
Указано ли устройству перезапуститься.
Пример:
True
|
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 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/cisco/nxos/nxos_reboot_module.html
