Release 1.2.0.

* Update BOTMETA.yml

* Update .github/BOTMETA.yml

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

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit ee34fdb4ac)

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

.azure-pipelines/README.md

@@ -1,9 +0,0 @@
-<!--
-Copyright (c) Ansible Project
-GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-SPDX-License-Identifier: GPL-3.0-or-later
--->
-
-## Azure Pipelines Configuration
-
-Please see the [Documentation](https://github.com/ansible/community/wiki/Testing:-Azure-Pipelines) for more information.

.azure-pipelines/azure-pipelines.yml

@@ -1,427 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-trigger:
-  batch: true
-  branches:
-    include:
-      - main
-      - stable-*
-
-pr:
-  autoCancel: true
-  branches:
-    include:
-      - main
-      - stable-*
-
-schedules:
-  - cron: 0 8 * * *
-    displayName: Nightly (main)
-    always: true
-    branches:
-      include:
-        - main
-  - cron: 0 10 * * *
-    displayName: Nightly (active stable branches)
-    always: true
-    branches:
-      include:
-        - stable-11
-  - cron: 0 11 * * 0
-    displayName: Weekly (old stable branches)
-    always: true
-    branches:
-      include:
-        - stable-10
-
-variables:
-  - name: checkoutPath
-    value: ansible_collections/community/general
-  - name: coverageBranches
-    value: main
-  - name: entryPoint
-    value: tests/utils/shippable/shippable.sh
-  - name: fetchDepth
-    value: 0
-
-resources:
-  containers:
-    - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:7.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
-  - stage: Sanity_2_20
-    displayName: Sanity 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.20/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_19
-    displayName: Sanity 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.19/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_18
-    displayName: Sanity 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.18/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-### 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.9
-            - test: '3.10'
-            - test: '3.11'
-            - test: '3.12'
-            - test: '3.13'
-            - test: '3.14'
-  - stage: Units_2_20
-    displayName: Units 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.20/units/{0}/1
-          targets:
-            - test: 3.9
-            - test: "3.12"
-            - test: "3.14"
-  - stage: Units_2_19
-    displayName: Units 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.19/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: "3.11"
-            - 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.11"
-            - test: "3.13"
-
-## 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.22
-              test: alpine/3.22
-            # - name: Fedora 42
-            #   test: fedora/42
-            - 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 15.3
-              test: macos/15.3
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: RHEL 9.6
-              test: rhel/9.6
-            - name: FreeBSD 14.3
-              test: freebsd/14.3
-            - name: FreeBSD 13.5
-              test: freebsd/13.5
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_20
-    displayName: Remote 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.20/{0}
-          targets:
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: FreeBSD 14.3
-              test: freebsd/14.3
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_19
-    displayName: Remote 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/{0}
-          targets:
-            - name: RHEL 9.5
-              test: rhel/9.5
-            - name: RHEL 10.0
-              test: rhel/10.0
-            - name: FreeBSD 14.2
-              test: freebsd/14.2
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_18
-    displayName: Remote 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/{0}
-          targets:
-            - name: macOS 14.3
-              test: macos/14.3
-            - name: RHEL 9.4
-              test: rhel/9.4
-            - name: FreeBSD 14.1
-              test: freebsd/14.1
-          groups:
-            - 1
-            - 2
-            - 3
-
-### Docker
-  - stage: Docker_devel
-    displayName: Docker devel
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: devel/linux/{0}
-          targets:
-            - name: Fedora 42
-              test: fedora42
-            - name: Alpine 3.22
-              test: alpine322
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_20
-    displayName: Docker 2.20
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.20/linux/{0}
-          targets:
-            - name: Fedora 42
-              test: fedora42
-            - name: Alpine 3.22
-              test: alpine322
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_19
-    displayName: Docker 2.19
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.19/linux/{0}
-          targets:
-            - name: Fedora 41
-              test: fedora41
-            - name: Alpine 3.21
-              test: alpine321
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_18
-    displayName: Docker 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/linux/{0}
-          targets:
-            - name: Fedora 40
-              test: fedora40
-            - name: Alpine 3.20
-              test: alpine320
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-
-### 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 11 Bullseye
-              test: debian-bullseye/3.9
-            - name: Debian 12 Bookworm
-              test: debian-bookworm/3.11
-            - name: Debian 13 Trixie
-              test: debian-13-trixie/3.13
-            - name: ArchLinux
-              test: archlinux/3.13
-          groups:
-            - 1
-            - 2
-            - 3
-
-### Generic
-# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-#  - stage: Generic_devel
-#    displayName: Generic devel
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: devel/generic/{0}/1
-#          targets:
-#            - test: '3.9'
-#            - test: '3.12'
-#            - test: '3.14'
-#  - stage: Generic_2_20
-#    displayName: Generic 2.20
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.20/generic/{0}/1
-#          targets:
-#            - test: '3.10'
-#            - test: '3.14'
-#  - stage: Generic_2_19
-#    displayName: Generic 2.19
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.19/generic/{0}/1
-#          targets:
-#            - test: '3.9'
-#            - 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: Summary
-    condition: succeededOrFailed()
-    dependsOn:
-      - Sanity_devel
-      - Sanity_2_20
-      - Sanity_2_19
-      - Sanity_2_18
-      - Units_devel
-      - Units_2_20
-      - Units_2_19
-      - Units_2_18
-      - Remote_devel_extra_vms
-      - Remote_devel
-      - Remote_2_20
-      - Remote_2_19
-      - Remote_2_18
-      - Docker_devel
-      - Docker_2_20
-      - Docker_2_19
-      - Docker_2_18
-      - Docker_community_devel
-# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-#      - Generic_devel
-#      - Generic_2_20
-#      - Generic_2_19
-#      - Generic_2_18
-    jobs:
-      - template: templates/coverage.yml

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

@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# Aggregate code coverage results for later processing.
-
-set -o pipefail -eu
-
-agent_temp_directory="$1"
-
-PATH="${PWD}/bin:${PATH}"
-
-mkdir "${agent_temp_directory}/coverage/"
-
-options=(--venv --venv-system-site-packages --color -v)
-
-ansible-test coverage combine --group-by command --export "${agent_temp_directory}/coverage/" "${options[@]}"
-
-if ansible-test coverage analyze targets generate --help >/dev/null 2>&1; then
-    # Only analyze coverage if the installed version of ansible-test supports it.
-    # Doing so allows this script to work unmodified for multiple Ansible versions.
-    ansible-test coverage analyze targets generate "${agent_temp_directory}/coverage/coverage-analyze-targets.json" "${options[@]}"
-fi

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

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

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

@@ -1,28 +0,0 @@
-#!/usr/bin/env bash
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# Check the test results and set variables for use in later steps.
-
-set -o pipefail -eu
-
-if [[ "$PWD" =~ /ansible_collections/ ]]; then
-    output_path="tests/output"
-else
-    output_path="test/results"
-fi
-
-echo "##vso[task.setVariable variable=outputPath]${output_path}"
-
-if compgen -G "${output_path}"'/junit/*.xml' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveTestResults]true"
-fi
-
-if compgen -G "${output_path}"'/bot/ansible-test-*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveBotResults]true"
-fi
-
-if compgen -G "${output_path}"'/coverage/*' > /dev/null; then
-    echo "##vso[task.setVariable variable=haveCoverageData]true"
-fi

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

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

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

@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# Generate code coverage reports for uploading to Azure Pipelines and codecov.io.
-
-set -o pipefail -eu
-
-PATH="${PWD}/bin:${PATH}"
-
-if ! ansible-test --help >/dev/null 2>&1; then
-    # Install the devel version of ansible-test for generating code coverage reports.
-    # This is only used by Ansible Collections, which are typically tested against multiple Ansible versions (in separate jobs).
-    # Since a version of ansible-test is required that can work the output from multiple older releases, the devel version is used.
-    pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check
-fi
-
-ansible-test coverage xml --group-by command --stub --venv --venv-system-site-packages --color -v

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

@@ -1,38 +0,0 @@
-#!/usr/bin/env bash
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# Configure the test environment and run the tests.
-
-set -o pipefail -eu
-
-entry_point="$1"
-test="$2"
-read -r -a coverage_branches <<< "$3"  # space separated list of branches to run code coverage on for scheduled builds
-
-export COMMIT_MESSAGE
-export COMPLETE
-export COVERAGE
-export IS_PULL_REQUEST
-
-if [ "${SYSTEM_PULLREQUEST_TARGETBRANCH:-}" ]; then
-    IS_PULL_REQUEST=true
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD^2)
-else
-    IS_PULL_REQUEST=
-    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD)
-fi
-
-COMPLETE=
-COVERAGE=
-
-if [ "${BUILD_REASON}" = "Schedule" ]; then
-    COMPLETE=yes
-
-    if printf '%s\n' "${coverage_branches[@]}" | grep -q "^${BUILD_SOURCEBRANCHNAME}$"; then
-        COVERAGE=yes
-    fi
-fi
-
-"${entry_point}" "${test}" 2>&1 | "$(dirname "$0")/time-command.py"

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

