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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно before, это позволяет разработчику плейбука добавить набор команд, которые должны быть выполнены после набора команд.
backup boolean		Варианты: нет ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создаётся.
backup_options словарь добавлен в 2.8			Это объект словаря, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только тогда, когда `backup` установлено в да; если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана; имя файла — это либо значение `filename`, либо имя по умолчанию, как описано в `filename` описании параметров. Если значение пути не задано, в текущей рабочей директории будет создана директория backup, и резервная копия конфигурации будет скопирована в `filename` внутри директории backup.
	filename -		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before -			Упорядоченный набор команд, которые нужно поместить в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой.
config -			Модуль по умолчанию подключается к удалённому устройству и получает текущую running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую running-config для каждой задачи в плейбуке. Параметр config позволяет реализатору передать конфигурацию, используемую в качестве базовой конфигурации для сравнения.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот параметр несовместим с src. псевдонимы: команды
match -		Варианты: строка ← строго точно ничего	Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match задано как строка, команды сравниваются по строкам. Если match задано как строго, строки команд сравниваются относительно их позиции. Если match задано как точно, строки команд должны точно совпадать. Наконец, если match задано как ничего, модуль не будет пытаться сравнивать исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents -			Упорядоченный набор родителей, уникально идентифицирующих раздел или иерархию, с которой должны проверяться команды. Если аргумент parents опущен, команды проверяются относительно набора команд верхнего уровня или глобальных команд.
provider словарь			Объект словаря, содержащий сведения о подключении.
	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 -		Варианты: строка ← блок	Указывает модулю способ выполнения конфигурации на устройстве. Если replace установлено в строка, изменённые строки передаются устройству в режиме конфигурации. Если replace установлено в блок, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка неверна.
save boolean		Варианты: нет ← да	Аргумент `save` указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src -			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня плейбука или роли. Этот параметр несовместим с lines.
update -		Варианты: слияние ← проверка	Параметр update управляет тем, как обрабатываются команды конфигурации на удалённом устройстве. Допустимые значения для параметра update — слияние и проверка. Когда этот параметр установлен в слияние, изменения конфигурации сливаются с текущей running-конфигурацией устройства. Когда этот параметр установлен в проверка, изменения конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Примечания

Примечание

Дополнительную информацию об использовании 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

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

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

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

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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/dellos10_config_module.html