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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after			Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется внести изменения. Так же, как и с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup bool		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущего `running-config` удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге плейбука. Если папка не существует, она создается.
before			Упорядоченный набор команд, которые добавляются в стек команд, если требуется внести изменения. Это даёт разработчику плейбука возможность выполнить команды конфигурации до добавления любых изменений без влияния на способ сопоставления набора команд с системой.
config			Модуль по умолчанию подключится к удалённому устройству и получит текущую рабочую конфигурацию, чтобы использовать её в качестве основы для сравнения с содержимым исходного файла. Иногда нет необходимости получать текущую рабочую конфигурацию для каждой задачи в плейбуке. Аргумент config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.
lines			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в текущей рабочей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически модифицируются анализатором конфигурации устройства. Этот аргумент несовместим с аргументом src. псевдонимы: команды
match		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match равен line, команды сопоставляются построчно. Если match равен strict, строки команд сопоставляются относительно позиции. Если match равен exact, строки команд должны быть точным совпадением. Наконец, если match равен none, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удалённом устройстве.
parents			Упорядоченный набор родителей, которые однозначно идентифицируют раздел или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider			Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	По умолчанию: 22	Указывает порт для создания подключения к удалённому устройству.
	username		Пользователь для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Пароль для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	ssh_keyfile		Путь к ключу ssh, используемому для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	По умолчанию: 10	Указывает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигураций.
replace		Варианты: line ← block	Указывает модулю способ внесения конфигурации на устройство. Если аргумент replace равен line, изменённые строки отправляются на устройство в режиме конфигурации. Если аргумент replace равен block, весь блок команды отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save bool		Варианты: no ← yes	Аргумент save указывает модулю сохранить рабочую конфигурацию в стартовую конфигурацию по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src			Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневого каталога плейбука или роли. Этот аргумент несовместим с аргументом lines.
update		Варианты: merge ← check	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые значения для аргумента update — merge и check. При установке этого аргумента в merge, изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. При установке этого аргумента в check, обновления конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Примечания

Примечание

Для этого модуля требуется 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

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

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = yes	Полный путь к файлу резервной копии Пример: /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 bool	Когда не check_mode.	Возвращает, сохраняется ли конфигурация в стартовую конфигурацию или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удалённое устройство. Пример: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности см. в разделе Техническое обслуживание модулей и поддержка.

Для списка других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

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