Release 3.5.0.

* Support older version of psutil (RHEL7 and RHEL6)

The psutil python module is a true mess, they changed the API twice. The function arguments, as well as the objects that are returned.
The documentation does not make it clear which version supports what so the safest implementation is this waterfall approach.

A better approach would be to inspect the returned information, rather than trust a version, but that would not be any more efficient.
In the end it is better to have something that at least works out-of-the-box on all platforms than something that requires custom updates to system packages before it works as expected. Especially for something as basic as `pids`.

* A little bit more concise

* Apply suggestions from code review

* Add changelog fragment.

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

Co-authored-by: Dag Wieers <dag@wieers.com>

.azure-pipelines/azure-pipelines.yml

@@ -24,15 +24,14 @@ schedules:
     always: true
     branches:
       include:
+        - stable-2
         - stable-3
-        - stable-4
   - cron: 0 11 * * 0
     displayName: Weekly (old stable branches)
     always: true
     branches:
       include:
         - stable-1
-        - stable-2
 
 variables:
   - name: checkoutPath
@@ -69,32 +68,6 @@ stages:
             - test: 3
             - test: 4
             - test: extra
-  - stage: Sanity_2_13
-    displayName: Sanity 2.13
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.13/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
-  - stage: Sanity_2_12
-    displayName: Sanity 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.12/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
   - stage: Sanity_2_11
     displayName: Sanity 2.11
     dependsOn: []
@@ -144,6 +117,7 @@ stages:
           nameFormat: Python {0}
           testFormat: devel/units/{0}/1
           targets:
+            - test: 2.6
             - test: 2.7
             - test: 3.5
             - test: 3.6
@@ -151,31 +125,6 @@ stages:
             - test: 3.8
             - test: 3.9
             - test: '3.10'
-  - stage: Units_2_13
-    displayName: Units 2.13
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.13/units/{0}/1
-          targets:
-            - test: 2.7
-            - test: 3.6
-            - test: 3.8
-            - test: 3.9
-  - stage: Units_2_12
-    displayName: Units 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.12/units/{0}/1
-          targets:
-            - test: 2.6
-            - test: 3.5
-            - test: 3.8
   - stage: Units_2_11
     displayName: Units 2.11
     dependsOn: []
@@ -188,6 +137,9 @@ stages:
             - test: 2.6
             - test: 2.7
             - test: 3.5
+            - test: 3.6
+            - test: 3.7
+            - test: 3.8
             - test: 3.9
   - stage: Units_2_10
     displayName: Units 2.10
@@ -198,8 +150,13 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.10/units/{0}/1
           targets:
+            - test: 2.6
             - test: 2.7
+            - test: 3.5
             - test: 3.6
+            - test: 3.7
+            - test: 3.8
+            - test: 3.9
   - stage: Units_2_9
     displayName: Units 2.9
     dependsOn: []
@@ -210,7 +167,11 @@ stages:
           testFormat: 2.9/units/{0}/1
           targets:
             - test: 2.6
+            - test: 2.7
             - test: 3.5
+            - test: 3.6
+            - test: 3.7
+            - test: 3.8
 
 ## Remote
   - stage: Remote_devel
@@ -220,54 +181,21 @@ stages:
       - template: templates/matrix.yml
         parameters:
           testFormat: devel/{0}
-          targets:
-            - name: macOS 12.0
-              test: macos/12.0
-            - name: RHEL 7.9
-              test: rhel/7.9
-            - name: RHEL 8.5
-              test: rhel/8.5
-            - name: FreeBSD 12.3
-              test: freebsd/12.3
-            - name: FreeBSD 13.0
-              test: freebsd/13.0
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_13
-    displayName: Remote 2.13
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.13/{0}
-          targets:
-            - name: macOS 12.0
-              test: macos/12.0
-            - name: RHEL 8.5
-              test: rhel/8.5
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_12
-    displayName: Remote 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.12/{0}
           targets:
             - name: macOS 11.1
               test: macos/11.1
+            - name: RHEL 7.9
+              test: rhel/7.9
             - name: RHEL 8.4
               test: rhel/8.4
+            - name: FreeBSD 12.2
+              test: freebsd/12.2
             - name: FreeBSD 13.0
               test: freebsd/13.0
           groups:
             - 1
             - 2
+            - 3
   - stage: Remote_2_11
     displayName: Remote 2.11
     dependsOn: []
@@ -276,12 +204,14 @@ stages:
         parameters:
           testFormat: 2.11/{0}
           targets:
+            - name: macOS 11.1
+              test: macos/11.1
             - name: RHEL 7.9
               test: rhel/7.9
             - name: RHEL 8.3
               test: rhel/8.3
-            #- name: FreeBSD 12.2
-            #  test: freebsd/12.2
+            - name: FreeBSD 12.2
+              test: freebsd/12.2
           groups:
             - 1
             - 2
@@ -297,6 +227,14 @@ stages:
               test: osx/10.11
             - name: macOS 10.15
               test: macos/10.15
+            - name: macOS 11.1
+              test: macos/11.1
+            - name: RHEL 7.8
+              test: rhel/7.8
+            - name: RHEL 8.2
+              test: rhel/8.2
+            - name: FreeBSD 12.1
+              test: freebsd/12.1
           groups:
             - 1
             - 2
@@ -310,10 +248,8 @@ stages:
           targets:
             - name: RHEL 8.2
               test: rhel/8.2
-            - name: RHEL 7.8
-              test: rhel/7.8
-            #- name: FreeBSD 12.0
-            #  test: freebsd/12.0
+            - name: FreeBSD 12.0
+              test: freebsd/12.0
           groups:
             - 1
             - 2
@@ -327,56 +263,24 @@ stages:
         parameters:
           testFormat: devel/linux/{0}
           targets:
+            - name: CentOS 6
+              test: centos6
             - name: CentOS 7
               test: centos7
+            - name: CentOS 8
+              test: centos8
+            - name: Fedora 33
+              test: fedora33
             - name: Fedora 34
               test: fedora34
-            - name: Fedora 35
-              test: fedora35
-            - name: openSUSE 15
+            - name: openSUSE 15 py2
+              test: opensuse15py2
+            - name: openSUSE 15 py3
               test: opensuse15
             - name: Ubuntu 18.04
               test: ubuntu1804
             - name: Ubuntu 20.04
               test: ubuntu2004
-            - name: Alpine 3
-              test: alpine3
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_13
-    displayName: Docker 2.13
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.13/linux/{0}
-          targets:
-            - name: Fedora 35
-              test: fedora35
-            - name: openSUSE 15 py2
-              test: opensuse15py2
-            - name: Alpine 3
-              test: alpine3
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_12
-    displayName: Docker 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.12/linux/{0}
-          targets:
-            - name: CentOS 6
-              test: centos6
-            - name: Fedora 34
-              test: fedora34
-            - name: Ubuntu 20.04
-              test: ubuntu2004
           groups:
             - 1
             - 2
@@ -389,10 +293,14 @@ stages:
         parameters:
           testFormat: 2.11/linux/{0}
           targets:
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 33
               test: fedora33
-            - name: Alpine 3
-              test: alpine3
+            - name: openSUSE 15 py3
+              test: opensuse15
+            - name: Ubuntu 20.04
+              test: ubuntu2004
           groups:
             - 2
             - 3
@@ -404,8 +312,12 @@ stages:
         parameters:
           testFormat: 2.10/linux/{0}
           targets:
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 32
               test: fedora32
+            - name: openSUSE 15 py3
+              test: opensuse15
             - name: Ubuntu 16.04
               test: ubuntu1604
           groups:
@@ -419,32 +331,16 @@ stages:
         parameters:
           testFormat: 2.9/linux/{0}
           targets:
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 31
               test: fedora31
+            - name: openSUSE 15 py3
+              test: opensuse15
           groups:
             - 2
             - 3
 
-### Community Docker
-  - stage: Docker_community_devel
-    displayName: Docker (community images) devel
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: devel/linux-community/{0}
-          targets:
-            - name: Debian Bullseye
-              test: debian-bullseye/3.9
-            - name: ArchLinux
-              test: archlinux/3.10
-            - name: CentOS Stream 8
-              test: centos-stream8/3.8
-          groups:
-            - 1
-            - 2
-            - 3
-
 ### Cloud
   - stage: Cloud_devel
     displayName: Cloud devel
@@ -454,27 +350,6 @@ stages:
         parameters:
           nameFormat: Python {0}
           testFormat: devel/cloud/{0}/1
-          targets:
-            - test: 2.7
-            - test: '3.10'
-  - stage: Cloud_2_13
-    displayName: Cloud 2.13
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.13/cloud/{0}/1
-          targets:
-            - test: 3.9
-  - stage: Cloud_2_12
-    displayName: Cloud 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.12/cloud/{0}/1
           targets:
             - test: 3.8
   - stage: Cloud_2_11
@@ -486,6 +361,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.11/cloud/{0}/1
           targets:
+            - test: 2.7
             - test: 3.6
   - stage: Cloud_2_10
     displayName: Cloud 2.10
@@ -496,7 +372,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.10/cloud/{0}/1
           targets:
-            - test: 3.5
+            - test: 3.6
   - stage: Cloud_2_9
     displayName: Cloud 2.9
     dependsOn: []
@@ -506,7 +382,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.9/cloud/{0}/1
           targets:
-            - test: 2.7
+            - test: 3.6
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
@@ -514,32 +390,21 @@ stages:
       - Sanity_2_9
       - Sanity_2_10
       - Sanity_2_11
-      - Sanity_2_12
-      - Sanity_2_13
       - Units_devel
       - Units_2_9
       - Units_2_10
       - Units_2_11
-      - Units_2_12
-      - Units_2_13
       - Remote_devel
       - Remote_2_9
       - Remote_2_10
       - Remote_2_11
-      - Remote_2_12
-      - Remote_2_13
       - Docker_devel
       - Docker_2_9
       - Docker_2_10
       - Docker_2_11
-      - Docker_2_12
-      - Docker_2_13
-      - Docker_community_devel
       - Cloud_devel
       - Cloud_2_9
       - Cloud_2_10
       - Cloud_2_11
-      - Cloud_2_12
-      - Cloud_2_13
     jobs:
       - template: templates/coverage.yml

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

@@ -11,7 +11,7 @@ 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[@]}"
+ansible-test coverage combine --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.

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

