theforeman.foreman.templates_import – Синхронизация шаблонов из репозитория
Примечание
Этот плагин входит в состав коллекции theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman.
Для использования в плейбуке укажите: theforeman.foreman.templates_import.
Новое в версии 1.0.0: of theforeman.foreman
Обзор
- Синхронизация шаблонов провизионирования, шаблонов отчетов, таблиц разделов и шаблонов задач из внешнего репозитория Git или файловой системы.
- Основано на плагине foreman_templates https://github.com/theforeman/foreman_templates.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| associate строка |
| Связь с операционными системами, местоположениями и организациями на основе метаданных. |
| branch строка | Ветка репозитория repo. Только для репозиториев на основе Git. | |
| dirname строка | Директория внутри репозитория Git, содержащая шаблоны. | |
| filter строка | Синхронизировать только шаблоны с именем, соответствующим этому регулярному выражению, после применения prefix. Без учета регистра, фрагменты не фильтруются. | |
| force логическое |
| Обновлять заблокированные шаблоны. |
| locations список / элементы=строка | Список местоположений, к которым должна быть назначена сущность | |
| lock логическое |
| Заблокировать импортированные шаблоны. |
| negate логическое |
| Инвертировать условие фильтра. |
| organizations список / элементы=строка | Список организаций, к которым должна быть назначена сущность | |
| password строка / обязательно | Пароль пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_PASSWORD. | |
| prefix строка | Добавляет указанную строку в начало всех импортированных шаблонов, которые еще не содержат этого префикса. | |
| repo строка | Путь к файловой системе или репозиторию (с протоколом), например /tmp/dir или git://example.com/repo.git или https://example.com/repo.git. | |
| server_url строка / обязательно | URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_SERVER_URL. | |
| username строка / обязательно | Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_USERNAME. | |
| validate_certs логическое |
| Требовать проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_VALIDATE_CERTS. |
| verbose логическое |
| Добавить отчеты по шаблонам в вывод. |
Примечания
Примечание
- Из-за ошибки в плагине foreman_templates этот модуль не будет сообщать
changed=true, когда единственным изменением является назначение организации/местоположения импортированных шаблонов. Подробности см. на странице https://projects.theforeman.org/issues/29534. - Значения по умолчанию для всех параметров модуля можно задать с помощью theforeman.foreman.setting для категории TemplateSync или на странице настроек в WebUI.
Примеры
- name: Sync templates from git repo
theforeman.foreman.templates_import:
repo: https://github.com/theforeman/community-templates.git
branch: 1.24-stable
associate: new
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| message словарь | успех | Информация об импорте. | |
| branch строка | успех | Ветка, используемая в репозитории. | |
| repo строка | успех | Репозиторий, из которого были импортированы шаблоны. | |
| report словарь | успех | Отчет об импорте. | |
| changed список / элементы=строка | успех | Список шаблонов, которые были обновлены. | |
| new список / элементы=строка | успех | Список шаблонов, которые были созданы. | |
| templates словарь | успех | Конечное состояние шаблонов. | |
Авторы
- Антон Нестеров (@nesanton)
© 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/theforeman/foreman/templates_import_module.html