mellanox.onyx.onyx_config – Управление секциями конфигурации Mellanox ONYX
Примечание
Этот плагин входит в коллекцию mellanox.onyx (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install mellanox.onyx.
Для использования в книге задач укажите: mellanox.onyx.onyx_config.
Обзор
- Конфигурации Mellanox ONYX используют простой синтаксис файла с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ONYX детерминированным способом.
Примечание
У этого модуля есть соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Так же как и с before, это позволяет автору книги задач добавить набор команд, которые должны быть выполнены после набора команд. | ||
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением каких-либо изменений. Если значение backup_options не задано, резервная копия файла записывается в папку backup в корневой директории книги задач. Если директория не существует, она создается. | |
| backup_options словарь | Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только при backup равно yes. Если backup равно no, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр задаёт путь, заканчивающийся именем каталога, в котором будет храниться резервная копия конфигурации. Если директория не существует, она будет создана первой, а имя файла — это либо значение filename, либо имя файла по умолчанию, как описано в описании опций filename. Если значение пути не указано, то в текущем рабочем каталоге будет создана папка backup, и резервная копия конфигурации будет скопирована в filename внутри папки backup. | ||
| filename строка | Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before строка | Упорядоченный набор команд, которые необходимо добавить в стек команд, если требуется внести изменения. Это даёт автору книги задач возможность выполнить команды конфигурации до добавления любых изменений, не влияя на сопоставление набора команд с системой. | ||
| config строка | Аргумент config позволяет автору книги задач предоставить базу конфигурации, которая будет использоваться для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удалённого узла. | ||
| lines строка | Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть идентичны командам, найденным в running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. Псевдонимы: команды | ||
| match строка |
| Инструктирует модуль о том, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются с учётом позиции. Если match установлено в exact, строки команд должны быть идентичны. И наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удалённом устройстве. | |
| parents строка | Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию, с которой должны быть проверены команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд. | ||
| replace строка |
| Инструктирует модуль о том, как выполнить конфигурацию на устройстве. Если replace установлено в line, изменённые строки передаются устройству в режиме конфигурации. Если replace установлено в block, весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка неверна. | |
| save булево |
| Аргумент save инструктирует модуль сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется. | |
| src строка | Указывает путь к источнику файла, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневой директории книги задач или роли. Этот аргумент взаимоисключает lines, parents. | ||
Примеры
---
- onyx_config:
lines:
- snmp-server community
- snmp-server host 10.2.2.2 traps version 2c
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup равно yes | Полный путь к резервному файлу Пример: /playbooks/ansible/backup/onyx_config.2016-07-16@22:28:34 |
| updates список / элементы=строка | всегда | Набор команд, которые будут переданы удалённому устройству Пример: ['...', '...'] |
Авторы
- Alex Tabachnik (@atabachnik), Samer Deeb (@samerd)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/mellanox/onyx/onyx_config_module.html
