...
| Предупреждение |
|---|
Предупреждения информируют пользователя о ситуациях, которые могут нанести вред программно-аппаратному комплексу, привести к некорректной работе системы или потере данных. |
Коллекция Ansible для маршрутизаторов ESR включает в себя модули, позволяющие автоматизировать управление сетевыми устройствами Eltex ESR.
| Примечание |
|---|
Для получения информации об использовании Ansible для управлении сетевыми устройствами обратитесь к официальному руководству Ansible |
...
| Предупреждение |
|---|
Для корректной работы модулей требуется версия python >= 3.11 |
Ссылка на архивна PlayBook:
| View file | ||||
|---|---|---|---|---|
|
| Блок кода | ||||
|---|---|---|---|---|
| ||||
Установка зависимостей: (venv)user@user:~/eltex/esr/ansible-playbooks$ pip install -r requirements.txt Установка коллекции: (venv)user@user:~/eltex/esr/ansible-playbooks$ cd eltex.esr (venv)user@user:~/eltex/esr/ansible-playbooks/eltex.esr$ ansible-galaxy collection build --force . Created collection for eltex.esr at /home/user/eltex/esr/ansible-playbooks/eltex.esr/eltex-esr-2.1.0.tar.gz (venv)user@user:~/eltex/esr/ansible-playbooks/eltex.esr$ ansible-galaxy collection install --force eltex-esr-2.1.0.tar.gz После установки удаляем артефакты: (venv)user@user:~/eltex/esr/ansible-playbooks/eltex.esr$ rm eltex-esr-2.1.0.tar.gz |
...
Данный модуль отправляет произвольные команды на маршрутизатор ESR и возвращает результаты, полученные с устройства.
Параметры
Параметр | Варианты/По умолчанию | Комментарий |
|---|---|---|
commands - / required | Список команд для отправки на удалённый маршрутизатор ESR. Возвращается вывод команд. Если отправляемая команда ожидает ответа на вопрос, то возможно отправить словарь, содержащий command, answer и prompt. Обычные ответы: 'y', 'n'. Смотрите примеры. | |
interval | По умолчанию: 1 | Данный параметр определяет интервал в секундах для ожидания между повторными попытками выполнения команды. Если вывод команды не удовлетворяет заданным условиям, интервал указывает время ожидания перед повторной отправкой команды. |
| match | Варианты:
| Данный параметр используется вместе с параметром wait_for для указания политики соответствия. Допустимые значения - all или any. Если установлено значение all, то все условия в wait_for должны быть выполнены. Если установлено значение any, то выполнится должно только одно из условий. |
| retries | По умолчанию: 10 | Количество попыток отправки команд, прежде чем она будет считаться неудачной. Команда запускается на удалённом устройстве при каждой попытке и её вывод сравнивается с условиями wait_for. |
| wait_for | Список условий для сравнения с выводом команды. Задача будет ожидать выполнения каждого условия, прежде чем продолжить. Если вывод команды не соответствует условиям в течение настроенного числа попыток, то задача завершится с ошибкой. Смотрите примеры. |
Возвращаемые значения
В общем случае возвращаемые значения описаны здесь. Ниже перечислены уникальные для модуля значения:
Значение | Описание |
|---|---|
stdout list | Набор ответов, полученных с устройства после выполнение команд Пример: ['...', '...'] |
stdout_lines list | Значение stdout в виде списка Пример: [['...', '...'], ['...'], ['...']] |
Примеры использования модуля в плейбуках
...
Данный модуль позволяет управлять как отдельными частями конфигурации, так и загружать файл конфигурации целиком.
Параметры
| Параметр | Варианты/По умолчанию | Комментарий | ||||
|---|---|---|---|---|---|---|
after - | Упорядоченный набор команд, которые необходимо выполнить на устройстве после выполнения команд в списке lines. Данные команды будут выполнены только если должны быть внесены изменения, при этом они будут выполнены в независимости от того, есть ли они в текущей конфигурации. | |||||
apply_when - | Варианты:
| Данный параметр управляет отправкой команды commit на устройство. Если параметр установлен в always, то команда commit отправится на устройство в независимости от необходимости внесения изменений. Если параметр установлен в modified, то команда commit отправится на устройство только в том случае, если текущая конфигурация устройства отличается от исходной. Если параметр установлен в never, то команда commit не будет отправлена на устройство. Если команда commit была отправлена на устройство, то будет активирован таймер (по умолчанию 600 секунд), по истечению которого на устройстве будет произведён автоматический откат на действующую ранее конфигурацию. Для остановки этого таймера и применения внесённых изменений необходимо использовать параметр save_when. | ||||
backup boolean | Варианты:
| Данный параметр даёт указание модулю получить полный бэкап текущей конфигурации с устройства, прежде чем какие-либо изменения будут произведены. Файл бэкапа будет сохранён в каталоге backup в корневой директории плейбука. Если каталог отсутствует, то он будет создан. | ||||
before - | Упорядоченный набор команд, которые необходимо выполнить на устройстве до выполнения команд в списке lines. Данные команды будут выполнены только если должны быть внесены изменения, при этом они будут выполнены в независимости от того, есть ли они в текущей конфигурации. | |||||
lines - | Упорядоченный набор команд, который необходимо сконфигурировать на устройстве. Для достижения идемпотентности необходимо указывать команды так, как они будут выглядеть в running-config после их обработки парсером устройства. псевдоним: commands | |||||
match - | Варианты:
| Данный параметр указывает каким образом сравнивать набор команд с текущей конфигурацией устройства. Если параметр установлен в line, то команды сравниваются построчно. Если параметр установлен в strict, то команды сравниваются с учётом позиции. Если параметр установлен в exact, то набор команд должен в точности совпадать с соответствующей секцией в текущей конфигурации устройства. Если параметр установлен в none, то модуль не будет сравнивать команды с текущей конфигурацией устройства. | ||||
merge boolean | Варианты:
| Данный параметр включает объединение загруженной конфигурации с candidate-config, текущие параметры будут обновлены, новые параметры будут добавлены. Команда поддержана начиная с версии ПО ESR 1.11.2. | ||||
parents - | Упорядоченный набор предков, однозначно идентифицирующих раздел или иерархию, по которым должны проверяться команды. Если параметр не указан, то команды будут проверяться с верхнего уровня иерархии. | |||||
replace - | Варианты:
| Данный параметр указывает каким образом отправлять команды на устройство. Если параметр установлен в line, то изменённые строки отправляются на устройство. Если параметр установлен в block, то на устройство будет отправлен блок команд, если какая-то строка будет изменена. | ||||
rollback - | Варианты:
| Данный параметр управляет отправкой команды rollback на устройство. Если параметр установлен в true, то модуль отправит команду rollback перед тем, как внести изменения. Если параметр установлен в false, то команда rollback не будет отправлена на устройство. | ||||
save_when - | Варианты:
| Данный параметр управляет отправкой команды confirm на устройство. Если параметр установлен в always, то команда confirm отправится в независимости от применённых изменений. Если параметр установлен в applied, то команда confirm будет отправлена только в том случае, если на устройстве были применены какие-то изменения в соответствии с параметром apply_when. Если параметр установлен в never, то команда confirm не будет отправлена на устройство и по истечению заданного времени (по умолчанию 600 секунд) устройство произведёт автоматический откат на действующую ранее конфигурацию. | ||||
sftp_user - | Данный параметр указывает имя пользователя, с которым необходимо подключиться к устройству по протоколу sftp. Игнорируется, если параметр use_sftp установлен в false. | |||||
sftp_password - | Данный параметр указывает пароль, с которым необходимо подключиться к устройству по протоколу sftp с использованием имени пользователя, указанного в параметре sftp_user. Игнорируется, если параметр use_sftp установлен в false. | |||||
src - | - | В данном параметре указывается путь к файлу, содержащему конфигурацию маршрутизатора ESR, либо шаблон конфигурации. При использовании данного параметра произойдёт полная замена текущей конфигурации. Если параметр merge будет уставлен в true, то загружаемая конфигурация будет объединена с candidate-config.
| ||||
use_sftp boolean | Варианты:
| Данный параметр даёт указание использовать протокол sftp для отправки конфигурации на устройство при использовании параметра src. Для работы необходимо также указать параметры sftp_user и sftp_password. |
Возвращаемые значения
В общем случае возвращаемые значения описаны здесь. Ниже перечислены уникальные для модуля значения:
| Значение | Условие | Описание |
|---|---|---|
changed bool | всегда | Идентификатор внесённых изменений Пример: true |
backup_path string | когда параметр backup установлен в true | Полный путь к файлу бэкапа Пример: /ansible/playbooks/backup/esr-1000-config.2019-02-19@11:10:06 |
commands list | когда параметр changed имеет значение true | Набор команд, которые будут отправлены на устройство Пример: ['hostname esr-1000', 'ip ssh server', 'ip telnet server'] |
updates list | когда параметр changed имеет значение true | Набор команд, которые будут отправлены на устройство Пример: ['hostname esr-1000', 'ip ssh server', 'ip telnet server'] |
Примеры использования модуля в плейбуках
...