Spec-Zone.ru › Ansible 2.4

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:

  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 и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API