ansible.builtin.dnf module – Manages packages with the dnf package manager
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
dnf
even without specifying the collections keyword.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.dnf
for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
Synopsis
Installs, upgrade, removes, and lists packages and groups with the dnf package manager.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
python-dnf
for the autoremove option you need dnf >= 2.0.1”
Parameters
Parameter |
Comments |
---|---|
Specify if the named package and version is allowed to downgrade a maybe already installed higher version of that package. Note that setting allow_downgrade=True can make this module behave in a non-idempotent way. The task could end up with a set of packages that does not match the complete list of specified packages to install (because dependencies between the downgraded package and others can cause changes to the packages which were in the earlier transaction). Choices:
|
|
If Choices:
|
|
If Choices:
|
|
When set to When set to Default is set by the operating system distribution. Choices:
|
|
If set to Note that, similar to Choices:
|
|
Tells dnf to run entirely from system cache; does not download or update metadata. Choices:
|
|
The remote dnf configuration file to use for the transaction. |
|
Disable the excludes defined in DNF config files. If set to If set to If set to |
|
Whether to disable the GPG checking of signatures of packages being installed. Has an effect only if This setting affects packages installed from a repository as well as “local” packages installed from the filesystem or a URL. Choices:
|
|
Plugin name to disable for the install/update operation. The disabled plugins will not persist beyond the transaction. Default: |
|
Repoid of repositories to disable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a “,”. Default: |
|
Specifies an alternate directory to store packages. Has an effect only if |
|
Only download the packages, do not install them. Choices:
|
|
Plugin name to enable for the install/update operation. The enabled plugin will not persist beyond the transaction. Default: |
|
Repoid of repositories to enable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a “,”. Default: |
|
Package name(s) to exclude when state=present, or latest. This can be a list or a comma separated string. Default: |
|
This is effectively a no-op in DNF as it is not needed with DNF. This option is deprecated and will be removed in ansible-core 2.20. Choices:
|
|
Will also install all packages linked by a weak dependency relation. Choices:
|
|
Specifies an alternative installroot, relative to which all packages will be installed. Default: |
|
Various (non-idempotent) commands for usage with |
|
Amount of time to wait for the dnf lockfile to be freed. Default: |
|
A package name or package specifier with version, like Comparison operators for package version are valid here You can also pass an absolute path for a binary which is provided by the package to install. See examples for more information. Default: |
|
This is the opposite of the Since ansible-core 2.17 the default value is set by the operating system distribution. Choices:
|
|
Specifies an alternative release from which all packages will be installed. |
|
If set to Note that, similar to Choices:
|
|
Skip all unavailable packages or packages with broken dependencies without raising an error. Equivalent to passing the –skip-broken option. Choices:
|
|
Disables SSL validation of the repository server for this transaction. This should be set to Choices:
|
|
Whether to install ( Default is Choices:
|
|
Force dnf to check if cache is out of date and redownload if needed. Has an effect only if Choices:
|
|
When using latest, only update installed packages. Do not install packages. Has an effect only if Choices:
|
|
Backend module to use. Choices:
|
|
This only applies if using a https url as the source of the rpm. e.g. for localinstall. If set to This should only set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: partial dnf has 2 action plugins that use it under the hood, ansible.builtin.dnf and ansible.builtin.package. |
Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller |
|
Support: none |
Supports being used with the |
|
Support: none |
Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations Conditionals will work as if This action will not work normally outside of lockstep strategies |
|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platform: rhel |
Target OS/families that can be operated against |
Notes
Note
When used with a
loop:
each package will be processed individually, it is much more efficient to pass the list directly to the name option.Group removal doesn’t work if the group was installed with Ansible because upstream dnf’s API doesn’t properly mark groups as installed, therefore upon removal the module is unable to detect that the group is installed (https://bugzilla.redhat.com/show_bug.cgi?id=1620324)
While
use_backend=yum
and the ability to call the action plugin as ansible.builtin.yum are provided for syntax compatibility, the YUM backend was removed in ansible-core 2.17 because the required libraries are not available for any supported version of Python. If you rely on this functionality, use an older version of Ansible.
Examples
- 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: 'http://nginx.org/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