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

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

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

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль поддерживается на ansible_network_os платформах сетей. См. Параметры платформы сети для получения подробных сведений.

Примеры

- 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 ответ Пример: { "architecture": "i386", "bootupTimestamp": 1532649700.56, "modelName": "vEOS", "version": "4.15.9M" [...] }
stdout строка	если sendonly равен false	Ответ на команду Пример: Версия: VyOS 1.1.7[...]

Статус

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

Поддержка 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.8/modules/cli_command_module.html