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