Remove all CI scripts since this branch is now End of Life.

[stable-9] docs: add notes that dnf_* modules do not work with dnf5 (#10238) (#10248)

docs: add notes that dnf_* modules do not work with dnf5 (#10238)

* Add notes that dnf_* modules do not work with dnf5.

* Apply suggestions from code review.

---------

(cherry picked from commit 1956815884)


(cherry picked from commit cb26c50d65)

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

.azure-pipelines/README.md

@@ -1,9 +0,0 @@
-<!--
-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
--->
-
-## Azure Pipelines Configuration
-
-Please see the [Documentation](https://github.com/ansible/community/wiki/Testing:-Azure-Pipelines) for more information.

.azure-pipelines/azure-pipelines.yml

@@ -1,435 +0,0 @@
----
-# 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
-
-trigger:
-  batch: true
-  branches:
-    include:
-      - main
-      - stable-*
-
-pr:
-  autoCancel: true
-  branches:
-    include:
-      - main
-      - stable-*
-
-schedules:
-  - cron: 0 8 * * *
-    displayName: Nightly (main)
-    always: true
-    branches:
-      include:
-        - main
-  - cron: 0 10 * * *
-    displayName: Nightly (active stable branches)
-    always: true
-    branches:
-      include:
-        - stable-10
-        - stable-9
-  - cron: 0 11 * * 0
-    displayName: Weekly (old stable branches)
-    always: true
-    branches:
-      include:
-        - stable-8
-
-variables:
-  - name: checkoutPath
-    value: ansible_collections/community/general
-  - name: coverageBranches
-    value: main
-  - name: entryPoint
-    value: tests/utils/shippable/shippable.sh
-  - name: fetchDepth
-    value: 0
-
-resources:
-  containers:
-    - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:6.0.0
-
-pool: Standard
-
-stages:
-### Sanity
-  - stage: Sanity_2_19
-    displayName: Sanity 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.19/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_18
-    displayName: Sanity 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.18/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_17
-    displayName: Sanity 2.17
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.17/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_16
-    displayName: Sanity 2.16
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.16/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-### Units
-  - stage: Units_2_19
-    displayName: Units 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.19/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: 3.9
-            - test: '3.10'
-            - test: '3.11'
-            - test: '3.12'
-            - test: '3.13'
-  - stage: Units_2_18
-    displayName: Units 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.18/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: "3.13"
-  - stage: Units_2_17
-    displayName: Units 2.17
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.17/units/{0}/1
-          targets:
-            - test: 3.7
-            - test: "3.12"
-  - stage: Units_2_16
-    displayName: Units 2.16
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.16/units/{0}/1
-          targets:
-            - test: 2.7
-            - test: 3.6
-            - test: "3.11"
-
-## Remote
-  - stage: Remote_2_19_extra_vms
-    displayName: Remote 2.19 extra VMs
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/{0}
-          targets:
-            - name: Alpine 3.21
-              test: alpine/3.21
-            # - name: Fedora 41
-            #   test: fedora/41
-            - name: Ubuntu 22.04
-              test: ubuntu/22.04
-            - name: Ubuntu 24.04
-              test: ubuntu/24.04
-          groups:
-            - vm
-  - stage: Remote_2_19
-    displayName: Remote 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/{0}
-          targets:
-            - name: macOS 15.3
-              test: macos/15.3
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: RHEL 9.5
-              test: rhel/9.5
-            - name: FreeBSD 14.2
-              test: freebsd/14.2
-            - name: FreeBSD 13.5
-              test: freebsd/13.5
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_18
-    displayName: Remote 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/{0}
-          targets:
-            - name: macOS 14.3
-              test: macos/14.3
-            - name: RHEL 9.4
-              test: rhel/9.4
-            - name: FreeBSD 14.1
-              test: freebsd/14.1
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_17
-    displayName: Remote 2.17
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.17/{0}
-          targets:
-            - name: FreeBSD 13.3
-              test: freebsd/13.3
-            - name: RHEL 9.3
-              test: rhel/9.3
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_16
-    displayName: Remote 2.16
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.16/{0}
-          targets:
-            - name: macOS 13.2
-              test: macos/13.2
-            - name: RHEL 9.2
-              test: rhel/9.2
-            - name: RHEL 8.8
-              test: rhel/8.8
-            - name: RHEL 7.9
-              test: rhel/7.9
-            # - name: FreeBSD 13.2
-            #   test: freebsd/13.2
-          groups:
-            - 1
-            - 2
-            - 3
-
-### Docker
-  - stage: Docker_2_19
-    displayName: Docker 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/linux/{0}
-          targets:
-            - name: Fedora 41
-              test: fedora41
-            - name: Alpine 3.21
-              test: alpine321
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_18
-    displayName: Docker 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/linux/{0}
-          targets:
-            - name: Fedora 40
-              test: fedora40
-            - name: Alpine 3.20
-              test: alpine320
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_17
-    displayName: Docker 2.17
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.17/linux/{0}
-          targets:
-            - name: Fedora 39
-              test: fedora39
-            - name: Alpine 3.19
-              test: alpine319
-            - name: Ubuntu 20.04
-              test: ubuntu2004
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_16
-    displayName: Docker 2.16
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.16/linux/{0}
-          targets:
-            - name: Fedora 38
-              test: fedora38
-            - name: openSUSE 15
-              test: opensuse15
-            - name: Alpine 3
-              test: alpine3
-            - name: CentOS 7
-              test: centos7
-          groups:
-            - 1
-            - 2
-            - 3
-
-### Community Docker
-  - stage: Docker_community_2_19
-    displayName: Docker (community images) 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/linux-community/{0}
-          targets:
-            - name: Debian Bullseye
-              test: debian-bullseye/3.9
-            - name: Debian Bookworm
-              test: debian-bookworm/3.11
-            - name: ArchLinux
-              test: archlinux/3.13
-          groups:
-            - 1
-            - 2
-            - 3
-
-### Generic
-# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-#  - stage: Generic_2_19
-#    displayName: Generic 2.19
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.19/generic/{0}/1
-#          targets:
-#            - test: '3.8'
-#            - test: '3.11'
-#            - test: '3.13'
-#  - stage: Generic_2_18
-#    displayName: Generic 2.18
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.18/generic/{0}/1
-#          targets:
-#            - test: '3.8'
-#            - test: '3.13'
-#  - stage: Generic_2_17
-#    displayName: Generic 2.17
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.17/generic/{0}/1
-#          targets:
-#            - test: '3.7'
-#            - test: '3.12'
-#  - stage: Generic_2_16
-#    displayName: Generic 2.16
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.16/generic/{0}/1
-#          targets:
-#            - test: '2.7'
-#            - test: '3.6'
-#            - test: '3.11'
-
-  - stage: Summary
-    condition: succeededOrFailed()
-    dependsOn:
-      - Sanity_2_19
-      - Sanity_2_18
-      - Sanity_2_17
-      - Sanity_2_16
-      - Units_2_19
-      - Units_2_18
-      - Units_2_17
-      - Units_2_16
-      - Remote_2_19_extra_vms
-      - Remote_2_19
-      - Remote_2_18
-      - Remote_2_17
-      - Remote_2_16
-      - Docker_2_19
-      - Docker_2_18
-      - Docker_2_17
-      - Docker_2_16
-      - Docker_community_2_19
-# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-#      - Generic_2_19
-#      - Generic_2_18
-#      - Generic_2_17
-#      - Generic_2_16
-    jobs:
-      - template: templates/coverage.yml

.azure-pipelines/scripts/aggregate-coverage.sh

@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-# 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
-
-# Aggregate code coverage results for later processing.
-
-set -o pipefail -eu
-
-agent_temp_directory="$1"
-
-PATH="${PWD}/bin:${PATH}"
-
-mkdir "${agent_temp_directory}/coverage/"
-
-options=(--venv --venv-system-site-packages --color -v)
-
-ansible-test coverage combine --group-by command --export "${agent_temp_directory}/coverage/" "${options[@]}"
-
-if ansible-test coverage analyze targets generate --help >/dev/null 2>&1; then
-    # Only analyze coverage if the installed version of ansible-test supports it.
-    # Doing so allows this script to work unmodified for multiple Ansible versions.
-    ansible-test coverage analyze targets generate "${agent_temp_directory}/coverage/coverage-analyze-targets.json" "${options[@]}"
-fi

.azure-pipelines/scripts/combine-coverage.py

@@ -1,64 +0,0 @@
-#!/usr/bin/env python
-# 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
-
-"""
-Combine coverage data from multiple jobs, keeping the data only from the most recent attempt from each job.
-Coverage artifacts must be named using the format: "Coverage $(System.JobAttempt) {StableUniqueNameForEachJob}"
-The recommended coverage artifact name format is: Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)
-Keep in mind that Azure Pipelines does not enforce unique job display names (only names).
-It is up to pipeline authors to avoid name collisions when deviating from the recommended format.
-"""
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import os
-import re
-import shutil
-import sys
-
-
-def main():
-    """Main program entry point."""
-    source_directory = sys.argv[1]
-
-    if '/ansible_collections/' in os.getcwd():
-        output_path = "tests/output"
-    else:
-        output_path = "test/results"
-
-    destination_directory = os.path.join(output_path, 'coverage')
-
-    if not os.path.exists(destination_directory):
-        os.makedirs(destination_directory)
-
-    jobs = {}
-    count = 0
-
-    for name in os.listdir(source_directory):
-        match = re.search('^Coverage (?P<attempt>[0-9]+) (?P<label>.+)$', name)
-        label = match.group('label')
-        attempt = int(match.group('attempt'))
-        jobs[label] = max(attempt, jobs.get(label, 0))
-
-    for label, attempt in jobs.items():
-        name = 'Coverage {attempt} {label}'.format(label=label, attempt=attempt)
-        source = os.path.join(source_directory, name)
-        source_files = os.listdir(source)
-
-        for source_file in source_files:
-            source_path = os.path.join(source, source_file)
-            destination_path = os.path.join(destination_directory, source_file + '.' + label)
-            print('"%s" -> "%s"' % (source_path, destination_path))
-            shutil.copyfile(source_path, destination_path)
-            count += 1
-
-    print('Coverage file count: %d' % count)
-    print('##vso[task.setVariable variable=coverageFileCount]%d' % count)
-    print('##vso[task.setVariable variable=outputPath]%s' % output_path)
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/scripts/process-results.sh

@@ -1,28 +0,0 @@
-#!/usr/bin/env bash
-# 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
-
-# Check the test results and set variables for use in later steps.
-
-set -o pipefail -eu
-
-if [[ "$PWD" =~ /ansible_collections/ ]]; then
-    output_path="tests/output"
-else
-    output_path="test/results"
-fi
-
-echo "##vso[task.setVariable variable=outputPath]${output_path}"
-
-if compgen -G "${output_path}"'/junit/*.xml' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveTestResults]true"
-fi
-
-if compgen -G "${output_path}"'/bot/ansible-test-*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveBotResults]true"
-fi
-
-if compgen -G "${output_path}"'/coverage/*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveCoverageData]true"
-fi

.azure-pipelines/scripts/publish-codecov.py

@@ -1,105 +0,0 @@
-#!/usr/bin/env python
-# 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
-
-"""
-Upload code coverage reports to codecov.io.
-Multiple coverage files from multiple languages are accepted and aggregated after upload.
-Python coverage, as well as PowerShell and Python stubs can all be uploaded.
-"""
-
-import argparse
-import dataclasses
-import pathlib
-import shutil
-import subprocess
-import tempfile
-import typing as t
-import urllib.request
-
-
-@dataclasses.dataclass(frozen=True)
-class CoverageFile:
-    name: str
-    path: pathlib.Path
-    flags: t.List[str]
-
-
-@dataclasses.dataclass(frozen=True)
-class Args:
-    dry_run: bool
-    path: pathlib.Path
-
-
-def parse_args() -> Args:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-n', '--dry-run', action='store_true')
-    parser.add_argument('path', type=pathlib.Path)
-
-    args = parser.parse_args()
-
-    # Store arguments in a typed dataclass
-    fields = dataclasses.fields(Args)
-    kwargs = {field.name: getattr(args, field.name) for field in fields}
-
-    return Args(**kwargs)
-
-
-def process_files(directory: pathlib.Path) -> t.Tuple[CoverageFile, ...]:
-    processed = []
-    for file in directory.joinpath('reports').glob('coverage*.xml'):
-        name = file.stem.replace('coverage=', '')
-
-        # Get flags from name
-        flags = name.replace('-powershell', '').split('=')  # Drop '-powershell' suffix
-        flags = [flag if not flag.startswith('stub') else flag.split('-')[0] for flag in flags]  # Remove "-01" from stub files
-
-        processed.append(CoverageFile(name, file, flags))
-
-    return tuple(processed)
-
-
-def upload_files(codecov_bin: pathlib.Path, files: t.Tuple[CoverageFile, ...], dry_run: bool = False) -> None:
-    for file in files:
-        cmd = [
-            str(codecov_bin),
-            '--name', file.name,
-            '--file', str(file.path),
-        ]
-        for flag in file.flags:
-            cmd.extend(['--flags', flag])
-
-        if dry_run:
-            print(f'DRY-RUN: Would run command: {cmd}')
-            continue
-
-        subprocess.run(cmd, check=True)
-
-
-def download_file(url: str, dest: pathlib.Path, flags: int, dry_run: bool = False) -> None:
-    if dry_run:
-        print(f'DRY-RUN: Would download {url} to {dest} and set mode to {flags:o}')
-        return
-
-    with urllib.request.urlopen(url) as resp:
-        with dest.open('w+b') as f:
-            # Read data in chunks rather than all at once
-            shutil.copyfileobj(resp, f, 64 * 1024)
-
-    dest.chmod(flags)
-
-
-def main():
-    args = parse_args()
-    url = 'https://ansible-ci-files.s3.amazonaws.com/codecov/linux/codecov'
-    with tempfile.TemporaryDirectory(prefix='codecov-') as tmpdir:
-        codecov_bin = pathlib.Path(tmpdir) / 'codecov'
-        download_file(url, codecov_bin, 0o755, args.dry_run)
-
-        files = process_files(args.path)
-        upload_files(codecov_bin, files, args.dry_run)
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/scripts/report-coverage.sh

@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-# 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
-
-# Generate code coverage reports for uploading to Azure Pipelines and codecov.io.
-
-set -o pipefail -eu
-
-PATH="${PWD}/bin:${PATH}"
-
-if ! ansible-test --help >/dev/null 2>&1; then
-    # Install the devel version of ansible-test for generating code coverage reports.
-    # This is only used by Ansible Collections, which are typically tested against multiple Ansible versions (in separate jobs).
-    # Since a version of ansible-test is required that can work the output from multiple older releases, the devel version is used.
-    pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check
-fi
-
-ansible-test coverage xml --group-by command --stub --venv --venv-system-site-packages --color -v

.azure-pipelines/scripts/run-tests.sh

@@ -1,38 +0,0 @@
-#!/usr/bin/env bash
-# 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
-
-# Configure the test environment and run the tests.
-
-set -o pipefail -eu
-
-entry_point="$1"
-test="$2"
-read -r -a coverage_branches <<< "$3"  # space separated list of branches to run code coverage on for scheduled builds
-
-export COMMIT_MESSAGE
-export COMPLETE
-export COVERAGE
-export IS_PULL_REQUEST
-
-if [ "${SYSTEM_PULLREQUEST_TARGETBRANCH:-}" ]; then
-    IS_PULL_REQUEST=true
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD^2)
-else
-    IS_PULL_REQUEST=
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD)
-fi
-
-COMPLETE=
-COVERAGE=
-
-if [ "${BUILD_REASON}" = "Schedule" ]; then
-    COMPLETE=yes
-
-    if printf '%s\n' "${coverage_branches[@]}" | grep -q "^${BUILD_SOURCEBRANCHNAME}$"; then
-        COVERAGE=yes
-    fi
-fi
-
-"${entry_point}" "${test}" 2>&1 | "$(dirname "$0")/time-command.py"

.azure-pipelines/scripts/time-command.py

