mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 10:21:25 -07:00
[PR #9393/84655b0d backport][stable-10] i[b-n]*.py: normalize docs (#9412)
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
0df708b15a
commit
05ba79c5fe
25 changed files with 1036 additions and 1100 deletions
|
@ -10,92 +10,90 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: ibm_sa_domain
|
||||
short_description: Manages domains on IBM Spectrum Accelerate Family storage systems
|
||||
|
||||
description:
|
||||
- "This module can be used to add domains to or removes them from IBM Spectrum Accelerate Family storage systems."
|
||||
|
||||
- This module can be used to add domains to or removes them from IBM Spectrum Accelerate Family storage systems.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
domain:
|
||||
description:
|
||||
- Name of the domain to be managed.
|
||||
required: true
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- The desired state of the domain.
|
||||
default: "present"
|
||||
choices: [ "present", "absent" ]
|
||||
type: str
|
||||
ldap_id:
|
||||
description:
|
||||
- ldap id to add to the domain.
|
||||
required: false
|
||||
type: str
|
||||
size:
|
||||
description:
|
||||
- Size of the domain.
|
||||
required: false
|
||||
type: str
|
||||
hard_capacity:
|
||||
description:
|
||||
- Hard capacity of the domain.
|
||||
required: false
|
||||
type: str
|
||||
soft_capacity:
|
||||
description:
|
||||
- Soft capacity of the domain.
|
||||
required: false
|
||||
type: str
|
||||
max_cgs:
|
||||
description:
|
||||
- Number of max cgs.
|
||||
required: false
|
||||
type: str
|
||||
max_dms:
|
||||
description:
|
||||
- Number of max dms.
|
||||
required: false
|
||||
type: str
|
||||
max_mirrors:
|
||||
description:
|
||||
- Number of max_mirrors.
|
||||
required: false
|
||||
type: str
|
||||
max_pools:
|
||||
description:
|
||||
- Number of max_pools.
|
||||
required: false
|
||||
type: str
|
||||
max_volumes:
|
||||
description:
|
||||
- Number of max_volumes.
|
||||
required: false
|
||||
type: str
|
||||
perf_class:
|
||||
description:
|
||||
- Add the domain to a performance class.
|
||||
required: false
|
||||
type: str
|
||||
domain:
|
||||
description:
|
||||
- Name of the domain to be managed.
|
||||
required: true
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- The desired state of the domain.
|
||||
default: "present"
|
||||
choices: ["present", "absent"]
|
||||
type: str
|
||||
ldap_id:
|
||||
description:
|
||||
- LDAP id to add to the domain.
|
||||
required: false
|
||||
type: str
|
||||
size:
|
||||
description:
|
||||
- Size of the domain.
|
||||
required: false
|
||||
type: str
|
||||
hard_capacity:
|
||||
description:
|
||||
- Hard capacity of the domain.
|
||||
required: false
|
||||
type: str
|
||||
soft_capacity:
|
||||
description:
|
||||
- Soft capacity of the domain.
|
||||
required: false
|
||||
type: str
|
||||
max_cgs:
|
||||
description:
|
||||
- Number of max cgs.
|
||||
required: false
|
||||
type: str
|
||||
max_dms:
|
||||
description:
|
||||
- Number of max dms.
|
||||
required: false
|
||||
type: str
|
||||
max_mirrors:
|
||||
description:
|
||||
- Number of max_mirrors.
|
||||
required: false
|
||||
type: str
|
||||
max_pools:
|
||||
description:
|
||||
- Number of max_pools.
|
||||
required: false
|
||||
type: str
|
||||
max_volumes:
|
||||
description:
|
||||
- Number of max_volumes.
|
||||
required: false
|
||||
type: str
|
||||
perf_class:
|
||||
description:
|
||||
- Add the domain to a performance class.
|
||||
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: Define new domain.
|
||||
community.general.ibm_sa_domain:
|
||||
domain: domain_name
|
||||
|
@ -112,14 +110,14 @@ EXAMPLES = '''
|
|||
username: admin
|
||||
password: secret
|
||||
endpoints: hostdev-system
|
||||
'''
|
||||
RETURN = '''
|
||||
"""
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: module return status.
|
||||
returned: as needed
|
||||
type: str
|
||||
sample: "domain 'domain_name' created successfully."
|
||||
'''
|
||||
description: Module return status.
|
||||
returned: as needed
|
||||
type: str
|
||||
sample: "domain 'domain_name' created successfully."
|
||||
"""
|
||||
|
||||
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