mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
[PR #9389/a9fca563 backport][stable-10] ma*.py: normalize docs (#9405)
ma*.py: normalize docs (#9389)
* ma*.py: normalize docs
* Update plugins/modules/matrix.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit a9fca56374
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
11ba71c802
commit
29e9afcbf4
17 changed files with 596 additions and 639 deletions
|
@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function)
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: manageiq_alert_profiles
|
||||
|
||||
short_description: Configuration of alert profiles for ManageIQ
|
||||
|
@ -20,7 +19,6 @@ extends_documentation_fragment:
|
|||
author: Elad Alfassa (@elad661) <ealfassa@redhat.com>
|
||||
description:
|
||||
- The manageiq_alert_profiles module supports adding, updating and deleting alert profiles in ManageIQ.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
|
@ -31,8 +29,8 @@ options:
|
|||
state:
|
||||
type: str
|
||||
description:
|
||||
- absent - alert profile should not exist,
|
||||
- present - alert profile should exist,
|
||||
- V(absent) - alert profile should not exist,
|
||||
- V(present) - alert profile should exist.
|
||||
choices: ['absent', 'present']
|
||||
default: 'present'
|
||||
name:
|
||||
|
@ -43,23 +41,21 @@ options:
|
|||
resource_type:
|
||||
type: str
|
||||
description:
|
||||
- The resource type for the alert profile in ManageIQ. Required when state is "present".
|
||||
choices: ['Vm', 'ContainerNode', 'MiqServer', 'Host', 'Storage', 'EmsCluster',
|
||||
'ExtManagementSystem', 'MiddlewareServer']
|
||||
- The resource type for the alert profile in ManageIQ. Required when O(state=present).
|
||||
choices: ['Vm', 'ContainerNode', 'MiqServer', 'Host', 'Storage', 'EmsCluster', 'ExtManagementSystem', 'MiddlewareServer']
|
||||
alerts:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- List of alert descriptions to assign to this profile.
|
||||
- Required if state is "present"
|
||||
- Required if O(state=present).
|
||||
notes:
|
||||
type: str
|
||||
description:
|
||||
- Optional notes for this profile
|
||||
- Optional notes for this profile.
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Add an alert profile to ManageIQ
|
||||
community.general.manageiq_alert_profiles:
|
||||
state: present
|
||||
|
@ -72,7 +68,7 @@ EXAMPLES = '''
|
|||
url: 'http://127.0.0.1:3000'
|
||||
username: 'admin'
|
||||
password: 'smartvm'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Delete an alert profile from ManageIQ
|
||||
community.general.manageiq_alert_profiles:
|
||||
|
@ -82,11 +78,11 @@ EXAMPLES = '''
|
|||
url: 'http://127.0.0.1:3000'
|
||||
username: 'admin'
|
||||
password: 'smartvm'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
'''
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
'''
|
||||
RETURN = r"""
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.manageiq import ManageIQ, manageiq_argument_spec
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue