1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-28 06:28:56 +00:00

Make all doc fragments, module utils, and plugin utils private (#11896)

* 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.
This commit is contained in:
Felix Fontein 2026-04-20 20:16:26 +02:00 committed by GitHub
parent 9ef1dbb6d5
commit 4fa82b9617
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
807 changed files with 2041 additions and 1702 deletions

View file

@ -16,7 +16,7 @@ description:
ok.
author: "Albert Autin (@Alb0t)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ short_description: Notify airbrake about app deployments
description:
- Notify airbrake about app deployments (see U(https://airbrake.io/docs/api/#deploys-v4)).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -20,7 +20,7 @@ deprecated:
Use C(ibm.power_aix.devices) instead.
See U(https://ibm.github.io/ansible-power-aix/modules/devices.html) for details.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -21,7 +21,7 @@ deprecated:
Use C(ibm.power_aix.filesystem) instead.
See U(https://ibm.github.io/ansible-power-aix/modules/filesystem.html) for details.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -20,7 +20,7 @@ deprecated:
Use C(ibm.power_aix.inittab) instead.
See U(https://ibm.github.io/ansible-power-aix/modules/inittab.html) for details.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -20,7 +20,7 @@ deprecated:
Use C(ibm.power_aix.lvg) instead.
See U(https://ibm.github.io/ansible-power-aix/modules/lvg.html) for details.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -20,7 +20,7 @@ deprecated:
Use C(ibm.power_aix.lvol) instead.
See U(https://ibm.github.io/ansible-power-aix/modules/lvol.html) for details.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -18,7 +18,7 @@ seealso:
description: Documentation for Alerta API.
link: https://docs.alerta.io/api/reference.html#customers
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -246,8 +246,8 @@ requirements:
- "Python >= 3.6"
- "footmark >= 1.19.0"
extends_documentation_fragment:
- community.general.alicloud
- community.general.attributes
- community.general._alicloud
- community.general._attributes
"""
EXAMPLES = r"""
@ -616,7 +616,7 @@ import time
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible_collections.community.general.plugins.module_utils.alicloud_ecs import (
from ansible_collections.community.general.plugins.module_utils._alicloud_ecs import (
FOOTMARK_IMP_ERR,
HAS_FOOTMARK,
ecs_argument_spec,

View file

@ -57,9 +57,9 @@ requirements:
- "Python >= 3.6"
- "footmark >= 1.13.0"
extends_documentation_fragment:
- community.general.alicloud
- community.general.attributes
- community.general.attributes.info_module
- community.general._alicloud
- community.general._attributes
- community.general._attributes.info_module
"""
EXAMPLES = r"""
@ -343,7 +343,7 @@ ids:
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible_collections.community.general.plugins.module_utils.alicloud_ecs import (
from ansible_collections.community.general.plugins.module_utils._alicloud_ecs import (
FOOTMARK_IMP_ERR,
HAS_FOOTMARK,
ecs_argument_spec,

View file

@ -19,7 +19,7 @@ author:
- David Wittman (@DavidWittman)
- Gabe Mulley (@mulby)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ description:
- Allows installation of packages to a non-default SDK root directory.
author: Stanislav Shamilov (@shamilovstas)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -132,8 +132,8 @@ removed:
sample: ["build-tools;34.0.0", "platform-tools"]
"""
from ansible_collections.community.general.plugins.module_utils.android_sdkmanager import AndroidSdkManager, Package
from ansible_collections.community.general.plugins.module_utils.mh.module_helper import StateModuleHelper
from ansible_collections.community.general.plugins.module_utils._android_sdkmanager import AndroidSdkManager, Package
from ansible_collections.community.general.plugins.module_utils._mh.module_helper import StateModuleHelper
class AndroidSdk(StateModuleHelper):

View file

@ -26,7 +26,7 @@ seealso:
requirements:
- ansible-core 2.11 or newer
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none
@ -194,8 +194,11 @@ version:
import re
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper, ModuleHelperException
from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils._module_helper import (
ModuleHelper,
ModuleHelperException,
)
class AnsibleGalaxyInstall(ModuleHelper):

View file

@ -14,7 +14,7 @@ description:
- Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool, using HTTP POST and GET requests. The
httpd mod_proxy balancer-member status page has to be enabled and accessible, as this module relies on parsing this page.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
requirements:
- Python package C(beautifulsoup4)
attributes:
@ -210,8 +210,11 @@ import re
from ansible.module_utils.common.text.converters import to_text
from ansible.module_utils.urls import fetch_url
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper, ModuleHelperException
from ansible_collections.community.general.plugins.module_utils import _deps as deps
from ansible_collections.community.general.plugins.module_utils._module_helper import (
ModuleHelper,
ModuleHelperException,
)
with deps.declare("beautifulsoup4"):
from bs4 import BeautifulSoup

View file

@ -16,7 +16,7 @@ short_description: Enables/disables a module of the Apache2 webserver
description:
- Enables or disables a specified module of the Apache2 webserver.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -16,7 +16,7 @@ description:
- Manages C(apk) packages for Alpine Linux.
author: "Kevin Brebanov (@kbrebanov)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -17,7 +17,7 @@ notes:
- This module works on ALT based distros.
- Does NOT support checkmode, due to a limitation in C(apt-repo) tool.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -15,7 +15,7 @@ short_description: APT-RPM package manager
description:
- Manages packages with C(apt-rpm). Both low-level (C(rpm)) and high-level (C(apt-get)) package manager binaries required.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -13,7 +13,7 @@ module: archive
short_description: Creates a compressed archive of one or more files or trees
extends_documentation_fragment:
- ansible.builtin.files
- community.general.attributes
- community.general._attributes
description:
- Creates or extends an archive.
- The source and archive are on the target host, and the archive I(is not) copied to the controller host.

View file

@ -15,7 +15,7 @@ description:
- Alpine Wall (C(awall)) generates a firewall configuration from the enabled policy files and activates the configuration
on the system.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,7 +14,7 @@ description:
- Mount and unmount ZFS boot environments.
author: Adam Števko (@xen0l)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -13,7 +13,7 @@ description:
- Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters
for future module calls.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,8 +14,8 @@ description:
author:
- Evgeniy Krysanov (@catcombo)
extends_documentation_fragment:
- community.general.bitbucket
- community.general.attributes
- community.general._bitbucket
- community.general._attributes
attributes:
check_mode:
support: full
@ -74,7 +74,7 @@ RETURN = r""" # """
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.module_utils._source_control.bitbucket import BitbucketHelper
error_messages = {
"required_key": "`key` is required when the `state` is `present`",

View file

@ -14,8 +14,8 @@ description:
author:
- Evgeniy Krysanov (@catcombo)
extends_documentation_fragment:
- community.general.bitbucket
- community.general.attributes
- community.general._bitbucket
- community.general._attributes
attributes:
check_mode:
support: full
@ -71,7 +71,7 @@ RETURN = r""" # """
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.module_utils._source_control.bitbucket import BitbucketHelper
error_messages = {
"invalid_params": "Account, repository or SSH key pair was not found",

View file

@ -15,8 +15,8 @@ description:
author:
- Evgeniy Krysanov (@catcombo)
extends_documentation_fragment:
- community.general.bitbucket
- community.general.attributes
- community.general._bitbucket
- community.general._attributes
requirements:
- paramiko
attributes:
@ -95,7 +95,7 @@ except ImportError:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.module_utils._source_control.bitbucket import BitbucketHelper
error_messages = {
"invalid_params": "Account or repository was not found",

View file

@ -14,8 +14,8 @@ description:
author:
- Evgeniy Krysanov (@catcombo)
extends_documentation_fragment:
- community.general.bitbucket
- community.general.attributes
- community.general._bitbucket
- community.general._attributes
attributes:
check_mode:
support: full
@ -83,7 +83,7 @@ RETURN = r""" # """
from ansible.module_utils.basic import AnsibleModule, _load_params
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.module_utils._source_control.bitbucket import BitbucketHelper
error_messages = {
"required_value": "`value` is required when the `state` is `present`",

View file

@ -13,7 +13,7 @@ description:
- Manage bower packages with C(bower).
author: "Michael Warkentin (@mwarkentin)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -16,8 +16,8 @@ author:
- Gregory Furlong (@gnfzdz)
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general._attributes
- community.general._attributes.info_module
"""
EXAMPLES = r"""
@ -77,7 +77,7 @@ filesystems:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.btrfs import BtrfsFilesystemsProvider
from ansible_collections.community.general.plugins.module_utils._btrfs import BtrfsFilesystemsProvider
def run_module():

View file

@ -82,7 +82,7 @@ notes:
only a single btrfs filesystem is mounted, that filesystem is used; otherwise, the module takes no action and returns an
error.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
@ -209,7 +209,7 @@ import tempfile
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.btrfs import (
from ansible_collections.community.general.plugins.module_utils._btrfs import (
BtrfsCommands,
BtrfsFilesystemsProvider,
BtrfsModuleException,

View file

@ -12,7 +12,7 @@ short_description: Manage Ruby Gem dependencies with Bundler
description:
- Manage installation and Gem version dependencies for Ruby using the Bundler gem.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ short_description: Deploy software (or files) from bzr branches
description:
- Manage C(bzr) branches to deploy files or software.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -13,7 +13,7 @@ description:
- Send a message to Campfire.
- Messages with newlines result in a "Paste" message being sent.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -12,7 +12,7 @@ short_description: Manage Linux capabilities
description:
- This module manipulates files privileges using the Linux capabilities(7) system.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,7 +14,7 @@ description:
- Manage Rust packages with cargo.
author: "Radek Sprta (@radek-sprta)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ author: "Nick Harring (@NickatEpic)"
requirements:
- requests >= 2.0.0
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none
@ -147,7 +147,7 @@ import json
import time
import traceback
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
REQUESTS_IMP_ERR = None
try:

View file

@ -16,7 +16,7 @@ notes:
- The O(recipient_type) must be valid for the supplied O(recipient_id).
- Full API documentation can be found at U(https://developer.webex.com/docs/api/basics).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -12,9 +12,9 @@ description:
- Gathers facts by reading the C(status.json) and C(result.json) of cloud-init.
author: René Moser (@resmo)
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.facts
- community.general.attributes.facts_module
- community.general._attributes
- community.general._attributes.facts
- community.general._attributes.facts_module
options:
filter:
description:

View file

@ -14,7 +14,7 @@ short_description: Manage Cloudflare DNS records
description:
- 'Manages DNS records using the Cloudflare API, see the docs: U(https://api.cloudflare.com/).'
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -12,7 +12,7 @@ short_description: Sync Cobbler
description:
- Sync Cobbler to commit changes.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -75,7 +75,7 @@ import xmlrpc.client as xmlrpc_client
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.datetime import (
from ansible_collections.community.general.plugins.module_utils._datetime import (
now,
)

View file

@ -12,7 +12,7 @@ short_description: Manage system objects in Cobbler
description:
- Add, modify or remove systems in Cobbler.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -152,7 +152,7 @@ import xmlrpc.client as xmlrpc_client
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.datetime import (
from ansible_collections.community.general.plugins.module_utils._datetime import (
now,
)

View file

@ -16,7 +16,7 @@ description:
- Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs
and it installs them in your project for you.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -26,7 +26,7 @@ requirements:
- requests
author: "Steve Gargan (@sgargan)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -16,8 +16,8 @@ description:
author:
- Florian Apolloner (@apollo13)
extends_documentation_fragment:
- community.general.consul
- community.general.attributes
- community.general._consul
- community.general._attributes
attributes:
check_mode:
support: none
@ -68,7 +68,7 @@ result:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
RequestError,
_ConsulModule,

View file

@ -20,10 +20,10 @@ description:
author:
- Michael Ilg (@Ilgmi)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: full
@ -149,7 +149,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
OPERATION_CREATE,
OPERATION_DELETE,

View file

@ -18,10 +18,10 @@ description:
author:
- Michael Ilg (@Ilgmi)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: full
@ -184,7 +184,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
OPERATION_CREATE,
OPERATION_DELETE,

View file

@ -16,10 +16,10 @@ description:
author:
- Florian Apolloner (@apollo13)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: full
@ -132,7 +132,7 @@ import re
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
_ConsulModule,
camel_case_key,

View file

@ -16,10 +16,10 @@ description:
author:
- Florian Apolloner (@apollo13)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: full
@ -112,7 +112,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
RequestError,
_ConsulModule,

View file

@ -23,7 +23,7 @@ author:
- Steve Gargan (@sgargan)
- Colin Nolan (@colin-nolan)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -16,10 +16,10 @@ description:
author:
- Håkon Lerring (@Hakon)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: full
@ -122,7 +122,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
OPERATION_READ,
_ConsulModule,

View file

@ -16,10 +16,10 @@ description:
author:
- Håkon Lerring (@Hakon)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.token
- community.general.consul.actiongroup_consul
- community.general.attributes
- community.general._consul
- community.general._consul.token
- community.general._consul.actiongroup_consul
- community.general._attributes
attributes:
check_mode:
support: full
@ -202,7 +202,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
OPERATION_READ,
_ConsulModule,

View file

@ -17,10 +17,10 @@ author:
- Steve Gargan (@sgargan)
- Håkon Lerring (@Hakon)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.actiongroup_consul
- community.general.consul.token
- community.general.attributes
- community.general._consul
- community.general._consul.actiongroup_consul
- community.general._consul.token
- community.general._attributes
attributes:
check_mode:
support: none
@ -116,7 +116,7 @@ EXAMPLES = r"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import AUTH_ARGUMENTS_SPEC, _ConsulModule
from ansible_collections.community.general.plugins.module_utils._consul import AUTH_ARGUMENTS_SPEC, _ConsulModule
def execute(module, consul_module):

View file

@ -16,10 +16,10 @@ description:
author:
- Florian Apolloner (@apollo13)
extends_documentation_fragment:
- community.general.consul
- community.general.consul.token
- community.general.consul.actiongroup_consul
- community.general.attributes
- community.general._consul
- community.general._consul.token
- community.general._consul.actiongroup_consul
- community.general._attributes
attributes:
check_mode:
support: full
@ -202,7 +202,7 @@ operation:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.consul import (
from ansible_collections.community.general.plugins.module_utils._consul import (
AUTH_ARGUMENTS_SPEC,
_ConsulModule,
)

View file

@ -18,7 +18,7 @@ requirements:
notes:
- Supports C(check_mode).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -13,7 +13,7 @@ short_description: Manages Perl library dependencies
description:
- Manage Perl library dependencies using cpanminus.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none
@ -161,8 +161,8 @@ cpanm_version:
import os
import re
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
class CPANMinus(ModuleHelper):

View file

@ -22,7 +22,7 @@ description:
- Use this module to manage crontab variables.
- This module allows you to create, update, or delete cron variable definitions.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -12,7 +12,7 @@ short_description: Encrypted Linux block devices
description:
- Control Linux encrypted block devices that are set up during system boot in C(/etc/crypttab).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -19,7 +19,7 @@ requirements:
- datadog-api-client
- Python 3.6+
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -21,7 +21,7 @@ author:
- "Artūras 'arturaz' Šlajus (@arturaz)"
- "Naoya Nakazawa (@n0ts)"
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -15,7 +15,7 @@ description:
author: Sebastian Kornehl (@skornehl)
requirements: [datadog]
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -46,7 +46,7 @@ notes:
application affected by the key, and then having a look at value set using commands C(dconf dump /path/to/dir/) or C(dconf
read /path/to/key).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -136,7 +136,7 @@ from ansible.module_utils.common.respawn import (
respawn_module,
)
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils import _deps as deps
glib_module_name = "gi.repository.GLib"

View file

@ -16,7 +16,7 @@ description:
- Source file can be deleted after decompression.
extends_documentation_fragment:
- ansible.builtin.files
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -94,8 +94,8 @@ import tempfile
from ansible.module_utils.common.text.converters import to_bytes
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils.mh.module_helper import ModuleHelper
from ansible_collections.community.general.plugins.module_utils import _deps as deps
from ansible_collections.community.general.plugins.module_utils._mh.module_helper import ModuleHelper
with deps.declare("lzma"):
import lzma

View file

@ -104,7 +104,7 @@ notes:
your own release name with O(release). Due to the nature of deploying software, this should not be much of a problem.
extends_documentation_fragment:
- ansible.builtin.files
- community.general.attributes
- community.general._attributes
"""
EXAMPLES = r"""

View file

@ -18,7 +18,7 @@ seealso:
description: Documentation for Discord API.
link: https://discord.com/developers/docs/resources/webhook#execute-webhook
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,8 +14,8 @@ version_added: 9.1.0
description:
- This module is a wrapper for the execution of C(django-admin check).
extends_documentation_fragment:
- community.general.attributes
- community.general.django
- community.general._attributes
- community.general._django
options:
databases:
description:
@ -85,7 +85,7 @@ version:
version_added: 10.0.0
"""
from ansible_collections.community.general.plugins.module_utils.django import DjangoModuleHelper
from ansible_collections.community.general.plugins.module_utils._django import DjangoModuleHelper
class DjangoCheck(DjangoModuleHelper):

View file

@ -14,8 +14,8 @@ version_added: 9.0.0
description:
- This module allows the execution of arbitrary Django admin commands.
extends_documentation_fragment:
- community.general.attributes
- community.general.django
- community.general._attributes
- community.general._django
attributes:
check_mode:
support: none
@ -63,8 +63,8 @@ version:
import shlex
from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils.django import DjangoModuleHelper
from ansible_collections.community.general.plugins.module_utils._cmd_runner import cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils._django import DjangoModuleHelper
class DjangoCommand(DjangoModuleHelper):

View file

@ -14,9 +14,9 @@ version_added: 9.1.0
description:
- This module is a wrapper for the execution of C(django-admin createcachetable).
extends_documentation_fragment:
- community.general.attributes
- community.general.django
- community.general.django.database
- community.general._attributes
- community.general._django
- community.general._django.database
attributes:
check_mode:
support: full
@ -50,7 +50,7 @@ version:
version_added: 10.0.0
"""
from ansible_collections.community.general.plugins.module_utils.django import DjangoModuleHelper
from ansible_collections.community.general.plugins.module_utils._django import DjangoModuleHelper
class DjangoCreateCacheTable(DjangoModuleHelper):

View file

@ -14,10 +14,10 @@ version_added: 11.3.0
description:
- This module is a wrapper for the execution of C(django-admin dumpdata).
extends_documentation_fragment:
- community.general.attributes
- community.general.django
- community.general.django.database
- community.general.django.data
- community.general._attributes
- community.general._django
- community.general._django.database
- community.general._django.data
attributes:
check_mode:
support: none
@ -91,7 +91,7 @@ version:
sample: 5.1.2
"""
from ansible_collections.community.general.plugins.module_utils.django import DjangoModuleHelper
from ansible_collections.community.general.plugins.module_utils._django import DjangoModuleHelper
class DjangoDumpData(DjangoModuleHelper):

View file

@ -14,10 +14,10 @@ version_added: 11.3.0
description:
- This module is a wrapper for the execution of C(django-admin loaddata).
extends_documentation_fragment:
- community.general.attributes
- community.general.django
- community.general.django.database
- community.general.django.data
- community.general._attributes
- community.general._django
- community.general._django.database
- community.general._django.data
attributes:
check_mode:
support: none
@ -62,7 +62,7 @@ version:
sample: 5.1.2
"""
from ansible_collections.community.general.plugins.module_utils.django import DjangoModuleHelper
from ansible_collections.community.general.plugins.module_utils._django import DjangoModuleHelper
class DjangoLoadData(DjangoModuleHelper):

View file

@ -14,7 +14,7 @@ description:
- Manages a Django application using the C(manage.py) application frontend to C(django-admin). With the O(virtualenv) parameter,
all management commands are executed by the given C(virtualenv) installation.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -16,7 +16,7 @@ requirements:
- dnf
- dnf-plugins-core
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,7 +14,7 @@ description:
for packages and excludes all other versions of those packages. This allows you to for example protect packages from being
updated by newer versions. The state of the plugin that reflects locking of packages is the C(locklist).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: partial

View file

@ -13,7 +13,7 @@ short_description: Interface with dnsimple.com (a DNS hosting service)
description:
- 'Manages domains and records using the DNSimple API, see the docs: U(http://developer.dnsimple.com/).'
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -168,7 +168,7 @@ RETURN = r"""#"""
import re
import traceback
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
class DNSimpleV2:

View file

@ -16,8 +16,8 @@ version_added: "4.2.0"
description: Retrieve existing records and domains from DNSimple API.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general._attributes
- community.general._attributes.info_module
options:
name:
@ -226,7 +226,7 @@ dnsimple_record_info:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils import _deps as deps
with deps.declare("requests"):
from requests import Request, Session

View file

@ -13,7 +13,7 @@ description:
- 'Manages DNS records using the v2 REST API of the DNS Made Easy service. It handles records only; there is no manipulation
of domains or monitor/account support yet. See: U(https://www.dnsmadeeasy.com/integration/restapi/).'
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: none

View file

@ -21,7 +21,7 @@ description:
or remove a diversion for a given file, but also update an existing diversion to modify its O(holder) and/or its O(divert)
location.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -145,7 +145,7 @@ import re
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_bytes
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
def diversion_state(module, command, path):

View file

@ -12,7 +12,7 @@ short_description: Installs Python libraries
description:
- Installs Python libraries, optionally in a C(virtualenv).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ requirements:
description:
- This module provides user management for ejabberd servers.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -65,7 +65,7 @@ EXAMPLES = r"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
class EjabberdUser:

View file

@ -15,7 +15,7 @@ author:
- Mathew Davies (@ThePixelDeveloper)
- Sam Doran (@samdoran)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -17,8 +17,8 @@ short_description: Manage storage group member on EMC VNX
description:
- This module manages the members of an existing storage group.
extends_documentation_fragment:
- community.general.emc.emc_vnx
- community.general.attributes
- community.general._emc.emc_vnx
- community.general._attributes
attributes:
check_mode:
@ -82,7 +82,7 @@ import traceback
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible_collections.community.general.plugins.module_utils.storage.emc.emc_vnx import emc_vnx_argument_spec
from ansible_collections.community.general.plugins.module_utils._storage.emc.emc_vnx import emc_vnx_argument_spec
LIB_IMP_ERR = None
try:

View file

@ -15,7 +15,7 @@ description:
- Sets or deletes values in etcd3 cluster using its v3 API.
- Needs python etcd3 lib to work.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,9 +15,9 @@ description:
- Runs the C(facter) discovery program (U(https://github.com/puppetlabs/facter)) on the remote system, returning Ansible
facts from the JSON data that can be useful for inventory purposes.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.facts
- community.general.attributes.facts_module
- community.general._attributes
- community.general._attributes.facts
- community.general._attributes.facts_module
options:
arguments:
description:

View file

@ -23,7 +23,7 @@ author:
- Shahar Golshani (@shahargolshani)
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:

View file

@ -85,7 +85,7 @@ requirements:
extends_documentation_fragment:
- ansible.builtin.files
- community.general.attributes
- community.general._attributes
seealso:
- name: dd(1) manpage for Linux

View file

@ -16,7 +16,7 @@ short_description: Makes a filesystem
description:
- This module creates a filesystem.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -155,7 +155,7 @@ import stat
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils._lvm import pvs_runner
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
class Device:

View file

@ -20,7 +20,7 @@ author:
requirements:
- flatpak
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: partial
@ -188,7 +188,7 @@ from urllib.parse import urlparse
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
OUTDATED_FLATPAK_VERSION_ERROR_MESSAGE = "Unknown option --columns=application"

View file

@ -23,7 +23,7 @@ author:
requirements:
- flatpak
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -15,7 +15,7 @@ short_description: Manage Gandi LiveDNS records
description:
- 'Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/).'
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -160,7 +160,7 @@ record:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.gandi_livedns_api import GandiLiveDNSAPI
from ansible_collections.community.general.plugins.module_utils._gandi_livedns_api import GandiLiveDNSAPI
def main():

View file

@ -21,7 +21,7 @@ seealso:
link: https://help.gnome.org/admin//system-admin-guide/2.32/gconf-6.html.en
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -102,8 +102,8 @@ version:
version_added: 10.0.0
"""
from ansible_collections.community.general.plugins.module_utils.gconftool2 import gconftool2_runner
from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
from ansible_collections.community.general.plugins.module_utils._gconftool2 import gconftool2_runner
from ansible_collections.community.general.plugins.module_utils._module_helper import StateModuleHelper
class GConftool(StateModuleHelper):

View file

@ -14,8 +14,8 @@ version_added: 5.1.0
description:
- This module allows retrieving application preferences from the GConf database, with the help of C(gconftool-2).
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general._attributes
- community.general._attributes.info_module
options:
key:
description:
@ -53,8 +53,8 @@ version:
version_added: 10.0.0
"""
from ansible_collections.community.general.plugins.module_utils.gconftool2 import gconftool2_runner
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
from ansible_collections.community.general.plugins.module_utils._gconftool2 import gconftool2_runner
from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
class GConftoolInfo(ModuleHelper):

View file

@ -12,7 +12,7 @@ short_description: Manage Ruby gems
description:
- Manage installation and uninstallation of Ruby gems.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -126,8 +126,8 @@ import re
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils import cmd_runner_fmt as fmt
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner
from ansible_collections.community.general.plugins.module_utils import _cmd_runner_fmt as fmt
from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner
RE_VERSION = re.compile(r"^(\d+)\.(\d+)\.(\d+)")
RE_INSTALLED = re.compile(r"\S+\s+\((?:default: )?(.+)\)")

View file

@ -15,7 +15,7 @@ description:
- This module allows configuring the default handler for a specific MIME type, to be used by applications built with the
Gnome GIO API.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -67,8 +67,8 @@ version:
version_added: 10.0.0
"""
from ansible_collections.community.general.plugins.module_utils.gio_mime import gio_mime_get, gio_mime_runner
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
from ansible_collections.community.general.plugins.module_utils._gio_mime import gio_mime_get, gio_mime_runner
from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
class GioMime(ModuleHelper):

View file

@ -21,7 +21,7 @@ description:
just C(user.email) in C(/etc/.git/config)). Solutions involving M(ansible.builtin.command) are cumbersome or do not work
correctly in check mode.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -17,8 +17,8 @@ short_description: Read git configuration
description:
- The M(community.general.git_config_info) module reads the git configuration by invoking C(git config).
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general._attributes
- community.general._attributes.info_module
options:
name:
description:

View file

@ -15,7 +15,7 @@ description:
password and 2-factor authentication code (OTP), OAuth2 token, or personal access token. Admin rights on the repository
are required.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -13,7 +13,7 @@ short_description: View GitHub issue
description:
- View GitHub issue for a given repository and organization.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -13,7 +13,7 @@ description:
- Creates, removes, or updates GitHub access keys.
- Works with both GitHub.com and GitHub Enterprise Server installations.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -134,7 +134,7 @@ import re
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
from ansible_collections.community.general.plugins.module_utils.datetime import (
from ansible_collections.community.general.plugins.module_utils._datetime import (
now,
)

View file

@ -12,7 +12,7 @@ short_description: Interact with GitHub Releases
description:
- Fetch metadata about GitHub Releases.
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -14,7 +14,7 @@ description:
- Manages Github repositories using PyGithub library.
- Authentication can be done with O(access_token) or with O(username) and O(password).
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full

View file

@ -17,7 +17,7 @@ version_added: '12.5.0'
requirements:
- pynacl
extends_documentation_fragment:
- community.general.attributes
- community.general._attributes
attributes:
check_mode:
support: full
@ -106,7 +106,7 @@ from http import HTTPStatus
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils import _deps as deps
with deps.declare(
"pynacl",

View file

@ -15,8 +15,8 @@ author:
- Thomas Sjögren (@konstruktoid)
version_added: '12.5.0'
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general._attributes
- community.general._attributes.info_module
options:
organization:
description:
@ -82,7 +82,7 @@ from http import HTTPStatus
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
from ansible_collections.community.general.plugins.module_utils import deps
from ansible_collections.community.general.plugins.module_utils import _deps as deps
def list_secrets(

Some files were not shown because too many files have changed in this diff Show more