Release 4.3.0

* feat(plugins/keycloak): add get_realm_info_by_id as util function

* feat(plugins/keycloak): add keycloak_realm_info module

* chore: add maintainer

* feat(plugins/keycloak): remove supports_check_mode

* feat(plugins/keycloak): add supports_check_mode back

* Update plugins/modules/identity/keycloak/keycloak_realm_info.py

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

* Update plugins/modules/identity/keycloak/keycloak_realm_info.py

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

* docs(plugins/keycloak): cleanup docs

* feat(plugins/keycloak): add unit test

* Update plugins/modules/identity/keycloak/keycloak_realm_info.py

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

* Update plugins/modules/identity/keycloak/keycloak_realm_info.py

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

* feat(plugins/keycloak): remove end_state

* docs(plugins/keycloak): complete sentences

* docs(plugins/keycloak): use dict for return type

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

Co-authored-by: Fynnnnn <fynn.cfchen@gmail.com>

.azure-pipelines/azure-pipelines.yml

@@ -24,14 +24,15 @@ schedules:
     always: true
     branches:
       include:
-        - stable-5
+        - stable-3
         - stable-4
   - cron: 0 11 * * 0
     displayName: Weekly (old stable branches)
     always: true
     branches:
       include:
-        - stable-3
+        - stable-1
+        - stable-2
 
 variables:
   - name: checkoutPath
@@ -48,7 +49,7 @@ variables:
 resources:
   containers:
     - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:3.0.0
+      image: quay.io/ansible/azure-pipelines-test-container:1.9.0
 
 pool: Standard
 
@@ -68,19 +69,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: []
@@ -107,6 +95,32 @@ stages:
             - test: 2
             - test: 3
             - test: 4
+  - stage: Sanity_2_10
+    displayName: Sanity 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.10/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+  - stage: Sanity_2_9
+    displayName: Sanity 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.9/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
 ### Units
   - stage: Units_devel
     displayName: Units devel
@@ -124,19 +138,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: []
@@ -147,8 +148,12 @@ stages:
           testFormat: 2.12/units/{0}/1
           targets:
             - test: 2.6
+            - test: 2.7
             - test: 3.5
+            - test: 3.6
+            - test: 3.7
             - test: 3.8
+            - test: '3.10'
   - stage: Units_2_11
     displayName: Units 2.11
     dependsOn: []
@@ -162,7 +167,35 @@ stages:
             - 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
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.10/units/{0}/1
+          targets:
+            - test: 2.7
+            - test: 3.6
+  - stage: Units_2_9
+    displayName: Units 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          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
@@ -173,32 +206,16 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: macOS 12.0
-              test: macos/12.0
+            - name: macOS 11.1
+              test: macos/11.1
             - name: RHEL 7.9
               test: rhel/7.9
-            - name: RHEL 9.0
-              test: rhel/9.0
-            - name: FreeBSD 12.3
-              test: freebsd/12.3
-            - name: FreeBSD 13.1
-              test: freebsd/13.1
-          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
+            - name: FreeBSD 12.2
+              test: freebsd/12.2
+            - name: FreeBSD 13.0
+              test: freebsd/13.0
           groups:
             - 1
             - 2
@@ -220,7 +237,6 @@ stages:
           groups:
             - 1
             - 2
-            - 3
   - stage: Remote_2_11
     displayName: Remote 2.11
     dependsOn: []
@@ -233,12 +249,43 @@ stages:
               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
+  - stage: Remote_2_10
+    displayName: Remote 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.10/{0}
+          targets:
+            - name: OS X 10.11
+              test: osx/10.11
+            - name: macOS 10.15
+              test: macos/10.15
+          groups:
+            - 1
+            - 2
+  - stage: Remote_2_9
+    displayName: Remote 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.9/{0}
+          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
           groups:
             - 1
             - 2
-            - 3
 
 ### Docker
   - stage: Docker_devel
@@ -251,36 +298,18 @@ stages:
           targets:
             - name: CentOS 7
               test: centos7
-            - name: Fedora 35
-              test: fedora35
-            - name: Fedora 36
-              test: fedora36
-            - name: openSUSE 15
-              test: opensuse15
-            - name: Ubuntu 20.04
-              test: ubuntu2004
-            - name: Ubuntu 22.04
-              test: ubuntu2204
-            - 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 34
+              test: fedora34
             - name: Fedora 35
               test: fedora35
             - name: openSUSE 15 py2
               test: opensuse15py2
-            - name: Alpine 3
-              test: alpine3
+            - name: openSUSE 15 py3
+              test: opensuse15
+            - name: Ubuntu 18.04
+              test: ubuntu1804
+            - name: Ubuntu 20.04
+              test: ubuntu2004
           groups:
             - 1
             - 2
@@ -295,10 +324,14 @@ stages:
           targets:
             - name: CentOS 6
               test: centos6
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 34
               test: fedora34
-            - name: Ubuntu 18.04
-              test: ubuntu1804
+            - name: openSUSE 15 py3
+              test: opensuse15
+            - name: Ubuntu 20.04
+              test: ubuntu2004
           groups:
             - 1
             - 2
@@ -311,34 +344,43 @@ stages:
         parameters:
           testFormat: 2.11/linux/{0}
           targets:
-            - name: Fedora 32
-              test: fedora32
+            - name: CentOS 7
+              test: centos7
             - name: Fedora 33
               test: fedora33
-            - name: Alpine 3
-              test: alpine3
+            - name: openSUSE 15 py2
+              test: opensuse15py2
           groups:
-            - 1
             - 2
             - 3
-
-### Community Docker
-  - stage: Docker_community_devel
-    displayName: Docker (community images) devel
+  - stage: Docker_2_10
+    displayName: Docker 2.10
     dependsOn: []
     jobs:
       - template: templates/matrix.yml
         parameters:
