dellos10_config - Управление секциями конфигурации Dell EMC Networking OS10

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after		По умолчанию: None	Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Также, как и с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущего `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если папка не существует, она создается.
before		По умолчанию: None	Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения любых изменений без влияния на сопоставление набора команд с системой.
config		По умолчанию: None	Модуль по умолчанию подключается к удаленному устройству и извлекает текущую рабочую конфигурацию (running-config), чтобы использовать ее в качестве основы для сравнения с содержимым source. Иногда нежелательно получать текущую рабочую конфигурацию для каждой задачи в playbook. Аргумент config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
lines		По умолчанию: None	Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть точно такими же, как и в рабочей конфигурации (running-config) устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент взаимоисключает src. псевдонимы: commands
match		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются построчно. Если match установлен на strict, строки команд сопоставляются с учетом позиции. Если match установлен на exact, строки команд должны быть тождественными. Наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией удаленного устройства.
parents		По умолчанию: None	Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию или иерархию, с которой следует проверять команды. Если аргумент parents опущен, команды проверяются относительно набора команд верхнего уровня или глобальных команд.
provider		По умолчанию: None	Объект типа dict, содержащий данные подключения.
	username		Пользователь для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве целевого адреса для протокола.
	ssh_keyfile		Путь к файлу ssh-ключа, используемого для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	По умолчанию: 10	Устанавливает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигураций.
	password	По умолчанию: None	Пароль для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port	По умолчанию: 22	Указывает порт для подключения к удаленному устройству.
replace		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если replace установлен на line, измененные строки отправляются на устройство в режиме конфигурации. Если replace установлен на block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save		Варианты: yes no ←	Аргумент `save` инструктирует модуль сохранить рабочую конфигурацию (running-config) в стартовую конфигурацию (startup-config) по завершении работы модуля. Если указан режим проверки (check mode), этот аргумент игнорируется.
src		По умолчанию: None	Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент взаимоисключает 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 логическое значение	при отсутствии check_mode.	Возвращает, сохранена ли конфигурация в стартовой конфигурации или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удаленное устройство. Пример: ['hostname foo', 'router bgp 1', 'router-id 1.1.1.1']

Статус

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

Автор

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