@@ -1,29 +0,0 @@
-#!/usr/bin/env python
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-"""Prepends a relative timestamp to each input line from stdin and writes it to stdout."""
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import time
-
-
-def main():
-    """Main program entry point."""
-    start = time.time()
-
-    sys.stdin.reconfigure(errors='surrogateescape')
-    sys.stdout.reconfigure(errors='surrogateescape')
-
-    for line in sys.stdin:
-        seconds = time.time() - start
-        sys.stdout.write('%02d:%02d %s' % (seconds // 60, seconds % 60, line))
-        sys.stdout.flush()
-
-
-if __name__ == '__main__':
-    main()

.azure-pipelines/templates/coverage.yml

@@ -1,34 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# This template adds a job for processing code coverage data.
-# It will upload results to Azure Pipelines and codecov.io.
-# Use it from a job stage that completes after all other jobs have completed.
-# This can be done by placing it in a separate summary stage that runs after the test stage(s) have completed.
-
-jobs:
-  - job: Coverage
-    displayName: Code Coverage
-    container: default
-    workspace:
-      clean: all
-    steps:
-      - checkout: self
-        fetchDepth: $(fetchDepth)
-        path: $(checkoutPath)
-      - task: DownloadPipelineArtifact@2
-        displayName: Download Coverage Data
-        inputs:
-          path: coverage/
-          patterns: "Coverage */*=coverage.combined"
-      - bash: .azure-pipelines/scripts/combine-coverage.py coverage/
-        displayName: Combine Coverage Data
-      - bash: .azure-pipelines/scripts/report-coverage.sh
-        displayName: Generate Coverage Report
-        condition: gt(variables.coverageFileCount, 0)
-      - bash: .azure-pipelines/scripts/publish-codecov.py "$(outputPath)"
-        displayName: Publish to codecov.io
-        condition: gt(variables.coverageFileCount, 0)
-        continueOnError: true

.azure-pipelines/templates/matrix.yml

@@ -1,60 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# This template uses the provided targets and optional groups to generate a matrix which is then passed to the test template.
-# If this matrix template does not provide the required functionality, consider using the test template directly instead.
-
-parameters:
-  # A required list of dictionaries, one per test target.
-  # Each item in the list must contain a "test" or "name" key.
-  # Both may be provided. If one is omitted, the other will be used.
-  - name: targets
-    type: object
-
-  # An optional list of values which will be used to multiply the targets list into a matrix.
-  # Values can be strings or numbers.
-  - name: groups
-    type: object
-    default: []
-
-  # An optional format string used to generate the job name.
-  # - {0} is the name of an item in the targets list.
-  - name: nameFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to generate the test name.
-  # - {0} is the name of an item in the targets list.
-  - name: testFormat
-    type: string
-    default: "{0}"
-
-  # An optional format string used to add the group to the job name.
-  # {0} is the formatted name of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: nameGroupFormat
-    type: string
-    default: "{0} - {{1}}"
-
-  # An optional format string used to add the group to the test name.
-  # {0} is the formatted test of an item in the targets list.
-  # {{1}} is the group -- be sure to include the double "{{" and "}}".
-  - name: testGroupFormat
-    type: string
-    default: "{0}/{{1}}"
-
-jobs:
-  - template: test.yml
-    parameters:
-      jobs:
-        - ${{ if eq(length(parameters.groups), 0) }}:
-            - ${{ each target in parameters.targets }}:
-                - name: ${{ format(parameters.nameFormat, coalesce(target.name, target.test)) }}
-                  test: ${{ format(parameters.testFormat, coalesce(target.test, target.name)) }}
-        - ${{ if not(eq(length(parameters.groups), 0)) }}:
-            - ${{ each group in parameters.groups }}:
-                - ${{ each target in parameters.targets }}:
-                    - name: ${{ format(format(parameters.nameGroupFormat, parameters.nameFormat), coalesce(target.name, target.test), group) }}
-                      test: ${{ format(format(parameters.testGroupFormat, parameters.testFormat), coalesce(target.test, target.name), group) }}

.azure-pipelines/templates/test.yml

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

.git-blame-ignore-revs

@@ -1,12 +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
-
-# YAML reformatting
-d032de3b16eed11ea3a31cd3d96d78f7c46a2ee0
-e8f965fbf8154ea177c6622da149f2ae8533bd3c
-e938ca5f20651abc160ee6aba10014013d04dcc1
-eaa5e07b2866e05b6c7b5628ca92e9cb1142d008
-
-# Code reformatting
-340ff8586d4f1cb6a0f3c934eb42589bcc29c0ea

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,153 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: Bug report
-description: Create a report to help us improve
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        Verify first that your issue is not [already reported on GitHub][issue search].
-        Also test if the latest release and devel branch are affected too.
-        *Complete **all** sections as described, this form is processed automatically.*
-
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
-
-
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Explain the problem briefly below.
-      placeholder: >-
-        When I try to do X with the collection from the main branch on GitHub, Y
-        breaks in a way Z under the env E. Here are all the details I know
-        about this problem...
-    validations:
-      required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # FIXME: Once GitHub allows defining the default choice, update this
-      options:
-        - Bug Report
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      # For smaller collections we could use a multi-select and hardcode the list
-      # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
-      # Select from list, filter as you type (`mysql` would only show the 3 mysql components)
-      # OR freeform - doesn't seem to be supported in adaptivecards
-      label: Component Name
-      description: >-
-        Write the short name of the module, plugin, task or feature below,
-        *use your best guess if unsure*. Do not include `community.general.`!
-      placeholder: dnf, apt, yum, pip, user etc.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Ansible Version
-      description: >-
-        Paste verbatim output from `ansible --version` between
-        tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible --version
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Community.general Version
-      description: >-
-        Paste verbatim output from "ansible-galaxy collection list community.general"
-        between tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible-galaxy collection list community.general
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Configuration
-      description: >-
-        If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
-        This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
-        Paste verbatim output from `ansible-config dump --only-changed` between quotes
-      value: |
-        ```console (paste below)
-        $ ansible-config dump --only-changed
-
-        ```
-
-
-  - type: textarea
-    attributes:
-      label: OS / Environment
-      description: >-
-        Provide all relevant information below, e.g. target OS versions,
-        network device firmware, etc.
-      placeholder: RHEL 8, CentOS Stream etc.
-    validations:
-      required: false
-
-
-  - type: textarea
-    attributes:
-      label: Steps to Reproduce
-      description: |
-        Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also passed any playbooks, configs and commands you used.
-
-        **HINT:** You can paste https://gist.github.com links for larger files.
-      value: |
-        <!--- Paste example playbooks or commands between quotes below -->
-        ```yaml (paste below)
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Expected Results
-      description: >-
-        Describe what you expected to happen when running the steps above.
-      placeholder: >-
-        I expected X to happen because I assumed Y.
-        that it did not.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Actual Results
-      description: |
-        Describe what actually happened. If possible run with extra verbosity (`-vvvv`).
-
-        Paste verbatim command output between quotes.
-      value: |
-        ```console (paste below)
-
-        ```
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
-...

.github/ISSUE_TEMPLATE/config.yml

@@ -1,31 +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
-
-# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-blank_issues_enabled: false  # default: true
-contact_links:
-  - name: Security bug report
-    url: https://docs.ansible.com/projects/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
-    about: |
-      Please learn how to report security vulnerabilities here.
-
-      For all security related bugs, email security@ansible.com
-      instead of using this issue tracker and you will receive
-      a prompt response.
-
-      For more information, see
-      https://docs.ansible.com/projects/ansible/latest/community/reporting_bugs_and_features.html
-  - name: Ansible Code of Conduct
-    url: https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
-    about: Be nice to other members of the community.
-  - name: Talks to the community
-    url: https://docs.ansible.com/projects/ansible/latest/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information
-    about: Please ask and answer usage questions here
-  - name: Working groups
-    url: https://github.com/ansible/community/wiki
-    about: Interested in improving a specific area? Become a part of a working group!
-  - name: For Enterprise
-    url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
-    about: Red Hat offers support for the Ansible Automation Platform

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -1,129 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: Documentation Report
-description: Ask us about docs
-# NOTE: issue body is enabled to allow screenshots
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        Verify first that your issue is not [already reported on GitHub][issue search].
-        Also test if the latest release and devel branch are affected too.
-        *Complete **all** sections as described, this form is processed automatically.*
-
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
-
-
-  - type: textarea
-    attributes:
-      label: Summary
-      description: |
-        Explain the problem briefly below, add suggestions to wording or structure.
-
-        **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
-      placeholder: >-
-        I was reading the Collection documentation of version X and I'm having
-        problems understanding Y. It would be very helpful if that got
-        rephrased as Z.
-    validations:
-      required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # FIXME: Once GitHub allows defining the default choice, update this
-      options:
-        - Documentation Report
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Component Name
-      description: >-
-        Write the short name of the file, module, plugin, task or feature below,
-        *use your best guess if unsure*. Do not include `community.general.`!
-      placeholder: mysql_user
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Ansible Version
-      description: >-
-        Paste verbatim output from `ansible --version` between
-        tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible --version
-
-        ```
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: Community.general Version
-      description: >-
-        Paste verbatim output from "ansible-galaxy collection list community.general"
-        between tripple backticks.
-      value: |
-        ```console (paste below)
-        $ ansible-galaxy collection list community.general
-
-        ```
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Configuration
-      description: >-
-        Paste verbatim output from `ansible-config dump --only-changed` between quotes.
-      value: |
-        ```console (paste below)
-        $ ansible-config dump --only-changed
-
-        ```
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: OS / Environment
-      description: >-
-        Provide all relevant information below, e.g. OS version,
-        browser, etc.
-      placeholder: Fedora 33, Firefox etc.
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: Additional Information
-      description: |
-        Describe how this improves the documentation, e.g. before/after situation or screenshots.
-
-        **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
-
-        **HINT:** You can paste https://gist.github.com links for larger files.
-      placeholder: >-
-        When the improvement is applied, it makes it more straightforward
-        to understand X.
-    validations:
-      required: false
-
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
-...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,73 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: Feature request
-description: Suggest an idea for this project
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ⚠
-        Verify first that your issue is not [already reported on GitHub][issue search].
-        Also test if the latest release and devel branch are affected too.
-        *Complete **all** sections as described, this form is processed automatically.*
-
-        [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
-
-
-  - type: textarea
-    attributes:
-      label: Summary
-      description: Describe the new feature/improvement briefly below.
-      placeholder: >-
-        I am trying to do X with the collection from the main branch on GitHub and
-        I think that implementing a feature Y would be very helpful for me and
-        every other user of community.general because of Z.
-    validations:
-      required: true
-
-  - type: dropdown
-    attributes:
-      label: Issue Type
-      # FIXME: Once GitHub allows defining the default choice, update this
-      options:
-        - Feature Idea
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Component Name
-      description: >-
-        Write the short name of the module or plugin, or which other part(s) of the collection this feature affects.
-        *use your best guess if unsure*. Do not include `community.general.`!
-      placeholder: dnf, apt, yum, pip, user etc.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Additional Information
-      description: |
-        Describe how the feature would be used, why it is needed and what it would solve.
-
-        **HINT:** You can paste https://gist.github.com links for larger files.
-      value: |
-        <!--- Paste example playbooks or commands between quotes below -->
-        ```yaml (paste below)
-
-        ```
-    validations:
-      required: false
-  - type: checkboxes
-    attributes:
-      label: Code of Conduct
-      description: |
-        Read the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
-      options:
-        - label: I agree to follow the Ansible Code of Conduct
-          required: true
-...

.github/dependabot.yml

@@ -1,15 +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: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    groups:
-      ci:
-        patterns:
-          - "*"

.github/patchback.yml

@@ -1,8 +1,4 @@
 ---
-# 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
-
 backport_branch_prefix: patchback/backports/
 backport_label_prefix: backport-
 target_branch_prefix: stable-

.github/pull_request_template.md

@@ -1,32 +0,0 @@
-##### SUMMARY
-<!--- Describe the change below, including rationale and design decisions -->
-
-<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
-
-<!--- Please do not forget to include a changelog fragment:
-      https://docs.ansible.com/projects/ansible/devel/community/collection_development_process.html#creating-changelog-fragments
-      No need to include one for docs-only or test-only PR, and for new plugin/module PRs.
-      Read about more details in CONTRIBUTING.md.
-      -->
-
-##### ISSUE TYPE
-<!--- Pick one or more below and delete the rest.
-      'Test Pull Request' is for PRs that add/extend tests without code changes. -->
-- Bugfix Pull Request
-- Docs Pull Request
-- Feature Pull Request
-- New Module/Plugin Pull Request
-- Refactoring Pull Request
-- Test Pull Request
-
-##### COMPONENT NAME
-<!--- Write the SHORT NAME of the module, plugin, task or feature below. -->
-
-##### ADDITIONAL INFORMATION
-<!--- Include additional information to help people understand the change here -->
-<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
-
-<!--- Paste verbatim command output below, e.g. before and after your change -->
-```paste below
-
-```

.github/pull_request_template.md.license

@@ -1,3 +0,0 @@
-Copyright (c) Ansible Project
-GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-SPDX-License-Identifier: GPL-3.0-or-later

.github/settings.yml

@@ -1,8 +1,3 @@
----
-# 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
-
 # DO NOT MODIFY
 
 # Settings: https://probot.github.io/apps/settings/

.github/workflows/ansible-test.yml

@@ -1,176 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# 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.17'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Perform sanity testing
-        uses: felixfontein/ansible-test-gh-action@main
-        with:
-          ansible-core-version: stable-${{ matrix.ansible }}
-          codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
-          pull-request-change-detection: 'true'
-          testing-type: sanity
-          pre-test-cmd: >-
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
-
-  units:
-    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.17'
-            python: '3.7'
-          - ansible: '2.17'
-            python: '3.10'
-          - ansible: '2.17'
-            python: '3.12'
-
-    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:
-    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.17
-          - ansible: '2.17'
-            docker: fedora39
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.17'
-            docker: fedora39
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.17'
-            docker: fedora39
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.17'
-            docker: ubuntu2004
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.17'
-            docker: ubuntu2004
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.17'
-            docker: ubuntu2004
-            python: ''
-            target: azp/posix/3/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/1/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/2/
-          - ansible: '2.17'
-            docker: alpine319
-            python: ''
-            target: azp/posix/3/
-          # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-          # - ansible: '2.17'
-          #   docker: default
-          #   python: '3.7'
-          #   target: azp/generic/1/
-          # - ansible: '2.17'
-          #   docker: default
-          #   python: '3.12'
-          #   target: azp/generic/1/
-
-    steps:
-      - name: >-
-          Perform integration testing against
-          Ansible version ${{ matrix.ansible }}
-          under Python ${{ matrix.python }}
-        uses: felixfontein/ansible-test-gh-action@main
-        with:
-          ansible-core-version: stable-${{ matrix.ansible }}
-          codecov-token: ${{ secrets.CODECOV_TOKEN }}
-          coverage: ${{ github.event_name == 'schedule' && 'always' || 'never' }}
-          docker-image: ${{ matrix.docker }}
-          integration-continue-on-error: 'false'
-          integration-diff: 'false'
-          integration-retry-on-error: 'true'
-          # TODO: remove "--branch stable-2" from community.crypto install once we're only using ansible-core 2.17 or newer!
-          pre-test-cmd: >-
-            mkdir -p ../../ansible
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/ansible.posix.git ../../ansible/posix
-            ;
-            git clone --depth=1 --single-branch --branch stable-2 https://github.com/ansible-collections/community.crypto.git ../../community/crypto
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.docker.git ../../community/docker
-            ;
-            git clone --depth=1 --single-branch https://github.com/ansible-collections/community.internal_test_tools.git ../../community/internal_test_tools
-          pull-request-change-detection: 'true'
-          target: ${{ matrix.target }}
-          target-python-version: ${{ matrix.python }}
-          testing-type: integration

.github/workflows/codeql-analysis.yml

@@ -1,38 +1,49 @@
----
-# 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":
+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@v6
-        with:
-          persist-credentials: false
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
 
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v4
-        with:
-          languages: python
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
 
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v4
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/docs.yml

@@ -1,34 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: nox
-'on':
-  push:
-    branches:
-      - main
-      - stable-*
-    paths:
-      - docs/**
-  pull_request:
-    paths:
-      - docs/**
-  # Run CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-  workflow_dispatch:
-
-jobs:
-  nox:
-    runs-on: ubuntu-latest
-    name: "Validate generated Ansible output"
-    steps:
-      - name: Check out collection
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-      - name: Run nox
-        uses: ansible-community/antsibull-nox@main
-        with:
-          sessions: ansible-output

.github/workflows/nox.yml

@@ -1,28 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-name: nox
-'on':
-  push:
-    branches:
-      - main
-      - stable-*
-  pull_request:
-  # Run CI once per day (at 08:00 UTC)
-  schedule:
-    - cron: '0 8 * * *'
-  workflow_dispatch:
-
-jobs:
-  nox:
-    runs-on: ubuntu-latest
-    name: "Run extra sanity tests"
-    steps:
-      - name: Check out collection
-        uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-      - name: Run nox
-        uses: ansible-community/antsibull-nox@main

.gitignore

@@ -1,9 +1,6 @@
-# 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
 
-# Created by https://www.toptal.com/developers/gitignore/api/vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
-# Edit at https://www.toptal.com/developers/gitignore?templates=vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
+# Created by https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
+# Edit at https://www.gitignore.io/?templates=git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
 
 ### dotenv ###
 .env
@@ -74,19 +71,7 @@ flycheck_*.el
 *_LOCAL_*.txt
 *_REMOTE_*.txt
 
-### JupyterNotebooks ###
-# gitignore template for Jupyter Notebooks
-# website: http://jupyter.org/
-
-.ipynb_checkpoints
-*/.ipynb_checkpoints/*
-
-# IPython
-profile_default/
-ipython_config.py
-
-# Remove previous ipynb_checkpoints
-#   git rm -r .ipynb_checkpoints/
+#!! ERROR: jupyternotebook is undefined. Use list command to see defined gitignore types !!#
 
 ### Linux ###
 
@@ -102,41 +87,8 @@ ipython_config.py
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
-### macOS ###
-# General
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### macOS Patch ###
-# iCloud generated files
-*.icloud
-
 ### PyCharm+all ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
@@ -146,9 +98,6 @@ Temporary Items
 .idea/**/dictionaries
 .idea/**/shelf
 
-# AWS User-specific
-.idea/**/aws.xml
-
 # Generated files
 .idea/**/contentModel.xml
 
@@ -169,9 +118,6 @@ Temporary Items
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
@@ -199,9 +145,6 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
-# SonarLint plugin
-.idea/sonarlint/
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
@@ -215,13 +158,20 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 ### PyCharm+all Patch ###
-# Ignore everything but code style settings and run configurations
-# that are supposed to be shared within teams.
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
 
-.idea/*
+.idea/
 
-!.idea/codeStyles
-!.idea/runConfigurations
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
 
 ### pydev ###
 .pydevproject
@@ -248,6 +198,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -274,25 +225,13 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
 .hypothesis/
 .pytest_cache/
-cover/
 
 # Translations
 *.mo
 *.pot
 
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
 # Scrapy stuff:
 .scrapy
 
@@ -300,17 +239,10 @@ instance/
 docs/_build/
 
 # PyBuilder
-.pybuilder/
 target/
 
-# Jupyter Notebook
-
-# IPython
-
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -319,39 +251,12 @@ target/
 #   install all needed dependencies.
 #Pipfile.lock
 
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# Environments
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
 # Spyder project settings
 .spyderproject
 .spyproject
@@ -359,6 +264,10 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
+# Mr Developer
+.mr.developer.cfg
+.project
+
 # mkdocs documentation
 /site
 
@@ -370,33 +279,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  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]
-!*.svg  # comment out if you don't need vector files
 [._]*.sw[a-p]
 [._]s[a-rt-v][a-z]
 [._]ss[a-gi-z]
@@ -414,13 +299,11 @@ tags
 [._]*.un~
 
 ### WebStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
 
-# AWS User-specific
-
 # Generated files
 
 # Sensitive or high-churn files
@@ -431,9 +314,6 @@ tags
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
@@ -454,8 +334,6 @@ tags
 
 # Cursive Clojure plugin
 
-# SonarLint plugin
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
 
 # Editor-based Rest Client
@@ -471,31 +349,15 @@ tags
 # *.ipr
 
 # Sonarlint plugin
-# https://plugins.jetbrains.com/plugin/7973-sonarlint
 .idea/**/sonarlint/
 
 # SonarQube Plugin
-# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
 .idea/**/sonarIssues.xml
 
 # Markdown Navigator plugin
-# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
 .idea/**/markdown-navigator.xml
-.idea/**/markdown-navigator-enh.xml
 .idea/**/markdown-navigator/
 
-# Cache file creation bug
-# See https://youtrack.jetbrains.com/issue/JBR-2257
-.idea/$CACHE_FILE$
-
-# CodeStream plugin
-# 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
@@ -522,12 +384,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
-
-# Integration tests cloud configs
-tests/integration/cloud-config-*.ini
-
-
-# VSCode specific extensions
-.vscode/settings.json
-.ansible
+# End of https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv

.mypy.ini

@@ -1,216 +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
-
-[mypy]
-# check_untyped_defs = True
-# disallow_untyped_defs = True
-
-# strict = True -- only try to enable once everything (including dependencies!) is typed
-strict_equality = True
-strict_bytes = True
-
-warn_redundant_casts = True
-# warn_return_any = True
-warn_unreachable = True
-
-[mypy-ansible.*]
-# ansible-core has partial typing information
-follow_untyped_imports = True
-
-# The following imports are Python packages that:
-# 1. We do not install (we can't install everything!);
-# 2. That have type stubs, but we don't install them (again, we can't install everything!); or
-# 3. That have no types and type stubs.
-[mypy-aerospike.*]
-ignore_missing_imports = True
-[mypy-boto3.*]
-ignore_missing_imports = True
-[mypy-bs4.*]
-ignore_missing_imports = True
-[mypy-cgi.*]
-ignore_missing_imports = True
-[mypy-chef.*]
-ignore_missing_imports = True
-[mypy-consul.*]
-ignore_missing_imports = True
-[mypy-credstash.*]
-ignore_missing_imports = True
-[mypy-crypt.*]
-ignore_missing_imports = True
-[mypy-datadog.*]
-ignore_missing_imports = True
-[mypy-dbus.*]
-ignore_missing_imports = True
-[mypy-delinea.*]
-ignore_missing_imports = True
-[mypy-dnf.*]
-ignore_missing_imports = True
-[mypy-dnsimple.*]
-ignore_missing_imports = True
-[mypy-etcd3.*]
-ignore_missing_imports = True
-[mypy-flatdict.*]
-ignore_missing_imports = True
-[mypy-footmark.*]
-ignore_missing_imports = True
-[mypy-fqdn.*]
-ignore_missing_imports = True
-[mypy-func.*]
-ignore_missing_imports = True
-[mypy-gi.*]
-ignore_missing_imports = True
-[mypy-github3.*]
-ignore_missing_imports = True
-[mypy-hashids.*]
-ignore_missing_imports = True
-[mypy-heroku3.*]
-ignore_missing_imports = True
-[mypy-hpe3parclient.*]
-ignore_missing_imports = True
-[mypy-hpe3par_sdk.*]
-ignore_missing_imports = True
-[mypy-hpilo.*]
-ignore_missing_imports = True
-[mypy-hpOneView.*]
-ignore_missing_imports = True
-[mypy-httmock.*]  # TODO!
-ignore_missing_imports = True
-[mypy-influxdb.*]
-ignore_missing_imports = True
-[mypy-jc.*]
-ignore_missing_imports = True
-[mypy-jenkins.*]
-ignore_missing_imports = True
-[mypy-jmespath.*]
-ignore_missing_imports = True
-[mypy-jsonpatch.*]
-ignore_missing_imports = True
-[mypy-kazoo.*]
-ignore_missing_imports = True
-[mypy-keyring.*]
-ignore_missing_imports = True
-[mypy-keystoneauth1.*]
-ignore_missing_imports = True
-[mypy-layman.*]
-ignore_missing_imports = True
-[mypy-ldap.*]
-ignore_missing_imports = True
-[mypy-legacycrypt.*]
-ignore_missing_imports = True
-[mypy-libcloud.*]
-ignore_missing_imports = True
-[mypy-linode.*]
-ignore_missing_imports = True
-[mypy-linode_api4.*]
-ignore_missing_imports = True
-[mypy-lmdb.*]
-ignore_missing_imports = True
-[mypy-logdna.*]
-ignore_missing_imports = True
-[mypy-logstash.*]
-ignore_missing_imports = True
-[mypy-lxc.*]
-ignore_missing_imports = True
-[mypy-manageiq_client.*]
-ignore_missing_imports = True
-[mypy-matrix_client.*]
-ignore_missing_imports = True
-[mypy-memcache.*]
-ignore_missing_imports = True
-[mypy-nc_dnsapi.*]
-ignore_missing_imports = True
-[mypy-nomad.*]
-ignore_missing_imports = True
-[mypy-oci.*]
-ignore_missing_imports = True
-[mypy-oneandone.*]
-ignore_missing_imports = True
-[mypy-opentelemetry.*]
-ignore_missing_imports = True
-[mypy-ovh.*]
-ignore_missing_imports = True
-[mypy-ovirtsdk.*]
-ignore_missing_imports = True
-[mypy-packet.*]
-ignore_missing_imports = True
-[mypy-paho.*]
-ignore_missing_imports = True
-[mypy-pam.*]
-ignore_missing_imports = True
-[mypy-pdpyras.*]
-ignore_missing_imports = True
-[mypy-petname.*]
-ignore_missing_imports = True
-[mypy-pingdom.*]
-ignore_missing_imports = True
-[mypy-portage.*]
-ignore_missing_imports = True
-[mypy-potatoes_that_will_never_be_there.*]
-ignore_missing_imports = True
-[mypy-prettytable.*]
-ignore_missing_imports = True
-[mypy-pubnub_blocks_client.*]
-ignore_missing_imports = True
-[mypy-pushbullet.*]
-ignore_missing_imports = True
-[mypy-pycdlib.*]
-ignore_missing_imports = True
-[mypy-pyghmi.*]
-ignore_missing_imports = True
-[mypy-pylxca.*]
-ignore_missing_imports = True
-[mypy-pymssql.*]
-ignore_missing_imports = True
-[mypy-pyodbc.*]
-ignore_missing_imports = True
-[mypy-pyone.*]
-ignore_missing_imports = True
-[mypy-pypureomapi.*]
-ignore_missing_imports = True
-[mypy-pysnmp.*]
-ignore_missing_imports = True
-[mypy-pyxcli.*]
-ignore_missing_imports = True
-[mypy-rpm.*]
-ignore_missing_imports = True
-[mypy-salt.*]
-ignore_missing_imports = True
-[mypy-selinux.*]
-ignore_missing_imports = True
-[mypy-semantic_version.*]
-ignore_missing_imports = True
-[mypy-sendgrid.*]
-ignore_missing_imports = True
-[mypy-seobject.*]
-ignore_missing_imports = True
-[mypy-sha.*]
-ignore_missing_imports = True
-[mypy-SoftLayer.*]
-ignore_missing_imports = True
-[mypy-spotinst_sdk.*]
-ignore_missing_imports = True
-[mypy-statsd.*]
-ignore_missing_imports = True
-[mypy-storops.*]
-ignore_missing_imports = True
-[mypy-taiga.*]
-ignore_missing_imports = True
-[mypy-thycotic.*]
-ignore_missing_imports = True
-[mypy-univention.*]
-ignore_missing_imports = True
-[mypy-vexatapi.*]
-ignore_missing_imports = True
-[mypy-websocket.*]
-ignore_missing_imports = True
-[mypy-XenAPI.*]
-ignore_missing_imports = True
-[mypy-xkcdpass.*]
-ignore_missing_imports = True
-[mypy-xmljson.*]
-ignore_missing_imports = True
-[mypy-xmltodict.*]
-ignore_missing_imports = True
-[mypy-xmpp.*]
-ignore_missing_imports = True

.yamllint

@@ -1,52 +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
-
-extends: default
-
-ignore: |
-  /changelogs/
-
-rules:
-  line-length:
-    max: 1000
-    level: error
-  document-start: disable
-  document-end: disable
-  truthy:
-    level: error
-    allowed-values:
-      - 'true'
-      - 'false'
-  indentation:
-    spaces: 2
-    indent-sequences: true
-  key-duplicates: enable
-  trailing-spaces: enable
-  new-line-at-end-of-file: disable
-  hyphens:
-    max-spaces-after: 1
-  empty-lines:
-    max: 2
-    max-start: 0
-    max-end: 0
-  commas:
-    max-spaces-before: 0
-    min-spaces-after: 1
-    max-spaces-after: 1
-  colons:
-    max-spaces-before: 0
-    max-spaces-after: 1
-  brackets:
-    min-spaces-inside: 0
-    max-spaces-inside: 0
-  braces:
-    min-spaces-inside: 0
-    max-spaces-inside: 1
-  octal-values:
-    forbid-implicit-octal: true
-    forbid-explicit-octal: true
-  comments:
-    min-spaces-from-content: 1
-  comments-indentation: false

CHANGELOG.md.license

@@ -1,3 +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: Ansible Project

CHANGELOG.rst.license

@@ -1,3 +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: Ansible Project

CONTRIBUTING.md

@@ -1,225 +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
--->
-
-# Contributing
-
-We follow [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
-
-If you are a committer, also refer to the [collection's committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
-
-## Issue tracker
-
-Whether you are looking for an opportunity to contribute or you found a bug and already know how to solve it, please go to the [issue tracker](https://github.com/ansible-collections/community.general/issues).
-There you can find feature ideas to implement, reports about bugs to solve, or submit an issue to discuss your idea before implementing it which can help choose a right direction at the beginning of your work and potentially save a lot of time and effort.
-Also somebody may already have started discussing or working on implementing the same or a similar idea,
-so you can cooperate to create a better solution together.
-
-* If you are interested in starting with an easy issue, look for [issues with an `easyfix` label](https://github.com/ansible-collections/community.general/labels/easyfix).
-* Often issues that are waiting for contributors to pick up have [the `waiting_on_contributor` label](https://github.com/ansible-collections/community.general/labels/waiting_on_contributor).
-
-## Review pull requests
-
-Look through currently [open pull requests](https://github.com/ansible-collections/community.general/pulls).
-
-You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. And it is always worth saying that good reviews are often more valuable than pull requests themselves.
-Note that reviewing does not only mean code review, but also offering comments on new interfaces added to existing plugins/modules, interfaces of new plugins/modules, improving language (not everyone is a native English speaker), or testing bugfixes and new features!
-
-Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself.
-
-## Open pull requests
-
-Please read our ['Contributing to collections'](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections_contributing.html#contributing-to-a-collection-community-general) guide.
-
-* Try committing your changes with an informative but short commit message.
-* Do not squash your commits and force-push to your branch if not needed. Reviews of your pull request are much easier with individual commits to comprehend the pull request history. All commits of your pull request branch will be squashed into one commit by GitHub upon merge.
-* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/projects/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the repository checkout.
-* Make sure your PR includes a [changelog fragment](https://docs.ansible.com/projects/ansible/devel/community/collection_development_process.html#creating-a-changelog-fragment).
-  * You must not include a fragment for new modules or new plugins. Also you shouldn't include one for docs-only changes. (If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) )
-  * Please always include a link to the pull request itself, and if the PR is about an issue, also a link to the issue. Also make sure the fragment ends with a period, and begins with a lower-case letter after `-`. (Again, if you don't do this, we'll add suggestions to fix it, so don't worry too much :) )
-* Note that we format the code with `ruff format`. If your change does not match the formatters expectations, CI will fail and your PR will not get merged. See below for how to format code with antsibull-nox.
-
-You can also read the Ansible community's [Quick-start development guide](https://docs.ansible.com/projects/ansible/devel/community/create_pr_quick_start.html).
-
-## Test pull requests
-
-If you want to test a PR locally, refer to [our testing guide](https://docs.ansible.com/projects/ansible/devel/community/collection_contributors/collection_test_pr_locally.html) for instructions on how do it quickly.
-
-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.
-
-## Format code; and run sanity or unit tests locally (with antsibull-nox)
-
-The easiest way to format the code, and to run sanity and unit tests locally is to use [antsibull-nox](https://docs.ansible.com/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.)
-
-### Format code
-
-The following commands show how to run ansible-test sanity tests:
-
-```.bash
-# Run all configured formatters:
-nox -Re formatters
-
-# If you notice discrepancies between your local formatter and CI, you might
-# need to re-generate the virtual environment:
-nox -e formatters
-```
-
-### 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.
-
-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://docs.ansible.com/projects/ansible/devel/community/collection_contributors/collection_test_pr_locally.html) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
-
-```.bash
-mkdir -p ~/dev/ansible_collections/community
-git clone https://github.com/ansible-collections/community.general.git ~/dev/ansible_collections/community/general
-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
-
-The following commands show how to run basic sanity tests:
-
-```.bash
-# Run basic sanity tests for all files in the collection:
-ansible-test sanity --docker -v
-
-# Run basic 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
-# Run all unit tests:
-ansible-test units --docker -v
-
-# Run all unit tests for one Python version (a lot faster):
-ansible-test units --docker -v --python 3.8
-
-# Run a specific unit test (for the nmcli module) for one Python version:
-ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools/test_nmcli.py
-```
-
-### 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
-
-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`.
-  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
-ansible-test integration -v --docker fedora40
-
-# Template
-ansible-test integration -v --docker image_name test_name
-
-# Example community.general.ini_file module on fedora40 Docker image:
-ansible-test integration -v --docker fedora40 ini_file
-```
-
-#### Without isolation
-
-```.bash
-# Run integration tests for the flattened lookup **without any isolation**:
-ansible-test integration -v lookup_flattened
-```
-
-If you are unsure about the integration test target name for a module or plugin, you can take a look in `tests/integration/targets/`. Tests for plugins have the plugin type prepended.
-
-## Creating new modules or plugins
-
-Creating new modules and plugins requires a bit more work than other Pull Requests.
-
-1. Please make sure that your new module or plugin is of interest to a larger audience. Very specialized modules or plugins that
-   can only be used by very few people should better be added to more specialized collections.
-
-2. Please do not add more than one plugin/module in one PR, especially if it is the first plugin/module you are contributing.
-   That makes it easier for reviewers, and increases the chance that your PR will get merged. If you plan to contribute a group
-   of plugins/modules (say, more than a module and a corresponding ``_info`` module), please mention that in the first PR. In
-   such cases, you also have to think whether it is better to publish the group of plugins/modules in a new collection.
-
-3. When creating a new module or plugin, please make sure that you follow various guidelines:
-
-   - Follow [development conventions](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_modules_best_practices.html);
-   - Follow [documentation standards](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_modules_documenting.html) and
-     the [Ansible style guide](https://docs.ansible.com/projects/ansible/devel/dev_guide/style_guide/index.html#style-guide);
-   - Make sure your modules and plugins are [GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0-standalone.html) licensed
-     (new module_utils can also be [BSD-2-clause](https://opensource.org/licenses/BSD-2-Clause) licensed);
-   - Make sure that new plugins and modules have tests (unit tests, integration tests, or both); it is preferable to have some tests
-     which run in CI.
-
-4. Action plugins need to be accompanied by a module, even if the module file only contains documentation
-   (`DOCUMENTATION`, `EXAMPLES` and `RETURN`). The module must have the same name and directory path in `plugins/modules/`
-   than the action plugin has in `plugins/action/`.
-
-5. Make sure to add a BOTMETA entry for your new module/plugin in `.github/BOTMETA.yml`. Search for other plugins/modules in the
-   same directory to see how entries could look. You should list all authors either as `maintainers` or under `ignore`. People
-   listed as `maintainers` will be pinged for new issues and PRs that modify the module/plugin or its tests.
-
-   When you add a new plugin/module, we expect that you perform maintainer duty for at least some time after contributing it.

LICENSES/BSD-2-Clause.txt

@@ -1,8 +0,0 @@
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

LICENSES/GPL-3.0-or-later.txt

@@ -1 +0,0 @@
-../COPYING

LICENSES/MIT.txt

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) <year> <copyright holders>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,45 +1,12 @@
-<!--
-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
--->
-
 # Community General Collection
 
-[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://docs.ansible.com/projects/ansible/devel/collections/community/general/)
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-12)](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-12)](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-12)](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)
+[![Run Status](https://api.shippable.com/projects/5e664a167c32620006c9fa50/badge?branch=main)](https://app.shippable.com/github/ansible-collections/community.general/dashboard) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 
-This repository contains the `community.general` Ansible Collection. The collection is a part of the Ansible package and includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
-
-You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/projects/ansible/latest/collections/community/general/).
-
-Please note that this collection does **not** support Windows targets. Only connection plugins included in this collection might support Windows targets, and will explicitly mention that in their documentation if they do so.
-
-## Code of Conduct
-
-We follow [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
-
-If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
-
-## Communication
-
-* Join the Ansible forum:
-  * [Get Help](https://forum.ansible.com/c/help/6): get help or help others. This is for questions about modules or plugins in the collection. Please add appropriate tags if you start new discussions.
-  * [Tag `community-general`](https://forum.ansible.com/tag/community-general): discuss the *collection itself*, instead of specific modules or plugins.
-  * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
-  * [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
-
-* The Ansible [Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
-
-For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/projects/ansible/devel/community/communication.html).
+This repo contains the `community.general` Ansible Collection. The collection includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
 
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.17, ansible-core 2.18, ansible-core 2.19, ansible-core 2.20 releases and the current development version of ansible-core. Ansible-core versions before 2.17.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
+Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.
 
 ## External requirements
 
@@ -47,13 +14,11 @@ Some modules and plugins require external libraries. Please check the requiremen
 
 ## Included content
 
-Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/ui/repo/published/community/general/) or the [documentation on the Ansible docs site](https://docs.ansible.com/projects/ansible/latest/collections/community/general/).
+Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/community/general).
 
 ## Using this collection
 
-This collection is shipped with the Ansible package. So if you have it installed, no more action is required.
-
-If you have a minimal installation (only Ansible Core installed) or you want to use the latest version of the collection along with the whole Ansible package, you need to install the collection from [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/community/general/) manually with the `ansible-galaxy` command-line tool:
+Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI:
 
     ansible-galaxy collection install community.general
 
@@ -64,81 +29,59 @@ collections:
 - name: community.general
 ```
 
-Note that if you install the collection manually, it will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:
-
-```bash
-ansible-galaxy collection install community.general --upgrade
-```
-
-You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/ui/repo/published/community/general/):
-
-```bash
-ansible-galaxy collection install community.general:==X.Y.Z
-```
-
-See [Ansible Using collections](https://docs.ansible.com/projects/ansible/latest/user_guide/collections_using.html) for more details.
+See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
 
 ## Contributing to this collection
 
-The content of this collection is made by good people just like you, a community of individuals collaborating on making the world better through developing automation software.
+If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
 
-We are actively accepting new contributors.
-
-All types of contributions are very welcome.
-
-You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md)!
-
-The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
-
-You can find more information in the [developer guide for collections](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/projects/ansible/latest/community/index.html).
-
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-12/CONTRIBUTING.md).
+You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
 
 ### Running tests
 
-See [here](https://docs.ansible.com/projects/ansible/devel/dev_guide/developing_collections.html#testing-collections).
+See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
 
-## Collection maintenance
+### Communication
 
-To learn how to maintain / become a maintainer of this collection, refer to:
+We have a dedicated Working Group for Ansible development.
 
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-12/commit-rights.md).
-* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/stable-12/maintaining.rst).
+You can find other people interested on the following Freenode IRC channels -
+- `#ansible` - For general use questions and support.
+- `#ansible-devel` - For discussions on developer topics and code related to features or bugs.
+- `#ansible-community` - For discussions on community topics and community meetings.
 
-It is necessary for maintainers of this collection to be subscribed to:
+For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
 
-* The collection itself (the `Watch` button → `All Activity` in the upper right corner of the repository's homepage).
-* The "Changes Impacting Collection Contributors and Maintainers" [issue](https://github.com/ansible-collections/overview/issues/45).
+For more information about [communication](https://docs.ansible.com/ansible/latest/community/communication.html)
 
-They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/projects/ansible/devel/community/communication.html#the-bullhorn).
+### Publishing New Version
 
-## Publishing New Version
+Basic instructions without release branches:
 
-See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection.
+1. Create `changelogs/fragments/<version>.yml` with `release_summary:` section (which must be a string, not a list).
+2. Run `antsibull-changelog release --collection-flatmap yes`
+3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed.
+4. Tag the commit with `<version>`. Push changes and tag to the main repository.
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-12/CHANGELOG.md).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/main/CHANGELOG.rst).
 
 ## Roadmap
 
-In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
+See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning and deprecation.
 
-See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning, and deprecation.
+In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
 
 ## More information
 
 - [Ansible Collection overview](https://github.com/ansible-collections/overview)
-- [Ansible User guide](https://docs.ansible.com/projects/ansible/latest/user_guide/index.html)
-- [Ansible Developer guide](https://docs.ansible.com/projects/ansible/latest/dev_guide/index.html)
-- [Ansible Community code of conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html)
+- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
+- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
+- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
 
 ## Licensing
 
-This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
+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-12/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-12/LICENSES/BSD-2-Clause.txt) and the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-12/LICENSES/MIT.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/).
+See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.

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,116 +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.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.lint]
-run_isort = false
-run_black = false
-run_ruff_check = true
-ruff_check_config = "ruff.toml"
-run_ruff_format = true
-ruff_format_config = "ruff.toml"
-run_flake8 = false
-run_pylint = false
-run_yamllint = true
-yamllint_config = ".yamllint"
-# yamllint_config_plugins = ".yamllint-docs"
-# yamllint_config_plugins_examples = ".yamllint-examples"
-run_mypy = true
-mypy_ansible_core_package = "ansible-core>=2.19.0"
-mypy_config = ".mypy.ini"
-mypy_extra_deps = [
-    "cryptography",
-    "dnspython",
-    "lxml-stubs",
-    "types-mock",
-    "types-paramiko",
-    "types-passlib",
-    "types-psutil",
-    "types-PyYAML",
-    "types-requests",
-]
-
-[sessions.docs_check]
-validate_collection_refs="all"
-codeblocks_restrict_types = [
-    "ansible-output",
-    "console",
-    "ini",
-    "json",
-    "python",
-    "shell",
-    "yaml",
-    "yaml+jinja",
-    "text",
-]
-codeblocks_restrict_type_exact_case = true
-codeblocks_allow_without_type = false
-codeblocks_allow_literal_blocks = false
-
-[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
-run_no_trailing_whitespace = true
-no_trailing_whitespace_skip_paths = [
-    "tests/integration/targets/iso_extract/files/test.iso",
-    "tests/integration/targets/java_cert/files/testpkcs.p12",
-    "tests/integration/targets/one_host/files/testhost/tmp/opennebula-fixtures.json.gz",
-    "tests/integration/targets/one_template/files/testhost/tmp/opennebula-fixtures.json.gz",
-    "tests/integration/targets/setup_flatpak_remote/files/repo.tar.xz",
-]
-no_trailing_whitespace_skip_directories = [
-    "tests/unit/plugins/modules/interfaces_file/interfaces_file_fixtures/golden_output/",
-    "tests/unit/plugins/modules/interfaces_file/interfaces_file_fixtures/input/",
-]
-
-[[sessions.extra_checks.action_groups_config]]
-name = "consul"
-pattern = "^consul_.*$"
-exclusions = [
-    "consul_acl_bootstrap",
-    "consul_kv",
-]
-doc_fragment = "community.general.consul.actiongroup_consul"
-
-[[sessions.extra_checks.action_groups_config]]
-name = "keycloak"
-pattern = "^keycloak_.*$"
-exclusions = [
-    "keycloak_realm_info",
-]
-doc_fragment = "community.general.keycloak.actiongroup_keycloak"
-
-[[sessions.extra_checks.action_groups_config]]
-name = "scaleway"
-pattern = "^scaleway_.*$"
-doc_fragment = "community.general.scaleway.actiongroup_scaleway"
-
-[sessions.build_import_check]
-run_galaxy_importer = true
-
-[sessions.ansible_test_sanity]
-include_devel = true
-
-[sessions.ansible_test_units]
-include_devel = true

changelogs/.gitignore

@@ -1,5 +1 @@
-# 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
-
 /.plugin-cache.yaml

changelogs/changelog.yaml.license

@@ -1,3 +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: Ansible Project

changelogs/config.yaml

@@ -1,43 +1,29 @@
----
-# 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
-
 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:
-  - md
-  - rst
 prelude_section_name: release_summary
 prelude_section_title: Release Summary
 sections:
-  - - major_changes
-    - Major Changes
-  - - minor_changes
-    - Minor Changes
-  - - breaking_changes
-    - Breaking Changes / Porting Guide
-  - - deprecated_features
-    - Deprecated Features
-  - - removed_features
-    - Removed Features (previously deprecated)
-  - - security_fixes
-    - Security Fixes
-  - - bugfixes
-    - Bugfixes
-  - - known_issues
-    - Known Issues
+- - major_changes
+  - Major Changes
+- - minor_changes
+  - Minor Changes
+- - breaking_changes
+  - Breaking Changes / Porting Guide
+- - deprecated_features
+  - Deprecated Features
+- - removed_features
+  - Removed Features (previously deprecated)
+- - security_fixes
+  - Security Fixes
+- - bugfixes
+  - Bugfixes
+- - known_issues
+  - Known Issues
 title: Community General
-trivial_section_name: trivial
-use_fqcn: true
-add_plugin_period: true
-changelog_nice_yaml: true
-changelog_sort: version
-vcs: auto

commit-rights.md

@@ -1,80 +0,0 @@
-<!--
-Copyright (c) Ansible Project
-GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-SPDX-License-Identifier: GPL-3.0-or-later
--->
-
-Committers Guidelines for community.general
-===========================================
-
-This document is based on the [Ansible committer guidelines](https://github.com/ansible/ansible/blob/b57444af14062ec96e0af75fdfc2098c74fe2d9a/docs/docsite/rst/community/committer_guidelines.rst) ([latest version](https://docs.ansible.com/projects/ansible/devel/community/committer_guidelines.html)).
-
-These are the guidelines for people with commit privileges on the Ansible Community General Collection GitHub repository. Please read the guidelines before you commit.
-
-These guidelines apply to everyone. At the same time, this is NOT a process document. So just use good judgment. You have been given commit access because we trust your judgment.
-
-That said, use the trust wisely.
-
-If you abuse the trust and break components and builds, and so on, the trust level falls and you may be asked not to commit or you may lose your commit privileges.
-
-Our workflow on GitHub
-----------------------
-
-As a committer, you may already know this, but our workflow forms a lot of our team policies. Please ensure you are aware of the following workflow steps:
-
-* Fork the repository upon which you want to do some work to your own personal repository
-* Work on the specific branch upon which you need to commit
-* Create a Pull Request back to the collection repository and await reviews
-* Adjust code as necessary based on the Comments provided
-* Ask someone from the other committers to do a final review and merge
-
-Sometimes, committers merge their own pull requests. This section is a set of guidelines. If you are changing a comma in a doc or making a very minor change, you can use your best judgement. This is another trust thing. The process is critical for any major change, but for little things or getting something done quickly, use your best judgement and make sure people on the team are aware of your work.
-
-Roles
------
-* Release managers: Merge pull requests to `stable-X` branches, create tags to do releases.
-* Committers: Fine to do PRs for most things, but we should have a timebox. Hanging PRs may merge on the judgement of these devs.
-* Module maintainers: Module maintainers own specific modules and have indirect commit access through the current module PR mechanisms. This is primary [ansibullbot](https://github.com/ansibullbot)'s `shipit` mechanism.
-
-General rules
--------------
-Individuals with direct commit access to this collection repository are entrusted with powers that allow them to do a broad variety of things--probably more than we can write down. Rather than rules, treat these as general *guidelines*, individuals with this power are expected to use their best judgement.
-
-* Do NOTs:
-
-  - Do not commit directly.
-  - Do not merge your own PRs. Someone else should have a chance to review and approve the PR merge. You have a small amount of leeway here for very minor changes.
-  - Do not forget about non-standard / alternate environments. Consider the alternatives. Yes, people have bad/unusual/strange environments (like binaries from multiple init systems installed), but they are the ones who need us the most.
-  - Do not drag your community team members down. Discuss the technical merits of any pull requests you review. Avoid negativity and personal comments. For more guidance on being a good community member, read the [Ansible Community Code of Conduct](https://docs.ansible.com/projects/ansible/latest/community/code_of_conduct.html).
-  - Do not forget about the maintenance burden. High-maintenance features may not be worth adding.
-  - Do not break playbooks. Always keep backwards compatibility in mind.
-  - Do not forget to keep it simple. Complexity breeds all kinds of problems.
-  - Do not merge to branches other than `main`, especially not to `stable-X`, if you do not have explicit permission to do so.
-  - Do not create tags. Tags are used in the release process, and should only be created by the people responsible for managing the stable branches.
-
-* Do:
-
-  - Squash, avoid merges whenever possible, use GitHub's squash commits or cherry pick if needed (bisect thanks you).
-  - Be active. Committers who have no activity on the project (through merges, triage, commits, and so on) will have their permissions suspended.
-  - Consider backwards compatibility (goes back to "do not break existing playbooks").
-  - Write tests. PRs with tests are looked at with more priority than PRs without tests that should have them included. While not all changes require tests, be sure to add them for bug fixes or functionality changes.
-  - Discuss with other committers, specially when you are unsure of something.
-  - Document! If your PR is a new feature or a change to behavior, make sure you've updated all associated documentation or have notified the right people to do so.
-  - Consider scope, sometimes a fix can be generalized.
-  - Keep it simple, then things are maintainable, debuggable and intelligible.
-
-Committers are expected to continue to follow the same community and contribution guidelines followed by the rest of the Ansible community.
-
-
-People
-------
-
-Individuals who have been asked to become a part of this group have generally been contributing in significant ways to the community.general collection for some time. Should they agree, they are requested to add their names and GitHub IDs to this file, in the section below, through a pull request. Doing so indicates that these individuals agree to act in the ways that their fellow committers trust that they will act.
-
-| Name                | GitHub ID            | IRC Nick           | Other                |
-| ------------------- | -------------------- | ------------------ | -------------------- |
-| Alexei Znamensky    | russoz               | russoz             |                      |
-| Andrew Klychkov     | andersson007         | andersson007_      |                      |
-| Andrew Pantuso      | Ajpantuso            | ajpantuso          |                      |
-| Felix Fontein       | felixfontein         | felixfontein       |                      |
-| John R Barker       | gundalow             | gundalow           |                      |

docs/docsite/config.yml

@@ -1,17 +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
-
-changelog:
-  write_changelog: true
-
-ansible_output:
-  global_env:
-    ANSIBLE_STDOUT_CALLBACK: community.general.tasks_only
-    ANSIBLE_COLLECTIONS_TASKS_ONLY_NUMBER_OF_COLUMNS: 90
-  global_postprocessors:
-    reformat-yaml:
-      command:
-        - python
-        - docs/docsite/reformat-yaml.py

docs/docsite/extra-docs.yml

@@ -1,24 +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
-
-sections:
-  - title: Guides
-    toctree:
-      - filter_guide
-      - test_guide
-  - title: Technology Guides
-    toctree:
-      - guide_alicloud
-      - guide_iocage
-      - guide_online
-      - guide_packet
-      - guide_scaleway
-  - title: Developer Guides
-    toctree:
-      - guide_deps
-      - guide_vardict
-      - guide_cmdrunner
-      - guide_modulehelper
-      - guide_uthelper

docs/docsite/links.yml

@@ -1,33 +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
-
-edit_on_github:
-  repository: ansible-collections/community.general
-  branch: main
-  path_prefix: ''
-
-extra_links:
-  - description: Ask for help
-    url: https://forum.ansible.com/c/help/6/none
-  - description: Submit a bug report
-    url: https://github.com/ansible-collections/community.general/issues/new?assignees=&labels=&template=bug_report.yml
-  - description: Request a feature
-    url: https://github.com/ansible-collections/community.general/issues/new?assignees=&labels=&template=feature_request.yml
-
-communication:
-  matrix_rooms:
-    - topic: General usage and support questions
-      room: '#users:ansible.im'
-  irc_channels:
-    - topic: General usage and support questions
-      network: Libera
-      channel: '#ansible'
-  forums:
-    - topic: "Ansible Forum: General usage and support questions"
-      # The following URL directly points to the "Get Help" section
-      url: https://forum.ansible.com/c/help/6/none
-    - topic: "Ansible Forum: Discussions about the collection itself, not for specific modules or plugins"
-      # The following URL directly points to the "community-general" tag
-      url: https://forum.ansible.com/tag/community-general

docs/docsite/reformat-yaml.py

@@ -1,26 +0,0 @@
-#!/usr/bin/env python
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-import sys
-from io import StringIO
-
-from ruamel.yaml import YAML
-
-
-def main() -> None:
-    yaml = YAML(typ='rt')
-    yaml.indent(mapping=2, sequence=4, offset=2)
-
-    # Load
-    data = yaml.load(sys.stdin)
-
-    # Dump
-    sio = StringIO()
-    yaml.dump(data, sio)
-    print(sio.getvalue().rstrip('\n'))
-
-
-if __name__ == "__main__":
-    main()

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

@@ -1,218 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-keep_keys
-"""""""""
-
-Use the filter :ansplugin:`community.general.keep_keys#filter` if you have a list of dictionaries and want to keep certain keys only.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.keep_keys(target=target) }}"
-
-
-gives
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k0_x0: A0
-       k1_x1: B0
-     - k0_x0: A1
-       k1_x1: B1
-
-
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: ['k0_x0', 'k1_x1']
-              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k0_x0: A0
-       k1_x1: B0
-     - k0_x0: A1
-       k1_x1: B1
-
-
-1. Match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-2. Match keys that start with any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: ['k0', 'k1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-3. Match keys that end with any of the items in target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: ['x0', 'x1']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-4. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ['^.*[01]_x.*$']
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-5. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*[01]_x.*$
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 6-9 are all the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: k0_x0
-              result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k0_x0: A0
-     - k0_x0: A1
-
-
-6. Match keys that equal the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: k0_x0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-7. Match keys that start with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: k0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-8. Match keys that end with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: x0
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"
-
-9. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*0_x.*$
-   result: "{{ input | community.general.keep_keys(target=target, matching_parameter=mp) }}"

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

@@ -1,228 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-remove_keys
-"""""""""""
-
-Use the filter :ansplugin:`community.general.remove_keys#filter` if you have a list of dictionaries and want to remove certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1
-
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.remove_keys(target=target) }}"
-
-
-gives
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k2_x2:
-         - C0
-       k3_x3: foo
-     - k2_x2:
-         - C1
-       k3_x3: bar
-
-
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-5 are all the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: ['k0_x0', 'k1_x1']
-              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k2_x2:
-         - C0
-       k3_x3: foo
-     - k2_x2:
-         - C1
-       k3_x3: bar
-
-
-1. Match keys that equal any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: ['k0_x0', 'k1_x1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-2. Match keys that start with any of the items in the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: ['k0', 'k1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-3. Match keys that end with any of the items in target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: ['x0', 'x1']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-4. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ['^.*[01]_x.*$']
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-5. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*[01]_x.*$
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 6-9 are all the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: equal
-              target: k0_x0
-              result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - k1_x1: B0
-       k2_x2:
-         - C0
-       k3_x3: foo
-     - k1_x1: B1
-       k2_x2:
-         - C1
-       k3_x3: bar
-
-
-6. Match keys that equal the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: equal
-   target: k0_x0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-7. Match keys that start with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: starts_with
-   target: k0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-8. Match keys that end with the target.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: ends_with
-   target: x0
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"
-
-9. Match keys by the regex.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1,2
-
-   mp: regex
-   target: ^.*0_x.*$
-   result: "{{ input | community.general.remove_keys(target=target, matching_parameter=mp) }}"

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

@@ -1,257 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-replace_keys
-""""""""""""
-
-Use the filter :ansplugin:`community.general.replace_keys#filter` if you have a list of dictionaries and want to replace certain keys.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See :ansplugin:`the documentation for the community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-
-Let us use the below list in the following examples:
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
-.. code-block:: yaml
-
-   input:
-     - k0_x0: A0
-       k1_x1: B0
-       k2_x2: [C0]
-       k3_x3: foo
-     - k0_x0: A1
-       k1_x1: B1
-       k2_x2: [C1]
-       k3_x3: bar
-
-
-* By default, match keys that equal any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   target:
-     - {after: a0, before: k0_x0}
-     - {after: a1, before: k1_x1}
-
-   result: "{{ input | community.general.replace_keys(target=target) }}"
-
-
-gives
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - a0: A0
-       a1: B0
-       k2_x2:
-         - C0
-       k3_x3: foo
-     - a0: A1
-       a1: B1
-       k2_x2:
-         - C1
-       k3_x3: bar
-
-
-.. versionadded:: 9.1.0
-
-* The results of the below examples 1-3 are all the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: starts_with
-              target:
-                - {after: a0, before: k0}
-                - {after: a1, before: k1}
-              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - a0: A0
-       a1: B0
-       k2_x2:
-         - C0
-       k3_x3: foo
-     - a0: A1
-       a1: B1
-       k2_x2:
-         - C1
-       k3_x3: bar
-
-
-1. Replace keys that starts with any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: starts_with
-   target:
-     - {after: a0, before: k0}
-     - {after: a1, before: k1}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-2. Replace keys that ends with any of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: ends_with
-   target:
-     - {after: a0, before: x0}
-     - {after: a1, before: x1}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-3. Replace keys that match any regex of the attributes before.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: regex
-   target:
-     - {after: a0, before: ^.*0_x.*$}
-     - {after: a1, before: ^.*1_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-
-* The results of the below examples 4-5 are the same:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - vars:
-              @{{ data | indent(8) }}@
-
-              # I picked one of the examples
-              mp: regex
-              target:
-                - {after: X, before: ^.*_x.*$}
-              result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-            ansible.builtin.debug:
-              var: result
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - X: foo
-     - X: bar
-
-
-4. If more keys match the same attribute before the last one will be used.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   mp: regex
-   target:
-     - {after: X, before: ^.*_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-5. If there are items with equal attribute before the first one will be used.
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-3
-
-   mp: regex
-   target:
-     - {after: X, before: ^.*_x.*$}
-     - {after: Y, before: ^.*_x.*$}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-
-6. If there are more matches for a key the first one will be used.
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   input:
-     - {aaa1: A, bbb1: B, ccc1: C}
-     - {aaa2: D, bbb2: E, ccc2: F}
-
-
-.. code-block:: yaml+jinja
-   :emphasize-lines: 1-4
-
-   mp: starts_with
-   target:
-     - {after: X, before: a}
-     - {after: Y, before: aa}
-
-   result: "{{ input | community.general.replace_keys(target=target, matching_parameter=mp) }}"
-
-gives
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-   :emphasize-lines: 1-
-
-   result:
-     - X: A
-       bbb1: B
-       ccc1: C
-     - X: D
-       bbb2: E
-       ccc2: F

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

@@ -1,18 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.filter_guide.filter_guide_abstract_informations.lists_of_dicts:
-
-Lists of dictionaries
-^^^^^^^^^^^^^^^^^^^^^
-
-Filters to manage keys in a list of dictionaries:
-
-.. toctree::
-   :maxdepth: 1
-
-   filter_guide-abstract_informations-lists_of_dictionaries-keep_keys
-   filter_guide-abstract_informations-lists_of_dictionaries-remove_keys
-   filter_guide-abstract_informations-lists_of_dictionaries-replace_keys

docs/docsite/rst/filter_guide.rst

@@ -1,23 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.filter_guide:
-
-community.general Filter Guide
-==============================
-
-The :anscollection:`community.general collection <community.general#collection>` offers several useful filter plugins.
-
-.. toctree::
-   :maxdepth: 2
-
-   filter_guide_paths
-   filter_guide_abstract_informations
-   filter_guide_working_with_times
-   filter_guide_working_with_versions
-   filter_guide_creating_identifiers
-   filter_guide_conversions
-   filter_guide_selecting_json_data
-   filter_guide_working_with_unicode

docs/docsite/rst/filter_guide_abstract_informations.rst

@@ -1,17 +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
-
-Abstract transformations
-------------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   filter_guide_abstract_informations_dictionaries
-   filter_guide_abstract_informations_grouping
-   filter_guide-abstract_informations-lists_of_dictionaries
-   filter_guide_abstract_informations_merging_lists_of_dictionaries
-   filter_guide_abstract_informations_lists_helper
-   filter_guide_abstract_informations_counting_elements_in_sequence

docs/docsite/rst/filter_guide_abstract_informations_counting_elements_in_sequence.rst

@@ -1,104 +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
-
-Counting elements in a sequence
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The :ansplugin:`community.general.counter filter plugin <community.general.counter#filter>` allows you to count (hashable) elements in a sequence. Elements are returned as dictionary keys and their counts are stored as dictionary values.
-
-.. code-block:: yaml+jinja
-
-    - name: Count character occurrences in a string
-      debug:
-        msg: "{{ 'abccbaabca' | community.general.counter }}"
-
-    - name: Count items in a list
-      debug:
-        msg: "{{ ['car', 'car', 'bike', 'plane', 'bike'] | community.general.counter }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Count character occurrences in a string] ********************************************
-    ok: [localhost] => {
-        "msg": {
-            "a": 4,
-            "b": 3,
-            "c": 3
-        }
-    }
-
-    TASK [Count items in a list] **************************************************************
-    ok: [localhost] => {
-        "msg": {
-            "bike": 2,
-            "car": 2,
-            "plane": 1
-        }
-    }
-
-This plugin is useful for selecting resources based on current allocation:
-
-.. code-block:: yaml+jinja
-
-    - name: Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks
-      debug:
-        msg: >-
-          {{
-             ( disks | dict2items | map(attribute='value.adapter') | list
-               | community.general.counter | dict2items
-               | rejectattr('value', '>=', 4) | sort(attribute='value') | first
-             ).key
-          }}
-      vars:
-        disks:
-          sda:
-            adapter: scsi_1
-          sdb:
-            adapter: scsi_1
-          sdc:
-            adapter: scsi_1
-          sdd:
-            adapter: scsi_1
-          sde:
-            adapter: scsi_2
-          sdf:
-            adapter: scsi_3
-          sdg:
-            adapter: scsi_3
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Get ID of SCSI controller(s) with less than 4 disks attached and choose the one with the least disks] ***
-    ok: [localhost] => {
-        "msg": "scsi_2"
-    }
-
-.. versionadded:: 4.3.0

docs/docsite/rst/filter_guide_abstract_informations_dictionaries.rst

@@ -1,146 +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
-
-Dictionaries
-^^^^^^^^^^^^
-
-You can use the :ansplugin:`community.general.dict_kv filter <community.general.dict_kv#filter>` to create a single-entry dictionary with ``value | community.general.dict_kv(key)``:
-
-.. code-block:: yaml+jinja
-
-    - name: Create a single-entry dictionary
-      debug:
-        msg: "{{ myvar | community.general.dict_kv('thatsmyvar') }}"
-      vars:
-        myvar: myvalue
-
-    - name: Create a list of dictionaries where the 'server' field is taken from a list
-      debug:
-        msg: >-
-          {{ myservers | map('community.general.dict_kv', 'server')
-                       | map('combine', common_config) }}
-      vars:
-        common_config:
-          type: host
-          database: all
-        myservers:
-          - server1
-          - server2
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Create a single-entry dictionary] ***************************************************
-    ok: [localhost] => {
-        "msg": {
-            "thatsmyvar": "myvalue"
-        }
-    }
-
-    TASK [Create a list of dictionaries where the 'server' field is taken from a list] ********
-    ok: [localhost] => {
-        "msg": [
-            {
-                "database": "all",
-                "server": "server1",
-                "type": "host"
-            },
-            {
-                "database": "all",
-                "server": "server2",
-                "type": "host"
-            }
-        ]
-    }
-
-.. versionadded:: 2.0.0
-
-If you need to convert a list of key-value pairs to a dictionary, you can use the ``dict`` function. Unfortunately, this function cannot be used with ``map``. For this, the :ansplugin:`community.general.dict filter <community.general.dict#filter>` can be used:
-
-.. code-block:: yaml+jinja
-
-    - name: Create a dictionary with the dict function
-      debug:
-        msg: "{{ dict([[1, 2], ['a', 'b']]) }}"
-
-    - name: Create a dictionary with the community.general.dict filter
-      debug:
-        msg: "{{ [[1, 2], ['a', 'b']] | community.general.dict }}"
-
-    - name: Create a list of dictionaries with map and the community.general.dict filter
-      debug:
-        msg: >-
-          {{ values | map('zip', ['k1', 'k2', 'k3'])
-                    | map('map', 'reverse')
-                    | map('community.general.dict') }}
-      vars:
-        values:
-          - - foo
-            - 23
-            - a
-          - - bar
-            - 42
-            - b
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Create a dictionary with the dict function] *****************************************
-    ok: [localhost] => {
-        "msg": {
-            "1": 2,
-            "a": "b"
-        }
-    }
-
-    TASK [Create a dictionary with the community.general.dict filter] *************************
-    ok: [localhost] => {
-        "msg": {
-            "1": 2,
-            "a": "b"
-        }
-    }
-
-    TASK [Create a list of dictionaries with map and the community.general.dict filter] *******
-    ok: [localhost] => {
-        "msg": [
-            {
-                "k1": "foo",
-                "k2": 23,
-                "k3": "a"
-            },
-            {
-                "k1": "bar",
-                "k2": 42,
-                "k3": "b"
-            }
-        ]
-    }
-
-.. versionadded:: 3.0.0

docs/docsite/rst/filter_guide_abstract_informations_grouping.rst

@@ -1,146 +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
-
-Grouping
-^^^^^^^^
-
-If you have a list of dictionaries, the Jinja2 ``groupby`` filter allows to group the list by an attribute. This results in a list of ``(grouper, list)`` namedtuples, where ``list`` contains all dictionaries where the selected attribute equals ``grouper``. If you know that for every ``grouper``, there will be a most one entry in that list, you can use the :ansplugin:`community.general.groupby_as_dict filter <community.general.groupby_as_dict#filter>` to convert the original list into a dictionary which maps ``grouper`` to the corresponding dictionary.
-
-One example is ``ansible_facts.mounts``, which is a list of dictionaries where each has one ``device`` element to indicate the device which is mounted. Therefore, ``ansible_facts.mounts | community.general.groupby_as_dict('device')`` is a dictionary mapping a device to the mount information:
-
-.. code-block:: yaml+jinja
-
-    - name: Output mount facts grouped by device name
-      debug:
-        var: ansible_facts.mounts | community.general.groupby_as_dict('device')
-
-    - name: Output mount facts grouped by mount point
-      debug:
-        var: ansible_facts.mounts | community.general.groupby_as_dict('mount')
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    skip_first_lines: 3  # the set_fact task
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - ansible.builtin.set_fact:
-              ansible_facts:
-                mounts:
-                  - block_available: 2000
-                    block_size: 4096
-                    block_total: 2345
-                    block_used: 345
-                    device: "/dev/sda1"
-                    fstype: "ext4"
-                    inode_available: 500
-                    inode_total: 512
-                    inode_used: 12
-                    mount: "/boot"
-                    options: "rw,relatime,data=ordered"
-                    size_available: 56821
-                    size_total: 543210
-                    uuid: "ab31cade-d9c1-484d-8482-8a4cbee5241a"
-                  - block_available: 1234
-                    block_size: 4096
-                    block_total: 12345
-                    block_used: 11111
-                    device: "/dev/sda2"
-                    fstype: "ext4"
-                    inode_available: 1111
-                    inode_total: 1234
-                    inode_used: 123
-                    mount: "/"
-                    options: "rw,relatime"
-                    size_available: 42143
-                    size_total: 543210
-                    uuid: "abcdef01-2345-6789-0abc-def012345678"
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Output mount facts grouped by device name] ******************************************
-    ok: [localhost] => {
-        "ansible_facts.mounts | community.general.groupby_as_dict('device')": {
-            "/dev/sda1": {
-                "block_available": 2000,
-                "block_size": 4096,
-                "block_total": 2345,
-                "block_used": 345,
-                "device": "/dev/sda1",
-                "fstype": "ext4",
-                "inode_available": 500,
-                "inode_total": 512,
-                "inode_used": 12,
-                "mount": "/boot",
-                "options": "rw,relatime,data=ordered",
-                "size_available": 56821,
-                "size_total": 543210,
-                "uuid": "ab31cade-d9c1-484d-8482-8a4cbee5241a"
-            },
-            "/dev/sda2": {
-                "block_available": 1234,
-                "block_size": 4096,
-                "block_total": 12345,
-                "block_used": 11111,
-                "device": "/dev/sda2",
-                "fstype": "ext4",
-                "inode_available": 1111,
-                "inode_total": 1234,
-                "inode_used": 123,
-                "mount": "/",
-                "options": "rw,relatime",
-                "size_available": 42143,
-                "size_total": 543210,
-                "uuid": "abcdef01-2345-6789-0abc-def012345678"
-            }
-        }
-    }
-
-    TASK [Output mount facts grouped by mount point] ******************************************
-    ok: [localhost] => {
-        "ansible_facts.mounts | community.general.groupby_as_dict('mount')": {
-            "/": {
-                "block_available": 1234,
-                "block_size": 4096,
-                "block_total": 12345,
-                "block_used": 11111,
-                "device": "/dev/sda2",
-                "fstype": "ext4",
-                "inode_available": 1111,
-                "inode_total": 1234,
-                "inode_used": 123,
-                "mount": "/",
-                "options": "rw,relatime",
-                "size_available": 42143,
-                "size_total": 543210,
-                "uuid": "abcdef01-2345-6789-0abc-def012345678"
-            },
-            "/boot": {
-                "block_available": 2000,
-                "block_size": 4096,
-                "block_total": 2345,
-                "block_used": 345,
-                "device": "/dev/sda1",
-                "fstype": "ext4",
-                "inode_available": 500,
-                "inode_total": 512,
-                "inode_used": 12,
-                "mount": "/boot",
-                "options": "rw,relatime,data=ordered",
-                "size_available": 56821,
-                "size_total": 543210,
-                "uuid": "ab31cade-d9c1-484d-8482-8a4cbee5241a"
-            }
-        }
-    }
-
-.. versionadded: 3.0.0

docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst

@@ -1,134 +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
-
-Union, intersection and difference of lists
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Starting with Ansible Core 2.16, the builtin filters :ansplugin:`ansible.builtin.union#filter`, :ansplugin:`ansible.builtin.intersect#filter`, :ansplugin:`ansible.builtin.difference#filter` and :ansplugin:`ansible.builtin.symmetric_difference#filter` began to behave differently and do no longer preserve the item order. Items in the resulting lists are returned in arbitrary order and the order can vary between subsequent runs.
-
-The Ansible community.general collection provides the following additional list filters:
-
-- :ansplugin:`community.general.lists_union#filter`
-- :ansplugin:`community.general.lists_intersect#filter`
-- :ansplugin:`community.general.lists_difference#filter`
-- :ansplugin:`community.general.lists_symmetric_difference#filter`
-
-These filters preserve the item order, eliminate duplicates and are an extended version of the builtin ones, because they can operate on more than two lists.
-
-.. note:: Stick to the builtin filters, when item order is not important or when you do not need the n-ary operating mode. The builtin filters are faster, because they rely mostly on sets as their underlying datastructure.
-
-Let us use the lists below in the following examples:
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: result
-
-.. code-block:: yaml
-
-  A: [9, 5, 7, 1, 9, 4, 10, 5, 9, 7]
-  B: [4, 1, 2, 8, 3, 1, 7]
-  C: [10, 2, 1, 9, 1]
-
-The union of ``A`` and ``B`` can be written as:
-
-.. code-block:: yaml+jinja
-
-  result: "{{ A | community.general.lists_union(B) }}"
-
-This statement produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  result:
-    - 9
-    - 5
-    - 7
-    - 1
-    - 4
-    - 10
-    - 2
-    - 8
-    - 3
-
-If you want to calculate the intersection of ``A``, ``B`` and ``C``, you can use the following statement:
-
-.. code-block:: yaml+jinja
-
-  result: "{{ A | community.general.lists_intersect(B, C) }}"
-
-Alternatively, you can use a list of lists as an input of the filter
-
-.. code-block:: yaml+jinja
-
-  result: "{{ [A, B] | community.general.lists_intersect(C) }}"
-
-or
-
-.. code-block:: yaml+jinja
-
-  result: "{{ [A, B, C] | community.general.lists_intersect(flatten=true) }}"
-
-All three statements are equivalent and give:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  result:
-    - 1
-
-.. 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.
-
-For example, the symmetric difference of ``A``, ``B`` and ``C`` may be written as:
-
-.. code-block:: yaml+jinja
-
-  result: "{{ A | community.general.lists_symmetric_difference(B, C) }}"
-
-This gives:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  result:
-    - 5
-    - 8
-    - 3
-    - 1

docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst

@@ -1,393 +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
-
-Merging lists of dictionaries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you have two or more lists of dictionaries and want to combine them into a list of merged dictionaries, where the dictionaries are merged by an attribute, you can use the :ansplugin:`community.general.lists_mergeby <community.general.lists_mergeby#filter>` filter.
-
-.. note:: The output of the examples in this section use the YAML callback plugin. Quoting: "Ansible output that can be quite a bit easier to read than the default JSON formatting." See the documentation for the :ansplugin:`community.general.yaml callback plugin <community.general.yaml#callback>`.
-
-Let us use the lists below in the following examples:
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-    - name: set-template
-      template:
-        env:
-          ANSIBLE_CALLBACK_RESULT_FORMAT: yaml
-        variables:
-          data:
-            previous_code_block: yaml
-            previous_code_block_index: 0
-          computation:
-            previous_code_block: yaml+jinja
-        postprocessors:
-          - name: reformat-yaml
-        language: yaml
-        skip_first_lines: 2
-        playbook: |-
-          - hosts: localhost
-            gather_facts: false
-            tasks:
-              - vars:
-                  @{{ data | indent(8) }}@
-                  @{{ computation | indent(8) }}@
-                ansible.builtin.debug:
-                  var: list3
-
-.. code-block:: yaml
-
-  list1:
-    - {name: foo, extra: true}
-    - {name: bar, extra: false}
-    - {name: meh, extra: true}
-
-  list2:
-    - {name: foo, path: /foo}
-    - {name: baz, path: /baz}
-
-Two lists
-"""""""""
-In the example below the lists are merged by the attribute ``name``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ list1 |
-             community.general.lists_mergeby(list2, 'name') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
-
-
-.. versionadded:: 2.0.0
-
-List of two lists
-"""""""""""""""""
-It is possible to use a list of lists as an input of the filter:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name') }}"
-
-This produces the same result as in the previous example:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
-
-Single list
-"""""""""""
-It is possible to merge single list:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1 + list2, []] |
-             community.general.lists_mergeby('name') }}"
-
-This produces the same result as in the previous example:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - extra: false
-      name: bar
-    - name: baz
-      path: /baz
-    - extra: true
-      name: foo
-      path: /foo
-    - extra: true
-      name: meh
-
-
-The filter also accepts two optional parameters: :ansopt:`community.general.lists_mergeby#filter:recursive` and :ansopt:`community.general.lists_mergeby#filter:list_merge`. This is available since community.general 4.4.0.
-
-**recursive**
-    Is a boolean, default to ``false``. Should the :ansplugin:`community.general.lists_mergeby#filter` filter recursively merge nested hashes. Note: It does not depend on the value of the ``hash_behaviour`` setting in ``ansible.cfg``.
-
-**list_merge**
-    Is a string, its possible values are :ansval:`replace` (default), :ansval:`keep`, :ansval:`append`, :ansval:`prepend`, :ansval:`append_rp` or :ansval:`prepend_rp`. It modifies the behaviour of :ansplugin:`community.general.lists_mergeby#filter` when the hashes to merge contain arrays/lists.
-
-The examples below set :ansopt:`community.general.lists_mergeby#filter:recursive=true` and display the differences among all six options of :ansopt:`community.general.lists_mergeby#filter:list_merge`. Functionality of the parameters is exactly the same as in the filter :ansplugin:`ansible.builtin.combine#filter`. See :ref:`Combining hashes/dictionaries <combine_filter>` to learn details about these options.
-
-Let us use the lists below in the following examples
-
-.. ansible-output-meta::
-
-  actions:
-    - name: reset-previous-blocks
-
-.. code-block:: yaml
-
-  list1:
-    - name: myname01
-      param01:
-        x: default_value
-        y: default_value
-        list: [default_value]
-    - name: myname02
-      param01: [1, 1, 2, 3]
-
-  list2:
-    - name: myname01
-      param01:
-        y: patch_value
-        z: patch_value
-        list: [patch_value]
-    - name: myname02
-      param01: [3, 4, 4]
-
-list_merge=replace (default)
-""""""""""""""""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=replace` (default):
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true) }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - patch_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
-
-list_merge=keep
-"""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=keep`:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='keep') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - default_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
-
-list_merge=append
-"""""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append`:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='append') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - default_value
-          - patch_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
-        - 3
-        - 4
-        - 4
-
-list_merge=prepend
-""""""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend`:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='prepend') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - patch_value
-          - default_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
-        - 1
-        - 1
-        - 2
-        - 3
-
-list_merge=append_rp
-""""""""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=append_rp`:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='append_rp') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - default_value
-          - patch_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 1
-        - 1
-        - 2
-        - 3
-        - 4
-        - 4
-
-list_merge=prepend_rp
-"""""""""""""""""""""
-Example :ansopt:`community.general.lists_mergeby#filter:list_merge=prepend_rp`:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2] |
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='prepend_rp') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: ~
-
-.. code-block:: yaml
-
-  list3:
-    - name: myname01
-      param01:
-        list:
-          - patch_value
-          - default_value
-        x: default_value
-        y: patch_value
-        z: patch_value
-    - name: myname02
-      param01:
-        - 3
-        - 4
-        - 4
-        - 1
-        - 1
-        - 2

docs/docsite/rst/filter_guide_conversions.rst

@@ -1,152 +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
-
-Conversions
------------
-
-Parsing CSV files
-^^^^^^^^^^^^^^^^^
-
-Ansible offers the :ansplugin:`community.general.read_csv module <community.general.read_csv#module>` to read CSV files. Sometimes you need to convert strings to CSV files instead. For this, the :ansplugin:`community.general.from_csv filter <community.general.from_csv#filter>` exists.
-
-.. code-block:: yaml+jinja
-
-    - name: "Parse CSV from string"
-      debug:
-        msg: "{{ csv_string | community.general.from_csv }}"
-      vars:
-        csv_string: |
-          foo,bar,baz
-          1,2,3
-          you,this,then
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Parse CSV from string] **************************************************************
-    ok: [localhost] => {
-        "msg": [
-            {
-                "bar": "2",
-                "baz": "3",
-                "foo": "1"
-            },
-            {
-                "bar": "this",
-                "baz": "then",
-                "foo": "you"
-            }
-        ]
-    }
-
-The :ansplugin:`community.general.from_csv filter <community.general.from_csv#filter>` has several keyword arguments to control its behavior:
-
-:dialect: Dialect of the CSV file. Default is ``excel``. Other possible choices are ``excel-tab`` and ``unix``. If one of ``delimiter``, ``skipinitialspace`` or ``strict`` is specified, ``dialect`` is ignored.
-:fieldnames: A set of column names to use. If not provided, the first line of the CSV is assumed to contain the column names.
-:delimiter: Sets the delimiter to use. Default depends on the dialect used.
-:skipinitialspace: Set to ``true`` to ignore space directly after the delimiter. Default depends on the dialect used (usually ``false``).
-:strict: Set to ``true`` to error out on invalid CSV input.
-
-.. versionadded: 3.0.0
-
-Converting to JSON
-^^^^^^^^^^^^^^^^^^
-
-`JC <https://pypi.org/project/jc/>`_ is a CLI tool and Python library which allows to interpret output of various CLI programs as JSON. It is also available as a filter in community.general, called :ansplugin:`community.general.jc#filter`. This filter needs the `jc Python library <https://pypi.org/project/jc/>`_ installed on the controller.
-
-.. code-block:: yaml+jinja
-
-    - name: Run 'ls' to list files in /
-      command: ls /
-      register: result
-
-    - name: Parse the ls output
-      debug:
-        msg: "{{ result.stdout | community.general.jc('ls') }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    skip_first_lines: 3
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - ansible.builtin.set_fact:
-              result_stdout: |-
-                bin
-                boot
-                dev
-                etc
-                home
-                lib
-                proc
-                root
-                run
-                tmp
-
-          - name: Run 'ls' to list files in /
-            command: ls /
-            register: result
-
-          - name: Parse the ls output
-            debug:
-              msg: "{{ result_stdout | community.general.jc('ls') }}"
-
-.. code-block:: ansible-output
-
-    TASK [Run 'ls' to list files in /] ********************************************************
-    changed: [localhost]
-
-    TASK [Parse the ls output] ****************************************************************
-    ok: [localhost] => {
-        "msg": [
-            {
-                "filename": "bin"
-            },
-            {
-                "filename": "boot"
-            },
-            {
-                "filename": "dev"
-            },
-            {
-                "filename": "etc"
-            },
-            {
-                "filename": "home"
-            },
-            {
-                "filename": "lib"
-            },
-            {
-                "filename": "proc"
-            },
-            {
-                "filename": "root"
-            },
-            {
-                "filename": "run"
-            },
-            {
-                "filename": "tmp"
-            }
-        ]
-    }
-
-.. versionadded: 2.0.0

docs/docsite/rst/filter_guide_creating_identifiers.rst

@@ -1,112 +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
-
-Creating identifiers
---------------------
-
-The following filters allow to create identifiers.
-
-Hashids
-^^^^^^^
-
-`Hashids <https://hashids.org/>`_ allow to convert sequences of integers to short unique string identifiers. The :ansplugin:`community.general.hashids_encode#filter` and :ansplugin:`community.general.hashids_decode#filter` filters need the `hashids Python library <https://pypi.org/project/hashids/>`_ installed on the controller.
-
-.. code-block:: yaml+jinja
-
-    - name: "Create hashid"
-      debug:
-        msg: "{{ [1234, 5, 6] | community.general.hashids_encode }}"
-
-    - name: "Decode hashid"
-      debug:
-        msg: "{{ 'jm2Cytn' | community.general.hashids_decode }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Create hashid] **********************************************************************
-    ok: [localhost] => {
-        "msg": "jm2Cytn"
-    }
-
-    TASK [Decode hashid] **********************************************************************
-    ok: [localhost] => {
-        "msg": [
-            1234,
-            5,
-            6
-        ]
-    }
-
-The hashids filters accept keyword arguments to allow fine-tuning the hashids generated:
-
-:salt: String to use as salt when hashing.
-:alphabet: String of 16 or more unique characters to produce a hash.
-:min_length: Minimum length of hash produced.
-
-.. versionadded: 3.0.0
-
-Random MACs
-^^^^^^^^^^^
-
-You can use the :ansplugin:`community.general.random_mac filter <community.general.random_mac#filter>` to complete a partial `MAC address <https://en.wikipedia.org/wiki/MAC_address>`_ to a random 6-byte MAC address.
-
-.. code-block:: yaml+jinja
-
-    - name: "Create a random MAC starting with ff:"
-      debug:
-        msg: "{{ 'FF' | community.general.random_mac }}"
-
-    - name: "Create a random MAC starting with 00:11:22:"
-      debug:
-        msg: "{{ '00:11:22' | community.general.random_mac }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          - name: "Create a random MAC starting with ff:"
-            debug:
-              # We're using a seed here to avoid randomness in the output
-              msg: "{{ 'FF' | community.general.random_mac(seed='') }}"
-
-          - name: "Create a random MAC starting with 00:11:22:"
-            debug:
-              # We're using a seed here to avoid randomness in the output
-              msg: "{{ '00:11:22' | community.general.random_mac(seed='') }}"
-
-.. code-block:: ansible-output
-
-    TASK [Create a random MAC starting with ff:] **********************************************
-    ok: [localhost] => {
-        "msg": "ff:84:f5:d1:59:20"
-    }
-
-    TASK [Create a random MAC starting with 00:11:22:] ****************************************
-    ok: [localhost] => {
-        "msg": "00:11:22:84:f5:d1"
-    }
-
-You can also initialize the random number generator from a seed to create random-but-idempotent MAC addresses:
-
-.. code-block:: yaml+jinja
-
-    "{{ '52:54:00' | community.general.random_mac(seed=inventory_hostname) }}"

docs/docsite/rst/filter_guide_paths.rst

@@ -1,9 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-Paths
------
-
-The :ansplugin:`ansible.builtin.path_join filter <ansible.builtin.path_join#filter>` has been added in ansible-base 2.10. Community.general 3.0.0 and newer contains an alias ``community.general.path_join`` for this filter that could be used on Ansible 2.9 as well. Since community.general no longer supports Ansible 2.9, this is now a simple redirect to :ansplugin:`ansible.builtin.path_join filter <ansible.builtin.path_join#filter>`.

docs/docsite/rst/filter_guide_selecting_json_data.rst

@@ -1,149 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.json_query_filter:
-
-Selecting JSON data: JSON queries
----------------------------------
-
-To select a single element or a data subset from a complex data structure in JSON format (for example, Ansible facts), use the :ansplugin:`community.general.json_query filter <community.general.json_query#filter>`.  The :ansplugin:`community.general.json_query#filter` filter lets you query a complex JSON structure and iterate over it using a loop structure.
-
-.. note:: You must manually install the **jmespath** dependency on the Ansible controller before using this filter. This filter is built upon **jmespath**, and you can use the same syntax. For examples, see `jmespath examples <http://jmespath.org/examples.html>`_.
-
-Consider this data structure:
-
-.. code-block:: yaml+jinja
-
-    {
-      "domain_definition": {
-        "domain": {
-          "cluster": [
-            {
-              "name": "cluster1"
-            },
-            {
-              "name": "cluster2"
-            }
-          ],
-          "server": [
-            {
-              "name": "server11",
-              "cluster": "cluster1",
-              "port": "8080"
-            },
-            {
-              "name": "server12",
-              "cluster": "cluster1",
-              "port": "8090"
-            },
-            {
-              "name": "server21",
-              "cluster": "cluster2",
-              "port": "9080"
-            },
-            {
-              "name": "server22",
-              "cluster": "cluster2",
-              "port": "9090"
-            }
-          ],
-          "library": [
-            {
-              "name": "lib1",
-              "target": "cluster1"
-            },
-            {
-              "name": "lib2",
-              "target": "cluster2"
-            }
-          ]
-        }
-      }
-    }
-
-To extract all clusters from this structure, you can use the following query:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all cluster names
-      ansible.builtin.debug:
-        var: item
-      loop: "{{ domain_definition | community.general.json_query('domain.cluster[*].name') }}"
-
-To extract all server names:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all server names
-      ansible.builtin.debug:
-        var: item
-      loop: "{{ domain_definition | community.general.json_query('domain.server[*].name') }}"
-
-To extract ports from cluster1:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all ports from cluster1
-      ansible.builtin.debug:
-        var: item
-      loop: "{{ domain_definition | community.general.json_query(server_name_cluster1_query) }}"
-      vars:
-        server_name_cluster1_query: "domain.server[?cluster=='cluster1'].port"
-
-.. note:: You can use a variable to make the query more readable.
-
-To print out the ports from cluster1 in a comma separated string:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all ports from cluster1 as a string
-      ansible.builtin.debug:
-        msg: "{{ domain_definition | community.general.json_query('domain.server[?cluster==`cluster1`].port') | join(', ') }}"
-
-.. note:: In the example above, quoting literals using backticks avoids escaping quotes and maintains readability.
-
-You can use YAML `single quote escaping <https://yaml.org/spec/current.html#id2534365>`_:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all ports from cluster1
-      ansible.builtin.debug:
-        var: item
-      loop: "{{ domain_definition | community.general.json_query('domain.server[?cluster==''cluster1''].port') }}"
-
-.. note:: Escaping single quotes within single quotes in YAML is done by doubling the single quote.
-
-To get a hash map with all ports and names of a cluster:
-
-.. code-block:: yaml+jinja
-
-    - name: Display all server ports and names from cluster1
-      ansible.builtin.debug:
-        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}"
-
-To extract ports from all clusters with name starting with 'server1':
-
-.. code-block:: yaml+jinja
-
-    - name: Display all ports from cluster1
-      ansible.builtin.debug:
-        msg: "{{ domain_definition | to_json | from_json | community.general.json_query(server_name_query) }}"
-      vars:
-        server_name_query: "domain.server[?starts_with(name,'server1')].port"
-
-To extract ports from all clusters with name containing 'server1':
-
-.. code-block:: yaml+jinja
-
-    - name: Display all ports from cluster1
-      ansible.builtin.debug:
-        msg: "{{ domain_definition | to_json | from_json | community.general.json_query(server_name_query) }}"
-      vars:
-        server_name_query: "domain.server[?contains(name,'server1')].port"
-
-.. note:: while using ``starts_with`` and ``contains``, you have to use ``to_json | from_json`` filter for correct parsing of data structure.

docs/docsite/rst/filter_guide_working_with_times.rst

@@ -1,100 +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
-
-Working with times
-------------------
-
-The :ansplugin:`community.general.to_time_unit filter <community.general.to_time_unit#filter>` allows to convert times from a human-readable string to a unit. For example, ``'4h 30min 12second' | community.general.to_time_unit('hour')`` gives the number of hours that correspond to 4 hours, 30 minutes and 12 seconds.
-
-There are shorthands to directly convert to various units, like :ansplugin:`community.general.to_hours#filter`, :ansplugin:`community.general.to_minutes#filter`, :ansplugin:`community.general.to_seconds#filter`, and so on. The following table lists all units that can be used:
-
-.. list-table:: Units
-   :widths: 25 25 25 25
-   :header-rows: 1
-
-   * - Unit name
-     - Unit value in seconds
-     - Unit strings for filter
-     - Shorthand filter
-   * - Millisecond
-     - 1/1000 second
-     - ``ms``, ``millisecond``, ``milliseconds``, ``msec``, ``msecs``, ``msecond``, ``mseconds``
-     - :ansplugin:`community.general.to_milliseconds#filter`
-   * - Second
-     - 1 second
-     - ``s``, ``sec``, ``secs``, ``second``, ``seconds``
-     - :ansplugin:`community.general.to_seconds#filter`
-   * - Minute
-     - 60 seconds
-     - ``m``, ``min``, ``mins``, ``minute``, ``minutes``
-     - :ansplugin:`community.general.to_minutes#filter`
-   * - Hour
-     - 60*60 seconds
-     - ``h``, ``hour``, ``hours``
-     - :ansplugin:`community.general.to_hours#filter`
-   * - Day
-     - 24*60*60 seconds
-     - ``d``, ``day``, ``days``
-     - :ansplugin:`community.general.to_days#filter`
-   * - Week
-     - 7*24*60*60 seconds
-     - ``w``, ``week``, ``weeks``
-     - :ansplugin:`community.general.to_weeks#filter`
-   * - Month
-     - 30*24*60*60 seconds
-     - ``mo``, ``month``, ``months``
-     - :ansplugin:`community.general.to_months#filter`
-   * - Year
-     - 365*24*60*60 seconds
-     - ``y``, ``year``, ``years``
-     - :ansplugin:`community.general.to_years#filter`
-
-Note that months and years are using a simplified representation: a month is 30 days, and a year is 365 days. If you need different definitions of months or years, you can pass them as keyword arguments. For example, if you want a year to be 365.25 days, and a month to be 30.5 days, you can write ``'11months 4' | community.general.to_years(year=365.25, month=30.5)``. These keyword arguments can be specified to :ansplugin:`community.general.to_time_unit#filter` and to all shorthand filters.
-
-.. code-block:: yaml+jinja
-
-    - name: Convert string to seconds
-      debug:
-        msg: "{{ '30h 20m 10s 123ms' | community.general.to_time_unit('seconds') }}"
-
-    - name: Convert string to hours
-      debug:
-        msg: "{{ '30h 20m 10s 123ms' | community.general.to_hours }}"
-
-    - name: Convert string to years (using 365.25 days == 1 year)
-      debug:
-        msg: "{{ '400d 15h' | community.general.to_years(year=365.25) }}"
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Convert string to seconds] **********************************************************
-    ok: [localhost] => {
-        "msg": 109210.123
-    }
-
-    TASK [Convert string to hours] ************************************************************
-    ok: [localhost] => {
-        "msg": 30.336145277778
-    }
-
-    TASK [Convert string to years (using 365.25 days == 1 year)] ******************************
-    ok: [localhost] => {
-        "msg": 1.096851471595
-    }
-
-.. versionadded: 0.2.0

docs/docsite/rst/filter_guide_working_with_unicode.rst

@@ -1,46 +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
-
-Working with Unicode
----------------------
-
-`Unicode <https://unicode.org/main.html>`_ makes it possible to produce two strings which may be visually equivalent, but are comprised of distinctly different characters/character sequences. To address this Unicode defines `normalization forms <https://unicode.org/reports/tr15/>`_ which avoid these distinctions by choosing a unique character sequence for a given visual representation.
-
-You can use the :ansplugin:`community.general.unicode_normalize filter <community.general.unicode_normalize#filter>` to normalize Unicode strings within your playbooks.
-
-.. code-block:: yaml+jinja
-
-    - name: Compare Unicode representations
-      debug:
-        msg: "{{ with_combining_character | community.general.unicode_normalize == without_combining_character }}"
-      vars:
-        with_combining_character: "{{ 'Mayagu\u0308ez' }}"
-        without_combining_character: Mayagüez
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Compare Unicode representations] ****************************************************
-    ok: [localhost] => {
-        "msg": true
-    }
-
-The :ansplugin:`community.general.unicode_normalize filter <community.general.unicode_normalize#filter>` accepts a keyword argument :ansopt:`community.general.unicode_normalize#filter:form` to select the Unicode form used to normalize the input string.
-
-:form: One of ``'NFC'`` (default), ``'NFD'``, ``'NFKC'``, or ``'NFKD'``. See the `Unicode reference <https://unicode.org/reports/tr15/>`_ for more information.
-
-.. versionadded:: 3.7.0

docs/docsite/rst/filter_guide_working_with_versions.rst

@@ -1,50 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-Working with versions
----------------------
-
-If you need to sort a list of version numbers, the Jinja ``sort`` filter is problematic. Since it sorts lexicographically, ``2.10`` will come before ``2.9``. To treat version numbers correctly, you can use the :ansplugin:`community.general.version_sort filter <community.general.version_sort#filter>`:
-
-.. code-block:: yaml+jinja
-
-    - name: Sort list by version number
-      debug:
-        var: ansible_versions | community.general.version_sort
-      vars:
-        ansible_versions:
-          - '2.8.0'
-          - '2.11.0'
-          - '2.7.0'
-          - '2.10.0'
-          - '2.9.0'
-
-This produces:
-
-.. ansible-output-data::
-
-    variables:
-      task:
-        previous_code_block: yaml+jinja
-    playbook: |-
-      - hosts: localhost
-        gather_facts: false
-        tasks:
-          @{{ task | indent(4) }}@
-
-.. code-block:: ansible-output
-
-    TASK [Sort list by version number] ********************************************************
-    ok: [localhost] => {
-        "ansible_versions | community.general.version_sort": [
-            "2.7.0",
-            "2.8.0",
-            "2.9.0",
-            "2.10.0",
-            "2.11.0"
-        ]
-    }
-
-.. versionadded: 2.2.0

docs/docsite/rst/guide_alicloud.rst

@@ -1,96 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_alicloud:
-
-Alibaba Cloud Compute Services Guide
-====================================
-
-Introduction
-````````````
-
-The community.general collection contains several modules for controlling and managing Alibaba Cloud Compute Services (Alicloud).  This guide
-explains how to use the Alicloud Ansible modules together.
-
-All Alicloud modules require ``footmark`` - install it on your control machine with ``pip install footmark``.
-
-Cloud modules, including Alicloud modules, are usually executed on your local machine (the control machine) with ``connection: local``, rather than on remote machines defined in your hosts.
-
-Normally, you'll use the following pattern for plays that provision Alicloud resources:
-
-.. code-block:: yaml
-
-    - hosts: localhost
-      connection: local
-      vars:
-        - ...
-      tasks:
-        - ...
-
-Authentication
-``````````````
-
-You can specify your Alicloud authentication credentials (access key and secret key) by passing them as
-environment variables or by storing them in a vars file.
-
-To pass authentication credentials as environment variables:
-
-.. code-block:: console
-
-    export ALICLOUD_ACCESS_KEY='Alicloud123'
-    export ALICLOUD_SECRET_KEY='AlicloudSecret123'
-
-To store authentication credentials in a vars file, encrypt them with :ref:`Ansible Vault <vault>` to keep them secure, then list them:
-
-.. code-block:: yaml
-
-    ---
-    alicloud_access_key: "--REMOVED--"
-    alicloud_secret_key: "--REMOVED--"
-
-Note that if you store your credentials in a vars file, you need to refer to them in each Alicloud module. For example:
-
-.. code-block:: yaml+jinja
-
-    - community.general.ali_instance:
-        alicloud_access_key: "{{ alicloud_access_key }}"
-        alicloud_secret_key: "{{ alicloud_secret_key }}"
-        image_id: "..."
-
-Provisioning
-````````````
-
-Alicloud modules create Alicloud ECS instances (:ansplugin:`community.general.ali_instance#module`) and retrieve information on these (:ansplugin:`community.general.ali_instance_info#module`).
-
-You can use the ``count`` parameter to control the number of resources you create or terminate. For example, if you want exactly 5 instances tagged ``NewECS``, set the ``count`` of instances to 5 and the ``count_tag`` to ``NewECS``, as shown in the last task of the example playbook below. If there are no instances with the tag ``NewECS``, the task creates 5 new instances. If there are 2 instances with that tag, the task creates 3 more. If there are 8 instances with that tag, the task terminates 3 of those instances.
-
-If you do not specify a ``count_tag``, the task creates the number of instances you specify in ``count`` with the ``instance_name`` you provide.
-
-.. code-block:: yaml+jinja
-
-    # alicloud_setup.yml
-
-    - hosts: localhost
-      connection: local
-
-      tasks:
-        - name: Create a set of instances
-          community.general.ali_instance:
-            instance_type: ecs.n4.small
-            image_id: "{{ ami_id }}"
-            instance_name: "My-new-instance"
-            instance_tags:
-              Name: NewECS
-              Version: 0.0.1
-            count: 5
-            count_tag:
-              Name: NewECS
-            allocate_public_ip: true
-            max_bandwidth_out: 50
-          register: create_instance
-
-In the example playbook above, data about the instances created by this playbook is saved in the variable defined by the ``register`` keyword in the task.
-
-Each Alicloud module offers a variety of parameter options. Not all options are demonstrated in the above example. See each individual module for further details and examples.

docs/docsite/rst/guide_cmdrunner.rst

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

docs/docsite/rst/guide_deps.rst

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

docs/docsite/rst/guide_iocage.rst

@@ -1,15 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage:
-
-************
-Iocage Guide
-************
-
-.. toctree::
-   :maxdepth: 1
-
-   guide_iocage_inventory

docs/docsite/rst/guide_iocage_inventory.rst

@@ -1,31 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory:
-
-community.general.iocage inventory plugin
-=========================================
-
-The inventory plugin :ansplugin:`community.general.iocage#inventory` gets the inventory hosts from the iocage jail manager.
-
-See:
-
-* `iocage - A FreeBSD Jail Manager <https://iocage.readthedocs.io/en/latest>`_
-* `man iocage <https://man.freebsd.org/cgi/man.cgi?query=iocage>`_
-* `Jails and Containers <https://docs.freebsd.org/en/books/handbook/jails>`_
-
-.. note::
-  The output of the examples is YAML formatted. See the option :ansopt:`ansible.builtin.default#callback:result_format`.
-
-.. toctree::
-   :caption: Table of Contents
-   :maxdepth: 1
-
-   guide_iocage_inventory_basics
-   guide_iocage_inventory_dhcp
-   guide_iocage_inventory_hooks
-   guide_iocage_inventory_properties
-   guide_iocage_inventory_tags
-   guide_iocage_inventory_aliases

docs/docsite/rst/guide_iocage_inventory_aliases.rst

@@ -1,200 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_aliases:
-
-Aliases
--------
-
-Quoting :ref:`inventory_aliases`:
-
-   The ``inventory_hostname`` is the unique identifier for a host in Ansible, this can be an IP or a hostname, but also just an 'alias' or short name for the host.
-
-As root at the iocage host, stop and destroy all jails:
-
-.. code-block:: console
-
-   shell> iocage stop ALL
-   * Stopping srv_1
-     + Executing prestop OK
-     + Stopping services OK
-     + Tearing down VNET OK
-     + Removing devfs_ruleset: 1000 OK
-     + Removing jail process OK
-     + Executing poststop OK
-   * Stopping srv_2
-     + Executing prestop OK
-     + Stopping services OK
-     + Tearing down VNET OK
-     + Removing devfs_ruleset: 1001 OK
-     + Removing jail process OK
-     + Executing poststop OK
-   * Stopping srv_3
-     + Executing prestop OK
-     + Stopping services OK
-     + Tearing down VNET OK
-     + Removing devfs_ruleset: 1002 OK
-     + Removing jail process OK
-     + Executing poststop OK
-   ansible_client is not running!
-
-   shell> iocage destroy -f srv_1 srv_2 srv_3
-   Destroying srv_1
-   Destroying srv_2
-   Destroying srv_3
-
-Create three VNET jails with a DHCP interface from the template *ansible_client*. Use the option ``--count``:
-
-.. code-block:: console
-
-   shell> iocage create --short --template ansible_client --count 3 bpf=1 dhcp=1 vnet=1
-   1c11de2d successfully created!
-   9d94cc9e successfully created!
-   052b9557 successfully created!
-
-The names are random. Start the jails:
-
-.. code-block:: console
-
-   shell> iocage start ALL
-   No default gateway found for ipv6.
-   * Starting 052b9557
-     + Started OK
-     + Using devfs_ruleset: 1000 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.137/24
-   No default gateway found for ipv6.
-   * Starting 1c11de2d
-     + Started OK
-     + Using devfs_ruleset: 1001 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.146/24
-   No default gateway found for ipv6.
-   * Starting 9d94cc9e
-     + Started OK
-     + Using devfs_ruleset: 1002 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.115/24
-   Please convert back to a jail before trying to start ansible_client
-
-List the jails:
-
-.. code-block:: console
-
-   shell> iocage list -l
-   +-----+----------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | JID |   NAME   | BOOT | STATE | TYPE |     RELEASE     |        IP4         | IP6 |    TEMPLATE    | BASEJAIL |
-   +=====+==========+======+=======+======+=================+====================+=====+================+==========+
-   | 207 | 052b9557 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.137 | -   | ansible_client | no       |
-   +-----+----------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 208 | 1c11de2d | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.146 | -   | ansible_client | no       |
-   +-----+----------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 209 | 9d94cc9e | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.115 | -   | ansible_client | no       |
-   +-----+----------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-
-Set notes. The tag *alias* will be used to create inventory aliases:
-
-.. code-block:: console
-
-   shell> iocage set notes="vmm=iocage_02 project=foo alias=srv_1" 052b9557
-   notes: none -> vmm=iocage_02 project=foo alias=srv_1
-   shell> iocage set notes="vmm=iocage_02 project=foo alias=srv_2" 1c11de2d
-   notes: none -> vmm=iocage_02 project=foo alias=srv_2
-   shell> iocage set notes="vmm=iocage_02 project=bar alias=srv_3" 9d94cc9e
-   notes: none -> vmm=iocage_02 project=bar alias=srv_3
-
-Update the inventory configuration. Set the option
-:ansopt:`community.general.iocage#inventory:inventory_hostname_tag` to :ansval:`alias`. This tag keeps the
-value of the alias. The option :ansopt:`community.general.iocage#inventory:get_properties` must be
-enabled. For example, ``hosts/02_iocage.yml`` contains:
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   get_properties: true
-   inventory_hostname_tag: alias
-   hooks_results:
-     - /var/db/dhclient-hook.address.epair0b
-   compose:
-     ansible_host: (iocage_hooks.0 == '-') | ternary(iocage_ip4, iocage_hooks.0)
-     iocage_tags: dict(iocage_properties.notes | split | map('split', '='))
-   keyed_groups:
-     - prefix: vmm
-       key: iocage_tags.vmm
-     - prefix: project
-       key: iocage_tags.project
-
-Display tags and groups. Create a playbook ``pb-test-groups.yml`` with the following content:
-
-.. code-block:: yaml+jinja
-
-   - hosts: all
-     remote_user: admin
-
-     vars:
-
-       ansible_python_interpreter: auto_silent
-
-     tasks:
-
-       - debug:
-           var: iocage_tags
-
-       - debug:
-           msg: |
-             {% for group in groups %}
-             {{ group }}: {{ groups[group] }}
-             {% endfor %}
-         run_once: true
-
-Run the playbook:
-
-.. code-block:: console
-
-   shell> ansible-playbook -i hosts/02_iocage.yml pb-test-groups.yml
-
-   PLAY [all] **********************************************************************************************************
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_1] =>
-       iocage_tags:
-           alias: srv_1
-           project: foo
-           vmm: iocage_02
-   ok: [srv_2] =>
-       iocage_tags:
-           alias: srv_2
-           project: foo
-           vmm: iocage_02
-   ok: [srv_3] =>
-       iocage_tags:
-           alias: srv_3
-           project: bar
-           vmm: iocage_02
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_1] =>
-       msg: |-
-           all: ['srv_1', 'srv_2', 'srv_3']
-           ungrouped: []
-           vmm_iocage_02: ['srv_1', 'srv_2', 'srv_3']
-           project_foo: ['srv_1', 'srv_2']
-           project_bar: ['srv_3']
-
-   PLAY RECAP **********************************************************************************************************
-   srv_1                      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_2                      : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_3                      : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

docs/docsite/rst/guide_iocage_inventory_basics.rst

@@ -1,128 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_basics:
-
-Basics
-------
-
-As root at the iocage host, create three VNET jails with a DHCP interface from the template
-*ansible_client*:
-
-.. code-block:: console
-
-   shell> iocage create --template ansible_client --name srv_1 bpf=1 dhcp=1 vnet=1
-   srv_1 successfully created!
-   shell> iocage create --template ansible_client --name srv_2 bpf=1 dhcp=1 vnet=1
-   srv_2 successfully created!
-   shell> iocage create --template ansible_client --name srv_3 bpf=1 dhcp=1 vnet=1
-   srv_3 successfully created!
-
-See: `Configuring a VNET Jail <https://iocage.readthedocs.io/en/latest/networking.html#configuring-a-vnet-jail>`_.
-
-As admin at the controller, list the jails:
-
-.. code-block:: console
-
-   shell> ssh admin@10.1.0.73 iocage list -l
-   +------+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | JID  | NAME  | BOOT | STATE | TYPE |     RELEASE     |        IP4         | IP6 |    TEMPLATE    | BASEJAIL |
-   +======+=======+======+=======+======+=================+====================+=====+================+==========+
-   | None | srv_1 | off  | down  | jail | 14.2-RELEASE-p3 | DHCP (not running) | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | None | srv_2 | off  | down  | jail | 14.2-RELEASE-p3 | DHCP (not running) | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | None | srv_3 | off  | down  | jail | 14.2-RELEASE-p3 | DHCP (not running) | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-
-Create the inventory file ``hosts/02_iocage.yml``
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-
-Display the inventory:
-
-.. code-block:: console
-
-   shell> ansible-inventory -i hosts/02_iocage.yml --list --yaml
-   all:
-     children:
-       ungrouped:
-         hosts:
-           srv_1:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (not running)
-             iocage_ip6: '-'
-             iocage_jid: None
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: down
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_2:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (not running)
-             iocage_ip6: '-'
-             iocage_jid: None
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: down
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_3:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (not running)
-             iocage_ip6: '-'
-             iocage_jid: None
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: down
-             iocage_template: ansible_client
-             iocage_type: jail
-
-Optionally, create shared IP jails:
-
-.. code-block:: console
-
-   shell> iocage create --template ansible_client --name srv_1 ip4_addr="em0|10.1.0.101/24"
-   srv_1 successfully created!
-   shell> iocage create --template ansible_client --name srv_2 ip4_addr="em0|10.1.0.102/24"
-   srv_2 successfully created!
-   shell> iocage create --template ansible_client --name srv_3 ip4_addr="em0|10.1.0.103/24"
-   srv_3 successfully created!
-   shell> iocage list -l
-   +------+-------+------+-------+------+-----------------+-------------------+-----+----------------+----------+
-   | JID  | NAME  | BOOT | STATE | TYPE |     RELEASE     |        IP4        | IP6 |    TEMPLATE    | BASEJAIL |
-   +======+=======+======+=======+======+=================+===================+=====+================+==========+
-   | None | srv_1 | off  | down  | jail | 14.2-RELEASE-p3 | em0|10.1.0.101/24 | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+-------------------+-----+----------------+----------+
-   | None | srv_2 | off  | down  | jail | 14.2-RELEASE-p3 | em0|10.1.0.102/24 | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+-------------------+-----+----------------+----------+
-   | None | srv_3 | off  | down  | jail | 14.2-RELEASE-p3 | em0|10.1.0.103/24 | -   | ansible_client | no       |
-   +------+-------+------+-------+------+-----------------+-------------------+-----+----------------+----------+
-
-See: `Configuring a Shared IP Jail <https://iocage.readthedocs.io/en/latest/networking.html#configuring-a-shared-ip-jail>`_
-
-If iocage needs environment variable(s), use the option :ansopt:`community.general.iocage#inventory:env`. For example,
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   env:
-     CRYPTOGRAPHY_OPENSSL_NO_LEGACY: 1

docs/docsite/rst/guide_iocage_inventory_dhcp.rst

@@ -1,175 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_dhcp:
-
-DHCP
-----
-
-As root at the iocage host, start the jails:
-
-.. code-block:: console
-
-   shell> iocage start ALL
-   No default gateway found for ipv6.
-   * Starting srv_1
-     + Started OK
-     + Using devfs_ruleset: 1000 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.183/24
-   No default gateway found for ipv6.
-   * Starting srv_2
-     + Started OK
-     + Using devfs_ruleset: 1001 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.204/24
-   No default gateway found for ipv6.
-   * Starting srv_3
-     + Started OK
-     + Using devfs_ruleset: 1002 (iocage generated default)
-     + Configuring VNET OK
-     + Using IP options: vnet
-     + Starting services OK
-     + Executing poststart OK
-     + DHCP Address: 10.1.0.169/24
-   Please convert back to a jail before trying to start ansible_client
-
-List the jails:
-
-.. code-block:: console
-
-   shell> iocage list -l
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | JID | NAME  | BOOT | STATE | TYPE |     RELEASE     |        IP4         | IP6 |    TEMPLATE    | BASEJAIL |
-   +=====+=======+======+=======+======+=================+====================+=====+================+==========+
-   | 204 | srv_1 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.183 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 205 | srv_2 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.204 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 206 | srv_3 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.169 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-
-As admin at the controller, list the jails. The IP4 tab says "... address requires root":
-
-.. code-block:: console
-
-   shell> ssh admin@10.1.0.73 iocage list -l
-   +-----+-------+------+-------+------+-----------------+-----------------------------------------+-----+----------------+----------+
-   | JID | NAME  | BOOT | STATE | TYPE |     RELEASE     |                   IP4                   | IP6 |    TEMPLATE    | BASEJAIL |
-   +=====+=======+======+=======+======+=================+=========================================+=====+================+==========+
-   | 204 | srv_1 | off  | up    | jail | 14.2-RELEASE-p3 | DHCP (running -- address requires root) | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+-----------------------------------------+-----+----------------+----------+
-   | 205 | srv_2 | off  | up    | jail | 14.2-RELEASE-p3 | DHCP (running -- address requires root) | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+-----------------------------------------+-----+----------------+----------+
-   | 206 | srv_3 | off  | up    | jail | 14.2-RELEASE-p3 | DHCP (running -- address requires root) | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+-----------------------------------------+-----+----------------+----------+
-
-Use sudo if enabled:
-
-.. code-block:: console
-
-   shell> ssh admin@10.1.0.73 sudo iocage list -l
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | JID | NAME  | BOOT | STATE | TYPE |     RELEASE     |        IP4         | IP6 |    TEMPLATE    | BASEJAIL |
-   +=====+=======+======+=======+======+=================+====================+=====+================+==========+
-   | 204 | srv_1 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.183 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 205 | srv_2 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.204 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-   | 206 | srv_3 | off  | up    | jail | 14.2-RELEASE-p3 | epair0b|10.1.0.169 | -   | ansible_client | no       |
-   +-----+-------+------+-------+------+-----------------+--------------------+-----+----------------+----------+
-
-Create the inventory file ``hosts/02_iocage.yml``. Use the option
-:ansopt:`community.general.iocage#inventory:sudo`:
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   sudo: true
-
-Display the inventory:
-
-.. code-block:: console
-
-   shell> ansible-inventory -i hosts/02_iocage.yml --list --yaml
-   all:
-     children:
-       ungrouped:
-         hosts:
-           srv_1:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: 10.1.0.183
-             iocage_ip4_dict:
-               ip4:
-               - ifc: epair0b
-                 ip: 10.1.0.183
-                 mask: '-'
-               msg: ''
-             iocage_ip6: '-'
-             iocage_jid: '204'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_2:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: 10.1.0.204
-             iocage_ip4_dict:
-               ip4:
-               - ifc: epair0b
-                 ip: 10.1.0.204
-                 mask: '-'
-               msg: ''
-             iocage_ip6: '-'
-             iocage_jid: '205'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_3:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_ip4: 10.1.0.169
-             iocage_ip4_dict:
-               ip4:
-               - ifc: epair0b
-                 ip: 10.1.0.169
-                 mask: '-'
-               msg: ''
-             iocage_ip6: '-'
-             iocage_jid: '206'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-
-Note: If the option :ansopt:`community.general.iocage#inventory:env` is used and :ansopt:`community.general.iocage#inventory:sudo` is enabled, enable also :ansopt:`community.general.iocage#inventory:sudo_preserve_env`. For example,
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   env:
-     CRYPTOGRAPHY_OPENSSL_NO_LEGACY: 1
-   sudo: true
-   sudo_preserve_env: true
-
-In this case, make sure the sudo tag ``SETENV`` is used:
-
-.. code-block:: console
-
-   shell> ssh admin@10.1.0.73 sudo cat /usr/local/etc/sudoers | grep admin
-   admin ALL=(ALL) NOPASSWD:SETENV: ALL

docs/docsite/rst/guide_iocage_inventory_hooks.rst

@@ -1,187 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_hooks:
-
-Hooks
------
-
-The iocage utility internally opens a console to a jail to get the jail's DHCP address. This
-requires root. If you run the command ``iocage list -l`` as unprivileged user, you'll see the
-message ``DHCP (running -- address requires root)``. If you are not granted the root privilege, use
-``/etc/dhclient-exit-hooks``. For example, in the jail *srv_1*, create the file
-``/zroot/iocage/jails/srv_1/root/etc/dhclient-exit-hooks``
-
-.. code-block:: shell
-
-   case "$reason" in
-       "BOUND"|"REBIND"|"REBOOT"|"RENEW")
-       echo $new_ip_address > /var/db/dhclient-hook.address.$interface
-       ;;
-   esac
-
-where ``/zroot/iocage`` is the activated pool.
-
-.. code-block:: console
-
-   shell> zfs list | grep /zroot/iocage
-   zroot/iocage                                4.69G   446G  5.08M  /zroot/iocage
-   zroot/iocage/download                        927M   446G   384K  /zroot/iocage/download
-   zroot/iocage/download/14.1-RELEASE           465M   446G   465M  /zroot/iocage/download/14.1-RELEASE
-   zroot/iocage/download/14.2-RELEASE           462M   446G   462M  /zroot/iocage/download/14.2-RELEASE
-   zroot/iocage/images                          384K   446G   384K  /zroot/iocage/images
-   zroot/iocage/jails                           189M   446G   480K  /zroot/iocage/jails
-   zroot/iocage/jails/srv_1                    62.9M   446G   464K  /zroot/iocage/jails/srv_1
-   zroot/iocage/jails/srv_1/root               62.4M   446G  3.53G  /zroot/iocage/jails/srv_1/root
-   zroot/iocage/jails/srv_2                    62.8M   446G   464K  /zroot/iocage/jails/srv_2
-   zroot/iocage/jails/srv_2/root               62.3M   446G  3.53G  /zroot/iocage/jails/srv_2/root
-   zroot/iocage/jails/srv_3                    62.8M   446G   464K  /zroot/iocage/jails/srv_3
-   zroot/iocage/jails/srv_3/root               62.3M   446G  3.53G  /zroot/iocage/jails/srv_3/root
-   zroot/iocage/log                             688K   446G   688K  /zroot/iocage/log
-   zroot/iocage/releases                       2.93G   446G   384K  /zroot/iocage/releases
-   zroot/iocage/releases/14.2-RELEASE          2.93G   446G   384K  /zroot/iocage/releases/14.2-RELEASE
-   zroot/iocage/releases/14.2-RELEASE/root     2.93G   446G  2.88G  /zroot/iocage/releases/14.2-RELEASE/root
-   zroot/iocage/templates                       682M   446G   416K  /zroot/iocage/templates
-   zroot/iocage/templates/ansible_client        681M   446G   432K  /zroot/iocage/templates/ansible_client
-   zroot/iocage/templates/ansible_client/root   681M   446G  3.53G  /zroot/iocage/templates/ansible_client/root
-
-See: `man dhclient-script <https://man.freebsd.org/cgi/man.cgi?dhclient-script>`_
-
-Create the inventory configuration. Use the option :ansopt:`community.general.iocage#inventory:hooks_results` instead of :ansopt:`community.general.iocage#inventory:sudo`:
-
-.. code-block:: console
-
-   shell> cat hosts/02_iocage.yml
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   hooks_results:
-     - /var/db/dhclient-hook.address.epair0b
-
-.. note::
-
-   The option :ansopt:`community.general.iocage#inventory:hooks_results` expects the poolname to be mounted to ``/poolname``. For example, if you
-   activate the pool iocage, this plugin expects to find the :ansopt:`community.general.iocage#inventory:hooks_results` items in the path
-   /iocage/iocage/jails/<name>/root. If you mount the poolname to a different path, the easiest
-   remedy is to create a symlink.
-
-As admin at the controller, display the inventory:
-
-.. code-block:: console
-
-   shell> ansible-inventory -i hosts/02_iocage.yml --list --yaml
-   all:
-     children:
-       ungrouped:
-         hosts:
-           srv_1:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_hooks:
-             - 10.1.0.183
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (running -- address requires root)
-             iocage_ip6: '-'
-             iocage_jid: '204'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_2:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_hooks:
-             - 10.1.0.204
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (running -- address requires root)
-             iocage_ip6: '-'
-             iocage_jid: '205'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-           srv_3:
-             iocage_basejail: 'no'
-             iocage_boot: 'off'
-             iocage_hooks:
-             - 10.1.0.169
-             iocage_ip4: '-'
-             iocage_ip4_dict:
-               ip4: []
-               msg: DHCP (running -- address requires root)
-             iocage_ip6: '-'
-             iocage_jid: '206'
-             iocage_release: 14.2-RELEASE-p3
-             iocage_state: up
-             iocage_template: ansible_client
-             iocage_type: jail
-
-Compose the variable ``ansible_host``. For example, ``hosts/02_iocage.yml`` could look like:
-
-.. code-block:: yaml+jinja
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   hooks_results:
-     - /var/db/dhclient-hook.address.epair0b
-   compose:
-     ansible_host: (iocage_hooks.0 == '-') | ternary(iocage_ip4, iocage_hooks.0)
-
-Test the jails. Create a playbook ``pb-test-uname.yml``:
-
-.. code-block:: yaml
-
-   - hosts: all
-     remote_user: admin
-
-     vars:
-
-       ansible_python_interpreter: auto_silent
-
-     tasks:
-
-       - command: uname -a
-         register: out
-
-       - debug:
-           var: out.stdout
-
-See: :ref:`working_with_bsd`
-
-Run the playbook:
-
-.. code-block:: console
-
-   shell> ansible-playbook -i hosts/02_iocage.yml pb-test-uname.yml
-
-   PLAY [all] **********************************************************************************************************
-
-   TASK [command] ******************************************************************************************************
-   changed: [srv_3]
-   changed: [srv_1]
-   changed: [srv_2]
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_1] =>
-       out.stdout: FreeBSD srv-1 14.2-RELEASE-p1 FreeBSD 14.2-RELEASE-p1 GENERIC amd64
-   ok: [srv_3] =>
-       out.stdout: FreeBSD srv-3 14.2-RELEASE-p1 FreeBSD 14.2-RELEASE-p1 GENERIC amd64
-   ok: [srv_2] =>
-       out.stdout: FreeBSD srv-2 14.2-RELEASE-p1 FreeBSD 14.2-RELEASE-p1 GENERIC amd64
-
-   PLAY RECAP **********************************************************************************************************
-   srv_1                      : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_2                      : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_3                      : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-
-Note: This playbook and the inventory configuration works also for the *Shared IP Jails*.

