Release 8.6.2.

Fix launchd check-mode to report changed correctly (#8476)

* Fix launchd check-mode to report changed correctly

* Update changelog fragment.

---------

Co-authored-by: Strahinja Kustudic <strahinjak@nordeus.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 2612ceee37)

Co-authored-by: Strahinja Kustudic <kustodian@gmail.com>

.azure-pipelines/azure-pipelines.yml

@@ -29,14 +29,14 @@ schedules:
     always: true
     branches:
       include:
-        - stable-10
         - stable-9
+        - stable-8
   - cron: 0 11 * * 0
     displayName: Weekly (old stable branches)
     always: true
     branches:
       include:
-        - stable-8
+        - stable-7
 
 variables:
   - name: checkoutPath
@@ -73,19 +73,6 @@ stages:
             - test: 3
             - test: 4
             - test: extra
-  - stage: Sanity_2_18
-    displayName: Sanity 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.18/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
   - stage: Sanity_2_17
     displayName: Sanity 2.17
     dependsOn: []
@@ -112,6 +99,19 @@ stages:
             - test: 2
             - test: 3
             - test: 4
+  - stage: Sanity_2_15
+    displayName: Sanity 2.15
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.15/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
 ### Units
   - stage: Units_devel
     displayName: Units devel
@@ -128,17 +128,6 @@ stages:
             - test: '3.11'
             - test: '3.12'
             - test: '3.13'
-  - stage: Units_2_18
-    displayName: Units 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.18/units/{0}/1
-          targets:
-            - test: 3.8
-            - test: "3.13"
   - stage: Units_2_17
     displayName: Units 2.17
     dependsOn: []
@@ -162,6 +151,17 @@ stages:
             - test: 2.7
             - test: 3.6
             - test: "3.11"
+  - stage: Units_2_15
+    displayName: Units 2.15
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.15/units/{0}/1
+          targets:
+            - test: 3.5
+            - test: "3.10"
 
 ## Remote
   - stage: Remote_devel_extra_vms
@@ -172,14 +172,12 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: Alpine 3.20
-              test: alpine/3.20
-            # - name: Fedora 40
-            #   test: fedora/40
+            - name: Alpine 3.19
+              test: alpine/3.19
+            # - name: Fedora 39
+            #   test: fedora/39
             - name: Ubuntu 22.04
               test: ubuntu/22.04
-            - name: Ubuntu 24.04
-              test: ubuntu/24.04
           groups:
             - vm
   - stage: Remote_devel
@@ -192,26 +190,10 @@ stages:
           targets:
             - name: macOS 14.3
               test: macos/14.3
-            - name: RHEL 9.4
-              test: rhel/9.4
-            - name: FreeBSD 14.1
-              test: freebsd/14.1
-            - name: FreeBSD 13.4
-              test: freebsd/13.4
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Remote_2_18
-    displayName: Remote 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/{0}
-          targets:
-            - name: RHEL 9.4
-              test: rhel/9.4
+            - name: RHEL 9.3
+              test: rhel/9.3
+            - name: FreeBSD 14.0
+              test: freebsd/14.0
           groups:
             - 1
             - 2
@@ -226,10 +208,6 @@ stages:
           targets:
             - name: FreeBSD 13.3
               test: freebsd/13.3
-            - name: RHEL 9.3
-              test: rhel/9.3
-            - name: FreeBSD 14.0
-              test: freebsd/14.0
           groups:
             - 1
             - 2
@@ -248,10 +226,30 @@ stages:
               test: rhel/9.2
             - name: RHEL 8.8
               test: rhel/8.8
+            - name: FreeBSD 13.2
+              test: freebsd/13.2
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Remote_2_15
+    displayName: Remote 2.15
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.15/{0}
+          targets:
+            - name: RHEL 9.1
+              test: rhel/9.1
+            - name: RHEL 8.7
+              test: rhel/8.7
             - name: RHEL 7.9
               test: rhel/7.9
-            # - name: FreeBSD 13.2
-            #   test: freebsd/13.2
+            # - name: FreeBSD 13.1
+            #   test: freebsd/13.1
+            # - name: FreeBSD 12.4
+            #   test: freebsd/12.4
           groups:
             - 1
             - 2
@@ -266,28 +264,12 @@ stages:
         parameters:
           testFormat: devel/linux/{0}
           targets:
-            - name: Fedora 40
-              test: fedora40
-            - name: Alpine 3.20
-              test: alpine320
+            - name: Fedora 39
+              test: fedora39
+            - name: Ubuntu 20.04
+              test: ubuntu2004
             - name: Ubuntu 22.04
               test: ubuntu2204
-            - name: Ubuntu 24.04
-              test: ubuntu2404
-          groups:
-            - 1
-            - 2
-            - 3
-  - stage: Docker_2_18
-    displayName: Docker 2.18
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.18/linux/{0}
-          targets:
-            - name: Ubuntu 24.04
-              test: ubuntu2404
           groups:
             - 1
             - 2
@@ -300,12 +282,8 @@ stages:
         parameters:
           testFormat: 2.17/linux/{0}
           targets:
-            - name: Fedora 39
-              test: fedora39
             - name: Alpine 3.19
               test: alpine319
-            - name: Ubuntu 20.04
-              test: ubuntu2004
           groups:
             - 1
             - 2
@@ -324,6 +302,20 @@ stages:
               test: opensuse15
             - name: Alpine 3
               test: alpine3
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Docker_2_15
+    displayName: Docker 2.15
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.15/linux/{0}
+          targets:
+            - name: Fedora 37
+              test: fedora37
             - name: CentOS 7
               test: centos7
           groups:
@@ -345,86 +337,84 @@ stages:
             - name: Debian Bookworm
               test: debian-bookworm/3.11
             - name: ArchLinux
-              test: archlinux/3.13
+              test: archlinux/3.12
           groups:
             - 1
             - 2
             - 3
 
 ### Generic
-# Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
-#  - stage: Generic_devel
-#    displayName: Generic devel
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: devel/generic/{0}/1
-#          targets:
-#            - test: '3.8'
-#            - test: '3.11'
-#            - test: '3.13'
-#  - stage: Generic_2_18
-#    displayName: Generic 2.18
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.18/generic/{0}/1
-#          targets:
-#            - test: '3.8'
-#            - test: '3.13'
-#  - stage: Generic_2_17
-#    displayName: Generic 2.17
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.17/generic/{0}/1
-#          targets:
-#            - test: '3.7'
-#            - test: '3.12'
-#  - stage: Generic_2_16
-#    displayName: Generic 2.16
-#    dependsOn: []
-#    jobs:
-#      - template: templates/matrix.yml
-#        parameters:
-#          nameFormat: Python {0}
-#          testFormat: 2.16/generic/{0}/1
-#          targets:
-#            - test: '2.7'
-#            - test: '3.6'
-#            - test: '3.11'
+  - stage: Generic_devel
+    displayName: Generic devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: devel/generic/{0}/1
+          targets:
+            - test: '3.8'
+            - test: '3.11'
+            - test: '3.13'
+  - stage: Generic_2_17
+    displayName: Generic 2.17
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.17/generic/{0}/1
+          targets:
+            - test: '3.7'
+            - test: '3.12'
+  - stage: Generic_2_16
+    displayName: Generic 2.16
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.16/generic/{0}/1
+          targets:
+            - test: '2.7'
+            - test: '3.6'
+            - test: '3.11'
+  - stage: Generic_2_15
+    displayName: Generic 2.15
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.15/generic/{0}/1
+          targets:
+            - test: '3.9'
 
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
       - Sanity_devel
-      - Sanity_2_18
       - Sanity_2_17
       - Sanity_2_16
+      - Sanity_2_15
       - Units_devel
-      - Units_2_18
       - Units_2_17
       - Units_2_16
+      - Units_2_15
       - Remote_devel_extra_vms
       - Remote_devel
-      - Remote_2_18
       - Remote_2_17
       - Remote_2_16
+      - Remote_2_15
       - Docker_devel
-      - Docker_2_18
       - Docker_2_17
       - Docker_2_16
+      - Docker_2_15
       - Docker_community_devel
 # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
 #      - Generic_devel
-#      - Generic_2_18
 #      - Generic_2_17
 #      - Generic_2_16
+#      - Generic_2_15
     jobs:
       - template: templates/coverage.yml

.github/BOTMETA.yml

@@ -33,8 +33,6 @@ files:
     maintainers: $team_ansible_core
   $becomes/pmrun.py:
     maintainers: $team_ansible_core
-  $becomes/run0.py:
-    maintainers: konstruktoid
   $becomes/sesu.py:
     maintainers: nekonyuu
   $becomes/sudosu.py:
@@ -61,6 +59,7 @@ files:
   $callbacks/elastic.py:
     keywords: apm observability
     maintainers: v1v
+  $callbacks/hipchat.py: {}
   $callbacks/jabber.py: {}
   $callbacks/log_plays.py: {}
   $callbacks/loganalytics.py:
@@ -90,8 +89,6 @@ files:
     maintainers: ryancurrah
   $callbacks/syslog_json.py:
     maintainers: imjoseangel
-  $callbacks/timestamp.py:
-    maintainers: kurokobo
   $callbacks/unixy.py:
     labels: unixy
     maintainers: akatch
@@ -120,8 +117,6 @@ files:
     maintainers: $team_ansible_core
   $doc_fragments/:
     labels: docs_fragments
-  $doc_fragments/django.py:
-    maintainers: russoz
   $doc_fragments/hpe3par.py:
     labels: hpe3par
     maintainers: farhan7500 gautamphegde
@@ -130,13 +125,9 @@ files:
     maintainers: $team_huawei
   $doc_fragments/nomad.py:
     maintainers: chris93111 apecnascimento
-  $doc_fragments/pipx.py:
-    maintainers: russoz
   $doc_fragments/xenserver.py:
     labels: xenserver
     maintainers: bvitnik
-  $filters/accumulate.py:
-    maintainers: VannTen
   $filters/counter.py:
     maintainers: keilr
   $filters/crc32.py:
@@ -160,8 +151,6 @@ files:
   $filters/jc.py:
     maintainers: kellyjonbrazil
   $filters/json_query.py: {}
-  $filters/keep_keys.py:
-    maintainers: vbotka
   $filters/lists.py:
     maintainers: cfiehe
   $filters/lists_difference.yml:
@@ -175,12 +164,6 @@ files:
   $filters/lists_union.yml:
     maintainers: cfiehe
   $filters/random_mac.py: {}
-  $filters/remove_keys.py:
-    maintainers: vbotka
-  $filters/replace_keys.py:
-    maintainers: vbotka
-  $filters/reveal_ansible_type.py:
-    maintainers: vbotka
   $filters/time.py:
     maintainers: resmo
   $filters/to_days.yml:
@@ -213,8 +196,6 @@ files:
     maintainers: opoplawski
   $inventories/gitlab_runners.py:
     maintainers: morph027
-  $inventories/iocage.py:
-    maintainers: vbotka
   $inventories/icinga2.py:
     maintainers: BongoEADGC6
   $inventories/linode.py:
@@ -311,18 +292,10 @@ files:
     maintainers: delineaKrehl tylerezimmerman
   $module_utils/:
     labels: module_utils
-  $module_utils/android_sdkmanager.py:
-    maintainers: shamilovstas
   $module_utils/btrfs.py:
     maintainers: gnfzdz
-  $module_utils/cmd_runner_fmt.py:
-    maintainers: russoz
-  $module_utils/cmd_runner.py:
-    maintainers: russoz
   $module_utils/deps.py:
     maintainers: russoz
-  $module_utils/django.py:
-    maintainers: russoz
   $module_utils/gconftool2.py:
     labels: gconftool2
     maintainers: russoz
@@ -366,8 +339,6 @@ files:
   $module_utils/pipx.py:
     labels: pipx
     maintainers: russoz
-  $module_utils/python_runner.py:
-    maintainers: russoz
   $module_utils/puppet.py:
     labels: puppet
     maintainers: russoz
@@ -424,8 +395,6 @@ files:
     ignore: DavidWittman jiuka
     labels: alternatives
     maintainers: mulby
-  $modules/android_sdk.py:
-    maintainers: shamilovstas
   $modules/ansible_galaxy_install.py:
     maintainers: russoz
   $modules/apache2_mod_proxy.py:
@@ -459,8 +428,6 @@ files:
     maintainers: hkariti
   $modules/bitbucket_:
     maintainers: catcombo
-  $modules/bootc_manage.py:
-    maintainers: cooktheryan
   $modules/bower.py:
     maintainers: mwarkentin
   $modules/btrfs_:
@@ -514,8 +481,6 @@ files:
     ignore: skornehl
   $modules/dconf.py:
     maintainers: azaghal
-  $modules/decompress.py:
-    maintainers: shamilovstas
   $modules/deploy_helper.py:
     maintainers: ramondelafuente
   $modules/dimensiondata_network.py:
@@ -525,12 +490,6 @@ files:
     maintainers: tintoy
   $modules/discord.py:
     maintainers: cwollinger
-  $modules/django_check.py:
-    maintainers: russoz
-  $modules/django_command.py:
-    maintainers: russoz
-  $modules/django_createcachetable.py:
-    maintainers: russoz
   $modules/django_manage.py:
     ignore: scottanderson42 tastychutney
     labels: django_manage
@@ -573,6 +532,8 @@ files:
     maintainers: $team_flatpak
   $modules/flatpak_remote.py:
     maintainers: $team_flatpak
+  $modules/flowdock.py:
+    ignore: mcodd
   $modules/gandi_livedns.py:
     maintainers: gthiemonge
   $modules/gconftool2.py:
@@ -661,11 +622,6 @@ files:
     labels: homebrew_ macos
     maintainers: $team_macos
     notify: chris-short
-  $modules/homebrew_services.py:
-    ignore: ryansb
-    keywords: brew cask services darwin homebrew macosx macports osx
-    labels: homebrew_ macos
-    maintainers: $team_macos kitizz
   $modules/homectl.py:
     maintainers: jameslivulpi
   $modules/honeybadger_deployment.py:
@@ -725,8 +681,6 @@ files:
   $modules/ipa_:
     maintainers: $team_ipa
     ignore: fxfitz
-  $modules/ipa_getkeytab.py:
-    maintainers: abakanovskii
   $modules/ipa_dnsrecord.py:
     maintainers: $team_ipa jwbernin
   $modules/ipbase_info.py:
@@ -772,8 +726,6 @@ files:
     maintainers: sermilrod
   $modules/jenkins_job_info.py:
     maintainers: stpierre
-  $modules/jenkins_node.py:
-    maintainers: phyrwork
   $modules/jenkins_plugin.py:
     maintainers: jtyr
   $modules/jenkins_script.py:
@@ -810,8 +762,6 @@ files:
     maintainers: fynncfchen johncant
   $modules/keycloak_clientsecret_regenerate.py:
     maintainers: fynncfchen johncant
-  $modules/keycloak_component.py:
-    maintainers: fivetide
   $modules/keycloak_group.py:
     maintainers: adamgoossens
   $modules/keycloak_identity_provider.py:
@@ -828,8 +778,6 @@ files:
     maintainers: elfelip
   $modules/keycloak_user_federation.py:
     maintainers: laurpaum
-  $modules/keycloak_userprofile.py:
-    maintainers: yeoldegrove
   $modules/keycloak_component_info.py:
     maintainers: desand01
   $modules/keycloak_client_rolescope.py:
@@ -844,8 +792,6 @@ files:
     maintainers: ahussey-redhat
   $modules/kibana_plugin.py:
     maintainers: barryib
-  $modules/krb_ticket.py:
-    maintainers: abakanovskii
   $modules/launchd.py:
     maintainers: martinm82
   $modules/layman.py:
@@ -856,8 +802,6 @@ files:
     maintainers: drybjed jtyr noles
   $modules/ldap_entry.py:
     maintainers: jtyr
-  $modules/ldap_inc.py:
-    maintainers: pduveau
   $modules/ldap_passwd.py:
     maintainers: KellerFuchs jtyr
   $modules/ldap_search.py:
@@ -999,8 +943,6 @@ files:
     maintainers: $team_opennebula
   $modules/one_host.py:
     maintainers: rvalle
-  $modules/one_vnet.py:
-    maintainers: abakanovskii
   $modules/oneandone_:
     maintainers: aajdinov edevenport
   $modules/onepassword_info.py:
@@ -1129,8 +1071,6 @@ files:
   $modules/proxmox_kvm.py:
     ignore: skvidal
     maintainers: helldorado krauthosting
-  $modules/proxmox_backup.py:
-    maintainers: IamLunchbox
   $modules/proxmox_nic.py:
     maintainers: Kogelvis krauthosting
   $modules/proxmox_node_info.py:
@@ -1156,6 +1096,46 @@ files:
   $modules/python_requirements_info.py:
     ignore: ryansb
     maintainers: willthames
+  $modules/rax:
+    ignore: ryansb sivel
+  $modules/rax.py:
+    maintainers: omgjlk sivel
+  $modules/rax_cbs.py:
+    maintainers: claco
+  $modules/rax_cbs_attachments.py:
+    maintainers: claco
+  $modules/rax_cdb.py:
+    maintainers: jails
+  $modules/rax_cdb_database.py:
+    maintainers: jails
+  $modules/rax_cdb_user.py:
+    maintainers: jails
+  $modules/rax_clb.py:
+    maintainers: claco
+  $modules/rax_clb_nodes.py:
+    maintainers: neuroid
+  $modules/rax_clb_ssl.py:
+    maintainers: smashwilson
+  $modules/rax_files.py:
+    maintainers: angstwad
+  $modules/rax_files_objects.py:
+    maintainers: angstwad
+  $modules/rax_identity.py:
+    maintainers: claco
+  $modules/rax_mon_alarm.py:
+    maintainers: smashwilson
+  $modules/rax_mon_check.py:
+    maintainers: smashwilson
+  $modules/rax_mon_entity.py:
+    maintainers: smashwilson
+  $modules/rax_mon_notification.py:
+    maintainers: smashwilson
+  $modules/rax_mon_notification_plan.py:
+    maintainers: smashwilson
+  $modules/rax_network.py:
+    maintainers: claco omgjlk
+  $modules/rax_queue.py:
+    maintainers: claco
   $modules/read_csv.py:
     maintainers: dagwieers
   $modules/redfish_:
@@ -1180,6 +1160,12 @@ files:
     keywords: kvm libvirt proxmox qemu
     labels: rhevm virt
     maintainers: $team_virt TimothyVandenbrande
+  $modules/rhn_channel.py:
+    labels: rhn_channel
+    maintainers: vincentvdk alikins $team_rhn
+  $modules/rhn_register.py:
+    labels: rhn_register
+    maintainers: jlaska $team_rhn
   $modules/rhsm_release.py:
     maintainers: seandst $team_rhsm
   $modules/rhsm_repository.py:
@@ -1314,6 +1300,8 @@ files:
     maintainers: farhan7500 gautamphegde
   $modules/ssh_config.py:
     maintainers: gaqzi Akasurde
+  $modules/stackdriver.py:
+    maintainers: bwhaley
   $modules/stacki_host.py:
     labels: stacki_host
     maintainers: bsanders bbyhuy
@@ -1343,10 +1331,6 @@ files:
     maintainers: precurse
   $modules/sysrc.py:
     maintainers: dlundgren
-  $modules/systemd_creds_decrypt.py:
-    maintainers: konstruktoid
-  $modules/systemd_creds_encrypt.py:
-    maintainers: konstruktoid
   $modules/sysupgrade.py:
     maintainers: precurse
   $modules/taiga_issue.py:
@@ -1410,6 +1394,8 @@ files:
     maintainers: $team_wdc
   $modules/wdc_redfish_info.py:
     maintainers: $team_wdc
+  $modules/webfaction_:
+    maintainers: quentinsf
   $modules/xattr.py:
     labels: xattr
     maintainers: bcoca
@@ -1461,19 +1447,10 @@ files:
     ignore: matze
     labels: zypper
     maintainers: $team_suse
-  $plugin_utils/ansible_type.py:
-    maintainers: vbotka
-  $modules/zypper_repository_info.py:
-    labels: zypper
-    maintainers: $team_suse TobiasZeuch181
-  $plugin_utils/keys_filter.py:
-    maintainers: vbotka
   $plugin_utils/unsafe.py:
     maintainers: felixfontein
   $tests/a_module.py:
     maintainers: felixfontein
-  $tests/ansible_type.py:
-    maintainers: vbotka
   $tests/fqdn_valid.py:
     maintainers: vbotka
 #########################
@@ -1487,14 +1464,6 @@ files:
     maintainers: felixfontein
   docs/docsite/rst/filter_guide_abstract_informations_lists_helper.rst:
     maintainers: cfiehe
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst:
-    maintainers: vbotka
-  docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries.rst:
-    maintainers: vbotka
   docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst:
     maintainers: vbotka
   docs/docsite/rst/filter_guide_conversions.rst:
@@ -1511,20 +1480,12 @@ files:
     maintainers: ericzolf
   docs/docsite/rst/guide_alicloud.rst:
     maintainers: xiaozhu36
-  docs/docsite/rst/guide_cmdrunner.rst:
-    maintainers: russoz
-  docs/docsite/rst/guide_deps.rst:
-    maintainers: russoz
-  docs/docsite/rst/guide_modulehelper.rst:
-    maintainers: russoz
   docs/docsite/rst/guide_online.rst:
     maintainers: remyleone
   docs/docsite/rst/guide_packet.rst:
     maintainers: baldwinSPC nurfet-becirevic t0mk teebes
   docs/docsite/rst/guide_scaleway.rst:
     maintainers: $team_scaleway
-  docs/docsite/rst/guide_vardict.rst:
-    maintainers: russoz
   docs/docsite/rst/test_guide.rst:
     maintainers: felixfontein
 #########################
@@ -1556,7 +1517,7 @@ macros:
   team_ansible_core:
   team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
-  team_consul: sgargan apollo13 Ilgmi
+  team_consul: sgargan apollo13
   team_cyberark_conjur: jvanderhoof ryanprior
   team_e_spirit: MatrixCrawler getjack
   team_flatpak: JayKayy oolongbrothers
@@ -1565,7 +1526,7 @@ macros:
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht justchris1
   team_jboss: Wolfant jairojunior wbrefvem
-  team_keycloak: eikef ndclt mattock thomasbach-dev
+  team_keycloak: eikef ndclt mattock
   team_linode: InTheCloudDan decentral1se displague rmcintosh Charliekenney23 LBGarber
   team_macos: Akasurde kyleabenson martinm82 danieljaouen indrajitr
   team_manageiq: abellotti cben gtanzillo yaacov zgalor dkorn evertmulder
@@ -1574,9 +1535,10 @@ macros:
   team_oracle: manojmeda mross22 nalsaber
   team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
   team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06 jyundt
+  team_rhn: FlossWare alikins barnabycourt vritant
   team_rhsm: cnsnyder ptoscano
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel evrardjp lrupp AnderEnder alxgu andytom sealor
+  team_suse: commel evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab Thulium-Drake Ajpantuso
   team_wdc: mikemoerk

.github/workflows/ansible-test.yml

@@ -29,7 +29,8 @@ jobs:
     strategy:
       matrix:
         ansible:
-          - '2.15'
+          - '2.13'
+          - '2.14'
     # Ansible-test on various stable branches does not yet work well with cgroups v2.
     # Since ubuntu-latest now uses Ubuntu 22.04, we need to fall back to the ubuntu-20.04
     # image for these stable branches. The list of branches where this is necessary will
@@ -65,12 +66,16 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          - ansible: '2.15'
+          - ansible: '2.13'
             python: '2.7'
-          - ansible: '2.15'
-            python: '3.5'
-          - ansible: '2.15'
-            python: '3.10'
+          - ansible: '2.13'
+            python: '3.8'
+          - ansible: '2.13'
+            python: '2.7'
+          - ansible: '2.13'
+            python: '3.8'
+          - ansible: '2.14'
+            python: '3.9'
 
     steps:
       - name: >-
@@ -111,29 +116,54 @@ jobs:
         exclude:
           - ansible: ''
         include:
-          # 2.15
-          - ansible: '2.15'
+          # 2.13
+          - ansible: '2.13'
+            docker: fedora35
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.13'
+            docker: fedora35
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.13'
+            docker: fedora35
+            python: ''
+            target: azp/posix/3/
+          - ansible: '2.13'
+            docker: opensuse15py2
+            python: ''
+            target: azp/posix/1/
+          - ansible: '2.13'
+            docker: opensuse15py2
+            python: ''
+            target: azp/posix/2/
+          - ansible: '2.13'
+            docker: opensuse15py2
+            python: ''
+            target: azp/posix/3/
+          - ansible: '2.13'
             docker: alpine3
             python: ''
             target: azp/posix/1/
-          - ansible: '2.15'
+          - ansible: '2.13'
             docker: alpine3
             python: ''
             target: azp/posix/2/
-          - ansible: '2.15'
+          - ansible: '2.13'
             docker: alpine3
             python: ''
             target: azp/posix/3/
-          - ansible: '2.15'
-            docker: fedora37
+          # 2.14
+          - ansible: '2.14'
+            docker: alpine3
             python: ''
             target: azp/posix/1/
-          - ansible: '2.15'
-            docker: fedora37
+          - ansible: '2.14'
+            docker: alpine3
             python: ''
             target: azp/posix/2/
-          - ansible: '2.15'
-            docker: fedora37
+          - ansible: '2.14'
+            docker: alpine3
             python: ''
             target: azp/posix/3/
           # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
@@ -141,14 +171,11 @@ jobs:
           #   docker: default
           #   python: '3.9'
           #   target: azp/generic/1/
+          # Right now all generic tests are disabled. Uncomment when at least one of them is re-enabled.
           # - ansible: '2.14'
           #   docker: default
           #   python: '3.10'
           #   target: azp/generic/1/
-          # - ansible: '2.15'
-          #   docker: default
-          #   python: '3.9'
-          #   target: azp/generic/1/
 
     steps:
       - name: >-

.github/workflows/codeql-analysis.yml

@@ -25,8 +25,6 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
-      with:
-        persist-credentials: false
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/reuse.yml

@@ -7,14 +7,10 @@ name: Verify REUSE
 
 on:
   push:
-    branches:
-      - main
-      - stable-*
-  pull_request:
+    branches: [main]
+  pull_request_target:
     types: [opened, synchronize, reopened]
-    branches:
-      - main
-      - stable-*
+    branches: [main]
   # Run CI once per day (at 07:30 UTC)
   schedule:
     - cron: '30 7 * * *'
@@ -28,8 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          persist-credentials: false
           ref: ${{ github.event.pull_request.head.sha || '' }}
 
       - name: REUSE Compliance Check
-        uses: fsfe/reuse-action@v5
+        uses: fsfe/reuse-action@v3

.gitignore

@@ -512,7 +512,3 @@ $RECYCLE.BIN/
 
 # Integration tests cloud configs
 tests/integration/cloud-config-*.ini
-
-
-# VSCode specific extensions
-.vscode/settings.json

CONTRIBUTING.md

@@ -56,8 +56,6 @@ 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+.
 
-### Sanity tests
-
 The following commands show how to run sanity tests:
 
 ```.bash
@@ -68,8 +66,6 @@ ansible-test sanity --docker -v
 ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/
 ```
 
-### Unit tests
-
 The following commands show how to run unit tests:
 
 ```.bash
@@ -83,32 +79,13 @@ ansible-test units --docker -v --python 3.8
 ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools/test_nmcli.py
 ```
 
-### Integration tests
-
 The following commands show how to run integration tests:
 
