mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-02 22:39:09 -07:00
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>
This commit is contained in:
parent
a99f72fc36
commit
a9fca56374
17 changed files with 596 additions and 639 deletions
|
@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: manageiq_policies
|
||||
|
||||
short_description: Management of resource policy_profiles in ManageIQ
|
||||
|
@ -21,7 +20,6 @@ extends_documentation_fragment:
|
|||
author: Daniel Korn (@dkorn)
|
||||
description:
|
||||
- The manageiq_policies module supports adding and deleting policy_profiles in ManageIQ.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
|
@ -33,7 +31,7 @@ options:
|
|||
type: str
|
||||
description:
|
||||
- V(absent) - policy_profiles should not exist,
|
||||
- V(present) - policy_profiles should exist,
|
||||
- V(present) - policy_profiles should exist.
|
||||
choices: ['absent', 'present']
|
||||
default: 'present'
|
||||
policy_profiles:
|
||||
|
@ -47,9 +45,8 @@ options:
|
|||
description:
|
||||
- The type of the resource to which the profile should be [un]assigned.
|
||||
required: true
|
||||
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster',
|
||||
'data store', 'group', 'resource pool', 'service', 'service template',
|
||||
'template', 'tenant', 'user']
|
||||
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template',
|
||||
'template', 'tenant', 'user']
|
||||
resource_name:
|
||||
type: str
|
||||
description:
|
||||
|
@ -61,9 +58,9 @@ options:
|
|||
- The ID of the resource to which the profile should be [un]assigned.
|
||||
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
|
||||
version_added: 2.2.0
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Assign new policy_profile for a provider in ManageIQ
|
||||
community.general.manageiq_policies:
|
||||
resource_name: 'EngLab'
|
||||
|
@ -74,7 +71,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: Unassign a policy_profile for a provider in ManageIQ
|
||||
community.general.manageiq_policies:
|
||||
|
@ -87,13 +84,13 @@ 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"""
|
||||
manageiq_policies:
|
||||
description:
|
||||
- List current policy_profile and policies for a provider in ManageIQ
|
||||
- List current policy_profile and policies for a provider in ManageIQ.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: '{
|
||||
|
@ -122,7 +119,7 @@ manageiq_policies:
|
|||
}
|
||||
]
|
||||
}'
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.manageiq import ManageIQ, manageiq_argument_spec, manageiq_entities
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue