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

Примечание

Этот плагин входит в состав коллекции community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.ce_command.

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

Описание

Отправляет произвольную команду на узел 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 строка		Указывает, что должно быть проанализировано из вывода команды и какие условия должны быть применены. Этот аргумент заставит задачу ожидать выполнения определённого условия, прежде чем перейти дальше. Если условие не выполняется в течение настроенного количества попыток, задача завершается неудачей. См. примеры.

Примечания

Примечание

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

Примеры

# 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"
    community.network.ce_command:
      commands: display version
      provider: "{{ cli }}"

  - name: "Run display version and check to see if output contains HUAWEI"
    community.network.ce_command:
      commands: display version
      wait_for: result[0] contains HUAWEI
      provider: "{{ cli }}"

  - name: "Run multiple commands on remote nodes"
    community.network.ce_command:
      commands:
        - display version
        - display device
      provider: "{{ cli }}"

  - name: "Run multiple commands and evaluate the output"
    community.network.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ce_command_module.html