ansible.builtin.dnf5 模块 - 使用 dnf5 包管理器管理软件包

注意

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

在 ansible-core 2.15 中新增

摘要

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

  • 警告:dnf5 包管理器仍在开发中,并非所有现有 ansible.builtin.dnf 模块提供的功能都在 ansible.builtin.dnf5 中实现,请咨询特定选项以了解更多信息。

需求

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

  • python3-libdnf5

参数

参数

注释

allow_downgrade

布尔值

指定是否允许指定的软件包和版本降级可能已经安装的该软件包的更高版本。请注意,设置 allow_downgrade=true 会使此模块的行为不幂等。该任务最终可能具有一组与要安装的指定软件包的完整列表不匹配的软件包(因为降级软件包与其他软件包之间的依赖关系会导致对先前事务中存在的软件包进行更改)。

选项

  • false ← (默认)

  • true

allowerasing

布尔值

如果 true,则允许擦除已安装的软件包以解决依赖关系。

选项

  • false ← (默认)

  • true

autoremove

布尔值

如果 true,则从系统中删除所有最初作为用户安装的软件包的依赖关系安装的“叶”软件包,但这些软件包不再被任何此类软件包需要。应单独使用或与 state=absent 一起使用。

选项

  • false ← (默认)

  • true

best

布尔值

在 ansible-core 2.17 中添加

设置为 true 时,使用可用的最高版本软件包或失败。

设置为 false 时,如果无法安装最新版本,则使用较低版本。

默认值由操作系统发行版设置。

选项

  • false

  • true

bugfix

布尔值

如果设置为 true,并且 state=latest,则仅安装已标记为错误修复相关的更新。

请注意,类似于 dnf upgrade-minimal,此过滤器也适用于依赖关系。

选项

  • false ← (默认)

  • true

cacheonly

布尔值

告诉 dnf 仅从系统缓存运行;不下载或更新元数据。

选项

  • false ← (默认)

  • true

conf_file

字符串

要用于事务的远程 dnf 配置文件。

disable_excludes

字符串

禁用在 DNF 配置文件中定义的排除项。

如果设置为 all,则禁用所有排除项。

如果设置为 main,则禁用在 dnf.conf 中的 [main] 中定义的排除项。

如果设置为 repoid,则禁用为给定仓库 ID 定义的排除项。

disable_gpg_check

布尔值

是否禁用对正在安装的软件包签名的 GPG 检查。仅当 statepresentlatest 时生效。

此设置影响从仓库安装的软件包以及从文件系统或 URL 安装的“本地”软件包。

选项

  • false ← (默认)

  • true

disable_plugin

列表 / 元素=字符串

要为安装/更新操作禁用的 插件 名称。禁用的插件不会在事务结束后持续存在。

disable_pluginenable_plugindisable_plugin 中都列出插件的情况下具有优先级。

需要 python3-libdnf5 5.2.0.0+

默认值: []

disablerepo

列表 / 元素=字符串

要为安装/更新操作禁用的仓库的 仓库 ID。这些仓库不会在事务结束后持续存在。当指定多个仓库时,请用 , 分隔它们。

默认值: []

download_dir

字符串

指定一个用于存储软件包的备用目录。

仅当指定了 download_only 时生效。

download_only

布尔值

仅下载软件包,不安装它们。

选项

  • false ← (默认)

  • true

enable_plugin

列表 / 元素=字符串

要为安装/更新操作启用的 插件 名称。启用的插件不会在事务结束后持续存在。

disable_pluginenable_plugindisable_plugin 中都列出插件的情况下具有优先级。

需要 python3-libdnf5 5.2.0.0+

默认值: []

enablerepo

列表 / 元素=字符串

要为安装/更新操作启用的仓库的 仓库 ID。这些仓库不会在事务结束后持续存在。当指定多个仓库时,请用 , 分隔它们。

默认值: []

exclude

列表 / 元素=字符串

state=presentstate=latest 时要排除的软件包名称。这可以是列表或逗号分隔的字符串。

默认值: []

install_repoquery

布尔值

这在 DNF 中实际上是无操作,因为它在 DNF 中不需要。

此选项已弃用,将在 ansible-core 2.20 中删除。

选项

  • false

  • true ← (默认)

install_weak_deps

布尔值

还将安装所有通过弱依赖关系关联的软件包。

选项

  • false

  • true ← (默认)

installroot

字符串

指定一个备用安装根目录,所有软件包都将相对于该目录安装。

