mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-25 05:02:46 +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.
38 lines
1.3 KiB
Python
38 lines
1.3 KiB
Python
# Copyright (c) 2021, Florian Dambrine <android.florian@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
|
|
|
|
# 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:
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
pritunl_url:
|
|
type: str
|
|
required: true
|
|
description:
|
|
- URL and port of the Pritunl server on which the API is enabled.
|
|
pritunl_api_token:
|
|
type: str
|
|
required: true
|
|
description:
|
|
- API Token of a Pritunl admin user.
|
|
- It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
|
|
pritunl_api_secret:
|
|
type: str
|
|
required: true
|
|
description:
|
|
- API Secret found in Administrators > USERNAME > API Secret.
|
|
validate_certs:
|
|
type: bool
|
|
required: false
|
|
default: true
|
|
description:
|
|
- If certificates should be validated or not.
|
|
- This should never be set to V(false), except if you are very sure that your connection to the server can not be subject
|
|
to a Man In The Middle attack.
|
|
"""
|