@@ -1,101 +0,0 @@
-#!/usr/bin/env python
-"""
-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/publish-codecov.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# 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.
+
+set -o pipefail -eu
+
+output_path="$1"
+
+curl --silent --show-error https://ansible-ci-files.s3.us-east-1.amazonaws.com/codecov/codecov.sh > codecov.sh
+
+for file in "${output_path}"/reports/coverage*.xml; do
+    name="${file}"
+    name="${name##*/}"  # remove path
+    name="${name##coverage=}"  # remove 'coverage=' prefix if present
+    name="${name%.xml}"  # remove '.xml' suffix
+
+    bash codecov.sh \
+        -f "${file}" \
+        -n "${name}" \
+        -X coveragepy \
+        -X gcov \
+        -X fix \
+        -X search \
+        -X xcode \
+        || echo "Failed to upload code coverage report to codecov.io: ${file}"
+done

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

@@ -12,4 +12,4 @@ if ! ansible-test --help >/dev/null 2>&1; then
     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
+ansible-test coverage xml --stub --venv --venv-system-site-packages --color -v

.azure-pipelines/templates/coverage.yml

@@ -33,7 +33,7 @@ jobs:
           summaryFileLocation: "$(outputPath)/reports/$(pipelinesCoverage).xml"
         displayName: Publish to Azure Pipelines
         condition: gt(variables.coverageFileCount, 0)
-      - bash: .azure-pipelines/scripts/publish-codecov.py "$(outputPath)"
+      - bash: .azure-pipelines/scripts/publish-codecov.sh "$(outputPath)"
         displayName: Publish to codecov.io
         condition: gt(variables.coverageFileCount, 0)
         continueOnError: true

.github/BOTMETA.yml

@@ -1,8 +1,7 @@
-notifications: true
 automerge: true
 files:
   plugins/:
-    supershipit: quidame
+    supershipit: quidame Ajpantuso
   changelogs/: {}
   changelogs/fragments/:
     support: community
@@ -49,9 +48,6 @@ files:
     maintainers: dagwieers
   $callbacks/diy.py:
     maintainers: theque5t
-  $callbacks/elastic.py:
-    maintainers: v1v
-    keywords: apm observability
   $callbacks/hipchat.py: {}
   $callbacks/jabber.py: {}
   $callbacks/loganalytics.py:
@@ -66,9 +62,6 @@ files:
   $callbacks/nrdp.py:
     maintainers: rverchere
   $callbacks/null.py: {}
-  $callbacks/opentelemetry.py:
-    maintainers: v1v
-    keywords: opentelemetry observability
   $callbacks/say.py:
     notify: chris-short
     maintainers: $team_macos
@@ -118,8 +111,6 @@ files:
   $doc_fragments/xenserver.py:
     maintainers: bvitnik
     labels: xenserver
-  $filters/counter.py:
-    maintainers: keilr
   $filters/dict.py:
     maintainers: felixfontein
   $filters/dict_kv.py:
@@ -140,8 +131,6 @@ files:
   $filters/random_mac.py: {}
   $filters/time.py:
     maintainers: resmo
-  $filters/unicode_normalize.py:
-    maintainers: Ajpantuso
   $filters/version_sort.py:
     maintainers: ericzolf
   $inventories/:
@@ -158,17 +147,9 @@ files:
     maintainers: conloos
   $inventories/nmap.py: {}
   $inventories/online.py:
-    maintainers: remyleone
-  $inventories/opennebula.py:
-    maintainers: feldsam
-    labels: cloud opennebula
-    keywords: opennebula dynamic inventory script
+    maintainers: sieben
   $inventories/proxmox.py:
     maintainers: $team_virt ilijamt
-  $inventories/xen_orchestra.py:
-    maintainers: ddelnano shinuza
-  $inventories/icinga2.py:
-    maintainers: BongoEADGC6
   $inventories/scaleway.py:
     maintainers: $team_scaleway
     labels: cloud scaleway
@@ -179,8 +160,6 @@ files:
     labels: lookups
   $lookups/cartesian.py: {}
   $lookups/chef_databag.py: {}
-  $lookups/collection_version.py:
-    maintainers: felixfontein
   $lookups/consul_kv.py: {}
   $lookups/credstash.py: {}
   $lookups/cyberarkpassword.py:
@@ -194,7 +173,7 @@ files:
   $lookups/dnstxt.py:
     maintainers: jpmens
   $lookups/dsv.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus
   $lookups/etcd3.py:
     maintainers: eric-belhomme
   $lookups/etcd.py:
@@ -211,6 +190,9 @@ files:
   $lookups/manifold.py:
     maintainers: galanoff
     labels: manifold
+  $lookups/nios:
+    maintainers: $team_networking sganesh-infoblox
+    labels: infoblox networking
   $lookups/onepass:
     maintainers: samdoran
     labels: onepassword
@@ -223,15 +205,11 @@ files:
     maintainers: Akasurde
   $lookups/random_string.py:
     maintainers: Akasurde
-  $lookups/random_words.py:
-    maintainers: konstruktoid
   $lookups/redis.py:
     maintainers: $team_ansible_core jpmens
-  $lookups/revbitspss.py:
-    maintainers: RevBits
   $lookups/shelvefile.py: {}
   $lookups/tss.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus
   $module_utils/:
     labels: module_utils
   $module_utils/gitlab.py:
@@ -260,8 +238,9 @@ files:
   $module_utils/module_helper.py:
     maintainers: russoz
     labels: module_helper
-  $module_utils/net_tools/pritunl/:
-    maintainers: Lowess
+  $module_utils/net_tools/nios/api.py:
+    maintainers: $team_networking sganesh-infoblox
+    labels: infoblox networking
   $module_utils/oracle/oci_utils.py:
     maintainers: $team_oracle
     labels: cloud
@@ -312,8 +291,6 @@ files:
     ignore: hnakamur
   $modules/cloud/lxd/lxd_profile.py:
     maintainers: conloos
-  $modules/cloud/lxd/lxd_project.py:
-    maintainers: we10710aa
   $modules/cloud/memset/:
     maintainers: glitchcrab
   $modules/cloud/misc/cloud_init_data_facts.py:
@@ -328,10 +305,6 @@ files:
   $modules/cloud/misc/proxmox_kvm.py:
     maintainers: helldorado
     ignore: skvidal
-  $modules/cloud/misc/proxmox_nic.py:
-    maintainers: Kogelvis
-  $modules/cloud/misc/proxmox_tasks_info:
-    maintainers: paginabianca
   $modules/cloud/misc/proxmox_template.py:
     maintainers: UnderGreen
     ignore: skvidal
@@ -351,7 +324,7 @@ files:
   $modules/cloud/oneandone/:
     maintainers: aajdinov edevenport
   $modules/cloud/online/:
-    maintainers: remyleone
+    maintainers: sieben
   $modules/cloud/opennebula/:
     maintainers: $team_opennebula
   $modules/cloud/opennebula/one_host.py:
@@ -421,13 +394,11 @@ files:
   $modules/cloud/scaleway/scaleway_ip_info.py:
     maintainers: Spredzy
   $modules/cloud/scaleway/scaleway_organization_info.py:
-    maintainers: Spredzy
-  $modules/cloud/scaleway/scaleway_private_network.py:
-    maintainers: pastral
+    maintainers: sieben Spredzy
   $modules/cloud/scaleway/scaleway_security_group.py:
     maintainers: DenBeke
   $modules/cloud/scaleway/scaleway_security_group_info.py:
-    maintainers: Spredzy
+    maintainers: sieben Spredzy
   $modules/cloud/scaleway/scaleway_security_group_rule.py:
     maintainers: DenBeke
   $modules/cloud/scaleway/scaleway_server_info.py:
@@ -487,20 +458,11 @@ files:
     maintainers: slok
   $modules/database/misc/redis_info.py:
     maintainers: levonet
-  $modules/database/misc/redis_data_info.py:
-    maintainers: paginabianca
-  $modules/database/misc/redis_data.py:
-    maintainers: paginabianca
-  $modules/database/misc/redis_data_incr.py:
-    maintainers: paginabianca
   $modules/database/misc/riak.py:
     maintainers: drewkerrigan jsmartin
   $modules/database/mssql/mssql_db.py:
     maintainers: vedit Jmainguy kenichi-ogawa-1988
     labels: mssql_db
-  $modules/database/mssql/mssql_script.py:
-    maintainers: kbudde
-    labels: mssql_script
   $modules/database/saphana/hana_query.py:
     maintainers: rainerleber
   $modules/database/vertica/:
@@ -544,16 +506,10 @@ files:
     maintainers: Gaetan2907
   $modules/identity/keycloak/keycloak_group.py:
     maintainers: adamgoossens
-  $modules/identity/keycloak/keycloak_identity_provider.py:
-    maintainers: laurpaum
-  $modules/identity/keycloak/keycloak_realm_info.py:
-    maintainers: fynncfchen
   $modules/identity/keycloak/keycloak_realm.py:
     maintainers: kris2kris
   $modules/identity/keycloak/keycloak_role.py:
     maintainers: laurpaum
-  $modules/identity/keycloak/keycloak_user_federation.py:
-    maintainers: laurpaum
   $modules/identity/onepassword_info.py:
     maintainers: Rylon
   $modules/identity/opendj/opendj_backendprop.py:
@@ -562,8 +518,6 @@ files:
     maintainers: phumpal
     labels: airbrake_deployment
     ignore: bpennypacker
-  $modules/monitoring/alerta_customer.py:
-    maintainers: cwollinger
   $modules/monitoring/bigpanda.py:
     maintainers: hkariti
   $modules/monitoring/circonus_annotation.py:
@@ -635,8 +589,6 @@ files:
     labels: cloudflare_dns
   $modules/net_tools/dnsimple.py:
     maintainers: drcapulet
-  $modules/net_tools/dnsimple_info.py:
-    maintainers: edhilgendorf
   $modules/net_tools/dnsmadeeasy.py:
     maintainers: briceburg
   $modules/net_tools/gandi_livedns.py:
@@ -672,6 +624,31 @@ files:
     maintainers: amasolov nerzhul
   $modules/net_tools/pritunl/:
     maintainers: Lowess
+  $modules/net_tools/nios/:
+    maintainers: $team_networking
+    labels: infoblox networking
+  $modules/net_tools/nios/nios_a_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_aaaa_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_cname_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_fixed_address.py:
+    maintainers: sjaiswal
+  $modules/net_tools/nios/nios_member.py:
+    maintainers: krisvasudevan
+  $modules/net_tools/nios/nios_mx_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_naptr_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_nsgroup.py:
+    maintainers: ebirn sjaiswal
+  $modules/net_tools/nios/nios_ptr_record.py:
+    maintainers: clementtrebuchet
+  $modules/net_tools/nios/nios_srv_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_txt_record.py:
+    maintainers: coreywan
   $modules/net_tools/nmcli.py:
     maintainers: alcamie101
   $modules/net_tools/snmp_facts.py:
@@ -738,8 +715,6 @@ files:
     maintainers: mwarkentin
   $modules/packaging/language/bundler.py:
     maintainers: thoiberg
-  $modules/packaging/language/cargo.py:
-    maintainers: radek-sprta
   $modules/packaging/language/composer.py:
     maintainers: dmtrs
     ignore: resmo
@@ -763,8 +738,6 @@ files:
     ignore: jle64
   $modules/packaging/language/pip_package_info.py:
     maintainers: bcoca matburt maxamillion
-  $modules/packaging/language/pipx.py:
-    maintainers: russoz
   $modules/packaging/language/yarn.py:
     maintainers: chrishoffman verkaufer
   $modules/packaging/os/apk.py:
@@ -777,8 +750,6 @@ files:
     maintainers: evgkrsk
   $modules/packaging/os/copr.py:
     maintainers: schlupov
-  $modules/packaging/os/dnf_versionlock.py:
-    maintainers: moreda
   $modules/packaging/os/flatpak.py:
     maintainers: $team_flatpak
   $modules/packaging/os/flatpak_remote.py:
@@ -827,7 +798,7 @@ files:
   $modules/packaging/os/opkg.py:
     maintainers: skinp
   $modules/packaging/os/pacman.py:
-    maintainers: elasticdog indrajitr tchernomax jraby
+    maintainers: elasticdog indrajitr tchernomax
     labels: pacman
     ignore: elasticdog
   $modules/packaging/os/pacman_key.py:
@@ -875,9 +846,6 @@ files:
   $modules/packaging/os/snap.py:
     maintainers: angristan vcarceler
     labels: snap
-  $modules/packaging/os/snap_alias.py:
-    maintainers: russoz
-    labels: snap
   $modules/packaging/os/sorcery.py:
     maintainers: vaygr
   $modules/packaging/os/svr4pkg.py:
@@ -921,10 +889,6 @@ files:
   $modules/remote_management/manageiq/:
     labels: manageiq
     maintainers: $team_manageiq
-  $modules/remote_management/manageiq/manageiq_alert_profiles.py:
-    maintainers: elad661
-  $modules/remote_management/manageiq/manageiq_alerts.py:
-    maintainers: elad661
   $modules/remote_management/manageiq/manageiq_group.py:
     maintainers: evertmulder
   $modules/remote_management/manageiq/manageiq_tenant.py:
@@ -975,8 +939,6 @@ files:
     maintainers: SamyCoenen
   $modules/source_control/gitlab/gitlab_user.py:
     maintainers: LennertMertens stgrace
-  $modules/source_control/gitlab/gitlab_branch.py:
-    maintainers: paytroff
   $modules/source_control/hg.py:
     maintainers: yeukhon
   $modules/storage/emc/emc_vnx_sg_member.py:
@@ -985,8 +947,6 @@ files:
     maintainers: farhan7500 gautamphegde
   $modules/storage/ibm/:
     maintainers: tzure
-  $modules/storage/pmem/pmem.py:
-    maintainers: mizumm
   $modules/storage/vexata/:
     maintainers: vexata
   $modules/storage/zfs/:
@@ -1032,8 +992,6 @@ files:
   $modules/system/gconftool2.py:
     maintainers: Akasurde kevensen
     labels: gconftool2
-  $modules/system/homectl.py:
-    maintainers: jameslivulpi
   $modules/system/interfaces_file.py:
     maintainers: obourdon hryamzik
     labels: interfaces_file
@@ -1116,8 +1074,6 @@ files:
     keywords: beadm dladm illumos ipadm nexenta omnios openindiana pfexec smartos solaris sunos zfs zpool
   $modules/system/ssh_config.py:
     maintainers: gaqzi Akasurde
-  $modules/system/sudoers.py:
-    maintainers: JonEllis
   $modules/system/svc.py:
     maintainers: bcoca
   $modules/system/syspatch.py:
@@ -1145,13 +1101,11 @@ files:
   $modules/web_infrastructure/apache2_mod_proxy.py:
     maintainers: oboukili
   $modules/web_infrastructure/apache2_module.py:
-    maintainers: berendt n0trax
-    ignore: robinro
+    maintainers: berendt n0trax robinro
   $modules/web_infrastructure/deploy_helper.py:
     maintainers: ramondelafuente
   $modules/web_infrastructure/django_manage.py:
-    maintainers: russoz
-    ignore: scottanderson42 tastychutney
+    maintainers: scottanderson42 russoz tastychutney
     labels: django_manage
   $modules/web_infrastructure/ejabberd_user.py:
     maintainers: privateip
@@ -1174,8 +1128,7 @@ files:
   $modules/web_infrastructure/jenkins_script.py:
     maintainers: hogarthj
   $modules/web_infrastructure/jira.py:
-    maintainers: Slezhuk tarka pertoft
-    ignore: DWSR
+    maintainers: Slezhuk tarka pertoft DWSR
     labels: jira
   $modules/web_infrastructure/nginx_status_info.py:
     maintainers: resmo
@@ -1183,10 +1136,6 @@ files:
     maintainers: nerzhul
   $modules/web_infrastructure/rundeck_project.py:
     maintainers: nerzhul
-  $modules/web_infrastructure/rundeck_job_run.py:
-    maintainers: phsmith
-  $modules/web_infrastructure/rundeck_job_executions_info.py:
-    maintainers: phsmith
   $modules/web_infrastructure/sophos_utm/:
     maintainers: $team_e_spirit
     keywords: sophos utm
@@ -1208,8 +1157,6 @@ files:
     maintainers: inetfuture mattupstate
   $modules/web_infrastructure/taiga_issue.py:
     maintainers: lekum
-  $tests/a_module.py:
-    maintainers: felixfontein
 #########################
   tests/:
     labels: tests
@@ -1236,7 +1183,6 @@ macros:
   module_utils: plugins/module_utils
   modules: plugins/modules
   terminals: plugins/terminal
-  tests: plugins/test
   team_ansible_core:
   team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
@@ -1244,7 +1190,7 @@ macros:
   team_cyberark_conjur: jvanderhoof ryanprior
   team_e_spirit: MatrixCrawler getjack
   team_flatpak: JayKayy oolongbrothers
-  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii sh0shin nejch lgatellier suukit
+  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii
   team_hpux: bcoca davx8342
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht fxfitz justchris1
@@ -1257,9 +1203,9 @@ macros:
   team_opennebula: ilicmilan meerkampdvv rsmontero xorel nilsding
   team_oracle: manojmeda mross22 nalsaber
   team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
-  team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06
+  team_redfish: mraineri tomasg2012 xmadsen renxulei
   team_rhn: FlossWare alikins barnabycourt vritant
-  team_scaleway: remyleone abarbare
+  team_scaleway: QuentinBrosse abarbare jerome-quere kindermoumoute remyleone sieben
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
   team_suse: commel dcermak evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab tleguern Thulium-Drake Ajpantuso

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -62,20 +62,6 @@ body:
   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

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -62,20 +62,6 @@ body:
   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

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -21,7 +21,7 @@ body:
     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.
+      every other user of ansible-core because of Z.
   validations:
     required: true
 

.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    interval:
-      schedule: "weekly"

CONTRIBUTING.md

@@ -24,9 +24,8 @@ Also, consider taking up a valuable, reviewed, but abandoned pull request which
 
 * 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/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.
+* 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/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 respository checkout.
 * Make sure your PR includes a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#changelogs-how-to). (You must not include a fragment for new modules or new plugins, except for test and filter 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 :) )
-* Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed.
 
 You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst).
 
@@ -36,54 +35,6 @@ If you want to test a PR locally, refer to [our testing guide](https://github.co
 
 If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.
 
-## Run sanity, unit or integration tests locally
-
-You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
-
-```.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+.
-
-The following commands show how to run sanity tests:
-
-```.bash
-# Run sanity tests for all files in the collection:
-ansible-test sanity --docker -v
-
-# Run sanity tests for the given files and directories:
-ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/
-```
-
-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
-```
-
-The following commands show how to run integration tests:
-
-```.bash
-# Run integration tests for the interfaces_files module in a Docker container using the
-# fedora35 operating system image (the supported images depend on your ansible-core version):
-ansible-test integration --docker fedora35 -v interfaces_file
-
-# 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.
@@ -91,12 +42,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
 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:
+2. When creating a new module or plugin, please make sure that you follow various guidelines:
 
    - Follow [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html);
    - Follow [documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and
@@ -106,7 +52,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
    - 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. For modules and action plugins, make sure to create your module/plugin in the correct subdirectory, and create a symbolic link
+3. For modules and action plugins, make sure to create your module/plugin in the correct subdirectory, and create a symbolic link
    from `plugins/modules/` respectively `plugins/action/` to the actual module/plugin code. (Other plugin types should not use
    subdirectories.)
 
@@ -114,7 +60,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
      (`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
+4. 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.
 

README.md

@@ -1,6 +1,6 @@
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-4)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-3)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
 [![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.
@@ -17,7 +17,7 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https:
 
 ## Tested with Ansible
 
-Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
+Tested with the current Ansible 2.9, ansible-base 2.10 and ansible-core 2.11 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
 
 ## External requirements
 
@@ -64,33 +64,19 @@ 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-4/CONTRIBUTING.md)!
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md)!
 
-The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/stable-4/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/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/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).
 
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md).
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md).
 
 ### Running tests
 
 See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
 
-## Collection maintenance
-
-To learn how to maintain / become a maintainer of this collection, refer to:
-
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-4/commit-rights.md).
-* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
-
-It is necessary for maintainers of this collection to be subscribed to:
-
-* 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).
-
-They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
-
-## Communication
+### Communication
 
 We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed.
 
@@ -100,21 +86,26 @@ We take part in the global quarterly [Ansible Contributor Summit](https://github
 
 For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
 
-For more information about communication, refer to Ansible's the [Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+For more information about communication, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
 
-## Publishing New Version
+### Publishing New Version
 
-See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection.
+Basic instructions without release branches:
+
+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-4/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-3/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
 

commit-rights.md

@@ -69,6 +69,5 @@ Individuals who have been asked to become a part of this group have generally be
 | ------------------- | -------------------- | ------------------ | -------------------- |
 | Alexei Znamensky    | russoz               | russoz             |                      |
 | Andrew Klychkov     | andersson007         | andersson007_      |                      |
-| Andrew Pantuso      | Ajpantuso            | ajpantuso          |                      |
 | Felix Fontein       | felixfontein         | felixfontein       |                      |
 | John R Barker       | gundalow             | gundalow           |                      |

docs/docsite/extra-docs.yml

@@ -3,4 +3,3 @@ sections:
   - title: Guides
     toctree:
       - filter_guide
-      - test_guide

docs/docsite/helper/lists_mergeby/default-common.yml

@@ -1,13 +0,0 @@
-list1:
-  - name: foo
-    extra: true
-  - name: bar
-    extra: false
-  - name: meh
-    extra: true
-
-list2:
-  - name: foo
-    path: /foo
-  - name: baz
-    path: /baz

docs/docsite/helper/lists_mergeby/default-recursive-true.yml

@@ -1,19 +0,0 @@
-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, {key: value}]

docs/docsite/helper/lists_mergeby/example-001.yml

@@ -1,10 +0,0 @@
----
-- name: 1. Merge two lists by common attribute 'name'
-  include_vars:
-    dir: example-001_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-001.out

docs/docsite/helper/lists_mergeby/example-001_vars/default-common.yml

@@ -1 +0,0 @@
-../default-common.yml

docs/docsite/helper/lists_mergeby/example-001_vars/list3.yml

@@ -1,2 +0,0 @@
-list3: "{{ list1|
-           community.general.lists_mergeby(list2, 'name') }}"

docs/docsite/helper/lists_mergeby/example-002.yml

@@ -1,10 +0,0 @@
----
-- name: 2. Merge two lists by common attribute 'name'
-  include_vars:
-    dir: example-002_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-002.out

docs/docsite/helper/lists_mergeby/example-002_vars/default-common.yml

@@ -1 +0,0 @@
-../default-common.yml

docs/docsite/helper/lists_mergeby/example-002_vars/list3.yml

@@ -1,2 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name') }}"

docs/docsite/helper/lists_mergeby/example-003.yml

@@ -1,10 +0,0 @@
----
-- name: 3. Merge recursive by 'name', replace lists (default)
-  include_vars:
-    dir: example-003_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-003.out

docs/docsite/helper/lists_mergeby/example-003_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-003_vars/list3.yml

@@ -1,3 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true) }}"

docs/docsite/helper/lists_mergeby/example-004.yml

@@ -1,10 +0,0 @@
----
-- name: 4. Merge recursive by 'name', keep lists
-  include_vars:
-    dir: example-004_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-004.out

docs/docsite/helper/lists_mergeby/example-004_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-004_vars/list3.yml

@@ -1,4 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true,
-                                           list_merge='keep') }}"

docs/docsite/helper/lists_mergeby/example-005.yml

@@ -1,10 +0,0 @@
----
-- name: 5. Merge recursive by 'name', append lists
-  include_vars:
-    dir: example-005_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-005.out

docs/docsite/helper/lists_mergeby/example-005_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-005_vars/list3.yml

@@ -1,4 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true,
-                                           list_merge='append') }}"

docs/docsite/helper/lists_mergeby/example-006.yml

@@ -1,10 +0,0 @@
----
-- name: 6. Merge recursive by 'name', prepend lists
-  include_vars:
-    dir: example-006_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-006.out

docs/docsite/helper/lists_mergeby/example-006_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-006_vars/list3.yml

@@ -1,4 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true,
-                                           list_merge='prepend') }}"

docs/docsite/helper/lists_mergeby/example-007.yml

@@ -1,10 +0,0 @@
----
-- name: 7. Merge recursive by 'name', append lists 'remove present'
-  include_vars:
-    dir: example-007_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-007.out

docs/docsite/helper/lists_mergeby/example-007_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-007_vars/list3.yml

@@ -1,4 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true,
-                                           list_merge='append_rp') }}"

docs/docsite/helper/lists_mergeby/example-008.yml

@@ -1,10 +0,0 @@
----
-- name: 8. Merge recursive by 'name', prepend lists 'remove present'
-  include_vars:
-    dir: example-008_vars
-- debug:
-    var: list3
-  when: debug|d(false)|bool
-- template:
-    src: list3.out.j2
-    dest: example-008.out

docs/docsite/helper/lists_mergeby/example-008_vars/default-recursive-true.yml

@@ -1 +0,0 @@
-../default-recursive-true.yml

docs/docsite/helper/lists_mergeby/example-008_vars/list3.yml

@@ -1,4 +0,0 @@
-list3: "{{ [list1, list2]|
-           community.general.lists_mergeby('name',
-                                           recursive=true,
-                                           list_merge='prepend_rp') }}"

docs/docsite/helper/lists_mergeby/examples.yml

@@ -1,50 +0,0 @@
----
-examples:
-  - label: 'In the example below the lists are merged by the attribute ``name``:'
-    file: example-001_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-001.out
-    lang: 'yaml'
-  - label: 'It is possible to use a list of lists as an input of the filter:'
-    file: example-002_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces the same result as in the previous example:'
-    file: example-002.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=replace`` (default):'
-    file: example-003_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-003.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=keep``:'
-    file: example-004_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-004.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=append``:'
-    file: example-005_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-005.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=prepend``:'
-    file: example-006_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-006.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=append_rp``:'
-    file: example-007_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-007.out
-    lang: 'yaml'
-  - label: 'Example ``list_merge=prepend_rp``:'
-    file: example-008_vars/list3.yml
-    lang: 'yaml+jinja'
-  - label: 'This produces:'
-    file: example-008.out
-    lang: 'yaml'

docs/docsite/helper/lists_mergeby/examples_all.rst.j2

@@ -1,8 +0,0 @@
-{% for i in examples %}
-{{ i.label }}
-
-.. code-block:: {{ i.lang }}
-
-  {{ lookup('file', i.file)|indent(2) }}
-
-{% endfor %}

docs/docsite/helper/lists_mergeby/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2

@@ -1,57 +0,0 @@
-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 ``lists_mergeby`` 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 :ref:`the documentation for the community.general.yaml callback plugin <ansible_collections.community.general.yaml_callback>`.
-
-Let us use the lists below in the following examples:
-
-.. code-block:: yaml
-
-  {{ lookup('file', 'default-common.yml')|indent(2) }}
-
-{% for i in examples[0:2] %}
-{{ i.label }}
-
-.. code-block:: {{ i.lang }}
-
-  {{ lookup('file', i.file)|indent(2) }}
-
-{% endfor %}
-
-.. versionadded:: 2.0.0
-
-{% for i in examples[2:4] %}
-{{ i.label }}
-
-.. code-block:: {{ i.lang }}
-
-  {{ lookup('file', i.file)|indent(2) }}
-
-{% endfor %}
-
-The filter also accepts two optional parameters: ``recursive`` and ``list_merge``. These parameters are only supported when used with ansible-base 2.10 or ansible-core, but not with Ansible 2.9. This is available since community.general 4.4.0.
-
-**recursive**
-    Is a boolean, default to ``False``. Should the ``community.general.lists_mergeby`` 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 ``replace`` (default), ``keep``, ``append``, ``prepend``, ``append_rp`` or ``prepend_rp``. It modifies the behaviour of ``community.general.lists_mergeby`` when the hashes to merge contain arrays/lists.
-
-The examples below set ``recursive=true`` and display the differences among all six options of ``list_merge``. Functionality of the parameters is exactly the same as in the filter ``combine``. See :ref:`Combining hashes/dictionaries <combine_filter>` to learn details about these options.
-
-Let us use the lists below in the following examples
-
-.. code-block:: yaml
-
-  {{ lookup('file', 'default-recursive-true.yml')|indent(2) }}
-
-{% for i in examples[4:16] %}
-{{ i.label }}
-
-.. code-block:: {{ i.lang }}
-
-  {{ lookup('file', i.file)|indent(2) }}
-
-{% endfor %}

docs/docsite/helper/lists_mergeby/list3.out.j2

@@ -1,2 +0,0 @@
-list3:
-{{ list3|to_nice_yaml(indent=0) }}

docs/docsite/helper/lists_mergeby/playbook.yml

@@ -1,59 +0,0 @@
----
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# 1) Run all examples and create example-XXX.out
-# shell> ansible-playbook playbook.yml -e examples=true
-#
-# 2) Optionally, for testing, create examples_all.rst
-# shell> ansible-playbook playbook.yml -e examples_all=true
-#
-# 3) Create docs REST files
-# shell> ansible-playbook playbook.yml -e merging_lists_of_dictionaries=true
-#
-# Notes:
-# * Use YAML callback, e.g. set ANSIBLE_STDOUT_CALLBACK=community.general.yaml
-# * Use sphinx-view to render and review the REST files
-#   shell> sphinx-view <path_to_helper>/examples_all.rst
-# * Proofread and copy completed docs *.rst files into the directory rst.
-# * Then delete the *.rst and *.out files from this directory. Do not
-#   add *.rst and *.out in this directory to the version control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/lists_mergeby/playbook.yml
-
-- hosts: localhost
-  gather_facts: false
-  tasks:
-
-    - block:
-        - import_tasks: example-001.yml
-          tags: t001
-        - import_tasks: example-002.yml
-          tags: t002
-        - import_tasks: example-003.yml
-          tags: t003
-        - import_tasks: example-004.yml
-          tags: t004
-        - import_tasks: example-005.yml
-          tags: t005
-        - import_tasks: example-006.yml
-          tags: t006
-        - import_tasks: example-007.yml
-          tags: t007
-        - import_tasks: example-008.yml
-          tags: t008
-      when: examples|d(false)|bool
-
-    - block:
-        - include_vars: examples.yml
-        - template:
-            src: examples_all.rst.j2
-            dest: examples_all.rst
-      when: examples_all|d(false)|bool
-
-    - block:
-        - include_vars: examples.yml
-        - template:
-            src: filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2
-            dest: filter_guide_abstract_informations_merging_lists_of_dictionaries.rst
-      when: merging_lists_of_dictionaries|d(false)|bool

docs/docsite/links.yml

@@ -1,23 +0,0 @@
----
-edit_on_github:
-  repository: ansible-collections/community.general
-  branch: main
-  path_prefix: ''
-
-extra_links:
-  - 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'
-  mailing_lists:
-    - topic: Ansible Project List
-      url: https://groups.google.com/g/ansible-project

docs/docsite/rst/filter_guide.rst

@@ -1,4 +1,3 @@
-
 .. _ansible_collections.community.general.docsite.filter_guide:
 
 community.general Filter Guide
@@ -6,14 +5,749 @@ community.general Filter Guide
 
 The :ref:`community.general collection <plugins_in_community.general>` offers several useful filter plugins.
 
-.. toctree::
-   :maxdepth: 2
+.. contents:: Topics
 
-   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
+Paths
+-----
+
+The ``path_join`` filter has been added in ansible-base 2.10. If you want to use this filter, but also need to support Ansible 2.9, you can use ``community.general``'s ``path_join`` shim, ``community.general.path_join``. This filter redirects to ``path_join`` for ansible-base 2.10 and ansible-core 2.11 or newer, and re-implements the filter for Ansible 2.9.
+
+.. code-block:: yaml+jinja
+
+    # ansible-base 2.10 or newer:
+    path: {{ ('/etc', path, 'subdir', file) | path_join }}
+
+    # Also works with Ansible 2.9:
+    path: {{ ('/etc', path, 'subdir', file) | community.general.path_join }}
+
+.. versionadded:: 3.0.0
+
+Abstract transformations
+------------------------
+
+Dictionaries
+^^^^^^^^^^^^
+
+You can use the ``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:
+
+.. 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 ``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:
+
+.. 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
+
+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 ``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:
+
+.. 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": "bdf50b7d-4859-40af-8665-c637ee7a7808"
+            },
+            "/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
+
+Merging lists of dictionaries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have two lists of dictionaries and want to combine them into a list of merged dictionaries, where two dictionaries are merged if they coincide in one attribute, you can use the ``lists_mergeby`` filter.
+
+.. code-block:: yaml+jinja
+
+    - name: Merge two lists by common attribute 'name'
+      debug:
+        var: list1 | community.general.lists_mergeby(list2, 'name')
+      vars:
+        list1:
+          - name: foo
+            extra: true
+          - name: bar
+            extra: false
+          - name: meh
+            extra: true
+        list2:
+          - name: foo
+            path: /foo
+          - name: baz
+            path: /bazzz
+
+This produces:
+
+.. code-block:: ansible-output
+
+    TASK [Merge two lists by common attribute 'name']  ****************************************
+    ok: [localhost] => {
+        "list1 | community.general.lists_mergeby(list2, 'name')": [
+            {
+                "extra": false,
+                "name": "bar"
+            },
+            {
+                "name": "baz",
+                "path": "/bazzz"
+            },
+            {
+                "extra": true,
+                "name": "foo",
+                "path": "/foo"
+            },
+            {
+                "extra": true,
+                "name": "meh"
+            }
+        ]
+    }
+
+.. versionadded: 2.0.0
+
+Working with times
+------------------
+
+The ``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 ``to_hours``, ``to_minutes``, ``to_seconds``, 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``
+     - ``to_milliseconds``
+   * - Second
+     - 1 second
+     - ``s``, ``sec``, ``secs``, ``second``, ``seconds``
+     - ``to_seconds``
+   * - Minute
+     - 60 seconds
+     - ``m``, ``min``, ``mins``, ``minute``, ``minutes``
+     - ``to_minutes``
+   * - Hour
+     - 60*60 seconds
+     - ``h``, ``hour``, ``hours``
+     - ``to_hours``
+   * - Day
+     - 24*60*60 seconds
+     - ``d``, ``day``, ``days``
+     - ``to_days``
+   * - Week
+     - 7*24*60*60 seconds
+     - ``w``, ``week``, ``weeks``
+     - ``to_weeks``
+   * - Month
+     - 30*24*60*60 seconds
+     - ``mo``, ``month``, ``months``
+     - ``to_months``
+   * - Year
+     - 365*24*60*60 seconds
+     - ``y``, ``year``, ``years``
+     - ``to_years``
+
+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 ``to_time_unit`` 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:
+
+.. 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
+
+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 ``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:
+
+.. 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
+
+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. This filter needs 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:
+
+.. 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 ``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:
+
+.. code-block:: ansible-output
+
+    TASK [Create a random MAC starting with ff:] **********************************************
+    ok: [localhost] => {
+        "msg": "ff:69:d3:78:7f:b4"
+    }
+
+    TASK [Create a random MAC starting with 00:11:22:] ****************************************
+    ok: [localhost] => {
+        "msg": "00:11:22:71:5d:3b"
+    }
+
+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) }}"
+
+Conversions
+-----------
+
+Parsing CSV files
+^^^^^^^^^^^^^^^^^
+
+Ansible offers the :ref:`community.general.read_csv module <ansible_collections.community.general.read_csv_module>` to read CSV files. Sometimes you need to convert strings to CSV files instead. For this, the ``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:
+
+.. 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 ``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. 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:
+
+.. 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
+
+.. _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 ``json_query`` filter.  The ``json_query`` 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=='cluster2'].{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_abstract_informations.rst

@@ -1,10 +0,0 @@
-Abstract transformations
-------------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   filter_guide_abstract_informations_dictionaries
-   filter_guide_abstract_informations_grouping
-   filter_guide_abstract_informations_merging_lists_of_dictionaries
-   filter_guide_abstract_informations_counting_elements_in_sequence

docs/docsite/rst/filter_guide_abstract_informations_counting_elements_in_sequence.rst

@@ -1,77 +0,0 @@
-Counting elements in a sequence
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ``community.general.counter`` filter plugin 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:
-
-.. 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:
-
-.. 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,119 +0,0 @@
-Dictionaries
-^^^^^^^^^^^^
-
-You can use the ``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:
-
-.. 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 ``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:
-
-.. 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,98 +0,0 @@
-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 ``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:
-
-.. 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": "bdf50b7d-4859-40af-8665-c637ee7a7808"
-            },
-            "/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_merging_lists_of_dictionaries.rst

@@ -1,292 +0,0 @@
-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 ``lists_mergeby`` 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 :ref:`the documentation for the community.general.yaml callback plugin <ansible_collections.community.general.yaml_callback>`.
-
-Let us use the lists below in the following examples:
-
-.. 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
-
-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:
-
-.. 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
-
-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:
-
-.. 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: ``recursive`` and ``list_merge``. These parameters are only supported when used with ansible-base 2.10 or ansible-core, but not with Ansible 2.9. This is available since community.general 4.4.0.
-
-**recursive**
-    Is a boolean, default to ``False``. Should the ``community.general.lists_mergeby`` 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 ``replace`` (default), ``keep``, ``append``, ``prepend``, ``append_rp`` or ``prepend_rp``. It modifies the behaviour of ``community.general.lists_mergeby`` when the hashes to merge contain arrays/lists.
-
-The examples below set ``recursive=true`` and display the differences among all six options of ``list_merge``. Functionality of the parameters is exactly the same as in the filter ``combine``. See :ref:`Combining hashes/dictionaries <combine_filter>` to learn details about these options.
-
-Let us use the lists below in the following examples
-
-.. 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, {key: value}]
-
-Example ``list_merge=replace`` (default):
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true) }}"
-
-This produces:
-
-.. 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
-    - key: value
-
-Example ``list_merge=keep``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='keep') }}"
-
-This produces:
-
-.. 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
-
-Example ``list_merge=append``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='append') }}"
-
-This produces:
-
-.. 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
-    - key: value
-
-Example ``list_merge=prepend``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='prepend') }}"
-
-This produces:
-
-.. 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
-    - key: value
-    - 1
-    - 1
-    - 2
-    - 3
-
-Example ``list_merge=append_rp``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='append_rp') }}"
-
-This produces:
-
-.. 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
-    - key: value
-
-Example ``list_merge=prepend_rp``:
-
-.. code-block:: yaml+jinja
-
-  list3: "{{ [list1, list2]|
-             community.general.lists_mergeby('name',
-                                             recursive=true,
-                                             list_merge='prepend_rp') }}"
-
-This produces:
-
-.. 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
-    - key: value
-    - 1
-    - 1
-    - 2
-

docs/docsite/rst/filter_guide_conversions.rst

@@ -1,108 +0,0 @@
-Conversions
------------
-
-Parsing CSV files
-^^^^^^^^^^^^^^^^^
-
-Ansible offers the :ref:`community.general.read_csv module <ansible_collections.community.general.read_csv_module>` to read CSV files. Sometimes you need to convert strings to CSV files instead. For this, the ``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:
-
-.. 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 ``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. 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:
-
-.. 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,80 +0,0 @@
-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. This filter needs 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:
-
-.. 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 ``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:
-
-.. code-block:: ansible-output
-
-    TASK [Create a random MAC starting with ff:] **********************************************
-    ok: [localhost] => {
-        "msg": "ff:69:d3:78:7f:b4"
-    }
-
-    TASK [Create a random MAC starting with 00:11:22:] ****************************************
-    ok: [localhost] => {
-        "msg": "00:11:22:71:5d:3b"
-    }
-
-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,14 +0,0 @@
-Paths
------
-
-The ``path_join`` filter has been added in ansible-base 2.10. If you want to use this filter, but also need to support Ansible 2.9, you can use ``community.general``'s ``path_join`` shim, ``community.general.path_join``. This filter redirects to ``path_join`` for ansible-base 2.10 and ansible-core 2.11 or newer, and re-implements the filter for Ansible 2.9.
-
-.. code-block:: yaml+jinja
-
-    # ansible-base 2.10 or newer:
-    path: {{ ('/etc', path, 'subdir', file) | path_join }}
-
-    # Also works with Ansible 2.9:
-    path: {{ ('/etc', path, 'subdir', file) | community.general.path_join }}
-
-.. versionadded:: 3.0.0

docs/docsite/rst/filter_guide_selecting_json_data.rst

@@ -1,144 +0,0 @@
-.. _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 ``json_query`` filter.  The ``json_query`` 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=='cluster2'].{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,84 +0,0 @@
-Working with times
-------------------
-
-The ``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 ``to_hours``, ``to_minutes``, ``to_seconds``, 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``
-     - ``to_milliseconds``
-   * - Second
-     - 1 second
-     - ``s``, ``sec``, ``secs``, ``second``, ``seconds``
-     - ``to_seconds``
-   * - Minute
-     - 60 seconds
-     - ``m``, ``min``, ``mins``, ``minute``, ``minutes``
-     - ``to_minutes``
-   * - Hour
-     - 60*60 seconds
-     - ``h``, ``hour``, ``hours``
-     - ``to_hours``
-   * - Day
-     - 24*60*60 seconds
-     - ``d``, ``day``, ``days``
-     - ``to_days``
-   * - Week
-     - 7*24*60*60 seconds
-     - ``w``, ``week``, ``weeks``
-     - ``to_weeks``
-   * - Month
-     - 30*24*60*60 seconds
-     - ``mo``, ``month``, ``months``
-     - ``to_months``
-   * - Year
-     - 365*24*60*60 seconds
-     - ``y``, ``year``, ``years``
-     - ``to_years``
-
-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 ``to_time_unit`` 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:
-
-.. 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,30 +0,0 @@
-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 ``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:
-
-.. code-block:: ansible-output
-
-    TASK [Compare Unicode representations] ********************************************************
-    ok: [localhost] => {
-        "msg": true
-    }
-
-The ``community.general.unicode_normalize`` filter accepts a keyword argument 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,34 +0,0 @@
-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 ``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:
-
-.. 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/test_guide.rst

@@ -1,28 +0,0 @@
-.. _ansible_collections.community.general.docsite.test_guide:
-
-community.general Test (Plugin) Guide
-=====================================
-
-The :ref:`community.general collection <plugins_in_community.general>` offers currently one test plugin.
-
-.. contents:: Topics
-
-Feature Tests
--------------
-
-The ``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,6 +1,6 @@
 namespace: community
 name: general
-version: 4.8.0
+version: 3.5.0
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)

meta/runtime.yml

@@ -12,11 +12,20 @@ plugin_routing:
     hashi_vault:
       redirect: community.hashi_vault.hashi_vault
     nios:
-      redirect: infoblox.nios_modules.nios_lookup
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios lookup plugin has been deprecated.
+          Please use infoblox.nios_modules.nios_lookup instead.
     nios_next_ip:
-      redirect: infoblox.nios_modules.nios_next_ip
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_next_ip lookup plugin has been deprecated.
+          Please use infoblox.nios_modules.nios_next_ip instead.
     nios_next_network:
-      redirect: infoblox.nios_modules.nios_next_network
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_next_network lookup plugin has been
+          deprecated. Please use infoblox.nios_modules.nios_next_network instead.
   modules:
     ali_instance_facts:
       tombstone:
@@ -257,37 +266,85 @@ plugin_routing:
         removal_version: 3.0.0
         warning_text: Use community.general.nginx_status_info instead.
     nios_a_record:
-      redirect: infoblox.nios_modules.nios_a_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_a_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_a_record instead.
     nios_aaaa_record:
-      redirect: infoblox.nios_modules.nios_aaaa_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_aaaa_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_aaaa_record instead.
     nios_cname_record:
-      redirect: infoblox.nios_modules.nios_cname_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_cname_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_cname_record instead.
     nios_dns_view:
-      redirect: infoblox.nios_modules.nios_dns_view
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_dns_view module has been deprecated.
+          Please use infoblox.nios_modules.nios_dns_view instead.
     nios_fixed_address:
-      redirect: infoblox.nios_modules.nios_fixed_address
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_fixed_address module has been deprecated.
+          Please use infoblox.nios_modules.nios_fixed_address instead.
     nios_host_record:
-      redirect: infoblox.nios_modules.nios_host_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_host_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_host_record instead.
     nios_member:
-      redirect: infoblox.nios_modules.nios_member
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_member module has been deprecated.
+          Please use infoblox.nios_modules.nios_member instead.
     nios_mx_record:
-      redirect: infoblox.nios_modules.nios_mx_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_mx_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_mx_record instead.
     nios_naptr_record:
-      redirect: infoblox.nios_modules.nios_naptr_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_naptr_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_naptr_record instead.
     nios_network:
-      redirect: infoblox.nios_modules.nios_network
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_network module has been deprecated.
+          Please use infoblox.nios_modules.nios_network instead.
     nios_network_view:
-      redirect: infoblox.nios_modules.nios_network_view
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_network_view module has been deprecated.
+          Please use infoblox.nios_modules.nios_network_view instead.
     nios_nsgroup:
-      redirect: infoblox.nios_modules.nios_nsgroup
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_nsgroup module has been deprecated.
+          Please use infoblox.nios_modules.nios_nsgroup instead.
     nios_ptr_record:
-      redirect: infoblox.nios_modules.nios_ptr_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_ptr_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_ptr_record instead.
     nios_srv_record:
-      redirect: infoblox.nios_modules.nios_srv_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_srv_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_srv_record instead.
     nios_txt_record:
-      redirect: infoblox.nios_modules.nios_txt_record
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_txt_record module has been deprecated.
+          Please use infoblox.nios_modules.nios_txt_record instead.
     nios_zone:
-      redirect: infoblox.nios_modules.nios_zone
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios_zone module has been deprecated.
+          Please use infoblox.nios_modules.nios_zone instead.
     ome_device_info:
       redirect: dellemc.openmanage.ome_device_info
     one_image_facts:
@@ -571,7 +628,10 @@ plugin_routing:
     kubevirt_vm_options:
       redirect: community.kubevirt.kubevirt_vm_options
     nios:
-      redirect: infoblox.nios_modules.nios
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.nios document fragment has been deprecated.
+          Please use infoblox.nios_modules.nios instead.
     postgresql:
       redirect: community.postgresql.postgresql
   module_utils:
@@ -590,7 +650,10 @@ plugin_routing:
     kubevirt:
       redirect: community.kubevirt.kubevirt
     net_tools.nios.api:
-      redirect: infoblox.nios_modules.api
+      deprecation:
+        removal_version: 5.0.0
+        warning_text: The community.general.net_tools.nios.api module_utils has been
+          deprecated. Please use infoblox.nios_modules.api instead.
     postgresql:
       redirect: community.postgresql.postgresql
     remote_management.dellemc.dellemc_idrac:

plugins/cache/memcached.py

@@ -20,7 +20,6 @@ DOCUMENTATION = '''
           - List of connection information for the memcached DBs
         default: ['127.0.0.1:11211']
         type: list
-        elements: string
         env:
           - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
         ini:
@@ -155,12 +154,12 @@ class CacheModuleKeys(MutableSet):
     def __len__(self):
         return len(self._keyset)
 
-    def add(self, value):
-        self._keyset[value] = time.time()
+    def add(self, key):
+        self._keyset[key] = time.time()
         self._cache.set(self.PREFIX, self._keyset)
 
-    def discard(self, value):
-        del self._keyset[value]
+    def discard(self, key):
+        del self._keyset[key]
         self._cache.set(self.PREFIX, self._keyset)
 
     def remove_by_timerange(self, s_min, s_max):

plugins/callback/counter_enabled.py

@@ -45,8 +45,6 @@ class CallbackModule(CallbackBase):
     _task_total = 0
     _host_counter = 1
     _host_total = 0
-    _current_batch_total = 0
-    _previous_batch_total = 0
 
     def __init__(self):
         super(CallbackModule, self).__init__()
@@ -78,11 +76,8 @@ class CallbackModule(CallbackBase):
         self._display.banner(msg)
         self._play = play
 
-        self._previous_batch_total = self._current_batch_total
-        self._current_batch_total = self._previous_batch_total + len(self._all_vars()['vars']['ansible_play_batch'])
         self._host_total = len(self._all_vars()['vars']['ansible_play_hosts_all'])
         self._task_total = len(self._play.get_tasks()[0])
-        self._task_counter = 1
 
     def v2_playbook_on_stats(self, stats):
         self._display.banner("PLAY RECAP")
@@ -150,7 +145,7 @@ class CallbackModule(CallbackBase):
             path = task.get_path()
             if path:
                 self._display.display("task path: %s" % path, color=C.COLOR_DEBUG)
-        self._host_counter = self._previous_batch_total
+        self._host_counter = 0
         self._task_counter += 1
 
     def v2_runner_on_ok(self, result):

plugins/callback/elastic.py

@@ -1,423 +0,0 @@
-# (C) 2021, Victor Martinez <VictorMartinezRubio@gmail.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
-
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: elastic
-    type: notification
-    short_description: Create distributed traces for each Ansible task in Elastic APM
-    version_added: 3.8.0
-    description:
-      - This callback creates distributed traces for each Ansible task in Elastic APM.
-      - You can configure the plugin with environment variables.
-      - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-      apm_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: ELASTIC_APM_SERVICE_NAME
-      apm_server_url:
-        type: str
-        description:
-          - Use the APM server and its environment variables.
-        env:
-          - name: ELASTIC_APM_SERVER_URL
-      apm_secret_token:
-        type: str
-        description:
-          - Use the APM server token
-        env:
-          - name: ELASTIC_APM_SECRET_TOKEN
-      apm_api_key:
-        type: str
-        description:
-          - Use the APM API key
-        env:
-          - name: ELASTIC_APM_API_KEY
-      apm_verify_server_cert:
-        default: true
-        type: bool
-        description:
-          - Verifies the SSL certificate if an HTTPS connection.
-        env:
-          - name: ELASTIC_APM_VERIFY_SERVER_CERT
-      traceparent:
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-    requirements:
-      - elastic-apm (Python library)
-'''
-
-
-EXAMPLES = '''
-examples: |
-  Enable the plugin in ansible.cfg:
-    [defaults]
-    callbacks_enabled = community.general.elastic
-
-  Set the environment variable:
-    export ELASTIC_APM_SERVER_URL=<your APM server URL)>
-    export ELASTIC_APM_SERVICE_NAME=your_service_name
-    export ELASTIC_APM_API_KEY=your_APM_API_KEY
-'''
-
-import getpass
-import socket
-import time
-import uuid
-
-from collections import OrderedDict
-from os.path import basename
-
-from ansible.errors import AnsibleError, AnsibleRuntimeError
-from ansible.module_utils.six import raise_from
-from ansible.plugins.callback import CallbackBase
-
-try:
-    from elasticapm import Client, capture_span, trace_parent_from_string, instrument, label
-except ImportError as imp_exc:
-    ELASTIC_LIBRARY_IMPORT_ERROR = imp_exc
-else:
-    ELASTIC_LIBRARY_IMPORT_ERROR = None
-
-
-class TaskData:
-    """
-    Data about an individual task.
-    """
-
-    def __init__(self, uuid, name, path, play, action, args):
-        self.uuid = uuid
-        self.name = name
-        self.path = path
-        self.play = play
-        self.host_data = OrderedDict()
-        self.start = time.time()
-        self.action = action
-        self.args = args
-
-    def add_host(self, host):
-        if host.uuid in self.host_data:
-            if host.status == 'included':
-                # concatenate task include output from multiple items
-                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
-            else:
-                return
-
-        self.host_data[host.uuid] = host
-
-
-class HostData:
-    """
-    Data about an individual host.
-    """
-
-    def __init__(self, uuid, name, status, result):
-        self.uuid = uuid
-        self.name = name
-        self.status = status
-        self.result = result
-        self.finish = time.time()
-
-
-class ElasticSource(object):
-    def __init__(self, display):
-        self.ansible_playbook = ""
-        self.ansible_version = None
-        self.session = str(uuid.uuid4())
-        self.host = socket.gethostname()
-        try:
-            self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
-            self.ip_address = None
-        self.user = getpass.getuser()
-
-        self._display = display
-
-    def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
-
-        uuid = task._uuid
-
-        if uuid in tasks_data:
-            return
-
-        name = task.get_name().strip()
-        path = task.get_path()
-        action = task.action
-        args = None
-
-        if not task.no_log and not hide_task_arguments:
-            args = ', '.join(('%s=%s' % a for a in task.args.items()))
-
-        tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
-
-    def finish_task(self, tasks_data, status, result):
-        """ record the results of a task for a single host """
-
-        task_uuid = result._task._uuid
-
-        if hasattr(result, '_host') and result._host is not None:
-            host_uuid = result._host._uuid
-            host_name = result._host.name
-        else:
-            host_uuid = 'include'
-            host_name = 'include'
-
-        task = tasks_data[task_uuid]
-
-        if self.ansible_version is None and result._task_fields['args'].get('_ansible_version'):
-            self.ansible_version = result._task_fields['args'].get('_ansible_version')
-
-        task.add_host(HostData(host_uuid, host_name, status, result))
-
-    def generate_distributed_traces(self, tasks_data, status, end_time, traceparent, apm_service_name,
-                                    apm_server_url, apm_verify_server_cert, apm_secret_token, apm_api_key):
-        """ generate distributed traces from the collected TaskData and HostData """
-
-        tasks = []
-        parent_start_time = None
-        for task_uuid, task in tasks_data.items():
-            if parent_start_time is None:
-                parent_start_time = task.start
-            tasks.append(task)
-
-        apm_cli = self.init_apm_client(apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key)
-        if apm_cli:
-            instrument()  # Only call this once, as early as possible.
-            if traceparent:
-                parent = trace_parent_from_string(traceparent)
-                apm_cli.begin_transaction("Session", trace_parent=parent, start=parent_start_time)
-            else:
-                apm_cli.begin_transaction("Session", start=parent_start_time)
-            # Populate trace metadata attributes
-            if self.ansible_version is not None:
-                label(ansible_version=self.ansible_version)
-            label(ansible_session=self.session, ansible_host_name=self.host, ansible_host_user=self.user)
-            if self.ip_address is not None:
-                label(ansible_host_ip=self.ip_address)
-
-            for task_data in tasks:
-                for host_uuid, host_data in task_data.host_data.items():
-                    self.create_span_data(apm_cli, task_data, host_data)
-
-            apm_cli.end_transaction(name=__name__, result=status, duration=end_time - parent_start_time)
-
-    def create_span_data(self, apm_cli, task_data, host_data):
-        """ create the span with the given TaskData and HostData """
-
-        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
-
-        message = "success"
-        status = "success"
-        enriched_error_message = None
-        if host_data.status == 'included':
-            rc = 0
-        else:
-            res = host_data.result._result
-            rc = res.get('rc', 0)
-            if host_data.status == 'failed':
-                message = self.get_error_message(res)
-                enriched_error_message = self.enrich_error_message(res)
-                status = "failure"
-            elif host_data.status == 'skipped':
-                if 'skip_reason' in res:
-                    message = res['skip_reason']
-                else:
-                    message = 'skipped'
-                status = "unknown"
-
-        with capture_span(task_data.name,
-                          start=task_data.start,
-                          span_type="ansible.task.run",
-                          duration=host_data.finish - task_data.start,
-                          labels={"ansible.task.args": task_data.args,
-                                  "ansible.task.message": message,
-                                  "ansible.task.module": task_data.action,
-                                  "ansible.task.name": name,
-                                  "ansible.task.result": rc,
-                                  "ansible.task.host.name": host_data.name,
-                                  "ansible.task.host.status": host_data.status}) as span:
-            span.outcome = status
-            if 'failure' in status:
-                exception = AnsibleRuntimeError(message="{0}: {1} failed with error message {2}".format(task_data.action, name, enriched_error_message))
-                apm_cli.capture_exception(exc_info=(type(exception), exception, exception.__traceback__), handled=True)
-
-    def init_apm_client(self, apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key):
-        if apm_server_url:
-            return Client(service_name=apm_service_name,
-                          server_url=apm_server_url,
-                          verify_server_cert=False,
-                          secret_token=apm_secret_token,
-                          api_key=apm_api_key,
-                          use_elastic_traceparent_header=True,
-                          debug=True)
-
-    @staticmethod
-    def get_error_message(result):
-        if result.get('exception') is not None:
-            return ElasticSource._last_line(result['exception'])
-        return result.get('msg', 'failed')
-
-    @staticmethod
-    def _last_line(text):
-        lines = text.strip().split('\n')
-        return lines[-1]
-
-    @staticmethod
-    def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
-
-
-class CallbackModule(CallbackBase):
-    """
-    This callback creates distributed traces with Elastic APM.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.elastic'
-    CALLBACK_NEEDS_ENABLED = True
-
-    def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
-        self.hide_task_arguments = None
-        self.apm_service_name = None
-        self.ansible_playbook = None
-        self.traceparent = False
-        self.play_name = None
-        self.tasks_data = None
-        self.errors = 0
-        self.disabled = False
-
-        if ELASTIC_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('The `elastic-apm` must be installed to use this plugin'),
-                ELASTIC_LIBRARY_IMPORT_ERROR)
-
-        self.tasks_data = OrderedDict()
-
-        self.elastic = ElasticSource(display=self._display)
-
-    def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
-
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
-
-        self.apm_service_name = self.get_option('apm_service_name')
-        if not self.apm_service_name:
-            self.apm_service_name = 'ansible'
-
-        self.apm_server_url = self.get_option('apm_server_url')
-        self.apm_secret_token = self.get_option('apm_secret_token')
-        self.apm_api_key = self.get_option('apm_api_key')
-        self.apm_verify_server_cert = self.get_option('apm_verify_server_cert')
-        self.traceparent = self.get_option('traceparent')
-
-    def v2_playbook_on_start(self, playbook):
-        self.ansible_playbook = basename(playbook._file_name)
-
-    def v2_playbook_on_play_start(self, play):
-        self.play_name = play.get_name()
-
-    def v2_runner_on_no_hosts(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_cleanup_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_handler_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        self.errors += 1
-        self.elastic.finish_task(
-            self.tasks_data,
-            'failed',
-            result
-        )
-
-    def v2_runner_on_ok(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'ok',
-            result
-        )
-
-    def v2_runner_on_skipped(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'skipped',
-            result
-        )
-
-    def v2_playbook_on_include(self, included_file):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'included',
-            included_file
-        )
-
-    def v2_playbook_on_stats(self, stats):
-        if self.errors == 0:
-            status = "success"
-        else:
-            status = "failure"
-        self.elastic.generate_distributed_traces(
-            self.tasks_data,
-            status,
-            time.time(),
-            self.traceparent,
-            self.apm_service_name,
-            self.apm_server_url,
-            self.apm_verify_server_cert,
-            self.apm_secret_token,
-            self.apm_api_key
-        )
-
-    def v2_runner_on_async_failed(self, result, **kwargs):
-        self.errors += 1

