ansible.builtin.package_facts module – Package information as facts
Note
This module is part of ansible-core and included in all Ansible installations. In most cases, you can use the short module name package_facts even without specifying the collections keyword. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.package_facts for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.
Synopsis
- Return information about installed packages as facts.
Requirements
The below requirements are needed on the host that executes this module.
- For ‘portage’ support it requires the
qlistutility, which is part of ‘app-portage/portage-utils’. - For Debian-based systems
python-aptpackage must be installed on targeted hosts. - For SUSE-based systems
python3-rpmpackage must be installed on targeted hosts. This package is required because SUSE does not include RPM Python bindings by default.
Parameters
Parameter | Comments |
|---|---|
manager list / elements=string | The package manager used by the system so we can query the package information. Since 2.8 this is a list and can support multiple package managers per system. The ‘portage’ and ‘pkg’ options were added in version 2.8. The ‘apk’ option was added in version 2.11. The ‘pkg_info’ option was added in version 2.13. Choices:
Default: |
strategy string added in Ansible 2.8 | This option controls how the module queries the package managers on the system. Choices:
|
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
facts | Support: full | Action returns an |
platform | Platform: posix | Target OS/families that can be operated against |
Examples
- name: Gather the package facts
ansible.builtin.package_facts:
manager: auto
- name: Print the package facts
ansible.builtin.debug:
var: ansible_facts.packages
- name: Check whether a package called foobar is installed
ansible.builtin.debug:
msg: "{{ ansible_facts.packages['foobar'] | length }} versions of foobar are installed!"
when: "'foobar' in ansible_facts.packages"
Returned Facts
Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
Key | Description |
|---|---|
packages dictionary | Maps the package name to a non-empty list of dicts with package information. Every dict in the list corresponds to one installed version of the package. The fields described below are present for all package managers. Depending on the package manager, there might be more fields for a package. Returned: when operating system level package manager is specified or auto detected manager Sample: |
|
name string |
The package’s name. Returned: always |
|
source string |
Where information on the package came from. Returned: always |
|
version string |
The package’s version. Returned: always |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/package_facts_module.html