[PR #9393/84655b0d backport][stable-9] i[b-n]*.py: normalize docs (#9411)

i[b-n]*.py: normalize docs (#9393)

* i[b-n]*.py: normalize docs

* Update plugins/modules/ilo_redfish_command.py

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 84655b0d0f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-26 22:44:38 +01:00 committed by GitHub
parent a66b9fc5c9
commit 4dd76284e9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 1036 additions and 1100 deletions

View file

@ -6,14 +6,12 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: ilo_redfish_command
short_description: Manages Out-Of-Band controllers using Redfish APIs
version_added: 6.6.0
description:
- Builds Redfish URIs locally and sends them to remote OOB controllers to
perform an action.
- Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.
attributes:
check_mode:
support: none
@ -62,35 +60,35 @@ options:
type: int
author:
- Varni H P (@varini-hp)
'''
"""
EXAMPLES = '''
- name: Wait for iLO Reboot Completion
community.general.ilo_redfish_command:
category: Systems
command: WaitforiLORebootCompletion
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
'''
EXAMPLES = r"""
- name: Wait for iLO Reboot Completion
community.general.ilo_redfish_command:
category: Systems
command: WaitforiLORebootCompletion
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
"""
RETURN = '''
RETURN = r"""
ilo_redfish_command:
description: Returns the status of the operation performed on the iLO.
type: dict
contains:
WaitforiLORebootCompletion:
description: Returns the output msg and whether the function executed successfully.
type: dict
contains:
ret:
description: Return True/False based on whether the operation was performed successfully.
type: bool
msg:
description: Status of the operation performed on the iLO.
type: str
returned: always
'''
description: Returns the status of the operation performed on the iLO.
type: dict
contains:
WaitforiLORebootCompletion:
description: Returns the output msg and whether the function executed successfully.
type: dict
contains:
ret:
description: Return V(true)/V(false) based on whether the operation was performed successfully.
type: bool
msg:
description: Status of the operation performed on the iLO.
type: str
returned: always
"""
# More will be added as module features are expanded
CATEGORY_COMMANDS_ALL = {