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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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 -			Модуль по умолчанию подключается к удалённому устройству и получает текущую рабочую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую рабочую конфигурацию для каждой задачи в плейбуке. Параметр config позволяет реализатору передать конфигурацию, используемую в качестве базовой конфигурации для сравнения.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в рабочей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот параметр взаимоисключающий с 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 указывает модулю сохранить рабочую конфигурацию в конфигурацию по умолчанию по завершении работы модуля. Если указан режим проверки, этот параметр игнорируется.
src -			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня плейбука или роли. Этот параметр взаимоисключающий с lines.
update -		Варианты: слить ← проверить	Параметр update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые варианты параметра update — слить и проверить. При установке этого параметра в слить изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. При установке этого параметра в проверить изменения конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Примечания

Примечание

Для работы данного модуля требуется Dell OS9 версии 9.10.0.1P13 или выше.
Необходимо увеличить предел скорости подключения ssh. Используйте следующую команду ip ssh connection-rate-limit 60 для настройки. Это также можно сделать с помощью модуля dellos9_config.
Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на сайте https://www.ansible.com/ansible-dell-networking.

Примеры

- dellos9_config:
    lines: ['hostname {{ inventory_hostname }}']
    provider: "{{ cli }}"

- dellos9_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 extended test']
    before: ['no ip access-list extended test']
    match: exact

- dellos9_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 extended test']
    before: ['no ip access-list extended test']
    replace: block

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

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = да	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/dellos9_config.2016-07-16@22:28:34
commands список	всегда	Набор команд, которые будут отправлены на удаленное устройство Пример: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
saved логическое	Когда check_mode не используется.	Возвращает, сохранена ли конфигурация в стартовой конфигурации или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удаленное устройство. Пример: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Dhivya P (@dhivyap)

Подсказка

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

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