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

注意

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

概要

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

注意

此模块具有相应的操作插件。

别名：yum

要求

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

• python3-dnf

参数

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

属性

属性	支持	描述
action	支持：部分 dnf 有 2 个在底层使用它的 action 插件，ansible.builtin.dnf 和 ansible.builtin.package。	表示它具有相应的 action 插件，因此可以在控制器上执行部分选项
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 以及将 action 插件作为 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)

集合链接

• 问题跟踪器
• 存储库（源）
• 沟通