mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 18:31: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
|
@ -10,65 +10,61 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: ibm_sa_vol_map
|
||||
short_description: Handles volume mapping on IBM Spectrum Accelerate Family storage systems
|
||||
|
||||
description:
|
||||
- "This module maps volumes to or unmaps them from the hosts on
|
||||
IBM Spectrum Accelerate Family storage systems."
|
||||
|
||||
- This module maps volumes to or unmaps them from the hosts on IBM Spectrum Accelerate Family storage systems.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
vol:
|
||||
description:
|
||||
- Volume name.
|
||||
required: true
|
||||
type: str
|
||||
state:
|
||||
default: "present"
|
||||
choices: [ "present", "absent" ]
|
||||
description:
|
||||
- When the state is present the volume is mapped.
|
||||
When the state is absent, the volume is meant to be unmapped.
|
||||
type: str
|
||||
vol:
|
||||
description:
|
||||
- Volume name.
|
||||
required: true
|
||||
type: str
|
||||
state:
|
||||
default: "present"
|
||||
choices: ["present", "absent"]
|
||||
description:
|
||||
- When the state is present the volume is mapped. When the state is absent, the volume is meant to be unmapped.
|
||||
type: str
|
||||
|
||||
cluster:
|
||||
description:
|
||||
- Maps the volume to a cluster.
|
||||
required: false
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Maps the volume to a host.
|
||||
required: false
|
||||
type: str
|
||||
lun:
|
||||
description:
|
||||
- The LUN identifier.
|
||||
required: false
|
||||
type: str
|
||||
override:
|
||||
description:
|
||||
- Overrides the existing volume mapping.
|
||||
required: false
|
||||
type: str
|
||||
cluster:
|
||||
description:
|
||||
- Maps the volume to a cluster.
|
||||
required: false
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Maps the volume to a host.
|
||||
required: false
|
||||
type: str
|
||||
lun:
|
||||
description:
|
||||
- The LUN identifier.
|
||||
required: false
|
||||
type: str
|
||||
override:
|
||||
description:
|
||||
- Overrides the existing volume mapping.
|
||||
required: false
|
||||
type: str
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.ibm_storage
|
||||
- community.general.attributes
|
||||
|
||||
author:
|
||||
- Tzur Eliyahu (@tzure)
|
||||
'''
|
||||
- Tzur Eliyahu (@tzure)
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Map volume to host.
|
||||
community.general.ibm_sa_vol_map:
|
||||
vol: volume_name
|
||||
|
@ -96,9 +92,9 @@ EXAMPLES = '''
|
|||
password: secret
|
||||
endpoints: hostdev-system
|
||||
state: absent
|
||||
'''
|
||||
RETURN = '''
|
||||
'''
|
||||
"""
|
||||
RETURN = r"""
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.ibm_sa_utils import (execute_pyxcli_command,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue