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

Примечание

Этот плагин входит в коллекцию cisco.ios (версия 1.2.1).

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

Для использования в плейбуке укажите: cisco.ios.ios_command.

Новое в версии 1.0.0: плагина cisco.ios

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

Описание

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

Примечание

Данный модуль имеет соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands список / элементы=сырые / обязательный			Список команд для отправки на удалённое устройство IOS через указанный поставщик. На выходе возвращаются результаты выполнения команды. Если указан аргумент wait_for, модуль не вернётся до тех пор, пока условие не будет выполнено или не истечёт время ожидания. Если команда, отправленная устройству, требует ответа на приглашение, можно передать словарь, содержащий команду, ответ и приглашение. Общими ответами являются 'y' или "\r" (возврат каретки, в двойных кавычках). См. примеры.
interval целое число		По умолчанию: 1	Устанавливает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед следующей попыткой.
match строка		Варианты: any all ←	Аргумент 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 булево	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для создания подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	username строка		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
retries целое число		По умолчанию: 10	Определяет количество попыток выполнения команды перед тем, как считать её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for список / элементы=строка			Список условий для проверки по отношению к выводу команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем перейти к следующему этапу. Если условие не станет истинным в течение заданного количества попыток, задача завершается неудачей. См. примеры. псевдонимы: waitfor

Примечания

Примечание

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

Примеры

- name: run show version on remote devices
  cisco.ios.ios_command:
    commands: show version

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

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

- name: run multiple commands and evaluate the output
  cisco.ios.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
  cisco.ios.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: '
'

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

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

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

Авторы

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.10/collections/cisco/ios/ios_command_module.html