-#### In Docker
-
-Integration tests on Docker have the following parameters:
-- `image_name` (required): The name of the Docker image. To get the list of supported Docker images, run
-  `ansible-test integration --help` and look for _target docker images_.
-- `test_name` (optional): The name of the integration test.  
-  For modules, this equals the short name of the module; for example, `pacman` in case of `community.general.pacman`.  
-  For plugins, the plugin type is added before the plugin's short name, for example `callback_yaml` for the `community.general.yaml` callback.
 ```.bash
-# Test all plugins/modules on fedora40
-ansible-test integration -v --docker fedora40
+# 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
 
-# Template
-ansible-test integration -v --docker image_name test_name
-
-# Example community.general.ini_file module on fedora40 Docker image:
-ansible-test integration -v --docker fedora40 ini_file
-```
-
-#### Without isolation
-
-```.bash
 # Run integration tests for the flattened lookup **without any isolation**:
 ansible-test integration -v lookup_flattened
 ```

README.md

@@ -6,7 +6,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-10)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-8)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
 [![EOL CI](https://github.com/ansible-collections/community.general/workflows/EOL%20CI/badge.svg?event=push)](https://github.com/ansible-collections/community.general/actions)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-collections/community.general)](https://api.reuse.software/info/github.com/ansible-collections/community.general)
@@ -23,21 +23,9 @@ We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/comm
 
 If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
 
-## Communication
-
-* Join the Ansible forum:
-  * [Get Help](https://forum.ansible.com/c/help/6): get help or help others. This is for questions about modules or plugins in the collection. Please add appropriate tags if you start new discussions.
-  * [Tag `community-general`](https://forum.ansible.com/tag/community-general): discuss the *collection itself*, instead of specific modules or plugins.
-  * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
-  * [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
-
-* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
-
-For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
-
 ## Tested with Ansible
 
-Tested with the current ansible-core 2.15, ansible-core 2.16, ansible-core 2.17, ansible-core 2.18 releases and the current development version of ansible-core. Ansible-core versions before 2.15.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
+Tested with the current ansible-core 2.13, ansible-core 2.14, ansible-core 2.15, ansible-core 2.16, ansible-core 2.17 releases and the current development version of ansible-core. Ansible-core versions before 2.13.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.
 
 ## External requirements
 
@@ -110,13 +98,25 @@ It is necessary for maintainers of this collection to be subscribed to:
 
 They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
 
+## Communication
+
+We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed.
+
+Join us in the `#ansible` (general use questions and support), `#ansible-community` (community and collection development questions), and other [IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels) on [Libera.chat](https://libera.chat).
+
+We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
+
+For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
+
+For more information about communication, refer to Ansible's the [Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+
 ## Publishing New Version
 
 See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection.
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-10/CHANGELOG.md).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-8/CHANGELOG.md).
 
 ## Roadmap
 
@@ -135,8 +135,8 @@ See [this issue](https://github.com/ansible-collections/community.general/issues
 
 This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.
 
-See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/stable-10/COPYING) for the full text.
+See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.general/blob/main/COPYING) for the full text.
 
-Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/stable-10/LICENSES/PSF-2.0.txt).
+Parts of the collection are licensed under the [BSD 2-Clause license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/BSD-2-Clause.txt), the [MIT license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/MIT.txt), and the [PSF 2.0 license](https://github.com/ansible-collections/community.general/blob/main/LICENSES/PSF-2.0.txt).
 
 All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `.reuse/dep5`. This conforms to the [REUSE specification](https://reuse.software/spec/).

changelogs/config.yaml

@@ -18,25 +18,23 @@ output_formats:
 prelude_section_name: release_summary
 prelude_section_title: Release Summary
 sections:
-  - - major_changes
-    - Major Changes
-  - - minor_changes
-    - Minor Changes
-  - - breaking_changes
-    - Breaking Changes / Porting Guide
-  - - deprecated_features
-    - Deprecated Features
-  - - removed_features
-    - Removed Features (previously deprecated)
-  - - security_fixes
-    - Security Fixes
-  - - bugfixes
-    - Bugfixes
-  - - known_issues
-    - Known Issues
+- - major_changes
+  - Major Changes
+- - minor_changes
+  - Minor Changes
+- - breaking_changes
+  - Breaking Changes / Porting Guide
+- - deprecated_features
+  - Deprecated Features
+- - removed_features
+  - Removed Features (previously deprecated)
+- - security_fixes
+  - Security Fixes
+- - bugfixes
+  - Bugfixes
+- - known_issues
+  - Known Issues
 title: Community General
 trivial_section_name: trivial
 use_fqcn: true
 add_plugin_period: true
-changelog_nice_yaml: true
-changelog_sort: version

docs/docsite/extra-docs.yml

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

docs/docsite/helper/keep_keys/README.md

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

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

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

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

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

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

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

docs/docsite/helper/keep_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/keep_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: keep_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

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

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

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

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

docs/docsite/helper/remove_keys/README.md

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

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

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

docs/docsite/helper/remove_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/remove_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: remove_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

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

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

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

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

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

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

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

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

docs/docsite/helper/replace_keys/README.md

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

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

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

docs/docsite/helper/replace_keys/playbook.yml

@@ -1,79 +0,0 @@
----
-# Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-# SPDX-License-Identifier: GPL-3.0-or-later
-
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# Create docs REST files
-# shell> ansible-playbook playbook.yml
-#
-# Proofread and copy created *.rst file into the directory
-# docs/docsite/rst. Do not add *.rst in this directory to the version
-# control.
-#
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-# community.general/docs/docsite/helper/replace_keys/playbook.yml
-
-- name: Create RST file for docs/docsite/rst
-  hosts: localhost
-  gather_facts: false
-
-  vars:
-
-    plugin: replace_keys
-    plugin_type: filter
-    docs_path:
-      - filter_guide
-      - abstract_informations
-      - lists_of_dictionaries
-
-    file_base: "{{ (docs_path + [plugin]) | join('-') }}"
-    file_rst: ../../rst/{{ file_base }}.rst
-    file_sha1: "{{ plugin }}.rst.sha1"
-
-    target: "../../../../tests/integration/targets/{{ plugin_type }}_{{ plugin }}"
-    target_vars: "{{ target }}/vars/main/tests.yml"
-    target_sha1: tests.yml.sha1
-
-  tasks:
-
-    - name: Test integrity tests.yml
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', target_sha1) != lookup('pipe', 'sha1sum ' ~  target_vars)
-      block:
-
-        - name: Changed tests.yml
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ target_vars }}
-              Review the changes and update {{ target_sha1 }}
-              shell> sha1sum {{ target_vars }} > {{ target_sha1 }}
-
-        - name: Changed tests.yml end host
-          ansible.builtin.meta: end_play
-
-    - name: Test integrity RST file
-      when:
-        - integrity | d(true) | bool
-        - lookup('file', file_sha1) != lookup('pipe', 'sha1sum ' ~ file_rst)
-      block:
-
-        - name: Changed RST file
-          ansible.builtin.debug:
-            msg: |
-              Changed {{ file_rst }}
-              Review the changes and update {{ file_sha1 }}
-              shell> sha1sum {{ file_rst }} > {{ file_sha1 }}
-
-        - name: Changed RST file end host
-          ansible.builtin.meta: end_play
-
-    - name: Include target vars
-      include_vars:
-        file: "{{ target_vars }}"
-
-    - name: Create RST file
-      ansible.builtin.template:
-        src: "{{ file_base }}.rst.j2"
-        dest: "{{ file_base }}.rst"

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

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

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

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

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

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

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

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

docs/docsite/links.yml

@@ -9,8 +9,6 @@ edit_on_github:
   path_prefix: ''
 
 extra_links:
-  - description: Ask for help
-    url: https://forum.ansible.com/c/help/6/none
   - description: Submit a bug report
     url: https://github.com/ansible-collections/community.general/issues/new?assignees=&labels=&template=bug_report.yml
   - description: Request a feature
@@ -24,10 +22,6 @@ communication:
     - topic: General usage and support questions
       network: Libera
       channel: '#ansible'
-  forums:
-    - topic: "Ansible Forum: General usage and support questions"
-      # The following URL directly points to the "Get Help" section
-      url: https://forum.ansible.com/c/help/6/none
-    - topic: "Ansible Forum: Discussions about the collection itself, not for specific modules or plugins"
-      # The following URL directly points to the "community-general" tag
-      url: https://forum.ansible.com/tag/community-general
+  mailing_lists:
+    - topic: Ansible Project List
+      url: https://groups.google.com/g/ansible-project

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

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

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

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

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

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

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

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

docs/docsite/rst/filter_guide_abstract_informations.rst

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

docs/docsite/rst/guide_cmdrunner.rst

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

docs/docsite/rst/guide_deps.rst

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

docs/docsite/rst/guide_modulehelper.rst

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

docs/docsite/rst/guide_vardict.rst

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

galaxy.yml

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

plugins/action/iptables_state.py

@@ -22,33 +22,25 @@ class ActionModule(ActionBase):
     _VALID_ARGS = frozenset(('path', 'state', 'table', 'noflush', 'counters', 'modprobe', 'ip_version', 'wait'))
     DEFAULT_SUDOABLE = True
 
-    @staticmethod
-    def msg_error__async_and_poll_not_zero(task_poll, task_async, max_timeout):
-        return (
-            "This module doesn't support async>0 and poll>0 when its 'state' param "
-            "is set to 'restored'. To enable its rollback feature (that needs the "
-            "module to run asynchronously on the remote), please set task attribute "
-            f"'poll' (={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended).")
-
-    @staticmethod
-    def msg_warning__no_async_is_no_rollback(task_poll, task_async, max_timeout):
-        return (
-            "Attempts to restore iptables state without rollback in case of mistake "
-            "may lead the ansible controller to loose access to the hosts and never "
-            "regain it before fixing firewall rules through a serial console, or any "
-            f"other way except SSH. Please set task attribute 'poll' (={task_poll}) to 0, and "
-            f"'async' (={task_async}) to a value >2 and not greater than 'ansible_timeout' (={max_timeout}) "
-            "(recommended).")
-
-    @staticmethod
-    def msg_warning__async_greater_than_timeout(task_poll, task_async, max_timeout):
-        return (
-            "You attempt to restore iptables state with rollback in case of mistake, "
-            "but with settings that will lead this rollback to happen AFTER that the "
-            "controller will reach its own timeout. Please set task attribute 'poll' "
-            f"(={task_poll}) to 0, and 'async' (={task_async}) to a value >2 and not greater than "
-            f"'ansible_timeout' (={max_timeout}) (recommended).")
+    MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO = (
+        "This module doesn't support async>0 and poll>0 when its 'state' param "
+        "is set to 'restored'. To enable its rollback feature (that needs the "
+        "module to run asynchronously on the remote), please set task attribute "
+        "'poll' (=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
+    MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK = (
+        "Attempts to restore iptables state without rollback in case of mistake "
+        "may lead the ansible controller to loose access to the hosts and never "
+        "regain it before fixing firewall rules through a serial console, or any "
+        "other way except SSH. Please set task attribute 'poll' (=%s) to 0, and "
+        "'async' (=%s) to a value >2 and not greater than 'ansible_timeout' (=%s) "
+        "(recommended).")
+    MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT = (
+        "You attempt to restore iptables state with rollback in case of mistake, "
+        "but with settings that will lead this rollback to happen AFTER that the "
+        "controller will reach its own timeout. Please set task attribute 'poll' "
+        "(=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
 
     def _async_result(self, async_status_args, task_vars, timeout):
         '''
@@ -96,25 +88,21 @@ class ActionModule(ActionBase):
             max_timeout = self._connection._play_context.timeout
             module_args = self._task.args
 
-            async_status_args = {}
-            starter_cmd = None
-            confirm_cmd = None
-
             if module_args.get('state', None) == 'restored':
                 if not wrap_async:
                     if not check_mode:
-                        display.warning(self.msg_error__async_and_poll_not_zero(
+                        display.warning(self.MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK % (
                             task_poll,
                             task_async,
                             max_timeout))
                 elif task_poll:
-                    raise AnsibleActionFail(self.msg_warning__no_async_is_no_rollback(
+                    raise AnsibleActionFail(self.MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO % (
                         task_poll,
                         task_async,
                         max_timeout))
                 else:
                     if task_async > max_timeout and not check_mode:
-                        display.warning(self.msg_warning__async_greater_than_timeout(
+                        display.warning(self.MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT % (
                             task_poll,
                             task_async,
                             max_timeout))
@@ -127,10 +115,10 @@ class ActionModule(ActionBase):
                     # remote and local sides (if not the same, make the loop
                     # longer on the controller); and set a backup file path.
                     module_args['_timeout'] = task_async
-                    module_args['_back'] = f'{async_dir}/iptables.state'
+                    module_args['_back'] = '%s/iptables.state' % async_dir
                     async_status_args = dict(mode='status')
-                    confirm_cmd = f"rm -f {module_args['_back']}"
-                    starter_cmd = f"touch {module_args['_back']}.starter"
+                    confirm_cmd = 'rm -f %s' % module_args['_back']
+                    starter_cmd = 'touch %s.starter' % module_args['_back']
                     remaining_time = max(task_async, max_timeout)
 
             # do work!

plugins/action/shutdown.py

@@ -18,10 +18,6 @@ from ansible.utils.display import Display
 display = Display()
 
 
-def fmt(mapping, key):
-    return to_native(mapping[key]).strip()
-
-
 class TimedOutException(Exception):
     pass
 
@@ -88,26 +84,31 @@ class ActionModule(ActionBase):
     def get_distribution(self, task_vars):
         # FIXME: only execute the module if we don't already have the facts we need
         distribution = {}
-        display.debug(f'{self._task.action}: running setup module to get distribution')
+        display.debug('{action}: running setup module to get distribution'.format(action=self._task.action))
         module_output = self._execute_module(
             task_vars=task_vars,
             module_name='ansible.legacy.setup',
             module_args={'gather_subset': 'min'})
         try:
             if module_output.get('failed', False):
-                raise AnsibleError(f"Failed to determine system distribution. {fmt(module_output, 'module_stdout')}, {fmt(module_output, 'module_stderr')}")
+                raise AnsibleError('Failed to determine system distribution. {0}, {1}'.format(
+                    to_native(module_output['module_stdout']).strip(),
+                    to_native(module_output['module_stderr']).strip()))
             distribution['name'] = module_output['ansible_facts']['ansible_distribution'].lower()
             distribution['version'] = to_text(
                 module_output['ansible_facts']['ansible_distribution_version'].split('.')[0])
             distribution['family'] = to_text(module_output['ansible_facts']['ansible_os_family'].lower())
-            display.debug(f"{self._task.action}: distribution: {distribution}")
+            display.debug("{action}: distribution: {dist}".format(action=self._task.action, dist=distribution))
             return distribution
         except KeyError as ke:
-            raise AnsibleError(f'Failed to get distribution information. Missing "{ke.args[0]}" in output.')
+            raise AnsibleError('Failed to get distribution information. Missing "{0}" in output.'.format(ke.args[0]))
 
     def get_shutdown_command(self, task_vars, distribution):
         def find_command(command, find_search_paths):
-            display.debug(f'{self._task.action}: running find module looking in {find_search_paths} to get path for "{command}"')
+            display.debug('{action}: running find module looking in {paths} to get path for "{command}"'.format(
+                action=self._task.action,
+                command=command,
+                paths=find_search_paths))
             find_result = self._execute_module(
                 task_vars=task_vars,
                 # prevent collection search by calling with ansible.legacy (still allows library/ override of find)
@@ -129,37 +130,42 @@ class ActionModule(ActionBase):
         if is_string(search_paths):
             search_paths = [search_paths]
 
+        # Error if we didn't get a list
+        err_msg = "'search_paths' must be a string or flat list of strings, got {0}"
         try:
             incorrect_type = any(not is_string(x) for x in search_paths)
             if not isinstance(search_paths, list) or incorrect_type:
                 raise TypeError
         except TypeError:
-            # Error if we didn't get a list
-            err_msg = f"'search_paths' must be a string or flat list of strings, got {search_paths}"
-            raise AnsibleError(err_msg)
+            raise AnsibleError(err_msg.format(search_paths))
 
         full_path = find_command(shutdown_bin, search_paths)  # find the path to the shutdown command
         if not full_path:  # if we could not find the shutdown command
-
-            # tell the user we will try with systemd
-            display.vvv(f'Unable to find command "{shutdown_bin}" in search paths: {search_paths}, will attempt a shutdown using systemd directly.')
+            display.vvv('Unable to find command "{0}" in search paths: {1}, will attempt a shutdown using systemd '
+                        'directly.'.format(shutdown_bin, search_paths))  # tell the user we will try with systemd
             systemctl_search_paths = ['/bin', '/usr/bin']
             full_path = find_command('systemctl', systemctl_search_paths)  # find the path to the systemctl command
             if not full_path:  # if we couldn't find systemctl
                 raise AnsibleError(
-                    f'Could not find command "{shutdown_bin}" in search paths: {search_paths} or systemctl'
-                    f' command in search paths: {systemctl_search_paths}, unable to shutdown.')  # we give up here
+                    'Could not find command "{0}" in search paths: {1} or systemctl command in search paths: {2}, unable to shutdown.'.
+                    format(shutdown_bin, search_paths, systemctl_search_paths))  # we give up here
             else:
-                return f"{full_path[0]} poweroff"  # done, since we cannot use args with systemd shutdown
+                return "{0} poweroff".format(full_path[0])  # done, since we cannot use args with systemd shutdown
 
         # systemd case taken care of, here we add args to the command
         args = self._get_value_from_facts('SHUTDOWN_COMMAND_ARGS', distribution, 'DEFAULT_SHUTDOWN_COMMAND_ARGS')
         # Convert seconds to minutes. If less that 60, set it to 0.
         delay_sec = self.delay
         shutdown_message = self._task.args.get('msg', self.DEFAULT_SHUTDOWN_MESSAGE)
-
-        af = args.format(delay_sec=delay_sec, delay_min=delay_sec // 60, message=shutdown_message)
-        return f'{full_path[0]} {af}'
+        return '{0} {1}'. \
+            format(
+                full_path[0],
+                args.format(
+                    delay_sec=delay_sec,
+                    delay_min=delay_sec // 60,
+                    message=shutdown_message
+                )
+            )
 
     def perform_shutdown(self, task_vars, distribution):
         result = {}
@@ -168,8 +174,9 @@ class ActionModule(ActionBase):
 
         self.cleanup(force=True)
         try:
-            display.vvv(f"{self._task.action}: shutting down server...")
-            display.debug(f"{self._task.action}: shutting down server with command '{shutdown_command_exec}'")
+            display.vvv("{action}: shutting down server...".format(action=self._task.action))
+            display.debug("{action}: shutting down server with command '{command}'".
+                          format(action=self._task.action, command=shutdown_command_exec))
             if self._play_context.check_mode:
                 shutdown_result['rc'] = 0
             else:
@@ -177,13 +184,16 @@ class ActionModule(ActionBase):
         except AnsibleConnectionFailure as e:
             # If the connection is closed too quickly due to the system being shutdown, carry on
             display.debug(
-                f'{self._task.action}: AnsibleConnectionFailure caught and handled: {e}')
+                '{action}: AnsibleConnectionFailure caught and handled: {error}'.format(action=self._task.action,
+                                                                                        error=to_text(e)))
             shutdown_result['rc'] = 0
 
         if shutdown_result['rc'] != 0:
             result['failed'] = True
             result['shutdown'] = False
-            result['msg'] = f"Shutdown command failed. Error was {fmt(shutdown_result, 'stdout')}, {fmt(shutdown_result, 'stderr')}"
+            result['msg'] = "Shutdown command failed. Error was {stdout}, {stderr}".format(
+                stdout=to_native(shutdown_result['stdout'].strip()),
+                stderr=to_native(shutdown_result['stderr'].strip()))
             return result
 
         result['failed'] = False
@@ -196,7 +206,7 @@ class ActionModule(ActionBase):
 
         # If running with local connection, fail so we don't shutdown ourself
         if self._connection.transport == 'local' and (not self._play_context.check_mode):
-            msg = f'Running {self._task.action} with local connection would shutdown the control node.'
+            msg = 'Running {0} with local connection would shutdown the control node.'.format(self._task.action)
             return {'changed': False, 'elapsed': 0, 'shutdown': False, 'failed': True, 'msg': msg}
 
         if task_vars is None:

plugins/become/doas.py

@@ -5,86 +5,80 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: doas
-short_description: Do As user
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(doas) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: doas_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_doas_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_DOAS_USER
-  become_exe:
-    description: C(doas) executable.
-    type: string
-    default: doas
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: doas_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_doas_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_DOAS_EXE
-  become_flags:
-    description: Options to pass to C(doas).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: doas_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_doas_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_DOAS_FLAGS
-  become_pass:
-    description: Password for C(doas) prompt.
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_doas_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_DOAS_PASS
-    ini:
-      - section: doas_become_plugin
-        key: password
-  prompt_l10n:
+DOCUMENTATION = '''
+    name: doas
+    short_description: Do As user
     description:
-      - List of localized strings to match for prompt detection.
-      - If empty we will use the built in one.
-    type: list
-    elements: string
-    default: []
-    ini:
-      - section: doas_become_plugin
-        key: localized_prompts
-    vars:
-      - name: ansible_doas_prompt_l10n
-    env:
-      - name: ANSIBLE_DOAS_PROMPT_L10N
-"""
+        - This become plugins allows your remote/login user to execute commands as another user via the doas utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: doas_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_doas_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_DOAS_USER
+        become_exe:
+            description: Doas executable
+            default: doas
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: doas_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_doas_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_DOAS_EXE
+        become_flags:
+            description: Options to pass to doas
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: doas_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_doas_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_DOAS_FLAGS
+        become_pass:
+            description: password for doas prompt
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_doas_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_DOAS_PASS
+            ini:
+              - section: doas_become_plugin
+                key: password
+        prompt_l10n:
+            description:
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
+            default: []
+            ini:
+              - section: doas_become_plugin
+                key: localized_prompts
+            vars:
+              - name: ansible_doas_prompt_l10n
+            env:
+              - name: ANSIBLE_DOAS_PROMPT_L10N
+'''
 
 import re
 
@@ -125,9 +119,9 @@ class BecomeModule(BecomeBase):
             flags += ' -n'
 
         become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
+        user = '-u %s' % (become_user) if become_user else ''
 
         success_cmd = self._build_success_command(cmd, shell, noexe=True)
         executable = getattr(shell, 'executable', shell.SHELL_FAMILY)
 
-        return f'{become_exe} {flags} {user} {executable} -c {success_cmd}'
+        return '%s %s %s %s -c %s' % (become_exe, flags, user, executable, success_cmd)

plugins/become/dzdo.py

@@ -5,72 +5,68 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: dzdo
-short_description: Centrify's Direct Authorize
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(dzdo) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: dzdo_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_dzdo_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_DZDO_USER
-  become_exe:
-    description: C(dzdo) executable.
-    type: string
-    default: dzdo
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: dzdo_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_dzdo_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_DZDO_EXE
-  become_flags:
-    description: Options to pass to C(dzdo).
-    type: string
-    default: -H -S -n
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: dzdo_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_dzdo_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_DZDO_FLAGS
-  become_pass:
-    description: Options to pass to C(dzdo).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_dzdo_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_DZDO_PASS
-    ini:
-      - section: dzdo_become_plugin
-        key: password
-"""
+DOCUMENTATION = '''
+    name: dzdo
+    short_description: Centrify's Direct Authorize
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the dzdo utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: dzdo_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_dzdo_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_DZDO_USER
+        become_exe:
+            description: Dzdo executable
+            default: dzdo
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: dzdo_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_dzdo_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_DZDO_EXE
+        become_flags:
+            description: Options to pass to dzdo
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: dzdo_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_dzdo_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_DZDO_FLAGS
+        become_pass:
+            description: Options to pass to dzdo
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_dzdo_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_DZDO_PASS
+            ini:
+              - section: dzdo_become_plugin
+                key: password
+'''
 
 from ansible.plugins.become import BecomeBase
 
@@ -92,10 +88,10 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         if self.get_option('become_pass'):
-            self.prompt = f'[dzdo via ansible, key={self._id}] password:'
-            flags = f"{flags.replace('-n', '')} -p \"{self.prompt}\""
+            self.prompt = '[dzdo via ansible, key=%s] password:' % self._id
+            flags = '%s -p "%s"' % (flags.replace('-n', ''), self.prompt)
 
         become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
+        user = '-u %s' % (become_user) if become_user else ''
 
-        return f"{becomecmd} {flags} {user} {self._build_success_command(cmd, shell)}"
+        return ' '.join([becomecmd, flags, user, self._build_success_command(cmd, shell)])

plugins/become/ksu.py

@@ -5,87 +5,81 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: ksu
-short_description: Kerberos substitute user
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(ksu) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: ksu_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_ksu_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_KSU_USER
-    required: true
-  become_exe:
-    description: C(ksu) executable.
-    type: string
-    default: ksu
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: ksu_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_ksu_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_KSU_EXE
-  become_flags:
-    description: Options to pass to C(ksu).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: ksu_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_ksu_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_KSU_FLAGS
-  become_pass:
-    description: C(ksu) password.
-    type: string
-    required: false
-    vars:
-      - name: ansible_ksu_pass
-      - name: ansible_become_pass
-      - name: ansible_become_password
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_KSU_PASS
-    ini:
-      - section: ksu_become_plugin
-        key: password
-  prompt_l10n:
+DOCUMENTATION = '''
+    name: ksu
+    short_description: Kerberos substitute user
     description:
-      - List of localized strings to match for prompt detection.
-      - If empty we will use the built in one.
-    type: list
-    elements: string
-    default: []
-    ini:
-      - section: ksu_become_plugin
-        key: localized_prompts
-    vars:
-      - name: ansible_ksu_prompt_l10n
-    env:
-      - name: ANSIBLE_KSU_PROMPT_L10N
-"""
+        - This become plugins allows your remote/login user to execute commands as another user via the ksu utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: ksu_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_ksu_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_KSU_USER
+            required: true
+        become_exe:
+            description: Su executable
+            default: ksu
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: ksu_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_ksu_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_KSU_EXE
+        become_flags:
+            description: Options to pass to ksu
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: ksu_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_ksu_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_KSU_FLAGS
+        become_pass:
+            description: ksu password
+            required: false
+            vars:
+              - name: ansible_ksu_pass
+              - name: ansible_become_pass
+              - name: ansible_become_password
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_KSU_PASS
+            ini:
+              - section: ksu_become_plugin
+                key: password
+        prompt_l10n:
+            description:
+                - List of localized strings to match for prompt detection
+                - If empty we'll use the built in one
+            default: []
+            ini:
+              - section: ksu_become_plugin
+                key: localized_prompts
+            vars:
+              - name: ansible_ksu_prompt_l10n
+            env:
+              - name: ANSIBLE_KSU_PROMPT_L10N
+'''
 
 import re
 
@@ -124,4 +118,4 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         user = self.get_option('become_user')
-        return f'{exe} {user} {flags} -e {self._build_success_command(cmd, shell)} '
+        return '%s %s %s -e %s ' % (exe, user, flags, self._build_success_command(cmd, shell))

plugins/become/machinectl.py

@@ -5,90 +5,86 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: machinectl
-short_description: Systemd's machinectl privilege escalation
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(machinectl) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: machinectl_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_machinectl_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_MACHINECTL_USER
-  become_exe:
-    description: C(machinectl) executable.
-    type: string
-    default: machinectl
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: machinectl_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_machinectl_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_MACHINECTL_EXE
-  become_flags:
-    description: Options to pass to C(machinectl).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: machinectl_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_machinectl_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_MACHINECTL_FLAGS
-  become_pass:
-    description: Password for C(machinectl).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_machinectl_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_MACHINECTL_PASS
-    ini:
-      - section: machinectl_become_plugin
-        key: password
-notes:
-  - When not using this plugin with user V(root), it only works correctly with a polkit rule which will alter the behaviour
-    of machinectl. This rule must alter the prompt behaviour to ask directly for the user credentials, if the user is allowed
-    to perform the action (take a look at the examples section). If such a rule is not present the plugin only work if it
-    is used in context with the root user, because then no further prompt will be shown by machinectl.
-"""
+DOCUMENTATION = '''
+    name: machinectl
+    short_description: Systemd's machinectl privilege escalation
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the machinectl utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: machinectl_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_machinectl_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_MACHINECTL_USER
+        become_exe:
+            description: Machinectl executable
+            default: machinectl
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: machinectl_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_machinectl_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_MACHINECTL_EXE
+        become_flags:
+            description: Options to pass to machinectl
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: machinectl_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_machinectl_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_MACHINECTL_FLAGS
+        become_pass:
+            description: Password for machinectl
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_machinectl_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_MACHINECTL_PASS
+            ini:
+              - section: machinectl_become_plugin
+                key: password
+    notes:
+      - When not using this plugin with user V(root), it only works correctly with a polkit rule which will alter
+        the behaviour of machinectl. This rule must alter the prompt behaviour to ask directly for the user credentials,
+        if the user is allowed to perform the action (take a look at the examples section).
+        If such a rule is not present the plugin only work if it is used in context with the root user,
+        because then no further prompt will be shown by machinectl.
+'''
 
-EXAMPLES = r"""
+EXAMPLES = r'''
 # A polkit rule needed to use the module with a non-root user.
 # See the Notes section for details.
-/etc/polkit-1/rules.d/60-machinectl-fast-user-auth.rules: |-
-  polkit.addRule(function(action, subject) {
-    if(action.id == "org.freedesktop.machine1.host-shell" &&
-      subject.isInGroup("wheel")) {
-        return polkit.Result.AUTH_SELF_KEEP;
-    }
-  });
-"""
+60-machinectl-fast-user-auth.rules: |
+    polkit.addRule(function(action, subject) {
+        if(action.id == "org.freedesktop.machine1.host-shell" && subject.isInGroup("wheel")) {
+            return polkit.Result.AUTH_SELF_KEEP;
+        }
+    });
+'''
 
 from re import compile as re_compile
 
@@ -122,7 +118,7 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         user = self.get_option('become_user')
-        return f'{become} -q shell {flags} {user}@ {self._build_success_command(cmd, shell)}'
+        return '%s -q shell %s %s@ %s' % (become, flags, user, self._build_success_command(cmd, shell))
 
     def check_success(self, b_output):
         b_output = self.remove_ansi_codes(b_output)

plugins/become/pbrun.py

@@ -5,84 +5,80 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: pbrun
-short_description: PowerBroker run
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(pbrun) utility.
-author: Ansible Core Team
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: pbrun_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_pbrun_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_PBRUN_USER
-  become_exe:
-    description: C(pbrun) executable.
-    type: string
-    default: pbrun
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: pbrun_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_pbrun_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_PBRUN_EXE
-  become_flags:
-    description: Options to pass to C(pbrun).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: pbrun_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_pbrun_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_PBRUN_FLAGS
-  become_pass:
-    description: Password for C(pbrun).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_pbrun_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_PBRUN_PASS
-    ini:
-      - section: pbrun_become_plugin
-        key: password
-  wrap_exe:
-    description: Toggle to wrap the command C(pbrun) calls in C(shell -c) or not.
-    default: false
-    type: bool
-    ini:
-      - section: pbrun_become_plugin
-        key: wrap_execution
-    vars:
-      - name: ansible_pbrun_wrap_execution
-    env:
-      - name: ANSIBLE_PBRUN_WRAP_EXECUTION
-"""
+DOCUMENTATION = '''
+    name: pbrun
+    short_description: PowerBroker run
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the pbrun utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: pbrun_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_pbrun_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_PBRUN_USER
+        become_exe:
+            description: Sudo executable
+            default: pbrun
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: pbrun_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_pbrun_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_PBRUN_EXE
+        become_flags:
+            description: Options to pass to pbrun
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: pbrun_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_pbrun_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_PBRUN_FLAGS
+        become_pass:
+            description: Password for pbrun
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_pbrun_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_PBRUN_PASS
+            ini:
+              - section: pbrun_become_plugin
+                key: password
+        wrap_exe:
+            description: Toggle to wrap the command pbrun calls in 'shell -c' or not
+            default: false
+            type: bool
+            ini:
+              - section: pbrun_become_plugin
+                key: wrap_execution
+            vars:
+              - name: ansible_pbrun_wrap_execution
+            env:
+              - name: ANSIBLE_PBRUN_WRAP_EXECUTION
+'''
 
 from ansible.plugins.become import BecomeBase
 
@@ -103,7 +99,7 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         become_user = self.get_option('become_user')
-        user = f'-u {become_user}' if become_user else ''
+        user = '-u %s' % (become_user) if become_user else ''
         noexe = not self.get_option('wrap_exe')
 
-        return f"{become_exe} {flags} {user} {self._build_success_command(cmd, shell, noexe=noexe)}"
+        return ' '.join([become_exe, flags, user, self._build_success_command(cmd, shell, noexe=noexe)])

plugins/become/pfexec.py

@@ -5,89 +5,85 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: pfexec
-short_description: profile based execution
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(pfexec) utility.
-author: Ansible Core Team
-options:
-  become_user:
+DOCUMENTATION = '''
+    name: pfexec
+    short_description: profile based execution
     description:
-      - User you 'become' to execute the task.
-      - This plugin ignores this setting as pfexec uses its own C(exec_attr) to figure this out, but it is supplied here
-        for Ansible to make decisions needed for the task execution, like file permissions.
-    type: string
-    default: root
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: pfexec_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_pfexec_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_PFEXEC_USER
-  become_exe:
-    description: C(pfexec) executable.
-    type: string
-    default: pfexec
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: pfexec_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_pfexec_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_PFEXEC_EXE
-  become_flags:
-    description: Options to pass to C(pfexec).
-    type: string
-    default: -H -S -n
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: pfexec_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_pfexec_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_PFEXEC_FLAGS
-  become_pass:
-    description: C(pfexec) password.
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_pfexec_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_PFEXEC_PASS
-    ini:
-      - section: pfexec_become_plugin
-        key: password
-  wrap_exe:
-    description: Toggle to wrap the command C(pfexec) calls in C(shell -c) or not.
-    default: false
-    type: bool
-    ini:
-      - section: pfexec_become_plugin
-        key: wrap_execution
-    vars:
-      - name: ansible_pfexec_wrap_execution
-    env:
-      - name: ANSIBLE_PFEXEC_WRAP_EXECUTION
-notes:
-  - This plugin ignores O(become_user) as pfexec uses its own C(exec_attr) to figure this out.
-"""
+        - This become plugins allows your remote/login user to execute commands as another user via the pfexec utility.
+    author: Ansible Core Team
+    options:
+        become_user:
+            description:
+                - User you 'become' to execute the task
+                - This plugin ignores this setting as pfexec uses it's own C(exec_attr) to figure this out,
+                  but it is supplied here for Ansible to make decisions needed for the task execution, like file permissions.
+            default: root
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: pfexec_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_pfexec_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_PFEXEC_USER
+        become_exe:
+            description: Sudo executable
+            default: pfexec
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: pfexec_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_pfexec_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_PFEXEC_EXE
+        become_flags:
+            description: Options to pass to pfexec
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: pfexec_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_pfexec_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_PFEXEC_FLAGS
+        become_pass:
+            description: pfexec password
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_pfexec_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_PFEXEC_PASS
+            ini:
+              - section: pfexec_become_plugin
+                key: password
+        wrap_exe:
+            description: Toggle to wrap the command pfexec calls in 'shell -c' or not
+            default: false
+            type: bool
+            ini:
+              - section: pfexec_become_plugin
+                key: wrap_execution
+            vars:
+              - name: ansible_pfexec_wrap_execution
+            env:
+              - name: ANSIBLE_PFEXEC_WRAP_EXECUTION
+    notes:
+      - This plugin ignores O(become_user) as pfexec uses it's own C(exec_attr) to figure this out.
+'''
 
 from ansible.plugins.become import BecomeBase
 
@@ -106,4 +102,4 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         noexe = not self.get_option('wrap_exe')
-        return f'{exe} {flags} {self._build_success_command(cmd, shell, noexe=noexe)}'
+        return '%s %s %s' % (exe, flags, self._build_success_command(cmd, shell, noexe=noexe))

plugins/become/pmrun.py

@@ -5,60 +5,57 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: pmrun
-short_description: Privilege Manager run
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(pmrun) utility.
-author: Ansible Core Team
-options:
-  become_exe:
-    description: C(pmrun) executable.
-    type: string
-    default: pmrun
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: pmrun_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_pmrun_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_PMRUN_EXE
-  become_flags:
-    description: Options to pass to C(pmrun).
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: pmrun_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_pmrun_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_PMRUN_FLAGS
-  become_pass:
-    description: C(pmrun) password.
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_pmrun_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_PMRUN_PASS
-    ini:
-      - section: pmrun_become_plugin
-        key: password
-notes:
-  - This plugin ignores the C(become_user) supplied and uses C(pmrun)'s own configuration to select the user.
-"""
+DOCUMENTATION = '''
+    name: pmrun
+    short_description: Privilege Manager run
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the pmrun utility.
+    author: Ansible Core Team
+    options:
+        become_exe:
+            description: Sudo executable
+            default: pmrun
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: pmrun_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_pmrun_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_PMRUN_EXE
+        become_flags:
+            description: Options to pass to pmrun
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: pmrun_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_pmrun_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_PMRUN_FLAGS
+        become_pass:
+            description: pmrun password
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_pmrun_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_PMRUN_PASS
+            ini:
+              - section: pmrun_become_plugin
+                key: password
+    notes:
+      - This plugin ignores the become_user supplied and uses pmrun's own configuration to select the user.
+'''
 
 from ansible.plugins.become import BecomeBase
 from ansible.module_utils.six.moves import shlex_quote
@@ -78,4 +75,4 @@ class BecomeModule(BecomeBase):
         become = self.get_option('become_exe')
 
         flags = self.get_option('become_flags')
-        return f'{become} {flags} {shlex_quote(self._build_success_command(cmd, shell))}'
+        return '%s %s %s' % (become, flags, shlex_quote(self._build_success_command(cmd, shell)))

plugins/become/run0.py

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

plugins/become/sesu.py

@@ -5,73 +5,69 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: sesu
-short_description: CA Privileged Access Manager
-description:
-  - This become plugins allows your remote/login user to execute commands as another user using the C(sesu) utility.
-author: ansible (@nekonyuu)
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    default: ''
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: sesu_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_sesu_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_SESU_USER
-  become_exe:
-    description: C(sesu) executable.
-    type: string
-    default: sesu
-    ini:
-      - section: privilege_escalation
-        key: become_exe
-      - section: sesu_become_plugin
-        key: executable
-    vars:
-      - name: ansible_become_exe
-      - name: ansible_sesu_exe
-    env:
-      - name: ANSIBLE_BECOME_EXE
-      - name: ANSIBLE_SESU_EXE
-  become_flags:
-    description: Options to pass to C(sesu).
-    type: string
-    default: -H -S -n
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: sesu_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_sesu_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_SESU_FLAGS
-  become_pass:
-    description: Password to pass to C(sesu).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_sesu_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_SESU_PASS
-    ini:
-      - section: sesu_become_plugin
-        key: password
-"""
+DOCUMENTATION = '''
+    name: sesu
+    short_description: CA Privileged Access Manager
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the sesu utility.
+    author: ansible (@nekonyuu)
+    options:
+        become_user:
+            description: User you 'become' to execute the task
+            default: ''
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: sesu_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_sesu_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_SESU_USER
+        become_exe:
+            description: sesu executable
+            default: sesu
+            ini:
+              - section: privilege_escalation
+                key: become_exe
+              - section: sesu_become_plugin
+                key: executable
+            vars:
+              - name: ansible_become_exe
+              - name: ansible_sesu_exe
+            env:
+              - name: ANSIBLE_BECOME_EXE
+              - name: ANSIBLE_SESU_EXE
+        become_flags:
+            description: Options to pass to sesu
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: sesu_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_sesu_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_SESU_FLAGS
+        become_pass:
+            description: Password to pass to sesu
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_sesu_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_SESU_PASS
+            ini:
+              - section: sesu_become_plugin
+                key: password
+'''
 
 from ansible.plugins.become import BecomeBase
 
@@ -93,4 +89,4 @@ class BecomeModule(BecomeBase):
 
         flags = self.get_option('become_flags')
         user = self.get_option('become_user')
-        return f'{become} {flags} {user} -c {self._build_success_command(cmd, shell)}'
+        return '%s %s %s -c %s' % (become, flags, user, self._build_success_command(cmd, shell))

plugins/become/sudosu.py

@@ -5,75 +5,56 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: sudosu
-short_description: Run tasks using sudo su -
-description:
-  - This become plugin allows your remote/login user to execute commands as another user using the C(sudo) and C(su) utilities
-    combined.
-author:
-  - Dag Wieers (@dagwieers)
-version_added: 2.4.0
-options:
-  become_user:
-    description: User you 'become' to execute the task.
-    type: string
-    default: root
-    ini:
-      - section: privilege_escalation
-        key: become_user
-      - section: sudo_become_plugin
-        key: user
-    vars:
-      - name: ansible_become_user
-      - name: ansible_sudo_user
-    env:
-      - name: ANSIBLE_BECOME_USER
-      - name: ANSIBLE_SUDO_USER
-  become_flags:
-    description: Options to pass to C(sudo).
-    type: string
-    default: -H -S -n
-    ini:
-      - section: privilege_escalation
-        key: become_flags
-      - section: sudo_become_plugin
-        key: flags
-    vars:
-      - name: ansible_become_flags
-      - name: ansible_sudo_flags
-    env:
-      - name: ANSIBLE_BECOME_FLAGS
-      - name: ANSIBLE_SUDO_FLAGS
-  become_pass:
-    description: Password to pass to C(sudo).
-    type: string
-    required: false
-    vars:
-      - name: ansible_become_password
-      - name: ansible_become_pass
-      - name: ansible_sudo_pass
-    env:
-      - name: ANSIBLE_BECOME_PASS
-      - name: ANSIBLE_SUDO_PASS
-    ini:
-      - section: sudo_become_plugin
-        key: password
-  alt_method:
+DOCUMENTATION = """
+    name: sudosu
+    short_description: Run tasks using sudo su -
     description:
-      - Whether to use an alternative method to call C(su). Instead of running C(su -l user /path/to/shell -c command), it
-        runs C(su -l user -c command).
-      - Use this when the default one is not working on your system.
-    required: false
-    type: boolean
-    ini:
-      - section: community.general.sudosu
-        key: alternative_method
-    vars:
-      - name: ansible_sudosu_alt_method
-    env:
-      - name: ANSIBLE_SUDOSU_ALT_METHOD
-    version_added: 9.2.0
+      - This become plugin allows your remote/login user to execute commands as another user via the C(sudo) and C(su) utilities combined.
+    author:
+      - Dag Wieers (@dagwieers)
+    version_added: 2.4.0
+    options:
+        become_user:
+            description: User you 'become' to execute the task.
+            default: root
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: sudo_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_sudo_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_SUDO_USER
+        become_flags:
+            description: Options to pass to C(sudo).
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: sudo_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_sudo_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_SUDO_FLAGS
+        become_pass:
+            description: Password to pass to C(sudo).
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_sudo_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_SUDO_PASS
+            ini:
+              - section: sudo_become_plugin
+                key: password
 """
 
 
@@ -99,16 +80,13 @@ class BecomeModule(BecomeBase):
         flags = self.get_option('become_flags') or ''
         prompt = ''
         if self.get_option('become_pass'):
-            self.prompt = f'[sudo via ansible, key={self._id}] password:'
+            self.prompt = '[sudo via ansible, key=%s] password:' % self._id
             if flags:  # this could be simplified, but kept as is for now for backwards string matching
                 flags = flags.replace('-n', '')
-            prompt = f'-p "{self.prompt}"'
+            prompt = '-p "%s"' % (self.prompt)
 
         user = self.get_option('become_user') or ''
         if user:
-            user = f'{user}'
+            user = '%s' % (user)
 
-        if self.get_option('alt_method'):
-            return f"{becomecmd} {flags} {prompt} su -l {user} -c {self._build_success_command(cmd, shell, True)}"
-        else:
-            return f"{becomecmd} {flags} {prompt} su -l {user} {self._build_success_command(cmd, shell)}"
+        return ' '.join([becomecmd, flags, prompt, 'su -l', user, self._build_success_command(cmd, shell)])

plugins/cache/memcached.py

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

plugins/cache/pickle.py

@@ -8,41 +8,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: pickle
-short_description: Pickle formatted files
-description:
-  - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
-author: Brian Coca (@bcoca)
-options:
-  _uri:
-    required: true
+DOCUMENTATION = '''
+    name: pickle
+    short_description: Pickle formatted files.
     description:
-      - Path in which the cache plugin will save the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-    type: path
-  _prefix:
-    description: User defined prefix to use when creating the files.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-    type: string
-  _timeout:
-    default: 86400
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-    type: float
-"""
+        - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
+    author: Brian Coca (@bcoca)
+    options:
+      _uri:
+        required: true
+        description:
+          - Path in which the cache plugin will save the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the files
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+'''
 
 try:
     import cPickle as pickle

plugins/cache/redis.py

@@ -6,73 +6,69 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: redis
-short_description: Use Redis DB for cache
-description:
-  - This cache uses JSON formatted, per host records saved in Redis.
-requirements:
-  - redis>=2.4.5 (python lib)
-options:
-  _uri:
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: redis
+    short_description: Use Redis DB for cache
     description:
-      - A colon separated string of connection information for Redis.
-      - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
-      - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
-      - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
-    type: string
-    required: true
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-    ini:
-      - key: fact_caching_connection
-        section: defaults
-  _prefix:
-    description: User defined prefix to use when creating the DB entries.
-    type: string
-    default: ansible_facts
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-    ini:
-      - key: fact_caching_prefix
-        section: defaults
-  _keyset_name:
-    description: User defined name for cache keyset name.
-    type: string
-    default: ansible_cache_keys
-    env:
-      - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
-    ini:
-      - key: fact_caching_redis_keyset_name
-        section: defaults
-    version_added: 1.3.0
-  _sentinel_service_name:
-    description: The redis sentinel service name (or referenced as cluster name).
-    type: string
-    env:
-      - name: ANSIBLE_CACHE_REDIS_SENTINEL
-    ini:
-      - key: fact_caching_redis_sentinel
-        section: defaults
-    version_added: 1.3.0
-  _timeout:
-    default: 86400
-    type: integer
-        # TODO: determine whether it is OK to change to: type: float
-    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
-    env:
-      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-    ini:
-      - key: fact_caching_timeout
-        section: defaults
-"""
+        - This cache uses JSON formatted, per host records saved in Redis.
+    requirements:
+      - redis>=2.4.5 (python lib)
+    options:
+      _uri:
+        description:
+          - A colon separated string of connection information for Redis.
+          - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
+          - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
+          - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
+        required: true
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+        ini:
+          - key: fact_caching_connection
+            section: defaults
+      _prefix:
+        description: User defined prefix to use when creating the DB entries
+        default: ansible_facts
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+        ini:
+          - key: fact_caching_prefix
+            section: defaults
+      _keyset_name:
+        description: User defined name for cache keyset name.
+        default: ansible_cache_keys
+        env:
+          - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
+        ini:
+          - key: fact_caching_redis_keyset_name
+            section: defaults
+        version_added: 1.3.0
+      _sentinel_service_name:
+        description: The redis sentinel service name (or referenced as cluster name).
+        env:
+          - name: ANSIBLE_CACHE_REDIS_SENTINEL
+        ini:
+          - key: fact_caching_redis_sentinel
+            section: defaults
+        version_added: 1.3.0
+      _timeout:
+        default: 86400
+        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
+        env:
+          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+        ini:
+          - key: fact_caching_timeout
+            section: defaults
+        type: integer
+'''
 
 import re
 import time
 import json
 
 from ansible.errors import AnsibleError
+from ansible.module_utils.common.text.converters import to_native
 from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder
 from ansible.plugins.cache import BaseCacheModule
 from ansible.utils.display import Display
@@ -130,7 +126,7 @@ class CacheModule(BaseCacheModule):
             connection = self._parse_connection(self.re_url_conn, uri)
             self._db = StrictRedis(*connection, **kw)
 
-        display.vv(f'Redis connection: {self._db}')
+        display.vv('Redis connection: %s' % self._db)
 
     @staticmethod
     def _parse_connection(re_patt, uri):
@@ -163,12 +159,12 @@ class CacheModule(BaseCacheModule):
                 pass  # password is optional
 
         sentinels = [self._parse_connection(self.re_sent_conn, shost) for shost in connections]
-        display.vv(f'\nUsing redis sentinels: {sentinels}')
+        display.vv('\nUsing redis sentinels: %s' % sentinels)
         scon = Sentinel(sentinels, **kw)
         try:
             return scon.master_for(self._sentinel_service_name, socket_timeout=0.2)
         except Exception as exc:
-            raise AnsibleError(f'Could not connect to redis sentinel: {exc}')
+            raise AnsibleError('Could not connect to redis sentinel: %s' % to_native(exc))
 
     def _make_key(self, key):
         return self._prefix + key
@@ -226,7 +222,7 @@ class CacheModule(BaseCacheModule):
 
     def copy(self):
         # TODO: there is probably a better way to do this in redis
-        ret = {k: self.get(k) for k in self.keys()}
+        ret = dict([(k, self.get(k)) for k in self.keys()])
         return ret
 
     def __getstate__(self):

plugins/cache/yaml.py

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

plugins/callback/cgroup_memory_recap.py

@@ -7,41 +7,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: cgroup_memory_recap
-type: aggregate
-requirements:
-  - whitelist in configuration
-  - cgroups
-short_description: Profiles maximum memory usage of tasks and full execution using cgroups
-description:
-  - This is an Ansible callback plugin that profiles maximum memory usage of Ansible and individual tasks, and displays a
-    recap at the end using cgroups.
-notes:
-  - Requires ansible to be run from within a C(cgroup), such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
-  - This C(cgroup) should only be used by Ansible to get accurate results.
-  - To create the C(cgroup), first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
-options:
-  max_mem_file:
-    required: true
-    description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
-    type: str
-    env:
-      - name: CGROUP_MAX_MEM_FILE
-    ini:
-      - section: callback_cgroupmemrecap
-        key: max_mem_file
-  cur_mem_file:
-    required: true
-    description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
-    type: str
-    env:
-      - name: CGROUP_CUR_MEM_FILE
-    ini:
-      - section: callback_cgroupmemrecap
-        key: cur_mem_file
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: cgroup_memory_recap
+    type: aggregate
+    requirements:
+      - whitelist in configuration
+      - cgroups
+    short_description: Profiles maximum memory usage of tasks and full execution using cgroups
+    description:
+        - This is an ansible callback plugin that profiles maximum memory usage of ansible and individual tasks, and displays a recap at the end using cgroups.
+    notes:
+        - Requires ansible to be run from within a cgroup, such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
+        - This cgroup should only be used by ansible to get accurate results.
+        - To create the cgroup, first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
+    options:
+      max_mem_file:
+        required: true
+        description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
+        env:
+          - name: CGROUP_MAX_MEM_FILE
+        ini:
+          - section: callback_cgroupmemrecap
+            key: max_mem_file
+      cur_mem_file:
+        required: true
+        description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
+        env:
+          - name: CGROUP_CUR_MEM_FILE
+        ini:
+          - section: callback_cgroupmemrecap
+            key: cur_mem_file
+'''
 
 import time
 import threading
@@ -115,7 +112,7 @@ class CallbackModule(CallbackBase):
             max_results = int(f.read().strip()) / 1024 / 1024
 
         self._display.banner('CGROUP MEMORY RECAP')
-        self._display.display(f'Execution Maximum: {max_results:0.2f}MB\n\n')
+        self._display.display('Execution Maximum: %0.2fMB\n\n' % max_results)
 
         for task, memory in self.task_results:
-            self._display.display(f'{task.get_name()} ({task._uuid}): {memory:0.2f}MB')
+            self._display.display('%s (%s): %0.2fMB' % (task.get_name(), task._uuid, memory))

plugins/callback/context_demo.py

@@ -7,17 +7,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: context_demo
-type: aggregate
-short_description: demo callback that adds play/task context
-description:
-  - Displays some play and task context along with normal output.
-  - This is mostly for demo purposes.
-requirements:
-  - whitelist in configuration
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: context_demo
+    type: aggregate
+    short_description: demo callback that adds play/task context
+    description:
+      - Displays some play and task context along with normal output.
+      - This is mostly for demo purposes.
+    requirements:
+      - whitelist in configuration
+'''
 
 from ansible.plugins.callback import CallbackBase
 
@@ -38,15 +38,15 @@ class CallbackModule(CallbackBase):
         self.play = None
 
     def v2_on_any(self, *args, **kwargs):
-        self._display.display(f"--- play: {getattr(self.play, 'name', None)} task: {self.task} ---")
+        self._display.display("--- play: {0} task: {1} ---".format(getattr(self.play, 'name', None), self.task))
 
         self._display.display("     --- ARGS ")
         for i, a in enumerate(args):
-            self._display.display(f'     {i}: {a}')
+            self._display.display('     %s: %s' % (i, a))
 
         self._display.display("      --- KWARGS ")
         for k in kwargs:
-            self._display.display(f'     {k}: {kwargs[k]}')
+            self._display.display('     %s: %s' % (k, kwargs[k]))
 
     def v2_playbook_on_play_start(self, play):
         self.play = play

plugins/callback/counter_enabled.py

@@ -9,20 +9,20 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: counter_enabled
-type: stdout
-short_description: adds counters to the output items (tasks and hosts/task)
-description:
-  - Use this callback when you need a kind of progress bar on a large environments.
-  - You will know how many tasks has the playbook to run, and which one is actually running.
-  - You will know how many hosts may run a task, and which of them is actually running.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: counter_enabled
+    type: stdout
+    short_description: adds counters to the output items (tasks and hosts/task)
+    description:
+      - Use this callback when you need a kind of progress bar on a large environments.
+      - You will know how many tasks has the playbook to run, and which one is actually running.
+      - You will know how many hosts may run a task, and which of them is actually running.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
+'''
 
 from ansible import constants as C
 from ansible.plugins.callback import CallbackBase
@@ -71,7 +71,7 @@ class CallbackModule(CallbackBase):
         if not name:
             msg = u"play"
         else:
-            msg = f"PLAY [{name}]"
+            msg = u"PLAY [%s]" % name
 
         self._play = play
 
@@ -91,17 +91,25 @@ class CallbackModule(CallbackBase):
         for host in hosts:
             stat = stats.summarize(host)
 
-            self._display.display(
-                f"{hostcolor(host, stat)} : {colorize('ok', stat['ok'], C.COLOR_OK)} {colorize('changed', stat['changed'], C.COLOR_CHANGED)} "
-                f"{colorize('unreachable', stat['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', stat['failures'], C.COLOR_ERROR)} "
-                f"{colorize('rescued', stat['rescued'], C.COLOR_OK)} {colorize('ignored', stat['ignored'], C.COLOR_WARN)}",
+            self._display.display(u"%s : %s %s %s %s %s %s" % (
+                hostcolor(host, stat),
+                colorize(u'ok', stat['ok'], C.COLOR_OK),
+                colorize(u'changed', stat['changed'], C.COLOR_CHANGED),
+                colorize(u'unreachable', stat['unreachable'], C.COLOR_UNREACHABLE),
+                colorize(u'failed', stat['failures'], C.COLOR_ERROR),
+                colorize(u'rescued', stat['rescued'], C.COLOR_OK),
+                colorize(u'ignored', stat['ignored'], C.COLOR_WARN)),
                 screen_only=True
             )
 
-            self._display.display(
-                f"{hostcolor(host, stat, False)} : {colorize('ok', stat['ok'], None)} {colorize('changed', stat['changed'], None)} "
-                f"{colorize('unreachable', stat['unreachable'], None)} {colorize('failed', stat['failures'], None)} "
-                f"{colorize('rescued', stat['rescued'], None)} {colorize('ignored', stat['ignored'], None)}",
+            self._display.display(u"%s : %s %s %s %s %s %s" % (
+                hostcolor(host, stat, False),
+                colorize(u'ok', stat['ok'], None),
+                colorize(u'changed', stat['changed'], None),
+                colorize(u'unreachable', stat['unreachable'], None),
+                colorize(u'failed', stat['failures'], None),
+                colorize(u'rescued', stat['rescued'], None),
+                colorize(u'ignored', stat['ignored'], None)),
                 log_only=True
             )
 
@@ -116,14 +124,12 @@ class CallbackModule(CallbackBase):
             for k in sorted(stats.custom.keys()):
                 if k == '_run':
                     continue
-                _custom_stats = self._dump_results(stats.custom[k], indent=1).replace('\n', '')
-                self._display.display(f'\t{k}: {_custom_stats}')
+                self._display.display('\t%s: %s' % (k, self._dump_results(stats.custom[k], indent=1).replace('\n', '')))
 
             # print per run custom stats
             if '_run' in stats.custom:
                 self._display.display("", screen_only=True)
-                _custom_stats_run = self._dump_results(stats.custom['_run'], indent=1).replace('\n', '')
-                self._display.display(f'\tRUN: {_custom_stats_run}')
+                self._display.display('\tRUN: %s' % self._dump_results(stats.custom['_run'], indent=1).replace('\n', ''))
             self._display.display("", screen_only=True)
 
     def v2_playbook_on_task_start(self, task, is_conditional):
@@ -137,13 +143,13 @@ class CallbackModule(CallbackBase):
         # that they can secure this if they feel that their stdout is insecure
         # (shoulder surfing, logging stdout straight to a file, etc).
         if not task.no_log and C.DISPLAY_ARGS_TO_STDOUT:
-            args = ', '.join(('{k}={v}' for k, v in task.args.items()))
-            args = f' {args}'
-        self._display.banner(f"TASK {self._task_counter}/{self._task_total} [{task.get_name().strip()}{args}]")
+            args = ', '.join(('%s=%s' % a for a in task.args.items()))
+            args = ' %s' % args
+        self._display.banner("TASK %d/%d [%s%s]" % (self._task_counter, self._task_total, task.get_name().strip(), args))
         if self._display.verbosity >= 2:
             path = task.get_path()
             if path:
-                self._display.display(f"task path: {path}", color=C.COLOR_DEBUG)
+                self._display.display("task path: %s" % path, color=C.COLOR_DEBUG)
         self._host_counter = self._previous_batch_total
         self._task_counter += 1
 
@@ -160,15 +166,15 @@ class CallbackModule(CallbackBase):
             return
         elif result._result.get('changed', False):
             if delegated_vars:
-                msg = f"changed: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> {delegated_vars['ansible_host']}]"
+                msg = "changed: %d/%d [%s -> %s]" % (self._host_counter, self._host_total, result._host.get_name(), delegated_vars['ansible_host'])
             else:
-                msg = f"changed: {self._host_counter}/{self._host_total} [{result._host.get_name()}]"
+                msg = "changed: %d/%d [%s]" % (self._host_counter, self._host_total, result._host.get_name())
             color = C.COLOR_CHANGED
         else:
             if delegated_vars:
-                msg = f"ok: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> {delegated_vars['ansible_host']}]"
+                msg = "ok: %d/%d [%s -> %s]" % (self._host_counter, self._host_total, result._host.get_name(), delegated_vars['ansible_host'])
             else:
-                msg = f"ok: {self._host_counter}/{self._host_total} [{result._host.get_name()}]"
+                msg = "ok: %d/%d [%s]" % (self._host_counter, self._host_total, result._host.get_name())
             color = C.COLOR_OK
 
         self._handle_warnings(result._result)
@@ -179,7 +185,7 @@ class CallbackModule(CallbackBase):
             self._clean_results(result._result, result._task.action)
 
             if self._run_is_verbose(result):
-                msg += f" => {self._dump_results(result._result)}"
+                msg += " => %s" % (self._dump_results(result._result),)
             self._display.display(msg, color=color)
 
     def v2_runner_on_failed(self, result, ignore_errors=False):
@@ -200,16 +206,14 @@ class CallbackModule(CallbackBase):
 
         else:
             if delegated_vars:
-                self._display.display(
-                    f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> "
-                    f"{delegated_vars['ansible_host']}]: FAILED! => {self._dump_results(result._result)}",
-                    color=C.COLOR_ERROR
-                )
+                self._display.display("fatal: %d/%d [%s -> %s]: FAILED! => %s" % (self._host_counter, self._host_total,
+                                                                                  result._host.get_name(), delegated_vars['ansible_host'],
+                                                                                  self._dump_results(result._result)),
+                                      color=C.COLOR_ERROR)
             else:
-                self._display.display(
-                    f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()}]: FAILED! => {self._dump_results(result._result)}",
-                    color=C.COLOR_ERROR
-                )
+                self._display.display("fatal: %d/%d [%s]: FAILED! => %s" % (self._host_counter, self._host_total,
+                                                                            result._host.get_name(), self._dump_results(result._result)),
+                                      color=C.COLOR_ERROR)
 
         if ignore_errors:
             self._display.display("...ignoring", color=C.COLOR_SKIP)
@@ -227,9 +231,9 @@ class CallbackModule(CallbackBase):
             if result._task.loop and 'results' in result._result:
                 self._process_items(result)
             else:
-                msg = f"skipping: {self._host_counter}/{self._host_total} [{result._host.get_name()}]"
+                msg = "skipping: %d/%d [%s]" % (self._host_counter, self._host_total, result._host.get_name())
                 if self._run_is_verbose(result):
-                    msg += f" => {self._dump_results(result._result)}"
+                    msg += " => %s" % self._dump_results(result._result)
                 self._display.display(msg, color=C.COLOR_SKIP)
 
     def v2_runner_on_unreachable(self, result):
@@ -240,13 +244,11 @@ class CallbackModule(CallbackBase):
 
         delegated_vars = result._result.get('_ansible_delegated_vars', None)
         if delegated_vars:
-            self._display.display(
-                f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()} -> "
-                f"{delegated_vars['ansible_host']}]: UNREACHABLE! => {self._dump_results(result._result)}",
-                color=C.COLOR_UNREACHABLE
-            )
+            self._display.display("fatal: %d/%d [%s -> %s]: UNREACHABLE! => %s" % (self._host_counter, self._host_total,
+                                                                                   result._host.get_name(), delegated_vars['ansible_host'],
+                                                                                   self._dump_results(result._result)),
+                                  color=C.COLOR_UNREACHABLE)
         else:
-            self._display.display(
-                f"fatal: {self._host_counter}/{self._host_total} [{result._host.get_name()}]: UNREACHABLE! => {self._dump_results(result._result)}",
-                color=C.COLOR_UNREACHABLE
-            )
+            self._display.display("fatal: %d/%d [%s]: UNREACHABLE! => %s" % (self._host_counter, self._host_total,
+                                                                             result._host.get_name(), self._dump_results(result._result)),
+                                  color=C.COLOR_UNREACHABLE)

plugins/callback/default_without_diff.py

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

plugins/callback/dense.py

@@ -7,19 +7,19 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
+DOCUMENTATION = '''
 name: dense
 type: stdout
 short_description: minimal stdout output
 extends_documentation_fragment:
-  - default_callback
+- default_callback
 description:
-  - When in verbose mode it will act the same as the default callback.
+- When in verbose mode it will act the same as the default callback.
 author:
-  - Dag Wieers (@dagwieers)
+- Dag Wieers (@dagwieers)
 requirements:
-  - set as stdout in configuration
-"""
+- set as stdout in configuration
+'''
 
 HAS_OD = False
 try:
@@ -195,7 +195,7 @@ class CallbackModule(CallbackModule_default):
             self.disabled = True
 
     def __del__(self):
-        sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+        sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
 
     def _add_host(self, result, status):
         name = result._host.get_name()
@@ -243,7 +243,7 @@ class CallbackModule(CallbackModule_default):
 
     def _handle_exceptions(self, result):
         if 'exception' in result:
-            # Remove the exception from the result so it is not shown every time
+            # Remove the exception from the result so it's not shown every time
             del result['exception']
 
             if self._display.verbosity == 1:
@@ -252,7 +252,7 @@ class CallbackModule(CallbackModule_default):
     def _display_progress(self, result=None):
         # Always rewrite the complete line
         sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.nolinewrap + vt100.underline)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}:')
+        sys.stdout.write('%s %d:' % (self.type, self.count[self.type]))
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
@@ -260,7 +260,7 @@ class CallbackModule(CallbackModule_default):
         for name in self.hosts:
             sys.stdout.write(' ')
             if self.hosts[name].get('delegate', None):
-                sys.stdout.write(f"{self.hosts[name]['delegate']}>")
+                sys.stdout.write(self.hosts[name]['delegate'] + '>')
             sys.stdout.write(colors[self.hosts[name]['state']] + name + vt100.reset)
             sys.stdout.flush()
 
@@ -274,8 +274,8 @@ class CallbackModule(CallbackModule_default):
         if not self.shown_title:
             self.shown_title = True
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.underline)
-            sys.stdout.write(f'{self.type} {self.count[self.type]}: {self.task.get_name().strip()}')
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+            sys.stdout.write('%s %d: %s' % (self.type, self.count[self.type], self.task.get_name().strip()))
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
             sys.stdout.flush()
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline)
@@ -284,7 +284,7 @@ class CallbackModule(CallbackModule_default):
     def _display_results(self, result, status):
         # Leave the previous task on screen (as it has changes/errors)
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline)
         self.keep = False
