nxos_reboot — Перезагрузка сетевого устройства.
Новая версия 2.2.
Описание
- Перезагрузка сетевого устройства.
Параметры
| Параметр | Обязательный | Значение по умолчанию | Допустимые значения | Комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4) |
нет | нет | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот параметр не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. |
|
| authorize (добавлен в 2.4.4) |
нет |
|
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. |
|
| confirm |
нет | Логическая переменная защиты. Установите в значение true, если уверены, что хотите перезагрузить устройство. |
||
| host |
да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
| password |
нет | Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. |
||
| port |
нет | 0 (используется стандартный порт) | Указывает порт, используемый при построении подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для соответствующего транспорта, если в задаче не указано иное. (cli=22, http=80, https=443). |
|
| provider |
нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательные параметры, допустимые значения и т.д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. |
||
| ssh_keyfile |
нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. |
||
| timeout (добавлен в 2.3) |
нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). |
|
| transport |
да | cli | Настраивает транспортное подключение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. |
|
| use_ssl |
нет |
|
Настраивает транспорт transport на использование SSL, если значение равно true, только если transport=nxapi, в противном случае это значение игнорируется. |
|
| username |
нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. |
||
| validate_certs |
нет |
|
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если параметр transport не равен nxapi, это значение игнорируется. |
Примеры
- nxos_reboot:
confirm: true
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| rebooted | Указано ли устройству перезагрузиться. |
успешно | логический тип | True |
Примечания
Примечание
- Тестировалось с NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершится ошибкой из-за проблем с временем ожидания, но перезагрузка все равно будет выполнена.
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке данного модуля компанией Red Hat, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_reboot_module.html
