[PR #9309/b57fef20 backport][stable-9] [vw]*: adjust docs (#9325)

[vw]*: adjust docs (#9309)

[vm]*: adjust docs

(cherry picked from commit b57fef201e)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-23 12:22:42 +01:00 committed by GitHub
parent 3dd1c9d64a
commit 19b6f9ef3f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 353 additions and 507 deletions

View file

@ -8,14 +8,12 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: wdc_redfish_info
short_description: Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs
version_added: 5.4.0
description:
- Builds Redfish URIs locally and sends them to remote OOB controllers to
get information back.
- Builds Redfish URIs locally and sends them to remote OOB controllers to get information back.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
@ -33,11 +31,11 @@ options:
elements: str
baseuri:
description:
- Base URI of OOB controller. Must include this or O(ioms).
- Base URI of OOB controller. Must include this or O(ioms).
type: str
ioms:
description:
- List of IOM FQDNs for the enclosure. Must include this or O(baseuri).
- List of IOM FQDNs for the enclosure. Must include this or O(baseuri).
type: list
elements: str
username:
@ -59,13 +57,12 @@ options:
type: int
notes:
- In the inventory, you can specify baseuri or ioms. See the EXAMPLES section.
- ioms is a list of FQDNs for the enclosure's IOMs.
- In the inventory, you can specify baseuri or ioms. See the EXAMPLES section.
- Ioms is a list of FQDNs for the enclosure's IOMs.
author: Mike Moerk (@mikemoerk)
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Get Simple Update Status with individual IOMs specified
community.general.wdc_redfish_info:
category: Update
@ -93,30 +90,30 @@ EXAMPLES = '''
- name: Print fetched information
ansible.builtin.debug:
msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"
'''
"""
RETURN = '''
RETURN = r"""
Description:
description: Firmware update status description.
returned: always
type: str
sample: Ready for FW update
description: Firmware update status description.
returned: always
type: str
sample: Ready for FW update
ErrorCode:
description: Numeric error code for firmware update status. Non-zero indicates an error condition.
returned: always
type: int
sample: 0
description: Numeric error code for firmware update status. Non-zero indicates an error condition.
returned: always
type: int
sample: 0
EstimatedRemainingMinutes:
description: Estimated number of minutes remaining in firmware update operation.
returned: always
type: int
sample: 20
description: Estimated number of minutes remaining in firmware update operation.
returned: always
type: int
sample: 20
StatusCode:
description: Firmware update status code.
returned: always
type: int
sample: 2
'''
description: Firmware update status code.
returned: always
type: int
sample: 2
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_native