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

Примечание

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

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

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

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

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

Описание

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

Псевдонимы: network.cnos.cnos_command

Параметры

Параметр	Комментарии
commands строка / обязательно	Список команд для отправки на удалённое устройство. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт число попыток.
interval строка	Настраивает интервал ожидания в секундах между повторами команды. Если команда не удовлетворяет указанным условиям, интервал указывает время ожидания перед повторной попыткой выполнения команды. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено на `all`, то все условия в wait_for должны быть выполнены. Если значение установлено на `any`, то должно быть выполнено только одно из значений. Варианты: `"any"` `"all"` ← (по умолчанию)
retries строка	Указывает количество повторов команды, которое должно быть выполнено, прежде чем она будет считаться неудачной. Команда выполняется на целевом устройстве при каждом повторе и оценивается по условиям wait_for. По умолчанию: `10`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/cnos_command_module.html