@@ -1,29 +0,0 @@
-#!/usr/bin/env python
-# 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
-
-"""Prepends a relative timestamp to each input line from stdin and writes it to stdout."""
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import time
-
-
-def main():
-    """Main program entry point."""
-    start = time.time()
-
-    sys.stdin.reconfigure(errors='surrogateescape')
-    sys.stdout.reconfigure(errors='surrogateescape')
-
-    for line in sys.stdin:
-        seconds = time.time() - start
-        sys.stdout.write('%02d:%02d %s' % (seconds // 60, seconds % 60, line))
-        sys.stdout.flush()
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/templates/coverage.yml

@@ -1,34 +0,0 @@
----
-# 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
-
-# This template adds a job for processing code coverage data.
-# It will upload results to Azure Pipelines and codecov.io.
-# Use it from a job stage that completes after all other jobs have completed.
-# This can be done by placing it in a separate summary stage that runs after the test stage(s) have completed.
-
-jobs:
-  - job: Coverage
-    displayName: Code Coverage
-    container: default
-    workspace:
-      clean: all
-    steps:
-      - checkout: self
-        fetchDepth: $(fetchDepth)
-        path: $(checkoutPath)
-      - task: DownloadPipelineArtifact@2
-        displayName: Download Coverage Data
-        inputs:
-          path: coverage/
-          patterns: "Coverage */*=coverage.combined"
-      - bash: .azure-pipelines/scripts/combine-coverage.py coverage/
-        displayName: Combine Coverage Data
-      - bash: .azure-pipelines/scripts/report-coverage.sh
-        displayName: Generate Coverage Report
-        condition: gt(variables.coverageFileCount, 0)
-      - bash: .azure-pipelines/scripts/publish-codecov.py "$(outputPath)"
-        displayName: Publish to codecov.io
-        condition: gt(variables.coverageFileCount, 0)
-        continueOnError: true

.azure-pipelines/templates/matrix.yml

@@ -1,60 +0,0 @@
----
-# 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
-
-# This template uses the provided targets and optional groups to generate a matrix which is then passed to the test template.
-# If this matrix template does not provide the required functionality, consider using the test template directly instead.
-
-parameters:
-  # A required list of dictionaries, one per test target.
-  # Each item in the list must contain a "test" or "name" key.
-  # Both may be provided. If one is omitted, the other will be used.
-  - name: targets
-    type: object
-
-  # An optional list of values which will be used to multiply the targets list into a matrix.
-  # Values can be strings or numbers.
-  - name: groups
-    type: object
-    default: []
-
-  # An optional format string used to generate the job name.
-  # - {0} is the name of an item in the targets list.
-  - name: nameFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to generate the test name.
-  # - {0} is the name of an item in the targets list.
-  - name: testFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to add the group to the job name.
-  # {0} is the formatted name of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: nameGroupFormat
-    type: string
-    default: "{0} - {{1}}"
-
-  # An optional format string used to add the group to the test name.
-  # {0} is the formatted test of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: testGroupFormat
-    type: string
-    default: "{0}/{{1}}"
-
-jobs:
-  - template: test.yml
-    parameters:
-      jobs:
-        - ${{ if eq(length(parameters.groups), 0) }}:
-          - ${{ each target in parameters.targets }}:
-            - name: ${{ format(parameters.nameFormat, coalesce(target.name, target.test)) }}
-              test: ${{ format(parameters.testFormat, coalesce(target.test, target.name)) }}
-        - ${{ if not(eq(length(parameters.groups), 0)) }}:
-          - ${{ each group in parameters.groups }}:
-            - ${{ each target in parameters.targets }}:
-              - name: ${{ format(format(parameters.nameGroupFormat, parameters.nameFormat), coalesce(target.name, target.test), group) }}
-                test: ${{ format(format(parameters.testGroupFormat, parameters.testFormat), coalesce(target.test, target.name), group) }}

.azure-pipelines/templates/test.yml

@@ -1,50 +0,0 @@
----
-# 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
-
-# This template uses the provided list of jobs to create test one or more test jobs.
-# It can be used directly if needed, or through the matrix template.
-
-parameters:
-  # A required list of dictionaries, one per test job.
-  # Each item in the list must contain a "job" and "name" key.
-  - name: jobs
-    type: object
-
-jobs:
-  - ${{ each job in parameters.jobs }}:
-    - job: test_${{ replace(replace(replace(job.test, '/', '_'), '.', '_'), '-', '_') }}
-      displayName: ${{ job.name }}
-      container: default
-      workspace:
-        clean: all
-      steps:
-        - checkout: self
-          fetchDepth: $(fetchDepth)
-          path: $(checkoutPath)
-        - bash: .azure-pipelines/scripts/run-tests.sh "$(entryPoint)" "${{ job.test }}" "$(coverageBranches)"
-          displayName: Run Tests
-        - bash: .azure-pipelines/scripts/process-results.sh
-          condition: succeededOrFailed()
-          displayName: Process Results
-        - bash: .azure-pipelines/scripts/aggregate-coverage.sh "$(Agent.TempDirectory)"
-          condition: eq(variables.haveCoverageData, 'true')
-          displayName: Aggregate Coverage Data
-        - task: PublishTestResults@2
-          condition: eq(variables.haveTestResults, 'true')
-          inputs:
-            testResultsFiles: "$(outputPath)/junit/*.xml"
-          displayName: Publish Test Results
-        - task: PublishPipelineArtifact@1
-          condition: eq(variables.haveBotResults, 'true')
-          displayName: Publish Bot Results
-          inputs:
-            targetPath: "$(outputPath)/bot/"
-            artifactName: "Bot $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"
-        - task: PublishPipelineArtifact@1
-          condition: eq(variables.haveCoverageData, 'true')
-          displayName: Publish Coverage Data
-          inputs:
-            targetPath: "$(Agent.TempDirectory)/coverage/"
-            artifactName: "Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"

.github/BOTMETA.yml

@@ -33,8 +33,6 @@ files:
     maintainers: $team_ansible_core
   $becomes/pmrun.py:
     maintainers: $team_ansible_core
-  $becomes/run0.py:
-    maintainers: konstruktoid
   $becomes/sesu.py:
     maintainers: nekonyuu
   $becomes/sudosu.py:
@@ -91,8 +89,6 @@ files:
     maintainers: ryancurrah
   $callbacks/syslog_json.py:
     maintainers: imjoseangel
-  $callbacks/timestamp.py:
-    maintainers: kurokobo
   $callbacks/unixy.py:
     labels: unixy
     maintainers: akatch
@@ -121,8 +117,6 @@ files:
     maintainers: $team_ansible_core
   $doc_fragments/:
     labels: docs_fragments
-  $doc_fragments/django.py:
-    maintainers: russoz
   $doc_fragments/hpe3par.py:
     labels: hpe3par
     maintainers: farhan7500 gautamphegde
@@ -131,8 +125,6 @@ files:
     maintainers: $team_huawei
   $doc_fragments/nomad.py:
     maintainers: chris93111 apecnascimento
-  $doc_fragments/pipx.py:
-    maintainers: russoz
   $doc_fragments/xenserver.py:
     labels: xenserver
     maintainers: bvitnik
@@ -159,8 +151,6 @@ files:
   $filters/jc.py:
     maintainers: kellyjonbrazil
   $filters/json_query.py: {}
-  $filters/keep_keys.py:
-    maintainers: vbotka
   $filters/lists.py:
     maintainers: cfiehe
   $filters/lists_difference.yml:
@@ -174,12 +164,6 @@ files:
   $filters/lists_union.yml:
     maintainers: cfiehe
   $filters/random_mac.py: {}
-  $filters/remove_keys.py:
-    maintainers: vbotka
-  $filters/replace_keys.py:
-    maintainers: vbotka
-  $filters/reveal_ansible_type.py:
-    maintainers: vbotka
   $filters/time.py:
     maintainers: resmo
   $filters/to_days.yml:
@@ -310,12 +294,8 @@ files:
     labels: module_utils
   $module_utils/btrfs.py:
     maintainers: gnfzdz
-  $module_utils/cmd_runner.py:
-    maintainers: russoz
   $module_utils/deps.py:
     maintainers: russoz
-  $module_utils/django.py:
-    maintainers: russoz
   $module_utils/gconftool2.py:
     labels: gconftool2
     maintainers: russoz
@@ -359,8 +339,6 @@ files:
   $module_utils/pipx.py:
     labels: pipx
     maintainers: russoz
-  $module_utils/python_runner.py:
-    maintainers: russoz
   $module_utils/puppet.py:
     labels: puppet
     maintainers: russoz
@@ -450,8 +428,6 @@ files:
     ignore: hkariti
   $modules/bitbucket_:
     maintainers: catcombo
-  $modules/bootc_manage.py:
-    maintainers: cooktheryan
   $modules/bower.py:
     maintainers: mwarkentin
   $modules/btrfs_:
@@ -514,12 +490,6 @@ files:
     maintainers: tintoy
   $modules/discord.py:
     maintainers: cwollinger
-  $modules/django_check.py:
-    maintainers: russoz
-  $modules/django_command.py:
-    maintainers: russoz
-  $modules/django_createcachetable.py:
-    maintainers: russoz
   $modules/django_manage.py:
     ignore: scottanderson42 tastychutney
     labels: django_manage
@@ -562,6 +532,8 @@ files:
     maintainers: $team_flatpak
   $modules/flatpak_remote.py:
     maintainers: $team_flatpak
+  $modules/flowdock.py:
+    ignore: mcodd
   $modules/gandi_livedns.py:
     maintainers: gthiemonge
   $modules/gconftool2.py:
@@ -650,11 +622,6 @@ files:
     labels: homebrew_ macos
     maintainers: $team_macos
     notify: chris-short
-  $modules/homebrew_services.py:
-    ignore: ryansb
-    keywords: brew cask services darwin homebrew macosx macports osx
-    labels: homebrew_ macos
-    maintainers: $team_macos kitizz
   $modules/homectl.py:
     maintainers: jameslivulpi
   $modules/honeybadger_deployment.py:
@@ -714,8 +681,6 @@ files:
   $modules/ipa_:
     maintainers: $team_ipa
     ignore: fxfitz
-  $modules/ipa_getkeytab.py:
-    maintainers: abakanovskii
   $modules/ipa_dnsrecord.py:
     maintainers: $team_ipa jwbernin
   $modules/ipbase_info.py:
@@ -813,8 +778,6 @@ files:
     maintainers: elfelip
   $modules/keycloak_user_federation.py:
     maintainers: laurpaum
-  $modules/keycloak_userprofile.py:
-    maintainers: yeoldegrove
   $modules/keycloak_component_info.py:
     maintainers: desand01
   $modules/keycloak_client_rolescope.py:
@@ -980,8 +943,6 @@ files:
     maintainers: $team_opennebula
   $modules/one_host.py:
     maintainers: rvalle
-  $modules/one_vnet.py:
-    maintainers: abakanovskii
   $modules/oneandone_:
     maintainers: aajdinov edevenport
   $modules/onepassword_info.py:
@@ -1135,6 +1096,46 @@ files:
   $modules/python_requirements_info.py:
     ignore: ryansb
     maintainers: willthames
+  $modules/rax:
+    ignore: ryansb sivel
+  $modules/rax.py:
+    maintainers: omgjlk sivel
+  $modules/rax_cbs.py:
+    maintainers: claco
+  $modules/rax_cbs_attachments.py:
+    maintainers: claco
+  $modules/rax_cdb.py:
+    maintainers: jails
+  $modules/rax_cdb_database.py:
+    maintainers: jails
+  $modules/rax_cdb_user.py:
+    maintainers: jails
+  $modules/rax_clb.py:
+    maintainers: claco
+  $modules/rax_clb_nodes.py:
+    maintainers: neuroid
+  $modules/rax_clb_ssl.py:
+    maintainers: smashwilson
+  $modules/rax_files.py:
+    maintainers: angstwad
+  $modules/rax_files_objects.py:
+    maintainers: angstwad
+  $modules/rax_identity.py:
+    maintainers: claco
+  $modules/rax_mon_alarm.py:
+    maintainers: smashwilson
+  $modules/rax_mon_check.py:
+    maintainers: smashwilson
+  $modules/rax_mon_entity.py:
+    maintainers: smashwilson
+  $modules/rax_mon_notification.py:
+    maintainers: smashwilson
+  $modules/rax_mon_notification_plan.py:
+    maintainers: smashwilson
+  $modules/rax_network.py:
+    maintainers: claco omgjlk
+  $modules/rax_queue.py:
+    maintainers: claco
   $modules/read_csv.py:
     maintainers: dagwieers
   $modules/redfish_:
@@ -1299,6 +1300,8 @@ files:
     maintainers: farhan7500 gautamphegde
   $modules/ssh_config.py:
     maintainers: gaqzi Akasurde
+  $modules/stackdriver.py:
+    maintainers: bwhaley
   $modules/stacki_host.py:
     labels: stacki_host
     maintainers: bsanders bbyhuy
@@ -1394,6 +1397,8 @@ files:
     maintainers: $team_wdc
   $modules/wdc_redfish_info.py:
     maintainers: $team_wdc
+  $modules/webfaction_:
+    maintainers: quentinsf
   $modules/xattr.py:
     labels: xattr
     maintainers: bcoca
@@ -1445,16 +1450,10 @@ files:
     ignore: matze
     labels: zypper
     maintainers: $team_suse
-  $plugin_utils/ansible_type.py:
-    maintainers: vbotka
-  $plugin_utils/keys_filter.py:
-    maintainers: vbotka
   $plugin_utils/unsafe.py:
     maintainers: felixfontein
   $tests/a_module.py:
     maintainers: felixfontein
-  $tests/ansible_type.py:
-    maintainers: vbotka
   $tests/fqdn_valid.py:
     maintainers: vbotka
 #########################
@@ -1468,14 +1467,6 @@ files:
     maintainers: felixfontein
   docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst:
     maintainers: cfiehe
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries.rst:
-    maintainers: vbotka
   docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst:
     maintainers: vbotka
   docs/docsite/rst/filter_guide_conversions.rst:
@@ -1492,20 +1483,12 @@ files:
     maintainers: ericzolf
   docs/docsite/rst/guide_alicloud.rst:
     maintainers: xiaozhu36
-  docs/docsite/rst/guide_cmdrunner.rst:
-    maintainers: russoz
-  docs/docsite/rst/guide_deps.rst:
-    maintainers: russoz
-  docs/docsite/rst/guide_modulehelper.rst:
-    maintainers: russoz
   docs/docsite/rst/guide_online.rst:
     maintainers: remyleone
   docs/docsite/rst/guide_packet.rst:
     maintainers: baldwinSPC nurfet-becirevic t0mk teebes
   docs/docsite/rst/guide_scaleway.rst:
     maintainers: $team_scaleway
-  docs/docsite/rst/guide_vardict.rst:
-    maintainers: russoz
   docs/docsite/rst/test_guide.rst:
     maintainers: felixfontein
 #########################
@@ -1537,7 +1520,7 @@ macros:
   team_ansible_core:
   team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
-  team_consul: sgargan apollo13 Ilgmi
+  team_consul: sgargan apollo13
   team_cyberark_conjur: jvanderhoof ryanprior
   team_e_spirit: MatrixCrawler getjack
   team_flatpak: JayKayy oolongbrothers
@@ -1546,7 +1529,7 @@ macros:
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht justchris1
   team_jboss: Wolfant jairojunior wbrefvem
-  team_keycloak: eikef ndclt mattock thomasbach-dev
+  team_keycloak: eikef ndclt mattock
   team_linode: InTheCloudDan decentral1se displague rmcintosh Charliekenney23 LBGarber
   team_macos: Akasurde kyleabenson martinm82 danieljaouen indrajitr
   team_manageiq: abellotti cben gtanzillo yaacov zgalor dkorn evertmulder

.github/workflows/ansible-test.yml

@@ -1,231 +0,0 @@
----
-# 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
-
-# For the comprehensive list of the inputs supported by the ansible-community/ansible-test-gh-action GitHub Action, see
-# https://github.com/marketplace/actions/ansible-test
-
-name: EOL CI
-on:
-  # Run EOL CI against all pushes (direct commits, also merged PRs), Pull Requests
-  push:
-    branches:
-      - main
-      - stable-*
-  pull_request:
-  # Run EOL CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-
-concurrency:
-  # Make sure there is at most one active run per PR, but do not cancel any non-PR runs
-  group: ${{ github.workflow }}-${{ (github.head_ref && github.event.number) || github.run_id }}
-  cancel-in-progress: true
-
-jobs:
-  sanity:
-    name: EOL Sanity (Ⓐ${{ matrix.ansible }})
-    strategy:
-      matrix:
-        ansible:
-          - '2.13'
-          - '2.14'
-          - '2.15'
-    # Ansible-test on various stable branches does not yet work well with cgroups v2.
-    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
-    # image for these stable branches. The list of branches where this is necessary will
-    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
-    # for the latest list.
-    runs-on: ubuntu-latest
-    steps:
-      - name: Perform sanity testing
-        uses: felixfontein/ansible-test-gh-action@main
-        with:
-          ansible-core-version: stable-${{ matrix.ansible }}
-          codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
-          pull-request-change-detection: 'true'
-          testing-type: sanity
-          pre-test-cmd: >-
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
-
-  units:
-    # Ansible-test on various stable branches does not yet work well with cgroups v2.
-    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
-    # image for these stable branches. The list of branches where this is necessary will
-    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
-    # for the latest list.
-    runs-on: ubuntu-latest
-    name: EOL Units (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }})
-    strategy:
-      # As soon as the first unit test fails, cancel the others to free up the CI queue
-      fail-fast: true
-      matrix:
-        ansible:
-          - ''
-        python:
-          - ''
-        exclude:
-          - ansible: ''
-        include:
-          - ansible: '2.13'
-            python: '2.7'
-          - ansible: '2.13'
-            python: '3.8'
-          - ansible: '2.13'
-            python: '2.7'
-          - ansible: '2.13'
-            python: '3.8'
-          - ansible: '2.14'
-            python: '3.9'
-          - ansible: '2.15'
-            python: '3.5'
-          - ansible: '2.15'
-            python: '3.10'
-
-    steps:
-      - name: >-
-          Perform unit testing against
-          Ansible version ${{ matrix.ansible }}
-        uses: felixfontein/ansible-test-gh-action@main
-        with:
-          ansible-core-version: stable-${{ matrix.ansible }}
-          codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
-          pre-test-cmd: >-
-            mkdir -p ../../ansible
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
-          pull-request-change-detection: 'true'
-          target-python-version: ${{ matrix.python }}
-          testing-type: units
-
-  integration:
-    # Ansible-test on various stable branches does not yet work well with cgroups v2.
-    # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
-    # image for these stable branches. The list of branches where this is necessary will
-    # shrink over time, check out https://github.com/ansible-collections/news-for-maintainers/issues/28
-    # for the latest list.
-    runs-on: ubuntu-latest
-    name: EOL I (Ⓐ${{ matrix.ansible }}+${{ matrix.docker }}+py${{ matrix.python }}:${{ matrix.target }})
-    strategy:
-      fail-fast: false
-      matrix:
-        ansible:
-          - ''
-        docker:
-          - ''
-        python:
-          - ''
-        target:
-          - ''
-        exclude:
-          - ansible: ''
-        include:
-          # 2.13
-          - ansible: '2.13'
-            docker: fedora35
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.13'
-            docker: fedora35
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.13'
-            docker: fedora35
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.13'
-            docker: opensuse15py2
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.13'
-            docker: opensuse15py2
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.13'
-            docker: opensuse15py2
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.13'
-            docker: alpine3
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.13'
-            docker: alpine3
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.13'
-            docker: alpine3
-            python: ''
-            target: azp/posix/3/
-          # 2.14
-          - ansible: '2.14'
-            docker: alpine3
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.14'
-            docker: alpine3
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.14'
-            docker: alpine3
-            python: ''
-            target: azp/posix/3/
-          # 2.15
-          - ansible: '2.15'
-            docker: fedora37
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.15'
-            docker: fedora37
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.15'
-            docker: fedora37
-            python: ''
-            target: azp/posix/3/
-          # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-          # - ansible: '2.13'
-          #   docker: default
-          #   python: '3.9'
-          #   target: azp/generic/1/
-          # - ansible: '2.14'
-          #   docker: default
-          #   python: '3.10'
-          #   target: azp/generic/1/
-          # - ansible: '2.15'
-          #   docker: default
-          #   python: '3.9'
-          #   target: azp/generic/1/
-
-    steps:
-      - name: >-
-          Perform integration testing against
-          Ansible version ${{ matrix.ansible }}
-          under Python ${{ matrix.python }}
-        uses: felixfontein/ansible-test-gh-action@main
-        with:
-          ansible-core-version: stable-${{ matrix.ansible }}
-          codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
-          docker-image: ${{ matrix.docker }}
-          integration-continue-on-error: 'false'
-          integration-diff: 'false'
-          integration-retry-on-error: 'true'
-          # TODO: remove "--branch stable-2" from community.crypto install once we're only using ansible-core 2.17 or newer!
-          pre-test-cmd: >-
-            mkdir -p ../../ansible
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/ansible.posix.git ../../ansible/posix
-            ;
-            git clone --depth=1 --single-branch --branch stable-2 https://github.com/ansible-collections/community.crypto.git ../../community/crypto
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.docker.git ../../community/docker
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
-          pull-request-change-detection: 'true'
-          target: ${{ matrix.target }}
-          target-python-version: ${{ matrix.python }}
-          testing-type: integration

.github/workflows/codeql-analysis.yml

@@ -1,38 +0,0 @@
----
-# 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
-
-name: "Code scanning - action"
-
-on:
-  schedule:
-    - cron: '26 19 * * 1'
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  CodeQL-Build:
-
-    permissions:
-      actions: read  # for github/codeql-action/init to get workflow details
-      contents: read  # for actions/checkout to fetch code
-      security-events: write  # for github/codeql-action/autobuild to send a status report
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        persist-credentials: false
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: python
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3

.github/workflows/nox.yml

@@ -1,28 +0,0 @@
----
-# 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
-
-name: nox
-'on':
-  push:
-    branches:
-      - main
-      - stable-*
-  pull_request:
-  # Run CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-  workflow_dispatch:
-
-jobs:
-  nox:
-    runs-on: ubuntu-latest
-    name: "Run extra sanity tests"
-    steps:
-      - name: Check out collection
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-      - name: Run nox
-        uses: ansible-community/antsibull-nox@main

.gitignore

@@ -383,16 +383,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-### Python Patch ###
-# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
-poetry.toml
-
-# ruff
-.ruff_cache/
-
-# LSP config files
-pyrightconfig.json
-
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
@@ -492,10 +482,6 @@ tags
 # https://plugins.jetbrains.com/plugin/12206-codestream
 .idea/codestream.xml
 
-# Azure Toolkit for IntelliJ plugin
-# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
-.idea/**/azureSettings.xml
-
 ### Windows ###
 # Windows thumbnail cache files
 Thumbs.db
@@ -526,7 +512,3 @@ $RECYCLE.BIN/
 
 # Integration tests cloud configs
 tests/integration/cloud-config-*.ini
-
-
-# VSCode specific extensions
-.vscode/settings.json

CONTRIBUTING.md

