Spec-Zone.ru › Ansible 2.8

cnos_command – Выполнение произвольных команд на устройствах Lenovo CNOS

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

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

Описание

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

Параметры

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

Примеры

---
- name: test contains operator
  cnos_command:
    commands:
      - show version
      - show system memory
    wait_for:
      - "result[0] contains 'Lenovo'"
      - "result[1] contains 'MemFree'"
  register: result

- assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"

- name: get output for single command
  cnos_command:
    commands: ['show version']
  register: result

- assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"

- name: get output for multiple commands
  cnos_command:
    commands:
      - show version
      - show interface information
  register: result

- assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"
      - "result.stdout | length == 2"

Возвращаемые значения

Общие значения возврата описаны здесь, ниже указаны поля, уникальные для данного модуля:

Ключ Возвращаемое значение Описание
failed_conditions
список
ошибка
условия, которые не были выполнены

Пример:
['...', '...']
stdout
список
всегда
набор ответов от команд

Пример:
['...', '...']
stdout_lines
список
всегда
Значение stdout, разделенное на список

Пример:
[['...', '...'], ['...'], ['...']]


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/cnos_command_module.html

Spec-Zone.ru

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