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

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

Краткое описание

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

Параметры

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

Статус

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