ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-20 01:11:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[ab]*.py: normalize docs (#9421)

Browse source 
* [ab]*.py: normalize docs

* Update plugins/modules/atomic_image.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-28 02:29:15 +13:00 • committed by GitHub
parent 43599c6850
commit 2a2a9661d9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1931 additions and 2013 deletions
Download patch file Download diff file Expand all files Collapse all files

46
plugins/modules/bootc_manage.py
View file

@ -8,34 +8,32 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: bootc_manage
version_added: 9.3.0
author:
- Ryan Cook (@cooktheryan)
- Ryan Cook (@cooktheryan)
short_description: Bootc Switch and Upgrade
description:
- This module manages the switching and upgrading of C(bootc).
- This module manages the switching and upgrading of C(bootc).
options:
state:
description:
- 'Control to apply the latest image or switch the image.'
- 'B(Note:) This will not reboot the system.'
- 'Please use M(ansible.builtin.reboot) to reboot the system.'
required: true
type: str
choices: ['switch', 'latest']
image:
description:
- 'The image to switch to.'
- 'This is required when O(state=switch).'
required: false
type: str
state:
description:
- Control whether to apply the latest image or switch the image.
- B(Note:) This will not reboot the system.
- Please use M(ansible.builtin.reboot) to reboot the system.
required: true
type: str
choices: ['switch', 'latest']
image:
description:
- The image to switch to.
- This is required when O(state=switch).
required: false
type: str
"""
'''
EXAMPLES = '''
EXAMPLES = r"""
# Switch to a different image
- name: Provide image to switch to a different image and retain the current running image
community.general.bootc_manage:
@ -46,10 +44,10 @@ EXAMPLES = '''
- name: Apply updates of the current running image
community.general.bootc_manage:
state: latest
'''
"""
RETURN = '''
'''
RETURN = r"""
"""
from ansible.module_utils.basic import AnsibleModule