@@ -309,15 +309,15 @@ class CallbackModule(CallbackModule_default):
         if result._task.loop and 'results' in result._result:
             self._process_items(result)
         else:
-            sys.stdout.write(f"{colors[status] + status}: ")
+            sys.stdout.write(colors[status] + status + ': ')
 
             delegated_vars = result._result.get('_ansible_delegated_vars', None)
             if delegated_vars:
-                sys.stdout.write(f"{vt100.reset + result._host.get_name()}>{colors[status]}{delegated_vars['ansible_host']}")
+                sys.stdout.write(vt100.reset + result._host.get_name() + '>' + colors[status] + delegated_vars['ansible_host'])
             else:
                 sys.stdout.write(result._host.get_name())
 
-            sys.stdout.write(f": {dump}\n")
+            sys.stdout.write(': ' + dump + '\n')
             sys.stdout.write(vt100.reset + vt100.save + vt100.clearline)
             sys.stdout.flush()
 
@@ -327,7 +327,7 @@ class CallbackModule(CallbackModule_default):
     def v2_playbook_on_play_start(self, play):
         # Leave the previous task on screen (as it has changes/errors)
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}{vt100.bold}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline + vt100.bold)
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.bold)
 
@@ -341,14 +341,14 @@ class CallbackModule(CallbackModule_default):
         name = play.get_name().strip()
         if not name:
             name = 'unnamed'
