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

Примечание

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

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

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

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

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

Описание

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

Псевдонимы: network.enos.enos_command

Параметры

Параметр	Комментарии
auth_pass строка	Указывает пароль, который нужно использовать, если требуется ввод привилегированного режима на удаленном устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize булево	Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`. Варианты: `false` ← (по умолчанию) `true`
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.enos_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.enos_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.enos_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/enos_command_module.html