Release 5.3.0.

* Update proxmox.py

* Forgot a debug print.

* pep

* Check if int, old school way.

* pep, once again.

* Create 4910-fix-for-agent-enabled.yml

* Must check the first listentry for enabled=1

* Update changelogs/fragments/4910-fix-for-agent-enabled.yml

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

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

Co-authored-by: ube <ube@alienautopsy.net>

.azure-pipelines/azure-pipelines.yml

@@ -48,7 +48,7 @@ variables:
 resources:
   containers:
     - container: default
-      image: quay.io/ansible/azure-pipelines-test-container:1.9.0
+      image: quay.io/ansible/azure-pipelines-test-container:3.0.0
 
 pool: Standard
 
@@ -177,12 +177,12 @@ stages:
               test: macos/12.0
             - name: RHEL 7.9
               test: rhel/7.9
-            - name: RHEL 8.5
+            - name: RHEL 9.0
-              test: rhel/8.5
+              test: rhel/9.0
             - name: FreeBSD 12.3
               test: freebsd/12.3
-            - name: FreeBSD 13.0
+            - name: FreeBSD 13.1
-              test: freebsd/13.0
+              test: freebsd/13.1
           groups:
             - 1
             - 2
@@ -251,16 +251,16 @@ stages:
           targets:
             - name: CentOS 7
               test: centos7
-            - name: Fedora 34
-              test: fedora34
             - name: Fedora 35
               test: fedora35
+            - name: Fedora 36
+              test: fedora36
             - name: openSUSE 15
               test: opensuse15
-            - name: Ubuntu 18.04
-              test: ubuntu1804
             - name: Ubuntu 20.04
               test: ubuntu2004
+            - name: Ubuntu 22.04
+              test: ubuntu2204
             - name: Alpine 3
               test: alpine3
           groups:
@@ -297,8 +297,8 @@ stages:
               test: centos6
             - name: Fedora 34
               test: fedora34
-            - name: Ubuntu 20.04
+            - name: Ubuntu 18.04
-              test: ubuntu2004
+              test: ubuntu1804
           groups:
             - 1
             - 2

.github/BOTMETA.yml

@@ -214,7 +214,7 @@ files:
   $lookups/dnstxt.py:
     maintainers: jpmens
   $lookups/dsv.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus endlesstrax delineaKrehl tylerezimmerman
   $lookups/etcd3.py:
     maintainers: eric-belhomme
   $lookups/etcd.py:
@@ -251,9 +251,12 @@ files:
     maintainers: RevBits
   $lookups/shelvefile.py: {}
   $lookups/tss.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus endlesstrax delineaKrehl tylerezimmerman
   $module_utils/:
     labels: module_utils
+  $module_utils/gconftool2.py:
+    maintainers: russoz
+    labels: gconftool2
   $module_utils/gitlab.py:
     notify: jlozadad
     maintainers: $team_gitlab
@@ -304,6 +307,9 @@ files:
   $module_utils/xenserver.py:
     maintainers: bvitnik
     labels: xenserver
+  $module_utils/xfconf.py:
+    maintainers: russoz
+    labels: xfconf
   $modules/cloud/alicloud/:
     maintainers: xiaozhu36
   $modules/cloud/atomic/atomic_container.py:
@@ -434,6 +440,8 @@ files:
     maintainers: claco
   $modules/cloud/scaleway/:
     maintainers: $team_scaleway
+  $modules/cloud/scaleway/scaleway_compute_private_network.py:
+    maintainers: pastral
   $modules/cloud/scaleway/scaleway_database_backup.py:
     maintainers: guillaume_ro_fr
   $modules/cloud/scaleway/scaleway_image_info.py:
@@ -615,7 +623,7 @@ files:
   $modules/monitoring/nagios.py:
     maintainers: tbielawa tgoetheyn
   $modules/monitoring/newrelic_deployment.py:
-    maintainers: mcodd
+    ignore: mcodd
   $modules/monitoring/pagerduty.py:
     maintainers: suprememoocow thaumos
     labels: pagerduty
@@ -707,7 +715,7 @@ files:
   $modules/notification/discord.py:
     maintainers: cwollinger
   $modules/notification/flowdock.py:
-    maintainers: mcodd
+    ignore: mcodd
   $modules/notification/grove.py:
     maintainers: zimbatm
   $modules/notification/hipchat.py:
@@ -1024,7 +1032,7 @@ files:
   $modules/system/alternatives.py:
     maintainers: mulby
     labels: alternatives
-    ignore: DavidWittman
+    ignore: DavidWittman jiuka
   $modules/system/aix_lvol.py:
     maintainers: adejoux
   $modules/system/awall.py:
@@ -1052,6 +1060,9 @@ files:
   $modules/system/gconftool2.py:
     maintainers: Akasurde kevensen
     labels: gconftool2
+  $modules/system/gconftool2_info.py:
+    maintainers: russoz
+    labels: gconftool2
   $modules/system/homectl.py:
     maintainers: jameslivulpi
   $modules/system/interfaces_file.py:
@@ -1059,6 +1070,10 @@ files:
     labels: interfaces_file
   $modules/system/iptables_state.py:
     maintainers: quidame
+  $modules/system/keyring.py:
+    maintainers: ahussey-redhat
+  $modules/system/keyring_info.py:
+    maintainers: ahussey-redhat
   $modules/system/shutdown.py:
     maintainers: nitzmahone samdoran aminvakil
   $modules/system/java_cert.py:
@@ -1281,5 +1296,5 @@ macros:
   team_rhn: FlossWare alikins barnabycourt vritant
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel dcermak evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
+  team_suse: commel evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab tleguern Thulium-Drake Ajpantuso

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -105,7 +105,7 @@ body:
   attributes:
     label: Steps to Reproduce
     description: |
-      Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also pased any playbooks, configs and commands you used.
+      Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also passed any playbooks, configs and commands you used.
 
       **HINT:** You can paste https://gist.github.com links for larger files.
     value: |

CHANGELOG.rst

@@ -6,6 +6,167 @@ Community General Release Notes
 
 This changelog describes changes after version 4.0.0.
 
