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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after		Значение по умолчанию: None	Упорядоченный набор команд, которые будут добавлены в конец стека команд, если необходимо внести изменения. Как и в случае с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением любых изменений. Файл резервной копии будет записан в папку `backup` в корневом каталоге playbook. Если каталог не существует, он будет создан.
before		Значение по умолчанию: None	Упорядоченный набор команд, которые будут добавлены в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением любых изменений без влияния на способ сопоставления набора команд с системой.
config		Значение по умолчанию: None	Модуль по умолчанию подключится к удаленному устройству и извлечет текущую running-конфигурацию, чтобы использовать ее в качестве основы для сравнения с содержимым source. Иногда нежелательно, чтобы задача получала текущую running-конфигурацию для каждой задачи в playbook. Аргумент config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.
lines		Значение по умолчанию: None	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в running-конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Этот аргумент несовместим с аргументом src. псевдонимы: команды
match		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются построчно. Если match установлен на strict, строки команд сопоставляются относительно позиции. Если match установлен на exact, строки команд должны точно совпадать. Наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удаленного устройства.
parents		Значение по умолчанию: None	Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider		Значение по умолчанию: None	Объект типа dict, содержащий сведения о подключении.
	username		Пользователь для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	ssh_keyfile		Путь к ssh-ключу, используемому для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	Значение по умолчанию: 10	Указывает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
	password	Значение по умолчанию: None	Пароль для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port	Значение по умолчанию: 22	Указывает порт, который нужно использовать при построении соединения с удаленным устройством.
replace		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен на line, то измененные строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен на block, то весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save		Варианты: yes no ←	Аргумент `save` указывает модулю сохранить running-конфигурацию в startup-конфигурацию по окончании работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src		Значение по умолчанию: None	Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога playbook или роли. Этот аргумент несовместим с аргументом lines.
update		Варианты: merge ← check	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удаленном устройстве. Допустимые значения для аргумента update — merge и check. При установке этого аргумента в merge изменения конфигурации объединяются с текущей running-конфигурацией устройства. При установке этого аргумента в 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 булево	Когда не check_mode.	Возвращает, сохранена ли конфигурация в конфигурацию startup или нет. Пример: True
updates список	всегда	Набор команд, которые будут отправлены на удаленное устройство. Пример: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']

Статус

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

Автор

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