mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
[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:
parent
a66b9fc5c9
commit
4dd76284e9
25 changed files with 1036 additions and 1100 deletions
|
@ -8,13 +8,11 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: idrac_redfish_command
|
||||
short_description: Manages Out-Of-Band controllers using iDRAC OEM Redfish APIs
|
||||
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.
|
||||
- For use with Dell iDRAC operations that require Redfish OEM extensions.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
@ -66,34 +64,32 @@ options:
|
|||
version_added: '0.2.0'
|
||||
|
||||
author: "Jose Delarosa (@jose-delarosa)"
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create BIOS configuration job (schedule BIOS setting update)
|
||||
community.general.idrac_redfish_command:
|
||||
category: Systems
|
||||
command: CreateBiosConfigJob
|
||||
resource_id: System.Embedded.1
|
||||
baseuri: "{{ baseuri }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
'''
|
||||
EXAMPLES = r"""
|
||||
- name: Create BIOS configuration job (schedule BIOS setting update)
|
||||
community.general.idrac_redfish_command:
|
||||
category: Systems
|
||||
command: CreateBiosConfigJob
|
||||
resource_id: System.Embedded.1
|
||||
baseuri: "{{ baseuri }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Message with action result or error description
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Action was successful"
|
||||
description: Message with action result or error description.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Action was successful"
|
||||
return_values:
|
||||
description: Dictionary containing command-specific response data from the action.
|
||||
returned: on success
|
||||
type: dict
|
||||
version_added: 6.6.0
|
||||
sample: {
|
||||
"job_id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011"
|
||||
}
|
||||
'''
|
||||
description: Dictionary containing command-specific response data from the action.
|
||||
returned: on success
|
||||
type: dict
|
||||
version_added: 6.6.0
|
||||
sample: {"job_id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011"}
|
||||
"""
|
||||
|
||||
import re
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue