Release 10.0.0.

* proxmox inventory: fix urllib3 InsecureRequestWarnings not suppressing when a token is used

* proxmox inventory: add changelog fragment

* proxmox inventory: add forgotten pr number

* Update changelog.

---------

Co-authored-by: Felix Fontein <felix@fontein.de>

.azure-pipelines/README.md

@@ -3,8 +3,7 @@ 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
 -->
-# Running keycloak_authentication module integration test
 
-Run integration tests:
+## Azure Pipelines Configuration
 
-    ansible-test integration -v keycloak_authentication --allow-unsupported --docker fedora35 --docker-network host
+Please see the [Documentation](https://github.com/ansible/community/wiki/Testing:-Azure-Pipelines) for more information.

.azure-pipelines/azure-pipelines.yml

@@ -0,0 +1,428 @@
+---
+# 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-9
+        - stable-8
+  - cron: 0 11 * * 0
+    displayName: Weekly (old stable branches)
+    always: true
+    branches:
+      include:
+        - stable-7
+
+variables:
+  - name: checkoutPath
+    value: ansible_collections/community/general
+  - name: coverageBranches
+    value: main
+  - name: pipelinesCoverage
+    value: coverage
+  - 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_devel
+    displayName: Sanity devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: devel/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+            - test: extra
+  - 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_devel
+    displayName: Units devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: devel/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_devel_extra_vms
+    displayName: Remote devel extra VMs
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/{0}
+          targets:
+            - name: Alpine 3.20
+              test: alpine/3.20
+            # - name: Fedora 40
+            #   test: fedora/40
+            - name: Ubuntu 22.04
+              test: ubuntu/22.04
+            - name: Ubuntu 24.04
+              test: ubuntu/24.04
+          groups:
+            - vm
+  - stage: Remote_devel
+    displayName: Remote devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/{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_18
+    displayName: Remote 2.18
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.18/{0}
+          targets:
+            - name: RHEL 9.4
+              test: rhel/9.4
+          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
+            - name: FreeBSD 14.0
+              test: freebsd/14.0
+          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_devel
+    displayName: Docker devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/linux/{0}
+          targets:
+            - name: Fedora 40
+              test: fedora40
+            - name: Alpine 3.20
+              test: alpine320
+            - 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: 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_devel
+    displayName: Docker (community images) devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/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.12
+          groups:
+            - 1
+            - 2
+            - 3
+
+### Generic
+# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
+#  - stage: Generic_devel
+#    displayName: Generic devel
+#    dependsOn: []
+#    jobs:
+#      - template: templates/matrix.yml
+#        parameters:
+#          nameFormat: Python {0}
+#          testFormat: devel/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_devel
+      - Sanity_2_18
+      - Sanity_2_17
+      - Sanity_2_16
+      - Units_devel
+      - Units_2_18
+      - Units_2_17
+      - Units_2_16
+      - Remote_devel_extra_vms
+      - Remote_devel
+      - Remote_2_18
+      - Remote_2_17
+      - Remote_2_16
+      - Docker_devel
+      - Docker_2_18
+      - Docker_2_17
+      - Docker_2_16
+      - Docker_community_devel
+# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
+#      - Generic_devel
+#      - Generic_2_18
+#      - Generic_2_17
+#      - Generic_2_16
+    jobs:
+      - template: templates/coverage.yml

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

@@ -0,0 +1,24 @@
+#!/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

@@ -0,0 +1,64 @@
+#!/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

@@ -0,0 +1,28 @@
+#!/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

@@ -0,0 +1,105 @@
+#!/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

@@ -0,0 +1,19 @@
+#!/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

@@ -0,0 +1,38 @@
+#!/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

@@ -0,0 +1,29 @@
+#!/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

@@ -0,0 +1,44 @@
+---
+# 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)
+      - task: PublishCodeCoverageResults@1
+        inputs:
+          codeCoverageTool: Cobertura
+          # Azure Pipelines only accepts a single coverage data file.
+          # That means only Python or PowerShell coverage can be uploaded, but not both.
+          # Set the "pipelinesCoverage" variable to determine which type is uploaded.
+          # Use "coverage" for Python and "coverage-powershell" for PowerShell.
+          summaryFileLocation: "$(outputPath)/reports/$(pipelinesCoverage).xml"
+        displayName: Publish to Azure Pipelines
+        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

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

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

@@ -61,7 +61,6 @@ files:
   $callbacks/elastic.py:
     keywords: apm observability
     maintainers: v1v
-  $callbacks/hipchat.py: {}
   $callbacks/jabber.py: {}
   $callbacks/log_plays.py: {}
   $callbacks/loganalytics.py:
@@ -310,6 +309,8 @@ files:
     labels: module_utils
   $module_utils/btrfs.py:
     maintainers: gnfzdz
+  $module_utils/cmd_runner_fmt.py:
+    maintainers: russoz
   $module_utils/cmd_runner.py:
     maintainers: russoz
   $module_utils/deps.py:
@@ -447,7 +448,7 @@ files:
   $modules/bearychat.py:
     maintainers: tonyseek
   $modules/bigpanda.py:
-    ignore: hkariti
+    maintainers: hkariti
   $modules/bitbucket_:
     maintainers: catcombo
   $modules/bootc_manage.py:
@@ -761,6 +762,8 @@ files:
     maintainers: sermilrod
   $modules/jenkins_job_info.py:
     maintainers: stpierre
+  $modules/jenkins_node.py:
+    maintainers: phyrwork
   $modules/jenkins_plugin.py:
     maintainers: jtyr
   $modules/jenkins_script.py:
@@ -797,6 +800,8 @@ files:
     maintainers: fynncfchen johncant
   $modules/keycloak_clientsecret_regenerate.py:
     maintainers: fynncfchen johncant
+  $modules/keycloak_component.py:
+    maintainers: fivetide
   $modules/keycloak_group.py:
     maintainers: adamgoossens
   $modules/keycloak_identity_provider.py:
@@ -829,6 +834,8 @@ files:
     maintainers: ahussey-redhat
   $modules/kibana_plugin.py:
     maintainers: barryib
+  $modules/krb_ticket.py:
+    maintainers: abakanovskii
   $modules/launchd.py:
     maintainers: martinm82
   $modules/layman.py:
@@ -1159,12 +1166,6 @@ files:
     keywords: kvm libvirt proxmox qemu
     labels: rhevm virt
     maintainers: $team_virt TimothyVandenbrande
-  $modules/rhn_channel.py:
-    labels: rhn_channel
-    maintainers: vincentvdk alikins $team_rhn
-  $modules/rhn_register.py:
-    labels: rhn_register
-    maintainers: jlaska $team_rhn
   $modules/rhsm_release.py:
     maintainers: seandst $team_rhsm
   $modules/rhsm_repository.py:
@@ -1359,19 +1360,16 @@ files:
     keywords: sophos utm
     maintainers: $team_e_spirit
   $modules/utm_ca_host_key_cert.py:
-    ignore: stearz
-    maintainers: $team_e_spirit
+    maintainers: stearz
   $modules/utm_ca_host_key_cert_info.py:
-    ignore: stearz
-    maintainers: $team_e_spirit
+    maintainers: stearz
   $modules/utm_network_interface_address.py:
     maintainers: steamx
   $modules/utm_network_interface_address_info.py:
     maintainers: steamx
   $modules/utm_proxy_auth_profile.py:
     keywords: sophos utm
-    ignore: stearz
-    maintainers: $team_e_spirit
+    maintainers: $team_e_spirit stearz
   $modules/utm_proxy_exception.py:
     keywords: sophos utm
     maintainers: $team_e_spirit RickS-C137
@@ -1447,6 +1445,9 @@ files:
     maintainers: $team_suse
   $plugin_utils/ansible_type.py:
     maintainers: vbotka
+  $modules/zypper_repository_info.py:
+    labels: zypper
+    maintainers: $team_suse TobiasZeuch181
   $plugin_utils/keys_filter.py:
     maintainers: vbotka
   $plugin_utils/unsafe.py:
@@ -1555,10 +1556,9 @@ macros:
   team_oracle: manojmeda mross22 nalsaber
   team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
   team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06 jyundt
-  team_rhn: FlossWare alikins barnabycourt vritant
   team_rhsm: cnsnyder ptoscano
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel evrardjp lrupp AnderEnder alxgu andytom sealor
+  team_suse: commel evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab Thulium-Drake Ajpantuso
   team_wdc: mikemoerk

.github/workflows/ansible-test.yml

@@ -0,0 +1,178 @@
+---
+# 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.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
+
+  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.15'
+            python: '2.7'
+          - 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.15
+          - ansible: '2.15'
+            docker: alpine3
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.15'
+            docker: alpine3
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.15'
+            docker: alpine3
+            python: ''
+            target: azp/posix/3/
+          - 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'
+          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 https://github.com/ansible-collections/community.crypto.git ../../community/crypto
+            ;
+            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

@@ -0,0 +1,36 @@
+---
+# 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
+
+    # 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/import-galaxy.yml

@@ -0,0 +1,20 @@
+---
+# 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: import-galaxy
+'on':
+  # Run CI against all pushes (direct commits, also merged PRs) to main, and all Pull Requests
+  push:
+    branches:
+      - main
+      - stable-*
+  pull_request:
+
+jobs:
+  import-galaxy:
+    permissions:
+      contents: read
+    name: Test to import built collection artifact with Galaxy importer
+    uses: ansible-community/github-action-test-galaxy-import/.github/workflows/test-galaxy-import.yml@main

.github/workflows/reuse.yml

@@ -0,0 +1,34 @@
+---
+# 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: Verify REUSE
+
+on:
+  push:
+    branches:
+      - main
+      - stable-*
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+      - stable-*
+  # Run CI once per day (at 07:30 UTC)
+  schedule:
+    - cron: '30 7 * * *'
+
+jobs:
+  check:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha || '' }}
+
+      - name: REUSE Compliance Check
+        uses: fsfe/reuse-action@v4

