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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно параметру before, это позволяет разработчику плейбука добавить набор команд, которые должны быть выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением любых изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создается.
backup_options словарь добавлено в версии 2.8			Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра читается только при `backup` равно yes. Если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться файл резервной копии конфигурации. Если каталог не существует, он будет сначала создан, а имя файла будет либо значением `filename`, либо именем по умолчанию, как описано в `filename` описание параметров. Если значение пути не указано, в этом случае будет создан каталог backup в текущей рабочей директории, и резервная копия конфигурации будет скопирована в `filename` внутри каталога backup.
	filename -		Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<current-date>@<current-time>
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 словарь			Объект типа 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 изменения конфигурации объединяются с текущей конфигурацией устройства. При установке аргумента в 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.9/modules/dellos6_config_module.html