plugins/callback/logdna.py

@@ -78,7 +78,7 @@ def get_mac():
 
 # Getting hostname of system:
 def get_hostname():
-    return str(socket.gethostname()).split('.local', 1)[0]
+    return str(socket.gethostname()).split('.local')[0]
 
 
 # Getting IP of system:

plugins/callback/logstash.py

@@ -94,7 +94,6 @@ ansible.cfg: |
 
 import os
 import json
-from ansible import context
 import socket
 import uuid
 import logging
@@ -153,11 +152,11 @@ class CallbackModule(CallbackBase):
                 self.base_data['ansible_pre_command_output'] = os.popen(
                     self.ls_pre_command).read()
 
-            if context.CLIARGS is not None:
-                self.base_data['ansible_checkmode'] = context.CLIARGS.get('check')
-                self.base_data['ansible_tags'] = context.CLIARGS.get('tags')
-                self.base_data['ansible_skip_tags'] = context.CLIARGS.get('skip_tags')
-                self.base_data['inventory'] = context.CLIARGS.get('inventory')
+            if self._options is not None:
+                self.base_data['ansible_checkmode'] = self._options.check
+                self.base_data['ansible_tags'] = self._options.tags
+                self.base_data['ansible_skip_tags'] = self._options.skip_tags
+                self.base_data['inventory'] = self._options.inventory
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
         super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)

