модуль theforeman.foreman.repository — управление репозиториями

Примечание

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

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

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

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

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

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

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

Создание репозиториев и управление ими

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

Требования

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

requests

Параметры

Параметр	Комментарии
ansible_collection_auth_token string добавлено в theforeman.foreman 5.5.0	Ключ токена для аутентификации.
ansible_collection_auth_url string добавлено в theforeman.foreman 5.5.0	URL-адрес для получения токена сеанса, например используемый с Automation Hub.
ansible_collection_requirements string	Содержимое файла yaml с требованиями для синхронизации с URL-адреса
arch string	Архитектура содержимого в репозитории Установите значение `noarch`, чтобы снова отключить ограничение по архитектуре.
auto_enabled boolean	репозитории будут автоматически включены на зарегистрированном узле, подписанном на этот продукт Варианты: `false` `true`
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
checksum_type string	Контрольная сумма репозитория Варианты: `"sha1"` `"sha256"`
content_type string / обязательный	Тип содержимого репозитория Варианты: `"deb"` `"docker"` `"file"` `"ostree"` `"puppet"` `"yum"` `"ansible_collection"` `"python"`
deb_architectures string	Список архитектур, разделённых запятыми, для синхронизации из deb-archive доступно только для content_type=deb
deb_components string	Список компонентов репозитория, разделённых запятыми, для синхронизации из deb-archive доступно только для content_type=deb
deb_errata_url string	URL-адрес для синхронизации сведений об errata Debian или Ubuntu доступно только в Orcharhino доступно только для content_type=deb
deb_releases string	Список выпусков, разделённых запятыми, для синхронизации из deb-archive доступно только для content_type=deb
depth integer добавлено в theforeman.foreman 5.5.0	Параметр, задающий количество обходных коммитов ostree.
description string	Описание репозитория
docker_tags_whitelist list / elements=string	Список тегов для синхронизации из репозитория образов контейнеров доступно только для content_type=docker Устарело начиная с Katello 4.4
docker_upstream_name string	Имя вышестоящего репозитория Docker доступно только для content_type=docker
download_concurrency integer добавлено в theforeman.foreman 3.0.0	Параллелизм загрузки при синхронизации из вышестоящего источника Поскольку API не возвращает это значение, идемпотентность этого модуля будет нарушена
download_policy string	Политика загрузки при синхронизации из вышестоящего источника. Политика загрузки `background` устарела и недоступна начиная с Katello 4.3. Варианты: `"background"` `"immediate"` `"on_demand"`
exclude_refs list / elements=string добавлено в theforeman.foreman 5.5.0	Список тегов, исключаемых при синхронизации ostree. Распознаются подстановочные знаки `*`, `?`. `exclude_refs` применяется после `include_refs`.
exclude_tags list / elements=string добавлено в theforeman.foreman 3.7.0	Список тегов, исключаемых при синхронизации репозитория образов контейнеров.
excludes list / elements=string добавлено в theforeman.foreman 5.5.0	Пакеты Python, исключаемые из вышестоящего URL-адреса. Можно также указать версии, например: `django~=2.0`.
gpg_key string	Ключ GPG репозитория
http_proxy string	Имя HTTP-прокси для синхронизации содержимого Следует использовать вместе с http_proxy_policy=’use_selected_http_proxy’
http_proxy_policy string	Прокси-сервер, используемый для синхронизации содержимого Варианты: `"global_default_http_proxy"` `"none"` `"use_selected_http_proxy"`
ignorable_content list / elements=string	Список единиц содержимого, которые следует игнорировать при синхронизации yum-репозитория. Должен быть подмножеством rpm,drpm,srpm,distribution,erratum.
ignore_global_proxy boolean	Следует ли использовать глобальную настройку HTTP-прокси для синхронизации содержимого или игнорировать её Устарело начиная с Katello 3.13 Заменено параметром http_proxy_policy Варианты: `false` `true`
include_refs list / elements=string добавлено в theforeman.foreman 5.5.0	Список ссылок, включаемых при синхронизации ostree. Распознаются подстановочные знаки `*`, `?`.
include_tags list / elements=string добавлено в theforeman.foreman 3.7.0	Список тегов для синхронизации из репозитория образов контейнеров.
includes list / elements=string добавлено в theforeman.foreman 5.5.0	Пакеты Python для включения из вышестоящего URL-адреса, Можно также указать версии, например: `django~=2.0`. Оставьте поле пустым, чтобы включить все пакеты.
keep_latest_packages integer добавлено в theforeman.foreman 5.5.0	Количество последних версий пакета, сохраняемых при синхронизации; включает предварительные выпуски, если они синхронизируются. По умолчанию сохраняются все версии.
label string	Метка репозитория
metadata_expire integer добавлено в theforeman.foreman 5.4.0	Задаёт время устаревания метаданных (в секундах) для yum-репозитория.
mirror_on_sync boolean	Включает или отключает режим «зеркалирование при синхронизации», при котором состояние репозитория во время синхронизации соответствует состоянию вышестоящего репозитория Устарело начиная с Katello 4.3 Заменено параметром mirroring_policy=mirror_content_only Варианты: `false` `true`
mirroring_policy string	Политика зеркалирования содержимого Поддерживается начиная с Katello 4.3 Варианты: `"additive"` `"mirror_content_only"` `"mirror_complete"`
name string / обязательный	Имя репозитория
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization string / обязательный	Организация, к которой относится объект
os_versions list / elements=string	Определяет, следует ли отключить репозиторий на клиенте с несовпадающей версией ОС. Можно выбрать не более одной версии ОС. Установите значение `[]`, чтобы снова отключить фильтрацию. Варианты: `"rhel-6"` `"rhel-7"` `"rhel-8"` `"rhel-9"` `"rhel-10"`
package_types list / elements=string добавлено в theforeman.foreman 5.5.0	Типы пакетов для синхронизации содержимого Python, разделённые запятыми. FIXME Оставьте поле пустым, чтобы получить все типы пакетов. Варианты: `"bdist_dmg"` `"bdist_dumb"` `"bdist_egg"` `"bdist_msi"` `"bdist_rpm"` `"bdist_wheel"` `"bdist_wininst"` `"sdist"`
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
product string / обязательный	Продукт, к которому относится репозиторий
retain_package_versions_count integer добавлено в theforeman.foreman 5.4.0	Максимальное количество версий каждого пакета, которые следует сохранять.
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
ssl_ca_cert string	Сертификат центра сертификации SSL репозитория
ssl_client_cert string	Клиентский сертификат SSL репозитория
ssl_client_key string	Закрытый клиентский ключ SSL репозитория
state string	Состояние объекта `present_with_defaults` обеспечит существование объекта, но не обновит уже существующие объекты Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
unprotected boolean	Публиковать репозиторий по HTTP Варианты: `false` `true`
upstream_authentication_token string добавлено в theforeman.foreman 5.5.0	Строка токена аутентификации для вышестоящих yum-репозиториев.
upstream_password string	Пароль для доступа к вышестоящему репозиторию. Если этот параметр задан, модуль не будет идемпотентным.
upstream_username string	Имя пользователя для доступа к вышестоящему репозиторию
url string	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` ← (по умолчанию)
verify_ssl_on_sync boolean	Проверять, подписаны ли сертификаты вышестоящего сервера доверенным центром сертификации Варианты: `false` `true`

Атрибуты

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

Примечания

Примечание

С помощью этого модуля можно настроить некоторые параметры существующих репозиториев Red Hat (например, download_policy), но нельзя создавать (включать) или удалять (отключать) их.
Чтобы включить или отключить репозитории Red Hat, доступные по вашей подписке, используйте вместо этого модуль theforeman.foreman.repository_set.

Примеры

- name: "Create repository"
  theforeman.foreman.repository:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My repository"
    state: present
    content_type: "yum"
    product: "My Product"
    organization: "Default Organization"
    url: "http://yum.theforeman.org/plugins/latest/el7/x86_64/"
    mirror_on_sync: true
    download_policy: immediate

- name: "Create repository with content credentials"
  theforeman.foreman.repository:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My repository 2"
    state: present
    content_type: "yum"
    product: "My Product"
    organization: "Default Organization"
    url: "http://yum.theforeman.org/releases/latest/el7/x86_64/"
    download_policy: on_demand
    mirror_on_sync: true
    gpg_key: RPM-GPG-KEY-my-product2

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
entity dictionary	Итоговое состояние затронутых объектов, сгруппированных по типу. Возвращается: при успехе
repositories list / элементы=dictionary	Список репозиториев. Возвращается: при успехе

Авторы

Eric D Helms (@ehelms)

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

© 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/repository_module.html