cisco.ios.ios_command – Выполнение команд на удалённых устройствах с Cisco IOS
Примечание
Этот плагин входит в состав коллекции cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Чтобы использовать его в книге задач, укажите: cisco.ios.ios_command.
Новое в версии 1.0.0: модуля cisco.ios
Обзор
- Отправляет произвольные команды на узел IOS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать выполнения определённого условия перед возвратом или таймаутом, если условие не выполнено.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств IOS используйте ios_config.
Примечание
Этот модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands список / элементы=необработанный / обязательно | Список команд для отправки на удалённое устройство IOS через настроенный поставщик. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания. Если для команды, отправленной на устройство, требуется ответ на запрос, можно передать словарь, содержащий command, answer и prompt. Общие ответы – 'y' или "\r" (возврат каретки, в двойных кавычках). См. примеры. | ||
| interval целое число | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не выполняет указанные условия, интервал определяет время ожидания перед новой попыткой. | |
| match строка |
| Аргумент 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_command_module.html