+v5.3.0
+======
+
+Release Summary
+---------------
+
+Regular bugfix and feature release.
+
+Minor Changes
+-------------
+
+- machinectl become plugin - can now be used with a password from another user than root, if a polkit rule is present (https://github.com/ansible-collections/community.general/pull/4849).
+- opentelemetry callback plugin - allow configuring opentelementry callback via config file (https://github.com/ansible-collections/community.general/pull/4916).
+- redfish_info - add ``GetManagerInventory`` to report list of Manager inventory information (https://github.com/ansible-collections/community.general/issues/4899).
+
+Bugfixes
+--------
+
+- cmd_runner module utils - fix bug caused by using the ``command`` variable instead of ``self.command`` when looking for binary path (https://github.com/ansible-collections/community.general/pull/4903).
+- dsv lookup plugin - do not ignore the ``tld`` parameter (https://github.com/ansible-collections/community.general/pull/4911).
+- lxd connection plugin - fix incorrect ``inventory_hostname`` in ``remote_addr``. This is needed for compatibility with ansible-core 2.13 (https://github.com/ansible-collections/community.general/issues/4886).
+- proxmox inventory plugin - fix crash when ``enabled=1`` is used in agent config string (https://github.com/ansible-collections/community.general/pull/4910).
+- rax_clb_nodes - fix code to be compatible with Python 3 (https://github.com/ansible-collections/community.general/pull/4933).
+- redfish_info - fix to ``GetChassisPower`` to correctly report power information when multiple chassis exist, but not all chassis report power information (https://github.com/ansible-collections/community.general/issues/4901).
+
+v5.2.0
+======
+
+Release Summary
+---------------
+
+Regular bugfix and feature release.
+
+Minor Changes
+-------------
+
+- cmd_runner module utils - add ``__call__`` method to invoke context (https://github.com/ansible-collections/community.general/pull/4791).
+- passwordstore lookup plugin - allow using alternative password managers by detecting wrapper scripts, allow explicit configuration of pass and gopass backends (https://github.com/ansible-collections/community.general/issues/4766).
+- sudoers - will attempt to validate the proposed sudoers rule using visudo if available, optionally skipped, or required (https://github.com/ansible-collections/community.general/pull/4794, https://github.com/ansible-collections/community.general/issues/4745).
+
+Bugfixes
+--------
+
+- Include ``PSF-license.txt`` file for ``plugins/module_utils/_mount.py``.
+- redfish_command - fix the check if a virtual media is unmounted to just check for ``instered= false`` caused by Supermicro hardware that does not clear the ``ImageName`` (https://github.com/ansible-collections/community.general/pull/4839).
+- redfish_command - the Supermicro Redfish implementation only supports the ``image_url`` parameter in the underlying API calls to ``VirtualMediaInsert`` and ``VirtualMediaEject``. Any values set (or the defaults) for ``write_protected`` or ``inserted`` will be ignored (https://github.com/ansible-collections/community.general/pull/4839).
+- sudoers - fix incorrect handling of ``state: absent`` (https://github.com/ansible-collections/community.general/issues/4852).
+
+New Modules
+-----------
+
+Cloud
+~~~~~
+
+scaleway
+^^^^^^^^
+
+- scaleway_compute_private_network - Scaleway compute - private network management
+
+System
+~~~~~~
+
+- keyring - Set or delete a passphrase using the Operating System's native keyring
+- keyring_info - Get a passphrase using the Operating System's native keyring
+
+v5.1.1
+======
+
+Release Summary
+---------------
+
+Bugfix release.
+
+Bugfixes
+--------
+
+- alternatives - do not set the priority if the priority was not set by the user (https://github.com/ansible-collections/community.general/pull/4810).
+- alternatives - only pass subcommands when they are specified as module arguments (https://github.com/ansible-collections/community.general/issues/4803, https://github.com/ansible-collections/community.general/issues/4804, https://github.com/ansible-collections/community.general/pull/4836).
+- alternatives - when ``subcommands`` is specified, ``link`` must be given for every subcommand. This was already mentioned in the documentation, but not enforced by the code (https://github.com/ansible-collections/community.general/pull/4836).
+- nmcli - fix error caused by adding undefined module arguments for list options (https://github.com/ansible-collections/community.general/issues/4373, https://github.com/ansible-collections/community.general/pull/4813).
+- proxmox inventory plugin - fixed extended status detection for qemu (https://github.com/ansible-collections/community.general/pull/4816).
+- redhat_subscription - fix unsubscribing on RHEL 9 (https://github.com/ansible-collections/community.general/issues/4741).
+- sudoers - ensure sudoers config files are created with the permissions requested by sudoers (0440) (https://github.com/ansible-collections/community.general/pull/4814).
+
+v5.1.0
+======
+
+Release Summary
+---------------
+
+Regular bugfix and feature release.
+
+Minor Changes
+-------------
+
+- ModuleHelper module utils - improved ``ModuleHelperException``, using ``to_native()`` for the exception message (https://github.com/ansible-collections/community.general/pull/4755).
+- alternatives - add ``state=absent`` to be able to remove an alternative (https://github.com/ansible-collections/community.general/pull/4654).
+- alternatives - add ``subcommands`` parameter (https://github.com/ansible-collections/community.general/pull/4654).
+- ansible_galaxy_install - minor refactoring using latest ``ModuleHelper`` updates (https://github.com/ansible-collections/community.general/pull/4752).
+- cmd_runner module util - added parameters ``check_mode_skip`` and ``check_mode_return`` to ``CmdRunner.context()``, so that the command is not executed when ``check_mode=True`` (https://github.com/ansible-collections/community.general/pull/4736).
+- nmcli - adds ``vpn`` type and parameter for supporting VPN with service type L2TP and PPTP (https://github.com/ansible-collections/community.general/pull/4746).
+- proxmox inventory plugin - added new flag ``qemu_extended_statuses`` and new groups ``<group_prefix>prelaunch``, ``<group_prefix>paused``. They will be populated only when ``want_facts=true``, ``qemu_extended_statuses=true`` and only for ``QEMU`` machines (https://github.com/ansible-collections/community.general/pull/4723).
+- puppet - adds ``confdir`` parameter to configure a custom confir location (https://github.com/ansible-collections/community.general/pull/4740).
+- xfconf - changed implementation to use ``cmd_runner`` (https://github.com/ansible-collections/community.general/pull/4776).
+- xfconf module utils - created new module util ``xfconf`` providing a ``cmd_runner`` specific for ``xfconf`` modules (https://github.com/ansible-collections/community.general/pull/4776).
+- xfconf_info - changed implementation to use ``cmd_runner`` (https://github.com/ansible-collections/community.general/pull/4776).
+
+Deprecated Features
+-------------------
+
+- cmd_runner module utils - deprecated ``fmt`` in favour of ``cmd_runner_fmt`` as the parameter format object (https://github.com/ansible-collections/community.general/pull/4777).
+
+New Modules
+-----------
+
+System
+~~~~~~
+
+- gconftool2_info - Retrieve GConf configurations
+
+v5.0.2
+======
+
+Release Summary
+---------------
+
+Maintenance and bugfix release for Ansible 6.0.0.
+
+Bugfixes
+--------
+
+- Include ``simplified_bsd.txt`` license file for various module utils, the ``lxca_common`` docs fragment, and the ``utm_utils`` unit tests.
+
+v5.0.1
+======
+
+Release Summary
+---------------
+
+Regular bugfix release for inclusion in Ansible 6.0.0.
+
+Minor Changes
+-------------
+
+- cpanm - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived modules (https://github.com/ansible-collections/community.general/pull/4674).
+- mksysb - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived modules (https://github.com/ansible-collections/community.general/pull/4674).
+- pipx - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived modules (https://github.com/ansible-collections/community.general/pull/4674).
+- snap - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived modules (https://github.com/ansible-collections/community.general/pull/4674).
+- xfconf - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived modules (https://github.com/ansible-collections/community.general/pull/4674).
+
+Bugfixes
+--------
+
+- consul - fixed bug introduced in PR 4590 (https://github.com/ansible-collections/community.general/issues/4680).
+- filesystem - handle ``fatresize --info`` output lines without ``:`` (https://github.com/ansible-collections/community.general/pull/4700).
+- filesystem - improve error messages when output cannot be parsed by including newlines in escaped form (https://github.com/ansible-collections/community.general/pull/4700).
+- keycloak_realm - fix default groups and roles (https://github.com/ansible-collections/community.general/issues/4241).
+- redis* modules - fix call to ``module.fail_json`` when failing because of missing Python libraries (https://github.com/ansible-collections/community.general/pull/4733).
+- xcc_redfish_command - for compatibility due to Redfish spec changes the virtualMedia resource location changed from Manager to System (https://github.com/ansible-collections/community.general/pull/4682).
+- zfs - fix wrong quoting of properties (https://github.com/ansible-collections/community.general/issues/4707, https://github.com/ansible-collections/community.general/pull/4726).
+
 v5.0.0
 ======
 

PSF-license.txt

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

changelogs/changelog.yaml

@@ -755,3 +755,195 @@ releases:
         name: counter
         namespace: null
     release_date: '2022-04-29'
+  5.0.1:
+    changes:
+      bugfixes:
+      - consul - fixed bug introduced in PR 4590 (https://github.com/ansible-collections/community.general/issues/4680).
+      - filesystem - handle ``fatresize --info`` output lines without ``:`` (https://github.com/ansible-collections/community.general/pull/4700).
+      - filesystem - improve error messages when output cannot be parsed by including
+        newlines in escaped form (https://github.com/ansible-collections/community.general/pull/4700).
+      - keycloak_realm - fix default groups and roles (https://github.com/ansible-collections/community.general/issues/4241).
+      - redis* modules - fix call to ``module.fail_json`` when failing because of
+        missing Python libraries (https://github.com/ansible-collections/community.general/pull/4733).
+      - xcc_redfish_command - for compatibility due to Redfish spec changes the virtualMedia
+        resource location changed from Manager to System (https://github.com/ansible-collections/community.general/pull/4682).
+      - zfs - fix wrong quoting of properties (https://github.com/ansible-collections/community.general/issues/4707,
+        https://github.com/ansible-collections/community.general/pull/4726).
+      minor_changes:
+      - cpanm - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived
+        modules (https://github.com/ansible-collections/community.general/pull/4674).
+      - mksysb - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived
+        modules (https://github.com/ansible-collections/community.general/pull/4674).
+      - pipx - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived
+        modules (https://github.com/ansible-collections/community.general/pull/4674).
+      - snap - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived
+        modules (https://github.com/ansible-collections/community.general/pull/4674).
+      - xfconf - using ``do_raise()`` to raise exceptions in ``ModuleHelper`` derived
+        modules (https://github.com/ansible-collections/community.general/pull/4674).
+      release_summary: Regular bugfix release for inclusion in Ansible 6.0.0.
+    fragments:
+    - 4674-use-mh-raise.yaml
+    - 4682-compatibility-virtualmedia-resource-location.yaml
+    - 4700-code-changes.yml
+    - 4712-consul-bugfix.yaml
+    - 4719-fix-keycloak-realm.yaml
+    - 4726-zfs.yml
+    - 4733-redis-fail.yml
+    - 5.0.1.yml
+    release_date: '2022-05-30'
+  5.0.2:
+    changes:
+      bugfixes:
+      - Include ``simplified_bsd.txt`` license file for various module utils, the
+        ``lxca_common`` docs fragment, and the ``utm_utils`` unit tests.
+      release_summary: Maintenance and bugfix release for Ansible 6.0.0.
+    fragments:
+    - 5.0.2.yml
+    - simplified-bsd-license.yml
+    release_date: '2022-06-06'
+  5.1.0:
+    changes:
+      deprecated_features:
+      - cmd_runner module utils - deprecated ``fmt`` in favour of ``cmd_runner_fmt``
+        as the parameter format object (https://github.com/ansible-collections/community.general/pull/4777).
+      minor_changes:
+      - ModuleHelper module utils - improved ``ModuleHelperException``, using ``to_native()``
+        for the exception message (https://github.com/ansible-collections/community.general/pull/4755).
+      - alternatives - add ``state=absent`` to be able to remove an alternative (https://github.com/ansible-collections/community.general/pull/4654).
+      - alternatives - add ``subcommands`` parameter (https://github.com/ansible-collections/community.general/pull/4654).
+      - ansible_galaxy_install - minor refactoring using latest ``ModuleHelper`` updates
+        (https://github.com/ansible-collections/community.general/pull/4752).
+      - cmd_runner module util - added parameters ``check_mode_skip`` and ``check_mode_return``
+        to ``CmdRunner.context()``, so that the command is not executed when ``check_mode=True``
+        (https://github.com/ansible-collections/community.general/pull/4736).
+      - nmcli - adds ``vpn`` type and parameter for supporting VPN with service type
+        L2TP and PPTP (https://github.com/ansible-collections/community.general/pull/4746).
+      - proxmox inventory plugin - added new flag ``qemu_extended_statuses`` and new
+        groups ``<group_prefix>prelaunch``, ``<group_prefix>paused``. They will be
+        populated only when ``want_facts=true``, ``qemu_extended_statuses=true`` and
+        only for ``QEMU`` machines (https://github.com/ansible-collections/community.general/pull/4723).
+      - puppet - adds ``confdir`` parameter to configure a custom confir location
+        (https://github.com/ansible-collections/community.general/pull/4740).
+      - xfconf - changed implementation to use ``cmd_runner`` (https://github.com/ansible-collections/community.general/pull/4776).
+      - xfconf module utils - created new module util ``xfconf`` providing a ``cmd_runner``
+        specific for ``xfconf`` modules (https://github.com/ansible-collections/community.general/pull/4776).
+      - xfconf_info - changed implementation to use ``cmd_runner`` (https://github.com/ansible-collections/community.general/pull/4776).
+      release_summary: Regular bugfix and feature release.
+    fragments:
+    - 4654-alternatives-add-subcommands.yml
+    - 4724-proxmox-qemu-extend.yaml
+    - 4736-cmd-runner-skip-if-check.yml
+    - 4740-puppet-feature.yaml
+    - 4746-add-vpn-support-nmcli.yaml
+    - 4752-ansible-galaxy-install-mh-updates.yml
+    - 4755-mhexception-improvement.yml
+    - 4776-xfconf-cmd-runner.yaml
+    - 4777-cmd-runner-deprecate-fmt.yaml
+    - 5.1.0.yml
+    modules:
+    - description: Retrieve GConf configurations
+      name: gconftool2_info
+      namespace: system
+    release_date: '2022-06-07'
+  5.1.1:
+    changes:
+      bugfixes:
+      - alternatives - do not set the priority if the priority was not set by the
+        user (https://github.com/ansible-collections/community.general/pull/4810).
+      - alternatives - only pass subcommands when they are specified as module arguments
+        (https://github.com/ansible-collections/community.general/issues/4803, https://github.com/ansible-collections/community.general/issues/4804,
+        https://github.com/ansible-collections/community.general/pull/4836).
+      - alternatives - when ``subcommands`` is specified, ``link`` must be given for
+        every subcommand. This was already mentioned in the documentation, but not
+        enforced by the code (https://github.com/ansible-collections/community.general/pull/4836).
+      - nmcli - fix error caused by adding undefined module arguments for list options
+        (https://github.com/ansible-collections/community.general/issues/4373, https://github.com/ansible-collections/community.general/pull/4813).
+      - proxmox inventory plugin - fixed extended status detection for qemu (https://github.com/ansible-collections/community.general/pull/4816).
+      - redhat_subscription - fix unsubscribing on RHEL 9 (https://github.com/ansible-collections/community.general/issues/4741).
+      - sudoers - ensure sudoers config files are created with the permissions requested
+        by sudoers (0440) (https://github.com/ansible-collections/community.general/pull/4814).
+      release_summary: Bugfix release.
+    fragments:
+    - 4809-redhat_subscription-unsubscribe.yaml
+    - 4810-alternatives-bug.yml
+    - 4813-fix-nmcli-convert-list.yaml
+    - 4814-sudoers-file-permissions.yml
+    - 4816-proxmox-fix-extended-status.yaml
+    - 4836-alternatives.yml
+    - 5.1.1.yml
+    release_date: '2022-06-14'
+  5.2.0:
+    changes:
+      bugfixes:
+      - Include ``PSF-license.txt`` file for ``plugins/module_utils/_mount.py``.
+      - redfish_command - fix the check if a virtual media is unmounted to just check
+        for ``instered= false`` caused by Supermicro hardware that does not clear
+        the ``ImageName`` (https://github.com/ansible-collections/community.general/pull/4839).
+      - redfish_command - the Supermicro Redfish implementation only supports the
+        ``image_url`` parameter in the underlying API calls to ``VirtualMediaInsert``
+        and ``VirtualMediaEject``. Any values set (or the defaults) for ``write_protected``
+        or ``inserted`` will be ignored (https://github.com/ansible-collections/community.general/pull/4839).
+      - 'sudoers - fix incorrect handling of ``state: absent`` (https://github.com/ansible-collections/community.general/issues/4852).'
+      minor_changes:
+      - cmd_runner module utils - add ``__call__`` method to invoke context (https://github.com/ansible-collections/community.general/pull/4791).
+      - passwordstore lookup plugin - allow using alternative password managers by
+        detecting wrapper scripts, allow explicit configuration of pass and gopass
+        backends (https://github.com/ansible-collections/community.general/issues/4766).
+      - sudoers - will attempt to validate the proposed sudoers rule using visudo
+        if available, optionally skipped, or required (https://github.com/ansible-collections/community.general/pull/4794,
+        https://github.com/ansible-collections/community.general/issues/4745).
+      release_summary: Regular bugfix and feature release.
+    fragments:
+    - 4780-passwordstore-wrapper-compat.yml
+    - 4791-cmd-runner-callable.yaml
+    - 4794-sudoers-validation.yml
+    - 4839-fix-VirtualMediaInsert-Supermicro.yml
+    - 4852-sudoers-state-absent.yml
+    - 5.2.0.yml
+    - psf-license.yml
+    modules:
+    - description: Set or delete a passphrase using the Operating System's native
+        keyring
+      name: keyring
+      namespace: system
+    - description: Get a passphrase using the Operating System's native keyring
+      name: keyring_info
+      namespace: system
+    - description: Scaleway compute - private network management
+      name: scaleway_compute_private_network
+      namespace: cloud.scaleway
+    release_date: '2022-06-21'
+  5.3.0:
+    changes:
+      bugfixes:
+      - cmd_runner module utils - fix bug caused by using the ``command`` variable
+        instead of ``self.command`` when looking for binary path (https://github.com/ansible-collections/community.general/pull/4903).
+      - dsv lookup plugin - do not ignore the ``tld`` parameter (https://github.com/ansible-collections/community.general/pull/4911).
+      - lxd connection plugin - fix incorrect ``inventory_hostname`` in ``remote_addr``.
+        This is needed for compatibility with ansible-core 2.13 (https://github.com/ansible-collections/community.general/issues/4886).
+      - proxmox inventory plugin - fix crash when ``enabled=1`` is used in agent config
+        string (https://github.com/ansible-collections/community.general/pull/4910).
+      - rax_clb_nodes - fix code to be compatible with Python 3 (https://github.com/ansible-collections/community.general/pull/4933).
+      - redfish_info - fix to ``GetChassisPower`` to correctly report power information
+        when multiple chassis exist, but not all chassis report power information
+        (https://github.com/ansible-collections/community.general/issues/4901).
+      minor_changes:
+      - machinectl become plugin - can now be used with a password from another user
+        than root, if a polkit rule is present (https://github.com/ansible-collections/community.general/pull/4849).
+      - opentelemetry callback plugin - allow configuring opentelementry callback
+        via config file (https://github.com/ansible-collections/community.general/pull/4916).
+      - redfish_info - add ``GetManagerInventory`` to report list of Manager inventory
+        information (https://github.com/ansible-collections/community.general/issues/4899).
+      release_summary: Regular bugfix and feature release.
+    fragments:
+    - 4849-add-password-prompt-support-for-machinectl.yml
+    - 4886-fix-lxd-inventory-hostname.yml
+    - 4899-add-GetManagerInventory-for-redfish_info.yml
+    - 4901-fix-redfish-chassispower.yml
+    - 4903-cmdrunner-bugfix.yaml
+    - 4910-fix-for-agent-enabled.yml
+    - 4911-dsv-honor-tld-option.yml
+    - 4916-opentelemetry-ini-options.yaml
+    - 4933-fix-rax-clb-nodes.yaml
+    - 5.3.0.yml
+    release_date: '2022-07-12'

galaxy.yml

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

meta/runtime.yml

@@ -292,6 +292,8 @@ plugin_routing:
       redirect: community.google.gce_tag
     gconftool2:
       redirect: community.general.system.gconftool2
+    gconftool2_info:
+      redirect: community.general.system.gconftool2_info
     gcp_backend_service:
       tombstone:
         removal_version: 2.0.0
@@ -606,6 +608,10 @@ plugin_routing:
       redirect: community.general.identity.keycloak.keycloak_role
     keycloak_user_federation:
       redirect: community.general.identity.keycloak.keycloak_user_federation
+    keyring:
+      redirect: community.general.system.keyring
+    keyring_info:
+      redirect: community.general.system.keyring_info
     kibana_plugin:
       redirect: community.general.database.misc.kibana_plugin
     kubevirt_cdi_upload:
@@ -1355,6 +1361,8 @@ plugin_routing:
       redirect: community.general.notification.say
     scaleway_compute:
       redirect: community.general.cloud.scaleway.scaleway_compute
+    scaleway_compute_private_network:
+      redirect: community.general.cloud.scaleway.scaleway_compute_private_network
     scaleway_database_backup:
       redirect: community.general.cloud.scaleway.scaleway_database_backup
     scaleway_image_facts:

plugins/become/machinectl.py

@@ -66,15 +66,46 @@ DOCUMENTATION = '''
             ini:
               - section: machinectl_become_plugin
                 key: password
+    notes:
+      - When not using this plugin with user C(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'''
+# A polkit rule needed to use the module with a non-root user.
+# See the Notes section for details.
+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
+
 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.machinectl'
 
+    prompt = 'Password: '
+    fail = ('==== AUTHENTICATION FAILED ====',)
+    success = ('==== AUTHENTICATION COMPLETE ====',)
+
+    @staticmethod
+    def remove_ansi_codes(line):
+        return ansi_color_codes.sub(b"", line)
+
     def build_become_command(self, cmd, shell):
         super(BecomeModule, self).build_become_command(cmd, shell)
 
@@ -86,3 +117,15 @@ class BecomeModule(BecomeBase):
         flags = self.get_option('become_flags')
         user = self.get_option('become_user')
         return '%s -q shell %s %s@ %s' % (become, flags, user, cmd)
+
+    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/callback/log_plays.py

@@ -12,7 +12,7 @@ DOCUMENTATION = '''
     type: notification
     short_description: write playbook output to log file
     description:
-      - This callback writes playbook output to a file per host in the `/var/log/ansible/hosts` directory
+      - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory
     requirements:
      - Whitelist in configuration
      - A writeable /var/log/ansible/hosts directory by the user executing Ansible on the controller

plugins/callback/opentelemetry.py

@@ -24,6 +24,10 @@ DOCUMENTATION = '''
           - 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:
@@ -34,6 +38,10 @@ DOCUMENTATION = '''
             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
@@ -42,6 +50,10 @@ DOCUMENTATION = '''
           - 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
@@ -61,11 +73,14 @@ examples: |
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.opentelemetry
+    [callback_opentelemetry]
+    enable_from_environment = ANSIBLE_OPENTELEMETRY_ENABLED
 
   Set the environment variable:
     export OTEL_EXPORTER_OTLP_ENDPOINT=<your endpoint (OTLP/HTTP)>
     export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
     export OTEL_SERVICE_NAME=your_service_name
+    export ANSIBLE_OPENTELEMETRY_ENABLED=true
 '''
 
 import getpass

plugins/callback/selective.py

@@ -14,9 +14,9 @@ DOCUMENTATION = '''
       - set as main display callback
     short_description: only print certain tasks
     description:
-      - This callback only prints tasks that have been tagged with `print_action` or that have failed.
+      - 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 '.'.
+      - Tasks that are not printed are placed with a C(.).
       - If you increase verbosity all tasks are printed.
     options:
       nocolor:

plugins/connection/lxd.py

@@ -18,6 +18,7 @@ DOCUMENTATION = '''
             - Container identifier.
         default: inventory_hostname
         vars:
+            - name: inventory_hostname
             - name: ansible_host
             - name: ansible_lxd_host
       executable:
@@ -61,7 +62,6 @@ class Connection(ConnectionBase):
     def __init__(self, play_context, new_stdin, *args, **kwargs):
         super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
 
-        self._host = self._play_context.remote_addr
         try:
             self._lxc_cmd = get_bin_path("lxc")
         except ValueError:
@@ -75,14 +75,14 @@ class Connection(ConnectionBase):
         super(Connection, self)._connect()
 
         if not self._connected:
-            self._display.vvv(u"ESTABLISH LXD CONNECTION FOR USER: root", host=self._host)
+            self._display.vvv(u"ESTABLISH LXD CONNECTION FOR USER: root", host=self.get_option('remote_addr'))
             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(u"EXEC {0}".format(cmd), host=self._host)
+        self._display.vvv(u"EXEC {0}".format(cmd), host=self.get_option('remote_addr'))
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):
@@ -104,10 +104,10 @@ class Connection(ConnectionBase):
         stderr = to_text(stderr)
 
         if stderr == "error: Container is not running.\n":
-            raise AnsibleConnectionFailure("container not running: %s" % self._host)
+            raise AnsibleConnectionFailure("container not running: %s" % self.get_option('remote_addr'))
 
         if stderr == "error: not found\n":
-            raise AnsibleConnectionFailure("container not found: %s" % self._host)
+            raise AnsibleConnectionFailure("container not found: %s" % self.get_option('remote_addr'))
 
         return process.returncode, stdout, stderr
 
@@ -115,7 +115,7 @@ class Connection(ConnectionBase):
         """ put a file from local to lxd """
         super(Connection, self).put_file(in_path, out_path)
 
-        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path), host=self._host)
+        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path), host=self.get_option('remote_addr'))
 
         if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
             raise AnsibleFileNotFound("input path is not a file: %s" % in_path)
@@ -138,7 +138,7 @@ class Connection(ConnectionBase):
         """ fetch a file from lxd to local """
         super(Connection, self).fetch_file(in_path, out_path)
 
-        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path), host=self._host)
+        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path), host=self.get_option('remote_addr'))
 
         local_cmd = [self._lxc_cmd]
         if self.get_option("project"):

plugins/doc_fragments/lxca_common.py

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

plugins/filter/counter.py

@@ -21,7 +21,7 @@ DOCUMENTATION = '''
 '''
 
 EXAMPLES = '''
-- name: Count occurences
+- name: Count occurrences
   ansible.builtin.debug:
     msg: >-
       {{ [1, 'a', 2, 2, 'a', 'b', 'a'] | community.general.counter }}
@@ -30,7 +30,7 @@ EXAMPLES = '''
 
 RETURN = '''
   _value:
-    description: A dictionary with the elements of the sequence as keys, and their number of occurance in the sequence as values.
+    description: A dictionary with the elements of the sequence as keys, and their number of occurrences in the sequence as values.
     type: dictionary
 '''
 

plugins/filter/jc.py

@@ -38,7 +38,7 @@ DOCUMENTATION = '''
     parser:
       description:
         - The correct parser for the input data.
-        - For exmaple C(ifconfig).
+        - For example C(ifconfig).
         - See U(https://github.com/kellyjonbrazil/jc#parsers) for the latest list of parsers.
       type: string
       required: true

plugins/inventory/cobbler.py

@@ -213,7 +213,7 @@ class InventoryModule(BaseInventoryPlugin, Cacheable):
                         self.inventory.add_child(parent_group_name, group_name)
             else:
                 self.display.vvvv('Processing profile %s without parent\n' % profile['name'])
-                # Create a heirarchy of profile names
+                # Create a hierarchy of profile names
                 profile_elements = profile['name'].split('-')
                 i = 0
                 while i < len(profile_elements) - 1:

plugins/inventory/lxd.py

@@ -522,7 +522,7 @@ class InventoryModule(BaseInventoryPlugin):
         """Helper to save data
 
         Helper to save the data in self.data
-        Detect if data is allready in branch and use dict_merge() to prevent that branch is overwritten.
+        Detect if data is already in branch and use dict_merge() to prevent that branch is overwritten.
 
         Args:
             str(instance_name): name of instance

plugins/inventory/proxmox.py

@@ -92,9 +92,21 @@ DOCUMENTATION = '''
         default: proxmox_
         type: str
       want_facts:
-        description: Gather LXC/QEMU configuration facts.
+        description:
+          - Gather LXC/QEMU configuration facts.
+          - When I(want_facts) is set to C(true) more details about QEMU VM status are possible, besides the running and stopped states.
+            Currently if the VM is running and it is suspended, the status will be running and the machine will be in C(running) group,
+            but its actual state will be paused. See I(qemu_extended_statuses) for how to retrieve the real status.
         default: no
         type: bool
+      qemu_extended_statuses:
+        description:
+          - Requires I(want_facts) to be set to C(true) to function. This will allow you to differentiate betweend C(paused) and C(prelaunch)
+            statuses of the QEMU VMs.
+          - This introduces multiple groups [prefixed with I(group_prefix)] C(prelaunch) and C(paused).
+        default: no
+        type: bool
+        version_added: 5.1.0
       want_proxmox_nodes_ansible_host:
         version_added: 3.0.0
         description:
@@ -400,12 +412,20 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                         properties[parsed_key] = [tag.strip() for tag in stripped_value.split(",")]
 
                 # The first field in the agent string tells you whether the agent is enabled
-                # the rest of the comma separated string is extra config for the agent
+                # the rest of the comma separated string is extra config for the agent.
-                if config == 'agent' and int(value.split(',')[0]):
+                # In some (newer versions of proxmox) instances it can be 'enabled=1'.
-                    agent_iface_value = self._get_agent_network_interfaces(node, vmid, vmtype)
+                if config == 'agent':
-                    if agent_iface_value:
+                    agent_enabled = 0
-                        agent_iface_key = self.to_safe('%s%s' % (key, "_interfaces"))
+                    try:
-                        properties[agent_iface_key] = agent_iface_value
+                        agent_enabled = int(value.split(',')[0])
+                    except ValueError:
+                        if value.split(',')[0] == "enabled=1":
+                            agent_enabled = 1
+                    if agent_enabled:
+                        agent_iface_value = self._get_agent_network_interfaces(node, vmid, vmtype)
+                        if agent_iface_value:
+                            agent_iface_key = self.to_safe('%s%s' % (key, "_interfaces"))
+                            properties[agent_iface_key] = agent_iface_value
 
                 if config == 'lxc':
                     out_val = {}
@@ -431,6 +451,8 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
     def _get_vm_status(self, properties, node, vmid, vmtype, name):
         ret = self._get_json("%s/api2/json/nodes/%s/%s/%s/status/current" % (self.proxmox_url, node, vmtype, vmid))
         properties[self._fact('status')] = ret['status']
+        if vmtype == 'qemu':
+            properties[self._fact('qmpstatus')] = ret['qmpstatus']
 
     def _get_vm_snapshots(self, properties, node, vmid, vmtype, name):
         ret = self._get_json("%s/api2/json/nodes/%s/%s/%s/snapshot" % (self.proxmox_url, node, vmtype, vmid))
@@ -489,7 +511,8 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         name, vmid = item['name'], item['vmid']
 
         # get status, config and snapshots if want_facts == True
-        if self.get_option('want_facts'):
+        want_facts = self.get_option('want_facts')
+        if want_facts:
             self._get_vm_status(properties, node, vmid, ittype, name)
             self._get_vm_config(properties, node, vmid, ittype, name)
             self._get_vm_snapshots(properties, node, vmid, ittype, name)
@@ -503,10 +526,13 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         node_type_group = self._group('%s_%s' % (node, ittype))
         self.inventory.add_child(self._group('all_' + ittype), name)
         self.inventory.add_child(node_type_group, name)
-        if item['status'] == 'stopped':
+
-            self.inventory.add_child(self._group('all_stopped'), name)
+        item_status = item['status']
-        elif item['status'] == 'running':
+        if item_status == 'running':
-            self.inventory.add_child(self._group('all_running'), name)
+            if want_facts and ittype == 'qemu' and self.get_option('qemu_extended_statuses'):
+                # get more details about the status of the qemu VM
+                item_status = properties.get(self._fact('qmpstatus'), item_status)
+        self.inventory.add_child(self._group('all_%s' % (item_status, )), name)
 
         return name
 
@@ -528,10 +554,14 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
     def _populate(self):
 
         # create common groups
-        self.inventory.add_group(self._group('all_lxc'))
+        default_groups = ['lxc', 'qemu', 'running', 'stopped']
-        self.inventory.add_group(self._group('all_qemu'))
+
-        self.inventory.add_group(self._group('all_running'))
+        if self.get_option('qemu_extended_statuses'):
-        self.inventory.add_group(self._group('all_stopped'))
+            default_groups.extend(['prelaunch', 'paused'])
+
+        for group in default_groups:
+            self.inventory.add_group(self._group('all_%s' % (group)))
+
         nodes_group = self._group('nodes')
         self.inventory.add_group(nodes_group)
 
@@ -621,6 +651,9 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         if proxmox_password is None and (proxmox_token_id is None or proxmox_token_secret is None):
             raise AnsibleError('You must specify either a password or both token_id and token_secret.')
 
+        if self.get_option('qemu_extended_statuses') and not self.get_option('want_facts'):
+            raise AnsibleError('You must set want_facts to True if you want to use qemu_extended_statuses.')
+
         self.cache_key = self.get_cache_key(path)
         self.use_cache = cache and self.get_option('cache')
         self.host_filters = self.get_option('filters')

plugins/lookup/chef_databag.py

@@ -16,7 +16,7 @@ DOCUMENTATION = '''
          The lookup order mirrors the one from Chef, all folders in the base path are walked back looking for the following configuration
          file in order : .chef/knife.rb, ~/.chef/knife.rb, /etc/chef/client.rb"
     requirements:
-        - "pychef (python library https://pychef.readthedocs.io `pip install pychef`)"
+        - "pychef (L(Python library, https://pychef.readthedocs.io), C(pip install pychef))"
     options:
         name:
           description:

plugins/lookup/dsv.py

@@ -122,6 +122,7 @@ class LookupModule(LookupBase):
                 "tenant": self.get_option("tenant"),
                 "client_id": self.get_option("client_id"),
                 "client_secret": self.get_option("client_secret"),
+                "tld": self.get_option("tld"),
                 "url_template": self.get_option("url_template"),
             }
         )

plugins/lookup/keyring.py

@@ -18,7 +18,7 @@ DOCUMENTATION = '''
 '''
 
 EXAMPLES = """
-- name : output secrets to screen (BAD IDEA)
+- name: output secrets to screen (BAD IDEA)
   ansible.builtin.debug:
     msg: "Password: {{item}}"
   with_community.general.keyring:

plugins/lookup/passwordstore.py

@@ -106,6 +106,22 @@ DOCUMENTATION = '''
         type: str
         default: 15m
         version_added: 4.5.0
+      backend:
+        description:
+          - Specify which backend to use.
+          - Defaults to C(pass), passwordstore.org's original pass utility.
+          - C(gopass) support is incomplete.
+        ini:
+          - section: passwordstore_lookup
+            key: backend
+        vars:
+          - name: passwordstore_backend
+        type: str
+        default: pass
+        choices:
+          - pass
+          - gopass
+        version_added: 5.2.0
 '''
 EXAMPLES = """
 ansible.cfg: |
@@ -231,6 +247,24 @@ def check_output2(*popenargs, **kwargs):
 
 
 class LookupModule(LookupBase):
+    def __init__(self, loader=None, templar=None, **kwargs):
+
+        super(LookupModule, self).__init__(loader, templar, **kwargs)
+        self.realpass = None
+
+    def is_real_pass(self):
+        if self.realpass is None:
+            try:
+                self.passoutput = to_text(
+                    check_output2([self.pass_cmd, "--version"], env=self.env),
+                    errors='surrogate_or_strict'
+                )
+                self.realpass = 'pass: the standard unix password manager' in self.passoutput
+            except (subprocess.CalledProcessError) as e:
+                raise AnsibleError(e)
+
+        return self.realpass
+
     def parse_params(self, term):
         # I went with the "traditional" param followed with space separated KV pairs.
         # Waiting for final implementation of lookup parameter parsing.
@@ -270,10 +304,12 @@ class LookupModule(LookupBase):
             self.env = os.environ.copy()
             self.env['LANGUAGE'] = 'C'  # make sure to get errors in English as required by check_output2
 
-            # Set PASSWORD_STORE_DIR
+            if self.backend == 'gopass':
-            if os.path.isdir(self.paramvals['directory']):
+                self.env['GOPASS_NO_REMINDER'] = "YES"
+            elif os.path.isdir(self.paramvals['directory']):
+                # Set PASSWORD_STORE_DIR
                 self.env['PASSWORD_STORE_DIR'] = self.paramvals['directory']
-            else:
+            elif self.is_real_pass():
                 raise AnsibleError('Passwordstore directory \'{0}\' does not exist'.format(self.paramvals['directory']))
 
             # Set PASSWORD_STORE_UMASK if umask is set
@@ -288,7 +324,9 @@ class LookupModule(LookupBase):
     def check_pass(self):
         try:
             self.passoutput = to_text(
-                check_output2(["pass", "show", self.passname], env=self.env),
+                check_output2([self.pass_cmd, 'show'] +
+                              (['--password'] if self.backend == 'gopass' else []) +
+                              [self.passname], env=self.env),
                 errors='surrogate_or_strict'
             ).splitlines()
             self.password = self.passoutput[0]
@@ -302,8 +340,10 @@ class LookupModule(LookupBase):
                     if ':' in line:
                         name, value = line.split(':', 1)
                         self.passdict[name.strip()] = value.strip()
-            if os.path.isfile(os.path.join(self.paramvals['directory'], self.passname + ".gpg")):
+            if (self.backend == 'gopass' or
-                # Only accept password as found, if there a .gpg file for it (might be a tree node otherwise)
+                    os.path.isfile(os.path.join(self.paramvals['directory'], self.passname + ".gpg"))
+                    or not self.is_real_pass()):
+                # When using real pass, only accept password as found if there is a .gpg file for it (might be a tree node otherwise)
                 return True
         except (subprocess.CalledProcessError) as e:
             # 'not in password store' is the expected error if a password wasn't found
@@ -339,7 +379,7 @@ class LookupModule(LookupBase):
         if self.paramvals['backup']:
             msg += "lookup_pass: old password was {0} (Updated on {1})\n".format(self.password, datetime)
         try:
-            check_output2(['pass', 'insert', '-f', '-m', self.passname], input=msg, env=self.env)
+            check_output2([self.pass_cmd, 'insert', '-f', '-m', self.passname], input=msg, env=self.env)
         except (subprocess.CalledProcessError) as e:
             raise AnsibleError(e)
         return newpass
@@ -351,7 +391,7 @@ class LookupModule(LookupBase):
         datetime = time.strftime("%d/%m/%Y %H:%M:%S")
         msg = newpass + '\n' + "lookup_pass: First generated by ansible on {0}\n".format(datetime)
         try:
-            check_output2(['pass', 'insert', '-f', '-m', self.passname], input=msg, env=self.env)
+            check_output2([self.pass_cmd, 'insert', '-f', '-m', self.passname], input=msg, env=self.env)
         except (subprocess.CalledProcessError) as e:
             raise AnsibleError(e)
         return newpass
@@ -380,6 +420,8 @@ class LookupModule(LookupBase):
             yield
 
     def setup(self, variables):
+        self.backend = self.get_option('backend')
+        self.pass_cmd = self.backend  # pass and gopass are commands as well
         self.locked = None
         timeout = self.get_option('locktimeout')
         if not re.match('^[0-9]+[smh]$', timeout):
@@ -402,6 +444,7 @@ class LookupModule(LookupBase):
         }
 
     def run(self, terms, variables, **kwargs):
+        self.set_options(var_options=variables, direct=kwargs)
         self.setup(variables)
         result = []
 

plugins/module_utils/_mount.py

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

plugins/module_utils/alicloud_ecs.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c) 2017-present Alibaba Group Holding Limited. He Guimin <heguimin36@163.com>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/cmd_runner.py

@@ -191,13 +191,13 @@ class CmdRunner(object):
             environ_update = {}
         self.environ_update = environ_update
 
-        self.command[0] = module.get_bin_path(command[0], opt_dirs=path_prefix, required=True)
+        self.command[0] = module.get_bin_path(self.command[0], opt_dirs=path_prefix, required=True)
 
         for mod_param_name, spec in iteritems(module.argument_spec):
             if mod_param_name not in self.arg_formats:
                 self.arg_formats[mod_param_name] = _Format.as_default_type(spec['type'], mod_param_name)
 
-    def context(self, args_order=None, output_process=None, ignore_value_none=True, **kwargs):
+    def __call__(self, args_order=None, output_process=None, ignore_value_none=True, check_mode_skip=False, check_mode_return=None, **kwargs):
         if output_process is None:
             output_process = _process_as_is
         if args_order is None:
@@ -209,18 +209,25 @@ class CmdRunner(object):
         return _CmdRunnerContext(runner=self,
                                  args_order=args_order,
                                  output_process=output_process,
-                                 ignore_value_none=ignore_value_none, **kwargs)
+                                 ignore_value_none=ignore_value_none,
+                                 check_mode_skip=check_mode_skip,
+                                 check_mode_return=check_mode_return, **kwargs)
 
     def has_arg_format(self, arg):
         return arg in self.arg_formats
 
+    # not decided whether to keep it or not, but if deprecating it will happen in a farther future.
+    context = __call__
+
 
 class _CmdRunnerContext(object):
-    def __init__(self, runner, args_order, output_process, ignore_value_none, **kwargs):
+    def __init__(self, runner, args_order, output_process, ignore_value_none, check_mode_skip, check_mode_return, **kwargs):
         self.runner = runner
         self.args_order = tuple(args_order)
         self.output_process = output_process
         self.ignore_value_none = ignore_value_none
+        self.check_mode_skip = check_mode_skip
+        self.check_mode_return = check_mode_return
         self.run_command_args = dict(kwargs)
 
         self.environ_update = runner.environ_update
@@ -260,6 +267,8 @@ class _CmdRunnerContext(object):
             except Exception as e:
                 raise FormatError(arg_name, value, runner.arg_formats[arg_name], e)
 
+        if self.check_mode_skip and module.check_mode:
+            return self.check_mode_return
         results = module.run_command(self.cmd, **self.run_command_args)
         self.results_rc, self.results_out, self.results_err = results
         self.results_processed = self.output_process(*results)
@@ -288,4 +297,12 @@ class _CmdRunnerContext(object):
         return False
 
 
-fmt = _Format()
+cmd_runner_fmt = _Format()
+
+#
+# The fmt form is deprecated and will be removed in community.general 7.0.0
+# Please use:
+#   cmd_runner_fmt
+# Or, to retain the same effect, use:
+#   from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt as fmt
+fmt = cmd_runner_fmt

plugins/module_utils/database.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c) 2014, Toshio Kuratomi <tkuratomi@ansible.com>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/gandi_livedns_api.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright: (c) 2019 Gregory Thiemonge <gregory.thiemonge@gmail.com>
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/gconftool2.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# (c) 2022, Alexei Znamensky <russoz@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt as fmt
+
+
+def gconftool2_runner(module, **kwargs):
+    return CmdRunner(
+        module,
+        command='gconftool-2',
+        arg_formats=dict(
+            key=fmt.as_list(),
+            value_type=fmt.as_opt_val("--type"),
+            value=fmt.as_list(),
+            direct=fmt.as_bool("--direct"),
+            config_source=fmt.as_opt_val("--config-source"),
+            get=fmt.as_bool("--get"),
+            set_arg=fmt.as_bool("--set"),
+            unset=fmt.as_bool("--unset"),
+        ),
+        **kwargs
+    )

plugins/module_utils/heroku.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright: (c) 2018, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/hwc_utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright (c), Google Inc, 2017
-# Simplified BSD License (see licenses/simplified_bsd.txt or
+# Simplified BSD License (see simplified_bsd.txt or
 # https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
@@ -351,7 +351,7 @@ def wait_to_finish(target, pending, refresh, timeout, min_interval=1, delay=3):
 
             if pending and status not in pending:
                 raise HwcModuleException(
-                    "unexpect status(%s) occured" % status)
+                    "unexpect status(%s) occurred" % status)
 
         if not is_last_time:
             wait *= 2

plugins/module_utils/ibm_sa_utils.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2018 IBM CORPORATION
 # Author(s): Tzur Eliyahu <tzure@il.ibm.com>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/ilo_redfish_utils.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 # Copyright (c) 2021-2022 Hewlett Packard Enterprise, Inc. All rights reserved.
-# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/influxdb.py

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

plugins/module_utils/ipa.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c) 2016 Thomas Krahn (@Nosmoht)
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/known_hosts.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c), Michael DeHaan <michael.dehaan@gmail.com>, 2012-2013
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/linode.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c), Luke Murphy @decentral1se
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/lxd.py

@@ -8,7 +8,7 @@
 # still belong to the author of the module, and may assign their own license
 # to the complete work.
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/manageiq.py

@@ -8,7 +8,7 @@
 # still belong to the author of the module, and may assign their own license
 # to the complete work.
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/memset.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c) 2018, Simon Weald <ansible@simonweald.com>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/mh/base.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/deco.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/exceptions.py

@@ -1,22 +1,18 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+from ansible.module_utils.common.text.converters import to_native
+
 
 class ModuleHelperException(Exception):
-    @staticmethod
+    def __init__(self, msg, update_output=None, *args, **kwargs):
-    def _get_remove(key, kwargs):
+        self.msg = to_native(msg or "Module failed with exception: {0}".format(self))
-        if key in kwargs:
+        if update_output is None:
-            result = kwargs[key]
+            update_output = {}
-            del kwargs[key]
+        self.update_output = update_output
-            return result
-        return None
-
-    def __init__(self, *args, **kwargs):
-        self.msg = self._get_remove('msg', kwargs) or "Module failed with exception: {0}".format(self)
-        self.update_output = self._get_remove('update_output', kwargs) or {}
         super(ModuleHelperException, self).__init__(*args)

plugins/module_utils/mh/mixins/cmd.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/mixins/deprecate_attrs.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/mixins/deps.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/mixins/state.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/mixins/vars.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/mh/module_helper.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/module_helper.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # (c) 2020, Alexei Znamensky <russoz@gmail.com>
 # Copyright: (c) 2020, Ansible Project
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type

plugins/module_utils/oneandone.py

@@ -5,7 +5,7 @@
 # still belong to the author of the module, and may assign their own license
 # to the complete work.
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/onepassword.py

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

plugins/module_utils/oneview.py

@@ -7,7 +7,7 @@
 #
 # Copyright (2016-2017) Hewlett Packard Enterprise Development LP
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/online.py

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

plugins/module_utils/opennebula.py

@@ -2,7 +2,7 @@
 #
 # Copyright 2018 www.privaz.io Valletech AB
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
@@ -83,12 +83,12 @@ class OpenNebulaModule:
         if self.module.params.get("api_username"):
             username = self.module.params.get("api_username")
         else:
-            self.fail("Either api_username or the environment vairable ONE_USERNAME must be provided")
+            self.fail("Either api_username or the environment variable ONE_USERNAME must be provided")
 
         if self.module.params.get("api_password"):
             password = self.module.params.get("api_password")
         else:
-            self.fail("Either api_password or the environment vairable ONE_PASSWORD must be provided")
+            self.fail("Either api_password or the environment variable ONE_PASSWORD must be provided")
 
         session = "%s:%s" % (username, password)
 

plugins/module_utils/oracle/oci_utils.py

@@ -691,7 +691,7 @@ def check_and_create_resource(
     :param model: Model used to create a resource.
     :param exclude_attributes: The attributes which should not be used to distinguish the resource. e.g. display_name,
      dns_label.
-    :param dead_states: List of states which can't transition to any of the usable states of the resource. This deafults
+    :param dead_states: List of states which can't transition to any of the usable states of the resource. This defaults
     to ["TERMINATING", "TERMINATED", "FAULTY", "FAILED", "DELETING", "DELETED", "UNKNOWN_ENUM_VALUE"]
     :param default_attribute_values: A dictionary containing default values for attributes.
     :return: A dictionary containing the resource & the "changed" status. e.g. {"vcn":{x:y}, "changed":True}
@@ -1189,7 +1189,7 @@ def are_dicts_equal(
 
 
 def should_dict_attr_be_excluded(map_option_name, option_key, exclude_list):
-    """An entry for the Exclude list for excluding a map's key is specifed as a dict with the map option name as the
+    """An entry for the Exclude list for excluding a map's key is specified as a dict with the map option name as the
     key, and the value as a list of keys to be excluded within that map. For example, if the keys "k1" and "k2" of a map
     option named "m1" needs to be excluded, the exclude list must have an entry {'m1': ['k1','k2']} """
     for exclude_item in exclude_list:

plugins/module_utils/pure.py

@@ -7,7 +7,7 @@
 # to the complete work.
 #
 # Copyright (c), Simon Dodsley <simon@purestorage.com>,2017
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/rax.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c), Michael DeHaan <michael.dehaan@gmail.com>, 2012-2013
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/redfish_utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2017-2018 Dell EMC Inc.
-# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
@@ -1888,14 +1888,13 @@ class RedfishUtils(object):
                         for property in properties:
                             if property in data:
                                 chassis_power_result[property] = data[property]
-                else:
-                    return {'ret': False, 'msg': 'Key PowerControl not found.'}
                 chassis_power_results.append(chassis_power_result)
-            else:
-                return {'ret': False, 'msg': 'Key Power not found.'}
 
-        result['entries'] = chassis_power_results
+        if len(chassis_power_results) > 0:
-        return result
+            result['entries'] = chassis_power_results
+            return result
+        else:
+            return {'ret': False, 'msg': 'Power information not found.'}
 
     def get_chassis_thermals(self):
         result = {}
@@ -2187,9 +2186,8 @@ class RedfishUtils(object):
             else:
                 if media_match_strict:
                     continue
-            # if ejected, 'Inserted' should be False and 'ImageName' cleared
+            # if ejected, 'Inserted' should be False
-            if (not data.get('Inserted', False) and
+            if (not data.get('Inserted', False)):
-                    not data.get('ImageName')):
                 return uri, data
         return None, None
 
@@ -2225,7 +2223,7 @@ class RedfishUtils(object):
         return resources, headers
 
     @staticmethod
-    def _insert_virt_media_payload(options, param_map, data, ai):
+    def _insert_virt_media_payload(options, param_map, data, ai, image_only=False):
         payload = {
             'Image': options.get('image_url')
         }
@@ -2239,6 +2237,12 @@ class RedfishUtils(object):
                                        options.get(option), option,
                                        allowable)}
                 payload[param] = options.get(option)
+
+        # Some hardware (such as iLO 4 or Supermicro) only supports the Image property
+        # Inserted and WriteProtected are not writable
+        if image_only:
+            del payload['Inserted']
+            del payload['WriteProtected']
         return payload
 
     def virtual_media_insert_via_patch(self, options, param_map, uri, data, image_only=False):
@@ -2247,16 +2251,10 @@ class RedfishUtils(object):
                    {'AllowableValues': v}) for k, v in data.items()
                   if k.endswith('@Redfish.AllowableValues'))
         # construct payload
-        payload = self._insert_virt_media_payload(options, param_map, data, ai)
+        payload = self._insert_virt_media_payload(options, param_map, data, ai, image_only)
-        if 'Inserted' not in payload:
+        if 'Inserted' not in payload and not image_only:
             payload['Inserted'] = True
 
-        # Some hardware (such as iLO 4) only supports the Image property on the PATCH operation
-        # Inserted and WriteProtected are not writable
-        if image_only:
-            del payload['Inserted']
-            del payload['WriteProtected']
-
         # PATCH the resource
         response = self.patch_request(self.root_uri + uri, payload)
         if response['ret'] is False:
@@ -2292,6 +2290,13 @@ class RedfishUtils(object):
         if data["FirmwareVersion"].startswith("iLO 4"):
             image_only = True
 
+        # Supermicro does also not support Inserted and WriteProtected
+        # Supermicro uses as firmware version only a number so we can't check for it because we
+        # can't be sure that this firmware version is nut used by another vendor
+        # Tested with Supermicro Firmware 01.74.02
+        if 'Supermicro' in data['Oem']:
+            image_only = True
+
         virt_media_uri = data["VirtualMedia"]["@odata.id"]
         response = self.get_request(self.root_uri + virt_media_uri)
         if response['ret'] is False:
@@ -2346,7 +2351,7 @@ class RedfishUtils(object):
         # get ActionInfo or AllowableValues
         ai = self._get_all_action_info_values(action)
         # construct payload
-        payload = self._insert_virt_media_payload(options, param_map, data, ai)
+        payload = self._insert_virt_media_payload(options, param_map, data, ai, image_only)
         # POST to action
         response = self.post_request(self.root_uri + action_uri, payload)
         if response['ret'] is False:
@@ -2392,6 +2397,9 @@ class RedfishUtils(object):
         if data["FirmwareVersion"].startswith("iLO 4"):
             image_only = True
 
+        if 'Supermicro' in data['Oem']:
+            image_only = True
+
         virt_media_uri = data["VirtualMedia"]["@odata.id"]
         response = self.get_request(self.root_uri + virt_media_uri)
         if response['ret'] is False:
@@ -3020,3 +3028,26 @@ class RedfishUtils(object):
         if not result["entries"]:
             return {'ret': False, 'msg': "No HostInterface objects found"}
         return result
+
+    def get_manager_inventory(self, manager_uri):
+        result = {}
+        inventory = {}
+        # Get these entries, but does not fail if not found
+        properties = ['FirmwareVersion', 'ManagerType', 'Manufacturer', 'Model',
+                      'PartNumber', 'PowerState', 'SerialNumber', 'Status', 'UUID']
+
+        response = self.get_request(self.root_uri + manager_uri)
+        if response['ret'] is False:
+            return response
+        result['ret'] = True
+        data = response['data']
+
+        for property in properties:
+            if property in data:
+                inventory[property] = data[property]
+
+        result["entries"] = inventory
+        return result
+
+    def get_multi_manager_inventory(self):
+        return self.aggregate_managers(self.get_manager_inventory)

plugins/module_utils/redhat.py

@@ -7,7 +7,7 @@
 #
 # Copyright (c), James Laska
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/redis.py

@@ -37,7 +37,7 @@ def fail_imports(module, needs_certifi=True):
         errors.append(missing_required_lib('certifi'))
         traceback.append(CERTIFI_IMPORT_ERROR)
     if errors:
-        module.fail_json(errors=errors, traceback='\n'.join(traceback))
+        module.fail_json(msg='\n'.join(errors), traceback='\n'.join(traceback))
 
 
 def redis_auth_argument_spec(tls_default=True):

plugins/module_utils/remote_management/lxca/common.py

@@ -6,7 +6,7 @@
 # own license to the complete work.
 #
 # Copyright (C) 2017 Lenovo, Inc.
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 #
 # Contains LXCA common class
 # Lenovo xClarity Administrator (LXCA)

plugins/module_utils/saslprep.py

@@ -8,7 +8,7 @@
 
 # Copyright: (c) 2020, Andrew Klychkov (@Andersson007) <aaklychkov@mail.ru>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/source_control/bitbucket.py

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

plugins/module_utils/storage/emc/emc_vnx.py

@@ -7,7 +7,7 @@
 #
 # (c) 2018 Luca 'remix_tj' Lorenzetto
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/storage/hpe3par/hpe3par.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright: (c) 2018, Hewlett Packard Enterprise Development LP
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/univention_umc.py

@@ -9,7 +9,7 @@
 # Copyright (c) 2016, Adfinis SyGroup AG
 # Tobias Rueetschi <tobias.ruetschi@adfinis-sygroup.ch>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/utm_utils.py

@@ -7,7 +7,7 @@
 #
 # Copyright: (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com>
 #
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/vexata.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright: (c) 2019, Sandeep Kasargod <sandeep@vexata.com>
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+# Simplified BSD License (see simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

plugins/module_utils/xfconf.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+# (c) 2022, Alexei Znamensky <russoz@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible.module_utils.parsing.convert_bool import boolean
+from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt as fmt
+
+
+@fmt.unpack_args
+def _values_fmt(values, value_types):
+    result = []
+    for value, value_type in zip(values, value_types):
+        if value_type == 'bool':
+            value = boolean(value)
+        result.extend(['--type', '{0}'.format(value_type), '--set', '{0}'.format(value)])
+    return result
+
+
+def xfconf_runner(module, **kwargs):
+    runner = CmdRunner(
+        module,
+        command='xfconf-query',
+        arg_formats=dict(
+            channel=fmt.as_opt_val("--channel"),
+            property=fmt.as_opt_val("--property"),
+            force_array=fmt.as_bool("--force-array"),
+            reset=fmt.as_bool("--reset"),
+            create=fmt.as_bool("--create"),
+            list_arg=fmt.as_bool("--list"),
+            values_and_types=fmt.as_func(_values_fmt),
+        ),
+        **kwargs
+    )
+    return runner

plugins/modules/cloud/lxd/lxd_container.py

@@ -191,10 +191,10 @@ notes:
     2.1, the later requires python to be installed in the instance which can
     be done with the command module.
   - You can copy a file from the host to the instance
-    with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the `lxd` connection plugin.
+    with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the C(community.general.lxd) connection plugin.
     See the example below.
   - You can copy a file in the created instance to the localhost
-    with `command=lxc file pull instance_name/dir/filename filename`.
+    with C(command=lxc file pull instance_name/dir/filename filename).
     See the first example below.
 '''
 

plugins/modules/cloud/lxd/lxd_profile.py

@@ -360,7 +360,7 @@ class LXDProfileManagement(object):
         )
 
     def _merge_dicts(self, source, destination):
-        """Merge Dictionarys
+        """Merge Dictionaries
 
         Get a list of filehandle numbers from logger to be handed to
         DaemonContext.files_preserve

plugins/modules/cloud/lxd/lxd_project.py

@@ -303,7 +303,7 @@ class LXDProjectManagement(object):
         )
 
     def _merge_dicts(self, source, destination):
-        """ Return a new dict taht merge two dict,
+        """ Return a new dict that merge two dict,
         with values in source dict overwrite destination dict
 
         Args:

plugins/modules/cloud/misc/proxmox_kvm.py

@@ -83,7 +83,7 @@ options:
     version_added: 1.3.0
   clone:
     description:
-      - Name of VM to be cloned. If C(vmid) is setted, C(clone) can take arbitrary value but required for initiating the clone.
+      - Name of VM to be cloned. If I(vmid) is set, I(clone) can take an arbitrary value but is required for initiating the clone.
     type: str
   cores:
     description:
@@ -1204,12 +1204,12 @@ def main():
         # Ensure source VM id exists when cloning
         proxmox.get_vm(vmid)
 
-        # Ensure the choosen VM name doesn't already exist when cloning
+        # Ensure the chosen VM name doesn't already exist when cloning
         existing_vmid = proxmox.get_vmid(name, ignore_missing=True)
         if existing_vmid:
             module.exit_json(changed=False, vmid=existing_vmid, msg="VM with name <%s> already exists" % name)
 
-        # Ensure the choosen VM id doesn't already exist when cloning
+        # Ensure the chosen VM id doesn't already exist when cloning
         if proxmox.get_vm(newid, ignore_missing=True):
             module.exit_json(changed=False, vmid=vmid, msg="vmid %s with VM name %s already exists" % (newid, name))
 

plugins/modules/cloud/misc/serverless.py

@@ -107,7 +107,7 @@ state:
   returned: always
 command:
   type: str
-  description: Full `serverless` command run by this module, in case you want to re-run the command outside the module.
+  description: Full C(serverless) command run by this module, in case you want to re-run the command outside the module.
   returned: always
   sample: serverless deploy --stage production
 '''

plugins/modules/cloud/misc/terraform.py

@@ -67,7 +67,7 @@ options:
   state_file:
     description:
       - The path to an existing Terraform state file to use when building plan.
-        If this is not specified, the default `terraform.tfstate` will be used.
+        If this is not specified, the default C(terraform.tfstate) will be used.
       - This option is ignored when plan is specified.
     type: path
   variables_files:
@@ -103,7 +103,7 @@ options:
   force_init:
     description:
       - To avoid duplicating infra, if a state file can't be found this will
-        force a `terraform init`. Generally, this should be turned off unless
+        force a C(terraform init). Generally, this should be turned off unless
         you intend to provision an entirely new Terraform deployment.
     default: false
     type: bool
@@ -149,7 +149,7 @@ options:
     type: int
     version_added: '3.8.0'
 notes:
-   - To just run a `terraform plan`, use check mode.
+   - To just run a C(terraform plan), use check mode.
 requirements: [ "terraform" ]
 author: "Ryan Scott Brown (@ryansb)"
 '''
@@ -205,7 +205,7 @@ EXAMPLES = """
 RETURN = """
 outputs:
   type: complex
-  description: A dictionary of all the TF outputs by their assigned name. Use `.outputs.MyOutputName.value` to access the value.
+  description: A dictionary of all the TF outputs by their assigned name. Use C(.outputs.MyOutputName.value) to access the value.
   returned: on success
   sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
   contains:
@@ -223,12 +223,12 @@ outputs:
       description: The value of the output as interpolated by Terraform
 stdout:
   type: str
-  description: Full `terraform` command stdout, in case you want to display it or examine the event log
+  description: Full C(terraform) command stdout, in case you want to display it or examine the event log
   returned: always
   sample: ''
 command:
   type: str
-  description: Full `terraform` command built by this module, in case you want to re-run the command outside the module or debug a problem.
+  description: Full C(terraform) command built by this module, in case you want to re-run the command outside the module or debug a problem.
   returned: always
   sample: terraform apply ...
 """

plugins/modules/cloud/rackspace/rax_clb_nodes.py

@@ -252,7 +252,8 @@ def main():
                 'weight': weight,
             }
 
-            for name, value in mutable.items():
+            for name in list(mutable):
+                value = mutable[name]
                 if value is None or value == getattr(node, name):
                     mutable.pop(name)
 

plugins/modules/cloud/rackspace/rax_mon_check.py

@@ -75,15 +75,15 @@ options:
   target_hostname:
     type: str
     description:
-    - One of `target_hostname` and `target_alias` is required for remote.* checks,
+    - One of I(target_hostname) and I(target_alias) is required for remote.* checks,
       but prohibited for agent.* checks. The hostname this check should target.
       Must be a valid IPv4, IPv6, or FQDN.
   target_alias:
     type: str
     description:
-    - One of `target_alias` and `target_hostname` is required for remote.* checks,
+    - One of I(target_alias) and I(target_hostname) is required for remote.* checks,
       but prohibited for agent.* checks. Use the corresponding key in the entity's
-      `ip_addresses` hash to resolve an IP address to target.
+      I(ip_addresses) hash to resolve an IP address to target.
   details:
     type: dict
     description:

plugins/modules/cloud/scaleway/scaleway_compute_private_network.py

@@ -0,0 +1,209 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Scaleway VPC management module
+#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = '''
+---
+module: scaleway_compute_private_network
+short_description: Scaleway compute - private network management
+version_added: 5.2.0
+author: Pascal MANGIN (@pastral)
+description:
+    - This module add or remove a private network to a compute instance
+      (U(https://developer.scaleway.com)).
+extends_documentation_fragment:
+- community.general.scaleway
+
+
+options:
+  state:
+    type: str
+    description:
+     - Indicate desired state of the VPC.
+    default: present
+    choices:
+      - present
+      - absent
+
+  project:
+    type: str
+    description:
+      - Project identifier.
+    required: true
+
+  region:
+    type: str
+    description:
+     - Scaleway region to use (for example C(par1)).
+    required: true
+    choices:
+      - ams1
+      - EMEA-NL-EVS
+      - par1
+      - EMEA-FR-PAR1
+      - par2
+      - EMEA-FR-PAR2
+      - waw1
+      - EMEA-PL-WAW1
+
+  compute_id:
+    type: str
+    description:
+    - ID of the compute instance (see M(community.general.scaleway_compute)).
+    required: true
+
+  private_network_id:
+    type: str
+    description:
+    - ID of the private network (see M(community.general.scaleway_private_network)).
+    required: true
+
+'''
+
+EXAMPLES = '''
+- name: Plug a VM to a private network
+  community.general.scaleway_compute_private_network:
+    project: '{{ scw_project }}'
+    state: present
+    region: par1
+    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
+    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
+  register: nicsvpc_creation_task
+
+- name: Unplug a VM from a private network
+  community.general.scaleway_compute_private_network:
+    project: '{{ scw_project }}'
+    state: absent
+    region: par1
+    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
+    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
+
+'''
+
+RETURN = '''
+scaleway_compute_private_network:
+    description: Information on the VPC.
+    returned: success when C(state=present)
+    type: dict
+    sample:
+        {
+            "created_at": "2022-01-15T11:11:12.676445Z",
+            "id": "12345678-f1e6-40ec-83e5-12345d67ed89",
+            "name": "network",
+            "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
+            "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
+            "tags": [
+                "tag1",
+                "tag2",
+                "tag3",
+                "tag4",
+                "tag5"
+            ],
+            "updated_at": "2022-01-15T11:12:04.624837Z",
+            "zone": "fr-par-2"
+        }
+'''
+from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway
+from ansible.module_utils.basic import AnsibleModule
+
+
+def get_nics_info(api, compute_id, private_network_id):
+
+    response = api.get('servers/' + compute_id + '/private_nics')
+    if not response.ok:
+        msg = "Error during get servers information: %s: '%s' (%s)" % (response.info['msg'], response.json['message'], response.json)
+        api.module.fail_json(msg=msg)
+
+    i = 0
+    list_nics = response.json['private_nics']
+
+    while i < len(list_nics):
+        if list_nics[i]['private_network_id'] == private_network_id:
+            return list_nics[i]
+        i += 1
+
+    return None
+
+
+def present_strategy(api, compute_id, private_network_id):
+
+    changed = False
+    nic = get_nics_info(api, compute_id, private_network_id)
+    if nic is not None:
+        return changed, nic
+
+    data = {"private_network_id": private_network_id}
+    changed = True
+    if api.module.check_mode:
+        return changed, {"status": "a private network would be add to a server"}
+
+    response = api.post(path='servers/' + compute_id + '/private_nics', data=data)
+
+    if not response.ok:
+        api.module.fail_json(msg='Error when adding a private network to a server [{0}: {1}]'.format(response.status_code, response.json))
+
+    return changed, response.json
+
+
+def absent_strategy(api, compute_id, private_network_id):
+
+    changed = False
+    nic = get_nics_info(api, compute_id, private_network_id)
+    if nic is None:
+        return changed, {}
+
+    changed = True
+    if api.module.check_mode:
+        return changed, {"status": "private network would be destroyed"}
+
+    response = api.delete('servers/' + compute_id + '/private_nics/' + nic['id'])
+
+    if not response.ok:
+        api.module.fail_json(msg='Error deleting private network from server [{0}: {1}]'.format(
+            response.status_code, response.json))
+
+    return changed, response.json
+
+
+def core(module):
+
+    compute_id = module.params['compute_id']
+    pn_id = module.params['private_network_id']
+
+    region = module.params["region"]
+    module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"]
+
+    api = Scaleway(module=module)
+    if module.params["state"] == "absent":
+        changed, summary = absent_strategy(api=api, compute_id=compute_id, private_network_id=pn_id)
+    else:
+        changed, summary = present_strategy(api=api, compute_id=compute_id, private_network_id=pn_id)
+    module.exit_json(changed=changed, scaleway_compute_private_network=summary)
+
+
+def main():
+    argument_spec = scaleway_argument_spec()
+    argument_spec.update(dict(
+        state=dict(default='present', choices=['absent', 'present']),
+        project=dict(required=True),
+        region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())),
+        compute_id=dict(required=True),
+        private_network_id=dict(required=True)
+    ))
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
+
+    core(module)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/cloud/scaleway/scaleway_user_data.py

@@ -35,7 +35,7 @@ options:
   user_data:
     type: dict
     description:
-    - User defined data. Typically used with `cloud-init`.
+    - User defined data. Typically used with C(cloud-init).
     - Pass your cloud-init script here as a string
     required: false
 

plugins/modules/cloud/xenserver/xenserver_guest.py

@@ -1207,7 +1207,7 @@ class XenServerVM(XenServerObject):
                 if (self.module.params['home_server'] and
                         (not self.vm_params['affinity'] or self.module.params['home_server'] != self.vm_params['affinity']['name_label'])):
 
-                    # Check existance only. Ignore return value.
+                    # Check existence only. Ignore return value.
                     get_object_ref(self.module, self.module.params['home_server'], uuid=None, obj_type="home server", fail=True,
                                    msg_prefix="VM check home_server: ")
 
@@ -1371,7 +1371,7 @@ class XenServerVM(XenServerObject):
                         disk_sr = disk_params.get('sr')
 
                         if disk_sr_uuid is not None or disk_sr is not None:
-                            # Check existance only. Ignore return value.
+                            # Check existence only. Ignore return value.
                             get_object_ref(self.module, disk_sr, disk_sr_uuid, obj_type="SR", fail=True,
                                            msg_prefix="VM check disks[%s]: " % position)
                         elif self.default_sr_ref == 'OpaqueRef:NULL':
@@ -1448,7 +1448,7 @@ class XenServerVM(XenServerObject):
 
                 if cdrom_type == "iso":
                     # Check if ISO exists.
-                    # Check existance only. Ignore return value.
+                    # Check existence only. Ignore return value.
                     get_object_ref(self.module, cdrom_iso_name, uuid=None, obj_type="ISO image", fail=True,
                                    msg_prefix="VM check cdrom.iso_name: ")
 
@@ -1496,7 +1496,7 @@ class XenServerVM(XenServerObject):
                         self.module.fail_json(msg="VM check networks[%s]: network name cannot be an empty string!" % position)
 
                     if network_name:
-                        # Check existance only. Ignore return value.
+                        # Check existence only. Ignore return value.
                         get_object_ref(self.module, network_name, uuid=None, obj_type="network", fail=True,
                                        msg_prefix="VM check networks[%s]: " % position)
 

plugins/modules/clustering/consul/consul.py

@@ -333,7 +333,7 @@ def add_service(module, service):
                      service_id=result.id,
                      service_name=result.name,
                      service_port=result.port,
-                     checks=[check.to_dict() for check in service.checks],
+                     checks=[check.to_dict() for check in service.checks()],
                      tags=result.tags)
 
 

plugins/modules/clustering/consul/consul_kv.py

@@ -28,14 +28,14 @@ author:
 options:
     state:
         description:
-          - The action to take with the supplied key and value. If the state is 'present' and `value` is set, the key
+          - The action to take with the supplied key and value. If the state is C(present) and I(value) is set, the key
-            contents will be set to the value supplied and `changed` will be set to `true` only if the value was
+            contents will be set to the value supplied and C(changed) will be set to C(true) only if the value was
-            different to the current contents. If the state is 'present' and `value` is not set, the existing value
+            different to the current contents. If the state is C(present) and I(value) is not set, the existing value
-            associated to the key will be returned. The state 'absent' will remove the key/value pair,
+            associated to the key will be returned. The state C(absent) will remove the key/value pair,
-            again 'changed' will be set to true only if the key actually existed
+            again C(changed) will be set to true only if the key actually existed
             prior to the removal. An attempt can be made to obtain or free the
-            lock associated with a key/value pair with the states 'acquire' or
+            lock associated with a key/value pair with the states C(acquire) or
-            'release' respectively. a valid session must be supplied to make the
+            C(release) respectively. a valid session must be supplied to make the
             attempt changed will be true if the attempt is successful, false
             otherwise.
         type: str

plugins/modules/files/ini_file.py

@@ -279,7 +279,7 @@ def do_ini(module, filename, section=None, option=None, values=None,
     # handling multiple instances of option=value when state is 'present' with/without exclusive is a bit complex
     #
     # 1. edit all lines where we have a option=value pair with a matching value in values[]
-    # 2. edit all the remaing lines where we have a matching option
+    # 2. edit all the remaining lines where we have a matching option
     # 3. delete remaining lines where we have a matching option
     # 4. insert missing option line(s) at the end of the section
 

plugins/modules/files/sapcar_extract.py

@@ -207,7 +207,7 @@ def main():
         changed = True
     else:
         changed = False
-        out = "allready unpacked"
+        out = "already unpacked"
 
     if remove:
         os.remove(path)

plugins/modules/identity/ipa/ipa_otpconfig.py

@@ -45,7 +45,7 @@ EXAMPLES = r'''
     ipa_user: admin
     ipa_pass: supersecret
 
-- name: Ensure the TOTP syncronization window is set to 86400 seconds
+- name: Ensure the TOTP synchronization window is set to 86400 seconds
   community.general.ipa_otpconfig:
     ipatokentotpsyncwindow: '86400'
     ipa_host: localhost
@@ -59,7 +59,7 @@ EXAMPLES = r'''
     ipa_user: admin
     ipa_pass: supersecret
 
-- name: Ensure the HOTP syncronization window is set to 100 hops
+- name: Ensure the HOTP synchronization window is set to 100 hops
   community.general.ipa_otpconfig:
     ipatokenhotpsyncwindow: '100'
     ipa_host: localhost

plugins/modules/identity/ipa/ipa_vault.py

@@ -63,7 +63,7 @@ options:
         type: str
     replace:
         description:
-        - Force replace the existant vault on IPA server.
+        - Force replace the existent vault on IPA server.
         type: bool
         default: False
         choices: ["True", "False"]

plugins/modules/identity/keycloak/keycloak_realm.py

@@ -163,7 +163,7 @@ options:
         aliases:
             - defaultGroups
         type: list
-        elements: dict
+        elements: str
     default_locale:
         description:
             - The realm default locale.
@@ -183,7 +183,7 @@ options:
         aliases:
             - defaultRoles
         type: list
-        elements: dict
+        elements: str
     default_signature_algorithm:
         description:
             - The realm default signature algorithm.
@@ -622,10 +622,10 @@ def main():
         client_authentication_flow=dict(type='str', aliases=['clientAuthenticationFlow']),
         client_scope_mappings=dict(type='dict', aliases=['clientScopeMappings']),
         default_default_client_scopes=dict(type='list', elements='str', aliases=['defaultDefaultClientScopes']),
-        default_groups=dict(type='list', elements='dict', aliases=['defaultGroups']),
+        default_groups=dict(type='list', elements='str', aliases=['defaultGroups']),
         default_locale=dict(type='str', aliases=['defaultLocale']),
         default_optional_client_scopes=dict(type='list', elements='str', aliases=['defaultOptionalClientScopes']),
-        default_roles=dict(type='list', elements='dict', aliases=['defaultRoles']),
+        default_roles=dict(type='list', elements='str', aliases=['defaultRoles']),
         default_signature_algorithm=dict(type='str', aliases=['defaultSignatureAlgorithm']),
         direct_grant_flow=dict(type='str', aliases=['directGrantFlow']),
         display_name=dict(type='str', aliases=['displayName']),

plugins/modules/identity/keycloak/keycloak_realm_info.py

@@ -64,7 +64,7 @@ msg:
 
 realm_info:
     description:
-        - Representation of the realm public infomation.
+        - Representation of the realm public information.
     returned: always
     type: dict
     contains:

plugins/modules/monitoring/datadog/datadog_event.py

@@ -20,7 +20,7 @@ description:
 - "Allows to post events to Datadog (www.datadoghq.com) service."
 - "Uses http://docs.datadoghq.com/api/#events API."
 author:
-- "Artūras `arturaz` Šlajus (@arturaz)"
+- "Artūras 'arturaz' Šlajus (@arturaz)"
 - "Naoya Nakazawa (@n0ts)"
 options:
     api_key:

plugins/modules/net_tools/haproxy.py

@@ -99,7 +99,7 @@ options:
   weight:
     description:
       - The value passed in argument.
-      - If the value ends with the `%` sign, then the new weight will be
+      - If the value ends with the C(%) sign, then the new weight will be
         relative to the initially configured weight.
       - Relative weights are only permitted between 0 and 100% and absolute
         weights are permitted between 0 and 256.

plugins/modules/net_tools/nmcli.py

@@ -45,8 +45,8 @@ options:
             - The interface to bind the connection to.
             - The connection will only be applicable to this interface name.
             - A special value of C('*') can be used for interface-independent connections.
-            - The ifname argument is mandatory for all connection types except bond, team, bridge and vlan.
+            - The ifname argument is mandatory for all connection types except bond, team, bridge, vlan and vpn.
-            - This parameter defaults to C(conn_name) when left unset.
+            - This parameter defaults to C(conn_name) when left unset for all connection types except vpn that removes it.
         type: str
     type:
         description:
@@ -55,10 +55,11 @@ options:
             - Type C(generic) is added in Ansible 2.5.
             - Type C(infiniband) is added in community.general 2.0.0.
             - Type C(gsm) is added in community.general 3.7.0.
-            - Type C(wireguard) is added in community.general 4.3.0
+            - Type C(wireguard) is added in community.general 4.3.0.
+            - Type C(vpn) is added in community.general 5.1.0.
         type: str
         choices: [ bond, bond-slave, bridge, bridge-slave, dummy, ethernet, generic, gre, infiniband, ipip, sit, team, team-slave, vlan, vxlan, wifi, gsm,
-            wireguard ]
+            wireguard, vpn ]
     mode:
         description:
             - This is the type of device or network connection that you wish to create for a bond or bridge.
@@ -157,8 +158,8 @@ options:
         version_added: 2.0.0
     dns4:
         description:
-            - A list of up to 3 dns servers.
+            - A list of up to 3 DNS servers.
-            - IPv4 format e.g. to add two IPv4 DNS server addresses, use C(192.0.2.53 198.51.100.53).
+            - The entries must be IPv4 addresses, for example C(192.0.2.53).
         elements: str
         type: list
     dns4_search:
@@ -255,8 +256,8 @@ options:
         version_added: 4.4.0
     dns6:
         description:
-            - A list of up to 3 dns servers.
+            - A list of up to 3 DNS servers.
-            - IPv6 format e.g. to add two IPv6 DNS server addresses, use C(2001:4860:4860::8888 2001:4860:4860::8844).
+            - The entries must be IPv6 addresses, for example C(2001:4860:4860::8888).
         elements: str
         type: list
     dns6_search:
@@ -905,6 +906,58 @@ options:
                 description: C(NMSettingSecretFlags) indicating how to handle the I(wireguard.private-key) property.
                 type: int
                 choices: [ 0, 1, 2 ]
+    vpn:
+        description:
+            - Configuration of a VPN connection (PPTP and L2TP).
+            - In order to use L2TP you need to be sure that C(network-manager-l2tp) - and C(network-manager-l2tp-gnome)
+                if host has UI - are installed on the host.
+        type: dict
+        version_added: 5.1.0
+        suboptions:
+            permissions:
+                description: User that will have permission to use the connection.
+                type: str
+                required: true
+            service-type:
+                description: This defines the service type of connection.
+                type: str
+                required: true
+                choices: [ pptp, l2tp ]
+            gateway:
+                description: The gateway to connection. It can be an IP address (for example C(192.0.2.1))
+                    or a FQDN address (for example C(vpn.example.com)).
+                type: str
+                required: true
+            password-flags:
+                description:
+                    - NMSettingSecretFlags indicating how to handle the I(password) property.
+                    - 'Following choices are allowed:
+                      C(0) B(NONE): The system is responsible for providing and storing this secret (default);
+                      C(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be
+                           asked to retrieve it;
+                      C(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed;
+                      C(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required
+                           (some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.'
+                type: int
+                choices: [ 0, 1, 2 , 4 ]
+                default: 0
+            user:
+                description: Username provided by VPN administrator.
+                type: str
+                required: true
+            ipsec-enabled:
+                description:
+                    - Enable or disable IPSec tunnel to L2TP host.
+                    - This option is need when C(service-type) is C(l2tp).
+                type: bool
+                choices: [ yes, no ]
+            ipsec-psk:
+                description:
+                    - The pre-shared key in base64 encoding.
+                    - >
+                      You can encode using this Ansible jinja2 expression: C("0s{{ '[YOUR PRE-SHARED KEY]' | ansible.builtin.b64encode }}").
+                    - This is only used when I(ipsec-enabled=true).
+                type: str
 '''
 
 EXAMPLES = r'''
@@ -1288,6 +1341,23 @@ EXAMPLES = r'''
     autoconnect: true
     state: present
 
+- name: >-
+    Create a VPN L2TP connection for ansible_user to connect on vpn.example.com
+    authenticating with user 'brittany' and pre-shared key as 'Brittany123'
+  community.general.nmcli:
+    type: vpn
+    conn_name: my-vpn-connection
+    vpn:
+        permissions: "{{ ansible_user }}"
+        service-type: l2tp
+        gateway: vpn.example.com
+        password-flags: 2
+        user: brittany
+        ipsec-enabled: true
+        ipsec-psk: "0s{{ 'Brittany123' | ansible.builtin.b64encode }}"
+    autoconnect: false
+    state: present
+
 '''
 
 RETURN = r"""#
@@ -1404,6 +1474,7 @@ class Nmcli(object):
         self.wifi_sec = module.params['wifi_sec']
         self.gsm = module.params['gsm']
         self.wireguard = module.params['wireguard']
+        self.vpn = module.params['vpn']
 
         if self.method4:
             self.ipv4_method = self.method4
@@ -1430,7 +1501,7 @@ class Nmcli(object):
         if self._hairpin is None:
             self.module.deprecate(
                 "Parameter 'hairpin' default value will change from true to false in community.general 7.0.0. "
-                "Set the value explicitly to supress this warning.",
+                "Set the value explicitly to suppress this warning.",
                 version='7.0.0', collection_name='community.general',
             )
             # Should be False in 7.0.0 but then that should be in argument_specs
@@ -1592,6 +1663,29 @@ class Nmcli(object):
                     options.update({
                         'wireguard.%s' % name: value,
                     })
+        elif self.type == 'vpn':
+            if self.vpn:
+                vpn_data_values = ''
+                for name, value in self.vpn.items():
+                    if name == 'service-type':
+                        options.update({
+                            'vpn-type': value,
+                        })
+                    elif name == 'permissions':
+                        options.update({
+                            'connection.permissions': value,
+                        })
+                    else:
+                        if vpn_data_values != '':
+                            vpn_data_values += ', '
+
+                        if isinstance(value, bool):
+                            value = self.bool_to_string(value)
+
+                        vpn_data_values += '%s=%s' % (name, value)
+                    options.update({
+                        'vpn.data': vpn_data_values,
+                    })
         # Convert settings values based on the situation.
         for setting, value in options.items():
             setting_type = self.settings_type(setting)
@@ -1742,7 +1836,10 @@ class Nmcli(object):
 
     @staticmethod
     def list_to_string(lst):
-        return ",".join(lst or [""])
+        if lst is None:
+            return None
+        else:
+            return ",".join(lst)
 
     @staticmethod
     def settings_type(setting):
@@ -1832,6 +1929,10 @@ class Nmcli(object):
             'connection.interface-name': ifname,
         }
 
+        # VPN doesn't need an interface but if sended it must be a valid interface.
+        if self.type == 'vpn' and self.ifname is None:
+            del options['connection.interface-name']
+
         options.update(self.connection_options())
 
         # Constructing the command.
@@ -1997,6 +2098,9 @@ class Nmcli(object):
                     current_value = current_value.strip('"')
                 if key == self.mtu_setting and self.mtu is None:
                     self.mtu = 0
+                if key == 'vpn.data':
+                    current_value = list(map(str.strip, current_value.split(',')))
+                    value = list(map(str.strip, value.split(',')))
             else:
                 # parameter does not exist
                 current_value = None
@@ -2025,6 +2129,10 @@ class Nmcli(object):
             'connection.interface-name': self.ifname,
         }
 
+        # VPN doesn't need an interface but if sended it must be a valid interface.
+        if self.type == 'vpn' and self.ifname is None:
+            del options['connection.interface-name']
+
         if not self.type:
             current_con_type = self.show_connection().get('connection.type')
             if current_con_type:
@@ -2064,6 +2172,7 @@ def main():
                           'wifi',
                           'gsm',
                           'wireguard',
+                          'vpn',
                       ]),
             ip4=dict(type='list', elements='str'),
             gw4=dict(type='str'),
@@ -2163,6 +2272,7 @@ def main():
             wifi_sec=dict(type='dict', no_log=True),
             gsm=dict(type='dict'),
             wireguard=dict(type='dict'),
+            vpn=dict(type='dict'),
         ),
         mutually_exclusive=[['never_default4', 'gw4'],
                             ['routes4_extended', 'routes4'],

plugins/modules/packaging/language/ansible_galaxy_install.py

@@ -226,7 +226,7 @@ class AnsibleGalaxyInstall(CmdModuleHelper):
     check_rc = True
 
     def _get_ansible_galaxy_version(self):
-        ansible_galaxy = self.module.get_bin_path("ansible-galaxy", required=True)
+        ansible_galaxy = self.get_bin_path("ansible-galaxy", required=True)
         dummy, out, dummy = self.module.run_command([ansible_galaxy, "--version"], check_rc=True)
         line = out.splitlines()[0]
         match = self._RE_GALAXY_VERSION.match(line)
@@ -242,7 +242,7 @@ class AnsibleGalaxyInstall(CmdModuleHelper):
             self.module.deprecate(
                 "Support for Ansible 2.9 and ansible-base 2.10 is being deprecated. "
                 "At the same time support for them is ended, also the ack_ansible29 option will be removed. "
-                "Upgrading is strongly recommended, or set 'ack_min_ansiblecore211' to supress this message.",
+                "Upgrading is strongly recommended, or set 'ack_min_ansiblecore211' to suppress this message.",
                 version="8.0.0",
                 collection_name="community.general",
             )
@@ -302,9 +302,9 @@ class AnsibleGalaxyInstall(CmdModuleHelper):
         self.vars.set("new_roles", {})
         self.vars.set("ansible29_change", False, change=True, output=False)
         if not (self.vars.ack_ansible29 or self.vars.ack_min_ansiblecore211):
-            self.module.warn("Ansible 2.9 or older: unable to retrieve lists of roles and collections already installed")
+            self.warn("Ansible 2.9 or older: unable to retrieve lists of roles and collections already installed")
             if self.vars.requirements_file is not None and self.vars.type == 'both':
-                self.module.warn("Ansible 2.9 or older: will install only roles from requirement files")
+                self.warn("Ansible 2.9 or older: will install only roles from requirement files")
 
     def _setup210plus(self):
         self.vars.set("new_collections", {}, change=True)

plugins/modules/packaging/language/composer.py

@@ -81,7 +81,7 @@ options:
     classmap_authoritative:
         description:
             - Autoload classes from classmap only.
-            - Implicitely enable optimize_autoloader.
+            - Implicitly enable optimize_autoloader.
             - Recommended especially for production, but can take a bit of time to run.
         default: false
         type: bool

plugins/modules/packaging/language/cpanm.py

@@ -134,7 +134,7 @@ EXAMPLES = '''
 import os
 
 from ansible_collections.community.general.plugins.module_utils.module_helper import (
-    ModuleHelper, CmdMixin, ArgFormat, ModuleHelperException
+    ModuleHelper, CmdMixin, ArgFormat
 )
 
 
@@ -171,10 +171,10 @@ class CPANMinus(CmdMixin, ModuleHelper):
         v = self.vars
         if v.mode == "compatibility":
             if v.name_check:
-                raise ModuleHelperException("Parameter name_check can only be used with mode=new")
+                self.do_raise("Parameter name_check can only be used with mode=new")
         else:
             if v.name and v.from_path:
-                raise ModuleHelperException("Parameters 'name' and 'from_path' are mutually exclusive when 'mode=new'")
+                self.do_raise("Parameters 'name' and 'from_path' are mutually exclusive when 'mode=new'")
 
         self.command = self.module.get_bin_path(v.executable if v.executable else self.command)
         self.vars.set("binary", self.command)
@@ -190,17 +190,16 @@ class CPANMinus(CmdMixin, ModuleHelper):
 
         return rc == 0
 
-    @staticmethod
+    def sanitize_pkg_spec_version(self, pkg_spec, version):
-    def sanitize_pkg_spec_version(pkg_spec, version):
         if version is None:
             return pkg_spec
         if pkg_spec.endswith('.tar.gz'):
-            raise ModuleHelperException(msg="parameter 'version' must not be used when installing from a file")
+            self.do_raise(msg="parameter 'version' must not be used when installing from a file")
         if os.path.isdir(pkg_spec):
-            raise ModuleHelperException(msg="parameter 'version' must not be used when installing from a directory")
+            self.do_raise(msg="parameter 'version' must not be used when installing from a directory")
         if pkg_spec.endswith('.git'):
             if version.startswith('~'):
-                raise ModuleHelperException(msg="operator '~' not allowed in version parameter when installing from git repository")
+                self.do_raise(msg="operator '~' not allowed in version parameter when installing from git repository")
             version = version if version.startswith('@') else '@' + version
         elif version[0] not in ('@', '~'):
             version = '~' + version
@@ -228,7 +227,7 @@ class CPANMinus(CmdMixin, ModuleHelper):
 
     def process_command_output(self, rc, out, err):
         if self.vars.mode == "compatibility" and rc != 0:
-            raise ModuleHelperException(msg=err, cmd=self.vars.cmd_args)
+            self.do_raise(msg=err, cmd=self.vars.cmd_args)
         return 'is up to date' not in err and 'is up to date' not in out
 
 

plugins/modules/packaging/language/pip_package_info.py

@@ -17,7 +17,7 @@ options:
   clients:
     description:
       - A list of the pip executables that will be used to get the packages.
-        They can be supplied with the full path or just the executable name, i.e `pip3.7`.
+        They can be supplied with the full path or just the executable name, for example C(pip3.7).
     default: ['pip']
     required: False
     type: list

plugins/modules/packaging/language/pipx.py

@@ -134,7 +134,7 @@ EXAMPLES = '''
 import json
 
 from ansible_collections.community.general.plugins.module_utils.module_helper import (
-    CmdStateModuleHelper, ArgFormat, ModuleHelperException
+    CmdStateModuleHelper, ArgFormat
 )
 from ansible.module_utils.facts.compat import ansible_facts
 
@@ -153,9 +153,8 @@ class PipX(CmdStateModuleHelper):
     module = dict(
         argument_spec=dict(
             state=dict(type='str', default='install',
-                       choices=[
+                       choices=['present', 'absent', 'install', 'uninstall', 'uninstall_all',
-                           'present', 'absent', 'install', 'uninstall', 'uninstall_all',
+                                'inject', 'upgrade', 'upgrade_all', 'reinstall', 'reinstall_all']),
-                           'inject', 'upgrade', 'upgrade_all', 'reinstall', 'reinstall_all']),
             name=dict(type='str'),
             source=dict(type='str'),
             install_deps=dict(type='bool', default=False),
@@ -247,8 +246,7 @@ class PipX(CmdStateModuleHelper):
 
     def state_upgrade(self):
         if not self.vars.application:
-            raise ModuleHelperException(
+            self.do_raise("Trying to upgrade a non-existent application: {0}".format(self.vars.name))
-                "Trying to upgrade a non-existent application: {0}".format(self.vars.name))
         if self.vars.force:
             self.changed = True
         if not self.module.check_mode:
@@ -262,16 +260,14 @@ class PipX(CmdStateModuleHelper):
 
     def state_reinstall(self):
         if not self.vars.application:
-            raise ModuleHelperException(
+            self.do_raise("Trying to reinstall a non-existent application: {0}".format(self.vars.name))
-                "Trying to reinstall a non-existent application: {0}".format(self.vars.name))
         self.changed = True
         if not self.module.check_mode:
             self.run_command(params=['state', 'name', 'python'])
 
     def state_inject(self):
         if not self.vars.application:
-            raise ModuleHelperException(
+            self.do_raise("Trying to inject packages into a non-existent application: {0}".format(self.vars.name))
-                "Trying to inject packages into a non-existent application: {0}".format(self.vars.name))
         if self.vars.force:
             self.changed = True
         if not self.module.check_mode:

plugins/modules/packaging/os/apk.py

@@ -62,8 +62,8 @@ options:
     type: bool
     default: no
 notes:
-  - '"name" and "upgrade" are mutually exclusive.'
+  - 'I(name) and I(upgrade) are mutually exclusive.'
-  - When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option.
+  - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the I(name) option.
 '''
 
 EXAMPLES = '''

plugins/modules/packaging/os/homebrew.py

@@ -35,7 +35,7 @@ options:
         elements: str
     path:
         description:
-            - "A ':' separated list of paths to search for 'brew' executable.
+            - "A C(:) separated list of paths to search for C(brew) executable.
               Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
               providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
         default: '/usr/local/bin:/opt/homebrew/bin'
@@ -70,8 +70,8 @@ options:
         elements: str
         version_added: '0.2.0'
 notes:
-  - When used with a `loop:` each package will be processed individually,
+  - When used with a C(loop:) each package will be processed individually,
-    it is much more efficient to pass the list directly to the `name` option.
+    it is much more efficient to pass the list directly to the I(name) option.
 '''
 
 EXAMPLES = '''

plugins/modules/packaging/os/openbsd_pkg.py

@@ -70,8 +70,8 @@ options:
         type: bool
         default: no
 notes:
-  - When used with a `loop:` each package will be processed individually,
+  - When used with a C(loop:) each package will be processed individually,
-    it is much more efficient to pass the list directly to the `name` option.
+    it is much more efficient to pass the list directly to the I(name) option.
 '''
 
 EXAMPLES = '''