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 相对于 pkg 的大小超过此值时，不会使用 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= 行的位置插入。包含的文件可能包含更多包含行。如果检测到包含循环，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 用于此存储库。这可以通过在从存储库下载多个文件时使用一个连接来提高传输速度。 此参数已弃用，因为它对使用 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 string / required	唯一的存储库 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 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 文件系统对象上下文的 role 部分。 如果设置为 _default，它将使用策略（如果可用）的 role 部分。
setype 字符串	SELinux 文件系统对象上下文的 type 部分。 如果设置为 _default，它将使用策略（如果可用）的 type 部分。
seuser 字符串	SELinux 文件系统对象上下文的 user 部分。 默认情况下，它使用 system 策略（如果适用）。 如果设置为 _default，它将使用策略（如果可用）的 user 部分。
skip_if_unavailable 布尔值	如果设置为 true，yum 将会继续运行，即使该仓库因任何原因无法访问。应该谨慎设置此选项，因为所有仓库都会被查询以执行任何给定命令。 选项 false true
ssl_check_cert_permissions 布尔值	是否应该让 yum 检查仓库（远程和本地）上的证书路径的权限。 如果我们无法读取任何文件，yum 将强制 skip_if_unavailable 为 true。这对于使用 yum 在具有仅 root 可读的客户端证书文件的仓库上进行操作的非 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	支持：完全支持	将在差异模式下返回有关更改内容（或可能需要在 check_mode 下更改的内容）的详细信息。
platform	平台： rhel	可以对其进行操作的目标操作系统/系列。

说明

注意

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

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

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

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

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

• 在 Ansible 2.5 中删除了 params 参数，因为它绕过了 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 字符串	仓库名称 返回：成功 示例： "epel"
state 字符串	执行后目标的状态 返回：成功 示例： "present"

作者

• Jiri Tyr (@jtyr)

集合链接

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