plugins/callback/mail.py

@@ -11,16 +11,14 @@ name: mail
 type: notification
 short_description: Sends failure events via email
 description:
-- This callback will report failures via email.
+- This callback will report failures via email
 author:
 - Dag Wieers (@dagwieers)
 requirements:
 - whitelisting in configuration
 options:
   mta:
-    description:
-        - Mail Transfer Agent, server that accepts SMTP.
-    type: str
+    description: Mail Transfer Agent, server that accepts SMTP
     env:
         - name: SMTPHOST
     ini:
@@ -28,53 +26,39 @@ options:
           key: smtphost
     default: localhost
   mtaport:
-    description:
-        - Mail Transfer Agent Port.
-        - Port at which server SMTP.
-    type: int
+    description: Mail Transfer Agent Port, port at which server SMTP
     ini:
         - section: callback_mail
           key: smtpport
     default: 25
   to:
-    description:
-        - Mail recipient.
-    type: list
-    elements: str
+    description: Mail recipient
     ini:
         - section: callback_mail
           key: to
-    default: [root]
+    default: root
   sender:
-    description:
-        - Mail sender.
-        - Note that this will be required from community.general 6.0.0 on.
-    type: str
+    description: Mail sender
     ini:
         - section: callback_mail
           key: sender
   cc:
-    description:
-        - CC'd recipients.
-    type: list
-    elements: str
+    description: CC'd recipient
     ini:
         - section: callback_mail
           key: cc
   bcc:
-    description:
-        - BCC'd recipients.
-    type: list
-    elements: str
+    description: BCC'd recipient
     ini:
         - section: callback_mail
           key: bcc
