dellemc.os6.os6_config – Управление разделами конфигурации Dell EMC OS6

Примечание

Этот плагин является частью коллекции dellemc.os6 (версия 1.0.6).

Для его установки используйте: ansible-galaxy collection install dellemc.os6

Для использования в плейбуке укажите: dellemc.os6.os6_config

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after список / элементы=строка			Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Аналогично параметру before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup булево		Варианты: нет ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создается.
backup_options словарь			Это объект словаря, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только при условии, что `backup` установлено в да; если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр указывает путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана; имя файла — либо значение `filename`, либо имя файла по умолчанию, как описано в `filename` описании параметров. Если путь не указан, в текущей рабочей директории будет создана директория backup, и резервная копия конфигурации будет скопирована в `filename` в директории backup.
	filename строка		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before список / элементы=строка			Упорядоченный набор команд, которые будут добавлены в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения изменений, не влияя на сопоставление набора команд с системой.
config строка			Модуль по умолчанию подключается к удаленному устройству и извлекает текущую рабочую конфигурацию для сравнения с содержимым исходного файла. Иногда не нужно получать текущую рабочую конфигурацию для каждой задачи в плейбуке. Параметр config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
lines список / элементы=строка			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть идентичны командам, найденным в рабочей конфигурации устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот аргумент взаимоисключает аргумент src. псевдонимы: команды
match строка		Варианты: строка ← строго точно нет	Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сравниваются построчно. Если match установлено в строго, строки команд сравниваются относительно позиции. Если match установлено в точно, строки команд должны точно совпадать. И наконец, если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удаленном устройстве.
parents список / элементы=строка			Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны сравниваться команды. Если параметр parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider словарь			Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`
	authorize булево	Варианты: нет да	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Пароль для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для подключения к удаленному устройству.
	ssh_keyfile путь		Путь к SSH-ключу, используемому для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает таймаут бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигурации.
	username строка		Пользователь для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`
replace строка		Варианты: строка ← блок	Указывает модулю способ внесения изменений на устройстве. Если replace установлено в строка, измененные строки передаются устройству в режиме конфигурации. Если replace установлено в блок, весь блок команды передается устройству в режиме конфигурации, если какая-либо строка не верна.
save булево		Варианты: нет ← да	Аргумент save указывает модулю сохранить рабочую конфигурацию в конфигурацию по умолчанию по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src путь			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневой директории плейбука или роли. Этот аргумент взаимоисключает аргумент lines.
update строка		Варианты: слияние ← проверка	Параметр update управляет тем, как обрабатываются операторы конфигурации на удаленном устройстве. Допустимые значения для update — слияние и проверка. Когда вы устанавливаете этот параметр в слияние, изменения конфигурации сливаются с текущей рабочей конфигурацией устройства. Когда вы устанавливаете этот параметр в проверка, обновления конфигурации определяются, но фактически не настраиваются на удаленном устройстве.

Примечания

Примечание

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

Примеры

- os6_config:
    lines: ['hostname {{ inventory_hostname }}']
- os6_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
- os6_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
- os6_config:
    lines: ['hostname {{ inventory_hostname }}']
    backup: yes
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Возвращается	Описание
backup_path строка	при backup = да	Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/os6_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']

Авторы

Abirami N (@abirami-n)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/os6/os6_config_module.html