ce_command – Выполнение произвольной команды на устройствах HUAWEI CloudEngine

Новая версия с 2.3.

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

Описание

Отправляет произвольную команду узлу HUAWEI CloudEngine и возвращает результаты, считанные с устройства. Модуль ce_command включает аргумент, который заставит модуль ожидать выполнения определённого условия до возврата или таймаута, если условие не выполнено.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands - / обязательно		Команды, которые отправляются удалённому устройству HUAWEI CloudEngine через настроенный поставщик. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль не возвращает значение до тех пор, пока условие не будет выполнено или не будет превышено количество retries.
interval -	Значение по умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанному условию, интервал указывает, сколько времени ждать перед повторной попыткой выполнения команды.
match -	Значение по умолчанию: "all"	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all`, или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, достаточно выполнения одного из условий.
retries -	Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед тем, как она будет считаться неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for -		Указывает, что следует оценить из вывода команды и какие условия применить. Этот аргумент заставит задачу ожидать выполнения определённого условия до продолжения работы. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры.

Примечания

Примечание

Рекомендуемое подключение — network_cli.
Этот модуль также работает с подключениями local для устаревших playbooks.

Примеры

# 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.8/modules/ce_command_module.html