ansible.builtin.yum_repository 模块 - 添加或删除 YUM 存储库

注意

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

概要

• 在基于 RPM 的 Linux 发行版中添加或删除 YUM 存储库。

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

参数

参数	注释
异步 布尔值	如果设置为 true，Yum 将尽可能地并行下载此存储库中的软件包和元数据。 在 ansible-core 2.11、2.12 和 2.13 中，默认值为 true。 此选项已在 RHEL 8 中删除。如果您使用的是上述版本之一，可以将此选项设置为 null，以避免传递未知的配置选项。 此参数已弃用，因为它已在 ansible-core 支持的系统上删除，并将从 ansible-core 2.22 中删除。 选择 假 真
属性 别名：attr 字符串	结果文件系统对象应具有的属性。 要获取支持的标志，请查看目标系统上 chattr 的手册页。 此字符串应按与 lsattr 显示相同的顺序包含属性。 默认情况下假定为 = 运算符，否则需要在字符串中包含 + 或 - 运算符。
带宽 字符串	最大可用网络带宽，以字节/秒为单位。与 throttle 选项一起使用。 如果 throttle 是百分比且带宽为 0，则带宽限制将被禁用。如果 throttle 以数据速率 (字节/秒) 表示，则忽略此选项。默认值为 0（无带宽限制）。
基础网址 列表 / 元素=字符串	指向 yum 存储库的“repodata”目录所在的目录的 URL。 它也可以是多个 URL 的列表。 如果 state 设置为 present，则此参数、metalink 或 mirrorlist 参数是必需的。
成本 字符串	访问此存储库的相对成本。用于将一个存储库的软件包的权重与任何其他存储库的软件包的权重进行比较。
计数我 布尔值 在 ansible-core 2.18 中添加	每周是否应向随机选择的 metalink/mirrorlist 查询添加特殊标志。这允许存储库所有者估计使用它的系统数量。 选择 假 真
deltarpm_metadata_percentage 字符串	当 deltarpm 元数据的相对大小与软件包相比大于此值时，不会从存储库下载 deltarpm 元数据。请注意，您可以给出超过 100 的值，因此 200 表示元数据的大小必须是软件包大小的一半。使用 0 来关闭此检查，并始终下载元数据。 此参数已弃用，因为它对 dnf 作为底层软件包管理器没有影响，并将从 ansible-core 2.22 中删除。
deltarpm_percentage 字符串	当 delta 与软件包的相对大小大于此值时，不使用 delta。使用 0 关闭 delta rpm 处理。本地存储库（具有 file://baseurl）默认情况下关闭了 delta rpm。
描述 字符串	一个描述存储库的人类可读字符串。此选项对应于 repo 文件中的 name 属性。 此参数仅在 state=present 时才需要。
已启用 布尔值	这告诉 yum 是否使用此存储库。 Yum 默认值为 true。 选择 假 真
启用组 布尔值	确定 yum 是否允许在此存储库中使用软件包组。 Yum 默认值为 true。 选择 假 真
排除 别名：excludepkgs 列表 / 元素=字符串	要从更新或安装中排除的软件包列表。这应该是一个空格分隔的列表。允许使用通配符（例如 * 和 ?）的 shell 通配符。 列表也可以是常规的 YAML 数组。 excludepkgs 别名是在 ansible-core 2.18 中添加的。
故障转移方法 字符串	roundrobin 随机从 URL 列表中选择一个 URL 开始，并在遇到连接主机失败时依次遍历每个 URL。 priority 从列出的第一个 baseurl 开始，并按顺序读取它们。 选择 "轮循" "优先级"
文件 字符串	用于保存仓库的文件名，不包括 .repo 扩展名。默认值为 name 的值。
gpgcakey 字符串	指向仓库的 ASCII 编码 CA 密钥文件的 URL。 此参数已弃用，因为它对 dnf 作为底层软件包管理器没有影响，并将从 ansible-core 2.22 中删除。
gpgcheck 布尔值	告诉 yum 是否应该对软件包进行 GPG 签名检查。 没有默认设置。如果未设置该值，将使用 /etc/yum.conf 中的系统设置或 false 的系统默认值。 选择 假 真
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 中删除。 选择 假 真
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 提供足够的 information 以便正确解析它们。为了获得一致的结果，请引用八进制数（例如，'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。 选择 假 真
name string / required	唯一的仓库 ID。此选项构建仓库在 repo 文件中的部分名称。 此参数仅在 state 设置为 present 或 absent 时才需要。
owner 字符串	应该拥有文件系统对象的用户的名称，如同传递给 chown 一样。 如果未指定，它将使用当前用户，除非您是 root，在这种情况下它可以保留之前的拥有权。 指定数字用户名将被假定为用户 ID 而不是用户名。避免数字用户名以避免这种混淆。
password 字符串	与用户名一起用于基本身份验证的密码。
priority 字符串	强制执行对仓库的有序保护。该值是一个介于 1 到 99 之间的整数。 此选项仅在安装了 YUM Priorities 插件时才有效。
protect 布尔值	保护软件包免受来自其他仓库的更新。 此参数已弃用，因为它对 dnf 作为底层软件包管理器没有影响，并将从 ansible-core 2.22 中删除。 选择 假 真
proxy 字符串	yum 应该使用的代理服务器的 URL。设置为 _none_ 以禁用全局代理设置。
proxy_password 字符串	此代理的密码。
proxy_username 字符串	用于代理的用户名。
repo_gpgcheck 布尔值	这告诉 yum 是否应该对来自此仓库的 repodata 进行 GPG 签名检查。 选择 假 真
reposdir path	存储 .repo 文件的目录。 默认值： "/etc/yum.repos.d"
retries 字符串	设置在返回错误之前任何尝试检索文件的重试次数。将其设置为 0 将使 yum 永久尝试。
s3_enabled 布尔值	启用对 S3 仓库的支持。 此选项仅在安装了 YUM S3 插件时才有效。 选择 假 真
selevel 字符串	SELinux 文件系统对象上下文的 level 部分。 这是 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 将继续运行，即使由于任何原因无法联系到此仓库。应谨慎设置此选项，因为所有仓库都会针对任何给定命令进行咨询。 选择 假 真
ssl_check_cert_permissions 布尔值	yum 是否应该检查仓库（远程和本地）上的证书路径的权限。 如果我们无法读取任何文件，则 yum 将强制 skip_if_unavailable 为 true。这对于在仅 root 可读的证书文件的仓库上使用 yum 的非 root 进程最为有用。 此参数已弃用，因为它对 dnf 作为底层软件包管理器没有影响，并将从 ansible-core 2.22 中删除。 选择 假 真
sslcacert 别名：ca_cert 字符串	包含 yum 应用于验证 SSL 证书的证书颁发机构数据库的目录路径。
sslclientcert 别名：client_cert 字符串	yum 应用于连接到仓库/远程站点的 SSL 客户端证书路径。
sslclientkey 别名：client_key 字符串	yum 应用于连接到仓库/远程站点的 SSL 客户端密钥路径。
sslverify 别名：validate_certs 布尔值	定义 yum 是否应该完全验证 SSL 证书/主机。 选择 假 真
state 字符串	仓库文件的 state。 选择 "absent" "present" ← (默认)
throttle 字符串	启用下载带宽节流。 此选项可以表示为以字节/秒为单位的绝对数据速率。可以在带宽值后附加 SI 前缀 (k、M 或 G)。
timeout 字符串	在超时之前等待连接的时间（以秒为单位）。
ui_repoid_vars 字符串	当显示仓库 ID 时，如果这些 yum 变量在 baseurl/等中使用，则将这些 yum 变量附加到字符串中。按列出的顺序（和找到的顺序）附加变量。 此参数已弃用，因为它对 dnf 作为底层软件包管理器没有影响，并将从 ansible-core 2.22 中删除。
unsafe_writes 布尔值	影响何时使用原子操作以防止目标文件系统对象的数据损坏或不一致的读取。 默认情况下，此模块使用原子操作以防止目标文件系统对象的数据损坏或不一致的读取，但有时系统会以阻止这种操作的方式进行配置或只是损坏。例如，docker 挂载的文件系统对象，无法从容器内部进行原子更新，只能以不安全的方式写入。 此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全的写入）。 重要！不安全的写入会受到竞争条件的影响，并可能导致数据损坏。 选择 false ← (默认) 真
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 字符串	执行后目标的 state 返回：成功 示例："present"

作者

• Jiri Tyr (@jtyr)

集合链接

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