-        sys.stdout.write(f"PLAY {self.count['play']}: {name.upper()}")
-        sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+        sys.stdout.write('PLAY %d: %s' % (self.count['play'], name.upper()))
+        sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         sys.stdout.flush()
 
     def v2_playbook_on_task_start(self, task, is_conditional):
         # Leave the previous task on screen (as it has changes/errors)
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}{vt100.underline}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline + vt100.underline)
         else:
             # Do not clear line, since we want to retain the previous output
             sys.stdout.write(vt100.restore + vt100.reset + vt100.underline)
@@ -365,14 +365,14 @@ class CallbackModule(CallbackModule_default):
             self.count['task'] += 1
 
         # Write the next task on screen (behind the prompt is the previous output)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}.')
+        sys.stdout.write('%s %d.' % (self.type, self.count[self.type]))
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
     def v2_playbook_on_handler_task_start(self, task):
         # Leave the previous task on screen (as it has changes/errors)
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}{vt100.underline}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline + vt100.underline)
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline + vt100.underline)
 
@@ -388,7 +388,7 @@ class CallbackModule(CallbackModule_default):
             self.count[self.type] += 1
 
         # Write the next task on screen (behind the prompt is the previous output)
-        sys.stdout.write(f'{self.type} {self.count[self.type]}.')
+        sys.stdout.write('%s %d.' % (self.type, self.count[self.type]))
         sys.stdout.write(vt100.reset)
         sys.stdout.flush()
 
@@ -451,13 +451,13 @@ class CallbackModule(CallbackModule_default):
 
     def v2_playbook_on_no_hosts_remaining(self):
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline)
         self.keep = False
 
-        sys.stdout.write(f"{vt100.white + vt100.redbg}NO MORE HOSTS LEFT")
-        sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+        sys.stdout.write(vt100.white + vt100.redbg + 'NO MORE HOSTS LEFT')
+        sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         sys.stdout.flush()
 
     def v2_playbook_on_include(self, included_file):
@@ -465,7 +465,7 @@ class CallbackModule(CallbackModule_default):
 
     def v2_playbook_on_stats(self, stats):
         if self._display.verbosity == 0 and self.keep:
-            sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+            sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         else:
             sys.stdout.write(vt100.restore + vt100.reset + vt100.clearline)
 
@@ -476,16 +476,22 @@ class CallbackModule(CallbackModule_default):
         sys.stdout.write(vt100.bold + vt100.underline)
         sys.stdout.write('SUMMARY')
 
-        sys.stdout.write(f"{vt100.restore}{vt100.reset}\n{vt100.save}{vt100.clearline}")
+        sys.stdout.write(vt100.restore + vt100.reset + '\n' + vt100.save + vt100.clearline)
         sys.stdout.flush()
 
         hosts = sorted(stats.processed.keys())
         for h in hosts:
             t = stats.summarize(h)
             self._display.display(
-                f"{hostcolor(h, t)} : {colorize('ok', t['ok'], C.COLOR_OK)} {colorize('changed', t['changed'], C.COLOR_CHANGED)} "
-                f"{colorize('unreachable', t['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', t['failures'], C.COLOR_ERROR)} "
-                f"{colorize('rescued', t['rescued'], C.COLOR_OK)} {colorize('ignored', t['ignored'], C.COLOR_WARN)}",
+                u"%s : %s %s %s %s %s %s" % (
+                    hostcolor(h, t),
+                    colorize(u'ok', t['ok'], C.COLOR_OK),
+                    colorize(u'changed', t['changed'], C.COLOR_CHANGED),
+                    colorize(u'unreachable', t['unreachable'], C.COLOR_UNREACHABLE),
+                    colorize(u'failed', t['failures'], C.COLOR_ERROR),
+                    colorize(u'rescued', t['rescued'], C.COLOR_OK),
+                    colorize(u'ignored', t['ignored'], C.COLOR_WARN),
+                ),
                 screen_only=True
             )
 

plugins/callback/elastic.py

@@ -5,69 +5,69 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-name: elastic
-type: notification
-short_description: Create distributed traces for each Ansible task in Elastic APM
-version_added: 3.8.0
-description:
-  - This callback creates distributed traces for each Ansible task in Elastic APM.
-  - You can configure the plugin with environment variables.
-  - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
-options:
-  hide_task_arguments:
-    default: false
-    type: bool
+DOCUMENTATION = '''
+    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+    name: elastic
+    type: notification
+    short_description: Create distributed traces for each Ansible task in Elastic APM
+    version_added: 3.8.0
     description:
-      - Hide the arguments for a task.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-  apm_service_name:
-    default: ansible
-    type: str
-    description:
-      - The service name resource attribute.
-    env:
-      - name: ELASTIC_APM_SERVICE_NAME
-  apm_server_url:
-    type: str
-    description:
-      - Use the APM server and its environment variables.
-    env:
-      - name: ELASTIC_APM_SERVER_URL
-  apm_secret_token:
-    type: str
-    description:
-      - Use the APM server token.
-    env:
-      - name: ELASTIC_APM_SECRET_TOKEN
-  apm_api_key:
-    type: str
-    description:
-      - Use the APM API key.
-    env:
-      - name: ELASTIC_APM_API_KEY
-  apm_verify_server_cert:
-    default: true
-    type: bool
-    description:
-      - Verifies the SSL certificate if an HTTPS connection.
-    env:
-      - name: ELASTIC_APM_VERIFY_SERVER_CERT
-  traceparent:
-    type: str
-    description:
-      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-    env:
-      - name: TRACEPARENT
-requirements:
-  - elastic-apm (Python library)
-"""
+      - This callback creates distributed traces for each Ansible task in Elastic APM.
+      - You can configure the plugin with environment variables.
+      - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
+    options:
+      hide_task_arguments:
+        default: false
+        type: bool
+        description:
+          - Hide the arguments for a task.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+      apm_service_name:
+        default: ansible
+        type: str
+        description:
+          - The service name resource attribute.
+        env:
+          - name: ELASTIC_APM_SERVICE_NAME
+      apm_server_url:
+        type: str
+        description:
+          - Use the APM server and its environment variables.
+        env:
+          - name: ELASTIC_APM_SERVER_URL
+      apm_secret_token:
+        type: str
+        description:
+          - Use the APM server token
+        env:
+          - name: ELASTIC_APM_SECRET_TOKEN
+      apm_api_key:
+        type: str
+        description:
+          - Use the APM API key
+        env:
+          - name: ELASTIC_APM_API_KEY
+      apm_verify_server_cert:
+        default: true
+        type: bool
+        description:
+          - Verifies the SSL certificate if an HTTPS connection.
+        env:
+          - name: ELASTIC_APM_VERIFY_SERVER_CERT
+      traceparent:
+        type: str
+        description:
+          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+        env:
+          - name: TRACEPARENT
+    requirements:
+      - elastic-apm (Python library)
+'''
 
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.elastic
@@ -76,7 +76,7 @@ examples: |-
     export ELASTIC_APM_SERVER_URL=<your APM server URL)>
     export ELASTIC_APM_SERVICE_NAME=your_service_name
     export ELASTIC_APM_API_KEY=your_APM_API_KEY
-"""
+'''
 
 import getpass
 import socket
@@ -118,7 +118,7 @@ class TaskData:
         if host.uuid in self.host_data:
             if host.status == 'included':
                 # concatenate task include output from multiple items
-                host.result = f'{self.host_data[host.uuid].result}\n{host.result}'
+                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
             else:
                 return
 
@@ -166,7 +166,7 @@ class ElasticSource(object):
         args = None
 
         if not task.no_log and not hide_task_arguments:
-            args = ', '.join((f'{k}={v}' for k, v in task.args.items()))
+            args = ', '.join(('%s=%s' % a for a in task.args.items()))
 
         tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
 
@@ -225,7 +225,7 @@ class ElasticSource(object):
     def create_span_data(self, apm_cli, task_data, host_data):
         """ create the span with the given TaskData and HostData """
 
-        name = f'[{host_data.name}] {task_data.play}: {task_data.name}'
+        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
 
         message = "success"
         status = "success"
@@ -259,7 +259,7 @@ class ElasticSource(object):
                                   "ansible.task.host.status": host_data.status}) as span:
             span.outcome = status
             if 'failure' in status:
-                exception = AnsibleRuntimeError(message=f"{task_data.action}: {name} failed with error message {enriched_error_message}")
+                exception = AnsibleRuntimeError(message="{0}: {1} failed with error message {2}".format(task_data.action, name, enriched_error_message))
                 apm_cli.capture_exception(exc_info=(type(exception), exception, exception.__traceback__), handled=True)
 
     def init_apm_client(self, apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key):
@@ -288,7 +288,7 @@ class ElasticSource(object):
         message = result.get('msg', 'failed')
         exception = result.get('exception')
         stderr = result.get('stderr')
-        return f"message: \"{message}\"\nexception: \"{exception}\"\nstderr: \"{stderr}\""
+        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
 
 
 class CallbackModule(CallbackBase):

plugins/callback/hipchat.py

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

plugins/callback/jabber.py

@@ -7,42 +7,38 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: jabber
-type: notification
-short_description: post task events to a Jabber server
-description:
-  - The chatty part of ChatOps with a Hipchat server as a target.
-  - This callback plugin sends status updates to a HipChat channel during playbook execution.
-requirements:
-  - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
-options:
-  server:
-    description: Connection info to Jabber server.
-    type: str
-    required: true
-    env:
-      - name: JABBER_SERV
-  user:
-    description: Jabber user to authenticate as.
-    type: str
-    required: true
-    env:
-      - name: JABBER_USER
-  password:
-    description: Password for the user to the Jabber server.
-    type: str
-    required: true
-    env:
-      - name: JABBER_PASS
-  to:
-    description: Chat identifier that will receive the message.
-    type: str
-    required: true
-    env:
-      - name: JABBER_TO
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: jabber
+    type: notification
+    short_description: post task events to a jabber server
+    description:
+      - The chatty part of ChatOps with a Hipchat server as a target.
+      - This callback plugin sends status updates to a HipChat channel during playbook execution.
+    requirements:
+      - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
+    options:
+      server:
+        description: connection info to jabber server
+        required: true
+        env:
+          - name: JABBER_SERV
+      user:
+        description: Jabber user to authenticate as
+        required: true
+        env:
+          - name: JABBER_USER
+      password:
+        description: Password for the user to the jabber server
+        required: true
+        env:
+          - name: JABBER_PASS
+      to:
+        description: chat identifier that will receive the message
+        required: true
+        env:
+          - name: JABBER_TO
+'''
 
 import os
 
@@ -102,7 +98,7 @@ class CallbackModule(CallbackBase):
         """Display Playbook and play start messages"""
         self.play = play
         name = play.name
-        self.send_msg(f"Ansible starting play: {name}")
+        self.send_msg("Ansible starting play: %s" % (name))
 
     def playbook_on_stats(self, stats):
         name = self.play
@@ -118,7 +114,7 @@ class CallbackModule(CallbackBase):
 
         if failures or unreachable:
             out = self.debug
-            self.send_msg(f"{name}: Failures detected \n{self.task} \nHost: {h}\n Failed at:\n{out}")
+            self.send_msg("%s: Failures detected \n%s \nHost: %s\n Failed at:\n%s" % (name, self.task, h, out))
         else:
             out = self.debug
-            self.send_msg(f"Great! \n Playbook {name} completed:\n{s} \n Last task debug:\n {out}")
+            self.send_msg("Great! \n Playbook %s completed:\n%s \n Last task debug:\n %s" % (name, s, out))

plugins/callback/log_plays.py

@@ -7,27 +7,26 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: log_plays
-type: notification
-short_description: write playbook output to log file
-description:
-  - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory.
-requirements:
-  - Whitelist in configuration
-  - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
-options:
-  log_folder:
-    default: /var/log/ansible/hosts
-    description: The folder where log files will be created.
-    type: str
-    env:
-      - name: ANSIBLE_LOG_FOLDER
-    ini:
-      - section: callback_log_plays
-        key: log_folder
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: log_plays
+    type: notification
+    short_description: write playbook output to log file
+    description:
+      - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory.
+    requirements:
+     - Whitelist in configuration
+     - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
+    options:
+      log_folder:
+        default: /var/log/ansible/hosts
+        description: The folder where log files will be created.
+        env:
+          - name: ANSIBLE_LOG_FOLDER
+        ini:
+          - section: callback_log_plays
+            key: log_folder
+'''
 
 import os
 import time
@@ -57,10 +56,7 @@ class CallbackModule(CallbackBase):
     CALLBACK_NEEDS_WHITELIST = True
 
     TIME_FORMAT = "%b %d %Y %H:%M:%S"
-
-    @staticmethod
-    def _make_msg(now, playbook, task_name, task_action, category, data):
-        return f"{now} - {playbook} - {task_name} - {task_action} - {category} - {data}\n\n"
+    MSG_FORMAT = "%(now)s - %(playbook)s - %(task_name)s - %(task_action)s - %(category)s - %(data)s\n\n"
 
     def __init__(self):
 
@@ -85,12 +81,22 @@ class CallbackModule(CallbackBase):
                 invocation = data.pop('invocation', None)
                 data = json.dumps(data, cls=AnsibleJSONEncoder)
                 if invocation is not None:
-                    data = f"{json.dumps(invocation)} => {data} "
+                    data = json.dumps(invocation) + " => %s " % data
 
         path = os.path.join(self.log_folder, result._host.get_name())
         now = time.strftime(self.TIME_FORMAT, time.localtime())
 
-        msg = to_bytes(self._make_msg(now, self.playbook, result._task.name, result._task.action, category, data))
+        msg = to_bytes(
+            self.MSG_FORMAT
+            % dict(
+                now=now,
+                playbook=self.playbook,
+                task_name=result._task.name,
+                task_action=result._task.action,
+                category=category,
+                data=data,
+            )
+        )
         with open(path, "ab") as fd:
             fd.write(msg)
 

plugins/callback/loganalytics.py

@@ -6,41 +6,39 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: loganalytics
-type: notification
-short_description: Posts task results to Azure Log Analytics
-author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
-description:
-  - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
-  - Credits to authors of splunk callback plugin.
-version_added: "2.4.0"
-requirements:
-  - Whitelisting this callback plugin.
-  - An Azure log analytics work space has been established.
-options:
-  workspace_id:
-    description: Workspace ID of the Azure log analytics workspace.
-    type: str
-    required: true
-    env:
-      - name: WORKSPACE_ID
-    ini:
-      - section: callback_loganalytics
-        key: workspace_id
-  shared_key:
-    description: Shared key to connect to Azure log analytics workspace.
-    type: str
-    required: true
-    env:
-      - name: WORKSPACE_SHARED_KEY
-    ini:
-      - section: callback_loganalytics
-        key: shared_key
-"""
+DOCUMENTATION = '''
+    name: loganalytics
+    type: notification
+    short_description: Posts task results to Azure Log Analytics
+    author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
+    description:
+      - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
+      - Credits to authors of splunk callback plugin.
+    version_added: "2.4.0"
+    requirements:
+      - Whitelisting this callback plugin.
+      - An Azure log analytics work space has been established.
+    options:
+      workspace_id:
+        description: Workspace ID of the Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_ID
+        ini:
+          - section: callback_loganalytics
+            key: workspace_id
+      shared_key:
+        description: Shared key to connect to Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_SHARED_KEY
+        ini:
+          - section: callback_loganalytics
+            key: shared_key
+'''
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Whitelist the plugin in ansible.cfg:
     [defaults]
     callback_whitelist = community.general.loganalytics
@@ -51,7 +49,7 @@ examples: |-
     [callback_loganalytics]
     workspace_id = 01234567-0123-0123-0123-01234567890a
     shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
