[PR #9373/d96e5604 backport][stable-10] [onev ... ovh]*.py: normalize docs (#9381)

[onev ... ovh]*.py: normalize docs (#9373)

* [onev ... ovh]*.py: normalize docs

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d96e56048f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 22:56:20 +01:00 committed by GitHub
commit e38f9e5cfc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 956 additions and 1021 deletions

View file

@ -8,45 +8,43 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: oneview_logical_interconnect_group
short_description: Manage OneView Logical Interconnect Group resources
description:
- Provides an interface to manage Logical Interconnect Group resources. Can create, update, or delete.
- Provides an interface to manage Logical Interconnect Group resources. Can create, update, or delete.
requirements:
- hpOneView >= 4.0.0
- hpOneView >= 4.0.0
author:
- Felipe Bulsoni (@fgbulsoni)
- Thiago Miotto (@tmiotto)
- Adriane Cardozo (@adriane-cardozo)
- Felipe Bulsoni (@fgbulsoni)
- Thiago Miotto (@tmiotto)
- Adriane Cardozo (@adriane-cardozo)
attributes:
check_mode:
support: none
diff_mode:
support: none
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:
- Indicates the desired state for the Logical Interconnect Group resource.
V(absent) will remove the resource from OneView, if it exists.
V(present) will ensure data properties are compliant with OneView.
type: str
choices: [absent, present]
default: present
data:
description:
- List with the Logical Interconnect Group properties.
type: dict
required: true
state:
description:
- Indicates the desired state for the Logical Interconnect Group resource.
- V(absent) will remove the resource from OneView, if it exists.
- V(present) will ensure data properties are compliant with OneView.
type: str
choices: [absent, present]
default: present
data:
description:
- List with the Logical Interconnect Group properties.
type: dict
required: true
extends_documentation_fragment:
- community.general.oneview
- community.general.oneview.validateetag
- community.general.attributes
- community.general.oneview
- community.general.oneview.validateetag
- community.general.attributes
"""
'''
EXAMPLES = '''
EXAMPLES = r"""
- name: Ensure that the Logical Interconnect Group is present
community.general.oneview_logical_interconnect_group:
config: /etc/oneview/oneview_config.json
@ -57,15 +55,15 @@ EXAMPLES = '''
enclosureType: C7000
interconnectMapTemplate:
interconnectMapEntryTemplates:
- logicalDownlinkUri: ~
- logicalDownlinkUri:
logicalLocation:
locationEntries:
- relativeValue: 1
type: Bay
- relativeValue: 1
type: Enclosure
locationEntries:
- relativeValue: 1
type: Bay
- relativeValue: 1
type: Enclosure
permittedInterconnectTypeName: HP VC Flex-10/10D Module
# Alternatively you can inform permittedInterconnectTypeUri
# Alternatively you can inform permittedInterconnectTypeUri
delegate_to: localhost
- name: Ensure that the Logical Interconnect Group has the specified scopes
@ -95,14 +93,14 @@ EXAMPLES = '''
data:
name: New Logical Interconnect Group
delegate_to: localhost
'''
"""
RETURN = '''
RETURN = r"""
logical_interconnect_group:
description: Has the facts about the OneView Logical Interconnect Group.
returned: On state 'present'. Can be null.
type: dict
'''
description: Has the facts about the OneView Logical Interconnect Group.
returned: On O(state=present). Can be null.
type: dict
"""
from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase, OneViewModuleResourceNotFound