Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

ПараметрВарианты/По умолчаниюКомментарий

after

-


Набор Упорядоченный набор команд, который будет добавлен в конец списка команд, отправляемых на устройство, если необходимо внести изменения. Данный параметр позволяет выполнить команды после основного набора команд, отправляемого на устройствокоторые необходимо выполнить на устройстве после выполнения команд в списке lines. Данные команды будут выполнены только если должны быть внесены изменения, при этом они будут выполнены в независимости от того, есть ли они в текущей конфигурации.

apply_when

-

Варианты:

  • always
  • modified 
  • never
Данный параметр управляет отправкой команды commit на устройство. Если параметр установлен в always, то команда commit отправится на устройство в независимости от необходимости внесения изменений. Если параметр установлен в modified, то команда commit отправится на устройство только в том случае, если текущая конфигурация устройства отличается от требуемойисходной. Если параметр установлен в never, то команда commit не будет отправлена на устройство. Если команда commit была отправлена на устройство, то будет активирован таймер (по умолчанию 600 секунд), по истечению которого на устройстве будет произведён автоматический откат на действующую ранее конфигурацию. Для остановки этого таймера и применения внесённых изменений необходимо использовать параметр save_when.

backup

boolean

Варианты:

  • True
  • False 
Данный параметр даёт указание модулю получить полный бэкап текущей конфигурации с устройства, прежде чем какие-либо изменения будут произведены. Файл бэкапа будет сохранён в каталоге backup в корневой директории плейбука. Если каталог отсутствует, то он будет создан.

before

-


Упорядоченный набор команд, которые необходимо выполнить на устройстве до выполнения команд в списке lines. Данные команды будут выполнены только если должны быть внесены изменения, при этом они будут выполнены в независимости от того, есть ли они в текущей конфигурации.

lines

-


Упорядоченный набор команд, который необходимо сконфигурировать на устройстве. Для достижения идемпотентности необходимо указывать команды так, как они будут выглядеть в running-config после их обработки парсером устройства.

match

-

Варианты:
  • line 
  • strict
  • exact
  • none
Данный параметр указывает каким образом сравнивать набор команд с текущей конфигурацией устройства. Если параметр установлен в line, то команды сравниваются построчно. Если параметр установлен в strict, то команды сравниваются с учётом позиции. Если параметр установлен в exact, то набор команд должен в точности совпадать с соответствующей секцией в текущей конфигурации устройства. Если параметр установлен в none, то модуль не будет сравнивать команды с текущей конфигурацией устройства.

parents

-


Упорядоченный набор предков, однозначно идентифицирующих раздел или иерархию, по которым должны проверяться команды. Если параметр не указан, то команды будут проверяться с верхнего уровня иерархии.

replace

-

Варианты:

  • line 
  • block
Данный параметр указывает каким образом отправлять команды на устройство. Если параметр установлен в line, то изменённые строки отправляются на устройство. Если параметр установлен в block, то на устройство будет отправлен блок команд, если какая-то строка будет изменена.

save_when

-

Варианты:

  • always
  • applied
  • never 
Данный параметр управляет отправкой команды 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, либо шаблон конфигурации. При использовании данного параметра произойдёт полная замена текущей конфигурации.

use_sftp

boolean

Варианты:

  • True
  • False
Данный параметр даёт указание использовать протокол sftp для отправки конфигурации на устройство при использовании параметра src. Для работы необходимо также указать параметры sftp_user и sftp_password.

...

Примечание
  • Протестировано на версии ПО ESR 1.6.2
  • Для ускорения загрузки конфигурации при использовании параметра src рекомендуется использовать параметр use_sftp.
  • Для использования протокола sftp для загрузки конфигурации необходимо предварительно создать на устройстве пользователя для работы с sftp, указав в настройках этого пользователя ip sftp enable. Данный функционал доступен на ПО ESR версий не ниже 1.6.2
  • Для корректной работы необходима версия Ansible не ниже 2.7.6
  • Сокращённые команды не являются идемпотентными, подробнее смотрите здесь
  • Для подключения к устройству необходимо указать connection: network_cli и ansible_network_os: esr
  • Для получения информации об использовании Ansible для управлении сетевыми устройствами обратитесь к официальному руководству Ansible

...