Модуль dellemc.enterprise_sonic.sonic_config – Управляет разделами конфигурации на устройствах под управлением Enterprise SONiC
Примечание
Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install dellemc.enterprise_sonic.
Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_config.
Новое в dellemc.enterprise_sonic 1.0.0
Краткое описание
- Управляет разделами конфигурации Enterprise SONiC Distribution от Dell Technologies. В конфигурациях SONiC используется простой синтаксис блочных файлов с отступами для разделения конфигурации на секции. Этот модуль обеспечивает детерминированную работу с разделами конфигурации SONiC.
Параметры
Параметр | Комментарии |
|---|---|
after list / elements=string | Упорядоченный набор команд, добавляемых в конец стека команд, если необходимо внести изменения. Как и параметр before, он позволяет разработчику плейбука добавить набор команд, которые будут выполнены после указанного набора. |
backup boolean | Этот аргумент указывает модулю создать полную резервную копию текущей конфигурации Варианты:
|
backup_options dictionary | Словарь с настраиваемыми параметрами, относящимися к пути к файлу резервной копии. Значение этого параметра считывается, только если для |
|
dir_path path |
Этот параметр задаёт путь, заканчивающийся именем каталога, в котором хранится файл резервной копии конфигурации. Если каталога не существует, он сначала создаётся; имя файла задаётся значением |
|
filename string |
Имя файла для сохранения резервной копии конфигурации. Если имя файла не указано, оно формируется на основе имени узла, текущего времени и даты в формате <hostname>_config.<current-date>@<current-time>. |
before list / elements=string | Упорядоченный набор команд, добавляемых в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до применения каких-либо изменений, не влияя на сопоставление набора команд с системой. |
config string | По умолчанию модуль подключается к удалённому устройству и получает текущую running-конфигурацию для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-конфигурацию при каждом запуске в плейбуке. Аргумент config позволяет передать конфигурацию, которая будет использоваться в качестве базовой для сравнения. |
lines псевдонимы: commands list / elements=string | Упорядоченный набор команд, которые необходимо настроить в разделе. Команды должны в точности совпадать с командами из running-конфигурации устройства. Обратите внимание на синтаксис команд конфигурации: некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент несовместим с src. |
match string | Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если для match задано значение line, команды сопоставляются построчно. Если для match задано значение strict, строки команд сопоставляются с учётом их положения. Если для match задано значение exact, строки команд должны полностью совпадать. Если для match задано значение none, модуль не пытается сравнивать исходную конфигурацию с running-конфигурацией удалённого устройства. Варианты:
|
parents list / elements=string | Упорядоченный набор родительских элементов, однозначно определяющих раздел или иерархию, в которой следует проверить команды. Если аргумент parents не указан, команды проверяются среди команд верхнего уровня или глобальных команд. |
replace string | Указывает модулю, как применять конфигурацию на устройстве. Если для аргумента replace задано значение line, изменённые строки отправляются на устройство в режиме конфигурации. Если для аргумента replace задано значение block, весь блок команд отправляется на устройство в режиме конфигурации, если хотя бы одна строка неверна. Варианты:
|
save boolean | Аргумент Варианты:
|
src path | Задаёт исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на управляющем узле Ansible или относительным путём от корневого каталога плейбука или роли. Этот аргумент несовместим с lines. |
update string | Аргумент update определяет способ обработки операторов конфигурации на удалённом устройстве. Допустимые значения аргумента update — merge и check. Если задать этому аргументу значение merge, изменения конфигурации объединяются с текущей running-конфигурацией устройства. Если задать значение check, обновления конфигурации определяются, но не применяются на удалённом устройстве. Варианты:
|
Примечания
Примечание
- Проверено на Enterprise SONiC Distribution от 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 list / elements=string | Набор команд, отправляемых на удалённое устройство. Возвращается: всегда Пример: |
saved boolean | Показывает, сохранена ли конфигурация в startup-конфигурацию. Возвращается: если check_mode не включён. Пример: |
updates list / elements=string | Набор команд, отправляемых на удалённое устройство. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_config_module.html
