cli_command – Выполнение командной строки на устройствах сети с командной строкой

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
answer список		Ответ, который нужно отправить, если совпадает prompt. Значение может быть одним ответом или списком ответов для нескольких запросов. В случае, если выполнение команды приводит к нескольким запросам, последовательность запроса и ожидаемого ответа должна быть в том же порядке.
check_all логическое значение	Варианты: нет ← да	По умолчанию, если любой из запросов, указанных в параметре `prompt`, совпадает, проверка других запросов не выполняется. Этот флаг логического типа, который при установке в значение True проверит все запросы, указанные в параметре `prompt`, в заданном порядке. Если параметр установлен в значение True, все запросы должны быть получены от удалённого хоста, в противном случае это приведёт к таймауту.
command - / обязательно		Команда, которая будет отправлена удалённому сетевому устройству. Результат вывода команды возвращается, если sendonly не установлен.
prompt список		Один шаблон регулярного выражения или последовательность шаблонов для оценки ожидаемого запроса из command.
sendonly логическое значение	Варианты: нет ← да	Логическое значение, которое, при установке в значение true, отправит command на устройство, но не будет ожидать результата.

Примеры

- name: run show version on remote devices
  cli_command:
    command: show version

- name: run command with json formatted output
  cli_command:
    command: show version | json

- name: run command expecting user confirmation
  cli_command:
    command: commit replace
    prompt: This commit will replace or remove the entire running configuration
    answer: yes

- name: run config mode command and handle prompt/answer
  cli_command:
    command: "{{ item }}"
    prompt:
      - "Exit with uncommitted changes"
    answer: 'y'
  loop:
    - configure
    - set system syslog file test any any
    - exit

- name: multiple prompt, multiple answer (mandatory check for all prompts)
  cli_command:
    command: "copy sftp sftp://user@host//user/test.img"
    check_all: True
    prompt:
      - "Confirm download operation"
      - "Password"
      - "Do you want to change that to the standby image"
    answer:
      - 'y'
      - <password>
      - 'y'

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

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

Ключ	Возвращаемое значение	Описание
json словарь	когда ответ устройства — это корректный JSON	Словарь, представляющий JSON-форматированный ответ Пример: { "архитектура": "i386", "время_запуска": 1532649700.56, "модель": "vEOS", "версия": "4.15.9M" [...] }
stdout строка	когда sendonly — false	Ответ от команды Пример: Версия: VyOS 1.1.7[...]

Статус

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

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

Nathaniel Case (@qalthos)

Подсказка

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

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