nxos_reboot — Перезагрузка сетевого устройства.
Новая версия с 2.2.
Описание
- Перезагрузка сетевого устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| confirm | Значение по умолчанию: "нет" | Логическая переменная защиты. Установите в значение "да", если уверены, что хотите перезагрузить устройство. | |
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство по параметрам платформы NXOS NXOS Platform Options. Объект типа dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение параметра host используется как адрес назначения для протокола. | ||
| port | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт, который будет использоваться при установке соединения с удаленным устройством. Это значение применимо как к cli, так и к nxapi. Значение порта будет по умолчанию соответствовать стандартному порту соответствующего протокола, если не указано иное в задаче (cli=22, http=80, https=443). | |
| username | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий параметр, используемый для протоколов cli и nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | Значение по умолчанию: "нет" | Указывает пароль, необходимый для перехода в привилегированный режим на удаленном устройстве. Если authorize равно false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для протокола cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает использование SSL для протокола transport, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Если транспорт не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
Примечания
Примечание
- Тестировалось с NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершится ошибкой из-за проблем с таймаутом, но перезагрузка всё равно будет выполнена.
- Сведения об использовании CLI и NX-API см. в руководстве Параметры платформы NXOS.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Руководство по сети Ansible.
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration.
Примеры
- nxos_reboot:
confirm: true
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| rebooted логический тип | успех | Указано ли устройству выполнить перезагрузку. Пример: Истина |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network. Для получения дополнительной информации см. Поддержка и техническое обслуживание модулей.
Список других модулей, которые также поддерживаются командой Ansible Network, см. в этом разделе.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний.
Автор
- 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.6/modules/nxos_reboot_module.html