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

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定集合关键字，您也可以使用短模块名称 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 中删除。如果您使用的是上面列出的版本之一，则可以将此选项设置为 null 以避免传递未知的配置选项。 此参数已弃用，因为它已在 ansible-core 支持的系统上删除，并且将在 ansible-core 2.22 中删除。 选项 false true
attributes 别名：attr 字符串	结果文件系统对象应具有的属性。 要获取支持的标志，请查看目标系统上的 chattr 的手册页。 此字符串应包含与 lsattr 显示的顺序相同的属性。 默认情况下假定 = 运算符，否则需要在字符串中包含 + 或 - 运算符。
bandwidth 字符串	最大可用网络带宽，单位为字节/秒。与 throttle 选项一起使用。 如果 throttle 是百分比，并且带宽为 0，则将禁用带宽限制。如果 throttle 表示为数据速率（字节/秒），则将忽略此选项。默认值为 0（无带宽限制）。
baseurl 列表 / 元素=字符串	Yum 仓库的 “repodata” 目录所在的目录 URL。 它也可以是多个 URL 的列表。 如果 state 设置为 present，则需要此参数、 metalink 或 mirrorlist 参数。
cost 字符串	访问此仓库的相对成本。用于衡量一个仓库的软件包比其他仓库的软件包的优先级高/低。
countme 布尔值 在 ansible-core 2.18 中添加	是否应该每周向随机选择的 metalink/mirrorlist 查询添加一个特殊标志。这允许仓库所有者估计使用它的系统数量。 选项 false true
deltarpm_metadata_percentage 字符串	当 deltarpm 元数据与软件包的相对大小大于此值时，不会从仓库下载 deltarpm 元数据。请注意，您可以提供大于 100 的值，因此 200 表示元数据的大小必须是软件包的一半。使用 0 关闭此检查，并始终下载元数据。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。
deltarpm_percentage 字符串	当 delta 与软件包的相对大小大于此值时，不使用 delta。使用 0 关闭 delta rpm 处理。默认情况下，本地仓库（使用 file://baseurl）已关闭 delta rpm。
description 字符串	描述仓库的可读字符串。此选项对应于仓库文件中的 name 属性。 仅当 state=present 时才需要此参数。
enabled 布尔值	这告诉 yum 是否使用此仓库。 Yum 默认值为 true。 选项 false true
enablegroups 布尔值	确定 yum 是否允许为此仓库使用软件包组。 Yum 默认值为 true。 选项 false true
exclude 别名：excludepkgs 列表 / 元素=字符串	要从更新或安装中排除的软件包列表。这应该是一个以空格分隔的列表。允许使用通配符的 Shell 模式（例如 * 和 ?）。 该列表也可以是常规 YAML 数组。 excludepkgs 别名在 ansible-core 2.18 中添加。
failovermethod 字符串	roundrobin 随机选择 URL 列表中的一个 URL 开始，并在遇到与主机联系失败时依次遍历每个 URL。 priority 从列出的第一个 baseurl 开始，并按顺序读取它们。 选项 “roundrobin” “priority”
file 字符串	不带 .repo 扩展名的文件名，用于保存仓库。默认为 name 的值。
gpgcakey 字符串	指向仓库的 ASCII 装甲 CA 密钥文件的 URL。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。
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 下载。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。 选项 "all" "packages" "none"
include 字符串	包含外部配置文件。支持本地路径和 URL。配置文件将插入到 include= 行的位置。包含的文件可能包含进一步的 include 行。如果检测到包含循环，Yum 将中止并报错。
includepkgs 列表 / 元素=字符串	您只想从仓库使用的软件包列表。这应该是一个空格分隔的列表。允许使用通配符 (例如 * 和 ?) 的 Shell glob。这里会解析替换变量 (例如 $releasever)。 该列表也可以是常规 YAML 数组。
ip_resolve 字符串	确定 yum 如何解析主机名。 4 或 IPv4 - 仅解析为 IPv4 地址。 6 或 IPv6 - 仅解析为 IPv6 地址。 选项 "4" "6" "IPv4" "IPv6" "whatever"
keepalive 布尔值	这告诉 yum 是否应在此仓库中使用 HTTP/1.1 keepalive。通过在从仓库下载多个文件时使用一个连接，这可以提高传输速度。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。 选项 false true
keepcache 字符串	可以是 1 或 0。确定 yum 在成功安装后是否保留标头和软件包的缓存。 此参数已弃用，因为它仅在主配置中有效，并且将在 ansible-core 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。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。 选项 "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 小时。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。
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 可用。默认值为 null。 选项 false true
name 字符串 / 必需	唯一的仓库 ID。此选项在 repo 文件中构建仓库的节名称。 仅当 state 设置为 present 或 absent 时，才需要此参数。
owner 字符串	应拥有文件系统对象的用户名称，如同提供给 chown 命令的一样。 如果未指定，则使用当前用户，除非您是 root 用户，在这种情况下，它可以保留先前的所有权。 指定数字用户名将被假定为用户 ID 而不是用户名。避免使用数字用户名以避免混淆。
password 字符串	与用户名一起用于基本身份验证的密码。
priority 字符串	强制执行仓库的有序保护。该值是 1 到 99 的整数。 此选项仅在安装了 YUM Priorities 插件时才有效。
protect 布尔值	保护软件包免受其他仓库的更新。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。 选项 false true
proxy 字符串	yum 应使用的代理服务器的 URL。设置为 _none_ 以禁用全局代理设置。
proxy_password 字符串	此代理的密码。
proxy_username 字符串	用于代理的用户名。
repo_gpgcheck 布尔值	这告诉 yum 是否应该对来自此仓库的 repodata 执行 GPG 签名检查。 选项 false true
reposdir 路径	存储 .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 进程最有用。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。 选项 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 等中使用，则将这些变量附加到字符串。变量将按列出的顺序（和找到的顺序）附加。 此参数已弃用，因为它在使用 dnf 作为底层软件包管理器时无效，并且将在 ansible-core 2.22 中删除。
unsafe_writes 布尔值	影响何时使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据。 默认情况下，此模块使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据，但有时系统配置或损坏的方式会阻止此操作。一个例子是 docker 挂载的文件系统对象，它不能从容器内部以原子方式更新，只能以不安全的方式写入。 此选项允许 Ansible 在原子操作失败时回退到更新文件系统对象的不安全方法（但是，它不会强制 Ansible 执行不安全写入）。 重要提示！不安全的写入容易发生竞争条件，并可能导致数据损坏。 选项 false ← (默认) true
username 字符串	用于对仓库或任何 url 进行基本身份验证的用户名。

属性

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

备注

注意

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

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

• 在现有仓库文件中，一个段落中的参数按字母顺序排序。

• 如果仓库文件不包含任何仓库，则会自动删除该文件。

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

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

示例

- 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)

集合链接

• 问题跟踪器
• 仓库（源）
• 通信