docs/docsite/rst/guide_iocage_inventory_properties.rst

@@ -1,201 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_properties:
-
-Properties
-----------
-
-Optionally, in the inventory file ``hosts/02_iocage.yml``, get the iocage properties. Enable
-:ansopt:`community.general.iocage#inventory:get_properties`:
-
-.. code-block:: yaml+jinja
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   get_properties: true
-   hooks_results:
-     - /var/db/dhclient-hook.address.epair0b
-   compose:
-     ansible_host: (iocage_hooks.0 == '-') | ternary(iocage_ip4, iocage_hooks.0)
-
-Display the properties. Create the playbook ``pb-test-properties.yml``:
-
-.. code-block:: yaml
-
-   - hosts: all
-     remote_user: admin
-
-     vars:
-
-       ansible_python_interpreter: auto_silent
-
-     tasks:
-
-       - debug:
-           var: iocage_properties
-
-Run the playbook. Limit the inventory to *srv_3*:
-
-.. code-block:: console
-
-   shell> ansible-playbook -i hosts/02_iocage.yml -l srv_3 pb-test-properties.yml
-
-   PLAY [all] **********************************************************************************************************
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_3] =>
-       iocage_properties:
-           CONFIG_VERSION: '33'
-           allow_chflags: '0'
-           allow_mlock: '0'
-           allow_mount: '1'
-           allow_mount_devfs: '0'
-           allow_mount_fdescfs: '0'
-           allow_mount_fusefs: '0'
-           allow_mount_linprocfs: '0'
-           allow_mount_linsysfs: '0'
-           allow_mount_nullfs: '0'
-           allow_mount_procfs: '0'
-           allow_mount_tmpfs: '0'
-           allow_mount_zfs: '0'
-           allow_nfsd: '0'
-           allow_quotas: '0'
-           allow_raw_sockets: '0'
-           allow_set_hostname: '1'
-           allow_socket_af: '0'
-           allow_sysvipc: '0'
-           allow_tun: '0'
-           allow_vmm: '0'
-           assign_localhost: '0'
-           available: readonly
-           basejail: '0'
-           boot: '0'
-           bpf: '1'
-           children_max: '0'
-           cloned_release: 14.2-RELEASE
-           comment: none
-           compression: 'on'
-           compressratio: readonly
-           coredumpsize: 'off'
-           count: '1'
-           cpuset: 'off'
-           cputime: 'off'
-           datasize: 'off'
-           dedup: 'off'
-           defaultrouter: auto
-           defaultrouter6: auto
-           depends: none
-           devfs_ruleset: '4'
-           dhcp: '1'
-           enforce_statfs: '2'
-           exec_clean: '1'
-           exec_created: /usr/bin/true
-           exec_fib: '0'
-           exec_jail_user: root
-           exec_poststart: /usr/bin/true
-           exec_poststop: /usr/bin/true
-           exec_prestart: /usr/bin/true
-           exec_prestop: /usr/bin/true
-           exec_start: /bin/sh /etc/rc
-           exec_stop: /bin/sh /etc/rc.shutdown
-           exec_system_jail_user: '0'
-           exec_system_user: root
-           exec_timeout: '60'
-           host_domainname: none
-           host_hostname: srv-3
-           host_hostuuid: srv_3
-           host_time: '1'
-           hostid: ea2ba7d1-4fcd-f13f-82e4-8b32c0a03403
-           hostid_strict_check: '0'
-           interfaces: vnet0:bridge0
-           ip4: new
-           ip4_addr: none
-           ip4_saddrsel: '1'
-           ip6: new
-           ip6_addr: none
-           ip6_saddrsel: '1'
-           ip_hostname: '0'
-           jail_zfs: '0'
-           jail_zfs_dataset: iocage/jails/srv_3/data
-           jail_zfs_mountpoint: none
-           last_started: '2025-06-11 04:29:23'
-           localhost_ip: none
-           login_flags: -f root
-           mac_prefix: 02a098
-           maxproc: 'off'
-           memorylocked: 'off'
-           memoryuse: 'off'
-           min_dyn_devfs_ruleset: '1000'
-           mount_devfs: '1'
-           mount_fdescfs: '1'
-           mount_linprocfs: '0'
-           mount_procfs: '0'
-           mountpoint: readonly
-           msgqqueued: 'off'
-           msgqsize: 'off'
-           nat: '0'
-           nat_backend: ipfw
-           nat_forwards: none
-           nat_interface: none
-           nat_prefix: '172.16'
-           nmsgq: 'off'
-           notes: none
-           nsem: 'off'
-           nsemop: 'off'
-           nshm: 'off'
-           nthr: 'off'
-           openfiles: 'off'
-           origin: readonly
-           owner: root
-           pcpu: 'off'
-           plugin_name: none
-           plugin_repository: none
-           priority: '99'
-           pseudoterminals: 'off'
-           quota: none
-           readbps: 'off'
-           readiops: 'off'
-           release: 14.2-RELEASE-p3
-           reservation: none
-           resolver: /etc/resolv.conf
-           rlimits: 'off'
-           rtsold: '0'
-           securelevel: '2'
-           shmsize: 'off'
-           source_template: ansible_client
-           stacksize: 'off'
-           state: up
-           stop_timeout: '30'
-           swapuse: 'off'
-           sync_state: none
-           sync_target: none
-           sync_tgt_zpool: none
-           sysvmsg: new
-           sysvsem: new
-           sysvshm: new
-           template: '0'
-           type: jail
-           used: readonly
-           vmemoryuse: 'off'
-           vnet: '1'
-           vnet0_mac: 02a0983da05d 02a0983da05e
-           vnet0_mtu: auto
-           vnet1_mac: none
-           vnet1_mtu: auto
-           vnet2_mac: none
-           vnet2_mtu: auto
-           vnet3_mac: none
-           vnet3_mtu: auto
-           vnet_default_interface: auto
-           vnet_default_mtu: '1500'
-           vnet_interfaces: none
-           wallclock: 'off'
-           writebps: 'off'
-           writeiops: 'off'
-
-   PLAY RECAP **********************************************************************************************************
-   srv_3                      : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

