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