+notes:
+- "TODO: expand configuration options now that plugins can leverage Ansible's configuration"
 '''
 
 import json
 import os
 import re
-import email.utils
 import smtplib
 
 from ansible.module_utils.six import string_types
@@ -104,13 +88,9 @@ class CallbackModule(CallbackBase):
         super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
 
         self.sender = self.get_option('sender')
-        if self.sender is None:
-            self._display.deprecated(
-                'The sender for the mail callback has not been specified. This will be an error in the future',
-                version='6.0.0', collection_name='community.general')
         self.to = self.get_option('to')
         self.smtphost = self.get_option('mta')
-        self.smtpport = self.get_option('mtaport')
+        self.smtpport = int(self.get_option('mtaport'))
         self.cc = self.get_option('cc')
         self.bcc = self.get_option('bcc')
 
@@ -120,34 +100,28 @@ class CallbackModule(CallbackBase):
 
         smtp = smtplib.SMTP(self.smtphost, port=self.smtpport)
 
-        sender_address = email.utils.parseaddr(self.sender)
-        if self.to:
-            to_addresses = email.utils.getaddresses(self.to)
+        b_sender = to_bytes(self.sender)
+        b_to = to_bytes(self.to)
+        b_cc = to_bytes(self.cc)
+        b_bcc = to_bytes(self.bcc)
+        b_subject = to_bytes(subject)
+        b_body = to_bytes(body)
+
+        b_content = b'From: %s\n' % b_sender
+        b_content += b'To: %s\n' % b_to
         if self.cc:
-            cc_addresses = email.utils.getaddresses(self.cc)
+            b_content += b'Cc: %s\n' % b_cc
+        b_content += b'Subject: %s\n\n' % b_subject
+        b_content += b_body
+
+        b_addresses = b_to.split(b',')
+        if self.cc:
+            b_addresses += b_cc.split(b',')
         if self.bcc:
-            bcc_addresses = email.utils.getaddresses(self.bcc)
+            b_addresses += b_bcc.split(b',')
 
-        content = 'Date: %s\n' % email.utils.formatdate()
-        content += 'From: %s\n' % email.utils.formataddr(sender_address)
-        if self.to:
-            content += 'To: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in to_addresses])
-        if self.cc:
-            content += 'Cc: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in cc_addresses])
-        content += 'Message-ID: %s\n' % email.utils.make_msgid()
-        content += 'Subject: %s\n\n' % subject.strip()
-        content += body
-
-        addresses = to_addresses
-        if self.cc:
-            addresses += cc_addresses
-        if self.bcc:
-            addresses += bcc_addresses
-
-        if not addresses:
-            self._display.warning('No receiver has been specified for the mail callback plugin.')
-
-        smtp.sendmail(self.sender, [address for name, address in addresses], to_bytes(content))
+        for b_address in b_addresses:
+            smtp.sendmail(b_sender, b_address, b_content)
 
         smtp.quit()
 

plugins/callback/nrdp.py

@@ -70,7 +70,6 @@ import os
 import json
 
 from ansible.module_utils.six.moves.urllib.parse import urlencode
-from ansible.module_utils.common.text.converters import to_bytes
 from ansible.module_utils.urls import open_url
 from ansible.plugins.callback import CallbackBase
 
@@ -144,7 +143,7 @@ class CallbackModule(CallbackBase):
         body = {
             'cmd': 'submitcheck',
             'token': self.token,
-            'XMLDATA': to_bytes(xmldata)
+            'XMLDATA': bytes(xmldata)
         }
 
         try:

plugins/callback/opentelemetry.py

@@ -1,515 +0,0 @@
-# -*- coding: utf-8 -*-
-# (C) 2021, Victor Martinez <VictorMartinezRubio@gmail.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
-
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: opentelemetry
-    type: notification
-    short_description: Create distributed traces with OpenTelemetry
-    version_added: 3.7.0
-    description:
-      - This callback creates distributed traces for each Ansible task with OpenTelemetry.
-      - You can configure the OpenTelemetry exporter and SDK with environment variables.
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-      enable_from_environment:
-        type: str
-        description:
-          - Whether to enable this callback only if the given environment variable exists and it is set to C(true).
-          - This is handy when you use Configuration as Code and want to send distributed traces
-            if running in the CI rather when running Ansible locally.
-          - For such, it evaluates the given I(enable_from_environment) value as environment variable
-            and if set to true this plugin will be enabled.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
-        version_added: 3.8.0
-      otel_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: OTEL_SERVICE_NAME
-      traceparent:
-        default: None
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-    requirements:
-      - opentelemetry-api (Python library)
-      - opentelemetry-exporter-otlp (Python library)
-      - opentelemetry-sdk (Python library)
-'''
-
-
-EXAMPLES = '''
-examples: |
-  Enable the plugin in ansible.cfg:
-    [defaults]
-    callbacks_enabled = community.general.opentelemetry
-
-  Set the environment variable:
-    export OTEL_EXPORTER_OTLP_ENDPOINT=<your endpoint (OTLP/HTTP)>
-    export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
-    export OTEL_SERVICE_NAME=your_service_name
-'''
-
-import getpass
-import os
-import socket
-import sys
-import time
-import uuid
-
-from collections import OrderedDict
-from os.path import basename
-
-from ansible.errors import AnsibleError
-from ansible.module_utils.six import raise_from
-from ansible.module_utils.six.moves.urllib.parse import urlparse
-from ansible.plugins.callback import CallbackBase
-
-try:
-    from opentelemetry import trace
-    from opentelemetry.trace import SpanKind
-    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
-    from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-    from opentelemetry.trace.status import Status, StatusCode
-    from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
-    from opentelemetry.sdk.trace import TracerProvider
-    from opentelemetry.sdk.trace.export import (
-        BatchSpanProcessor
-    )
-    from opentelemetry.util._time import _time_ns
-except ImportError as imp_exc:
-    OTEL_LIBRARY_IMPORT_ERROR = imp_exc
-else:
-    OTEL_LIBRARY_IMPORT_ERROR = None
-
-
-class TaskData:
-    """
-    Data about an individual task.
-    """
-
-    def __init__(self, uuid, name, path, play, action, args):
-        self.uuid = uuid
-        self.name = name
-        self.path = path
-        self.play = play
-        self.host_data = OrderedDict()
-        if sys.version_info >= (3, 7):
-            self.start = time.time_ns()
-        else:
-            self.start = _time_ns()
-        self.action = action
-        self.args = args
-
-    def add_host(self, host):
-        if host.uuid in self.host_data:
-            if host.status == 'included':
-                # concatenate task include output from multiple items
-                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
-            else:
-                return
-
-        self.host_data[host.uuid] = host
-
-
-class HostData:
-    """
-    Data about an individual host.
-    """
-
-    def __init__(self, uuid, name, status, result):
-        self.uuid = uuid
-        self.name = name
-        self.status = status
-        self.result = result
-        if sys.version_info >= (3, 7):
-            self.finish = time.time_ns()
-        else:
-            self.finish = _time_ns()
-
-
-class OpenTelemetrySource(object):
-    def __init__(self, display):
-        self.ansible_playbook = ""
-        self.ansible_version = None
-        self.session = str(uuid.uuid4())
-        self.host = socket.gethostname()
-        try:
-            self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
-            self.ip_address = None
-        self.user = getpass.getuser()
-
-        self._display = display
-
-    def traceparent_context(self, traceparent):
-        carrier = dict()
-        carrier['traceparent'] = traceparent
-        return TraceContextTextMapPropagator().extract(carrier=carrier)
-
-    def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
-
-        uuid = task._uuid
-
-        if uuid in tasks_data:
-            return
-
-        name = task.get_name().strip()
-        path = task.get_path()
-        action = task.action
-        args = None
-
-        if not task.no_log and not hide_task_arguments:
-            args = task.args
-
-        tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
-
-    def finish_task(self, tasks_data, status, result):
-        """ record the results of a task for a single host """
-
-        task_uuid = result._task._uuid
-
-        if hasattr(result, '_host') and result._host is not None:
-            host_uuid = result._host._uuid
-            host_name = result._host.name
-        else:
-            host_uuid = 'include'
-            host_name = 'include'
-
-        task = tasks_data[task_uuid]
-
-        if self.ansible_version is None and result._task_fields['args'].get('_ansible_version'):
-            self.ansible_version = result._task_fields['args'].get('_ansible_version')
-
-        task.add_host(HostData(host_uuid, host_name, status, result))
-
-    def generate_distributed_traces(self, otel_service_name, ansible_playbook, tasks_data, status, traceparent):
-        """ generate distributed traces from the collected TaskData and HostData """
-
-        tasks = []
-        parent_start_time = None
-        for task_uuid, task in tasks_data.items():
-            if parent_start_time is None:
-                parent_start_time = task.start
-            tasks.append(task)
-
-        trace.set_tracer_provider(
-            TracerProvider(
-                resource=Resource.create({SERVICE_NAME: otel_service_name})
-            )
-        )
-
-        processor = BatchSpanProcessor(OTLPSpanExporter())
-
-        trace.get_tracer_provider().add_span_processor(processor)
-
-        tracer = trace.get_tracer(__name__)
-
-        with tracer.start_as_current_span(ansible_playbook, context=self.traceparent_context(traceparent),
-                                          start_time=parent_start_time, kind=SpanKind.SERVER) as parent:
-            parent.set_status(status)
-            # Populate trace metadata attributes
-            if self.ansible_version is not None:
-                parent.set_attribute("ansible.version", self.ansible_version)
-            parent.set_attribute("ansible.session", self.session)
-            parent.set_attribute("ansible.host.name", self.host)
-            if self.ip_address is not None:
-                parent.set_attribute("ansible.host.ip", self.ip_address)
-            parent.set_attribute("ansible.host.user", self.user)
-            for task in tasks:
-                for host_uuid, host_data in task.host_data.items():
-                    with tracer.start_as_current_span(task.name, start_time=task.start, end_on_exit=False) as span:
-                        self.update_span_data(task, host_data, span)
-
-    def update_span_data(self, task_data, host_data, span):
-        """ update the span with the given TaskData and HostData """
-
-        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
-
-        message = 'success'
-        res = {}
-        rc = 0
-        status = Status(status_code=StatusCode.OK)
-        if host_data.status != 'included':
-            # Support loops
-            if 'results' in host_data.result._result:
-                if host_data.status == 'failed':
-                    message = self.get_error_message_from_results(host_data.result._result['results'], task_data.action)
-                    enriched_error_message = self.enrich_error_message_from_results(host_data.result._result['results'], task_data.action)
-            else:
-                res = host_data.result._result
-                rc = res.get('rc', 0)
-                message = self.get_error_message(res)
-                enriched_error_message = self.enrich_error_message(res)
-
-            if host_data.status == 'failed':
-                status = Status(status_code=StatusCode.ERROR, description=message)
-                # Record an exception with the task message
-                span.record_exception(BaseException(enriched_error_message))
-            elif host_data.status == 'skipped':
-                message = res['skip_reason'] if 'skip_reason' in res else 'skipped'
-                status = Status(status_code=StatusCode.UNSET)
-            elif host_data.status == 'ignored':
-                status = Status(status_code=StatusCode.UNSET)
-
-        span.set_status(status)
-        if isinstance(task_data.args, dict) and "gather_facts" not in task_data.action:
-            names = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.keys())
-            values = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.values())
-            self.set_span_attribute(span, ("ansible.task.args.name"), names)
-            self.set_span_attribute(span, ("ansible.task.args.value"), values)
-        self.set_span_attribute(span, "ansible.task.module", task_data.action)
-        self.set_span_attribute(span, "ansible.task.message", message)
-        self.set_span_attribute(span, "ansible.task.name", name)
-        self.set_span_attribute(span, "ansible.task.result", rc)
-        self.set_span_attribute(span, "ansible.task.host.name", host_data.name)
-        self.set_span_attribute(span, "ansible.task.host.status", host_data.status)
-        # This will allow to enrich the service map
-        self.add_attributes_for_service_map_if_possible(span, task_data)
-        span.end(end_time=host_data.finish)
-
-    def set_span_attribute(self, span, attributeName, attributeValue):
-        """ update the span attribute with the given attribute and value if not None """
-
-        if span is None and self._display is not None:
-            self._display.warning('span object is None. Please double check if that is expected.')
-        else:
-            if attributeValue is not None:
-                span.set_attribute(attributeName, attributeValue)
-
-    def add_attributes_for_service_map_if_possible(self, span, task_data):
-        """Update the span attributes with the service that the task interacted with, if possible."""
-
-        redacted_url = self.parse_and_redact_url_if_possible(task_data.args)
-        if redacted_url:
-            self.set_span_attribute(span, "http.url", redacted_url.geturl())
-
-    @staticmethod
-    def parse_and_redact_url_if_possible(args):
-        """Parse and redact the url, if possible."""
-
-        try:
-            parsed_url = urlparse(OpenTelemetrySource.url_from_args(args))
-        except ValueError:
-            return None
-
-        if OpenTelemetrySource.is_valid_url(parsed_url):
-            return OpenTelemetrySource.redact_user_password(parsed_url)
-        return None
-
-    @staticmethod
-    def url_from_args(args):
-        # the order matters
-        url_args = ("url", "api_url", "baseurl", "repo", "server_url", "chart_repo_url", "registry_url", "endpoint", "uri", "updates_url")
-        for arg in url_args:
-            if args is not None and args.get(arg):
-                return args.get(arg)
-        return ""
-
-    @staticmethod
-    def redact_user_password(url):
-        return url._replace(netloc=url.hostname) if url.password else url
-
-    @staticmethod
-    def is_valid_url(url):
-        if all([url.scheme, url.netloc, url.hostname]):
-            return "{{" not in url.hostname
-        return False
-
-    @staticmethod
-    def transform_ansible_unicode_to_str(value):
-        parsed_url = urlparse(str(value))
-        if OpenTelemetrySource.is_valid_url(parsed_url):
-            return OpenTelemetrySource.redact_user_password(parsed_url).geturl()
-        return str(value)
-
-    @staticmethod
-    def get_error_message(result):
-        if result.get('exception') is not None:
-            return OpenTelemetrySource._last_line(result['exception'])
-        return result.get('msg', 'failed')
-
-    @staticmethod
-    def get_error_message_from_results(results, action):
-        for result in results:
-            if result.get('failed', False):
-                return ('{0}({1}) - {2}').format(action, result.get('item', 'none'), OpenTelemetrySource.get_error_message(result))
-
-    @staticmethod
-    def _last_line(text):
-        lines = text.strip().split('\n')
-        return lines[-1]
-
-    @staticmethod
-    def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
-
-    @staticmethod
-    def enrich_error_message_from_results(results, action):
-        message = ""
-        for result in results:
-            if result.get('failed', False):
-                message = ('{0}({1}) - {2}\n{3}').format(action, result.get('item', 'none'), OpenTelemetrySource.enrich_error_message(result), message)
-        return message
-
-
-class CallbackModule(CallbackBase):
-    """
-    This callback creates distributed traces.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.opentelemetry'
-    CALLBACK_NEEDS_ENABLED = True
-
-    def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
-        self.hide_task_arguments = None
-        self.otel_service_name = None
-        self.ansible_playbook = None
-        self.play_name = None
-        self.tasks_data = None
-        self.errors = 0
-        self.disabled = False
-        self.traceparent = False
-
-        if OTEL_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('The `opentelemetry-api`, `opentelemetry-exporter-otlp` or `opentelemetry-sdk` must be installed to use this plugin'),
-                OTEL_LIBRARY_IMPORT_ERROR)
-
-        self.tasks_data = OrderedDict()
-
-        self.opentelemetry = OpenTelemetrySource(display=self._display)
-
-    def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
-
-        environment_variable = self.get_option('enable_from_environment')
-        if environment_variable is not None and os.environ.get(environment_variable, 'false').lower() != 'true':
-            self.disabled = True
-            self._display.warning("The `enable_from_environment` option has been set and {0} is not enabled. "
-                                  "Disabling the `opentelemetry` callback plugin.".format(environment_variable))
-
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
-
-        self.otel_service_name = self.get_option('otel_service_name')
-
-        if not self.otel_service_name:
-            self.otel_service_name = 'ansible'
-
-        # See https://github.com/open-telemetry/opentelemetry-specification/issues/740
-        self.traceparent = self.get_option('traceparent')
-
-    def v2_playbook_on_start(self, playbook):
-        self.ansible_playbook = basename(playbook._file_name)
-
-    def v2_playbook_on_play_start(self, play):
-        self.play_name = play.get_name()
-
-    def v2_runner_on_no_hosts(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_cleanup_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_handler_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        if ignore_errors:
-            status = 'ignored'
-        else:
-            status = 'failed'
-            self.errors += 1
-
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            status,
-            result
-        )
-
-    def v2_runner_on_ok(self, result):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'ok',
-            result
-        )
-
-    def v2_runner_on_skipped(self, result):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'skipped',
-            result
-        )
-
-    def v2_playbook_on_include(self, included_file):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'included',
-            included_file
-        )
-
-    def v2_playbook_on_stats(self, stats):
-        if self.errors == 0:
-            status = Status(status_code=StatusCode.OK)
-        else:
-            status = Status(status_code=StatusCode.ERROR)
-        self.opentelemetry.generate_distributed_traces(
-            self.otel_service_name,
-            self.ansible_playbook,
-            self.tasks_data,
-            status,
-            self.traceparent
-        )
-
-    def v2_runner_on_async_failed(self, result, **kwargs):
-        self.errors += 1

plugins/callback/say.py

@@ -21,11 +21,11 @@ DOCUMENTATION = '''
       - In 2.8, this callback has been renamed from C(osx_say) into M(community.general.say).
 '''
 
+import distutils.spawn
 import platform
 import subprocess
 import os
 
-from ansible.module_utils.common.process import get_bin_path
 from ansible.plugins.callback import CallbackBase
 
 
@@ -47,24 +47,21 @@ class CallbackModule(CallbackBase):
         self.HAPPY_VOICE = None
         self.LASER_VOICE = None
 
-        try:
-            self.synthesizer = get_bin_path('say')
-            if platform.system() != 'Darwin':
-                # 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter
-                self._display.warning("'say' executable found but system is '%s': ignoring voice parameter" % platform.system())
-            else:
-                self.FAILED_VOICE = 'Zarvox'
-                self.REGULAR_VOICE = 'Trinoids'
-                self.HAPPY_VOICE = 'Cellos'
-                self.LASER_VOICE = 'Princess'
-        except ValueError:
-            try:
-                self.synthesizer = get_bin_path('espeak')
+        self.synthesizer = distutils.spawn.find_executable('say')
+        if not self.synthesizer:
+            self.synthesizer = distutils.spawn.find_executable('espeak')
+            if self.synthesizer:
                 self.FAILED_VOICE = 'klatt'
                 self.HAPPY_VOICE = 'f5'
                 self.LASER_VOICE = 'whisper'
-            except ValueError:
-                self.synthesizer = None
+        elif platform.system() != 'Darwin':
+            # 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter
+            self._display.warning("'say' executable found but system is '%s': ignoring voice parameter" % platform.system())
+        else:
+            self.FAILED_VOICE = 'Zarvox'
+            self.REGULAR_VOICE = 'Trinoids'
+            self.HAPPY_VOICE = 'Cellos'
+            self.LASER_VOICE = 'Princess'
 
         # plugin disable itself if say is not present
         # ansible will not call any callback if disabled is set to True

plugins/callback/syslog_json.py

@@ -41,16 +41,6 @@ DOCUMENTATION = '''
         ini:
           - section: callback_syslog_json
             key: syslog_facility
-      setup:
-        description: Log setup tasks.
-        env:
-          - name: ANSIBLE_SYSLOG_SETUP
-        type: bool
-        default: true
-        ini:
-          - section: callback_syslog_json
-            key: syslog_setup
-        version_added: 4.5.0
 '''
 
 import os
@@ -96,36 +86,23 @@ class CallbackModule(CallbackBase):
         self.logger.addHandler(self.handler)
         self.hostname = socket.gethostname()
 
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        res = result._result
-        host = result._host.get_name()
+    def runner_on_failed(self, host, res, ignore_errors=False):
         self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
 
-    def v2_runner_on_ok(self, result):
-        res = result._result
-        host = result._host.get_name()
-        if result._task.action != "gather_facts" or self.get_option("setup"):
-            self.logger.info('%s ansible-command: task execution OK; host: %s; message: %s', self.hostname, host, self._dump_results(res))
+    def runner_on_ok(self, host, res):
+        self.logger.info('%s ansible-command: task execution OK; host: %s; message: %s', self.hostname, host, self._dump_results(res))
 
-    def v2_runner_on_skipped(self, result):
-        host = result._host.get_name()
+    def runner_on_skipped(self, host, item=None):
         self.logger.info('%s ansible-command: task execution SKIPPED; host: %s; message: %s', self.hostname, host, 'skipped')
 
-    def v2_runner_on_unreachable(self, result):
-        res = result._result
-        host = result._host.get_name()
+    def runner_on_unreachable(self, host, res):
         self.logger.error('%s ansible-command: task execution UNREACHABLE; host: %s; message: %s', self.hostname, host, self._dump_results(res))
 
-    def v2_runner_on_async_failed(self, result):
-        res = result._result
-        host = result._host.get_name()
-        jid = result._result.get('ansible_job_id')
+    def runner_on_async_failed(self, host, res, jid):
         self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
 
-    def v2_playbook_on_import_for_host(self, result, imported_file):
-        host = result._host.get_name()
+    def playbook_on_import_for_host(self, host, imported_file):
         self.logger.info('%s ansible-command: playbook IMPORTED; host: %s; message: imported file %s', self.hostname, host, imported_file)
 
-    def v2_playbook_on_not_import_for_host(self, result, missing_file):
-        host = result._host.get_name()
+    def playbook_on_not_import_for_host(self, host, missing_file):
         self.logger.info('%s ansible-command: playbook NOT IMPORTED; host: %s; message: missing file %s', self.hostname, host, missing_file)

plugins/callback/yaml.py

@@ -42,29 +42,28 @@ def should_use_block(value):
     return False
 
 
-class MyDumper(AnsibleDumper):
-    def represent_scalar(self, tag, value, style=None):
-        """Uses block style for multi-line strings"""
-        if style is None:
-            if should_use_block(value):
-                style = '|'
-                # we care more about readable than accuracy, so...
-                # ...no trailing space
-                value = value.rstrip()
-                # ...and non-printable characters
-                value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
-                # ...tabs prevent blocks from expanding
-                value = value.expandtabs()
-                # ...and odd bits of whitespace
-                value = re.sub(r'[\x0b\x0c\r]', '', value)
-                # ...as does trailing space
-                value = re.sub(r' +\n', '\n', value)
-            else:
-                style = self.default_style
-        node = yaml.representer.ScalarNode(tag, value, style=style)
-        if self.alias_key is not None:
-            self.represented_objects[self.alias_key] = node
-        return node
+def my_represent_scalar(self, tag, value, style=None):
+    """Uses block style for multi-line strings"""
+    if style is None:
+        if should_use_block(value):
+            style = '|'
+            # we care more about readable than accuracy, so...
+            # ...no trailing space
+            value = value.rstrip()
+            # ...and non-printable characters
+            value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+            # ...tabs prevent blocks from expanding
+            value = value.expandtabs()
+            # ...and odd bits of whitespace
+            value = re.sub(r'[\x0b\x0c\r]', '', value)
+            # ...as does trailing space
+            value = re.sub(r' +\n', '\n', value)
+        else:
+            style = self.default_style
+    node = yaml.representer.ScalarNode(tag, value, style=style)
+    if self.alias_key is not None:
+        self.represented_objects[self.alias_key] = node
+    return node
 
 
 class CallbackModule(Default):
@@ -80,6 +79,7 @@ class CallbackModule(Default):
 
     def __init__(self):
         super(CallbackModule, self).__init__()
+        yaml.representer.BaseRepresenter.represent_scalar = my_represent_scalar
 
     def _dump_results(self, result, indent=None, sort_keys=True, keep_invocation=False):
         if result.get('_ansible_no_log', False):
@@ -121,7 +121,7 @@ class CallbackModule(Default):
 
         if abridged_result:
             dumped += '\n'
-            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=MyDumper, default_flow_style=False))
+            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=AnsibleDumper, default_flow_style=False))
 
         # indent by a couple of spaces
         dumped = '\n  '.join(dumped.split('\n')).rstrip()

plugins/connection/jail.py

@@ -31,6 +31,7 @@ DOCUMENTATION = '''
             - name: ansible_jail_user
 '''
 
+import distutils.spawn
 import os
 import os.path
 import subprocess
@@ -38,7 +39,6 @@ import traceback
 
 from ansible.errors import AnsibleError
 from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
 from ansible.plugins.connection import ConnectionBase, BUFSIZE
 from ansible.utils.display import Display
@@ -75,10 +75,10 @@ class Connection(ConnectionBase):
 
     @staticmethod
     def _search_executable(executable):
-        try:
-            return get_bin_path(executable)
-        except ValueError:
+        cmd = distutils.spawn.find_executable(executable)
+        if not cmd:
             raise AnsibleError("%s command not found in PATH" % executable)
+        return cmd
 
     def list_jails(self):
         p = subprocess.Popen([self.jls_cmd, '-q', 'name'],

plugins/connection/lxd.py

@@ -43,10 +43,10 @@ DOCUMENTATION = '''
 '''
 
 import os
+from distutils.spawn import find_executable
 from subprocess import Popen, PIPE
 
 from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
-from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.connection import ConnectionBase
 
@@ -62,9 +62,9 @@ class Connection(ConnectionBase):
         super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
 
         self._host = self._play_context.remote_addr
-        try:
-            self._lxc_cmd = get_bin_path("lxc")
-        except ValueError:
+        self._lxc_cmd = find_executable("lxc")
+
+        if not self._lxc_cmd:
             raise AnsibleError("lxc command not found in PATH")
 
         if self._play_context.remote_user is not None and self._play_context.remote_user != 'root':
@@ -89,9 +89,9 @@ class Connection(ConnectionBase):
             local_cmd.extend(["--project", self.get_option("project")])
         local_cmd.extend([
             "exec",
-            "%s:%s" % (self.get_option("remote"), self.get_option("remote_addr")),
+            "%s:%s" % (self.get_option("remote"), self._host),
             "--",
-            self.get_option("executable"), "-c", cmd
+            self._play_context.executable, "-c", cmd
         ])
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
@@ -126,7 +126,7 @@ class Connection(ConnectionBase):
         local_cmd.extend([
             "file", "push",
             in_path,
-            "%s:%s/%s" % (self.get_option("remote"), self.get_option("remote_addr"), out_path)
+            "%s:%s/%s" % (self.get_option("remote"), self._host, out_path)
         ])
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
@@ -145,7 +145,7 @@ class Connection(ConnectionBase):
             local_cmd.extend(["--project", self.get_option("project")])
         local_cmd.extend([
             "file", "pull",
-            "%s:%s/%s" % (self.get_option("remote"), self.get_option("remote_addr"), in_path),
+            "%s:%s/%s" % (self.get_option("remote"), self._host, in_path),
             out_path
         ])
 

plugins/connection/saltstack.py

@@ -51,7 +51,7 @@ class Connection(ConnectionBase):
         self._connected = True
         return self
 
-    def exec_command(self, cmd, in_data=None, sudoable=False):
+    def exec_command(self, cmd, sudoable=False, in_data=None):
         """ run a command on the remote minion """
         super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
 

plugins/connection/zone.py

@@ -26,6 +26,7 @@ DOCUMENTATION = '''
             - name: ansible_zone_host
 '''
 
+import distutils.spawn
 import os
 import os.path
 import subprocess
@@ -33,7 +34,6 @@ import traceback
 
 from ansible.errors import AnsibleError
 from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes
 from ansible.plugins.connection import ConnectionBase, BUFSIZE
 from ansible.utils.display import Display
@@ -64,10 +64,10 @@ class Connection(ConnectionBase):
 
     @staticmethod
     def _search_executable(executable):
-        try:
-            return get_bin_path(executable)
-        except ValueError:
+        cmd = distutils.spawn.find_executable(executable)
+        if not cmd:
             raise AnsibleError("%s command not found in PATH" % executable)
+        return cmd
 
     def list_zones(self):
         process = subprocess.Popen([self.zoneadm_cmd, 'list', '-ip'],

plugins/doc_fragments/_netapp.py

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2018, Sumit Kumar <sumit4@netapp.com>, chris Archibald <carchi@netapp.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
+
+
+class ModuleDocFragment(object):
+
+    DOCUMENTATION = r'''
+options:
+  - See respective platform section for more details
+requirements:
+  - See respective platform section for more details
+notes:
+  - Ansible modules are available for the following NetApp Storage Platforms: E-Series, ONTAP, SolidFire
+'''
+
+    # Documentation fragment for ONTAP (na_cdot)
+    ONTAP = r'''
+options:
+  hostname:
+      required: true
+      description:
+      - The hostname or IP address of the ONTAP instance.
+  username:
+      required: true
+      description:
+      - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
+        For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
+      aliases: ['user']
+  password:
+      required: true
+      description:
+      - Password for the specified user.
+      aliases: ['pass']
+requirements:
+  - A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 8.3
+  - Ansible 2.2
+  - netapp-lib (2015.9.25). Install using 'pip install netapp-lib'
+
+notes:
+  - The modules prefixed with na\\_cdot are built to support the ONTAP storage platform.
+
+'''
+
+    # Documentation fragment for SolidFire
+    SOLIDFIRE = r'''
+options:
+  hostname:
+      required: true
+      description:
+      - The hostname or IP address of the SolidFire cluster.
+  username:
+      required: true
+      description:
+      - Please ensure that the user has the adequate permissions. For more information, please read the official documentation
+        U(https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US).
+      aliases: ['user']
+  password:
+      required: true
+      description:
+      - Password for the specified user.
+      aliases: ['pass']
+
+requirements:
+  - The modules were developed with SolidFire 10.1
+  - solidfire-sdk-python (1.1.0.92) or greater. Install using 'pip install solidfire-sdk-python'
+
+notes:
+  - The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform.
+
+'''
+
+    # Documentation fragment for ONTAP (na_ontap)
+    NA_ONTAP = r'''
+options:
+  hostname:
+      description:
+      - The hostname or IP address of the ONTAP instance.
+      type: str
+      required: true
+  username:
+      description:
+      - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
+        For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
+      type: str
+      required: true
+      aliases: [ user ]
+  password:
+      description:
+      - Password for the specified user.
+      type: str
+      required: true
+      aliases: [ pass ]
+  https:
+      description:
+      - Enable and disable https
+      type: bool
+      default: no
+  validate_certs:
+      description:
+      - If set to C(no), the SSL certificates will not be validated.
+      - This should only set to C(False) used on personally controlled sites using self-signed certificates.
+      type: bool
+      default: yes
+  http_port:
+      description:
+      - Override the default port (80 or 443) with this port
+      type: int
+  ontapi:
+      description:
+      - The ontap api version to use
+      type: int
+  use_rest:
+      description:
+      - REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
+      - Always -- will always use the REST API
+      - Never -- will always use the ZAPI
+      - Auto -- will try to use the REST Api
+      default: Auto
+      choices: ['Never', 'Always', 'Auto']
+      type: str
+
+
+requirements:
+  - A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
+  - Ansible 2.6
+  - Python2 netapp-lib (2017.10.30) or later. Install using 'pip install netapp-lib'
+  - Python3 netapp-lib (2018.11.13) or later. Install using 'pip install netapp-lib'
+  - To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'
+
+notes:
+  - The modules prefixed with na\\_ontap are built to support the ONTAP storage platform.
+
+'''

plugins/doc_fragments/bitbucket.py

@@ -1,41 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.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
-
-
-class ModuleDocFragment(object):
-
-    # Standard documentation fragment
-    DOCUMENTATION = r'''
-options:
-  client_id:
-    description:
-      - The OAuth consumer key.
-      - If not set the environment variable C(BITBUCKET_CLIENT_ID) will be used.
-    type: str
-  client_secret:
-    description:
-      - The OAuth consumer secret.
-      - If not set the environment variable C(BITBUCKET_CLIENT_SECRET) will be used.
-    type: str
-  user:
-    description:
-      - The username.
-      - If not set the environment variable C(BITBUCKET_USERNAME) will be used.
-    type: str
-    version_added: 4.0.0
-  password:
-    description:
-      - The App password.
-      - If not set the environment variable C(BITBUCKET_PASSWORD) will be used.
-    type: str
-    version_added: 4.0.0
-notes:
-  - Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
-  - Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
-  - If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
-'''

plugins/doc_fragments/gitlab.py

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# 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
-
-
-class ModuleDocFragment(object):
-
-    # Standard files documentation fragment
-    DOCUMENTATION = r'''
-requirements:
-  - requests (Python library U(https://pypi.org/project/requests/))
-
-options:
-  api_token:
-    description:
-      - GitLab access token with API permissions.
-    type: str
-  api_oauth_token:
-    description:
-      - GitLab OAuth token for logging in.
-    type: str
-    version_added: 4.2.0
-  api_job_token:
-    description:
-      - GitLab CI job token for logging in.
-    type: str
-    version_added: 4.2.0
-'''

plugins/doc_fragments/keycloak.py

@@ -61,11 +61,4 @@ options:
             - Verify TLS certificates (do not disable this in production).
         type: bool
         default: yes
-
-    connection_timeout:
-        description:
-            - Controls the HTTP connections timeout period (in seconds) to Keycloak API.
-        type: int
-        default: 10
-        version_added: 4.5.0
 '''

plugins/doc_fragments/ldap.py

@@ -38,10 +38,8 @@ options:
     version_added: 2.0.0
   server_uri:
     description:
-      - The I(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields.
+      - A URI to the LDAP server.
       - The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.
-      - Note that when using multiple URIs you cannot determine to which URI your client gets connected.
-      - For URIs containing additional fields, particularly when using commas, behavior is undefined.
     type: str
     default: ldapi:///
   start_tls:

plugins/doc_fragments/nios.py

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.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
+
+
+class ModuleDocFragment(object):
+
+    # Standard files documentation fragment
+    DOCUMENTATION = r'''
+options:
+  provider:
+    description:
+      - A dict object containing connection details.
+    type: dict
+    suboptions:
+      host:
+        description:
+          - Specifies the DNS host name or address for connecting to the remote
+            instance of NIOS WAPI over REST
+          - Value can also be specified using C(INFOBLOX_HOST) environment
+            variable.
+        type: str
+      username:
+        description:
+          - Configures the username to use to authenticate the connection to
+            the remote instance of NIOS.
+          - Value can also be specified using C(INFOBLOX_USERNAME) environment
+            variable.
+        type: str
+      password:
+        description:
+          - Specifies the password to use to authenticate the connection to
+            the remote instance of NIOS.
+          - Value can also be specified using C(INFOBLOX_PASSWORD) environment
+            variable.
+        type: str
+      validate_certs:
+        description:
+          - Boolean value to enable or disable verifying SSL certificates
+          - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment
+            variable.
+        type: bool
+        default: no
+        aliases: [ ssl_verify ]
+      http_request_timeout:
+        description:
+          - The amount of time before to wait before receiving a response
+          - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
+            variable.
+        type: int
+        default: 10
+      max_retries:
+        description:
+          - Configures the number of attempted retries before the connection
+            is declared usable
+          - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment
+            variable.
+        type: int
+        default: 3
+      wapi_version:
+        description:
+          - Specifies the version of WAPI to use
+          - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment
+            variable.
+          - Until ansible 2.8 the default WAPI was 1.4
+        type: str
+        default: '2.1'
+      max_results:
+        description:
+          - Specifies the maximum number of objects to be returned,
+            if set to a negative number the appliance will return an error when the
+            number of returned objects would exceed the setting.
+          - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment
+            variable.
+        type: int
+        default: 1000
+      http_pool_connections:
+        description:
+          - Number of pools to be used by the C(infoblox_client.Connector) object.
+          - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
+        type: int
+        default: 10
+      http_pool_maxsize:
+        description:
+          - Maximum number of connections per pool to be used by the C(infoblox_client.Connector) object.
+          - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
+        type: int
+        default: 10
+      silent_ssl_warnings:
+        description:
+          - Disable C(urllib3) SSL warnings in the C(infoblox_client.Connector) object.
+          - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
+        type: bool
+        default: true
+notes:
+  - "This module must be run locally, which can be achieved by specifying C(connection: local)."
+  - Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.
+
+'''

plugins/doc_fragments/redis.py

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

plugins/doc_fragments/rundeck.py

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

plugins/filter/counter.py

@@ -1,36 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021, Remy Keil <remy.keil@gmail.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 AnsibleFilterError
-from ansible.module_utils.common._collections_compat import Sequence
-from collections import Counter
-
-
-def counter(sequence):
-    ''' Count elements in a sequence. Returns dict with count result. '''
-    if not isinstance(sequence, Sequence):
-        raise AnsibleFilterError('Argument for community.general.counter must be a sequence (string or list). %s is %s' %
-                                 (sequence, type(sequence)))
-
-    try:
-        result = dict(Counter(sequence))
-    except TypeError as e:
-        raise AnsibleFilterError(
-            "community.general.counter needs a sequence with hashable elements (int, float or str) - %s" % (e)
-        )
-    return result
-
-
-class FilterModule(object):
-    ''' Ansible counter jinja2 filters '''
-
-    def filters(self):
-        filters = {
-            'counter': counter,
-        }
-
-        return filters

plugins/filter/list.py

@@ -1,111 +1,41 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2020-2022, Vladimir Botka <vbotka@gmail.com>
+# Copyright (c) 2020, Vladimir Botka <vbotka@gmail.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 AnsibleFilterError
+from ansible.errors import AnsibleError, AnsibleFilterError
 from ansible.module_utils.six import string_types
 from ansible.module_utils.common._collections_compat import Mapping, Sequence
-from ansible.utils.vars import merge_hash
-from ansible.release import __version__ as ansible_version
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 from collections import defaultdict
 from operator import itemgetter
 
 
-def merge_hash_wrapper(x, y, recursive=False, list_merge='replace'):
-    ''' Wrapper of the function merge_hash from ansible.utils.vars. Only 2 paramaters are allowed
-        for Ansible 2.9 and lower.'''
+def lists_mergeby(l1, l2, index):
+    ''' merge lists by attribute index. Example:
+        - debug: msg="{{ l1|community.general.lists_mergeby(l2, 'index')|list }}" '''
 
-    if LooseVersion(ansible_version) < LooseVersion('2.10'):
-        if list_merge != 'replace' or recursive:
-            msg = ("Non default options of list_merge(default=replace) or recursive(default=False) "
-                   "are not allowed in Ansible version 2.9 or lower. Ansible version is %s, "
-                   "recursive=%s, and list_merge=%s.")
-            raise AnsibleFilterError(msg % (ansible_version, recursive, list_merge))
-        else:
-            return merge_hash(x, y)
-    else:
-        return merge_hash(x, y, recursive, list_merge)
+    if not isinstance(l1, Sequence):
+        raise AnsibleFilterError('First argument for community.general.lists_mergeby must be list. %s is %s' %
+                                 (l1, type(l1)))
 
-
-def list_mergeby(x, y, index, recursive=False, list_merge='replace'):
-    ''' Merge 2 lists by attribute 'index'. The function merge_hash from ansible.utils.vars is used.
-        This function is used by the function lists_mergeby.
-    '''
-
-    d = defaultdict(dict)
-    for l in (x, y):
-        for elem in l:
-            if not isinstance(elem, Mapping):
-                msg = "Elements of list arguments for lists_mergeby must be dictionaries. %s is %s"
-                raise AnsibleFilterError(msg % (elem, type(elem)))
-            if index in elem.keys():
-                d[elem[index]].update(merge_hash_wrapper(d[elem[index]], elem, recursive, list_merge))
-    return sorted(d.values(), key=itemgetter(index))
-
-
-def lists_mergeby(*terms, **kwargs):
-    ''' Merge 2 or more lists by attribute 'index'. Optional parameters 'recursive' and 'list_merge'
-        control the merging of the lists in values. The function merge_hash from ansible.utils.vars
-        is used. To learn details on how to use the parameters 'recursive' and 'list_merge' see
-        Ansible User's Guide chapter "Using filters to manipulate data" section "Combining
-        hashes/dictionaries".
-
-        Example:
-        - debug:
-            msg: "{{ list1|
-                     community.general.lists_mergeby(list2,
-                                                     'index',
-                                                     recursive=True,
-                                                     list_merge='append')|
-                     list }}"
-    '''
-
-    recursive = kwargs.pop('recursive', False)
-    list_merge = kwargs.pop('list_merge', 'replace')
-    if kwargs:
-        raise AnsibleFilterError("'recursive' and 'list_merge' are the only valid keyword arguments.")
-    if len(terms) < 2:
-        raise AnsibleFilterError("At least one list and index are needed.")
-
-    # allow the user to do `[list1, list2, ...] | lists_mergeby('index')`
-    flat_list = []
-    for sublist in terms[:-1]:
-        if not isinstance(sublist, Sequence):
-            msg = ("All arguments before the argument index for community.general.lists_mergeby "
-                   "must be lists. %s is %s")
-            raise AnsibleFilterError(msg % (sublist, type(sublist)))
-        if len(sublist) > 0:
-            if all(isinstance(l, Sequence) for l in sublist):
-                for item in sublist:
-                    flat_list.append(item)
-            else:
-                flat_list.append(sublist)
-    lists = flat_list
-
-    if not lists:
-        return []
-
-    if len(lists) == 1:
-        return lists[0]
-
-    index = terms[-1]
+    if not isinstance(l2, Sequence):
+        raise AnsibleFilterError('Second argument for community.general.lists_mergeby must be list. %s is %s' %
+                                 (l2, type(l2)))
 
     if not isinstance(index, string_types):
-        msg = ("First argument after the lists for community.general.lists_mergeby must be string. "
-               "%s is %s")
-        raise AnsibleFilterError(msg % (index, type(index)))
+        raise AnsibleFilterError('Third argument for community.general.lists_mergeby must be string. %s is %s' %
+                                 (index, type(index)))
 
-    high_to_low_prio_list_iterator = reversed(lists)
-    result = next(high_to_low_prio_list_iterator)
-    for list in high_to_low_prio_list_iterator:
-        result = list_mergeby(list, result, index, recursive, list_merge)
-
-    return result
+    d = defaultdict(dict)
+    for l in (l1, l2):
+        for elem in l:
+            if not isinstance(elem, Mapping):
+                raise AnsibleFilterError('Elements of list arguments for lists_mergeby must be dictionaries. Found {0!r}.'.format(elem))
+            if index in elem.keys():
+                d[elem[index]].update(elem)
+    return sorted(d.values(), key=itemgetter(index))
 
 
 class FilterModule(object):

plugins/filter/unicode_normalize.py

@@ -1,40 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Andrew Pantuso (@ajpantuso) <ajpantuso@gmail.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 unicodedata import normalize
-
-from ansible.errors import AnsibleFilterError, AnsibleFilterTypeError
-from ansible.module_utils.six import text_type
-
-
-def unicode_normalize(data, form='NFC'):
-    """Applies normalization to 'unicode' strings.
-
-    Args:
-        data: A unicode string piped into the Jinja filter
-        form: One of ('NFC', 'NFD', 'NFKC', 'NFKD').
-              See https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize for more information.
-
-    Returns:
-        A normalized unicode string of the specified 'form'.
-    """
-
-    if not isinstance(data, text_type):
-        raise AnsibleFilterTypeError("%s is not a valid input type" % type(data))
-
-    if form not in ('NFC', 'NFD', 'NFKC', 'NFKD'):
-        raise AnsibleFilterError("%s is not a valid form" % form)
-
-    return normalize(form, data)
-
-
-class FilterModule(object):
-    def filters(self):
-        return {
-            'unicode_normalize': unicode_normalize,
-        }

plugins/filter/version_sort.py

@@ -5,7 +5,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 
 def version_sort(value, reverse=False):

plugins/inventory/cobbler.py

@@ -40,25 +40,13 @@ DOCUMENTATION = '''
         type: boolean
         default: no
       exclude_profiles:
-        description:
-          - Profiles to exclude from inventory.
-          - Ignored if I(include_profiles) is specified.
+        description: Profiles to exclude from inventory
         type: list
         default: []
         elements: str
-      include_profiles:
-        description:
-          - Profiles to include from inventory.
-          - If specified, all other profiles will be excluded.
-          - I(exclude_profiles) is ignored if I(include_profiles) is specified.
-        type: list
-        default: []
-        elements: str
-        version_added: 4.4.0
       group_by:
         description: Keys to group hosts by
         type: list
-        elements: string
         default: [ 'mgmt_classes', 'owners', 'status' ]
       group:
         description: Group to place all hosts into
@@ -80,10 +68,12 @@ user: ansible-tester
 password: secure
 '''
 
+from distutils.version import LooseVersion
 import socket
 
 from ansible.errors import AnsibleError
-from ansible.module_utils.common.text.converters import to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
+from ansible.module_utils.common._collections_compat import MutableMapping
 from ansible.module_utils.six import iteritems
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, to_safe_group_name
 
@@ -105,9 +95,18 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
     NAME = 'community.general.cobbler'
 
     def __init__(self):
+
         super(InventoryModule, self).__init__()
-        self.cache_key = None
+
+        # from config
+        self.cobbler_url = None
+        self.exclude_profiles = []  # A list of profiles to exclude
+
         self.connection = None
+        self.token = None
+
+        self.cache_key = None
+        self.use_cache = None
 
     def verify_file(self, path):
         valid = False
@@ -179,12 +178,6 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
             self.inventory.add_child(group_name, child)
         return group_name
 
-    def _exclude_profile(self, profile):
-        if self.include_profiles:
-            return profile not in self.include_profiles
-        else:
-            return profile in self.exclude_profiles
-
     def parse(self, inventory, loader, path, cache=True):
 
         super(InventoryModule, self).parse(inventory, loader, path)
@@ -198,16 +191,15 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
         self.use_cache = cache and self.get_option('cache')
 
         self.exclude_profiles = self.get_option('exclude_profiles')
-        self.include_profiles = self.get_option('include_profiles')
         self.group_by = self.get_option('group_by')
 
         for profile in self._get_profiles():
             if profile['parent']:
                 self.display.vvvv('Processing profile %s with parent %s\n' % (profile['name'], profile['parent']))
-                if not self._exclude_profile(profile['parent']):
+                if profile['parent'] not in self.exclude_profiles:
                     parent_group_name = self._add_safe_group_name(profile['parent'])
                     self.display.vvvv('Added profile parent group %s\n' % parent_group_name)
-                    if not self._exclude_profile(profile['name']):
+                    if profile['name'] not in self.exclude_profiles:
                         group_name = self._add_safe_group_name(profile['name'])
                         self.display.vvvv('Added profile group %s\n' % group_name)
                         self.inventory.add_child(parent_group_name, group_name)
@@ -219,7 +211,7 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
                 while i < len(profile_elements) - 1:
                     profile_group = '-'.join(profile_elements[0:i + 1])
                     profile_group_child = '-'.join(profile_elements[0:i + 2])
-                    if self._exclude_profile(profile_group):
+                    if profile_group in self.exclude_profiles:
                         self.display.vvvv('Excluding profile %s\n' % profile_group)
                         break
                     group_name = self._add_safe_group_name(profile_group)
@@ -240,7 +232,7 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
             hostname = host['hostname']  # None
             interfaces = host['interfaces']
 
-            if self._exclude_profile(host['profile']):
+            if host['profile'] in self.exclude_profiles:
                 self.display.vvvv('Excluding host %s in profile %s\n' % (host['name'], host['profile']))
                 continue
 

plugins/inventory/gitlab_runners.py

@@ -35,6 +35,7 @@ DOCUMENTATION = '''
                 version_added: 1.0.0
             type: str
             required: true
+            default: https://gitlab.com
         api_token:
             description: GitLab token for logging in.
             env:

plugins/inventory/icinga2.py

@@ -1,293 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021, Cliff Hults <cliff.hlts@gmail.com>
-# Copyright (c) 2021 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 = '''
-    name: icinga2
-    short_description: Icinga2 inventory source
-    version_added: 3.7.0
-    author:
-        - Cliff Hults (@BongoEADGC6) <cliff.hults@gmail.com>
-    description:
-        - Get inventory hosts from the Icinga2 API.
-        - "Uses a configuration file as an inventory source, it must end in
-          C(.icinga2.yml) or C(.icinga2.yaml)."
-    extends_documentation_fragment:
-        - constructed
-    options:
-      strict:
-        version_added: 4.4.0
-      compose:
-        version_added: 4.4.0
-      groups:
-        version_added: 4.4.0
-      keyed_groups:
-        version_added: 4.4.0
-      plugin:
-        description: Name of the plugin.
-        required: true
-        type: string
-        choices: ['community.general.icinga2']
-      url:
-        description: Root URL of Icinga2 API.
-        type: string
-        required: true
-      user:
-        description: Username to query the API.
-        type: string
-        required: true
-      password:
-        description: Password to query the API.
-        type: string
-        required: true
-      host_filter:
-        description:
-          - An Icinga2 API valid host filter. Leave blank for no filtering
-        type: string
-        required: false
-      validate_certs:
-        description: Enables or disables SSL certificate verification.
-        type: boolean
-        default: true
-      inventory_attr:
-        description:
-          - Allows the override of the inventory name based on different attributes.
-          - This allows for changing the way limits are used.
-          - The current default, C(address), is sometimes not unique or present. We recommend to use C(name) instead.
-        type: string
-        default: address
-        choices: ['name', 'display_name', 'address']
-        version_added: 4.2.0
-'''
-
-EXAMPLES = r'''
-# my.icinga2.yml
-plugin: community.general.icinga2
-url: http://localhost:5665
-user: ansible
-password: secure
-host_filter: \"linux-servers\" in host.groups
-validate_certs: false
-inventory_attr: name
-groups:
-  # simple name matching
-  webservers: inventory_hostname.startswith('web')
-
-  # using icinga2 template
-  databaseservers: "'db-template' in (icinga2_attributes.templates|list)"
-
-compose:
-  # set all icinga2 attributes to a host variable 'icinga2_attrs'
-  icinga2_attrs: icinga2_attributes
-
-  # set 'ansible_user' and 'ansible_port' from icinga2 host vars
-  ansible_user: icinga2_attributes.vars.ansible_user
-  ansible_port: icinga2_attributes.vars.ansible_port | default(22)
-'''
-
-import json
-
-from ansible.errors import AnsibleParserError
-from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
-from ansible.module_utils.urls import open_url
-from ansible.module_utils.six.moves.urllib.error import HTTPError
-
-
-class InventoryModule(BaseInventoryPlugin, Constructable):
-    ''' Host inventory parser for ansible using Icinga2 as source. '''
-
-    NAME = 'community.general.icinga2'
-
-    def __init__(self):
-
-        super(InventoryModule, self).__init__()
-
-        # from config
-        self.icinga2_url = None
-        self.icinga2_user = None
-        self.icinga2_password = None
-        self.ssl_verify = None
-        self.host_filter = None
-        self.inventory_attr = None
-
-        self.cache_key = None
-        self.use_cache = None
-
-    def verify_file(self, path):
-        valid = False
-        if super(InventoryModule, self).verify_file(path):
-            if path.endswith(('icinga2.yaml', 'icinga2.yml')):
-                valid = True
-            else:
-                self.display.vvv('Skipping due to inventory source not ending in "icinga2.yaml" nor "icinga2.yml"')
-        return valid
-
-    def _api_connect(self):
-        self.headers = {
-            'User-Agent': "ansible-icinga2-inv",
-            'Accept': "application/json",
-        }
-        api_status_url = self.icinga2_url + "/status"
-        request_args = {
-            'headers': self.headers,
-            'url_username': self.icinga2_user,
-            'url_password': self.icinga2_password,
-            'validate_certs': self.ssl_verify
-        }
-        open_url(api_status_url, **request_args)
-
-    def _post_request(self, request_url, data=None):
-        self.display.vvv("Requested URL: %s" % request_url)
-        request_args = {
-            'headers': self.headers,
-            'url_username': self.icinga2_user,
-            'url_password': self.icinga2_password,
-            'validate_certs': self.ssl_verify
-        }
-        if data is not None:
-            request_args['data'] = json.dumps(data)
-        self.display.vvv("Request Args: %s" % request_args)
-        try:
-            response = open_url(request_url, **request_args)
-        except HTTPError as e:
-            try:
-                error_body = json.loads(e.read().decode())
-                self.display.vvv("Error returned: {0}".format(error_body))
-            except Exception:
-                error_body = {"status": None}
-            if e.code == 404 and error_body.get('status') == "No objects found.":
-                raise AnsibleParserError("Host filter returned no data. Please confirm your host_filter value is valid")
-            raise AnsibleParserError("Unexpected data returned: {0} -- {1}".format(e, error_body))
-
-        response_body = response.read()
-        json_data = json.loads(response_body.decode('utf-8'))
-        self.display.vvv("Returned Data: %s" % json.dumps(json_data, indent=4, sort_keys=True))
-        if 200 <= response.status <= 299:
-            return json_data
-        if response.status == 404 and json_data['status'] == "No objects found.":
-            raise AnsibleParserError(
-                "API returned no data -- Response: %s - %s"
-                % (response.status, json_data['status']))
-        if response.status == 401:
-            raise AnsibleParserError(
-                "API was unable to complete query -- Response: %s - %s"
-                % (response.status, json_data['status']))
-        if response.status == 500:
-            raise AnsibleParserError(
-                "API Response - %s - %s"
-                % (json_data['status'], json_data['errors']))
-        raise AnsibleParserError(
-            "Unexpected data returned - %s - %s"
-            % (json_data['status'], json_data['errors']))
-
-    def _query_hosts(self, hosts=None, attrs=None, joins=None, host_filter=None):
-        query_hosts_url = "{0}/objects/hosts".format(self.icinga2_url)
-        self.headers['X-HTTP-Method-Override'] = 'GET'
-        data_dict = dict()
-        if hosts:
-            data_dict['hosts'] = hosts
-        if attrs is not None:
-            data_dict['attrs'] = attrs
-        if joins is not None:
-            data_dict['joins'] = joins
-        if host_filter is not None:
-            data_dict['filter'] = host_filter.replace("\\\"", "\"")
-            self.display.vvv(host_filter)
-        host_dict = self._post_request(query_hosts_url, data_dict)
-        return host_dict['results']
-
-    def get_inventory_from_icinga(self):
-        """Query for all hosts """
-        self.display.vvv("Querying Icinga2 for inventory")
-        query_args = {
-            "attrs": ["address", "address6", "name", "display_name", "state_type", "state", "templates", "groups", "vars", "zone"],
-        }
-        if self.host_filter is not None:
-            query_args['host_filter'] = self.host_filter
-        # Icinga2 API Call
-        results_json = self._query_hosts(**query_args)
-        # Manipulate returned API data to Ansible inventory spec
-        ansible_inv = self._convert_inv(results_json)
-        return ansible_inv
-
-    def _apply_constructable(self, name, variables):
-        strict = self.get_option('strict')
-        self._add_host_to_composed_groups(self.get_option('groups'), variables, name, strict=strict)
-        self._add_host_to_keyed_groups(self.get_option('keyed_groups'), variables, name, strict=strict)
-        self._set_composite_vars(self.get_option('compose'), variables, name, strict=strict)
-
-    def _populate(self):
-        groups = self._to_json(self.get_inventory_from_icinga())
-        return groups
-
-    def _to_json(self, in_dict):
-        """Convert dictionary to JSON"""
-        return json.dumps(in_dict, sort_keys=True, indent=2)
-
-    def _convert_inv(self, json_data):
-        """Convert Icinga2 API data to JSON format for Ansible"""
-        groups_dict = {"_meta": {"hostvars": {}}}
-        for entry in json_data:
-            host_attrs = entry['attrs']
-            if self.inventory_attr == "name":
-                host_name = entry.get('name')
-            if self.inventory_attr == "address":
-                # When looking for address for inventory, if missing fallback to object name
-                if host_attrs.get('address', '') != '':
-                    host_name = host_attrs.get('address')
-                else:
-                    host_name = entry.get('name')
-            if self.inventory_attr == "display_name":
-                host_name = host_attrs.get('display_name')
-            if host_attrs['state'] == 0:
-                host_attrs['state'] = 'on'
-            else:
-                host_attrs['state'] = 'off'
-            host_groups = host_attrs.get('groups')
-            self.inventory.add_host(host_name)
-            for group in host_groups:
-                if group not in self.inventory.groups.keys():
-                    self.inventory.add_group(group)
-                self.inventory.add_child(group, host_name)
-            # If the address attribute is populated, override ansible_host with the value
-            if host_attrs.get('address') != '':
-                self.inventory.set_variable(host_name, 'ansible_host', host_attrs.get('address'))
-            self.inventory.set_variable(host_name, 'hostname', entry.get('name'))
-            self.inventory.set_variable(host_name, 'display_name', host_attrs.get('display_name'))
-            self.inventory.set_variable(host_name, 'state',
-                                        host_attrs['state'])
-            self.inventory.set_variable(host_name, 'state_type',
-                                        host_attrs['state_type'])
-            # Adds all attributes to a variable 'icinga2_attributes'
-            construct_vars = dict(self.inventory.get_host(host_name).get_vars())
-            construct_vars['icinga2_attributes'] = host_attrs
-            self._apply_constructable(host_name, construct_vars)
-        return groups_dict
-
-    def parse(self, inventory, loader, path, cache=True):
-
-        super(InventoryModule, self).parse(inventory, loader, path)
-
-        # read config from file, this sets 'options'
-        self._read_config_data(path)
-
-        # Store the options from the YAML file
-        self.icinga2_url = self.get_option('url').rstrip('/') + '/v1'
-        self.icinga2_user = self.get_option('user')
-        self.icinga2_password = self.get_option('password')
-        self.ssl_verify = self.get_option('validate_certs')
-        self.host_filter = self.get_option('host_filter')
-        self.inventory_attr = self.get_option('inventory_attr')
-        # Not currently enabled
-        # self.cache_key = self.get_cache_key(path)
-        # self.use_cache = cache and self.get_option('cache')
-
-        # Test connection to API
-        self._api_connect()
-
-        # Call our internal helper to populate the dynamic inventory
-        self._populate()

plugins/inventory/linode.py

@@ -21,30 +21,11 @@ DOCUMENTATION = r'''
           Linode) and not tags.
     extends_documentation_fragment:
         - constructed
-        - inventory_cache
     options:
-        cache:
-            version_added: 4.5.0
-        cache_plugin:
-            version_added: 4.5.0
-        cache_timeout:
-            version_added: 4.5.0
-        cache_connection:
-            version_added: 4.5.0
-        cache_prefix:
-            version_added: 4.5.0
         plugin:
-            description: Marks this as an instance of the 'linode' plugin.
+            description: marks this as an instance of the 'linode' plugin
             required: true
             choices: ['linode', 'community.general.linode']
-        ip_style:
-            description: Populate hostvars with all information available from the Linode APIv4.
-            type: string
-            default: plain
-            choices:
-                - plain
-                - api
-            version_added: 3.6.0
         access_token:
             description: The Linode account personal access token.
             required: true
@@ -54,18 +35,15 @@ DOCUMENTATION = r'''
           description: Populate inventory with instances in this region.
           default: []
           type: list
-          elements: string
         tags:
           description: Populate inventory only with instances which have at least one of the tags listed here.
           default: []
           type: list
-          elements: string
           version_added: 2.0.0
         types:
           description: Populate inventory with instances with this type.
           default: []
           type: list
-          elements: string
         strict:
           version_added: 2.0.0
         compose:
@@ -80,12 +58,6 @@ EXAMPLES = r'''
 # Minimal example. `LINODE_ACCESS_TOKEN` is exposed in environment.
 plugin: community.general.linode
 
-# You can use Jinja to template the access token.
-plugin: community.general.linode
-access_token: "{{ lookup('ini', 'token', section='your_username', file='~/.config/linode-cli') }}"
-# For older Ansible versions, you need to write this as:
-# access_token: "{{ lookup('ini', 'token section=your_username file=~/.config/linode-cli') }}"
-
 # Example with regions, types, groups and access token
 plugin: community.general.linode
 access_token: foobar
@@ -106,49 +78,32 @@ groups:
   webservers: "'web' in (tags|list)"
   mailservers: "'mail' in (tags|list)"
 compose:
-  # By default, Ansible tries to connect to the label of the instance.
-  # Since that might not be a valid name to connect to, you can
-  # replace it with the first IPv4 address of the linode as follows:
-  ansible_ssh_host: ipv4[0]
   ansible_port: 2222
-
-# Example where control traffic limited to internal network
-plugin: community.general.linode
-access_token: foobar
-ip_style: api
-compose:
-  ansible_host: "ipv4 | community.general.json_query('[?public==`false`].address') | first"
 '''
 
 import os
 
 from ansible.errors import AnsibleError, AnsibleParserError
 from ansible.module_utils.six import string_types
-from ansible.plugins.inventory import BaseInventoryPlugin, Constructable, Cacheable
-from ansible.template import Templar
+from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 
 
 try:
     from linode_api4 import LinodeClient
-    from linode_api4.objects.linode import Instance
     from linode_api4.errors import ApiError as LinodeApiError
     HAS_LINODE = True
 except ImportError:
     HAS_LINODE = False
 
 
-class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
+class InventoryModule(BaseInventoryPlugin, Constructable):
 
     NAME = 'community.general.linode'
 
-    def _build_client(self, loader):
+    def _build_client(self):
         """Build the Linode client."""
 
-        t = Templar(loader=loader)
-
         access_token = self.get_option('access_token')
-        if t.is_template(access_token):
-            access_token = t.template(variable=access_token, disable_lookups=False)
 
         if access_token is None:
             try:
@@ -184,23 +139,20 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         for linode_group in self.linode_groups:
             self.inventory.add_group(linode_group)
 
-    def _filter_by_config(self):
+    def _filter_by_config(self, regions, types, tags):
         """Filter instances by user specified configuration."""
-        regions = self.get_option('regions')
         if regions:
             self.instances = [
                 instance for instance in self.instances
                 if instance.region.id in regions
             ]
 
-        types = self.get_option('types')
         if types:
             self.instances = [
                 instance for instance in self.instances
                 if instance.type.id in types
             ]
 
-        tags = self.get_option('tags')
         if tags:
             self.instances = [
                 instance for instance in self.instances
@@ -214,52 +166,85 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
 
     def _add_hostvars_for_instances(self):
         """Add hostvars for instances in the dynamic inventory."""
-        ip_style = self.get_option('ip_style')
         for instance in self.instances:
             hostvars = instance._raw_json
             for hostvar_key in hostvars:
-                if ip_style == 'api' and hostvar_key in ['ipv4', 'ipv6']:
-                    continue
                 self.inventory.set_variable(
                     instance.label,
                     hostvar_key,
                     hostvars[hostvar_key]
                 )
-            if ip_style == 'api':
-                ips = instance.ips.ipv4.public + instance.ips.ipv4.private
-                ips += [instance.ips.ipv6.slaac, instance.ips.ipv6.link_local]
-                ips += instance.ips.ipv6.pools
 
-                for ip_type in set(ip.type for ip in ips):
-                    self.inventory.set_variable(
-                        instance.label,
-                        ip_type,
-                        self._ip_data([ip for ip in ips if ip.type == ip_type])
-                    )
+    def _validate_option(self, name, desired_type, option_value):
+        """Validate user specified configuration data against types."""
+        if isinstance(option_value, string_types) and desired_type == list:
+            option_value = [option_value]
 
-    def _ip_data(self, ip_list):
-        data = []
-        for ip in list(ip_list):
-            data.append(
-                {
-                    'address': ip.address,
-                    'subnet_mask': ip.subnet_mask,
-                    'gateway': ip.gateway,
-                    'public': ip.public,
-                    'prefix': ip.prefix,
-                    'rdns': ip.rdns,
-                    'type': ip.type
-                }
+        if option_value is None:
+            option_value = desired_type()
+
+        if not isinstance(option_value, desired_type):
+            raise AnsibleParserError(
+                'The option %s (%s) must be a %s' % (
+                    name, option_value, desired_type
+                )
             )
-        return data
 
-    def _cacheable_inventory(self):
-        return [i._raw_json for i in self.instances]
+        return option_value
+
+    def _get_query_options(self, config_data):
+        """Get user specified query options from the configuration."""
+        options = {
+            'regions': {
+                'type_to_be': list,
+                'value': config_data.get('regions', [])
+            },
+            'types': {
+                'type_to_be': list,
+                'value': config_data.get('types', [])
+            },
+            'tags': {
+                'type_to_be': list,
+                'value': config_data.get('tags', [])
+            },
+        }
+
+        for name in options:
+            options[name]['value'] = self._validate_option(
+                name,
+                options[name]['type_to_be'],
+                options[name]['value']
+            )
+
+        regions = options['regions']['value']
+        types = options['types']['value']
+        tags = options['tags']['value']
+
+        return regions, types, tags
+
+    def verify_file(self, path):
+        """Verify the Linode configuration file."""
+        if super(InventoryModule, self).verify_file(path):
+            endings = ('linode.yaml', 'linode.yml')
+            if any((path.endswith(ending) for ending in endings)):
+                return True
+        return False
+
+    def parse(self, inventory, loader, path, cache=True):
+        """Dynamically parse Linode the cloud inventory."""
+        super(InventoryModule, self).parse(inventory, loader, path)
+
+        if not HAS_LINODE:
+            raise AnsibleError('the Linode dynamic inventory plugin requires linode_api4.')
+
+        config_data = self._read_config_data(path)
+        self._build_client()
+
+        self._get_instances_inventory()
 
-    def populate(self):
         strict = self.get_option('strict')
-
-        self._filter_by_config()
+        regions, types, tags = self._get_query_options(config_data)
+        self._filter_by_config(regions, types, tags)
 
         self._add_groups()
         self._add_instances_to_groups()
@@ -281,44 +266,3 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                 variables,
                 instance.label,
                 strict=strict)
-
-    def verify_file(self, path):
-        """Verify the Linode configuration file."""
-        if super(InventoryModule, self).verify_file(path):
-            endings = ('linode.yaml', 'linode.yml')
-            if any((path.endswith(ending) for ending in endings)):
-                return True
-        return False
-
-    def parse(self, inventory, loader, path, cache=True):
-        """Dynamically parse Linode the cloud inventory."""
-        super(InventoryModule, self).parse(inventory, loader, path)
-        self.instances = None
-
-        if not HAS_LINODE:
-            raise AnsibleError('the Linode dynamic inventory plugin requires linode_api4.')
-
-        self._read_config_data(path)
-
-        cache_key = self.get_cache_key(path)
-
-        if cache:
-            cache = self.get_option('cache')
-
-        update_cache = False
-        if cache:
-            try:
-                self.instances = [Instance(None, i["id"], i) for i in self._cache[cache_key]]
-            except KeyError:
-                update_cache = True
-
-        # Check for None rather than False in order to allow
-        # for empty sets of cached instances
-        if self.instances is None:
-            self._build_client(loader)
-            self._get_instances_inventory()
-
-        if update_cache:
-            self._cache[cache_key] = self._cacheable_inventory()
-
-        self.populate()

plugins/inventory/lxd.py

@@ -13,9 +13,6 @@ DOCUMENTATION = r'''
         - Uses a YAML configuration file that ends with 'lxd.(yml|yaml)'.
     version_added: "3.0.0"
     author: "Frank Dornheim (@conloos)"
-    requirements:
-        - ipaddress
-        - lxd >= 4.0
     options:
         plugin:
             description: Token that ensures this is a source file for the 'lxd' plugin.
@@ -50,38 +47,26 @@ DOCUMENTATION = r'''
             - If I(trust_password) is set, this module send a request for authentication before sending any requests.
             type: str
         state:
-            description: Filter the instance according to the current status.
+            description: Filter the container according to the current status.
             type: str
             default: none
             choices: [ 'STOPPED', 'STARTING', 'RUNNING', 'none' ]
-        type_filter:
+        prefered_container_network_interface:
             description:
-            - Filter the instances by type C(virtual-machine), C(container) or C(both).
-            - The first version of the inventory only supported containers.
-            type: str
-            default: container
-            choices: [ 'virtual-machine', 'container', 'both' ]
-            version_added: 4.2.0
-        prefered_instance_network_interface:
-            description:
-            - If an instance has multiple network interfaces, select which one is the prefered as pattern.
+            - If a container has multiple network interfaces, select which one is the prefered as pattern.
             - Combined with the first number that can be found e.g. 'eth' + 0.
-            - The option has been renamed from I(prefered_container_network_interface) to I(prefered_instance_network_interface) in community.general 3.8.0.
-              The old name still works as an alias.
             type: str
             default: eth
-            aliases:
-              - prefered_container_network_interface
-        prefered_instance_network_family:
+        prefered_container_network_family:
             description:
-            - If an instance has multiple network interfaces, which one is the prefered by family.
+            - If a container has multiple network interfaces, which one is the prefered by family.
             - Specify C(inet) for IPv4 and C(inet6) for IPv6.
             type: str
             default: inet
             choices: [ 'inet', 'inet6' ]
         groupby:
             description:
-            - Create groups by the following keywords C(location), C(network_range), C(os), C(pattern), C(profile), C(release), C(type), C(vlanid).
+            - Create groups by the following keywords C(location), C(pattern), C(network_range), C(os), C(release), C(profile), C(vlanid).
             - See example for syntax.
             type: dict
 '''
@@ -96,49 +81,38 @@ plugin: community.general.lxd
 url: unix:/var/snap/lxd/common/lxd/unix.socket
 state: RUNNING
 
-# simple lxd.yml including virtual machines and containers
-plugin: community.general.lxd
-url: unix:/var/snap/lxd/common/lxd/unix.socket
-type_filter: both
-
 # grouping lxd.yml
 groupby:
-  locationBerlin:
-    type: location
-    attribute: Berlin
-  netRangeIPv4:
-    type: network_range
-    attribute: 10.98.143.0/24
-  netRangeIPv6:
-    type: network_range
-    attribute: fd42:bd00:7b11:2167:216:3eff::/24
-  osUbuntu:
-    type: os
-    attribute: ubuntu
   testpattern:
     type: pattern
     attribute: test
-  profileDefault:
-    type: profile
-    attribute: default
-  profileX11:
-    type: profile
-    attribute: x11
+  vlan666:
+    type: vlanid
+    attribute: 666
+  locationBerlin:
+    type: location
+    attribute: Berlin
+  osUbuntu:
+    type: os
+    attribute: ubuntu
   releaseFocal:
     type: release
     attribute: focal
   releaseBionic:
     type: release
     attribute: bionic
-  typeVM:
-    type: type
-    attribute: virtual-machine
-  typeContainer:
-    type: type
-    attribute: container
-  vlan666:
-    type: vlanid
-    attribute: 666
+  profileDefault:
+    type: profile
+    attribute: default
+  profileX11:
+    type: profile
+    attribute: x11
+  netRangeIPv4:
+    type: network_range
+    attribute: 10.98.143.0/24
+  netRangeIPv6:
+    type: network_range
+    attribute: fd42:bd00:7b11:2167:216:3eff::/24
 '''
 
 import binascii
@@ -150,17 +124,10 @@ import socket
 from ansible.plugins.inventory import BaseInventoryPlugin
 from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.module_utils.common.dict_transformations import dict_merge
-from ansible.module_utils.six import raise_from
 from ansible.errors import AnsibleError, AnsibleParserError
+from ansible_collections.community.general.plugins.module_utils.compat import ipaddress
 from ansible_collections.community.general.plugins.module_utils.lxd import LXDClient, LXDClientException
 
-try:
-    import ipaddress
-except ImportError as exc:
-    IPADDRESS_IMPORT_ERROR = exc
-else:
-    IPADDRESS_IMPORT_ERROR = None
-
 
 class InventoryModule(BaseInventoryPlugin):
     DEBUG = 4
@@ -307,10 +274,10 @@ class InventoryModule(BaseInventoryPlugin):
         network_configs = self.socket.do('GET', '/1.0/networks')
         return [m.split('/')[3] for m in network_configs['metadata']]
 
-    def _get_instances(self):
-        """Get instancenames
+    def _get_containers(self):
+        """Get Containernames
 
-        Returns all instancenames
+        Returns all containernames
 
         Args:
             None
@@ -319,27 +286,25 @@ class InventoryModule(BaseInventoryPlugin):
         Raises:
             None
         Returns:
-            list(names): names of all instances"""
-        # e.g. {
-        #        "metadata": [
-        #          "/1.0/instances/foo",
-        #          "/1.0/instances/bar"
-        #        ],
-        #        "status": "Success",
-        #        "status_code": 200,
-        #        "type": "sync"
-        #      }
-        instances = self.socket.do('GET', '/1.0/instances')
-        return [m.split('/')[3] for m in instances['metadata']]
+            list(names): names of all containers"""
+        # e.g. {'type': 'sync',
+        #       'status': 'Success',
+        #       'status_code': 200,
+        #       'operation': '',
+        #       'error_code': 0,
+        #       'error': '',
+        #       'metadata': ['/1.0/containers/udemy-ansible-ubuntu-2004']}
+        containers = self.socket.do('GET', '/1.0/containers')
+        return [m.split('/')[3] for m in containers['metadata']]
 
     def _get_config(self, branch, name):
-        """Get inventory of instance
+        """Get inventory of container
 
-        Get config of instance
+        Get config of container
 
         Args:
             str(branch): Name oft the API-Branch
-            str(name): Name of instance
+            str(name): Name of Container
         Kwargs:
             None
         Source:
@@ -347,7 +312,7 @@ class InventoryModule(BaseInventoryPlugin):
         Raises:
             None
         Returns:
-            dict(config): Config of the instance"""
+            dict(config): Config of the container"""
         config = {}
         if isinstance(branch, (tuple, list)):
             config[name] = {branch[1]: self.socket.do('GET', '/1.0/{0}/{1}/{2}'.format(to_native(branch[0]), to_native(name), to_native(branch[1])))}
@@ -355,13 +320,13 @@ class InventoryModule(BaseInventoryPlugin):
             config[name] = {branch: self.socket.do('GET', '/1.0/{0}/{1}'.format(to_native(branch), to_native(name)))}
         return config
 
-    def get_instance_data(self, names):
-        """Create Inventory of the instance
+    def get_container_data(self, names):
+        """Create Inventory of the container
 
-        Iterate through the different branches of the instances and collect Informations.
+        Iterate through the different branches of the containers and collect Informations.
 
         Args:
-            list(names): List of instance names
+            list(names): List of container names
         Kwargs:
             None
         Raises:
@@ -370,20 +335,20 @@ class InventoryModule(BaseInventoryPlugin):
             None"""
         # tuple(('instances','metadata/templates')) to get section in branch
         # e.g. /1.0/instances/<name>/metadata/templates
