Модуль dellemc.enterprise_sonic.sonic_config – Управление разделами конфигурации на устройствах с Enterprise SONiC
Примечание
Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install dellemc.enterprise_sonic.
Чтобы использовать его в playbook, укажите: dellemc.enterprise_sonic.sonic_config.
Добавлена в dellemc.enterprise_sonic 1.0.0
Обзор
- Управляет разделами конфигурации Enterprise SONiC Distribution от Dell Technologies. Конфигурации SONiC используют простой синтаксис с отступами блоков для разбиения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации SONiC детерминированным способом.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
Параметр | Комментарии |
|---|---|
after список / элементы=строка | Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Как и в случае с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. |
backup логическое | Этот аргумент заставляет модуль создать полную резервную копию текущей Варианты:
|
backup_options словарь | Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра читается только тогда, когда |
|
dir_path путь |
Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором хранится файл конфигурации резервной копии. Если каталог не существует, он сначала создается, а имя файла — это значение |
|
filename строка |
Имя файла, используемое для хранения конфигурации резервной копии. Если имя файла не указано, оно генерируется на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>. |
before список / элементы=строка | Упорядоченный набор команд, которые помещаются в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой. |
config строка | По умолчанию модуль подключается к удаленному устройству и извлекает текущую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую конфигурацию для каждой задачи в плейбуке. Аргумент config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения. |
строки псевдонимы: команды список / элементы=строка | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот параметр взаимоисключает параметр src. |
match строка | Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны совпадать полностью. Если match установлено в none, модуль не пытается сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. Варианты:
|
parents список / элементы=строка | Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами. |
replace строка | Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, то измененные строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в block, то весь блок команд передается устройству в режиме конфигурации, если какая-либо строка неверна. Варианты:
|
save логическое | Аргумент Варианты:
|
src путь | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня плейбука или роли. Этот параметр взаимоисключает параметр lines. |
update строка | Аргумент update управляет обработкой инструкций конфигурации на удаленном устройстве. Допустимые значения для аргумента update — merge и check. При установке аргумента в merge изменения конфигурации объединяются с текущей конфигурацией устройства. При установке аргумента в check изменения конфигурации определяются, но не настраиваются на удаленном устройстве. Варианты:
|
Примечания
Примечание
- Проверено с дистрибутивом Enterprise SONiC от Dell Technologies.
- Поддерживает
check_mode.
Примеры
- dellemc.enterprise_sonic.sonic_config:
lines: ['username {{ user_name }} password {{ user_password }} role {{ user_role }}']
- dellemc.enterprise_sonic.sonic_config:
lines:
- description 'SONiC'
parents: ['interface Eth1/10']
- dellemc.enterprise_sonic.sonic_config:
lines:
- seq 2 permit udp any any
- seq 3 deny icmp any any
parents: ['ip access-list test']
before: ['no ip access-list test']
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
commands список / элементы=строка | Набор команд, который отправляется на удаленное устройство. Возвращается: всегда Пример: |
saved логическое | Возвращает, сохранена ли конфигурация в стартовой конфигурации или нет. Возвращается: когда режим check_mode не используется. Пример: |
updates список / элементы=строка | Набор команд, который отправляется на удаленное устройство. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_config_module.html