docs/docsite/rst/guide_iocage_inventory_tags.rst

@@ -1,117 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_iocage.guide_iocage_inventory.guide_iocage_inventory_tags:
-
-Tags
-----
-
-Quoting `man iocage <https://man.freebsd.org/cgi/man.cgi?query=iocage>`_
-
-.. code-block:: text
-
-   PROPERTIES
-   ...
-   notes="any string"
-         Custom notes for miscellaneous tagging.
-         Default: none
-         Source: local
-
-We will use the format ``notes="tag1=value1 tag2=value2 ..."``.
-
-.. note::
-
-    The iocage tags have nothing to do with the :ref:`tags`.
-
-As root at the iocage host, set notes. For example,
-
-.. code-block:: console
-
-   shell> iocage set notes="vmm=iocage_02 project=foo" srv_1
-   notes: none -> vmm=iocage_02 project=foo
-   shell> iocage set notes="vmm=iocage_02 project=foo" srv_2
-   notes: none -> vmm=iocage_02 project=foo
-   shell> iocage set notes="vmm=iocage_02 project=bar" srv_3
-   notes: none -> vmm=iocage_02 project=bar
-
-Update the inventory configuration. Compose a dictionary *iocage_tags* and create groups. The option
-:ansopt:`community.general.iocage#inventory:get_properties` must be enabled.
-For example, ``hosts/02_iocage.yml`` could look like:
-
-.. code-block:: yaml
-
-   plugin: community.general.iocage
-   host: 10.1.0.73
-   user: admin
-   get_properties: true
-   hooks_results:
-     - /var/db/dhclient-hook.address.epair0b
-   compose:
-     ansible_host: (iocage_hooks.0 == '-') | ternary(iocage_ip4, iocage_hooks.0)
-     iocage_tags: dict(iocage_properties.notes | split | map('split', '='))
-   keyed_groups:
-     - prefix: vmm
-       key: iocage_tags.vmm
-     - prefix: project
-       key: iocage_tags.project
-
-Display tags and groups. Create a playbook ``pb-test-groups.yml``:
-
-.. code-block:: yaml+jinja
-
-   - hosts: all
-     remote_user: admin
-
-     vars:
-
-       ansible_python_interpreter: auto_silent
-
-     tasks:
-
-       - debug:
-           var: iocage_tags
-
-       - debug:
-           msg: |
-             {% for group in groups %}
-             {{ group }}: {{ groups[group] }}
-             {% endfor %}
-         run_once: true
-
-Run the playbook:
-
-.. code-block:: console
-
-   shell> ansible-playbook -i hosts/02_iocage.yml pb-test-groups.yml
-
-   PLAY [all] **********************************************************************************************************
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_1] =>
-       iocage_tags:
-           project: foo
-           vmm: iocage_02
-   ok: [srv_2] =>
-       iocage_tags:
-           project: foo
-           vmm: iocage_02
-   ok: [srv_3] =>
-       iocage_tags:
-           project: bar
-           vmm: iocage_02
-
-   TASK [debug] ********************************************************************************************************
-   ok: [srv_1] =>
-       msg: |-
-           all: ['srv_1', 'srv_2', 'srv_3']
-           ungrouped: []
-           vmm_iocage_02: ['srv_1', 'srv_2', 'srv_3']
-           project_foo: ['srv_1', 'srv_2']
-           project_bar: ['srv_3']
-
-   PLAY RECAP **********************************************************************************************************
-   srv_1                      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_2                      : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
-   srv_3                      : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

