cnos_command – Выполнение произвольных команд на устройствах Lenovo CNOS
Новое в версии 2.6.
Обзор
- Отправляет произвольные команды узлу CNOS и возвращает результаты, считанные с устройства. Модуль
cnos_commandвключает аргумент, который заставит модуль ожидать выполнения определенного условия перед возвратом или сработает таймаут, если условие не будет выполнено.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands - / обязательно Добавлен в 2.6 | Список команд для отправки на удаленное устройство. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не вернет результат, пока условие не будет выполнено или не истечет число попыток. | |
| interval - Добавлен в 2.6 | По умолчанию: 1 | Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько ждать перед повторной попыткой выполнения. |
| match - Добавлен в 2.6 |
| Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — all или any. Если значение установлено в all, все условные условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из условий. |
| retries - Добавлен в 2.6 | По умолчанию: 10 | Указывает количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. |
| wait_for - Добавлен в 2.6 | Список условий, которые должны быть проверены по выводу команды. Задача будет ожидать выполнения каждого условия, прежде чем перейти к следующему. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. |
Примеры
---
- name: test contains operator
cnos_command:
commands:
- show version
- show system memory
wait_for:
- "result[0] contains 'Lenovo'"
- "result[1] contains 'MemFree'"
register: result
- assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: get output for single command
cnos_command:
commands: ['show version']
register: result
- assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: get output for multiple commands
cnos_command:
commands:
- show version
- show interface information
register: result
- assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- "result.stdout | length == 2"
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудача | невыполненные условия Пример: ['...', '...'] |
| stdout список | всегда | набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Anil Kumar Muraleedharan (@amuraleedhar)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cnos_command_module.html