dellos6_config – Управление секциями конфигурации Dell EMC Networking OS6

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Аналогично параметру before, это позволяет разработчику плейбука добавить набор команд, которые должны быть выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге плейбука. Если папка не существует, она создается.
before -			Упорядоченный набор команд для помещения в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения любых изменений, не влияя на способ сопоставления набора команд с системой.
config -			Модуль по умолчанию подключается к удаленному устройству и получает текущую running-config в качестве основы для сравнения с содержимым source. Иногда нежелательно получать текущую running-config для каждой задачи в плейбуке. Аргумент config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
lines -			Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть идентичны командам, найденным в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот аргумент несовместим с аргументом src. псевдонимы: commands
match -		Варианты: line ← strict exact none	Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сравниваются построчно. Если match установлен на strict, строки команд сравниваются относительно позиции. Если match установлен на exact, строки команд должны быть точным соответствием. И, наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве.
parents -			Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider -			Объект типа dict, содержащий данные подключения.
	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 -		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен на line, измененные строки отправляются устройству в режиме конфигурации. Если аргумент replace установлен на block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save boolean		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src -			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога плейбука или роли. Этот аргумент несовместим с аргументом lines.
update -		Варианты: merge ← check	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удаленном устройстве. Допустимые значения для аргумента update — merge и check. При установке этого аргумента на merge, изменения конфигурации объединяются с текущей running-config устройства. При установке этого аргумента на 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 = да	Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34
commands список	всегда	Набор команд, которые будут отправлены на удалённое устройство Пример: ['interface Te1/0/1', 'no shutdown', 'exit']
saved логическое значение	Когда не используется режим check_mode.	Возвращает, сохранена ли конфигурация в стартовую конфигурацию или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удалённое устройство. Пример: ['interface Te1/0/1', 'no shutdown', 'exit']

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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