onyx_command - Выполнение команд на удалённых устройствах с Mellanox ONYX
Новая версия с 2.5.
Описание
- Отправляет произвольные команды на сетевое устройство Mellanox ONYX и возвращает результаты, полученные с устройства. В этом модуле есть аргумент, который заставит модуль дождаться выполнения определённого условия до возврата или вызовет таймаут, если условие не выполнится.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств Mellanox ONYX используйте onyx_config.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands обязательно | Список команд для отправки на удалённое сетевое устройство Mellanox ONYX. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращает значение до тех пор, пока условие не будет выполнено или не истечёт время ожидания. | ||
| interval | Значение по умолчанию: 1 | Устанавливает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал определяет, сколько времени ждать перед повторной попыткой. | |
| match |
| Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — all или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из условий. | |
| provider | Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт для создания подключения к удалённому устройству. | |
| username | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль, если требуется для перехода в привилегированный режим на удалённом устройстве. Если authorize — ложь, этот аргумент не работает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| retries | Значение по умолчанию: 10 | Указывает количество попыток выполнения команды до того, как она будет считана неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | |
| wait_for | Список условий для проверки по выводу команды. Задача ждёт, пока каждое условие не станет истинным, перед продолжением. Если условие не становится истинным в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. | ||
Примечания
Примечание
- Проверено на ONYX 3.6.4000
Примеры
tasks:
- name: run show version on remote devices
onyx_command:
commands: show version
- name: run show version and check to see if output contains MLNXOS
onyx_command:
commands: show version
wait_for: result[0] contains MLNXOS
- name: run multiple commands on remote nodes
onyx_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
onyx_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains MLNXOS
- result[1] contains mgmt1
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| failed_conditions список | ошибка | Список условий, которые не выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме ошибок низкого уровня (например, плагин действий) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме ошибок низкого уровня (например, плагин действий) | Значение stdout, разбитое на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое сопровождение
Этот модуль помечен как сообщество, что означает, что его сопровождает сообщество Ansible. Подробнее об этом см. Техническое сопровождение и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- Samer Deeb (@samerd)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/onyx_command_module.html
