dellos6_config - Управление разделами конфигурации Dell EMC Networking OS6

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after			Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Как и в случае с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup bool		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущего `running-config` с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге плейбука. Если каталог не существует, он создаётся.
before			Упорядоченный набор команд, которые нужно поместить в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой.
config			Модуль по умолчанию подключается к удалённому устройству и получает текущую running-config, чтобы использовать её в качестве основы для сравнения с содержимым source. Бывают случаи, когда нежелательно получать текущую running-config для каждой задачи в плейбуке. Аргумент config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
lines			Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть абсолютно идентичными тем, которые находятся в running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент взаимоисключает src. псевдонимы: команды
match		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются построчно. Если match установлен в strict, строки команд сопоставляются относительно позиции. Если match установлен в exact, строки команд должны быть точным совпадением. Наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents			Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами.
provider			Объект словаря, содержащий сведения о подключении.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: 22	Указывает порт, который следует использовать при построении подключения к удалённому устройству.
	username		Пользователь для аутентификации сессии SSH на удалённом устройстве. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	password		Пароль для аутентификации сессии SSH на удалённом устройстве. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	ssh_keyfile		Путь к файлу SSH-ключа, используемому для аутентификации сессии SSH на удалённом устройстве. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	Значение по умолчанию: 10	Устанавливает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
replace		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, то изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в block, то весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка неверна.
save bool		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня плейбука или роли. Этот аргумент взаимоисключает lines.
update		Варианты: merge ← check	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые значения для аргумента update — merge и check. При установке этого аргумента в merge изменения конфигурации объединяются с текущей конфигурацией running устройства. При установке этого аргумента в check изменения конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.

Примеры

- dellos6_config:
    lines: ['hostname {{ inventory_hostname }}']

- dellos6_config:
    lines:
      - 10 permit ip 1.1.1.1 any log
      - 20 permit ip 2.2.2.2 any log
      - 30 permit ip 3.3.3.3 any log
      - 40 permit ip 4.4.4.4 any log
      - 50 permit ip  5.5.5.5 any log
    parents: ['ip access-list test']
    before: ['no ip access-list test']
    match: exact

- dellos6_config:
    lines:
      - 10 permit ip 1.1.1.1 any log
      - 20 permit ip 2.2.2.2 any log
      - 30 permit ip 3.3.3.3 any log
      - 40 permit ip 4.4.4.4 any log
    parents: ['ip access-list test']
    before: ['no ip access-list test']
    replace: block

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

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = yes	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34
commands список	всегда	Набор команд, которые будут переданы на удалённое устройство Пример: ['interface Te1/0/1', 'no shutdown', 'exit']
saved bool	Когда не check_mode.	Возвращает, сохранена ли конфигурация в конфигурацию startup или нет. Пример: True
updates список	всегда	Набор команд, которые будут переданы на удалённое устройство. Пример: ['interface Te1/0/1', 'no shutdown', 'exit']

Статус

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

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

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

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

Автор

Abirami N(@abirami-n)

Подсказка

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

© 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/dellos6_config_module.html