W3cubDocs

/Ansible

community.general.yum_versionlock module – Locks / unlocks a installed package(s) from being updated by yum package manager

Note

This module is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.yum_versionlock.

New in community.general 2.0.0

Synopsis

  • This module adds installed packages to yum versionlock to prevent the package(s) from being updated.

Requirements

The below requirements are needed on the host that executes this module.

  • yum
  • yum-versionlock

Parameters

Parameter

Comments

name

list / elements=string / required

Package name or a list of package names with optional version or wildcards.

Specifying versions is supported since community.general 7.2.0.

state

string

If state is present, package(s) is/are added to yum versionlock list.

If state is absent, package(s) is/are removed from yum versionlock list.

Choices:

  • "absent"
  • "present" ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

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

Notes

Note

  • Requires yum-plugin-versionlock package on the remote node.

Examples

- name: Prevent Apache / httpd from being updated
  community.general.yum_versionlock:
    state: present
    name:
      - httpd

- name: Prevent Apache / httpd version 2.4.57-2 from being updated
  community.general.yum_versionlock:
    state: present
    name:
      - httpd-0:2.4.57-2.el9

- name: Prevent multiple packages from being updated
  community.general.yum_versionlock:
    state: present
    name:
      - httpd
      - nginx
      - haproxy
      - curl

- name: Remove lock from Apache / httpd to be updated again
  community.general.yum_versionlock:
    state: absent
    name: httpd

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

packages

list / elements=string

A list of package(s) in versionlock list.

Returned: success

Sample: ["httpd"]

state

string

State of package(s).

Returned: success

Sample: "present"

Authors

  • Florian Paul Azim Hoberg (@gyptazy)
  • Amin Vakil (@aminvakil)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/yum_versionlock_module.html