mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
l*.py: normalize docs (#9390)
This commit is contained in:
parent
6b7ea3443d
commit
cea6eeef37
25 changed files with 1194 additions and 1350 deletions
|
@ -8,16 +8,14 @@ from __future__ import (absolute_import, division, print_function)
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
author:
|
||||
- Naval Patel (@navalkp)
|
||||
- Prashant Bhosale (@prabhosa)
|
||||
module: lxca_cmms
|
||||
short_description: Custom module for lxca cmms inventory utility
|
||||
description:
|
||||
- This module returns/displays a inventory details of cmms
|
||||
|
||||
- This module returns/displays a inventory details of cmms.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
|
@ -26,32 +24,28 @@ attributes:
|
|||
|
||||
options:
|
||||
uuid:
|
||||
description:
|
||||
uuid of device, this is string with length greater than 16.
|
||||
description: UUID of device, this is string with length greater than 16.
|
||||
type: str
|
||||
|
||||
command_options:
|
||||
description:
|
||||
options to filter nodes information
|
||||
description: Options to filter nodes information.
|
||||
default: cmms
|
||||
choices:
|
||||
- cmms
|
||||
- cmms_by_uuid
|
||||
- cmms_by_chassis_uuid
|
||||
- cmms
|
||||
- cmms_by_uuid
|
||||
- cmms_by_chassis_uuid
|
||||
type: str
|
||||
|
||||
chassis:
|
||||
description:
|
||||
uuid of chassis, this is string with length greater than 16.
|
||||
description: UUID of chassis, this is string with length greater than 16.
|
||||
type: str
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.lxca_common
|
||||
- community.general.attributes
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# get all cmms info
|
||||
- name: Get nodes data from LXCA
|
||||
community.general.lxca_cmms:
|
||||
|
@ -76,28 +70,27 @@ EXAMPLES = '''
|
|||
auth_url: "https://10.243.15.168"
|
||||
chassis: "3C737AA5E31640CE949B10C129A8B01F"
|
||||
command_options: cmms_by_chassis_uuid
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
result:
|
||||
description: cmms detail from lxca
|
||||
returned: success
|
||||
type: dict
|
||||
sample:
|
||||
cmmList:
|
||||
- machineType: ''
|
||||
model: ''
|
||||
type: 'CMM'
|
||||
uuid: '118D2C88C8FD11E4947B6EAE8B4BDCDF'
|
||||
description: Cmms detail from lxca.
|
||||
returned: success
|
||||
type: dict
|
||||
sample:
|
||||
cmmList:
|
||||
- machineType: ''
|
||||
model: ''
|
||||
type: 'CMM'
|
||||
uuid: '118D2C88C8FD11E4947B6EAE8B4BDCDF'
|
||||
# bunch of properties
|
||||
- machineType: ''
|
||||
model: ''
|
||||
type: 'CMM'
|
||||
uuid: '223D2C88C8FD11E4947B6EAE8B4BDCDF'
|
||||
- machineType: ''
|
||||
model: ''
|
||||
type: 'CMM'
|
||||
uuid: '223D2C88C8FD11E4947B6EAE8B4BDCDF'
|
||||
# bunch of properties
|
||||
# Multiple cmms details
|
||||
'''
|
||||
"""
|
||||
|
||||
import traceback
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue