enos_config – Управление разделами конфигурации Lenovo ENOS

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

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

- 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. [сообщество]

Авторы

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.7/modules/enos_config_module.html