Модуль theforeman.foreman.templates_import – Синхронизация шаблонов из репозитория

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: theforeman.foreman.templates_import.

Новое в theforeman.foreman 1.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Синхронизирует шаблоны provisioning, report_templates, таблицы разделов и шаблоны заданий из внешнего Git-репозитория или файловой системы.
Основан на плагине foreman_templates https://github.com/theforeman/foreman_templates.

Псевдонимы: foreman_templates_import

Требования

Указанные ниже требования необходимы на хосте, который выполняет этот модуль.

requests

Параметры

Параметр	Комментарии
associate строка	Связать с операционными системами, местоположениями и организациями на основе метаданных. Варианты: `"always"` `"new"` `"never"`
branch строка	Ветка repo. Только для репозиториев на основе Git.
dirname строка	Каталог в Git-репозитории, содержащий шаблоны.
filter строка	Синхронизировать только шаблоны с именем, соответствующим этому регулярному выражению, после применения prefix. Без учёта регистра, фрагменты не фильтруются.
force логическое	Обновлять шаблоны, которые заблокированы. Варианты: `false` `true`
locations список / элементы=строка	Список местоположений, к которым должен быть назначен объект
lock логическое	Блокировать импортированные шаблоны. Варианты: `false` `true`
negate логическое	Инвертировать условие фильтра. Варианты: `false` `true`
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`. Варианты: `false` `true` ← (по умолчанию)
verbose логическое	Добавить отчеты по шаблонам в вывод. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя сущность
diff_mode	Поддержка: нет	Возвращает подробности о том, что было изменено (или, возможно, нуждается в изменении в режиме check_mode), когда в режиме diff

Примечания

Примечание

Из-за ошибки в плагине 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/templates_import_module.html