mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
[PR #9354/97514612 backport][stable-10] r*: normalize docs (#9377)
r*: normalize docs (#9354)
* r*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* Apply suggestions from code review
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 9751461295
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
899fcb8749
commit
f6fa7fb273
22 changed files with 1858 additions and 1947 deletions
|
@ -8,18 +8,15 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: rhsm_release
|
||||
short_description: Set or Unset RHSM Release version
|
||||
description:
|
||||
- Sets or unsets the release version used by RHSM repositories.
|
||||
notes:
|
||||
- This module will fail on an unregistered system.
|
||||
Use the M(community.general.redhat_subscription) module to register a system
|
||||
prior to setting the RHSM release.
|
||||
- It is possible to interact with C(subscription-manager) only as root,
|
||||
so root permissions are required to successfully run this module.
|
||||
- This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system prior to setting
|
||||
the RHSM release.
|
||||
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module.
|
||||
requirements:
|
||||
- Red Hat Enterprise Linux 6+ with subscription-manager installed
|
||||
extends_documentation_fragment:
|
||||
|
@ -37,9 +34,9 @@ options:
|
|||
type: str
|
||||
author:
|
||||
- Sean Myers (@seandst)
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# Set release version to 7.1
|
||||
- name: Set RHSM release version
|
||||
community.general.rhsm_release:
|
||||
|
@ -53,15 +50,15 @@ EXAMPLES = '''
|
|||
# Unset release version
|
||||
- name: Unset RHSM release release
|
||||
community.general.rhsm_release:
|
||||
release: null
|
||||
'''
|
||||
release:
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
current_release:
|
||||
description: The current RHSM release version value
|
||||
description: The current RHSM release version value.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue