W3cubDocs

/Ansible

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

Note

This plugin is part of the community.general collection (version 3.8.1).

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.

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

New in version 2.0.0: of community.general

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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	Choices/Defaults	Comments
name list / elements=string / required		Package name or a list of packages.
state string	Choices: absent present ←	If state is `present`, package(s) will be added to yum versionlock list. If state is `absent`, package(s) will be removed from yum versionlock list.

Notes

Note

Requires yum-plugin-versionlock package on the remote node.
Supports check_mode.

Examples

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

- 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
    package: httpd

Return Values

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

Key	Returned	Description
packages list / elements=string	success	A list of package(s) in versionlock list. Sample: ['httpd']
state string	success	State of package(s). Sample: present

Authors

Florian Paul Hoberg (@florianpaulhoberg)
Amin Vakil (@aminvakil)

© 2012–2018 Michael DeHaan
© 2018–2021 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