manageiq: Clean up parameter types (#52538)

This PR includes:
- Parameter types added
- Copyright format fixes
- Short license statement

This breaks out PR #52182
pull/52605/head
Dag Wieers 5 years ago committed by Sandra McCann
parent a7846391a9
commit 4dce9c4da9

@ -1,38 +1,47 @@
# (c) 2017, Daniel Korn <korndaniel1@gmail.com> # -*- coding: utf-8 -*-
# Copyright: (c) 2017, Daniel Korn <korndaniel1@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard ManageIQ documentation fragment # Standard ManageIQ documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
manageiq_connection: manageiq_connection:
required: true
description: description:
- ManageIQ connection configuration information. - ManageIQ connection configuration information.
required: true
type: dict
suboptions: suboptions:
url: url:
required: true
description: description:
- ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it. - ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it.
type: str
required: true
username: username:
description: description:
- ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in. - ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in.
type: str
password: password:
description: description:
- ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in. - ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in.
type: str
token: token:
description: description:
- ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in. - ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in.
type: str
verify_ssl: verify_ssl:
description: description:
- Whether SSL certificates should be verified for HTTPS requests. defaults to True. - Whether SSL certificates should be verified for HTTPS requests. defaults to True.
default: true type: bool
default: yes
ca_bundle_path: ca_bundle_path:
description: description:
- The path to a CA bundle file or directory with certificates. defaults to None. - The path to a CA bundle file or directory with certificates. defaults to None.
type: path
requirements: requirements:
- 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)' - 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
""" '''

Loading…
Cancel
Save