ansible.builtin.dnf 模块 – 使用 dnf 包管理器管理软件包

注意

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

概要

• 使用 dnf 包管理器安装、升级、删除和列出软件包和组。

注意

此模块有一个对应的 action 插件。

别名：yum

要求

以下是在执行此模块的主机上所需的要求。

• python >= 2.6

• python-dnf

• 对于 autoremove 选项，您需要 dnf >= 2.0.1”

参数

参数	注释
allow_downgrade 布尔值 在 Ansible 2.7 中添加	指定是否允许指定的软件包和版本降级可能已安装的较高版本的软件包。请注意，设置 allow_downgrade=True 可能会使此模块的行为不具有幂等性。该任务最终可能会得到一组与要安装的指定软件包的完整列表不匹配的软件包（因为降级的软件包和其他软件包之间的依赖关系可能会导致较早的事务中存在的软件包发生更改）。 选项 false ← (默认) true
allowerasing 布尔值 在 ansible-base 2.10 中添加	如果 true，则允许擦除已安装的软件包以解决依赖关系。 选项 false ← (默认) true
autoremove 布尔值	如果 true，则从系统中删除所有最初作为用户安装的软件包的依赖项安装但不再被任何此类软件包需要的“叶”软件包。应单独使用，或者当 state 为 absent 时使用 选项 false ← (默认) true
best 布尔值 在 ansible-core 2.17 中添加	设置为 true 时，要么使用可用的最高版本软件包，要么失败。 设置为 false 时，如果无法安装最新版本，则使用较低的版本。 默认值由操作系统发行版设置。 选项 false true
bugfix 布尔值 在 Ansible 2.7 中添加	如果设置为 true，且 state=latest，则仅安装已标记为与错误修复相关的更新。 请注意，与 dnf upgrade-minimal 类似，此过滤器也适用于依赖项。 选项 false ← (默认) true
cacheonly 布尔值 在 ansible-core 2.12 中添加	告诉 dnf 完全从系统缓存运行；不下载或更新元数据。 选项 false ← (默认) true
conf_file 字符串	用于事务的远程 dnf 配置文件。
disable_excludes 字符串 在 Ansible 2.7 中添加	禁用在 DNF 配置文件中定义的排除项。 如果设置为 all，则禁用所有排除项。 如果设置为 main，则禁用在 dnf.conf 的 [main] 中定义的排除项。 如果设置为 repoid，则禁用为给定仓库 ID 定义的排除项。
disable_gpg_check 布尔值	是否禁用正在安装的软件包的签名的 GPG 检查。仅当 state 为 present 或 latest 时有效。 此设置会影响从仓库安装的软件包以及从文件系统或 URL 安装的“本地”软件包。 选项 false ← (默认) true
disable_plugin 列表 / 元素=字符串 在 Ansible 2.7 中添加	要为安装/更新操作禁用的插件名称。禁用的插件不会在事务之外持久存在。 默认值： []
disablerepo 列表 / 元素=字符串	要禁用安装/更新操作的仓库的Repoid。这些仓库不会在事务处理后保留。指定多个仓库时，请用“,”分隔。 默认值： []
download_dir 字符串 在 Ansible 2.8 中添加	指定一个备用目录来存储软件包。 仅当指定了 download_only 时才有效。
download_only 布尔值 在 Ansible 2.7 中添加	仅下载软件包，不安装它们。 选项 false ← (默认) true
enable_plugin 列表 / 元素=字符串 在 Ansible 2.7 中添加	要在安装/更新操作中启用的插件名称。启用的插件不会在事务处理后保留。 默认值： []
enablerepo 列表 / 元素=字符串	要在安装/更新操作中启用的仓库的Repoid。这些仓库不会在事务处理后保留。指定多个仓库时，请用“,”分隔。 默认值： []
exclude 列表 / 元素=字符串 在 Ansible 2.7 中添加	当 state=present 或 latest 时要排除的软件包名称。它可以是列表或逗号分隔的字符串。 默认值： []
install_repoquery 布尔值 在 Ansible 2.7 中添加	这在 DNF 中实际上是一个空操作，因为 DNF 不需要它。 此选项已弃用，将在 ansible-core 2.20 中删除。 选项 false true ← (默认)
install_weak_deps 布尔值 在 Ansible 2.8 中添加	还将安装通过弱依赖关系链接的所有软件包。 选项 false true ← (默认)
installroot 字符串	指定一个备用安装根目录，所有软件包都将相对于该目录安装。 默认值： "/"
list 字符串	用于 /usr/bin/ansible 的各种（非幂等的）命令，而非 playbook。最佳实践是使用 ansible.builtin.package_facts，而不是 list 参数。
lock_timeout 整数 在 Ansible 2.8 中添加	等待 dnf 锁文件释放的时间。 默认值： 30
name 别名：pkg 列表 / 元素=字符串	软件包名称或带有版本的软件包说明符，如 name-1.0。当使用 state=latest 时，这可以是“*”，表示运行：dnf -y update。你还可以传递一个 URL 或 RPM 文件的本地路径。要对多个软件包进行操作，这可以接受逗号分隔的软件包字符串或软件包列表。 此处可以使用软件包版本的比较运算符 >、<、>=、<=。例如 - name >= 1.0。运算符周围需要空格。 你还可以传递由要安装的软件包提供的二进制文件的绝对路径。有关更多信息，请参阅示例。 默认值： []
nobest 布尔值 在 ansible-core 2.11 中添加	这与为向后兼容而保留的 best 选项相反。 自 ansible-core 2.17 起，默认值由操作系统发行版设置。 选项 false true
releasever 字符串	指定一个备用发行版，从中安装所有软件包。
security 布尔值 在 Ansible 2.7 中添加	如果设置为 true，并且 state=latest，则仅安装标记为与安全相关的更新。 请注意，与 dnf upgrade-minimal 类似，此过滤器也适用于依赖项。 选项 false ← (默认) true
skip_broken 布尔值 在 Ansible 2.7 中添加	跳过所有不可用的软件包或具有损坏依赖关系的软件包，而不引发错误。等效于传递 –skip-broken 选项。 选项 false ← (默认) true
sslverify 布尔值 在 ansible-core 2.13 中添加	禁用此事务的仓库服务器的 SSL 验证。 如果其中一个配置的仓库正在使用不受信任或自签名证书，则应将其设置为 false。 选项 false true ← (默认)
state 字符串	是安装 (present、latest) 还是删除 (absent) 软件包。 默认值为 None，但实际上默认操作是 present，除非为此模块启用了 autoremove 选项，那么会推断为 absent。 选项 "absent" "present" "installed" "removed" "latest"
update_cache 别名：expire-cache 布尔值 在 Ansible 2.7 中添加	强制 dnf 检查缓存是否已过期，如果需要，重新下载。仅当 state 为 present 或 latest 时才有效。 选项 false ← (默认) true
update_only 布尔值 在 Ansible 2.7 中添加	当使用 latest 时，仅更新已安装的软件包。不安装软件包。 仅当 state 为 latest 时才有效 选项 false ← (默认) true
use_backend 字符串 在 ansible-core 2.15 中添加	要使用的后端模块。 选项 "auto" (默认)：基于 ansible_facts.pkg_mgr 事实自动选择后端。 "dnf": ansible.builtin.dnf "dnf4": dnf 的别名 "dnf5": ansible.builtin.dnf5 "yum": auto 的别名（请参阅注释） "yum4": dnf 的别名
validate_certs 布尔值 在 Ansible 2.7 中添加	这仅适用于使用 https url 作为 rpm 的源的情况。例如，对于 localinstall。如果设置为 false，则不会验证 SSL 证书。 这应该仅在个人控制的使用自签名证书的站点上设置为 false，因为它避免了验证源站点。 选项 false true ← (默认)