-"""
+'''
 
 import hashlib
 import hmac
@@ -84,17 +82,18 @@ class AzureLogAnalyticsSource(object):
 
     def __build_signature(self, date, workspace_id, shared_key, content_length):
         # Build authorisation signature for Azure log analytics API call
-        sigs = f"POST\n{content_length}\napplication/json\nx-ms-date:{date}\n/api/logs"
+        sigs = "POST\n{0}\napplication/json\nx-ms-date:{1}\n/api/logs".format(
+            str(content_length), date)
         utf8_sigs = sigs.encode('utf-8')
         decoded_shared_key = base64.b64decode(shared_key)
         hmac_sha256_sigs = hmac.new(
             decoded_shared_key, utf8_sigs, digestmod=hashlib.sha256).digest()
         encoded_hash = base64.b64encode(hmac_sha256_sigs).decode('utf-8')
-        signature = f"SharedKey {workspace_id}:{encoded_hash}"
+        signature = "SharedKey {0}:{1}".format(workspace_id, encoded_hash)
         return signature
 
     def __build_workspace_url(self, workspace_id):
-        return f"https://{workspace_id}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01"
+        return "https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01".format(workspace_id)
 
     def __rfc1123date(self):
         return now().strftime('%a, %d %b %Y %H:%M:%S GMT')

plugins/callback/logdna.py

@@ -6,56 +6,56 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: logdna
-type: notification
-short_description: Sends playbook logs to LogDNA
-description:
-  - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
-requirements:
-  - LogDNA Python Library (U(https://github.com/logdna/python))
-  - whitelisting in configuration
-options:
-  conf_key:
-    required: true
-    description: LogDNA Ingestion Key.
-    type: string
-    env:
-      - name: LOGDNA_INGESTION_KEY
-    ini:
-      - section: callback_logdna
-        key: conf_key
-  plugin_ignore_errors:
-    required: false
-    description: Whether to ignore errors on failing or not.
-    type: boolean
-    env:
-      - name: ANSIBLE_IGNORE_ERRORS
-    ini:
-      - section: callback_logdna
-        key: plugin_ignore_errors
-    default: false
-  conf_hostname:
-    required: false
-    description: Alternative Host Name; the current host name by default.
-    type: string
-    env:
-      - name: LOGDNA_HOSTNAME
-    ini:
-      - section: callback_logdna
-        key: conf_hostname
-  conf_tags:
-    required: false
-    description: Tags.
-    type: string
-    env:
-      - name: LOGDNA_TAGS
-    ini:
-      - section: callback_logdna
-        key: conf_tags
-    default: ansible
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: logdna
+    type: notification
+    short_description: Sends playbook logs to LogDNA
+    description:
+      - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
+    requirements:
+      - LogDNA Python Library (U(https://github.com/logdna/python))
+      - whitelisting in configuration
+    options:
+      conf_key:
+        required: true
+        description: LogDNA Ingestion Key.
+        type: string
+        env:
+          - name: LOGDNA_INGESTION_KEY
+        ini:
+          - section: callback_logdna
+            key: conf_key
+      plugin_ignore_errors:
+        required: false
+        description: Whether to ignore errors on failing or not.
+        type: boolean
+        env:
+          - name: ANSIBLE_IGNORE_ERRORS
+        ini:
+          - section: callback_logdna
+            key: plugin_ignore_errors
+        default: false
+      conf_hostname:
+        required: false
+        description: Alternative Host Name; the current host name by default.
+        type: string
+        env:
+          - name: LOGDNA_HOSTNAME
+        ini:
+          - section: callback_logdna
+            key: conf_hostname
+      conf_tags:
+        required: false
+        description: Tags.
+        type: string
+        env:
+          - name: LOGDNA_TAGS
+        ini:
+          - section: callback_logdna
+            key: conf_tags
+        default: ansible
+'''
 
 import logging
 import json
@@ -73,7 +73,7 @@ except ImportError:
 
 # Getting MAC Address of system:
 def get_mac():
-    mac = f"{getnode():012x}"
+    mac = "%012x" % getnode()
     return ":".join(map(lambda index: mac[index:index + 2], range(int(len(mac) / 2))))
 
 
@@ -161,7 +161,7 @@ class CallbackModule(CallbackBase):
         if ninvalidKeys > 0:
             for key in invalidKeys:
                 del meta[key]
-            meta['__errors'] = f"These keys have been sanitized: {', '.join(invalidKeys)}"
+            meta['__errors'] = 'These keys have been sanitized: ' + ', '.join(invalidKeys)
         return meta
 
     def sanitizeJSON(self, data):

plugins/callback/logentries.py

@@ -6,77 +6,75 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: logentries
-type: notification
-short_description: Sends events to Logentries
-description:
-  - This callback plugin will generate JSON objects and send them to Logentries using TCP for auditing/debugging purposes.
-requirements:
-  - whitelisting in configuration
-  - certifi (Python library)
-  - flatdict (Python library), if you want to use the O(flatten) option
-options:
-  api:
-    description: URI to the Logentries API.
-    type: str
-    env:
-      - name: LOGENTRIES_API
-    default: data.logentries.com
-    ini:
-      - section: callback_logentries
-        key: api
-  port:
-    description: HTTP port to use when connecting to the API.
-    type: int
-    env:
-      - name: LOGENTRIES_PORT
-    default: 80
-    ini:
-      - section: callback_logentries
-        key: port
-  tls_port:
-    description: Port to use when connecting to the API when TLS is enabled.
-    type: int
-    env:
-      - name: LOGENTRIES_TLS_PORT
-    default: 443
-    ini:
-      - section: callback_logentries
-        key: tls_port
-  token:
-    description: The logentries C(TCP token).
-    type: str
-    env:
-      - name: LOGENTRIES_ANSIBLE_TOKEN
-    required: true
-    ini:
-      - section: callback_logentries
-        key: token
-  use_tls:
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: logentries
+    type: notification
+    short_description: Sends events to Logentries
     description:
-      - Toggle to decide whether to use TLS to encrypt the communications with the API server.
-    env:
-      - name: LOGENTRIES_USE_TLS
-    default: false
-    type: boolean
-    ini:
-      - section: callback_logentries
-        key: use_tls
-  flatten:
-    description: Flatten complex data structures into a single dictionary with complex keys.
-    type: boolean
-    default: false
-    env:
-      - name: LOGENTRIES_FLATTEN
-    ini:
-      - section: callback_logentries
-        key: flatten
-"""
+      - This callback plugin will generate JSON objects and send them to Logentries via TCP for auditing/debugging purposes.
+      - Before 2.4, if you wanted to use an ini configuration, the file must be placed in the same directory as this plugin and named C(logentries.ini).
+      - In 2.4 and above you can just put it in the main Ansible configuration file.
+    requirements:
+      - whitelisting in configuration
+      - certifi (Python library)
+      - flatdict (Python library), if you want to use the O(flatten) option
+    options:
+      api:
+        description: URI to the Logentries API.
+        env:
+          - name: LOGENTRIES_API
+        default: data.logentries.com
+        ini:
+          - section: callback_logentries
+            key: api
+      port:
+        description: HTTP port to use when connecting to the API.
+        env:
+            - name: LOGENTRIES_PORT
+        default: 80
+        ini:
+          - section: callback_logentries
+            key: port
+      tls_port:
+        description: Port to use when connecting to the API when TLS is enabled.
+        env:
+            - name: LOGENTRIES_TLS_PORT
+        default: 443
+        ini:
+          - section: callback_logentries
+            key: tls_port
+      token:
+        description: The logentries C(TCP token).
+        env:
+          - name: LOGENTRIES_ANSIBLE_TOKEN
+        required: true
+        ini:
+          - section: callback_logentries
+            key: token
+      use_tls:
+        description:
+          - Toggle to decide whether to use TLS to encrypt the communications with the API server.
+        env:
+          - name: LOGENTRIES_USE_TLS
+        default: false
+        type: boolean
+        ini:
+          - section: callback_logentries
+            key: use_tls
+      flatten:
+        description: Flatten complex data structures into a single dictionary with complex keys.
+        type: boolean
+        default: false
+        env:
+          - name: LOGENTRIES_FLATTEN
+        ini:
+          - section: callback_logentries
+            key: flatten
+'''
 
-EXAMPLES = r"""
-examples: >-
+EXAMPLES = '''
+examples: >
   To enable, add this to your ansible.cfg file in the defaults block
 
     [defaults]
@@ -95,7 +93,7 @@ examples: >-
     use_tls = true
     token = dd21fc88-f00a-43ff-b977-e3a4233c53af
     flatten = false
-"""
+'''
 
 import os
 import socket
@@ -133,7 +131,7 @@ class PlainTextSocketAppender(object):
         # Error message displayed when an incorrect Token has been detected
         self.INVALID_TOKEN = "\n\nIt appears the LOGENTRIES_TOKEN parameter you entered is incorrect!\n\n"
         # Unicode Line separator character   \u2028
-        self.LINE_SEP = '\u2028'
+        self.LINE_SEP = u'\u2028'
 
         self._display = display
         self._conn = None
@@ -151,7 +149,7 @@ class PlainTextSocketAppender(object):
                 self.open_connection()
                 return
             except Exception as e:
-                self._display.vvvv(f"Unable to connect to Logentries: {e}")
+                self._display.vvvv(u"Unable to connect to Logentries: %s" % to_text(e))
 
             root_delay *= 2
             if root_delay > self.MAX_DELAY:
@@ -160,7 +158,7 @@ class PlainTextSocketAppender(object):
             wait_for = root_delay + random.uniform(0, root_delay)
 
             try:
-                self._display.vvvv(f"sleeping {wait_for} before retry")
+                self._display.vvvv("sleeping %s before retry" % wait_for)
                 time.sleep(wait_for)
             except KeyboardInterrupt:
                 raise
@@ -173,8 +171,8 @@ class PlainTextSocketAppender(object):
         # Replace newlines with Unicode line separator
         # for multi-line events
         data = to_text(data, errors='surrogate_or_strict')
-        multiline = data.replace('\n', self.LINE_SEP)
-        multiline += "\n"
+        multiline = data.replace(u'\n', self.LINE_SEP)
+        multiline += u"\n"
         # Send data, reconnect if needed
         while True:
             try:
@@ -247,7 +245,7 @@ class CallbackModule(CallbackBase):
             self.use_tls = self.get_option('use_tls')
             self.flatten = self.get_option('flatten')
         except KeyError as e:
-            self._display.warning(f"Missing option for Logentries callback plugin: {e}")
+            self._display.warning(u"Missing option for Logentries callback plugin: %s" % to_text(e))
             self.disabled = True
 
         try:
@@ -266,10 +264,10 @@ class CallbackModule(CallbackBase):
 
         if not self.disabled:
             if self.use_tls:
-                self._display.vvvv(f"Connecting to {self.api_url}:{self.api_tls_port} with TLS")
+                self._display.vvvv("Connecting to %s:%s with TLS" % (self.api_url, self.api_tls_port))
                 self._appender = TLSSocketAppender(display=self._display, LE_API=self.api_url, LE_TLS_PORT=self.api_tls_port)
             else:
-                self._display.vvvv(f"Connecting to {self.api_url}:{self.api_port}")
+                self._display.vvvv("Connecting to %s:%s" % (self.api_url, self.api_port))
                 self._appender = PlainTextSocketAppender(display=self._display, LE_API=self.api_url, LE_PORT=self.api_port)
             self._appender.reopen_connection()
 
@@ -282,7 +280,7 @@ class CallbackModule(CallbackBase):
 
     def emit(self, record):
         msg = record.rstrip('\n')
-        msg = f"{self.token} {msg}"
+        msg = "{0} {1}".format(self.token, msg)
         self._appender.put(msg)
         self._display.vvvv("Sent event to logentries")
 

plugins/callback/logstash.py

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

plugins/callback/mail.py

@@ -7,80 +7,81 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
+DOCUMENTATION = '''
 name: mail
 type: notification
-short_description: Sends failure events through email
+short_description: Sends failure events via email
 description:
-  - This callback will report failures through email.
+- This callback will report failures via email.
 author:
-  - Dag Wieers (@dagwieers)
+- Dag Wieers (@dagwieers)
 requirements:
-  - whitelisting in configuration
+- whitelisting in configuration
 options:
   mta:
     description:
-      - Mail Transfer Agent, server that accepts SMTP.
+        - Mail Transfer Agent, server that accepts SMTP.
     type: str
     env:
-      - name: SMTPHOST
+        - name: SMTPHOST
     ini:
-      - section: callback_mail
-        key: smtphost
+        - section: callback_mail
+          key: smtphost
     default: localhost
   mtaport:
     description:
-      - Mail Transfer Agent Port.
-      - Port at which server SMTP.
+        - Mail Transfer Agent Port.
+        - Port at which server SMTP.
     type: int
     ini:
-      - section: callback_mail
-        key: smtpport
+        - section: callback_mail
+          key: smtpport
     default: 25
   to:
     description:
-      - Mail recipient.
+        - Mail recipient.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: to
+        - section: callback_mail
+          key: to
     default: [root]
   sender:
     description:
-      - Mail sender.
-      - This is required since community.general 6.0.0.
+        - Mail sender.
+        - This is required since community.general 6.0.0.
     type: str
     required: true
     ini:
-      - section: callback_mail
-        key: sender
+        - section: callback_mail
+          key: sender
   cc:
     description:
-      - CC'd recipients.
+        - CC'd recipients.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: cc
+        - section: callback_mail
+          key: cc
   bcc:
     description:
-      - BCC'd recipients.
+        - BCC'd recipients.
     type: list
     elements: str
     ini:
-      - section: callback_mail
-        key: bcc
+        - section: callback_mail
+          key: bcc
   message_id_domain:
     description:
-      - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
-      - The default is the hostname of the control node.
+        - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
+        - The default is the hostname of the control node.
     type: str
     ini:
-      - section: callback_mail
-        key: message_id_domain
+        - section: callback_mail
+          key: message_id_domain
     version_added: 8.2.0
-"""
+
+'''
 
 import json
 import os
@@ -134,14 +135,14 @@ class CallbackModule(CallbackBase):
         if self.bcc:
             bcc_addresses = email.utils.getaddresses(self.bcc)
 
-        content = f'Date: {email.utils.formatdate()}\n'
-        content += f'From: {email.utils.formataddr(sender_address)}\n'
+        content = 'Date: %s\n' % email.utils.formatdate()
+        content += 'From: %s\n' % email.utils.formataddr(sender_address)
         if self.to:
-            content += f"To: {', '.join([email.utils.formataddr(pair) for pair in to_addresses])}\n"
+            content += 'To: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in to_addresses])
         if self.cc:
-            content += f"Cc: {', '.join([email.utils.formataddr(pair) for pair in cc_addresses])}\n"
-        content += f"Message-ID: {email.utils.make_msgid(domain=self.get_option('message_id_domain'))}\n"
-        content += f'Subject: {subject.strip()}\n\n'
+            content += 'Cc: %s\n' % ', '.join([email.utils.formataddr(pair) for pair in cc_addresses])
+        content += 'Message-ID: %s\n' % email.utils.make_msgid(domain=self.get_option('message_id_domain'))
+        content += 'Subject: %s\n\n' % subject.strip()
         content += body
 
         addresses = to_addresses
@@ -158,22 +159,23 @@ class CallbackModule(CallbackBase):
         smtp.quit()
 
     def subject_msg(self, multiline, failtype, linenr):
-        msg = multiline.strip('\r\n').splitlines()[linenr]
-        return f'{failtype}: {msg}'
+        return '%s: %s' % (failtype, multiline.strip('\r\n').splitlines()[linenr])
 
     def indent(self, multiline, indent=8):
         return re.sub('^', ' ' * indent, multiline, flags=re.MULTILINE)
 
     def body_blob(self, multiline, texttype):
         ''' Turn some text output in a well-indented block for sending in a mail body '''
-        intro = f'with the following {texttype}:\n\n'
-        blob = "\n".join(multiline.strip('\r\n').splitlines())
-        return f"{intro}{self.indent(blob)}\n"
+        intro = 'with the following %s:\n\n' % texttype
+        blob = ''
+        for line in multiline.strip('\r\n').splitlines():
+            blob += '%s\n' % line
+        return intro + self.indent(blob) + '\n'
 
     def mail_result(self, result, failtype):
         host = result._host.get_name()
         if not self.sender:
-            self.sender = f'"Ansible: {host}" <root>'
+            self.sender = '"Ansible: %s" <root>' % host
 
         # Add subject
         if self.itembody:
@@ -189,32 +191,31 @@ class CallbackModule(CallbackBase):
         elif result._result.get('exception'):  # Unrelated exceptions are added to output :-/
             subject = self.subject_msg(result._result['exception'], failtype, -1)
         else:
-            subject = f'{failtype}: {result._task.name or result._task.action}'
+            subject = '%s: %s' % (failtype, result._task.name or result._task.action)
 
         # Make playbook name visible (e.g. in Outlook/Gmail condensed view)
-        body = f'Playbook: {os.path.basename(self.playbook._file_name)}\n'
+        body = 'Playbook: %s\n' % os.path.basename(self.playbook._file_name)
         if result._task.name:
-            body += f'Task: {result._task.name}\n'
-        body += f'Module: {result._task.action}\n'
-        body += f'Host: {host}\n'
+            body += 'Task: %s\n' % result._task.name
+        body += 'Module: %s\n' % result._task.action
+        body += 'Host: %s\n' % host
         body += '\n'
 
         # Add task information (as much as possible)
         body += 'The following task failed:\n\n'
         if 'invocation' in result._result:
-            body += self.indent(f"{result._task.action}: {json.dumps(result._result['invocation']['module_args'], indent=4)}\n")
+            body += self.indent('%s: %s\n' % (result._task.action, json.dumps(result._result['invocation']['module_args'], indent=4)))
         elif result._task.name:
-            body += self.indent(f'{result._task.name} ({result._task.action})\n')
+            body += self.indent('%s (%s)\n' % (result._task.name, result._task.action))
         else:
-            body += self.indent(f'{result._task.action}\n')
+            body += self.indent('%s\n' % result._task.action)
         body += '\n'
 
         # Add item / message
         if self.itembody:
             body += self.itembody
         elif result._result.get('failed_when_result') is True:
-            fail_cond = self.indent('failed_when:\n- ' + '\n- '.join(result._task.failed_when))
-            body += f"due to the following condition:\n\n{fail_cond}\n\n"
+            body += "due to the following condition:\n\n" + self.indent('failed_when:\n- ' + '\n- '.join(result._task.failed_when)) + '\n\n'
         elif result._result.get('msg'):
             body += self.body_blob(result._result['msg'], 'message')
 
@@ -227,13 +228,13 @@ class CallbackModule(CallbackBase):
             body += self.body_blob(result._result['exception'], 'exception')
         if result._result.get('warnings'):
             for i in range(len(result._result.get('warnings'))):
-                body += self.body_blob(result._result['warnings'][i], f'exception {i + 1}')
+                body += self.body_blob(result._result['warnings'][i], 'exception %d' % (i + 1))
         if result._result.get('deprecations'):
             for i in range(len(result._result.get('deprecations'))):
-                body += self.body_blob(result._result['deprecations'][i], f'exception {i + 1}')
+                body += self.body_blob(result._result['deprecations'][i], 'exception %d' % (i + 1))
 
         body += 'and a complete dump of the error:\n\n'
-        body += self.indent(f'{failtype}: {json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4)}')
+        body += self.indent('%s: %s' % (failtype, json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4)))
 
         self.mail(subject=subject, body=body)
 
@@ -256,4 +257,4 @@ class CallbackModule(CallbackBase):
     def v2_runner_item_on_failed(self, result):
         # Pass item information to task failure
         self.itemsubject = result._result['msg']
-        self.itembody += self.body_blob(json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4), f"failed item dump '{result._result['item']}'")
+        self.itembody += self.body_blob(json.dumps(result._result, cls=AnsibleJSONEncoder, indent=4), "failed item dump '%(item)s'" % result._result)

plugins/callback/nrdp.py

@@ -7,65 +7,65 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: nrdp
-type: notification
-author: "Remi VERCHERE (@rverchere)"
-short_description: Post task results to a Nagios server through nrdp
-description:
-  - This callback send playbook result to Nagios.
-  - Nagios shall use NRDP to receive passive events.
-  - The passive check is sent to a dedicated host/service for Ansible.
-options:
-  url:
-    description: URL of the nrdp server.
-    required: true
-    env:
-      - name: NRDP_URL
-    ini:
-      - section: callback_nrdp
-        key: url
-    type: string
-  validate_certs:
-    description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs).
-    env:
-      - name: NRDP_VALIDATE_CERTS
-    ini:
-      - section: callback_nrdp
-        key: validate_nrdp_certs
-      - section: callback_nrdp
-        key: validate_certs
-    type: boolean
-    default: false
-    aliases: [validate_nrdp_certs]
-  token:
-    description: Token to be allowed to push nrdp events.
-    required: true
-    env:
-      - name: NRDP_TOKEN
-    ini:
-      - section: callback_nrdp
-        key: token
-    type: string
-  hostname:
-    description: Hostname where the passive check is linked to.
-    required: true
-    env:
-      - name: NRDP_HOSTNAME
-    ini:
-      - section: callback_nrdp
-        key: hostname
-    type: string
-  servicename:
-    description: Service where the passive check is linked to.
-    required: true
-    env:
-      - name: NRDP_SERVICENAME
-    ini:
-      - section: callback_nrdp
-        key: servicename
-    type: string
-"""
+DOCUMENTATION = '''
+    name: nrdp
+    type: notification
+    author: "Remi VERCHERE (@rverchere)"
+    short_description: Post task results to a Nagios server through nrdp
+    description:
+        - This callback send playbook result to Nagios.
+        - Nagios shall use NRDP to receive passive events.
+        - The passive check is sent to a dedicated host/service for Ansible.
+    options:
+        url:
+            description: URL of the nrdp server.
+            required: true
+            env:
+                - name : NRDP_URL
+            ini:
+                - section: callback_nrdp
+                  key: url
+            type: string
+        validate_certs:
+            description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs.)
+            env:
+                - name: NRDP_VALIDATE_CERTS
+            ini:
+                - section: callback_nrdp
+                  key: validate_nrdp_certs
+                - section: callback_nrdp
+                  key: validate_certs
+            type: boolean
+            default: false
+            aliases: [ validate_nrdp_certs ]
+        token:
+            description: Token to be allowed to push nrdp events.
+            required: true
+            env:
+                - name: NRDP_TOKEN
+            ini:
+                - section: callback_nrdp
+                  key: token
+            type: string
+        hostname:
+            description: Hostname where the passive check is linked to.
+            required: true
+            env:
+                - name : NRDP_HOSTNAME
+            ini:
+                - section: callback_nrdp
+                  key: hostname
+            type: string
+        servicename:
+            description: Service where the passive check is linked to.
+            required: true
+            env:
+                - name : NRDP_SERVICENAME
+            ini:
+                - section: callback_nrdp
+                  key: servicename
+            type: string
+'''
 
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.common.text.converters import to_bytes
@@ -132,10 +132,10 @@ class CallbackModule(CallbackBase):
         xmldata = "<?xml version='1.0'?>\n"
         xmldata += "<checkresults>\n"
         xmldata += "<checkresult type='service'>\n"
-        xmldata += f"<hostname>{self.hostname}</hostname>\n"
-        xmldata += f"<servicename>{self.servicename}</servicename>\n"
-        xmldata += f"<state>{state}</state>\n"
-        xmldata += f"<output>{msg}</output>\n"
+        xmldata += "<hostname>%s</hostname>\n" % self.hostname
+        xmldata += "<servicename>%s</servicename>\n" % self.servicename
+        xmldata += "<state>%d</state>\n" % state
+        xmldata += "<output>%s</output>\n" % msg
         xmldata += "</checkresult>\n"
         xmldata += "</checkresults>\n"
 
@@ -152,7 +152,7 @@ class CallbackModule(CallbackBase):
                                 validate_certs=self.validate_nrdp_certs)
             return response.read()
         except Exception as ex:
-            self._display.warning(f"NRDP callback cannot send result {ex}")
+            self._display.warning("NRDP callback cannot send result {0}".format(ex))
 
     def v2_playbook_on_play_start(self, play):
         '''
@@ -170,16 +170,17 @@ class CallbackModule(CallbackBase):
         critical = warning = 0
         for host in hosts:
             stat = stats.summarize(host)
-            gstats += (
-                f"'{host}_ok'={stat['ok']} '{host}_changed'={stat['changed']} '{host}_unreachable'={stat['unreachable']} '{host}_failed'={stat['failures']} "
-            )
+            gstats += "'%s_ok'=%d '%s_changed'=%d \
+                       '%s_unreachable'=%d '%s_failed'=%d " % \
+                (host, stat['ok'], host, stat['changed'],
+                 host, stat['unreachable'], host, stat['failures'])
             # Critical when failed tasks or unreachable host
             critical += stat['failures']
             critical += stat['unreachable']
             # Warning when changed tasks
             warning += stat['changed']
 
-        msg = f"{name} | {gstats}"
+        msg = "%s | %s" % (name, gstats)
         if critical:
             # Send Critical
             self._send_nrdp(self.CRITICAL, msg)

plugins/callback/null.py

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

plugins/callback/opentelemetry.py

