community.general.rhsm_release – Set or Unset RHSM Release version

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.rhsm_release.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Sets or unsets the release version used by RHSM repositories.

Requirements

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

Red Hat Enterprise Linux 6+ with subscription-manager installed

Parameters

Parameter	Choices/Defaults	Comments
release string / required		RHSM release version to use (use null to unset)

Notes

Note

This module will fail on an unregistered system. Use the redhat_subscription module to register a system prior to setting the RHSM release.

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	Returned	Description
current_release string	success	The current RHSM release version value

Authors

Sean Myers (@seandst)

© 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/rhsm_release_module.html