Adding in Ansible (still a WIP).

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/alicloud.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017-present Alibaba Group Holding Limited. He Guimin <heguimin36@163.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):
+
+    # Alicloud only documentation fragment
+    DOCUMENTATION = r'''
+options:
+  alicloud_access_key:
+    description:
+      - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY),
+        E(ALICLOUD_ACCESS_KEY_ID) will be used instead.
+    aliases: ['access_key_id', 'access_key']
+    type: str
+  alicloud_secret_key:
+    description:
+      - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY),
+        E(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
+    aliases: ['secret_access_key', 'secret_key']
+    type: str
+  alicloud_region:
+    description:
+      - The Alibaba Cloud region to use. If not specified then the value of environment variable
+        E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) will be used instead.
+    aliases: ['region', 'region_id']
+    required: true
+    type: str
+  alicloud_security_token:
+    description:
+      - The Alibaba Cloud security token. If not specified then the value of environment variable
+        E(ALICLOUD_SECURITY_TOKEN) will be used instead.
+    aliases: ['security_token']
+    type: str
+  alicloud_assume_role:
+    description:
+      - If provided with a role ARN, Ansible will attempt to assume this role using the supplied credentials.
+      - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name),
+        C(alicloud_assume_role_session_expiration) and C(alicloud_assume_role_policy).
+    type: dict
+    aliases: ['assume_role']
+  alicloud_assume_role_arn:
+    description:
+      - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string,
+        it does not perform role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN).
+        ansible will execute with provided credentials.
+    aliases: ['assume_role_arn']
+    type: str
+  alicloud_assume_role_session_name:
+    description:
+      - The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
+        'ansible' is passed to the AssumeRole call as session name. It supports environment variable
+        E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
+    aliases: ['assume_role_session_name']
+    type: str
+  alicloud_assume_role_session_expiration:
+    description:
+      - The Alibaba Cloud C(session_expiration). The time after which the established session for assuming
+        role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
+        value). It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
+    aliases: ['assume_role_session_expiration']
+    type: int
+  ecs_role_name:
+    description:
+      - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control'
+        section of the Alibaba Cloud console.
+      - If you're running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the
+        metadata U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS
+        credential. This is a preferred approach over any other when running in ECS as you can avoid hard coding
+        credentials. Instead these are leased on-the-fly by Ansible which reduces the chance of leakage.
+    aliases: ['role_name']
+    type: str
+  profile:
+    description:
+      - This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
+        E(ALICLOUD_PROFILE) environment variable.
+    type: str
+  shared_credentials_file:
+    description:
+      - This is the path to the shared credentials file. It can also be sourced from the E(ALICLOUD_SHARED_CREDENTIALS_FILE)
+        environment variable.
+      - If this is not set and a profile is specified, C(~/.aliyun/config.json) will be used.
+    type: str
+author:
+    - "He Guimin (@xiaozhu36)"
+requirements:
+    - "Python >= 3.6"
+notes:
+  - If parameters are not set within the module, the following
+    environment variables can be used in decreasing order of precedence
+    E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID),
+    E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY),
+    E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID),
+    E(ALICLOUD_SECURITY_TOKEN),
+    E(ALICLOUD_ECS_ROLE_NAME),
+    E(ALICLOUD_SHARED_CREDENTIALS_FILE),
+    E(ALICLOUD_PROFILE),
+    E(ALICLOUD_ASSUME_ROLE_ARN),
+    E(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
+    E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
+  - E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the
+    Alicloud region, when required, but this can also be configured in the footmark config file
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/attributes.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see COPYING 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 documentation fragment
+    DOCUMENTATION = r'''
+options: {}
+attributes:
+    check_mode:
+      description: Can run in C(check_mode) and return changed status prediction without modifying target.
+    diff_mode:
+      description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
+'''
+
+    PLATFORM = r'''
+options: {}
+attributes:
+    platform:
+      description: Target OS/families that can be operated against.
+      support: N/A
+'''
+
+    # Should be used together with the standard fragment
+    INFO_MODULE = r'''
+options: {}
+attributes:
+    check_mode:
+      support: full
+      details:
+        - This action does not modify state.
+    diff_mode:
+      support: N/A
+      details:
+        - This action does not modify state.
+'''
+
+    CONN = r'''
+options: {}
+attributes:
+    become:
+      description: Is usable alongside C(become) keywords.
+    connection:
+      description: Uses the target's configured connection information to execute code on it.
+    delegation:
+      description: Can be used in conjunction with C(delegate_to) and related keywords.
+'''
+
+    FACTS = r'''
+options: {}
+attributes:
+    facts:
+      description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
+'''
+
+    # Should be used together with the standard fragment and the FACTS fragment
+    FACTS_MODULE = r'''
+options: {}
+attributes:
+    check_mode:
+      support: full
+      details:
+        - This action does not modify state.
+    diff_mode:
+      support: N/A
+      details:
+        - This action does not modify state.
+    facts:
+      support: full
+'''
+
+    FILES = r'''
+options: {}
+attributes:
+    safe_file_operations:
+      description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
+'''
+
+    FLOW = r'''
+options: {}
+attributes:
+    action:
+      description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+    async:
+      description: Supports being used with the C(async) keyword.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/auth_basic.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Ansible project
+# 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 files documentation fragment
+    DOCUMENTATION = r'''
+options:
+  api_url:
+    description:
+      - The resolvable endpoint for the API.
+    type: str
+  api_username:
+    description:
+      - The username to use for authentication against the API.
+    type: str
+  api_password:
+    description:
+      - The password to use for authentication against the API.
+    type: str
+  validate_certs:
+    description:
+      - Whether or not to validate SSL certs when supplying a HTTPS endpoint.
+    type: bool
+    default: true
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/bitbucket.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@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 documentation fragment
+    DOCUMENTATION = r'''
+options:
+  client_id:
+    description:
+      - The OAuth consumer key.
+      - If not set the environment variable E(BITBUCKET_CLIENT_ID) will be used.
+    type: str
+  client_secret:
+    description:
+      - The OAuth consumer secret.
+      - If not set the environment variable E(BITBUCKET_CLIENT_SECRET) will be used.
+    type: str
+  user:
+    description:
+      - The username.
+      - If not set the environment variable E(BITBUCKET_USERNAME) will be used.
+      - O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
+    type: str
+    version_added: 4.0.0
+    aliases: [ username ]
+  password:
+    description:
+      - The App password.
+      - If not set the environment variable E(BITBUCKET_PASSWORD) will be used.
+    type: str
+    version_added: 4.0.0
+notes:
+  - Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
+  - Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
+  - If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/dimensiondata.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016, Dimension Data
+# 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
+
+# Authors:
+#   - Adam Friedman  <tintoy@tintoy.io>
+
+
+class ModuleDocFragment(object):
+
+    # Dimension Data doc fragment
+    DOCUMENTATION = r'''
+
+options:
+  region:
+    description:
+      - The target region.
+      - Regions are defined in Apache libcloud project [libcloud/common/dimensiondata.py].
+      - They are also listed in U(https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html).
+      - Note that the default value C(na) stands for "North America".
+      - The module prepends C(dd-) to the region choice.
+    type: str
+    default: na
+  mcp_user:
+    description:
+      - The username used to authenticate to the CloudControl API.
+      - If not specified, will fall back to E(MCP_USER) from environment variable or C(~/.dimensiondata).
+    type: str
+  mcp_password:
+    description:
+      - The password used to authenticate to the CloudControl API.
+      - If not specified, will fall back to E(MCP_PASSWORD) from environment variable or C(~/.dimensiondata).
+      - Required if O(mcp_user) is specified.
+    type: str
+  location:
+    description:
+      - The target datacenter.
+    type: str
+    required: true
+  validate_certs:
+    description:
+      - If V(false), SSL certificates will not be validated.
+      - This should only be used on private instances of the CloudControl API that use self-signed certificates.
+    type: bool
+    default: true
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/dimensiondata_wait.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016, Dimension Data
+# 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
+
+# Authors:
+#   - Adam Friedman  <tintoy@tintoy.io>
+
+
+class ModuleDocFragment(object):
+
+    # Dimension Data ("wait-for-completion" parameters) doc fragment
+    DOCUMENTATION = r'''
+
+options:
+  wait:
+    description:
+      - Should we wait for the task to complete before moving onto the next.
+    type: bool
+    default: false
+  wait_time:
+    description:
+      - The maximum amount of time (in seconds) to wait for the task to complete.
+      - Only applicable if O(wait=true).
+    type: int
+    default: 600
+  wait_poll_interval:
+    description:
+      - The amount of time (in seconds) to wait between checks for task completion.
+      - Only applicable if O(wait=true).
+    type: int
+    default: 2
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/emc.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Luca Lorenzetto (@remix_tj) <lorenzetto.luca@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):
+
+    DOCUMENTATION = r'''
+options:
+  - See respective platform section for more details
+requirements:
+  - See respective platform section for more details
+notes:
+  - Ansible modules are available for EMC VNX.
+'''
+
+    # Documentation fragment for VNX (emc_vnx)
+    EMC_VNX = r'''
+options:
+    sp_address:
+        description:
+            - Address of the SP of target/secondary storage.
+        type: str
+        required: true
+    sp_user:
+        description:
+            - Username for accessing SP.
+        type: str
+        default: sysadmin
+    sp_password:
+        description:
+            - password for accessing SP.
+        type: str
+        default: sysadmin
+requirements:
+  - An EMC VNX Storage device.
+  - storops (0.5.10 or greater). Install using C(pip install storops).
+notes:
+  - The modules prefixed with C(emc_vnx) are built to support the EMC VNX storage platform.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/gitlab.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Ansible project
+# 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 files documentation fragment
+    DOCUMENTATION = r'''
+requirements:
+  - requests (Python library U(https://pypi.org/project/requests/))
+
+options:
+  api_token:
+    description:
+      - GitLab access token with API permissions.
+    type: str
+  api_oauth_token:
+    description:
+      - GitLab OAuth token for logging in.
+    type: str
+    version_added: 4.2.0
+  api_job_token:
+    description:
+      - GitLab CI job token for logging in.
+    type: str
+    version_added: 4.2.0
+  ca_path:
+    description:
+      - The CA certificates bundle to use to verify GitLab server certificate.
+    type: str
+    version_added: 8.1.0
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/hpe3par.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Hewlett Packard Enterprise Development LP
+# 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):
+
+    # HPE 3PAR doc fragment
+    DOCUMENTATION = '''
+options:
+    storage_system_ip:
+      description:
+        - The storage system IP address.
+      type: str
+      required: true
+    storage_system_password:
+      description:
+        - The storage system password.
+      type: str
+      required: true
+    storage_system_username:
+      description:
+        - The storage system user name.
+      type: str
+      required: true
+
+requirements:
+  - hpe3par_sdk >= 1.0.2. Install using C(pip install hpe3par_sdk).
+  - WSAPI service should be enabled on the 3PAR storage array.
+notes:
+    '''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/hwc.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Huawei Inc.
+# 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):
+
+    # HWC doc fragment.
+    DOCUMENTATION = '''
+options:
+    identity_endpoint:
+        description:
+            - The Identity authentication URL.
+        type: str
+        required: true
+    user:
+        description:
+            - The user name to login with.
+            - Currently only user names are supported, and not user IDs.
+        type: str
+        required: true
+    password:
+        description:
+            - The password to login with.
+        type: str
+        required: true
+    domain:
+        description:
+            - The name of the Domain to scope to (Identity v3).
+            - Currently only domain names are supported, and not domain IDs.
+        type: str
+        required: true
+    project:
+        description:
+            - The name of the Tenant (Identity v2) or Project (Identity v3).
+            - Currently only project names are supported, and not project IDs.
+        type: str
+        required: true
+    region:
+        description:
+            - The region to which the project belongs.
+        type: str
+    id:
+        description:
+            - The ID of resource to be managed.
+        type: str
+notes:
+  - For authentication, you can set identity_endpoint using the
+    E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
+  - For authentication, you can set user using the
+    E(ANSIBLE_HWC_USER) environment variable.
+  - For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment
+    variable.
+  - For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment
+    variable.
+  - For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment
+    variable.
+  - For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable.
+  - Environment variables values will only be used if the playbook values are
+    not set.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/ibm_storage.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, IBM CORPORATION
+# Author(s): Tzur Eliyahu <tzure@il.ibm.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):
+
+    # ibm_storage documentation fragment
+    DOCUMENTATION = r'''
+options:
+    username:
+        description:
+            - Management user on the spectrum accelerate storage system.
+        type: str
+        required: true
+    password:
+        description:
+            - Password for username on the spectrum accelerate storage system.
+        type: str
+        required: true
+    endpoints:
+        description:
+            - The hostname or management IP of Spectrum Accelerate storage system.
+        type: str
+        required: true
+notes:
+  - This module requires pyxcli python library.
+    Use C(pip install pyxcli) in order to get pyxcli.
+requirements:
+  - pyxcli
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/influxdb.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017, Ansible Project
+# Copyright (c) 2017, Abhijeet Kasurde (akasurde@redhat.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):
+    # Parameters for influxdb modules
+    DOCUMENTATION = r'''
+options:
+  hostname:
+    description:
+    - The hostname or IP address on which InfluxDB server is listening.
+    type: str
+    default: localhost
+  username:
+    description:
+    - Username that will be used to authenticate against InfluxDB server.
+    type: str
+    default: root
+    aliases: [ login_username ]
+  password:
+    description:
+    - Password that will be used to authenticate against InfluxDB server.
+    type: str
+    default: root
+    aliases: [ login_password ]
+  port:
+    description:
+    - The port on which InfluxDB server is listening.
+    type: int
+    default: 8086
+  path:
+    description:
+    - The path on which InfluxDB server is accessible.
+    - Only available when using python-influxdb >= 5.1.0.
+    type: str
+    default: ''
+    version_added: '0.2.0'
+  validate_certs:
+    description:
+    - If set to V(false), the SSL certificates will not be validated.
+    - This should only set to V(false) used on personally controlled sites using self-signed certificates.
+    type: bool
+    default: true
+  ssl:
+    description:
+    - Use https instead of http to connect to InfluxDB server.
+    type: bool
+    default: false
+  timeout:
+    description:
+    - Number of seconds Requests will wait for client to establish a connection.
+    type: int
+  retries:
+    description:
+    - Number of retries client will try before aborting.
+    - V(0) indicates try until success.
+    - Only available when using python-influxdb >= 4.1.0.
+    type: int
+    default: 3
+  use_udp:
+    description:
+    - Use UDP to connect to InfluxDB server.
+    type: bool
+    default: false
+  udp_port:
+    description:
+    - UDP port to connect to InfluxDB server.
+    type: int
+    default: 4444
+  proxies:
+    description:
+    - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
+    type: dict
+    default: {}
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/ipa.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017-18, Ansible Project
+# Copyright (c) 2017-18, Abhijeet Kasurde (akasurde@redhat.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):
+    # Parameters for FreeIPA/IPA modules
+    DOCUMENTATION = r'''
+options:
+  ipa_port:
+    description:
+    - Port of FreeIPA / IPA server.
+    - If the value is not specified in the task, the value of environment variable E(IPA_PORT) will be used instead.
+    - If both the environment variable E(IPA_PORT) and the value are not specified in the task, then default value is set.
+    type: int
+    default: 443
+  ipa_host:
+    description:
+    - IP or hostname of IPA server.
+    - If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead.
+    - If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
+    - The relevant entry needed in FreeIPA is the C(ipa-ca) entry.
+    - If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default value will be used.
+    type: str
+    default: ipa.example.com
+  ipa_user:
+    description:
+    - Administrative account used on IPA server.
+    - If the value is not specified in the task, the value of environment variable E(IPA_USER) will be used instead.
+    - If both the environment variable E(IPA_USER) and the value are not specified in the task, then default value is set.
+    type: str
+    default: admin
+  ipa_pass:
+    description:
+    - Password of administrative user.
+    - If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead.
+    - Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
+    - If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
+    - If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate.
+    - If GSSAPI is not available, the usage of O(ipa_pass) is required.
+    type: str
+  ipa_prot:
+    description:
+    - Protocol used by IPA server.
+    - If the value is not specified in the task, the value of environment variable E(IPA_PROT) will be used instead.
+    - If both the environment variable E(IPA_PROT) and the value are not specified in the task, then default value is set.
+    type: str
+    choices: [ http, https ]
+    default: https
+  validate_certs:
+    description:
+    - This only applies if O(ipa_prot) is V(https).
+    - If set to V(false), the SSL certificates will not be validated.
+    - This should only set to V(false) used on personally controlled sites using self-signed certificates.
+    type: bool
+    default: true
+  ipa_timeout:
+    description:
+    - Specifies idle timeout (in seconds) for the connection.
+    - For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
+    - If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead.
+    - If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is set.
+    type: int
+    default: 10
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/keycloak.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017, Eike Frost <ei@kefro.st>
+# 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 documentation fragment
+    DOCUMENTATION = r'''
+options:
+    auth_keycloak_url:
+        description:
+            - URL to the Keycloak instance.
+        type: str
+        required: true
+        aliases:
+          - url
+
+    auth_client_id:
+        description:
+            - OpenID Connect C(client_id) to authenticate to the API with.
+        type: str
+        default: admin-cli
+
+    auth_realm:
+        description:
+            - Keycloak realm name to authenticate to for API access.
+        type: str
+
+    auth_client_secret:
+        description:
+            - Client Secret to use in conjunction with O(auth_client_id) (if required).
+        type: str
+
+    auth_username:
+        description:
+            - Username to authenticate for API access with.
+        type: str
+        aliases:
+          - username
+
+    auth_password:
+        description:
+            - Password to authenticate for API access with.
+        type: str
+        aliases:
+          - password
+
+    token:
+        description:
+            - Authentication token for Keycloak API.
+        type: str
+        version_added: 3.0.0
+
+    validate_certs:
+        description:
+            - Verify TLS certificates (do not disable this in production).
+        type: bool
+        default: true
+
+    connection_timeout:
+        description:
+            - Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+        type: int
+        default: 10
+        version_added: 4.5.0
+
+    http_agent:
+        description:
+            - Configures the HTTP User-Agent header.
+        type: str
+        default: Ansible
+        version_added: 5.4.0
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/ldap.py

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2016, Peter Sagerson <psagers@ignorare.net>
+# Copyright (c) 2016, Jiri Tyr <jiri.tyr@gmail.com>
+# Copyright (c) 2017-2018 Keller Fuchs (@KellerFuchs) <kellerfuchs@hashbang.sh>
+# 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 LDAP documentation fragment
+    DOCUMENTATION = r'''
+options:
+  bind_dn:
+    description:
+      - A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism as default.
+      - If this is blank, we'll use an anonymous bind.
+    type: str
+  bind_pw:
+    description:
+      - The password to use with O(bind_dn).
+    type: str
+    default: ''
+  ca_path:
+    description:
+      - Set the path to PEM file with CA certs.
+    type: path
+    version_added: "6.5.0"
+  client_cert:
+    type: path
+    description:
+      - PEM formatted certificate chain file to be used for SSL client authentication.
+      - Required if O(client_key) is defined.
+    version_added: "7.1.0"
+  client_key:
+    type: path
+    description:
+      - PEM formatted file that contains your private key to be used for SSL client authentication.
+      - Required if O(client_cert) is defined.
+    version_added: "7.1.0"
+  dn:
+    required: true
+    description:
+      - The DN of the entry to add or remove.
+    type: str
+  referrals_chasing:
+    choices: [disabled, anonymous]
+    default: anonymous
+    type: str
+    description:
+      - Set the referrals chasing behavior.
+      - V(anonymous) follow referrals anonymously. This is the default behavior.
+      - V(disabled) disable referrals chasing. This sets C(OPT_REFERRALS) to off.
+    version_added: 2.0.0
+  server_uri:
+    description:
+      - The O(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields.
+      - The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.
+      - Note that when using multiple URIs you cannot determine to which URI your client gets connected.
+      - For URIs containing additional fields, particularly when using commas, behavior is undefined.
+    type: str
+    default: ldapi:///
+  start_tls:
+    description:
+      - If true, we'll use the START_TLS LDAP extension.
+    type: bool
+    default: false
+  validate_certs:
+    description:
+      - If set to V(false), SSL certificates will not be validated.
+      - This should only be used on sites using self-signed certificates.
+    type: bool
+    default: true
+  sasl_class:
+    description:
+      - The class to use for SASL authentication.
+    type: str
+    choices: ['external', 'gssapi']
+    default: external
+    version_added: "2.0.0"
+  xorder_discovery:
+    description:
+      - Set the behavior on how to process Xordered DNs.
+      - V(enable) will perform a C(ONELEVEL) search below the superior RDN to find the matching DN.
+      - V(disable) will always use the DN unmodified (as passed by the O(dn) parameter).
+      - V(auto) will only perform a search if the first RDN does not contain an index number (C({x})).
+    type: str
+    choices: ['enable', 'auto', 'disable']
+    default: auto
+    version_added: "6.4.0"
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/lxca_common.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2017 Lenovo, Inc.
+# Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
+# SPDX-License-Identifier: BSD-2-Clause
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+    # Standard Pylxca documentation fragment
+    DOCUMENTATION = r'''
+author:
+  - Naval Patel (@navalkp)
+  - Prashant Bhosale (@prabhosa)
+
+options:
+  login_user:
+    description:
+    - The username for use in HTTP basic authentication.
+    type: str
+    required: true
+
+  login_password:
+    description:
+    - The password for use in HTTP basic authentication.
+    type: str
+    required: true
+
+  auth_url:
+    description:
+    - lxca HTTPS full web address.
+    type: str
+    required: true
+
+requirements:
+  - pylxca
+
+notes:
+  - Additional detail about pylxca can be found at U(https://github.com/lenovo/pylxca).
+  - Playbooks using these modules can be found at U(https://github.com/lenovo/ansible.lenovo-lxca).
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/manageiq.py

@@ -0,0 +1,53 @@
+# -*- 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. E(MIQ_URL) environment variable if set. Otherwise, it is required to pass it.
+        type: str
+        required: false
+      username:
+        description:
+          - ManageIQ username. E(MIQ_USERNAME) environment variable if set. Otherwise, required if no token is passed in.
+        type: str
+      password:
+        description:
+          - ManageIQ password. E(MIQ_PASSWORD) environment variable if set. Otherwise, required if no token is passed in.
+        type: str
+      token:
+        description:
+          - ManageIQ token. E(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.
+        type: bool
+        default: true
+        aliases: [ verify_ssl ]
+      ca_cert:
+        description:
+          - The path to a CA bundle file or directory with certificates.
+        type: str
+        aliases: [ ca_bundle_path ]
+
+requirements:
+  - 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/nomad.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2020 FERREIRA Christophe <christophe.ferreira@cnaf.fr>
+# 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 files documentation fragment
+    DOCUMENTATION = r'''
+options:
+    host:
+      description:
+        - FQDN of Nomad server.
+      required: true
+      type: str
+    port:
+      description:
+        - Port of Nomad server.
+      type: int
+      default: 4646
+      version_added: 8.0.0
+    use_ssl:
+      description:
+        - Use TLS/SSL connection.
+      type: bool
+      default: true
+    timeout:
+      description:
+        - Timeout (in seconds) for the request to Nomad.
+      type: int
+      default: 5
+    validate_certs:
+      description:
+        - Enable TLS/SSL certificate validation.
+      type: bool
+      default: true
+    client_cert:
+      description:
+        - Path of certificate for TLS/SSL.
+      type: path
+    client_key:
+      description:
+        - Path of certificate's private key for TLS/SSL.
+      type: path
+    namespace:
+      description:
+        - Namespace for Nomad.
+      type: str
+    token:
+      description:
+        - ACL token for authentication.
+      type: str
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/onepassword.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Ansible Project
+# 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):
+    DOCUMENTATION = r'''
+requirements:
+  - See U(https://support.1password.com/command-line/)
+options:
+  master_password:
+    description: The password used to unlock the specified vault.
+    aliases: ['vault_password']
+    type: str
+  section:
+    description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from any section.
+  domain:
+    description: Domain of 1Password.
+    default: '1password.com'
+    type: str
+  subdomain:
+    description: The 1Password subdomain to authenticate against.
+    type: str
+  account_id:
+    description: The account ID to target.
+    type: str
+  username:
+    description: The username used to sign in.
+    type: str
+  secret_key:
+    description: The secret key used when performing an initial sign in.
+    type: str
+  service_account_token:
+    description:
+      - The access key for a service account.
+      - Only works with 1Password CLI version 2 or later.
+    type: str
+  vault:
+    description: Vault containing the item to retrieve (case-insensitive). If absent will search all vaults.
+    type: str
+  connect_host:
+    description: The host for 1Password Connect. Must be used in combination with O(connect_token).
+    type: str
+    env:
+      - name: OP_CONNECT_HOST
+    version_added: 8.1.0
+  connect_token:
+    description: The token for 1Password Connect. Must be used in combination with O(connect_host).
+    type: str
+    env:
+      - name: OP_CONNECT_TOKEN
+    version_added: 8.1.0
+'''
+
+    LOOKUP = r'''
+options:
+  service_account_token:
+    env:
+      - name: OP_SERVICE_ACCOUNT_TOKEN
+        version_added: 8.2.0
+notes:
+  - This lookup will use an existing 1Password session if one exists. If not, and you have already
+    performed an initial sign in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the
+    O(master_password) is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op).
+  - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password).
+  - Can target a specific account by providing the O(account_id).
+  - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials
+    needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength
+    to the 1Password master password.
+  - This lookup stores potentially sensitive data from 1Password as Ansible facts.
+    Facts are subject to caching if enabled, which means this data could be stored in clear text
+    on disk or in a database.
+  - Tested with C(op) version 2.7.2.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oneview.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016-2017, Hewlett Packard Enterprise Development LP
+# 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):
+
+    # OneView doc fragment
+    DOCUMENTATION = r'''
+options:
+    config:
+        description:
+        - Path to a JSON configuration file containing the OneView client configuration.
+          The configuration file is optional and when used should be present in the host running the ansible commands.
+          If the file path is not provided, the configuration will be loaded from environment variables.
+          For links to example configuration files or how to use the environment variables verify the notes section.
+        type: path
+    api_version:
+        description:
+        - OneView API Version.
+        type: int
+    image_streamer_hostname:
+        description:
+        - IP address or hostname for the HPE Image Streamer REST API.
+        type: str
+    hostname:
+        description:
+        - IP address or hostname for the appliance.
+        type: str
+    username:
+        description:
+        - Username for API authentication.
+        type: str
+    password:
+        description:
+        - Password for API authentication.
+        type: str
+
+requirements:
+  - Python >= 2.7.9
+
+notes:
+    - "A sample configuration file for the config parameter can be found at:
+       U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json)"
+    - "Check how to use environment variables for configuration at:
+       U(https://github.com/HewlettPackard/oneview-ansible#environment-variables)"
+    - "Additional Playbooks for the HPE OneView Ansible modules can be found at:
+       U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples)"
+    - "The OneView API version used will directly affect returned and expected fields in resources.
+       Information on setting the desired API version and can be found at:
+       U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version)"
+    '''
+
+    VALIDATEETAG = r'''
+options:
+    validate_etag:
+        description:
+            - When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag
+                for the resource matches the ETag provided in the data.
+        type: bool
+        default: true
+'''
+
+    FACTSPARAMS = r'''
+options:
+    params:
+        description:
+        - List of parameters to delimit, filter and sort the list of resources.
+        - "Parameter keys allowed are:"
+        - "C(start): The first item to return, using 0-based indexing."
+        - "C(count): The number of resources to return."
+        - "C(filter): A general filter/query string to narrow the list of items returned."
+        - "C(sort): The sort order of the returned data set."
+        type: dict
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/online.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Ansible project
+# 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 documentation fragment
+    DOCUMENTATION = r'''
+options:
+  api_token:
+    description:
+      - Online OAuth token.
+    type: str
+    required: true
+    aliases: [ oauth_token ]
+  api_url:
+    description:
+      - Online API URL.
+    type: str
+    default: 'https://api.online.net'
+    aliases: [ base_url ]
+  api_timeout:
+    description:
+      - HTTP timeout to Online API in seconds.
+    type: int
+    default: 30
+    aliases: [ timeout ]
+  validate_certs:
+    description:
+      - Validate SSL certs of the Online API.
+    type: bool
+    default: true
+notes:
+  - Also see the API documentation on U(https://console.online.net/en/api/).
+  - If O(api_token) is not set within the module, the following
+    environment variables can be used in decreasing order of precedence
+    E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN).
+  - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL)
+    environment variable.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/opennebula.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+# 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
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+    # 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
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/openswitch.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2015, Peter Sprygada <psprygada@ansible.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 files documentation fragment
+    DOCUMENTATION = r'''
+options:
+  host:
+    description:
+      - Specifies the DNS host name or address for connecting to the remote
+        device over the specified transport.  The value of host is used as
+        the destination address for the transport.  Note this argument
+        does not affect the SSH argument.
+    type: str
+  port:
+    description:
+      - Specifies the port to use when building the connection to the remote
+        device.  This value applies to either O(transport=cli) or O(transport=rest).  The port
+        value will default to the appropriate transport common port if
+        none is provided in the task.  (cli=22, http=80, https=443).  Note
+        this argument does not affect the SSH transport.
+    type: int
+    default: 0 (use common port)
+  username:
+    description:
+      - Configures the username to use to authenticate the connection to
+        the remote device.  This value is used to authenticate
+        either the CLI login or the eAPI authentication depending on which
+        transport is used. Note this argument does not affect the SSH
+        transport. If the value is not specified in the task, the value of
+        environment variable E(ANSIBLE_NET_USERNAME) will be used instead.
+    type: str
+  password:
+    description:
+      - Specifies the password to use to authenticate the connection to
+        the remote device.  This is a common argument used for either O(transport=cli)
+        or O(transport=rest).  Note this argument does not affect the SSH
+        transport. If the value is not specified in the task, the value of
+        environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
+    type: str
+  timeout:
+    description:
+      - Specifies the timeout in seconds for communicating with the network device
+        for either connecting or sending commands.  If the timeout is
+        exceeded before the operation is completed, the module will error.
+    type: int
+    default: 10
+  ssh_keyfile:
+    description:
+      - Specifies the SSH key to use to authenticate the connection to
+        the remote device.  This argument is only used for O(transport=cli).
+        If the value is not specified in the task, the value of
+        environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
+    type: path
+  transport:
+    description:
+      - Configures the transport connection to use when connecting to the
+        remote device.  The transport argument supports connectivity to the
+        device over SSH (V(ssh)), CLI (V(cli)), or REST (V(rest)).
+    required: true
+    type: str
+    choices: [ cli, rest, ssh ]
+    default: ssh
+  use_ssl:
+    description:
+      - Configures the O(transport) to use SSL if set to V(true) only when the
+        O(transport) argument is configured as rest.  If the transport
+        argument is not V(rest), this value is ignored.
+    type: bool
+    default: true
+  provider:
+    description:
+      - Convenience method that allows all C(openswitch) arguments to be passed as
+        a dict object.  All constraints (required, choices, etc) must be
+        met either by individual arguments or values in this dict.
+    type: dict
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    requirements:
+        - Python SDK for Oracle Cloud Infrastructure U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io)
+    notes:
+        - For OCI Python SDK configuration, please refer to
+          U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html).
+    options:
+        config_file_location:
+            description:
+                - Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable,
+                  if any, is used. Otherwise, defaults to C(~/.oci/config).
+            type: str
+        config_profile_name:
+            description:
+                - The profile to load from the config file referenced by O(config_file_location). If not set, then the
+                  value of the E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the
+                  C(DEFAULT) profile in O(config_file_location).
+            default: "DEFAULT"
+            type: str
+        api_user:
+            description:
+                - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
+                  value of the E(OCI_USER_OCID) environment variable, if any, is used. This option is required if the user
+                  is not specified through a configuration file (See O(config_file_location)). To get the user's OCID,
+                  please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+            type: str
+        api_user_fingerprint:
+            description:
+                - Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT)
+                  environment variable, if any, is used. This option is required if the key fingerprint is not
+                  specified through a configuration file (See O(config_file_location)). To get the key pair's
+                  fingerprint value please refer
+                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+            type: str
+        api_user_key_file:
+            description:
+                - Full path and filename of the private key (in PEM format). If not set, then the value of the
+                  OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is
+                  not specified through a configuration file (See O(config_file_location)). If the key is encrypted
+                  with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
+            type: path
+        api_user_key_pass_phrase:
+            description:
+                - Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then
+                  the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the
+                  key passphrase is not specified through a configuration file (See O(config_file_location)).
+            type: str
+        auth_type:
+            description:
+                - The type of authentication to use for making API requests. By default O(auth_type=api_key) based
+                  authentication is performed and the API key (see O(api_user_key_file)) in your config file will be
+                  used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE,
+                  if any, is used. Use O(auth_type=instance_principal) to use instance principal based authentication
+                  when running ansible playbooks within an OCI compute instance.
+            choices: ['api_key', 'instance_principal']
+            default: 'api_key'
+            type: str
+        tenancy:
+            description:
+                - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is
+                  used. This option is required if the tenancy OCID is not specified through a configuration file
+                  (See O(config_file_location)). To get the tenancy OCID, please refer to
+                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+            type: str
+        region:
+            description:
+                - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the
+                  value of the OCI_REGION variable, if any, is used. This option is required if the region is
+                  not specified through a configuration file (See O(config_file_location)). Please refer to
+                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information
+                  on OCI regions.
+            type: str
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle_creatable_resource.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    options:
+        force_create:
+            description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an
+                         idempotent operation, and doesn't create the resource if it already exists. Setting this option
+                         to true, forcefully creates a copy of the resource, even if it already exists.This option is
+                         mutually exclusive with O(key_by).
+            default: false
+            type: bool
+        key_by:
+            description: The list of comma-separated attributes of this resource which should be used to uniquely
+                         identify an instance of the resource. By default, all the attributes of a resource except
+                         O(freeform_tags) are used to uniquely identify a resource.
+            type: list
+            elements: str
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle_display_name_option.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    options:
+        display_name:
+            description: Use O(display_name) along with the other options to return only resources that match the given
+                         display name exactly.
+            type: str
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle_name_option.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    options:
+        name:
+            description: Use O(name) along with the other options to return only resources that match the given name
+                         exactly.
+            type: str
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle_tags.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    options:
+        defined_tags:
+            description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
+                         information, see
+                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+            type: dict
+        freeform_tags:
+            description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name,
+                         type, or namespace. For more information, see
+                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+            type: dict
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/oracle_wait_options.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018, Oracle and/or its affiliates.
+# 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):
+    DOCUMENTATION = """
+    options:
+        wait:
+            description: Whether to wait for create or delete operation to complete.
+            default: true
+            type: bool
+        wait_timeout:
+            description: Time, in seconds, to wait when O(wait=true).
+            default: 1200
+            type: int
+        wait_until:
+            description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default,
+                         when O(wait=true), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
+                         RUNNING applicable lifecycle state during create operation and to get into DELETED/DETACHED/
+                         TERMINATED lifecycle state during delete operation.
+            type: str
+    """

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/pritunl.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+# 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
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    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.
+"""

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/proxmox.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Ansible project
+# 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):
+    # Common parameters for Proxmox VE modules
+    DOCUMENTATION = r'''
+options:
+  api_host:
+    description:
+      - Specify the target host of the Proxmox VE cluster.
+    type: str
+    required: true
+  api_user:
+    description:
+      - Specify the user to authenticate with.
+    type: str
+    required: true
+  api_password:
+    description:
+      - Specify the password to authenticate with.
+      - You can use E(PROXMOX_PASSWORD) environment variable.
+    type: str
+  api_token_id:
+    description:
+      - Specify the token ID.
+      - Requires C(proxmoxer>=1.1.0) to work.
+    type: str
+    version_added: 1.3.0
+  api_token_secret:
+    description:
+      - Specify the token secret.
+      - Requires C(proxmoxer>=1.1.0) to work.
+    type: str
+    version_added: 1.3.0
+  validate_certs:
+    description:
+      - If V(false), SSL certificates will not be validated.
+      - This should only be used on personally controlled sites using self-signed certificates.
+    type: bool
+    default: false
+requirements: [ "proxmoxer", "requests" ]
+'''
+
+    SELECTION = r'''
+options:
+  vmid:
+    description:
+      - Specifies the instance ID.
+      - If not set the next available ID will be fetched from ProxmoxAPI.
+    type: int
+  node:
+    description:
+      - Proxmox VE node on which to operate.
+      - Only required for O(state=present).
+      - For every other states it will be autodiscovered.
+    type: str
+  pool:
+    description:
+      - Add the new VM to the specified pool.
+    type: str
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/purestorage.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017, Simon Dodsley <simon@purestorage.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 Pure Storage documentation fragment
+    DOCUMENTATION = r'''
+options:
+  - See separate platform section for more details
+requirements:
+  - See separate platform section for more details
+notes:
+  - Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade
+'''
+
+    # Documentation fragment for FlashBlade
+    FB = r'''
+options:
+  fb_url:
+    description:
+      - FlashBlade management IP address or Hostname.
+    type: str
+  api_token:
+    description:
+      - FlashBlade API token for admin privileged user.
+    type: str
+notes:
+  - This module requires the C(purity_fb) Python library.
+  - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables
+    if O(fb_url) and O(api_token) arguments are not passed to the module directly.
+requirements:
+  - purity_fb >= 1.1
+'''
+
+    # Documentation fragment for FlashArray
+    FA = r'''
+options:
+  fa_url:
+    description:
+      - FlashArray management IPv4 address or Hostname.
+    type: str
+    required: true
+  api_token:
+    description:
+      - FlashArray API token for admin privileged user.
+    type: str
+    required: true
+notes:
+  - This module requires the C(purestorage) Python library.
+  - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables
+    if O(fa_url) and O(api_token) arguments are not passed to the module directly.
+requirements:
+  - purestorage
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/rackspace.py

@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014, Matt Martz <matt@sivel.net>
+# 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 Rackspace only documentation fragment
+    DOCUMENTATION = r'''
+options:
+  api_key:
+    description:
+      - Rackspace API key, overrides O(credentials).
+    type: str
+    aliases: [ password ]
+  credentials:
+    description:
+      - File to find the Rackspace credentials in. Ignored if O(api_key) and
+        O(username) are provided.
+    type: path
+    aliases: [ creds_file ]
+  env:
+    description:
+      - Environment as configured in C(~/.pyrax.cfg),
+        see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
+    type: str
+  region:
+    description:
+      - Region to create an instance in.
+    type: str
+  username:
+    description:
+      - Rackspace username, overrides O(credentials).
+    type: str
+  validate_certs:
+    description:
+      - Whether or not to require SSL validation of API endpoints.
+    type: bool
+    aliases: [ verify_ssl ]
+requirements:
+  - pyrax
+notes:
+  - The following environment variables can be used, E(RAX_USERNAME),
+    E(RAX_API_KEY), E(RAX_CREDS_FILE), E(RAX_CREDENTIALS), E(RAX_REGION).
+  - E(RAX_CREDENTIALS) and E(RAX_CREDS_FILE) point to a credentials file
+    appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating).
+  - E(RAX_USERNAME) and E(RAX_API_KEY) obviate the use of a credentials file.
+  - E(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...).
+'''
+
+    # Documentation fragment including attributes to enable communication
+    # of other OpenStack clouds. Not all rax modules support this.
+    OPENSTACK = r'''
+options:
+  api_key:
+    type: str
+    description:
+      - Rackspace API key, overrides O(credentials).
+    aliases: [ password ]
+  auth_endpoint:
+    type: str
+    description:
+      - The URI of the authentication service.
+      - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/).
+  credentials:
+    type: path
+    description:
+      - File to find the Rackspace credentials in. Ignored if O(api_key) and
+        O(username) are provided.
+    aliases: [ creds_file ]
+  env:
+    type: str
+    description:
+      - Environment as configured in C(~/.pyrax.cfg),
+        see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
+  identity_type:
+    type: str
+    description:
+      - Authentication mechanism to use, such as rackspace or keystone.
+    default: rackspace
+  region:
+    type: str
+    description:
+      - Region to create an instance in.
+  tenant_id:
+    type: str
+    description:
+      - The tenant ID used for authentication.
+  tenant_name:
+    type: str
+    description:
+      - The tenant name used for authentication.
+  username:
+    type: str
+    description:
+      - Rackspace username, overrides O(credentials).
+  validate_certs:
+    description:
+      - Whether or not to require SSL validation of API endpoints.
+    type: bool
+    aliases: [ verify_ssl ]
+deprecated:
+  removed_in: 9.0.0
+  why: This module relies on the deprecated package pyrax.
+  alternative: Use the Openstack modules instead.
+requirements:
+  - pyrax
+notes:
+  - The following environment variables can be used, E(RAX_USERNAME),
+    E(RAX_API_KEY), E(RAX_CREDS_FILE), E(RAX_CREDENTIALS), E(RAX_REGION).
+  - E(RAX_CREDENTIALS) and E(RAX_CREDS_FILE) points to a credentials file
+    appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating).
+  - E(RAX_USERNAME) and E(RAX_API_KEY) obviate the use of a credentials file.
+  - E(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...).
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/redis.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Andreas Botzner <andreas at botzner dot 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):
+    # Common parameters for Redis modules
+    DOCUMENTATION = r'''
+options:
+  login_host:
+    description:
+      - Specify the target host running the database.
+    default: localhost
+    type: str
+  login_port:
+    description:
+      - Specify the port to connect to.
+    default: 6379
+    type: int
+  login_user:
+    description:
+      - Specify the user to authenticate with.
+      - Requires L(redis,https://pypi.org/project/redis) >= 3.4.0.
+    type: str
+  login_password:
+    description:
+      - Specify the password to authenticate with.
+      - Usually not used when target is localhost.
+    type: str
+  tls:
+    description:
+      - Specify whether or not to use TLS for the connection.
+    type: bool
+    default: true
+  validate_certs:
+    description:
+      - Specify whether or not to validate TLS certificates.
+      - This should only be turned off for personally controlled sites or with
+        C(localhost) as target.
+    type: bool
+    default: true
+  ca_certs:
+    description:
+      - Path to root certificates file. If not set and O(tls) is
+        set to V(true), certifi ca-certificates will be used.
+    type: str
+requirements: [ "redis", "certifi" ]
+
+notes:
+  - Requires the C(redis) Python package on the remote host. You can
+    install it with pip (C(pip install redis)) or with a package manager.
+    Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/rundeck.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Phillipe Smith <phsmithcc@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 files documentation fragment
+    DOCUMENTATION = r'''
+options:
+  url:
+    type: str
+    description:
+      - Rundeck instance URL.
+    required: true
+  api_version:
+    type: int
+    description:
+      - Rundeck API version to be used.
+      - API version must be at least 14.
+    default: 39
+  api_token:
+    type: str
+    description:
+      - Rundeck User API Token.
+    required: true
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/scaleway.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
+# 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 documentation fragment
+    DOCUMENTATION = r'''
+options:
+  api_token:
+    description:
+      - Scaleway OAuth token.
+    type: str
+    required: true
+    aliases: [ oauth_token ]
+  api_url:
+    description:
+      - Scaleway API URL.
+    type: str
+    default: https://api.scaleway.com
+    aliases: [ base_url ]
+  api_timeout:
+    description:
+      - HTTP timeout to Scaleway API in seconds.
+    type: int
+    default: 30
+    aliases: [ timeout ]
+  query_parameters:
+    description:
+    - List of parameters passed to the query string.
+    type: dict
+    default: {}
+  validate_certs:
+    description:
+      - Validate SSL certs of the Scaleway API.
+    type: bool
+    default: true
+notes:
+  - Also see the API documentation on U(https://developer.scaleway.com/).
+  - If O(api_token) is not set within the module, the following
+    environment variables can be used in decreasing order of precedence
+    E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN).
+  - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL)
+    environment variable.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/scaleway_waitable_resource.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2022, Guillaume MARTINEZ <lunik@tiwabbit.fr>
+# 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 documentation fragment
+    DOCUMENTATION = r'''
+options:
+  wait:
+    description:
+    - Wait for the resource to reach its desired state before returning.
+    type: bool
+    default: true
+  wait_timeout:
+    type: int
+    description:
+    - Time to wait for the resource to reach the expected state.
+    required: false
+    default: 300
+  wait_sleep_time:
+    type: int
+    description:
+    - Time to wait before every attempt to check the state of the resource.
+    required: false
+    default: 3
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/utm.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Johannes Brunswicker <johannes.brunswicker@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):
+    DOCUMENTATION = r'''
+options:
+    headers:
+        description:
+          - A dictionary of additional headers to be sent to POST and PUT requests.
+          - Is needed for some modules.
+        type: dict
+        required: false
+        default: {}
+    utm_host:
+        description:
+          - The REST Endpoint of the Sophos UTM.
+        type: str
+        required: true
+    utm_port:
+        description:
+          - The port of the REST interface.
+        type: int
+        default: 4444
+    utm_token:
+        description:
+          - "The token used to identify at the REST-API. See
+            U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en),
+            Chapter 2.4.2."
+        type: str
+        required: true
+    utm_protocol:
+        description:
+          - The protocol of the REST Endpoint.
+        choices: [ http, https ]
+        type: str
+        default: https
+    validate_certs:
+        description:
+          - Whether the REST interface's ssl certificate should be verified or not.
+        type: bool
+        default: true
+    state:
+        description:
+          - The desired state of the object.
+          - V(present) will create or update an object.
+          - V(absent) will delete an object if it was present.
+        type: str
+        choices: [ absent, present ]
+        default: present
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/vexata.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2019, Sandeep Kasargod <sandeep@vexata.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):
+
+    DOCUMENTATION = r'''
+options:
+    - See respective platform section for more details
+requirements:
+    - See respective platform section for more details
+notes:
+    - Ansible modules are available for Vexata VX100 arrays.
+'''
+
+    # Documentation fragment for Vexata VX100 series
+    VX100 = r'''
+options:
+  array:
+    description:
+      - Vexata VX100 array hostname or IPv4 Address.
+    required: true
+    type: str
+  user:
+    description:
+      - Vexata API user with administrative privileges.
+      - Uses the E(VEXATA_USER) environment variable as a fallback.
+    required: false
+    type: str
+  password:
+    description:
+      - Vexata API user password.
+      - Uses the E(VEXATA_PASSWORD) environment variable as a fallback.
+    required: false
+    type: str
+  validate_certs:
+    description:
+      - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
+      - If set to V(true), please make sure Python >= 2.7.9 is installed on the given machine.
+    required: false
+    type: bool
+    default: false
+
+requirements:
+  - Vexata VX100 storage array with VXOS >= v3.5.0 on storage array
+  - vexatapi >= 0.0.1
+  - E(VEXATA_USER) and E(VEXATA_PASSWORD) environment variables must be set if
+    user and password arguments are not passed to the module directly.
+'''

ansible/collections/ansible_collections/community/general/plugins/doc_fragments/xenserver.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Bojan Vitnik <bvitnik@mainstream.rs>
+# 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):
+    # Common parameters for XenServer modules
+    DOCUMENTATION = r'''
+options:
+  hostname:
+    description:
+    - The hostname or IP address of the XenServer host or XenServer pool master.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
+    type: str
+    default: localhost
+    aliases: [ host, pool ]
+  username:
+    description:
+    - The username to use for connecting to XenServer.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
+    type: str
+    default: root
+    aliases: [ admin, user ]
+  password:
+    description:
+    - The password to use for connecting to XenServer.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
+    type: str
+    aliases: [ pass, pwd ]
+  validate_certs:
+    description:
+    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used instead.
+    type: bool
+    default: true
+'''