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

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

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

Краткое описание

Отправляет произвольные команды на узел IOS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать определённого условия перед возвратом или таймаутом, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте ios_config для конфигурации устройств IOS.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_pass -			Устаревший Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize boolean		Варианты: нет ← да	Устаревший Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
commands - / обязательно			Список команд для отправки на удалённое устройство IOS через заданный поставщик. Результирующий вывод команды возвращается. Если аргумент wait_for задан, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания. Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. Обычные ответы — 'y' или "\r" (возврат каретки, должен быть в двойных кавычках). Смотрите примеры.
interval -		Значение по умолчанию: 1	Настраивает интервал в секундах ожидания между попытками повторного выполнения команды. Если команда не соответствует заданным условиям, интервал указывает, сколько времени подождать перед повторной попыткой.
match - добавлен в 2.2		Варианты: любое все ←	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть выполнено только одно из условий.
provider -			Устаревший Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass -		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port -	Значение по умолчанию: 22	Указывает порт для подключения к удалённому устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
	username -		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
retries -		Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой повторной попытке и оценивается по условиям wait_for.
wait_for - добавлен в 2.2			Список условий для оценки по результатам выполнения команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. псевдонимы: waitfor

Примечания

Примечание

Тестировалось на IOS 15.6
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, обратитесь к Руководству по сетям Ansible
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, обратитесь к странице интеграции Cisco.

Примеры

tasks:
  - name: run show version on remote devices
    ios_command:
      commands: show version

  - name: run show version and check to see if output contains IOS
    ios_command:
      commands: show version
      wait_for: result[0] contains IOS

  - name: run multiple commands on remote nodes
    ios_command:
      commands:
        - show version
        - show interfaces

  - name: run multiple commands and evaluate the output
    ios_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains IOS
        - result[1] contains Loopback0
  - name: run commands that require answering a prompt
    ios_command:
      commands:
        - command: 'clear counters GigabitEthernet0/1'
          prompt: 'Clear "show interface" counters on this interface \[confirm\]'
          answer: 'y'
        - command: 'clear counters GigabitEthernet0/2'
          prompt: '[confirm]'
          answer: "\r"

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

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

Ключ	Возвращаемое значение	Описание
failed_conditions список	неуспешно	Список условных выражений, которые завершились неудачно Пример: ['...', '...']
stdout список	всегда, кроме ошибок низкого уровня (таких как плагин действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда, кроме ошибок низкого уровня (таких как плагин действия)	Значение stdout, разбитое на список Пример: [['...', '...'], ['...'], ['...']]

Статус

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

Поддержка Red Hat

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

Авторы

Peter Sprygada (@privateip)

Подсказка

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

© 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/ios_command_module.html