dellos10_config — Управление разделами конфигурации Dell EMC Networking OS10

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after			Упорядоченный набор команд, добавляемых в конец стека команд, если требуется изменение. Аналогично before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup bool		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге плейбука. Если папка не существует, она будет создана.
before			Упорядоченный набор команд, помещаемых в стек команд, если требуется изменение. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением любых изменений, не влияя на способ сопоставления набора команд с системой.
config			По умолчанию модуль подключается к удаленному устройству и извлекает текущую рабочую конфигурацию (running-config), чтобы использовать ее в качестве основы для сравнения с содержимым source. Иногда нежелательно получать текущую рабочую конфигурацию для каждой задачи в плейбуке. Аргумент 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 по окончании работы модуля. Если указан режим проверки (check mode), этот аргумент игнорируется.
src			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня плейбука или роли. Этот аргумент несовместим с lines.
update		Варианты: merge ← check	Аргумент update управляет обработкой заявлений конфигурации на удаленном устройстве. Допустимые значения аргумента update — merge и check. При установке аргумента в merge изменения конфигурации сливаются с текущей рабочей конфигурацией устройства. При установке в check изменения конфигурации определяются, но фактически не настраиваются на удаленном устройстве.

Примечания

Примечание

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

Примеры

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

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

- dellos10_config:
    lines:
      - 10 permit ip host 1.1.1.1 any log
      - 20 permit ip host 2.2.2.2 any log
      - 30 permit ip host 3.3.3.3 any log
      - 40 permit ip host 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/dellos10_config.2016-07-16@22:28:34
commands список	всегда	Набор команд, которые будут отправлены на удаленное устройство Пример: ['hostname foo', 'router bgp 1', 'router-id 1.1.1.1']
saved bool	Если не check_mode.	Возвращает, сохранена ли конфигурация в стартовой конфигурации (startup-config) или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удаленное устройство. Пример: ['hostname foo', 'router bgp 1', 'router-id 1.1.1.1']

Статус

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

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

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

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

Автор

Senthil Kumar Ganesan (@skg-net)

Подсказка

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

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