community.general/lib/ansible/utils/module_docs_fragments/manageiq.py
Yaacov Zamir 48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
2017-08-03 10:49:47 -04:00

55 lines
1.8 KiB
Python

#
# (c) 2017, Daniel Korn <korndaniel1@gmail.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object):
# Standard ManageIQ documentation fragment
DOCUMENTATION = """
options:
manageiq_connection:
required: true
description:
- ManageIQ connection configuration information.
suboptions:
url:
required: true
description:
- ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it.
username:
required: true
description:
- ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, it is required to pass it.
password:
required: true
description:
- ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, it is required to pass it.
verify_ssl:
required: false
default: true
description:
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
ca_bundle_path:
required: false
default: null
description:
- The path to a CA bundle file or directory with certificates. defaults to None.
requirements:
- 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
"""