enos_config — Управление секциями конфигурации Lenovo ENOS

Новое в версии 2.5.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Конфигурации Lenovo ENOS используют простой синтаксис блочных отступов для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ENOS детерминированным способом.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin bool		Варианты: no ← yes	Переход в административный режим конфигурации для внесения изменений в конфигурацию устройства.
after			Упорядоченный набор команд, которые добавляются в конец стека команд, если необходимо внести изменения. Аналогично параметру before, это позволяет разработчику конфигурационного сценария добавить набор команд, которые будут выполняться после набора команд.
auth_pass			Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize bool		Варианты: no ← yes	Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
backup bool		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневой директории сценария. Если папка не существует, она создаётся.
before			Упорядоченный набор команд, которые будут добавлены в стек команд, если необходимо внести изменения. Это позволяет разработчику конфигурационного сценария выполнить команды конфигурации перед добавлением каких-либо изменений, не влияя на соответствие набора команд системе.
comment		Значение по умолчанию: "configured by enos_config"	Разрешает указать описание коммита, которое будет включено при фиксации конфигурации. Если конфигурация не изменена или не зафиксирована, этот аргумент игнорируется.
config			По умолчанию модуль подключается к удалённому устройству и извлекает текущую running-конфигурацию для использования в качестве базы сравнения с содержимым source. Бывают случаи, когда нежелательно, чтобы задача извлекала текущую running-конфигурацию для каждой задачи в сценарии. Аргумент config позволяет реализатору указать конфигурацию для использования в качестве базовой конфигурации для сравнения.
lines			Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть идентичными командам, найденным в running-конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически модифицируются анализатором конфигурации устройства. псевдонимы: commands
match		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match равен line, команды сопоставляются построчно. Если match равен strict, строки команд сопоставляются с учётом позиции. Если match равен exact, строки команд должны быть точным соответствием. Наконец, если match равен none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents			Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами.
provider			Объект типа dict, содержащий данные подключения.
	host обязательный		Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: 22	Указывает порт для построения подключения к удалённому устройству.
	username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	authorize bool	Варианты: no ← yes	Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
replace		Варианты: line ← block config	Указывает модулю способ выполнения конфигурации на устройстве. Если replace равен line, изменённые строки отправляются на устройство в режиме конфигурации. Если replace равен block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна.
src			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневой директории сценария или роли. Этот аргумент несовместим с lines и parents.

Примечания

Примечание

Тестировалось на ENOS 8.4.1.2

Примеры

- name: configure top level configuration
  enos_config:
    "lines: hostname {{ inventory_hostname }}"

- name: configure interface settings
  enos_config:
    lines:
      - enable
      - ip ospf enable
    parents: interface ip 13

- name: load a config from disk and replace the current config
  enos_config:
    src: config.cfg
    backup: yes

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

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup равно yes	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/enos01.2016-07-16@22:28:34
updates список	только при указании lines	Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...']

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в Поддержка и сопровождение модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/enos_config_module.html