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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Подобно параметру before, это позволяет разработчику playbook добавлять набор команд, которые будут выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если папка не существует, она создается.
before -			Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения любых изменений, не влияя на способ сопоставления набора команд с системой.
config -			По умолчанию модуль подключится к удаленному устройству и получит текущую running-config, чтобы использовать ее в качестве основы для сравнения с содержимым источника. В некоторых случаях нежелательно получать текущую running-config для каждой задачи в playbook. Аргумент config позволяет реализатору указать конфигурацию, которая будет использоваться как базовая конфигурация для сравнения.
lines -			Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть точно такими же, как и в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот аргумент взаимоисключающий с src. псевдонимы: команды
match -		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются по строкам. Если match установлен на strict, строки команд сопоставляются относительно позиции. Если match установлен на exact, строки команд должны быть точным совпадением. Наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве.
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 -		Варианты: line ← block	Указывает модулю способ внесения конфигурации на устройстве. Если аргумент replace установлен на line, то измененные строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен на block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save boolean		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить running-config в startup-config по завершении работы модуля. Если задан режим проверки, этот аргумент игнорируется.
src -			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к файлу-источнику может быть полным путем на хосте 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 = да	Полный путь к резервной копии файла Пример: /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. [community]

Авторы

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