@@ -6,120 +6,93 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-name: opentelemetry
-type: notification
-short_description: Create distributed traces with OpenTelemetry
-version_added: 3.7.0
-description:
-  - This callback creates distributed traces for each Ansible task with OpenTelemetry.
-  - You can configure the OpenTelemetry exporter and SDK with environment variables.
-  - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
-  - See
-    U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
-options:
-  hide_task_arguments:
-    default: false
-    type: bool
+DOCUMENTATION = '''
+    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+    name: opentelemetry
+    type: notification
+    short_description: Create distributed traces with OpenTelemetry
+    version_added: 3.7.0
     description:
-      - Hide the arguments for a task.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-    ini:
-      - section: callback_opentelemetry
-        key: hide_task_arguments
-        version_added: 5.3.0
-  enable_from_environment:
-    type: str
-    description:
-      - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
-      - This is handy when you use Configuration as Code and want to send distributed traces if running in the CI rather when
-        running Ansible locally.
-      - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to true this
-        plugin will be enabled.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
-    ini:
-      - section: callback_opentelemetry
-        key: enable_from_environment
-        version_added: 5.3.0
-    version_added: 3.8.0
-  otel_service_name:
-    default: ansible
-    type: str
-    description:
-      - The service name resource attribute.
-    env:
-      - name: OTEL_SERVICE_NAME
-    ini:
-      - section: callback_opentelemetry
-        key: otel_service_name
-        version_added: 5.3.0
-  traceparent:
-    default: None
-    type: str
-    description:
-      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-    env:
-      - name: TRACEPARENT
-  disable_logs:
-    default: false
-    type: bool
-    description:
-      - Disable sending logs.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
-    ini:
-      - section: callback_opentelemetry
-        key: disable_logs
-    version_added: 5.8.0
-  disable_attributes_in_logs:
-    default: false
-    type: bool
-    description:
-      - Disable populating span attributes to the logs.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
-    ini:
-      - section: callback_opentelemetry
-        key: disable_attributes_in_logs
-    version_added: 7.1.0
-  store_spans_in_file:
-    type: str
-    description:
-      - It stores the exported spans in the given file.
-    env:
-      - name: ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE
-    ini:
-      - section: callback_opentelemetry
-        key: store_spans_in_file
-    version_added: 9.0.0
-  otel_exporter_otlp_traces_protocol:
-    type: str
-    description:
-      - E(OTEL_EXPORTER_OTLP_TRACES_PROTOCOL) represents the the transport protocol for spans.
-      - See
-        U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL).
-    default: grpc
-    choices:
-      - grpc
-      - http/protobuf
-    env:
-      - name: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
-    ini:
-      - section: callback_opentelemetry
-        key: otel_exporter_otlp_traces_protocol
-    version_added: 9.0.0
-requirements:
-  - opentelemetry-api (Python library)
-  - opentelemetry-exporter-otlp (Python library)
-  - opentelemetry-sdk (Python library)
-"""
+      - This callback creates distributed traces for each Ansible task with OpenTelemetry.
+      - You can configure the OpenTelemetry exporter and SDK with environment variables.
+      - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
+      - See U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
+    options:
+      hide_task_arguments:
+        default: false
+        type: bool
+        description:
+          - Hide the arguments for a task.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+        ini:
+          - section: callback_opentelemetry
+            key: hide_task_arguments
+            version_added: 5.3.0
+      enable_from_environment:
+        type: str
+        description:
+          - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
+          - This is handy when you use Configuration as Code and want to send distributed traces
+            if running in the CI rather when running Ansible locally.
+          - For such, it evaluates the given O(enable_from_environment) value as environment variable
+            and if set to true this plugin will be enabled.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
+        ini:
+          - section: callback_opentelemetry
+            key: enable_from_environment
+            version_added: 5.3.0
+        version_added: 3.8.0
+      otel_service_name:
+        default: ansible
+        type: str
+        description:
+          - The service name resource attribute.
+        env:
+          - name: OTEL_SERVICE_NAME
+        ini:
+          - section: callback_opentelemetry
+            key: otel_service_name
+            version_added: 5.3.0
+      traceparent:
+        default: None
+        type: str
+        description:
+          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+        env:
+          - name: TRACEPARENT
+      disable_logs:
+        default: false
+        type: bool
+        description:
+          - Disable sending logs.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
+        ini:
+          - section: callback_opentelemetry
+            key: disable_logs
+        version_added: 5.8.0
+      disable_attributes_in_logs:
+        default: false
+        type: bool
+        description:
+          - Disable populating span attributes to the logs.
+        env:
+          - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
+        ini:
+          - section: callback_opentelemetry
+            key: disable_attributes_in_logs
+        version_added: 7.1.0
+    requirements:
+      - opentelemetry-api (Python library)
+      - opentelemetry-exporter-otlp (Python library)
+      - opentelemetry-sdk (Python library)
+'''
 
 
-EXAMPLES = r"""
-examples: |-
+EXAMPLES = '''
+examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.opentelemetry
@@ -131,14 +104,14 @@ examples: |-
     export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
     export OTEL_SERVICE_NAME=your_service_name
     export ANSIBLE_OPENTELEMETRY_ENABLED=true
-"""
+'''
 
 import getpass
-import json
 import os
 import socket
+import sys
+import time
 import uuid
-from time import time_ns
 
 from collections import OrderedDict
 from os.path import basename
@@ -151,25 +124,40 @@ from ansible.plugins.callback import CallbackBase
 try:
     from opentelemetry import trace
     from opentelemetry.trace import SpanKind
-    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter as GRPCOTLPSpanExporter
-    from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter as HTTPOTLPSpanExporter
+    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
     from opentelemetry.sdk.resources import SERVICE_NAME, Resource
     from opentelemetry.trace.status import Status, StatusCode
     from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
     from opentelemetry.sdk.trace import TracerProvider
     from opentelemetry.sdk.trace.export import (
-        BatchSpanProcessor,
-        SimpleSpanProcessor
-    )
-    from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
-        InMemorySpanExporter
+        BatchSpanProcessor
     )
+
+    # Support for opentelemetry-api <= 1.12
+    try:
+        from opentelemetry.util._time import _time_ns
+    except ImportError as imp_exc:
+        OTEL_LIBRARY_TIME_NS_ERROR = imp_exc
+    else:
+        OTEL_LIBRARY_TIME_NS_ERROR = None
+
 except ImportError as imp_exc:
     OTEL_LIBRARY_IMPORT_ERROR = imp_exc
+    OTEL_LIBRARY_TIME_NS_ERROR = imp_exc
 else:
     OTEL_LIBRARY_IMPORT_ERROR = None
 
 
+if sys.version_info >= (3, 7):
+    time_ns = time.time_ns
+elif not OTEL_LIBRARY_TIME_NS_ERROR:
+    time_ns = _time_ns
+else:
+    def time_ns():
+        # Support versions older than 3.7 with opentelemetry-api > 1.12
+        return int(time.time() * 1e9)
+
+
 class TaskData:
     """
     Data about an individual task.
@@ -190,7 +178,7 @@ class TaskData:
         if host.uuid in self.host_data:
             if host.status == 'included':
                 # concatenate task include output from multiple items
-                host.result = f'{self.host_data[host.uuid].result}\n{host.result}'
+                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
             else:
                 return
 
@@ -267,16 +255,7 @@ class OpenTelemetrySource(object):
         task.dump = dump
         task.add_host(HostData(host_uuid, host_name, status, result))
 
-    def generate_distributed_traces(self,
-                                    otel_service_name,
-                                    ansible_playbook,
-                                    tasks_data,
-                                    status,
-                                    traceparent,
-                                    disable_logs,
-                                    disable_attributes_in_logs,
-                                    otel_exporter_otlp_traces_protocol,
-                                    store_spans_in_file):
+    def generate_distributed_traces(self, otel_service_name, ansible_playbook, tasks_data, status, traceparent, disable_logs, disable_attributes_in_logs):
         """ generate distributed traces from the collected TaskData and HostData """
 
         tasks = []
@@ -292,16 +271,7 @@ class OpenTelemetrySource(object):
             )
         )
 
-        otel_exporter = None
-        if store_spans_in_file:
-            otel_exporter = InMemorySpanExporter()
-            processor = SimpleSpanProcessor(otel_exporter)
-        else:
-            if otel_exporter_otlp_traces_protocol == 'grpc':
-                otel_exporter = GRPCOTLPSpanExporter()
-            else:
-                otel_exporter = HTTPOTLPSpanExporter()
-            processor = BatchSpanProcessor(otel_exporter)
+        processor = BatchSpanProcessor(OTLPSpanExporter())
 
         trace.get_tracer_provider().add_span_processor(processor)
 
@@ -323,12 +293,10 @@ class OpenTelemetrySource(object):
                     with tracer.start_as_current_span(task.name, start_time=task.start, end_on_exit=False) as span:
                         self.update_span_data(task, host_data, span, disable_logs, disable_attributes_in_logs)
 
-        return otel_exporter
-
     def update_span_data(self, task_data, host_data, span, disable_logs, disable_attributes_in_logs):
         """ update the span with the given TaskData and HostData """
 
-        name = f'[{host_data.name}] {task_data.play}: {task_data.name}'
+        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
 
         message = 'success'
         res = {}
@@ -336,7 +304,6 @@ class OpenTelemetrySource(object):
         status = Status(status_code=StatusCode.OK)
         if host_data.status != 'included':
             # Support loops
-            enriched_error_message = None
             if 'results' in host_data.result._result:
                 if host_data.status == 'failed':
                     message = self.get_error_message_from_results(host_data.result._result['results'], task_data.action)
@@ -451,7 +418,7 @@ class OpenTelemetrySource(object):
     def get_error_message_from_results(results, action):
         for result in results:
             if result.get('failed', False):
-                return f"{action}({result.get('item', 'none')}) - {OpenTelemetrySource.get_error_message(result)}"
+                return ('{0}({1}) - {2}').format(action, result.get('item', 'none'), OpenTelemetrySource.get_error_message(result))
 
     @staticmethod
     def _last_line(text):
@@ -463,14 +430,14 @@ class OpenTelemetrySource(object):
         message = result.get('msg', 'failed')
         exception = result.get('exception')
         stderr = result.get('stderr')
-        return f"message: \"{message}\"\nexception: \"{exception}\"\nstderr: \"{stderr}\""
+        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
 
     @staticmethod
     def enrich_error_message_from_results(results, action):
         message = ""
         for result in results:
             if result.get('failed', False):
-                message = f"{action}({result.get('item', 'none')}) - {OpenTelemetrySource.enrich_error_message(result)}\n{message}"
+                message = ('{0}({1}) - {2}\n{3}').format(action, result.get('item', 'none'), OpenTelemetrySource.enrich_error_message(result), message)
         return message
 
 
@@ -496,8 +463,6 @@ class CallbackModule(CallbackBase):
         self.errors = 0
         self.disabled = False
         self.traceparent = False
-        self.store_spans_in_file = False
-        self.otel_exporter_otlp_traces_protocol = None
 
         if OTEL_LIBRARY_IMPORT_ERROR:
             raise_from(
@@ -516,9 +481,8 @@ class CallbackModule(CallbackBase):
         environment_variable = self.get_option('enable_from_environment')
         if environment_variable is not None and os.environ.get(environment_variable, 'false').lower() != 'true':
             self.disabled = True
-            self._display.warning(
-                f"The `enable_from_environment` option has been set and {environment_variable} is not enabled. Disabling the `opentelemetry` callback plugin."
-            )
+            self._display.warning("The `enable_from_environment` option has been set and {0} is not enabled. "
+                                  "Disabling the `opentelemetry` callback plugin.".format(environment_variable))
 
         self.hide_task_arguments = self.get_option('hide_task_arguments')
 
@@ -526,8 +490,6 @@ class CallbackModule(CallbackBase):
 
         self.disable_logs = self.get_option('disable_logs')
 
-        self.store_spans_in_file = self.get_option('store_spans_in_file')
-
         self.otel_service_name = self.get_option('otel_service_name')
 
         if not self.otel_service_name:
@@ -536,8 +498,6 @@ class CallbackModule(CallbackBase):
         # See https://github.com/open-telemetry/opentelemetry-specification/issues/740
         self.traceparent = self.get_option('traceparent')
 
-        self.otel_exporter_otlp_traces_protocol = self.get_option('otel_exporter_otlp_traces_protocol')
-
     def dump_results(self, task, result):
         """ dump the results if disable_logs is not enabled """
         if self.disable_logs:
@@ -633,22 +593,15 @@ class CallbackModule(CallbackBase):
             status = Status(status_code=StatusCode.OK)
         else:
             status = Status(status_code=StatusCode.ERROR)
-        otel_exporter = self.opentelemetry.generate_distributed_traces(
+        self.opentelemetry.generate_distributed_traces(
             self.otel_service_name,
             self.ansible_playbook,
             self.tasks_data,
             status,
             self.traceparent,
             self.disable_logs,
-            self.disable_attributes_in_logs,
-            self.otel_exporter_otlp_traces_protocol,
-            self.store_spans_in_file
+            self.disable_attributes_in_logs
         )
 
-        if self.store_spans_in_file:
-            spans = [json.loads(span.to_json()) for span in otel_exporter.get_finished_spans()]
-            with open(self.store_spans_in_file, "w", encoding="utf-8") as output:
-                json.dump({"spans": spans}, output, indent=4)
-
     def v2_runner_on_async_failed(self, result, **kwargs):
         self.errors += 1

plugins/callback/say.py

@@ -8,17 +8,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: say
-type: notification
-requirements:
-  - whitelisting in configuration
-  - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
-short_description: notify using software speech synthesizer
-description:
-  - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: say
+    type: notification
+    requirements:
+      - whitelisting in configuration
+      - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
+    short_description: notify using software speech synthesizer
+    description:
+      - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
+'''
 
 import platform
 import subprocess
@@ -50,7 +50,7 @@ class CallbackModule(CallbackBase):
             self.synthesizer = get_bin_path('say')
             if platform.system() != 'Darwin':
                 # 'say' binary available, it might be GNUstep tool which doesn't support 'voice' parameter
-                self._display.warning(f"'say' executable found but system is '{platform.system()}': ignoring voice parameter")
+                self._display.warning("'say' executable found but system is '%s': ignoring voice parameter" % platform.system())
             else:
                 self.FAILED_VOICE = 'Zarvox'
                 self.REGULAR_VOICE = 'Trinoids'
@@ -69,7 +69,7 @@ class CallbackModule(CallbackBase):
         # ansible will not call any callback if disabled is set to True
         if not self.synthesizer:
             self.disabled = True
-            self._display.warning(f"Unable to find either 'say' or 'espeak' executable, plugin {os.path.basename(__file__)} disabled")
+            self._display.warning("Unable to find either 'say' or 'espeak' executable, plugin %s disabled" % os.path.basename(__file__))
 
     def say(self, msg, voice):
         cmd = [self.synthesizer, msg]
@@ -78,7 +78,7 @@ class CallbackModule(CallbackBase):
         subprocess.call(cmd)
 
     def runner_on_failed(self, host, res, ignore_errors=False):
-        self.say(f"Failure on host {host}", self.FAILED_VOICE)
+        self.say("Failure on host %s" % host, self.FAILED_VOICE)
 
     def runner_on_ok(self, host, res):
         self.say("pew", self.LASER_VOICE)
@@ -87,13 +87,13 @@ class CallbackModule(CallbackBase):
         self.say("pew", self.LASER_VOICE)
 
     def runner_on_unreachable(self, host, res):
-        self.say(f"Failure on host {host}", self.FAILED_VOICE)
+        self.say("Failure on host %s" % host, self.FAILED_VOICE)
 
     def runner_on_async_ok(self, host, res, jid):
         self.say("pew", self.LASER_VOICE)
 
     def runner_on_async_failed(self, host, res, jid):
-        self.say(f"Failure on host {host}", self.FAILED_VOICE)
+        self.say("Failure on host %s" % host, self.FAILED_VOICE)
 
     def playbook_on_start(self):
         self.say("Running Playbook", self.REGULAR_VOICE)
@@ -103,15 +103,15 @@ class CallbackModule(CallbackBase):
 
     def playbook_on_task_start(self, name, is_conditional):
         if not is_conditional:
-            self.say(f"Starting task: {name}", self.REGULAR_VOICE)
+            self.say("Starting task: %s" % name, self.REGULAR_VOICE)
         else:
-            self.say(f"Notifying task: {name}", self.REGULAR_VOICE)
+            self.say("Notifying task: %s" % name, self.REGULAR_VOICE)
 
     def playbook_on_setup(self):
         self.say("Gathering facts", self.REGULAR_VOICE)
 
     def playbook_on_play_start(self, name):
-        self.say(f"Starting play: {name}", self.HAPPY_VOICE)
+        self.say("Starting play: %s" % name, self.HAPPY_VOICE)
 
     def playbook_on_stats(self, stats):
         self.say("Play complete", self.HAPPY_VOICE)

plugins/callback/selective.py

@@ -7,35 +7,35 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: selective
-type: stdout
-requirements:
-  - set as main display callback
-short_description: only print certain tasks
-description:
-  - This callback only prints tasks that have been tagged with C(print_action) or that have failed. This allows operators
-    to focus on the tasks that provide value only.
-  - Tasks that are not printed are placed with a C(.).
-  - If you increase verbosity all tasks are printed.
-options:
-  nocolor:
-    default: false
-    description: This setting allows suppressing colorizing output.
-    env:
-      - name: ANSIBLE_NOCOLOR
-      - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
-    ini:
-      - section: defaults
-        key: nocolor
-    type: boolean
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: selective
+    type: stdout
+    requirements:
+      - set as main display callback
+    short_description: only print certain tasks
+    description:
+      - This callback only prints tasks that have been tagged with C(print_action) or that have failed.
+        This allows operators to focus on the tasks that provide value only.
+      - Tasks that are not printed are placed with a C(.).
+      - If you increase verbosity all tasks are printed.
+    options:
+      nocolor:
+        default: false
+        description: This setting allows suppressing colorizing output.
+        env:
+          - name: ANSIBLE_NOCOLOR
+          - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
+        ini:
+          - section: defaults
+            key: nocolor
+        type: boolean
+'''
 
-EXAMPLES = r"""
-- ansible.builtin.debug: msg="This will not be printed"
-- ansible.builtin.debug: msg="But this will"
-  tags: [print_action]
+EXAMPLES = """
+  - ansible.builtin.debug: msg="This will not be printed"
+  - ansible.builtin.debug: msg="But this will"
+    tags: [print_action]
 """
 
 import difflib
@@ -48,13 +48,13 @@ from ansible.module_utils.common.text.converters import to_text
 DONT_COLORIZE = False
 COLORS = {
     'normal': '\033[0m',
-    'ok': f'\x1b[{C.COLOR_CODES[C.COLOR_OK]}m',
+    'ok': '\033[{0}m'.format(C.COLOR_CODES[C.COLOR_OK]),
     'bold': '\033[1m',
     'not_so_bold': '\033[1m\033[34m',
-    'changed': f'\x1b[{C.COLOR_CODES[C.COLOR_CHANGED]}m',
-    'failed': f'\x1b[{C.COLOR_CODES[C.COLOR_ERROR]}m',
+    'changed': '\033[{0}m'.format(C.COLOR_CODES[C.COLOR_CHANGED]),
+    'failed': '\033[{0}m'.format(C.COLOR_CODES[C.COLOR_ERROR]),
     'endc': '\033[0m',
-    'skipped': f'\x1b[{C.COLOR_CODES[C.COLOR_SKIP]}m',
+    'skipped': '\033[{0}m'.format(C.COLOR_CODES[C.COLOR_SKIP]),
 }
 
 
@@ -73,7 +73,7 @@ def colorize(msg, color):
     if DONT_COLORIZE:
         return msg
     else:
-        return f"{COLORS[color]}{msg}{COLORS['endc']}"
+        return '{0}{1}{2}'.format(COLORS[color], msg, COLORS['endc'])
 
 
 class CallbackModule(CallbackBase):
@@ -106,15 +106,15 @@ class CallbackModule(CallbackBase):
             line_length = 120
             if self.last_skipped:
                 print()
-            line = f"# {task_name} "
-            msg = colorize(f"{line}{'*' * (line_length - len(line))}", 'bold')
+            line = "# {0} ".format(task_name)
+            msg = colorize("{0}{1}".format(line, '*' * (line_length - len(line))), 'bold')
             print(msg)
 
     def _indent_text(self, text, indent_level):
         lines = text.splitlines()
         result_lines = []
         for l in lines:
-            result_lines.append(f"{' ' * indent_level}{l}")
+            result_lines.append("{0}{1}".format(' ' * indent_level, l))
         return '\n'.join(result_lines)
 
     def _print_diff(self, diff, indent_level):
@@ -147,19 +147,19 @@ class CallbackModule(CallbackBase):
             change_string = colorize('FAILED!!!', color)
         else:
             color = 'changed' if changed else 'ok'
-            change_string = colorize(f"changed={changed}", color)
+            change_string = colorize("changed={0}".format(changed), color)
 
         msg = colorize(msg, color)
 
         line_length = 120
         spaces = ' ' * (40 - len(name) - indent_level)
-        line = f"{' ' * indent_level}  * {name}{spaces}- {change_string}"
+        line = "{0}  * {1}{2}- {3}".format(' ' * indent_level, name, spaces, change_string)
 
         if len(msg) < 50:
-            line += f' -- {msg}'
-            print(f"{line} {'-' * (line_length - len(line))}---------")
+            line += ' -- {0}'.format(msg)
+            print("{0} {1}---------".format(line, '-' * (line_length - len(line))))
         else:
-            print(f"{line} {'-' * (line_length - len(line))}")
+            print("{0} {1}".format(line, '-' * (line_length - len(line))))
             print(self._indent_text(msg, indent_level + 4))
 
         if diff:
@@ -239,10 +239,8 @@ class CallbackModule(CallbackBase):
             else:
                 color = 'ok'
 
-            msg = (
-                f"{host}    : ok={s['ok']}\tchanged={s['changed']}\tfailed={s['failures']}\tunreachable="
-                f"{s['unreachable']}\trescued={s['rescued']}\tignored={s['ignored']}"
-            )
+            msg = '{0}    : ok={1}\tchanged={2}\tfailed={3}\tunreachable={4}\trescued={5}\tignored={6}'.format(
+                host, s['ok'], s['changed'], s['failures'], s['unreachable'], s['rescued'], s['ignored'])
             print(colorize(msg, color))
 
     def v2_runner_on_skipped(self, result, **kwargs):
@@ -254,15 +252,17 @@ class CallbackModule(CallbackBase):
             line_length = 120
             spaces = ' ' * (31 - len(result._host.name) - 4)
 
-            line = f"  * {colorize(result._host.name, 'not_so_bold')}{spaces}- {colorize('skipped', 'skipped')}"
+            line = "  * {0}{1}- {2}".format(colorize(result._host.name, 'not_so_bold'),
+                                            spaces,
+                                            colorize("skipped", 'skipped'),)
 
             reason = result._result.get('skipped_reason', '') or \
                 result._result.get('skip_reason', '')
             if len(reason) < 50:
-                line += f' -- {reason}'
-                print(f"{line} {'-' * (line_length - len(line))}---------")
+                line += ' -- {0}'.format(reason)
+                print("{0} {1}---------".format(line, '-' * (line_length - len(line))))
             else:
-                print(f"{line} {'-' * (line_length - len(line))}")
+                print("{0} {1}".format(line, '-' * (line_length - len(line))))
                 print(self._indent_text(reason, 8))
                 print(reason)
 

plugins/callback/slack.py

@@ -8,60 +8,58 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: slack
-type: notification
-requirements:
-  - whitelist in configuration
-  - prettytable (python library)
-short_description: Sends play events to a Slack channel
-description:
-  - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
-options:
-  webhook_url:
-    required: true
-    description: Slack Webhook URL.
-    type: str
-    env:
-      - name: SLACK_WEBHOOK_URL
-    ini:
-      - section: callback_slack
-        key: webhook_url
-  channel:
-    default: "#ansible"
-    description: Slack room to post in.
-    type: str
-    env:
-      - name: SLACK_CHANNEL
-    ini:
-      - section: callback_slack
-        key: channel
-  username:
-    description: Username to post as.
-    type: str
-    env:
-      - name: SLACK_USERNAME
-    default: ansible
-    ini:
-      - section: callback_slack
-        key: username
-  validate_certs:
-    description: Validate the SSL certificate of the Slack server for HTTPS URLs.
-    env:
-      - name: SLACK_VALIDATE_CERTS
-    ini:
-      - section: callback_slack
-        key: validate_certs
-    default: true
-    type: bool
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: slack
+    type: notification
+    requirements:
+      - whitelist in configuration
+      - prettytable (python library)
+    short_description: Sends play events to a Slack channel
+    description:
+        - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
+    options:
+      webhook_url:
+        required: true
+        description: Slack Webhook URL.
+        env:
+          - name: SLACK_WEBHOOK_URL
+        ini:
+          - section: callback_slack
+            key: webhook_url
+      channel:
+        default: "#ansible"
+        description: Slack room to post in.
+        env:
+          - name: SLACK_CHANNEL
+        ini:
+          - section: callback_slack
+            key: channel
+      username:
+        description: Username to post as.
+        env:
+          - name: SLACK_USERNAME
+        default: ansible
+        ini:
+          - section: callback_slack
+            key: username
+      validate_certs:
+        description: Validate the SSL certificate of the Slack server for HTTPS URLs.
+        env:
+          - name: SLACK_VALIDATE_CERTS
+        ini:
+          - section: callback_slack
+            key: validate_certs
+        default: true
+        type: bool
+'''
 
 import json
 import os
 import uuid
 
 from ansible import context
+from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.urls import open_url
 from ansible.plugins.callback import CallbackBase
 
@@ -137,13 +135,14 @@ class CallbackModule(CallbackBase):
                                 headers=headers)
             return response.read()
         except Exception as e:
-            self._display.warning(f'Could not submit message to Slack: {e}')
+            self._display.warning(u'Could not submit message to Slack: %s' %
+                                  to_text(e))
 
     def v2_playbook_on_start(self, playbook):
         self.playbook_name = os.path.basename(playbook._file_name)
 
         title = [
-            f'*Playbook initiated* (_{self.guid}_)'
+            '*Playbook initiated* (_%s_)' % self.guid
         ]
 
         invocation_items = []
@@ -154,23 +153,23 @@ class CallbackModule(CallbackBase):
             subset = context.CLIARGS['subset']
             inventory = [os.path.abspath(i) for i in context.CLIARGS['inventory']]
 
-            invocation_items.append(f"Inventory:  {', '.join(inventory)}")
+            invocation_items.append('Inventory:  %s' % ', '.join(inventory))
             if tags and tags != ['all']:
-                invocation_items.append(f"Tags:       {', '.join(tags)}")
+                invocation_items.append('Tags:       %s' % ', '.join(tags))
             if skip_tags:
-                invocation_items.append(f"Skip Tags:  {', '.join(skip_tags)}")
+                invocation_items.append('Skip Tags:  %s' % ', '.join(skip_tags))
             if subset:
-                invocation_items.append(f'Limit:      {subset}')
+                invocation_items.append('Limit:      %s' % subset)
             if extra_vars:
-                invocation_items.append(f"Extra Vars: {' '.join(extra_vars)}")
+                invocation_items.append('Extra Vars: %s' %
+                                        ' '.join(extra_vars))
 
-            title.append(f"by *{context.CLIARGS['remote_user']}*")
+            title.append('by *%s*' % context.CLIARGS['remote_user'])
 
-        title.append(f'\n\n*{self.playbook_name}*')
+        title.append('\n\n*%s*' % self.playbook_name)
         msg_items = [' '.join(title)]
         if invocation_items:
-            _inv_item = '\n'.join(invocation_items)
-            msg_items.append(f'```\n{_inv_item}\n```')
+            msg_items.append('```\n%s\n```' % '\n'.join(invocation_items))
 
         msg = '\n'.join(msg_items)
 
@@ -190,8 +189,8 @@ class CallbackModule(CallbackBase):
     def v2_playbook_on_play_start(self, play):
         """Display Play start messages"""
 
