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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется внести изменения. Как и в случае с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создаётся.
backup_options dictionary добавлен в 2.8			Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только тогда, когда `backup` установлено в yes, если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path path		Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет сначала создана, и имя файла будет либо значением `filename`, либо именем по умолчанию, как описано в `filename` описании параметров. Если значение пути не указано, в этом случае будет создана директория backup в текущем рабочем каталоге, и резервная копия конфигурации будет скопирована в `filename` внутри директории backup.
	filename -		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before -			Упорядоченный набор команд, которые нужно поместить в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить конфигурационные команды перед внесением каких-либо изменений, не затрагивая способ сопоставления набора команд с системой.
config -			Модуль по умолчанию подключается к удалённому устройству и извлекает текущую running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в плейбуке. Параметр config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в текущей running-config устройства. Обратите внимание на синтаксис конфигурационных команд, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот параметр взаимоисключающий с src. алиасы: commands
match -		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются построчно. Если match установлен в strict, строки команд сопоставляются с учётом позиции. Если match установлен в exact, строки команд должны быть точным совпадением. Наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents -			Упорядоченный набор родителей, которые уникально идентифицируют раздел или иерархию, с которой должны сравниваться команды. Если параметр parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider dictionary			Объект типа dict, содержащий данные соединения.
	host string / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола.
	password string		Пароль для аутентификации сессии SSH с удалённым устройством. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port integer	По умолчанию: 22	Указывает порт, используемый при построении подключения к удалённому устройству.
	ssh_keyfile path		Путь к ключу ssh, используемому для аутентификации сессии SSH с удалённым устройством. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer	По умолчанию: 10	Указывает тайм-аут бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
	username string		Пользователь для аутентификации сессии 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

- dellos6_config:
    lines: ['hostname {{ inventory_hostname }}']
    backup: yes
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

Значения возврата

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup равно yes	Полный путь к резервной копии файла Пример: /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.8/modules/dellos6_config_module.html