docs/docsite/rst/guide_modulehelper.rst

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

docs/docsite/rst/guide_online.rst

@@ -1,49 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_online:
-
-****************
-Online.net Guide
-****************
-
-Introduction
-============
-
-Online is a French hosting company mainly known for providing bare-metal servers named Dedibox.
-Check it out: `https://www.online.net/en <https://www.online.net/en>`_
-
-Dynamic inventory for Online resources
---------------------------------------
-
-Ansible has a dynamic inventory plugin that can list your resources.
-
-1. Create a YAML configuration such as ``online_inventory.yml`` with this content:
-
-   .. code-block:: yaml
-
-       plugin: community.general.online
-
-2. Set your ``ONLINE_TOKEN`` environment variable with your token.
-
-   You need to open an account and log into it before you can get a token.
-   You can find your token at the following page: `https://console.online.net/en/api/access <https://console.online.net/en/api/access>`_
-
-3. You can test that your inventory is working by running:
-
-   .. code-block:: console
-
-       $ ansible-inventory -v -i online_inventory.yml --list
-
-
-4. Now you can run your playbook or any other module with this inventory:
-
-   .. code-block:: ansible-output
-
-       $ ansible all -i online_inventory.yml -m ping
-       sd-96735 | SUCCESS => {
-           "changed": false,
-           "ping": "pong"
-       }

