Spec-Zone.ru › Ansible 2.5

nxos_reboot — Перезагрузка сетевого устройства.

Новое в версии 2.2.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Поддержка
    • Автор

Описание

  • Перезагрузка сетевого устройства.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
confirm По умолчанию:
no
Логическая переменная защиты. Установите в значение true, если уверены, что хотите перезагрузить устройство.
provider По умолчанию:
None
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр нужен только при использовании NX-API.
Дополнительную информацию см. в руководстве NXOS Platform Options.
Объект словаря, содержащий данные подключения.
username
Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
authorize
(добавлено в 2.5.3)
    Варианты:
  • no ←
  • yes
Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
use_proxy
(добавлено в 2.5)
    Варианты:
  • yes ←
  • no
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
auth_pass
(добавлено в 2.5.3)
По умолчанию:
none
Указывает пароль для перехода в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
обязательно
Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве целевого адреса для транспорта.
timeout
(добавлено в 2.3)
По умолчанию:
10
Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
use_ssl
    Варианты:
  • yes
  • no ←
Устанавливает транспорт transport для использования SSL, если значение true, только если transport=nxapi, в противном случае это значение игнорируется.
password По умолчанию:
None
Указывает пароль для аутентификации подключения к удалённому устройству. Это распространённый аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
validate_certs
    Варианты:
  • yes
  • no
По умолчанию:
None
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, с самоподписанными сертификатами. Если транспортный аргумент не nxapi, это значение игнорируется.
port По умолчанию:
0 (используется стандартный порт)
Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту для транспорта, если оно не указано в задаче. (cli=22, http=80, https=443).
transport
обязательно
По умолчанию:
cli
Устанавливает тип подключения для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Модуль может завершиться ошибкой из-за таймаута, но перезагрузка всё равно будет выполнена.
  • Подробную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- nxos_reboot:
    confirm: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
rebooted
boolean
success
Указание на то, что устройство было проинструктировано на перезагрузку.

Пример:
True


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_reboot_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API