community.general.rhsm_release module – Set or Unset RHSM Release version
Note
This module is part of the community.general collection (version 8.6.4).
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.rhsm_release
.
Synopsis
Sets or unsets the release version used by RHSM repositories.
Aliases: packaging.os.rhsm_release
Requirements
The below requirements are needed on the host that executes this module.
Red Hat Enterprise Linux 6+ with subscription-manager installed
Parameters
Parameter |
Comments |
---|---|
RHSM release version to use. To unset either pass |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
This module will fail on an unregistered system. Use the community.general.redhat_subscription module to register a system prior to setting the RHSM release.
It is possible to interact with
subscription-manager
only as root, so root permissions are required to successfully run this module.
Examples
# Set release version to 7.1
- name: Set RHSM release version
community.general.rhsm_release:
release: "7.1"
# Set release version to 6Server
- name: Set RHSM release version
community.general.rhsm_release:
release: "6Server"
# Unset release version
- name: Unset RHSM release release
community.general.rhsm_release:
release: null
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The current RHSM release version value Returned: success |