docs/docsite/rst/guide_packet.rst

@@ -1,214 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_packet:
-
-**********************************
-Packet.net Guide
-**********************************
-
-Introduction
-============
-
-`Packet.net <https://packet.net>`_ is a bare metal infrastructure host that is supported by the community.general collection through six cloud modules. The six modules are:
-
-- :ansplugin:`community.general.packet_device#module`: manages servers on Packet. You can use this module to create, restart and delete devices.
-- :ansplugin:`community.general.packet_ip_subnet#module`: assign IP subnet to a bare metal server
-- :ansplugin:`community.general.packet_project#module`: create/delete a project in Packet host
-- :ansplugin:`community.general.packet_sshkey#module`: adds a public SSH key from file or value to the Packet infrastructure. Every subsequently-created device will have this public key installed in .ssh/authorized_keys.
-- :ansplugin:`community.general.packet_volume#module`: create/delete a volume in Packet host
-- :ansplugin:`community.general.packet_volume_attachment#module`: attach/detach a volume to a device in the Packet host
-
-Note, this guide assumes you are familiar with Ansible and how it works. If you are not, have a look at their :ref:`docs <ansible_documentation>` before getting started.
-
-Requirements
-============
-
-The Packet modules connect to the Packet API using the `packet-python package <https://pypi.org/project/packet-python/>`_. You can install it with pip:
-
-.. code-block:: console
-
-    $ pip install packet-python
-
-In order to check the state of devices created by Ansible on Packet, it is a good idea to install one of the `Packet CLI clients <https://www.packet.net/developers/integrations/>`_. Otherwise you can check them through the `Packet portal <https://app.packet.net/portal>`_.
-
-To use the modules you will need a Packet API token. You can generate an API token through the Packet portal `here <https://app.packet.net/portal#/api-keys>`__. The simplest way to authenticate yourself is to set the Packet API token in an environment variable:
-
-.. code-block:: console
-
-    $ export PACKET_API_TOKEN=Bfse9F24SFtfs423Gsd3ifGsd43sSdfs
-
-If you are not comfortable exporting your API token, you can pass it as a parameter to the modules.
-
-On Packet, devices and reserved IP addresses belong to `projects <https://www.packet.com/developers/api/#projects>`_. In order to use the packet_device module, you need to specify the UUID of the project in which you want to create or manage devices. You can find a project's UUID in the Packet portal `here <https://app.packet.net/portal#/projects/list/table/>`_ (it is just under the project table) or through one of the available `CLIs <https://www.packet.net/developers/integrations/>`_.
-
-
-If you want to use a new SSH key pair in this tutorial, you can generate it to ``./id_rsa`` and ``./id_rsa.pub`` as:
-
-.. code-block:: console
-
-    $ ssh-keygen -t rsa -f ./id_rsa
-
-If you want to use an existing key pair, just copy the private and public key over to the playbook directory.
-
-
-Device Creation
-===============
-
-The following code block is a simple playbook that creates one `Type 0 <https://www.packet.com/cloud/servers/t1-small/>`_ server (the ``plan`` parameter). You have to supply ``plan`` and ``operating_system``. ``location`` defaults to ``ewr1`` (Parsippany, NJ). You can find all the possible values for the parameters through a `CLI client <https://www.packet.net/developers/integrations/>`_.
-
-.. code-block:: yaml+jinja
-
-    # playbook_create.yml
-
-    - name: Create Ubuntu device
-      hosts: localhost
-      tasks:
-
-        - community.general.packet_sshkey:
-            key_file: ./id_rsa.pub
-            label: tutorial key
-
-        - community.general.packet_device:
-            project_id: <your_project_id>
-            hostnames: myserver
-            operating_system: ubuntu_16_04
-            plan: baremetal_0
-            facility: sjc1
-
-After running ``ansible-playbook playbook_create.yml``, you should have a server provisioned on Packet. You can verify through a CLI or in the `Packet portal <https://app.packet.net/portal#/projects/list/table>`__.
-
-If you get an error with the message "failed to set machine state present, error: Error 404: Not Found", please verify your project UUID.
-
-
-Updating Devices
-================
-
-The two parameters used to uniquely identify Packet devices are: "device_ids" and "hostnames". Both parameters accept either a single string (later converted to a one-element list), or a list of strings.
-
-The ``device_ids`` and ``hostnames`` parameters are mutually exclusive. The following values are all acceptable:
-
-- device_ids: ``a27b7a83-fc93-435b-a128-47a5b04f2dcf``
-
-- hostnames: ``mydev1``
-
-- device_ids: ``[a27b7a83-fc93-435b-a128-47a5b04f2dcf, 4887130f-0ccd-49a0-99b0-323c1ceb527b]``
-
-- hostnames: ``[mydev1, mydev2]``
-
-In addition, hostnames can contain a special ``%d`` formatter along with a ``count`` parameter that lets you easily expand hostnames that follow a simple name and number pattern; in other words, ``hostnames: "mydev%d", count: 2`` will expand to [mydev1, mydev2].
-
-If your playbook acts on existing Packet devices, you can only pass the ``hostname`` and ``device_ids`` parameters. The following playbook shows how you can reboot a specific Packet device by setting the ``hostname`` parameter:
-
-.. code-block:: yaml+jinja
-
-    # playbook_reboot.yml
-
-    - name: reboot myserver
-      hosts: localhost
-      tasks:
-
-        - community.general.packet_device:
-            project_id: <your_project_id>
-            hostnames: myserver
-            state: rebooted
-
-You can also identify specific Packet devices with the ``device_ids`` parameter. The device's UUID can be found in the `Packet Portal <https://app.packet.net/portal>`_ or by using a `CLI <https://www.packet.net/developers/integrations/>`_. The following playbook removes a Packet device using the ``device_ids`` field:
-
-.. code-block:: yaml+jinja
-
-    # playbook_remove.yml
-
-    - name: remove a device
-      hosts: localhost
-      tasks:
-
-        - community.general.packet_device:
-            project_id: <your_project_id>
-            device_ids: <myserver_device_id>
-            state: absent
-
-
-More Complex Playbooks
-======================
-
-In this example, we will create a CoreOS cluster with `user data <https://packet.com/developers/docs/servers/key-features/user-data/>`_.
-
-
-The CoreOS cluster will use `etcd <https://etcd.io/>`_ for discovery of other servers in the cluster. Before provisioning your servers, you will need to generate a discovery token for your cluster:
-
-.. code-block:: console
-
-    $ curl -w "\n" 'https://discovery.etcd.io/new?size=3'
-
-The following playbook will create an SSH key, 3 Packet servers, and then wait until SSH is ready (or until 5 minutes passed). Make sure to substitute the discovery token URL in ``user_data``, and the ``project_id`` before running ``ansible-playbook``. Also, feel free to change ``plan`` and ``facility``.
-
-.. code-block:: yaml+jinja
-
-    # playbook_coreos.yml
-
-    - name: Start 3 CoreOS nodes in Packet and wait until SSH is ready
-      hosts: localhost
-      tasks:
-
-        - community.general.packet_sshkey:
-            key_file: ./id_rsa.pub
-            label: new
-
-        - community.general.packet_device:
-            hostnames: [coreos-one, coreos-two, coreos-three]
-            operating_system: coreos_beta
-            plan: baremetal_0
-            facility: ewr1
-            project_id: <your_project_id>
-            wait_for_public_IPv: 4
-            user_data: |
-              # cloud-config
-              coreos:
-                etcd2:
-                  discovery: https://discovery.etcd.io/<token>
-                  advertise-client-urls: http://$private_ipv4:2379,http://$private_ipv4:4001
-                  initial-advertise-peer-urls: http://$private_ipv4:2380
-                  listen-client-urls: http://0.0.0.0:2379,http://0.0.0.0:4001
-                  listen-peer-urls: http://$private_ipv4:2380
-                fleet:
-                  public-ip: $private_ipv4
-                units:
-                  - name: etcd2.service
-                    command: start
-                  - name: fleet.service
-                    command: start
-          register: newhosts
-
-        - name: wait for ssh
-          ansible.builtin.wait_for:
-            delay: 1
-            host: "{{ item.public_ipv4 }}"
-            port: 22
-            state: started
-            timeout: 500
-          loop: "{{ newhosts.results[0].devices }}"
-
-
-As with most Ansible modules, the default states of the Packet modules are idempotent, meaning the resources in your project will remain the same after re-runs of a playbook. Thus, we can keep the ``packet_sshkey`` module call in our playbook. If the public key is already in your Packet account, the call will have no effect.
-
-The second module call provisions 3 Packet Type 0 (specified using the ``plan`` parameter) servers in the project identified by the ``project_id`` parameter. The servers are all provisioned with CoreOS beta (the ``operating_system`` parameter) and are customized with cloud-config user data passed to the ``user_data`` parameter.
-
-The ``packet_device`` module has a ``wait_for_public_IPv`` that is used to specify the version of the IP address to wait for (valid values are ``4`` or ``6`` for IPv4 or IPv6). If specified, Ansible will wait until the GET API call for a device contains an Internet-routeable IP address of the specified version. When referring to an IP address of a created device in subsequent module calls, it is wise to use the ``wait_for_public_IPv`` parameter, or ``state: active`` in the packet_device module call.
-
-Run the playbook:
-
-.. code-block:: console
-
-    $ ansible-playbook playbook_coreos.yml
-
-Once the playbook quits, your new devices should be reachable through SSH. Try to connect to one and check if etcd has started properly:
-
-.. code-block:: console
-
-    tomk@work $ ssh -i id_rsa core@$one_of_the_servers_ip
-    core@coreos-one ~ $ etcdctl cluster-health
-
-If you have any questions or comments let us know! help@packet.net

docs/docsite/rst/guide_scaleway.rst

@@ -1,320 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_scaleway:
-
-**************
-Scaleway Guide
-**************
-
-Introduction
-============
-
-`Scaleway <https://scaleway.com>`_ is a cloud provider supported by the community.general collection through a set of plugins and modules.
-Those modules are:
-
-- :ansplugin:`community.general.scaleway_compute#module`: manages servers on Scaleway. You can use this module to create, restart and delete servers.
-- :ansplugin:`community.general.scaleway_compute_private_network#module`
-- :ansplugin:`community.general.scaleway_container#module`
-- :ansplugin:`community.general.scaleway_container_info#module`
-- :ansplugin:`community.general.scaleway_container_namespace_info#module`
-- :ansplugin:`community.general.scaleway_container_namespace#module`
-- :ansplugin:`community.general.scaleway_container_registry_info#module`
-- :ansplugin:`community.general.scaleway_container_registry#module`
-- :ansplugin:`community.general.scaleway_database_backup#module`
-- :ansplugin:`community.general.scaleway_function#module`
-- :ansplugin:`community.general.scaleway_function_info#module`
-- :ansplugin:`community.general.scaleway_function_namespace_info#module`
-- :ansplugin:`community.general.scaleway_function_namespace#module`
-- :ansplugin:`community.general.scaleway_image_info#module`
-- :ansplugin:`community.general.scaleway_ip#module`
-- :ansplugin:`community.general.scaleway_ip_info#module`
-- :ansplugin:`community.general.scaleway_lb#module`
-- :ansplugin:`community.general.scaleway_organization_info#module`
-- :ansplugin:`community.general.scaleway_private_network#module`
-- :ansplugin:`community.general.scaleway_security_group#module`
-- :ansplugin:`community.general.scaleway_security_group_info#module`
-- :ansplugin:`community.general.scaleway_security_group_rule#module`
-- :ansplugin:`community.general.scaleway_server_info#module`
-- :ansplugin:`community.general.scaleway_snapshot_info#module`
-- :ansplugin:`community.general.scaleway_sshkey#module`: adds a public SSH key from a file or value to the Packet infrastructure. Every subsequently-created device will have this public key installed in .ssh/authorized_keys.
-- :ansplugin:`community.general.scaleway_user_data#module`
-- :ansplugin:`community.general.scaleway_volume#module`: manages volumes on Scaleway.
-- :ansplugin:`community.general.scaleway_volume_info#module`
-
-The plugins are:
-
-- :ansplugin:`community.general.scaleway#inventory`: inventory plugin
-
-
-.. note::
-   This guide assumes you are familiar with Ansible and how it works.
-   If you are not, have a look at :ref:`ansible_documentation` before getting started.
-
-Requirements
-============
-
-The Scaleway modules and inventory script connect to the Scaleway API using `Scaleway REST API <https://developer.scaleway.com>`_.
-To use the modules and inventory script you will need a Scaleway API token.
-You can generate an API token through the `Scaleway console's credential page <https://cloud.scaleway.com/#/credentials>`__.
-The simplest way to authenticate yourself is to set the Scaleway API token in an environment variable:
-
-.. code-block:: console
-
-    $ export SCW_TOKEN=00000000-1111-2222-3333-444444444444
-
-If you are not comfortable exporting your API token, you can pass it as a parameter to the modules using the ``api_token`` argument.
-
-If you want to use a new SSH key pair in this tutorial, you can generate it to ``./id_rsa`` and ``./id_rsa.pub`` as:
-
-.. code-block:: console
-
-    $ ssh-keygen -t rsa -f ./id_rsa
-
-If you want to use an existing key pair, just copy the private and public key over to the playbook directory.
-
-How to add an SSH key?
-======================
-
-Connection to Scaleway Compute nodes use Secure Shell.
-SSH keys are stored at the account level, which means that you can reuse the same SSH key in multiple nodes.
-The first step to configure Scaleway compute resources is to have at least one SSH key configured.
-
-:ansplugin:`community.general.scaleway_sshkey#module` is a module that manages SSH keys on your Scaleway account.
-You can add an SSH key to your account by including the following task in a playbook:
-
-.. code-block:: yaml+jinja
-
-    - name: "Add SSH key"
-      community.general.scaleway_sshkey:
-        ssh_pub_key: "ssh-rsa AAAA..."
-        state: "present"
-
-The ``ssh_pub_key`` parameter contains your ssh public key as a string. Here is an example inside a playbook:
-
-
-.. code-block:: yaml+jinja
-
-    - name: Test SSH key lifecycle on a Scaleway account
-      hosts: localhost
-      gather_facts: false
-      environment:
-        SCW_API_KEY: ""
-
-      tasks:
-
-        - community.general.scaleway_sshkey:
-            ssh_pub_key: "ssh-rsa AAAAB...424242 developer@example.com"
-            state: present
-          register: result
-
-        - ansible.builtin.assert:
-            that:
-              - result is success and result is changed
-
-How to create a compute instance?
-=================================
-
-Now that we have an SSH key configured, the next step is to spin up a server!
-:ansplugin:`community.general.scaleway_compute#module` is a module that can create, update and delete Scaleway compute instances:
-
-.. code-block:: yaml+jinja
-
-    - name: Create a server
-      community.general.scaleway_compute:
-        name: foobar
-        state: present
-        image: 00000000-1111-2222-3333-444444444444
-        organization: 00000000-1111-2222-3333-444444444444
-        region: ams1
-        commercial_type: START1-S
-
-Here are the parameter details for the example shown above:
-
-- ``name`` is the name of the instance (the one that will show up in your web console).
-- ``image`` is the UUID of the system image you would like to use.
-  A list of all images is available for each availability zone.
-- ``organization`` represents the organization that your account is attached to.
-- ``region`` represents the Availability Zone which your instance is in (for this example, ``par1`` and ``ams1``).
-- ``commercial_type`` represents the name of the commercial offers.
-  You can check out the Scaleway pricing page to find which instance is right for you.
-
-Take a look at this short playbook to see a working example using ``scaleway_compute``:
-
-.. code-block:: yaml+jinja
-
-    - name: Test compute instance lifecycle on a Scaleway account
-      hosts: localhost
-      gather_facts: false
-      environment:
-        SCW_API_KEY: ""
-
-      tasks:
-
-        - name: Create a server
-          register: server_creation_task
-          community.general.scaleway_compute:
-            name: foobar
-            state: present
-            image: 00000000-1111-2222-3333-444444444444
-            organization: 00000000-1111-2222-3333-444444444444
-            region: ams1
-            commercial_type: START1-S
-            wait: true
-
-        - ansible.builtin.debug:
-            var: server_creation_task
-
-        - ansible.builtin.assert:
-            that:
-              - server_creation_task is success
-              - server_creation_task is changed
-
-        - name: Run it
-          community.general.scaleway_compute:
-            name: foobar
-            state: running
-            image: 00000000-1111-2222-3333-444444444444
-            organization: 00000000-1111-2222-3333-444444444444
-            region: ams1
-            commercial_type: START1-S
-            wait: true
-            tags:
-              - web_server
-          register: server_run_task
-
-        - ansible.builtin.debug:
-            var: server_run_task
-
-        - ansible.builtin.assert:
-            that:
-              - server_run_task is success
-              - server_run_task is changed
-
-Dynamic Inventory Plugin
-========================
-
-Ansible ships with :ansplugin:`community.general.scaleway#inventory`.
-You can now get a complete inventory of your Scaleway resources through this plugin and filter it on
-different parameters (``regions`` and ``tags`` are currently supported).
-
-Let us create an example!
-Suppose that we want to get all hosts that got the tag web_server.
-Create a file named ``scaleway_inventory.yml`` with the following content:
-
-.. code-block:: yaml+jinja
-
-    plugin: community.general.scaleway
-    regions:
-      - ams1
-      - par1
-    tags:
-      - web_server
-
-This inventory means that we want all hosts that got the tag ``web_server`` on the zones ``ams1`` and ``par1``.
-Once you have configured this file, you can get the information using the following command:
-
-.. code-block:: console
-
-    $ ansible-inventory --list -i scaleway_inventory.yml
-
-The output will be:
-
-.. code-block:: json
-
-    {
-        "_meta": {
-            "hostvars": {
-                "dd8e3ae9-0c7c-459e-bc7b-aba8bfa1bb8d": {
-                    "ansible_verbosity": 6,
-                    "arch": "x86_64",
-                    "commercial_type": "START1-S",
-                    "hostname": "foobar",
-                    "ipv4": "192.0.2.1",
-                    "organization": "00000000-1111-2222-3333-444444444444",
-                    "state": "running",
-                    "tags": [
-                        "web_server"
-                    ]
-                }
-            }
-        },
-        "all": {
-            "children": [
-                "ams1",
-                "par1",
-                "ungrouped",
-                "web_server"
-            ]
-        },
-        "ams1": {},
-        "par1": {
-            "hosts": [
-                "dd8e3ae9-0c7c-459e-bc7b-aba8bfa1bb8d"
-            ]
-        },
-        "ungrouped": {},
-        "web_server": {
-            "hosts": [
-                "dd8e3ae9-0c7c-459e-bc7b-aba8bfa1bb8d"
-            ]
-        }
-    }
-
-As you can see, we get different groups of hosts.
-``par1`` and ``ams1`` are groups based on location.
-``web_server`` is a group based on a tag.
-
-In case a filter parameter is not defined, the plugin supposes all values possible are wanted.
-This means that for each tag that exists on your Scaleway compute nodes, a group based on each tag will be created.
-
-Scaleway S3 object storage
-==========================
-
-`Object Storage <https://www.scaleway.com/object-storage>`_ allows you to store any kind of objects (documents, images, videos, and so on).
-As the Scaleway API is S3 compatible, Ansible supports it natively through the amazon.aws modules: :ansplugin:`amazon.aws.s3_bucket#module`, :ansplugin:`amazon.aws.s3_object#module`.
-
-You can find many examples in the `scaleway_s3 integration tests <https://github.com/ansible/ansible-legacy-tests/tree/devel/test/legacy/roles/scaleway_s3>`_.
-
-.. code-block:: yaml+jinja
-
-    - hosts: myserver
-      vars:
-        scaleway_region: nl-ams
-        s3_url: https://s3.nl-ams.scw.cloud
-      environment:
-        # AWS_ACCESS_KEY matches your scaleway organization id available at https://cloud.scaleway.com/#/account
-        AWS_ACCESS_KEY: 00000000-1111-2222-3333-444444444444
-        # AWS_SECRET_KEY matches a secret token that you can retrieve at https://cloud.scaleway.com/#/credentials
-        AWS_SECRET_KEY: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
-      module_defaults:
-        group/amazon.aws.aws:
-          s3_url: '{{ s3_url }}'
-          region: '{{ scaleway_region }}'
-      tasks:
-       # use a fact instead of a variable, otherwise template is evaluate each time variable is used
-        - ansible.builtin.set_fact:
-            bucket_name: "{{ 99999999 | random | to_uuid }}"
-
-        # "requester_pays:" is mandatory because Scaleway does not implement related API
-        # another way is to use amazon.aws.s3_object and "mode: create" !
-        - amazon.aws.s3_bucket:
-            name: '{{ bucket_name }}'
-            requester_pays:
-
-        - name: Another way to create the bucket
-          amazon.aws.s3_object:
-            bucket: '{{ bucket_name }}'
-            mode: create
-            encrypt: false
-          register: bucket_creation_check
-
-        - name: add something in the bucket
-          amazon.aws.s3_object:
-            mode: put
-            bucket: '{{ bucket_name }}'
-            src: /tmp/test.txt  #  needs to be created before
-            object: test.txt
-            encrypt: false  # server side encryption must be disabled

docs/docsite/rst/guide_uthelper.rst

