community.network.icx_command – Выполнение произвольных команд на удалённых коммутаторах Ruckus ICX серии 7000
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач, укажите: community.network.icx_command.
Обзор
- Отправляет произвольные команды на узел ICX и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать определённого условия перед возвратом или при достижении таймаута, если условие не выполняется.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands список / элементы=строка / обязательно | Список команд для отправки на удалённое устройство ICX через настроенный поставщик. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращает значение, пока условие не будет выполнено или не истечёт время ожидания. Если отправленная на устройство команда требует ввода с запросом, проверьте все возможные варианты и переходы на новую строку (если запросов несколько), можно передать словарь, содержащий команда, ответ, запрос, проверить все и переход на новую строку. Общими ответами являются 'y' или "\r" (возврат каретки, должен быть в двойных кавычках). См. примеры. | |
| interval целое число | Значение по умолчанию: 1 | Настраивает интервал ожидания в секундах между повторными попытками выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени ждать, прежде чем попробовать выполнить команду снова. |
| match строка |
| Аргумент match используется совместно с аргументом wait_for для задания политики соответствия. Допустимые значения: all или any. Если значение установлено на all, все условия в wait_for должны быть выполнены. Если значение установлено на any, достаточно, чтобы было выполнено лишь одно из условий. |
| retries целое число | Значение по умолчанию: 10 | Определяет количество попыток выполнения команды, после чего она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. |
| wait_for список / элементы=строка | Список условий для оценки по результатам выполнения команды. Задача будет ждать выполнения каждого условия перед продолжением. Если условие не выполнится в течение заданного количества попыток, задача завершится неудачей. См. примеры. псевдонимы: waitfor |
Примечания
Примечание
- Проверено на ICX 10.1
Примеры
tasks:
- name: Run show version on remote devices
community.network.icx_command:
commands: show version
- name: Run show version and check to see if output contains ICX
community.network.icx_command:
commands: show version
wait_for: result[0] contains ICX
- name: Run multiple commands on remote nodes
community.network.icx_command:
commands:
- show version
- show interfaces
- name: Run multiple commands and evaluate the output
community.network.icx_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains ICX
- result[1] contains GigabitEthernet1/1/1
- name: Run commands that require answering a prompt
community.network.icx_command:
commands:
- command: 'service password-encryption sha1'
prompt: 'Warning: Moving to higher password-encryption type,.*'
answer: 'y'
- name: Run commands that require answering multiple prompt
community.network.icx_command:
commands:
- command: 'username qqq password qqq'
prompt:
- 'User already exists. Do you want to modify:.*'
- 'To modify or remove user, enter current password:'
answer:
- 'y'
- 'qqq\
'
check_all: True
newline: False
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список / элементы=строка | неудачно | Список условий, которые не были выполнены Пример: ['...', '...'] |
| stdout список / элементы=строка | всегда, кроме ошибок низкого уровня | Набор ответов на команды Пример: ['...', '...'] |
| stdout_lines список / элементы=строка | всегда, кроме ошибок низкого уровня | Значение stdout, разделённое на список Пример: [['...', '...'], ['...'], ['...']] |
Авторы
- Ruckus Wireless (@Commscope)
© 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/community/network/icx_command_module.html