@@ -44,49 +44,7 @@ If you want to test a PR locally, refer to [our testing guide](https://github.co
 
 If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.
 
-## Run sanity or unit locally (with antsibull-nox)
-
-The easiest way to run sanity and unit tests locally is to use [antsibull-nox](https://ansible.readthedocs.io/projects/antsibull-nox/).
-(If you have [nox](https://nox.thea.codes/en/stable/) installed, it will automatically install antsibull-nox in a virtual environment for you.)
-
-### Sanity tests
-
-The following commands show how to run ansible-test sanity tests:
-
-```.bash
-# Run basic sanity tests for all files in the collection:
-nox -Re ansible-test-sanity-devel
-
-# Run basic sanity tests for the given files and directories:
-nox -Re ansible-test-sanity-devel -- plugins/modules/system/pids.py tests/integration/targets/pids/
-
-# Run all other sanity tests for all files in the collection:
-nox -R
-```
-
-If you replace `-Re` with `-e`, respectively. If you leave `-R` away, then the virtual environments will be re-created. The `-R` re-uses them (if they already exist).
-
-### Unit tests
-
-The following commands show how to run unit tests:
-
-```.bash
-# Run all unit tests:
-nox -Re ansible-test-units-devel
-
-# Run all unit tests for one Python version (a lot faster):
-nox -Re ansible-test-units-devel -- --python 3.13
-
-# Run a specific unit test (for the nmcli module) for one Python version:
-nox -Re ansible-test-units-devel -- --python 3.13 tests/unit/plugins/modules/net_tools/test_nmcli.py
-```
-
-If you replace `-Re` with `-e`, then the virtual environments will be re-created. The `-R` re-uses them (if they already exist).
-
-## Run basic sanity, unit or integration tests locally (with ansible-test)
-
-Instead of using antsibull-nox, you can also run sanity and unit tests with ansible-test directly.
-This also allows you to run integration tests.
+## Run sanity, unit or integration tests locally
 
 You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
 
@@ -98,27 +56,20 @@ cd ~/dev/ansible_collections/community/general
 
 Then you can run `ansible-test` (which is a part of [ansible-core](https://pypi.org/project/ansible-core/)) inside the checkout. The following example commands expect that you have installed Docker or Podman. Note that Podman has only been supported by more recent ansible-core releases. If you are using Docker, the following will work with Ansible 2.9+.
 
-### Basic sanity tests
+### Sanity tests
 
-The following commands show how to run basic sanity tests:
+The following commands show how to run sanity tests:
 
 ```.bash
-# Run basic sanity tests for all files in the collection:
+# Run sanity tests for all files in the collection:
 ansible-test sanity --docker -v
 
-# Run basic sanity tests for the given files and directories:
+# Run sanity tests for the given files and directories:
 ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/
 ```
 
 ### Unit tests
 
-Note that for running unit tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
-Right now, you need to install [`community.internal_test_tools`](https://github.com/ansible-collections/community.internal_test_tools).
-If you want to use the latest version from GitHub, you can run:
-```
-git clone https://github.com/ansible-collections/community.internal_test_tools.git ~/dev/ansible_collections/community/internal_test_tools
-```
-
 The following commands show how to run unit tests:
 
 ```.bash
@@ -134,16 +85,6 @@ ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools
 
 ### Integration tests
 
-Note that for running integration tests, you need to install required collections in the same folder structure that `community.general` is checked out in.
-Right now, depending on the test, you need to install [`ansible.posix`](https://github.com/ansible-collections/ansible.posix), [`community.crypto`](https://github.com/ansible-collections/community.crypto), and [`community.docker`](https://github.com/ansible-collections/community.docker):
-If you want to use the latest versions from GitHub, you can run:
-```
-mkdir -p ~/dev/ansible_collections/ansible
-git clone https://github.com/ansible-collections/ansible.posix.git ~/dev/ansible_collections/ansible/posix
-git clone https://github.com/ansible-collections/community.crypto.git ~/dev/ansible_collections/community/crypto
-git clone https://github.com/ansible-collections/community.docker.git ~/dev/ansible_collections/community/docker
-```
-
 The following commands show how to run integration tests:
 
 #### In Docker
@@ -151,8 +92,8 @@ The following commands show how to run integration tests:
 Integration tests on Docker have the following parameters:
 - `image_name` (required): The name of the Docker image. To get the list of supported Docker images, run
   `ansible-test integration --help` and look for _target docker images_.
-- `test_name` (optional): The name of the integration test.
-  For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.
+- `test_name` (optional): The name of the integration test.  
+  For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.  
   For plugins, the plugin type is added before the plugin's short name, for example `callback_yaml` for the `community.general.yaml` callback.
 ```.bash
 # Test all plugins/modules on fedora40

README.md

@@ -6,10 +6,9 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 # Community General Collection
 
-[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/ansible/latest/collections/community/general/)
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-9)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
-[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-9)](https://github.com/ansible-collections/community.general/actions)
-[![Nox CI](https://github.com/ansible-collections/community.general/actions/workflows/nox.yml/badge.svg?branch=stable-9)](https://github.com/ansible-collections/community.general/actions)
+[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/ansible/devel/collections/community/general/)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-8)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![EOL CI](https://github.com/ansible-collections/community.general/actions/workflows/ansible-test.yml/badge.svg?branch=stable-8)](https://github.com/ansible-collections/community.general/actions)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-collections/community.general)](https://api.reuse.software/info/github.com/ansible-collections/community.general)
 
@@ -39,7 +38,7 @@ For more information about communication, see the [Ansible communication guide](
 
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.13, ansible-core 2.14, ansible-core 2.15, ansible-core 2.16, ansible-core 2.17, ansible-core 2.18, and ansible-core 2.19 releases. Ansible-core versions before 2.13.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
+Tested with the current ansible-core 2.13, ansible-core 2.14, ansible-core 2.15, ansible-core 2.16, ansible-core 2.17, and ansible-core 2.18 releases of ansible-core. Ansible-core versions before 2.13.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
 
 ## External requirements
 
@@ -118,7 +117,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-9/CHANGELOG.md).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-8/CHANGELOG.md).
 
 ## Roadmap
 
@@ -137,8 +136,8 @@ See [this issue](https://github.com/ansible-collections/community.general/issues
 
 This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
 
-See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-9/COPYING) for the full text.
+See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/main/COPYING) for the full text.
 
-Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-9/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-9/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/stable-9/LICENSES/PSF-2.0.txt).
+Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/PSF-2.0.txt).
 
 All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `REUSE.toml`. This conforms to the [REUSE specification](https://reuse.software/spec/).

antsibull-nox.toml

@@ -1,63 +0,0 @@
-# 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
-# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
-
-[collection_sources]
-"ansible.posix" = "git+https://github.com/ansible-collections/ansible.posix.git,main"
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,main"
-"community.docker" = "git+https://github.com/ansible-collections/community.docker.git,main"
-"community.internal_test_tools" = "git+https://github.com/ansible-collections/community.internal_test_tools.git,main"
-
-[collection_sources_per_ansible.'2.13']
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,stable-2"
-
-[collection_sources_per_ansible.'2.14']
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,stable-2"
-
-[collection_sources_per_ansible.'2.15']
-# community.crypto's main branch needs ansible-core >= 2.17
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,stable-2"
-
-[collection_sources_per_ansible.'2.16']
-# community.crypto's main branch needs ansible-core >= 2.17
-"community.crypto" = "git+https://github.com/ansible-collections/community.crypto.git,stable-2"
-
-[sessions]
-
-[sessions.docs_check]
-validate_collection_refs="all"
-
-[sessions.license_check]
-
-[sessions.extra_checks]
-run_no_unwanted_files = true
-no_unwanted_files_module_extensions = [".py"]
-no_unwanted_files_yaml_extensions = [".yml"]
-run_action_groups = true
-
-[[sessions.extra_checks.action_groups_config]]
-name = "consul"
-pattern = "^consul_.*$"
-exclusions = [
-    "consul_acl",
-    "consul_acl_bootstrap",
-    "consul_kv",
-]
-doc_fragment = "community.general.consul.actiongroup_consul"
-
-[[sessions.extra_checks.action_groups_config]]
-name = "proxmox"
-pattern = "^proxmox(_.*)?$"
-exclusions = []
-doc_fragment = "community.general.proxmox.actiongroup_proxmox"
-
-[sessions.build_import_check]
-run_galaxy_importer = true
-
-[sessions.ansible_test_sanity]
-include_devel = false
-max_version = "2.19"
-
-[sessions.ansible_test_units]
-include_devel = false
-max_version = "2.19"

docs/docsite/extra-docs.yml

@@ -14,9 +14,3 @@ sections:
       - guide_online
       - guide_packet
       - guide_scaleway
-  - title: Developer Guides
-    toctree:
-      - guide_deps
-      - guide_vardict
-      - guide_cmdrunner
-      - guide_modulehelper

docs/docsite/helper/keep_keys/README.md

@@ -1,61 +0,0 @@
-<!--
-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
--->
-
-# Docs helper. Create RST file.
-
-The playbook `playbook.yml` writes a RST file that can be used in
-docs/docsite/rst. The usage of this helper is recommended but not
-mandatory. You can stop reading here and update the RST file manually
-if you don't want to use this helper.
-
-## Run the playbook
-
-If you want to generate the RST file by this helper fit the variables
-in the playbook and the template to your needs. Then, run the play
-
-```sh
-shell> ansible-playbook playbook.yml
-```
-
-## Copy RST to docs/docsite/rst
-
-Copy the RST file to `docs/docsite/rst` and remove it from this
-directory.
-
-## Update the checksums
-
-Substitute the variables and run the below commands
-
-```sh
-shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-```
-
-## Playbook explained
-
-The playbook includes the variable *tests* from the integration tests
-and creates the RST file from the template. The playbook will
-terminate if:
-
-* The file with the variable *tests* was changed
-* The RST file was changed
-
-This means that this helper is probably not up to date.
-
-### The file with the variable *tests* was changed
-
-This means that somebody updated the integration tests. Review the
-changes and update the template if needed. Update the checksum to pass
-the integrity test. The playbook message provides you with the
-command.
-
-### The RST file was changed
-
-This means that somebody updated the RST file manually. Review the
-changes and update the template. Update the checksum to pass the
-integrity test. The playbook message provides you with the
-command. Make sure that the updated template will create identical RST
-file. Only then apply your changes.

docs/docsite/helper/keep_keys/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst.j2

@@ -1,80 +0,0 @@
-..
-  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
-
-keep_keys
-"""""""""
-
-Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a list of dictionaries and want to keep certain keys only.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[0:1]|subelements('group') %}
-* {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[1:2]|subelements('group') %}
-{{ loop.index }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: {{ i.1.mp }}
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-* The results of the below examples 6-9 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[2:3]|subelements('group') %}
-{{ loop.index + 5 }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: {{ i.1.mp }}
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}

docs/docsite/helper/keep_keys/keep_keys.rst.sha1

@@ -1 +0,0 @@
-8690afce792abc95693c2f61f743ee27388b1592  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

docs/docsite/helper/keep_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# 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
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/keep_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: keep_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

docs/docsite/helper/keep_keys/tests.yml.sha1

@@ -1 +0,0 @@
-c6fc4ee2017d9222675bcd13cc4f88ba8d14f38d  ../../../../tests/integration/targets/filter_keep_keys/vars/main/tests.yml

docs/docsite/helper/remove_keys/README.md

@@ -1,61 +0,0 @@
-<!--
-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
--->
-
-# Docs helper. Create RST file.
-
-The playbook `playbook.yml` writes a RST file that can be used in
-docs/docsite/rst. The usage of this helper is recommended but not
-mandatory. You can stop reading here and update the RST file manually
-if you don't want to use this helper.
-
-## Run the playbook
-
-If you want to generate the RST file by this helper fit the variables
-in the playbook and the template to your needs. Then, run the play
-
-```sh
-shell> ansible-playbook playbook.yml
-```
-
-## Copy RST to docs/docsite/rst
-
-Copy the RST file to `docs/docsite/rst` and remove it from this
-directory.
-
-## Update the checksums
-
-Substitute the variables and run the below commands
-
-```sh
-shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-```
-
-## Playbook explained
-
-The playbook includes the variable *tests* from the integration tests
-and creates the RST file from the template. The playbook will
-terminate if:
-
-* The file with the variable *tests* was changed
-* The RST file was changed
-
-This means that this helper is probably not up to date.
-
-### The file with the variable *tests* was changed
-
-This means that somebody updated the integration tests. Review the
-changes and update the template if needed. Update the checksum to pass
-the integrity test. The playbook message provides you with the
-command.
-
-### The RST file was changed
-
-This means that somebody updated the RST file manually. Review the
-changes and update the template. Update the checksum to pass the
-integrity test. The playbook message provides you with the
-command. Make sure that the updated template will create identical RST
-file. Only then apply your changes.

docs/docsite/helper/remove_keys/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst.j2

@@ -1,80 +0,0 @@
-..
-  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
-
-remove_keys
-"""""""""""
-
-Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a list of dictionaries and want to remove certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[0:1]|subelements('group') %}
-* {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[1:2]|subelements('group') %}
-{{ loop.index }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: {{ i.1.mp }}
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-* The results of the below examples 6-9 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[2:3]|subelements('group') %}
-{{ loop.index + 5 }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: {{ i.1.mp }}
-   target: {{ i.1.tt }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}

docs/docsite/helper/remove_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# 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
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/remove_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: remove_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

docs/docsite/helper/remove_keys/remove_keys.rst.sha1

@@ -1 +0,0 @@
-3cc606b42e3d450cf6323f25930f7c5a591fa086  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst

docs/docsite/helper/remove_keys/tests.yml.sha1

@@ -1 +0,0 @@
-0554335045f02d8c37b824355b0cf86864cee9a5  ../../../../tests/integration/targets/filter_remove_keys/vars/main/tests.yml

docs/docsite/helper/replace_keys/README.md

@@ -1,61 +0,0 @@
-<!--
-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
--->
-
-# Docs helper. Create RST file.
-
-The playbook `playbook.yml` writes a RST file that can be used in
-docs/docsite/rst. The usage of this helper is recommended but not
-mandatory. You can stop reading here and update the RST file manually
-if you don't want to use this helper.
-
-## Run the playbook
-
-If you want to generate the RST file by this helper fit the variables
-in the playbook and the template to your needs. Then, run the play
-
-```sh
-shell> ansible-playbook playbook.yml
-```
-
-## Copy RST to docs/docsite/rst
-
-Copy the RST file to `docs/docsite/rst` and remove it from this
-directory.
-
-## Update the checksums
-
-Substitute the variables and run the below commands
-
-```sh
-shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-```
-
-## Playbook explained
-
-The playbook includes the variable *tests* from the integration tests
-and creates the RST file from the template. The playbook will
-terminate if:
-
-* The file with the variable *tests* was changed
-* The RST file was changed
-
-This means that this helper is probably not up to date.
-
-### The file with the variable *tests* was changed
-
-This means that somebody updated the integration tests. Review the
-changes and update the template if needed. Update the checksum to pass
-the integrity test. The playbook message provides you with the
-command.
-
-### The RST file was changed
-
-This means that somebody updated the RST file manually. Review the
-changes and update the template. Update the checksum to pass the
-integrity test. The playbook message provides you with the
-command. Make sure that the updated template will create identical RST
-file. Only then apply your changes.

docs/docsite/helper/replace_keys/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst.j2

@@ -1,110 +0,0 @@
-..
-  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
-
-replace_keys
-""""""""""""
-
-Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a list of dictionaries and want to replace certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     {{ tests.0.input | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[0:1]|subelements('group') %}
-* {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   target:
-     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.0.result | to_yaml(indent=2) | indent(5) }}
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-3 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.1.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[1:2]|subelements('group') %}
-{{ loop.index }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: {{ i.1.mp }}
-   target:
-     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-* The results of the below examples 4-5 are the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ tests.2.result | to_yaml(indent=2) | indent(5) }}
-
-{% for i in tests[2:3]|subelements('group') %}
-{{ loop.index + 3 }}. {{ i.1.d }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   mp: {{ i.1.mp }}
-   target:
-     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-{% endfor %}
-
-{% for i in tests[3:4]|subelements('group') %}
-{{ loop.index + 5 }}. {{ i.1.d }}
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   input:
-     {{ i.0.input | to_yaml(indent=2) | indent(5) }}
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: {{ i.1.mp }}
-   target:
-     {{ i.1.tt | to_yaml(indent=2) | indent(5) }}
-   result: "{{ lookup('file', target ~ '/templates/' ~ i.0.template) }}"
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     {{ i.0.result | to_yaml(indent=2) | indent(5) }}
-
-{% endfor %}

docs/docsite/helper/replace_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# 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
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/replace_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: replace_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

docs/docsite/helper/replace_keys/replace_keys.rst.sha1

@@ -1 +0,0 @@
-403f23c02ac02b1c3b611cb14f9b3ba59dc3f587  ../../rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst

docs/docsite/helper/replace_keys/replace_keys.rst.sha1.license

@@ -1,3 +0,0 @@
-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

docs/docsite/helper/replace_keys/tests.yml.sha1

@@ -1 +0,0 @@
-2e54f3528c95cca746d5748f1ed7ada56ad0890e  ../../../../tests/integration/targets/filter_replace_keys/vars/main/tests.yml

docs/docsite/helper/replace_keys/tests.yml.sha1.license

@@ -1,3 +0,0 @@
-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

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

@@ -1,151 +0,0 @@
-..
-  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
-
-keep_keys
-"""""""""
-
-Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a list of dictionaries and want to keep certain keys only.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.keep_keys(target=target) }}"
-
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - {k0_x0: A0, k1_x1: B0}
-     - {k0_x0: A1, k1_x1: B1}
-
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - {k0_x0: A0, k1_x1: B0}
-     - {k0_x0: A1, k1_x1: B1}
-
-
-1. Match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-2. Match keys that start with any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: ['k0', 'k1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-3. Match keys that end with any of the items in target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: ['x0', 'x1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-4. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ['^.*[01]_x.*$']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-5. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*[01]_x.*$
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 6-9 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - {k0_x0: A0}
-     - {k0_x0: A1}
-
-
-6. Match keys that equal the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: k0_x0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-7. Match keys that start with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: k0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-8. Match keys that end with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: x0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-9. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*0_x.*$
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst

@@ -1,159 +0,0 @@
-..
-  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
-
-remove_keys
-"""""""""""
-
-Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a list of dictionaries and want to remove certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.remove_keys(target=target) }}"
-
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k2_x2: [C0]
-       k3_x3: foo
-     - k2_x2: [C1]
-       k3_x3: bar
-
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k2_x2: [C0]
-       k3_x3: foo
-     - k2_x2: [C1]
-       k3_x3: bar
-
-
-1. Match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-2. Match keys that start with any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: ['k0', 'k1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-3. Match keys that end with any of the items in target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: ['x0', 'x1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-4. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ['^.*[01]_x.*$']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-5. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*[01]_x.*$
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 6-9 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-6. Match keys that equal the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: k0_x0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-7. Match keys that start with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: k0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-8. Match keys that end with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: x0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-9. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*0_x.*$
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst

@@ -1,175 +0,0 @@
-..
-  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
-
-replace_keys
-""""""""""""
-
-Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a list of dictionaries and want to replace certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   target:
-     - {after: a0, before: k0_x0}
-     - {after: a1, before: k1_x1}
-
-   result: "{{ input | community.general.replace_keys(target=target) }}"
-
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - a0: A0
-       a1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - a0: A1
-       a1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
- 
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-3 are all the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - a0: A0
-       a1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - a0: A1
-       a1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-1. Replace keys that starts with any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: starts_with
-   target:
-     - {after: a0, before: k0}
-     - {after: a1, before: k1}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-2. Replace keys that ends with any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: ends_with
-   target:
-     - {after: a0, before: x0}
-     - {after: a1, before: x1}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-3. Replace keys that match any regex of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: regex
-   target:
-     - {after: a0, before: ^.*0_x.*$}
-     - {after: a1, before: ^.*1_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 4-5 are the same:
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - {X: foo}
-     - {X: bar}
-
-
-4. If more keys match the same attribute before the last one will be used.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   mp: regex
-   target:
-     - {after: X, before: ^.*_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-5. If there are items with equal attribute before the first one will be used.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   mp: regex
-   target:
-     - {after: X, before: ^.*_x.*$}
-     - {after: Y, before: ^.*_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-
-6. If there are more matches for a key the first one will be used.
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   input:
-     - {aaa1: A, bbb1: B, ccc1: C}
-     - {aaa2: D, bbb2: E, ccc2: F}
-
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: starts_with
-   target:
-     - {after: X, before: a}
-     - {after: Y, before: aa}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-gives
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - {X: A, bbb1: B, ccc1: C}
-     - {X: D, bbb2: E, ccc2: F}
-
-

docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries.rst

@@ -1,18 +0,0 @@
-..
-  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
-
-.. _ansible_collections.community.general.docsite.filter_guide.filter_guide_abstract_informations.lists_of_dicts:
-  
-Lists of dictionaries
-^^^^^^^^^^^^^^^^^^^^^
-
-Filters to manage keys in a list of dictionaries:
-
-.. toctree::
-   :maxdepth: 1
-
-   filter_guide-abstract_informations-lists_of_dictionaries-keep_keys
-   filter_guide-abstract_informations-lists_of_dictionaries-remove_keys
-   filter_guide-abstract_informations-lists_of_dictionaries-replace_keys

docs/docsite/rst/filter_guide_abstract_informations.rst

@@ -11,7 +11,6 @@ Abstract transformations
 
    filter_guide_abstract_informations_dictionaries
    filter_guide_abstract_informations_grouping
-   filter_guide-abstract_informations-lists_of_dictionaries
    filter_guide_abstract_informations_merging_lists_of_dictionaries
    filter_guide_abstract_informations_lists_helper
    filter_guide_abstract_informations_counting_elements_in_sequence

docs/docsite/rst/guide_cmdrunner.rst

@@ -1,499 +0,0 @@
-..
-  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
-
-.. _ansible_collections.community.general.docsite.guide_cmdrunner:
-
-
-Command Runner guide
-====================
-
-
-Introduction
-^^^^^^^^^^^^
-
-The ``ansible_collections.community.general.plugins.module_utils.cmd_runner`` module util provides the
-``CmdRunner`` class to help execute external commands. The class is a wrapper around
-the standard ``AnsibleModule.run_command()`` method, handling command arguments, localization setting,
-output processing output, check mode, and other features.
-
-It is even more useful when one command is used in multiple modules, so that you can define all options
-in a module util file, and each module uses the same runner with different arguments.
-
-For the sake of clarity, throughout this guide, unless otherwise specified, we use the term *option* when referring to
-Ansible module options, and the term *argument* when referring to the command line arguments for the external command.
-
-
-Quickstart
-""""""""""
-
-``CmdRunner`` defines a command and a set of coded instructions on how to format
-the command-line arguments, in which specific order, for a particular execution.
-It relies on ``ansible.module_utils.basic.AnsibleModule.run_command()`` to actually execute the command.
-There are other features, see more details throughout this document.
-
-To use ``CmdRunner`` you must start by creating an object. The example below is a simplified
-version of the actual code in :ansplugin:`community.general.ansible_galaxy_install#module`:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
-
-    runner = CmdRunner(
-        module,
-        command="ansible-galaxy",
-        arg_formats=dict(
-            type=cmd_runner_fmt.as_func(lambda v: [] if v == 'both' else [v]),
-            galaxy_cmd=cmd_runner_fmt.as_list(),
-            upgrade=cmd_runner_fmt.as_bool("--upgrade"),
-            requirements_file=cmd_runner_fmt.as_opt_val('-r'),
-            dest=cmd_runner_fmt.as_opt_val('-p'),
-            force=cmd_runner_fmt.as_bool("--force"),
-            no_deps=cmd_runner_fmt.as_bool("--no-deps"),
-            version=cmd_runner_fmt.as_fixed("--version"),
-            name=cmd_runner_fmt.as_list(),
-        )
-    )
-
-This is meant to be done once, then every time you need to execute the command you create a context and pass values as needed:
-
-.. code-block:: python
-
-        # Run the command with these arguments, when values exist for them
-        with runner("type galaxy_cmd upgrade force no_deps dest requirements_file name", output_process=process) as ctx:
-            ctx.run(galaxy_cmd="install", upgrade=upgrade)
-
-        # version is fixed, requires no value
-        with runner("version") as ctx:
-            dummy, stdout, dummy = ctx.run()
-
-        # passes arg 'data' to AnsibleModule.run_command()
-        with runner("type name", data=stdin_data) as ctx:
-            dummy, stdout, dummy = ctx.run()
-
-        # Another way of expressing it
-        dummy, stdout, dummy = runner("version").run()
-
-Note that you can pass values for the arguments when calling ``run()``, otherwise ``CmdRunner``
-uses the module options with the exact same names to provide values for the runner arguments.
-If no value is passed and no module option is found for the name specified, then an exception is raised, unless
-the argument is using ``cmd_runner_fmt.as_fixed`` as format function like the ``version`` in the example above.
-See more about it below.
-
-In the first example, values of ``type``, ``force``, ``no_deps`` and others
-are taken straight from the module, whilst ``galaxy_cmd`` and ``upgrade`` are
-passed explicitly.
-
-.. note::
-
-    It is not possible to automatically retrieve values of suboptions.
-
-That generates a resulting command line similar to (example taken from the
-output of an integration test):
-
-.. code-block:: python
-
-        [
-            "<venv>/bin/ansible-galaxy",
-            "collection",
-            "install",
-            "--upgrade",
-            "-p",
-            "<collection-install-path>",
-            "netbox.netbox",
-        ]
-
-
-Argument formats
-^^^^^^^^^^^^^^^^
-
-As seen in the example, ``CmdRunner`` expects a parameter named ``arg_formats``
-defining how to format each CLI named argument.
-An "argument format" is nothing but a function to transform the value of a variable
-into something formatted for the command line.
-
-
-Argument format function
-""""""""""""""""""""""""
-
-An ``arg_format`` function is defined in the form similar to:
-
-.. code-block:: python
-
-    def func(value):
-        return ["--some-param-name", value]
-
-The parameter ``value`` can be of any type - although there are convenience
-mechanisms to help handling sequence and mapping objects.
-
-The result is expected to be of the type ``Sequence[str]`` type (most commonly
-``list[str]`` or ``tuple[str]``), otherwise it is considered to be a ``str``,
-and it is coerced into ``list[str]``.
-This resulting sequence of strings is added to the command line when that
-argument is actually used.
-
-For example, if ``func`` returns:
-
-- ``["nee", 2, "shruberries"]``, the command line adds arguments ``"nee" "2" "shruberries"``.
-- ``2 == 2``, the command line adds argument ``True``.
-- ``None``, the command line adds argument ``None``.
-- ``[]``, the command line adds no command line argument for that particular argument.
-
-
-Convenience format methods
-""""""""""""""""""""""""""
-
-In the same module as ``CmdRunner`` there is a class ``cmd_runner_fmt`` which
-provides a set of convenience methods that return format functions for common cases.
-In the first block of code in the `Quickstart`_ section you can see the importing of
-that class:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
-
-The same example shows how to make use of some of them in the instantiation of the ``CmdRunner`` object.
-A description of each one of the convenience methods available and examples of how to use them is found below.
-In these descriptions ``value`` refers to the single parameter passed to the formatting function.
-
-- ``cmd_runner_fmt.as_list()``
-    This method does not receive any parameter, function returns ``value`` as-is.
-
-    - Creation:
-        ``cmd_runner_fmt.as_list()``
-    - Examples:
-        +----------------------+---------------------+
-        | Value                | Outcome             |
-        +======================+=====================+
-        | ``["foo", "bar"]``   | ``["foo", "bar"]``  |
-        +----------------------+---------------------+
-        | ``"foobar"``         | ``["foobar"]``      |
-        +----------------------+---------------------+
-
-- ``cmd_runner_fmt.as_bool()``
-    This method receives two different parameters: ``args_true`` and ``args_false``, latter being optional.
-    If the boolean evaluation of ``value`` is ``True``, the format function returns ``args_true``.
-    If the boolean evaluation is ``False``, then the function returns ``args_false`` if it was provided, or ``[]`` otherwise.
-
-    - Creation (one arg):
-        ``cmd_runner_fmt.as_bool("--force")``
-    - Examples:
-        +------------+--------------------+
-        | Value      | Outcome            |
-        +============+====================+
-        | ``True``   | ``["--force"]``    |
-        +------------+--------------------+
-        | ``False``  | ``[]``             |
-        +------------+--------------------+
-    - Creation (two args, ``None`` treated as ``False``):
-        ``cmd_runner_fmt.as_bool("--relax", "--dont-do-it")``
-    - Examples:
-        +------------+----------------------+
-        | Value      | Outcome              |
-        +============+======================+
-        | ``True``   | ``["--relax"]``      |
-        +------------+----------------------+
-        | ``False``  | ``["--dont-do-it"]`` |
-        +------------+----------------------+
-        |            | ``["--dont-do-it"]`` |
-        +------------+----------------------+
-    - Creation (two args, ``None`` is ignored):
-        ``cmd_runner_fmt.as_bool("--relax", "--dont-do-it", ignore_none=True)``
-    - Examples:
-        +------------+----------------------+
-        | Value      | Outcome              |
-        +============+======================+
-        | ``True``   | ``["--relax"]``      |
-        +------------+----------------------+
-        | ``False``  | ``["--dont-do-it"]`` |
-        +------------+----------------------+
-        |            | ``[]``               |
-        +------------+----------------------+
-
-- ``cmd_runner_fmt.as_bool_not()``
-    This method receives one parameter, which is returned by the function when the boolean evaluation
-    of ``value`` is ``False``.
-
-    - Creation:
-        ``cmd_runner_fmt.as_bool_not("--no-deps")``
-    - Examples:
-        +-------------+---------------------+
-        | Value       | Outcome             |
-        +=============+=====================+
-        | ``True``    | ``[]``              |
-        +-------------+---------------------+
-        | ``False``   | ``["--no-deps"]``   |
-        +-------------+---------------------+
-
-- ``cmd_runner_fmt.as_optval()``
-    This method receives one parameter ``arg``, the function returns the string concatenation
-    of ``arg`` and ``value``.
-
-    - Creation:
-        ``cmd_runner_fmt.as_optval("-i")``
-    - Examples:
-        +---------------+---------------------+
-        | Value         | Outcome             |
-        +===============+=====================+
-        | ``3``         | ``["-i3"]``         |
-        +---------------+---------------------+
-        | ``foobar``    | ``["-ifoobar"]``    |
-        +---------------+---------------------+
-
-- ``cmd_runner_fmt.as_opt_val()``
-    This method receives one parameter ``arg``, the function returns ``[arg, value]``.
-
-    - Creation:
-        ``cmd_runner_fmt.as_opt_val("--name")``
-    - Examples:
-        +--------------+--------------------------+
-        | Value        | Outcome                  |
-        +==============+==========================+
-        | ``abc``      | ``["--name", "abc"]``    |
-        +--------------+--------------------------+
-
-- ``cmd_runner_fmt.as_opt_eq_val()``
-    This method receives one parameter ``arg``, the function returns the string of the form
-    ``{arg}={value}``.
-
-    - Creation:
-        ``cmd_runner_fmt.as_opt_eq_val("--num-cpus")``
-    - Examples:
-        +------------+-------------------------+
-        | Value      | Outcome                 |
-        +============+=========================+
-        | ``10``     | ``["--num-cpus=10"]``   |
-        +------------+-------------------------+
-
-- ``cmd_runner_fmt.as_fixed()``
-    This method receives one parameter ``arg``, the function expects no ``value`` - if one
-    is provided then it is ignored.
-    The function returns ``arg`` as-is.
-
-    - Creation:
-        ``cmd_runner_fmt.as_fixed("--version")``
-    - Examples:
-        +---------+-----------------------+
-        | Value   | Outcome               |
-        +=========+=======================+
-        |         | ``["--version"]``     |
-        +---------+-----------------------+
-        | 57      | ``["--version"]``     |
-        +---------+-----------------------+
-
-    - Note:
-        This is the only special case in which a value can be missing for the formatting function.
-        The example also comes from the code in `Quickstart`_.
-        In that case, the module has code to determine the command's version so that it can assert compatibility.
-        There is no *value* to be passed for that CLI argument.
-
-- ``cmd_runner_fmt.as_map()``
-    This method receives one parameter ``arg`` which must be a dictionary, and an optional parameter ``default``.
-    The function returns the evaluation of ``arg[value]``.
-    If ``value not in arg``, then it returns ``default`` if defined, otherwise ``[]``.
-
-    - Creation:
-        ``cmd_runner_fmt.as_map(dict(a=1, b=2, c=3), default=42)``
-    - Examples:
-        +---------------------+---------------+
-        | Value               | Outcome       |
-        +=====================+===============+
-        | ``"b"``             | ``["2"]``     |
-        +---------------------+---------------+
-        | ``"yabadabadoo"``   | ``["42"]``    |
-        +---------------------+---------------+
-
-    - Note:
-        If ``default`` is not specified, invalid values return an empty list, meaning they are silently ignored.
-
-- ``cmd_runner_fmt.as_func()``
-    This method receives one parameter ``arg`` which is itself is a format function and it must abide by the rules described above.
-
-    - Creation:
-        ``cmd_runner_fmt.as_func(lambda v: [] if v == 'stable' else ['--channel', '{0}'.format(v)])``
-    - Note:
-        The outcome for that depends entirely on the function provided by the developer.
-
-
-Other features for argument formatting
-""""""""""""""""""""""""""""""""""""""
-
-Some additional features are available as decorators:
-
-- ``cmd_runner_fmt.unpack args()``
-    This decorator unpacks the incoming ``value`` as a list of elements.
-
-    For example, in ``ansible_collections.community.general.plugins.module_utils.puppet``, it is used as:
-
-    .. code-block:: python
-
-          @cmd_runner_fmt.unpack_args
-          def execute_func(execute, manifest):
-              if execute:
-                  return ["--execute", execute]
-              else:
-                  return [manifest]
-
-          runner = CmdRunner(
-              module,
-              command=_prepare_base_cmd(),
-              path_prefix=_PUPPET_PATH_PREFIX,
-              arg_formats=dict(
-                  # ...
-                  _execute=cmd_runner_fmt.as_func(execute_func),
-                  # ...
-              ),
-          )
-
-    Then, in :ansplugin:`community.general.puppet#module` it is put to use with:
-
-    .. code-block:: python
-
-          with runner(args_order) as ctx:
-              rc, stdout, stderr = ctx.run(_execute=[p['execute'], p['manifest']])
-
-- ``cmd_runner_fmt.unpack_kwargs()``
-    Conversely, this decorator unpacks the incoming ``value`` as a ``dict``-like object.
-
-- ``cmd_runner_fmt.stack()``
-    This decorator assumes ``value`` is a sequence and concatenates the output
-    of the wrapped function applied to each element of the sequence.
-
-    For example, in :ansplugin:`community.general.django_check#module`, the argument format for ``database``
-    is defined as:
-
-    .. code-block:: python
-
-          arg_formats = dict(
-              # ...
-              database=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("--database"),
-              # ...
-          )
-
-    When receiving a list ``["abc", "def"]``, the output is:
-
-    .. code-block:: python
-
-          ["--database", "abc", "--database", "def"]
-
-
-Command Runner
-^^^^^^^^^^^^^^
-
-Settings that can be passed to the ``CmdRunner`` constructor are:
-
-- ``module: AnsibleModule``
-    Module instance. Mandatory parameter.
-- ``command: str | list[str]``
-    Command to be executed. It can be a single string, the executable name, or a list
-    of strings containing the executable name as the first element and, optionally, fixed parameters.
-    Those parameters are used in all executions of the runner.
-    The *executable* pointed by this parameter (whether itself when ``str`` or its first element when ``list``) is
-    processed using ``AnsibleModule.get_bin_path()`` *unless* it is an absolute path or contains the character ``/``.
-- ``arg_formats: dict``
-    Mapping of argument names to formatting functions.
-- ``default_args_order: str``
-    As the name suggests, a default ordering for the arguments. When
-    this is passed, the context can be created without specifying ``args_order``. Defaults to ``()``.
-- ``check_rc: bool``
-    When ``True``, if the return code from the command is not zero, the module exits
-    with an error. Defaults to ``False``.
-- ``path_prefix: list[str]``
-    If the command being executed is installed in a non-standard directory path,
-    additional paths might be provided to search for the executable. Defaults to ``None``.
-- ``environ_update: dict``
-    Pass additional environment variables to be set during the command execution.
-    Defaults to ``None``.
-- ``force_lang: str``
-    It is usually important to force the locale to one specific value, so that responses are consistent and, therefore, parseable.
-    Please note that using this option (which is enabled by default) overwrites the environment variables ``LANGUAGE`` and ``LC_ALL``.
-    To disable this mechanism, set this parameter to ``None``.
-    In community.general 9.1.0 a special value ``auto`` was introduced for this parameter, with the effect
-    that ``CmdRunner`` then tries to determine the best parseable locale for the runtime.
-    It should become the default value in the future, but for the time being the default value is ``C``.
-
-When creating a context, the additional settings that can be passed to the call are:
-
-- ``args_order: str``
-    Establishes the order in which the arguments are rendered in the command line.
-    This parameter is mandatory unless ``default_args_order`` was provided to the runner instance.
-- ``output_process: func``
-    Function to transform the output of the executable into different values or formats.
-    See examples in section below.
-- ``check_mode_skip: bool``
-    Whether to skip the actual execution of the command when the module is in check mode.
-    Defaults to ``False``.
-- ``check_mode_return: any``
-    If ``check_mode_skip=True``, then return this value instead.
-- valid named arguments to ``AnsibleModule.run_command()``
-    Other than ``args``, any valid argument to ``run_command()`` can be passed when setting up the run context.
-    For example, ``data`` can be used to send information to the command's standard input.
-    Or ``cwd`` can be used to run the command inside a specific working directory.
-
-Additionally, any other valid parameters for ``AnsibleModule.run_command()`` may be passed, but unexpected behavior
-might occur if redefining options already present in the runner or its context creation. Use with caution.
-
-
-Processing results
-^^^^^^^^^^^^^^^^^^
-
-As mentioned, ``CmdRunner`` uses ``AnsibleModule.run_command()`` to execute the external command,
-and it passes the return value from that method back to caller. That means that,
-by default, the result is going to be a tuple ``(rc, stdout, stderr)``.
-
-If you need to transform or process that output, you can pass a function to the context,
-as the ``output_process`` parameter. It must be a function like:
-
-.. code-block:: python
-
-    def process(rc, stdout, stderr):
-        # do some magic
-        return processed_value    # whatever that is
-
-In that case, the return of ``run()`` is the ``processed_value`` returned by the function.
-
-
-PythonRunner
-^^^^^^^^^^^^
-
-The ``PythonRunner`` class is a specialized version of ``CmdRunner``, geared towards the execution of
-Python scripts. It features two extra and  mutually exclusive parameters ``python`` and ``venv`` in its constructor:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.python_runner import PythonRunner
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt
-
-    runner = PythonRunner(
-        module,
-        command=["-m", "django"],
-        arg_formats=dict(...),
-        python="python",
-        venv="/path/to/some/venv",
-    )
-
-The default value for ``python`` is the string ``python``, and the for ``venv`` it is ``None``.
-
-The command line produced by such a command with ``python="python3.12"`` is something like:
-
-.. code-block:: shell
-
-    /usr/bin/python3.12 -m django <arg1> <arg2> ...
-
-And the command line for ``venv="/work/venv"`` is like:
-
-.. code-block:: shell
-
-    /work/venv/bin/python -m django <arg1> <arg2> ...
-
-You may provide the value of the ``command`` argument as a string (in that case the string is used as a script name)
-or as a list, in which case the elements of the list must be valid arguments for the Python interpreter, as in the example above.
-See `Command line and environment <https://docs.python.org/3/using/cmdline.html>`_ for more details.
-
-If the parameter ``python`` is an absolute path, or contains directory separators, such as ``/``, then it is used
-as-is, otherwise the runtime ``PATH`` is searched for that command name.
-
-Other than that, everything else works as in ``CmdRunner``.
-
-.. versionadded:: 4.8.0

docs/docsite/rst/guide_deps.rst

@@ -1,74 +0,0 @@
-..
-  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
-
-.. _ansible_collections.community.general.docsite.guide_deps:
-
-``deps`` Guide
-==============
-
-
-Using ``deps``
-^^^^^^^^^^^^^^
-
-The ``ansible_collections.community.general.plugins.module_utils.deps`` module util simplifies
-the importing of code as described in :ref:`Importing and using shared code <shared_code>`.
-Please notice that ``deps`` is meant to be used specifically with Ansible modules, and not other types of plugins.
-
-The same example from the Developer Guide would become:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils import deps
-
-    with deps.declare("foo"):
-        import foo
-
-Then in ``main()``, just after the argspec (or anywhere in the code, for that matter), do
-
-.. code-block:: python
-
-    deps.validate(module)  # assuming module is a valid AnsibleModule instance
-
-By default, ``deps`` will rely on ``ansible.module_utils.basic.missing_required_lib`` to generate
-a message about a failing import. That function accepts parameters ``reason`` and ``url``, and
-and so does ``deps```:
-
-.. code-block:: python
-
-    with deps.declare("foo", reason="foo is needed to properly bar", url="https://foo.bar.io"):
-        import foo
-
-If you would rather write a custom message instead of using ``missing_required_lib`` then do:
-
-.. code-block:: python
-
-    with deps.declare("foo", msg="Custom msg explaining why foo is needed"):
-        import foo
-
-``deps`` allows for multiple dependencies to be declared:
-
-.. code-block:: python
-
-    with deps.declare("foo"):
-        import foo
-
-    with deps.declare("bar"):
-        import bar
-
-    with deps.declare("doe"):
-        import doe
-
-By default, ``deps.validate()`` will check on all the declared dependencies, but if so desired,
-they can be validated selectively by doing:
-
-.. code-block:: python
-
-    deps.validate(module, "foo")       # only validates the "foo" dependency
-
-    deps.validate(module, "doe:bar")   # only validates the "doe" and "bar" dependencies
-
-    deps.validate(module, "-doe:bar")  # validates all dependencies except "doe" and "bar"
-
-.. versionadded:: 6.1.0

docs/docsite/rst/guide_modulehelper.rst

@@ -1,540 +0,0 @@
-..
-  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
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper:
-
-Module Helper guide
-===================
-
-
-Introduction
-^^^^^^^^^^^^
-
-Writing a module for Ansible is largely described in existing documentation.
-However, a good part of that is boilerplate code that needs to be repeated every single time.
-That is where ``ModuleHelper`` comes to assistance: a lot of that boilerplate code is done.
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.quickstart:
-
-Quickstart
-""""""""""
-
-See the `example from Ansible documentation <https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#creating-a-module>`_
-written with ``ModuleHelper``.
-But bear in mind that it does not showcase all of MH's features:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
-
-
-    class MyTest(ModuleHelper):
-        module = dict(
-            argument_spec=dict(
-                name=dict(type='str', required=True),
-                new=dict(type='bool', required=False, default=False),
-            ),
-            supports_check_mode=True,
-        )
-        use_old_vardict = False
-
-        def __run__(self):
-            self.vars.original_message = ''
-            self.vars.message = ''
-            if self.check_mode:
-                return
-            self.vars.original_message = self.vars.name
-            self.vars.message = 'goodbye'
-            self.changed = self.vars['new']
-            if self.vars.name == "fail me":
-                self.do_raise("You requested this to fail")
-
-
-    def main():
-        MyTest.execute()
-
-
-    if __name__ == '__main__':
-        main()
-
-
-Module Helper
-^^^^^^^^^^^^^
-
-Introduction
-""""""""""""
-
-``ModuleHelper`` is a wrapper around the standard ``AnsibleModule``, providing extra features and conveniences.
-The basic structure of a module using ``ModuleHelper`` is as shown in the
-:ref:`ansible_collections.community.general.docsite.guide_modulehelper.quickstart`
-section above, but there are more elements that will take part in it.
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
-
-    class MyTest(ModuleHelper):
-        output_params = ()
-        change_params = ()
-        diff_params = ()
-        facts_name = None
-        facts_params = ()
-        use_old_vardict = True
-        mute_vardict_deprecation = False
-        module = dict(
-            argument_spec=dict(...),
-            # ...
-        )
-
-After importing the ``ModuleHelper`` class, you need to declare your own class extending it.
-
-.. seealso::
-
-    There is a variation called ``StateModuleHelper``, which builds on top of the features provided by MH.
-    See :ref:`ansible_collections.community.general.docsite.guide_modulehelper.statemh` below for more details.
-
-The easiest way of specifying the module is to create the class variable ``module`` with a dictionary
-containing the exact arguments that would be passed as parameters to ``AnsibleModule``.
-If you prefer to create the ``AnsibleModule`` object yourself, just assign it to the ``module`` class variable.
-MH also accepts a parameter ``module`` in its constructor, if that parameter is used used,
-then it will override the class variable. The parameter can either be ``dict`` or ``AnsibleModule`` as well.
-
-Beyond the definition of the module, there are other variables that can be used to control aspects
-of MH's behavior. These variables should be set at the very beginning of the class, and their semantics are
-explained through this document.
-
-The main logic of MH happens in the ``ModuleHelper.run()`` method, which looks like:
-
-.. code-block:: python
-
-    @module_fails_on_exception
-    def run(self):
-        self.__init_module__()
-        self.__run__()
-        self.__quit_module__()
-        output = self.output
-        if 'failed' not in output:
-            output['failed'] = False
-        self.module.exit_json(changed=self.has_changed(), **output)
-
-The method ``ModuleHelper.__run__()`` must be implemented by the module and most
-modules will be able to perform their actions implementing only that MH method.
-However, in some cases, you might want to execute actions before or after the main tasks, in which cases
-you should implement ``ModuleHelper.__init_module__()`` and ``ModuleHelper.__quit_module__()`` respectively.
-
-Note that the output comes from ``self.output``, which is a ``@property`` method.
-By default, that property will collect all the variables that are marked for output and return them in a dictionary with their values.
-Moreover, the default ``self.output`` will also handle Ansible ``facts`` and *diff mode*.
-Also note the changed status comes from ``self.has_changed()``, which is usually calculated from variables that are marked
-to track changes in their content.
-
-.. seealso::
-
-    More details in sections
-    :ref:`ansible_collections.community.general.docsite.guide_modulehelper.paramvaroutput` and
-    :ref:`ansible_collections.community.general.docsite.guide_modulehelper.changes` below.
-
-.. seealso::
-
-    See more about the decorator
-    :ref:`ansible_collections.community.general.docsite.guide_modulehelper.modulefailsdeco` below.
-
-
-Another way to write the example from the
-:ref:`ansible_collections.community.general.docsite.guide_modulehelper.quickstart`
-would be:
-
-.. code-block:: python
-
-        def __init_module__(self):
-            self.vars.original_message = ''
-            self.vars.message = ''
-
-        def __run__(self):
-            if self.check_mode:
-                return
-            self.vars.original_message = self.vars.name
-            self.vars.message = 'goodbye'
-            self.changed = self.vars['new']
-
-        def __quit_module__(self):
-            if self.vars.name == "fail me":
-                self.do_raise("You requested this to fail")
-
-Notice that there are no calls to ``module.exit_json()`` nor ``module.fail_json()``: if the module fails, raise an exception.
-You can use the convenience method ``self.do_raise()`` or raise the exception as usual in Python to do that.
-If no exception is raised, then the module succeeds.
-
-.. seealso::
-
-    See more about exceptions in section
-    :ref:`ansible_collections.community.general.docsite.guide_modulehelper.exceptions` below.
-
-Ansible modules must have a ``main()`` function and the usual test for ``'__main__'``. When using MH that should look like:
-
-.. code-block:: python
-
-    def main():
-        MyTest.execute()
-
-
-    if __name__ == '__main__':
-        main()
-
-The class method ``execute()`` is nothing more than a convenience shorcut for:
-
-.. code-block:: python
-
-    m = MyTest()
-    m.run()
-
-Optionally, an ``AnsibleModule`` may be passed as parameter to ``execute()``.
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.paramvaroutput:
-
-Parameters, variables, and output
-"""""""""""""""""""""""""""""""""
-
-All the parameters automatically become variables in the ``self.vars`` attribute, which is of the ``VarDict`` type.
-By using ``self.vars``, you get a central mechanism to access the parameters but also to expose variables as return values of the module.
-As described in :ref:`ansible_collections.community.general.docsite.guide_vardict`, variables in ``VarDict`` have metadata associated to them.
-One of the attributes in that metadata marks the variable for output, and MH makes use of that to generate the module's return values.
-
-.. important::
-
-    The ``VarDict`` feature described was introduced in community.general 7.1.0, but there was a first
-    implementation of it embedded within ``ModuleHelper``.
-    That older implementation is now deprecated and will be removed in community.general 11.0.0.
-    After community.general 7.1.0, MH modules generate a deprecation message about *using the old VarDict*.
-    There are two ways to prevent that from happening:
-
-        #.  Set ``mute_vardict_deprecation = True`` and the deprecation will be silenced. If the module still uses the old ``VarDict``,
-            it will not be able to update to community.general 11.0.0 (Spring 2026) upon its release.
-        #.  Set ``use_old_vardict = False`` to make the MH module use the new ``VarDict`` immediatelly.
-            The new ``VarDict`` and its use is documented and this is the recommended way to handle this.
-
-    .. code-block:: python
-
-        class MyTest(ModuleHelper):
-            use_old_vardict = False
-            mute_vardict_deprecation = True
-            ...
-
-    These two settings are mutually exclusive, but that is not enforced and the behavior when setting both is not specified.
-
-Contrary to new variables created in ``VarDict``, module parameters are not set for output by default.
-If you want to include some module parameters in the output, list them in the ``output_params`` class variable.
-
-.. code-block:: python
-
-    class MyTest(ModuleHelper):
-        output_params = ('state', 'name')
-        ...
-
-Another neat feature provided by MH by using ``VarDict`` is the automatic tracking of changes when setting the metadata ``change=True``.
-Again, to enable this feature for module parameters, you must list them in the ``change_params`` class variable.
-
-.. code-block:: python
-
-    class MyTest(ModuleHelper):
-        # example from community.general.xfconf
-        change_params = ('value', )
-        ...
-
-.. seealso::
-
-    See more about this in
-    :ref:`ansible_collections.community.general.docsite.guide_modulehelper.changes` below.
-
-Similarly, if you want to use Ansible's diff mode, you can set the metadata ``diff=True`` and ``diff_params`` for module parameters.
-With that, MH will automatically generate the diff output for variables that have changed.
-
-.. code-block:: python
-
-    class MyTest(ModuleHelper):
-        diff_params = ('value', )
-
-    def __run__(self):
-        # example from community.general.gio_mime
-        self.vars.set_meta("handler", initial_value=gio_mime_get(self.runner, self.vars.mime_type), diff=True, change=True)
-
-Moreover, if a module is set to return *facts* instead of return values, then again use the metadata ``fact=True`` and ``fact_params`` for module parameters.
-Additionally, you must specify ``facts_name``, as in:
-
-.. code-block:: python
-
-    class VolumeFacts(ModuleHelper):
-        facts_name = 'volume_facts'
-
-        def __init_module__(self):
-            self.vars.set("volume", 123, fact=True)
-
-That generates an Ansible fact like:
-
-.. code-block:: yaml+jinja
-
-    - name: Obtain volume facts
-      some.collection.volume_facts:
-        # parameters
-
-    - name: Print volume facts
-      debug:
-        msg: Volume fact is {{ ansible_facts.volume_facts.volume }}
-
-.. important::
-
-    If ``facts_name`` is not set, the module does not generate any facts.
-
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.changes:
-
-Handling changes
-""""""""""""""""
-
-In MH there are many ways to indicate change in the module execution. Here they are:
-
-Tracking changes in variables
------------------------------
-
-As explained above, you can enable change tracking in any number of variables in ``self.vars``.
-By the end of the module execution, if any of those variables has a value different then the first value assigned to them,
-then that will be picked up by MH and signalled as changed at the module output.
-See the example below to learn how you can enabled change tracking in variables:
-
-.. code-block:: python
-
-    # using __init_module__() as example, it works the same in __run__() and __quit_module__()
-    def __init_module__(self):
-        # example from community.general.ansible_galaxy_install
-        self.vars.set("new_roles", {}, change=True)
-
-        # example of "hidden" variable used only to track change in a value from community.general.gconftool2
-        self.vars.set('_value', self.vars.previous_value, output=False, change=True)
-
-        # enable change-tracking without assigning value
-        self.vars.set_meta("new_roles", change=True)
-
-        # if you must forcibly set an initial value to the variable
-        self.vars.set_meta("new_roles", initial_value=[])
-        ...
-
-If the end value of any variable marked ``change`` is different from its initial value, then MH will return ``changed=True``.
-
-Indicating changes with ``changed``
------------------------------------
-
-If you want to indicate change directly in the code, then use the ``self.changed`` property in MH.
-Beware that this is a ``@property`` method in MH, with both a *getter* and a *setter*.
-By default, that hidden field is set to ``False``.
-
-Effective change
-----------------
-
-The effective outcome for the module is determined in the ``self.has_changed()`` method, and it consists of the logical *OR* operation
-between ``self.changed`` and the change calculated from ``self.vars``.
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.exceptions:
-
-Exceptions
-""""""""""
-
-In MH, instead of calling ``module.fail_json()`` you can just raise an exception.
-The output variables are collected the same way they would be for a successful execution.
-However, you can set output variables specifically for that exception, if you so choose.
-
-.. code-block:: python
-
-    def __init_module__(self):
-        if not complex_validation():
-            self.do_raise("Validation failed!")
-
-        # Or passing output variables
-        awesomeness = calculate_awesomeness()
-        if awesomeness > 1000:
-            self.do_raise("Over awesome, I cannot handle it!", update_output={"awesomeness": awesomeness})
-
-All exceptions derived from ``Exception`` are captured and translated into a ``fail_json()`` call.
-However, if you do want to call ``self.module.fail_json()`` yourself it will work,
-just keep in mind that there will be no automatic handling of output variables in that case.
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.statemh:
-
-StateModuleHelper
-^^^^^^^^^^^^^^^^^
-
-Many modules use a parameter ``state`` that effectively controls the exact action performed by the module, such as
-``state=present`` or ``state=absent`` for installing or removing packages.
-By using ``StateModuleHelper`` you can make your code like the excerpt from the ``gconftool2`` below:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
-
-    class GConftool(StateModuleHelper):
-        ...
-        module = dict(
-            ...
-        )
-        use_old_vardict = False
-
-        def __init_module__(self):
-            self.runner = gconftool2_runner(self.module, check_rc=True)
-            ...
-
-            self.vars.set('previous_value', self._get(), fact=True)
-            self.vars.set('value_type', self.vars.value_type)
-            self.vars.set('_value', self.vars.previous_value, output=False, change=True)
-            self.vars.set_meta('value', initial_value=self.vars.previous_value)
-            self.vars.set('playbook_value', self.vars.value, fact=True)
-
-        ...
-
-        def state_absent(self):
-            with self.runner("state key", output_process=self._make_process(False)) as ctx:
-                ctx.run()
-                self.vars.set('run_info', ctx.run_info, verbosity=4)
-            self.vars.set('new_value', None, fact=True)
-            self.vars._value = None
-
-        def state_present(self):
-            with self.runner("direct config_source value_type state key value", output_process=self._make_process(True)) as ctx:
-                ctx.run()
-                self.vars.set('run_info', ctx.run_info, verbosity=4)
-            self.vars.set('new_value', self._get(), fact=True)
-            self.vars._value = self.vars.new_value
-
-Note that the method ``__run__()`` is implemented in ``StateModuleHelper``, all you need to implement are the methods ``state_<state_value>``.
-In the example above, :ansplugin:`community.general.gconftool2#module` only has two states, ``present`` and ``absent``, thus, ``state_present()`` and ``state_absent()``.
-
-If the controlling parameter is not called ``state``, like in :ansplugin:`community.general.jira#module` module, just let SMH know about it:
-
-.. code-block:: python
-
-    class JIRA(StateModuleHelper):
-        state_param = 'operation'
-
-        def operation_create(self):
-            ...
-
-        def operation_search(self):
-            ...
-
-Lastly, if the module is called with ``state=somevalue`` and the method ``state_somevalue``
-is not implemented, SMH will resort to call a method called ``__state_fallback__()``.
-By default, this method will raise a ``ValueError`` indicating the method was not found.
-Naturally, you can override that method to write a default implementation, as in :ansplugin:`community.general.locale_gen#module`:
-
-.. code-block:: python
-
-        def __state_fallback__(self):
-            if self.vars.state_tracking == self.vars.state:
-                return
-            if self.vars.ubuntu_mode:
-                self.apply_change_ubuntu(self.vars.state, self.vars.name)
-            else:
-                self.apply_change(self.vars.state, self.vars.name)
-
-That module has only the states ``present`` and ``absent`` and the code for both is the one in the fallback method.
-
-.. note::
-
-    The name of the fallback method **does not change** if you set a different value of ``state_param``.
-
-
-Other Conveniences
-^^^^^^^^^^^^^^^^^^
-
-Delegations to AnsibleModule
-""""""""""""""""""""""""""""
-
-The MH properties and methods below are delegated as-is to the underlying ``AnsibleModule`` instance in ``self.module``:
-
-- ``check_mode``
-- ``get_bin_path()``
-- ``warn()``
-- ``deprecate()``
-
-Additionally, MH will also delegate:
-
-- ``diff_mode`` to ``self.module._diff``
-- ``verbosity`` to ``self.module._verbosity``
-
-Decorators
-""""""""""
-
-The following decorators should only be used within ``ModuleHelper`` class.
-
-@cause_changes
---------------
-
-This decorator will control whether the outcome of the method will cause the module to signal change in its output.
-If the method completes without raising an exception it is considered to have succeeded, otherwise, it will have failed.
-
-The decorator has a parameter ``when`` that accepts three different values: ``success``, ``failure``, and ``always``.
-There are also two legacy parameters, ``on_success`` and ``on_failure``, that will be deprecated, so do not use them.
-The value of ``changed`` in the module output will be set to ``True``:
-
-- ``when="success"`` and the method completes without raising an exception.
-- ``when="failure"`` and the method raises an exception.
-- ``when="always"``, regardless of the method raising an exception or not.
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.module_helper import cause_changes
-
-    # adapted excerpt from the community.general.jira module
-    class JIRA(StateModuleHelper):
-        @cause_changes(when="success")
-        def operation_create(self):
-            ...
-
-If ``when`` has a different value or no parameters are specificied, the decorator will have no effect whatsoever.
-
-.. _ansible_collections.community.general.docsite.guide_modulehelper.modulefailsdeco:
-
-@module_fails_on_exception
---------------------------
-
-In a method using this decorator, if an exception is raised, the text message of that exception will be captured
-by the decorator and used to call ``self.module.fail_json()``.
-In most of the cases there will be no need to use this decorator, because ``ModuleHelper.run()`` already uses it.
-
-@check_mode_skip
-----------------
-
-If the module is running in check mode, this decorator will prevent the method from executing.
-The return value in that case is ``None``.
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.module_helper import check_mode_skip
-
-    # adapted excerpt from the community.general.locale_gen module
-    class LocaleGen(StateModuleHelper):
-        @check_mode_skip
-        def __state_fallback__(self):
-            ...
-
-
-@check_mode_skip_returns
-------------------------
-
-This decorator is similar to the previous one, but the developer can control the return value for the method when running in check mode.
-It is used with one of two parameters. One is ``callable`` and the return value in check mode will be ``callable(self, *args, **kwargs)``,
-where ``self`` is the ``ModuleHelper`` instance and the union of ``args`` and ``kwargs`` will contain all the parameters passed to the method.
-
-The other option is to use the parameter ``value``, in which case the method will return ``value`` when in check mode.
-
-
-References
-^^^^^^^^^^
-
-- `Ansible Developer Guide <https://docs.ansible.com/ansible/latest/dev_guide/index.html>`_
-- `Creating a module <https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#creating-a-module>`_
-- `Returning ansible facts <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#ansible-facts>`_
-- :ref:`ansible_collections.community.general.docsite.guide_vardict`
-
-
-.. versionadded:: 3.1.0

docs/docsite/rst/guide_vardict.rst

@@ -1,176 +0,0 @@
-..
-  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
-
-.. _ansible_collections.community.general.docsite.guide_vardict:
-
-VarDict Guide
-=============
-
-Introduction
-^^^^^^^^^^^^
-
-The ``ansible_collections.community.general.plugins.module_utils.vardict`` module util provides the
-``VarDict`` class to help manage the module variables. That class is a container for module variables,
-especially the ones for which the module must keep track of state changes, and the ones that should
-be published as return values.
-
-Each variable has extra behaviors controlled by associated metadata, simplifying the generation of
-output values from the module.
-
-Quickstart
-""""""""""
-
-The simplest way of using ``VarDict`` is:
-
-.. code-block:: python
-
-    from ansible_collections.community.general.plugins.module_utils.vardict import VarDict
-
-Then in ``main()``, or any other function called from there:
-
-.. code-block:: python
-
-    vars = VarDict()
-
-    # Next 3 statements are equivalent
-    vars.abc = 123
-    vars["abc"] = 123
-    vars.set("abc", 123)
-
-    vars.xyz = "bananas"
-    vars.ghi = False
-
-And by the time the module is about to exit:
-
-.. code-block:: python
-
-    results = vars.output()
-    module.exit_json(**results)
-
-That makes the return value of the module:
-
-.. code-block:: javascript
-
-    {
-        "abc": 123,
-        "xyz": "bananas",
-        "ghi": false
-    }
-
-Metadata
-""""""""
-
-The metadata values associated with each variable are:
-
-- ``output: bool`` - marks the variable for module output as a module return value.
-- ``fact: bool`` - marks the variable for module output as an Ansible fact.
-- ``verbosity: int`` - sets the minimum level of verbosity for which the variable will be included in the output.
-- ``change: bool`` - controls the detection of changes in the variable value.
-- ``initial_value: any`` - when using ``change`` and need to forcefully set an intial value to the variable.
-- ``diff: bool`` - used along with ``change``, this generates an Ansible-style diff ``dict``.
-
-See the sections below for more details on how to use the metadata.
-
-
-Using VarDict
-^^^^^^^^^^^^^
-
-Basic Usage
-"""""""""""
-
-As shown above, variables can be accessed using the ``[]`` operator, as in a ``dict`` object,
-and also as an object attribute, such as ``vars.abc``. The form using the ``set()``
-method is special in the sense that you can use it to set metadata values:
-
-.. code-block:: python
-
-    vars.set("abc", 123, output=False)
-    vars.set("abc", 123, output=True, change=True)
-
-Another way to set metadata after the variables have been created is:
-
-.. code-block:: python
-
-    vars.set_meta("abc", output=False)
-    vars.set_meta("abc", output=True, change=True, diff=True)
-
-You can use either operator and attribute forms to access the value of the variable. Other ways to
-access its value and its metadata are:
-
-.. code-block:: python
-
-    print("abc value = {0}".format(vars.var("abc")["value"]))        # get the value
-    print("abc output? {0}".format(vars.get_meta("abc")["output"]))  # get the metadata like this
-
-The names of methods, such as ``set``, ``get_meta``, ``output`` amongst others, are reserved and
-cannot be used as variable names. If you try to use a reserved name a ``ValueError`` exception
-is raised with the message "Name <var> is reserved".
-
-Generating output
-"""""""""""""""""
-
-By default, every variable create will be enable for output with minimum verbosity set to zero, in
-other words, they will always be in the output by default.
-
-You can control that when creating the variable for the first time or later in the code:
-
-.. code-block:: python
-
-    vars.set("internal", x + 4, output=False)
-    vars.set_meta("internal", output=False)
-
-You can also set the verbosity of some variable, like:
-
-.. code-block:: python
-
-    vars.set("abc", x + 4)
-    vars.set("debug_x", x, verbosity=3)
-
-    results = vars.output(module._verbosity)
-    module.exit_json(**results)
-
-If the module was invoked with verbosity lower than 3, then the output will only contain
-the variable ``abc``. If running at higher verbosity, as in ``ansible-playbook -vvv``,
-then the output will also contain ``debug_x``.
-
-Generating facts is very similar to regular output, but variables are not marked as facts by default.
-
-.. code-block:: python
-
-    vars.set("modulefact", x + 4, fact=True)
-    vars.set("debugfact", x, fact=True, verbosity=3)
-
-    results = vars.output(module._verbosity)
-    results["ansible_facts"] = {"module_name": vars.facts(module._verbosity)}
-    module.exit_json(**results)
-
-Handling change
-"""""""""""""""
-
-You can use ``VarDict`` to determine whether variables have had their values changed.
-
-.. code-block:: python
-
-    vars.set("abc", 42, change=True)
-    vars.abc = 90
-
-    results = vars.output()
-    results["changed"] = vars.has_changed
-    module.exit_json(**results)
-
-If tracking changes in variables, you may want to present the difference between the initial and the final
-values of it. For that, you want to use:
-
-.. code-block:: python
-
-    vars.set("abc", 42, change=True, diff=True)
-    vars.abc = 90
-
-    results = vars.output()
-    results["changed"] = vars.has_changed
-    results["diff"] = vars.diff()
-    module.exit_json(**results)
-
-.. versionadded:: 7.1.0

galaxy.yml

@@ -5,7 +5,7 @@
 
 namespace: community
 name: general
-version: 9.5.9
+version: 8.6.11
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)

noxfile.py

@@ -1,38 +0,0 @@
-# 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
-# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
-
-# /// script
-# dependencies = ["nox>=2025.02.09", "antsibull-nox"]
-# ///
-
-import sys
-
-import nox
-
-
-try:
-    import antsibull_nox
-except ImportError:
-    print("You need to install antsibull-nox in the same Python environment as nox.")
-    sys.exit(1)
-
-
-antsibull_nox.load_antsibull_nox_toml()
-
-
-@nox.session(name="aliases", python=False, default=True)
-def aliases(session: nox.Session) -> None:
-    session.run("python", "tests/sanity/extra/aliases.py")
-
-
-@nox.session(name="botmeta", default=True)
-def botmeta(session: nox.Session) -> None:
-    session.install("PyYAML", "voluptuous")
-    session.run("python", "tests/sanity/extra/botmeta.py")
-
-
-# Allow to run the noxfile with `python noxfile.py`, `pipx run noxfile.py`, or similar.
-# Requires nox >= 2025.02.09
-if __name__ == "__main__":
-    nox.main()

plugins/become/doas.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: Ansible Core Team
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             ini:
               - section: privilege_escalation
                 key: become_user
@@ -27,8 +26,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_DOAS_USER
         become_exe:
-            description: Doas executable.
-            type: string
+            description: Doas executable
             default: doas
             ini:
               - section: privilege_escalation
@@ -42,8 +40,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_DOAS_EXE
         become_flags:
-            description: Options to pass to doas.
-            type: string
+            description: Options to pass to doas
             default: ''
             ini:
               - section: privilege_escalation
@@ -57,8 +54,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_DOAS_FLAGS
         become_pass:
-            description: Password for doas prompt.
-            type: string
+            description: password for doas prompt
             required: false
             vars:
               - name: ansible_become_password
@@ -72,10 +68,8 @@ DOCUMENTATION = '''
                 key: password
         prompt_l10n:
             description:
-                - List of localized strings to match for prompt detection.
-                - If empty we will use the built in one.
-            type: list
-            elements: string
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
             default: []
             ini:
               - section: doas_become_plugin

plugins/become/dzdo.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: Ansible Core Team
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             ini:
               - section: privilege_escalation
                 key: become_user
@@ -27,8 +26,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_DZDO_USER
         become_exe:
-            description: Dzdo executable.
-            type: string
+            description: Dzdo executable
             default: dzdo
             ini:
               - section: privilege_escalation
@@ -42,8 +40,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_DZDO_EXE
         become_flags:
-            description: Options to pass to dzdo.
-            type: string
+            description: Options to pass to dzdo
             default: -H -S -n
             ini:
               - section: privilege_escalation
@@ -57,8 +54,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_DZDO_FLAGS
         become_pass:
-            description: Options to pass to dzdo.
-            type: string
+            description: Options to pass to dzdo
             required: false
             vars:
               - name: ansible_become_password

plugins/become/ksu.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: Ansible Core Team
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             ini:
               - section: privilege_escalation
                 key: become_user
@@ -28,8 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_KSU_USER
             required: true
         become_exe:
-            description: Su executable.
-            type: string
+            description: Su executable
             default: ksu
             ini:
               - section: privilege_escalation
@@ -43,8 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_KSU_EXE
         become_flags:
-            description: Options to pass to ksu.
-            type: string
+            description: Options to pass to ksu
             default: ''
             ini:
               - section: privilege_escalation
@@ -58,8 +55,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_KSU_FLAGS
         become_pass:
-            description: Ksu password.
-            type: string
+            description: ksu password
             required: false
             vars:
               - name: ansible_ksu_pass
@@ -73,10 +69,8 @@ DOCUMENTATION = '''
                 key: password
         prompt_l10n:
             description:
-                - List of localized strings to match for prompt detection.
-                - If empty we will use the built in one.
-            type: list
-            elements: string
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
             default: []
             ini:
               - section: ksu_become_plugin

plugins/become/machinectl.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: Ansible Core Team
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             default: ''
             ini:
               - section: privilege_escalation
@@ -28,8 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_MACHINECTL_USER
         become_exe:
-            description: Machinectl executable.
-            type: string
+            description: Machinectl executable
             default: machinectl
             ini:
               - section: privilege_escalation
@@ -43,8 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_MACHINECTL_EXE
         become_flags:
-            description: Options to pass to machinectl.
-            type: string
+            description: Options to pass to machinectl
             default: ''
             ini:
               - section: privilege_escalation
@@ -58,8 +55,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_MACHINECTL_FLAGS
         become_pass:
-            description: Password for machinectl.
-            type: string
+            description: Password for machinectl
             required: false
             vars:
               - name: ansible_become_password
@@ -82,13 +78,12 @@ DOCUMENTATION = '''
 EXAMPLES = r'''
 # A polkit rule needed to use the module with a non-root user.
 # See the Notes section for details.
-/etc/polkit-1/rules.d/60-machinectl-fast-user-auth.rules: |
-  polkit.addRule(function(action, subject) {
-    if(action.id == "org.freedesktop.machine1.host-shell" &&
-      subject.isInGroup("wheel")) {
-        return polkit.Result.AUTH_SELF_KEEP;
-    }
-  });
+60-machinectl-fast-user-auth.rules: |
+    polkit.addRule(function(action, subject) {
+        if(action.id == "org.freedesktop.machine1.host-shell" && subject.isInGroup("wheel")) {
+            return polkit.Result.AUTH_SELF_KEEP;
+        }
+    });
 '''
 
 from re import compile as re_compile

plugins/become/pbrun.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: Ansible Core Team
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             default: ''
             ini:
               - section: privilege_escalation
@@ -28,8 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_PBRUN_USER
         become_exe:
-            description: Sudo executable.
-            type: string
+            description: Sudo executable
             default: pbrun
             ini:
               - section: privilege_escalation
@@ -43,8 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_PBRUN_EXE
         become_flags:
-            description: Options to pass to pbrun.
-            type: string
+            description: Options to pass to pbrun
             default: ''
             ini:
               - section: privilege_escalation
@@ -58,8 +55,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_PBRUN_FLAGS
         become_pass:
-            description: Password for pbrun.
-            type: string
+            description: Password for pbrun
             required: false
             vars:
               - name: ansible_become_password
@@ -72,7 +68,7 @@ DOCUMENTATION = '''
               - section: pbrun_become_plugin
                 key: password
         wrap_exe:
-            description: Toggle to wrap the command pbrun calls in C(shell -c) or not.
+            description: Toggle to wrap the command pbrun calls in 'shell -c' or not
             default: false
             type: bool
             ini:

plugins/become/pfexec.py

@@ -14,10 +14,9 @@ DOCUMENTATION = '''
     options:
         become_user:
             description:
-                - User you 'become' to execute the task.
+                - User you 'become' to execute the task
                 - This plugin ignores this setting as pfexec uses it's own C(exec_attr) to figure this out,
                   but it is supplied here for Ansible to make decisions needed for the task execution, like file permissions.
-            type: string
             default: root
             ini:
               - section: privilege_escalation
@@ -31,8 +30,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_PFEXEC_USER
         become_exe:
-            description: Sudo executable.
-            type: string
+            description: Sudo executable
             default: pfexec
             ini:
               - section: privilege_escalation
@@ -46,8 +44,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_PFEXEC_EXE
         become_flags:
-            description: Options to pass to pfexec.
-            type: string
+            description: Options to pass to pfexec
             default: -H -S -n
             ini:
               - section: privilege_escalation
@@ -61,8 +58,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_PFEXEC_FLAGS
         become_pass:
-            description: pfexec password.
-            type: string
+            description: pfexec password
             required: false
             vars:
               - name: ansible_become_password
@@ -75,7 +71,7 @@ DOCUMENTATION = '''
               - section: pfexec_become_plugin
                 key: password
         wrap_exe:
-            description: Toggle to wrap the command pfexec calls in C(shell -c) or not.
+            description: Toggle to wrap the command pfexec calls in 'shell -c' or not
             default: false
             type: bool
             ini:
@@ -86,7 +82,7 @@ DOCUMENTATION = '''
             env:
               - name: ANSIBLE_PFEXEC_WRAP_EXECUTION
     notes:
-      - This plugin ignores O(become_user) as pfexec uses its own C(exec_attr) to figure this out.
+      - This plugin ignores O(become_user) as pfexec uses it's own C(exec_attr) to figure this out.
 '''
 
 from ansible.plugins.become import BecomeBase

plugins/become/pmrun.py

@@ -14,7 +14,6 @@ DOCUMENTATION = '''
     options:
         become_exe:
             description: Sudo executable
-            type: string
             default: pmrun
             ini:
               - section: privilege_escalation
@@ -28,8 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_PMRUN_EXE
         become_flags:
-            description: Options to pass to pmrun.
-            type: string
+            description: Options to pass to pmrun
             default: ''
             ini:
               - section: privilege_escalation
@@ -43,8 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_PMRUN_FLAGS
         become_pass:
-            description: pmrun password.
-            type: string
+            description: pmrun password
             required: false
             vars:
               - name: ansible_become_password

plugins/become/run0.py

@@ -1,128 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2024, 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
-
-DOCUMENTATION = """
-    name: run0
-    short_description: Systemd's run0
-    description:
-        - This become plugins allows your remote/login user to execute commands as another user via the C(run0) utility.
-    author:
-        - Thomas Sjögren (@konstruktoid)
-    version_added: '9.0.0'
-    options:
-        become_user:
-            description: User you 'become' to execute the task.
-            default: root
-            ini:
-              - section: privilege_escalation
-                key: become_user
-              - section: run0_become_plugin
-                key: user
-            vars:
-              - name: ansible_become_user
-              - name: ansible_run0_user
-            env:
-              - name: ANSIBLE_BECOME_USER
-              - name: ANSIBLE_RUN0_USER
-            type: string
-        become_exe:
-            description: The C(run0) executable.
-            default: run0
-            ini:
-              - section: privilege_escalation
-                key: become_exe
-              - section: run0_become_plugin
-                key: executable
-            vars:
-              - name: ansible_become_exe
-              - name: ansible_run0_exe
-            env:
-              - name: ANSIBLE_BECOME_EXE
-              - name: ANSIBLE_RUN0_EXE
-            type: string
-        become_flags:
-            description: Options to pass to run0.
-            default: ''
-            ini:
-              - section: privilege_escalation
-                key: become_flags
-              - section: run0_become_plugin
-                key: flags
-            vars:
-              - name: ansible_become_flags
-              - name: ansible_run0_flags
-            env:
-              - name: ANSIBLE_BECOME_FLAGS
-              - name: ANSIBLE_RUN0_FLAGS
-            type: string
-    notes:
-      - This plugin will only work when a polkit rule is in place.
-"""
-
-EXAMPLES = r"""
-# An example polkit rule that allows the user 'ansible' in the 'wheel' group
-# to execute commands using run0 without authentication.
-/etc/polkit-1/rules.d/60-run0-fast-user-auth.rules: |
-  polkit.addRule(function(action, subject) {
-    if(action.id == "org.freedesktop.systemd1.manage-units" &&
-      subject.isInGroup("wheel") &&
-      subject.user == "ansible") {
-        return polkit.Result.YES;
-    }
-  });
-"""
-
-from re import compile as re_compile
-
-from ansible.plugins.become import BecomeBase
-from ansible.module_utils._text import to_bytes
-
-ansi_color_codes = re_compile(to_bytes(r"\x1B\[[0-9;]+m"))
-
-
-class BecomeModule(BecomeBase):
-
-    name = "community.general.run0"
-
-    prompt = "Password: "
-    fail = ("==== AUTHENTICATION FAILED ====",)
-    success = ("==== AUTHENTICATION COMPLETE ====",)
-    require_tty = (
-        True  # see https://github.com/ansible-collections/community.general/issues/6932
-    )
-
-    @staticmethod
-    def remove_ansi_codes(line):
-        return ansi_color_codes.sub(b"", line)
-
-    def build_become_command(self, cmd, shell):
-        super().build_become_command(cmd, shell)
-
-        if not cmd:
-            return cmd
-
-        become = self.get_option("become_exe")
-        flags = self.get_option("become_flags")
-        user = self.get_option("become_user")
-
-        return (
-            f"{become} --user={user} {flags} {self._build_success_command(cmd, shell)}"
-        )
-
-    def check_success(self, b_output):
-        b_output = self.remove_ansi_codes(b_output)
-        return super().check_success(b_output)
-
-    def check_incorrect_password(self, b_output):
-        b_output = self.remove_ansi_codes(b_output)
-        return super().check_incorrect_password(b_output)
-
-    def check_missing_password(self, b_output):
-        b_output = self.remove_ansi_codes(b_output)
-        return super().check_missing_password(b_output)

plugins/become/sesu.py

@@ -13,8 +13,7 @@ DOCUMENTATION = '''
     author: ansible (@nekonyuu)
     options:
         become_user:
-            description: User you 'become' to execute the task.
-            type: string
+            description: User you 'become' to execute the task
             default: ''
             ini:
               - section: privilege_escalation
@@ -28,8 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_USER
               - name: ANSIBLE_SESU_USER
         become_exe:
-            description: sesu executable.
-            type: string
+            description: sesu executable
             default: sesu
             ini:
               - section: privilege_escalation
@@ -43,8 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_EXE
               - name: ANSIBLE_SESU_EXE
         become_flags:
-            description: Options to pass to sesu.
-            type: string
+            description: Options to pass to sesu
             default: -H -S -n
             ini:
               - section: privilege_escalation
@@ -58,8 +55,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_BECOME_FLAGS
               - name: ANSIBLE_SESU_FLAGS
         become_pass:
-            description: Password to pass to sesu.
-            type: string
+            description: Password to pass to sesu
             required: false
             vars:
               - name: ansible_become_password

plugins/become/sudosu.py

@@ -16,7 +16,6 @@ DOCUMENTATION = """
     options:
         become_user:
             description: User you 'become' to execute the task.
-            type: string
             default: root
             ini:
               - section: privilege_escalation
@@ -31,7 +30,6 @@ DOCUMENTATION = """
               - name: ANSIBLE_SUDO_USER
         become_flags:
             description: Options to pass to C(sudo).
-            type: string
             default: -H -S -n
             ini:
               - section: privilege_escalation
@@ -46,7 +44,6 @@ DOCUMENTATION = """
               - name: ANSIBLE_SUDO_FLAGS
         become_pass:
             description: Password to pass to C(sudo).
-            type: string
             required: false
             vars:
               - name: ansible_become_password
@@ -58,21 +55,6 @@ DOCUMENTATION = """
             ini:
               - section: sudo_become_plugin
                 key: password
-        alt_method:
-            description:
-              - Whether to use an alternative method to call C(su). Instead of running C(su -l user /path/to/shell -c command),
-                it runs C(su -l user -c command).
-              - Use this when the default one is not working on your system.
-            required: false
-            type: boolean
-            ini:
-              - section: community.general.sudosu
-                key: alternative_method
-            vars:
-              - name: ansible_sudosu_alt_method
-            env:
-              - name: ANSIBLE_SUDOSU_ALT_METHOD
-            version_added: 9.2.0
 """
 
 
@@ -107,7 +89,4 @@ class BecomeModule(BecomeBase):
         if user:
             user = '%s' % (user)
 
-        if self.get_option('alt_method'):
-            return ' '.join([becomecmd, flags, prompt, "su -l", user, "-c", self._build_success_command(cmd, shell, True)])
-        else:
-            return ' '.join([becomecmd, flags, prompt, 'su -l', user, self._build_success_command(cmd, shell)])
+        return ' '.join([becomecmd, flags, prompt, 'su -l', user, self._build_success_command(cmd, shell)])

plugins/cache/memcached.py

@@ -7,46 +7,44 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: memcached
-short_description: Use memcached DB for cache
-description:
-  - This cache uses JSON formatted, per host records saved in memcached.
-requirements:
-  - memcache (python lib)
-options:
-  _uri:
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: memcached
+    short_description: Use memcached DB for cache
     description:
-      - List of connection information for the memcached DBs.
-    default: ['127.0.0.1:11211']
-    type: list
-    elements: string
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-  _prefix:
-    description: User defined prefix to use when creating the DB entries.
-    type: string
-    default: ansible_facts
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-  _timeout:
-    default: 86400
-    type: integer
-        # TODO: determine whether it is OK to change to: type: float
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-"""
+        - This cache uses JSON formatted, per host records saved in memcached.
+    requirements:
+      - memcache (python lib)
+    options:
+      _uri:
+        description:
+          - List of connection information for the memcached DBs
+        default: ['127.0.0.1:11211']
+        type: list
+        elements: string
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the DB entries
+        default: ansible_facts
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+        type: integer
+'''
 
 import collections
 import os

plugins/cache/pickle.py

@@ -8,41 +8,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: pickle
-short_description: Pickle formatted files
-description:
-  - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
-author: Brian Coca (@bcoca)
-options:
-  _uri:
-    required: true
+DOCUMENTATION = '''
+    name: pickle
+    short_description: Pickle formatted files.
     description:
-      - Path in which the cache plugin will save the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-    type: path
-  _prefix:
-    description: User defined prefix to use when creating the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-    type: string
-  _timeout:
-    default: 86400
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-    type: float
-"""
+        - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
+    author: Brian Coca (@bcoca)
+    options:
+      _uri:
+        required: true
+        description:
+          - Path in which the cache plugin will save the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+'''
 
 try:
     import cPickle as pickle
@@ -57,7 +54,6 @@ class CacheModule(BaseFileCacheModule):
     """
     A caching module backed by pickle files.
     """
-    _persistent = False  # prevent unnecessary JSON serialization and key munging
 
     def _load(self, filepath):
         # Pickle is a binary format

plugins/cache/redis.py

@@ -6,67 +6,62 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: redis
-short_description: Use Redis DB for cache
-description:
-  - This cache uses JSON formatted, per host records saved in Redis.
-requirements:
-  - redis>=2.4.5 (python lib)
-options:
-  _uri:
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: redis
+    short_description: Use Redis DB for cache
     description:
-      - A colon separated string of connection information for Redis.
-      - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
-      - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
-      - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
-    type: string
-    required: true
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-  _prefix:
-    description: User defined prefix to use when creating the DB entries.
-    type: string
-    default: ansible_facts
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-  _keyset_name:
-    description: User defined name for cache keyset name.
-    type: string
-    default: ansible_cache_keys
-    env:
-      - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
-    ini:
-      - key: fact_caching_redis_keyset_name
-        section: defaults
-    version_added: 1.3.0
-  _sentinel_service_name:
-    description: The redis sentinel service name (or referenced as cluster name).
-    type: string
-    env:
-      - name: ANSIBLE_CACHE_REDIS_SENTINEL
-    ini:
-      - key: fact_caching_redis_sentinel
-        section: defaults
-    version_added: 1.3.0
-  _timeout:
-    default: 86400
-    type: integer
-        # TODO: determine whether it is OK to change to: type: float
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-"""
+        - This cache uses JSON formatted, per host records saved in Redis.
+    requirements:
+      - redis>=2.4.5 (python lib)
+    options:
+      _uri:
+        description:
+          - A colon separated string of connection information for Redis.
+          - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
+          - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
+          - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
+        required: true
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the DB entries
+        default: ansible_facts
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _keyset_name:
+        description: User defined name for cache keyset name.
+        default: ansible_cache_keys
+        env:
+          - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
+        ini:
+          - key: fact_caching_redis_keyset_name
+            section: defaults
+        version_added: 1.3.0
+      _sentinel_service_name:
+        description: The redis sentinel service name (or referenced as cluster name).
+        env:
+          - name: ANSIBLE_CACHE_REDIS_SENTINEL
+        ini:
+          - key: fact_caching_redis_sentinel
+            section: defaults
+        version_added: 1.3.0
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+        type: integer
+'''
 
 import re
 import time
@@ -227,7 +222,7 @@ class CacheModule(BaseCacheModule):
 
     def copy(self):
         # TODO: there is probably a better way to do this in redis
-        ret = {k: self.get(k) for k in self.keys()}
+        ret = dict([(k, self.get(k)) for k in self.keys()])
         return ret
 
     def __getstate__(self):

plugins/cache/yaml.py

@@ -8,42 +8,39 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: yaml
-short_description: YAML formatted files
-description:
-  - This cache uses YAML formatted, per host, files saved to the filesystem.
-author: Brian Coca (@bcoca)
-options:
-  _uri:
-    required: true
+DOCUMENTATION = '''
+    name: yaml
+    short_description: YAML formatted files.
     description:
-      - Path in which the cache plugin will save the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-    type: string
-  _prefix:
-    description: User defined prefix to use when creating the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-    type: string
-  _timeout:
-    default: 86400
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-    type: integer
-        # TODO: determine whether it is OK to change to: type: float
-"""
+        - This cache uses YAML formatted, per host, files saved to the filesystem.
+    author: Brian Coca (@bcoca)
+    options:
+      _uri:
+        required: true
+        description:
+          - Path in which the cache plugin will save the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+        type: integer
+'''
 
 
 import codecs

plugins/callback/cgroup_memory_recap.py

@@ -7,41 +7,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: cgroup_memory_recap
-type: aggregate
-requirements:
-  - whitelist in configuration
-  - cgroups
-short_description: Profiles maximum memory usage of tasks and full execution using cgroups
-description:
-  - This is an Ansible callback plugin that profiles maximum memory usage of Ansible and individual tasks, and displays a
-    recap at the end using cgroups.
-notes:
-  - Requires ansible to be run from within a C(cgroup), such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
-  - This C(cgroup) should only be used by Ansible to get accurate results.
-  - To create the C(cgroup), first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
-options:
-  max_mem_file:
-    required: true
-    description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
-    type: str
-    env:
-      - name: CGROUP_MAX_MEM_FILE
-    ini:
-      - section: callback_cgroupmemrecap
-        key: max_mem_file
-  cur_mem_file:
-    required: true
-    description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
-    type: str
-    env:
-      - name: CGROUP_CUR_MEM_FILE
-    ini:
-      - section: callback_cgroupmemrecap
-        key: cur_mem_file
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: cgroup_memory_recap
+    type: aggregate
+    requirements:
+      - whitelist in configuration
+      - cgroups
+    short_description: Profiles maximum memory usage of tasks and full execution using cgroups
+    description:
+        - This is an ansible callback plugin that profiles maximum memory usage of ansible and individual tasks, and displays a recap at the end using cgroups.
+    notes:
+        - Requires ansible to be run from within a cgroup, such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
+        - This cgroup should only be used by ansible to get accurate results.
+        - To create the cgroup, first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
+    options:
+      max_mem_file:
+        required: true
+        description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
+        env:
+          - name: CGROUP_MAX_MEM_FILE
+        ini:
+          - section: callback_cgroupmemrecap
+            key: max_mem_file
+      cur_mem_file:
+        required: true
+        description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
+        env:
+          - name: CGROUP_CUR_MEM_FILE
+        ini:
+          - section: callback_cgroupmemrecap
+            key: cur_mem_file
+'''
 
 import time
 import threading

plugins/callback/context_demo.py

@@ -7,17 +7,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: context_demo
-type: aggregate
-short_description: demo callback that adds play/task context
-description:
-  - Displays some play and task context along with normal output.
-  - This is mostly for demo purposes.
-requirements:
-  - whitelist in configuration
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: context_demo
+    type: aggregate
+    short_description: demo callback that adds play/task context
+    description:
+      - Displays some play and task context along with normal output.
+      - This is mostly for demo purposes.
+    requirements:
+      - whitelist in configuration
+'''
 
 from ansible.plugins.callback import CallbackBase
 

plugins/callback/counter_enabled.py

@@ -9,20 +9,20 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: counter_enabled
-type: stdout
-short_description: adds counters to the output items (tasks and hosts/task)
-description:
-  - Use this callback when you need a kind of progress bar on a large environments.
-  - You will know how many tasks has the playbook to run, and which one is actually running.
-  - You will know how many hosts may run a task, and which of them is actually running.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: counter_enabled
+    type: stdout
+    short_description: adds counters to the output items (tasks and hosts/task)
+    description:
+      - Use this callback when you need a kind of progress bar on a large environments.
+      - You will know how many tasks has the playbook to run, and which one is actually running.
+      - You will know how many hosts may run a task, and which of them is actually running.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
+'''
 
 from ansible import constants as C
 from ansible.plugins.callback import CallbackBase

plugins/callback/default_without_diff.py

@@ -7,22 +7,23 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: default_without_diff
-type: stdout
-short_description: The default ansible callback without diff output
-version_added: 8.4.0
-description:
-  - This is basically the default ansible callback plugin (P(ansible.builtin.default#callback)) without showing diff output.
-    This can be useful when using another callback which sends more detailed information to another service, like the L(ARA,
-    https://ara.recordsansible.org/) callback, and you want diff output sent to that plugin but not shown on the console output.
-author: Felix Fontein (@felixfontein)
-extends_documentation_fragment:
-  - ansible.builtin.default_callback
-  - ansible.builtin.result_format_callback
-"""
+DOCUMENTATION = r'''
+  name: default_without_diff
+  type: stdout
+  short_description: The default ansible callback without diff output
+  version_added: 8.4.0
+  description:
+    - This is basically the default ansible callback plugin (P(ansible.builtin.default#callback)) without
+      showing diff output. This can be useful when using another callback which sends more detailed information
+      to another service, like the L(ARA, https://ara.recordsansible.org/) callback, and you want diff output
+      sent to that plugin but not shown on the console output.
+  author: Felix Fontein (@felixfontein)
+  extends_documentation_fragment:
+    - ansible.builtin.default_callback
+    - ansible.builtin.result_format_callback
+'''
 
-EXAMPLES = r"""
+EXAMPLES = r'''
 # Enable callback in ansible.cfg:
 ansible_config: |
   [defaults]
@@ -31,7 +32,7 @@ ansible_config: |
 # Enable callback with environment variables:
 environment_variable: |
   ANSIBLE_STDOUT_CALLBACK=community.general.default_without_diff
-"""
+'''
 
 from ansible.plugins.callback.default import CallbackModule as Default
 

plugins/callback/dense.py

@@ -7,19 +7,19 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
+DOCUMENTATION = '''
 name: dense
 type: stdout
 short_description: minimal stdout output
 extends_documentation_fragment:
-  - default_callback
+- default_callback
 description:
-  - When in verbose mode it will act the same as the default callback.
+- When in verbose mode it will act the same as the default callback.
 author:
-  - Dag Wieers (@dagwieers)
+- Dag Wieers (@dagwieers)
 requirements:
-  - set as stdout in configuration
-"""
+- set as stdout in configuration
+'''
 
 HAS_OD = False
 try:

plugins/callback/elastic.py

@@ -5,69 +5,69 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-name: elastic
-type: notification
-short_description: Create distributed traces for each Ansible task in Elastic APM
-version_added: 3.8.0
-description:
-  - This callback creates distributed traces for each Ansible task in Elastic APM.
-  - You can configure the plugin with environment variables.
-  - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
-options:
-  hide_task_arguments:
-    default: false
-    type: bool
+DOCUMENTATION = '''
+    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+    name: elastic
+    type: notification
+    short_description: Create distributed traces for each Ansible task in Elastic APM
+    version_added: 3.8.0
     description:
-      - Hide the arguments for a task.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-  apm_service_name:
-    default: ansible
-    type: str
-    description:
-      - The service name resource attribute.
-    env:
-      - name: ELASTIC_APM_SERVICE_NAME
-  apm_server_url:
-    type: str
-    description:
-      - Use the APM server and its environment variables.
-    env:
-      - name: ELASTIC_APM_SERVER_URL
-  apm_secret_token:
-    type: str
-    description:
-      - Use the APM server token.
-    env:
-      - name: ELASTIC_APM_SECRET_TOKEN
-  apm_api_key:
-    type: str
-    description:
-      - Use the APM API key.
-    env:
-      - name: ELASTIC_APM_API_KEY
-  apm_verify_server_cert:
-    default: true
-    type: bool
-    description:
-      - Verifies the SSL certificate if an HTTPS connection.
-    env:
-      - name: ELASTIC_APM_VERIFY_SERVER_CERT
-  traceparent:
-    type: str
-    description:
-      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-    env:
-      - name: TRACEPARENT
-requirements:
-  - elastic-apm (Python library)
-"""
+      - This callback creates distributed traces for each Ansible task in Elastic APM.
+      - You can configure the plugin with environment variables.
+      - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
+    options:
+      hide_task_arguments:
+        default: false
+        type: bool
+        description:
+          - Hide the arguments for a task.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+      apm_service_name:
+        default: ansible
+        type: str
+        description:
+          - The service name resource attribute.
+        env:
+          - name: ELASTIC_APM_SERVICE_NAME
+      apm_server_url:
+        type: str
+        description:
+          - Use the APM server and its environment variables.
+        env:
+          - name: ELASTIC_APM_SERVER_URL
+      apm_secret_token:
+        type: str
+        description:
+          - Use the APM server token
+        env:
+          - name: ELASTIC_APM_SECRET_TOKEN
+      apm_api_key:
+        type: str
+        description:
+          - Use the APM API key
+        env:
+          - name: ELASTIC_APM_API_KEY
+      apm_verify_server_cert:
+        default: true
+        type: bool
+        description:
+          - Verifies the SSL certificate if an HTTPS connection.
+        env:
+          - name: ELASTIC_APM_VERIFY_SERVER_CERT
+      traceparent:
+        type: str
+        description:
+          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+        env:
+          - name: TRACEPARENT
+    requirements:
+      - elastic-apm (Python library)
+'''
 
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.elastic
@@ -76,7 +76,7 @@ examples: |-
     export ELASTIC_APM_SERVER_URL=<your APM server URL)>
     export ELASTIC_APM_SERVICE_NAME=your_service_name
     export ELASTIC_APM_API_KEY=your_APM_API_KEY
-"""
+'''
 
 import getpass
 import socket

plugins/callback/hipchat.py

@@ -25,7 +25,6 @@ DOCUMENTATION = '''
     options:
       token:
         description: HipChat API token for v1 or v2 API.
-        type: str
         required: true
         env:
           - name: HIPCHAT_TOKEN
@@ -34,10 +33,6 @@ DOCUMENTATION = '''
             key: token
       api_version:
         description: HipChat API version, v1 or v2.
-        type: str
-        choices:
-          - v1
-          - v2
         required: false
         default: v1
         env:
@@ -47,7 +42,6 @@ DOCUMENTATION = '''
             key: api_version
       room:
         description: HipChat room to post in.
-        type: str
         default: ansible
         env:
           - name: HIPCHAT_ROOM
@@ -56,7 +50,6 @@ DOCUMENTATION = '''
             key: room
       from:
         description:  Name to post as
-        type: str
         default: ansible
         env:
           - name: HIPCHAT_FROM

plugins/callback/jabber.py

@@ -7,42 +7,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: jabber
-type: notification
-short_description: post task events to a Jabber server
-description:
-  - The chatty part of ChatOps with a Hipchat server as a target.
-  - This callback plugin sends status updates to a HipChat channel during playbook execution.
-requirements:
-  - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
-options:
-  server:
-    description: Connection info to Jabber server.
-    type: str
-    required: true
-    env:
-      - name: JABBER_SERV
-  user:
-    description: Jabber user to authenticate as.
-    type: str
-    required: true
-    env:
-      - name: JABBER_USER
-  password:
-    description: Password for the user to the Jabber server.
-    type: str
-    required: true
-    env:
-      - name: JABBER_PASS
-  to:
-    description: Chat identifier that will receive the message.
-    type: str
-    required: true
-    env:
-      - name: JABBER_TO
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: jabber
+    type: notification
+    short_description: post task events to a jabber server
+    description:
+      - The chatty part of ChatOps with a Hipchat server as a target.
+      - This callback plugin sends status updates to a HipChat channel during playbook execution.
+    requirements:
+      - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
+    options:
+      server:
+        description: connection info to jabber server
+        required: true
+        env:
+          - name: JABBER_SERV
+      user:
+        description: Jabber user to authenticate as
+        required: true
+        env:
+          - name: JABBER_USER
+      password:
+        description: Password for the user to the jabber server
+        required: true
+        env:
+          - name: JABBER_PASS
+      to:
+        description: chat identifier that will receive the message
+        required: true
+        env:
+          - name: JABBER_TO
+'''
 
 import os
 

plugins/callback/log_plays.py

@@ -7,27 +7,26 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: log_plays
-type: notification
-short_description: write playbook output to log file
-description:
-  - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory.
-requirements:
-  - Whitelist in configuration
-  - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
-options:
-  log_folder:
-    default: /var/log/ansible/hosts
-    description: The folder where log files will be created.
-    type: str
-    env:
-      - name: ANSIBLE_LOG_FOLDER
-    ini:
-      - section: callback_log_plays
-        key: log_folder
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: log_plays
+    type: notification
+    short_description: write playbook output to log file
+    description:
+      - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory.
+    requirements:
+     - Whitelist in configuration
+     - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
+    options:
+      log_folder:
+        default: /var/log/ansible/hosts
+        description: The folder where log files will be created.
+        env:
+          - name: ANSIBLE_LOG_FOLDER
+        ini:
+          - section: callback_log_plays
+            key: log_folder
+'''
 
 import os
 import time

plugins/callback/loganalytics.py

@@ -6,41 +6,39 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: loganalytics
-type: notification
-short_description: Posts task results to Azure Log Analytics
-author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
-description:
-  - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
-  - Credits to authors of splunk callback plugin.
-version_added: "2.4.0"
-requirements:
-  - Whitelisting this callback plugin.
-  - An Azure log analytics work space has been established.
-options:
-  workspace_id:
-    description: Workspace ID of the Azure log analytics workspace.
-    type: str
-    required: true
-    env:
-      - name: WORKSPACE_ID
-    ini:
-      - section: callback_loganalytics
-        key: workspace_id
-  shared_key:
-    description: Shared key to connect to Azure log analytics workspace.
-    type: str
-    required: true
-    env:
-      - name: WORKSPACE_SHARED_KEY
-    ini:
-      - section: callback_loganalytics
-        key: shared_key
-"""
+DOCUMENTATION = '''
+    name: loganalytics
+    type: notification
+    short_description: Posts task results to Azure Log Analytics
+    author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
+    description:
+      - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
+      - Credits to authors of splunk callback plugin.
+    version_added: "2.4.0"
+    requirements:
+      - Whitelisting this callback plugin.
+      - An Azure log analytics work space has been established.
+    options:
+      workspace_id:
+        description: Workspace ID of the Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_ID
+        ini:
+          - section: callback_loganalytics
+            key: workspace_id
+      shared_key:
+        description: Shared key to connect to Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_SHARED_KEY
+        ini:
+          - section: callback_loganalytics
+            key: shared_key
+'''
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Whitelist the plugin in ansible.cfg:
     [defaults]
     callback_whitelist = community.general.loganalytics
@@ -51,7 +49,7 @@ examples: |-
     [callback_loganalytics]
     workspace_id = 01234567-0123-0123-0123-01234567890a
     shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
-"""
+'''
 
 import hashlib
 import hmac

plugins/callback/logdna.py

@@ -6,56 +6,56 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: logdna
-type: notification
-short_description: Sends playbook logs to LogDNA
-description:
-  - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
-requirements:
-  - LogDNA Python Library (U(https://github.com/logdna/python))
-  - whitelisting in configuration
-options:
-  conf_key:
-    required: true
-    description: LogDNA Ingestion Key.
-    type: string
-    env:
-      - name: LOGDNA_INGESTION_KEY
-    ini:
-      - section: callback_logdna
-        key: conf_key
-  plugin_ignore_errors:
-    required: false
-    description: Whether to ignore errors on failing or not.
-    type: boolean
-    env:
-      - name: ANSIBLE_IGNORE_ERRORS
-    ini:
-      - section: callback_logdna
-        key: plugin_ignore_errors
-    default: false
-  conf_hostname:
-    required: false
-    description: Alternative Host Name; the current host name by default.
-    type: string
-    env:
-      - name: LOGDNA_HOSTNAME
-    ini:
-      - section: callback_logdna
-        key: conf_hostname
-  conf_tags:
-    required: false
-    description: Tags.
-    type: string
-    env:
-      - name: LOGDNA_TAGS
-    ini:
-      - section: callback_logdna
-        key: conf_tags
-    default: ansible
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: logdna
+    type: notification
+    short_description: Sends playbook logs to LogDNA
+    description:
+      - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
+    requirements:
+      - LogDNA Python Library (U(https://github.com/logdna/python))
+      - whitelisting in configuration
+    options:
+      conf_key:
+        required: true
+        description: LogDNA Ingestion Key.
+        type: string
+        env:
+          - name: LOGDNA_INGESTION_KEY
+        ini:
+          - section: callback_logdna
+            key: conf_key
+      plugin_ignore_errors:
+        required: false
+        description: Whether to ignore errors on failing or not.
+        type: boolean
+        env:
+          - name: ANSIBLE_IGNORE_ERRORS
+        ini:
+          - section: callback_logdna
+            key: plugin_ignore_errors
+        default: false
+      conf_hostname:
+        required: false
+        description: Alternative Host Name; the current host name by default.
+        type: string
+        env:
+          - name: LOGDNA_HOSTNAME
+        ini:
+          - section: callback_logdna
+            key: conf_hostname
+      conf_tags:
+        required: false
+        description: Tags.
+        type: string
+        env:
+          - name: LOGDNA_TAGS
+        ini:
+          - section: callback_logdna
+            key: conf_tags
+        default: ansible
+'''
 
 import logging
 import json

plugins/callback/logentries.py

@@ -6,77 +6,75 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: logentries
-type: notification
-short_description: Sends events to Logentries
-description:
-  - This callback plugin will generate JSON objects and send them to Logentries using TCP for auditing/debugging purposes.
-requirements:
-  - whitelisting in configuration
-  - certifi (Python library)
-  - flatdict (Python library), if you want to use the O(flatten) option
-options:
-  api:
-    description: URI to the Logentries API.
-    type: str
-    env:
-      - name: LOGENTRIES_API
-    default: data.logentries.com
-    ini:
-      - section: callback_logentries
-        key: api
-  port:
-    description: HTTP port to use when connecting to the API.
-    type: int
-    env:
-      - name: LOGENTRIES_PORT
-    default: 80
-    ini:
-      - section: callback_logentries
-        key: port
-  tls_port:
-    description: Port to use when connecting to the API when TLS is enabled.
-    type: int
-    env:
-      - name: LOGENTRIES_TLS_PORT
-    default: 443
-    ini:
-      - section: callback_logentries
-        key: tls_port
-  token:
-    description: The logentries C(TCP token).
-    type: str
-    env:
-      - name: LOGENTRIES_ANSIBLE_TOKEN
-    required: true
-    ini:
-      - section: callback_logentries
-        key: token
-  use_tls:
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: logentries
+    type: notification
+    short_description: Sends events to Logentries
     description:
-      - Toggle to decide whether to use TLS to encrypt the communications with the API server.
-    env:
-      - name: LOGENTRIES_USE_TLS
-    default: false
-    type: boolean
-    ini:
-      - section: callback_logentries
-        key: use_tls
-  flatten:
-    description: Flatten complex data structures into a single dictionary with complex keys.
-    type: boolean
-    default: false
-    env:
-      - name: LOGENTRIES_FLATTEN
-    ini:
-      - section: callback_logentries
-        key: flatten
-"""
+      - This callback plugin will generate JSON objects and send them to Logentries via TCP for auditing/debugging purposes.
+      - Before 2.4, if you wanted to use an ini configuration, the file must be placed in the same directory as this plugin and named C(logentries.ini).
+      - In 2.4 and above you can just put it in the main Ansible configuration file.
+    requirements:
+      - whitelisting in configuration
+      - certifi (Python library)
+      - flatdict (Python library), if you want to use the O(flatten) option
+    options:
+      api:
+        description: URI to the Logentries API.
+        env:
+          - name: LOGENTRIES_API
+        default: data.logentries.com
+        ini:
+          - section: callback_logentries
+            key: api
+      port:
+        description: HTTP port to use when connecting to the API.
+        env:
+            - name: LOGENTRIES_PORT
+        default: 80
+        ini:
+          - section: callback_logentries
+            key: port
+      tls_port:
+        description: Port to use when connecting to the API when TLS is enabled.
+        env:
+            - name: LOGENTRIES_TLS_PORT
+        default: 443
+        ini:
+          - section: callback_logentries
+            key: tls_port
+      token:
+        description: The logentries C(TCP token).
+        env:
+          - name: LOGENTRIES_ANSIBLE_TOKEN
+        required: true
+        ini:
+          - section: callback_logentries
+            key: token
+      use_tls:
+        description:
+          - Toggle to decide whether to use TLS to encrypt the communications with the API server.
+        env:
+          - name: LOGENTRIES_USE_TLS
+        default: false
+        type: boolean
+        ini:
+          - section: callback_logentries
+            key: use_tls
+      flatten:
+        description: Flatten complex data structures into a single dictionary with complex keys.
+        type: boolean
+        default: false
+        env:
+          - name: LOGENTRIES_FLATTEN
+        ini:
+          - section: callback_logentries
+            key: flatten
+'''
 
-EXAMPLES = r"""
-examples: >-
+EXAMPLES = '''
+examples: >
   To enable, add this to your ansible.cfg file in the defaults block
 
     [defaults]
@@ -95,7 +93,7 @@ examples: >-
     use_tls = true
     token = dd21fc88-f00a-43ff-b977-e3a4233c53af
     flatten = false
-"""
+'''
 
 import os
 import socket

plugins/callback/logstash.py

@@ -7,94 +7,91 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Yevhen Khmelenko (@ujenmr)
-name: logstash
-type: notification
-short_description: Sends events to Logstash
-description:
-  - This callback will report facts and task events to Logstash U(https://www.elastic.co/products/logstash).
-requirements:
-  - whitelisting in configuration
-  - logstash (Python library)
-options:
-  server:
-    description: Address of the Logstash server.
-    type: str
-    env:
-      - name: LOGSTASH_SERVER
-    ini:
-      - section: callback_logstash
-        key: server
-        version_added: 1.0.0
-    default: localhost
-  port:
-    description: Port on which logstash is listening.
-    type: int
-    env:
-      - name: LOGSTASH_PORT
-    ini:
-      - section: callback_logstash
-        key: port
-        version_added: 1.0.0
-    default: 5000
-  type:
-    description: Message type.
-    type: str
-    env:
-      - name: LOGSTASH_TYPE
-    ini:
-      - section: callback_logstash
-        key: type
-        version_added: 1.0.0
-    default: ansible
-  pre_command:
-    description: Executes command before run and its result is added to the C(ansible_pre_command_output) logstash field.
-    type: str
-    version_added: 2.0.0
-    ini:
-      - section: callback_logstash
-        key: pre_command
-    env:
-      - name: LOGSTASH_PRE_COMMAND
-  format_version:
-    description: Logging format.
-    type: str
-    version_added: 2.0.0
-    ini:
-      - section: callback_logstash
-        key: format_version
-    env:
-      - name: LOGSTASH_FORMAT_VERSION
-    default: v1
-    choices:
-      - v1
-      - v2
-"""
+DOCUMENTATION = r'''
+    author: Yevhen Khmelenko (@ujenmr)
+    name: logstash
+    type: notification
+    short_description: Sends events to Logstash
+    description:
+      - This callback will report facts and task events to Logstash U(https://www.elastic.co/products/logstash).
+    requirements:
+      - whitelisting in configuration
+      - logstash (Python library)
+    options:
+      server:
+        description: Address of the Logstash server.
+        env:
+          - name: LOGSTASH_SERVER
+        ini:
+          - section: callback_logstash
+            key: server
+            version_added: 1.0.0
+        default: localhost
+      port:
+        description: Port on which logstash is listening.
+        env:
+            - name: LOGSTASH_PORT
+        ini:
+          - section: callback_logstash
+            key: port
+            version_added: 1.0.0
+        default: 5000
+      type:
+        description: Message type.
+        env:
+          - name: LOGSTASH_TYPE
+        ini:
+          - section: callback_logstash
+            key: type
+            version_added: 1.0.0
+        default: ansible
+      pre_command:
+        description: Executes command before run and its result is added to the C(ansible_pre_command_output) logstash field.
+        version_added: 2.0.0
+        ini:
+          - section: callback_logstash
+            key: pre_command
+        env:
+          - name: LOGSTASH_PRE_COMMAND
+      format_version:
+        description: Logging format.
+        type: str
+        version_added: 2.0.0
+        ini:
+          - section: callback_logstash
+            key: format_version
+        env:
+          - name: LOGSTASH_FORMAT_VERSION
+        default: v1
+        choices:
+          - v1
+          - v2
 
-EXAMPLES = r"""
+'''
+
+EXAMPLES = r'''
 ansible.cfg: |
-  # Enable Callback plugin
-  [defaults]
-      callback_whitelist = community.general.logstash
+    # Enable Callback plugin
+    [defaults]
+        callback_whitelist = community.general.logstash
 
-  [callback_logstash]
-      server = logstash.example.com
-      port = 5000
-      pre_command = git rev-parse HEAD
-      type = ansible
+    [callback_logstash]
+        server = logstash.example.com
+        port = 5000
+        pre_command = git rev-parse HEAD
+        type = ansible
 
-11-input-tcp.conf: |-
-  # Enable Logstash TCP Input
-  input {
-          tcp {
-              port => 5000
-              codec => json
-              add_field => { "[@metadata][beat]" => "notify" }
-              add_field => { "[@metadata][type]" => "ansible" }
-          }
-      }
-"""
+11-input-tcp.conf: |
+    # Enable Logstash TCP Input
+    input {
+            tcp {
+                port => 5000
+                codec => json
+                add_field => { "[@metadata][beat]" => "notify" }
+                add_field => { "[@metadata][type]" => "ansible" }
+            }
+        }
+'''
 
 import os
 import json

plugins/callback/mail.py

@@ -7,80 +7,81 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
+DOCUMENTATION = '''
 name: mail
 type: notification
-short_description: Sends failure events through email
+short_description: Sends failure events via email
 description:
-  - This callback will report failures through email.
+- This callback will report failures via email.
 author:
-  - Dag Wieers (@dagwieers)
+- Dag Wieers (@dagwieers)
 requirements:
-  - whitelisting in configuration
+- whitelisting in configuration
 options:
   mta:
     description:
-      - Mail Transfer Agent, server that accepts SMTP.
+        - Mail Transfer Agent, server that accepts SMTP.
     type: str
     env:
-      - name: SMTPHOST
+        - name: SMTPHOST
     ini:
-      - section: callback_mail
-        key: smtphost
+        - section: callback_mail
+          key: smtphost
     default: localhost
   mtaport:
     description:
-      - Mail Transfer Agent Port.
-      - Port at which server SMTP.
+        - Mail Transfer Agent Port.
+        - Port at which server SMTP.
     type: int
     ini:
-      - section: callback_mail
-        key: smtpport
+        - section: callback_mail
+          key: smtpport
     default: 25
   to:
     description:
-      - Mail recipient.
+        - Mail recipient.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: to
+        - section: callback_mail
+          key: to
     default: [root]
   sender:
     description:
-      - Mail sender.
-      - This is required since community.general 6.0.0.
+        - Mail sender.
+        - This is required since community.general 6.0.0.
     type: str
     required: true
     ini:
-      - section: callback_mail
-        key: sender
+        - section: callback_mail
+          key: sender
   cc:
     description:
-      - CC'd recipients.
+        - CC'd recipients.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: cc
+        - section: callback_mail
+          key: cc
   bcc:
     description:
-      - BCC'd recipients.
+        - BCC'd recipients.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: bcc
+        - section: callback_mail
+          key: bcc
   message_id_domain:
     description:
-      - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
-      - The default is the hostname of the control node.
+        - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
+        - The default is the hostname of the control node.
     type: str
     ini:
-      - section: callback_mail
-        key: message_id_domain
+        - section: callback_mail
+          key: message_id_domain
     version_added: 8.2.0
-"""
+
+'''
 
 import json
 import os

plugins/callback/nrdp.py

@@ -7,65 +7,65 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: nrdp
-type: notification
-author: "Remi VERCHERE (@rverchere)"
-short_description: Post task results to a Nagios server through nrdp
-description:
-  - This callback send playbook result to Nagios.
-  - Nagios shall use NRDP to receive passive events.
-  - The passive check is sent to a dedicated host/service for Ansible.
-options:
-  url:
-    description: URL of the nrdp server.
-    required: true
-    env:
-      - name: NRDP_URL
-    ini:
-      - section: callback_nrdp
-        key: url
-    type: string
-  validate_certs:
-    description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs).
-    env:
-      - name: NRDP_VALIDATE_CERTS
-    ini:
-      - section: callback_nrdp
-        key: validate_nrdp_certs
-      - section: callback_nrdp
-        key: validate_certs
-    type: boolean
-    default: false
-    aliases: [validate_nrdp_certs]
-  token:
-    description: Token to be allowed to push nrdp events.
-    required: true
-    env:
-      - name: NRDP_TOKEN
-    ini:
-      - section: callback_nrdp
-        key: token
-    type: string
-  hostname:
-    description: Hostname where the passive check is linked to.
-    required: true
-    env:
-      - name: NRDP_HOSTNAME
-    ini:
-      - section: callback_nrdp
-        key: hostname
-    type: string
-  servicename:
-    description: Service where the passive check is linked to.
-    required: true
-    env:
-      - name: NRDP_SERVICENAME
-    ini:
-      - section: callback_nrdp
-        key: servicename
-    type: string
-"""
+DOCUMENTATION = '''
+    name: nrdp
+    type: notification
+    author: "Remi VERCHERE (@rverchere)"
+    short_description: Post task results to a Nagios server through nrdp
+    description:
+        - This callback send playbook result to Nagios.
+        - Nagios shall use NRDP to receive passive events.
+        - The passive check is sent to a dedicated host/service for Ansible.
+    options:
+        url:
+            description: URL of the nrdp server.
+            required: true
+            env:
+                - name : NRDP_URL
+            ini:
+                - section: callback_nrdp
+                  key: url
+            type: string
+        validate_certs:
+            description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs.)
+            env:
+                - name: NRDP_VALIDATE_CERTS
+            ini:
+                - section: callback_nrdp
+                  key: validate_nrdp_certs
+                - section: callback_nrdp
+                  key: validate_certs
+            type: boolean
+            default: false
+            aliases: [ validate_nrdp_certs ]
+        token:
+            description: Token to be allowed to push nrdp events.
+            required: true
+            env:
+                - name: NRDP_TOKEN
+            ini:
+                - section: callback_nrdp
+                  key: token
+            type: string
+        hostname:
+            description: Hostname where the passive check is linked to.
+            required: true
+            env:
+                - name : NRDP_HOSTNAME
+            ini:
+                - section: callback_nrdp
+                  key: hostname
+            type: string
+        servicename:
+            description: Service where the passive check is linked to.
+            required: true
+            env:
+                - name : NRDP_SERVICENAME
+            ini:
+                - section: callback_nrdp
+                  key: servicename
+            type: string
+'''
 
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.common.text.converters import to_bytes

plugins/callback/null.py

@@ -7,16 +7,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: 'null'
-type: stdout
-requirements:
-  - set as main display callback
-short_description: do not display stuff to screen
-description:
-  - This callback prevents outputting events to screen.
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: 'null'
+    type: stdout
+    requirements:
+      - set as main display callback
+    short_description: Don't display stuff to screen
+    description:
+        - This callback prevents outputting events to screen.
+'''
 
 from ansible.plugins.callback import CallbackBase
 

plugins/callback/opentelemetry.py

@@ -6,120 +6,93 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-name: opentelemetry
-type: notification
-short_description: Create distributed traces with OpenTelemetry
-version_added: 3.7.0
-description:
-  - This callback creates distributed traces for each Ansible task with OpenTelemetry.
-  - You can configure the OpenTelemetry exporter and SDK with environment variables.
-  - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
-  - See
-    U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
-options:
-  hide_task_arguments:
-    default: false
-    type: bool
+DOCUMENTATION = '''
+    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+    name: opentelemetry
+    type: notification
+    short_description: Create distributed traces with OpenTelemetry
+    version_added: 3.7.0
     description:
-      - Hide the arguments for a task.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-    ini:
-      - section: callback_opentelemetry
-        key: hide_task_arguments
-        version_added: 5.3.0
-  enable_from_environment:
-    type: str
-    description:
-      - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
-      - This is handy when you use Configuration as Code and want to send distributed traces if running in the CI rather when
-        running Ansible locally.
-      - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to true this
-        plugin will be enabled.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
-    ini:
-      - section: callback_opentelemetry
-        key: enable_from_environment
-        version_added: 5.3.0
-    version_added: 3.8.0
-  otel_service_name:
-    default: ansible
-    type: str
-    description:
-      - The service name resource attribute.
-    env:
-      - name: OTEL_SERVICE_NAME
-    ini:
-      - section: callback_opentelemetry
-        key: otel_service_name
-        version_added: 5.3.0
-  traceparent:
-    default: None
-    type: str
-    description:
-      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-    env:
-      - name: TRACEPARENT
-  disable_logs:
-    default: false
-    type: bool
-    description:
-      - Disable sending logs.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
-    ini:
-      - section: callback_opentelemetry
-        key: disable_logs
-    version_added: 5.8.0
-  disable_attributes_in_logs:
-    default: false
-    type: bool
-    description:
-      - Disable populating span attributes to the logs.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
-    ini:
-      - section: callback_opentelemetry
-        key: disable_attributes_in_logs
-    version_added: 7.1.0
-  store_spans_in_file:
-    type: str
-    description:
-      - It stores the exported spans in the given file.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE
-    ini:
-      - section: callback_opentelemetry
-        key: store_spans_in_file
-    version_added: 9.0.0
-  otel_exporter_otlp_traces_protocol:
-    type: str
-    description:
-      - E(OTEL_EXPORTER_OTLP_TRACES_PROTOCOL) represents the the transport protocol for spans.
-      - See
-        U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL).
-    default: grpc
-    choices:
-      - grpc
-      - http/protobuf
-    env:
-      - name: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
-    ini:
-      - section: callback_opentelemetry
-        key: otel_exporter_otlp_traces_protocol
-    version_added: 9.0.0
-requirements:
-  - opentelemetry-api (Python library)
-  - opentelemetry-exporter-otlp (Python library)
-  - opentelemetry-sdk (Python library)
-"""
+      - This callback creates distributed traces for each Ansible task with OpenTelemetry.
+      - You can configure the OpenTelemetry exporter and SDK with environment variables.
+      - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
+      - See U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
+    options:
+      hide_task_arguments:
+        default: false
+        type: bool
+        description:
+          - Hide the arguments for a task.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+        ini:
+          - section: callback_opentelemetry
+            key: hide_task_arguments
+            version_added: 5.3.0
+      enable_from_environment:
+        type: str
+        description:
+          - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
+          - This is handy when you use Configuration as Code and want to send distributed traces
+            if running in the CI rather when running Ansible locally.
+          - For such, it evaluates the given O(enable_from_environment) value as environment variable
+            and if set to true this plugin will be enabled.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
+        ini:
+          - section: callback_opentelemetry
+            key: enable_from_environment
+            version_added: 5.3.0
+        version_added: 3.8.0
+      otel_service_name:
+        default: ansible
+        type: str
+        description:
+          - The service name resource attribute.
+        env:
+          - name: OTEL_SERVICE_NAME
+        ini:
+          - section: callback_opentelemetry
+            key: otel_service_name
+            version_added: 5.3.0
+      traceparent:
+        default: None
+        type: str
+        description:
+          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+        env:
+          - name: TRACEPARENT
+      disable_logs:
+        default: false
+        type: bool
+        description:
+          - Disable sending logs.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
+        ini:
+          - section: callback_opentelemetry
+            key: disable_logs
+        version_added: 5.8.0
+      disable_attributes_in_logs:
+        default: false
+        type: bool
+        description:
+          - Disable populating span attributes to the logs.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
+        ini:
+          - section: callback_opentelemetry
+            key: disable_attributes_in_logs
+        version_added: 7.1.0
+    requirements:
+      - opentelemetry-api (Python library)
+      - opentelemetry-exporter-otlp (Python library)
+      - opentelemetry-sdk (Python library)
+'''
 
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.opentelemetry
@@ -131,10 +104,9 @@ examples: |-
     export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
     export OTEL_SERVICE_NAME=your_service_name
     export ANSIBLE_OPENTELEMETRY_ENABLED=true
-"""
+'''
 
 import getpass
-import json
 import os
 import socket
 import sys
@@ -152,19 +124,15 @@ from ansible.plugins.callback import CallbackBase
 try:
     from opentelemetry import trace
     from opentelemetry.trace import SpanKind
-    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter as GRPCOTLPSpanExporter
-    from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter as HTTPOTLPSpanExporter
+    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
     from opentelemetry.sdk.resources import SERVICE_NAME, Resource
     from opentelemetry.trace.status import Status, StatusCode
     from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
     from opentelemetry.sdk.trace import TracerProvider
     from opentelemetry.sdk.trace.export import (
-        BatchSpanProcessor,
-        SimpleSpanProcessor
-    )
-    from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
-        InMemorySpanExporter
+        BatchSpanProcessor
     )
+
     # Support for opentelemetry-api <= 1.12
     try:
         from opentelemetry.util._time import _time_ns
@@ -287,16 +255,7 @@ class OpenTelemetrySource(object):
         task.dump = dump
         task.add_host(HostData(host_uuid, host_name, status, result))
 
-    def generate_distributed_traces(self,
-                                    otel_service_name,
-                                    ansible_playbook,
-                                    tasks_data,
-                                    status,
-                                    traceparent,
-                                    disable_logs,
-                                    disable_attributes_in_logs,
-                                    otel_exporter_otlp_traces_protocol,
-                                    store_spans_in_file):
+    def generate_distributed_traces(self, otel_service_name, ansible_playbook, tasks_data, status, traceparent, disable_logs, disable_attributes_in_logs):
         """ generate distributed traces from the collected TaskData and HostData """
 
         tasks = []
@@ -312,16 +271,7 @@ class OpenTelemetrySource(object):
             )
         )
 
-        otel_exporter = None
-        if store_spans_in_file:
-            otel_exporter = InMemorySpanExporter()
-            processor = SimpleSpanProcessor(otel_exporter)
-        else:
-            if otel_exporter_otlp_traces_protocol == 'grpc':
-                otel_exporter = GRPCOTLPSpanExporter()
-            else:
-                otel_exporter = HTTPOTLPSpanExporter()
-            processor = BatchSpanProcessor(otel_exporter)
+        processor = BatchSpanProcessor(OTLPSpanExporter())
 
         trace.get_tracer_provider().add_span_processor(processor)
 
@@ -343,8 +293,6 @@ class OpenTelemetrySource(object):
                     with tracer.start_as_current_span(task.name, start_time=task.start, end_on_exit=False) as span:
                         self.update_span_data(task, host_data, span, disable_logs, disable_attributes_in_logs)
 
-        return otel_exporter
-
     def update_span_data(self, task_data, host_data, span, disable_logs, disable_attributes_in_logs):
         """ update the span with the given TaskData and HostData """
 
@@ -516,8 +464,6 @@ class CallbackModule(CallbackBase):
         self.errors = 0
         self.disabled = False
         self.traceparent = False
-        self.store_spans_in_file = False
-        self.otel_exporter_otlp_traces_protocol = None
 
         if OTEL_LIBRARY_IMPORT_ERROR:
             raise_from(
@@ -545,8 +491,6 @@ class CallbackModule(CallbackBase):
 
         self.disable_logs = self.get_option('disable_logs')
 
-        self.store_spans_in_file = self.get_option('store_spans_in_file')
-
         self.otel_service_name = self.get_option('otel_service_name')
 
         if not self.otel_service_name:
@@ -555,8 +499,6 @@ class CallbackModule(CallbackBase):
         # See https://github.com/open-telemetry/opentelemetry-specification/issues/740
         self.traceparent = self.get_option('traceparent')
 
-        self.otel_exporter_otlp_traces_protocol = self.get_option('otel_exporter_otlp_traces_protocol')
-
     def dump_results(self, task, result):
         """ dump the results if disable_logs is not enabled """
         if self.disable_logs:
@@ -652,22 +594,15 @@ class CallbackModule(CallbackBase):
             status = Status(status_code=StatusCode.OK)
         else:
             status = Status(status_code=StatusCode.ERROR)
-        otel_exporter = self.opentelemetry.generate_distributed_traces(
+        self.opentelemetry.generate_distributed_traces(
             self.otel_service_name,
             self.ansible_playbook,
             self.tasks_data,
             status,
             self.traceparent,
             self.disable_logs,
-            self.disable_attributes_in_logs,
-            self.otel_exporter_otlp_traces_protocol,
-            self.store_spans_in_file
+            self.disable_attributes_in_logs
         )
 
-        if self.store_spans_in_file:
-            spans = [json.loads(span.to_json()) for span in otel_exporter.get_finished_spans()]
-            with open(self.store_spans_in_file, "w", encoding="utf-8") as output:
-                json.dump({"spans": spans}, output, indent=4)
-
     def v2_runner_on_async_failed(self, result, **kwargs):
         self.errors += 1

plugins/callback/say.py

@@ -8,17 +8,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: say
-type: notification
-requirements:
-  - whitelisting in configuration
-  - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
-short_description: notify using software speech synthesizer
-description:
-  - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: say
+    type: notification
+    requirements:
+      - whitelisting in configuration
+      - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
+    short_description: notify using software speech synthesizer
+    description:
+      - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
+'''
 
 import platform
 import subprocess

plugins/callback/selective.py

@@ -7,35 +7,35 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: selective
-type: stdout
-requirements:
-  - set as main display callback
-short_description: only print certain tasks
-description:
-  - This callback only prints tasks that have been tagged with C(print_action) or that have failed. This allows operators
-    to focus on the tasks that provide value only.
-  - Tasks that are not printed are placed with a C(.).
-  - If you increase verbosity all tasks are printed.
-options:
-  nocolor:
-    default: false
-    description: This setting allows suppressing colorizing output.
-    env:
-      - name: ANSIBLE_NOCOLOR
-      - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
-    ini:
-      - section: defaults
-        key: nocolor
-    type: boolean
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: selective
+    type: stdout
+    requirements:
+      - set as main display callback
+    short_description: only print certain tasks
+    description:
+      - This callback only prints tasks that have been tagged with C(print_action) or that have failed.
+        This allows operators to focus on the tasks that provide value only.
+      - Tasks that are not printed are placed with a C(.).
+      - If you increase verbosity all tasks are printed.
+    options:
+      nocolor:
+        default: false
+        description: This setting allows suppressing colorizing output.
+        env:
+          - name: ANSIBLE_NOCOLOR
+          - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
+        ini:
+          - section: defaults
+            key: nocolor
+        type: boolean
+'''
 
-EXAMPLES = r"""
-- ansible.builtin.debug: msg="This will not be printed"
-- ansible.builtin.debug: msg="But this will"
-  tags: [print_action]
+EXAMPLES = """
+  - ansible.builtin.debug: msg="This will not be printed"
+  - ansible.builtin.debug: msg="But this will"
+    tags: [print_action]
 """
 
 import difflib

plugins/callback/slack.py

@@ -8,54 +8,51 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: slack
-type: notification
-requirements:
-  - whitelist in configuration
-  - prettytable (python library)
-short_description: Sends play events to a Slack channel
-description:
-  - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
-options:
-  webhook_url:
-    required: true
-    description: Slack Webhook URL.
-    type: str
-    env:
-      - name: SLACK_WEBHOOK_URL
-    ini:
-      - section: callback_slack
-        key: webhook_url
-  channel:
-    default: "#ansible"
-    description: Slack room to post in.
-    type: str
-    env:
-      - name: SLACK_CHANNEL
-    ini:
-      - section: callback_slack
-        key: channel
-  username:
-    description: Username to post as.
-    type: str
-    env:
-      - name: SLACK_USERNAME
-    default: ansible
-    ini:
-      - section: callback_slack
-        key: username
-  validate_certs:
-    description: Validate the SSL certificate of the Slack server for HTTPS URLs.
-    env:
-      - name: SLACK_VALIDATE_CERTS
-    ini:
-      - section: callback_slack
-        key: validate_certs
-    default: true
-    type: bool
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: slack
+    type: notification
+    requirements:
+      - whitelist in configuration
+      - prettytable (python library)
+    short_description: Sends play events to a Slack channel
+    description:
+        - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
+    options:
+      webhook_url:
+        required: true
+        description: Slack Webhook URL.
+        env:
+          - name: SLACK_WEBHOOK_URL
+        ini:
+          - section: callback_slack
+            key: webhook_url
+      channel:
+        default: "#ansible"
+        description: Slack room to post in.
+        env:
+          - name: SLACK_CHANNEL
+        ini:
+          - section: callback_slack
+            key: channel
+      username:
+        description: Username to post as.
+        env:
+          - name: SLACK_USERNAME
+        default: ansible
+        ini:
+          - section: callback_slack
+            key: username
+      validate_certs:
+        description: Validate the SSL certificate of the Slack server for HTTPS URLs.
+        env:
+          - name: SLACK_VALIDATE_CERTS
+        ini:
+          - section: callback_slack
+            key: validate_certs
+        default: true
+        type: bool
+'''
 
 import json
 import os

plugins/callback/splunk.py

@@ -6,73 +6,71 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: splunk
-type: notification
-short_description: Sends task result events to Splunk HTTP Event Collector
-author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
-description:
-  - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
-  - The companion Splunk Monitoring & Diagnostics App is available here U(https://splunkbase.splunk.com/app/4023/).
-  - Credit to "Ryan Currah (@ryancurrah)" for original source upon which this is based.
-requirements:
-  - Whitelisting this callback plugin
-  - 'Create a HTTP Event Collector in Splunk'
-  - 'Define the URL and token in C(ansible.cfg)'
-options:
-  url:
-    description: URL to the Splunk HTTP collector source.
-    type: str
-    env:
-      - name: SPLUNK_URL
-    ini:
-      - section: callback_splunk
-        key: url
-  authtoken:
-    description: Token to authenticate the connection to the Splunk HTTP collector.
-    type: str
-    env:
-      - name: SPLUNK_AUTHTOKEN
-    ini:
-      - section: callback_splunk
-        key: authtoken
-  validate_certs:
-    description: Whether to validate certificates for connections to HEC. It is not recommended to set to V(false) except
-      when you are sure that nobody can intercept the connection between this plugin and HEC, as setting it to V(false) allows
-      man-in-the-middle attacks!
-    env:
-      - name: SPLUNK_VALIDATE_CERTS
-    ini:
-      - section: callback_splunk
-        key: validate_certs
-    type: bool
-    default: true
-    version_added: '1.0.0'
-  include_milliseconds:
-    description: Whether to include milliseconds as part of the generated timestamp field in the event sent to the Splunk
-      HTTP collector.
-    env:
-      - name: SPLUNK_INCLUDE_MILLISECONDS
-    ini:
-      - section: callback_splunk
-        key: include_milliseconds
-    type: bool
-    default: false
-    version_added: 2.0.0
-  batch:
+DOCUMENTATION = '''
+    name: splunk
+    type: notification
+    short_description: Sends task result events to Splunk HTTP Event Collector
+    author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
     description:
-      - Correlation ID which can be set across multiple playbook executions.
-    env:
-      - name: SPLUNK_BATCH
-    ini:
-      - section: callback_splunk
-        key: batch
-    type: str
-    version_added: 3.3.0
-"""
+      - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
+      - The companion Splunk Monitoring & Diagnostics App is available here U(https://splunkbase.splunk.com/app/4023/).
+      - Credit to "Ryan Currah (@ryancurrah)" for original source upon which this is based.
+    requirements:
+      - Whitelisting this callback plugin
+      - 'Create a HTTP Event Collector in Splunk'
+      - 'Define the URL and token in C(ansible.cfg)'
+    options:
+      url:
+        description: URL to the Splunk HTTP collector source.
+        env:
+          - name: SPLUNK_URL
+        ini:
+          - section: callback_splunk
+            key: url
+      authtoken:
+        description: Token to authenticate the connection to the Splunk HTTP collector.
+        env:
+          - name: SPLUNK_AUTHTOKEN
+        ini:
+          - section: callback_splunk
+            key: authtoken
+      validate_certs:
+        description: Whether to validate certificates for connections to HEC. It is not recommended to set to
+                     V(false) except when you are sure that nobody can intercept the connection
+                     between this plugin and HEC, as setting it to V(false) allows man-in-the-middle attacks!
+        env:
+          - name: SPLUNK_VALIDATE_CERTS
+        ini:
+          - section: callback_splunk
+            key: validate_certs
+        type: bool
+        default: true
+        version_added: '1.0.0'
+      include_milliseconds:
+        description: Whether to include milliseconds as part of the generated timestamp field in the event
+                     sent to the Splunk HTTP collector.
+        env:
+          - name: SPLUNK_INCLUDE_MILLISECONDS
+        ini:
+          - section: callback_splunk
+            key: include_milliseconds
+        type: bool
+        default: false
+        version_added: 2.0.0
+      batch:
+        description:
+          - Correlation ID which can be set across multiple playbook executions.
+        env:
+          - name: SPLUNK_BATCH
+        ini:
+          - section: callback_splunk
+            key: batch
+        type: str
+        version_added: 3.3.0
+'''
 
-EXAMPLES = r"""
-examples: >-
+EXAMPLES = '''
+examples: >
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
     callback_whitelist = community.general.splunk
@@ -83,7 +81,7 @@ examples: >-
     [callback_splunk]
     url = http://mysplunkinstance.datapaas.io:8088/services/collector/event
     authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88
-"""
+'''
 
 import json
 import uuid

plugins/callback/sumologic.py

@@ -6,7 +6,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
+DOCUMENTATION = r'''
 name: sumologic
 type: notification
 short_description: Sends task result events to Sumologic
@@ -15,21 +15,20 @@ description:
   - This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source.
 requirements:
   - Whitelisting this callback plugin
-  - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and
-    a custom timestamp locator of V("timestamp": "(.*\)")'
+  - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and a custom timestamp locator
+    of V("timestamp": "(.*\)")'
 options:
   url:
     description: URL to the Sumologic HTTP collector source.
-    type: str
     env:
       - name: SUMOLOGIC_URL
     ini:
       - section: callback_sumologic
         key: url
-"""
+'''
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
     callback_whitelist = community.general.sumologic
@@ -40,7 +39,7 @@ examples: |-
   Set the ansible.cfg variable in the callback_sumologic block
     [callback_sumologic]
     url = https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==
-"""
+'''
 
 import json
 import uuid

plugins/callback/syslog_json.py

@@ -7,54 +7,51 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: syslog_json
-type: notification
-requirements:
-  - whitelist in configuration
-short_description: sends JSON events to syslog
-description:
-  - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
-options:
-  server:
-    description: Syslog server that will receive the event.
-    type: str
-    env:
-      - name: SYSLOG_SERVER
-    default: localhost
-    ini:
-      - section: callback_syslog_json
-        key: syslog_server
-  port:
-    description: Port on which the syslog server is listening.
-    type: int
-    env:
-      - name: SYSLOG_PORT
-    default: 514
-    ini:
-      - section: callback_syslog_json
-        key: syslog_port
-  facility:
-    description: Syslog facility to log as.
-    type: str
-    env:
-      - name: SYSLOG_FACILITY
-    default: user
-    ini:
-      - section: callback_syslog_json
-        key: syslog_facility
-  setup:
-    description: Log setup tasks.
-    env:
-      - name: ANSIBLE_SYSLOG_SETUP
-    type: bool
-    default: true
-    ini:
-      - section: callback_syslog_json
-        key: syslog_setup
-    version_added: 4.5.0
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: syslog_json
+    type: notification
+    requirements:
+      - whitelist in configuration
+    short_description: sends JSON events to syslog
+    description:
+      - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
+    options:
+      server:
+        description: Syslog server that will receive the event.
+        env:
+        - name: SYSLOG_SERVER
+        default: localhost
+        ini:
+          - section: callback_syslog_json
+            key: syslog_server
+      port:
+        description: Port on which the syslog server is listening.
+        env:
+          - name: SYSLOG_PORT
+        default: 514
+        ini:
+          - section: callback_syslog_json
+            key: syslog_port
+      facility:
+        description: Syslog facility to log as.
+        env:
+          - name: SYSLOG_FACILITY
+        default: user
+        ini:
+          - section: callback_syslog_json
+            key: syslog_facility
+      setup:
+        description: Log setup tasks.
+        env:
+          - name: ANSIBLE_SYSLOG_SETUP
+        type: bool
+        default: true
+        ini:
+          - section: callback_syslog_json
+            key: syslog_setup
+        version_added: 4.5.0
+'''
 
 import logging
 import logging.handlers

plugins/callback/timestamp.py

@@ -1,126 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2024, kurokobo <kurokobo@protonmail.com>
-# Copyright (c) 2014, Michael DeHaan <michael.dehaan@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
-
-DOCUMENTATION = r"""
-name: timestamp
-type: stdout
-short_description: Adds simple timestamp for each header
-version_added: 9.0.0
-description:
-  - This callback adds simple timestamp for each header.
-author: kurokobo (@kurokobo)
-options:
-  timezone:
-    description:
-      - Timezone to use for the timestamp in IANA time zone format.
-      - For example V(America/New_York), V(Asia/Tokyo)). Ignored on Python < 3.9.
-    ini:
-      - section: callback_timestamp
-        key: timezone
-    env:
-      - name: ANSIBLE_CALLBACK_TIMESTAMP_TIMEZONE
-    type: string
-  format_string:
-    description:
-      - Format of the timestamp shown to user in 1989 C standard format.
-      - Refer to L(the Python documentation,https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)
-        for the available format codes.
-    ini:
-      - section: callback_timestamp
-        key: format_string
-    env:
-      - name: ANSIBLE_CALLBACK_TIMESTAMP_FORMAT_STRING
-    default: "%H:%M:%S"
-    type: string
-seealso:
-  - plugin: ansible.posix.profile_tasks
-    plugin_type: callback
-    description: >-
-      You can use P(ansible.posix.profile_tasks#callback) callback plugin to time individual tasks and overall execution time
-      with detailed timestamps.
-extends_documentation_fragment:
-  - ansible.builtin.default_callback
-  - ansible.builtin.result_format_callback
-"""
-
-
-from ansible.plugins.callback.default import CallbackModule as Default
-from ansible.utils.display import get_text_width
-from ansible.module_utils.common.text.converters import to_text
-from datetime import datetime
-import types
-import sys
-
-# Store whether the zoneinfo module is available
-_ZONEINFO_AVAILABLE = sys.version_info >= (3, 9)
-
-
-def get_datetime_now(tz):
-    """
-    Returns the current timestamp with the specified timezone
-    """
-    return datetime.now(tz=tz)
-
-
-def banner(self, msg, color=None, cows=True):
-    """
-    Prints a header-looking line with cowsay or stars with length depending on terminal width (3 minimum) with trailing timestamp
-
-    Based on the banner method of Display class from ansible.utils.display
-
-    https://github.com/ansible/ansible/blob/4403519afe89138042108e237aef317fd5f09c33/lib/ansible/utils/display.py#L511
-    """
-    timestamp = get_datetime_now(self.timestamp_tzinfo).strftime(self.timestamp_format_string)
-    timestamp_len = get_text_width(timestamp) + 1  # +1 for leading space
-
-    msg = to_text(msg)
-    if self.b_cowsay and cows:
-        try:
-            self.banner_cowsay("%s @ %s" % (msg, timestamp))
-            return
-        except OSError:
-            self.warning("somebody cleverly deleted cowsay or something during the PB run.  heh.")
-
-    msg = msg.strip()
-    try:
-        star_len = self.columns - get_text_width(msg) - timestamp_len
-    except EnvironmentError:
-        star_len = self.columns - len(msg) - timestamp_len
-    if star_len <= 3:
-        star_len = 3
-    stars = "*" * star_len
-    self.display("\n%s %s %s" % (msg, stars, timestamp), color=color)
-
-
-class CallbackModule(Default):
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = "stdout"
-    CALLBACK_NAME = "community.general.timestamp"
-
-    def __init__(self):
-        super(CallbackModule, self).__init__()
-
-        # Replace the banner method of the display object with the custom one
-        self._display.banner = types.MethodType(banner, self._display)
-
-    def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
-
-        # Store zoneinfo for specified timezone if available
-        tzinfo = None
-        if _ZONEINFO_AVAILABLE and self.get_option("timezone"):
-            from zoneinfo import ZoneInfo
-
-            tzinfo = ZoneInfo(self.get_option("timezone"))
-
-        # Inject options into the display object
-        setattr(self._display, "timestamp_tzinfo", tzinfo)
-        setattr(self._display, "timestamp_format_string", self.get_option("format_string"))

plugins/callback/unixy.py

@@ -8,18 +8,18 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: unixy
-type: stdout
-author: Al Bowles (@akatch)
-short_description: condensed Ansible output
-description:
-  - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout in configuration
-"""
+DOCUMENTATION = '''
+    name: unixy
+    type: stdout
+    author: Al Bowles (@akatch)
+    short_description: condensed Ansible output
+    description:
+      - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout in configuration
+'''
 
 from os.path import basename
 from ansible import constants as C

plugins/callback/yaml.py

@@ -7,35 +7,37 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: yaml
-type: stdout
-short_description: YAML-ized Ansible screen output
-description:
-  - Ansible output that can be quite a bit easier to read than the default JSON formatting.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout in configuration
-seealso:
-  - plugin: ansible.builtin.default
-    plugin_type: callback
-    description: >-
-      There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback) that allows
-      you to change the output format to YAML.
-notes:
-  - With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
-    in P(ansible.builtin.default#callback).
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: yaml
+    type: stdout
+    short_description: YAML-ized Ansible screen output
+    description:
+        - Ansible output that can be quite a bit easier to read than the
+          default JSON formatting.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout in configuration
+    seealso:
+      - plugin: ansible.builtin.default
+        plugin_type: callback
+        description: >
+          There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback)
+          that allows you to change the output format to YAML.
+    notes:
+      - >
+        With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
+        in P(ansible.builtin.default#callback).
+'''
 
 import yaml
 import json
 import re
 import string
-from collections.abc import Mapping, Sequence
 
 from ansible.module_utils.common.text.converters import to_text
+from ansible.parsing.yaml.dumper import AnsibleDumper
 from ansible.plugins.callback import strip_internal_keys, module_response_deepcopy
 from ansible.plugins.callback.default import CallbackModule as Default
 
@@ -49,77 +51,29 @@ def should_use_block(value):
     return False
 
 
-def adjust_str_value_for_block(value):
-    # we care more about readable than accuracy, so...
-    # ...no trailing space
-    value = value.rstrip()
-    # ...and non-printable characters
-    value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
-    # ...tabs prevent blocks from expanding
-    value = value.expandtabs()
-    # ...and odd bits of whitespace
-    value = re.sub(r'[\x0b\x0c\r]', '', value)
-    # ...as does trailing space
-    value = re.sub(r' +\n', '\n', value)
-    return value
-
-
-def create_string_node(tag, value, style, default_style):
-    if style is None:
-        if should_use_block(value):
-            style = '|'
-            value = adjust_str_value_for_block(value)
-        else:
-            style = default_style
-    return yaml.representer.ScalarNode(tag, value, style=style)
-
-
-try:
-    from ansible.module_utils.common.yaml import HAS_LIBYAML
-    # import below was added in https://github.com/ansible/ansible/pull/85039,
-    # first contained in ansible-core 2.19.0b2:
-    from ansible.utils.vars import transform_to_native_types
-
-    if HAS_LIBYAML:
-        from yaml.cyaml import CSafeDumper as SafeDumper
-    else:
-        from yaml import SafeDumper
-
-    class MyDumper(SafeDumper):
-        def represent_scalar(self, tag, value, style=None):
-            """Uses block style for multi-line strings"""
-            node = create_string_node(tag, value, style, self.default_style)
-            if self.alias_key is not None:
-                self.represented_objects[self.alias_key] = node
-            return node
-
-except ImportError:
-    # In case transform_to_native_types cannot be imported, we either have ansible-core 2.19.0b1
-    # (or some random commit from the devel or stable-2.19 branch after merging the DT changes
-    # and before transform_to_native_types was added), or we have a version without the DT changes.
-
-    # Here we simply assume we have a version without the DT changes, and thus can continue as
-    # with ansible-core 2.18 and before.
-
-    transform_to_native_types = None
-
-    from ansible.parsing.yaml.dumper import AnsibleDumper
-
-    class MyDumper(AnsibleDumper):  # pylint: disable=inherit-non-class
-        def represent_scalar(self, tag, value, style=None):
-            """Uses block style for multi-line strings"""
-            node = create_string_node(tag, value, style, self.default_style)
-            if self.alias_key is not None:
-                self.represented_objects[self.alias_key] = node
-            return node
-
-
-def transform_recursively(value, transform):
-    if isinstance(value, Mapping):
-        return {transform(k): transform(v) for k, v in value.items()}
-    if isinstance(value, Sequence) and not isinstance(value, (str, bytes)):
-        return [transform(e) for e in value]
-    return transform(value)
+class MyDumper(AnsibleDumper):
+    def represent_scalar(self, tag, value, style=None):
+        """Uses block style for multi-line strings"""
+        if style is None:
+            if should_use_block(value):
+                style = '|'
+                # we care more about readable than accuracy, so...
+                # ...no trailing space
+                value = value.rstrip()
+                # ...and non-printable characters
+                value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+                # ...tabs prevent blocks from expanding
+                value = value.expandtabs()
+                # ...and odd bits of whitespace
+                value = re.sub(r'[\x0b\x0c\r]', '', value)
+                # ...as does trailing space
+                value = re.sub(r' +\n', '\n', value)
+            else:
+                style = self.default_style
+        node = yaml.representer.ScalarNode(tag, value, style=style)
+        if self.alias_key is not None:
+            self.represented_objects[self.alias_key] = node
+        return node
 
 
 class CallbackModule(Default):
@@ -176,8 +130,6 @@ class CallbackModule(Default):
 
         if abridged_result:
             dumped += '\n'
-            if transform_to_native_types is not None:
-                abridged_result = transform_recursively(abridged_result, lambda v: transform_to_native_types(v, redact=False))
             dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=MyDumper, default_flow_style=False))
 
         # indent by a couple of spaces

plugins/connection/chroot.py

@@ -10,66 +10,76 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
-name: chroot
-short_description: Interact with local chroot
-description:
-  - Run commands or put/fetch files to an existing chroot on the Ansible controller.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
+    name: chroot
+    short_description: Interact with local chroot
     description:
-      - The path of the chroot you want to access.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-  executable:
-    description:
-      - User specified executable shell.
-    type: string
-    ini:
-      - section: defaults
-        key: executable
-    env:
-      - name: ANSIBLE_EXECUTABLE
-    vars:
-      - name: ansible_executable
-    default: /bin/sh
-  chroot_exe:
-    description:
-      - User specified chroot binary.
-    type: string
-    ini:
-      - section: chroot_connection
-        key: exe
-    env:
-      - name: ANSIBLE_CHROOT_EXE
-    vars:
-      - name: ansible_chroot_exe
-    default: chroot
-  disable_root_check:
-    description:
-      - Do not check that the user is not root.
-    ini:
-      - section: chroot_connection
-        key: disable_root_check
-    env:
-      - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
-    vars:
-      - name: ansible_chroot_disable_root_check
-    default: false
-    type: bool
-    version_added: 7.3.0
-"""
+        - Run commands or put/fetch files to an existing chroot on the Ansible controller.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+      executable:
+        description:
+            - User specified executable shell
+        ini:
+          - section: defaults
+            key: executable
+        env:
+          - name: ANSIBLE_EXECUTABLE
+        vars:
+          - name: ansible_executable
+        default: /bin/sh
+      chroot_exe:
+        description:
+            - User specified chroot binary
+        ini:
+          - section: chroot_connection
+            key: exe
+        env:
+          - name: ANSIBLE_CHROOT_EXE
+        vars:
+          - name: ansible_chroot_exe
+        default: chroot
+      disable_root_check:
+        description:
+            - Do not check that the user is not root.
+        ini:
+          - section: chroot_connection
+            key: disable_root_check
+        env:
+          - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
+        vars:
+          - name: ansible_chroot_disable_root_check
+        default: false
+        type: bool
+        version_added: 7.3.0
+'''
 
 EXAMPLES = r"""
+# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
+# sudo -E ansible-playbook ...
+#
+# Static inventory file
+# [chroots]
+# /path/to/debootstrap
+# /path/to/feboostrap
+# /path/to/lxc-image
+# /path/to/chroot
+
+# playbook
+---
 - hosts: chroots
   connection: community.general.chroot
   tasks:
     - debug:
         msg: "This is coming from chroot environment"
+
 """
 
 import os

plugins/connection/funcd.py

@@ -9,24 +9,23 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Michael Scherer (@mscherer) <misc@zarb.org>
-name: funcd
-short_description: Use funcd to connect to target
-description:
-  - This transport permits you to use Ansible over Func.
-  - For people who have already setup func and that wish to play with ansible, this permit to move gradually to ansible without
-    having to redo completely the setup of the network.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: funcd
+    short_description: Use funcd to connect to target
     description:
-      - The path of the chroot you want to access.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-      - name: ansible_func_host
-"""
+        - This transport permits you to use Ansible over Func.
+        - For people who have already setup func and that wish to play with ansible,
+          this permit to move gradually to ansible without having to redo completely the setup of the network.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_func_host
+'''
 
 HAVE_FUNC = False
 try:

plugins/connection/incus.py

@@ -8,47 +8,43 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Stéphane Graber (@stgraber)
-name: incus
-short_description: Run tasks in Incus instances using the Incus CLI
-description:
-  - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
-version_added: "8.2.0"
-options:
-  remote_addr:
+DOCUMENTATION = """
+    author: Stéphane Graber (@stgraber)
+    name: incus
+    short_description: Run tasks in Incus instances via the Incus CLI.
     description:
-      - The instance identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_incus_host
-  executable:
-    description:
-      - The shell to use for execution inside the instance.
-    type: string
-    default: /bin/sh
-    vars:
-      - name: ansible_executable
-      - name: ansible_incus_executable
-  remote:
-    description:
-      - The name of the Incus remote to use (per C(incus remote list)).
-      - Remotes are used to access multiple servers from a single client.
-    type: string
-    default: local
-    vars:
-      - name: ansible_incus_remote
-  project:
-    description:
-      - The name of the Incus project to use (per C(incus project list)).
-      - Projects are used to divide the instances running on a server.
-    type: string
-    default: default
-    vars:
-      - name: ansible_incus_project
+        - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
+    version_added: "8.2.0"
+    options:
+      remote_addr:
+        description:
+            - The instance identifier.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_incus_host
+      executable:
+        description:
+            - The shell to use for execution inside the instance.
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_incus_executable
+      remote:
+        description:
+            - The name of the Incus remote to use (per C(incus remote list)).
+            - Remotes are used to access multiple servers from a single client.
+        default: local
+        vars:
+            - name: ansible_incus_remote
+      project:
+        description:
+            - The name of the Incus project to use (per C(incus project list)).
+            - Projects are used to divide the instances running on a server.
+        default: default
+        vars:
+            - name: ansible_incus_project
 """
 
 import os

plugins/connection/iocage.py

@@ -10,28 +10,26 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
-name: iocage
-short_description: Run tasks in iocage jails
-description:
-  - Run commands or put/fetch files to an existing iocage jail.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
+    name: iocage
+    short_description: Run tasks in iocage jails
     description:
-      - Path to the jail.
-    type: string
-    vars:
-      - name: ansible_host
-      - name: ansible_iocage_host
-  remote_user:
-    description:
-      - User to execute as inside the jail.
-    type: string
-    vars:
-      - name: ansible_user
-      - name: ansible_iocage_user
-"""
+        - Run commands or put/fetch files to an existing iocage jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        vars:
+            - name: ansible_host
+            - name: ansible_iocage_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_iocage_user
+'''
 
 import subprocess
 

plugins/connection/jail.py

@@ -10,30 +10,28 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Ansible Core Team
-name: jail
-short_description: Run tasks in jails
-description:
-  - Run commands or put/fetch files to an existing jail.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Ansible Core Team
+    name: jail
+    short_description: Run tasks in jails
     description:
-      - Path to the jail.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_jail_host
-  remote_user:
-    description:
-      - User to execute as inside the jail.
-    type: string
-    vars:
-      - name: ansible_user
-      - name: ansible_jail_user
-"""
+        - Run commands or put/fetch files to an existing jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_jail_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_jail_user
+'''
 
 import os
 import os.path

plugins/connection/lxc.py

@@ -7,31 +7,29 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
-name: lxc
-short_description: Run tasks in LXC containers using lxc python library
-description:
-  - Run commands or put/fetch files to an existing LXC container using lxc python library.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
+    name: lxc
+    short_description: Run tasks in lxc containers via lxc python library
     description:
-      - Container identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_lxc_host
-  executable:
-    default: /bin/sh
-    description:
-      - Shell executable.
-    type: string
-    vars:
-      - name: ansible_executable
-      - name: ansible_lxc_executable
-"""
+        - Run commands or put/fetch files to an existing lxc container using lxc python library
+    options:
+      remote_addr:
+        description:
+            - Container identifier
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxc_host
+      executable:
+        default: /bin/sh
+        description:
+            - Shell executable
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxc_executable
+'''
 
 import os
 import shutil