@@ -1,394 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.guide_uthelper:
-
-UTHelper Guide
-==============
-
-Introduction
-^^^^^^^^^^^^
-
-``UTHelper`` was written to reduce the boilerplate code used in unit tests for modules.
-It was originally written to handle tests of modules that run external commands using ``AnsibleModule.run_command()``.
-At the time of writing (Feb 2025) that remains the only type of tests you can use
-``UTHelper`` for, but it aims to provide support for other types of interactions.
-
-Until now, there are many different ways to implement unit tests that validate a module based on the execution of external commands. See some examples:
-
-* `test_apk.py <https://github.com/ansible-collections/community.general/blob/10.3.0/tests/unit/plugins/modules/test_apk.py>`_ - A very simple one
-* `test_bootc_manage.py <https://github.com/ansible-collections/community.general/blob/10.3.0/tests/unit/plugins/modules/test_bootc_manage.py>`_ -
-  This one has more test cases, but do notice how the code is repeated amongst them.
-* `test_modprobe.py <https://github.com/ansible-collections/community.general/blob/10.3.0/tests/unit/plugins/modules/test_modprobe.py>`_ -
-  This one has 15 tests in it, but to achieve that it declares 8 classes repeating quite a lot of code.
-
-As you can notice, there is no consistency in the way these tests are executed -
-they all do the same thing eventually, but each one is written in a very distinct way.
-
-``UTHelper`` aims to:
-
-* provide a consistent idiom to define unit tests
-* reduce the code to a bare minimal, and
-* define tests as data instead
-* allow the test cases definition to be expressed not only as a Python data structure but also as YAML content
-
-Quickstart
-""""""""""
-
-To use UTHelper, your test module will need only a bare minimal of code:
-
-.. code-block:: python
-
-    # tests/unit/plugin/modules/test_ansible_module.py
-    from ansible_collections.community.general.plugins.modules import ansible_module
-    from .uthelper import UTHelper, RunCommandMock
-
-
-    UTHelper.from_module(ansible_module, __name__, mocks=[RunCommandMock])
-
-Then, in the test specification file, you have:
-
-.. code-block:: yaml
-
-    # tests/unit/plugin/modules/test_ansible_module.yaml
-    test_cases:
-      - id: test_ansible_module
-        flags:
-          diff: true
-        input:
-          state: present
-          name: Roger the Shrubber
-        output:
-          shrubbery:
-            looks: nice
-            price: not too expensive
-          changed: true
-          diff:
-            before:
-              shrubbery: null
-            after:
-              shrubbery:
-                looks: nice
-                price: not too expensive
-        mocks:
-          run_command:
-            - command: [/testbin/shrubber, --version]
-              rc: 0
-              out: "2.80.0\n"
-              err: ''
-            - command: [/testbin/shrubber, --make-shrubbery]
-              rc: 0
-              out: 'Shrubbery created'
-              err: ''
-
-.. note::
-
-    If you prefer to pick a different YAML file for the test cases, or if you prefer to define them in plain Python,
-    you can use the convenience methods ``UTHelper.from_file()`` and ``UTHelper.from_spec()``, respectively.
-    See more details below.
-
-
-Using ``UTHelper``
-^^^^^^^^^^^^^^^^^^
-
-Test Module
-"""""""""""
-
-``UTHelper`` is **strictly for unit tests**. To use it, you import the ``.uthelper.UTHelper`` class.
-As mentioned in different parts of this guide, there are three different mechanisms to load the test cases.
-
-.. seealso::
-
-    See the UTHelper class reference below for API details on the three different mechanisms.
-
-
-The easies and most recommended way of using ``UTHelper`` is literally the example shown.
-See a real world example at
-`test_gconftool2.py <https://github.com/ansible-collections/community.general/blob/10.3.0/tests/unit/plugins/modules/test_gconftool2.py>`_.
-
-The ``from_module()`` method will pick the filename of the test module up (in the example above, ``tests/unit/plugins/modules/test_gconftool2.py``)
-and it will search for ``tests/unit/plugins/modules/test_gconftool2.yaml`` (or ``.yml`` if that is not found).
-In that file it will expect to find the test specification expressed in YAML format, conforming to the structure described below LINK LINK LINK.
-
-If you prefer to read the test specifications a different file path, use ``from_file()`` passing the file handle for the YAML file.
-
-And, if for any reason you prefer or need to pass the data structure rather than dealing with YAML files, use the ``from_spec()`` method.
-A real world example for that can be found at
-`test_snap.py <https://github.com/ansible-collections/community.general/blob/main/tests/unit/plugins/modules/test_snap.py>`_.
-
-
-Test Specification
-""""""""""""""""""
-
-The structure of the test specification data is described below.
-
-Top level
----------
-
-At the top level there are two accepted keys:
-
-- ``anchors: dict``
-    Optional. Placeholder for you to define YAML anchors that can be repeated in the test cases.
-    Its contents are never accessed directly by test Helper.
-- ``test_cases: list``
-    Mandatory. List of test cases, see below for definition.
-
-Test cases
-----------
-
-You write the test cases with five elements:
-
-- ``id: str``
-    Mandatory. Used to identify the test case.
-
-- ``flags: dict``
-    Optional. Flags controling the behavior of the test case. All flags are optional. Accepted flags:
-
-    * ``check: bool``: set to ``true`` if the module is to be executed in **check mode**.
-    * ``diff: bool``: set to ``true`` if the module is to be executed in **diff mode**.
-    * ``skip: str``: set the test case to be skipped, providing the message for ``pytest.skip()``.
-    * ``xfail: str``: set the test case to expect failure, providing the message for ``pytest.xfail()``.
-
-- ``input: dict``
-    Optional. Parameters for the Ansible module, it can be empty.
-
-- ``output: dict``
-    Optional. Expected return values from the Ansible module.
-    All RV names are used here are expected to be found in the module output, but not all RVs in the output must be here.
-    It can include special RVs such as ``changed`` and ``diff``.
-    It can be empty.
-
-- ``mocks: dict``
-    Optional. Mocked interactions, ``run_command`` being the only one supported for now.
-    Each key in this dictionary refers to one subclass of ``TestCaseMock`` and its
-    structure is dictated by the ``TestCaseMock`` subclass implementation.
-    All keys are expected to be named using snake case, as in ``run_command``.
-    The ``TestCaseMock`` subclass is responsible for defining the name used in the test specification.
-    The structure for that specification is dependent on the implementing class.
-    See more details below for the implementation of ``RunCommandMock``
-
-Example using YAML
-------------------
-
-We recommend you use ``UTHelper`` reading the test specifications from a YAML file.
-See an example below of how one actually looks like (excerpt from ``test_opkg.yaml``):
-
-..  code-block:: yaml
-
-  ---
-  anchors:
-    environ: &env-def {environ_update: {LANGUAGE: C, LC_ALL: C}, check_rc: false}
-  test_cases:
-    - id: install_zlibdev
-      input:
-        name: zlib-dev
-        state: present
-      output:
-        msg: installed 1 package(s)
-      mocks:
-        run_command:
-          - command: [/testbin/opkg, --version]
-            environ: *env-def
-            rc: 0
-            out: ''
-            err: ''
-          - command: [/testbin/opkg, list-installed, zlib-dev]
-            environ: *env-def
-            rc: 0
-            out: ''
-            err: ''
-          - command: [/testbin/opkg, install, zlib-dev]
-            environ: *env-def
-            rc: 0
-            out: |
-              Installing zlib-dev (1.2.11-6) to root...
-              Downloading https://downloads.openwrt.org/releases/22.03.0/packages/mips_24kc/base/zlib-dev_1.2.11-6_mips_24kc.ipk
-              Installing zlib (1.2.11-6) to root...
-              Downloading https://downloads.openwrt.org/releases/22.03.0/packages/mips_24kc/base/zlib_1.2.11-6_mips_24kc.ipk
-              Configuring zlib.
-              Configuring zlib-dev.
-            err: ''
-          - command: [/testbin/opkg, list-installed, zlib-dev]
-            environ: *env-def
-            rc: 0
-            out: |
-              zlib-dev - 1.2.11-6
-            err: ''
-    - id: install_zlibdev_present
-      input:
-        name: zlib-dev
-        state: present
-      output:
-        msg: package(s) already present
-      mocks:
-        run_command:
-          - command: [/testbin/opkg, --version]
-            environ: *env-def
-            rc: 0
-            out: ''
-            err: ''
-          - command: [/testbin/opkg, list-installed, zlib-dev]
-            environ: *env-def
-            rc: 0
-            out: |
-              zlib-dev - 1.2.11-6
-            err: ''
-
-TestCaseMocks Specifications
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ``TestCaseMock`` subclass is free to define the expected data structure.
-
-RunCommandMock Specification
-""""""""""""""""""""""""""""
-
-``RunCommandMock`` mocks can be specified with the key ``run_command`` and it expects a ``list`` in which elements follow the structure:
-
-- ``command: Union[list, str]``
-    Mandatory. The command that is expected to be executed by the module. It corresponds to the parameter ``args`` of the ``AnsibleModule.run_command()`` call.
-    It can be either a list or a string, though the list form is generally recommended.
-- ``environ: dict``
-    Mandatory. All other parameters passed to the ``AnsibleModule.run_command()`` call.
-    Most commonly used are ``environ_update`` and ``check_rc``.
-    Must include all parameters the Ansible module uses in the ``AnsibleModule.run_command()`` call, otherwise the test will fail.
-- ``rc: int``
-    Mandatory. The return code for the command execution.
-    As per usual in bash scripting, a value of ``0`` means success, whereas any other number is an error code.
-- ``out: str``
-    Mandatory. The *stdout* result of the command execution, as one single string containing zero or more lines.
-- ``err: str``
-    Mandatory. The *stderr* result of the command execution, as one single string containing zero or more lines.
-
-
-``UTHelper`` Reference
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. py:module:: .uthelper
-
-  .. py:class:: UTHelper
-
-    A class to encapsulate unit tests.
-
-    .. py:staticmethod:: from_spec(ansible_module, test_module, test_spec, mocks=None)
-
-      Creates an ``UTHelper`` instance from a given test specification.
-
-      :param ansible_module: The Ansible module to be tested.
-      :type ansible_module: :py:class:`types.ModuleType`
-      :param test_module: The test module.
-      :type test_module: :py:class:`types.ModuleType`
-      :param test_spec: The test specification.
-      :type test_spec: dict
-      :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.
-      :type mocks: list or None
-      :return: An ``UTHelper`` instance.
-      :rtype: UTHelper
-
-      Example usage of ``from_spec()``:
-
-      .. code-block:: python
-
-          import sys
-
-          from ansible_collections.community.general.plugins.modules import ansible_module
-          from .uthelper import UTHelper, RunCommandMock
-
-          TEST_SPEC = dict(
-              test_cases=[
-                  ...
-              ]
-          )
-
-          helper = UTHelper.from_spec(ansible_module, sys.modules[__name__], TEST_SPEC, mocks=[RunCommandMock])
-
-    .. py:staticmethod:: from_file(ansible_module, test_module, test_spec_filehandle, mocks=None)
-
-      Creates an ``UTHelper`` instance from a test specification file.
-
-      :param ansible_module: The Ansible module to be tested.
-      :type ansible_module: :py:class:`types.ModuleType`
-      :param test_module: The test module.
-      :type test_module: :py:class:`types.ModuleType`
-      :param test_spec_filehandle: A file handle to an file stream handle providing the test specification in YAML format.
-      :type test_spec_filehandle: ``file-like object``
-      :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.
-      :type mocks: list or None
-      :return: An ``UTHelper`` instance.
-      :rtype: UTHelper
-
-      Example usage of ``from_file()``:
-
-      .. code-block:: python
-
-          import sys
-
-          from ansible_collections.community.general.plugins.modules import ansible_module
-          from .uthelper import UTHelper, RunCommandMock
-
-          with open("test_spec.yaml", "r") as test_spec_filehandle:
-              helper = UTHelper.from_file(ansible_module, sys.modules[__name__], test_spec_filehandle, mocks=[RunCommandMock])
-
-    .. py:staticmethod:: from_module(ansible_module, test_module_name, mocks=None)
-
-      Creates an ``UTHelper`` instance from a given Ansible module and test module.
-
-      :param ansible_module: The Ansible module to be tested.
-      :type ansible_module: :py:class:`types.ModuleType`
-      :param test_module_name: The name of the test module. It works if passed ``__name__``.
-      :type test_module_name: str
-      :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.
-      :type mocks: list or None
-      :return: An ``UTHelper`` instance.
-      :rtype: UTHelper
-
-      Example usage of ``from_module()``:
-
-      .. code-block:: python
-
-          from ansible_collections.community.general.plugins.modules import ansible_module
-          from .uthelper import UTHelper, RunCommandMock
-
-          # Example usage
-          helper = UTHelper.from_module(ansible_module, __name__, mocks=[RunCommandMock])
-
-
-Creating TestCaseMocks
-^^^^^^^^^^^^^^^^^^^^^^
-
-To create a new ``TestCaseMock`` you must extend that class and implement the relevant parts:
-
-.. code-block:: python
-
-    class ShrubberyMock(TestCaseMock):
-        # this name is mandatory, it is the name used in the test specification
-        name = "shrubbery"
-
-        def setup(self, mocker):
-            # perform setup, commonly using mocker to patch some other piece of code
-            ...
-
-        def check(self, test_case, results):
-            # verify the tst execution met the expectations of the test case
-            # for example the function was called as many times as it should
-            ...
-
-        def fixtures(self):
-            # returns a dict mapping names to pytest fixtures that should be used for the test case
-            # for example, in RunCommandMock it creates a fixture that patches AnsibleModule.get_bin_path
-            ...
-
-Caveats
-^^^^^^^
-
-Known issues/opportunities for improvement:
-
-* Only one ``UTHelper`` per test module: UTHelper injects a test function with a fixed name into the module's namespace,
-  so placing a second ``UTHelper`` instance is going to overwrite the function created by the first one.
-* Order of elements in module's namespace is not consistent across executions in Python 3.5, so if adding more tests to the test module
-  might make Test Helper add its function before or after the other test functions.
-  In the community.general collection the CI processes uses ``pytest-xdist`` to paralellize and distribute the tests,
-  and it requires the order of the tests to be consistent.
-
-.. versionadded:: 7.5.0

docs/docsite/rst/guide_vardict.rst

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

docs/docsite/rst/test_guide.rst

@@ -1,33 +0,0 @@
-..
-  Copyright (c) Ansible Project
-  GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-  SPDX-License-Identifier: GPL-3.0-or-later
-
-.. _ansible_collections.community.general.docsite.test_guide:
-
-community.general Test (Plugin) Guide
-=====================================
-
-The :anscollection:`community.general collection <community.general#collection>` offers currently one test plugin.
-
-.. contents:: Topics
-
-Feature Tests
--------------
-
-The :ansplugin:`community.general.a_module test <community.general.a_module#test>` allows to check whether a given string refers to an existing module or action plugin. This can be useful in roles, which can use this to ensure that required modules are present ahead of time.
-
-.. code-block:: yaml+jinja
-
-    - name: Make sure that community.aws.route53 is available
-      assert:
-        that:
-          - >
-            'community.aws.route53' is community.general.a_module
-
-    - name: Make sure that community.general.does_not_exist is not a module or action plugin
-      assert:
-        that:
-          - "'community.general.does_not_exist' is not community.general.a_module"
-
-.. versionadded:: 4.0.0

galaxy.yml

@@ -1,21 +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
-
 namespace: community
 name: general
-version: 12.1.0
+version: 1.2.0
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)
-description: >-
-  The community.general collection is a part of the Ansible package and includes many modules and
-  plugins supported by Ansible community which are not part of more specialized community collections.
+description: null
 license_file: COPYING
-tags:
-  - community
+tags: [community]
+# NOTE: No more dependencies can be added to this list
+dependencies:
+  ansible.netcommon: '>=1.0.0'
+  ansible.posix: '>=1.0.0'
+  community.kubernetes: '>=1.0.0'
+  google.cloud: '>=1.0.0'
 repository: https://github.com/ansible-collections/community.general
-documentation: https://docs.ansible.com/projects/ansible/latest/collections/community/general/
+#documentation: https://github.com/ansible-collection-migration/community.general/tree/main/docs
 homepage: https://github.com/ansible-collections/community.general
 issues: https://github.com/ansible-collections/community.general/issues
+#type: flatmap

noxfile.py

@@ -1,59 +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 os
-import sys
-
-import nox
-
-# Whether the noxfile is running in CI:
-IN_CI = os.environ.get("CI") == "true"
-
-
-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")
-
-
-@nox.session(name="ansible-output", default=False)
-def ansible_output(session: nox.Session) -> None:
-    session.install(
-        "ansible-core",
-        "antsibull-docs",
-        # Needed libs for some code blocks:
-        "jc",
-        "hashids",
-        # Tools for post-processing
-        "ruamel.yaml",  # used by docs/docsite/reformat-yaml.py
-    )
-    args = []
-    if IN_CI:
-        args.append("--check")
-    session.run("antsibull-docs", "ansible-output", *args, *session.posargs)
-
-
-# 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/action/iptables_state.py

@@ -1,205 +0,0 @@
-# Copyright (c) 2020, quidame <quidame@poivron.org>
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-from __future__ import annotations
-
-import time
-import typing as t
-
-from ansible.plugins.action import ActionBase
-from ansible.errors import AnsibleActionFail, AnsibleConnectionFailure
-from ansible.utils.vars import merge_hash
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionBase):
-    # Keep internal params away from user interactions
-    _VALID_ARGS = frozenset(("path", "state", "table", "noflush", "counters", "modprobe", "ip_version", "wait"))
-    DEFAULT_SUDOABLE = True
-
-    @staticmethod
-    def msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout) -> str:
-        return (
-            "This module doesn't support async>0 and poll>0 when its 'state' param "
-            "is set to 'restored'. To enable its rollback feature (that needs the "
-            "module to run asynchronously on the remote), please set task attribute "
-            f"'poll' (={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended)."
-        )
-
-    @staticmethod
-    def msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout) -> str:
-        return (
-            "Attempts to restore iptables state without rollback in case of mistake "
-            "may lead the ansible controller to loose access to the hosts and never "
-            "regain it before fixing firewall rules through a serial console, or any "
-            f"other way except SSH. Please set task attribute 'poll' (={task_poll}) to 0, and "
-            f"'async' (={task_async}) to a value >2 and not greater than 'ansible_timeout' (={max_timeout}) "
-            "(recommended)."
-        )
-
-    @staticmethod
-    def msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout) -> str:
-        return (
-            "You attempt to restore iptables state with rollback in case of mistake, "
-            "but with settings that will lead this rollback to happen AFTER that the "
-            "controller will reach its own timeout. Please set task attribute 'poll' "
-            f"(={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended)."
-        )
-
-    def _async_result(
-        self, async_status_args: dict[str, t.Any], task_vars: dict[str, t.Any], timeout: int
-    ) -> dict[str, t.Any]:
-        """
-        Retrieve results of the asynchronous task, and display them in place of
-        the async wrapper results (those with the ansible_job_id key).
-        """
-        async_status = self._task.copy()
-        async_status.args = async_status_args
-        async_status.action = "ansible.builtin.async_status"
-        async_status.async_val = 0
-        async_action = self._shared_loader_obj.action_loader.get(
-            async_status.action,
-            task=async_status,
-            connection=self._connection,
-            play_context=self._play_context,
-            loader=self._loader,
-            templar=self._templar,
-            shared_loader_obj=self._shared_loader_obj,
-        )
-
-        if async_status.args["mode"] == "cleanup":
-            return async_action.run(task_vars=task_vars)
-
-        # At least one iteration is required, even if timeout is 0.
-        for dummy in range(max(1, timeout)):
-            async_result = async_action.run(task_vars=task_vars)
-            if async_result.get("finished", 0) == 1:
-                break
-            time.sleep(min(1, timeout))
-
-        return async_result
-
-    def run(self, tmp: str | None = None, task_vars: dict[str, t.Any] | None = None) -> dict[str, t.Any]:
-        self._supports_check_mode = True
-        self._supports_async = True
-
-        if task_vars is None:
-            task_vars = {}
-
-        result = super().run(tmp, task_vars)
-        del tmp  # tmp no longer has any effect
-
-        if not result.get("skipped"):
-            # FUTURE: better to let _execute_module calculate this internally?
-            wrap_async = self._task.async_val and not self._connection.has_native_async
-
-            # Set short names for values we'll have to compare or reuse
-            task_poll = self._task.poll
-            task_async = self._task.async_val
-            check_mode = self._play_context.check_mode
-            max_timeout = self._connection._play_context.timeout
-            module_args = self._task.args
-
-            async_status_args = {}
-            starter_cmd = None
-            confirm_cmd = None
-
-            if module_args.get("state", None) == "restored":
-                if not wrap_async:
-                    if not check_mode:
-                        display.warning(self.msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout))
-                elif task_poll:
-                    raise AnsibleActionFail(
-                        self.msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout)
-                    )
-                else:
-                    if task_async > max_timeout and not check_mode:
-                        display.warning(
-                            self.msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout)
-                        )
-
-                    # inject the async directory based on the shell option into the
-                    # module args
-                    async_dir = self.get_shell_option("async_dir", default="~/.ansible_async")
-
-                    # Bind the loop max duration to consistent values on both
-                    # remote and local sides (if not the same, make the loop
-                    # longer on the controller); and set a backup file path.
-                    module_args["_timeout"] = task_async
-                    module_args["_back"] = f"{async_dir}/iptables.state"
-                    async_status_args = dict(mode="status")
-                    confirm_cmd = f"rm -f {module_args['_back']}"
-                    starter_cmd = f"touch {module_args['_back']}.starter"
-                    remaining_time = max(task_async, max_timeout)
-
-            # do work!
-            result = merge_hash(
-                result, self._execute_module(module_args=module_args, task_vars=task_vars, wrap_async=wrap_async)
-            )
-
-            # Then the 3-steps "go ahead or rollback":
-            # 1. Catch early errors of the module (in asynchronous task) if any.
-            #    Touch a file on the target to signal the module to process now.
-            # 2. Reset connection to ensure a persistent one will not be reused.
-            # 3. Confirm the restored state by removing the backup on the remote.
-            #    Retrieve the results of the asynchronous task to return them.
-            if "_back" in module_args:
-                async_status_args["jid"] = result.get("ansible_job_id", None)
-                if async_status_args["jid"] is None:
-                    raise AnsibleActionFail("Unable to get 'ansible_job_id'.")
-
-                # Catch early errors due to missing mandatory option, bad
-                # option type/value, missing required system command, etc.
-                result = merge_hash(result, self._async_result(async_status_args, task_vars, 0))
-
-                # The module is aware to not process the main iptables-restore
-                # command before finding (and deleting) the 'starter' cookie on
-                # the host, so the previous query will not reach ssh timeout.
-                dummy = self._low_level_execute_command(starter_cmd, sudoable=self.DEFAULT_SUDOABLE)
-
-                # As the main command is not yet executed on the target, here
-                # 'finished' means 'failed before main command be executed'.
-                if not result["finished"]:
-                    try:
-                        self._connection.reset()
-                    except AttributeError:
-                        pass
-
-                    for dummy in range(max_timeout):
-                        time.sleep(1)
-                        remaining_time -= 1
-                        # - AnsibleConnectionFailure covers rejected requests (i.e.
-                        #   by rules with '--jump REJECT')
-                        # - ansible_timeout is able to cover dropped requests (due
-                        #   to a rule or policy DROP) if not lower than async_val.
-                        try:
-                            dummy = self._low_level_execute_command(confirm_cmd, sudoable=self.DEFAULT_SUDOABLE)
-                            break
-                        except AnsibleConnectionFailure:
-                            continue
-
-                    result = merge_hash(result, self._async_result(async_status_args, task_vars, remaining_time))
-
-                # Cleanup async related stuff and internal params
-                for key in ("ansible_job_id", "results_file", "started", "finished"):
-                    if result.get(key):
-                        del result[key]
-
-                if result.get("invocation", {}).get("module_args"):
-                    for key in ("_back", "_timeout", "_async_dir", "jid"):
-                        if result["invocation"]["module_args"].get(key):
-                            del result["invocation"]["module_args"][key]
-
-                async_status_args["mode"] = "cleanup"
-                dummy = self._async_result(async_status_args, task_vars, 0)
-
-        if not wrap_async:
-            # remove a temporary path we created
-            self._remove_tmp_path(self._connection._shell.tmpdir)
-
-        return result

plugins/action/iptables_state.py

@@ -0,0 +1 @@
+./system/iptables_state.py

plugins/action/shutdown.py

@@ -1,221 +0,0 @@
-# Copyright (c) 2020, Amin Vakil <info@aminvakil.com>
-# Copyright (c) 2016-2018, Matt Davis <mdavis@ansible.com>
-# Copyright (c) 2018, Sam Doran <sdoran@redhat.com>
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-from __future__ import annotations
-
-
-import typing as t
-
-from ansible.errors import AnsibleError, AnsibleConnectionFailure
-from ansible.module_utils.common.text.converters import to_native, to_text
-from ansible.module_utils.common.collections import is_string
-from ansible.plugins.action import ActionBase
-from ansible.utils.display import Display
-
-if t.TYPE_CHECKING:
-
-    class Distribution(t.TypedDict):
-        name: str
-        version: str
-        family: str
-
-
-display = Display()
-
-
-class TimedOutException(Exception):
-    pass
-
-
-class ActionModule(ActionBase):
-    TRANSFERS_FILES = False
-    _VALID_ARGS = frozenset(("msg", "delay", "search_paths"))
-
-    DEFAULT_CONNECT_TIMEOUT = None
-    DEFAULT_PRE_SHUTDOWN_DELAY = 0
-    DEFAULT_SHUTDOWN_MESSAGE = "Shut down initiated by Ansible"
-    DEFAULT_SHUTDOWN_COMMAND = "shutdown"
-    DEFAULT_SHUTDOWN_COMMAND_ARGS = '-h {delay_min} "{message}"'
-    DEFAULT_SUDOABLE = True
-
-    SHUTDOWN_COMMANDS = {
-        "alpine": "poweroff",
-        "vmkernel": "halt",
-    }
-
-    SHUTDOWN_COMMAND_ARGS = {
-        "alpine": "",
-        "void": '-h +{delay_min} "{message}"',
-        "freebsd": '-p +{delay_sec}s "{message}"',
-        "linux": DEFAULT_SHUTDOWN_COMMAND_ARGS,
-        "macosx": '-h +{delay_min} "{message}"',
-        "openbsd": '-h +{delay_min} "{message}"',
-        "solaris": '-y -g {delay_sec} -i 5 "{message}"',
-        "sunos": '-y -g {delay_sec} -i 5 "{message}"',
-        "vmkernel": "-d {delay_sec}",
-        "aix": "-Fh",
-    }
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-    @property
-    def delay(self):
-        return self._check_delay("delay", self.DEFAULT_PRE_SHUTDOWN_DELAY)
-
-    def _check_delay(self, key: str, default: int) -> int:
-        """Ensure that the value is positive or zero"""
-        value = int(self._task.args.get(key, default))
-        if value < 0:
-            value = 0
-        return value
-
-    @staticmethod
-    def _get_value_from_facts(data: dict[str, str], distribution: Distribution, default_value: str) -> str:
-        """Get dist+version specific args first, then distribution, then family, lastly use default"""
-        return data.get(
-            distribution["name"] + distribution["version"],
-            data.get(distribution["name"], data.get(distribution["family"], default_value)),
-        )
-
-    def get_distribution(self, task_vars: dict[str, t.Any]) -> Distribution:
-        # FIXME: only execute the module if we don't already have the facts we need
-        display.debug(f"{self._task.action}: running setup module to get distribution")
-        module_output = self._execute_module(
-            task_vars=task_vars, module_name="ansible.legacy.setup", module_args={"gather_subset": "min"}
-        )
-        try:
-            if module_output.get("failed", False):
-                raise AnsibleError(
-                    f"Failed to determine system distribution. {to_native(module_output['module_stdout'])}, {to_native(module_output['module_stderr'])}"
-                )
-            distribution: Distribution = {
-                "name": module_output["ansible_facts"]["ansible_distribution"].lower(),
-                "version": to_text(module_output["ansible_facts"]["ansible_distribution_version"].split(".")[0]),
-                "family": to_text(module_output["ansible_facts"]["ansible_os_family"].lower()),
-            }
-            display.debug(f"{self._task.action}: distribution: {distribution}")
-            return distribution
-        except KeyError as ke:
-            raise AnsibleError(f'Failed to get distribution information. Missing "{ke.args[0]}" in output.') from ke
-
-    def get_shutdown_command(self, task_vars: dict[str, t.Any], distribution: Distribution) -> str:
-        def find_command(command: str, find_search_paths: list[str]) -> list[str]:
-            display.debug(
-                f'{self._task.action}: running find module looking in {find_search_paths} to get path for "{command}"'
-            )
-            find_result = self._execute_module(
-                task_vars=task_vars,
-                # prevent collection search by calling with ansible.legacy (still allows library/ override of find)
-                module_name="ansible.legacy.find",
-                module_args={"paths": find_search_paths, "patterns": [command], "file_type": "any"},
-            )
-            return [x["path"] for x in find_result["files"]]
-
-        shutdown_bin = self._get_value_from_facts(self.SHUTDOWN_COMMANDS, distribution, self.DEFAULT_SHUTDOWN_COMMAND)
-        default_search_paths = ["/sbin", "/usr/sbin", "/usr/local/sbin"]
-        search_paths = self._task.args.get("search_paths", default_search_paths)
-
-        # FIXME: switch all this to user arg spec validation methods when they are available
-        # Convert bare strings to a list
-        if is_string(search_paths):
-            search_paths = [search_paths]
-
-        try:
-            incorrect_type = any(not is_string(x) for x in search_paths)
-            if not isinstance(search_paths, list) or incorrect_type:
-                raise TypeError
-        except TypeError as e:
-            # Error if we didn't get a list
-            err_msg = f"'search_paths' must be a string or flat list of strings, got {search_paths}"
-            raise AnsibleError(err_msg) from e
-
-        full_path = find_command(shutdown_bin, search_paths)  # find the path to the shutdown command
-        if not full_path:  # if we could not find the shutdown command
-            # tell the user we will try with systemd
-            display.vvv(
-                f'Unable to find command "{shutdown_bin}" in search paths: {search_paths}, will attempt a shutdown using systemd directly.'
-            )
-            systemctl_search_paths = ["/bin", "/usr/bin"]
-            full_path = find_command("systemctl", systemctl_search_paths)  # find the path to the systemctl command
-            if not full_path:  # if we couldn't find systemctl
-                raise AnsibleError(
-                    f'Could not find command "{shutdown_bin}" in search paths: {search_paths} or systemctl'
-                    f" command in search paths: {systemctl_search_paths}, unable to shutdown."
-                )  # we give up here
-            else:
-                return f"{full_path[0]} poweroff"  # done, since we cannot use args with systemd shutdown
-
-        # systemd case taken care of, here we add args to the command
-        args = self._get_value_from_facts(self.SHUTDOWN_COMMAND_ARGS, distribution, self.DEFAULT_SHUTDOWN_COMMAND_ARGS)
-        # Convert seconds to minutes. If less that 60, set it to 0.
-        delay_sec = self.delay
-        shutdown_message = self._task.args.get("msg", self.DEFAULT_SHUTDOWN_MESSAGE)
-
-        af = args.format(delay_sec=delay_sec, delay_min=delay_sec // 60, message=shutdown_message)
-        return f"{full_path[0]} {af}"
-
-    def perform_shutdown(self, task_vars, distribution) -> dict[str, t.Any]:
-        result: dict[str, t.Any] = {}
-        shutdown_result = {}
-        shutdown_command_exec = self.get_shutdown_command(task_vars, distribution)
-
-        self.cleanup(force=True)
-        try:
-            display.vvv(f"{self._task.action}: shutting down server...")
-            display.debug(f"{self._task.action}: shutting down server with command '{shutdown_command_exec}'")
-            if self._play_context.check_mode:
-                shutdown_result["rc"] = 0
-            else:
-                shutdown_result = self._low_level_execute_command(shutdown_command_exec, sudoable=self.DEFAULT_SUDOABLE)
-        except AnsibleConnectionFailure as e:
-            # If the connection is closed too quickly due to the system being shutdown, carry on
-            display.debug(f"{self._task.action}: AnsibleConnectionFailure caught and handled: {e}")
-            shutdown_result["rc"] = 0
-
-        if shutdown_result["rc"] != 0:
-            result["failed"] = True
-            result["shutdown"] = False
-            result["msg"] = (
-                f"Shutdown command failed. Error was {to_native(shutdown_result['stdout'])}, {to_native(shutdown_result['stderr'])}"
-            )
-            return result
-
-        result["failed"] = False
-        result["shutdown_command"] = shutdown_command_exec
-        return result
-
-    def run(self, tmp: str | None = None, task_vars: dict[str, t.Any] | None = None) -> dict[str, t.Any]:
-        self._supports_check_mode = True
-        self._supports_async = True
-
-        # If running with local connection, fail so we don't shutdown ourself
-        if self._connection.transport == "local" and (not self._play_context.check_mode):
-            msg = f"Running {self._task.action} with local connection would shutdown the control node."
-            return {"changed": False, "elapsed": 0, "shutdown": False, "failed": True, "msg": msg}
-
-        if task_vars is None:
-            task_vars = {}
-
-        result = super().run(tmp, task_vars)
-
-        if result.get("skipped", False) or result.get("failed", False):
-            return result
-
-        distribution = self.get_distribution(task_vars)
-
-        # Initiate shutdown
-        shutdown_result = self.perform_shutdown(task_vars, distribution)
-
-        if shutdown_result["failed"]:
-            result = shutdown_result
-            return result
-
-        result["shutdown"] = True
-        result["changed"] = True
-        result["shutdown_command"] = shutdown_result["shutdown_command"]
-
-        return result

plugins/action/shutdown.py

@@ -0,0 +1 @@
+./system/shutdown.py

plugins/action/system/iptables_state.py

@@ -0,0 +1,189 @@
+# Copyright: (c) 2020, quidame <quidame@poivron.org>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import time
+
+from ansible.plugins.action import ActionBase
+from ansible.errors import AnsibleError, AnsibleActionFail, AnsibleConnectionFailure
+from ansible.utils.vars import merge_hash
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class ActionModule(ActionBase):
+
+    # Keep internal params away from user interactions
+    _VALID_ARGS = frozenset(('path', 'state', 'table', 'noflush', 'counters', 'modprobe', 'ip_version', 'wait'))
+    DEFAULT_SUDOABLE = True
+
+    MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO = (
+        "This module doesn't support async>0 and poll>0 when its 'state' param "
+        "is set to 'restored'. To enable its rollback feature (that needs the "
+        "module to run asynchronously on the remote), please set task attribute "
+        "'poll' (=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
+    MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK = (
+        "Attempts to restore iptables state without rollback in case of mistake "
+        "may lead the ansible controller to loose access to the hosts and never "
+        "regain it before fixing firewall rules through a serial console, or any "
+        "other way except SSH. Please set task attribute 'poll' (=%s) to 0, and "
+        "'async' (=%s) to a value >2 and not greater than 'ansible_timeout' (=%s) "
+        "(recommended).")
+    MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT = (
+        "You attempt to restore iptables state with rollback in case of mistake, "
+        "but with settings that will lead this rollback to happen AFTER that the "
+        "controller will reach its own timeout. Please set task attribute 'poll' "
+        "(=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
+
+    def _async_result(self, module_args, task_vars, timeout):
+        '''
+        Retrieve results of the asynchonous task, and display them in place of
+        the async wrapper results (those with the ansible_job_id key).
+        '''
+        # At least one iteration is required, even if timeout is 0.
+        for i in range(max(1, timeout)):
+            async_result = self._execute_module(
+                module_name='ansible.builtin.async_status',
+                module_args=module_args,
+                task_vars=task_vars,
+                wrap_async=False)
+            if async_result['finished'] == 1:
+                break
+            time.sleep(min(1, timeout))
+
+        return async_result
+
+    def run(self, tmp=None, task_vars=None):
+
+        self._supports_check_mode = True
+        self._supports_async = True
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+        del tmp  # tmp no longer has any effect
+
+        if not result.get('skipped'):
+
+            # FUTURE: better to let _execute_module calculate this internally?
+            wrap_async = self._task.async_val and not self._connection.has_native_async
+
+            # Set short names for values we'll have to compare or reuse
+            task_poll = self._task.poll
+            task_async = self._task.async_val
+            check_mode = self._play_context.check_mode
+            max_timeout = self._connection._play_context.timeout
+            module_name = self._task.action
+            module_args = self._task.args
+
+            if module_args.get('state', None) == 'restored':
+                if not wrap_async:
+                    if not check_mode:
+                        display.warning(self.MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK % (
+                            task_poll,
+                            task_async,
+                            max_timeout))
+                elif task_poll:
+                    raise AnsibleActionFail(self.MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO % (
+                        task_poll,
+                        task_async,
+                        max_timeout))
+                else:
+                    if task_async > max_timeout and not check_mode:
+                        display.warning(self.MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT % (
+                            task_poll,
+                            task_async,
+                            max_timeout))
+
+                    # BEGIN snippet from async_status action plugin
+                    env_async_dir = [e for e in self._task.environment if
+                                     "ANSIBLE_ASYNC_DIR" in e]
+                    if len(env_async_dir) > 0:
+                        # for backwards compatibility we need to get the dir from
+                        # ANSIBLE_ASYNC_DIR that is defined in the environment. This is
+                        # deprecated and will be removed in favour of shell options
+                        async_dir = env_async_dir[0]['ANSIBLE_ASYNC_DIR']
+
+                        msg = "Setting the async dir from the environment keyword " \
+                              "ANSIBLE_ASYNC_DIR is deprecated. Set the async_dir " \
+                              "shell option instead"
+                        display.deprecated(msg, version='2.0.0',
+                                           collection_name='community.general')  # was Ansible 2.12
+                    else:
+                        # inject the async directory based on the shell option into the
+                        # module args
+                        async_dir = self.get_shell_option('async_dir', default="~/.ansible_async")
+                    # END snippet from async_status action plugin
+
+                    # Bind the loop max duration to consistent values on both
+                    # remote and local sides (if not the same, make the loop
+                    # longer on the controller); and set a backup file path.
+                    module_args['_timeout'] = task_async
+                    module_args['_back'] = '%s/iptables.state' % async_dir
+                    async_status_args = dict(_async_dir=async_dir)
+                    confirm_cmd = 'rm -f %s' % module_args['_back']
+                    remaining_time = max(task_async, max_timeout)
+
+            # do work!
+            result = merge_hash(result, self._execute_module(module_args=module_args, task_vars=task_vars, wrap_async=wrap_async))
+
+            # Then the 3-steps "go ahead or rollback":
+            # - reset connection to ensure a persistent one will not be reused
+            # - confirm the restored state by removing the backup on the remote
+            # - retrieve the results of the asynchronous task to return them
+            if '_back' in module_args:
+                async_status_args['jid'] = result.get('ansible_job_id', None)
+                if async_status_args['jid'] is None:
+                    raise AnsibleActionFail("Unable to get 'ansible_job_id'.")
+
+                # Catch early errors due to missing mandatory option, bad
+                # option type/value, missing required system command, etc.
+                result = merge_hash(result, self._async_result(async_status_args, task_vars, 0))
+
+                if not result['finished']:
+                    try:
+                        self._connection.reset()
+                        display.v("%s: reset connection" % (module_name))
+                    except AttributeError:
+                        display.warning("Connection plugin does not allow to reset the connection.")
+
+                    for x in range(max_timeout):
+                        time.sleep(1)
+                        remaining_time -= 1
+                        # - AnsibleConnectionFailure covers rejected requests (i.e.
+                        #   by rules with '--jump REJECT')
+                        # - ansible_timeout is able to cover dropped requests (due
+                        #   to a rule or policy DROP) if not lower than async_val.
+                        try:
+                            garbage = self._low_level_execute_command(confirm_cmd, sudoable=self.DEFAULT_SUDOABLE)
+                            break
+                        except AnsibleConnectionFailure:
+                            continue
+
+                    result = merge_hash(result, self._async_result(async_status_args, task_vars, remaining_time))
+
+                # Cleanup async related stuff and internal params
+                for key in ('ansible_job_id', 'results_file', 'started', 'finished'):
+                    if result.get(key):
+                        del result[key]
+
+                if result.get('invocation', {}).get('module_args'):
+                    if '_timeout' in result['invocation']['module_args']:
+                        del result['invocation']['module_args']['_back']
+                        del result['invocation']['module_args']['_timeout']
+
+                async_status_args['mode'] = 'cleanup'
+                garbage = self._execute_module(
+                    module_name='ansible.builtin.async_status',
+                    module_args=async_status_args,
+                    task_vars=task_vars,
+                    wrap_async=False)
+
+        if not wrap_async:
+            # remove a temporary path we created
+            self._remove_tmp_path(self._connection._shell.tmpdir)
+
+        return result

plugins/action/system/shutdown.py

@@ -0,0 +1,211 @@
+# Copyright: (c) 2020, Amin Vakil <info@aminvakil.com>
+# Copyright: (c) 2016-2018, Matt Davis <mdavis@ansible.com>
+# Copyright: (c) 2018, Sam Doran <sdoran@redhat.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.errors import AnsibleError, AnsibleConnectionFailure
+from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.common.collections import is_string
+from ansible.plugins.action import ActionBase
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class TimedOutException(Exception):
+    pass
+
+
+class ActionModule(ActionBase):
+    TRANSFERS_FILES = False
+    _VALID_ARGS = frozenset((
+        'msg',
+        'delay',
+        'search_paths'
+    ))
+
+    DEFAULT_CONNECT_TIMEOUT = None
+    DEFAULT_PRE_SHUTDOWN_DELAY = 0
+    DEFAULT_SHUTDOWN_MESSAGE = 'Shut down initiated by Ansible'
+    DEFAULT_SHUTDOWN_COMMAND = 'shutdown'
+    DEFAULT_SHUTDOWN_COMMAND_ARGS = '-h {delay_min} "{message}"'
+    DEFAULT_SUDOABLE = True
+
+    SHUTDOWN_COMMANDS = {
+        'alpine': 'poweroff',
+        'vmkernel': 'halt',
+    }
+
+    SHUTDOWN_COMMAND_ARGS = {
+        'alpine': '',
+        'void': '-h +{delay_min} "{message}"',
+        'freebsd': '-h +{delay_sec}s "{message}"',
+        'linux': DEFAULT_SHUTDOWN_COMMAND_ARGS,
+        'macosx': '-h +{delay_min} "{message}"',
+        'openbsd': '-h +{delay_min} "{message}"',
+        'solaris': '-y -g {delay_sec} -i 5 "{message}"',
+        'sunos': '-y -g {delay_sec} -i 5 "{message}"',
+        'vmkernel': '-d {delay_sec}',
+        'aix': '-Fh',
+    }
+
+    def __init__(self, *args, **kwargs):
+        super(ActionModule, self).__init__(*args, **kwargs)
+
+    @property
+    def delay(self):
+        return self._check_delay('delay', self.DEFAULT_PRE_SHUTDOWN_DELAY)
+
+    def _check_delay(self, key, default):
+        """Ensure that the value is positive or zero"""
+        value = int(self._task.args.get(key, default))
+        if value < 0:
+            value = 0
+        return value
+
+    def _get_value_from_facts(self, variable_name, distribution, default_value):
+        """Get dist+version specific args first, then distribution, then family, lastly use default"""
+        attr = getattr(self, variable_name)
+        value = attr.get(
+            distribution['name'] + distribution['version'],
+            attr.get(
+                distribution['name'],
+                attr.get(
+                    distribution['family'],
+                    getattr(self, default_value))))
+        return value
+
+    def get_shutdown_command_args(self, distribution):
+        args = self._get_value_from_facts('SHUTDOWN_COMMAND_ARGS', distribution, 'DEFAULT_SHUTDOWN_COMMAND_ARGS')
+        # Convert seconds to minutes. If less that 60, set it to 0.
+        delay_sec = self.delay
+        shutdown_message = self._task.args.get('msg', self.DEFAULT_SHUTDOWN_MESSAGE)
+        return args.format(delay_sec=delay_sec, delay_min=delay_sec // 60, message=shutdown_message)
+
+    def get_distribution(self, task_vars):
+        # FIXME: only execute the module if we don't already have the facts we need
+        distribution = {}
+        display.debug('{action}: running setup module to get distribution'.format(action=self._task.action))
+        module_output = self._execute_module(
+            task_vars=task_vars,
+            module_name='ansible.legacy.setup',
+            module_args={'gather_subset': 'min'})
+        try:
+            if module_output.get('failed', False):
+                raise AnsibleError('Failed to determine system distribution. {0}, {1}'.format(
+                    to_native(module_output['module_stdout']).strip(),
+                    to_native(module_output['module_stderr']).strip()))
+            distribution['name'] = module_output['ansible_facts']['ansible_distribution'].lower()
+            distribution['version'] = to_text(module_output['ansible_facts']['ansible_distribution_version'].split('.')[0])
+            distribution['family'] = to_text(module_output['ansible_facts']['ansible_os_family'].lower())
+            display.debug("{action}: distribution: {dist}".format(action=self._task.action, dist=distribution))
+            return distribution
+        except KeyError as ke:
+            raise AnsibleError('Failed to get distribution information. Missing "{0}" in output.'.format(ke.args[0]))
+
+    def get_shutdown_command(self, task_vars, distribution):
+        shutdown_bin = self._get_value_from_facts('SHUTDOWN_COMMANDS', distribution, 'DEFAULT_SHUTDOWN_COMMAND')
+        default_search_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']
+        search_paths = self._task.args.get('search_paths', default_search_paths)
+
+        # FIXME: switch all this to user arg spec validation methods when they are available
+        # Convert bare strings to a list
+        if is_string(search_paths):
+            search_paths = [search_paths]
+
+        # Error if we didn't get a list
+        err_msg = "'search_paths' must be a string or flat list of strings, got {0}"
+        try:
+            incorrect_type = any(not is_string(x) for x in search_paths)
+            if not isinstance(search_paths, list) or incorrect_type:
+                raise TypeError
+        except TypeError:
+            raise AnsibleError(err_msg.format(search_paths))
+
+        display.debug('{action}: running find module looking in {paths} to get path for "{command}"'.format(
+            action=self._task.action,
+            command=shutdown_bin,
+            paths=search_paths))
+        find_result = self._execute_module(
+            task_vars=task_vars,
+            # prevent collection search by calling with ansible.legacy (still allows library/ override of find)
+            module_name='ansible.legacy.find',
+            module_args={
+                'paths': search_paths,
+                'patterns': [shutdown_bin],
+                'file_type': 'any'
+            }
+        )
+
+        full_path = [x['path'] for x in find_result['files']]
+        if not full_path:
+            raise AnsibleError('Unable to find command "{0}" in search paths: {1}'.format(shutdown_bin, search_paths))
+        self._shutdown_command = full_path[0]
+        return self._shutdown_command
+
+    def perform_shutdown(self, task_vars, distribution):
+        result = {}
+        shutdown_result = {}
+        shutdown_command = self.get_shutdown_command(task_vars, distribution)
+        shutdown_command_args = self.get_shutdown_command_args(distribution)
+        shutdown_command_exec = '{0} {1}'.format(shutdown_command, shutdown_command_args)
+
+        self.cleanup(force=True)
+        try:
+            display.vvv("{action}: shutting down server...".format(action=self._task.action))
+            display.debug("{action}: shutting down server with command '{command}'".format(action=self._task.action, command=shutdown_command_exec))
+            if self._play_context.check_mode:
+                shutdown_result['rc'] = 0
+            else:
+                shutdown_result = self._low_level_execute_command(shutdown_command_exec, sudoable=self.DEFAULT_SUDOABLE)
+        except AnsibleConnectionFailure as e:
+            # If the connection is closed too quickly due to the system being shutdown, carry on
+            display.debug('{action}: AnsibleConnectionFailure caught and handled: {error}'.format(action=self._task.action, error=to_text(e)))
+            shutdown_result['rc'] = 0
+
+        if shutdown_result['rc'] != 0:
+            result['failed'] = True
+            result['shutdown'] = False
+            result['msg'] = "Shutdown command failed. Error was {stdout}, {stderr}".format(
+                stdout=to_native(shutdown_result['stdout'].strip()),
+                stderr=to_native(shutdown_result['stderr'].strip()))
+            return result
+
+        result['failed'] = False
+        result['shutdown_command'] = shutdown_command_exec
+        return result
+
+    def run(self, tmp=None, task_vars=None):
+        self._supports_check_mode = True
+        self._supports_async = True
+
+        # If running with local connection, fail so we don't shutdown ourself
+        if self._connection.transport == 'local' and (not self._play_context.check_mode):
+            msg = 'Running {0} with local connection would shutdown the control node.'.format(self._task.action)
+            return {'changed': False, 'elapsed': 0, 'shutdown': False, 'failed': True, 'msg': msg}
+
+        if task_vars is None:
+            task_vars = {}
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+
+        if result.get('skipped', False) or result.get('failed', False):
+            return result
+
+        distribution = self.get_distribution(task_vars)
+
+        # Initiate shutdown
+        shutdown_result = self.perform_shutdown(task_vars, distribution)
+
+        if shutdown_result['failed']:
+            result = shutdown_result
+            return result
+
+        result['shutdown'] = True
+        result['changed'] = True
+        result['shutdown_command'] = shutdown_result['shutdown_command']
+
+        return result

plugins/become/doas.py

@@ -1,137 +1,126 @@
-# Copyright (c) 2018, 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 annotations
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
 
-DOCUMENTATION = r"""
-name: doas
-short_description: Do As user
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(doas) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: doas_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_doas_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_DOAS_USER
-  become_exe:
-    description: C(doas) executable.
-    type: string
-    default: doas
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: doas_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_doas_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_DOAS_EXE
-  become_flags:
-    description: Options to pass to C(doas).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: doas_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_doas_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_DOAS_FLAGS
-  become_pass:
-    description: Password for C(doas) prompt.
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_doas_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_DOAS_PASS
-    ini:
-      - section: doas_become_plugin
-        key: password
-  prompt_l10n:
+DOCUMENTATION = '''
+    become: doas
+    short_description: Do As user
     description:
-      - List of localized strings to match for prompt detection.
-      - If empty the plugin uses the built-in one.
-    type: list
-    elements: string
-    default: []
-    ini:
-      - section: doas_become_plugin
-        key: localized_prompts
-    vars:
-      - 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.
-"""
+        - This become plugins allows your remote/login user to execute commands as another user via the doas utility.
+    author: ansible (@core)
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: doas_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_doas_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_DOAS_USER
+        become_exe:
+            description: Doas executable
+            default: doas
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: doas_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_doas_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_DOAS_EXE
+        become_flags:
+            description: Options to pass to doas
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: doas_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_doas_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_DOAS_FLAGS
+        become_pass:
+            description: password for doas prompt
+            required: False
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_doas_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_DOAS_PASS
+            ini:
+              - section: doas_become_plugin
+                key: password
+        prompt_l10n:
+            description:
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
+            default: []
+            ini:
+              - section: doas_become_plugin
+                key: localized_prompts
+            vars:
+              - name: ansible_doas_prompt_l10n
+            env:
+              - name: ANSIBLE_DOAS_PROMPT_L10N
+'''
 
 import re
 
