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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.templates_import.

Добавлено в theforeman.foreman 1.0.0

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

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

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

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

Требования

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

requests

Параметры

Параметр	Комментарии
associate string	Связывать с операционными системами, расположениями и организациями на основе метаданных. Варианты: `"always"` `"new"` `"never"`
branch string	Ветка репозитория. Только для репозиториев на основе Git.
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_CA_PATH`.
dirname string	Каталог в репозитории Git, содержащий шаблоны.
filter string	Синхронизировать только шаблоны, имена которых соответствуют этому регулярному выражению после применения префикса. Поиск не учитывает регистр; фрагменты не фильтруются.
force boolean	Обновлять заблокированные шаблоны. Варианты: `false` `true`
http_proxy string	HTTP-прокси для синхронизации шаблонов. Используйте этот параметр вместе с `http_proxy_policy=selected`
http_proxy_policy string	Политика использования HTTP-прокси для синхронизации шаблонов. Можно выбрать отсутствие HTTP-прокси, глобальный HTTP-прокси или пользовательский HTTP-прокси (`selected`) Если выбрано значение «selected», укажите параметр `http_proxy`. Варианты: `"none"` `"global"` `"selected"`
locations list / элементы=string	Список расположений, которым должна быть назначена сущность
lock boolean	Блокировать импортированные шаблоны. Варианты: `false` `true`
negate boolean	Инвертировать условие фильтра. Варианты: `false` `true`
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / элементы=string	Список организаций, которым должна быть назначена сущность
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_PASSWORD`.
prefix string	Добавляет указанную строку в начало всех импортируемых шаблонов, у которых ещё нет этого префикса.
repo string	Путь в файловой системе или репозиторий (с протоколом), например /tmp/dir, git://example.com/repo.git или https://example.com/repo.git.
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_SERVER_URL`.
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
verbose boolean	Добавлять отчёты о шаблонах в вывод. Варианты: `false` `true`

Атрибуты

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

Примечания

Примечание

Из-за ошибки в плагине 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 dictionary	Сведения об импорте. Возвращается: при успехе
branch string	Ветка, используемая в репозитории. Возвращается: при успехе
repo string	Репозиторий, из которого были импортированы шаблоны. Возвращается: при успехе
report dictionary	Отчёт об импорте. Возвращается: при успехе
changed list / элементы=string	Список обновлённых шаблонов. Возвращается: при успехе
new list / элементы=string	Список созданных шаблонов. Возвращается: при успехе
templates dictionary	Итоговое состояние шаблонов. Возвращается: при успехе

Авторы

Anton Nesterov (@nesanton)

Ссылки на коллекцию

© 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/theforeman/foreman/templates_import_module.html