ce_command - Выполнение произвольной команды на устройствах HUAWEI CloudEngine.
Новое в версии 2.3.
Описание
- Отправляет произвольную команду на узел HUAWEI CloudEngine и возвращает результаты, считанные с устройства. Модуль ce_command включает аргумент, который заставит модуль ожидать выполнения определённого условия перед возвратом или вызовет таймаут, если условие не будет выполнено.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands обязательно | Команды, которые нужно отправить на удалённое устройство HUAWEI CloudEngine через настроенный поставщик. На выходе возвращается результат выполнения команды. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет удовлетворено или не будет превышено количество повторов. | |
| interval | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторами выполнения команды. Если команда не удовлетворяет указанному условию, интервал определяет время ожидания перед повторной попыткой выполнения команды. |
| match | Значение по умолчанию: all | Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения - all, или any. Если значение установлено на all, все условия в wait_for должны быть выполнены. Если значение установлено на any, должно быть выполнено хотя бы одно из условий. |
| retries | Значение по умолчанию: 10 | Указывает количество повторов выполнения команды, после которого она считается неудачной. Команда выполняется на целевом устройстве при каждом повторе и оценивается по условиям wait_for. |
| wait_for | Значение по умолчанию: None | Указывает, что оценивать из вывода команды и какие условия применять. Этот аргумент заставит задачу ожидать выполнения определённого условия до перехода к следующему шагу. Если условие не выполняется в течение заданного количества повторов, задача завершается с ошибкой. Смотрите примеры. |
Примеры
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
- name: CloudEngine command test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: "Run display version on remote devices"
ce_command:
commands: display version
provider: "{{ cli }}"
- name: "Run display version and check to see if output contains HUAWEI"
ce_command:
commands: display version
wait_for: result[0] contains HUAWEI
provider: "{{ cli }}"
- name: "Run multiple commands on remote nodes"
ce_command:
commands:
- display version
- display device
provider: "{{ cli }}"
- name: "Run multiple commands and evaluate the output"
ce_command:
commands:
- display version
- display device
wait_for:
- result[0] contains HUAWEI
- result[1] contains Device
provider: "{{ cli }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | ошибка | невыполненные условия Пример: ['...', '...'] |
| stdout список | всегда | набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда | Значение stdout разделено на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости нет.
Автор
- JackyGao2016 (@CloudEngine-Ansible)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/ce_command_module.html