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 - | Указывает, что следует оценивать из результата команды и какие условия применять. Этот аргумент заставит задачу ждать, пока определённое условие не станет истинным, прежде чем продолжить. Если условие не становится истинным в течение заданного количества попыток, задача завершается неудачей. См. примеры. |
Примеры
# 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, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Интерфейс этого модуля не гарантируется как обратный совместимый. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/ce_command_module.html