-from ansible.module_utils.common.text.converters import to_bytes
+from ansible.module_utils._text import to_bytes
 from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-    name = "community.general.doas"
+
+    name = 'community.general.doas'
 
     # messages for detecting prompted password issues
-    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
+    fail = ('Permission denied',)
+    missing = ('Authorization required',)
 
     def check_password_prompt(self, b_output):
-        """checks if the expected password prompt exists in b_output"""
+        ''' checks if the expected password prompt exists in b_output '''
 
         # FIXME: more accurate would be: 'doas (%s@' % remote_user
         # however become plugins don't have that information currently
-        b_prompts = [to_bytes(p) for p in self.get_option("prompt_l10n")] or [rb"doas \(", rb"Password:"]
+        b_prompts = [to_bytes(p) for p in self.get_option('prompt_l10n')] or [br'doas \(', br'Password:']
         b_prompt = b"|".join(b_prompts)
 
         return bool(re.match(b_prompt, b_output))
 
     def build_become_command(self, cmd, shell):
-        super().build_become_command(cmd, shell)
+        super(BecomeModule, self).build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
         self.prompt = True
 
-        become_exe = self.get_option("become_exe")
+        become_exe = self.get_option('become_exe')
 
-        flags = self.get_option("become_flags")
-        if not self.get_option("become_pass") and "-n" not in flags:
-            flags += " -n"
+        flags = self.get_option('become_flags')
+        if not self.get_option('become_pass') and '-n' not in flags:
+            flags += ' -n'
 
-        become_user = self.get_option("become_user")
-        user = f"-u {become_user}" if become_user else ""
+        become_user = self.get_option('become_user')
+        user = '-u %s' % (become_user) if become_user else ''
 
         success_cmd = self._build_success_command(cmd, shell, noexe=True)
-        executable = getattr(shell, "executable", shell.SHELL_FAMILY)
+        executable = getattr(shell, 'executable', shell.SHELL_FAMILY)
 
-        return f"{become_exe} {flags} {user} {executable} -c {success_cmd}"
+        return '%s %s %s %s -c %s' % (become_exe, flags, user, executable, success_cmd)

plugins/become/dzdo.py

@@ -1,98 +1,95 @@
-# Copyright (c) 2018, 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 annotations
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
 
-DOCUMENTATION = r"""
-name: dzdo
-short_description: Centrify's Direct Authorize
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(dzdo) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: dzdo_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_dzdo_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_DZDO_USER
-  become_exe:
-    description: C(dzdo) executable.
-    type: string
-    default: dzdo
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: dzdo_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_dzdo_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_DZDO_EXE
-  become_flags:
-    description: Options to pass to C(dzdo).
-    type: string
-    default: -H -S -n
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: dzdo_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_dzdo_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_DZDO_FLAGS
-  become_pass:
-    description: Options to pass to C(dzdo).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_dzdo_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_DZDO_PASS
-    ini:
-      - section: dzdo_become_plugin
-        key: password
-"""
+DOCUMENTATION = '''
+    become: dzdo
+    short_description: Centrify's Direct Authorize
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the dzdo utility.
+    author: ansible (@core)
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: dzdo_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_dzdo_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_DZDO_USER
+        become_exe:
+            description: Dzdo executable
+            default: dzdo
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: dzdo_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_dzdo_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_DZDO_EXE
+        become_flags:
+            description: Options to pass to dzdo
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: dzdo_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_dzdo_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_DZDO_FLAGS
+        become_pass:
+            description: Options to pass to dzdo
+            required: False
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_dzdo_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_DZDO_PASS
+            ini:
+              - section: dzdo_become_plugin
+                key: password
+'''
 
 from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-    name = "community.general.dzdo"
+
+    name = 'community.general.dzdo'
 
     # messages for detecting prompted password issues
-    fail = ("Sorry, try again.",)
+    fail = ('Sorry, try again.',)
 
     def build_become_command(self, cmd, shell):
-        super().build_become_command(cmd, shell)
+        super(BecomeModule, self).build_become_command(cmd, shell)
 
         if not cmd:
             return cmd
 
-        becomecmd = self.get_option("become_exe")
+        becomecmd = self.get_option('become_exe')
 
-        flags = self.get_option("become_flags")
-        if self.get_option("become_pass"):
-            self.prompt = f"[dzdo via ansible, key={self._id}] password:"
-            flags = f'{flags.replace("-n", "")} -p "{self.prompt}"'
+        flags = self.get_option('become_flags')
+        if self.get_option('become_pass'):
+            self.prompt = '[dzdo via ansible, key=%s] password:' % self._id
+            flags = '%s -p "%s"' % (flags.replace('-n', ''), self.prompt)
 
-        become_user = self.get_option("become_user")
-        user = f"-u {become_user}" if become_user else ""
+        become_user = self.get_option('become_user')
+        user = '-u %s' % (become_user) if become_user else ''
 
-        return f"{becomecmd} {flags} {user} {self._build_success_command(cmd, shell)}"
+        return ' '.join([becomecmd, flags, user, self._build_success_command(cmd, shell)])

plugins/become/ksu.py

@@ -1,113 +1,110 @@
-# Copyright (c) 2018, 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 annotations
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
 
-DOCUMENTATION = r"""
-name: ksu
-short_description: Kerberos substitute user
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(ksu) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: ksu_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_ksu_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_KSU_USER
-    required: true
-  become_exe:
-    description: C(ksu) executable.
-    type: string
-    default: ksu
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: ksu_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_ksu_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_KSU_EXE
-  become_flags:
-    description: Options to pass to C(ksu).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: ksu_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_ksu_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_KSU_FLAGS
-  become_pass:
-    description: C(ksu) password.
-    type: string
-    required: false
-    vars:
-      - name: ansible_ksu_pass
-      - name: ansible_become_pass
-      - name: ansible_become_password
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_KSU_PASS
-    ini:
-      - section: ksu_become_plugin
-        key: password
-  prompt_l10n:
+DOCUMENTATION = '''
+    become: ksu
+    short_description: Kerberos substitute user
     description:
-      - List of localized strings to match for prompt detection.
-      - If empty the plugin uses the built-in one.
-    type: list
-    elements: string
-    default: []
-    ini:
-      - section: ksu_become_plugin
-        key: localized_prompts
-    vars:
-      - name: ansible_ksu_prompt_l10n
-    env:
-      - name: ANSIBLE_KSU_PROMPT_L10N
-"""
+        - This become plugins allows your remote/login user to execute commands as another user via the ksu utility.
+    author: ansible (@core)
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: ksu_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_ksu_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_KSU_USER
+            required: True
+        become_exe:
+            description: Su executable
+            default: ksu
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: ksu_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_ksu_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_KSU_EXE
+        become_flags:
+            description: Options to pass to ksu
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: ksu_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_ksu_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_KSU_FLAGS
+        become_pass:
+            description: ksu password
+            required: False
+            vars:
+              - name: ansible_ksu_pass
+              - name: ansible_become_pass
+              - name: ansible_become_password
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_KSU_PASS
+            ini:
+              - section: ksu_become_plugin
+                key: password
+        prompt_l10n:
+            description:
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
+            default: []
+            ini:
+              - section: ksu_become_plugin
+                key: localized_prompts
+            vars:
+              - name: ansible_ksu_prompt_l10n
+            env:
+              - name: ANSIBLE_KSU_PROMPT_L10N
+'''
 
 import re
 
-from ansible.module_utils.common.text.converters import to_bytes
+from ansible.module_utils._text import to_bytes
 from ansible.plugins.become import BecomeBase
 
 
 class BecomeModule(BecomeBase):
-    name = "community.general.ksu"
+
+    name = 'community.general.ksu'
 
     # messages for detecting prompted password issues
-    fail = ("Password incorrect",)
-    missing = ("No password given",)
+    fail = ('Password incorrect',)
+    missing = ('No password given',)
 
     def check_password_prompt(self, b_output):
-        """checks if the expected password prompt exists in b_output"""
+        ''' checks if the expected password prompt exists in b_output '''
 
-        prompts = self.get_option("prompt_l10n") or ["Kerberos password for .*@.*:"]
+        prompts = self.get_option('prompt_l10n') or ["Kerberos password for .*@.*:"]
         b_prompt = b"|".join(to_bytes(p) for p in prompts)
 
         return bool(re.match(b_prompt, b_output))
 
     def build_become_command(self, cmd, shell):
-        super().build_become_command(cmd, shell)
+
+        super(BecomeModule, self).build_become_command(cmd, shell)
 
         # Prompt handling for ``ksu`` is more complicated, this
         # is used to satisfy the connection plugin
@@ -116,8 +113,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        exe = self.get_option("become_exe")
+        exe = self.get_option('become_exe')
 
-        flags = self.get_option("become_flags")
-        user = self.get_option("become_user")
-        return f"{exe} {user} {flags} -e {self._build_success_command(cmd, shell)} "
+        flags = self.get_option('become_flags')
+        user = self.get_option('become_user')
+        return '%s %s %s -e %s ' % (exe, user, flags, self._build_success_command(cmd, shell))