-        branches = ['instances', ('instances', 'state')]
-        instance_config = {}
+        branches = ['containers', ('instances', 'state')]
+        container_config = {}
         for branch in branches:
             for name in names:
-                instance_config['instances'] = self._get_config(branch, name)
-                self.data = dict_merge(instance_config, self.data)
+                container_config['containers'] = self._get_config(branch, name)
+                self.data = dict_merge(container_config, self.data)
 
     def get_network_data(self, names):
-        """Create Inventory of the instance
+        """Create Inventory of the container
 
-        Iterate through the different branches of the instances and collect Informations.
+        Iterate through the different branches of the containers and collect Informations.
 
         Args:
-            list(names): List of instance names
+            list(names): List of container names
         Kwargs:
             None
         Raises:
@@ -402,26 +367,26 @@ class InventoryModule(BaseInventoryPlugin):
                     network_config['networks'] = {name: None}
                 self.data = dict_merge(network_config, self.data)
 
-    def extract_network_information_from_instance_config(self, instance_name):
+    def extract_network_information_from_container_config(self, container_name):
         """Returns the network interface configuration
 
-        Returns the network ipv4 and ipv6 config of the instance without local-link
+        Returns the network ipv4 and ipv6 config of the container without local-link
 
         Args:
-            str(instance_name): Name oft he instance
+            str(container_name): Name oft he container
         Kwargs:
             None
         Raises:
             None
         Returns:
             dict(network_configuration): network config"""