-        name = play.name or f'Play name not specified ({play._uuid})'
-        msg = f'*Starting play* (_{self.guid}_)\n\n*{name}*'
+        name = play.name or 'Play name not specified (%s)' % play._uuid
+        msg = '*Starting play* (_%s_)\n\n*%s*' % (self.guid, name)
         attachments = [
             {
                 'fallback': msg,
@@ -226,7 +225,7 @@ class CallbackModule(CallbackBase):
 
         attachments = []
         msg_items = [
-            f'*Playbook Complete* (_{self.guid}_)'
+            '*Playbook Complete* (_%s_)' % self.guid
         ]
         if failures or unreachable:
             color = 'danger'
@@ -235,7 +234,7 @@ class CallbackModule(CallbackBase):
             color = 'good'
             msg_items.append('\n*Success!*')
 
-        msg_items.append(f'```\n{t}\n```')
+        msg_items.append('```\n%s\n```' % t)
 
         msg = '\n'.join(msg_items)
 

plugins/callback/splunk.py

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

plugins/callback/sumologic.py

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

plugins/callback/syslog_json.py

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

plugins/callback/timestamp.py

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

plugins/callback/unixy.py

@@ -8,18 +8,18 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-name: unixy
-type: stdout
-author: Al Bowles (@akatch)
-short_description: condensed Ansible output
-description:
-  - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout in configuration
-"""
+DOCUMENTATION = '''
+    name: unixy
+    type: stdout
+    author: Al Bowles (@akatch)
+    short_description: condensed Ansible output
+    description:
+      - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout in configuration
+'''
 
 from os.path import basename
 from ansible import constants as C
@@ -67,24 +67,24 @@ class CallbackModule(CallbackModule_default):
 
     def _process_result_output(self, result, msg):
         task_host = result._host.get_name()
-        task_result = f"{task_host} {msg}"
+        task_result = "%s %s" % (task_host, msg)
 
         if self._run_is_verbose(result):
-            task_result = f"{task_host} {msg}: {self._dump_results(result._result, indent=4)}"
+            task_result = "%s %s: %s" % (task_host, msg, self._dump_results(result._result, indent=4))
             return task_result
 
         if self.delegated_vars:
             task_delegate_host = self.delegated_vars['ansible_host']
-            task_result = f"{task_host} -> {task_delegate_host} {msg}"
+            task_result = "%s -> %s %s" % (task_host, task_delegate_host, msg)
 
         if result._result.get('msg') and result._result.get('msg') != "All items completed":
-            task_result += f" | msg: {to_text(result._result.get('msg'))}"
+            task_result += " | msg: " + to_text(result._result.get('msg'))
 
         if result._result.get('stdout'):
-            task_result += f" | stdout: {result._result.get('stdout')}"
+            task_result += " | stdout: " + result._result.get('stdout')
 
         if result._result.get('stderr'):
-            task_result += f" | stderr: {result._result.get('stderr')}"
+            task_result += " | stderr: " + result._result.get('stderr')
 
         return task_result
 
@@ -92,30 +92,30 @@ class CallbackModule(CallbackModule_default):
         self._get_task_display_name(task)
         if self.task_display_name is not None:
             if task.check_mode and self.get_option('check_mode_markers'):
-                self._display.display(f"{self.task_display_name} (check mode)...")
+                self._display.display("%s (check mode)..." % self.task_display_name)
             else:
-                self._display.display(f"{self.task_display_name}...")
+                self._display.display("%s..." % self.task_display_name)
 
     def v2_playbook_on_handler_task_start(self, task):
         self._get_task_display_name(task)
         if self.task_display_name is not None:
             if task.check_mode and self.get_option('check_mode_markers'):
-                self._display.display(f"{self.task_display_name} (via handler in check mode)... ")
+                self._display.display("%s (via handler in check mode)... " % self.task_display_name)
             else:
-                self._display.display(f"{self.task_display_name} (via handler)... ")
+                self._display.display("%s (via handler)... " % self.task_display_name)
 
     def v2_playbook_on_play_start(self, play):
         name = play.get_name().strip()
         if play.check_mode and self.get_option('check_mode_markers'):
             if name and play.hosts:
-                msg = f"\n- {name} (in check mode) on hosts: {','.join(play.hosts)} -"
+                msg = u"\n- %s (in check mode) on hosts: %s -" % (name, ",".join(play.hosts))
             else:
-                msg = "- check mode -"
+                msg = u"- check mode -"
         else:
             if name and play.hosts:
-                msg = f"\n- {name} on hosts: {','.join(play.hosts)} -"
+                msg = u"\n- %s on hosts: %s -" % (name, ",".join(play.hosts))
             else:
-                msg = "---"
+                msg = u"---"
 
         self._display.display(msg)
 
@@ -126,7 +126,7 @@ class CallbackModule(CallbackModule_default):
             msg = "skipped"
 
             task_result = self._process_result_output(result, msg)
-            self._display.display(f"  {task_result}", display_color)
+            self._display.display("  " + task_result, display_color)
         else:
             return
 
@@ -136,10 +136,10 @@ class CallbackModule(CallbackModule_default):
         msg = "failed"
         item_value = self._get_item_label(result._result)
         if item_value:
-            msg += f" | item: {item_value}"
+            msg += " | item: %s" % (item_value,)
 
         task_result = self._process_result_output(result, msg)
-        self._display.display(f"  {task_result}", display_color, stderr=self.get_option('display_failed_stderr'))
+        self._display.display("  " + task_result, display_color, stderr=self.get_option('display_failed_stderr'))
 
     def v2_runner_on_ok(self, result, msg="ok", display_color=C.COLOR_OK):
         self._preprocess_result(result)
@@ -149,13 +149,13 @@ class CallbackModule(CallbackModule_default):
             msg = "done"
             item_value = self._get_item_label(result._result)
             if item_value:
-                msg += f" | item: {item_value}"
+                msg += " | item: %s" % (item_value,)
             display_color = C.COLOR_CHANGED
             task_result = self._process_result_output(result, msg)
-            self._display.display(f"  {task_result}", display_color)
+            self._display.display("  " + task_result, display_color)
         elif self.get_option('display_ok_hosts'):
             task_result = self._process_result_output(result, msg)
-            self._display.display(f"  {task_result}", display_color)
+            self._display.display("  " + task_result, display_color)
 
     def v2_runner_item_on_skipped(self, result):
         self.v2_runner_on_skipped(result)
@@ -173,7 +173,7 @@ class CallbackModule(CallbackModule_default):
         display_color = C.COLOR_UNREACHABLE
         task_result = self._process_result_output(result, msg)
 
-        self._display.display(f"  {task_result}", display_color, stderr=self.get_option('display_failed_stderr'))
+        self._display.display("  " + task_result, display_color, stderr=self.get_option('display_failed_stderr'))
 
     def v2_on_file_diff(self, result):
         if result._task.loop and 'results' in result._result:
@@ -195,17 +195,25 @@ class CallbackModule(CallbackModule_default):
             # TODO how else can we display these?
             t = stats.summarize(h)
 
-            self._display.display(
-                f"  {hostcolor(h, t)} : {colorize('ok', t['ok'], C.COLOR_OK)} {colorize('changed', t['changed'], C.COLOR_CHANGED)} "
-                f"{colorize('unreachable', t['unreachable'], C.COLOR_UNREACHABLE)} {colorize('failed', t['failures'], C.COLOR_ERROR)} "
-                f"{colorize('rescued', t['rescued'], C.COLOR_OK)} {colorize('ignored', t['ignored'], C.COLOR_WARN)}",
+            self._display.display(u"  %s : %s %s %s %s %s %s" % (
+                hostcolor(h, t),
+                colorize(u'ok', t['ok'], C.COLOR_OK),
+                colorize(u'changed', t['changed'], C.COLOR_CHANGED),
+                colorize(u'unreachable', t['unreachable'], C.COLOR_UNREACHABLE),
+                colorize(u'failed', t['failures'], C.COLOR_ERROR),
+                colorize(u'rescued', t['rescued'], C.COLOR_OK),
+                colorize(u'ignored', t['ignored'], C.COLOR_WARN)),
                 screen_only=True
             )
 
-            self._display.display(
-                f"  {hostcolor(h, t, False)} : {colorize('ok', t['ok'], None)} {colorize('changed', t['changed'], None)} "
-                f"{colorize('unreachable', t['unreachable'], None)} {colorize('failed', t['failures'], None)} {colorize('rescued', t['rescued'], None)} "
-                f"{colorize('ignored', t['ignored'], None)}",
+            self._display.display(u"  %s : %s %s %s %s %s %s" % (
+                hostcolor(h, t, False),
+                colorize(u'ok', t['ok'], None),
+                colorize(u'changed', t['changed'], None),
+                colorize(u'unreachable', t['unreachable'], None),
+                colorize(u'failed', t['failures'], None),
+                colorize(u'rescued', t['rescued'], None),
+                colorize(u'ignored', t['ignored'], None)),
                 log_only=True
             )
         if stats.custom and self.get_option('show_custom_stats'):
@@ -215,14 +223,12 @@ class CallbackModule(CallbackModule_default):
             for k in sorted(stats.custom.keys()):
                 if k == '_run':
                     continue
-                stat_val = self._dump_results(stats.custom[k], indent=1).replace('\n', '')
-                self._display.display(f'\t{k}: {stat_val}')
+                self._display.display('\t%s: %s' % (k, self._dump_results(stats.custom[k], indent=1).replace('\n', '')))
 
             # print per run custom stats
             if '_run' in stats.custom:
                 self._display.display("", screen_only=True)
-                stat_val_run = self._dump_results(stats.custom['_run'], indent=1).replace('\n', '')
-                self._display.display(f'\tRUN: {stat_val_run}')
+                self._display.display('\tRUN: %s' % self._dump_results(stats.custom['_run'], indent=1).replace('\n', ''))
             self._display.display("", screen_only=True)
 
     def v2_playbook_on_no_hosts_matched(self):
@@ -233,23 +239,23 @@ class CallbackModule(CallbackModule_default):
 
     def v2_playbook_on_start(self, playbook):
         if context.CLIARGS['check'] and self.get_option('check_mode_markers'):
-            self._display.display(f"Executing playbook {basename(playbook._file_name)} in check mode")
+            self._display.display("Executing playbook %s in check mode" % basename(playbook._file_name))
         else:
-            self._display.display(f"Executing playbook {basename(playbook._file_name)}")
+            self._display.display("Executing playbook %s" % basename(playbook._file_name))
 
         # show CLI arguments
         if self._display.verbosity > 3:
             if context.CLIARGS.get('args'):
-                self._display.display(f"Positional arguments: {' '.join(context.CLIARGS['args'])}",
+                self._display.display('Positional arguments: %s' % ' '.join(context.CLIARGS['args']),
                                       color=C.COLOR_VERBOSE, screen_only=True)
 
             for argument in (a for a in context.CLIARGS if a != 'args'):
                 val = context.CLIARGS[argument]
                 if val:
-                    self._display.vvvv(f'{argument}: {val}')
+                    self._display.vvvv('%s: %s' % (argument, val))
 
     def v2_runner_retry(self, result):
-        msg = f"  Retrying... ({result._result['attempts']} of {result._result['retries']})"
+        msg = "  Retrying... (%d of %d)" % (result._result['attempts'], result._result['retries'])
         if self._run_is_verbose(result):
-            msg += f"Result was: {self._dump_results(result._result)}"
+            msg += "Result was: %s" % self._dump_results(result._result)
         self._display.display(msg, color=C.COLOR_DEBUG)

plugins/callback/yaml.py

@@ -7,31 +7,29 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Unknown (!UNKNOWN)
-name: yaml
-type: stdout
-short_description: YAML-ized Ansible screen output
-deprecated:
-  removed_in: 13.0.0
-  why: Starting in ansible-core 2.13, the P(ansible.builtin.default#callback) callback has support for printing output in YAML format.
-  alternative: Use O(ansible.builtin.default#callback:result_format=yaml).
-description:
-  - Ansible output that can be quite a bit easier to read than the default JSON formatting.
-extends_documentation_fragment:
-  - default_callback
-requirements:
-  - set as stdout in configuration
-seealso:
-  - plugin: ansible.builtin.default
-    plugin_type: callback
-    description: >-
-      There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback) that allows
-      you to change the output format to YAML.
-notes:
-  - With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
-    in P(ansible.builtin.default#callback).
-"""
+DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
+    name: yaml
+    type: stdout
+    short_description: YAML-ized Ansible screen output
+    description:
+        - Ansible output that can be quite a bit easier to read than the
+          default JSON formatting.
+    extends_documentation_fragment:
+      - default_callback
+    requirements:
+      - set as stdout in configuration
+    seealso:
+      - plugin: ansible.builtin.default
+        plugin_type: callback
+        description: >
+          There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback)
+          that allows you to change the output format to YAML.
+    notes:
+      - >
+        With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
+        in P(ansible.builtin.default#callback).
+'''
 
 import yaml
 import json
@@ -47,7 +45,7 @@ from ansible.plugins.callback.default import CallbackModule as Default
 # from http://stackoverflow.com/a/15423007/115478
 def should_use_block(value):
     """Returns true if string should be in block format"""
-    for c in "\u000a\u000d\u001c\u001d\u001e\u0085\u2028\u2029":
+    for c in u"\u000a\u000d\u001c\u001d\u001e\u0085\u2028\u2029":
         if c in value:
             return True
     return False
@@ -115,11 +113,11 @@ class CallbackModule(Default):
 
         # put changed and skipped into a header line
         if 'changed' in abridged_result:
-            dumped += f"changed={str(abridged_result['changed']).lower()} "
+            dumped += 'changed=' + str(abridged_result['changed']).lower() + ' '
             del abridged_result['changed']
 
         if 'skipped' in abridged_result:
-            dumped += f"skipped={str(abridged_result['skipped']).lower()} "
+            dumped += 'skipped=' + str(abridged_result['skipped']).lower() + ' '
             del abridged_result['skipped']
 
         # if we already have stdout, we don't need stdout_lines

plugins/connection/chroot.py

@@ -10,66 +10,76 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
-name: chroot
-short_description: Interact with local chroot
-description:
-  - Run commands or put/fetch files to an existing chroot on the Ansible controller.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
+    name: chroot
+    short_description: Interact with local chroot
     description:
-      - The path of the chroot you want to access.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-  executable:
-    description:
-      - User specified executable shell.
-    type: string
-    ini:
-      - section: defaults
-        key: executable
-    env:
-      - name: ANSIBLE_EXECUTABLE
-    vars:
-      - name: ansible_executable
-    default: /bin/sh
-  chroot_exe:
-    description:
-      - User specified chroot binary.
-    type: string
-    ini:
-      - section: chroot_connection
-        key: exe
-    env:
-      - name: ANSIBLE_CHROOT_EXE
-    vars:
-      - name: ansible_chroot_exe
-    default: chroot
-  disable_root_check:
-    description:
-      - Do not check that the user is not root.
-    ini:
-      - section: chroot_connection
-        key: disable_root_check
-    env:
-      - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
-    vars:
-      - name: ansible_chroot_disable_root_check
-    default: false
-    type: bool
-    version_added: 7.3.0
-"""
+        - Run commands or put/fetch files to an existing chroot on the Ansible controller.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+      executable:
+        description:
+            - User specified executable shell
+        ini:
+          - section: defaults
+            key: executable
+        env:
+          - name: ANSIBLE_EXECUTABLE
+        vars:
+          - name: ansible_executable
+        default: /bin/sh
+      chroot_exe:
+        description:
+            - User specified chroot binary
+        ini:
+          - section: chroot_connection
+            key: exe
+        env:
+          - name: ANSIBLE_CHROOT_EXE
+        vars:
+          - name: ansible_chroot_exe
+        default: chroot
+      disable_root_check:
+        description:
+            - Do not check that the user is not root.
+        ini:
+          - section: chroot_connection
+            key: disable_root_check
+        env:
+          - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
+        vars:
+          - name: ansible_chroot_disable_root_check
+        default: false
+        type: bool
+        version_added: 7.3.0
+'''
 
 EXAMPLES = r"""
+# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
+# sudo -E ansible-playbook ...
+#
+# Static inventory file
+# [chroots]
+# /path/to/debootstrap
+# /path/to/feboostrap
+# /path/to/lxc-image
+# /path/to/chroot
+
+# playbook
+---
 - hosts: chroots
   connection: community.general.chroot
   tasks:
     - debug:
         msg: "This is coming from chroot environment"
+
 """
 
 import os
@@ -81,7 +91,7 @@ from ansible.errors import AnsibleError
 from ansible.module_utils.basic import is_executable
 from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils.common.text.converters import to_bytes
+from ansible.module_utils.common.text.converters import to_bytes, to_native
 from ansible.plugins.connection import ConnectionBase, BUFSIZE
 from ansible.utils.display import Display
 
@@ -107,15 +117,15 @@ class Connection(ConnectionBase):
 
         # do some trivial checks for ensuring 'host' is actually a chroot'able dir
         if not os.path.isdir(self.chroot):
-            raise AnsibleError(f"{self.chroot} is not a directory")
+            raise AnsibleError("%s is not a directory" % self.chroot)
 
         chrootsh = os.path.join(self.chroot, 'bin/sh')
         # Want to check for a usable bourne shell inside the chroot.
         # is_executable() == True is sufficient.  For symlinks it
         # gets really complicated really fast.  So we punt on finding that
-        # out.  As long as it is a symlink we assume that it will work
+        # out.  As long as it's a symlink we assume that it will work
         if not (is_executable(chrootsh) or (os.path.lexists(chrootsh) and os.path.islink(chrootsh))):
-            raise AnsibleError(f"{self.chroot} does not look like a chrootable dir (/bin/sh missing)")
+            raise AnsibleError("%s does not look like a chrootable dir (/bin/sh missing)" % self.chroot)
 
     def _connect(self):
         """ connect to the chroot """
@@ -130,7 +140,7 @@ class Connection(ConnectionBase):
             try:
                 self.chroot_cmd = get_bin_path(self.get_option('chroot_exe'))
             except ValueError as e:
-                raise AnsibleError(str(e))
+                raise AnsibleError(to_native(e))
 
         super(Connection, self)._connect()
         if not self._connected:
@@ -148,7 +158,7 @@ class Connection(ConnectionBase):
         executable = self.get_option('executable')
         local_cmd = [self.chroot_cmd, self.chroot, executable, '-c', cmd]
 
-        display.vvv(f"EXEC {local_cmd}", host=self.chroot)
+        display.vvv("EXEC %s" % local_cmd, host=self.chroot)
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
         p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE)
@@ -173,7 +183,7 @@ class Connection(ConnectionBase):
             exist in any given chroot.  So for now we're choosing "/" instead.
             This also happens to be the former default.
 
-            Can revisit using $HOME instead if it is a problem
+            Can revisit using $HOME instead if it's a problem
         """
         if not remote_path.startswith(os.path.sep):
             remote_path = os.path.join(os.path.sep, remote_path)
@@ -182,7 +192,7 @@ class Connection(ConnectionBase):
     def put_file(self, in_path, out_path):
         """ transfer a file from local to chroot """
         super(Connection, self).put_file(in_path, out_path)
-        display.vvv(f"PUT {in_path} TO {out_path}", host=self.chroot)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.chroot)
 
         out_path = shlex_quote(self._prefix_login_path(out_path))
         try:
@@ -192,27 +202,27 @@ class Connection(ConnectionBase):
                 else:
                     count = ''
                 try:
-                    p = self._buffered_exec_command(f'dd of={out_path} bs={BUFSIZE}{count}', stdin=in_file)
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
                 except OSError:
                     raise AnsibleError("chroot connection requires dd command in the chroot")
                 try:
                     stdout, stderr = p.communicate()
                 except Exception:
                     traceback.print_exc()
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
                 if p.returncode != 0:
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
         except IOError:
-            raise AnsibleError(f"file or module does not exist at: {in_path}")
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
 
     def fetch_file(self, in_path, out_path):
         """ fetch a file from chroot to local """
         super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv(f"FETCH {in_path} TO {out_path}", host=self.chroot)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.chroot)
 
         in_path = shlex_quote(self._prefix_login_path(in_path))
         try:
-            p = self._buffered_exec_command(f'dd if={in_path} bs={BUFSIZE}')
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
         except OSError:
             raise AnsibleError("chroot connection requires dd command in the chroot")
 
@@ -224,10 +234,10 @@ class Connection(ConnectionBase):
                     chunk = p.stdout.read(BUFSIZE)
             except Exception:
                 traceback.print_exc()
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
             stdout, stderr = p.communicate()
             if p.returncode != 0:
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
 
     def close(self):
         """ terminate the connection; nothing to do here """

plugins/connection/funcd.py

@@ -9,24 +9,23 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Michael Scherer (@mscherer) <misc@zarb.org>
-name: funcd
-short_description: Use funcd to connect to target
-description:
-  - This transport permits you to use Ansible over Func.
-  - For people who have already setup func and that wish to play with ansible, this permit to move gradually to ansible without
-    having to redo completely the setup of the network.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: funcd
+    short_description: Use funcd to connect to target
     description:
-      - The path of the chroot you want to access.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-      - name: ansible_func_host
-"""
+        - This transport permits you to use Ansible over Func.
+        - For people who have already setup func and that wish to play with ansible,
+          this permit to move gradually to ansible without having to redo completely the setup of the network.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_func_host
+'''
 
 HAVE_FUNC = False
 try:
@@ -72,7 +71,7 @@ class Connection(ConnectionBase):
             raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
 
         # totally ignores privilege escalation
-        display.vvv(f"EXEC {cmd}", host=self.host)
+        display.vvv("EXEC %s" % cmd, host=self.host)
         p = self.client.command.run(cmd)[self.host]
         return p[0], p[1], p[2]
 
@@ -87,14 +86,14 @@ class Connection(ConnectionBase):
         """ transfer a file from local to remote """
 
         out_path = self._normalize_path(out_path, '/')
-        display.vvv(f"PUT {in_path} TO {out_path}", host=self.host)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.host)
         self.client.local.copyfile.send(in_path, out_path)
 
     def fetch_file(self, in_path, out_path):
         """ fetch a file from remote to local """
 
         in_path = self._normalize_path(in_path, '/')
-        display.vvv(f"FETCH {in_path} TO {out_path}", host=self.host)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host)
         # need to use a tmp dir due to difference of semantic for getfile
         # ( who take a # directory as destination) and fetch_file, who
         # take a file directly

plugins/connection/incus.py

@@ -8,47 +8,43 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Stéphane Graber (@stgraber)
-name: incus
-short_description: Run tasks in Incus instances using the Incus CLI
-description:
-  - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
-version_added: "8.2.0"
-options:
-  remote_addr:
+DOCUMENTATION = """
+    author: Stéphane Graber (@stgraber)
+    name: incus
+    short_description: Run tasks in Incus instances via the Incus CLI.
     description:
-      - The instance identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_incus_host
-  executable:
-    description:
-      - The shell to use for execution inside the instance.
-    type: string
-    default: /bin/sh
-    vars:
-      - name: ansible_executable
-      - name: ansible_incus_executable
-  remote:
-    description:
-      - The name of the Incus remote to use (per C(incus remote list)).
-      - Remotes are used to access multiple servers from a single client.
-    type: string
-    default: local
-    vars:
-      - name: ansible_incus_remote
-  project:
-    description:
-      - The name of the Incus project to use (per C(incus project list)).
-      - Projects are used to divide the instances running on a server.
-    type: string
-    default: default
-    vars:
-      - name: ansible_incus_project
+        - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
+    version_added: "8.2.0"
+    options:
+      remote_addr:
+        description:
+            - The instance identifier.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_incus_host
+      executable:
+        description:
+            - The shell to use for execution inside the instance.
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_incus_executable
+      remote:
+        description:
+            - The name of the Incus remote to use (per C(incus remote list)).
+            - Remotes are used to access multiple servers from a single client.
+        default: local
+        vars:
+            - name: ansible_incus_remote
+      project:
+        description:
+            - The name of the Incus project to use (per C(incus project list)).
+            - Projects are used to divide the instances running on a server.
+        default: default
+        vars:
+            - name: ansible_incus_project
 """
 
 import os
@@ -80,7 +76,7 @@ class Connection(ConnectionBase):
         super(Connection, self)._connect()
 
         if not self._connected:
-            self._display.vvv("ESTABLISH Incus CONNECTION FOR USER: root",
+            self._display.vvv(u"ESTABLISH Incus CONNECTION FOR USER: root",
                               host=self._instance())
             self._connected = True
 
@@ -93,14 +89,14 @@ class Connection(ConnectionBase):
         """ execute a command on the Incus host """
         super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
-        self._display.vvv(f"EXEC {cmd}",
+        self._display.vvv(u"EXEC {0}".format(cmd),
                           host=self._instance())
 
         local_cmd = [
             self._incus_cmd,
             "--project", self.get_option("project"),
             "exec",
-            f"{self.get_option('remote')}:{self._instance()}",
+            "%s:%s" % (self.get_option("remote"), self._instance()),
             "--",
             self._play_context.executable, "-c", cmd]
 
@@ -114,10 +110,12 @@ class Connection(ConnectionBase):
         stderr = to_text(stderr)
 
         if stderr == "Error: Instance is not running.\n":
-            raise AnsibleConnectionFailure(f"instance not running: {self._instance()}")
+            raise AnsibleConnectionFailure("instance not running: %s" %
+                                           self._instance())
 
         if stderr == "Error: Instance not found\n":
-            raise AnsibleConnectionFailure(f"instance not found: {self._instance()}")
+            raise AnsibleConnectionFailure("instance not found: %s" %
+                                           self._instance())
 
         return process.returncode, stdout, stderr
 
@@ -125,18 +123,20 @@ class Connection(ConnectionBase):
         """ put a file from local to Incus """
         super(Connection, self).put_file(in_path, out_path)
 
-        self._display.vvv(f"PUT {in_path} TO {out_path}",
+        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path),
                           host=self._instance())
 
         if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
-            raise AnsibleFileNotFound(f"input path is not a file: {in_path}")
+            raise AnsibleFileNotFound("input path is not a file: %s" % in_path)
 
         local_cmd = [
             self._incus_cmd,
             "--project", self.get_option("project"),
             "file", "push", "--quiet",
             in_path,
-            f"{self.get_option('remote')}:{self._instance()}/{out_path}"]
+            "%s:%s/%s" % (self.get_option("remote"),
+                          self._instance(),
+                          out_path)]
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
 
@@ -146,14 +146,16 @@ class Connection(ConnectionBase):
         """ fetch a file from Incus to local """
         super(Connection, self).fetch_file(in_path, out_path)
 
-        self._display.vvv(f"FETCH {in_path} TO {out_path}",
+        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path),
                           host=self._instance())
 
         local_cmd = [
             self._incus_cmd,
             "--project", self.get_option("project"),
             "file", "pull", "--quiet",
-            f"{self.get_option('remote')}:{self._instance()}/{in_path}",
+            "%s:%s/%s" % (self.get_option("remote"),
+                          self._instance(),
+                          in_path),
             out_path]
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]

plugins/connection/iocage.py

@@ -10,28 +10,26 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
-name: iocage
-short_description: Run tasks in iocage jails
-description:
-  - Run commands or put/fetch files to an existing iocage jail.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
+    name: iocage
+    short_description: Run tasks in iocage jails
     description:
-      - Path to the jail.
-    type: string
-    vars:
-      - name: ansible_host
-      - name: ansible_iocage_host
-  remote_user:
-    description:
-      - User to execute as inside the jail.
-    type: string
-    vars:
-      - name: ansible_user
-      - name: ansible_iocage_user
-"""
+        - Run commands or put/fetch files to an existing iocage jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        vars:
+            - name: ansible_host
+            - name: ansible_iocage_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_iocage_user
+'''
 
 import subprocess
 
@@ -55,12 +53,11 @@ class Connection(Jail):
 
         jail_uuid = self.get_jail_uuid()
 
-        kwargs[Jail.modified_jailname_key] = f'ioc-{jail_uuid}'
+        kwargs[Jail.modified_jailname_key] = 'ioc-{0}'.format(jail_uuid)
 
-        display.vvv(
-            f"Jail {self.ioc_jail} has been translated to {kwargs[Jail.modified_jailname_key]}",
-            host=kwargs[Jail.modified_jailname_key]
-        )
+        display.vvv(u"Jail {iocjail} has been translated to {rawjail}".format(
+            iocjail=self.ioc_jail, rawjail=kwargs[Jail.modified_jailname_key]),
+            host=kwargs[Jail.modified_jailname_key])
 
         super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
 
@@ -82,6 +79,6 @@ class Connection(Jail):
         p.wait()
 
         if p.returncode != 0:
-            raise AnsibleError(f"iocage returned an error: {stdout}")
+            raise AnsibleError(u"iocage returned an error: {0}".format(stdout))
 
         return stdout.strip('\n')

plugins/connection/jail.py

@@ -10,30 +10,28 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Ansible Core Team
-name: jail
-short_description: Run tasks in jails
-description:
-  - Run commands or put/fetch files to an existing jail.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Ansible Core Team
+    name: jail
+    short_description: Run tasks in jails
     description:
-      - Path to the jail.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_jail_host
-  remote_user:
-    description:
-      - User to execute as inside the jail.
-    type: string
-    vars:
-      - name: ansible_user
-      - name: ansible_jail_user
-"""
+        - Run commands or put/fetch files to an existing jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_jail_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_jail_user
+'''
 
 import os
 import os.path
@@ -75,14 +73,14 @@ class Connection(ConnectionBase):
         self.jexec_cmd = self._search_executable('jexec')
 
         if self.jail not in self.list_jails():
-            raise AnsibleError(f"incorrect jail name {self.jail}")
+            raise AnsibleError("incorrect jail name %s" % self.jail)
 
     @staticmethod
     def _search_executable(executable):
         try:
             return get_bin_path(executable)
         except ValueError:
-            raise AnsibleError(f"{executable} command not found in PATH")
+            raise AnsibleError("%s command not found in PATH" % executable)
 
     def list_jails(self):
         p = subprocess.Popen([self.jls_cmd, '-q', 'name'],
@@ -97,7 +95,7 @@ class Connection(ConnectionBase):
         """ connect to the jail; nothing to do here """
         super(Connection, self)._connect()
         if not self._connected:
-            display.vvv(f"ESTABLISH JAIL CONNECTION FOR USER: {self._play_context.remote_user}", host=self.jail)
+            display.vvv(u"ESTABLISH JAIL CONNECTION FOR USER: {0}".format(self._play_context.remote_user), host=self.jail)
             self._connected = True
 
     def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
@@ -115,11 +113,11 @@ class Connection(ConnectionBase):
         if self._play_context.remote_user is not None:
             local_cmd += ['-U', self._play_context.remote_user]
             # update HOME since -U does not update the jail environment
-            set_env = f"HOME=~{self._play_context.remote_user} "
+            set_env = 'HOME=~' + self._play_context.remote_user + ' '
 
         local_cmd += [self.jail, self._play_context.executable, '-c', set_env + cmd]
 
-        display.vvv(f"EXEC {local_cmd}", host=self.jail)
+        display.vvv("EXEC %s" % (local_cmd,), host=self.jail)
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
         p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE)
@@ -144,7 +142,7 @@ class Connection(ConnectionBase):
             exist in any given chroot.  So for now we're choosing "/" instead.
             This also happens to be the former default.
 
-            Can revisit using $HOME instead if it is a problem
+            Can revisit using $HOME instead if it's a problem
         """
         if not remote_path.startswith(os.path.sep):
             remote_path = os.path.join(os.path.sep, remote_path)
@@ -153,7 +151,7 @@ class Connection(ConnectionBase):
     def put_file(self, in_path, out_path):
         """ transfer a file from local to jail """
         super(Connection, self).put_file(in_path, out_path)
-        display.vvv(f"PUT {in_path} TO {out_path}", host=self.jail)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.jail)
 
         out_path = shlex_quote(self._prefix_login_path(out_path))
         try:
