mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
011b2f8bdc
* Start using semantic markup. * Forgot some places. * Fix typo. * Use 'ignore:' prefix until https://github.com/ansible-community/antsibull-docs/pull/155 is out. * Break too long line.
53 lines
1.8 KiB
Python
53 lines
1.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2017, Daniel Korn <korndaniel1@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Standard ManageIQ documentation fragment
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
manageiq_connection:
|
|
description:
|
|
- ManageIQ connection configuration information.
|
|
required: false
|
|
type: dict
|
|
suboptions:
|
|
url:
|
|
description:
|
|
- ManageIQ environment URL. C(MIQ_URL) environment variable if set. otherwise, it is required to pass it.
|
|
type: str
|
|
required: false
|
|
username:
|
|
description:
|
|
- ManageIQ username. C(MIQ_USERNAME) environment variable if set. otherwise, required if no token is passed in.
|
|
type: str
|
|
password:
|
|
description:
|
|
- ManageIQ password. C(MIQ_PASSWORD) environment variable if set. otherwise, required if no token is passed in.
|
|
type: str
|
|
token:
|
|
description:
|
|
- ManageIQ token. C(MIQ_TOKEN) environment variable if set. otherwise, required if no username or password is passed in.
|
|
type: str
|
|
validate_certs:
|
|
description:
|
|
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
|
|
type: bool
|
|
default: true
|
|
aliases: [ verify_ssl ]
|
|
ca_cert:
|
|
description:
|
|
- The path to a CA bundle file or directory with certificates. defaults to None.
|
|
type: str
|
|
aliases: [ ca_bundle_path ]
|
|
|
|
requirements:
|
|
- 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
|
|
'''
|