-        instance_network_interfaces = self._get_data_entry('instances/{0}/state/metadata/network'.format(instance_name))
+        container_network_interfaces = self._get_data_entry('containers/{0}/state/metadata/network'.format(container_name))
         network_configuration = None
-        if instance_network_interfaces:
+        if container_network_interfaces:
             network_configuration = {}
-            gen_interface_names = [interface_name for interface_name in instance_network_interfaces if interface_name != 'lo']
+            gen_interface_names = [interface_name for interface_name in container_network_interfaces if interface_name != 'lo']
             for interface_name in gen_interface_names:
-                gen_address = [address for address in instance_network_interfaces[interface_name]['addresses'] if address.get('scope') != 'link']
+                gen_address = [address for address in container_network_interfaces[interface_name]['addresses'] if address.get('scope') != 'link']
                 network_configuration[interface_name] = []
                 for address in gen_address:
                     address_set = {}
@@ -432,24 +397,24 @@ class InventoryModule(BaseInventoryPlugin):
                     network_configuration[interface_name].append(address_set)
         return network_configuration
 
-    def get_prefered_instance_network_interface(self, instance_name):
-        """Helper to get the prefered interface of thr instance
+    def get_prefered_container_network_interface(self, container_name):
+        """Helper to get the prefered interface of thr container
 
-        Helper to get the prefered interface provide by neme pattern from 'prefered_instance_network_interface'.
+        Helper to get the prefered interface provide by neme pattern from 'prefered_container_network_interface'.
 
         Args:
-            str(containe_name): name of instance
+            str(containe_name): name of container
         Kwargs:
             None
         Raises:
             None
         Returns:
             str(prefered_interface): None or interface name"""
-        instance_network_interfaces = self._get_data_entry('inventory/{0}/network_interfaces'.format(instance_name))
+        container_network_interfaces = self._get_data_entry('inventory/{0}/network_interfaces'.format(container_name))
         prefered_interface = None  # init
-        if instance_network_interfaces:  # instance have network interfaces
+        if container_network_interfaces:  # container have network interfaces
             # generator if interfaces which start with the desired pattern
-            net_generator = [interface for interface in instance_network_interfaces if interface.startswith(self.prefered_instance_network_interface)]
+            net_generator = [interface for interface in container_network_interfaces if interface.startswith(self.prefered_container_network_interface)]
             selected_interfaces = []  # init
             for interface in net_generator:
                 selected_interfaces.append(interface)
@@ -457,13 +422,13 @@ class InventoryModule(BaseInventoryPlugin):
                 prefered_interface = sorted(selected_interfaces)[0]
         return prefered_interface
 
-    def get_instance_vlans(self, instance_name):
-        """Get VLAN(s) from instance
+    def get_container_vlans(self, container_name):
+        """Get VLAN(s) from container
 
-        Helper to get the VLAN_ID from the instance
+        Helper to get the VLAN_ID from the container
 
         Args:
-            str(containe_name): name of instance
+            str(containe_name): name of container
         Kwargs:
             None
         Raises:
@@ -476,13 +441,13 @@ class InventoryModule(BaseInventoryPlugin):
             if self._get_data_entry('state/metadata/vlan/vid', data=self.data['networks'].get(network)):
                 network_vlans[network] = self._get_data_entry('state/metadata/vlan/vid', data=self.data['networks'].get(network))
 
-        # get networkdevices of instance and return
+        # get networkdevices of container and return
         # e.g.
         # "eth0":{ "name":"eth0",
         #          "network":"lxdbr0",
         #          "type":"nic"},
         vlan_ids = {}
-        devices = self._get_data_entry('instances/{0}/instances/metadata/expanded_devices'.format(to_native(instance_name)))
+        devices = self._get_data_entry('containers/{0}/containers/metadata/expanded_devices'.format(to_native(container_name)))
         for device in devices:
             if 'network' in devices[device]:
                 if devices[device]['network'] in network_vlans:
@@ -518,14 +483,14 @@ class InventoryModule(BaseInventoryPlugin):
         except KeyError:
             return None
 
-    def _set_data_entry(self, instance_name, key, value, path=None):
+    def _set_data_entry(self, container_name, key, value, path=None):
         """Helper to save data
 
         Helper to save the data in self.data
         Detect if data is allready in branch and use dict_merge() to prevent that branch is overwritten.
 
         Args:
-            str(instance_name): name of instance
+            str(container_name): name of container
             str(key): same as dict
             *(value): same as dict
         Kwargs:
@@ -536,24 +501,24 @@ class InventoryModule(BaseInventoryPlugin):
             None"""
         if not path:
             path = self.data['inventory']
-        if instance_name not in path:
-            path[instance_name] = {}
+        if container_name not in path:
+            path[container_name] = {}
 
         try:
-            if isinstance(value, dict) and key in path[instance_name]:
-                path[instance_name] = dict_merge(value, path[instance_name][key])
+            if isinstance(value, dict) and key in path[container_name]:
+                path[container_name] = dict_merge(value, path[container_name][key])
             else:
-                path[instance_name][key] = value
+                path[container_name][key] = value
         except KeyError as err:
             raise AnsibleParserError("Unable to store Informations: {0}".format(to_native(err)))
 
-    def extract_information_from_instance_configs(self):
+    def extract_information_from_container_configs(self):
         """Process configuration information
 
         Preparation of the data
 
         Args:
-            dict(configs): instance configurations
+            dict(configs): Container configurations
         Kwargs:
             None
         Raises:
@@ -564,35 +529,33 @@ class InventoryModule(BaseInventoryPlugin):
         if 'inventory' not in self.data:
             self.data['inventory'] = {}
 
-        for instance_name in self.data['instances']:
-            self._set_data_entry(instance_name, 'os', self._get_data_entry(
-                'instances/{0}/instances/metadata/config/image.os'.format(instance_name)))
-            self._set_data_entry(instance_name, 'release', self._get_data_entry(
-                'instances/{0}/instances/metadata/config/image.release'.format(instance_name)))
-            self._set_data_entry(instance_name, 'version', self._get_data_entry(
-                'instances/{0}/instances/metadata/config/image.version'.format(instance_name)))
-            self._set_data_entry(instance_name, 'profile', self._get_data_entry(
-                'instances/{0}/instances/metadata/profiles'.format(instance_name)))
-            self._set_data_entry(instance_name, 'location', self._get_data_entry(
-                'instances/{0}/instances/metadata/location'.format(instance_name)))
-            self._set_data_entry(instance_name, 'state', self._get_data_entry(
-                'instances/{0}/instances/metadata/config/volatile.last_state.power'.format(instance_name)))
-            self._set_data_entry(instance_name, 'type', self._get_data_entry(
-                'instances/{0}/instances/metadata/type'.format(instance_name)))
-            self._set_data_entry(instance_name, 'network_interfaces', self.extract_network_information_from_instance_config(instance_name))
-            self._set_data_entry(instance_name, 'preferred_interface', self.get_prefered_instance_network_interface(instance_name))
-            self._set_data_entry(instance_name, 'vlan_ids', self.get_instance_vlans(instance_name))
+        for container_name in self.data['containers']:
+            self._set_data_entry(container_name, 'os', self._get_data_entry(
+                'containers/{0}/containers/metadata/config/image.os'.format(container_name)))
+            self._set_data_entry(container_name, 'release', self._get_data_entry(
+                'containers/{0}/containers/metadata/config/image.release'.format(container_name)))
+            self._set_data_entry(container_name, 'version', self._get_data_entry(
+                'containers/{0}/containers/metadata/config/image.version'.format(container_name)))
+            self._set_data_entry(container_name, 'profile', self._get_data_entry(
+                'containers/{0}/containers/metadata/profiles'.format(container_name)))
+            self._set_data_entry(container_name, 'location', self._get_data_entry(
+                'containers/{0}/containers/metadata/location'.format(container_name)))
+            self._set_data_entry(container_name, 'state', self._get_data_entry(
+                'containers/{0}/containers/metadata/config/volatile.last_state.power'.format(container_name)))
+            self._set_data_entry(container_name, 'network_interfaces', self.extract_network_information_from_container_config(container_name))
+            self._set_data_entry(container_name, 'preferred_interface', self.get_prefered_container_network_interface(container_name))
+            self._set_data_entry(container_name, 'vlan_ids', self.get_container_vlans(container_name))
 
-    def build_inventory_network(self, instance_name):
-        """Add the network interfaces of the instance to the inventory
+    def build_inventory_network(self, container_name):
+        """Add the network interfaces of the container to the inventory
 
         Logic:
-            - if the instance have no interface -> 'ansible_connection: local'
-            - get preferred_interface & prefered_instance_network_family -> 'ansible_connection: ssh' & 'ansible_host: <IP>'
-            - first Interface from: network_interfaces prefered_instance_network_family -> 'ansible_connection: ssh' & 'ansible_host: <IP>'
+            - if the container have no interface -> 'ansible_connection: local'
+            - get preferred_interface & prefered_container_network_family -> 'ansible_connection: ssh' & 'ansible_host: <IP>'
+            - first Interface from: network_interfaces prefered_container_network_family -> 'ansible_connection: ssh' & 'ansible_host: <IP>'
 
         Args:
-            str(instance_name): name of instance
+            str(container_name): name of container
         Kwargs:
             None
         Raises:
@@ -600,45 +563,45 @@ class InventoryModule(BaseInventoryPlugin):
         Returns:
             None"""
 
-        def interface_selection(instance_name):
-            """Select instance Interface for inventory
+        def interface_selection(container_name):
+            """Select container Interface for inventory
 
             Logic:
-                - get preferred_interface & prefered_instance_network_family -> str(IP)
-                - first Interface from: network_interfaces prefered_instance_network_family -> str(IP)
+                - get preferred_interface & prefered_container_network_family -> str(IP)
+                - first Interface from: network_interfaces prefered_container_network_family -> str(IP)
 
             Args:
-                str(instance_name): name of instance
+                str(container_name): name of container
             Kwargs:
                 None
             Raises:
                 None
             Returns:
                 dict(interface_name: ip)"""
-            prefered_interface = self._get_data_entry('inventory/{0}/preferred_interface'.format(instance_name))  # name or None
-            prefered_instance_network_family = self.prefered_instance_network_family
+            prefered_interface = self._get_data_entry('inventory/{0}/preferred_interface'.format(container_name))  # name or None
+            prefered_container_network_family = self.prefered_container_network_family
 
             ip_address = ''
             if prefered_interface:
-                interface = self._get_data_entry('inventory/{0}/network_interfaces/{1}'.format(instance_name, prefered_interface))
+                interface = self._get_data_entry('inventory/{0}/network_interfaces/{1}'.format(container_name, prefered_interface))
                 for config in interface:
-                    if config['family'] == prefered_instance_network_family:
+                    if config['family'] == prefered_container_network_family:
                         ip_address = config['address']
                         break
             else:
-                interfaces = self._get_data_entry('inventory/{0}/network_interfaces'.format(instance_name))
-                for interface in interfaces.values():
-                    for config in interface:
-                        if config['family'] == prefered_instance_network_family:
-                            ip_address = config['address']
-                            break
+                interface = self._get_data_entry('inventory/{0}/network_interfaces'.format(container_name))
+                for config in interface:
+                    if config['family'] == prefered_container_network_family:
+                        ip_address = config['address']
+                        break
             return ip_address
 
-        if self._get_data_entry('inventory/{0}/network_interfaces'.format(instance_name)):  # instance have network interfaces
-            self.inventory.set_variable(instance_name, 'ansible_connection', 'ssh')
-            self.inventory.set_variable(instance_name, 'ansible_host', interface_selection(instance_name))
+        if self._get_data_entry('inventory/{0}/network_interfaces'.format(container_name)):  # container have network interfaces
+            if self._get_data_entry('inventory/{0}/preferred_interface'.format(container_name)):  # container have a preferred interface
+                self.inventory.set_variable(container_name, 'ansible_connection', 'ssh')
+                self.inventory.set_variable(container_name, 'ansible_host', interface_selection(container_name))
         else:
-            self.inventory.set_variable(instance_name, 'ansible_connection', 'local')
+            self.inventory.set_variable(container_name, 'ansible_connection', 'local')
 
     def build_inventory_hosts(self):
         """Build host-part dynamic inventory
@@ -654,37 +617,29 @@ class InventoryModule(BaseInventoryPlugin):
             None
         Returns:
             None"""
-        for instance_name in self.data['inventory']:
-            instance_state = str(self._get_data_entry('inventory/{0}/state'.format(instance_name)) or "STOPPED").lower()
-
-            # Only consider instances that match the "state" filter, if self.state is not None
+        for container_name in self.data['inventory']:
+            # Only consider containers that match the "state" filter, if self.state is not None
             if self.filter:
-                if self.filter.lower() != instance_state:
+                if self.filter.lower() != self._get_data_entry('inventory/{0}/state'.format(container_name)).lower():
                     continue
-            # add instance
-            self.inventory.add_host(instance_name)
+            # add container
+            self.inventory.add_host(container_name)
             # add network informations