@@ -163,27 +161,27 @@ class Connection(ConnectionBase):
                 else:
                     count = ''
                 try:
-                    p = self._buffered_exec_command(f'dd of={out_path} bs={BUFSIZE}{count}', stdin=in_file)
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
                 except OSError:
                     raise AnsibleError("jail connection requires dd command in the jail")
                 try:
                     stdout, stderr = p.communicate()
                 except Exception:
                     traceback.print_exc()
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
                 if p.returncode != 0:
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}")
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, to_native(stdout), to_native(stderr)))
         except IOError:
-            raise AnsibleError(f"file or module does not exist at: {in_path}")
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
 
     def fetch_file(self, in_path, out_path):
         """ fetch a file from jail to local """
         super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv(f"FETCH {in_path} TO {out_path}", host=self.jail)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.jail)
 
         in_path = shlex_quote(self._prefix_login_path(in_path))
         try:
-            p = self._buffered_exec_command(f'dd if={in_path} bs={BUFSIZE}')
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
         except OSError:
             raise AnsibleError("jail connection requires dd command in the jail")
 
@@ -195,10 +193,10 @@ class Connection(ConnectionBase):
                     chunk = p.stdout.read(BUFSIZE)
             except Exception:
                 traceback.print_exc()
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
             stdout, stderr = p.communicate()
             if p.returncode != 0:
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{to_native(stdout)}\n{to_native(stderr)}")
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, to_native(stdout), to_native(stderr)))
 
     def close(self):
         """ terminate the connection; nothing to do here """

plugins/connection/lxc.py

@@ -7,31 +7,29 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
-name: lxc
-short_description: Run tasks in LXC containers using lxc python library
-description:
-  - Run commands or put/fetch files to an existing LXC container using lxc python library.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
+    name: lxc
+    short_description: Run tasks in lxc containers via lxc python library
     description:
-      - Container identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_lxc_host
-  executable:
-    default: /bin/sh
-    description:
-      - Shell executable.
-    type: string
-    vars:
-      - name: ansible_executable
-      - name: ansible_lxc_executable
-"""
+        - Run commands or put/fetch files to an existing lxc container using lxc python library
+    options:
+      remote_addr:
+        description:
+            - Container identifier
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxc_host
+      executable:
+        default: /bin/sh
+        description:
+            - Shell executable
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxc_executable
+'''
 
 import os
 import shutil
@@ -82,7 +80,7 @@ class Connection(ConnectionBase):
         self._display.vvv("THIS IS A LOCAL LXC DIR", host=self.container_name)
         self.container = _lxc.Container(self.container_name)
         if self.container.state == "STOPPED":
-            raise errors.AnsibleError(f"{self.container_name} is not running")
+            raise errors.AnsibleError("%s is not running" % self.container_name)
 
     @staticmethod
     def _communicate(pid, in_data, stdin, stdout, stderr):
@@ -144,10 +142,10 @@ class Connection(ConnectionBase):
                 read_stdin, write_stdin = os.pipe()
                 kwargs['stdin'] = self._set_nonblocking(read_stdin)
 
-            self._display.vvv(f"EXEC {local_cmd}", host=self.container_name)
+            self._display.vvv("EXEC %s" % (local_cmd), host=self.container_name)
             pid = self.container.attach(_lxc.attach_run_command, local_cmd, **kwargs)
             if pid == -1:
-                msg = f"failed to attach to container {self.container_name}"
+                msg = "failed to attach to container %s" % self.container_name
                 raise errors.AnsibleError(msg)
 
             write_stdout = os.close(write_stdout)
@@ -174,18 +172,18 @@ class Connection(ConnectionBase):
     def put_file(self, in_path, out_path):
         ''' transfer a file from local to lxc '''
         super(Connection, self).put_file(in_path, out_path)
-        self._display.vvv(f"PUT {in_path} TO {out_path}", host=self.container_name)
+        self._display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.container_name)
         in_path = to_bytes(in_path, errors='surrogate_or_strict')
         out_path = to_bytes(out_path, errors='surrogate_or_strict')
 
         if not os.path.exists(in_path):
-            msg = f"file or module does not exist: {in_path}"
+            msg = "file or module does not exist: %s" % in_path
             raise errors.AnsibleFileNotFound(msg)
         try:
             src_file = open(in_path, "rb")
         except IOError:
             traceback.print_exc()
-            raise errors.AnsibleError(f"failed to open input file to {in_path}")
+            raise errors.AnsibleError("failed to open input file to %s" % in_path)
         try:
             def write_file(args):
                 with open(out_path, 'wb+') as dst_file:
@@ -194,7 +192,7 @@ class Connection(ConnectionBase):
                 self.container.attach_wait(write_file, None)
             except IOError:
                 traceback.print_exc()
-                msg = f"failed to transfer file to {out_path}"
+                msg = "failed to transfer file to %s" % out_path
                 raise errors.AnsibleError(msg)
         finally:
             src_file.close()
@@ -202,7 +200,7 @@ class Connection(ConnectionBase):
     def fetch_file(self, in_path, out_path):
         ''' fetch a file from lxc to local '''
         super(Connection, self).fetch_file(in_path, out_path)
-        self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self.container_name)
+        self._display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.container_name)
         in_path = to_bytes(in_path, errors='surrogate_or_strict')
         out_path = to_bytes(out_path, errors='surrogate_or_strict')
 
@@ -210,7 +208,7 @@ class Connection(ConnectionBase):
             dst_file = open(out_path, "wb")
         except IOError:
             traceback.print_exc()
-            msg = f"failed to open output file {out_path}"
+            msg = "failed to open output file %s" % out_path
             raise errors.AnsibleError(msg)
         try:
             def write_file(args):
@@ -225,7 +223,7 @@ class Connection(ConnectionBase):
                 self.container.attach_wait(write_file, None)
             except IOError:
                 traceback.print_exc()
-                msg = f"failed to transfer file from {in_path} to {out_path}"
+                msg = "failed to transfer file from %s to %s" % (in_path, out_path)
                 raise errors.AnsibleError(msg)
         finally:
             dst_file.close()

plugins/connection/lxd.py

@@ -7,48 +7,44 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Matt Clay (@mattclay) <matt@mystile.com>
-name: lxd
-short_description: Run tasks in LXD instances using C(lxc) CLI
-description:
-  - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Matt Clay (@mattclay) <matt@mystile.com>
+    name: lxd
+    short_description: Run tasks in LXD instances via C(lxc) CLI
     description:
-      - Instance (container/VM) identifier.
-      - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.)) is
-        used as the instance identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: inventory_hostname
-      - name: ansible_host
-      - name: ansible_lxd_host
-  executable:
-    description:
-      - Shell to use for execution inside instance.
-    type: string
-    default: /bin/sh
-    vars:
-      - name: ansible_executable
-      - name: ansible_lxd_executable
-  remote:
-    description:
-      - Name of the LXD remote to use.
-    type: string
-    default: local
-    vars:
-      - name: ansible_lxd_remote
-    version_added: 2.0.0
-  project:
-    description:
-      - Name of the LXD project to use.
-    type: string
-    vars:
-      - name: ansible_lxd_project
-    version_added: 2.0.0
-"""
+        - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
+    options:
+      remote_addr:
+        description:
+            - Instance (container/VM) identifier.
+            - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.))
+              is used as the instance identifier.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxd_host
+      executable:
+        description:
+            - Shell to use for execution inside instance.
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxd_executable
+      remote:
+        description:
+            - Name of the LXD remote to use.
+        default: local
+        vars:
+            - name: ansible_lxd_remote
+        version_added: 2.0.0
+      project:
+        description:
+            - Name of the LXD project to use.
+        vars:
+            - name: ansible_lxd_project
+        version_added: 2.0.0
+'''
 
 import os
 from subprocess import Popen, PIPE
@@ -86,26 +82,26 @@ class Connection(ConnectionBase):
         super(Connection, self)._connect()
 
         if not self._connected:
-            self._display.vvv("ESTABLISH LXD CONNECTION FOR USER: root", host=self._host())
+            self._display.vvv(u"ESTABLISH LXD CONNECTION FOR USER: root", host=self._host())
             self._connected = True
 
     def exec_command(self, cmd, in_data=None, sudoable=True):
         """ execute a command on the lxd host """
         super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
-        self._display.vvv(f"EXEC {cmd}", host=self._host())
+        self._display.vvv(u"EXEC {0}".format(cmd), host=self._host())
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):
             local_cmd.extend(["--project", self.get_option("project")])
         local_cmd.extend([
             "exec",
-            f"{self.get_option('remote')}:{self._host()}",
+            "%s:%s" % (self.get_option("remote"), self._host()),
             "--",
             self.get_option("executable"), "-c", cmd
         ])
 
-        self._display.vvvvv(f"EXEC {local_cmd}", host=self._host())
+        self._display.vvvvv(u"EXEC {0}".format(local_cmd), host=self._host())
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
         in_data = to_bytes(in_data, errors='surrogate_or_strict', nonstring='passthru')
@@ -116,13 +112,13 @@ class Connection(ConnectionBase):
         stdout = to_text(stdout)
         stderr = to_text(stderr)
 
-        self._display.vvvvv(f"EXEC lxc output: {stdout} {stderr}", host=self._host())
+        self._display.vvvvv(u"EXEC lxc output: {0} {1}".format(stdout, stderr), host=self._host())
 
         if "is not running" in stderr:
-            raise AnsibleConnectionFailure(f"instance not running: {self._host()}")
+            raise AnsibleConnectionFailure("instance not running: %s" % self._host())
 
         if stderr.strip() == "Error: Instance not found" or stderr.strip() == "error: not found":
-            raise AnsibleConnectionFailure(f"instance not found: {self._host()}")
+            raise AnsibleConnectionFailure("instance not found: %s" % self._host())
 
         return process.returncode, stdout, stderr
 
@@ -130,10 +126,10 @@ class Connection(ConnectionBase):
         """ put a file from local to lxd """
         super(Connection, self).put_file(in_path, out_path)
 
-        self._display.vvv(f"PUT {in_path} TO {out_path}", host=self._host())
+        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path), host=self._host())
 
         if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
-            raise AnsibleFileNotFound(f"input path is not a file: {in_path}")
+            raise AnsibleFileNotFound("input path is not a file: %s" % in_path)
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):
@@ -141,7 +137,7 @@ class Connection(ConnectionBase):
         local_cmd.extend([
             "file", "push",
             in_path,
-            f"{self.get_option('remote')}:{self._host()}/{out_path}"
+            "%s:%s/%s" % (self.get_option("remote"), self._host(), out_path)
         ])
 
         local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
@@ -153,14 +149,14 @@ class Connection(ConnectionBase):
         """ fetch a file from lxd to local """
         super(Connection, self).fetch_file(in_path, out_path)
 
-        self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self._host())
+        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path), host=self._host())
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):
             local_cmd.extend(["--project", self.get_option("project")])
         local_cmd.extend([
             "file", "pull",
-            f"{self.get_option('remote')}:{self._host()}/{in_path}",
+            "%s:%s/%s" % (self.get_option("remote"), self._host(), in_path),
             out_path
         ])
 

plugins/connection/qubes.py

@@ -12,33 +12,32 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 
-DOCUMENTATION = r"""
-name: qubes
-short_description: Interact with an existing QubesOS AppVM
+DOCUMENTATION = '''
+    name: qubes
+    short_description: Interact with an existing QubesOS AppVM
 
-description:
-  - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
-author: Kushal Das (@kushaldas)
-
-
-options:
-  remote_addr:
     description:
-      - VM name.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-  remote_user:
-    description:
-      - The user to execute as inside the VM.
-    type: string
-    default: The I(user) account as default in Qubes OS.
-    vars:
-      - name: ansible_user
+        - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
+
+    author: Kushal Das (@kushaldas)
+
+
+    options:
+      remote_addr:
+        description:
+            - vm name
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+      remote_user:
+        description:
+            - The user to execute as inside the vm.
+        default: The *user* account as default in Qubes OS.
+        vars:
+            - name: ansible_user
 #        keyword:
 #            - name: hosts
-"""
+'''
 
 import subprocess
 
@@ -77,7 +76,7 @@ class Connection(ConnectionBase):
         """
         display.vvvv("CMD: ", cmd)
         if not cmd.endswith("\n"):
-            cmd = f"{cmd}\n"
+            cmd = cmd + "\n"
         local_cmd = []
 
         # For dom0
@@ -94,7 +93,7 @@ class Connection(ConnectionBase):
 
         display.vvvv("Local cmd: ", local_cmd)
 
-        display.vvv(f"RUN {local_cmd}", host=self._remote_vmname)
+        display.vvv("RUN %s" % (local_cmd,), host=self._remote_vmname)
         p = subprocess.Popen(local_cmd, shell=False, stdin=subprocess.PIPE,
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
@@ -113,42 +112,42 @@ class Connection(ConnectionBase):
         """Run specified command in a running QubesVM """
         super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
 
-        display.vvvv(f"CMD IS: {cmd}")
+        display.vvvv("CMD IS: %s" % cmd)
 
         rc, stdout, stderr = self._qubes(cmd)
 
-        display.vvvvv(f"STDOUT {stdout!r} STDERR {stderr!r}")
+        display.vvvvv("STDOUT %r STDERR %r" % (stderr, stderr))
         return rc, stdout, stderr
 
     def put_file(self, in_path, out_path):
         """ Place a local file located in 'in_path' inside VM at 'out_path' """
         super(Connection, self).put_file(in_path, out_path)
-        display.vvv(f"PUT {in_path} TO {out_path}", host=self._remote_vmname)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._remote_vmname)
 
         with open(in_path, "rb") as fobj:
             source_data = fobj.read()
 
-        retcode, dummy, dummy = self._qubes(f'cat > "{out_path}\"\n', source_data, "qubes.VMRootShell")
+        retcode, dummy, dummy = self._qubes('cat > "{0}"\n'.format(out_path), source_data, "qubes.VMRootShell")
         # if qubes.VMRootShell service not supported, fallback to qubes.VMShell and
         # hope it will have appropriate permissions
         if retcode == 127:
-            retcode, dummy, dummy = self._qubes(f'cat > "{out_path}\"\n', source_data)
+            retcode, dummy, dummy = self._qubes('cat > "{0}"\n'.format(out_path), source_data)
 
         if retcode != 0:
-            raise AnsibleConnectionFailure(f'Failed to put_file to {out_path}')
+            raise AnsibleConnectionFailure('Failed to put_file to {0}'.format(out_path))
 
     def fetch_file(self, in_path, out_path):
         """Obtain file specified via 'in_path' from the container and place it at 'out_path' """
         super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv(f"FETCH {in_path} TO {out_path}", host=self._remote_vmname)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._remote_vmname)
 
         # We are running in dom0
-        cmd_args_list = ["qvm-run", "--pass-io", self._remote_vmname, f"cat {in_path}"]
+        cmd_args_list = ["qvm-run", "--pass-io", self._remote_vmname, "cat {0}".format(in_path)]
         with open(out_path, "wb") as fobj:
             p = subprocess.Popen(cmd_args_list, shell=False, stdout=fobj)
             p.communicate()
             if p.returncode != 0:
-                raise AnsibleConnectionFailure(f'Failed to fetch file to {out_path}')
+                raise AnsibleConnectionFailure('Failed to fetch file to {0}'.format(out_path))
 
     def close(self):
         """ Closing the connection """

plugins/connection/saltstack.py

@@ -10,13 +10,13 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Michael Scherer (@mscherer) <misc@zarb.org>
-name: saltstack
-short_description: Allow ansible to piggyback on salt minions
-description:
-  - This allows you to use existing Saltstack infrastructure to connect to targets.
-"""
+DOCUMENTATION = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: saltstack
+    short_description: Allow ansible to piggyback on salt minions
+    description:
+        - This allows you to use existing Saltstack infrastructure to connect to targets.
+'''
 
 import os
 import base64
@@ -59,11 +59,11 @@ class Connection(ConnectionBase):
         if in_data:
             raise errors.AnsibleError("Internal Error: this module does not support optimized module pipelining")
 
-        self._display.vvv(f"EXEC {cmd}", host=self.host)
+        self._display.vvv("EXEC %s" % cmd, host=self.host)
         # need to add 'true;' to work around https://github.com/saltstack/salt/issues/28077
-        res = self.client.cmd(self.host, 'cmd.exec_code_all', ['bash', f"true;{cmd}"])
+        res = self.client.cmd(self.host, 'cmd.exec_code_all', ['bash', 'true;' + cmd])
         if self.host not in res:
-            raise errors.AnsibleError(f"Minion {self.host} didn't answer, check if salt-minion is running and the name is correct")
+            raise errors.AnsibleError("Minion %s didn't answer, check if salt-minion is running and the name is correct" % self.host)
 
         p = res[self.host]
         return p['retcode'], p['stdout'], p['stderr']
@@ -81,7 +81,7 @@ class Connection(ConnectionBase):
         super(Connection, self).put_file(in_path, out_path)
 
         out_path = self._normalize_path(out_path, '/')
-        self._display.vvv(f"PUT {in_path} TO {out_path}", host=self.host)
+        self._display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.host)
         with open(in_path, 'rb') as in_fh:
             content = in_fh.read()
         self.client.cmd(self.host, 'hashutil.base64_decodefile', [base64.b64encode(content), out_path])
@@ -93,7 +93,7 @@ class Connection(ConnectionBase):
         super(Connection, self).fetch_file(in_path, out_path)
 
         in_path = self._normalize_path(in_path, '/')
-        self._display.vvv(f"FETCH {in_path} TO {out_path}", host=self.host)
+        self._display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host)
         content = self.client.cmd(self.host, 'cp.get_file_str', [in_path])[self.host]
         open(out_path, 'wb').write(content)
 

plugins/connection/zone.py

@@ -11,22 +11,21 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r"""
-author: Ansible Core Team
-name: zone
-short_description: Run tasks in a zone instance
-description:
-  - Run commands or put/fetch files to an existing zone.
-options:
-  remote_addr:
+DOCUMENTATION = '''
+    author: Ansible Core Team
+    name: zone
+    short_description: Run tasks in a zone instance
     description:
-      - Zone identifier.
-    type: string
-    default: inventory_hostname
-    vars:
-      - name: ansible_host
-      - name: ansible_zone_host
-"""
+        - Run commands or put/fetch files to an existing zone
+    options:
+      remote_addr:
+        description:
+            - Zone identifier
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_zone_host
+'''
 
 import os
 import os.path
@@ -62,14 +61,14 @@ class Connection(ConnectionBase):
         self.zlogin_cmd = to_bytes(self._search_executable('zlogin'))
 
         if self.zone not in self.list_zones():
-            raise AnsibleError(f"incorrect zone name {self.zone}")
+            raise AnsibleError("incorrect zone name %s" % self.zone)
 
     @staticmethod
     def _search_executable(executable):
         try:
             return get_bin_path(executable)
         except ValueError:
-            raise AnsibleError(f"{executable} command not found in PATH")
+            raise AnsibleError("%s command not found in PATH" % executable)
 
     def list_zones(self):
         process = subprocess.Popen([self.zoneadm_cmd, 'list', '-ip'],
@@ -94,7 +93,7 @@ class Connection(ConnectionBase):
 
         # stdout, stderr = p.communicate()
         path = process.stdout.readlines()[0].split(':')[3]
-        return f"{path}/root"
+        return path + '/root'
 
     def _connect(self):
         """ connect to the zone; nothing to do here """
@@ -117,7 +116,7 @@ class Connection(ConnectionBase):
         local_cmd = [self.zlogin_cmd, self.zone, cmd]
         local_cmd = map(to_bytes, local_cmd)
 
-        display.vvv(f"EXEC {local_cmd}", host=self.zone)
+        display.vvv("EXEC %s" % (local_cmd), host=self.zone)
         p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
@@ -140,7 +139,7 @@ class Connection(ConnectionBase):
             exist in any given chroot.  So for now we're choosing "/" instead.
             This also happens to be the former default.
 
-            Can revisit using $HOME instead if it is a problem
+            Can revisit using $HOME instead if it's a problem
         """
         if not remote_path.startswith(os.path.sep):
             remote_path = os.path.join(os.path.sep, remote_path)
@@ -149,7 +148,7 @@ class Connection(ConnectionBase):
     def put_file(self, in_path, out_path):
         """ transfer a file from local to zone """
         super(Connection, self).put_file(in_path, out_path)
-        display.vvv(f"PUT {in_path} TO {out_path}", host=self.zone)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.zone)
 
         out_path = shlex_quote(self._prefix_login_path(out_path))
         try:
@@ -159,27 +158,27 @@ class Connection(ConnectionBase):
                 else:
                     count = ''
                 try:
-                    p = self._buffered_exec_command(f'dd of={out_path} bs={BUFSIZE}{count}', stdin=in_file)
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
                 except OSError:
                     raise AnsibleError("jail connection requires dd command in the jail")
                 try:
                     stdout, stderr = p.communicate()
                 except Exception:
                     traceback.print_exc()
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
                 if p.returncode != 0:
-                    raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
         except IOError:
-            raise AnsibleError(f"file or module does not exist at: {in_path}")
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
 
     def fetch_file(self, in_path, out_path):
         """ fetch a file from zone to local """
         super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv(f"FETCH {in_path} TO {out_path}", host=self.zone)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.zone)
 
         in_path = shlex_quote(self._prefix_login_path(in_path))
         try:
-            p = self._buffered_exec_command(f'dd if={in_path} bs={BUFSIZE}')
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
         except OSError:
             raise AnsibleError("zone connection requires dd command in the zone")
 
@@ -191,10 +190,10 @@ class Connection(ConnectionBase):
                     chunk = p.stdout.read(BUFSIZE)
             except Exception:
                 traceback.print_exc()
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}")
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
             stdout, stderr = p.communicate()
             if p.returncode != 0:
-                raise AnsibleError(f"failed to transfer file {in_path} to {out_path}:\n{stdout}\n{stderr}")
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
 
     def close(self):
         """ terminate the connection; nothing to do here """

plugins/doc_fragments/alicloud.py

@@ -11,73 +11,75 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Alicloud only documentation fragment
-    DOCUMENTATION = r"""
+    DOCUMENTATION = r'''
 options:
   alicloud_access_key:
     description:
-      - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY), E(ALICLOUD_ACCESS_KEY_ID)
-        will be used instead.
+      - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY),
+        E(ALICLOUD_ACCESS_KEY_ID) will be used instead.
     aliases: ['access_key_id', 'access_key']
     type: str
   alicloud_secret_key:
     description:
-      - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY), E(ALICLOUD_SECRET_ACCESS_KEY)
-        will be used instead.
+      - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY),
+        E(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
     aliases: ['secret_access_key', 'secret_key']
     type: str
   alicloud_region:
     description:
-      - The Alibaba Cloud region to use. If not specified then the value of environment variable E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID)
-        will be used instead.
+      - The Alibaba Cloud region to use. If not specified then the value of environment variable
+        E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) will be used instead.
     aliases: ['region', 'region_id']
     required: true
     type: str
   alicloud_security_token:
     description:
-      - The Alibaba Cloud security token. If not specified then the value of environment variable E(ALICLOUD_SECURITY_TOKEN)
-        will be used instead.
+      - The Alibaba Cloud security token. If not specified then the value of environment variable
+        E(ALICLOUD_SECURITY_TOKEN) will be used instead.
     aliases: ['security_token']
     type: str
   alicloud_assume_role:
     description:
       - If provided with a role ARN, Ansible will attempt to assume this role using the supplied credentials.
-      - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name), C(alicloud_assume_role_session_expiration)
-        and C(alicloud_assume_role_policy).
+      - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name),
+        C(alicloud_assume_role_session_expiration) and C(alicloud_assume_role_policy).
     type: dict
     aliases: ['assume_role']
   alicloud_assume_role_arn:
     description:
-      - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string, it does not perform
-        role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN). ansible will execute with provided credentials.
+      - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string,
+        it does not perform role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN).
+        ansible will execute with provided credentials.
     aliases: ['assume_role_arn']
     type: str
   alicloud_assume_role_session_name:
     description:
-      - The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted, 'ansible' is passed to
-        the AssumeRole call as session name. It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
+      - The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
+        'ansible' is passed to the AssumeRole call as session name. It supports environment variable
+        E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
     aliases: ['assume_role_session_name']
     type: str
   alicloud_assume_role_session_expiration:
     description:
-      - The Alibaba Cloud C(session_expiration). The time after which the established session for assuming role expires. Valid
-        value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default value). It supports environment
-        variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
+      - The Alibaba Cloud C(session_expiration). The time after which the established session for assuming
+        role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
+        value). It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
     aliases: ['assume_role_session_expiration']
     type: int
   ecs_role_name:
     description:
-      - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section
-        of the Alibaba Cloud console.
-      - If you are running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the metadata
-        U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS credential.
-        This is a preferred approach over any other when running in ECS as you can avoid hard coding credentials. Instead
-        these are leased on-the-fly by Ansible which reduces the chance of leakage.
+      - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control'
+        section of the Alibaba Cloud console.
+      - If you're running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the
+        metadata U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS
+        credential. This is a preferred approach over any other when running in ECS as you can avoid hard coding
+        credentials. Instead these are leased on-the-fly by Ansible which reduces the chance of leakage.
     aliases: ['role_name']
     type: str
   profile:
     description:
-      - This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the E(ALICLOUD_PROFILE)
-        environment variable.
+      - This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
+        E(ALICLOUD_PROFILE) environment variable.
     type: str
   shared_credentials_file:
     description:
@@ -86,14 +88,22 @@ options:
       - If this is not set and a profile is specified, C(~/.aliyun/config.json) will be used.
     type: str
 author:
-  - "He Guimin (@xiaozhu36)"
+    - "He Guimin (@xiaozhu36)"
 requirements:
-  - "Python >= 3.6"
+    - "Python >= 3.6"
 notes:
-  - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
-    E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID), E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY), E(ALICLOUD_REGION)
-    or E(ALICLOUD_REGION_ID), E(ALICLOUD_SECURITY_TOKEN), E(ALICLOUD_ECS_ROLE_NAME), E(ALICLOUD_SHARED_CREDENTIALS_FILE),
-    E(ALICLOUD_PROFILE), E(ALICLOUD_ASSUME_ROLE_ARN), E(ALICLOUD_ASSUME_ROLE_SESSION_NAME), E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
-  - E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the Alicloud region, when required, but
-    this can also be configured in the footmark config file.
-"""
+  - If parameters are not set within the module, the following
+    environment variables can be used in decreasing order of precedence
+    E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID),
+    E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY),
+    E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID),
+    E(ALICLOUD_SECURITY_TOKEN),
+    E(ALICLOUD_ECS_ROLE_NAME),
+    E(ALICLOUD_SHARED_CREDENTIALS_FILE),
+    E(ALICLOUD_PROFILE),
+    E(ALICLOUD_ASSUME_ROLE_ARN),
+    E(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
+    E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
+  - E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the
+    Alicloud region, when required, but this can also be configured in the footmark config file
+'''