nxos_reboot – Перезагрузка сетевого устройства.
Новое в версии 2.2.
Описание
- Перезагрузка сетевого устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| confirm - | Значение по умолчанию: "нет" | Логический параметр предосторожности. Установите в значение true, если уверены, что хотите перезагрузить устройство. | |
| provider - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Дополнительная информация доступна в руководстве по параметрам платформы NXOS NXOS Platform Options guide. Объект типа dict, содержащий сведения о подключении. | ||
| auth_pass - добавлен в 2.5.3 | Значение по умолчанию: "none" | Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 2.5.3 |
| Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве целевого адреса для протокола. | ||
| password - | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | Значение по умолчанию: "0 (используется стандартный порт)" | Указывает порт для подключения к удаленному устройству. Это значение применимо как к протоколу cli, так и к nxapi. Значение порта по умолчанию соответствует стандартному порту протокола, если оно не указано в задаче (cli=22, http=80, https=443). | |
| 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_proxy boolean добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает протокол transport на использование SSL, если значение равно true, только при 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 guide.
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами доступна в руководстве Ansible Network Guide.
- Дополнительная информация об использовании Ansible для управления устройствами Cisco доступна на странице интеграции Cisco Cisco integration page.
Примеры
- nxos_reboot:
confirm: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| rebooted boolean | успех | Было ли указано устройству выполнить перезагрузку. Пример: True |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сетевой]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.7/modules/nxos_reboot_module.html