ansible.builtin.dpkg_selections module – Dpkg package selection selections

Note

This module is part of ansible-core and included in all Ansible installations. In most cases, you can use the short module name dpkg_selections even without specifying the collections keyword. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.dpkg_selections for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

Synopsis

  • Change dpkg package selection state via --get-selections and --set-selections.

Parameters

Parameter

Comments

name

string / required

Name of the package.

selection

string / required

The selection state to set the package to.

Choices:

  • "install"

  • "hold"

  • "deinstall"

  • "purge"

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: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platform: debian

Target OS/families that can be operated against

Notes

Note

  • This module will not cause any packages to be installed/removed/purged, use the ansible.builtin.apt module for that.

Examples

- name: Prevent python from being upgraded
  ansible.builtin.dpkg_selections:
    name: python
    selection: hold

- name: Allow python to be upgraded
  ansible.builtin.dpkg_selections:
    name: python
    selection: install

Authors

  • Brian Brazil (@brian-brazil)