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

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в плейбуке, укажите: community.network.ce_command.

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

Краткое описание

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

Псевдонимы: network.cloudengine.ce_command

Параметры

Параметр	Комментарии
commands строка / обязательно	Команды для отправки на удаленное устройство HUAWEI CloudEngine через настроенный провайдер. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не будет превышено число повторных попыток.
interval строка	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанному условию, интервал указывает, как долго ждать перед повторной попыткой выполнения команды. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть выполнено только одно из значений. По умолчанию: `"all"`
retries строка	Указывает количество повторных попыток выполнения команды, прежде чем она будет считаться неудачной. Команда выполняется на целевом устройстве при каждой повторной попытке и оценивается по условиям wait_for. По умолчанию: `10`
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: false
  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 список / элементы=строка	невыполненные условия Возвращается: failed Пример: `["...", "..."]`
stdout список / элементы=строка	набор ответов от команд Возвращается: всегда Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разделенное на список Возвращается: всегда Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

JackyGao2016 (@CloudEngine-Ansible)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_command_module.html