.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

.reuse/dep5

@@ -0,0 +1,5 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files: changelogs/fragments/*
+Copyright: Ansible Project
+License: GPL-3.0-or-later

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,8 @@ 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)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-10)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![EOL CI](https://github.com/ansible-collections/community.general/workflows/EOL%20CI/badge.svg?event=push)](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 +37,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.15, ansible-core 2.16, ansible-core 2.17, ansible-core 2.18 releases and the current development version of ansible-core. Ansible-core versions before 2.15.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
 
 ## External requirements
 
@@ -118,7 +116,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-10/CHANGELOG.md).
 
 ## Roadmap
 
@@ -137,8 +135,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/stable-10/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/stable-10/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/stable-10/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/).
+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/dep5`. This conforms to the [REUSE specification](https://reuse.software/spec/).

REUSE.toml

@@ -1,11 +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
-
-version = 1
-
-[[annotations]]
-path = "changelogs/fragments/**"
-precedence = "aggregate"
-SPDX-FileCopyrightText = "Ansible Project"
-SPDX-License-Identifier = "GPL-3.0-or-later"

antsibull-nox.toml

@@ -1,68 +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"
-
-[vcs]
-vcs = "git"
-development_branch = "main"
-stable_branches = [ "stable-*" ]
-
-[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"

changelogs/config.yaml

@@ -7,9 +7,9 @@ changelog_filename_template: ../CHANGELOG.rst
 changelog_filename_version_depth: 0
 changes_file: changelog.yaml
 changes_format: combined
-ignore_other_fragment_extensions: true
 keep_fragments: false
 mention_ancestor: true
+flatmap: true
 new_plugins_after_name: removed_features
 notesdir: fragments
 output_formats:
@@ -40,4 +40,3 @@ use_fqcn: true
 add_plugin_period: true
 changelog_nice_yaml: true
 changelog_sort: version
-vcs: auto

docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst

@@ -65,7 +65,7 @@ All three statements are equivalent and give:
 
 .. note:: Be aware that in most cases, filter calls without any argument require ``flatten=true``, otherwise the input is returned as result. The reason for this is, that the input is considered as a variable argument and is wrapped by an additional outer list. ``flatten=true`` ensures that this list is removed before the input is processed by the filter logic.
 
-The filters :ansplugin:`community.general.lists_difference#filter` or :ansplugin:`community.general.lists_symmetric_difference#filter` can be used in the same way as the filters in the examples above. They calculate the difference or the symmetric difference between two or more lists and preserve the item order.
+The filters ansplugin:`community.general.lists_difference#filter` or :ansplugin:`community.general.lists_symmetric_difference#filter` can be used in the same way as the filters in the examples above. They calculate the difference or the symmetric difference between two or more lists and preserve the item order.
 
 For example, the symmetric difference of ``A``, ``B`` and ``C`` may be written as:
 

docs/docsite/rst/filter_guide_selecting_json_data.rst

@@ -124,7 +124,7 @@ To get a hash map with all ports and names of a cluster:
         var: item
       loop: "{{ domain_definition | community.general.json_query(server_name_cluster1_query) }}"
       vars:
-        server_name_cluster1_query: "domain.server[?cluster=='cluster1'].{name: name, port: port}"
+        server_name_cluster1_query: "domain.server[?cluster=='cluster2'].{name: name, port: port}"
 
 To extract ports from all clusters with name starting with 'server1':
 

docs/docsite/rst/guide_deps.rst

@@ -22,7 +22,6 @@ The same example from the Developer Guide would become:
 
     from ansible_collections.community.general.plugins.module_utils import deps
 
-
     with deps.declare("foo"):
         import foo
 

docs/docsite/rst/guide_modulehelper.rst

@@ -75,7 +75,6 @@ section above, but there are more elements that will take part in it.
 
     from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
 
-
     class MyTest(ModuleHelper):
         output_params = ()
         change_params = ()
@@ -257,9 +256,9 @@ With that, MH will automatically generate the diff output for variables that hav
     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)
+    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:

galaxy.yml

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

meta/runtime.yml

@@ -3,7 +3,7 @@
 # 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
 
-requires_ansible: '>=2.13.0'
+requires_ansible: '>=2.15.0'
 action_groups:
   consul:
     - consul_agent_check
@@ -44,7 +44,7 @@ plugin_routing:
         warning_text: Use the 'default' callback plugin with 'display_skipped_hosts
           = no' option.
     hipchat:
-      deprecation:
+      tombstone:
         removal_version: 10.0.0
         warning_text: The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
     osx_say:
@@ -72,7 +72,7 @@ plugin_routing:
       redirect: infoblox.nios_modules.nios_next_network
   modules:
     consul_acl:
-      deprecation:
+      tombstone:
         removal_version: 10.0.0
         warning_text: Use community.general.consul_token and/or community.general.consul_policy instead.
     hipchat:
@@ -184,12 +184,12 @@ plugin_routing:
         removal_version: 9.0.0
         warning_text: This module relied on the deprecated package pyrax.
     rhn_channel:
-      deprecation:
+      tombstone:
         removal_version: 10.0.0
         warning_text: RHN is EOL, please contact the community.general maintainers
           if still using this; see the module documentation for more details.
     rhn_register:
-      deprecation:
+      tombstone:
         removal_version: 10.0.0
         warning_text: RHN is EOL, please contact the community.general maintainers
           if still using this; see the module documentation for more details.

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

@@ -84,9 +84,6 @@ DOCUMENTATION = '''
               - name: ansible_doas_prompt_l10n
             env:
               - name: ANSIBLE_DOAS_PROMPT_L10N
-    notes:
-      - This become plugin does not work when connection pipelining is enabled. With ansible-core 2.19+, using it automatically
-        disables pipelining. On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
 '''
 
 import re
@@ -103,10 +100,6 @@ class BecomeModule(BecomeBase):
     fail = ('Permission denied',)
     missing = ('Authorization required',)
 
-    # See https://github.com/ansible-collections/community.general/issues/9977,
-    # https://github.com/ansible/ansible/pull/78111
-    pipelining = False
-
     def check_password_prompt(self, b_output):
         ''' checks if the expected password prompt exists in b_output '''
 

plugins/become/machinectl.py

@@ -77,8 +77,6 @@ DOCUMENTATION = '''
         if the user is allowed to perform the action (take a look at the examples section).
         If such a rule is not present the plugin only work if it is used in context with the root user,
         because then no further prompt will be shown by machinectl.
-      - This become plugin does not work when connection pipelining is enabled. With ansible-core 2.19+, using it automatically
-        disables pipelining. On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
 '''
 
 EXAMPLES = r'''
@@ -111,10 +109,6 @@ class BecomeModule(BecomeBase):
     success = ('==== AUTHENTICATION COMPLETE ====',)
     require_tty = True  # see https://github.com/ansible-collections/community.general/issues/6932
 
-    # See https://github.com/ansible/ansible/issues/81254,
-    # https://github.com/ansible/ansible/pull/78111
-    pipelining = False
-
     @staticmethod
     def remove_ansi_codes(line):
         return ansi_color_codes.sub(b"", line)

plugins/cache/memcached.py

@@ -7,46 +7,46 @@
 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
+        - 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
+        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
-"""
+        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
+'''
 
 import collections
 import os

plugins/cache/pickle.py

@@ -8,41 +8,41 @@
 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
+        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
+'''
 
 try:
     import cPickle as pickle
@@ -57,7 +57,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,67 @@
 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
+        - 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.
+        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
-"""
+        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
+'''
 
 import re
 import time

plugins/cache/yaml.py

@@ -8,44 +8,45 @@
 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
+        - 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
+        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
-"""
+'''
 
-import os
+
+import codecs
 
 import yaml
 
@@ -60,9 +61,9 @@ class CacheModule(BaseFileCacheModule):
     """
 
     def _load(self, filepath):
-        with open(os.path.abspath(filepath), 'r', encoding='utf-8') as f:
+        with codecs.open(filepath, 'r', encoding='utf-8') as f:
             return AnsibleLoader(f).get_single_data()
 
     def _dump(self, value, filepath):
-        with open(os.path.abspath(filepath), 'w', encoding='utf-8') as f:
+        with codecs.open(filepath, 'w', encoding='utf-8') as f:
             yaml.dump(value, f, Dumper=AnsibleDumper, default_flow_style=False)

plugins/callback/cgroup_memory_recap.py

@@ -7,41 +7,40 @@
 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).
+        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
+'''
 
 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

@@ -1,240 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2014, Matt Martz <matt@sivel.net>
-# Copyright (c) 2017 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 = '''
-    author: Unknown (!UNKNOWN)
-    name: hipchat
-    type: notification
-    requirements:
-      - whitelist in configuration.
-      - prettytable (python lib)
-    short_description: post task events to hipchat
-    description:
-      - This callback plugin sends status updates to a HipChat channel during playbook execution.
-      - Before 2.4 only environment variables were available for configuring this plugin.
-    deprecated:
-      removed_in: 10.0.0
-      why: The hipchat service has been discontinued and the self-hosted variant has been End of Life since 2020.
-      alternative: There is none.
-    options:
-      token:
-        description: HipChat API token for v1 or v2 API.
-        type: str
-        required: true
-        env:
-          - name: HIPCHAT_TOKEN
-        ini:
-          - section: callback_hipchat
-            key: token
-      api_version:
-        description: HipChat API version, v1 or v2.
-        type: str
-        choices:
-          - v1
-          - v2
-        required: false
-        default: v1
-        env:
-          - name: HIPCHAT_API_VERSION
-        ini:
-          - section: callback_hipchat
-            key: api_version
-      room:
-        description: HipChat room to post in.
-        type: str
-        default: ansible
-        env:
-          - name: HIPCHAT_ROOM
-        ini:
-          - section: callback_hipchat
-            key: room
-      from:
-        description:  Name to post as
-        type: str
-        default: ansible
-        env:
-          - name: HIPCHAT_FROM
-        ini:
-          - section: callback_hipchat
-            key: from
-      notify:
-        description: Add notify flag to important messages
-        type: bool
-        default: true
-        env:
-          - name: HIPCHAT_NOTIFY
-        ini:
-          - section: callback_hipchat
-            key: notify
-
-'''
-
-import os
-import json
-
-try:
-    import prettytable
-    HAS_PRETTYTABLE = True
-except ImportError:
-    HAS_PRETTYTABLE = False
-
-from ansible.plugins.callback import CallbackBase
-from ansible.module_utils.six.moves.urllib.parse import urlencode
-from ansible.module_utils.urls import open_url
-
-
-class CallbackModule(CallbackBase):
-    """This is an example ansible callback plugin that sends status
-    updates to a HipChat channel during playbook execution.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.hipchat'
-    CALLBACK_NEEDS_WHITELIST = True
-
-    API_V1_URL = 'https://api.hipchat.com/v1/rooms/message'
-    API_V2_URL = 'https://api.hipchat.com/v2/'
-
-    def __init__(self):
-
-        super(CallbackModule, self).__init__()
-
-        if not HAS_PRETTYTABLE:
-            self.disabled = True
-            self._display.warning('The `prettytable` python module is not installed. '
-                                  'Disabling the HipChat callback plugin.')
-        self.printed_playbook = False
-        self.playbook_name = None
-        self.play = None
-
-    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)
-
-        self.token = self.get_option('token')
-        self.api_version = self.get_option('api_version')
-        self.from_name = self.get_option('from')
-        self.allow_notify = self.get_option('notify')
-        self.room = self.get_option('room')
-
-        if self.token is None:
-            self.disabled = True
-            self._display.warning('HipChat token could not be loaded. The HipChat '
-                                  'token can be provided using the `HIPCHAT_TOKEN` '
-                                  'environment variable.')
-
-        # Pick the request handler.
-        if self.api_version == 'v2':
-            self.send_msg = self.send_msg_v2
-        else:
-            self.send_msg = self.send_msg_v1
-
-    def send_msg_v2(self, msg, msg_format='text', color='yellow', notify=False):
-        """Method for sending a message to HipChat"""
-
-        headers = {'Authorization': 'Bearer %s' % self.token, 'Content-Type': 'application/json'}
-
-        body = {}
-        body['room_id'] = self.room
-        body['from'] = self.from_name[:15]  # max length is 15
-        body['message'] = msg
-        body['message_format'] = msg_format
-        body['color'] = color
-        body['notify'] = self.allow_notify and notify
-
-        data = json.dumps(body)
-        url = self.API_V2_URL + "room/{room_id}/notification".format(room_id=self.room)
-        try:
-            response = open_url(url, data=data, headers=headers, method='POST')
-            return response.read()
-        except Exception as ex:
-            self._display.warning('Could not submit message to hipchat: {0}'.format(ex))
-
-    def send_msg_v1(self, msg, msg_format='text', color='yellow', notify=False):
-        """Method for sending a message to HipChat"""
-
-        params = {}
-        params['room_id'] = self.room
-        params['from'] = self.from_name[:15]  # max length is 15
-        params['message'] = msg
-        params['message_format'] = msg_format
-        params['color'] = color
-        params['notify'] = int(self.allow_notify and notify)
-
-        url = ('%s?auth_token=%s' % (self.API_V1_URL, self.token))
-        try:
-            response = open_url(url, data=urlencode(params))
-            return response.read()
-        except Exception as ex:
-            self._display.warning('Could not submit message to hipchat: {0}'.format(ex))
-
-    def v2_playbook_on_play_start(self, play):
-        """Display Playbook and play start messages"""
-
-        self.play = play
-        name = play.name
-        # This block sends information about a playbook when it starts
-        # The playbook object is not immediately available at
-        # playbook_on_start so we grab it via the play
-        #
-        # Displays info about playbook being started by a person on an
-        # inventory, as well as Tags, Skip Tags and Limits
-        if not self.printed_playbook:
-            self.playbook_name, dummy = os.path.splitext(os.path.basename(self.play.playbook.filename))
-            host_list = self.play.playbook.inventory.host_list
-            inventory = os.path.basename(os.path.realpath(host_list))
-            self.send_msg("%s: Playbook initiated by %s against %s" %
-                          (self.playbook_name,
-                           self.play.playbook.remote_user,
-                           inventory), notify=True)
-            self.printed_playbook = True
-            subset = self.play.playbook.inventory._subset
-            skip_tags = self.play.playbook.skip_tags
-            self.send_msg("%s:\nTags: %s\nSkip Tags: %s\nLimit: %s" %
-                          (self.playbook_name,
-                           ', '.join(self.play.playbook.only_tags),
-                           ', '.join(skip_tags) if skip_tags else None,
-                           ', '.join(subset) if subset else subset))
-
-        # This is where we actually say we are starting a play
-        self.send_msg("%s: Starting play: %s" %
-                      (self.playbook_name, name))
-
-    def playbook_on_stats(self, stats):
-        """Display info about playbook statistics"""
-        hosts = sorted(stats.processed.keys())
-
-        t = prettytable.PrettyTable(['Host', 'Ok', 'Changed', 'Unreachable',
-                                     'Failures'])
-
-        failures = False
-        unreachable = False
-
-        for h in hosts:
-            s = stats.summarize(h)
-
-            if s['failures'] > 0:
-                failures = True
-            if s['unreachable'] > 0:
-                unreachable = True
-
-            t.add_row([h] + [s[k] for k in ['ok', 'changed', 'unreachable',
-                                            'failures']])
-
-        self.send_msg("%s: Playbook complete" % self.playbook_name,
-                      notify=True)
-
-        if failures or unreachable:
-            color = 'red'
-            self.send_msg("%s: Failures detected" % self.playbook_name,
-                          color=color, notify=True)
-        else:
-            color = 'green'
-
-        self.send_msg("/code %s:\n%s" % (self.playbook_name, t), color=color)

plugins/callback/jabber.py

@@ -7,42 +7,42 @@
 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
+        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
+'''
 
 import os
 

plugins/callback/log_plays.py

@@ -7,27 +7,27 @@
 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.
+        type: str
+        env:
+          - name: ANSIBLE_LOG_FOLDER
+        ini:
+          - section: callback_log_plays
+            key: log_folder
+'''
 
 import os
 import time

plugins/callback/loganalytics.py

@@ -6,41 +6,41 @@
 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.
+        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
+'''
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Whitelist the plugin in ansible.cfg:
     [defaults]
     callback_whitelist = community.general.loganalytics
@@ -51,7 +51,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,79 @@
 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.
+        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:
+        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 +97,7 @@ examples: >-
     use_tls = true
     token = dd21fc88-f00a-43ff-b977-e3a4233c53af
     flatten = false
-"""
+'''
 
 import os
 import socket

plugins/callback/logstash.py

@@ -7,94 +7,95 @@
 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.
+        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
 
-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,119 @@
 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
+      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)
+'''
 
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.opentelemetry
@@ -131,7 +130,7 @@ 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

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,54 @@
 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.
+        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
+'''
 
 import json
 import os

plugins/callback/splunk.py

@@ -6,73 +6,73 @@
 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.
+        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:
+        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 +83,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,8 +15,8 @@ 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.
@@ -26,10 +26,10 @@ options:
     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 +40,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,54 @@
 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.
+        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
+'''
 
 import logging
 import logging.handlers

plugins/callback/timestamp.py

@@ -10,45 +10,46 @@ 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
+  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 C(America/New_York), C(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
 """
 
 

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,79 @@
 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.
+        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
+'''
 
 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,24 @@
 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.
+        type: string
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_func_host
+'''
 
 HAVE_FUNC = False
 try:

plugins/connection/incus.py

@@ -8,47 +8,47 @@
 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.
+        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
 """
 
 import os

plugins/connection/iocage.py

@@ -10,28 +10,28 @@
 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
+        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
+'''
 
 import subprocess
 

plugins/connection/jail.py

@@ -10,30 +10,30 @@
 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
+        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
+'''
 
 import os
 import os.path

plugins/connection/lxc.py

@@ -7,31 +7,31 @@
 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
+        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
+'''
 
 import os
 import shutil

plugins/connection/lxd.py

@@ -7,48 +7,48 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Matt Clay (@mattclay) <matt@mystile.com>
-name: lxd
-short_description: Run tasks in LXD instances using C(lxc) CLI
-description:
-  - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Matt Clay (@mattclay) <matt@mystile.com>
+    name: lxd
+    short_description: Run tasks in LXD instances via C(lxc) CLI
     description:
-      - Instance (container/VM) identifier.
-      - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.)) is
-        used as the instance identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_lxd_host
-  executable:
-    description:
-      - Shell to use for execution inside instance.
-    type: string
-    default: /bin/sh
-    vars:
-      - name: ansible_executable
-      - name: ansible_lxd_executable
-  remote:
-    description:
-      - Name of the LXD remote to use.
-    type: string
-    default: local
-    vars:
-      - name: ansible_lxd_remote
-    version_added: 2.0.0
-  project:
-    description:
-      - Name of the LXD project to use.
-    type: string
-    vars:
-      - name: ansible_lxd_project
-    version_added: 2.0.0
-"""
+        - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
+    options:
+      remote_addr:
+        description:
+            - Instance (container/VM) identifier.
+            - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.))
+              is used as the instance identifier.
+        type: string
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxd_host
+      executable:
+        description:
+            - Shell to use for execution inside instance.
+        type: string
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxd_executable
+      remote:
+        description:
+            - Name of the LXD remote to use.
+        type: string
+        default: local
+        vars:
+            - name: ansible_lxd_remote
+        version_added: 2.0.0
+      project:
+        description:
+            - Name of the LXD project to use.
+        type: string
+        vars:
+            - name: ansible_lxd_project
+        version_added: 2.0.0
+'''
 
 import os
 from subprocess import Popen, PIPE

plugins/connection/qubes.py

@@ -12,33 +12,34 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 
-DOCUMENTATION = r"""
-name: qubes
-short_description: Interact with an existing QubesOS AppVM
+DOCUMENTATION = '''
+    name: qubes
+    short_description: Interact with an existing QubesOS AppVM
 
-description:
-  - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
-author: Kushal Das (@kushaldas)
-
-
-options:
-  remote_addr:
     description:
-      - VM name.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-  remote_user:
-    description:
-      - The user to execute as inside the VM.
-    type: string
-    default: The I(user) account as default in Qubes OS.
-    vars:
-      - name: ansible_user
+        - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
+
+    author: Kushal Das (@kushaldas)
+
+
+    options:
+      remote_addr:
+        description:
+            - VM name.
+        type: string
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+      remote_user:
+        description:
+            - The user to execute as inside the VM.
+        type: string
+        default: The I(user) account as default in Qubes OS.
+        vars:
+            - name: ansible_user
 #        keyword:
 #            - name: hosts
-"""
+'''
 
 import subprocess
 
@@ -117,7 +118,7 @@ class Connection(ConnectionBase):
 
         rc, stdout, stderr = self._qubes(cmd)
 
-        display.vvvvv("STDOUT %r STDERR %r" % (stdout, stderr))
+        display.vvvvv("STDOUT %r STDERR %r" % (stderr, stderr))
         return rc, stdout, stderr
 
     def put_file(self, in_path, out_path):

plugins/connection/saltstack.py

@@ -10,13 +10,13 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Michael Scherer (@mscherer) <misc@zarb.org>
-name: saltstack
-short_description: Allow ansible to piggyback on salt minions
-description:
-  - This allows you to use existing Saltstack infrastructure to connect to targets.
-"""
+DOCUMENTATION = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: saltstack
+    short_description: Allow ansible to piggyback on salt minions
+    description:
+        - This allows you to use existing Saltstack infrastructure to connect to targets.
+'''
 
 import os
 import base64

plugins/connection/zone.py

@@ -11,22 +11,22 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Ansible Core Team
-name: zone
-short_description: Run tasks in a zone instance
-description:
-  - Run commands or put/fetch files to an existing zone.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Ansible Core Team
+    name: zone
+    short_description: Run tasks in a zone instance
     description:
-      - Zone identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-      - name: ansible_zone_host
-"""
+        - Run commands or put/fetch files to an existing zone.
+    options:
+      remote_addr:
+        description:
+            - Zone identifier
+        type: string
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_zone_host
+'''
 
 import os
 import os.path

plugins/doc_fragments/onepassword.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 requirements:
   - See U(https://support.1password.com/command-line/)
 options:
@@ -18,8 +18,7 @@ options:
     aliases: ['vault_password']
     type: str
   section:
-    description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from
-      any section.
+    description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from any section.
   domain:
     description: Domain of 1Password.
     default: '1password.com'
@@ -56,25 +55,25 @@ options:
     env:
       - name: OP_CONNECT_TOKEN
     version_added: 8.1.0
-"""
+'''
 
-    LOOKUP = r"""
+    LOOKUP = r'''
 options:
   service_account_token:
     env:
       - name: OP_SERVICE_ACCOUNT_TOKEN
         version_added: 8.2.0
 notes:
-  - This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign
-    in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the O(master_password)
-    is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used
-    by C(op).
+  - This lookup will use an existing 1Password session if one exists. If not, and you have already
+    performed an initial sign in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the
+    O(master_password) is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op).
   - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password).
   - Can target a specific account by providing the O(account_id).
-  - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal
-    credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or
-    greater in strength to the 1Password master password.
-  - This lookup stores potentially sensitive data from 1Password as Ansible facts. Facts are subject to caching if enabled,
-    which means this data could be stored in clear text on disk or in a database.
+  - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials
+    needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength
+    to the 1Password master password.
+  - This lookup stores potentially sensitive data from 1Password as Ansible facts.
+    Facts are subject to caching if enabled, which means this data could be stored in clear text
+    on disk or in a database.
   - Tested with C(op) version 2.7.2.
-"""
+'''

plugins/doc_fragments/oneview.py

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

plugins/doc_fragments/online.py

@@ -10,26 +10,26 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   api_token:
     description:
       - Online OAuth token.
     type: str
     required: true
-    aliases: [oauth_token]
+    aliases: [ oauth_token ]
   api_url:
     description:
       - Online API URL.
     type: str
     default: 'https://api.online.net'
-    aliases: [base_url]
+    aliases: [ base_url ]
   api_timeout:
     description:
       - HTTP timeout to Online API in seconds.
     type: int
     default: 30
-    aliases: [timeout]
+    aliases: [ timeout ]
   validate_certs:
     description:
       - Validate SSL certs of the Online API.
@@ -37,7 +37,9 @@ options:
     default: true
 notes:
   - Also see the API documentation on U(https://console.online.net/en/api/).
-  - If O(api_token) is not set within the module, the following environment variables can be used in decreasing order of precedence
+  - If O(api_token) is not set within the module, the following
+    environment variables can be used in decreasing order of precedence
     E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN).
-  - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL) environment variable.
-"""
+  - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL)
+    environment variable.
+'''

plugins/doc_fragments/opennebula.py

@@ -10,36 +10,36 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # OpenNebula common documentation
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
-  api_url:
-    description:
-      - The ENDPOINT URL of the XMLRPC server.
-      - If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
-    type: str
-    aliases:
-      - api_endpoint
-  api_username:
-    description:
-      - The name of the user for XMLRPC authentication.
-      - If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
-    type: str
-  api_password:
-    description:
-      - The password or token for XMLRPC authentication.
-      - If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
-    type: str
-    aliases:
-      - api_token
-  validate_certs:
-    description:
-      - Whether to validate the TLS/SSL certificates or not.
-      - This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
-    type: bool
-    default: true
-  wait_timeout:
-    description:
-      - Time to wait for the desired state to be reached before timeout, in seconds.
-    type: int
-    default: 300
-"""
+    api_url:
+        description:
+            - The ENDPOINT URL of the XMLRPC server.
+            - If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
+        type: str
+        aliases:
+            - api_endpoint
+    api_username:
+        description:
+            - The name of the user for XMLRPC authentication.
+            - If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
+        type: str
+    api_password:
+        description:
+            - The password or token for XMLRPC authentication.
+            - If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
+        type: str
+        aliases:
+            - api_token
+    validate_certs:
+        description:
+            - Whether to validate the TLS/SSL certificates or not.
+            - This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
+        type: bool
+        default: true
+    wait_timeout:
+        description:
+            - Time to wait for the desired state to be reached before timeout, in seconds.
+        type: int
+        default: 300
+'''

plugins/doc_fragments/openswitch.py

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

plugins/doc_fragments/oracle.py

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

plugins/doc_fragments/oracle_creatable_resource.py

@@ -8,18 +8,19 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
-options:
-  force_create:
-    description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation,
-      and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of the
-      resource, even if it already exists. This option is mutually exclusive with O(key_by).
-    default: false
-    type: bool
-  key_by:
-    description: The list of comma-separated attributes of this resource which should be used to uniquely identify an instance
-      of the resource. By default, all the attributes of a resource except O(freeform_tags) are used to uniquely identify
-      a resource.
-    type: list
-    elements: str
-"""
+    DOCUMENTATION = """
+    options:
+        force_create:
+            description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an
+                         idempotent operation, and doesn't create the resource if it already exists. Setting this option
+                         to true, forcefully creates a copy of the resource, even if it already exists.This option is
+                         mutually exclusive with O(key_by).
+            default: false
+            type: bool
+        key_by:
+            description: The list of comma-separated attributes of this resource which should be used to uniquely
+                         identify an instance of the resource. By default, all the attributes of a resource except
+                         O(freeform_tags) are used to uniquely identify a resource.
+            type: list
+            elements: str
+    """

plugins/doc_fragments/oracle_display_name_option.py

@@ -8,10 +8,10 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
-options:
-  display_name:
-    description: Use O(display_name) along with the other options to return only resources that match the given display name
-      exactly.
-    type: str
-"""
+    DOCUMENTATION = """
+    options:
+        display_name:
+            description: Use O(display_name) along with the other options to return only resources that match the given
+                         display name exactly.
+            type: str
+    """

plugins/doc_fragments/oracle_name_option.py

@@ -8,9 +8,10 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
-options:
-  name:
-    description: Use O(name) along with the other options to return only resources that match the given name exactly.
-    type: str
-"""
+    DOCUMENTATION = """
+    options:
+        name:
+            description: Use O(name) along with the other options to return only resources that match the given name
+                         exactly.
+            type: str
+    """

plugins/doc_fragments/oracle_tags.py

@@ -8,14 +8,16 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
-options:
-  defined_tags:
-    description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see
-      U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
-    type: dict
-  freeform_tags:
-    description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
-      For more information, see U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
-    type: dict
-"""
+    DOCUMENTATION = """
+    options:
+        defined_tags:
+            description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
+                         information, see
+                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+            type: dict
+        freeform_tags:
+            description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name,
+                         type, or namespace. For more information, see
+                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+            type: dict
+    """

plugins/doc_fragments/oracle_wait_options.py

@@ -8,19 +8,20 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
-options:
-  wait:
-    description: Whether to wait for create or delete operation to complete.
-    default: true
-    type: bool
-  wait_timeout:
-    description: Time, in seconds, to wait when O(wait=true).
-    default: 1200
-    type: int
-  wait_until:
-    description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default, when O(wait=true),
-      we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during
-      create operation and to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
-    type: str
-"""
+    DOCUMENTATION = """
+    options:
+        wait:
+            description: Whether to wait for create or delete operation to complete.
+            default: true
+            type: bool
+        wait_timeout:
+            description: Time, in seconds, to wait when O(wait=true).
+            default: 1200
+            type: int
+        wait_until:
+            description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default,
+                         when O(wait=true), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
+                         RUNNING applicable lifecycle state during create operation and to get into DELETED/DETACHED/
+                         TERMINATED lifecycle state during delete operation.
+            type: str
+    """

plugins/doc_fragments/pipx.py

@@ -9,32 +9,34 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   global:
     description:
       - The module will pass the C(--global) argument to C(pipx), to execute actions in global scope.
       - The C(--global) is only available in C(pipx>=1.6.0), so make sure to have a compatible version when using this option.
-        Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version
-        or newer.
+          Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version or newer.
     type: bool
     default: false
   executable:
     description:
       - Path to the C(pipx) installed in the system.
-      - If not specified, the module will use C(python -m pipx) to run the tool, using the same Python interpreter as ansible
-        itself.
+      - >
+        If not specified, the module will use C(python -m pipx) to run the tool,
+        using the same Python interpreter as ansible itself.
     type: path
 notes:
-  - This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require
-    C(pipx>=1.7.0).
-  - Please note that C(pipx) requires Python 3.6 or above.
-  - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
-  - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
-  - This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed
-    using the R(environment Ansible keyword, playbooks_environment).
+    - This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require C(pipx>=1.7.0).
+    - Please note that C(pipx) requires Python 3.6 or above.
+    - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
+    - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
+    - >
+      This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR)
+      passed using the R(environment Ansible keyword, playbooks_environment).
+
 seealso:
   - name: C(pipx) command manual page
     description: Manual page for the command.
     link: https://pipx.pypa.io/latest/docs/
-"""
+
+'''

plugins/doc_fragments/pritunl.py

@@ -13,28 +13,32 @@ class ModuleDocFragment(object):
 
     DOCUMENTATION = r"""
 options:
-  pritunl_url:
-    type: str
-    required: true
-    description:
-      - URL and port of the Pritunl server on which the API is enabled.
-  pritunl_api_token:
-    type: str
-    required: true
-    description:
-      - API Token of a Pritunl admin user.
-      - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
-  pritunl_api_secret:
-    type: str
-    required: true
-    description:
-      - API Secret found in Administrators > USERNAME > API Secret.
-  validate_certs:
-    type: bool
-    required: false
-    default: true
-    description:
-      - If certificates should be validated or not.
-      - This should never be set to V(false), except if you are very sure that your connection to the server can not be subject
-        to a Man In The Middle attack.
+    pritunl_url:
+        type: str
+        required: true
+        description:
+        - URL and port of the Pritunl server on which the API is enabled.
+
+    pritunl_api_token:
+        type: str
+        required: true
+        description:
+        - API Token of a Pritunl admin user.
+        - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
+
+    pritunl_api_secret:
+        type: str
+        required: true
+        description:
+        - API Secret found in Administrators > USERNAME > API Secret.
+
+    validate_certs:
+        type: bool
+        required: false
+        default: true
+        description:
+        - If certificates should be validated or not.
+        - This should never be set to V(false), except if you are very sure that
+          your connection to the server can not be subject to a Man In The Middle
+          attack.
 """

plugins/doc_fragments/proxmox.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for Proxmox VE modules
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   api_host:
     description:
@@ -51,10 +51,10 @@ options:
       - This should only be used on personally controlled sites using self-signed certificates.
     type: bool
     default: false
-requirements: ["proxmoxer", "requests"]
-"""
+requirements: [ "proxmoxer", "requests" ]
+'''
 
-    SELECTION = r"""
+    SELECTION = r'''
 options:
   vmid:
     description:
@@ -71,7 +71,7 @@ options:
     description:
       - Add the new VM to the specified pool.
     type: str
-"""
+'''
 
     ACTIONGROUP_PROXMOX = r"""
 options: {}

plugins/doc_fragments/purestorage.py

@@ -11,17 +11,17 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard Pure Storage documentation fragment
-    DOCUMENTATION = r"""
-options: {}
-# See separate platform section for more details
+    DOCUMENTATION = r'''
+options:
+  - See separate platform section for more details
 requirements:
   - See separate platform section for more details
 notes:
-  - 'Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade.'
-"""
+  - Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade
+'''
 
     # Documentation fragment for FlashBlade
-    FB = r"""
+    FB = r'''
 options:
   fb_url:
     description:
@@ -33,14 +33,14 @@ options:
     type: str
 notes:
   - This module requires the C(purity_fb) Python library.
-  - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables if O(fb_url) and O(api_token) arguments are not passed
-    to the module directly.
+  - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables
+    if O(fb_url) and O(api_token) arguments are not passed to the module directly.
 requirements:
   - purity_fb >= 1.1
-"""
+'''
 
     # Documentation fragment for FlashArray
-    FA = r"""
+    FA = r'''
 options:
   fa_url:
     description:
@@ -54,8 +54,8 @@ options:
     required: true
 notes:
   - This module requires the C(purestorage) Python library.
-  - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables if O(fa_url) and O(api_token) arguments are not passed
-    to the module directly.
+  - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables
+    if O(fa_url) and O(api_token) arguments are not passed to the module directly.
 requirements:
   - purestorage
-"""
+'''

plugins/doc_fragments/redis.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for Redis modules
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   login_host:
     description:
@@ -40,12 +40,14 @@ options:
   validate_certs:
     description:
       - Specify whether or not to validate TLS certificates.
-      - This should only be turned off for personally controlled sites or with C(localhost) as target.
+      - This should only be turned off for personally controlled sites or with
+        C(localhost) as target.
     type: bool
     default: true
   ca_certs:
     description:
-      - Path to root certificates file. If not set and O(tls) is set to V(true), certifi ca-certificates will be used.
+      - Path to root certificates file. If not set and O(tls) is
+        set to V(true), certifi ca-certificates will be used.
     type: str
   client_cert_file:
     description:
@@ -57,9 +59,10 @@ options:
       - Path to the client private key file.
     type: str
     version_added: 9.3.0
-requirements: ["redis", "certifi"]
+requirements: [ "redis", "certifi" ]
 
 notes:
-  - Requires the C(redis) Python package on the remote host. You can install it with pip (C(pip install redis)) or with a
-    package manager. Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
-"""
+  - Requires the C(redis) Python package on the remote host. You can
+    install it with pip (C(pip install redis)) or with a package manager.
+    Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
+'''

plugins/doc_fragments/rundeck.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   url:
     type: str
@@ -29,4 +29,4 @@ options:
     description:
       - Rundeck User API Token.
     required: true
-"""
+'''

plugins/doc_fragments/scaleway.py

@@ -11,29 +11,29 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   api_token:
     description:
       - Scaleway OAuth token.
     type: str
     required: true
-    aliases: [oauth_token]
+    aliases: [ oauth_token ]
   api_url:
     description:
       - Scaleway API URL.
     type: str
     default: https://api.scaleway.com
-    aliases: [base_url]
+    aliases: [ base_url ]
   api_timeout:
     description:
       - HTTP timeout to Scaleway API in seconds.
     type: int
     default: 30
-    aliases: [timeout]
+    aliases: [ timeout ]
   query_parameters:
     description:
-      - List of parameters passed to the query string.
+    - List of parameters passed to the query string.
     type: dict
     default: {}
   validate_certs:
@@ -43,7 +43,9 @@ options:
     default: true
 notes:
   - Also see the API documentation on U(https://developer.scaleway.com/).
-  - If O(api_token) is not set within the module, the following environment variables can be used in decreasing order of precedence
+  - If O(api_token) is not set within the module, the following
+    environment variables can be used in decreasing order of precedence
     E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN).
-  - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL) environment variable.
-"""
+  - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL)
+    environment variable.
+'''

plugins/doc_fragments/scaleway_waitable_resource.py

@@ -11,23 +11,23 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   wait:
     description:
-      - Wait for the resource to reach its desired state before returning.
+    - Wait for the resource to reach its desired state before returning.
     type: bool
     default: true
   wait_timeout:
     type: int
     description:
-      - Time to wait for the resource to reach the expected state.
+    - Time to wait for the resource to reach the expected state.
     required: false
     default: 300
   wait_sleep_time:
     type: int
     description:
-      - Time to wait before every attempt to check the state of the resource.
+    - Time to wait before every attempt to check the state of the resource.
     required: false
     default: 3
-"""
+'''

plugins/doc_fragments/utm.py

@@ -9,48 +9,49 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
-  headers:
-    description:
-      - A dictionary of additional headers to be sent to POST and PUT requests.
-      - Is needed for some modules.
-    type: dict
-    required: false
-    default: {}
-  utm_host:
-    description:
-      - The REST Endpoint of the Sophos UTM.
-    type: str
-    required: true
-  utm_port:
-    description:
-      - The port of the REST interface.
-    type: int
-    default: 4444
-  utm_token:
-    description:
-      - The token used to identify at the REST-API.
-      - See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
-    type: str
-    required: true
-  utm_protocol:
-    description:
-      - The protocol of the REST Endpoint.
-    choices: [http, https]
-    type: str
-    default: https
-  validate_certs:
-    description:
-      - Whether the REST interface's SSL certificate should be verified or not.
-    type: bool
-    default: true
-  state:
-    description:
-      - The desired state of the object.
-      - V(present) will create or update an object.
-      - V(absent) will delete an object if it was present.
-    type: str
-    choices: [absent, present]
-    default: present
-"""
+    headers:
+        description:
+          - A dictionary of additional headers to be sent to POST and PUT requests.
+          - Is needed for some modules.
+        type: dict
+        required: false
+        default: {}
+    utm_host:
+        description:
+          - The REST Endpoint of the Sophos UTM.
+        type: str
+        required: true
+    utm_port:
+        description:
+          - The port of the REST interface.
+        type: int
+        default: 4444
+    utm_token:
+        description:
+          - "The token used to identify at the REST-API. See
+            U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en),
+            Chapter 2.4.2."
+        type: str
+        required: true
+    utm_protocol:
+        description:
+          - The protocol of the REST Endpoint.
+        choices: [ http, https ]
+        type: str
+        default: https
+    validate_certs:
+        description:
+          - Whether the REST interface's ssl certificate should be verified or not.
+        type: bool
+        default: true
+    state:
+        description:
+          - The desired state of the object.
+          - V(present) will create or update an object.
+          - V(absent) will delete an object if it was present.
+        type: str
+        choices: [ absent, present ]
+        default: present
+'''

plugins/doc_fragments/vexata.py

@@ -10,14 +10,14 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r"""
-options: {}
-# See respective platform section for more details
+    DOCUMENTATION = r'''
+options:
+    - See respective platform section for more details
 requirements:
-  - See respective platform section for more details
+    - See respective platform section for more details
 notes:
-  - Ansible modules are available for Vexata VX100 arrays.
-"""
+    - Ansible modules are available for Vexata VX100 arrays.
+'''
 
     # Documentation fragment for Vexata VX100 series
     VX100 = r'''

plugins/doc_fragments/xenserver.py

@@ -10,33 +10,32 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for XenServer modules
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   hostname:
     description:
-      - The hostname or IP address of the XenServer host or XenServer pool master.
-      - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
+    - The hostname or IP address of the XenServer host or XenServer pool master.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
     type: str
     default: localhost
-    aliases: [host, pool]
+    aliases: [ host, pool ]
   username:
     description:
-      - The username to use for connecting to XenServer.
-      - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
+    - The username to use for connecting to XenServer.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
     type: str
     default: root
-    aliases: [admin, user]
+    aliases: [ admin, user ]
   password:
     description:
-      - The password to use for connecting to XenServer.
-      - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
+    - The password to use for connecting to XenServer.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
     type: str
-    aliases: [pass, pwd]
+    aliases: [ pass, pwd ]
   validate_certs:
     description:
-      - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-      - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used
-        instead.
+    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
+    - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used instead.
     type: bool
     default: true
-"""
+'''

plugins/filter/dict.py

@@ -57,8 +57,8 @@ EXAMPLES = '''
 
 RETURN = '''
   _value:
-    description: A dictionary with the provided key-value pairs.
-    type: dictionary
+    description: The dictionary having the provided key-value pairs.
+    type: boolean
 '''