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

Примечание

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

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

Для использования в книге задач укажите: community.network.cnos_command.

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

Описание

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

Параметры

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

Примеры

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

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

- name: Get output for single command
  community.network.cnos_command:
    commands: ['show version']
  register: result

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

- name: Get output for multiple commands
  community.network.cnos_command:
    commands:
      - show version
      - show interface information
  register: result

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

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

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

Ключ	Возвращаемое значение	Описание
failed_conditions список / элементы=строка	неуспешно	условия, которые не были выполнены Пример: ['...', '...']
stdout список / элементы=строка	всегда	набор ответов от команд Пример: ['...', '...']
stdout_lines список / элементы=строка	всегда	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Авторы

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.10/collections/community/network/cnos_command_module.html