属性

属性	支持	描述
action	支持： 部分 dnf 有 2 个在后台使用它的操作插件，ansible.builtin.dnf 和 ansible.builtin.package。	指示这有一个对应的操作插件，因此部分选项可以在控制器上执行
async	支持： 无	支持与 async 关键字一起使用
bypass_host_loop	支持： 无	强制执行不按主机执行的“全局”任务，这会绕过按主机模板和串行、节流和其他循环注意事项 条件语句将像使用 run_once 一样工作，使用的变量将来自第一个可用的主机 此操作在锁步策略之外无法正常工作
check_mode	支持： 完整	可以在 check_mode 中运行并返回已更改状态预测，而无需修改目标，如果不支持，则会跳过该操作。
diff_mode	支持： 完整	当处于 diff 模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息
platform	平台： rhel	可以对其执行操作的目标操作系统/系列

注释

注意

• 当与 loop: 一起使用时，每个软件包都将单独处理，直接将列表传递给 name 选项效率更高。

• 如果组是通过 Ansible 安装的，则组删除不起作用，因为上游 dnf 的 API 没有正确地将组标记为已安装，因此在删除时，模块无法检测到该组已安装 (https://bugzilla.redhat.com/show_bug.cgi?id=1620324)

• 虽然提供了 use_backend=yum 和将操作插件调用为 ansible.builtin.yum 的功能，以实现语法兼容性，但 YUM 后端已在 ansible-core 2.17 中删除，因为任何受支持的 Python 版本都无法使用所需的库。如果你依赖此功能，请使用旧版本的 Ansible。

示例

- name: Install the latest version of Apache
  ansible.builtin.dnf:
    name: httpd
    state: latest

- name: Install Apache >= 2.4
  ansible.builtin.dnf:
    name: httpd >= 2.4
    state: present

- name: Install the latest version of Apache and MariaDB
  ansible.builtin.dnf:
    name:
      - httpd
      - mariadb-server
    state: latest

- name: Remove the Apache package
  ansible.builtin.dnf:
    name: httpd
    state: absent

- name: Install the latest version of Apache from the testing repo
  ansible.builtin.dnf:
    name: httpd
    enablerepo: testing
    state: present

- name: Upgrade all packages
  ansible.builtin.dnf:
    name: "*"
    state: latest

- name: Update the webserver, depending on which is installed on the system. Do not install the other one
  ansible.builtin.dnf:
    name:
      - httpd
      - nginx
    state: latest
    update_only: yes

- name: Install the nginx rpm from a remote repo
  ansible.builtin.dnf:
    name: 'https://nginx.ac.cn/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm'
    state: present

- name: Install nginx rpm from a local file
  ansible.builtin.dnf:
    name: /usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm
    state: present

- name: Install Package based upon the file it provides
  ansible.builtin.dnf:
    name: /usr/bin/cowsay
    state: present

- name: Install the 'Development tools' package group
  ansible.builtin.dnf:
    name: '@Development tools'
    state: present

- name: Autoremove unneeded packages installed as dependencies
  ansible.builtin.dnf:
    autoremove: yes

- name: Uninstall httpd but keep its dependencies
  ansible.builtin.dnf:
    name: httpd
    state: absent
    autoremove: no

- name: Install a modularity appstream with defined stream and profile
  ansible.builtin.dnf:
    name: '@postgresql:9.6/client'
    state: present

- name: Install a modularity appstream with defined stream
  ansible.builtin.dnf:
    name: '@postgresql:9.6'
    state: present

- name: Install a modularity appstream with defined profile
  ansible.builtin.dnf:
    name: '@postgresql/client'
    state: present

作者

• Igor Gnatenko (@ignatenkobrain)

• Cristian van Ee (@DJMuggs) <cristian at cvee.org>

• Berend De Schouwer (@berenddeschouwer)

• Adam Miller (@maxamillion)

集合链接

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