-            self.build_inventory_network(instance_name)
+            self.build_inventory_network(container_name)
             # add os
-            v = self._get_data_entry('inventory/{0}/os'.format(instance_name))
-            if v:
-                self.inventory.set_variable(instance_name, 'ansible_lxd_os', v.lower())
+            self.inventory.set_variable(container_name, 'ansible_lxd_os', self._get_data_entry('inventory/{0}/os'.format(container_name)).lower())
             # add release
-            v = self._get_data_entry('inventory/{0}/release'.format(instance_name))
-            if v:
-                self.inventory.set_variable(instance_name, 'ansible_lxd_release', v.lower())
+            self.inventory.set_variable(container_name, 'ansible_lxd_release', self._get_data_entry('inventory/{0}/release'.format(container_name)).lower())
             # add profile
-            self.inventory.set_variable(instance_name, 'ansible_lxd_profile', self._get_data_entry('inventory/{0}/profile'.format(instance_name)))
+            self.inventory.set_variable(container_name, 'ansible_lxd_profile', self._get_data_entry('inventory/{0}/profile'.format(container_name)))
             # add state
-            self.inventory.set_variable(instance_name, 'ansible_lxd_state', instance_state)
-            # add type
-            self.inventory.set_variable(instance_name, 'ansible_lxd_type', self._get_data_entry('inventory/{0}/type'.format(instance_name)))
+            self.inventory.set_variable(container_name, 'ansible_lxd_state', self._get_data_entry('inventory/{0}/state'.format(container_name)).lower())
             # add location information
-            if self._get_data_entry('inventory/{0}/location'.format(instance_name)) != "none":  # wrong type by lxd 'none' != 'None'
-                self.inventory.set_variable(instance_name, 'ansible_lxd_location', self._get_data_entry('inventory/{0}/location'.format(instance_name)))
+            if self._get_data_entry('inventory/{0}/location'.format(container_name)) != "none":  # wrong type by lxd 'none' != 'None'
+                self.inventory.set_variable(container_name, 'ansible_lxd_location', self._get_data_entry('inventory/{0}/location'.format(container_name)))
             # add VLAN_ID information
-            if self._get_data_entry('inventory/{0}/vlan_ids'.format(instance_name)):
-                self.inventory.set_variable(instance_name, 'ansible_lxd_vlan_ids', self._get_data_entry('inventory/{0}/vlan_ids'.format(instance_name)))
+            if self._get_data_entry('inventory/{0}/vlan_ids'.format(container_name)):
+                self.inventory.set_variable(container_name, 'ansible_lxd_vlan_ids', self._get_data_entry('inventory/{0}/vlan_ids'.format(container_name)))
 
     def build_inventory_groups_location(self, group_name):
         """create group by attribute: location
@@ -701,9 +656,9 @@ class InventoryModule(BaseInventoryPlugin):
         if group_name not in self.inventory.groups:
             self.inventory.add_group(group_name)
 
-        for instance_name in self.inventory.hosts:
-            if 'ansible_lxd_location' in self.inventory.get_host(instance_name).get_vars():
-                self.inventory.add_child(group_name, instance_name)
+        for container_name in self.inventory.hosts:
+            if 'ansible_lxd_location' in self.inventory.get_host(container_name).get_vars():
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups_pattern(self, group_name):
         """create group by name pattern
@@ -722,10 +677,10 @@ class InventoryModule(BaseInventoryPlugin):
 
         regex_pattern = self.groupby[group_name].get('attribute')
 
-        for instance_name in self.inventory.hosts:
-            result = re.search(regex_pattern, instance_name)
+        for container_name in self.inventory.hosts:
+            result = re.search(regex_pattern, container_name)
             if result:
-                self.inventory.add_child(group_name, instance_name)
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups_network_range(self, group_name):
         """check if IP is in network-class
@@ -748,14 +703,14 @@ class InventoryModule(BaseInventoryPlugin):
             raise AnsibleParserError(
                 'Error while parsing network range {0}: {1}'.format(self.groupby[group_name].get('attribute'), to_native(err)))
 
-        for instance_name in self.inventory.hosts:
-            if self.data['inventory'][instance_name].get('network_interfaces') is not None:
-                for interface in self.data['inventory'][instance_name].get('network_interfaces'):
-                    for interface_family in self.data['inventory'][instance_name].get('network_interfaces')[interface]:
+        for container_name in self.inventory.hosts:
+            if self.data['inventory'][container_name].get('network_interfaces') is not None:
+                for interface in self.data['inventory'][container_name].get('network_interfaces'):
+                    for interface_family in self.data['inventory'][container_name].get('network_interfaces')[interface]:
                         try:
                             address = ipaddress.ip_address(to_text(interface_family['address']))
                             if address.version == network.version and address in network:
-                                self.inventory.add_child(group_name, instance_name)
+                                self.inventory.add_child(group_name, container_name)
                         except ValueError:
                             # Ignore invalid IP addresses returned by lxd
                             pass
@@ -766,7 +721,7 @@ class InventoryModule(BaseInventoryPlugin):
         Args:
             str(group_name): Group name
         Kwargs:
-            None
+            Noneself.data['inventory'][container_name][interface]
         Raises:
             None
         Returns:
@@ -775,12 +730,12 @@ class InventoryModule(BaseInventoryPlugin):
         if group_name not in self.inventory.groups:
             self.inventory.add_group(group_name)
 
-        gen_instances = [
-            instance_name for instance_name in self.inventory.hosts
-            if 'ansible_lxd_os' in self.inventory.get_host(instance_name).get_vars()]
-        for instance_name in gen_instances:
-            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(instance_name).get_vars().get('ansible_lxd_os'):
-                self.inventory.add_child(group_name, instance_name)
+        gen_containers = [
+            container_name for container_name in self.inventory.hosts
+            if 'ansible_lxd_os' in self.inventory.get_host(container_name).get_vars()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(container_name).get_vars().get('ansible_lxd_os'):
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups_release(self, group_name):
         """create group by attribute: release
@@ -797,12 +752,12 @@ class InventoryModule(BaseInventoryPlugin):
         if group_name not in self.inventory.groups:
             self.inventory.add_group(group_name)
 
-        gen_instances = [
-            instance_name for instance_name in self.inventory.hosts
-            if 'ansible_lxd_release' in self.inventory.get_host(instance_name).get_vars()]
-        for instance_name in gen_instances:
-            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(instance_name).get_vars().get('ansible_lxd_release'):
-                self.inventory.add_child(group_name, instance_name)
+        gen_containers = [
+            container_name for container_name in self.inventory.hosts
+            if 'ansible_lxd_release' in self.inventory.get_host(container_name).get_vars()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(container_name).get_vars().get('ansible_lxd_release'):
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups_profile(self, group_name):
         """create group by attribute: profile
@@ -819,12 +774,12 @@ class InventoryModule(BaseInventoryPlugin):
         if group_name not in self.inventory.groups:
             self.inventory.add_group(group_name)
 
-        gen_instances = [
-            instance_name for instance_name in self.inventory.hosts.keys()
-            if 'ansible_lxd_profile' in self.inventory.get_host(instance_name).get_vars().keys()]
-        for instance_name in gen_instances:
-            if self.groupby[group_name].get('attribute').lower() in self.inventory.get_host(instance_name).get_vars().get('ansible_lxd_profile'):
-                self.inventory.add_child(group_name, instance_name)
+        gen_containers = [
+            container_name for container_name in self.inventory.hosts.keys()
+            if 'ansible_lxd_profile' in self.inventory.get_host(container_name).get_vars().keys()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() in self.inventory.get_host(container_name).get_vars().get('ansible_lxd_profile'):
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups_vlanid(self, group_name):
         """create group by attribute: vlanid
@@ -841,34 +796,12 @@ class InventoryModule(BaseInventoryPlugin):
         if group_name not in self.inventory.groups:
             self.inventory.add_group(group_name)
 
-        gen_instances = [
-            instance_name for instance_name in self.inventory.hosts.keys()
-            if 'ansible_lxd_vlan_ids' in self.inventory.get_host(instance_name).get_vars().keys()]
-        for instance_name in gen_instances:
-            if self.groupby[group_name].get('attribute') in self.inventory.get_host(instance_name).get_vars().get('ansible_lxd_vlan_ids').values():
-                self.inventory.add_child(group_name, instance_name)
-
-    def build_inventory_groups_type(self, group_name):
-        """create group by attribute: type
-
-        Args:
-            str(group_name): Group name
-        Kwargs:
-            None
-        Raises:
-            None
-        Returns:
-            None"""
-        # maybe we just want to expand one group
-        if group_name not in self.inventory.groups:
-            self.inventory.add_group(group_name)
-
-        gen_instances = [
-            instance_name for instance_name in self.inventory.hosts
-            if 'ansible_lxd_type' in self.inventory.get_host(instance_name).get_vars()]
-        for instance_name in gen_instances:
-            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(instance_name).get_vars().get('ansible_lxd_type'):
-                self.inventory.add_child(group_name, instance_name)
+        gen_containers = [
+            container_name for container_name in self.inventory.hosts.keys()
+            if 'ansible_lxd_vlan_ids' in self.inventory.get_host(container_name).get_vars().keys()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute') in self.inventory.get_host(container_name).get_vars().get('ansible_lxd_vlan_ids').values():
+                self.inventory.add_child(group_name, container_name)
 
     def build_inventory_groups(self):
         """Build group-part dynamic inventory
@@ -897,7 +830,6 @@ class InventoryModule(BaseInventoryPlugin):
                 * 'release'
                 * 'profile'
                 * 'vlanid'
-                * 'type'
 
             Args:
                 str(group_name): Group name
@@ -923,8 +855,6 @@ class InventoryModule(BaseInventoryPlugin):
                 self.build_inventory_groups_profile(group_name)
             elif self.groupby[group_name].get('type') == 'vlanid':
                 self.build_inventory_groups_vlanid(group_name)
-            elif self.groupby[group_name].get('type') == 'type':
-                self.build_inventory_groups_type(group_name)
             else:
                 raise AnsibleParserError('Unknown group type: {0}'.format(to_native(group_name)))
 
@@ -951,30 +881,10 @@ class InventoryModule(BaseInventoryPlugin):
         self.build_inventory_hosts()
         self.build_inventory_groups()
 
-    def cleandata(self):
-        """Clean the dynamic inventory
-
-        The first version of the inventory only supported container.
-        This will change in the future.
-        The following function cleans up the data and remove the all items with the wrong type.
-
-        Args:
-            None
-        Kwargs:
-            None
-        Raises:
-            None
-        Returns:
-            None"""
-        iter_keys = list(self.data['instances'].keys())
-        for instance_name in iter_keys:
-            if self._get_data_entry('instances/{0}/instances/metadata/type'.format(instance_name)) != self.type_filter:
-                del self.data['instances'][instance_name]
-
     def _populate(self):
         """Return the hosts and groups
 
-        Returns the processed instance configurations from the lxd import
+        Returns the processed container configurations from the lxd import
 
         Args:
             None
@@ -987,16 +897,10 @@ class InventoryModule(BaseInventoryPlugin):
 
         if len(self.data) == 0:  # If no data is injected by unittests open socket
             self.socket = self._connect_to_socket()
-            self.get_instance_data(self._get_instances())
+            self.get_container_data(self._get_containers())
             self.get_network_data(self._get_networks())
 
-        # The first version of the inventory only supported containers.
-        # This will change in the future.
-        # The following function cleans up the data.
-        if self.type_filter != 'both':
-            self.cleandata()
-
-        self.extract_information_from_instance_configs()
+        self.extract_information_from_container_configs()
 
         # self.display.vvv(self.save_json_data([os.path.abspath(__file__)]))
 
@@ -1020,10 +924,6 @@ class InventoryModule(BaseInventoryPlugin):
             AnsibleParserError
         Returns:
             None"""
-        if IPADDRESS_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('another_library must be installed to use this plugin'),
-                IPADDRESS_IMPORT_ERROR)
 
         super(InventoryModule, self).parse(inventory, loader, path, cache=False)
         # Read the inventory YAML file
@@ -1035,9 +935,8 @@ class InventoryModule(BaseInventoryPlugin):
             self.data = {}  # store for inventory-data
             self.groupby = self.get_option('groupby')
             self.plugin = self.get_option('plugin')
-            self.prefered_instance_network_family = self.get_option('prefered_instance_network_family')
-            self.prefered_instance_network_interface = self.get_option('prefered_instance_network_interface')
-            self.type_filter = self.get_option('type_filter')
+            self.prefered_container_network_family = self.get_option('prefered_container_network_family')
+            self.prefered_container_network_interface = self.get_option('prefered_container_network_interface')
             if self.get_option('state').lower() == 'none':  # none in config is str()
                 self.filter = None
             else:

plugins/inventory/nmap.py

@@ -21,18 +21,12 @@ DOCUMENTATION = '''
             description: token that ensures this is a source file for the 'nmap' plugin.
             required: True
             choices: ['nmap', 'community.general.nmap']
-        sudo:
-            description: Set to C(true) to execute a C(sudo nmap) plugin scan.
-            version_added: 4.8.0
-            default: false
-            type: boolean
         address:
             description: Network IP or range of IPs to scan, you can use a simple range (10.2.2.15-25) or CIDR notation.
             required: True
         exclude:
             description: list of addresses to exclude
             type: list
-            elements: string
         ports:
             description: Enable/disable scanning for open ports
             type: boolean
@@ -54,13 +48,6 @@ EXAMPLES = '''
 plugin: community.general.nmap
 strict: False
 address: 192.168.0.0/24
-
-
-# a sudo nmap scan to fully use nmap scan power.
-plugin: community.general.nmap
-sudo: true
-strict: False
-address: 192.168.0.0/24
 '''
 
 import os
@@ -147,10 +134,6 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         if not user_cache_setting or cache_needs_update:
             # setup command
             cmd = [self._nmap]
-
-            if self._options['sudo']:
-                cmd.insert(0, 'sudo')
-
             if not self._options['ports']:
                 cmd.append('-sP')
 

plugins/inventory/online.py

@@ -8,7 +8,7 @@ __metaclass__ = type
 DOCUMENTATION = r'''
     name: online
     author:
-      - Remy Leone (@remyleone)
+      - Remy Leone (@sieben)
     short_description: Scaleway (previously Online SAS or Online.net) inventory source
     description:
         - Get inventory hosts from Scaleway (previously Online SAS or Online.net).
@@ -28,7 +28,6 @@ DOCUMENTATION = r'''
         hostnames:
             description: List of preference about what to use as an hostname.
             type: list
-            elements: string
             default:
                 - public_ipv4
             choices:
@@ -38,7 +37,6 @@ DOCUMENTATION = r'''
         groups:
             description: List of groups.
             type: list
-            elements: string
             choices:
                 - location
                 - offer
@@ -237,7 +235,7 @@ class InventoryModule(BaseInventoryPlugin):
 
         self.headers = {
             'Authorization': "Bearer %s" % token,
-            'User-Agent': "ansible %s Python %s" % (ansible_version, python_version.split(' ', 1)[0]),
+            'User-Agent': "ansible %s Python %s" % (ansible_version, python_version.split(' ')[0]),
             'Content-type': 'application/json'
         }
 

plugins/inventory/opennebula.py

@@ -1,251 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2020, FELDSAM s.r.o. - FeldHost™ <support@feldhost.cz>
-# 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: opennebula
-    author:
-        - Kristian Feldsam (@feldsam)
-    short_description: OpenNebula inventory source
-    version_added: "3.8.0"
-    extends_documentation_fragment:
-        - constructed
-    description:
-        - Get inventory hosts from OpenNebula cloud.
-        - Uses an YAML configuration file ending with either I(opennebula.yml) or I(opennebula.yaml)
-          to set parameter values.
-        - Uses I(api_authfile), C(~/.one/one_auth), or C(ONE_AUTH) pointing to a OpenNebula credentials file.
-    options:
-        plugin:
-            description: Token that ensures this is a source file for the 'opennebula' plugin.
-            type: string
-            required: true
-            choices: [ community.general.opennebula ]
-        api_url:
-            description:
-              - URL of the OpenNebula RPC server.
-              - It is recommended to use HTTPS so that the username/password are not
-                transferred over the network unencrypted.
-              - If not set then the value of the C(ONE_URL) environment variable is used.
-            env:
-              - name: ONE_URL
-            required: True
-            type: string
-        api_username:
-            description:
-              - Name of the user to login into the OpenNebula RPC server. If not set
-                then the value of the C(ONE_USERNAME) environment variable is used.
-            env:
-              - name: ONE_USERNAME
-            type: string
-        api_password:
-            description:
-              - Password or a token of the user to login into OpenNebula RPC server.
-              - If not set, the value of the C(ONE_PASSWORD) environment variable is used.
-            env:
-              - name: ONE_PASSWORD
-            required: False
-            type: string
-        api_authfile:
-            description:
-              - If both I(api_username) or I(api_password) are not set, then it will try
-                authenticate with ONE auth file. Default path is C(~/.one/one_auth).
-              - Set environment variable C(ONE_AUTH) to override this path.
-            env:
-              - name: ONE_AUTH
-            required: False
-            type: string
-        hostname:
-            description: Field to match the hostname. Note C(v4_first_ip) corresponds to the first IPv4 found on VM.
-            type: string
-            default: v4_first_ip
-            choices:
-                - v4_first_ip
-                - v6_first_ip
-                - name
-        filter_by_label:
-            description: Only return servers filtered by this label.
-            type: string
-        group_by_labels:
-            description: Create host groups by vm labels
-            type: bool
-            default: True
-'''
-
-EXAMPLES = r'''
-# inventory_opennebula.yml file in YAML format
-# Example command line: ansible-inventory --list -i inventory_opennebula.yml
-
-# Pass a label filter to the API
-plugin: community.general.opennebula
-api_url: https://opennebula:2633/RPC2
-filter_by_label: Cache
-'''
-
-try:
-    import pyone
-
-    HAS_PYONE = True
-except ImportError:
-    HAS_PYONE = False
-
-from ansible.errors import AnsibleError
-from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
-from ansible.module_utils.common.text.converters import to_native
-
-from collections import namedtuple
-import os
-
-
-class InventoryModule(BaseInventoryPlugin, Constructable):
-    NAME = 'community.general.opennebula'
-
-    def verify_file(self, path):
-        valid = False
-        if super(InventoryModule, self).verify_file(path):
-            if path.endswith(('opennebula.yaml', 'opennebula.yml')):
-                valid = True
-        return valid
-
-    def _get_connection_info(self):
-        url = self.get_option('api_url')
-        username = self.get_option('api_username')
-        password = self.get_option('api_password')
-        authfile = self.get_option('api_authfile')
-
-        if not username and not password:
-            if authfile is None:
-                authfile = os.path.join(os.environ.get("HOME"), ".one", "one_auth")
-            try:
-                with open(authfile, "r") as fp:
-                    authstring = fp.read().rstrip()
-                username, password = authstring.split(":")
-            except (OSError, IOError):
-                raise AnsibleError("Could not find or read ONE_AUTH file at '{e}'".format(e=authfile))
-            except Exception:
-                raise AnsibleError("Error occurs when reading ONE_AUTH file at '{e}'".format(e=authfile))
-
-        auth_params = namedtuple('auth', ('url', 'username', 'password'))
-
-        return auth_params(url=url, username=username, password=password)
-
-    def _get_vm_ipv4(self, vm):
-        nic = vm.TEMPLATE.get('NIC')
-
-        if isinstance(nic, dict):
-            nic = [nic]
-
-        for net in nic:
-            return net['IP']
-
-        return False
-
-    def _get_vm_ipv6(self, vm):
-        nic = vm.TEMPLATE.get('NIC')
-
-        if isinstance(nic, dict):
-            nic = [nic]
-
-        for net in nic:
-            if net.get('IP6_GLOBAL'):
-                return net['IP6_GLOBAL']
-
-        return False
-
-    def _get_vm_pool(self):
-        auth = self._get_connection_info()
-
-        if not (auth.username and auth.password):
-            raise AnsibleError('API Credentials missing. Check OpenNebula inventory file.')
-        else:
-            one_client = pyone.OneServer(auth.url, session=auth.username + ':' + auth.password)
-
-        # get hosts (VMs)
-        try:
-            vm_pool = one_client.vmpool.infoextended(-2, -1, -1, 3)
-        except Exception as e:
-            raise AnsibleError("Something happened during XML-RPC call: {e}".format(e=to_native(e)))
-
-        return vm_pool
-
-    def _retrieve_servers(self, label_filter=None):
-        vm_pool = self._get_vm_pool()
-
-        result = []
-
-        # iterate over hosts
-        for vm in vm_pool.VM:
-            server = vm.USER_TEMPLATE
-
-            labels = []
-            if vm.USER_TEMPLATE.get('LABELS'):
-                labels = [s for s in vm.USER_TEMPLATE.get('LABELS') if s == ',' or s == '-' or s.isalnum() or s.isspace()]
-                labels = ''.join(labels)
-                labels = labels.replace(' ', '_')
-                labels = labels.replace('-', '_')
-                labels = labels.split(',')
-
-            # filter by label
-            if label_filter is not None:
-                if label_filter not in labels:
-                    continue
-
-            server['name'] = vm.NAME
-            server['LABELS'] = labels
-            server['v4_first_ip'] = self._get_vm_ipv4(vm)
-            server['v6_first_ip'] = self._get_vm_ipv6(vm)
-
-            result.append(server)
-
-        return result
-
-    def _populate(self):
-        hostname_preference = self.get_option('hostname')
-        group_by_labels = self.get_option('group_by_labels')
-        strict = self.get_option('strict')
-
-        # Add a top group 'one'
-        self.inventory.add_group(group='all')
-
-        filter_by_label = self.get_option('filter_by_label')
-        servers = self._retrieve_servers(filter_by_label)
-        for server in servers:
-            hostname = server['name']
-            # check for labels
-            if group_by_labels and server['LABELS']:
-                for label in server['LABELS']:
-                    self.inventory.add_group(group=label)
-                    self.inventory.add_host(host=hostname, group=label)
-
-            self.inventory.add_host(host=hostname, group='all')
-
-            for attribute, value in server.items():
-                self.inventory.set_variable(hostname, attribute, value)
-
-            if hostname_preference != 'name':
-                self.inventory.set_variable(hostname, 'ansible_host', server[hostname_preference])
-
-            if server.get('SSH_PORT'):
-                self.inventory.set_variable(hostname, 'ansible_port', server['SSH_PORT'])
-
-            # handle construcable implementation: get composed variables if any
-            self._set_composite_vars(self.get_option('compose'), server, hostname, strict=strict)
-
-            # groups based on jinja conditionals get added to specific groups
-            self._add_host_to_composed_groups(self.get_option('groups'), server, hostname, strict=strict)
-
-            # groups based on variables associated with them in the inventory
-            self._add_host_to_keyed_groups(self.get_option('keyed_groups'), server, hostname, strict=strict)
-
-    def parse(self, inventory, loader, path, cache=True):
-        if not HAS_PYONE:
-            raise AnsibleError('OpenNebula Inventory plugin requires pyone to work!')
-
-        super(InventoryModule, self).parse(inventory, loader, path)
-        self._read_config_data(path=path)
-
-        self._populate()