mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-23 20:29:08 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
45 lines
1.5 KiB
Python
45 lines
1.5 KiB
Python
# Copyright (c) 2018, www.privaz.io Valletech AB
|
|
# 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
|
|
|
|
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
# OpenNebula common documentation
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
api_url:
|
|
description:
|
|
- The ENDPOINT URL of the XMLRPC server.
|
|
- If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
|
|
type: str
|
|
aliases:
|
|
- api_endpoint
|
|
api_username:
|
|
description:
|
|
- The name of the user for XMLRPC authentication.
|
|
- If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
|
|
type: str
|
|
api_password:
|
|
description:
|
|
- The password or token for XMLRPC authentication.
|
|
- If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
|
|
type: str
|
|
aliases:
|
|
- api_token
|
|
validate_certs:
|
|
description:
|
|
- Whether to validate the TLS/SSL certificates or not.
|
|
- This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
|
|
type: bool
|
|
default: true
|
|
wait_timeout:
|
|
description:
|
|
- Time to wait for the desired state to be reached before timeout, in seconds.
|
|
type: int
|
|
default: 300
|
|
"""
|