-          testFormat: devel/linux-community/{0}
+          testFormat: 2.10/linux/{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
+            - name: Fedora 32
+              test: fedora32
+            - name: Ubuntu 16.04
+              test: ubuntu1604
+          groups:
+            - 2
+            - 3
+  - stage: Docker_2_9
+    displayName: Docker 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.9/linux/{0}
+          targets:
+            - name: Fedora 31
+              test: fedora31
+            - name: openSUSE 15 py3
+              test: opensuse15
           groups:
-            - 1
             - 2
             - 3
 
@@ -353,16 +395,6 @@ stages:
           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
@@ -383,32 +415,54 @@ 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
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.10/cloud/{0}/1
+          targets:
             - test: 3.5
-
+  - stage: Cloud_2_9
+    displayName: Cloud 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.9/cloud/{0}/1
+          targets:
+            - test: 2.7
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
       - Sanity_devel
+      - 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

.github/BOTMETA.yml

@@ -126,42 +126,22 @@ files:
     maintainers: giner
   $filters/from_csv.py:
     maintainers: Ajpantuso
-  $filters/groupby_as_dict.py:
+  $filters/groupby:
     maintainers: felixfontein
-  $filters/hashids.py:
-    maintainers: Ajpantuso
-  $filters/hashids_decode.yml:
-    maintainers: Ajpantuso
-  $filters/hashids_encode.yml:
+  $filters/hashids:
     maintainers: Ajpantuso
   $filters/jc.py:
     maintainers: kellyjonbrazil
   $filters/json_query.py: {}
-  $filters/lists_mergeby.py:
+  $filters/list.py:
     maintainers: vbotka
+  $filters/path_join_shim.py:
+    maintainers: felixfontein
   $filters/random_mac.py: {}
   $filters/time.py:
     maintainers: resmo
   $filters/unicode_normalize.py:
     maintainers: Ajpantuso
-  $filters/to_days.yml:
-    maintainers: resmo
-  $filters/to_hours.yml:
-    maintainers: resmo
-  $filters/to_milliseconds.yml:
-    maintainers: resmo
-  $filters/to_minutes.yml:
-    maintainers: resmo
-  $filters/to_months.yml:
-    maintainers: resmo
-  $filters/to_seconds.yml:
-    maintainers: resmo
-  $filters/to_time_unit.yml:
-    maintainers: resmo
-  $filters/to_weeks.yml:
-    maintainers: resmo
-  $filters/to_years.yml:
-    maintainers: resmo
   $filters/version_sort.py:
     maintainers: ericzolf
   $inventories/:
@@ -254,9 +234,6 @@ files:
     maintainers: amigus endlesstrax
   $module_utils/:
     labels: module_utils
-  $module_utils/gconftool2.py:
-    maintainers: russoz
-    labels: gconftool2
   $module_utils/gitlab.py:
     notify: jlozadad
     maintainers: $team_gitlab
@@ -283,8 +260,6 @@ files:
   $module_utils/module_helper.py:
     maintainers: russoz
     labels: module_helper
-  $module_utils/net_tools/pritunl/:
-    maintainers: Lowess
   $module_utils/oracle/oci_utils.py:
     maintainers: $team_oracle
     labels: cloud
@@ -307,9 +282,6 @@ files:
   $module_utils/xenserver.py:
     maintainers: bvitnik
     labels: xenserver
-  $module_utils/xfconf.py:
-    maintainers: russoz
-    labels: xfconf
   $modules/cloud/alicloud/:
     maintainers: xiaozhu36
   $modules/cloud/atomic/atomic_container.py:
@@ -338,8 +310,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:
@@ -440,8 +410,6 @@ files:
     maintainers: claco
   $modules/cloud/scaleway/:
     maintainers: $team_scaleway
-  $modules/cloud/scaleway/scaleway_compute_private_network.py:
-    maintainers: pastral
   $modules/cloud/scaleway/scaleway_database_backup.py:
     maintainers: guillaume_ro_fr
   $modules/cloud/scaleway/scaleway_image_info.py:
@@ -450,8 +418,6 @@ files:
     maintainers: Spredzy
   $modules/cloud/scaleway/scaleway_organization_info.py:
     maintainers: Spredzy
-  $modules/cloud/scaleway/scaleway_private_network.py:
-    maintainers: pastral
   $modules/cloud/scaleway/scaleway_security_group.py:
     maintainers: DenBeke
   $modules/cloud/scaleway/scaleway_security_group_info.py:
@@ -590,8 +556,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:
@@ -623,7 +587,7 @@ files:
   $modules/monitoring/nagios.py:
     maintainers: tbielawa tgoetheyn
   $modules/monitoring/newrelic_deployment.py:
-    ignore: mcodd
+    maintainers: mcodd
   $modules/monitoring/pagerduty.py:
     maintainers: suprememoocow thaumos
     labels: pagerduty
@@ -715,7 +679,7 @@ files:
   $modules/notification/discord.py:
     maintainers: cwollinger
   $modules/notification/flowdock.py:
-    ignore: mcodd
+    maintainers: mcodd
   $modules/notification/grove.py:
     maintainers: zimbatm
   $modules/notification/hipchat.py:
@@ -855,7 +819,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:
@@ -1013,8 +977,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,7 +994,7 @@ files:
   $modules/system/alternatives.py:
     maintainers: mulby
     labels: alternatives
-    ignore: DavidWittman jiuka
+    ignore: DavidWittman
   $modules/system/aix_lvol.py:
     maintainers: adejoux
   $modules/system/awall.py:
@@ -1060,20 +1022,11 @@ files:
   $modules/system/gconftool2.py:
     maintainers: Akasurde kevensen
     labels: gconftool2
-  $modules/system/gconftool2_info.py:
-    maintainers: russoz
-    labels: gconftool2
-  $modules/system/homectl.py:
-    maintainers: jameslivulpi
   $modules/system/interfaces_file.py:
     maintainers: obourdon hryamzik
     labels: interfaces_file
   $modules/system/iptables_state.py:
     maintainers: quidame
-  $modules/system/keyring.py:
-    maintainers: ahussey-redhat
-  $modules/system/keyring_info.py:
-    maintainers: ahussey-redhat
   $modules/system/shutdown.py:
     maintainers: nitzmahone samdoran aminvakil
   $modules/system/java_cert.py:
@@ -1209,8 +1162,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
@@ -1279,7 +1231,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 sh0shin
   team_hpux: bcoca davx8342
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht fxfitz justchris1
@@ -1296,5 +1248,5 @@ macros:
   team_rhn: FlossWare alikins barnabycourt vritant
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
+  team_suse: commel dcermak evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab tleguern Thulium-Drake Ajpantuso

.github/dependabot.yml

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

.github/workflows/codeql-analysis.yml

@@ -4,21 +4,14 @@ on:
   schedule:
     - cron: '26 19 * * 1'
 
-permissions:
-  contents: read
-
 jobs:
   CodeQL-Build:
 
-    permissions:
-      actions: read  # for github/codeql-action/init to get workflow details
-      contents: read  # for actions/checkout to fetch code
-      security-events: write  # for github/codeql-action/autobuild to send a status report
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.
@@ -31,7 +24,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v1
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java
@@ -39,7 +32,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v1
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -53,4 +46,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -1,6 +1,6 @@
 
-# Created by https://www.toptal.com/developers/gitignore/api/vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
-# Edit at https://www.toptal.com/developers/gitignore?templates=vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
+# Created by https://www.toptal.com/developers/gitignore/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
+# Edit at https://www.toptal.com/developers/gitignore?templates=git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
 
 ### dotenv ###
 .env
@@ -71,19 +71,7 @@ flycheck_*.el
 *_LOCAL_*.txt
 *_REMOTE_*.txt
 
-### JupyterNotebooks ###
-# gitignore template for Jupyter Notebooks
-# website: http://jupyter.org/
-
-.ipynb_checkpoints
-*/.ipynb_checkpoints/*
-
-# IPython
-profile_default/
-ipython_config.py
-
-# Remove previous ipynb_checkpoints
-#   git rm -r .ipynb_checkpoints/
+#!! ERROR: jupyternotebook is undefined. Use list command to see defined gitignore types !!#
 
 ### Linux ###
 
@@ -99,39 +87,6 @@ ipython_config.py
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
-### macOS ###
-# General
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### macOS Patch ###
-# iCloud generated files
-*.icloud
-
 ### PyCharm+all ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -196,9 +151,6 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
-# SonarLint plugin
-.idea/sonarlint/
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
@@ -212,13 +164,20 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 ### PyCharm+all Patch ###
-# Ignore everything but code style settings and run configurations
-# that are supposed to be shared within teams.
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
 
-.idea/*
+.idea/
 
-!.idea/codeStyles
-!.idea/runConfigurations
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
 
 ### pydev ###
 .pydevproject
@@ -301,13 +260,16 @@ docs/_build/
 target/
 
 # Jupyter Notebook
+.ipynb_checkpoints
 
 # IPython
+profile_default/
+ipython_config.py
 
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -316,22 +278,7 @@ target/
 #   install all needed dependencies.
 #Pipfile.lock
 
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 
 # Celery stuff
@@ -373,13 +320,6 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
@@ -441,8 +381,6 @@ tags
 
 # Cursive Clojure plugin
 
-# SonarLint plugin
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
 
 # Editor-based Rest Client
@@ -505,4 +443,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/vim,git,macos,linux,pydev,emacs,dotenv,python,windows,webstorm,pycharm+all,jupyternotebooks
+# End of https://www.toptal.com/developers/gitignore/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv

.pre-commit-config.yaml

@@ -1,19 +0,0 @@
----
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
-    hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: mixed-line-ending
-        args: [--fix=lf]
-      - id: fix-encoding-pragma
-      - id: check-ast
-      - id: check-merge-conflict
-      - id: check-symlinks
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.9.0
-    hooks:
-      - id: rst-backticks
-        types: [file]
-        files: changelogs/fragments/.*\.(yml|yaml)$

CONTRIBUTING.md

@@ -24,7 +24,7 @@ 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.
 
@@ -36,54 +36,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.
@@ -106,15 +58,9 @@ 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 add a redirect entry
-   in `meta/runtime.yml`. For example, for the `aerospike_migrations` module located in
-   `plugins/modules/database/aerospike/aerospike_migrations.py`, you need to create the following entry:
-   ```.yaml
-       aerospike_migrations:
-         redirect: community.general.database.aerospike.aerospike_migrations
-   ```
-   Here, the relative path `database/aerospike/` is inserted into the module's FQCN (Fully Qualified Collection Name) after the
-   collection's name and before the module's name. This must not be done for other plugin types but modules and action plugins!
+4. 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.)
 
    - Action plugins need to be accompanied by a module, even if the module file only contains documentation
      (`DOCUMENTATION`, `EXAMPLES` and `RETURN`). The module must have the same name and directory path in `plugins/modules/`
@@ -125,19 +71,3 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
    listed as `maintainers` will be pinged for new issues and PRs that modify the module/plugin or its tests.
 
    When you add a new plugin/module, we expect that you perform maintainer duty for at least some time after contributing it.
-
-## pre-commit
-
-To help ensure high-quality contributions this repository includes a [pre-commit](https://pre-commit.com) configuration which
-corrects and tests against common issues that would otherwise cause CI to fail. To begin using these pre-commit hooks see
-the [Installation](#installation) section below.
-
-This is optional and not required to contribute to this repository.
-
-### Installation
-
-Follow the [instructions](https://pre-commit.com/#install) provided with pre-commit and run `pre-commit install` under the repository base. If for any reason you would like to disable the pre-commit hooks run `pre-commit uninstall`.
-
-This is optional to run it locally.
-
-You can trigger it locally with `pre-commit run --all-files` or even to run only for a given file `pre-commit run --files YOUR_FILE`.

PSF-license.txt

@@ -1,48 +0,0 @@
-PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
---------------------------------------------
-
-1. This LICENSE AGREEMENT is between the Python Software Foundation
-("PSF"), and the Individual or Organization ("Licensee") accessing and
-otherwise using this software ("Python") in source or binary form and
-its associated documentation.
-
-2. Subject to the terms and conditions of this License Agreement, PSF hereby
-grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
-analyze, test, perform and/or display publicly, prepare derivative works,
-distribute, and otherwise use Python alone or in any derivative version,
-provided, however, that PSF's License Agreement and PSF's notice of copyright,
-i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
-2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Python Software Foundation;
-All Rights Reserved" are retained in Python alone or in any derivative version
-prepared by Licensee.
-
-3. In the event Licensee prepares a derivative work that is based on
-or incorporates Python or any part thereof, and wants to make
-the derivative work available to others as provided herein, then
-Licensee hereby agrees to include in any such work a brief summary of
-the changes made to Python.
-
-4. PSF is making Python available to Licensee on an "AS IS"
-basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
-IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
-DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
-FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
-INFRINGE ANY THIRD PARTY RIGHTS.
-
-5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
-FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
-A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
-OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
-
-6. This License Agreement will automatically terminate upon a material
-breach of its terms and conditions.
-
-7. Nothing in this License Agreement shall be deemed to create any
-relationship of agency, partnership, or joint venture between PSF and
-Licensee.  This License Agreement does not grant permission to use PSF
-trademarks or trade name in a trademark sense to endorse or promote
-products or services of Licensee, or any third party.
-
-8. By copying, installing or otherwise using Python, Licensee
-agrees to be bound by the terms and conditions of this License
-Agreement.

README.md

@@ -1,6 +1,6 @@
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-5)](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-4)](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,9 +17,7 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https:
 
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.11, ansible-core 2.12, ansible-core 2.13 releases and the current development version of ansible-core. Ansible-core versions before 2.11.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
-
-Parts of this collection will not work with ansible-core 2.11 on Python 3.12+.
+Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
 
 ## External requirements
 
@@ -66,13 +64,13 @@ 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/main/CONTRIBUTING.md)!
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md)!
 
-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.
+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.
 
 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/main/CONTRIBUTING.md).
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md).
 
 ### Running tests
 
@@ -82,7 +80,7 @@ See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collectio
 
 To learn how to maintain / become a maintainer of this collection, refer to:
 
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
+* [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:
@@ -110,7 +108,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-5/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-4/CHANGELOG.rst).
 
 ## Roadmap
 

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,858 @@ 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
+
+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
+
+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.
+
+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_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

galaxy.yml

@@ -1,6 +1,6 @@
 namespace: community
 name: general
-version: 5.2.0
+version: 4.3.0
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)

plugins/action/iptables_state.py

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

plugins/action/shutdown.py

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

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:
@@ -176,11 +175,20 @@ class CacheModule(BaseCacheModule):
     def __init__(self, *args, **kwargs):
         connection = ['127.0.0.1:11211']
 
-        super(CacheModule, self).__init__(*args, **kwargs)
-        if self.get_option('_uri'):
-            connection = self.get_option('_uri')
-        self._timeout = self.get_option('_timeout')
-        self._prefix = self.get_option('_prefix')
+        try:
+            super(CacheModule, self).__init__(*args, **kwargs)
+            if self.get_option('_uri'):
+                connection = self.get_option('_uri')
+            self._timeout = self.get_option('_timeout')
+            self._prefix = self.get_option('_prefix')
+        except KeyError:
+            # TODO: remove once we no longer support Ansible 2.9
+            if not ansible_base_version.startswith('2.9.'):
+                raise AnsibleError("Do not import CacheModules directly. Use ansible.plugins.loader.cache_loader instead.")
+            if C.CACHE_PLUGIN_CONNECTION:
+                connection = C.CACHE_PLUGIN_CONNECTION.split(',')
+            self._timeout = C.CACHE_PLUGIN_TIMEOUT
+            self._prefix = C.CACHE_PLUGIN_PREFIX
 
         if not HAS_MEMCACHE:
             raise AnsibleError("python-memcached is required for the memcached fact cache")

plugins/cache/redis.py

@@ -99,13 +99,23 @@ class CacheModule(BaseCacheModule):
     def __init__(self, *args, **kwargs):
         uri = ''
 
-        super(CacheModule, self).__init__(*args, **kwargs)
-        if self.get_option('_uri'):
-            uri = self.get_option('_uri')
-        self._timeout = float(self.get_option('_timeout'))
-        self._prefix = self.get_option('_prefix')
-        self._keys_set = self.get_option('_keyset_name')
-        self._sentinel_service_name = self.get_option('_sentinel_service_name')
+        try:
+            super(CacheModule, self).__init__(*args, **kwargs)
+            if self.get_option('_uri'):
+                uri = self.get_option('_uri')
+            self._timeout = float(self.get_option('_timeout'))
+            self._prefix = self.get_option('_prefix')
+            self._keys_set = self.get_option('_keyset_name')
+            self._sentinel_service_name = self.get_option('_sentinel_service_name')
+        except KeyError:
+            # TODO: remove once we no longer support Ansible 2.9
+            if not ansible_base_version.startswith('2.9.'):
+                raise AnsibleError("Do not import CacheModules directly. Use ansible.plugins.loader.cache_loader instead.")
+            if C.CACHE_PLUGIN_CONNECTION:
+                uri = C.CACHE_PLUGIN_CONNECTION
+            self._timeout = float(C.CACHE_PLUGIN_TIMEOUT)
+            self._prefix = C.CACHE_PLUGIN_PREFIX
+            self._keys_set = 'ansible_cache_keys'
 
         if not HAS_REDIS:
             raise AnsibleError("The 'redis' python module (version 2.4.5 or newer) is required for the redis fact cache, 'pip install redis'")

plugins/callback/logstash.py

@@ -45,7 +45,7 @@ DOCUMENTATION = r'''
             version_added: 1.0.0
         default: ansible
       pre_command:
-        description: Executes command before run and its result is added to the C(ansible_pre_command_output) logstash field.
+        description: Executes command before run and result put to ansible_pre_command_output field.
         version_added: 2.0.0
         ini:
           - section: callback_logstash

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/opentelemetry.py

@@ -197,7 +197,7 @@ class OpenTelemetrySource(object):
 
         task = tasks_data[task_uuid]
 
-        if self.ansible_version is None and hasattr(result, '_task_fields') and result._task_fields['args'].get('_ansible_version'):
+        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))
@@ -258,9 +258,8 @@ class OpenTelemetrySource(object):
             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)
+                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)
@@ -320,9 +319,9 @@ class OpenTelemetrySource(object):
     @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")
+        url_args = ("url", "api_url", "baseurl", "repo", "server_url", "chart_repo_url")
         for arg in url_args:
-            if args is not None and args.get(arg):
+            if args.get(arg):
                 return args.get(arg)
         return ""
 

plugins/callback/osx_say.py

@@ -0,0 +1 @@
+say.py

plugins/callback/syslog_json.py

@@ -15,7 +15,7 @@ DOCUMENTATION = '''
     short_description: sends JSON events to syslog
     description:
       - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format
-      - Before Ansible 2.9 only environment variables were available for configuration
+      - Before 2.9 only environment variables were available for configuration
     options:
       server:
         description: syslog server that will receive the event
@@ -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/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/lxca_common.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2017 Lenovo, Inc.
-# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/filter/counter.py

@@ -5,35 +5,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: counter
-  short_description: Counts hashable elements in a sequence
-  version_added: 4.3.0
-  author: Rémy Keil (@keilr)
-  description:
-    - Counts hashable elements in a sequence.
-  options:
-    _input:
-      description: A sequence.
-      type: list
-      elements: any
-      required: true
-'''
-
-EXAMPLES = '''
-- name: Count occurences
-  ansible.builtin.debug:
-    msg: >-
-      {{ [1, 'a', 2, 2, 'a', 'b', 'a'] | community.general.counter }}
-    # Produces: {1: 1, 'a': 3, 2: 2, 'b': 1}
-'''
-
-RETURN = '''
-  _value:
-    description: A dictionary with the elements of the sequence as keys, and their number of occurance in the sequence as values.
-    type: dictionary
-'''
-
 from ansible.errors import AnsibleFilterError
 from ansible.module_utils.common._collections_compat import Sequence
 from collections import Counter

plugins/filter/dict.py

@@ -6,60 +6,6 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: dict
-  short_description: Convert a list of tuples into a dictionary
-  version_added: 3.0.0
-  author: Felix Fontein (@felixfontein)
-  description:
-    - Convert a list of tuples into a dictionary. This is a filter version of the C(dict) function.
-  options:
-    _input:
-      description: A list of tuples (with exactly two elements).
-      type: list
-      elements: tuple
-      required: true
-'''
-
-EXAMPLES = '''
-- name: Convert list of tuples into dictionary
-  ansible.builtin.set_fact:
-    dictionary: "{{ [[1, 2], ['a', 'b']] | community.general.dict }}"
-    # Result is {1: 2, 'a': 'b'}
-
-- name: Create a list of dictionaries with map and the community.general.dict filter
-  ansible.builtin.debug:
-    msg: >-
-      {{ values | map('zip', ['k1', 'k2', 'k3'])
-                | map('map', 'reverse')
-                | map('community.general.dict') }}
-  vars:
-    values:
-      - - foo
-        - 23
-        - a
-      - - bar
-        - 42
-        - b
-  # Produces the following list of dictionaries:
-  #   {
-  #     "k1": "foo",
-  #     "k2": 23,
-  #     "k3": "a"
-  #   },
-  #   {
-  #     "k1": "bar",
-  #     "k2": 42,
-  #     "k3": "b"
-  #   }
-'''
-
-RETURN = '''
-  _value:
-    description: The dictionary having the provided key-value pairs.
-    type: boolean
-'''
-
 
 def dict_filter(sequence):
     '''Convert a list of tuples to a dictionary.

plugins/filter/dict_kv.py

@@ -5,38 +5,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: dict_kv
-  short_description: Convert a value to a dictionary with a single key-value pair
-  version_added: 1.3.0
-  author: Stanislav German-Evtushenko (@giner)
-  description:
-    - Convert a value to a dictionary with a single key-value pair.
-  positional: key
-  options:
-    _input:
-      description: The value for the single key-value pair.
-      type: any
-      required: true
-    key:
-      description: The key for the single key-value pair.
-      type: any
-      required: true
-'''
-
-EXAMPLES = '''
-- name: Create a one-element dictionary from a value
-  ansible.builtin.debug:
-    msg: "{{ 'myvalue' | dict_kv('mykey') }}"
-    # Produces the dictionary {'mykey': 'myvalue'}
-'''
-
-RETURN = '''
-  _value:
-    description: A dictionary with a single key-value pair.
-    type: dictionary
-'''
-
 
 def dict_kv(value, key):
     '''Return a dictionary with a single key-value pair

plugins/filter/from_csv.py

@@ -7,78 +7,6 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: from_csv
-  short_description: Converts CSV text input into list of dicts
-  version_added: 2.3.0
-  author: Andrew Pantuso (@Ajpantuso)
-  description:
-    - Converts CSV text input into list of dictionaries.
-  options:
-    _input:
-      description: A string containing a CSV document.
-      type: string
-      required: true
-    dialect:
-      description:
-        - The CSV dialect to use when parsing the CSV file.
-        - Possible values include C(excel), C(excel-tab) or C(unix).
-      type: str
-      default: excel
-    fieldnames:
-      description:
-        - A list of field names for every column.
-        - This is needed if the CSV does not have a header.
-      type: list
-      elements: str
-    delimiter:
-      description:
-        - A one-character string used to separate fields.
-        - When using this parameter, you change the default value used by I(dialect).
-        - The default value depends on the dialect used.
-      type: str
-    skipinitialspace:
-      description:
-        - Whether to ignore any whitespaces immediately following the delimiter.
-        - When using this parameter, you change the default value used by I(dialect).
-        - The default value depends on the dialect used.
-      type: bool
-    strict:
-      description:
-        - Whether to raise an exception on bad CSV input.
-        - When using this parameter, you change the default value used by I(dialect).
-        - The default value depends on the dialect used.
-      type: bool
-'''
-
-EXAMPLES = '''
-- name: Parse a CSV file's contents
-  ansible.builtin.debug:
-    msg: >-
-      {{ csv_data | community.genera.from_csv(dialect='unix') }}
-  vars:
-    csv_data: |
-      Column 1,Value
-      foo,23
-      bar,42
-  # Produces the following list of dictionaries:
-  #   {
-  #     "Column 1": "foo",
-  #     "Value": "23",
-  #   },
-  #   {
-  #     "Column 1": "bar",
-  #     "Value": "42",
-  #   }
-'''
-
-RETURN = '''
-  _value:
-    description: A list with one dictionary per row.
-    type: list
-    elements: dictionary
-'''
-
 from ansible.errors import AnsibleFilterError
 from ansible.module_utils.common.text.converters import to_native
 

plugins/filter/groupby.py

@@ -5,52 +5,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: groupby_as_dict
-  short_description: Transform a sequence of dictionaries to a dictionary where the dictionaries are indexed by an attribute
-  version_added: 3.1.0
-  author: Felix Fontein (@felixfontein)
-  description:
-    - Transform a sequence of dictionaries to a dictionary where the dictionaries are indexed by an attribute.
-  positional: attribute
-  options:
-    _input:
-      description: A list of dictionaries
-      type: list
-      elements: dictionary
-      required: true
-    attribute:
-      description: The attribute to use as the key.
-      type: str
-      required: true
-'''
-
-EXAMPLES = '''
-- name: Arrange a list of dictionaries as a dictionary of dictionaries
-  ansible.builtin.debug:
-    msg: "{{ sequence | community.general.groupby_as_dict('key') }}"
-  vars:
-    sequence:
-      - key: value
-        foo: bar
-      - key: other_value
-        baz: bar
-  # Produces the following nested structure:
-  #
-  #  value:
-  #    key: value
-  #    foo: bar
-  #  other_value:
-  #    key: other_value
-  #    baz: bar
-'''
-
-RETURN = '''
-  _value:
-    description: A dictionary containing the dictionaries from the list as values.
-    type: dictionary
-'''
-
 from ansible.errors import AnsibleFilterError
 from ansible.module_utils.common._collections_compat import Mapping, Sequence
 

plugins/filter/hashids_decode.yml

@@ -1,38 +0,0 @@
-DOCUMENTATION:
-  name: hashids_decode
-  short_description: Decodes a sequence of numbers from a YouTube-like hash
-  version_added: 3.0.0
-  author: Andrew Pantuso (@Ajpantuso)
-  description:
-    - Decodes a sequence of numbers from a YouTube-like hash.
-  options:
-    _input:
-      description: A YouTube-like hash.
-      type: string
-      required: true
-    salt:
-      description:
-        - String to use as salt when hashing.
-      type: str
-      default: excel
-    alphabet:
-      description:
-        - String of 16 or more unique characters to produce a hash.
-      type: list
-      elements: str
-    min_length:
-      description:
-        - Minimum length of hash produced.
-      type: integer
-
-EXAMPLES: |
-  - name: Convert hash to list of integers
-    ansible.builtin.debug:
-      msg: "{{ 'o2fXhV' | community.general.hashids_decode }}"
-      # Produces: [1, 2, 3]
-
-RETURN:
-  _value:
-    description: A list of integers.
-    type: list
-    elements: integer

plugins/filter/hashids_encode.yml

@@ -1,38 +0,0 @@
-DOCUMENTATION:
-  name: hashids_encode
-  short_description: Encodes YouTube-like hashes from a sequence of integers
-  version_added: 3.0.0
-  author: Andrew Pantuso (@Ajpantuso)
-  description:
-    - Encodes YouTube-like hashes from a sequence of integers.
-  options:
-    _input:
-      description: A list of integers.
-      type: list
-      elements: integer
-      required: true
-    salt:
-      description:
-        - String to use as salt when hashing.
-      type: str
-      default: excel
-    alphabet:
-      description:
-        - String of 16 or more unique characters to produce a hash.
-      type: list
-      elements: str
-    min_length:
-      description:
-        - Minimum length of hash produced.
-      type: integer
-
-EXAMPLES: |
-  - name: Convert list of integers to hash
-    ansible.builtin.debug:
-      msg: "{{ [1, 2, 3] | community.general.hashids_encode }}"
-      # Produces: 'o2fXhV'
-
-RETURN:
-  _value:
-    description: A YouTube-like hash.
-    type: string

plugins/filter/jc.py

@@ -21,67 +21,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: jc
-  short_description: Convert output of many shell commands and file-types to JSON
-  version_added: 1.1.0
-  author: Kelly Brazil (@kellyjonbrazil)
-  description:
-    - Convert output of many shell commands and file-types to JSON.
-    - Uses the L(jc library,https://github.com/kellyjonbrazil/jc).
-  positional: parser
-  options:
-    _input:
-      description: The data to convert.
-      type: string
-      required: true
-    parser:
-      description:
-        - The correct parser for the input data.
-        - For exmaple C(ifconfig).
-        - See U(https://github.com/kellyjonbrazil/jc#parsers) for the latest list of parsers.
-      type: string
-      required: true
-    quiet:
-      description: Set to C(false) to not suppress warnings.
-      type: boolean
-      default: true
-    raw:
-      description: Set to C(true) to return pre-processed JSON.
-      type: boolean
-      default: false
-  requirements:
-    - jc (https://github.com/kellyjonbrazil/jc)
-'''
-
-EXAMPLES = '''
-- name: Run command
-  ansible.builtin.command: uname -a
-  register: result
-
-- name: Convert command's result to JSON
-  ansible.builtin.debug:
-    msg: "{{ result.stdout | community.general.jc('uname') }}"
-  # Possible output:
-  #
-  # "msg": {
-  #   "hardware_platform": "x86_64",
-  #   "kernel_name": "Linux",
-  #   "kernel_release": "4.15.0-112-generic",
-  #   "kernel_version": "#113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020",
-  #   "machine": "x86_64",
-  #   "node_name": "kbrazil-ubuntu",
-  #   "operating_system": "GNU/Linux",
-  #   "processor": "x86_64"
-  # }
-'''
-
-RETURN = '''
-  _value:
-    description: The processed output.
-    type: any
-'''
-
 from ansible.errors import AnsibleError, AnsibleFilterError
 import importlib
 

plugins/filter/json_query.py

@@ -19,107 +19,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: json_query
-  short_description: Select a single element or a data subset from a complex data structure
-  description:
-    - This filter lets you query a complex JSON structure and iterate over it using a loop structure.
-  positional: expr
-  options:
-    _input:
-      description:
-        - The JSON data to query.
-      type: any
-      required: true
-    expr:
-      description:
-        - The query expression.
-        - See U(http://jmespath.org/examples.html) for examples.
-      type: string
-      required: true
-  requirements:
-    - jmespath
-'''
-
-EXAMPLES = '''
-- name: Define data to work on in the examples below
-  ansible.builtin.set_fact:
-    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
-
-- name: Display all cluster names
-  ansible.builtin.debug:
-    var: item
-  loop: "{{ domain_definition | community.general.json_query('domain.cluster[*].name') }}"
-
-- name: Display all server names
-  ansible.builtin.debug:
-    var: item
-  loop: "{{ domain_definition | community.general.json_query('domain.server[*].name') }}"
-
-- 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"
-
-- 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(', ') }}"
-
-- name: Display all ports from cluster1
-  ansible.builtin.debug:
-    var: item
-  loop: "{{ domain_definition | community.general.json_query('domain.server[?cluster==''cluster1''].port') }}"
-
-- 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}"
-
-- 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"
-
-- 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"
-'''
-
-RETURN = '''
-  _value:
-    description: The result of the query.
-    type: any
-'''
-
 from ansible.errors import AnsibleError, AnsibleFilterError
 
 try:

plugins/filter/list.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# 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 AnsibleError, AnsibleFilterError
+from ansible.module_utils.six import string_types
+from ansible.module_utils.common._collections_compat import Mapping, Sequence
+from collections import defaultdict
+from operator import itemgetter
+
+
+def lists_mergeby(l1, l2, index):
+    ''' merge lists by attribute index. Example:
+        - debug: msg="{{ l1|community.general.lists_mergeby(l2, 'index')|list }}" '''
+
+    if not isinstance(l1, Sequence):
+        raise AnsibleFilterError('First argument for community.general.lists_mergeby must be list. %s is %s' %
+                                 (l1, type(l1)))
+
+    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):
+        raise AnsibleFilterError('Third argument for community.general.lists_mergeby must be string. %s is %s' %
+                                 (index, type(index)))
+
+    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):
+    ''' Ansible list filters '''
+
+    def filters(self):
+        return {
+            'lists_mergeby': lists_mergeby,
+        }

plugins/filter/lists_mergeby.py

@@ -1,193 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2020-2022, 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
-
-DOCUMENTATION = '''
-  name: lists_mergeby
-  short_description: Merge two or more lists of dictionaries by a given attribute
-  version_added: 2.0.0
-  author: Vladimir Botka (@vbotka)
-  description:
-    - Merge two or more lists by attribute I(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".
-  positional: another_list, index
-  options:
-    _input:
-      description: A list of dictionaries.
-      type: list
-      elements: dictionary
-      required: true
-    another_list:
-      description: Another list of dictionaries. This parameter can be specified multiple times.
-      type: list
-      elements: dictionary
-    index:
-      description:
-        - The dictionary key that must be present in every dictionary in every list that is used to
-          merge the lists.
-      type: string
-      required: true
-    recursive:
-      description:
-        - Should the combine recursively merge nested dictionaries (hashes).
-        - "B(Note:) It does not depend on the value of the C(hash_behaviour) setting in C(ansible.cfg)."
-      type: boolean
-      default: false
-    list_merge:
-      description:
-        - Modifies the behaviour when the dictionaries (hashes) to merge contain arrays/lists.
-      type: string
-      default: replace
-      choices:
-        - replace
-        - keep
-        - append
-        - prepend
-        - append_rp
-        - prepend_rp
-'''
-
-EXAMPLES = '''
-- name: Merge two lists
-  ansible.builtin.debug:
-    msg: >-
-      {{ list1 | community.general.lists_mergeby(
-                    list2,
-                    'index',
-                    recursive=True,
-                    list_merge='append'
-                 ) }}"
-  vars:
-    list1:
-      - index: a
-        value: 123
-      - index: b
-        value: 42
-    list2:
-      - index: a
-        foo: bar
-      - index: c
-        foo: baz
-  # Produces the following list of dictionaries:
-  #   {
-  #     "index": "a",
-  #     "foo": "bar",
-  #     "value": 123
-  #   },
-  #   {
-  #     "index": "b",
-  #     "value": 42
-  #   },
-  #   {
-  #     "index": "c",
-  #     "foo": "baz"
-  #   }
-'''
-
-RETURN = '''
-  _value:
-    description: The merged list.
-    type: list
-    elements: dictionary
-'''
-
-from ansible.errors import 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 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(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(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)))
-
-    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
-
-
-class FilterModule(object):
-    ''' Ansible list filters '''
-
-    def filters(self):
-        return {
-            'lists_mergeby': lists_mergeby,
-        }

plugins/filter/path_join_shim.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2020-2021, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+import os.path
+
+
+def path_join(list):
+    '''Join list of paths.
+
+    This is a minimal shim for ansible.builtin.path_join included in ansible-base 2.10.
+    This should only be called by Ansible 2.9 or earlier. See meta/runtime.yml for details.
+    '''
+    return os.path.join(*list)
+
+
+class FilterModule(object):
+    '''Ansible jinja2 filters'''
+
+    def filters(self):
+        return {
+            'path_join': path_join,
+        }

plugins/filter/random_mac.py

@@ -20,41 +20,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: random_mac
-  short_description: Generate a random MAC address
-  description:
-    - Generates random networking interfaces MAC addresses for a given prefix.
-  options:
-    _input:
-      description: A string prefix to use as a basis for the random MAC generated.
-      type: string
-      required: true
-    seed:
-      description:
-        - A randomization seed to initialize the process, used to get repeatable results.
-        - If no seed is provided, a system random source such as C(/dev/urandom) is used.
-      required: false
-      type: string
-'''
-
-EXAMPLES = '''
-- name: Random MAC given a prefix
-  ansible.builtin.debug:
-    msg: "{{ '52:54:00' | community.general.random_mac }}"
-    # => '52:54:00:ef:1c:03'
-
-- name: With a seed
-  ansible.builtin.debug:
-    msg: "{{ '52:54:00' | community.general.random_mac(seed=inventory_hostname) }}"
-'''
-
-RETURN = '''
-  _value:
-    description: The generated MAC.
-    type: string
-'''
-
 import re
 from random import Random, SystemRandom
 

plugins/filter/time.py

@@ -46,11 +46,6 @@ def multiply(factors):
 
 def to_time_unit(human_time, unit='ms', **kwargs):
     ''' Return a time unit from a human readable string '''
-
-    # No need to handle 0
-    if human_time == "0":
-        return 0
-
     unit_to_short_form = UNIT_TO_SHORT_FORM
     unit_factors = UNIT_FACTORS
 

plugins/filter/to_days.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_days
-  short_description: Converte a duration string to days
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to days.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into days
-    ansible.builtin.debug:
-      msg: "{{ '1y 7m 5d 30h' | community.general.to_days }}"
-
-RETURN:
-  _value:
-    description: Number of days.
-    type: float

plugins/filter/to_hours.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_hours
-  short_description: Converte a duration string to hours
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to hours.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into hours
-    ansible.builtin.debug:
-      msg: "{{ '7d 30h 20m 10s 123ms' | community.general.to_hours }}"
-
-RETURN:
-  _value:
-    description: Number of hours.
-    type: float

plugins/filter/to_milliseconds.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_milliseconds
-  short_description: Converte a duration string to milliseconds
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to milliseconds.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into milliseconds
-    ansible.builtin.debug:
-      msg: "{{ '30h 20m 10s 123ms' | community.general.to_milliseconds }}"
-
-RETURN:
-  _value:
-    description: Number of milliseconds.
-    type: float

plugins/filter/to_minutes.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_minutes
-  short_description: Converte a duration string to minutes
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to minutes.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into minutes
-    ansible.builtin.debug:
-      msg: "{{ '30h 20m 10s 123ms' | community.general.to_minutes }}"
-
-RETURN:
-  _value:
-    description: Number of minutes.
-    type: float

plugins/filter/to_months.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_months
-  short_description: Converte a duration string to months
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to months.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into months
-    ansible.builtin.debug:
-      msg: "{{ '1y 7m 5d 30h' | community.general.to_months }}"
-
-RETURN:
-  _value:
-    description: Number of months.
-    type: float

plugins/filter/to_seconds.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_seconds
-  short_description: Converte a duration string to seconds
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to seconds.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into seconds
-    ansible.builtin.debug:
-      msg: "{{ '30h 20m 10s 123ms' | community.general.to_seconds }}"
-
-RETURN:
-  _value:
-    description: Number of seconds.
-    type: float

plugins/filter/to_time_unit.yml

@@ -1,84 +0,0 @@
-DOCUMENTATION:
-  name: to_time_unit
-  short_description: Converte a duration string to the given time unit
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to the given time unit.
-  positional: unit
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    unit:
-      description:
-        - Time unit to convert the duration to.
-      default: ms
-      choices:
-        - millisecond
-        - milliseconds
-        - ms
-        - msec
-        - msecs
-        - msecond
-        - mseconds
-        - s
-        - sec
-        - secs
-        - second
-        - seconds
-        - h
-        - hour
-        - hours
-        - hs
-        - m
-        - min
-        - mins
-        - minute
-        - minutes
-        - d
-        - ds
-        - day
-        - days
-        - w
-        - ws
-        - week
-        - weeks
-        - mo
-        - mos
-        - month
-        - months
-        - y
-        - ys
-        - year
-        - years
-      type: string
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into seconds
-    ansible.builtin.debug:
-      msg: "{{ '1053d 17h 53m -10s 391ms' | community.general.to_time_unit('s') }}"
-
-RETURN:
-  _value:
-    description: Number of time units.
-    type: float

plugins/filter/to_weeks.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_weeks
-  short_description: Converte a duration string to weeks
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to weeks.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into weeks
-    ansible.builtin.debug:
-      msg: "{{ '1y 7m 5d 30h' | community.general.to_weeks }}"
-
-RETURN:
-  _value:
-    description: Number of weeks.
-    type: float

plugins/filter/to_years.yml

@@ -1,40 +0,0 @@
-DOCUMENTATION:
-  name: to_years
-  short_description: Converte a duration string to years
-  version_added: 0.2.0
-  description:
-    - Parse a human readable time duration string and convert to years.
-  options:
-    _input:
-      description:
-        - The time string to convert.
-        - Can use the units C(y) and C(year) for a year, C(mo) and C(month) for a month, C(w) and C(week) for a week,
-          C(d) and C(day) for a day, C(h) and C(hour) for a hour, C(m), C(min) and C(minute) for minutes, C(s), C(sec)
-          and C(second) for seconds, C(ms), C(msec), C(msecond) and C(millisecond) for milliseconds. The suffix C(s)
-          can be added to a unit as well, so C(seconds) is the same as C(second).
-        - Valid strings are space separated combinations of an integer with an optional minus sign and a unit.
-        - Examples are C(1h), C(-5m), and C(3h -5m 6s).
-      type: string
-      required: true
-    year:
-      description:
-        - Number of days per year.
-      default: 365
-      type: float
-    month:
-      description:
-        - Number of days per month.
-      default: 30
-      type: float
-  author:
-    - René Moser (@resmo)
-
-EXAMPLES: |
-  - name: Convert a duration into years
-    ansible.builtin.debug:
-      msg: "{{ '1053d 30h' | community.general.to_years }}"
-
-RETURN:
-  _value:
-    description: Number of years.
-    type: float

plugins/filter/unicode_normalize.py

@@ -6,46 +6,6 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: unicode_normalize
-  short_description: Normalizes unicode strings to facilitate comparison of characters with normalized forms
-  version_added: 3.7.0
-  author: Andrew Pantuso (@Ajpantuso)
-  description:
-    - Normalizes unicode strings to facilitate comparison of characters with normalized forms.
-  positional: form
-  options:
-    _input:
-      description: A unicode string.
-      type: string
-      required: true
-    form:
-      description:
-        - The normal form to use.
-        - See U(https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize) for details.
-      type: string
-      default: NFC
-      choices:
-        - NFC
-        - NFD
-        - NFKC
-        - NFKD
-'''
-
-EXAMPLES = '''
-- name: Normalize unicode string
-  ansible.builtin.set_fact:
-    dictionary: "{{ 'ä' | community.general.unicode_normalize('NFKD') }}"
-    # The resulting string has length 2: one letter is 'a', the other
-    # the diacritic combiner.
-'''
-
-RETURN = '''
-  _value:
-    description: The normalized unicode string of the specified normal form.
-    type: string
-'''
-
 from unicodedata import normalize
 
 from ansible.errors import AnsibleFilterError, AnsibleFilterTypeError

plugins/filter/version_sort.py

@@ -5,35 +5,6 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-  name: version_sort
-  short_description: Sort a list according to version order instead of pure alphabetical one
-  version_added: 2.2.0
-  author: Eric L. (@ericzolf)
-  description:
-    - Sort a list according to version order instead of pure alphabetical one.
-  options:
-    _input:
-      description: A list of strings to sort.
-      type: list
-      elements: string
-      required: true
-'''
-
-EXAMPLES = '''
-- name: Convert list of tuples into dictionary
-  ansible.builtin.set_fact:
-    dictionary: "{{ ['2.1', '2.10', '2.9'] | community.general.version_sort }}"
-    # Result is ['2.1', '2.9', '2.10']
-'''
-
-RETURN = '''
-  _value:
-    description: The list of strings sorted by version.
-    type: list
-    elements: string
-'''
-
 from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
 
 

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
@@ -83,7 +71,8 @@ password: secure
 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 +94,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 +177,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 +190,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 +210,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 +231,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

@@ -16,17 +16,7 @@ DOCUMENTATION = '''
         - 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
@@ -73,20 +63,6 @@ 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
@@ -204,7 +180,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         """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"],
+            "attrs": ["address", "display_name", "state_type", "state", "groups"],
         }
         if self.host_filter is not None:
             query_args['host_filter'] = self.host_filter
@@ -214,12 +190,6 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         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
@@ -262,10 +232,6 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
                                         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):

plugins/inventory/linode.py

@@ -21,18 +21,7 @@ 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.
             required: true
@@ -54,18 +43,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 +66,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
@@ -124,31 +104,25 @@ 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 +158,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
@@ -253,13 +224,76 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
             )
         return data
 
-    def _cacheable_inventory(self):
-        return [i._raw_json for i in self.instances]
+    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]
+
+        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 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 +315,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

@@ -666,13 +666,9 @@ class InventoryModule(BaseInventoryPlugin):
             # add network informations
             self.build_inventory_network(instance_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(instance_name, 'ansible_lxd_os', self._get_data_entry('inventory/{0}/os'.format(instance_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(instance_name, 'ansible_lxd_release', self._get_data_entry('inventory/{0}/release'.format(instance_name)).lower())
             # add profile
             self.inventory.set_variable(instance_name, 'ansible_lxd_profile', self._get_data_entry('inventory/{0}/profile'.format(instance_name)))
             # add state