默认值: "/"

list

字符串

/usr/bin/ansible(而不是剧本)一起使用的各种(非幂等)命令。使用 ansible.builtin.package_facts 而不是 list 参数作为最佳实践。

lock_timeout

整数

这目前是无操作,因为 dnf5 不提供配置它的选项。

等待 dnf 锁定文件释放的时间量。

默认值: 30

name

别名:pkg

列表 / 元素=字符串

包名或带版本的包说明符,例如 name-1.0。当使用 state=latest 时,可以为 *,这意味着运行:dnf -y update。您也可以传递 rpm 文件的 URL 或本地路径。要操作多个包,它可以接受用逗号分隔的包字符串或包列表。

包版本的比较运算符在这里有效 ><>=<=。例如 - name >= 1.0。运算符周围需要空格。

您也可以传递包提供的要安装的二进制文件的绝对路径。有关更多信息,请参阅示例。

默认值: []

nobest

布尔值

这是 best 选项的相反,为了向后兼容而保留。

从 ansible-core 2.17 开始,默认值由操作系统发行版设置。

选项

  • false

  • true

releasever

字符串

指定一个备用发行版,从中安装所有包。

security

布尔值

如果设置为 true,并且 state=latest,则只安装标记为安全相关的更新。

请注意,类似于 dnf upgrade-minimal,此过滤器也适用于依赖关系。

选项

  • false ← (默认)

  • true

skip_broken

布尔值

跳过所有不可用的包或依赖关系有问题的包,不引发错误。等效于传递 --skip-broken 选项。

选项

  • false ← (默认)

  • true

sslverify

布尔值

禁用此事务的存储库服务器的 SSL 验证。

如果配置的存储库之一使用不可信或自签名证书,则应将其设置为 false

选项

  • false

  • true ← (默认)

state

字符串

是否安装 (presentlatest) 或删除 (absent) 包。

默认值为 None,但是实际上,默认操作为 present,除非 autoremove=true,否则会推断出 absent

选项

  • "absent"

  • "present"

  • "installed"

  • "removed"

  • "latest"

update_cache

别名:expire-cache

布尔值

强制 dnf 检查缓存是否已过期,并在需要时重新下载。只有当 state=presentstate=latest 时才会生效。

选项

  • false ← (默认)

  • true

update_only

布尔值

使用最新版本时,只更新已安装的包。不安装包。

只有当 state=presentstate=latest 时才会生效。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

在 dnf5 模块中实际上是一个无操作,因为 dnf5 本身处理将 https url 作为 rpm 的源进行下载,但它是为了与 ansible.builtin.dnf 模块的功能一致性/兼容性而接受的参数。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

action

支持:部分

dnf5 有 2 个在后台使用它的操作插件,ansible.builtin.dnfansible.builtin.package.

表示它有相应的操作插件,因此选项的某些部分可以在控制器上执行

async

支持:

支持与 async 关键字一起使用

bypass_host_loop

支持:

强制执行一个“全局”任务,该任务不按主机执行,这绕过了按主机进行模板化以及串行、节流和其他循环考虑因素

条件将像使用 run_once 一样工作,使用的变量将来自第一个可用主机

此操作在非步调一致策略之外将无法正常工作

check_mode

支持:完全

可以在 check_mode 下运行并返回更改状态预测,而不会修改目标,如果不支持,则会跳过操作。

diff_mode

支持:完全

将在更改时(或可能在 check_mode 下需要更改时)返回有关更改内容的详细信息,处于 diff 模式时

platform

平台: rhel

可以对其进行操作的目标操作系统/系列

示例

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

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

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

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

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

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

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

- name: Install the nginx rpm from a remote repo
  ansible.builtin.dnf5:
    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.dnf5:
    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.dnf5:
    name: /usr/bin/cowsay
    state: present

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

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

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

返回值

常见返回值在 此处 有记录,以下是此模块特有的字段

描述

failures

列表 / 元素=字符串

dnf 事务失败的列表

已返回: failure

示例: ["Argument 'lsof' matches only excluded packages."]

msg

字符串

有关结果的附加信息

已返回: always

示例: "Nothing to do"

rc

整数

为了兼容性,成功为 0,失败为 1

已返回: always

示例: 0

results

列表 / 元素=字符串

dnf 事务结果的列表

已返回: success

示例: ["Installed: lsof-4.94.0-4.fc37.x86_64"]

作者

  • Ansible 核心团队