ansible.builtin.yum_repository 模块 – 添加或移除 YUM 仓库

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，也可以使用简短的模块名称 yum_repository。但是，我们建议您使用 完全限定的集合名称 (FQCN) ansible.builtin.yum_repository，以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合冲突。

概要

• 在基于 RPM 的 Linux 发行版中添加或移除 YUM 仓库。

• 如果您希望更新现有的仓库定义，请改用 community.general.ini_file。

参数

参数	注释
async 布尔值	如果设置为 true，则 Yum 将尽可能并行下载此仓库中的包和元数据。 在 ansible-core 2.11、2.12 和 2.13 中，默认值为 true。 此选项在 RHEL 8 中已弃用。如果您使用的是上述版本之一，可以将此选项设置为 None 以避免传递未知的配置选项。 选项 false true
attributes 别名：attr 字符串	生成的 filesystem 对象应具有的属性。 要获取支持的标志，请查看目标系统上 *chattr* 的手册页。 此字符串应按 *lsattr* 显示的相同顺序包含属性。 = 运算符被假定为默认值，否则需要在字符串中包含 + 或 - 运算符。
bandwidth 字符串	最大可用网络带宽，单位为字节/秒。与 throttle 选项一起使用。 如果 throttle 是百分比且带宽为 0，则带宽限制将被禁用。如果 throttle 表示为数据速率（字节/秒），则忽略此选项。默认为 0（无带宽限制）。
baseurl 列表 / 元素=字符串	指向 yum 仓库的“repodata”目录所在的目录的 URL。 它也可以是多个 URL 的列表。 如果 state 设置为 present，则需要此参数、metalink 或 mirrorlist 参数。
cost 字符串	访问此仓库的相对成本。用于将一个仓库的包的权重设置得高于/低于任何其他仓库。
deltarpm_metadata_percentage 字符串	当 deltarpm 元数据与包的相对大小大于此值时，不会从仓库下载 deltarpm 元数据。请注意，您可以提供大于 100 的值，因此 200 表示元数据的大小需要是包大小的一半。使用 0 关闭此检查，始终下载元数据。
deltarpm_percentage 字符串	当 delta 与包的相对大小大于此值时，不使用 delta。使用 0 关闭 delta rpm 处理。本地仓库（使用 file://baseurl）默认情况下关闭 delta rpm。
description 字符串	描述仓库的人类可读字符串。此选项对应于 repo 文件中的“name”属性。 如果 state 设置为 present，则此参数是必需的。
enabled 布尔值	这告诉 yum 是否使用此仓库。 Yum 默认值为 true。 选项 false true
enablegroups 布尔值	确定 yum 是否允许为此仓库使用软件包组。 Yum 默认值为 true。 选项 false true
exclude 列表 / 元素=字符串	要从更新或安装中排除的软件包列表。这应该是一个空格分隔的列表。允许使用通配符（例如 * 和 ?）的 shell 通配符。 列表也可以是常规的 YAML 数组。
failovermethod 字符串	roundrobin 随机选择 URL 列表中的一个 URL 开始，并在遇到联系主机失败时依次遍历每个 URL。 priority 从列出的第一个 baseurl 开始，并按顺序读取它们。 选项 "roundrobin" "priority"
file 字符串	保存仓库的文件名，不包含 .repo 扩展名。默认为 name 的值。
gpgcakey 字符串	指向仓库的 ASCII 编码 CA 密钥文件的 URL。
gpgcheck 布尔值	告诉 yum 是否应该对软件包执行 GPG 签名检查。 没有默认设置。如果未设置该值，则将使用 /etc/yum.conf 中的系统设置或 false 的系统默认值。 选项 false true
gpgkey 列表 / 元素=字符串	指向仓库的 ASCII 编码 GPG 密钥文件的 URL。 它也可以是多个 URL 的列表。
group 字符串	应该拥有文件系统对象的组名，如同提供给 chown 命令一样。 如果未指定，则使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。
http_caching 字符串	确定如何指示上游 HTTP 缓存处理 Yum 执行的任何 HTTP 下载。 all 表示应缓存所有 HTTP 下载。 packages 表示仅应缓存 RPM 软件包下载（但不缓存仓库元数据下载）。 none 表示不应缓存任何 HTTP 下载。 选项 "all" "packages" "none"
include 字符串	包含外部配置文件。支持本地路径和 URL。配置文件将插入 include= 行的位置。包含的文件可能包含更多 include 行。如果检测到包含循环，Yum 将中止并报错。
includepkgs 列表 / 元素=字符串	您只想从仓库中使用的软件包列表。这应该是一个空格分隔的列表。允许使用通配符（例如 * 和 ?）的 shell 通配符。此处支持替换变量（例如 $releasever）。 列表也可以是常规的 YAML 数组。
ip_resolve 字符串	确定 yum 如何解析主机名。 4 或 IPv4 - 仅解析为 IPv4 地址。 6 或 IPv6 - 仅解析为 IPv6 地址。 选项 "4" "6" "IPv4" "IPv6" "whatever"
keepalive 布尔值	这告诉 yum 是否应在此仓库中使用 HTTP/1.1 keepalive。通过在从仓库下载多个文件时使用一个连接，这可以提高传输速度。 选项 false true
keepcache 字符串	1 或 0。确定在成功安装后 yum 是否保留标题和软件包的缓存。 此参数已弃用，将在 2.20 版本中删除。 选项 "0" "1"
metadata_expire 字符串	元数据过期的时间（以秒为单位）。 默认值为 6 小时。
metadata_expire_filter 字符串	过滤 metadata_expire 时间，如果命令不需要，则允许以速度换取准确性。每个 yum 命令都可以指定它需要远程仓库的特定及时性质量级别。从“我即将安装/升级，所以这最好是最新的”到“任何可用的都足够好”。 never - 不过滤任何内容，始终遵守 metadata_expire。 read-only:past - 仅关心过去信息的命令将从元数据过期中过滤掉。例如，yum history 信息（如果历史记录需要查找有关先前事务的任何信息，则根据定义，远程软件包过去可用）。 read-only:present - 在过去和未来之间取得平衡的命令。例如 yum list yum。 read-only:future - 可能导致运行其他命令的命令，这些命令需要最新的元数据。例如 yum check-update。 请注意，此选项不会覆盖“yum clean expire-cache”。 选项 "never" "read-only:past" "read-only:present" "read-only:future"
metalink 字符串	指定 repomd.xml 的 metalink 文件的 URL，通过将 repomd.xml 文件的镜像转换为 baseurl，生成整个仓库的镜像列表。 如果 state 设置为 present，则需要此参数、baseurl 或 mirrorlist 参数。
mirrorlist 字符串	指定包含 baseurl 列表的文件的 URL。 如果 state 设置为 present，则需要此参数、baseurl 或 metalink 参数。
mirrorlist_expire 字符串	本地缓存的镜像列表过期的时间（以秒为单位）。 默认值为 6 小时。
mode any	生成的文 件系统对象应具有的权限。 对于习惯使用 /usr/bin/chmod 的用户，请记住模式实际上是八进制数。您必须为 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，'644' 或 '1777'），以便 Ansible 接收到一个字符串并可以自行将字符串转换为数字。添加前导零（例如，0755）有时有效，但在循环和其他一些情况下可能会失败。 如果不遵循这些规则中的任何一个而向 Ansible 提供数字，则最终会得到一个十进制数，这将产生意外的结果。 从 Ansible 1.8 开始，模式可以指定为符号模式（例如，u+rwx 或 u=rw,g=r,o=r）。 如果未指定 mode 且目标文件系统对象**不存在**，则在设置新创建的文件系统对象的模式时，将使用系统上的默认 umask。 如果未指定 mode 且目标文件系统对象**存在**，则将使用现有文件系统对象的模式。 指定 mode 是确保以正确的权限创建文件系统对象的最佳方法。有关详细信息，请参阅 CVE-2020-1736。
module_hotfixes 布尔值 添加到 ansible-core 2.11	禁用模块 RPM 过滤并使仓库中的所有 RPM 都可用。默认为 None。 选项 false true
name 字符串 / 必需	唯一的仓库 ID。此选项在仓库文件中构建仓库的节名称。 仅当state设置为present或absent时，才需要此参数。
owner 字符串	文件系统对象的拥有者用户名，类似于 `chown` 命令的参数。 未指定时，如果非root用户，则使用当前用户；如果是root用户，则保留之前的拥有者。 指定数字用户名将被视为用户ID而非用户名。为避免混淆，请避免使用数字用户名。
password 字符串	用于基本身份验证的用户名密码。
priority 字符串	强制执行仓库的有序保护。值是一个 1 到 99 的整数。 此选项仅在安装了 YUM Priorities 插件时有效。
protect 布尔值	保护软件包免受其他仓库的更新。 选项 false true
proxy 字符串	yum 应该使用的代理服务器 URL。设置为_none_以禁用全局代理设置。
proxy_password 字符串	此代理的密码。
proxy_username 字符串	用于代理的用户名。
repo_gpgcheck 布尔值	此参数告诉 yum 是否应该对来自此仓库的 repodata 执行 GPG 签名检查。 选项 false true
reposdir path	存储 .repo 文件的目录。 默认值： "/etc/yum.repos.d"
retries 字符串	设置尝试检索文件失败后，在返回错误之前应重试的次数。设置为0表示 yum 将无限重试。
s3_enabled 布尔值	启用对 S3 仓库的支持。 此选项仅在安装了 YUM S3 插件时有效。 选项 false true
selevel 字符串	SELinux 文件系统对象上下文中的级别部分。 这是 MLS/MCS 属性，有时称为 range。 设置为_default时，如果可用，它将使用策略的 level 部分。
serole 字符串	SELinux 文件系统对象上下文中的角色部分。 设置为_default时，如果可用，它将使用策略的 role 部分。
setype 字符串	SELinux 文件系统对象上下文中的类型部分。 设置为_default时，如果可用，它将使用策略的 type 部分。
seuser 字符串	SELinux 文件系统对象上下文中的用户部分。 默认情况下，它使用 system 策略（如果适用）。 设置为_default时，如果可用，它将使用策略的 user 部分。
skip_if_unavailable 布尔值	如果设置为true，如果由于任何原因无法联系此仓库，yum 将继续运行。应谨慎设置此选项，因为任何给定命令都会咨询所有仓库。 选项 false true
ssl_check_cert_permissions 布尔值	yum 是否应该检查仓库证书（远程和本地）路径上的权限。 如果我们无法读取任何文件，则 yum 将强制skip_if_unavailable为true。这对于在仅root用户可读的仓库客户端证书文件的仓库上使用 yum 的非root进程最为有用。 选项 false true
sslcacert 别名：ca_cert 字符串	包含 yum 应该用来验证 SSL 证书的证书颁发机构数据库的目录路径。
sslclientcert 别名：client_cert 字符串	yum 应该用来连接到仓库/远程站点的 SSL 客户端证书路径。
sslclientkey 别名：client_key 字符串	yum 应该用来连接到仓库/远程站点的 SSL 客户端密钥路径。
sslverify 别名：validate_certs 布尔值	定义 yum 是否应该验证 SSL 证书/主机。 选项 false true
state 字符串	仓库文件的状态。 选项 "absent" "present" ← (默认)
throttle 字符串	启用下载带宽限制。 此选项可以表示为以字节/秒为单位的绝对数据速率。可以在带宽值后附加 SI 前缀 (k、M 或 G)。
timeout 字符串	等待连接超时之前的秒数。
ui_repoid_vars 字符串	显示仓库 ID 时，如果这些 yum 变量在 baseurl 等中使用，则将它们附加到字符串中。变量按照列出的顺序（以及找到的顺序）附加。
unsafe_writes 布尔值	影响何时使用原子操作来防止目标文件系统对象的数据损坏或不一致读取。 默认情况下，此模块使用原子操作来防止目标文件系统对象的数据损坏或不一致读取，但有时系统配置或损坏的方式会阻止此操作。一个例子是 docker 挂载的文件系统对象，这些对象无法从容器内部以原子方式更新，只能以不安全的方式写入。 此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。 重要！不安全写入容易出现竞争条件，并可能导致数据损坏。 选项 false ← (默认) true
username 字符串	用于对仓库或任何 URL 进行基本身份验证的用户名。

属性

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 下运行并返回更改状态预测，而无需修改目标，如果不支持，则将跳过操作。
diff_mode	支持：完全支持	在 diff 模式下，将返回有关更改内容（或可能需要在 check_mode 下更改的内容）的详细信息。
platform	平台： rhel	可以对其进行操作的目标操作系统/系列

备注

注意

• 如果修改现有的仓库文件，所有注释都将被删除。

• 在现有的仓库文件中保留节的顺序。

• 节中的参数在现有的仓库文件中按字母顺序排列。

• 如果仓库文件不包含任何仓库，则它将被自动删除。

• 删除仓库时，请注意磁盘上的元数据缓存可能仍然保留，直到运行 yum clean all 为止。为此使用通知处理程序。

• 由于规避了 Ansible 的参数处理，Ansible 2.5 中已删除 params 参数。

示例

- 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 字符串	仓库名称 返回：成功 示例： "epel"
state 字符串	执行后目标的状态 返回：成功 示例： "present"

作者

• Jiri Tyr (@jtyr)

收藏链接

• 问题追踪器
• 代码库（源代码）
• 通信