Модуль ansible.builtin.yum_repository — добавление и удаление репозиториев YUM
Примечание
Этот модуль входит в ansible-core и включен во все установки Ansible. В большинстве случаев можно использовать краткое имя модуля yum_repository, даже не указывая ключевое слово collections. Однако для удобства перехода к документации модуля и во избежание конфликтов с другими коллекциями, в которых может быть модуль с таким же именем, рекомендуем использовать полное имя коллекции (FQCN) ansible.builtin.yum_repository.
Краткое описание
- Добавление и удаление репозиториев YUM в дистрибутивах Linux на основе RPM.
- Чтобы обновить существующее описание репозитория, используйте вместо этого community.general.ini_file.
Параметры
Параметр | Комментарии |
|---|---|
async boolean | Если установлено значение В ansible-core 2.11, 2.12 и 2.13 значение по умолчанию — Этот параметр удален в RHEL 8. Если вы используете одну из перечисленных выше версий, можно установить для этого параметра значение Этот параметр объявлен устаревшим, поскольку был удален в системах, поддерживаемых ansible-core, и будет удален в ansible-core 2.22. Допустимые значения:
|
attributes псевдонимы: attr string | Атрибуты, которыми должен обладать созданный объект файловой системы. Сведения о поддерживаемых флагах см. на странице руководства для Эта строка должна содержать атрибуты в том же порядке, в котором они отображаются командой По умолчанию предполагается оператор |
bandwidth string | Максимальная доступная пропускная способность сети в байтах в секунду. Используется с параметром Если |
baseurl list / elements=string | URL каталога, в котором находится каталог «repodata» репозитория yum. Также можно указать список из нескольких URL. Этот параметр, а также параметры |
cost string | Относительная стоимость доступа к этому репозиторию. Полезно для задания приоритета пакетов одного репозитория над пакетами другого. |
countme boolean добавлено в ansible-core 2.18 | Следует ли еженедельно добавлять специальный флаг к случайно выбранному запросу metalink/mirrorlist. Это позволяет владельцу репозитория оценить количество использующих его систем. Допустимые значения:
|
deltarpm_metadata_percentage string | Если относительный размер метаданных deltarpm по сравнению с пакетами превышает это значение, метаданные deltarpm не загружаются из репозитория. Обратите внимание, что можно указать значения больше Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. |
deltarpm_percentage string | |
description string | Понятное пользователю описание репозитория. Этот параметр соответствует свойству Этот параметр необходим только в том случае, если |
enabled boolean | Указывает yum, следует ли использовать этот репозиторий. Значение yum по умолчанию — Допустимые значения:
|
enablegroups boolean | Определяет, разрешит ли yum использовать группы пакетов для этого репозитория. Значение yum по умолчанию — Допустимые значения:
|
exclude псевдонимы: excludepkgs list / elements=string | Список пакетов, исключаемых из обновлений или установки. Элементы списка следует разделять пробелами. Допускаются шаблоны оболочки с подстановочными знаками (например, Список также можно задать как обычный массив YAML. Псевдоним |
failovermethod string |
Допустимые значения:
|
file string | Имя файла без расширения |
gpgcakey string | URL файла ключа CA репозитория в формате ASCII-armored. Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. |
gpgcheck boolean | Указывает yum, следует ли проверять подписи GPG пакетов. Значение по умолчанию не задано. Если значение не указано, будет использоваться системная настройка из Допустимые значения:
|
gpgkey list / elements=string | URL файла ключа GPG репозитория в формате ASCII-armored. Также можно указать список из нескольких URL. |
group string | Имя группы, которой должен принадлежать объект файловой системы; значение передается команде Если значение не задано, используется текущая группа пользователя; если пользователь — root, можно сохранить прежнее владение. Числовое имя группы (например, «1000») будет считаться идентификатором группы (GID), а не именем группы. Во избежание неоднозначности не используйте имена групп, состоящие только из цифр. |
http_caching string | Определяет, как следует instruировать вышестоящие кэши HTTP об обработке HTTP-загрузок, выполняемых Yum.
Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. Допустимые значения:
|
include string | Подключить внешний файл конфигурации. Поддерживаются локальный путь и URL. Файл конфигурации будет вставлен в месте строки |
includepkgs list / elements=string | Список пакетов, которые следует использовать только из этого репозитория. Элементы списка следует разделять пробелами. Допускаются шаблоны оболочки с подстановочными знаками (например, Список также можно задать как обычный массив YAML. |
ip_resolve string | Определяет, как yum разрешает имена узлов.
Допустимые значения:
|
keepalive boolean | Указывает yum, следует ли использовать HTTP/1.1 keepalive для этого репозитория. Это может увеличить скорость передачи данных, позволяя использовать одно соединение при загрузке нескольких файлов из репозитория. Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. Допустимые значения:
|
metadata_expire string | Время (в секундах), по истечении которого метаданные устаревают. Значение по умолчанию — 6 часов. |
metadata_expire_filter string | Фильтровать время
Обратите внимание, что этот параметр не переопределяет Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. Допустимые значения:
|
metalink string | Задает URL файла metalink для repomd.xml; список зеркал для всего репозитория создается путем преобразования зеркал файла repomd.xml в Этот параметр, а также параметры |
mirrorlist string | |
mirrorlist_expire string | Время (в секундах), по истечении которого локально кэшированный список зеркал устаревает. Значение по умолчанию — 6 часов. Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. |
mode any | Права доступа, которыми должен обладать созданный объект файловой системы. Если вы привыкли к Если передать Ansible число, не соблюдая ни одно из этих правил, оно будет интерпретировано как десятичное, что приведет к неожиданным результатам. Начиная с Ansible 1.8 режим можно указывать в символьном формате (например, Если Если Указание |
module_hotfixes boolean добавлено в ansible-core 2.11 | Отключить фильтрацию модулей RPM и сделать доступными все RPM из репозитория. Значение по умолчанию — Допустимые значения:
|
name string / обязательный | Уникальный идентификатор репозитория. Этот параметр задает имя раздела репозитория в файле репозитория. Этот параметр необходим только в том случае, если для |
owner string | Имя пользователя, которому должен принадлежать объект файловой системы; значение передается команде Если значение не задано, используется текущий пользователь; если пользователь — root, можно сохранить прежнее владение. Числовое имя пользователя (например, «1000») будет считаться идентификатором пользователя (UID), а не именем пользователя. Во избежание неоднозначности не используйте имена пользователей, состоящие только из цифр. |
password string | Пароль для базовой аутентификации с указанным именем пользователя. |
priority string | Задает упорядоченную защиту репозиториев. Значение — целое число от 1 до 99. Этот параметр работает только при установленном подключаемом модуле YUM Priorities. |
protect boolean | Защищать пакеты от обновлений из других репозиториев. Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удален в ansible-core 2.22. Допустимые значения:
|
proxy string | URL прокси-сервера, который должен использовать yum. Задайте |
proxy_password string | Пароль для этого прокси. |
proxy_username string | Имя пользователя для подключения к прокси. |
repo_gpgcheck boolean | Указывает yum, следует ли проверять подписи GPG метаданных репозитория. Допустимые значения:
|
reposdir path | Каталог, в котором будут храниться файлы По умолчанию: |
retries string | Задает количество повторных попыток получения файла, прежде чем будет возвращена ошибка. Если задать |
s3_enabled boolean | Включает поддержку репозиториев S3. Этот параметр работает только при установленном подключаемом модуле YUM S3. Допустимые значения:
|
selevel string | Уровень в контексте объекта файловой системы SELinux. Это атрибут MLS/MCS, иногда называемый Если задано значение |
serole string | Часть контекста объекта файловой системы SELinux, отвечающая за роль. Если задано значение |
setype string | Часть контекста объекта файловой системы SELinux, отвечающая за тип. Если задано значение |
seuser string | Часть контекста объекта файловой системы SELinux, отвечающая за пользователя. По умолчанию используется политика Если задано значение |
boolean | Если задано значение Варианты:
|
ssl_check_cert_permissions boolean | Определяет, должен ли yum проверять права доступа к путям сертификатов в репозитории (как удалённых, так и локальных). Если не удаётся прочитать какой-либо из файлов, yum принудительно задаст для Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удалён в ansible-core 2.22. Варианты:
|
sslcacert псевдонимы: ca_cert string | Путь к каталогу, содержащему базы данных центров сертификации, которые yum должен использовать для проверки SSL-сертификатов. |
sslclientcert псевдонимы: client_cert string | Путь к SSL-сертификату клиента, который yum должен использовать для подключения к репозиториям и удалённым сайтам. |
sslclientkey псевдонимы: client_key string | Путь к SSL-ключу клиента, который yum должен использовать для подключения к репозиториям и удалённым сайтам. |
sslverify псевдонимы: validate_certs boolean | Определяет, должен ли yum проверять SSL-сертификаты и узлы. Варианты:
|
state string | Состояние файла репозитория. Варианты:
|
throttle string | Включает ограничение пропускной способности при загрузке. Этот параметр можно задать как абсолютную скорость передачи данных в байтах/с. К значению пропускной способности можно добавить префикс СИ (k, M или G). |
timeout string | Количество секунд ожидания подключения до истечения времени ожидания. |
ui_repoid_vars string | При отображении идентификатора репозитория добавляет к строке указанные переменные yum, если они используются в Этот параметр объявлен устаревшим, поскольку не действует при использовании dnf в качестве базового менеджера пакетов, и будет удалён в ansible-core 2.22. |
unsafe_writes boolean | Определяет, когда использовать атомарные операции для предотвращения повреждения данных или несогласованного чтения целевого объекта файловой системы. По умолчанию этот модуль использует атомарные операции для предотвращения повреждения данных или несогласованного чтения целевых объектов файловой системы, однако иногда конфигурация систем или неисправности мешают этому. Например, объекты файловой системы, смонтированные Docker, нельзя атомарно обновить из контейнера — их можно записать только небезопасным способом. Этот параметр позволяет Ansible при сбое атомарных операций прибегнуть к небезопасным методам обновления объектов файловой системы (однако он не заставляет Ansible выполнять небезопасную запись). ВАЖНО! Небезопасная запись подвержена состояниям гонки и может привести к повреждению данных. Варианты:
|
username string | Имя пользователя для базовой аутентификации в репозитории или любом URL. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: full | Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект; если режим не поддерживается, действие будет пропущено. |
diff_mode | Поддержка: full | В режиме diff возвращает сведения об изменениях (или возможных изменениях в режиме check_mode). |
platform | Платформа: rhel | Целевые ОС и семейства ОС, с которыми можно работать |
Примечания
Примечание
- При изменении существующего файла репозитория все комментарии будут удалены.
- Порядок разделов в существующем файле репозитория сохраняется.
- Параметры в разделе существующего файла репозитория располагаются в алфавитном порядке.
- Файл репозитория будет автоматически удалён, если в нём не останется репозиториев.
- При удалении репозитория учтите, что кэш метаданных может оставаться на диске до запуска
yum clean all. Для этого используйте обработчик уведомлений. - Параметр
paramsбыл удалён в Ansible 2.5, поскольку обходил обработку параметров Ansible.
Примеры
- name: Add repository
ansible.builtin.yum_repository:
name: epel
description: EPEL YUM repo
baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/
- name: Add multiple repositories into the same file (1/2)
ansible.builtin.yum_repository:
name: epel
description: EPEL YUM repo
file: external_repos
baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/
gpgcheck: no
- name: Add multiple repositories into the same file (2/2)
ansible.builtin.yum_repository:
name: rpmforge
description: RPMforge YUM repo
file: external_repos
baseurl: http://apt.sw.be/redhat/el7/en/$basearch/rpmforge
mirrorlist: http://mirrorlist.repoforge.org/el7/mirrors-rpmforge
enabled: no
# Handler showing how to clean yum metadata cache
- name: yum-clean-metadata
ansible.builtin.command: yum clean metadata
# Example removing a repository and cleaning up metadata cache
- name: Remove repository (and clean up left-over metadata)
ansible.builtin.yum_repository:
name: epel
state: absent
notify: yum-clean-metadata
- name: Remove repository from a specific repo file
ansible.builtin.yum_repository:
name: epel
file: external_repos
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
repo string | имя репозитория Возвращается: при успехе Пример: |
state string | состояние целевого объекта после выполнения Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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/ansible/builtin/yum_repository_module.html