dellos9_config – Управление разделами конфигурации Dell EMC Networking OS9
Новое в версии 2.2.
Обзор
- Конфигурации OS9 используют простой синтаксис блочного отступа для разделения конфигурации на секции. Этот модуль предоставляет реализацию работы с секциями конфигурации OS9 детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after - | Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется изменение. Также, как и с параметром before, это позволяет разработчику конфигурационных файлов добавить набор команд, которые будут выполнены после указанного набора. | ||
| backup boolean |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневой директории файла playbook. Если директория не существует, она создается. | |
| before - | Упорядоченный набор команд, которые нужно поместить в стек команд при необходимости изменения. Это позволяет разработчику конфигурационных файлов выполнить команды конфигурации до добавления любых изменений, не влияя на способ сопоставления набора команд с системой. | ||
| config - | По умолчанию модуль подключается к удаленному устройству и получает текущую рабочую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую рабочую конфигурацию для каждой задачи в playbook. Аргумент config позволяет разработчику указать конфигурацию, используемую в качестве базовой конфигурации для сравнения. | ||
| lines - | Упорядоченный набор команд, которые необходимо настроить в разделе. Команды должны быть идентичными командам, найденным в рабочей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент несовместим с аргументом src. Псевдонимы: команды | ||
| match - |
| Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если 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 - |
| Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, изменённые строки передаются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка неверна. | |
| save boolean |
| Аргумент save указывает модулю сохранить рабочую конфигурацию в стартовую конфигурацию по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется. | |
| src - | Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент несовместим с аргументом lines. | ||
| update - |
| Аргумент 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 = да | Полный путь к резервной копии файла Пример: /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.7/modules/dellos9_config_module.html