Release 4.2.0.

* Add additional auth support to Gitlab (#705)

- removed unused imports from module_utils.gitlab
- fix bug in gitlab_project to check if avatar_path is provided

* add doc_fragment and argument_spec for gitlab auth

* doc fixes and remove avatar_path bug fix

* small doc changes, pass validate_certs to requests call

* update changelog

(cherry picked from commit 52ad0a5fbb)

Co-authored-by: Josh <josham@users.noreply.github.com>

.azure-pipelines/azure-pipelines.yml

@@ -206,14 +206,14 @@ stages:
         parameters:
           testFormat: devel/{0}
           targets:
-            - name: macOS 12.0
-              test: macos/12.0
+            - name: macOS 11.1
+              test: macos/11.1
             - name: RHEL 7.9
               test: rhel/7.9
             - name: RHEL 8.5
               test: rhel/8.5
-            - name: FreeBSD 12.3
-              test: freebsd/12.3
+            - name: FreeBSD 12.2
+              test: freebsd/12.2
             - name: FreeBSD 13.0
               test: freebsd/13.0
           groups:
@@ -324,6 +324,8 @@ stages:
           targets:
             - name: CentOS 6
               test: centos6
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 34
               test: fedora34
             - name: openSUSE 15 py3

.github/BOTMETA.yml

@@ -163,8 +163,10 @@ files:
     keywords: opennebula dynamic inventory script
   $inventories/proxmox.py:
     maintainers: $team_virt ilijamt
+  $inventories/xen_orchestra.py:
+    maintainers: shinuza
   $inventories/icinga2.py:
-    maintainers: BongoEADGC6
+    maintainers: bongoeadgc6
   $inventories/scaleway.py:
     maintainers: $team_scaleway
     labels: cloud scaleway
@@ -175,6 +177,8 @@ files:
     labels: lookups
   $lookups/cartesian.py: {}
   $lookups/chef_databag.py: {}
+  $lookups/collection_version.py:
+    maintainers: felixfontein
   $lookups/consul_kv.py: {}
   $lookups/credstash.py: {}
   $lookups/cyberarkpassword.py:
@@ -205,9 +209,6 @@ files:
   $lookups/manifold.py:
     maintainers: galanoff
     labels: manifold
-  $lookups/nios:
-    maintainers: $team_networking sganesh-infoblox
-    labels: infoblox networking
   $lookups/onepass:
     maintainers: samdoran
     labels: onepassword
@@ -220,8 +221,12 @@ files:
     maintainers: Akasurde
   $lookups/random_string.py:
     maintainers: Akasurde
+  $lookups/random_words.py:
+    maintainers: konstruktoid
   $lookups/redis.py:
     maintainers: $team_ansible_core jpmens
+  $lookups/revbitspss.py:
+    maintainers: RevBits
   $lookups/shelvefile.py: {}
   $lookups/tss.py:
     maintainers: amigus endlesstrax
@@ -253,9 +258,6 @@ files:
   $module_utils/module_helper.py:
     maintainers: russoz
     labels: module_helper
-  $module_utils/net_tools/nios/api.py:
-    maintainers: $team_networking sganesh-infoblox
-    labels: infoblox networking
   $module_utils/oracle/oci_utils.py:
     maintainers: $team_oracle
     labels: cloud
@@ -320,10 +322,6 @@ files:
   $modules/cloud/misc/proxmox_kvm.py:
     maintainers: helldorado
     ignore: skvidal
-  $modules/cloud/misc/proxmox_nic.py:
-    maintainers: Kogelvis
-  $modules/cloud/misc/proxmox_tasks_info:
-    maintainers: paginabianca
   $modules/cloud/misc/proxmox_template.py:
     maintainers: UnderGreen
     ignore: skvidal
@@ -481,11 +479,16 @@ files:
     maintainers: paginabianca
   $modules/database/misc/redis_data.py:
     maintainers: paginabianca
+  $modules/database/misc/redis_data_incr.py:
+    maintainers: paginabianca
   $modules/database/misc/riak.py:
     maintainers: drewkerrigan jsmartin
   $modules/database/mssql/mssql_db.py:
     maintainers: vedit Jmainguy kenichi-ogawa-1988
     labels: mssql_db
+  $modules/database/mssql/mssql_script.py:
+    maintainers: kbudde
+    labels: mssql_script
   $modules/database/saphana/hana_query.py:
     maintainers: rainerleber
   $modules/database/vertica/:
@@ -616,6 +619,8 @@ files:
     labels: cloudflare_dns
   $modules/net_tools/dnsimple.py:
     maintainers: drcapulet
+  $modules/net_tools/dnsimple_info.py:
+    maintainers: edhilgendorf
   $modules/net_tools/dnsmadeeasy.py:
     maintainers: briceburg
   $modules/net_tools/gandi_livedns.py:
@@ -651,31 +656,6 @@ files:
     maintainers: amasolov nerzhul
   $modules/net_tools/pritunl/:
     maintainers: Lowess
-  $modules/net_tools/nios/:
-    maintainers: $team_networking
-    labels: infoblox networking
-  $modules/net_tools/nios/nios_a_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_aaaa_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_cname_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_fixed_address.py:
-    maintainers: sjaiswal
-  $modules/net_tools/nios/nios_member.py:
-    maintainers: krisvasudevan
-  $modules/net_tools/nios/nios_mx_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_naptr_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_nsgroup.py:
-    maintainers: ebirn sjaiswal
-  $modules/net_tools/nios/nios_ptr_record.py:
-    maintainers: clementtrebuchet
-  $modules/net_tools/nios/nios_srv_record.py:
-    maintainers: brampling
-  $modules/net_tools/nios/nios_txt_record.py:
-    maintainers: coreywan
   $modules/net_tools/nmcli.py:
     maintainers: alcamie101
   $modules/net_tools/snmp_facts.py:
@@ -779,6 +759,8 @@ files:
     maintainers: evgkrsk
   $modules/packaging/os/copr.py:
     maintainers: schlupov
+  $modules/packaging/os/dnf_versionlock.py:
+    maintainers: moreda
   $modules/packaging/os/flatpak.py:
     maintainers: $team_flatpak
   $modules/packaging/os/flatpak_remote.py:
@@ -875,6 +857,9 @@ files:
   $modules/packaging/os/snap.py:
     maintainers: angristan vcarceler
     labels: snap
+  $modules/packaging/os/snap_alias.py:
+    maintainers: russoz
+    labels: snap
   $modules/packaging/os/sorcery.py:
     maintainers: vaygr
   $modules/packaging/os/svr4pkg.py:
@@ -918,10 +903,6 @@ files:
   $modules/remote_management/manageiq/:
     labels: manageiq
     maintainers: $team_manageiq
-  $modules/remote_management/manageiq/manageiq_alert_profiles.py:
-    maintainers: elad661
-  $modules/remote_management/manageiq/manageiq_alerts.py:
-    maintainers: elad661
   $modules/remote_management/manageiq/manageiq_group.py:
     maintainers: evertmulder
   $modules/remote_management/manageiq/manageiq_tenant.py:
@@ -972,6 +953,8 @@ files:
     maintainers: SamyCoenen
   $modules/source_control/gitlab/gitlab_user.py:
     maintainers: LennertMertens stgrace
+  $modules/source_control/gitlab/gitlab_branch.py:
+    maintainers: paytroff
   $modules/source_control/hg.py:
     maintainers: yeukhon
   $modules/storage/emc/emc_vnx_sg_member.py:
@@ -1196,6 +1179,8 @@ files:
     maintainers: inetfuture mattupstate
   $modules/web_infrastructure/taiga_issue.py:
     maintainers: lekum
+  $tests/a_module.py:
+    maintainers: felixfontein
 #########################
   tests/:
     labels: tests
@@ -1222,6 +1207,7 @@ macros:
   module_utils: plugins/module_utils
   modules: plugins/modules
   terminals: plugins/terminal
+  tests: plugins/test
   team_ansible_core:
   team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
@@ -1229,7 +1215,7 @@ macros:
   team_cyberark_conjur: jvanderhoof ryanprior
   team_e_spirit: MatrixCrawler getjack
   team_flatpak: JayKayy oolongbrothers
-  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii sh0shin nejch lgatellier
+  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii sh0shin
   team_hpux: bcoca davx8342
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht fxfitz justchris1
@@ -1242,7 +1228,7 @@ macros:
   team_opennebula: ilicmilan meerkampdvv rsmontero xorel nilsding
   team_oracle: manojmeda mross22 nalsaber
   team_purestorage: bannaych dnix101 genegr lionmax opslounge raekins sdodsley sile16
-  team_redfish: mraineri tomasg2012 xmadsen renxulei
+  team_redfish: mraineri tomasg2012 xmadsen renxulei rajeevkallur bhavya06
   team_rhn: FlossWare alikins barnabycourt vritant
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -62,6 +62,20 @@ body:
   validations:
     required: true
 
+- type: textarea
+  attributes:
+    label: Community.general Version
+    description: >-
+      Paste verbatim output from "ansible-galaxy collection list community.general"
+      between tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible-galaxy collection list community.general
+
+      ```
+  validations:
+    required: true
+
 - type: textarea
   attributes:
     label: Configuration

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -62,6 +62,20 @@ body:
   validations:
     required: false
 
+- type: textarea
+  attributes:
+    label: Community.general Version
+    description: >-
+      Paste verbatim output from "ansible-galaxy collection list community.general"
+      between tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible-galaxy collection list community.general
+
+      ```
+  validations:
+    required: true
+
 - type: textarea
   attributes:
     label: Configuration

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -21,7 +21,7 @@ body:
     placeholder: >-
       I am trying to do X with the collection from the main branch on GitHub and
       I think that implementing a feature Y would be very helpful for me and
-      every other user of ansible-core because of Z.
+      every other user of community.general because of Z.
   validations:
     required: true
 

.github/dependabot.yml

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

CONTRIBUTING.md

@@ -24,7 +24,7 @@ Also, consider taking up a valuable, reviewed, but abandoned pull request which
 
 * Try committing your changes with an informative but short commit message.
 * Do not squash your commits and force-push to your branch if not needed. Reviews of your pull request are much easier with individual commits to comprehend the pull request history. All commits of your pull request branch will be squashed into one commit by GitHub upon merge.
-* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the repository checkout.
+* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the respository checkout.
 * Make sure your PR includes a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#changelogs-how-to). (You must not include a fragment for new modules or new plugins, except for test and filter plugins. Also you shouldn't include one for docs-only changes. If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) )
 * Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed.
 
@@ -36,54 +36,6 @@ If you want to test a PR locally, refer to [our testing guide](https://github.co
 
 If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.
 
-## Run sanity, unit or integration tests locally
-
-You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is:
-
-```.bash
-mkdir -p ~/dev/ansible_collections/community
-git clone https://github.com/ansible-collections/community.general.git ~/dev/ansible_collections/community/general
-cd ~/dev/ansible_collections/community/general
-```
-
-Then you can run `ansible-test` (which is a part of [ansible-core](https://pypi.org/project/ansible-core/)) inside the checkout. The following example commands expect that you have installed Docker or Podman. Note that Podman has only been supported by more recent ansible-core releases. If you are using Docker, the following will work with Ansible 2.9+.
-
-The following commands show how to run sanity tests:
-
-```.bash
-# Run sanity tests for all files in the collection:
-ansible-test sanity --docker -v
-
-# Run sanity tests for the given files and directories:
-ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/
-```
-
-The following commands show how to run unit tests:
-
-```.bash
-# Run all unit tests:
-ansible-test units --docker -v
-
-# Run all unit tests for one Python version (a lot faster):
-ansible-test units --docker -v --python 3.8
-
-# Run a specific unit test (for the nmcli module) for one Python version:
-ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools/test_nmcli.py
-```
-
-The following commands show how to run integration tests:
-
-```.bash
-# Run integration tests for the interfaces_files module in a Docker container using the
-# fedora35 operating system image (the supported images depend on your ansible-core version):
-ansible-test integration --docker fedora35 -v interfaces_file
-
-# Run integration tests for the flattened lookup **without any isolation**:
-ansible-test integration -v lookup_flattened
-```
-
-If you are unsure about the integration test target name for a module or plugin, you can take a look in `tests/integration/targets/`. Tests for plugins have the plugin type prepended.
-
 ## Creating new modules or plugins
 
 Creating new modules and plugins requires a bit more work than other Pull Requests.

README.md

@@ -1,6 +1,6 @@
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-3)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-4)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 
 This repository contains the `community.general` Ansible Collection. The collection is a part of the Ansible package and includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
@@ -64,13 +64,13 @@ We are actively accepting new contributors.
 
 All types of contributions are very welcome.
 
-You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md)!
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md)!
 
-The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/stable-4/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
 
 You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
 
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md).
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md).
 
 ### Running tests
 
@@ -80,7 +80,7 @@ See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collectio
 
 To learn how to maintain / become a maintainer of this collection, refer to:
 
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
+* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-4/commit-rights.md).
 * [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
 
 It is necessary for maintainers of this collection to be subscribed to:
@@ -108,7 +108,7 @@ See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/ma
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-3/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-4/CHANGELOG.rst).
 
 ## Roadmap
 

docs/docsite/extra-docs.yml

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

docs/docsite/rst/test_guide.rst

@@ -0,0 +1,28 @@
+.. _ansible_collections.community.general.docsite.test_guide:
+
+community.general Test (Plugin) Guide
+=====================================
+
+The :ref:`community.general collection <plugins_in_community.general>` offers currently one test plugin.
+
+.. contents:: Topics
+
+Feature Tests
+-------------
+
+The ``a_module`` test allows to check whether a given string refers to an existing module or action plugin. This can be useful in roles, which can use this to ensure that required modules are present ahead of time.
+
+.. code-block:: yaml+jinja
+
+    - name: Make sure that community.aws.route53 is available
+      assert:
+        that:
+          - >
+            'community.aws.route53' is community.general.a_module
+
+    - name: Make sure that community.general.does_not_exist is not a module or action plugin
+      assert:
+        that:
+          - "'community.general.does_not_exist' is not community.general.a_module"
+
+.. versionadded:: 4.0.0

galaxy.yml

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

meta/runtime.yml

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

plugins/callback/elastic.py

@@ -226,18 +226,15 @@ class ElasticSource(object):
 
         message = "success"
         status = "success"
+        enriched_error_message = None
         if host_data.status == 'included':
             rc = 0
         else:
             res = host_data.result._result
             rc = res.get('rc', 0)
             if host_data.status == 'failed':
-                if res.get('exception') is not None:
-                    message = res['exception'].strip().split('\n')[-1]
-                elif 'msg' in res:
-                    message = res['msg']
-                else:
-                    message = 'failed'
+                message = self.get_error_message(res)
+                enriched_error_message = self.enrich_error_message(res)
                 status = "failure"
             elif host_data.status == 'skipped':
                 if 'skip_reason' in res:
@@ -259,7 +256,7 @@ class ElasticSource(object):
                                   "ansible.task.host.status": host_data.status}) as span:
             span.outcome = status
             if 'failure' in status:
-                exception = AnsibleRuntimeError(message="{0}: {1} failed with error message {2}".format(task_data.action, name, message))
+                exception = AnsibleRuntimeError(message="{0}: {1} failed with error message {2}".format(task_data.action, name, enriched_error_message))
                 apm_cli.capture_exception(exc_info=(type(exception), exception, exception.__traceback__), handled=True)
 
     def init_apm_client(self, apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key):
@@ -272,6 +269,24 @@ class ElasticSource(object):
                           use_elastic_traceparent_header=True,
                           debug=True)
 
+    @staticmethod
+    def get_error_message(result):
+        if result.get('exception') is not None:
+            return ElasticSource._last_line(result['exception'])
+        return result.get('msg', 'failed')
+
+    @staticmethod
+    def _last_line(text):
+        lines = text.strip().split('\n')
+        return lines[-1]
+
+    @staticmethod
+    def enrich_error_message(result):
+        message = result.get('msg', 'failed')
+        exception = result.get('exception')
+        stderr = result.get('stderr')
+        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
+
 
 class CallbackModule(CallbackBase):
     """

plugins/callback/mail.py

@@ -100,21 +100,28 @@ class CallbackModule(CallbackBase):
 
         smtp = smtplib.SMTP(self.smtphost, port=self.smtpport)
 
-        content = 'From: %s\n' % self.sender
-        content += 'To: %s\n' % self.to
-        if self.cc:
-            content += 'Cc: %s\n' % self.cc
-        content += 'Subject: %s\n\n' % subject.strip()
-        content += body
+        b_sender = to_bytes(self.sender)
+        b_to = to_bytes(self.to)
+        b_cc = to_bytes(self.cc)
+        b_bcc = to_bytes(self.bcc)
+        b_subject = to_bytes(subject)
+        b_body = to_bytes(body)
 
-        addresses = self.to.split(',')
+        b_content = b'From: %s\n' % b_sender
+        b_content += b'To: %s\n' % b_to
         if self.cc:
-            addresses += self.cc.split(',')
+            b_content += b'Cc: %s\n' % b_cc
+        b_content += b'Subject: %s\n\n' % b_subject
+        b_content += b_body
+
+        b_addresses = b_to.split(b',')
+        if self.cc:
+            b_addresses += b_cc.split(b',')
         if self.bcc:
-            addresses += self.bcc.split(',')
+            b_addresses += b_bcc.split(b',')
 
-        for address in addresses:
-            smtp.sendmail(self.sender, address, to_bytes(content))
+        for b_address in b_addresses:
+            smtp.sendmail(b_sender, b_address, b_content)
 
         smtp.quit()
 

plugins/callback/opentelemetry.py

@@ -80,6 +80,7 @@ from os.path import basename
 
 from ansible.errors import AnsibleError
 from ansible.module_utils.six import raise_from
+from ansible.module_utils.six.moves.urllib.parse import urlparse
 from ansible.plugins.callback import CallbackBase
 
 try:
@@ -91,8 +92,6 @@ try:
     from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
     from opentelemetry.sdk.trace import TracerProvider
     from opentelemetry.sdk.trace.export import (
-        ConsoleSpanExporter,
-        SimpleSpanProcessor,
         BatchSpanProcessor
     )
     from opentelemetry.util._time import _time_ns
@@ -180,7 +179,7 @@ class OpenTelemetrySource(object):
         args = None
 
         if not task.no_log and not hide_task_arguments:
-            args = ', '.join(('%s=%s' % a for a in task.args.items()))
+            args = task.args
 
         tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
 
@@ -247,34 +246,45 @@ class OpenTelemetrySource(object):
         name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
 
         message = 'success'
+        res = {}
+        rc = 0
         status = Status(status_code=StatusCode.OK)
-        if host_data.status == 'included':
-            rc = 0
-        else:
-            res = host_data.result._result
-            rc = res.get('rc', 0)
-            if host_data.status == 'failed':
+        if host_data.status != 'included':
+            # Support loops
+            if 'results' in host_data.result._result:
+                if host_data.status == 'failed':
+                    message = self.get_error_message_from_results(host_data.result._result['results'], task_data.action)
+                    enriched_error_message = self.enrich_error_message_from_results(host_data.result._result['results'], task_data.action)
+            else:
+                res = host_data.result._result
+                rc = res.get('rc', 0)
                 message = self.get_error_message(res)
+                enriched_error_message = self.enrich_error_message(res)
+
+            if host_data.status == 'failed':
                 status = Status(status_code=StatusCode.ERROR, description=message)
                 # Record an exception with the task message
-                span.record_exception(BaseException(self.enrich_error_message(res)))
+                span.record_exception(BaseException(enriched_error_message))
             elif host_data.status == 'skipped':
-                if 'skip_reason' in res:
-                    message = res['skip_reason']
-                else:
-                    message = 'skipped'
+                message = res['skip_reason'] if 'skip_reason' in res else 'skipped'
                 status = Status(status_code=StatusCode.UNSET)
             elif host_data.status == 'ignored':
                 status = Status(status_code=StatusCode.UNSET)
 
         span.set_status(status)
-        self.set_span_attribute(span, "ansible.task.args", task_data.args)
+        if isinstance(task_data.args, dict) and "gather_facts" not in task_data.action:
+            names = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.keys())
+            values = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.values())
+            self.set_span_attribute(span, ("ansible.task.args.name"), names)
+            self.set_span_attribute(span, ("ansible.task.args.value"), values)
         self.set_span_attribute(span, "ansible.task.module", task_data.action)
         self.set_span_attribute(span, "ansible.task.message", message)
         self.set_span_attribute(span, "ansible.task.name", name)
         self.set_span_attribute(span, "ansible.task.result", rc)
         self.set_span_attribute(span, "ansible.task.host.name", host_data.name)
         self.set_span_attribute(span, "ansible.task.host.status", host_data.status)
+        # This will allow to enrich the service map
+        self.add_attributes_for_service_map_if_possible(span, task_data)
         span.end(end_time=host_data.finish)
 
     def set_span_attribute(self, span, attributeName, attributeValue):
@@ -286,12 +296,64 @@ class OpenTelemetrySource(object):
             if attributeValue is not None:
                 span.set_attribute(attributeName, attributeValue)
 
+    def add_attributes_for_service_map_if_possible(self, span, task_data):
+        """Update the span attributes with the service that the task interacted with, if possible."""
+
+        redacted_url = self.parse_and_redact_url_if_possible(task_data.args)
+        if redacted_url:
+            self.set_span_attribute(span, "http.url", redacted_url.geturl())
+
+    @staticmethod
+    def parse_and_redact_url_if_possible(args):
+        """Parse and redact the url, if possible."""
+
+        try:
+            parsed_url = urlparse(OpenTelemetrySource.url_from_args(args))
+        except ValueError:
+            return None
+
+        if OpenTelemetrySource.is_valid_url(parsed_url):
+            return OpenTelemetrySource.redact_user_password(parsed_url)
+        return None
+
+    @staticmethod
+    def url_from_args(args):
+        # the order matters
+        url_args = ("url", "api_url", "baseurl", "repo", "server_url", "chart_repo_url")
+        for arg in url_args:
+            if args.get(arg):
+                return args.get(arg)
+        return ""
+
+    @staticmethod
+    def redact_user_password(url):
+        return url._replace(netloc=url.hostname) if url.password else url
+
+    @staticmethod
+    def is_valid_url(url):
+        if all([url.scheme, url.netloc, url.hostname]):
+            return "{{" not in url.hostname
+        return False
+
+    @staticmethod
+    def transform_ansible_unicode_to_str(value):
+        parsed_url = urlparse(str(value))
+        if OpenTelemetrySource.is_valid_url(parsed_url):
+            return OpenTelemetrySource.redact_user_password(parsed_url).geturl()
+        return str(value)
+
     @staticmethod
     def get_error_message(result):
         if result.get('exception') is not None:
             return OpenTelemetrySource._last_line(result['exception'])
         return result.get('msg', 'failed')
 
+    @staticmethod
+    def get_error_message_from_results(results, action):
+        for result in results:
+            if result.get('failed', False):
+                return ('{0}({1}) - {2}').format(action, result.get('item', 'none'), OpenTelemetrySource.get_error_message(result))
+
     @staticmethod
     def _last_line(text):
         lines = text.strip().split('\n')
@@ -304,6 +366,14 @@ class OpenTelemetrySource(object):
         stderr = result.get('stderr')
         return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
 
+    @staticmethod
+    def enrich_error_message_from_results(results, action):
+        message = ""
+        for result in results:
+            if result.get('failed', False):
+                message = ('{0}({1}) - {2}\n{3}').format(action, result.get('item', 'none'), OpenTelemetrySource.enrich_error_message(result), message)
+        return message
+
 
 class CallbackModule(CallbackBase):
     """

plugins/callback/say.py

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

plugins/connection/jail.py

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

plugins/connection/lxd.py

@@ -43,10 +43,10 @@ DOCUMENTATION = '''
 '''
 
 import os
+from distutils.spawn import find_executable
 from subprocess import Popen, PIPE
 
 from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
-from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.connection import ConnectionBase
 
@@ -62,9 +62,9 @@ class Connection(ConnectionBase):
         super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
 
         self._host = self._play_context.remote_addr
-        try:
-            self._lxc_cmd = get_bin_path("lxc")
-        except ValueError:
+        self._lxc_cmd = find_executable("lxc")
+
+        if not self._lxc_cmd:
             raise AnsibleError("lxc command not found in PATH")
 
         if self._play_context.remote_user is not None and self._play_context.remote_user != 'root':

plugins/connection/zone.py

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

plugins/doc_fragments/_netapp.py

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

plugins/doc_fragments/bitbucket.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Standard documentation fragment
+    DOCUMENTATION = r'''
+options:
+  client_id:
+    description:
+      - The OAuth consumer key.
+      - If not set the environment variable C(BITBUCKET_CLIENT_ID) will be used.
+    type: str
+  client_secret:
+    description:
+      - The OAuth consumer secret.
+      - If not set the environment variable C(BITBUCKET_CLIENT_SECRET) will be used.
+    type: str
+  user:
+    description:
+      - The username.
+      - If not set the environment variable C(BITBUCKET_USERNAME) will be used.
+    type: str
+    version_added: 4.0.0
+  password:
+    description:
+      - The App password.
+      - If not set the environment variable C(BITBUCKET_PASSWORD) will be used.
+    type: str
+    version_added: 4.0.0
+notes:
+  - Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
+  - Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
+  - If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
+'''

plugins/doc_fragments/gitlab.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Standard files documentation fragment
+    DOCUMENTATION = r'''
+requirements:
+  - requests (Python library U(https://pypi.org/project/requests/))
+
+options:
+  api_token:
+    description:
+      - GitLab access token with API permissions.
+    type: str
+  api_oauth_token:
+    description:
+      - GitLab OAuth token for logging in.
+    type: str
+    version_added: 4.2.0
+  api_job_token:
+    description:
+      - GitLab CI job token for logging in.
+    type: str
+    version_added: 4.2.0
+'''

plugins/doc_fragments/nios.py

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

plugins/filter/version_sort.py

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

plugins/inventory/cobbler.py

@@ -68,6 +68,7 @@ user: ansible-tester
 password: secure
 '''
 
+from distutils.version import LooseVersion
 import socket
 
 from ansible.errors import AnsibleError

plugins/inventory/icinga2.py

@@ -35,13 +35,23 @@ DOCUMENTATION = '''
         type: string
         required: true
       host_filter:
-        description: An Icinga2 API valid host filter.
+        description:
+          - An Icinga2 API valid host filter. Leave blank for no filtering
         type: string
         required: false
       validate_certs:
         description: Enables or disables SSL certificate verification.
         type: boolean
         default: true
+      inventory_attr:
+        description:
+          - Allows the override of the inventory name based on different attributes.
+          - This allows for changing the way limits are used.
+          - The current default, C(address), is sometimes not unique or present. We recommend to use C(name) instead.
+        type: string
+        default: address
+        choices: ['name', 'display_name', 'address']
+        version_added: 4.2.0
 '''
 
 EXAMPLES = r'''
@@ -52,6 +62,7 @@ user: ansible
 password: secure
 host_filter: \"linux-servers\" in host.groups
 validate_certs: false
+inventory_attr: name
 '''
 
 import json
@@ -59,6 +70,7 @@ import json
 from ansible.errors import AnsibleParserError
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 from ansible.module_utils.urls import open_url
+from ansible.module_utils.six.moves.urllib.error import HTTPError
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable):
@@ -76,6 +88,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         self.icinga2_password = None
         self.ssl_verify = None
         self.host_filter = None
+        self.inventory_attr = None
 
         self.cache_key = None
         self.use_cache = None
@@ -114,9 +127,21 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         if data is not None:
             request_args['data'] = json.dumps(data)
         self.display.vvv("Request Args: %s" % request_args)
-        response = open_url(request_url, **request_args)
+        try:
+            response = open_url(request_url, **request_args)
+        except HTTPError as e:
+            try:
+                error_body = json.loads(e.read().decode())
+                self.display.vvv("Error returned: {0}".format(error_body))
+            except Exception:
+                error_body = {"status": None}
+            if e.code == 404 and error_body.get('status') == "No objects found.":
+                raise AnsibleParserError("Host filter returned no data. Please confirm your host_filter value is valid")
+            raise AnsibleParserError("Unexpected data returned: {0} -- {1}".format(e, error_body))
+
         response_body = response.read()
         json_data = json.loads(response_body.decode('utf-8'))
+        self.display.vvv("Returned Data: %s" % json.dumps(json_data, indent=4, sort_keys=True))
         if 200 <= response.status <= 299:
             return json_data
         if response.status == 404 and json_data['status'] == "No objects found.":
@@ -155,7 +180,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         """Query for all hosts """
         self.display.vvv("Querying Icinga2 for inventory")
         query_args = {
-            "attrs": ["address", "state_type", "state", "groups"],
+            "attrs": ["address", "display_name", "state_type", "state", "groups"],
         }
         if self.host_filter is not None:
             query_args['host_filter'] = self.host_filter
@@ -177,24 +202,35 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         """Convert Icinga2 API data to JSON format for Ansible"""
         groups_dict = {"_meta": {"hostvars": {}}}
         for entry in json_data:
-            host_name = entry['name']
             host_attrs = entry['attrs']
+            if self.inventory_attr == "name":
+                host_name = entry.get('name')
+            if self.inventory_attr == "address":
+                # When looking for address for inventory, if missing fallback to object name
+                if host_attrs.get('address', '') != '':
+                    host_name = host_attrs.get('address')
+                else:
+                    host_name = entry.get('name')
+            if self.inventory_attr == "display_name":
+                host_name = host_attrs.get('display_name')
             if host_attrs['state'] == 0:
                 host_attrs['state'] = 'on'
             else:
                 host_attrs['state'] = 'off'
-            host_groups = host_attrs['groups']
-            host_addr = host_attrs['address']
-            self.inventory.add_host(host_addr)
+            host_groups = host_attrs.get('groups')
+            self.inventory.add_host(host_name)
             for group in host_groups:
                 if group not in self.inventory.groups.keys():
                     self.inventory.add_group(group)
-                self.inventory.add_child(group, host_addr)
-            self.inventory.set_variable(host_addr, 'address', host_addr)
-            self.inventory.set_variable(host_addr, 'hostname', host_name)
-            self.inventory.set_variable(host_addr, 'state',
+                self.inventory.add_child(group, host_name)
+            # If the address attribute is populated, override ansible_host with the value
+            if host_attrs.get('address') != '':
+                self.inventory.set_variable(host_name, 'ansible_host', host_attrs.get('address'))
+            self.inventory.set_variable(host_name, 'hostname', entry.get('name'))
+            self.inventory.set_variable(host_name, 'display_name', host_attrs.get('display_name'))
+            self.inventory.set_variable(host_name, 'state',
                                         host_attrs['state'])
-            self.inventory.set_variable(host_addr, 'state_type',
+            self.inventory.set_variable(host_name, 'state_type',
                                         host_attrs['state_type'])
         return groups_dict
 
@@ -211,6 +247,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
         self.icinga2_password = self.get_option('password')
         self.ssl_verify = self.get_option('validate_certs')
         self.host_filter = self.get_option('host_filter')
+        self.inventory_attr = self.get_option('inventory_attr')
         # Not currently enabled
         # self.cache_key = self.get_cache_key(path)
         # self.use_cache = cache and self.get_option('cache')

plugins/inventory/lxd.py

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

plugins/inventory/proxmox.py

@@ -114,34 +114,17 @@ groups:
   mailservers: "'mail' in (proxmox_tags_parsed|list)"
 compose:
   ansible_port: 2222
-
-# Using the inventory to allow ansible to connect via the first IP address of the VM / Container
-# (Default is connection by name of QEMU/LXC guests)
-# Note: my_inv_var demonstrates how to add a string variable to every host used by the inventory.
-# my.proxmox.yml
-plugin: community.general.proxmox
-url: http://pve.domain.com:8006
-user: ansible@pve
-password: secure
-validate_certs: false
-want_facts: true
-compose:
-  ansible_host: proxmox_ipconfig0.ip | default(proxmox_net0.ip) | ipaddr('address')
-  my_inv_var_1: "'my_var1_value'"
-  my_inv_var_2: >
-    "my_var_2_value"
 '''
 
 import re
 
 from ansible.module_utils.common._collections_compat import MutableMapping
+from distutils.version import LooseVersion
 
 from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable, Cacheable
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 # 3rd party imports
 try:
     import requests

plugins/inventory/xen_orchestra.py

@@ -0,0 +1,328 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = '''
+    name: xen_orchestra
+    short_description: Xen Orchestra inventory source
+    version_added: 4.1.0
+    author:
+        - Dom Del Nano (@ddelnano) <ddelnano@gmail.com>
+        - Samori Gorse (@shinuza) <samorigorse@gmail.com>
+    requirements:
+        - websocket-client >= 1.0.0
+    description:
+        - Get inventory hosts from a Xen Orchestra deployment.
+        - 'Uses a configuration file as an inventory source, it must end in C(.xen_orchestra.yml) or C(.xen_orchestra.yaml).'
+    extends_documentation_fragment:
+        - constructed
+        - inventory_cache
+    options:
+        plugin:
+            description: The name of this plugin, it should always be set to C(community.general.xen_orchestra) for this plugin to recognize it as its own.
+            required: yes
+            choices: ['community.general.xen_orchestra']
+            type: str
+        api_host:
+            description:
+                - API host to XOA API.
+                - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_HOST) will be used instead.
+            type: str
+            env:
+                - name: ANSIBLE_XO_HOST
+        user:
+            description:
+                - Xen Orchestra user.
+                - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_USER) will be used instead.
+            required: yes
+            type: str
+            env:
+                - name: ANSIBLE_XO_USER
+        password:
+            description:
+                - Xen Orchestra password.
+                - If the value is not specified in the inventory configuration, the value of environment variable C(ANSIBLE_XO_PASSWORD) will be used instead.
+            required: yes
+            type: str
+            env:
+                - name: ANSIBLE_XO_PASSWORD
+        validate_certs:
+            description: Verify TLS certificate if using HTTPS.
+            type: boolean
+            default: true
+        use_ssl:
+            description: Use wss when connecting to the Xen Orchestra API
+            type: boolean
+            default: true
+'''
+
+
+EXAMPLES = '''
+# file must be named xen_orchestra.yaml or xen_orchestra.yml
+simple_config_file:
+    plugin: community.general.xen_orchestra
+    api_host: 192.168.1.255
+    user: xo
+    password: xo_pwd
+    validate_certs: true
+    use_ssl: true
+    groups:
+        kube_nodes: "'kube_node' in tags"
+    compose:
+        ansible_port: 2222
+
+'''
+
+import json
+import ssl
+
+from distutils.version import LooseVersion
+
+from ansible.errors import AnsibleError
+from ansible.plugins.inventory import BaseInventoryPlugin, Constructable, Cacheable
+
+# 3rd party imports
+try:
+    HAS_WEBSOCKET = True
+    import websocket
+    from websocket import create_connection
+
+    if LooseVersion(websocket.__version__) <= LooseVersion('1.0.0'):
+        raise ImportError
+except ImportError as e:
+    HAS_WEBSOCKET = False
+
+
+HALTED = 'Halted'
+PAUSED = 'Paused'
+RUNNING = 'Running'
+SUSPENDED = 'Suspended'
+POWER_STATES = [RUNNING, HALTED, SUSPENDED, PAUSED]
+HOST_GROUP = 'xo_hosts'
+POOL_GROUP = 'xo_pools'
+
+
+def clean_group_name(label):
+    return label.lower().replace(' ', '-').replace('-', '_')
+
+
+class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
+    ''' Host inventory parser for ansible using XenOrchestra as source. '''
+
+    NAME = 'community.general.xen_orchestra'
+
+    def __init__(self):
+
+        super(InventoryModule, self).__init__()
+
+        # from config
+        self.counter = -1
+        self.session = None
+        self.cache_key = None
+        self.use_cache = None
+
+    @property
+    def pointer(self):
+        self.counter += 1
+        return self.counter
+
+    def create_connection(self, xoa_api_host):
+        validate_certs = self.get_option('validate_certs')
+        use_ssl = self.get_option('use_ssl')
+        proto = 'wss' if use_ssl else 'ws'
+
+        sslopt = None if validate_certs else {'cert_reqs': ssl.CERT_NONE}
+        self.conn = create_connection(
+            '{0}://{1}/api/'.format(proto, xoa_api_host), sslopt=sslopt)
+
+    def login(self, user, password):
+        payload = {'id': self.pointer, 'jsonrpc': '2.0', 'method': 'session.signIn', 'params': {
+            'username': user, 'password': password}}
+        self.conn.send(json.dumps(payload))
+        result = json.loads(self.conn.recv())
+
+        if 'error' in result:
+            raise AnsibleError(
+                'Could not connect: {0}'.format(result['error']))
+
+    def get_object(self, name):
+        payload = {'id': self.pointer, 'jsonrpc': '2.0',
+                   'method': 'xo.getAllObjects', 'params': {'filter': {'type': name}}}
+        self.conn.send(json.dumps(payload))
+        answer = json.loads(self.conn.recv())
+
+        if 'error' in answer:
+            raise AnsibleError(
+                'Could not request: {0}'.format(answer['error']))
+
+        return answer['result']
+
+    def _get_objects(self):
+        self.create_connection(self.xoa_api_host)
+        self.login(self.xoa_user, self.xoa_password)
+
+        return {
+            'vms': self.get_object('VM'),
+            'pools': self.get_object('pool'),
+            'hosts': self.get_object('host'),
+        }
+
+    def _apply_constructable(self, name, variables):
+        strict = self.get_option('strict')
+        self._add_host_to_composed_groups(self.get_option('groups'), variables, name, strict=strict)
+        self._add_host_to_keyed_groups(self.get_option('keyed_groups'), variables, name, strict=strict)
+        self._set_composite_vars(self.get_option('compose'), variables, name, strict=strict)
+
+    def _add_vms(self, vms, hosts, pools):
+        for uuid, vm in vms.items():
+            group = 'with_ip'
+            ip = vm.get('mainIpAddress')
+            entry_name = uuid
+            power_state = vm['power_state'].lower()
+            pool_name = self._pool_group_name_for_uuid(pools, vm['$poolId'])
+            host_name = self._host_group_name_for_uuid(hosts, vm['$container'])
+
+            self.inventory.add_host(entry_name)
+
+            # Grouping by power state
+            self.inventory.add_child(power_state, entry_name)
+
+            # Grouping by host
+            if host_name:
+                self.inventory.add_child(host_name, entry_name)
+
+            # Grouping by pool
+            if pool_name:
+                self.inventory.add_child(pool_name, entry_name)
+
+            # Grouping VMs with an IP together
+            if ip is None:
+                group = 'without_ip'
+            self.inventory.add_group(group)
+            self.inventory.add_child(group, entry_name)
+
+            # Adding meta
+            self.inventory.set_variable(entry_name, 'uuid', uuid)
+            self.inventory.set_variable(entry_name, 'ip', ip)
+            self.inventory.set_variable(entry_name, 'ansible_host', ip)
+            self.inventory.set_variable(entry_name, 'power_state', power_state)
+            self.inventory.set_variable(
+                entry_name, 'name_label', vm['name_label'])
+            self.inventory.set_variable(entry_name, 'type', vm['type'])
+            self.inventory.set_variable(
+                entry_name, 'cpus', vm['CPUs']['number'])
+            self.inventory.set_variable(entry_name, 'tags', vm['tags'])
+            self.inventory.set_variable(
+                entry_name, 'memory', vm['memory']['size'])
+            self.inventory.set_variable(
+                entry_name, 'has_ip', group == 'with_ip')
+            self.inventory.set_variable(
+                entry_name, 'is_managed', vm.get('managementAgentDetected', False))
+            self.inventory.set_variable(
+                entry_name, 'os_version', vm['os_version'])
+
+            self._apply_constructable(entry_name, self.inventory.get_host(entry_name).get_vars())
+
+    def _add_hosts(self, hosts, pools):
+        for host in hosts.values():
+            entry_name = host['uuid']
+            group_name = 'xo_host_{0}'.format(
+                clean_group_name(host['name_label']))
+            pool_name = self._pool_group_name_for_uuid(pools, host['$poolId'])
+
+            self.inventory.add_group(group_name)
+            self.inventory.add_host(entry_name)
+            self.inventory.add_child(HOST_GROUP, entry_name)
+            self.inventory.add_child(pool_name, entry_name)
+
+            self.inventory.set_variable(entry_name, 'enabled', host['enabled'])
+            self.inventory.set_variable(
+                entry_name, 'hostname', host['hostname'])
+            self.inventory.set_variable(entry_name, 'memory', host['memory'])
+            self.inventory.set_variable(entry_name, 'address', host['address'])
+            self.inventory.set_variable(entry_name, 'cpus', host['cpus'])
+            self.inventory.set_variable(entry_name, 'type', 'host')
+            self.inventory.set_variable(entry_name, 'tags', host['tags'])
+            self.inventory.set_variable(entry_name, 'version', host['version'])
+            self.inventory.set_variable(
+                entry_name, 'power_state', host['power_state'].lower())
+            self.inventory.set_variable(
+                entry_name, 'product_brand', host['productBrand'])
+
+        for pool in pools.values():
+            group_name = 'xo_pool_{0}'.format(
+                clean_group_name(pool['name_label']))
+
+            self.inventory.add_group(group_name)
+
+    def _add_pools(self, pools):
+        for pool in pools.values():
+            group_name = 'xo_pool_{0}'.format(
+                clean_group_name(pool['name_label']))
+
+            self.inventory.add_group(group_name)
+
+    # TODO: Refactor
+    def _pool_group_name_for_uuid(self, pools, pool_uuid):
+        for pool in pools:
+            if pool == pool_uuid:
+                return 'xo_pool_{0}'.format(
+                    clean_group_name(pools[pool_uuid]['name_label']))
+
+    # TODO: Refactor
+    def _host_group_name_for_uuid(self, hosts, host_uuid):
+        for host in hosts:
+            if host == host_uuid:
+                return 'xo_host_{0}'.format(
+                    clean_group_name(hosts[host_uuid]['name_label']
+                                     ))
+
+    def _populate(self, objects):
+        # Prepare general groups
+        self.inventory.add_group(HOST_GROUP)
+        self.inventory.add_group(POOL_GROUP)
+        for group in POWER_STATES:
+            self.inventory.add_group(group.lower())
+
+        self._add_pools(objects['pools'])
+        self._add_hosts(objects['hosts'], objects['pools'])
+        self._add_vms(objects['vms'], objects['hosts'], objects['pools'])
+
+    def verify_file(self, path):
+
+        valid = False
+        if super(InventoryModule, self).verify_file(path):
+            if path.endswith(('xen_orchestra.yaml', 'xen_orchestra.yml')):
+                valid = True
+            else:
+                self.display.vvv(
+                    'Skipping due to inventory source not ending in "xen_orchestra.yaml" nor "xen_orchestra.yml"')
+        return valid
+
+    def parse(self, inventory, loader, path, cache=True):
+        if not HAS_WEBSOCKET:
+            raise AnsibleError('This plugin requires websocket-client 1.0.0 or higher: '
+                               'https://github.com/websocket-client/websocket-client.')
+
+        super(InventoryModule, self).parse(inventory, loader, path)
+
+        # read config from file, this sets 'options'
+        self._read_config_data(path)
+        self.inventory = inventory
+
+        self.protocol = 'wss'
+        self.xoa_api_host = self.get_option('api_host')
+        self.xoa_user = self.get_option('user')
+        self.xoa_password = self.get_option('password')
+        self.cache_key = self.get_cache_key(path)
+        self.use_cache = cache and self.get_option('cache')
+
+        self.validate_certs = self.get_option('validate_certs')
+        if not self.get_option('use_ssl'):
+            self.protocol = 'ws'
+
+        objects = self._get_objects()
+        self._populate(objects)

plugins/lookup/collection_version.py

@@ -0,0 +1,138 @@
+# (c) 2021, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = """
+name: collection_version
+author: Felix Fontein (@felixfontein)
+version_added: "4.0.0"
+short_description: Retrieves the version of an installed collection
+description:
+  - This lookup allows to query the version of an installed collection, and to determine whether a
+    collection is installed at all.
+  - By default it returns C(none) for non-existing collections and C(*) for collections without a
+    version number. The latter should only happen in development environments, or when installing
+    a collection from git which has no version in its C(galaxy.yml). This behavior can be adjusted
+    by providing other values with I(result_not_found) and I(result_no_version).
+options:
+  _terms:
+    description:
+      - The collections to look for.
+      - For example C(community.general).
+    type: list
+    elements: str
+    required: true
+  result_not_found:
+    description:
+      - The value to return when the collection could not be found.
+      - By default, C(none) is returned.
+    type: string
+    default: ~
+  result_no_version:
+    description:
+      - The value to return when the collection has no version number.
+      - This can happen for collections installed from git which do not have a version number
+        in C(galaxy.yml).
+      - By default, C(*) is returned.
+    type: string
+    default: '*'
+"""
+
+EXAMPLES = """
+- name: Check version of community.general
+  ansible.builtin.debug:
+    msg: "community.general version {{ lookup('community.general.collection_version', 'community.general') }}"
+"""
+
+RETURN = """
+  _raw:
+    description:
+      - The version number of the collections listed as input.
+      - If a collection can not be found, it will return the value provided in I(result_not_found).
+        By default, this is C(none).
+      - If a collection can be found, but the version not identified, it will return the value provided in
+        I(result_no_version). By default, this is C(*). This can happen for collections installed
+        from git which do not have a version number in C(galaxy.yml).
+    type: list
+    elements: str
+"""
+
+import json
+import os
+import re
+
+import yaml
+
+from ansible.errors import AnsibleLookupError
+from ansible.module_utils.compat.importlib import import_module
+from ansible.plugins.lookup import LookupBase
+
+
+FQCN_RE = re.compile(r'^[A-Za-z0-9_]+\.[A-Za-z0-9_]+$')
+
+
+def load_collection_meta_manifest(manifest_path):
+    with open(manifest_path, 'rb') as f:
+        meta = json.load(f)
+    return {
+        'version': meta['collection_info']['version'],
+    }
+
+
+def load_collection_meta_galaxy(galaxy_path, no_version='*'):
+    with open(galaxy_path, 'rb') as f:
+        meta = yaml.safe_load(f)
+    return {
+        'version': meta.get('version') or no_version,
+    }
+
+
+def load_collection_meta(collection_pkg, no_version='*'):
+    path = os.path.dirname(collection_pkg.__file__)
+
+    # Try to load MANIFEST.json
+    manifest_path = os.path.join(path, 'MANIFEST.json')
+    if os.path.exists(manifest_path):
+        return load_collection_meta_manifest(manifest_path)
+
+    # Try to load galaxy.y(a)ml
+    galaxy_path = os.path.join(path, 'galaxy.yml')
+    galaxy_alt_path = os.path.join(path, 'galaxy.yaml')
+    # galaxy.yaml was only supported in ansible-base 2.10 and ansible-core 2.11. Support was removed
+    # in https://github.com/ansible/ansible/commit/595413d11346b6f26bb3d9df2d8e05f2747508a3 for
+    # ansible-core 2.12.
+    for path in (galaxy_path, galaxy_alt_path):
+        if os.path.exists(path):
+            return load_collection_meta_galaxy(path, no_version=no_version)
+
+    return {}
+
+
+class LookupModule(LookupBase):
+    def run(self, terms, variables=None, **kwargs):
+        result = []
+        self.set_options(var_options=variables, direct=kwargs)
+        not_found = self.get_option('result_not_found')
+        no_version = self.get_option('result_no_version')
+
+        for term in terms:
+            if not FQCN_RE.match(term):
+                raise AnsibleLookupError('"{term}" is not a FQCN'.format(term=term))
+
+            try:
+                collection_pkg = import_module('ansible_collections.{fqcn}'.format(fqcn=term))
+            except ImportError:
+                # Collection not found
+                result.append(not_found)
+                continue
+
+            try:
+                data = load_collection_meta(collection_pkg, no_version=no_version)
+            except Exception as exc:
+                raise AnsibleLookupError('Error while loading metadata for {fqcn}: {error}'.format(fqcn=term, error=exc))
+
+            result.append(data.get('version', no_version))
+
+        return result

plugins/lookup/flattened.py

@@ -23,7 +23,7 @@ DOCUMENTATION = '''
 EXAMPLES = """
 - name: "'unnest' all elements into single list"
   ansible.builtin.debug:
-    msg: "all in one list {{lookup('community.general.flattened', [1,2,3,[5,6]], ['a','b','c'], [[5,6,1,3], [34,'a','b','c']])}}"
+    msg: "all in one list {{lookup('community.general.flattened', [1,2,3,[5,6]], [a,b,c], [[5,6,1,3], [34,a,b,c]])}}"
 """
 
 RETURN = """

plugins/lookup/nios.py

@@ -1,126 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-#  Copyright 2018 Red Hat | Ansible
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-from __future__ import (absolute_import, division, print_function)
-
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-author: Unknown (!UNKNOWN)
-name: nios
-short_description: Query Infoblox NIOS objects
-deprecated:
-    why: Please install the infoblox.nios_modules collection and use the corresponding lookup from it.
-    alternative: infoblox.nios_modules.nios_lookup
-    removed_in: 5.0.0
-description:
-  - Uses the Infoblox WAPI API to fetch NIOS specified objects.  This lookup
-    supports adding additional keywords to filter the return data and specify
-    the desired set of returned fields.
-requirements:
-  - infoblox-client
-extends_documentation_fragment:
-- community.general.nios
-
-options:
-    _terms:
-      description: The name of the object to return from NIOS
-      required: True
-    return_fields:
-      description: The list of field names to return for the specified object.
-    filter:
-      description: a dict object that is used to filter the return objects
-    extattrs:
-      description: a dict object that is used to filter on extattrs
-'''
-
-EXAMPLES = """
-- name: fetch all networkview objects
-  ansible.builtin.set_fact:
-    networkviews: "{{ lookup('community.general.nios', 'networkview',
-                         provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-- name: fetch the default dns view
-  ansible.builtin.set_fact:
-    dns_views: "{{ lookup('community.general.nios', 'view', filter={'name': 'default'},
-                      provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-# all of the examples below use credentials that are  set using env variables
-# export INFOBLOX_HOST=nios01
-# export INFOBLOX_USERNAME=admin
-# export INFOBLOX_PASSWORD=admin
-
-- name: fetch all host records and include extended attributes
-  ansible.builtin.set_fact:
-    host_records: "{{ lookup('community.general.nios', 'record:host', return_fields=['extattrs', 'name', 'view', 'comment']}) }}"
-
-
-- name: use env variables to pass credentials
-  ansible.builtin.set_fact:
-    networkviews: "{{ lookup('community.general.nios', 'networkview') }}"
-
-- name: get a host record
-  ansible.builtin.set_fact:
-    host: "{{ lookup('community.general.nios', 'record:host', filter={'name': 'hostname.ansible.com'}) }}"
-
-- name: get the authoritative zone from a non default dns view
-  ansible.builtin.set_fact:
-    host: "{{ lookup('community.general.nios', 'zone_auth', filter={'fqdn': 'ansible.com', 'view': 'ansible-dns'}) }}"
-"""
-
-RETURN = """
-obj_type:
-  description:
-    - The object type specified in the terms argument
-  type: dictionary
-  contains:
-    obj_field:
-      description:
-        - One or more obj_type fields as specified by return_fields argument or
-          the default set of fields as per the object type
-"""
-
-from ansible.plugins.lookup import LookupBase
-from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiLookup
-from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_extattrs, flatten_extattrs
-from ansible.errors import AnsibleError
-
-
-class LookupModule(LookupBase):
-
-    def run(self, terms, variables=None, **kwargs):
-        try:
-            obj_type = terms[0]
-        except IndexError:
-            raise AnsibleError('the object_type must be specified')
-
-        return_fields = kwargs.pop('return_fields', None)
-        filter_data = kwargs.pop('filter', {})
-        extattrs = normalize_extattrs(kwargs.pop('extattrs', {}))
-        provider = kwargs.pop('provider', {})
-        wapi = WapiLookup(provider)
-        res = wapi.get_object(obj_type, filter_data, return_fields=return_fields, extattrs=extattrs)
-        if res is not None:
-            for obj in res:
-                if 'extattrs' in obj:
-                    obj['extattrs'] = flatten_extattrs(obj['extattrs'])
-        else:
-            res = []
-        return res

plugins/lookup/nios_next_ip.py

@@ -1,105 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-#  Copyright 2018 Red Hat | Ansible
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-from __future__ import (absolute_import, division, print_function)
-
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-author: Unknown (!UNKNOWN)
-name: nios_next_ip
-short_description: Return the next available IP address for a network
-deprecated:
-    why: Please install the infoblox.nios_modules collection and use the corresponding lookup from it.
-    alternative: infoblox.nios_modules.nios_next_ip
-    removed_in: 5.0.0
-description:
-  - Uses the Infoblox WAPI API to return the next available IP addresses
-    for a given network CIDR
-requirements:
-  - infoblox-client
-extends_documentation_fragment:
-- community.general.nios
-
-options:
-    _terms:
-      description: The CIDR network to retrieve the next addresses from
-      required: True
-    num:
-      description: The number of IP addresses to return
-      required: false
-      default: 1
-    exclude:
-      description: List of IP's that need to be excluded from returned IP addresses
-      required: false
-'''
-
-EXAMPLES = """
-- name: return next available IP address for network 192.168.10.0/24
-  ansible.builtin.set_fact:
-    ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-- name: return the next 3 available IP addresses for network 192.168.10.0/24
-  ansible.builtin.set_fact:
-    ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', num=3, provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-- name: return the next 3 available IP addresses for network 192.168.10.0/24 excluding ip addresses - ['192.168.10.1', '192.168.10.2']
-  ansible.builtin.set_fact:
-    ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', num=3, exclude=['192.168.10.1', '192.168.10.2'],
-                provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-"""
-
-RETURN = """
-_list:
-  description:
-    - The list of next IP addresses available
-  type: list
-"""
-
-from ansible.plugins.lookup import LookupBase
-from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiLookup
-from ansible.module_utils.common.text.converters import to_text
-from ansible.errors import AnsibleError
-
-
-class LookupModule(LookupBase):
-
-    def run(self, terms, variables=None, **kwargs):
-        try:
-            network = terms[0]
-        except IndexError:
-            raise AnsibleError('missing argument in the form of A.B.C.D/E')
-
-        provider = kwargs.pop('provider', {})
-        wapi = WapiLookup(provider)
-
-        network_obj = wapi.get_object('network', {'network': network})
-        if network_obj is None:
-            raise AnsibleError('unable to find network object %s' % network)
-
-        num = kwargs.get('num', 1)
-        exclude_ip = kwargs.get('exclude', [])
-
-        try:
-            ref = network_obj[0]['_ref']
-            avail_ips = wapi.call_func('next_available_ip', ref, {'num': num, 'exclude': exclude_ip})
-            return [avail_ips['ips']]
-        except Exception as exc:
-            raise AnsibleError(to_text(exc))

plugins/lookup/nios_next_network.py

@@ -1,118 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright 2018 Red Hat | Ansible
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-from __future__ import (absolute_import, division, print_function)
-
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-author: Unknown (!UNKNOWN)
-name: nios_next_network
-short_description: Return the next available network range for a network-container
-deprecated:
-    why: Please install the infoblox.nios_modules collection and use the corresponding lookup from it.
-    alternative: infoblox.nios_modules.nios_next_network
-    removed_in: 5.0.0
-description:
-  - Uses the Infoblox WAPI API to return the next available network addresses for
-    a given network CIDR
-requirements:
-  - infoblox_client
-extends_documentation_fragment:
-- community.general.nios
-
-options:
-    _terms:
-      description: The CIDR network to retrieve the next network from next available network within the specified
-                   container.
-      required: True
-    cidr:
-      description:
-        - The CIDR of the network to retrieve the next network from next available network within the
-          specified container. Also, Requested CIDR must be specified and greater than the parent CIDR.
-      required: True
-      default: 24
-    num:
-      description: The number of network addresses to return from network-container
-      required: false
-      default: 1
-    exclude:
-      description: Network addresses returned from network-container excluding list of user's input network range
-      required: false
-      default: ''
-'''
-
-EXAMPLES = """
-- name: return next available network for network-container 192.168.10.0/24
-  ansible.builtin.set_fact:
-    networkaddr: "{{ lookup('community.general.nios_next_network', '192.168.10.0/24', cidr=25,
-                        provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-- name: return the next 2 available network addresses for network-container 192.168.10.0/24
-  ansible.builtin.set_fact:
-    networkaddr: "{{ lookup('community.general.nios_next_network', '192.168.10.0/24', cidr=25, num=2,
-                        provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-
-- name: return the available network addresses for network-container 192.168.10.0/24 excluding network range '192.168.10.0/25'
-  ansible.builtin.set_fact:
-    networkaddr: "{{ lookup('community.general.nios_next_network', '192.168.10.0/24', cidr=25, exclude=['192.168.10.0/25'],
-                        provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
-"""
-
-RETURN = """
-_list:
-  description:
-    - The list of next network addresses available
-  type: list
-"""
-
-from ansible.plugins.lookup import LookupBase
-from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiLookup
-from ansible.module_utils.common.text.converters import to_text
-from ansible.errors import AnsibleError
-
-
-class LookupModule(LookupBase):
-
-    def run(self, terms, variables=None, **kwargs):
-        try:
-            network = terms[0]
-        except IndexError:
-            raise AnsibleError('missing network argument in the form of A.B.C.D/E')
-        try:
-            cidr = kwargs.get('cidr', 24)
-        except IndexError:
-            raise AnsibleError('missing CIDR argument in the form of xx')
-
-        provider = kwargs.pop('provider', {})
-        wapi = WapiLookup(provider)
-        network_obj = wapi.get_object('networkcontainer', {'network': network})
-
-        if network_obj is None:
-            raise AnsibleError('unable to find network-container object %s' % network)
-        num = kwargs.get('num', 1)
-        exclude_ip = kwargs.get('exclude', [])
-
-        try:
-            ref = network_obj[0]['_ref']
-            avail_nets = wapi.call_func('next_available_network', ref, {'cidr': cidr, 'num': num, 'exclude': exclude_ip})
-            return [avail_nets['networks']]
-        except Exception as exc:
-            raise AnsibleError(to_text(exc))

plugins/lookup/passwordstore.py

@@ -141,9 +141,9 @@ import time
 import yaml
 
 
+from distutils import util
 from ansible.errors import AnsibleError, AnsibleAssertionError
 from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
-from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.utils.display import Display
 from ansible.utils.encrypt import random_password
 from ansible.plugins.lookup import LookupBase
@@ -154,7 +154,6 @@ display = Display()
 
 # backhacked check_output with input for python 2.7
 # http://stackoverflow.com/questions/10103551/passing-data-to-subprocess-check-output
-# note: contains special logic for calling 'pass', so not a drop-in replacement for check_output
 def check_output2(*popenargs, **kwargs):
     if 'stdout' in kwargs:
         raise ValueError('stdout argument not allowed, it will be overridden.')
@@ -176,10 +175,9 @@ def check_output2(*popenargs, **kwargs):
         process.wait()
         raise
     retcode = process.poll()
-    if retcode == 0 and (b'encryption failed: Unusable public key' in b_out or
-                         b'encryption failed: Unusable public key' in b_err):
-        retcode = 78  # os.EX_CONFIG
-    if retcode != 0:
+    if retcode != 0 or \
+            b'encryption failed: Unusable public key' in b_out or \
+            b'encryption failed: Unusable public key' in b_err:
         cmd = kwargs.get("args")
         if cmd is None:
             cmd = popenargs[0]
@@ -213,7 +211,7 @@ class LookupModule(LookupBase):
             try:
                 for key in ['create', 'returnall', 'overwrite', 'backup', 'nosymbols']:
                     if not isinstance(self.paramvals[key], bool):
-                        self.paramvals[key] = boolean(self.paramvals[key])
+                        self.paramvals[key] = util.strtobool(self.paramvals[key])
             except (ValueError, AssertionError) as e:
                 raise AnsibleError(e)
             if self.paramvals['missing'] not in ['error', 'warn', 'create', 'empty']:
@@ -229,13 +227,13 @@ class LookupModule(LookupBase):
 
             # Collect pass environment variables from the plugin's parameters.
             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 os.path.isdir(self.paramvals['directory']):
-                self.env['PASSWORD_STORE_DIR'] = self.paramvals['directory']
-            else:
-                raise AnsibleError('Passwordstore directory \'{0}\' does not exist'.format(self.paramvals['directory']))
+            # Set PASSWORD_STORE_DIR if directory is set
+            if self.paramvals['directory']:
+                if os.path.isdir(self.paramvals['directory']):
+                    self.env['PASSWORD_STORE_DIR'] = self.paramvals['directory']
+                else:
+                    raise AnsibleError('Passwordstore directory \'{0}\' does not exist'.format(self.paramvals['directory']))
 
             # Set PASSWORD_STORE_UMASK if umask is set
             if 'umask' in self.paramvals:
@@ -263,20 +261,19 @@ 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")):
-                # Only accept password as found, if there 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
-            if 'not in the password store' not in e.output:
+            if e.returncode != 0 and 'not in the password store' in e.output:
+                # if pass returns 1 and return string contains 'is not in the password store.'
+                # We need to determine if this is valid or Error.
+                if self.paramvals['missing'] == 'error':
+                    raise AnsibleError('passwordstore: passname {0} not found and missing=error is set'.format(self.passname))
+                else:
+                    if self.paramvals['missing'] == 'warn':
+                        display.warning('passwordstore: passname {0} not found'.format(self.passname))
+                    return False
+            else:
                 raise AnsibleError(e)
-
-        if self.paramvals['missing'] == 'error':
-            raise AnsibleError('passwordstore: passname {0} not found and missing=error is set'.format(self.passname))
-        elif self.paramvals['missing'] == 'warn':
-            display.warning('passwordstore: passname {0} not found'.format(self.passname))
-
-        return False
+        return True
 
     def get_newpass(self):
         if self.paramvals['nosymbols']:
@@ -332,9 +329,7 @@ class LookupModule(LookupBase):
         result = []
         self.paramvals = {
             'subkey': 'password',
-            'directory': variables.get('passwordstore', os.environ.get(
-                                       'PASSWORD_STORE_DIR',
-                                       os.path.expanduser('~/.password-store'))),
+            'directory': variables.get('passwordstore'),
             'create': False,
             'returnall': False,
             'overwrite': False,

plugins/lookup/random_words.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+"""The community.general.random_words Ansible lookup plugin."""
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = r"""
+    name: random_words
+    author:
+      - Thomas Sjögren (@konstruktoid)
+    short_description: Return a number of random words
+    version_added: "4.0.0"
+    requirements:
+      - xkcdpass U(https://github.com/redacted/XKCD-password-generator)
+    description:
+      - Returns a number of random words. The output can for example be used for
+        passwords.
+      - See U(https://xkcd.com/936/) for background.
+    options:
+      numwords:
+        description:
+          - The number of words.
+        default: 6
+        type: int
+      min_length:
+        description:
+          - Minimum length of words to make password.
+        default: 5
+        type: int
+      max_length:
+        description:
+          - Maximum length of words to make password.
+        default: 9
+        type: int
+      delimiter:
+        description:
+          - The delimiter character between words.
+        default: " "
+        type: str
+      case:
+        description:
+          - The method for setting the case of each word in the passphrase.
+        choices: ["alternating", "upper", "lower", "random", "capitalize"]
+        default: "lower"
+        type: str
+"""
+
+EXAMPLES = r"""
+- name: Generate password with default settings
+  ansible.builtin.debug:
+    var: lookup('community.general.random_words')
+  # Example result: 'traitor gigabyte cesarean unless aspect clear'
+
+- name: Generate password with six, five character, words
+  ansible.builtin.debug:
+    var: lookup('community.general.random_words', min_length=5, max_length=5)
+  # Example result: 'brink banjo getup staff trump comfy'
+
+- name: Generate password with three capitalized words and the '-' delimiter
+  ansible.builtin.debug:
+    var: lookup('community.general.random_words', numwords=3, delimiter='-', case='capitalize')
+  # Example result: 'Overlabor-Faucet-Coastline'
+
+- name: Generate password with three words without any delimiter
+  ansible.builtin.debug:
+    var: lookup('community.general.random_words', numwords=3, delimiter='')
+  # Example result: 'deskworkmonopolystriking'
+  # https://www.ncsc.gov.uk/blog-post/the-logic-behind-three-random-words
+"""
+
+RETURN = r"""
+  _raw:
+    description: A single-element list containing random words.
+    type: list
+    elements: str
+"""
+
+from ansible.errors import AnsibleLookupError
+from ansible.plugins.lookup import LookupBase
+
+try:
+    from xkcdpass import xkcd_password as xp
+
+    HAS_XKCDPASS = True
+except ImportError:
+    HAS_XKCDPASS = False
+
+
+class LookupModule(LookupBase):
+    """The random_words Ansible lookup class."""
+
+    def run(self, terms, variables=None, **kwargs):
+
+        if not HAS_XKCDPASS:
+            raise AnsibleLookupError(
+                "Python xkcdpass library is required. "
+                'Please install using "pip install xkcdpass"'
+            )
+
+        self.set_options(var_options=variables, direct=kwargs)
+        method = self.get_option("case")
+        delimiter = self.get_option("delimiter")
+        max_length = self.get_option("max_length")
+        min_length = self.get_option("min_length")
+        numwords = self.get_option("numwords")
+
+        words = xp.locate_wordfile()
+        wordlist = xp.generate_wordlist(
+            max_length=max_length, min_length=min_length, wordfile=words
+        )
+
+        values = xp.generate_xkcdpassword(
+            wordlist, case=method, delimiter=delimiter, numwords=numwords
+        )
+
+        return [values]

plugins/lookup/revbitspss.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2021, RevBits <info@revbits.com>
+# GNU General Public License v3.0+ (see COPYING or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = r"""
+name: revbitspss
+author: RevBits (@RevBits) <info@revbits.com>
+short_description: Get secrets from RevBits PAM server
+version_added: 4.1.0
+description:
+    - Uses the revbits_ansible Python SDK to get Secrets from RevBits PAM
+      Server using API key authentication with the REST API.
+requirements:
+    - revbits_ansible - U(https://pypi.org/project/revbits_ansible/)
+options:
+    _terms:
+        description:
+            - This will be an array of keys for secrets which you want to fetch from RevBits PAM.
+        required: true
+        type: list
+        elements: string
+    base_url:
+        description:
+            - This will be the base URL of the server, for example C(https://server-url-here).
+        required: true
+        type: string
+    api_key:
+        description:
+            - This will be the API key for authentication. You can get it from the RevBits PAM secret manager module.
+        required: true
+        type: string
+"""
+
+RETURN = r"""
+_list:
+    description:
+        - The JSON responses which you can access with defined keys.
+        - If you are fetching secrets named as UUID, PASSWORD it will gives you the dict of all secrets.
+    type: list
+    elements: dict
+"""
+
+EXAMPLES = r"""
+- hosts: localhost
+  vars:
+      secret: >-
+        {{
+            lookup(
+                'community.general.revbitspss',
+                'UUIDPAM', 'DB_PASS',
+                base_url='https://server-url-here',
+                api_key='API_KEY_GOES_HERE'
+            )
+        }}
+  tasks:
+      - ansible.builtin.debug:
+          msg: >
+            UUIDPAM is {{ (secret['UUIDPAM']) }} and DB_PASS is {{ (secret['DB_PASS']) }}
+"""
+
+from ansible.plugins.lookup import LookupBase
+from ansible.utils.display import Display
+from ansible.errors import AnsibleError
+from ansible.module_utils.six import raise_from
+
+try:
+    from pam.revbits_ansible.server import SecretServer
+except ImportError as imp_exc:
+    ANOTHER_LIBRARY_IMPORT_ERROR = imp_exc
+else:
+    ANOTHER_LIBRARY_IMPORT_ERROR = None
+
+
+display = Display()
+
+
+class LookupModule(LookupBase):
+
+    @staticmethod
+    def Client(server_parameters):
+        return SecretServer(**server_parameters)
+
+    def run(self, terms, variables, **kwargs):
+        if ANOTHER_LIBRARY_IMPORT_ERROR:
+            raise_from(
+                AnsibleError('revbits_ansible must be installed to use this plugin'),
+                ANOTHER_LIBRARY_IMPORT_ERROR
+            )
+        self.set_options(var_options=variables, direct=kwargs)
+        secret_server = LookupModule.Client(
+            {
+                "base_url": self.get_option('base_url'),
+                "api_key": self.get_option('api_key'),
+            }
+        )
+        result = []
+        for term in terms:
+            try:
+                display.vvv(u"Secret Server lookup of Secret with ID %s" % term)
+                result.append({term: secret_server.get_pam_secret(term)})
+            except Exception as error:
+                raise AnsibleError("Secret Server lookup failure: %s" % error.message)
+        return result

plugins/module_utils/_netapp.py

@@ -1,748 +0,0 @@
-# -*- coding: utf-8 -*-
-# This code is part of Ansible, but is an independent component.
-# This particular file snippet, and this file snippet only, is BSD licensed.
-# Modules you write using this snippet, which is embedded dynamically by Ansible
-# still belong to the author of the module, and may assign their own license
-# to the complete work.
-#
-# Copyright (c) 2017, Sumit Kumar <sumit4@netapp.com>
-# Copyright (c) 2017, Michael Price <michael.price@netapp.com>
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-#
-#    * Redistributions of source code must retain the above copyright
-#      notice, this list of conditions and the following disclaimer.
-#    * Redistributions in binary form must reproduce the above copyright notice,
-#      this list of conditions and the following disclaimer in the documentation
-#      and/or other materials provided with the distribution.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
-# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import json
-import os
-import random
-import mimetypes
-
-from pprint import pformat
-from ansible.module_utils import six
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib
-from ansible.module_utils.six.moves.urllib.error import HTTPError, URLError
-from ansible.module_utils.urls import open_url
-from ansible.module_utils.api import basic_auth_argument_spec
-from ansible.module_utils.common.text.converters import to_native
-
-try:
-    from ansible.module_utils.ansible_release import __version__ as ansible_version
-except ImportError:
-    ansible_version = 'unknown'
-
-try:
-    from netapp_lib.api.zapi import zapi
-    HAS_NETAPP_LIB = True
-except ImportError:
-    HAS_NETAPP_LIB = False
-
-try:
-    import requests
-    HAS_REQUESTS = True
-except ImportError:
-    HAS_REQUESTS = False
-
-import ssl
-try:
-    from urlparse import urlparse, urlunparse
-except ImportError:
-    from urllib.parse import urlparse, urlunparse
-
-
-HAS_SF_SDK = False
-SF_BYTE_MAP = dict(
-    # Management GUI displays 1024 ** 3 as 1.1 GB, thus use 1000.
-    bytes=1,
-    b=1,
-    kb=1000,
-    mb=1000 ** 2,
-    gb=1000 ** 3,
-    tb=1000 ** 4,
-    pb=1000 ** 5,
-    eb=1000 ** 6,
-    zb=1000 ** 7,
-    yb=1000 ** 8
-)
-
-POW2_BYTE_MAP = dict(
-    # Here, 1 kb = 1024
-    bytes=1,
-    b=1,
-    kb=1024,
-    mb=1024 ** 2,
-    gb=1024 ** 3,
-    tb=1024 ** 4,
-    pb=1024 ** 5,
-    eb=1024 ** 6,
-    zb=1024 ** 7,
-    yb=1024 ** 8
-)
-
-try:
-    from solidfire.factory import ElementFactory
-    from solidfire.custom.models import TimeIntervalFrequency
-    from solidfire.models import Schedule, ScheduleInfo
-
-    HAS_SF_SDK = True
-except Exception:
-    HAS_SF_SDK = False
-
-
-def has_netapp_lib():
-    return HAS_NETAPP_LIB
-
-
-def has_sf_sdk():
-    return HAS_SF_SDK
-
-
-def na_ontap_host_argument_spec():
-
-    return dict(
-        hostname=dict(required=True, type='str'),
-        username=dict(required=True, type='str', aliases=['user']),
-        password=dict(required=True, type='str', aliases=['pass'], no_log=True),
-        https=dict(required=False, type='bool', default=False),
-        validate_certs=dict(required=False, type='bool', default=True),
-        http_port=dict(required=False, type='int'),
-        ontapi=dict(required=False, type='int'),
-        use_rest=dict(required=False, type='str', default='Auto', choices=['Never', 'Always', 'Auto'])
-    )
-
-
-def ontap_sf_host_argument_spec():
-
-    return dict(
-        hostname=dict(required=True, type='str'),
-        username=dict(required=True, type='str', aliases=['user']),
-        password=dict(required=True, type='str', aliases=['pass'], no_log=True)
-    )
-
-
-def aws_cvs_host_argument_spec():
-
-    return dict(
-        api_url=dict(required=True, type='str'),
-        validate_certs=dict(required=False, type='bool', default=True),
-        api_key=dict(required=True, type='str', no_log=True),
-        secret_key=dict(required=True, type='str', no_log=True)
-    )
-
-
-def create_sf_connection(module, port=None):
-    hostname = module.params['hostname']
-    username = module.params['username']
-    password = module.params['password']
-
-    if HAS_SF_SDK and hostname and username and password:
-        try:
-            return_val = ElementFactory.create(hostname, username, password, port=port)
-            return return_val
-        except Exception:
-            raise Exception("Unable to create SF connection")
-    else:
-        module.fail_json(msg="the python SolidFire SDK module is required")
-
-
-def setup_na_ontap_zapi(module, vserver=None):
-    hostname = module.params['hostname']
-    username = module.params['username']
-    password = module.params['password']
-    https = module.params['https']
-    validate_certs = module.params['validate_certs']
-    port = module.params['http_port']
-    version = module.params['ontapi']
-
-    if HAS_NETAPP_LIB:
-        # set up zapi
-        server = zapi.NaServer(hostname)
-        server.set_username(username)
-        server.set_password(password)
-        if vserver:
-            server.set_vserver(vserver)
-        if version:
-            minor = version
-        else:
-            minor = 110
-        server.set_api_version(major=1, minor=minor)
-        # default is HTTP
-        if https:
-            if port is None:
-                port = 443
-            transport_type = 'HTTPS'
-            # HACK to bypass certificate verification
-            if validate_certs is False:
-                if not os.environ.get('PYTHONHTTPSVERIFY', '') and getattr(ssl, '_create_unverified_context', None):
-                    ssl._create_default_https_context = ssl._create_unverified_context
-        else:
-            if port is None:
-                port = 80
-            transport_type = 'HTTP'
-        server.set_transport_type(transport_type)
-        server.set_port(port)
-        server.set_server_type('FILER')
-        return server
-    else:
-        module.fail_json(msg="the python NetApp-Lib module is required")
-
-
-def setup_ontap_zapi(module, vserver=None):
-    hostname = module.params['hostname']
-    username = module.params['username']
-    password = module.params['password']
-
-    if HAS_NETAPP_LIB:
-        # set up zapi
-        server = zapi.NaServer(hostname)
-        server.set_username(username)
-        server.set_password(password)
-        if vserver:
-            server.set_vserver(vserver)
-        # Todo : Replace hard-coded values with configurable parameters.
-        server.set_api_version(major=1, minor=110)
-        server.set_port(80)
-        server.set_server_type('FILER')
-        server.set_transport_type('HTTP')
-        return server
-    else:
-        module.fail_json(msg="the python NetApp-Lib module is required")
-
-
-def eseries_host_argument_spec():
-    """Retrieve a base argument specification common to all NetApp E-Series modules"""
-    argument_spec = basic_auth_argument_spec()
-    argument_spec.update(dict(
-        api_username=dict(type='str', required=True),
-        api_password=dict(type='str', required=True, no_log=True),
-        api_url=dict(type='str', required=True),
-        ssid=dict(type='str', required=False, default='1'),
-        validate_certs=dict(type='bool', required=False, default=True)
-    ))
-    return argument_spec
-
-
-class NetAppESeriesModule(object):
-    """Base class for all NetApp E-Series modules.
-
-    Provides a set of common methods for NetApp E-Series modules, including version checking, mode (proxy, embedded)
-    verification, http requests, secure http redirection for embedded web services, and logging setup.
-
-    Be sure to add the following lines in the module's documentation section:
-    extends_documentation_fragment:
-        - netapp.eseries
-
-    :param dict(dict) ansible_options: dictionary of ansible option definitions
-    :param str web_services_version: minimally required web services rest api version (default value: "02.00.0000.0000")
-    :param bool supports_check_mode: whether the module will support the check_mode capabilities (default=False)
-    :param list(list) mutually_exclusive: list containing list(s) of mutually exclusive options (optional)
-    :param list(list) required_if: list containing list(s) containing the option, the option value, and then
-    a list of required options. (optional)
-    :param list(list) required_one_of: list containing list(s) of options for which at least one is required. (optional)
-    :param list(list) required_together: list containing list(s) of options that are required together. (optional)
-    :param bool log_requests: controls whether to log each request (default: True)
-    """
-    DEFAULT_TIMEOUT = 60
-    DEFAULT_SECURE_PORT = "8443"
-    DEFAULT_REST_API_PATH = "devmgr/v2/"
-    DEFAULT_REST_API_ABOUT_PATH = "devmgr/utils/about"
-    DEFAULT_HEADERS = {"Content-Type": "application/json", "Accept": "application/json",
-                       "netapp-client-type": "Ansible-%s" % ansible_version}
-    HTTP_AGENT = "Ansible / %s" % ansible_version
-    SIZE_UNIT_MAP = dict(bytes=1, b=1, kb=1024, mb=1024**2, gb=1024**3, tb=1024**4,
-                         pb=1024**5, eb=1024**6, zb=1024**7, yb=1024**8)
-
-    def __init__(self, ansible_options, web_services_version=None, supports_check_mode=False,
-                 mutually_exclusive=None, required_if=None, required_one_of=None, required_together=None,
-                 log_requests=True):
-        argument_spec = eseries_host_argument_spec()
-        argument_spec.update(ansible_options)
-
-        self.module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=supports_check_mode,
-                                    mutually_exclusive=mutually_exclusive, required_if=required_if,
-                                    required_one_of=required_one_of, required_together=required_together)
-
-        args = self.module.params
-        self.web_services_version = web_services_version if web_services_version else "02.00.0000.0000"
-        self.ssid = args["ssid"]
-        self.url = args["api_url"]
-        self.log_requests = log_requests
-        self.creds = dict(url_username=args["api_username"],
-                          url_password=args["api_password"],
-                          validate_certs=args["validate_certs"])
-
-        if not self.url.endswith("/"):
-            self.url += "/"
-
-        self.is_embedded_mode = None
-        self.is_web_services_valid_cache = None
-
-    def _check_web_services_version(self):
-        """Verify proxy or embedded web services meets minimum version required for module.
-
-        The minimum required web services version is evaluated against version supplied through the web services rest
-        api. AnsibleFailJson exception will be raised when the minimum is not met or exceeded.
-
-        This helper function will update the supplied api url if secure http is not used for embedded web services
-
-        :raise AnsibleFailJson: raised when the contacted api service does not meet the minimum required version.
-        """
-        if not self.is_web_services_valid_cache:
-
-            url_parts = urlparse(self.url)
-            if not url_parts.scheme or not url_parts.netloc:
-                self.module.fail_json(msg="Failed to provide valid API URL. Example: https://192.168.1.100:8443/devmgr/v2. URL [%s]." % self.url)
-
-            if url_parts.scheme not in ["http", "https"]:
-                self.module.fail_json(msg="Protocol must be http or https. URL [%s]." % self.url)
-
-            self.url = "%s://%s/" % (url_parts.scheme, url_parts.netloc)
-            about_url = self.url + self.DEFAULT_REST_API_ABOUT_PATH
-            rc, data = request(about_url, timeout=self.DEFAULT_TIMEOUT, headers=self.DEFAULT_HEADERS, ignore_errors=True, **self.creds)
-
-            if rc != 200:
-                self.module.warn("Failed to retrieve web services about information! Retrying with secure ports. Array Id [%s]." % self.ssid)
-                self.url = "https://%s:8443/" % url_parts.netloc.split(":")[0]
-                about_url = self.url + self.DEFAULT_REST_API_ABOUT_PATH
-                try:
-                    rc, data = request(about_url, timeout=self.DEFAULT_TIMEOUT, headers=self.DEFAULT_HEADERS, **self.creds)
-                except Exception as error:
-                    self.module.fail_json(msg="Failed to retrieve the webservices about information! Array Id [%s]. Error [%s]."
-                                              % (self.ssid, to_native(error)))
-
-            major, minor, other, revision = data["version"].split(".")
-            minimum_major, minimum_minor, other, minimum_revision = self.web_services_version.split(".")
-
-            if not (major > minimum_major or
-                    (major == minimum_major and minor > minimum_minor) or
-                    (major == minimum_major and minor == minimum_minor and revision >= minimum_revision)):
-                self.module.fail_json(msg="Web services version does not meet minimum version required. Current version: [%s]."
-                                          " Version required: [%s]." % (data["version"], self.web_services_version))
-
-            self.module.log("Web services rest api version met the minimum required version.")
-            self.is_web_services_valid_cache = True
-
-    def is_embedded(self):
-        """Determine whether web services server is the embedded web services.
-
-        If web services about endpoint fails based on an URLError then the request will be attempted again using
-        secure http.
-
-        :raise AnsibleFailJson: raised when web services about endpoint failed to be contacted.
-        :return bool: whether contacted web services is running from storage array (embedded) or from a proxy.
-        """
-        self._check_web_services_version()
-
-        if self.is_embedded_mode is None:
-            about_url = self.url + self.DEFAULT_REST_API_ABOUT_PATH
-            try:
-                rc, data = request(about_url, timeout=self.DEFAULT_TIMEOUT, headers=self.DEFAULT_HEADERS, **self.creds)
-                self.is_embedded_mode = not data["runningAsProxy"]
-            except Exception as error:
-                self.module.fail_json(msg="Failed to retrieve the webservices about information! Array Id [%s]. Error [%s]."
-                                          % (self.ssid, to_native(error)))
-
-        return self.is_embedded_mode
-
-    def request(self, path, data=None, method='GET', headers=None, ignore_errors=False):
-        """Issue an HTTP request to a url, retrieving an optional JSON response.
-
-        :param str path: web services rest api endpoint path (Example: storage-systems/1/graph). Note that when the
-        full url path is specified then that will be used without supplying the protocol, hostname, port and rest path.
-        :param data: data required for the request (data may be json or any python structured data)
-        :param str method: request method such as GET, POST, DELETE.
-        :param dict headers: dictionary containing request headers.
-        :param bool ignore_errors: forces the request to ignore any raised exceptions.
-        """
-        self._check_web_services_version()
-
-        if headers is None:
-            headers = self.DEFAULT_HEADERS
-
-        if not isinstance(data, str) and headers["Content-Type"] == "application/json":
-            data = json.dumps(data)
-
-        if path.startswith("/"):
-            path = path[1:]
-        request_url = self.url + self.DEFAULT_REST_API_PATH + path
-
-        # if self.log_requests:
-        self.module.log(pformat(dict(url=request_url, data=data, method=method)))
-
-        return request(url=request_url, data=data, method=method, headers=headers, use_proxy=True, force=False, last_mod_time=None,
-                       timeout=self.DEFAULT_TIMEOUT, http_agent=self.HTTP_AGENT, force_basic_auth=True, ignore_errors=ignore_errors, **self.creds)
-
-
-def create_multipart_formdata(files, fields=None, send_8kb=False):
-    """Create the data for a multipart/form request.
-
-    :param list(list) files: list of lists each containing (name, filename, path).
-    :param list(list) fields: list of lists each containing (key, value).
-    :param bool send_8kb: only sends the first 8kb of the files (default: False).
-    """
-    boundary = "---------------------------" + "".join([str(random.randint(0, 9)) for x in range(27)])
-    data_parts = list()
-    data = None
-
-    if six.PY2:  # Generate payload for Python 2
-        newline = "\r\n"
-        if fields is not None:
-            for key, value in fields:
-                data_parts.extend(["--%s" % boundary,
-                                   'Content-Disposition: form-data; name="%s"' % key,
-                                   "",
-                                   value])
-
-        for name, filename, path in files:
-            with open(path, "rb") as fh:
-                value = fh.read(8192) if send_8kb else fh.read()
-
-                data_parts.extend(["--%s" % boundary,
-                                   'Content-Disposition: form-data; name="%s"; filename="%s"' % (name, filename),
-                                   "Content-Type: %s" % (mimetypes.guess_type(path)[0] or "application/octet-stream"),
-                                   "",
-                                   value])
-        data_parts.extend(["--%s--" % boundary, ""])
-        data = newline.join(data_parts)
-
-    else:
-        newline = six.b("\r\n")
-        if fields is not None:
-            for key, value in fields:
-                data_parts.extend([six.b("--%s" % boundary),
-                                   six.b('Content-Disposition: form-data; name="%s"' % key),
-                                   six.b(""),
-                                   six.b(value)])
-
-        for name, filename, path in files:
-            with open(path, "rb") as fh:
-                value = fh.read(8192) if send_8kb else fh.read()
-
-                data_parts.extend([six.b("--%s" % boundary),
-                                   six.b('Content-Disposition: form-data; name="%s"; filename="%s"' % (name, filename)),
-                                   six.b("Content-Type: %s" % (mimetypes.guess_type(path)[0] or "application/octet-stream")),
-                                   six.b(""),
-                                   value])
-        data_parts.extend([six.b("--%s--" % boundary), b""])
-        data = newline.join(data_parts)
-
-    headers = {
-        "Content-Type": "multipart/form-data; boundary=%s" % boundary,
-        "Content-Length": str(len(data))}
-
-    return headers, data
-
-
-def request(url, data=None, headers=None, method='GET', use_proxy=True,
-            force=False, last_mod_time=None, timeout=10, validate_certs=True,
-            url_username=None, url_password=None, http_agent=None, force_basic_auth=True, ignore_errors=False):
-    """Issue an HTTP request to a url, retrieving an optional JSON response."""
-
-    if headers is None:
-        headers = {"Content-Type": "application/json", "Accept": "application/json"}
-    headers.update({"netapp-client-type": "Ansible-%s" % ansible_version})
-
-    if not http_agent:
-        http_agent = "Ansible / %s" % ansible_version
-
-    try:
-        r = open_url(url=url, data=data, headers=headers, method=method, use_proxy=use_proxy,
-                     force=force, last_mod_time=last_mod_time, timeout=timeout, validate_certs=validate_certs,
-                     url_username=url_username, url_password=url_password, http_agent=http_agent,
-                     force_basic_auth=force_basic_auth)
-    except HTTPError as err:
-        r = err.fp
-
-    try:
-        raw_data = r.read()
-        if raw_data:
-            data = json.loads(raw_data)
-        else:
-            raw_data = None
-    except Exception:
-        if ignore_errors:
-            pass
-        else:
-            raise Exception(raw_data)
-
-    resp_code = r.getcode()
-
-    if resp_code >= 400 and not ignore_errors:
-        raise Exception(resp_code, data)
-    else:
-        return resp_code, data
-
-
-def ems_log_event(source, server, name="Ansible", id="12345", version=ansible_version,
-                  category="Information", event="setup", autosupport="false"):
-    ems_log = zapi.NaElement('ems-autosupport-log')
-    # Host name invoking the API.
-    ems_log.add_new_child("computer-name", name)
-    # ID of event. A user defined event-id, range [0..2^32-2].
-    ems_log.add_new_child("event-id", id)
-    # Name of the application invoking the API.
-    ems_log.add_new_child("event-source", source)
-    # Version of application invoking the API.
-    ems_log.add_new_child("app-version", version)
-    # Application defined category of the event.
-    ems_log.add_new_child("category", category)
-    # Description of event to log. An application defined message to log.
-    ems_log.add_new_child("event-description", event)
-    ems_log.add_new_child("log-level", "6")
-    ems_log.add_new_child("auto-support", autosupport)
-    server.invoke_successfully(ems_log, True)
-
-
-def get_cserver_zapi(server):
-    vserver_info = zapi.NaElement('vserver-get-iter')
-    query_details = zapi.NaElement.create_node_with_children('vserver-info', **{'vserver-type': 'admin'})
-    query = zapi.NaElement('query')
-    query.add_child_elem(query_details)
-    vserver_info.add_child_elem(query)
-    result = server.invoke_successfully(vserver_info,
-                                        enable_tunneling=False)
-    attribute_list = result.get_child_by_name('attributes-list')
-    vserver_list = attribute_list.get_child_by_name('vserver-info')
-    return vserver_list.get_child_content('vserver-name')
-
-
-def get_cserver(connection, is_rest=False):
-    if not is_rest:
-        return get_cserver_zapi(connection)
-
-    params = {'fields': 'type'}
-    api = "private/cli/vserver"
-    json, error = connection.get(api, params)
-    if json is None or error is not None:
-        # exit if there is an error or no data
-        return None
-    vservers = json.get('records')
-    if vservers is not None:
-        for vserver in vservers:
-            if vserver['type'] == 'admin':     # cluster admin
-                return vserver['vserver']
-        if len(vservers) == 1:                  # assume vserver admin
-            return vservers[0]['vserver']
-
-    return None
-
-
-class OntapRestAPI(object):
-    def __init__(self, module, timeout=60):
-        self.module = module
-        self.username = self.module.params['username']
-        self.password = self.module.params['password']
-        self.hostname = self.module.params['hostname']
-        self.use_rest = self.module.params['use_rest']
-        self.verify = self.module.params['validate_certs']
-        self.timeout = timeout
-        self.url = 'https://' + self.hostname + '/api/'
-        self.errors = list()
-        self.debug_logs = list()
-        self.check_required_library()
-
-    def check_required_library(self):
-        if not HAS_REQUESTS:
-            self.module.fail_json(msg=missing_required_lib('requests'))
-
-    def send_request(self, method, api, params, json=None, return_status_code=False):
-        ''' send http request and process reponse, including error conditions '''
-        url = self.url + api
-        status_code = None
-        content = None
-        json_dict = None
-        json_error = None
-        error_details = None
-
-        def get_json(response):
-            ''' extract json, and error message if present '''
-            try:
-                json = response.json()
-            except ValueError:
-                return None, None
-            error = json.get('error')
-            return json, error
-
-        try:
-            response = requests.request(method, url, verify=self.verify, auth=(self.username, self.password), params=params, timeout=self.timeout, json=json)
-            content = response.content  # for debug purposes
-            status_code = response.status_code
-            # If the response was successful, no Exception will be raised
-            response.raise_for_status()
-            json_dict, json_error = get_json(response)
-        except requests.exceptions.HTTPError as err:
-            __, json_error = get_json(response)
-            if json_error is None:
-                self.log_error(status_code, 'HTTP error: %s' % err)
-                error_details = str(err)
-            # If an error was reported in the json payload, it is handled below
-        except requests.exceptions.ConnectionError as err:
-            self.log_error(status_code, 'Connection error: %s' % err)
-            error_details = str(err)
-        except Exception as err:
-            self.log_error(status_code, 'Other error: %s' % err)
-            error_details = str(err)
-        if json_error is not None:
-            self.log_error(status_code, 'Endpoint error: %d: %s' % (status_code, json_error))
-            error_details = json_error
-        self.log_debug(status_code, content)
-        if return_status_code:
-            return status_code, error_details
-        return json_dict, error_details
-
-    def get(self, api, params):
-        method = 'GET'
-        return self.send_request(method, api, params)
-
-    def post(self, api, data, params=None):
-        method = 'POST'
-        return self.send_request(method, api, params, json=data)
-
-    def patch(self, api, data, params=None):
-        method = 'PATCH'
-        return self.send_request(method, api, params, json=data)
-
-    def delete(self, api, data, params=None):
-        method = 'DELETE'
-        return self.send_request(method, api, params, json=data)
-
-    def _is_rest(self, used_unsupported_rest_properties=None):
-        if self.use_rest == "Always":
-            if used_unsupported_rest_properties:
-                error = "REST API currently does not support '%s'" % \
-                        ', '.join(used_unsupported_rest_properties)
-                return True, error
-            else:
-                return True, None
-        if self.use_rest == 'Never' or used_unsupported_rest_properties:
-            # force ZAPI if requested or if some parameter requires it
-            return False, None
-        method = 'HEAD'
-        api = 'cluster/software'
-        status_code, __ = self.send_request(method, api, params=None, return_status_code=True)
-        if status_code == 200:
-            return True, None
-        return False, None
-
-    def is_rest(self, used_unsupported_rest_properties=None):
-        ''' only return error if there is a reason to '''
-        use_rest, error = self._is_rest(used_unsupported_rest_properties)
-        if used_unsupported_rest_properties is None:
-            return use_rest
-        return use_rest, error
-
-    def log_error(self, status_code, message):
-        self.errors.append(message)
-        self.debug_logs.append((status_code, message))
-
-    def log_debug(self, status_code, content):
-        self.debug_logs.append((status_code, content))
-
-
-class AwsCvsRestAPI(object):
-    def __init__(self, module, timeout=60):
-        self.module = module
-        self.api_key = self.module.params['api_key']
-        self.secret_key = self.module.params['secret_key']
-        self.api_url = self.module.params['api_url']
-        self.verify = self.module.params['validate_certs']
-        self.timeout = timeout
-        self.url = 'https://' + self.api_url + '/v1/'
-        self.check_required_library()
-
-    def check_required_library(self):
-        if not HAS_REQUESTS:
-            self.module.fail_json(msg=missing_required_lib('requests'))
-
-    def send_request(self, method, api, params, json=None):
-        ''' send http request and process reponse, including error conditions '''
-        url = self.url + api
-        status_code = None
-        content = None
-        json_dict = None
-        json_error = None
-        error_details = None
-        headers = {
-            'Content-type': "application/json",
-            'api-key': self.api_key,
-            'secret-key': self.secret_key,
-            'Cache-Control': "no-cache",
-        }
-
-        def get_json(response):
-            ''' extract json, and error message if present '''
-            try:
-                json = response.json()
-
-            except ValueError:
-                return None, None
-            success_code = [200, 201, 202]
-            if response.status_code not in success_code:
-                error = json.get('message')
-            else:
-                error = None
-            return json, error
-        try:
-            response = requests.request(method, url, headers=headers, timeout=self.timeout, json=json)
-            status_code = response.status_code
-            # If the response was successful, no Exception will be raised
-            json_dict, json_error = get_json(response)
-        except requests.exceptions.HTTPError as err:
-            __, json_error = get_json(response)
-            if json_error is None:
-                error_details = str(err)
-        except requests.exceptions.ConnectionError as err:
-            error_details = str(err)
-        except Exception as err:
-            error_details = str(err)
-        if json_error is not None:
-            error_details = json_error
-
-        return json_dict, error_details
-
-    # If an error was reported in the json payload, it is handled below
-    def get(self, api, params=None):
-        method = 'GET'
-        return self.send_request(method, api, params)
-
-    def post(self, api, data, params=None):
-        method = 'POST'
-        return self.send_request(method, api, params, json=data)
-
-    def patch(self, api, data, params=None):
-        method = 'PATCH'
-        return self.send_request(method, api, params, json=data)
-
-    def put(self, api, data, params=None):
-        method = 'PUT'
-        return self.send_request(method, api, params, json=data)
-
-    def delete(self, api, data, params=None):
-        method = 'DELETE'
-        return self.send_request(method, api, params, json=data)
-
-    def get_state(self, jobId):
-        """ Method to get the state of the job """
-        method = 'GET'
-        response, status_code = self.get('Jobs/%s' % jobId)
-        while str(response['state']) not in 'done':
-            response, status_code = self.get('Jobs/%s' % jobId)
-        return 'done'

plugins/module_utils/_version.py

@@ -1,343 +0,0 @@
-# Vendored copy of distutils/version.py from CPython 3.9.5
-#
-# Implements multiple version numbering conventions for the
-# Python Module Distribution Utilities.
-#
-# PSF License (see licenses/PSF-license.txt or https://opensource.org/licenses/Python-2.0)
-#
-
-"""Provides classes to represent module version numbers (one class for
-each style of version numbering).  There are currently two such classes
-implemented: StrictVersion and LooseVersion.
-
-Every version number class implements the following interface:
-  * the 'parse' method takes a string and parses it to some internal
-    representation; if the string is an invalid version number,
-    'parse' raises a ValueError exception
-  * the class constructor takes an optional string argument which,
-    if supplied, is passed to 'parse'
-  * __str__ reconstructs the string that was passed to 'parse' (or
-    an equivalent string -- ie. one that will generate an equivalent
-    version number instance)
-  * __repr__ generates Python code to recreate the version number instance
-  * _cmp compares the current instance with either another instance
-    of the same class or a string (which will be parsed to an instance
-    of the same class, thus must follow the same rules)
-"""
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import re
-
-try:
-    RE_FLAGS = re.VERBOSE | re.ASCII
-except AttributeError:
-    RE_FLAGS = re.VERBOSE
-
-
-class Version:
-    """Abstract base class for version numbering classes.  Just provides
-    constructor (__init__) and reproducer (__repr__), because those
-    seem to be the same for all version numbering classes; and route
-    rich comparisons to _cmp.
-    """
-
-    def __init__(self, vstring=None):
-        if vstring:
-            self.parse(vstring)
-
-    def __repr__(self):
-        return "%s ('%s')" % (self.__class__.__name__, str(self))
-
-    def __eq__(self, other):
-        c = self._cmp(other)
-        if c is NotImplemented:
-            return c
-        return c == 0
-
-    def __lt__(self, other):
-        c = self._cmp(other)
-        if c is NotImplemented:
-            return c
-        return c < 0
-
-    def __le__(self, other):
-        c = self._cmp(other)
-        if c is NotImplemented:
-            return c
-        return c <= 0
-
-    def __gt__(self, other):
-        c = self._cmp(other)
-        if c is NotImplemented:
-            return c
-        return c > 0
-
-    def __ge__(self, other):
-        c = self._cmp(other)
-        if c is NotImplemented:
-            return c
-        return c >= 0
-
-
-# Interface for version-number classes -- must be implemented
-# by the following classes (the concrete ones -- Version should
-# be treated as an abstract class).
-#    __init__ (string) - create and take same action as 'parse'
-#                        (string parameter is optional)
-#    parse (string)    - convert a string representation to whatever
-#                        internal representation is appropriate for
-#                        this style of version numbering
-#    __str__ (self)    - convert back to a string; should be very similar
-#                        (if not identical to) the string supplied to parse
-#    __repr__ (self)   - generate Python code to recreate
-#                        the instance
-#    _cmp (self, other) - compare two version numbers ('other' may
-#                        be an unparsed version string, or another
-#                        instance of your version class)
-
-
-class StrictVersion(Version):
-    """Version numbering for anal retentives and software idealists.
-    Implements the standard interface for version number classes as
-    described above.  A version number consists of two or three
-    dot-separated numeric components, with an optional "pre-release" tag
-    on the end.  The pre-release tag consists of the letter 'a' or 'b'
-    followed by a number.  If the numeric components of two version
-    numbers are equal, then one with a pre-release tag will always
-    be deemed earlier (lesser) than one without.
-
-    The following are valid version numbers (shown in the order that
-    would be obtained by sorting according to the supplied cmp function):
-
-        0.4       0.4.0  (these two are equivalent)
-        0.4.1
-        0.5a1
-        0.5b3
-        0.5
-        0.9.6
-        1.0
-        1.0.4a3
-        1.0.4b1
-        1.0.4
-
-    The following are examples of invalid version numbers:
-
-        1
-        2.7.2.2
-        1.3.a4
-        1.3pl1
-        1.3c4
-
-    The rationale for this version numbering system will be explained
-    in the distutils documentation.
-    """
-
-    version_re = re.compile(r'^(\d+) \. (\d+) (\. (\d+))? ([ab](\d+))?$',
-                            RE_FLAGS)
-
-    def parse(self, vstring):
-        match = self.version_re.match(vstring)
-        if not match:
-            raise ValueError("invalid version number '%s'" % vstring)
-
-        (major, minor, patch, prerelease, prerelease_num) = \
-            match.group(1, 2, 4, 5, 6)
-
-        if patch:
-            self.version = tuple(map(int, [major, minor, patch]))
-        else:
-            self.version = tuple(map(int, [major, minor])) + (0,)
-
-        if prerelease:
-            self.prerelease = (prerelease[0], int(prerelease_num))
-        else:
-            self.prerelease = None
-
-    def __str__(self):
-        if self.version[2] == 0:
-            vstring = '.'.join(map(str, self.version[0:2]))
-        else:
-            vstring = '.'.join(map(str, self.version))
-
-        if self.prerelease:
-            vstring = vstring + self.prerelease[0] + str(self.prerelease[1])
-
-        return vstring
-
-    def _cmp(self, other):
-        if isinstance(other, str):
-            other = StrictVersion(other)
-        elif not isinstance(other, StrictVersion):
-            return NotImplemented
-
-        if self.version != other.version:
-            # numeric versions don't match
-            # prerelease stuff doesn't matter
-            if self.version < other.version:
-                return -1
-            else:
-                return 1
-
-        # have to compare prerelease
-        # case 1: neither has prerelease; they're equal
-        # case 2: self has prerelease, other doesn't; other is greater
-        # case 3: self doesn't have prerelease, other does: self is greater
-        # case 4: both have prerelease: must compare them!
-
-        if (not self.prerelease and not other.prerelease):
-            return 0
-        elif (self.prerelease and not other.prerelease):
-            return -1
-        elif (not self.prerelease and other.prerelease):
-            return 1
-        elif (self.prerelease and other.prerelease):
-            if self.prerelease == other.prerelease:
-                return 0
-            elif self.prerelease < other.prerelease:
-                return -1
-            else:
-                return 1
-        else:
-            raise AssertionError("never get here")
-
-# end class StrictVersion
-
-# The rules according to Greg Stein:
-# 1) a version number has 1 or more numbers separated by a period or by
-#    sequences of letters. If only periods, then these are compared
-#    left-to-right to determine an ordering.
-# 2) sequences of letters are part of the tuple for comparison and are
-#    compared lexicographically
-# 3) recognize the numeric components may have leading zeroes
-#
-# The LooseVersion class below implements these rules: a version number
-# string is split up into a tuple of integer and string components, and
-# comparison is a simple tuple comparison.  This means that version
-# numbers behave in a predictable and obvious way, but a way that might
-# not necessarily be how people *want* version numbers to behave.  There
-# wouldn't be a problem if people could stick to purely numeric version
-# numbers: just split on period and compare the numbers as tuples.
-# However, people insist on putting letters into their version numbers;
-# the most common purpose seems to be:
-#   - indicating a "pre-release" version
-#     ('alpha', 'beta', 'a', 'b', 'pre', 'p')
-#   - indicating a post-release patch ('p', 'pl', 'patch')
-# but of course this can't cover all version number schemes, and there's
-# no way to know what a programmer means without asking him.
-#
-# The problem is what to do with letters (and other non-numeric
-# characters) in a version number.  The current implementation does the
-# obvious and predictable thing: keep them as strings and compare
-# lexically within a tuple comparison.  This has the desired effect if
-# an appended letter sequence implies something "post-release":
-# eg. "0.99" < "0.99pl14" < "1.0", and "5.001" < "5.001m" < "5.002".
-#
-# However, if letters in a version number imply a pre-release version,
-# the "obvious" thing isn't correct.  Eg. you would expect that
-# "1.5.1" < "1.5.2a2" < "1.5.2", but under the tuple/lexical comparison
-# implemented here, this just isn't so.
-#
-# Two possible solutions come to mind.  The first is to tie the
-# comparison algorithm to a particular set of semantic rules, as has
-# been done in the StrictVersion class above.  This works great as long
-# as everyone can go along with bondage and discipline.  Hopefully a
-# (large) subset of Python module programmers will agree that the
-# particular flavour of bondage and discipline provided by StrictVersion
-# provides enough benefit to be worth using, and will submit their
-# version numbering scheme to its domination.  The free-thinking
-# anarchists in the lot will never give in, though, and something needs
-# to be done to accommodate them.
-#
-# Perhaps a "moderately strict" version class could be implemented that
-# lets almost anything slide (syntactically), and makes some heuristic
-# assumptions about non-digits in version number strings.  This could
-# sink into special-case-hell, though; if I was as talented and
-# idiosyncratic as Larry Wall, I'd go ahead and implement a class that
-# somehow knows that "1.2.1" < "1.2.2a2" < "1.2.2" < "1.2.2pl3", and is
-# just as happy dealing with things like "2g6" and "1.13++".  I don't
-# think I'm smart enough to do it right though.
-#
-# In any case, I've coded the test suite for this module (see
-# ../test/test_version.py) specifically to fail on things like comparing
-# "1.2a2" and "1.2".  That's not because the *code* is doing anything
-# wrong, it's because the simple, obvious design doesn't match my
-# complicated, hairy expectations for real-world version numbers.  It
-# would be a snap to fix the test suite to say, "Yep, LooseVersion does
-# the Right Thing" (ie. the code matches the conception).  But I'd rather
-# have a conception that matches common notions about version numbers.
-
-
-class LooseVersion(Version):
-    """Version numbering for anarchists and software realists.
-    Implements the standard interface for version number classes as
-    described above.  A version number consists of a series of numbers,
-    separated by either periods or strings of letters.  When comparing
-    version numbers, the numeric components will be compared
-    numerically, and the alphabetic components lexically.  The following
-    are all valid version numbers, in no particular order:
-
-        1.5.1
-        1.5.2b2
-        161
-        3.10a
-        8.02
-        3.4j
-        1996.07.12
-        3.2.pl0
-        3.1.1.6
-        2g6
-        11g
-        0.960923
-        2.2beta29
-        1.13++
-        5.5.kw
-        2.0b1pl0
-
-    In fact, there is no such thing as an invalid version number under
-    this scheme; the rules for comparison are simple and predictable,
-    but may not always give the results you want (for some definition
-    of "want").
-    """
-
-    component_re = re.compile(r'(\d+ | [a-z]+ | \.)', re.VERBOSE)
-
-    def __init__(self, vstring=None):
-        if vstring:
-            self.parse(vstring)
-
-    def parse(self, vstring):
-        # I've given up on thinking I can reconstruct the version string
-        # from the parsed tuple -- so I just store the string here for
-        # use by __str__
-        self.vstring = vstring
-        components = [x for x in self.component_re.split(vstring) if x and x != '.']
-        for i, obj in enumerate(components):
-            try:
-                components[i] = int(obj)
-            except ValueError:
-                pass
-
-        self.version = components
-
-    def __str__(self):
-        return self.vstring
-
-    def __repr__(self):
-        return "LooseVersion ('%s')" % str(self)
-
-    def _cmp(self, other):
-        if isinstance(other, str):
-            other = LooseVersion(other)
-        elif not isinstance(other, LooseVersion):
-            return NotImplemented
-
-        if self.version == other.version:
-            return 0
-        if self.version < other.version:
-            return -1
-        if self.version > other.version:
-            return 1
-
-# end class LooseVersion

plugins/module_utils/gitlab.py

@@ -7,55 +7,41 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import json
+from distutils.version import StrictVersion
 
 from ansible.module_utils.basic import missing_required_lib
-from ansible.module_utils.urls import fetch_url
 from ansible.module_utils.common.text.converters import to_native
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 try:
     from urllib import quote_plus  # Python 2.X
+    from urlparse import urljoin
 except ImportError:
-    from urllib.parse import quote_plus  # Python 3+
+    from urllib.parse import quote_plus, urljoin  # Python 3+
 
 import traceback
 
 GITLAB_IMP_ERR = None
 try:
     import gitlab
+    import requests
     HAS_GITLAB_PACKAGE = True
 except Exception:
     GITLAB_IMP_ERR = traceback.format_exc()
     HAS_GITLAB_PACKAGE = False
 
 
-def request(module, api_url, project, path, access_token, private_token, rawdata='', method='GET'):
-    url = "%s/v4/projects/%s%s" % (api_url, quote_plus(project), path)
-    headers = {}
-    if access_token:
-        headers['Authorization'] = "Bearer %s" % access_token
-    else:
-        headers['Private-Token'] = private_token
-
-    headers['Accept'] = "application/json"
-    headers['Content-Type'] = "application/json"
-
-    response, info = fetch_url(module=module, url=url, headers=headers, data=rawdata, method=method)
-    status = info['status']
-    content = ""
-    if response:
-        content = response.read()
-    if status == 204:
-        return True, content
-    elif status == 200 or status == 201:
-        return True, json.loads(content)
-    else:
-        return False, str(status) + ": " + content
+def auth_argument_spec(spec=None):
+    arg_spec = (dict(
+        api_token=dict(type='str', no_log=True),
+        api_oauth_token=dict(type='str', no_log=True),
+        api_job_token=dict(type='str', no_log=True),
+    ))
+    if spec:
+        arg_spec.update(spec)
+    return arg_spec
 
 
-def findProject(gitlab_instance, identifier):
+def find_project(gitlab_instance, identifier):
     try:
         project = gitlab_instance.projects.get(identifier)
     except Exception as e:
@@ -68,7 +54,7 @@ def findProject(gitlab_instance, identifier):
     return project
 
 
-def findGroup(gitlab_instance, identifier):
+def find_group(gitlab_instance, identifier):
     try:
         project = gitlab_instance.groups.get(identifier)
     except Exception as e:
@@ -77,12 +63,14 @@ def findGroup(gitlab_instance, identifier):
     return project
 
 
-def gitlabAuthentication(module):
+def gitlab_authentication(module):
     gitlab_url = module.params['api_url']
     validate_certs = module.params['validate_certs']
     gitlab_user = module.params['api_username']
     gitlab_password = module.params['api_password']
     gitlab_token = module.params['api_token']
+    gitlab_oauth_token = module.params['api_oauth_token']
+    gitlab_job_token = module.params['api_job_token']
 
     if not HAS_GITLAB_PACKAGE:
         module.fail_json(msg=missing_required_lib("python-gitlab"), exception=GITLAB_IMP_ERR)
@@ -91,11 +79,20 @@ def gitlabAuthentication(module):
         # python-gitlab library remove support for username/password authentication since 1.13.0
         # Changelog : https://github.com/python-gitlab/python-gitlab/releases/tag/v1.13.0
         # This condition allow to still support older version of the python-gitlab library
-        if LooseVersion(gitlab.__version__) < LooseVersion("1.13.0"):
+        if StrictVersion(gitlab.__version__) < StrictVersion("1.13.0"):
             gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=validate_certs, email=gitlab_user, password=gitlab_password,
                                             private_token=gitlab_token, api_version=4)
         else:
-            gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=validate_certs, private_token=gitlab_token, api_version=4)
+            # We can create an oauth_token using a username and password
+            # https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow
+            if gitlab_user:
+                data = {'grant_type': 'password', 'username': gitlab_user, 'password': gitlab_password}
+                resp = requests.post(urljoin(gitlab_url, "oauth/token"), data=data, verify=validate_certs)
+                resp_data = resp.json()
+                gitlab_oauth_token = resp_data["access_token"]
+
+            gitlab_instance = gitlab.Gitlab(url=gitlab_url, ssl_verify=validate_certs, private_token=gitlab_token,
+                                            oauth_token=gitlab_oauth_token, job_token=gitlab_job_token, api_version=4)
 
         gitlab_instance.auth()
     except (gitlab.exceptions.GitlabAuthenticationError, gitlab.exceptions.GitlabGetError) as e:

plugins/module_utils/ilo_redfish_utils.py

@@ -0,0 +1,232 @@
+# -*- 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)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible_collections.community.general.plugins.module_utils.redfish_utils import RedfishUtils
+
+
+class iLORedfishUtils(RedfishUtils):
+
+    def get_ilo_sessions(self):
+        result = {}
+        # listing all users has always been slower than other operations, why?
+        session_list = []
+        sessions_results = []
+        # Get these entries, but does not fail if not found
+        properties = ['Description', 'Id', 'Name', 'UserName']
+
+        # Changed self.sessions_uri to Hardcoded string.
+        response = self.get_request(
+            self.root_uri + self.service_root + "SessionService/Sessions/")
+        if not response['ret']:
+            return response
+        result['ret'] = True
+        data = response['data']
+
+        if 'Oem' in data:
+            if data["Oem"]["Hpe"]["Links"]["MySession"]["@odata.id"]:
+                current_session = data["Oem"]["Hpe"]["Links"]["MySession"]["@odata.id"]
+
+        for sessions in data[u'Members']:
+            # session_list[] are URIs
+            session_list.append(sessions[u'@odata.id'])
+        # for each session, get details
+        for uri in session_list:
+            session = {}
+            if uri != current_session:
+                response = self.get_request(self.root_uri + uri)
+                if not response['ret']:
+                    return response
+                data = response['data']
+                for property in properties:
+                    if property in data:
+                        session[property] = data[property]
+                sessions_results.append(session)
+        result["msg"] = sessions_results
+        result["ret"] = True
+        return result
+
+    def set_ntp_server(self, mgr_attributes):
+        result = {}
+        setkey = mgr_attributes['mgr_attr_name']
+
+        nic_info = self.get_manager_ethernet_uri()
+        ethuri = nic_info["nic_addr"]
+
+        response = self.get_request(self.root_uri + ethuri)
+        if not response['ret']:
+            return response
+        result['ret'] = True
+        data = response['data']
+        payload = {"DHCPv4": {
+            "UseNTPServers": ""
+        }}
+
+        if data["DHCPv4"]["UseNTPServers"]:
+            payload["DHCPv4"]["UseNTPServers"] = False
+            res_dhv4 = self.patch_request(self.root_uri + ethuri, payload)
+            if not res_dhv4['ret']:
+                return res_dhv4
+
+        payload = {"DHCPv6": {
+            "UseNTPServers": ""
+        }}
+
+        if data["DHCPv6"]["UseNTPServers"]:
+            payload["DHCPv6"]["UseNTPServers"] = False
+            res_dhv6 = self.patch_request(self.root_uri + ethuri, payload)
+            if not res_dhv6['ret']:
+                return res_dhv6
+
+        datetime_uri = self.manager_uri + "DateTime"
+
+        response = self.get_request(self.root_uri + datetime_uri)
+        if not response['ret']:
+            return response
+
+        data = response['data']
+
+        ntp_list = data[setkey]
+        if(len(ntp_list) == 2):
+            ntp_list.pop(0)
+
+        ntp_list.append(mgr_attributes['mgr_attr_value'])
+
+        payload = {setkey: ntp_list}
+
+        response1 = self.patch_request(self.root_uri + datetime_uri, payload)
+        if not response1['ret']:
+            return response1
+
+        return {'ret': True, 'changed': True, 'msg': "Modified %s" % mgr_attributes['mgr_attr_name']}
+
+    def set_time_zone(self, attr):
+        key = attr['mgr_attr_name']
+
+        uri = self.manager_uri + "DateTime/"
+        response = self.get_request(self.root_uri + uri)
+        if not response['ret']:
+            return response
+
+        data = response["data"]
+
+        if key not in data:
+            return {'ret': False, 'changed': False, 'msg': "Key %s not found" % key}
+
+        timezones = data["TimeZoneList"]
+        index = ""
+        for tz in timezones:
+            if attr['mgr_attr_value'] in tz["Name"]:
+                index = tz["Index"]
+                break
+
+        payload = {key: {"Index": index}}
+        response = self.patch_request(self.root_uri + uri, payload)
+        if not response['ret']:
+            return response
+
+        return {'ret': True, 'changed': True, 'msg': "Modified %s" % attr['mgr_attr_name']}
+
+    def set_dns_server(self, attr):
+        key = attr['mgr_attr_name']
+        nic_info = self.get_manager_ethernet_uri()
+        uri = nic_info["nic_addr"]
+
+        response = self.get_request(self.root_uri + uri)
+        if not response['ret']:
+            return response
+
+        data = response['data']
+
+        dns_list = data["Oem"]["Hpe"]["IPv4"][key]
+
+        if len(dns_list) == 3:
+            dns_list.pop(0)
+
+        dns_list.append(attr['mgr_attr_value'])
+
+        payload = {
+            "Oem": {
+                "Hpe": {
+                    "IPv4": {
+                        key: dns_list
+                    }
+                }
+            }
+        }
+
+        response = self.patch_request(self.root_uri + uri, payload)
+        if not response['ret']:
+            return response
+
+        return {'ret': True, 'changed': True, 'msg': "Modified %s" % attr['mgr_attr_name']}
+
+    def set_domain_name(self, attr):
+        key = attr['mgr_attr_name']
+
+        nic_info = self.get_manager_ethernet_uri()
+        ethuri = nic_info["nic_addr"]
+
+        response = self.get_request(self.root_uri + ethuri)
+        if not response['ret']:
+            return response
+
+        data = response['data']
+
+        payload = {"DHCPv4": {
+            "UseDomainName": ""
+        }}
+
+        if data["DHCPv4"]["UseDomainName"]:
+            payload["DHCPv4"]["UseDomainName"] = False
+            res_dhv4 = self.patch_request(self.root_uri + ethuri, payload)
+            if not res_dhv4['ret']:
+                return res_dhv4
+
+        payload = {"DHCPv6": {
+            "UseDomainName": ""
+        }}
+
+        if data["DHCPv6"]["UseDomainName"]:
+            payload["DHCPv6"]["UseDomainName"] = False
+            res_dhv6 = self.patch_request(self.root_uri + ethuri, payload)
+            if not res_dhv6['ret']:
+                return res_dhv6
+
+        domain_name = attr['mgr_attr_value']
+
+        payload = {"Oem": {
+            "Hpe": {
+                key: domain_name
+            }
+        }}
+
+        response = self.patch_request(self.root_uri + ethuri, payload)
+        if not response['ret']:
+            return response
+        return {'ret': True, 'changed': True, 'msg': "Modified %s" % attr['mgr_attr_name']}
+
+    def set_wins_registration(self, mgrattr):
+        Key = mgrattr['mgr_attr_name']
+
+        nic_info = self.get_manager_ethernet_uri()
+        ethuri = nic_info["nic_addr"]
+
+        payload = {
+            "Oem": {
+                "Hpe": {
+                    "IPv4": {
+                        Key: False
+                    }
+                }
+            }
+        }
+
+        response = self.patch_request(self.root_uri + ethuri, payload)
+        if not response['ret']:
+            return response
+        return {'ret': True, 'changed': True, 'msg': "Modified %s" % mgrattr['mgr_attr_name']}

plugins/module_utils/influxdb.py

@@ -9,8 +9,7 @@ __metaclass__ = type
 import traceback
 
 from ansible.module_utils.basic import missing_required_lib
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:

plugins/module_utils/ipa.py

@@ -179,10 +179,10 @@ class IPAClient(object):
                 result.append(key)
         return result
 
-    def modify_if_diff(self, name, ipa_list, module_list, add_method, remove_method, item=None):
+    def modify_if_diff(self, name, ipa_list, module_list, add_method, remove_method, item=None, append=None):
         changed = False
         diff = list(set(ipa_list) - set(module_list))
-        if len(diff) > 0:
+        if append is not True and len(diff) > 0:
             changed = True
             if not self.module.check_mode:
                 if item:

plugins/module_utils/mh/deco.py

@@ -52,3 +52,36 @@ def module_fails_on_exception(func):
             self.module.fail_json(msg=msg, exception=traceback.format_exc(),
                                   output=self.output, vars=self.vars.output(), **self.output)
     return wrapper
+
+
+def check_mode_skip(func):
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        if not self.module.check_mode:
+            return func(self, *args, **kwargs)
+    return wrapper
+
+
+def check_mode_skip_returns(callable=None, value=None):
+
+    def deco(func):
+        if callable is not None:
+            @wraps(func)
+            def wrapper_callable(self, *args, **kwargs):
+                if self.module.check_mode:
+                    return callable(self, *args, **kwargs)
+                return func(self, *args, **kwargs)
+            return wrapper_callable
+
+        if value is not None:
+            @wraps(func)
+            def wrapper_value(self, *args, **kwargs):
+                if self.module.check_mode:
+                    return value
+                return func(self, *args, **kwargs)
+            return wrapper_value
+
+    if callable is None and value is None:
+        return check_mode_skip
+
+    return deco

plugins/module_utils/mh/mixins/cmd.py

@@ -141,11 +141,7 @@ class CmdMixin(object):
                     fmt = find_format(param)
                     value = extra_params[param]
                 else:
-                    self.module.deprecate("Cannot determine value for parameter: {0}. "
-                                          "From version 4.0.0 onwards this will generate an exception".format(param),
-                                          version="4.0.0", collection_name="community.general")
-                    continue
-
+                    raise self.ModuleHelperException('Cannot determine value for parameter: {0}'.format(param))
             else:
                 raise self.ModuleHelperException("run_command parameter must be either a str or a dict: {0}".format(param))
             cmd_args = add_arg_formatted_param(cmd_args, fmt, value)
@@ -162,8 +158,9 @@ class CmdMixin(object):
                     publish_rc=True,
                     publish_out=True,
                     publish_err=True,
+                    publish_cmd=True,
                     *args, **kwargs):
-        self.vars.cmd_args = self._calculate_args(extra_params, params)
+        cmd_args = self._calculate_args(extra_params, params)
         options = dict(self.run_command_fixed_options)
         options['check_rc'] = options.get('check_rc', self.check_rc)
         options.update(kwargs)
@@ -175,13 +172,15 @@ class CmdMixin(object):
             })
             self.update_output(force_lang=self.force_lang)
             options['environ_update'] = env_update
-        rc, out, err = self.module.run_command(self.vars.cmd_args, *args, **options)
+        rc, out, err = self.module.run_command(cmd_args, *args, **options)
         if publish_rc:
             self.update_output(rc=rc)
         if publish_out:
             self.update_output(stdout=out)
         if publish_err:
             self.update_output(stderr=err)
+        if publish_cmd:
+            self.update_output(cmd_args=cmd_args)
         if process_output is None:
             _process = self.process_command_output
         else:

plugins/module_utils/mh/mixins/deprecate_attrs.py

@@ -0,0 +1,61 @@
+# -*- 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)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+class DeprecateAttrsMixin(object):
+
+    def _deprecate_setup(self, attr, target, module):
+        if target is None:
+            target = self
+        if not hasattr(target, attr):
+            raise ValueError("Target {0} has no attribute {1}".format(target, attr))
+        if module is None:
+            if isinstance(target, AnsibleModule):
+                module = target
+            elif hasattr(target, "module") and isinstance(target.module, AnsibleModule):
+                module = target.module
+            else:
+                raise ValueError("Failed to automatically discover the AnsibleModule instance. Pass 'module' parameter explicitly.")
+
+        # setup internal state dicts
+        value_attr = "__deprecated_attr_value"
+        trigger_attr = "__deprecated_attr_trigger"
+        if not hasattr(target, value_attr):
+            setattr(target, value_attr, {})
+        if not hasattr(target, trigger_attr):
+            setattr(target, trigger_attr, {})
+        value_dict = getattr(target, value_attr)
+        trigger_dict = getattr(target, trigger_attr)
+        return target, module, value_dict, trigger_dict
+
+    def _deprecate_attr(self, attr, msg, version=None, date=None, collection_name=None, target=None, value=None, module=None):
+        target, module, value_dict, trigger_dict = self._deprecate_setup(attr, target, module)
+
+        value_dict[attr] = getattr(target, attr, value)
+        trigger_dict[attr] = False
+
+        def _trigger():
+            if not trigger_dict[attr]:
+                module.deprecate(msg, version=version, date=date, collection_name=collection_name)
+                trigger_dict[attr] = True
+
+        def _getter(_self):
+            _trigger()
+            return value_dict[attr]
+
+        def _setter(_self, new_value):
+            _trigger()
+            value_dict[attr] = new_value
+
+        # override attribute
+        prop = property(_getter)
+        setattr(target, attr, prop)
+        setattr(target, "_{0}_setter".format(attr), prop.setter(_setter))

plugins/module_utils/mh/module_helper.py

@@ -13,9 +13,10 @@ from ansible_collections.community.general.plugins.module_utils.mh.mixins.cmd im
 from ansible_collections.community.general.plugins.module_utils.mh.mixins.state import StateMixin
 from ansible_collections.community.general.plugins.module_utils.mh.mixins.deps import DependencyMixin
 from ansible_collections.community.general.plugins.module_utils.mh.mixins.vars import VarsMixin, VarDict as _VD
+from ansible_collections.community.general.plugins.module_utils.mh.mixins.deprecate_attrs import DeprecateAttrsMixin
 
 
-class ModuleHelper(VarsMixin, DependencyMixin, ModuleHelperBase):
+class ModuleHelper(DeprecateAttrsMixin, VarsMixin, DependencyMixin, ModuleHelperBase):
     _output_conflict_list = ('msg', 'exception', 'output', 'vars', 'changed')
     facts_name = None
     output_params = ()
@@ -36,6 +37,15 @@ class ModuleHelper(VarsMixin, DependencyMixin, ModuleHelperBase):
                 fact=name in self.facts_params,
             )
 
+        self._deprecate_attr(
+            attr="VarDict",
+            msg="ModuleHelper.VarDict attribute is deprecated, use VarDict from "
+                "the ansible_collections.community.general.plugins.module_utils.mh.mixins.vars module instead",
+            version="6.0.0",
+            collection_name="community.general",
+            target=ModuleHelper,
+            module=self.module)
+
     def update_output(self, **kwargs):
         self.update_vars(meta={"output": True}, **kwargs)
 

plugins/module_utils/net_tools/nios/api.py

@@ -1,598 +0,0 @@
-# -*- coding: utf-8 -*-
-# This code is part of Ansible, but is an independent component.
-# This particular file snippet, and this file snippet only, is BSD licensed.
-# Modules you write using this snippet, which is embedded dynamically by Ansible
-# still belong to the author of the module, and may assign their own license
-# to the complete work.
-#
-# (c) 2018 Red Hat Inc.
-#
-# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-
-import os
-from functools import partial
-from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six import iteritems
-from ansible.module_utils.common.text.converters import to_text
-from ansible.module_utils.basic import env_fallback
-from ansible.module_utils.common.validation import check_type_dict
-
-try:
-    from infoblox_client.connector import Connector
-    from infoblox_client.exceptions import InfobloxException
-    HAS_INFOBLOX_CLIENT = True
-except ImportError:
-    HAS_INFOBLOX_CLIENT = False
-
-# defining nios constants
-NIOS_DNS_VIEW = 'view'
-NIOS_NETWORK_VIEW = 'networkview'
-NIOS_HOST_RECORD = 'record:host'
-NIOS_IPV4_NETWORK = 'network'
-NIOS_IPV6_NETWORK = 'ipv6network'
-NIOS_ZONE = 'zone_auth'
-NIOS_PTR_RECORD = 'record:ptr'
-NIOS_A_RECORD = 'record:a'
-NIOS_AAAA_RECORD = 'record:aaaa'
-NIOS_CNAME_RECORD = 'record:cname'
-NIOS_MX_RECORD = 'record:mx'
-NIOS_SRV_RECORD = 'record:srv'
-NIOS_NAPTR_RECORD = 'record:naptr'
-NIOS_TXT_RECORD = 'record:txt'
-NIOS_NSGROUP = 'nsgroup'
-NIOS_IPV4_FIXED_ADDRESS = 'fixedaddress'
-NIOS_IPV6_FIXED_ADDRESS = 'ipv6fixedaddress'
-NIOS_NEXT_AVAILABLE_IP = 'func:nextavailableip'
-NIOS_IPV4_NETWORK_CONTAINER = 'networkcontainer'
-NIOS_IPV6_NETWORK_CONTAINER = 'ipv6networkcontainer'
-NIOS_MEMBER = 'member'
-
-NIOS_PROVIDER_SPEC = {
-    'host': dict(fallback=(env_fallback, ['INFOBLOX_HOST'])),
-    'username': dict(fallback=(env_fallback, ['INFOBLOX_USERNAME'])),
-    'password': dict(fallback=(env_fallback, ['INFOBLOX_PASSWORD']), no_log=True),
-    'validate_certs': dict(type='bool', default=False, fallback=(env_fallback, ['INFOBLOX_SSL_VERIFY']), aliases=['ssl_verify']),
-    'silent_ssl_warnings': dict(type='bool', default=True),
-    'http_request_timeout': dict(type='int', default=10, fallback=(env_fallback, ['INFOBLOX_HTTP_REQUEST_TIMEOUT'])),
-    'http_pool_connections': dict(type='int', default=10),
-    'http_pool_maxsize': dict(type='int', default=10),
-    'max_retries': dict(type='int', default=3, fallback=(env_fallback, ['INFOBLOX_MAX_RETRIES'])),
-    'wapi_version': dict(default='2.1', fallback=(env_fallback, ['INFOBLOX_WAP_VERSION'])),
-    'max_results': dict(type='int', default=1000, fallback=(env_fallback, ['INFOBLOX_MAX_RETRIES']))
-}
-
-
-def get_connector(*args, **kwargs):
-    ''' Returns an instance of infoblox_client.connector.Connector
-    :params args: positional arguments are silently ignored
-    :params kwargs: dict that is passed to Connector init
-    :returns: Connector
-    '''
-    if not HAS_INFOBLOX_CLIENT:
-        raise Exception('infoblox-client is required but does not appear '
-                        'to be installed.  It can be installed using the '
-                        'command `pip install infoblox-client`')
-
-    if not set(kwargs.keys()).issubset(list(NIOS_PROVIDER_SPEC.keys()) + ['ssl_verify']):
-        raise Exception('invalid or unsupported keyword argument for connector')
-    for key, value in iteritems(NIOS_PROVIDER_SPEC):
-        if key not in kwargs:
-            # apply default values from NIOS_PROVIDER_SPEC since we cannot just
-            # assume the provider values are coming from AnsibleModule
-            if 'default' in value:
-                kwargs[key] = value['default']
-
-            # override any values with env variables unless they were
-            # explicitly set
-            env = ('INFOBLOX_%s' % key).upper()
-            if env in os.environ:
-                kwargs[key] = os.environ.get(env)
-
-    if 'validate_certs' in kwargs.keys():
-        kwargs['ssl_verify'] = kwargs['validate_certs']
-        kwargs.pop('validate_certs', None)
-
-    return Connector(kwargs)
-
-
-def normalize_extattrs(value):
-    ''' Normalize extattrs field to expected format
-    The module accepts extattrs as key/value pairs.  This method will
-    transform the key/value pairs into a structure suitable for
-    sending across WAPI in the format of:
-        extattrs: {
-            key: {
-                value: <value>
-            }
-        }
-    '''
-    return dict([(k, {'value': v}) for k, v in iteritems(value)])
-
-
-def flatten_extattrs(value):
-    ''' Flatten the key/value struct for extattrs
-    WAPI returns extattrs field as a dict in form of:
-        extattrs: {
-            key: {
-                value: <value>
-            }
-        }
-    This method will flatten the structure to:
-        extattrs: {
-            key: value
-        }
-    '''
-    return dict([(k, v['value']) for k, v in iteritems(value)])
-
-
-def member_normalize(member_spec):
-    ''' Transforms the member module arguments into a valid WAPI struct
-    This function will transform the arguments into a structure that
-    is a valid WAPI structure in the format of:
-        {
-            key: <value>,
-        }
-    It will remove any arguments that are set to None since WAPI will error on
-    that condition.
-    The remainder of the value validation is performed by WAPI
-    Some parameters in ib_spec are passed as a list in order to pass the validation for elements.
-    In this function, they are converted to dictionary.
-    '''
-    member_elements = ['vip_setting', 'ipv6_setting', 'lan2_port_setting', 'mgmt_port_setting',
-                       'pre_provisioning', 'network_setting', 'v6_network_setting',
-                       'ha_port_setting', 'lan_port_setting', 'lan2_physical_setting',
-                       'lan_ha_port_setting', 'mgmt_network_setting', 'v6_mgmt_network_setting']
-    for key in list(member_spec.keys()):
-        if key in member_elements and member_spec[key] is not None:
-            member_spec[key] = member_spec[key][0]
-        if isinstance(member_spec[key], dict):
-            member_spec[key] = member_normalize(member_spec[key])
-        elif isinstance(member_spec[key], list):
-            for x in member_spec[key]:
-                if isinstance(x, dict):
-                    x = member_normalize(x)
-        elif member_spec[key] is None:
-            del member_spec[key]
-    return member_spec
-
-
-def normalize_ib_spec(ib_spec):
-    result = {}
-    for arg in ib_spec:
-        result[arg] = dict([(k, v)
-                            for k, v in iteritems(ib_spec[arg])
-                            if k not in ('ib_req', 'transform', 'update')])
-    return result
-
-
-class WapiBase(object):
-    ''' Base class for implementing Infoblox WAPI API '''
-    provider_spec = {'provider': dict(type='dict', options=NIOS_PROVIDER_SPEC)}
-
-    def __init__(self, provider):
-        self.connector = get_connector(**provider)
-
-    def __getattr__(self, name):
-        try:
-            return self.__dict__[name]
-        except KeyError:
-            if name.startswith('_'):
-                raise AttributeError("'%s' object has no attribute '%s'" % (self.__class__.__name__, name))
-            return partial(self._invoke_method, name)
-
-    def _invoke_method(self, name, *args, **kwargs):
-        try:
-            method = getattr(self.connector, name)
-            return method(*args, **kwargs)
-        except InfobloxException as exc:
-            if hasattr(self, 'handle_exception'):
-                self.handle_exception(name, exc)
-            else:
-                raise
-
-
-class WapiLookup(WapiBase):
-    ''' Implements WapiBase for lookup plugins '''
-    def handle_exception(self, method_name, exc):
-        if ('text' in exc.response):
-            raise Exception(exc.response['text'])
-        else:
-            raise Exception(exc)
-
-
-class WapiInventory(WapiBase):
-    ''' Implements WapiBase for dynamic inventory script '''
-    pass
-
-
-class WapiModule(WapiBase):
-    ''' Implements WapiBase for executing a NIOS module '''
-    def __init__(self, module):
-        self.module = module
-        provider = module.params['provider']
-        try:
-            super(WapiModule, self).__init__(provider)
-        except Exception as exc:
-            self.module.fail_json(msg=to_text(exc))
-
-    def handle_exception(self, method_name, exc):
-        ''' Handles any exceptions raised
-        This method will be called if an InfobloxException is raised for
-        any call to the instance of Connector and also, in case of generic
-        exception. This method will then gracefully fail the module.
-        :args exc: instance of InfobloxException
-        '''
-        if ('text' in exc.response):
-            self.module.fail_json(
-                msg=exc.response['text'],
-                type=exc.response['Error'].split(':')[0],
-                code=exc.response.get('code'),
-                operation=method_name
-            )
-        else:
-            self.module.fail_json(msg=to_native(exc))
-
-    def run(self, ib_obj_type, ib_spec):
-        ''' Runs the module and performans configuration tasks
-        :args ib_obj_type: the WAPI object type to operate against
-        :args ib_spec: the specification for the WAPI object as a dict
-        :returns: a results dict
-        '''
-
-        update = new_name = None
-        state = self.module.params['state']
-        if state not in ('present', 'absent'):
-            self.module.fail_json(msg='state must be one of `present`, `absent`, got `%s`' % state)
-
-        result = {'changed': False}
-
-        obj_filter = dict([(k, self.module.params[k]) for k, v in iteritems(ib_spec) if v.get('ib_req')])
-
-        # get object reference
-        ib_obj_ref, update, new_name = self.get_object_ref(self.module, ib_obj_type, obj_filter, ib_spec)
-        proposed_object = {}
-        for key, value in iteritems(ib_spec):
-            if self.module.params[key] is not None:
-                if 'transform' in value:
-                    proposed_object[key] = value['transform'](self.module)
-                else:
-                    proposed_object[key] = self.module.params[key]
-
-        # If configure_by_dns is set to False and view is 'default', then delete the default dns
-        if not proposed_object.get('configure_for_dns') and proposed_object.get('view') == 'default'\
-                and ib_obj_type == NIOS_HOST_RECORD:
-            del proposed_object['view']
-
-        if ib_obj_ref:
-            if len(ib_obj_ref) > 1:
-                for each in ib_obj_ref:
-                    # To check for existing A_record with same name with input A_record by IP
-                    if each.get('ipv4addr') and each.get('ipv4addr') == proposed_object.get('ipv4addr'):
-                        current_object = each
-                    # To check for existing Host_record with same name with input Host_record by IP
-                    elif each.get('ipv4addrs')[0].get('ipv4addr') and each.get('ipv4addrs')[0].get('ipv4addr')\
-                            == proposed_object.get('ipv4addrs')[0].get('ipv4addr'):
-                        current_object = each
-                    # Else set the current_object with input value
-                    else:
-                        current_object = obj_filter
-                        ref = None
-            else:
-                current_object = ib_obj_ref[0]
-            if 'extattrs' in current_object:
-                current_object['extattrs'] = flatten_extattrs(current_object['extattrs'])
-            if current_object.get('_ref'):
-                ref = current_object.pop('_ref')
-        else:
-            current_object = obj_filter
-            ref = None
-        # checks if the object type is member to normalize the attributes being passed
-        if (ib_obj_type == NIOS_MEMBER):
-            proposed_object = member_normalize(proposed_object)
-
-        # checks if the name's field has been updated
-        if update and new_name:
-            proposed_object['name'] = new_name
-
-        check_remove = []
-        if (ib_obj_type == NIOS_HOST_RECORD):
-            # this check is for idempotency, as if the same ip address shall be passed
-            # add param will be removed, and same exists true for remove case as well.
-            if 'ipv4addrs' in [current_object and proposed_object]:
-                for each in current_object['ipv4addrs']:
-                    if each['ipv4addr'] == proposed_object['ipv4addrs'][0]['ipv4addr']:
-                        if 'add' in proposed_object['ipv4addrs'][0]:
-                            del proposed_object['ipv4addrs'][0]['add']
-                            break
-                    check_remove += each.values()
-                if proposed_object['ipv4addrs'][0]['ipv4addr'] not in check_remove:
-                    if 'remove' in proposed_object['ipv4addrs'][0]:
-                        del proposed_object['ipv4addrs'][0]['remove']
-
-        res = None
-        modified = not self.compare_objects(current_object, proposed_object)
-        if 'extattrs' in proposed_object:
-            proposed_object['extattrs'] = normalize_extattrs(proposed_object['extattrs'])
-
-        # Checks if nios_next_ip param is passed in ipv4addrs/ipv4addr args
-        proposed_object = self.check_if_nios_next_ip_exists(proposed_object)
-
-        if state == 'present':
-            if ref is None:
-                if not self.module.check_mode:
-                    self.create_object(ib_obj_type, proposed_object)
-                result['changed'] = True
-            # Check if NIOS_MEMBER and the flag to call function create_token is set
-            elif (ib_obj_type == NIOS_MEMBER) and (proposed_object['create_token']):
-                proposed_object = None
-                # the function creates a token that can be used by a pre-provisioned member to join the grid
-                result['api_results'] = self.call_func('create_token', ref, proposed_object)
-                result['changed'] = True
-            elif modified:
-                if 'ipv4addrs' in proposed_object:
-                    if ('add' not in proposed_object['ipv4addrs'][0]) and ('remove' not in proposed_object['ipv4addrs'][0]):
-                        self.check_if_recordname_exists(obj_filter, ib_obj_ref, ib_obj_type, current_object, proposed_object)
-
-                if (ib_obj_type in (NIOS_HOST_RECORD, NIOS_NETWORK_VIEW, NIOS_DNS_VIEW)):
-                    run_update = True
-                    proposed_object = self.on_update(proposed_object, ib_spec)
-                    if 'ipv4addrs' in proposed_object:
-                        if ('add' or 'remove') in proposed_object['ipv4addrs'][0]:
-                            run_update, proposed_object = self.check_if_add_remove_ip_arg_exists(proposed_object)
-                            if run_update:
-                                res = self.update_object(ref, proposed_object)
-                                result['changed'] = True
-                            else:
-                                res = ref
-                if (ib_obj_type in (NIOS_A_RECORD, NIOS_AAAA_RECORD, NIOS_PTR_RECORD, NIOS_SRV_RECORD)):
-                    # popping 'view' key as update of 'view' is not supported with respect to a:record/aaaa:record/srv:record/ptr:record
-                    proposed_object = self.on_update(proposed_object, ib_spec)
-                    del proposed_object['view']
-                    if not self.module.check_mode:
-                        res = self.update_object(ref, proposed_object)
-                    result['changed'] = True
-                elif 'network_view' in proposed_object:
-                    proposed_object.pop('network_view')
-                    result['changed'] = True
-                if not self.module.check_mode and res is None:
-                    proposed_object = self.on_update(proposed_object, ib_spec)
-                    self.update_object(ref, proposed_object)
-                    result['changed'] = True
-
-        elif state == 'absent':
-            if ref is not None:
-                if 'ipv4addrs' in proposed_object:
-                    if 'remove' in proposed_object['ipv4addrs'][0]:
-                        self.check_if_add_remove_ip_arg_exists(proposed_object)
-                        self.update_object(ref, proposed_object)
-                        result['changed'] = True
-                elif not self.module.check_mode:
-                    self.delete_object(ref)
-                    result['changed'] = True
-
-        return result
-
-    def check_if_recordname_exists(self, obj_filter, ib_obj_ref, ib_obj_type, current_object, proposed_object):
-        ''' Send POST request if host record input name and retrieved ref name is same,
-            but input IP and retrieved IP is different'''
-
-        if 'name' in (obj_filter and ib_obj_ref[0]) and ib_obj_type == NIOS_HOST_RECORD:
-            obj_host_name = obj_filter['name']
-            ref_host_name = ib_obj_ref[0]['name']
-            if 'ipv4addrs' in (current_object and proposed_object):
-                current_ip_addr = current_object['ipv4addrs'][0]['ipv4addr']
-                proposed_ip_addr = proposed_object['ipv4addrs'][0]['ipv4addr']
-            elif 'ipv6addrs' in (current_object and proposed_object):
-                current_ip_addr = current_object['ipv6addrs'][0]['ipv6addr']
-                proposed_ip_addr = proposed_object['ipv6addrs'][0]['ipv6addr']
-
-            if obj_host_name == ref_host_name and current_ip_addr != proposed_ip_addr:
-                self.create_object(ib_obj_type, proposed_object)
-
-    def check_if_nios_next_ip_exists(self, proposed_object):
-        ''' Check if nios_next_ip argument is passed in ipaddr while creating
-            host record, if yes then format proposed object ipv4addrs and pass
-            func:nextavailableip and ipaddr range to create hostrecord with next
-             available ip in one call to avoid any race condition '''
-
-        if 'ipv4addrs' in proposed_object:
-            if 'nios_next_ip' in proposed_object['ipv4addrs'][0]['ipv4addr']:
-                ip_range = check_type_dict(proposed_object['ipv4addrs'][0]['ipv4addr'])['nios_next_ip']
-                proposed_object['ipv4addrs'][0]['ipv4addr'] = NIOS_NEXT_AVAILABLE_IP + ':' + ip_range
-        elif 'ipv4addr' in proposed_object:
-            if 'nios_next_ip' in proposed_object['ipv4addr']:
-                ip_range = check_type_dict(proposed_object['ipv4addr'])['nios_next_ip']
-                proposed_object['ipv4addr'] = NIOS_NEXT_AVAILABLE_IP + ':' + ip_range
-
-        return proposed_object
-
-    def check_if_add_remove_ip_arg_exists(self, proposed_object):
-        '''
-            This function shall check if add/remove param is set to true and
-            is passed in the args, then we will update the proposed dictionary
-            to add/remove IP to existing host_record, if the user passes false
-            param with the argument nothing shall be done.
-            :returns: True if param is changed based on add/remove, and also the
-            changed proposed_object.
-        '''
-        update = False
-        if 'add' in proposed_object['ipv4addrs'][0]:
-            if proposed_object['ipv4addrs'][0]['add']:
-                proposed_object['ipv4addrs+'] = proposed_object['ipv4addrs']
-                del proposed_object['ipv4addrs']
-                del proposed_object['ipv4addrs+'][0]['add']
-                update = True
-            else:
-                del proposed_object['ipv4addrs'][0]['add']
-        elif 'remove' in proposed_object['ipv4addrs'][0]:
-            if proposed_object['ipv4addrs'][0]['remove']:
-                proposed_object['ipv4addrs-'] = proposed_object['ipv4addrs']
-                del proposed_object['ipv4addrs']
-                del proposed_object['ipv4addrs-'][0]['remove']
-                update = True
-            else:
-                del proposed_object['ipv4addrs'][0]['remove']
-        return update, proposed_object
-
-    def issubset(self, item, objects):
-        ''' Checks if item is a subset of objects
-        :args item: the subset item to validate
-        :args objects: superset list of objects to validate against
-        :returns: True if item is a subset of one entry in objects otherwise
-            this method will return None
-        '''
-        for obj in objects:
-            if isinstance(item, dict):
-                if all(entry in obj.items() for entry in item.items()):
-                    return True
-            else:
-                if item in obj:
-                    return True
-
-    def compare_objects(self, current_object, proposed_object):
-        for key, proposed_item in iteritems(proposed_object):
-            current_item = current_object.get(key)
-
-            # if proposed has a key that current doesn't then the objects are
-            # not equal and False will be immediately returned
-            if current_item is None:
-                return False
-
-            elif isinstance(proposed_item, list):
-                if key == 'aliases':
-                    if set(current_item) != set(proposed_item):
-                        return False
-                for subitem in proposed_item:
-                    if not self.issubset(subitem, current_item):
-                        return False
-
-            elif isinstance(proposed_item, dict):
-                return self.compare_objects(current_item, proposed_item)
-
-            else:
-                if current_item != proposed_item:
-                    return False
-
-        return True
-
-    def get_object_ref(self, module, ib_obj_type, obj_filter, ib_spec):
-        ''' this function gets the reference object of pre-existing nios objects '''
-
-        update = False
-        old_name = new_name = None
-        if ('name' in obj_filter):
-            # gets and returns the current object based on name/old_name passed
-            try:
-                name_obj = check_type_dict(obj_filter['name'])
-                old_name = name_obj['old_name']
-                new_name = name_obj['new_name']
-            except TypeError:
-                name = obj_filter['name']
-
-            if old_name and new_name:
-                if (ib_obj_type == NIOS_HOST_RECORD):
-                    test_obj_filter = dict([('name', old_name), ('view', obj_filter['view'])])
-                elif (ib_obj_type in (NIOS_AAAA_RECORD, NIOS_A_RECORD)):
-                    test_obj_filter = obj_filter
-                else:
-                    test_obj_filter = dict([('name', old_name)])
-                # get the object reference
-                ib_obj = self.get_object(ib_obj_type, test_obj_filter, return_fields=list(ib_spec.keys()))
-                if ib_obj:
-                    obj_filter['name'] = new_name
-                else:
-                    test_obj_filter['name'] = new_name
-                    ib_obj = self.get_object(ib_obj_type, test_obj_filter, return_fields=list(ib_spec.keys()))
-                update = True
-                return ib_obj, update, new_name
-            if (ib_obj_type == NIOS_HOST_RECORD):
-                # to check only by name if dns bypassing is set
-                if not obj_filter['configure_for_dns']:
-                    test_obj_filter = dict([('name', name)])
-                else:
-                    test_obj_filter = dict([('name', name), ('view', obj_filter['view'])])
-            elif (ib_obj_type == NIOS_IPV4_FIXED_ADDRESS or ib_obj_type == NIOS_IPV6_FIXED_ADDRESS and 'mac' in obj_filter):
-                test_obj_filter = dict([['mac', obj_filter['mac']]])
-            elif (ib_obj_type == NIOS_A_RECORD):
-                # resolves issue where a_record with uppercase name was returning null and was failing
-                test_obj_filter = obj_filter
-                test_obj_filter['name'] = test_obj_filter['name'].lower()
-                # resolves issue where multiple a_records with same name and different IP address
-                try:
-                    ipaddr_obj = check_type_dict(obj_filter['ipv4addr'])
-                    ipaddr = ipaddr_obj['old_ipv4addr']
-                except TypeError:
-                    ipaddr = obj_filter['ipv4addr']
-                test_obj_filter['ipv4addr'] = ipaddr
-            elif (ib_obj_type == NIOS_TXT_RECORD):
-                # resolves issue where multiple txt_records with same name and different text
-                test_obj_filter = obj_filter
-                try:
-                    text_obj = check_type_dict(obj_filter['text'])
-                    txt = text_obj['old_text']
-                except TypeError:
-                    txt = obj_filter['text']
-                test_obj_filter['text'] = txt
-            # check if test_obj_filter is empty copy passed obj_filter
-            else:
-                test_obj_filter = obj_filter
-            ib_obj = self.get_object(ib_obj_type, test_obj_filter.copy(), return_fields=list(ib_spec.keys()))
-        elif (ib_obj_type == NIOS_A_RECORD):
-            # resolves issue where multiple a_records with same name and different IP address
-            test_obj_filter = obj_filter
-            try:
-                ipaddr_obj = check_type_dict(obj_filter['ipv4addr'])
-                ipaddr = ipaddr_obj['old_ipv4addr']
-            except TypeError:
-                ipaddr = obj_filter['ipv4addr']
-            test_obj_filter['ipv4addr'] = ipaddr
-            ib_obj = self.get_object(ib_obj_type, test_obj_filter.copy(), return_fields=list(ib_spec.keys()))
-        elif (ib_obj_type == NIOS_TXT_RECORD):
-            # resolves issue where multiple txt_records with same name and different text
-            test_obj_filter = obj_filter
-            try:
-                text_obj = check_type_dict(obj_filter['text'])
-                txt = text_obj['old_text']
-            except TypeError:
-                txt = obj_filter['text']
-            test_obj_filter['text'] = txt
-            ib_obj = self.get_object(ib_obj_type, test_obj_filter.copy(), return_fields=list(ib_spec.keys()))
-        elif (ib_obj_type == NIOS_ZONE):
-            # del key 'restart_if_needed' as nios_zone get_object fails with the key present
-            temp = ib_spec['restart_if_needed']
-            del ib_spec['restart_if_needed']
-            ib_obj = self.get_object(ib_obj_type, obj_filter.copy(), return_fields=list(ib_spec.keys()))
-            # reinstate restart_if_needed if ib_obj is none, meaning there's no existing nios_zone ref
-            if not ib_obj:
-                ib_spec['restart_if_needed'] = temp
-        elif (ib_obj_type == NIOS_MEMBER):
-            # del key 'create_token' as nios_member get_object fails with the key present
-            temp = ib_spec['create_token']
-            del ib_spec['create_token']
-            ib_obj = self.get_object(ib_obj_type, obj_filter.copy(), return_fields=list(ib_spec.keys()))
-            if temp:
-                # reinstate 'create_token' key
-                ib_spec['create_token'] = temp
-        else:
-            ib_obj = self.get_object(ib_obj_type, obj_filter.copy(), return_fields=list(ib_spec.keys()))
-        return ib_obj, update, new_name
-
-    def on_update(self, proposed_object, ib_spec):
-        ''' Event called before the update is sent to the API endpoing
-        This method will allow the final proposed object to be changed
-        and/or keys filtered before it is sent to the API endpoint to
-        be processed.
-        :args proposed_object: A dict item that will be encoded and sent
-            the API endpoint with the updated data structure
-        :returns: updated object to be sent to API endpoint
-        '''
-        keys = set()
-        for key, value in iteritems(proposed_object):
-            update = ib_spec[key].get('update', True)
-            if not update:
-                keys.add(key)
-        return dict([(k, v) for k, v in iteritems(proposed_object) if k not in keys])

plugins/module_utils/redfish_utils.py

@@ -1834,12 +1834,16 @@ class RedfishUtils(object):
                 result['ret'] = True
                 data = response['data']
 
-                for device in data[u'Fans']:
-                    fan = {}
-                    for property in properties:
-                        if property in device:
-                            fan[property] = device[property]
-                    fan_results.append(fan)
+                # Checking if fans are present
+                if u'Fans' in data:
+                    for device in data[u'Fans']:
+                        fan = {}
+                        for property in properties:
+                            if property in device:
+                                fan[property] = device[property]
+                        fan_results.append(fan)
+                else:
+                    return {'ret': False, 'msg': "No Fans present"}
         result["entries"] = fan_results
         return result
 
@@ -2029,15 +2033,28 @@ class RedfishUtils(object):
     def get_multi_memory_inventory(self):
         return self.aggregate_systems(self.get_memory_inventory)
 
+    def get_nic(self, resource_uri):
+        result = {}
+        properties = ['Name', 'Id', 'Description', 'FQDN', 'IPv4Addresses', 'IPv6Addresses',
+                      'NameServers', 'MACAddress', 'PermanentMACAddress',
+                      'SpeedMbps', 'MTUSize', 'AutoNeg', 'Status']
+        response = self.get_request(self.root_uri + resource_uri)
+        if response['ret'] is False:
+            return response
+        result['ret'] = True
+        data = response['data']
+        nic = {}
+        for property in properties:
+            if property in data:
+                nic[property] = data[property]
+        result['entries'] = nic
+        return(result)
+
     def get_nic_inventory(self, resource_uri):
         result = {}
         nic_list = []
         nic_results = []
         key = "EthernetInterfaces"
-        # Get these entries, but does not fail if not found
-        properties = ['Name', 'Id', 'Description', 'FQDN', 'IPv4Addresses', 'IPv6Addresses',
-                      'NameServers', 'MACAddress', 'PermanentMACAddress',
-                      'SpeedMbps', 'MTUSize', 'AutoNeg', 'Status']
 
         response = self.get_request(self.root_uri + resource_uri)
         if response['ret'] is False:
@@ -2061,18 +2078,9 @@ class RedfishUtils(object):
             nic_list.append(nic[u'@odata.id'])
 
         for n in nic_list:
-            nic = {}
-            uri = self.root_uri + n
-            response = self.get_request(uri)
-            if response['ret'] is False:
-                return response
-            data = response['data']
-
-            for property in properties:
-                if property in data:
-                    nic[property] = data[property]
-
-            nic_results.append(nic)
+            nic = self.get_nic(n)
+            if nic['ret']:
+                nic_results.append(nic['entries'])
         result["entries"] = nic_results
         return result
 
@@ -2697,39 +2705,14 @@ class RedfishUtils(object):
         return self.aggregate_managers(self.get_manager_health_report)
 
     def set_manager_nic(self, nic_addr, nic_config):
-        # Get EthernetInterface collection
-        response = self.get_request(self.root_uri + self.manager_uri)
-        if response['ret'] is False:
-            return response
-        data = response['data']
-        if 'EthernetInterfaces' not in data:
-            return {'ret': False, 'msg': "EthernetInterfaces resource not found"}
-        ethernetinterfaces_uri = data["EthernetInterfaces"]["@odata.id"]
-        response = self.get_request(self.root_uri + ethernetinterfaces_uri)
-        if response['ret'] is False:
-            return response
-        data = response['data']
-        uris = [a.get('@odata.id') for a in data.get('Members', []) if
-                a.get('@odata.id')]
+        # Get the manager ethernet interface uri
+        nic_info = self.get_manager_ethernet_uri(nic_addr)
 
-        # Find target EthernetInterface
-        target_ethernet_uri = None
-        target_ethernet_current_setting = None
-        if nic_addr == 'null':
-            # Find root_uri matched EthernetInterface when nic_addr is not specified
-            nic_addr = (self.root_uri).split('/')[-1]
-            nic_addr = nic_addr.split(':')[0]  # split port if existing
-        for uri in uris:
-            response = self.get_request(self.root_uri + uri)
-            if response['ret'] is False:
-                return response
-            data = response['data']
-            if '"' + nic_addr.lower() + '"' in str(data).lower() or "'" + nic_addr.lower() + "'" in str(data).lower():
-                target_ethernet_uri = uri
-                target_ethernet_current_setting = data
-                break
-        if target_ethernet_uri is None:
-            return {'ret': False, 'msg': "No matched EthernetInterface found under Manager"}
+        if nic_info.get('nic_addr') is None:
+            return nic_info
+        else:
+            target_ethernet_uri = nic_info['nic_addr']
+            target_ethernet_current_setting = nic_info['ethernet_setting']
 
         # Convert input to payload and check validity
         payload = {}
@@ -2792,3 +2775,208 @@ class RedfishUtils(object):
         if response['ret'] is False:
             return response
         return {'ret': True, 'changed': True, 'msg': "Modified Manager NIC"}
+
+    # A helper function to get the EthernetInterface URI
+    def get_manager_ethernet_uri(self, nic_addr='null'):
+        # Get EthernetInterface collection
+        response = self.get_request(self.root_uri + self.manager_uri)
+        if not response['ret']:
+            return response
+        data = response['data']
+        if 'EthernetInterfaces' not in data:
+            return {'ret': False, 'msg': "EthernetInterfaces resource not found"}
+        ethernetinterfaces_uri = data["EthernetInterfaces"]["@odata.id"]
+        response = self.get_request(self.root_uri + ethernetinterfaces_uri)
+        if not response['ret']:
+            return response
+        data = response['data']
+        uris = [a.get('@odata.id') for a in data.get('Members', []) if
+                a.get('@odata.id')]
+
+        # Find target EthernetInterface
+        target_ethernet_uri = None
+        target_ethernet_current_setting = None
+        if nic_addr == 'null':
+            # Find root_uri matched EthernetInterface when nic_addr is not specified
+            nic_addr = (self.root_uri).split('/')[-1]
+            nic_addr = nic_addr.split(':')[0]  # split port if existing
+        for uri in uris:
+            response = self.get_request(self.root_uri + uri)
+            if not response['ret']:
+                return response
+            data = response['data']
+            data_string = json.dumps(data)
+            if nic_addr.lower() in data_string.lower():
+                target_ethernet_uri = uri
+                target_ethernet_current_setting = data
+                break
+
+        nic_info = {}
+        nic_info['nic_addr'] = target_ethernet_uri
+        nic_info['ethernet_setting'] = target_ethernet_current_setting
+
+        if target_ethernet_uri is None:
+            return {}
+        else:
+            return nic_info
+
+    def set_hostinterface_attributes(self, hostinterface_config, hostinterface_id=None):
+        response = self.get_request(self.root_uri + self.manager_uri)
+        if response['ret'] is False:
+            return response
+        data = response['data']
+        if 'HostInterfaces' not in data:
+            return {'ret': False, 'msg': "HostInterfaces resource not found"}
+
+        hostinterfaces_uri = data["HostInterfaces"]["@odata.id"]
+        response = self.get_request(self.root_uri + hostinterfaces_uri)
+        if response['ret'] is False:
+            return response
+        data = response['data']
+        uris = [a.get('@odata.id') for a in data.get('Members', []) if a.get('@odata.id')]
+        # Capture list of URIs that match a specified HostInterface resource ID
+        if hostinterface_id:
+            matching_hostinterface_uris = [uri for uri in uris if hostinterface_id in uri.split('/')[-1]]
+
+        if hostinterface_id and matching_hostinterface_uris:
+            hostinterface_uri = list.pop(matching_hostinterface_uris)
+        elif hostinterface_id and not matching_hostinterface_uris:
+            return {'ret': False, 'msg': "HostInterface ID %s not present." % hostinterface_id}
+        elif len(uris) == 1:
+            hostinterface_uri = list.pop(uris)
+        else:
+            return {'ret': False, 'msg': "HostInterface ID not defined and multiple interfaces detected."}
+
+        response = self.get_request(self.root_uri + hostinterface_uri)
+        if response['ret'] is False:
+            return response
+        current_hostinterface_config = response['data']
+        payload = {}
+        for property in hostinterface_config.keys():
+            value = hostinterface_config[property]
+            if property not in current_hostinterface_config:
+                return {'ret': False, 'msg': "Property %s in hostinterface_config is invalid" % property}
+            if isinstance(value, dict):
+                if isinstance(current_hostinterface_config[property], dict):
+                    payload[property] = value
+                elif isinstance(current_hostinterface_config[property], list):
+                    payload[property] = list()
+                    payload[property].append(value)
+                else:
+                    return {'ret': False, 'msg': "Value of property %s in hostinterface_config is invalid" % property}
+            else:
+                payload[property] = value
+
+        need_change = False
+        for property in payload.keys():
+            set_value = payload[property]
+            cur_value = current_hostinterface_config[property]
+            if not isinstance(set_value, dict) and not isinstance(set_value, list):
+                if set_value != cur_value:
+                    need_change = True
+            if isinstance(set_value, dict):
+                for subprop in payload[property].keys():
+                    if subprop not in current_hostinterface_config[property]:
+                        need_change = True
+                        break
+                    sub_set_value = payload[property][subprop]
+                    sub_cur_value = current_hostinterface_config[property][subprop]
+                    if sub_set_value != sub_cur_value:
+                        need_change = True
+            if isinstance(set_value, list):
+                if len(set_value) != len(cur_value):
+                    need_change = True
+                    continue
+                for i in range(len(set_value)):
+                    for subprop in payload[property][i].keys():
+                        if subprop not in current_hostinterface_config[property][i]:
+                            need_change = True
+                            break
+                        sub_set_value = payload[property][i][subprop]
+                        sub_cur_value = current_hostinterface_config[property][i][subprop]
+                        if sub_set_value != sub_cur_value:
+                            need_change = True
+        if not need_change:
+            return {'ret': True, 'changed': False, 'msg': "Host Interface already configured"}
+
+        response = self.patch_request(self.root_uri + hostinterface_uri, payload)
+        if response['ret'] is False:
+            return response
+        return {'ret': True, 'changed': True, 'msg': "Modified Host Interface"}
+
+    def get_hostinterfaces(self):
+        result = {}
+        hostinterface_results = []
+        properties = ['Id', 'Name', 'Description', 'HostInterfaceType', 'Status',
+                      'InterfaceEnabled', 'ExternallyAccessible', 'AuthenticationModes',
+                      'AuthNoneRoleId', 'CredentialBootstrapping']
+        manager_uri_list = self.manager_uris
+        for manager_uri in manager_uri_list:
+            response = self.get_request(self.root_uri + manager_uri)
+            if response['ret'] is False:
+                return response
+
+            result['ret'] = True
+            data = response['data']
+
+            if 'HostInterfaces' in data:
+                hostinterfaces_uri = data[u'HostInterfaces'][u'@odata.id']
+            else:
+                continue
+
+            response = self.get_request(self.root_uri + hostinterfaces_uri)
+            data = response['data']
+
+            if 'Members' in data:
+                for hostinterface in data['Members']:
+                    hostinterface_uri = hostinterface['@odata.id']
+                    hostinterface_response = self.get_request(self.root_uri + hostinterface_uri)
+                    # dictionary for capturing individual HostInterface properties
+                    hostinterface_data_temp = {}
+                    if hostinterface_response['ret'] is False:
+                        return hostinterface_response
+                    hostinterface_data = hostinterface_response['data']
+                    for property in properties:
+                        if property in hostinterface_data:
+                            if hostinterface_data[property] is not None:
+                                hostinterface_data_temp[property] = hostinterface_data[property]
+                    # Check for the presence of a ManagerEthernetInterface
+                    # object, a link to a _single_ EthernetInterface that the
+                    # BMC uses to communicate with the host.
+                    if 'ManagerEthernetInterface' in hostinterface_data:
+                        interface_uri = hostinterface_data['ManagerEthernetInterface']['@odata.id']
+                        interface_response = self.get_nic(interface_uri)
+                        if interface_response['ret'] is False:
+                            return interface_response
+                        hostinterface_data_temp['ManagerEthernetInterface'] = interface_response['entries']
+
+                    # Check for the presence of a HostEthernetInterfaces
+                    # object, a link to a _collection_ of EthernetInterfaces
+                    # that the host uses to communicate with the BMC.
+                    if 'HostEthernetInterfaces' in hostinterface_data:
+                        interfaces_uri = hostinterface_data['HostEthernetInterfaces']['@odata.id']
+                        interfaces_response = self.get_request(self.root_uri + interfaces_uri)
+                        if interfaces_response['ret'] is False:
+                            return interfaces_response
+                        interfaces_data = interfaces_response['data']
+                        if 'Members' in interfaces_data:
+                            for interface in interfaces_data['Members']:
+                                interface_uri = interface['@odata.id']
+                                interface_response = self.get_nic(interface_uri)
+                                if interface_response['ret'] is False:
+                                    return interface_response
+                                # Check if this is the first
+                                # HostEthernetInterfaces item and create empty
+                                # list if so.
+                                if 'HostEthernetInterfaces' not in hostinterface_data_temp:
+                                    hostinterface_data_temp['HostEthernetInterfaces'] = []
+
+                                hostinterface_data_temp['HostEthernetInterfaces'].append(interface_response['entries'])
+
+                    hostinterface_results.append(hostinterface_data_temp)
+            else:
+                continue
+        result["entries"] = hostinterface_results
+        if not result["entries"]:
+            return {'ret': False, 'msg': "No HostInterface objects found"}
+        return result

plugins/module_utils/source_control/bitbucket.py

@@ -15,13 +15,6 @@ from ansible.module_utils.urls import fetch_url, basic_auth_header
 class BitbucketHelper:
     BITBUCKET_API_URL = 'https://api.bitbucket.org'
 
-    error_messages = {
-        'required_client_id': '`client_id` must be specified as a parameter or '
-                              'BITBUCKET_CLIENT_ID environment variable',
-        'required_client_secret': '`client_secret` must be specified as a parameter or '
-                                  'BITBUCKET_CLIENT_SECRET environment variable',
-    }
-
     def __init__(self, module):
         self.module = module
         self.access_token = None
@@ -29,35 +22,40 @@ class BitbucketHelper:
     @staticmethod
     def bitbucket_argument_spec():
         return dict(
-            client_id=dict(type='str', no_log=True, fallback=(env_fallback, ['BITBUCKET_CLIENT_ID'])),
+            client_id=dict(type='str', fallback=(env_fallback, ['BITBUCKET_CLIENT_ID'])),
             client_secret=dict(type='str', no_log=True, fallback=(env_fallback, ['BITBUCKET_CLIENT_SECRET'])),
+            # TODO:
+            # - Rename user to username once current usage of username is removed
+            # - Alias user to username and deprecate it
+            user=dict(type='str', fallback=(env_fallback, ['BITBUCKET_USERNAME'])),
+            password=dict(type='str', no_log=True, fallback=(env_fallback, ['BITBUCKET_PASSWORD'])),
         )
 
-    def check_arguments(self):
-        if self.module.params['client_id'] is None:
-            self.module.fail_json(msg=self.error_messages['required_client_id'])
+    @staticmethod
+    def bitbucket_required_one_of():
+        return [['client_id', 'client_secret', 'user', 'password']]
 
-        if self.module.params['client_secret'] is None:
-            self.module.fail_json(msg=self.error_messages['required_client_secret'])
+    @staticmethod
+    def bitbucket_required_together():
+        return [['client_id', 'client_secret'], ['user', 'password']]
 
     def fetch_access_token(self):
-        self.check_arguments()
+        if self.module.params['client_id'] and self.module.params['client_secret']:
+            headers = {
+                'Authorization': basic_auth_header(self.module.params['client_id'], self.module.params['client_secret']),
+            }
 
-        headers = {
-            'Authorization': basic_auth_header(self.module.params['client_id'], self.module.params['client_secret'])
-        }
+            info, content = self.request(
+                api_url='https://bitbucket.org/site/oauth2/access_token',
+                method='POST',
+                data='grant_type=client_credentials',
+                headers=headers,
+            )
 
-        info, content = self.request(
-            api_url='https://bitbucket.org/site/oauth2/access_token',
-            method='POST',
-            data='grant_type=client_credentials',
-            headers=headers,
-        )
-
-        if info['status'] == 200:
-            self.access_token = content['access_token']
-        else:
-            self.module.fail_json(msg='Failed to retrieve access token: {0}'.format(info))
+            if info['status'] == 200:
+                self.access_token = content['access_token']
+            else:
+                self.module.fail_json(msg='Failed to retrieve access token: {0}'.format(info))
 
     def request(self, api_url, method, data=None, headers=None):
         headers = headers or {}
@@ -66,6 +64,10 @@ class BitbucketHelper:
             headers.update({
                 'Authorization': 'Bearer {0}'.format(self.access_token),
             })
+        elif self.module.params['user'] and self.module.params['password']:
+            headers.update({
+                'Authorization': basic_auth_header(self.module.params['user'], self.module.params['password']),
+            })
 
         if isinstance(data, dict):
             data = self.module.jsonify(data)

plugins/module_utils/version.py

@@ -1,17 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Felix Fontein <felix@fontein.de>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-"""Provide version object to compare version numbers."""
-
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
-
-
-# Once we drop support for Ansible 2.9, ansible-base 2.10, and ansible-core 2.11, we can
-# remove the _version.py file, and replace the following import by
-#
-#     from ansible.module_utils.compat.version import LooseVersion
-
-from ._version import LooseVersion

plugins/modules/cloud/centurylink/clc_aa_policy.py

@@ -120,7 +120,7 @@ __version__ = '${version}'
 import os
 import traceback
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:

plugins/modules/cloud/centurylink/clc_alert_policy.py

@@ -161,8 +161,7 @@ __version__ = '${version}'
 import json
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:

plugins/modules/cloud/centurylink/clc_blueprint_package.py

@@ -89,8 +89,7 @@ __version__ = '${version}'
 
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -133,7 +132,8 @@ class ClcBlueprintPackage:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/centurylink/clc_firewall_policy.py

@@ -162,8 +162,7 @@ import os
 import traceback
 from ansible.module_utils.six.moves.urllib.parse import urlparse
 from time import sleep
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -204,7 +203,8 @@ class ClcFirewallPolicy:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/centurylink/clc_group.py

@@ -207,8 +207,7 @@ __version__ = '${version}'
 
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:

plugins/modules/cloud/centurylink/clc_loadbalancer.py

@@ -210,8 +210,7 @@ import json
 import os
 import traceback
 from time import sleep
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -256,7 +255,8 @@ class ClcLoadBalancer:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/centurylink/clc_modify_server.py

@@ -311,8 +311,7 @@ __version__ = '${version}'
 import json
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -356,7 +355,8 @@ class ClcModifyServer:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/centurylink/clc_publicip.py

@@ -117,8 +117,7 @@ __version__ = '${version}'
 
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:

plugins/modules/cloud/centurylink/clc_server.py

@@ -433,8 +433,7 @@ import json
 import os
 import time
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -479,7 +478,8 @@ class ClcServer:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/centurylink/clc_server_snapshot.py

@@ -101,8 +101,7 @@ __version__ = '${version}'
 
 import os
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try:
@@ -146,7 +145,8 @@ class ClcSnapshot:
             self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR)
         if not REQUESTS_FOUND:
             self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
-        if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'):
+        if requests.__version__ and LooseVersion(
+                requests.__version__) < LooseVersion('2.5.0'):
             self.module.fail_json(
                 msg='requests library  version should be >= 2.5.0')
 

plugins/modules/cloud/lxc/lxc_container.py

@@ -422,6 +422,7 @@ import shutil
 import subprocess
 import tempfile
 import time
+import shlex
 
 try:
     import lxc
@@ -661,9 +662,8 @@ class LxcContainerManagement(object):
         """
 
         for key, value in variables_dict.items():
-            build_command.append(
-                '%s %s' % (key, value)
-            )
+            build_command.append(str(key))
+            build_command.append(str(value))
         return build_command
 
     def _get_vars(self, variables):
@@ -686,24 +686,6 @@ class LxcContainerManagement(object):
                 return_dict[v] = _var
         return return_dict
 
-    def _run_command(self, build_command, unsafe_shell=False):
-        """Return information from running an Ansible Command.
-
-        This will squash the build command list into a string and then
-        execute the command via Ansible. The output is returned to the method.
-        This output is returned as `return_code`, `stdout`, `stderr`.
-
-        :param build_command: Used for the command and all options.
-        :type build_command: ``list``
-        :param unsafe_shell: Enable or Disable unsafe sell commands.
-        :type unsafe_shell: ``bol``
-        """
-
-        return self.module.run_command(
-            ' '.join(build_command),
-            use_unsafe_shell=unsafe_shell
-        )
-
     def _config(self):
         """Configure an LXC container.
 
@@ -810,7 +792,7 @@ class LxcContainerManagement(object):
         elif self.module.params.get('backing_store') == 'overlayfs':
             build_command.append('--snapshot')
 
-        rc, return_data, err = self._run_command(build_command)
+        rc, return_data, err = self.module.run_command(build_command)
         if rc != 0:
             message = "Failed executing %s." % os.path.basename(clone_cmd)
             self.failure(
@@ -843,7 +825,7 @@ class LxcContainerManagement(object):
 
         build_command = [
             self.module.get_bin_path('lxc-create', True),
-            '--name %s' % self.container_name,
+            '--name', self.container_name,
             '--quiet'
         ]
 
@@ -869,10 +851,12 @@ class LxcContainerManagement(object):
                 log_path = os.getenv('HOME')
 
             build_command.extend([
-                '--logfile %s' % os.path.join(
+                '--logfile',
+                os.path.join(
                     log_path, 'lxc-%s.log' % self.container_name
                 ),
-                '--logpriority %s' % self.module.params.get(
+                '--logpriority',
+                self.module.params.get(
                     'container_log_level'
                 ).upper()
             ])
@@ -880,9 +864,10 @@ class LxcContainerManagement(object):
         # Add the template commands to the end of the command if there are any
         template_options = self.module.params.get('template_options', None)
         if template_options:
-            build_command.append('-- %s' % template_options)
+            build_command.append('--')
+            build_command += shlex.split(template_options)
 
-        rc, return_data, err = self._run_command(build_command)
+        rc, return_data, err = self.module.run_command(build_command)
         if rc != 0:
             message = "Failed executing lxc-create."
             self.failure(
@@ -1186,7 +1171,7 @@ class LxcContainerManagement(object):
             self.module.get_bin_path('lxc-config', True),
             "lxc.bdev.lvm.vg"
         ]
-        rc, vg, err = self._run_command(build_command)
+        rc, vg, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1204,7 +1189,7 @@ class LxcContainerManagement(object):
         build_command = [
             self.module.get_bin_path('lvs', True)
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1231,7 +1216,7 @@ class LxcContainerManagement(object):
             '--units',
             'g'
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1262,7 +1247,7 @@ class LxcContainerManagement(object):
             '--units',
             'g'
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1311,7 +1296,7 @@ class LxcContainerManagement(object):
             os.path.join(vg, source_lv),
             "-L%sg" % snapshot_size_gb
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1336,7 +1321,7 @@ class LxcContainerManagement(object):
             "/dev/%s/%s" % (vg, lv_name),
             mount_point,
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1380,9 +1365,8 @@ class LxcContainerManagement(object):
             '.'
         ]
 
-        rc, stdout, err = self._run_command(
-            build_command=build_command,
-            unsafe_shell=True
+        rc, stdout, err = self.module.run_command(
+            build_command
         )
 
         os.umask(old_umask)
@@ -1410,7 +1394,7 @@ class LxcContainerManagement(object):
             "-f",
             "%s/%s" % (vg, lv_name),
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1442,11 +1426,10 @@ class LxcContainerManagement(object):
                 self.module.get_bin_path('rsync', True),
                 '-aHAX',
                 fs_path,
-                temp_dir
+                temp_dir,
             ]
-            rc, stdout, err = self._run_command(
+            rc, stdout, err = self.module.run_command(
                 build_command,
-                unsafe_shell=True
             )
             if rc != 0:
                 self.failure(
@@ -1467,7 +1450,7 @@ class LxcContainerManagement(object):
             self.module.get_bin_path('umount', True),
             mount_point,
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,
@@ -1489,12 +1472,12 @@ class LxcContainerManagement(object):
 
         build_command = [
             self.module.get_bin_path('mount', True),
-            '-t overlayfs',
-            '-o lowerdir=%s,upperdir=%s' % (lowerdir, upperdir),
+            '-t', 'overlayfs',
+            '-o', 'lowerdir=%s,upperdir=%s' % (lowerdir, upperdir),
             'overlayfs',
             mount_point,
         ]
-        rc, stdout, err = self._run_command(build_command)
+        rc, stdout, err = self.module.run_command(build_command)
         if rc != 0:
             self.failure(
                 err=err,

plugins/modules/cloud/lxd/lxd_container.py

@@ -11,29 +11,28 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 module: lxd_container
-short_description: Manage LXD Containers
+short_description: Manage LXD instances
 description:
-  - Management of LXD containers
+  - Management of LXD containers and virtual machines.
 author: "Hiroaki Nakamura (@hnakamur)"
 options:
     name:
         description:
-          - Name of a container.
+          - Name of an instance.
         type: str
         required: true
     architecture:
         description:
-          - 'The architecture for the container (for example C(x86_64) or C(i686)).
+          - 'The architecture for the instance (for example C(x86_64) or C(i686)).
             See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
         type: str
         required: false
     config:
         description:
-          - 'The config for the container (for example C({"limits.cpu": "2"})).
+          - 'The config for the instance (for example C({"limits.cpu": "2"})).
             See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
-          - If the container already exists and its "config" values in metadata
-            obtained from GET /1.0/containers/<name>
-            U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#10containersname)
+          - If the instance already exists and its "config" values in metadata
+            obtained from the LXD API U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#instances-containers-and-virtual-machines)
             are different, this module tries to apply the configurations.
           - The keys starting with C(volatile.) are ignored for this comparison when I(ignore_volatile_options=true).
         type: dict
@@ -43,33 +42,32 @@ options:
           - If set to C(true), options starting with C(volatile.) are ignored. As a result,
             they are reapplied for each execution.
           - This default behavior can be changed by setting this option to C(false).
-          - The default value C(true) will be deprecated in community.general 4.0.0,
-            and will change to C(false) in community.general 5.0.0.
+          - The current default value C(true) is deprecated since community.general 4.0.0,
+            and will change to C(false) in community.general 6.0.0.
         type: bool
-        default: true
         required: false
         version_added: 3.7.0
     profiles:
         description:
-          - Profile to be used by the container.
+          - Profile to be used by the instance.
         type: list
         elements: str
     devices:
         description:
-          - 'The devices for the container
+          - 'The devices for the instance
             (for example C({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})).
             See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
         type: dict
         required: false
     ephemeral:
         description:
-          - Whether or not the container is ephemeral (for example C(true) or C(false)).
+          - Whether or not the instance is ephemeral (for example C(true) or C(false)).
             See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).
         required: false
         type: bool
     source:
         description:
-          - 'The source for the container
+          - 'The source for the instance
             (e.g. { "type": "image",
                     "mode": "pull",
                     "server": "https://images.linuxcontainers.org",
@@ -87,39 +85,49 @@ options:
           - absent
           - frozen
         description:
-          - Define the state of a container.
+          - Define the state of an instance.
         required: false
         default: started
         type: str
     target:
         description:
-          - For cluster deployments. Will attempt to create a container on a target node.
-            If container exists elsewhere in a cluster, then container will not be replaced or moved.
+          - For cluster deployments. Will attempt to create an instance on a target node.
+            If the instance exists elsewhere in a cluster, then it will not be replaced or moved.
             The name should respond to same name of the node you see in C(lxc cluster list).
         type: str
         required: false
         version_added: 1.0.0
     timeout:
         description:
-          - A timeout for changing the state of the container.
+          - A timeout for changing the state of the instance.
           - This is also used as a timeout for waiting until IPv4 addresses
-            are set to the all network interfaces in the container after
+            are set to the all network interfaces in the instance after
             starting or restarting.
         required: false
         default: 30
         type: int
+    type:
+        description:
+          - Instance type can be either C(virtual-machine) or C(container).
+        required: false
+        default: container
+        choices:
+          - container
+          - virtual-machine
+        type: str
+        version_added: 4.1.0
     wait_for_ipv4_addresses:
         description:
           - If this is true, the C(lxd_container) waits until IPv4 addresses
-            are set to the all network interfaces in the container after
+            are set to the all network interfaces in the instance after
             starting or restarting.
         required: false
         default: false
         type: bool
     force_stop:
         description:
-          - If this is true, the C(lxd_container) forces to stop the container
-            when it stops or restarts the container.
+          - If this is true, the C(lxd_container) forces to stop the instance
+            when it stops or restarts the instance.
         required: false
         default: false
         type: bool
@@ -161,18 +169,18 @@ options:
         required: false
         type: str
 notes:
-  - Containers must have a unique name. If you attempt to create a container
+  - Instances can be a container or a virtual machine, both of them must have unique name. If you attempt to create an instance
     with a name that already existed in the users namespace the module will
     simply return as "unchanged".
-  - There are two ways to run commands in containers, using the command
+  - There are two ways to run commands inside a container or virtual machine, using the command
     module or using the ansible lxd connection plugin bundled in Ansible >=
-    2.1, the later requires python to be installed in the container which can
+    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 container
+  - 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.
     See the example below.
-  - You can copy a file in the created container to the localhost
-    with `command=lxc file pull container_name/dir/filename filename`.
+  - You can copy a file in the created instance to the localhost
+    with `command=lxc file pull instance_name/dir/filename filename`.
     See the first example below.
 '''
 
@@ -241,6 +249,7 @@ EXAMPLES = '''
       community.general.lxd_container:
         name: mycontainer
         state: absent
+        type: container
 
 # An example for restarting a container
 - hosts: localhost
@@ -250,6 +259,7 @@ EXAMPLES = '''
       community.general.lxd_container:
         name: mycontainer
         state: restarted
+        type: container
 
 # An example for restarting a container using https to connect to the LXD server
 - hosts: localhost
@@ -307,16 +317,36 @@ EXAMPLES = '''
           mode: pull
           alias: ubuntu/xenial/amd64
         target: node02
+
+# An example for creating a virtual machine
+- hosts: localhost
+  connection: local
+  tasks:
+    - name: Create container on another node
+      community.general.lxd_container:
+        name: new-vm-1
+        type: virtual-machine
+        state: started
+        ignore_volatile_options: true
+        wait_for_ipv4_addresses: true
+        profiles: ["default"]
+        source:
+          protocol: simplestreams
+          type: image
+          mode: pull
+          server: https://images.linuxcontainers.org
+          alias: debian/11
+        timeout: 600
 '''
 
 RETURN = '''
 addresses:
-  description: Mapping from the network device name to a list of IPv4 addresses in the container
+  description: Mapping from the network device name to a list of IPv4 addresses in the instance.
   returned: when state is started or restarted
   type: dict
   sample: {"eth0": ["10.155.92.191"]}
 old_state:
-  description: The old state of the container
+  description: The old state of the instance.
   returned: when state is started or restarted
   type: str
   sample: "stopped"
@@ -326,7 +356,7 @@ logs:
   type: list
   sample: "(too long to be placed here)"
 actions:
-  description: List of actions performed for the container.
+  description: List of actions performed for the instance.
   returned: success
   type: list
   sample: '["create", "start"]'
@@ -385,6 +415,15 @@ class LXDContainerManagement(object):
         self.addresses = None
         self.target = self.module.params['target']
 
+        self.type = self.module.params['type']
+
+        # LXD Rest API provides additional endpoints for creating containers and virtual-machines.
+        self.api_endpoint = None
+        if self.type == 'container':
+            self.api_endpoint = '/1.0/containers'
+        elif self.type == 'virtual-machine':
+            self.api_endpoint = '/1.0/virtual-machines'
+
         self.key_file = self.module.params.get('client_key')
         if self.key_file is None:
             self.key_file = '{0}/.config/lxc/client.key'.format(os.environ['HOME'])
@@ -420,20 +459,20 @@ class LXDContainerManagement(object):
             if param_val is not None:
                 self.config[attr] = param_val
 
-    def _get_container_json(self):
+    def _get_instance_json(self):
         return self.client.do(
-            'GET', '/1.0/containers/{0}'.format(self.name),
+            'GET', '{0}/{1}'.format(self.api_endpoint, self.name),
             ok_error_codes=[404]
         )
 
-    def _get_container_state_json(self):
+    def _get_instance_state_json(self):
         return self.client.do(
-            'GET', '/1.0/containers/{0}/state'.format(self.name),
+            'GET', '{0}/{1}/state'.format(self.api_endpoint, self.name),
             ok_error_codes=[404]
         )
 
     @staticmethod
-    def _container_json_to_module_state(resp_json):
+    def _instance_json_to_module_state(resp_json):
         if resp_json['type'] == 'error':
             return 'absent'
         return ANSIBLE_LXD_STATES[resp_json['metadata']['status']]
@@ -442,45 +481,45 @@ class LXDContainerManagement(object):
         body_json = {'action': action, 'timeout': self.timeout}
         if force_stop:
             body_json['force'] = True
-        return self.client.do('PUT', '/1.0/containers/{0}/state'.format(self.name), body_json=body_json)
+        return self.client.do('PUT', '{0}/{1}/state'.format(self.api_endpoint, self.name), body_json=body_json)
 
-    def _create_container(self):
+    def _create_instance(self):
         config = self.config.copy()
         config['name'] = self.name
         if self.target:
-            self.client.do('POST', '/1.0/containers?' + urlencode(dict(target=self.target)), config)
+            self.client.do('POST', '{0}?{1}'.format(self.api_endpoint, urlencode(dict(target=self.target))), config)
         else:
-            self.client.do('POST', '/1.0/containers', config)
+            self.client.do('POST', self.api_endpoint, config)
         self.actions.append('create')
 
-    def _start_container(self):
+    def _start_instance(self):
         self._change_state('start')
         self.actions.append('start')
 
-    def _stop_container(self):
+    def _stop_instance(self):
         self._change_state('stop', self.force_stop)
         self.actions.append('stop')
 
-    def _restart_container(self):
+    def _restart_instance(self):
         self._change_state('restart', self.force_stop)
         self.actions.append('restart')
 
-    def _delete_container(self):
-        self.client.do('DELETE', '/1.0/containers/{0}'.format(self.name))
+    def _delete_instance(self):
+        self.client.do('DELETE', '{0}/{1}'.format(self.api_endpoint, self.name))
         self.actions.append('delete')
 
-    def _freeze_container(self):
+    def _freeze_instance(self):
         self._change_state('freeze')
         self.actions.append('freeze')
 
-    def _unfreeze_container(self):
+    def _unfreeze_instance(self):
         self._change_state('unfreeze')
         self.actions.append('unfreez')
 
-    def _container_ipv4_addresses(self, ignore_devices=None):
+    def _instance_ipv4_addresses(self, ignore_devices=None):
         ignore_devices = ['lo'] if ignore_devices is None else ignore_devices
 
-        resp_json = self._get_container_state_json()
+        resp_json = self._get_instance_state_json()
         network = resp_json['metadata']['network'] or {}
         network = dict((k, v) for k, v in network.items() if k not in ignore_devices) or {}
         addresses = dict((k, [a['address'] for a in v['addresses'] if a['family'] == 'inet']) for k, v in network.items()) or {}
@@ -495,7 +534,7 @@ class LXDContainerManagement(object):
             due = datetime.datetime.now() + datetime.timedelta(seconds=self.timeout)
             while datetime.datetime.now() < due:
                 time.sleep(1)
-                addresses = self._container_ipv4_addresses()
+                addresses = self._instance_ipv4_addresses()
                 if self._has_all_ipv4_addresses(addresses):
                     self.addresses = addresses
                     return
@@ -505,72 +544,72 @@ class LXDContainerManagement(object):
 
     def _started(self):
         if self.old_state == 'absent':
-            self._create_container()
-            self._start_container()
+            self._create_instance()
+            self._start_instance()
         else:
             if self.old_state == 'frozen':
-                self._unfreeze_container()
+                self._unfreeze_instance()
             elif self.old_state == 'stopped':
-                self._start_container()
-            if self._needs_to_apply_container_configs():
-                self._apply_container_configs()
+                self._start_instance()
+            if self._needs_to_apply_instance_configs():
+                self._apply_instance_configs()
         if self.wait_for_ipv4_addresses:
             self._get_addresses()
 
     def _stopped(self):
         if self.old_state == 'absent':
-            self._create_container()
+            self._create_instance()
         else:
             if self.old_state == 'stopped':
-                if self._needs_to_apply_container_configs():
-                    self._start_container()
-                    self._apply_container_configs()
-                    self._stop_container()
+                if self._needs_to_apply_instance_configs():
+                    self._start_instance()
+                    self._apply_instance_configs()
+                    self._stop_instance()
             else:
                 if self.old_state == 'frozen':
-                    self._unfreeze_container()
-                if self._needs_to_apply_container_configs():
-                    self._apply_container_configs()
-                self._stop_container()
+                    self._unfreeze_instance()
+                if self._needs_to_apply_instance_configs():
+                    self._apply_instance_configs()
+                self._stop_instance()
 
     def _restarted(self):
         if self.old_state == 'absent':
-            self._create_container()
-            self._start_container()
+            self._create_instance()
+            self._start_instance()
         else:
             if self.old_state == 'frozen':
-                self._unfreeze_container()
-            if self._needs_to_apply_container_configs():
-                self._apply_container_configs()
-            self._restart_container()
+                self._unfreeze_instance()
+            if self._needs_to_apply_instance_configs():
+                self._apply_instance_configs()
+            self._restart_instance()
         if self.wait_for_ipv4_addresses:
             self._get_addresses()
 
     def _destroyed(self):
         if self.old_state != 'absent':
             if self.old_state == 'frozen':
-                self._unfreeze_container()
+                self._unfreeze_instance()
             if self.old_state != 'stopped':
-                self._stop_container()
-            self._delete_container()
+                self._stop_instance()
+            self._delete_instance()
 
     def _frozen(self):
         if self.old_state == 'absent':
-            self._create_container()
-            self._start_container()
-            self._freeze_container()
+            self._create_instance()
+            self._start_instance()
+            self._freeze_instance()
         else:
             if self.old_state == 'stopped':
-                self._start_container()
-            if self._needs_to_apply_container_configs():
-                self._apply_container_configs()
-            self._freeze_container()
+                self._start_instance()
+            if self._needs_to_apply_instance_configs():
+                self._apply_instance_configs()
+            self._freeze_instance()
 
-    def _needs_to_change_container_config(self, key):
+    def _needs_to_change_instance_config(self, key):
         if key not in self.config:
             return False
         if key == 'config' and self.ignore_volatile_options:  # the old behavior is to ignore configurations by keyword "volatile"
-            old_configs = dict((k, v) for k, v in self.old_container_json['metadata'][key].items() if not k.startswith('volatile.'))
+            old_configs = dict((k, v) for k, v in self.old_instance_json['metadata'][key].items() if not k.startswith('volatile.'))
             for k, v in self.config['config'].items():
                 if k not in old_configs:
                     return True
@@ -578,7 +617,7 @@ class LXDContainerManagement(object):
                     return True
             return False
         elif key == 'config':  # next default behavior
-            old_configs = dict((k, v) for k, v in self.old_container_json['metadata'][key].items())
+            old_configs = dict((k, v) for k, v in self.old_instance_json['metadata'][key].items())
             for k, v in self.config['config'].items():
                 if k not in old_configs:
                     return True
@@ -586,39 +625,41 @@ class LXDContainerManagement(object):
                     return True
             return False
         else:
-            old_configs = self.old_container_json['metadata'][key]
+            old_configs = self.old_instance_json['metadata'][key]
             return self.config[key] != old_configs
 
-    def _needs_to_apply_container_configs(self):
+    def _needs_to_apply_instance_configs(self):
         return (
-            self._needs_to_change_container_config('architecture') or
-            self._needs_to_change_container_config('config') or
-            self._needs_to_change_container_config('ephemeral') or
-            self._needs_to_change_container_config('devices') or
-            self._needs_to_change_container_config('profiles')
+            self._needs_to_change_instance_config('architecture') or
+            self._needs_to_change_instance_config('config') or
+            self._needs_to_change_instance_config('ephemeral') or
+            self._needs_to_change_instance_config('devices') or
+            self._needs_to_change_instance_config('profiles')
         )
 
-    def _apply_container_configs(self):
-        old_metadata = self.old_container_json['metadata']
+    def _apply_instance_configs(self):
+        old_metadata = self.old_instance_json['metadata']
         body_json = {
             'architecture': old_metadata['architecture'],
             'config': old_metadata['config'],
             'devices': old_metadata['devices'],
             'profiles': old_metadata['profiles']
         }
-        if self._needs_to_change_container_config('architecture'):
+
+        if self._needs_to_change_instance_config('architecture'):
             body_json['architecture'] = self.config['architecture']
-        if self._needs_to_change_container_config('config'):
+        if self._needs_to_change_instance_config('config'):
             for k, v in self.config['config'].items():
                 body_json['config'][k] = v
-        if self._needs_to_change_container_config('ephemeral'):
+        if self._needs_to_change_instance_config('ephemeral'):
             body_json['ephemeral'] = self.config['ephemeral']
-        if self._needs_to_change_container_config('devices'):
+        if self._needs_to_change_instance_config('devices'):
             body_json['devices'] = self.config['devices']
-        if self._needs_to_change_container_config('profiles'):
+        if self._needs_to_change_instance_config('profiles'):
             body_json['profiles'] = self.config['profiles']
-        self.client.do('PUT', '/1.0/containers/{0}'.format(self.name), body_json=body_json)
-        self.actions.append('apply_container_configs')
+
+        self.client.do('PUT', '{0}/{1}'.format(self.api_endpoint, self.name), body_json=body_json)
+        self.actions.append('apply_instance_configs')
 
     def run(self):
         """Run the main method."""
@@ -628,8 +669,8 @@ class LXDContainerManagement(object):
                 self.client.authenticate(self.trust_password)
             self.ignore_volatile_options = self.module.params.get('ignore_volatile_options')
 
-            self.old_container_json = self._get_container_json()
-            self.old_state = self._container_json_to_module_state(self.old_container_json)
+            self.old_instance_json = self._get_instance_json()
+            self.old_state = self._instance_json_to_module_state(self.old_instance_json)
             action = getattr(self, LXD_ANSIBLE_STATES[self.state])
             action()
 
@@ -674,7 +715,6 @@ def main():
             ),
             ignore_volatile_options=dict(
                 type='bool',
-                default=True
             ),
             devices=dict(
                 type='dict',
@@ -700,6 +740,11 @@ def main():
                 type='int',
                 default=30
             ),
+            type=dict(
+                type='str',
+                default='container',
+                choices=['container', 'virtual-machine'],
+            ),
             wait_for_ipv4_addresses=dict(
                 type='bool',
                 default=False
@@ -728,13 +773,17 @@ def main():
         ),
         supports_check_mode=False,
     )
-    # if module.params['ignore_volatile_options'] is None:
-    #     module.params['ignore_volatile_options'] = True
-    #     module.deprecate(
-    #         'If the keyword "volatile" is used in a playbook in the config section, a
-    #         "changed" message will appear with every run, even without a change to the playbook.
-    #         This will change in the future.
-    #         Please test your scripts by "ignore_volatile_options: false"', version='5.0.0', collection_name='community.general')
+
+    if module.params['ignore_volatile_options'] is None:
+        module.params['ignore_volatile_options'] = True
+        module.deprecate(
+            'If the keyword "volatile" is used in a playbook in the config'
+            'section, a "changed" message will appear with every run, even without a change'
+            'to the playbook.'
+            'This will change in the future. Please test your scripts'
+            'by "ignore_volatile_options: false". To keep the old behavior, set that option explicitly to "true"',
+            version='6.0.0', collection_name='community.general')
+
     lxd_manage = LXDContainerManagement(module=module)
     lxd_manage.run()
 

plugins/modules/cloud/misc/proxmox.py

@@ -13,7 +13,7 @@ short_description: management of instances in Proxmox VE cluster
 description:
   - allows you to create/delete/stop instances in Proxmox VE cluster
   - Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)
-  - From community.general 4.0.0 on, there will be no default values, see I(proxmox_default_behavior).
+  - Since community.general 4.0.0 on, there are no more default values, see I(proxmox_default_behavior).
 options:
   password:
     description:
@@ -40,37 +40,27 @@ options:
         comma-delimited list C([volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>]
         [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>])."
       - See U(https://pve.proxmox.com/wiki/Linux_Container) for a full description.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(3). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(3).
     type: str
   cores:
     description:
       - Specify number of cores per socket.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1).
     type: int
   cpus:
     description:
       - numbers of allocated cpus for instance
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1).
     type: int
   memory:
     description:
       - memory size in MB for instance
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(512). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(512).
     type: int
   swap:
     description:
       - swap memory size in MB for instance
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(0). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(0).
     type: int
   netif:
     description:
@@ -94,9 +84,7 @@ options:
   onboot:
     description:
       - specifies whether a VM will be started during system bootup
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(no). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
     type: bool
   storage:
     description:
@@ -106,9 +94,7 @@ options:
   cpuunits:
     description:
       - CPU weight for a VM
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1000). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1000).
     type: int
   nameserver:
     description:
@@ -168,16 +154,15 @@ options:
     version_added: '0.2.0'
   proxmox_default_behavior:
     description:
-      - Various module options used to have default values. This cause problems when
-        user expects different behavior from proxmox by default or fill options which cause
-        problems when they have been set.
-      - The default value is C(compatibility), which will ensure that the default values
-        are used when the values are not explicitly specified by the user.
-      - From community.general 4.0.0 on, the default value will switch to C(no_defaults). To avoid
-        deprecation warnings, please set I(proxmox_default_behavior) to an explicit
-        value.
+      - As of community.general 4.0.0, various options no longer have default values.
+        These default values caused problems when users expected different behavior from Proxmox
+        by default or filled options which caused problems when set.
+      - The value C(compatibility) (default before community.general 4.0.0) will ensure that the default values
+        are used when the values are not explicitly specified by the user. The new default is C(no_defaults),
+        which makes sure these options have no defaults.
       - This affects the I(disk), I(cores), I(cpus), I(memory), I(onboot), I(swap), I(cpuunits) options.
     type: str
+    default: no_defaults
     choices:
       - compatibility
       - no_defaults
@@ -363,8 +348,7 @@ EXAMPLES = r'''
 
 import time
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 try:
     from proxmoxer import ProxmoxAPI
@@ -534,7 +518,7 @@ def main():
             unprivileged=dict(type='bool', default=False),
             description=dict(type='str'),
             hookscript=dict(type='str'),
-            proxmox_default_behavior=dict(type='str', choices=['compatibility', 'no_defaults']),
+            proxmox_default_behavior=dict(type='str', default='no_defaults', choices=['compatibility', 'no_defaults']),
         ),
         required_if=[('state', 'present', ['node', 'hostname', 'ostemplate'])],
         required_together=[('api_token_id', 'api_token_secret')],
@@ -563,13 +547,6 @@ def main():
         template_store = module.params['ostemplate'].split(":")[0]
     timeout = module.params['timeout']
 
-    if module.params['proxmox_default_behavior'] is None:
-        module.params['proxmox_default_behavior'] = 'compatibility'
-        module.deprecate(
-            'The proxmox_default_behavior option will change its default value from "compatibility" to '
-            '"no_defaults" in community.general 4.0.0. To remove this warning, please specify an explicit value for it now',
-            version='4.0.0', collection_name='community.general'
-        )
     if module.params['proxmox_default_behavior'] == 'compatibility':
         old_default_values = dict(
             disk="3",

plugins/modules/cloud/misc/proxmox_kvm.py

@@ -13,15 +13,13 @@ module: proxmox_kvm
 short_description: Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster.
 description:
   - Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster.
-  - From community.general 4.0.0 on, there will be no default values, see I(proxmox_default_behavior).
+  - Since community.general 4.0.0 on, there are no more default values, see I(proxmox_default_behavior).
 author: "Abdoul Bah (@helldorado) <bahabdoul at gmail.com>"
 options:
   acpi:
     description:
       - Specify if ACPI should be enabled/disabled.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(yes). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
     type: bool
   agent:
     description:
@@ -31,24 +29,19 @@ options:
     description:
       - Pass arbitrary arguments to kvm.
       - This option is for experts only!
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(-serial unix:/var/run/qemu-server/<vmid>.serial,server,nowait).
-        Note that the default value of I(proxmox_default_behavior) changes in community.general 4.0.0.
+      - If I(proxmox_default_behavior) is set to C(compatiblity), this option has a default of
+        C(-serial unix:/var/run/qemu-server/<vmid>.serial,server,nowait).
     type: str
   autostart:
     description:
       - Specify if the VM should be automatically restarted after crash (currently ignored in PVE API).
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(no). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
     type: bool
   balloon:
     description:
       - Specify the amount of RAM for the VM in MB.
       - Using zero disables the balloon driver.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(0). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(0).
     type: int
   bios:
     description:
@@ -59,9 +52,7 @@ options:
     description:
       - Specify the boot order -> boot on floppy C(a), hard disk C(c), CD-ROM C(d), or network C(n).
       - You can combine to set order.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(cnd). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(cnd).
     type: str
   bootdisk:
     description:
@@ -97,16 +88,12 @@ options:
   cores:
     description:
       - Specify number of cores per socket.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1).
     type: int
   cpu:
     description:
       - Specify emulated CPU type.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(kvm64). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(kvm64).
     type: str
   cpulimit:
     description:
@@ -117,9 +104,7 @@ options:
     description:
       - Specify CPU weight for a VM.
       - You can disable fair-scheduler configuration by setting this to 0
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1000). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1000).
     type: int
   delete:
     description:
@@ -139,19 +124,15 @@ options:
     description:
       - Allow to force stop VM.
       - Can be used with states C(stopped), C(restarted) and C(absent).
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(no). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
     type: bool
   format:
     description:
       - Target drive's backing file's data format.
       - Used only with clone
       - Use I(format=unspecified) and I(full=false) for a linked clone.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(qcow2). If I(proxmox_default_behavior) is set to C(no_defaults),
-        not specifying this option is equivalent to setting it to C(unspecified).
-        Note that the default value of I(proxmox_default_behavior) changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(qcow2).
+        If I(proxmox_default_behavior) is set to C(no_defaults), not specifying this option is equivalent to setting it to C(unspecified).
     type: str
     choices: [ "cloop", "cow", "qcow", "qcow2", "qed", "raw", "vmdk", "unspecified" ]
   freeze:
@@ -216,9 +197,7 @@ options:
   kvm:
     description:
       - Enable/disable KVM hardware virtualization.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(yes). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
     type: bool
   localtime:
     description:
@@ -238,9 +217,7 @@ options:
   memory:
     description:
       - Memory size in MB for instance.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(512). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(512).
     type: int
   migrate_downtime:
     description:
@@ -296,17 +273,13 @@ options:
   onboot:
     description:
       - Specifies whether a VM will be started during system bootup.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(yes). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
     type: bool
   ostype:
     description:
       - Specifies guest operating system. This is used to enable special optimization/features for specific operating systems.
       - The l26 is Linux 2.6/3.X Kernel.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(l26). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(l26).
     type: str
     choices: ['other', 'wxp', 'w2k', 'w2k3', 'w2k8', 'wvista', 'win7', 'win8', 'win10', 'l24', 'l26', 'solaris']
   parallel:
@@ -387,9 +360,7 @@ options:
   sockets:
     description:
       - Sets the number of CPU sockets. (1 - N).
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(1). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(1).
     type: int
   sshkeys:
     description:
@@ -421,9 +392,7 @@ options:
   tablet:
     description:
       - Enables/disables the USB tablet device.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(no). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
     type: bool
   tags:
     description:
@@ -445,9 +414,7 @@ options:
   template:
     description:
       - Enables/disables the template.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(no). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
     type: bool
   timeout:
     description:
@@ -469,9 +436,7 @@ options:
   vga:
     description:
       - Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option 'std' or 'vmware'.
-      - If I(proxmox_default_behavior) is set to C(compatiblity) (the default value), this
-        option has a default of C(std). Note that the default value of I(proxmox_default_behavior)
-        changes in community.general 4.0.0.
+      - This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(std).
     type: str
     choices: ['std', 'cirrus', 'vmware', 'qxl', 'serial0', 'serial1', 'serial2', 'serial3', 'qxl2', 'qxl3', 'qxl4']
   virtio:
@@ -489,18 +454,17 @@ options:
     type: str
   proxmox_default_behavior:
     description:
-      - Various module options used to have default values. This cause problems when
-        user expects different behavior from proxmox by default or fill options which cause
-        problems when they have been set.
-      - The default value is C(compatibility), which will ensure that the default values
-        are used when the values are not explicitly specified by the user.
-      - From community.general 4.0.0 on, the default value will switch to C(no_defaults). To avoid
-        deprecation warnings, please set I(proxmox_default_behavior) to an explicit
-        value.
+     - As of community.general 4.0.0, various options no longer have default values.
+        These default values caused problems when users expected different behavior from Proxmox
+        by default or filled options which caused problems when set.
+      - The value C(compatibility) (default before community.general 4.0.0) will ensure that the default values
+        are used when the values are not explicitly specified by the user. The new default is C(no_defaults),
+        which makes sure these options have no defaults.
       - This affects the I(acpi), I(autostart), I(balloon), I(boot), I(cores), I(cpu),
         I(cpuunits), I(force), I(format), I(kvm), I(memory), I(onboot), I(ostype), I(sockets),
         I(tablet), I(template), I(vga), options.
     type: str
+    default: no_defaults
     choices:
       - compatibility
       - no_defaults
@@ -761,10 +725,9 @@ msg:
 import re
 import time
 import traceback
+from distutils.version import LooseVersion
 from ansible.module_utils.six.moves.urllib.parse import quote
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 try:
     from proxmoxer import ProxmoxAPI
     HAS_PROXMOXER = True
@@ -1092,7 +1055,7 @@ def main():
             virtio=dict(type='dict'),
             vmid=dict(type='int'),
             watchdog=dict(),
-            proxmox_default_behavior=dict(type='str', choices=['compatibility', 'no_defaults']),
+            proxmox_default_behavior=dict(type='str', default='no_defaults', choices=['compatibility', 'no_defaults']),
         ),
         mutually_exclusive=[('delete', 'revert'), ('delete', 'update'), ('revert', 'update'), ('clone', 'update'), ('clone', 'delete'), ('clone', 'revert')],
         required_together=[('api_token_id', 'api_token_secret')],
@@ -1123,13 +1086,6 @@ def main():
     vmid = module.params['vmid']
     validate_certs = module.params['validate_certs']
 
-    if module.params['proxmox_default_behavior'] is None:
-        module.params['proxmox_default_behavior'] = 'compatibility'
-        module.deprecate(
-            'The proxmox_default_behavior option will change its default value from "compatibility" to '
-            '"no_defaults" in community.general 4.0.0. To remove this warning, please specify an explicit value for it now',
-            version='4.0.0', collection_name='community.general'
-        )
     if module.params['proxmox_default_behavior'] == 'compatibility':
         old_default_values = dict(
             acpi=True,

plugins/modules/cloud/misc/terraform.py

@@ -230,12 +230,11 @@ command:
 import os
 import json
 import tempfile
+from distutils.version import LooseVersion
 from ansible.module_utils.six.moves import shlex_quote
 
 from ansible.module_utils.basic import AnsibleModule
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 module = None
 
 

plugins/modules/cloud/rackspace/rax_cbs.py

@@ -97,7 +97,7 @@ EXAMPLES = '''
       register: my_volume
 '''
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 try:
     import pyrax

plugins/modules/cloud/scaleway/scaleway_security_group_rule.py

@@ -18,11 +18,12 @@ module: scaleway_security_group_rule
 short_description: Scaleway Security Group Rule management module
 author: Antoine Barbare (@abarbare)
 description:
-    - This module manages Security Group Rule on Scaleway account
-      U(https://developer.scaleway.com)
+  - This module manages Security Group Rule on Scaleway account
+    U(https://developer.scaleway.com)
 extends_documentation_fragment:
-- community.general.scaleway
-
+  - community.general.scaleway
+requirements:
+  - ipaddress
 
 options:
   state:
@@ -130,10 +131,19 @@ data:
     }
 '''
 
+import traceback
+
 from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway, payload_from_object
-from ansible_collections.community.general.plugins.module_utils.compat.ipaddress import ip_network
 from ansible.module_utils.common.text.converters import to_text
-from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+
+try:
+    from ipaddress import ip_network
+except ImportError:
+    IPADDRESS_IMP_ERR = traceback.format_exc()
+    HAS_IPADDRESS = False
+else:
+    HAS_IPADDRESS = True
 
 
 def get_sgr_from_api(security_group_rules, security_group_rule):
@@ -256,6 +266,8 @@ def main():
         argument_spec=argument_spec,
         supports_check_mode=True,
     )
+    if not HAS_IPADDRESS:
+        module.fail_json(msg=missing_required_lib('ipaddress'), exception=IPADDRESS_IMP_ERR)
 
     core(module)
 

plugins/modules/cloud/scaleway/scaleway_user_data.py

@@ -75,7 +75,7 @@ def patch_user_data(compute_api, server_id, key, value):
     compute_api.module.debug("Starting patching user_data attributes")
 
     path = "servers/%s/user_data/%s" % (server_id, key)
-    response = compute_api.patch(path=path, data=value, headers={"Content-Type": "text/plain"})
+    response = compute_api.patch(path=path, data=value, headers={"Content-type": "text/plain"})
     if not response.ok:
         msg = 'Error during user_data patching: %s %s' % (response.status_code, response.body)
         compute_api.module.fail_json(msg=msg)

plugins/modules/database/misc/kibana_plugin.py

@@ -117,10 +117,9 @@ state:
 '''
 
 import os
+from distutils.version import LooseVersion
 from ansible.module_utils.basic import AnsibleModule
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 
 PACKAGE_STATE_MAP = dict(
     present="--install",

plugins/modules/database/misc/redis_data.py

@@ -60,6 +60,7 @@ extends_documentation_fragment:
   - community.general.redis.documentation
 
 seealso:
+    - module: community.general.redis_data_incr
     - module: community.general.redis_data_info
     - module: community.general.redis
 '''

plugins/modules/database/misc/redis_data_incr.py

@@ -0,0 +1,187 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+DOCUMENTATION = '''
+---
+module: redis_data_incr
+short_description: Increment keys in Redis
+version_added: 4.0.0
+description:
+   - Increment integers or float keys in Redis database and get new value.
+   - Default increment for all keys is 1. For specific increments use the
+     I(increment_int) and I(increment_float) options.
+   - When using I(check_mode) the module will try to calculate the value that
+     Redis would return. If the key is not present, 0.0 is used as value.
+author: "Andreas Botzner (@paginabianca)"
+options:
+  key:
+    description:
+      - Database key.
+    type: str
+    required: true
+  increment_int:
+    description:
+      - Integer amount to increment the key by.
+    required: false
+    type: int
+  increment_float:
+    description:
+      - Float amount to increment the key by.
+      - This only works with keys that contain float values
+        in their string representation.
+    type: float
+    required: false
+
+
+extends_documentation_fragment:
+  - community.general.redis.documentation
+
+notes:
+   - For C(check_mode) to work, the specified I(redis_user) needs permission to
+     run the C(GET) command on the key, otherwise the module will fail.
+
+seealso:
+    - module: community.general.redis_data
+    - module: community.general.redis_data_info
+    - module: community.general.redis
+'''
+
+EXAMPLES = '''
+- name: Increment integer key foo on localhost with no username and print new value
+  community.general.redis_data_incr:
+    login_host: localhost
+    login_password: supersecret
+    key: foo
+    increment_int: 1
+  register: result
+- name: Print new value
+  debug:
+    var: result.value
+
+- name: Increment float key foo by 20.4
+  community.general.redis_data_incr:
+    login_host: redishost
+    login_user: redisuser
+    login_password: somepass
+    key: foo
+    increment_float: '20.4'
+'''
+
+RETURN = '''
+value:
+  description: Incremented value of key
+  returned: on success
+  type: float
+  sample: '4039.4'
+msg:
+  description: A short message.
+  returned: always
+  type: str
+  sample: 'Incremented key: foo by 20.4 to 65.9'
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.redis import (
+    fail_imports, redis_auth_argument_spec, RedisAnsible)
+
+
+def main():
+    redis_auth_args = redis_auth_argument_spec()
+    module_args = dict(
+        key=dict(type='str', required=True, no_log=False),
+        increment_int=dict(type='int', required=False),
+        increment_float=dict(type='float', required=False),
+    )
+    module_args.update(redis_auth_args)
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True,
+        mutually_exclusive=[['increment_int', 'increment_float']],
+    )
+    fail_imports(module)
+
+    redis = RedisAnsible(module)
+    key = module.params['key']
+    increment_float = module.params['increment_float']
+    increment_int = module.params['increment_int']
+    increment = 1
+    if increment_float is not None:
+        increment = increment_float
+    elif increment_int is not None:
+        increment = increment_int
+
+    result = {'changed': False}
+    if module.check_mode:
+        value = 0.0
+        try:
+            res = redis.connection.get(key)
+            if res is not None:
+                value = float(res)
+        except ValueError as e:
+            msg = 'Value: {0} of key: {1} is not incrementable(int or float)'.format(
+                res, key)
+            result['msg'] = msg
+            module.fail_json(**result)
+        except Exception as e:
+            msg = 'Failed to get value of key: {0} with exception: {1}'.format(
+                key, str(e))
+            result['msg'] = msg
+            module.fail_json(**result)
+        msg = 'Incremented key: {0} by {1} to {2}'.format(
+            key, increment, value + increment)
+        result['msg'] = msg
+        result['value'] = float(value + increment)
+        module.exit_json(**result)
+
+    if increment_float is not None:
+        try:
+            value = redis.connection.incrbyfloat(key, increment)
+            msg = 'Incremented key: {0} by {1} to {2}'.format(
+                key, increment, value)
+            result['msg'] = msg
+            result['value'] = float(value)
+            result['changed'] = True
+            module.exit_json(**result)
+        except Exception as e:
+            msg = 'Failed to increment key: {0} by {1} with exception: {2}'.format(
+                key, increment, str(e))
+            result['msg'] = msg
+            module.fail_json(**result)
+    elif increment_int is not None:
+        try:
+            value = redis.connection.incrby(key, increment)
+            msg = 'Incremented key: {0} by {1} to {2}'.format(
+                key, increment, value)
+            result['msg'] = msg
+            result['value'] = float(value)
+            result['changed'] = True
+            module.exit_json(**result)
+        except Exception as e:
+            msg = 'Failed to increment key: {0} by {1} with exception: {2}'.format(
+                key, increment, str(e))
+            result['msg'] = msg
+            module.fail_json(**result)
+    else:
+        try:
+            value = redis.connection.incr(key)
+            msg = 'Incremented key: {0} to {1}'.format(key, value)
+            result['msg'] = msg
+            result['value'] = float(value)
+            result['changed'] = True
+            module.exit_json(**result)
+        except Exception as e:
+            msg = 'Failed to increment key: {0} with exception: {1}'.format(
+                key, str(e))
+            result['msg'] = msg
+            module.fail_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/database/misc/redis_data_info.py

@@ -27,6 +27,7 @@ extends_documentation_fragment:
 
 seealso:
   - module: community.general.redis_data
+  - module: community.general.redis_data_incr
   - module: community.general.redis_info
   - module: community.general.redis
 '''

plugins/modules/database/mssql/mssql_script.py

@@ -0,0 +1,301 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2021, Kris Budde <kris@budd.ee
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+---
+module: mssql_script
+
+short_description: Execute SQL scripts on a MSSQL database
+
+version_added: "4.0.0"
+
+description:
+  - Execute SQL scripts on a MSSQL database.
+
+options:
+    name:
+        description: Database to run script against.
+        aliases: [ db ]
+        default: ''
+        type: str
+    login_user:
+        description: The username used to authenticate with.
+        type: str
+    login_password:
+        description: The password used to authenticate with.
+        type: str
+    login_host:
+        description: Host running the database.
+        type: str
+        required: true
+    login_port:
+        description: Port of the MSSQL server. Requires I(login_host) be defined as well.
+        default: 1433
+        type: int
+    script:
+        description:
+          - The SQL script to be executed.
+          - Script can contain multiple SQL statements. Multiple Batches can be separated by C(GO) command.
+          - Each batch must return at least one result set.
+        required: true
+        type: str
+    output:
+        description:
+          - With C(default) each row will be returned as a list of values. See C(query_results).
+          - Output format C(dict) will return dictionary with the column names as keys. See C(query_results_dict).
+          - C(dict) requires named columns to be returned by each query otherwise an error is thrown.
+        choices: [ "dict", "default" ]
+        default: 'default'
+        type: str
+    params:
+        description: |
+            Parameters passed to the script as SQL parameters. ('SELECT %(name)s"' with C(example: '{"name": "John Doe"}).)'
+        type: dict
+notes:
+   - Requires the pymssql Python package on the remote host. For Ubuntu, this
+     is as easy as C(pip install pymssql) (See M(ansible.builtin.pip).)
+requirements:
+   - python >= 2.7
+   - pymssql
+
+author:
+    - Kris Budde (@kbudde)
+'''
+
+EXAMPLES = r'''
+- name: Check DB connection
+  community.general.mssql_script:
+    login_user: "{{ mssql_login_user }}"
+    login_password: "{{ mssql_login_password }}"
+    login_host: "{{ mssql_host }}"
+    login_port: "{{ mssql_port }}"
+    db: master
+    script: "SELECT 1"
+
+- name: Query with parameter
+  community.general.mssql_script:
+    login_user: "{{ mssql_login_user }}"
+    login_password: "{{ mssql_login_password }}"
+    login_host: "{{ mssql_host }}"
+    login_port: "{{ mssql_port }}"
+    script: |
+      SELECT name, state_desc FROM sys.databases WHERE name = %(dbname)s
+    params:
+      dbname: msdb
+  register: result_params
+- assert:
+    that:
+      - result_params.query_results[0][0][0][0] == 'msdb'
+      - result_params.query_results[0][0][0][1] == 'ONLINE'
+
+- name: two batches with default output
+  community.general.mssql_script:
+    login_user: "{{ mssql_login_user }}"
+    login_password: "{{ mssql_login_password }}"
+    login_host: "{{ mssql_host }}"
+    login_port: "{{ mssql_port }}"
+    script: |
+      SELECT 'Batch 0 - Select 0'
+      SELECT 'Batch 0 - Select 1'
+      GO
+      SELECT 'Batch 1 - Select 0'
+  register: result_batches
+- assert:
+    that:
+      - result_batches.query_results | length == 2  # two batch results
+      - result_batches.query_results[0] | length == 2  # two selects in first batch
+      - result_batches.query_results[0][0] | length == 1  # one row in first select
+      - result_batches.query_results[0][0][0] | length == 1  # one column in first row
+      - result_batches.query_results[0][0][0][0] == 'Batch 0 - Select 0'  # each row contains a list of values.
+
+- name: two batches with dict output
+  community.general.mssql_script:
+    login_user: "{{ mssql_login_user }}"
+    login_password: "{{ mssql_login_password }}"
+    login_host: "{{ mssql_host }}"
+    login_port: "{{ mssql_port }}"
+    output: dict
+    script: |
+      SELECT 'Batch 0 - Select 0' as b0s0
+      SELECT 'Batch 0 - Select 1' as b0s1
+      GO
+      SELECT 'Batch 1 - Select 0' as b1s0
+  register: result_batches_dict
+- assert:
+    that:
+      - result_batches_dict.query_results_dict | length == 2  # two batch results
+      - result_batches_dict.query_results_dict[0] | length == 2  # two selects in first batch
+      - result_batches_dict.query_results_dict[0][0] | length == 1  # one row in first select
+      - result_batches_dict.query_results_dict[0][0][0]['b0s0'] == 'Batch 0 - Select 0'  # column 'b0s0' of first row
+'''
+
+RETURN = r'''
+query_results:
+    description: List of batches (queries separated by C(GO) keyword).
+    type: list
+    elements: list
+    returned: success and I(output=default)
+    sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
+    contains:
+        queries:
+            description:
+              - List of result sets of each query.
+              - If a query returns no results, the results of this and all the following queries will not be included in the output.
+              - Use the C(GO) keyword in I(script) to separate queries.
+            type: list
+            elements: list
+            contains:
+                rows:
+                    description: List of rows returned by query.
+                    type: list
+                    elements: list
+                    contains:
+                        column_value:
+                            description:
+                              - List of column values.
+                              - Any non-standard JSON type is converted to string.
+                            type: list
+                            example: ["Batch 0 - Select 0"]
+                            returned: success, if output is default
+query_results_dict:
+    description: List of batches (queries separated by C(GO) keyword).
+    type: list
+    elements: list
+    returned: success and I(output=dict)
+    sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
+    contains:
+        queries:
+            description:
+              - List of result sets of each query.
+              - If a query returns no results, the results of this and all the following queries will not be included in the output.
+                Use 'GO' keyword to separate queries.
+            type: list
+            elements: list
+            contains:
+                rows:
+                    description: List of rows returned by query.
+                    type: list
+                    elements: list
+                    contains:
+                         column_dict:
+                            description:
+                              - Dictionary of column names and values.
+                              - Any non-standard JSON type is converted to string.
+                            type: dict
+                            example: {"col_name": "Batch 0 - Select 0"}
+                            returned: success, if output is dict
+'''
+
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+import traceback
+import json
+PYMSSQL_IMP_ERR = None
+try:
+    import pymssql
+except ImportError:
+    PYMSSQL_IMP_ERR = traceback.format_exc()
+    MSSQL_FOUND = False
+else:
+    MSSQL_FOUND = True
+
+
+def clean_output(o):
+    return str(o)
+
+
+def run_module():
+    module_args = dict(
+        name=dict(required=False, aliases=['db'], default=''),
+        login_user=dict(),
+        login_password=dict(no_log=True),
+        login_host=dict(required=True),
+        login_port=dict(type='int', default=1433),
+        script=dict(required=True),
+        output=dict(default='default', choices=['dict', 'default']),
+        params=dict(type='dict'),
+    )
+
+    result = dict(
+        changed=False,
+    )
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True
+    )
+    if not MSSQL_FOUND:
+        module.fail_json(msg=missing_required_lib(
+            'pymssql'), exception=PYMSSQL_IMP_ERR)
+
+    db = module.params['name']
+    login_user = module.params['login_user']
+    login_password = module.params['login_password']
+    login_host = module.params['login_host']
+    login_port = module.params['login_port']
+    script = module.params['script']
+    output = module.params['output']
+    sql_params = module.params['params']
+
+    login_querystring = login_host
+    if login_port != 1433:
+        login_querystring = "%s:%s" % (login_host, login_port)
+
+    if login_user is not None and login_password is None:
+        module.fail_json(
+            msg="when supplying login_user argument, login_password must also be provided")
+
+    try:
+        conn = pymssql.connect(
+            user=login_user, password=login_password, host=login_querystring, database=db)
+        cursor = conn.cursor()
+    except Exception as e:
+        if "Unknown database" in str(e):
+            errno, errstr = e.args
+            module.fail_json(msg="ERROR: %s %s" % (errno, errstr))
+        else:
+            module.fail_json(msg="unable to connect, check login_user and login_password are correct, or alternatively check your "
+                                 "@sysconfdir@/freetds.conf / ${HOME}/.freetds.conf")
+
+    conn.autocommit(True)
+
+    query_results_key = 'query_results'
+    if output == 'dict':
+        cursor = conn.cursor(as_dict=True)
+        query_results_key = 'query_results_dict'
+
+    queries = script.split('\nGO\n')
+    result['changed'] = True
+    if module.check_mode:
+        module.exit_json(**result)
+
+    query_results = []
+    try:
+        for query in queries:
+            cursor.execute(query, sql_params)
+            qry_result = []
+            rows = cursor.fetchall()
+            while rows:
+                qry_result.append(rows)
+                rows = cursor.fetchall()
+            query_results.append(qry_result)
+    except Exception as e:
+        return module.fail_json(msg="query failed", query=query, error=str(e), **result)
+
+    # ensure that the result is json serializable
+    qry_results = json.loads(json.dumps(query_results, default=clean_output))
+
+    result[query_results_key] = qry_results
+    module.exit_json(**result)
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/dnf_versionlock.py

@@ -0,0 +1 @@
+./packaging/os/dnf_versionlock.py

plugins/modules/dnsimple_info.py

@@ -0,0 +1 @@
+./net_tools/dnsimple_info.py

plugins/modules/files/archive.py

@@ -182,6 +182,7 @@ import zipfile
 from fnmatch import fnmatch
 from sys import version_info
 from traceback import format_exc
+from zlib import crc32
 
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 from ansible.module_utils.common.text.converters import to_bytes, to_native
@@ -234,10 +235,6 @@ def expand_paths(paths):
     return expanded_path, is_globby
 
 
-def legacy_filter(path, exclusion_patterns):
-    return matches_exclusion_patterns(path, exclusion_patterns)
-
-
 def matches_exclusion_patterns(path, exclusion_patterns):
     return any(fnmatch(path, p) for p in exclusion_patterns)
 
@@ -313,6 +310,7 @@ class Archive(object):
         if self.remove:
             self._check_removal_safety()
 
+        self.original_checksums = self.destination_checksums()
         self.original_size = self.destination_size()
 
     def add(self, path, archive_name):
@@ -377,8 +375,16 @@ class Archive(object):
                 msg='Errors when writing archive at %s: %s' % (_to_native(self.destination), '; '.join(self.errors))
             )
 
-    def compare_with_original(self):
-        self.changed |= self.original_size != self.destination_size()
+    def is_different_from_original(self):
+        if self.original_checksums is None:
+            return self.original_size != self.destination_size()
+        else:
+            return self.original_checksums != self.destination_checksums()
+
+    def destination_checksums(self):
+        if self.destination_exists() and self.destination_readable():
+            return self._get_checksums(self.destination)
+        return None
 
     def destination_exists(self):
         return self.destination and os.path.exists(self.destination)
@@ -494,6 +500,10 @@ class Archive(object):
     def _add(self, path, archive_name):
         pass
 
+    @abc.abstractmethod
+    def _get_checksums(self, path):
+        pass
+
 
 class ZipArchive(Archive):
     def __init__(self, module):
@@ -513,9 +523,18 @@ class ZipArchive(Archive):
         self.file = zipfile.ZipFile(_to_native_ascii(self.destination), 'w', zipfile.ZIP_DEFLATED, True)
 
     def _add(self, path, archive_name):
-        if not legacy_filter(path, self.exclusion_patterns):
+        if not matches_exclusion_patterns(path, self.exclusion_patterns):
             self.file.write(path, archive_name)
 
+    def _get_checksums(self, path):
+        try:
+            archive = zipfile.ZipFile(_to_native_ascii(path), 'r')
+            checksums = set((info.filename, info.CRC) for info in archive.infolist())
+            archive.close()
+        except zipfile.BadZipfile:
+            checksums = set()
+        return checksums
+
 
 class TarArchive(Archive):
     def __init__(self, module):
@@ -554,13 +573,35 @@ class TarArchive(Archive):
             return None if matches_exclusion_patterns(tarinfo.name, self.exclusion_patterns) else tarinfo
 
         def py26_filter(path):
-            return legacy_filter(path, self.exclusion_patterns)
+            return matches_exclusion_patterns(path, self.exclusion_patterns)
 
         if PY27:
             self.file.add(path, archive_name, recursive=False, filter=py27_filter)
         else:
             self.file.add(path, archive_name, recursive=False, exclude=py26_filter)
 
+    def _get_checksums(self, path):
+        try:
+            if self.format == 'xz':
+                with lzma.open(_to_native_ascii(path), 'r') as f:
+                    archive = tarfile.open(fileobj=f)
+                    checksums = set((info.name, info.chksum) for info in archive.getmembers())
+                    archive.close()
+            else:
+                archive = tarfile.open(_to_native_ascii(path), 'r|' + self.format)
+                checksums = set((info.name, info.chksum) for info in archive.getmembers())
+                archive.close()
+        except (lzma.LZMAError, tarfile.ReadError, tarfile.CompressionError):
+            try:
+                # The python implementations of gzip, bz2, and lzma do not support restoring compressed files
+                # to their original names so only file checksum is returned
+                f = self._open_compressed_file(_to_native_ascii(path), 'r')
+                checksums = set([(b'', crc32(f.read()))])
+                f.close()
+            except Exception:
+                checksums = set()
+        return checksums
+
 
 def get_archive(module):
     if module.params['format'] == 'zip':
@@ -603,7 +644,7 @@ def main():
         else:
             archive.add_targets()
             archive.destination_state = STATE_INCOMPLETE if archive.has_unfound_targets() else STATE_ARCHIVED
-            archive.compare_with_original()
+            archive.changed |= archive.is_different_from_original()
             if archive.remove:
                 archive.remove_targets()
     else:
@@ -613,7 +654,7 @@ def main():
         else:
             path = archive.paths[0]
             archive.add_single_target(path)
-            archive.compare_with_original()
+            archive.changed |= archive.is_different_from_original()
             if archive.remove:
                 archive.remove_single_target(path)
 

plugins/modules/files/ini_file.py

@@ -367,10 +367,9 @@ def do_ini(module, filename, section=None, option=None, values=None,
                     section_lines = new_section_lines
         else:
             # drop the entire section
-            if section_lines:
-                section_lines = []
-                msg = 'section removed'
-                changed = True
+            section_lines = []
+            msg = 'section removed'
+            changed = True
 
     # reassemble the ini_lines after manipulation
     ini_lines = before + section_lines + after

plugins/modules/files/iso_extract.py

@@ -85,11 +85,6 @@ import os.path
 import shutil
 import tempfile
 
-try:  # python 3.3+
-    from shlex import quote
-except ImportError:  # older python
-    from pipes import quote
-
 from ansible.module_utils.basic import AnsibleModule
 
 
@@ -154,9 +149,9 @@ def main():
 
     # Use 7zip when we have a binary, otherwise try to mount
     if binary:
-        cmd = '%s x "%s" -o"%s" %s' % (binary, image, tmp_dir, ' '.join([quote(f) for f in extract_files]))
+        cmd = [binary, 'x', image, '-o%s' % tmp_dir] + extract_files
     else:
-        cmd = 'mount -o loop,ro "%s" "%s"' % (image, tmp_dir)
+        cmd = [module.get_bin_path('mount'), '-o', 'loop,ro', image, tmp_dir]
 
     rc, out, err = module.run_command(cmd)
     if rc != 0:
@@ -201,7 +196,7 @@ def main():
                 result['changed'] = True
     finally:
         if not binary:
-            module.run_command('umount "%s"' % tmp_dir)
+            module.run_command([module.get_bin_path('umount'), tmp_dir])
 
         shutil.rmtree(tmp_dir)
 

plugins/modules/files/xattr.py

@@ -12,9 +12,9 @@ DOCUMENTATION = '''
 module: xattr
 short_description: Manage user defined extended attributes
 description:
-    - Manages filesystem user defined extended attributes.
-    - Requires that extended attributes are enabled on the target filesystem
-      and that the setfattr/getfattr utilities are present.
+  - Manages filesystem user defined extended attributes.
+  - Requires that extended attributes are enabled on the target filesystem
+    and that the setfattr/getfattr utilities are present.
 options:
   path:
     description:
@@ -34,13 +34,13 @@ options:
     type: str
   value:
     description:
-      - The value to set the named name/key to, it automatically sets the C(state) to 'set'.
+      - The value to set the named name/key to, it automatically sets the I(state) to C(present).
     type: str
   state:
     description:
       - defines which state you want to do.
-        C(read) retrieves the current value for a C(key) (default)
-        C(present) sets C(name) to C(value), default if value is set
+        C(read) retrieves the current value for a I(key) (default)
+        C(present) sets I(path) to C(value), default if value is set
         C(all) dumps all data
         C(keys) retrieves all keys
         C(absent) deletes the key
@@ -49,14 +49,14 @@ options:
     default: read
   follow:
     description:
-      - If C(yes), dereferences symlinks and sets/gets attributes on symlink target,
+      - If C(true), dereferences symlinks and sets/gets attributes on symlink target,
         otherwise acts on symlink itself.
     type: bool
-    default: yes
+    default: true
 notes:
   - As of Ansible 2.3, the I(name) option has been changed to I(path) as default, but I(name) still works as well.
 author:
-- Brian Coca (@bcoca)
+  - Brian Coca (@bcoca)
 '''
 
 EXAMPLES = '''
@@ -116,7 +116,8 @@ def get_xattr(module, path, key, follow):
     if key is None:
         cmd.append('-d')
     else:
-        cmd.append('-n %s' % key)
+        cmd.append('-n')
+        cmd.append(key)
     cmd.append(path)
 
     return _run_xattr(module, cmd, False)
@@ -127,8 +128,10 @@ def set_xattr(module, path, key, value, follow):
     cmd = [module.get_bin_path('setfattr', True)]
     if not follow:
         cmd.append('-h')
-    cmd.append('-n %s' % key)
-    cmd.append('-v %s' % value)
+    cmd.append('-n')
+    cmd.append(key)
+    cmd.append('-v')
+    cmd.append(value)
     cmd.append(path)
 
     return _run_xattr(module, cmd)
@@ -139,7 +142,8 @@ def rm_xattr(module, path, key, follow):
     cmd = [module.get_bin_path('setfattr', True)]
     if not follow:
         cmd.append('-h')
-    cmd.append('-x %s' % key)
+    cmd.append('-x')
+    cmd.append(key)
     cmd.append(path)
 
     return _run_xattr(module, cmd, False)
@@ -148,7 +152,7 @@ def rm_xattr(module, path, key, follow):
 def _run_xattr(module, cmd, check_rc=True):
 
     try:
-        (rc, out, err) = module.run_command(' '.join(cmd), check_rc=check_rc)
+        (rc, out, err) = module.run_command(cmd, check_rc=check_rc)
     except Exception as e:
         module.fail_json(msg="%s!" % to_native(e))
 

plugins/modules/files/xml.py

@@ -356,10 +356,9 @@ import os
 import re
 import traceback
 
+from distutils.version import LooseVersion
 from io import BytesIO
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 LXML_IMP_ERR = None
 try:
     from lxml import etree, objectify

plugins/modules/gitlab_branch.py

@@ -0,0 +1 @@
+source_control/gitlab/gitlab_branch.py

plugins/modules/identity/ipa/ipa_group.py

@@ -14,6 +14,13 @@ short_description: Manage FreeIPA group
 description:
 - Add, modify and delete group within IPA server
 options:
+  append:
+    description:
+    - If C(yes), add the listed I(user) and I(group) to the group members.
+    - If C(no), only the listed I(user) and I(group) will be group members, removing any other members.
+    default: no
+    type: bool
+    version_added: 4.0.0
   cn:
     description:
     - Canonical name.
@@ -37,9 +44,10 @@ options:
   group:
     description:
     - List of group names assigned to this group.
-    - If an empty list is passed all groups will be removed from this group.
-    - If option is omitted assigned groups will not be checked or changed.
+    - If I(append=no) and an empty list is passed all groups will be removed from this group.
     - Groups that are already assigned but not passed will be removed.
+    - If I(append=yes) the listed groups will be assigned without removing other groups.
+    - If option is omitted assigned groups will not be checked or changed.
     type: list
     elements: str
   nonposix:
@@ -49,9 +57,10 @@ options:
   user:
     description:
     - List of user names assigned to this group.
-    - If an empty list is passed all users will be removed from this group.
-    - If option is omitted assigned users will not be checked or changed.
+    - If I(append=no) and an empty list is passed all users will be removed from this group.
     - Users that are already assigned but not passed will be removed.
+    - If I(append=yes) the listed users will be assigned without removing other users.
+    - If option is omitted assigned users will not be checked or changed.
     type: list
     elements: str
   state:
@@ -95,6 +104,17 @@ EXAMPLES = r'''
     ipa_user: admin
     ipa_pass: topsecret
 
+- name: Ensure that new starter named john is member of the group, without removing other members
+  community.general.ipa_group:
+    name: developers
+    user:
+    - john
+    append: yes
+    state: present
+    ipa_host: ipa.example.com
+    ipa_user: admin
+    ipa_pass: topsecret
+
 - name: Ensure group is absent
   community.general.ipa_group:
     name: sysops
@@ -187,6 +207,7 @@ def ensure(module, client):
     name = module.params['cn']
     group = module.params['group']
     user = module.params['user']
+    append = module.params['append']
 
     module_group = get_group_dict(description=module.params['description'], external=module.params['external'],
                                   gid=module.params['gidnumber'], nonposix=module.params['nonposix'])
@@ -211,12 +232,14 @@ def ensure(module, client):
         if group is not None:
             changed = client.modify_if_diff(name, ipa_group.get('member_group', []), group,
                                             client.group_add_member_group,
-                                            client.group_remove_member_group) or changed
+                                            client.group_remove_member_group,
+                                            append=append) or changed
 
         if user is not None:
             changed = client.modify_if_diff(name, ipa_group.get('member_user', []), user,
                                             client.group_add_member_user,
-                                            client.group_remove_member_user) or changed
+                                            client.group_remove_member_user,
+                                            append=append) or changed
 
     else:
         if ipa_group:
@@ -236,7 +259,8 @@ def main():
                          group=dict(type='list', elements='str'),
                          nonposix=dict(type='bool'),
                          state=dict(type='str', default='present', choices=['present', 'absent']),
-                         user=dict(type='list', elements='str'))
+                         user=dict(type='list', elements='str'),
+                         append=dict(type='bool', default=False))
 
     module = AnsibleModule(argument_spec=argument_spec,
                            supports_check_mode=True,

plugins/modules/identity/ipa/ipa_subca.py

@@ -74,12 +74,11 @@ subca:
   type: dict
 '''
 
+from distutils.version import LooseVersion
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec
 from ansible.module_utils.common.text.converters import to_native
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-
 
 class SubCAIPAClient(IPAClient):
     def __init__(self, module, host, port, protocol):

plugins/modules/identity/keycloak/keycloak_authentication.py

@@ -9,11 +9,15 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 module: keycloak_authentication
+
 short_description: Configure authentication in Keycloak
+
 description:
     - This module actually can only make a copy of an existing authentication flow, add an execution to it and configure it.
     - It can also delete the flow.
+
 version_added: "3.3.0"
+
 options:
     realm:
         description:
@@ -79,6 +83,7 @@ options:
         default: false
         description:
             - If C(true), allows to remove the authentication flow and recreate it.
+
 extends_documentation_fragment:
 - community.general.keycloak
 
@@ -162,10 +167,74 @@ EXAMPLES = '''
 '''
 
 RETURN = '''
+msg:
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+
 flow:
-  description: JSON representation for the authentication.
-  returned: on success
-  type: dict
+    description:
+      - JSON representation for the authentication.
+      - Deprecated return value, it will be removed in community.general 6.0.0. Please use the return value I(end_state) instead.
+    returned: on success
+    type: dict
+    sample: {
+      "alias": "Copy of first broker login",
+      "authenticationExecutions": [
+        {
+          "alias": "review profile config",
+          "authenticationConfig": {
+            "alias": "review profile config",
+            "config": { "update.profile.on.first.login": "missing" },
+            "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"
+          },
+          "configurable": true,
+          "displayName": "Review Profile",
+          "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c",
+          "index": 0,
+          "level": 0,
+          "providerId": "idp-review-profile",
+          "requirement": "REQUIRED",
+          "requirementChoices": [ "REQUIRED", "ALTERNATIVE", "DISABLED" ]
+        }
+      ],
+      "builtIn": false,
+      "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account",
+      "id": "bc228863-5887-4297-b898-4d988f8eaa5c",
+      "providerId": "basic-flow",
+      "topLevel": true
+    }
+
+end_state:
+    description: Representation of the authentication after module execution.
+    returned: on success
+    type: dict
+    sample: {
+      "alias": "Copy of first broker login",
+      "authenticationExecutions": [
+        {
+          "alias": "review profile config",
+          "authenticationConfig": {
+            "alias": "review profile config",
+            "config": { "update.profile.on.first.login": "missing" },
+            "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"
+          },
+          "configurable": true,
+          "displayName": "Review Profile",
+          "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c",
+          "index": 0,
+          "level": 0,
+          "providerId": "idp-review-profile",
+          "requirement": "REQUIRED",
+          "requirementChoices": [ "REQUIRED", "ALTERNATIVE", "DISABLED" ]
+        }
+      ],
+      "builtIn": false,
+      "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account",
+      "id": "bc228863-5887-4297-b898-4d988f8eaa5c",
+      "providerId": "basic-flow",
+      "topLevel": true
+    }
 '''
 
 from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak \
@@ -271,9 +340,11 @@ def create_or_update_executions(kc, config, realm='master'):
 def main():
     """
     Module execution
+
     :return:
     """
     argument_spec = keycloak_argument_spec()
+
     meta_args = dict(
         realm=dict(type='str', required=True),
         alias=dict(type='str', required=True),
@@ -292,6 +363,7 @@ def main():
         state=dict(choices=["absent", "present"], default='present'),
         force=dict(type='bool', default=False),
     )
+
     argument_spec.update(meta_args)
 
     module = AnsibleModule(argument_spec=argument_spec,
@@ -301,6 +373,7 @@ def main():
                            )
 
     result = dict(changed=False, msg='', flow={})
+
     # Obtain access token, initialize API
     try:
         connection_header = get_token(module.params)
@@ -308,6 +381,7 @@ def main():
         module.fail_json(msg=str(e))
 
     kc = KeycloakAPI(module, connection_header)
+
     realm = module.params.get('realm')
     state = module.params.get('state')
     force = module.params.get('force')
@@ -323,35 +397,54 @@ def main():
     }
 
     auth_repr = kc.get_authentication_flow_by_alias(alias=new_auth_repr["alias"], realm=realm)
-    if auth_repr == {}:  # Authentication flow does not exist
-        if state == 'present':  # If desired state is present
+
+    # Cater for when it doesn't exist (an empty dict)
+    if not auth_repr:
+        if state == 'absent':
+            # Do nothing and exit
+            if module._diff:
+                result['diff'] = dict(before='', after='')
+            result['changed'] = False
+            result['end_state'] = {}
+            result['flow'] = result['end_state']
+            result['msg'] = new_auth_repr["alias"] + ' absent'
+            module.exit_json(**result)
+
+        elif state == 'present':
+            # Process a creation
             result['changed'] = True
+
             if module._diff:
                 result['diff'] = dict(before='', after=new_auth_repr)
+
             if module.check_mode:
                 module.exit_json(**result)
+
             # If copyFrom is defined, create authentication flow from a copy
             if "copyFrom" in new_auth_repr and new_auth_repr["copyFrom"] is not None:
                 auth_repr = kc.copy_auth_flow(config=new_auth_repr, realm=realm)
             else:  # Create an empty authentication flow
                 auth_repr = kc.create_empty_auth_flow(config=new_auth_repr, realm=realm)
+
             # If the authentication still not exist on the server, raise an exception.
             if auth_repr is None:
                 result['msg'] = "Authentication just created not found: " + str(new_auth_repr)
                 module.fail_json(**result)
+
             # Configure the executions for the flow
             create_or_update_executions(kc=kc, config=new_auth_repr, realm=realm)
+
             # Get executions created
             exec_repr = kc.get_executions_representation(config=new_auth_repr, realm=realm)
             if exec_repr is not None:
                 auth_repr["authenticationExecutions"] = exec_repr
-            result['flow'] = auth_repr
-        elif state == 'absent':  # If desired state is absent.
-            if module._diff:
-                result['diff'] = dict(before='', after='')
-            result['msg'] = new_auth_repr["alias"] + ' absent'
-    else:  # The authentication flow already exist
-        if state == 'present':  # if desired state is present
+            result['end_state'] = auth_repr
+            result['flow'] = result['end_state']
+
+    else:
+        if state == 'present':
+            # Process an update
+
             if force:  # If force option is true
                 # Delete the actual authentication flow
                 result['changed'] = True
@@ -370,25 +463,35 @@ def main():
                     result['msg'] = "Authentication just created not found: " + str(new_auth_repr)
                     module.fail_json(**result)
             # Configure the executions for the flow
+
             if module.check_mode:
                 module.exit_json(**result)
             changed, diff = create_or_update_executions(kc=kc, config=new_auth_repr, realm=realm)
             result['changed'] |= changed
+
             if module._diff:
                 result['diff'] = diff
+
             # Get executions created
             exec_repr = kc.get_executions_representation(config=new_auth_repr, realm=realm)
             if exec_repr is not None:
                 auth_repr["authenticationExecutions"] = exec_repr
-            result['flow'] = auth_repr
-        elif state == 'absent':  # If desired state is absent
+            result['end_state'] = auth_repr
+            result['flow'] = result['end_state']
+
+        else:
+            # Process a deletion (because state was not 'present')
             result['changed'] = True
-            # Delete the authentication flow alias.
+
             if module._diff:
                 result['diff'] = dict(before=auth_repr, after='')
+
             if module.check_mode:
                 module.exit_json(**result)
+
+            # delete it
             kc.delete_authentication_flow_by_id(id=auth_repr["id"], realm=realm)
+
             result['msg'] = 'Authentication flow: {alias} id: {id} is deleted'.format(alias=new_auth_repr['alias'],
                                                                                       id=auth_repr["id"])
 

plugins/modules/identity/keycloak/keycloak_client.py

@@ -62,17 +62,17 @@ options:
 
     name:
         description:
-            - Name of the client (this is not the same as I(client_id))
+            - Name of the client (this is not the same as I(client_id)).
         type: str
 
     description:
         description:
-            - Description of the client in Keycloak
+            - Description of the client in Keycloak.
         type: str
 
     root_url:
         description:
-            - Root URL appended to relative URLs for this client
+            - Root URL appended to relative URLs for this client.
               This is 'rootUrl' in the Keycloak REST API.
         aliases:
             - rootUrl
@@ -80,7 +80,7 @@ options:
 
     admin_url:
         description:
-            - URL to the admin interface of the client
+            - URL to the admin interface of the client.
               This is 'adminUrl' in the Keycloak REST API.
         aliases:
             - adminUrl
@@ -357,7 +357,7 @@ options:
 
             protocol:
                 description:
-                    - This is either C(openid-connect) or C(saml), this specifies for which protocol this protocol mapper
+                    - This is either C(openid-connect) or C(saml), this specifies for which protocol this protocol mapper.
                       is active.
                 choices: ['openid-connect', 'saml']
                 type: str
@@ -513,7 +513,6 @@ options:
 extends_documentation_fragment:
 - community.general.keycloak
 
-
 author:
     - Eike Frost (@eikef)
 '''
@@ -645,20 +644,21 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Client testclient has been updated"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Client testclient has been updated"
 
 proposed:
-    description: client representation of proposed changes to client
+    description: Representation of proposed client.
     returned: always
     type: dict
     sample: {
       clientId: "test"
     }
+
 existing:
-    description: client representation of existing client (sample is truncated)
+    description: Representation of existing client (sample is truncated).
     returned: always
     type: dict
     sample: {
@@ -667,9 +667,10 @@ existing:
             "request.object.signature.alg": "RS256",
         }
     }
+
 end_state:
-    description: client representation of client after module execution (sample is truncated)
-    returned: always
+    description: Representation of client after module execution (sample is truncated).
+    returned: on success
     type: dict
     sample: {
         "adminUrl": "http://www.example.com/admin_url",
@@ -684,8 +685,38 @@ from ansible_collections.community.general.plugins.module_utils.identity.keycloa
 from ansible.module_utils.basic import AnsibleModule
 
 
+def normalise_cr(clientrep, remove_ids=False):
+    """ Re-sorts any properties where the order so that diff's is minimised, and adds default values where appropriate so that the
+    the change detection is more effective.
+
+    :param clientrep: the clientrep dict to be sanitized
+    :param remove_ids: If set to true, then the unique ID's of objects is removed to make the diff and checks for changed
+                       not alert when the ID's of objects are not usually known, (e.g. for protocol_mappers)
+    :return: normalised clientrep dict
+    """
+    # Avoid the dict passed in to be modified
+    clientrep = clientrep.copy()
+
+    if 'attributes' in clientrep:
+        clientrep['attributes'] = list(sorted(clientrep['attributes']))
+
+    if 'redirectUris' in clientrep:
+        clientrep['redirectUris'] = list(sorted(clientrep['redirectUris']))
+
+    if 'protocolMappers' in clientrep:
+        clientrep['protocolMappers'] = sorted(clientrep['protocolMappers'], key=lambda x: (x.get('name'), x.get('protocol'), x.get('protocolMapper')))
+        for mapper in clientrep['protocolMappers']:
+            if remove_ids:
+                mapper.pop('id', None)
+
+            # Set to a default value.
+            mapper['consentRequired'] = mapper.get('consentRequired', False)
+
+    return clientrep
+
+
 def sanitize_cr(clientrep):
-    """ Removes probably sensitive details from a client representation
+    """ Removes probably sensitive details from a client representation.
 
     :param clientrep: the clientrep dict to be sanitized
     :return: sanitized clientrep dict
@@ -696,7 +727,7 @@ def sanitize_cr(clientrep):
     if 'attributes' in result:
         if 'saml.signing.private.key' in result['attributes']:
             result['attributes']['saml.signing.private.key'] = 'no_log'
-    return result
+    return normalise_cr(result)
 
 
 def main():
@@ -759,6 +790,7 @@ def main():
         protocol_mappers=dict(type='list', elements='dict', options=protmapper_spec, aliases=['protocolMappers']),
         authorization_settings=dict(type='dict', aliases=['authorizationSettings']),
     )
+
     argument_spec.update(meta_args)
 
     module = AnsibleModule(argument_spec=argument_spec,
@@ -781,12 +813,12 @@ def main():
     cid = module.params.get('id')
     state = module.params.get('state')
 
-    # convert module parameters to client representation parameters (if they belong in there)
+    # Filter and map the parameters names that apply to the client
     client_params = [x for x in module.params
                      if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm'] and
                      module.params.get(x) is not None]
-    keycloak_argument_spec().keys()
-    # See whether the client already exists in Keycloak
+
+    # See if it already exists in Keycloak
     if cid is None:
         before_client = kc.get_client_by_clientid(module.params.get('client_id'), realm=realm)
         if before_client is not None:
@@ -795,10 +827,10 @@ def main():
         before_client = kc.get_client_by_id(cid, realm=realm)
 
     if before_client is None:
-        before_client = dict()
+        before_client = {}
 
     # Build a proposed changeset from parameters given to this module
-    changeset = dict()
+    changeset = {}
 
     for client_param in client_params:
         new_param_value = module.params.get(client_param)
@@ -817,54 +849,63 @@ def main():
 
         changeset[camel(client_param)] = new_param_value
 
-    # Whether creating or updating a client, take the before-state and merge the changeset into it
-    updated_client = before_client.copy()
-    updated_client.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_client = before_client.copy()
+    desired_client.update(changeset)
 
     result['proposed'] = sanitize_cr(changeset)
     result['existing'] = sanitize_cr(before_client)
 
-    # If the client does not exist yet, before_client is still empty
-    if before_client == dict():
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_client:
         if state == 'absent':
-            # do nothing and exit
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
-            result['msg'] = 'Client does not exist, doing nothing.'
+            result['changed'] = False
+            result['end_state'] = {}
+            result['msg'] = 'Client does not exist; doing nothing.'
             module.exit_json(**result)
 
-        # create new client
+        # Process a creation
         result['changed'] = True
-        if 'clientId' not in updated_client:
+
+        if 'clientId' not in desired_client:
             module.fail_json(msg='client_id needs to be specified when creating a new client')
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize_cr(updated_client))
+            result['diff'] = dict(before='', after=sanitize_cr(desired_client))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        kc.create_client(updated_client, realm=realm)
-        after_client = kc.get_client_by_clientid(updated_client['clientId'], realm=realm)
+        # create it
+        kc.create_client(desired_client, realm=realm)
+        after_client = kc.get_client_by_clientid(desired_client['clientId'], realm=realm)
 
         result['end_state'] = sanitize_cr(after_client)
 
-        result['msg'] = 'Client %s has been created.' % updated_client['clientId']
+        result['msg'] = 'Client %s has been created.' % desired_client['clientId']
         module.exit_json(**result)
+
     else:
         if state == 'present':
-            # update existing client
+            # Process an update
             result['changed'] = True
+
             if module.check_mode:
                 # We can only compare the current client with the proposed updates we have
+                before_norm = normalise_cr(before_client, remove_ids=True)
+                desired_norm = normalise_cr(desired_client, remove_ids=True)
                 if module._diff:
-                    result['diff'] = dict(before=sanitize_cr(before_client),
-                                          after=sanitize_cr(updated_client))
-                result['changed'] = (before_client != updated_client)
+                    result['diff'] = dict(before=sanitize_cr(before_norm),
+                                          after=sanitize_cr(desired_norm))
+                result['changed'] = (before_norm != desired_norm)
 
                 module.exit_json(**result)
 
-            kc.update_client(cid, updated_client, realm=realm)
+            # do the update
+            kc.update_client(cid, desired_client, realm=realm)
 
             after_client = kc.get_client_by_id(cid, realm=realm)
             if before_client == after_client:
@@ -872,25 +913,29 @@ def main():
             if module._diff:
                 result['diff'] = dict(before=sanitize_cr(before_client),
                                       after=sanitize_cr(after_client))
+
             result['end_state'] = sanitize_cr(after_client)
 
-            result['msg'] = 'Client %s has been updated.' % updated_client['clientId']
+            result['msg'] = 'Client %s has been updated.' % desired_client['clientId']
             module.exit_json(**result)
+
         else:
-            # Delete existing client
+            # Process a deletion (because state was not 'present')
             result['changed'] = True
+
             if module._diff:
-                result['diff']['before'] = sanitize_cr(before_client)
-                result['diff']['after'] = ''
+                result['diff'] = dict(before=sanitize_cr(before_client), after='')
 
             if module.check_mode:
                 module.exit_json(**result)
 
+            # delete it
             kc.delete_client(cid, realm=realm)
-            result['proposed'] = dict()
-            result['end_state'] = dict()
+            result['proposed'] = {}
+
+            result['end_state'] = {}
+
             result['msg'] = 'Client %s has been deleted.' % before_client['clientId']
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_client_rolemapping.py

@@ -11,6 +11,7 @@ DOCUMENTATION = '''
 module: keycloak_client_rolemapping
 
 short_description: Allows administration of Keycloak client_rolemapping with the Keycloak API
+
 version_added: 3.5.0
 
 description:
@@ -158,21 +159,22 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Role role1 assigned to group group1."
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Role role1 assigned to group group1."
 
 proposed:
-    description: role_representation representation of proposed changes to client_rolemapping.
+    description: Representation of proposed client role mapping.
     returned: always
     type: dict
     sample: {
       clientId: "test"
     }
+
 existing:
     description:
-      - role_representation representation of existing role_representation.
+      - Representation of existing client role mapping.
       - The sample is truncated.
     returned: always
     type: dict
@@ -182,11 +184,12 @@ existing:
             "request.object.signature.alg": "RS256",
         }
     }
+
 end_state:
     description:
-      - role_representation representation of role_representation after module execution.
+      - Representation of client role mapping after module execution.
       - The sample is truncated.
-    returned: always
+    returned: on success
     type: dict
     sample: {
         "adminUrl": "http://www.example.com/admin_url",

plugins/modules/identity/keycloak/keycloak_clientscope.py

@@ -86,7 +86,7 @@ options:
         suboptions:
             protocol:
                 description:
-                    - This specifies for which protocol this protocol mapper
+                    - This specifies for which protocol this protocol mapper.
                     - is active.
                 choices: ['openid-connect', 'saml', 'wsfed']
                 type: str
@@ -256,20 +256,21 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Client_scope testclientscope has been updated"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Client_scope testclientscope has been updated"
 
 proposed:
-    description: client_scope representation of proposed changes to client_scope
+    description: Representation of proposed client scope.
     returned: always
     type: dict
     sample: {
       clientId: "test"
     }
+
 existing:
-    description: client_scope representation of existing client_scope (sample is truncated)
+    description: Representation of existing client scope (sample is truncated).
     returned: always
     type: dict
     sample: {
@@ -278,9 +279,10 @@ existing:
             "request.object.signature.alg": "RS256",
         }
     }
+
 end_state:
-    description: client_scope representation of client_scope after module execution (sample is truncated)
-    returned: always
+    description: Representation of client scope after module execution (sample is truncated).
+    returned: on success
     type: dict
     sample: {
         "adminUrl": "http://www.example.com/admin_url",
@@ -296,7 +298,7 @@ from ansible.module_utils.basic import AnsibleModule
 
 
 def sanitize_cr(clientscoperep):
-    """ Removes probably sensitive details from a clientscoperep representation
+    """ Removes probably sensitive details from a clientscoperep representation.
 
     :param clientscoperep: the clientscoperep dict to be sanitized
     :return: sanitized clientrep dict
@@ -361,22 +363,22 @@ def main():
     name = module.params.get('name')
     protocol_mappers = module.params.get('protocol_mappers')
 
-    before_clientscope = None         # current state of the clientscope, for merging.
+    # Filter and map the parameters names that apply to the client scope
+    clientscope_params = [x for x in module.params
+                          if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm'] and
+                          module.params.get(x) is not None]
 
-    # does the clientscope already exist?
+    # See if it already exists in Keycloak
     if cid is None:
         before_clientscope = kc.get_clientscope_by_name(name, realm=realm)
     else:
         before_clientscope = kc.get_clientscope_by_clientscopeid(cid, realm=realm)
 
-    before_clientscope = {} if before_clientscope is None else before_clientscope
-
-    clientscope_params = [x for x in module.params
-                          if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm'] and
-                          module.params.get(x) is not None]
+    if before_clientscope is None:
+        before_clientscope = {}
 
     # Build a proposed changeset from parameters given to this module
-    changeset = dict()
+    changeset = {}
 
     for clientscope_param in clientscope_params:
         new_param_value = module.params.get(clientscope_param)
@@ -394,81 +396,87 @@ def main():
             new_param_value = [dict((k, v) for k, v in x.items() if x[k] is not None) for x in new_param_value]
         changeset[camel(clientscope_param)] = new_param_value
 
-    # prepare the new clientscope
-    updated_clientscope = before_clientscope.copy()
-    updated_clientscope.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_clientscope = before_clientscope.copy()
+    desired_clientscope.update(changeset)
 
-    # if before_clientscope is none, the clientscope doesn't exist.
-    if before_clientscope == {}:
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_clientscope:
         if state == 'absent':
-            # nothing to do.
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
+            result['changed'] = False
+            result['end_state'] = {}
             result['msg'] = 'Clientscope does not exist; doing nothing.'
-            result['end_state'] = dict()
             module.exit_json(**result)
 
-        # for 'present', create a new clientscope.
+        # Process a creation
         result['changed'] = True
+
         if name is None:
             module.fail_json(msg='name must be specified when creating a new clientscope')
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize_cr(updated_clientscope))
+            result['diff'] = dict(before='', after=sanitize_cr(desired_clientscope))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # do it for real!
-        kc.create_clientscope(updated_clientscope, realm=realm)
+        # create it
+        kc.create_clientscope(desired_clientscope, realm=realm)
         after_clientscope = kc.get_clientscope_by_name(name, realm)
 
         result['end_state'] = sanitize_cr(after_clientscope)
+
         result['msg'] = 'Clientscope {name} has been created with ID {id}'.format(name=after_clientscope['name'],
                                                                                   id=after_clientscope['id'])
 
     else:
         if state == 'present':
+            # Process an update
+
             # no changes
-            if updated_clientscope == before_clientscope:
+            if desired_clientscope == before_clientscope:
                 result['changed'] = False
-                result['end_state'] = sanitize_cr(updated_clientscope)
+                result['end_state'] = sanitize_cr(desired_clientscope)
                 result['msg'] = "No changes required to clientscope {name}.".format(name=before_clientscope['name'])
                 module.exit_json(**result)
 
-            # update the existing clientscope
+            # doing an update
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=sanitize_cr(before_clientscope), after=sanitize_cr(updated_clientscope))
+                result['diff'] = dict(before=sanitize_cr(before_clientscope), after=sanitize_cr(desired_clientscope))
 
             if module.check_mode:
                 module.exit_json(**result)
 
-            # do the clientscope update
-            kc.update_clientscope(updated_clientscope, realm=realm)
+            # do the update
+            kc.update_clientscope(desired_clientscope, realm=realm)
 
             # do the protocolmappers update
             if protocol_mappers is not None:
                 for protocol_mapper in protocol_mappers:
                     # update if protocolmapper exist
-                    current_protocolmapper = kc.get_clientscope_protocolmapper_by_name(updated_clientscope['id'], protocol_mapper['name'], realm=realm)
+                    current_protocolmapper = kc.get_clientscope_protocolmapper_by_name(desired_clientscope['id'], protocol_mapper['name'], realm=realm)
                     if current_protocolmapper is not None:
                         protocol_mapper['id'] = current_protocolmapper['id']
-                        kc.update_clientscope_protocolmappers(updated_clientscope['id'], protocol_mapper, realm=realm)
+                        kc.update_clientscope_protocolmappers(desired_clientscope['id'], protocol_mapper, realm=realm)
                     # create otherwise
                     else:
-                        kc.create_clientscope_protocolmapper(updated_clientscope['id'], protocol_mapper, realm=realm)
+                        kc.create_clientscope_protocolmapper(desired_clientscope['id'], protocol_mapper, realm=realm)
 
-            after_clientscope = kc.get_clientscope_by_clientscopeid(updated_clientscope['id'], realm=realm)
+            after_clientscope = kc.get_clientscope_by_clientscopeid(desired_clientscope['id'], realm=realm)
 
             result['end_state'] = after_clientscope
-            result['msg'] = "Clientscope {id} has been updated".format(id=after_clientscope['id'])
 
+            result['msg'] = "Clientscope {id} has been updated".format(id=after_clientscope['id'])
             module.exit_json(**result)
 
-        elif state == 'absent':
-            result['end_state'] = dict()
+        else:
+            # Process a deletion (because state was not 'present')
+            result['changed'] = True
 
             if module._diff:
                 result['diff'] = dict(before=sanitize_cr(before_clientscope), after='')
@@ -476,14 +484,13 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete for real
+            # delete it
             cid = before_clientscope['id']
             kc.delete_clientscope(cid=cid, realm=realm)
 
-            result['changed'] = True
-            result['msg'] = "Clientscope {name} has been deleted".format(name=before_clientscope['name'])
+            result['end_state'] = {}
 
-            module.exit_json(**result)
+            result['msg'] = "Clientscope {name} has been deleted".format(name=before_clientscope['name'])
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_clienttemplate.py

@@ -31,7 +31,7 @@ description:
 options:
     state:
         description:
-            - State of the client template
+            - State of the client template.
             - On C(present), the client template will be created (or updated if it exists already).
             - On C(absent), the client template will be removed if it exists
         choices: ['present', 'absent']
@@ -51,12 +51,12 @@ options:
 
     name:
         description:
-            - Name of the client template
+            - Name of the client template.
         type: str
 
     description:
         description:
-            - Description of the client template in Keycloak
+            - Description of the client template in Keycloak.
         type: str
 
     protocol:
@@ -100,7 +100,7 @@ options:
 
             protocol:
                 description:
-                    - is either 'openid-connect' or 'saml', this specifies for which protocol this protocol mapper
+                    - This is either C(openid-connect) or C(saml), this specifies for which protocol this protocol mapper.
                       is active.
                 choices: ['openid-connect', 'saml']
                 type: str
@@ -143,7 +143,7 @@ options:
                       contents differ depending on the value of I(protocolMapper) and are not documented
                       other than by the source of the mappers and its parent class(es). An example is given
                       below. It is easiest to obtain valid config values by dumping an already-existing
-                      protocol mapper configuration through check-mode in the "existing" field.
+                      protocol mapper configuration through check-mode in the I(existing) field.
                 type: dict
 
     attributes:
@@ -163,7 +163,6 @@ notes:
 extends_documentation_fragment:
 - community.general.keycloak
 
-
 author:
     - Eike Frost (@eikef)
 '''
@@ -231,20 +230,21 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Client template testclient has been updated"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Client template testclient has been updated"
 
 proposed:
-    description: client template representation of proposed changes to client template
+    description: Representation of proposed client template.
     returned: always
     type: dict
     sample: {
       name: "test01"
     }
+
 existing:
-    description: client template representation of existing client template (sample is truncated)
+    description: Representation of existing client template (sample is truncated).
     returned: always
     type: dict
     sample: {
@@ -254,9 +254,10 @@ existing:
         "name": "test01",
         "protocol": "saml"
     }
+
 end_state:
-    description: client template representation of client template after module execution (sample is truncated)
-    returned: always
+    description: Representation of client template after module execution (sample is truncated).
+    returned: on success
     type: dict
     sample: {
         "description": "test01",
@@ -302,6 +303,7 @@ def main():
         full_scope_allowed=dict(type='bool'),
         protocol_mappers=dict(type='list', elements='dict', options=protmapper_spec),
     )
+
     argument_spec.update(meta_args)
 
     module = AnsibleModule(argument_spec=argument_spec,
@@ -317,19 +319,20 @@ def main():
         connection_header = get_token(module.params)
     except KeycloakError as e:
         module.fail_json(msg=str(e))
+
     kc = KeycloakAPI(module, connection_header)
 
     realm = module.params.get('realm')
     state = module.params.get('state')
     cid = module.params.get('id')
 
-    # convert module parameters to client representation parameters (if they belong in there)
+    # Filter and map the parameters names that apply to the client template
     clientt_params = [x for x in module.params
                       if x not in ['state', 'auth_keycloak_url', 'auth_client_id', 'auth_realm',
                                    'auth_client_secret', 'auth_username', 'auth_password',
                                    'validate_certs', 'realm'] and module.params.get(x) is not None]
 
-    # See whether the client template already exists in Keycloak
+    # See if it already exists in Keycloak
     if cid is None:
         before_clientt = kc.get_client_template_by_name(module.params.get('name'), realm=realm)
         if before_clientt is not None:
@@ -338,12 +341,12 @@ def main():
         before_clientt = kc.get_client_template_by_id(cid, realm=realm)
 
     if before_clientt is None:
-        before_clientt = dict()
+        before_clientt = {}
 
     result['existing'] = before_clientt
 
     # Build a proposed changeset from parameters given to this module
-    changeset = dict()
+    changeset = {}
 
     for clientt_param in clientt_params:
         # lists in the Keycloak API are sorted
@@ -355,78 +358,89 @@ def main():
                 pass
         changeset[camel(clientt_param)] = new_param_value
 
-    # Whether creating or updating a client, take the before-state and merge the changeset into it
-    updated_clientt = before_clientt.copy()
-    updated_clientt.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_clientt = before_clientt.copy()
+    desired_clientt.update(changeset)
 
     result['proposed'] = changeset
 
-    # If the client template does not exist yet, before_client is still empty
-    if before_clientt == dict():
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_clientt:
         if state == 'absent':
-            # do nothing and exit
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
+            result['changed'] = False
+            result['end_state'] = {}
             result['msg'] = 'Client template does not exist, doing nothing.'
             module.exit_json(**result)
 
-        # create new client template
+        # Process a creation
         result['changed'] = True
-        if 'name' not in updated_clientt:
+
+        if 'name' not in desired_clientt:
             module.fail_json(msg='name needs to be specified when creating a new client')
 
         if module._diff:
-            result['diff'] = dict(before='', after=updated_clientt)
+            result['diff'] = dict(before='', after=desired_clientt)
 
         if module.check_mode:
             module.exit_json(**result)
 
-        kc.create_client_template(updated_clientt, realm=realm)
-        after_clientt = kc.get_client_template_by_name(updated_clientt['name'], realm=realm)
+        # create it
+        kc.create_client_template(desired_clientt, realm=realm)
+        after_clientt = kc.get_client_template_by_name(desired_clientt['name'], realm=realm)
 
         result['end_state'] = after_clientt
 
-        result['msg'] = 'Client template %s has been created.' % updated_clientt['name']
+        result['msg'] = 'Client template %s has been created.' % desired_clientt['name']
         module.exit_json(**result)
+
     else:
         if state == 'present':
-            # update existing client template
+            # Process an update
+
             result['changed'] = True
             if module.check_mode:
                 # We can only compare the current client template with the proposed updates we have
                 if module._diff:
                     result['diff'] = dict(before=before_clientt,
-                                          after=updated_clientt)
+                                          after=desired_clientt)
 
                 module.exit_json(**result)
 
-            kc.update_client_template(cid, updated_clientt, realm=realm)
+            # do the update
+            kc.update_client_template(cid, desired_clientt, realm=realm)
 
             after_clientt = kc.get_client_template_by_id(cid, realm=realm)
             if before_clientt == after_clientt:
                 result['changed'] = False
-            if module._diff:
-                result['diff'] = dict(before=before_clientt,
-                                      after=after_clientt)
+
             result['end_state'] = after_clientt
 
-            result['msg'] = 'Client template %s has been updated.' % updated_clientt['name']
-            module.exit_json(**result)
-        else:
-            # Delete existing client
-            result['changed'] = True
             if module._diff:
-                result['diff']['before'] = before_clientt
-                result['diff']['after'] = ''
+                result['diff'] = dict(before=before_clientt, after=after_clientt)
+
+            result['msg'] = 'Client template %s has been updated.' % desired_clientt['name']
+            module.exit_json(**result)
+
+        else:
+            # Process a deletion (because state was not 'present')
+            result['changed'] = True
+
+            if module._diff:
+                result['diff'] = dict(before=before_clientt, after='')
 
             if module.check_mode:
                 module.exit_json(**result)
 
+            # delete it
             kc.delete_client_template(cid, realm=realm)
-            result['proposed'] = dict()
-            result['end_state'] = dict()
+            result['proposed'] = {}
+
+            result['end_state'] = {}
+
             result['msg'] = 'Client template %s has been deleted.' % before_clientt['name']
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_group.py

@@ -159,34 +159,91 @@ EXAMPLES = '''
 '''
 
 RETURN = '''
+msg:
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+
+end_state:
+    description: Representation of the group after module execution (sample is truncated).
+    returned: on success
+    type: complex
+    contains:
+        id:
+            description: GUID that identifies the group.
+            type: str
+            returned: always
+            sample: 23f38145-3195-462c-97e7-97041ccea73e
+        name:
+            description: Name of the group.
+            type: str
+            returned: always
+            sample: grp-test-123
+        attributes:
+            description: Attributes applied to this group.
+            type: dict
+            returned: always
+            sample:
+                attr1: ["val1", "val2", "val3"]
+        path:
+            description: URI path to the group.
+            type: str
+            returned: always
+            sample: /grp-test-123
+        realmRoles:
+            description: An array of the realm-level roles granted to this group.
+            type: list
+            returned: always
+            sample: []
+        subGroups:
+            description: A list of groups that are children of this group. These groups will have the same parameters as
+                         documented here.
+            type: list
+            returned: always
+        clientRoles:
+            description: A list of client-level roles granted to this group.
+            type: list
+            returned: always
+            sample: []
+        access:
+            description: A dict describing the accesses you have to this group based on the credentials used.
+            type: dict
+            returned: always
+            sample:
+                manage: true
+                manageMembership: true
+                view: true
+
 group:
-  description: Group representation of the group after module execution (sample is truncated).
+  description:
+    - Representation of the group after module execution.
+    - Deprecated return value, it will be removed in community.general 6.0.0. Please use the return value I(end_state) instead.
   returned: always
   type: complex
   contains:
     id:
-      description: GUID that identifies the group
+      description: GUID that identifies the group.
       type: str
       returned: always
       sample: 23f38145-3195-462c-97e7-97041ccea73e
     name:
-      description: Name of the group
+      description: Name of the group.
       type: str
       returned: always
       sample: grp-test-123
     attributes:
-      description: Attributes applied to this group
+      description: Attributes applied to this group.
       type: dict
       returned: always
       sample:
         attr1: ["val1", "val2", "val3"]
     path:
-      description: URI path to the group
+      description: URI path to the group.
       type: str
       returned: always
       sample: /grp-test-123
     realmRoles:
-      description: An array of the realm-level roles granted to this group
+      description: An array of the realm-level roles granted to this group.
       type: list
       returned: always
       sample: []
@@ -196,7 +253,7 @@ group:
       type: list
       returned: always
     clientRoles:
-      description: A list of client-level roles granted to this group
+      description: A list of client-level roles granted to this group.
       type: list
       returned: always
       sample: []
@@ -208,6 +265,7 @@ group:
         manage: true
         manageMembership: true
         view: true
+
 '''
 
 from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
@@ -222,6 +280,7 @@ def main():
     :return:
     """
     argument_spec = keycloak_argument_spec()
+
     meta_args = dict(
         state=dict(default='present', choices=['present', 'absent']),
         realm=dict(default='master'),
@@ -254,16 +313,6 @@ def main():
     name = module.params.get('name')
     attributes = module.params.get('attributes')
 
-    before_group = None         # current state of the group, for merging.
-
-    # does the group already exist?
-    if gid is None:
-        before_group = kc.get_group_by_name(name, realm=realm)
-    else:
-        before_group = kc.get_group_by_groupid(gid, realm=realm)
-
-    before_group = {} if before_group is None else before_group
-
     # attributes in Keycloak have their values returned as lists
     # via the API. attributes is a dict, so we'll transparently convert
     # the values to lists.
@@ -271,81 +320,103 @@ def main():
         for key, val in module.params['attributes'].items():
             module.params['attributes'][key] = [val] if not isinstance(val, list) else val
 
+    # Filter and map the parameters names that apply to the group
     group_params = [x for x in module.params
                     if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm'] and
                     module.params.get(x) is not None]
 
-    # build a changeset
+    # See if it already exists in Keycloak
+    if gid is None:
+        before_group = kc.get_group_by_name(name, realm=realm)
+    else:
+        before_group = kc.get_group_by_groupid(gid, realm=realm)
+
+    if before_group is None:
+        before_group = {}
+
+    # Build a proposed changeset from parameters given to this module
     changeset = {}
+
     for param in group_params:
         new_param_value = module.params.get(param)
         old_value = before_group[param] if param in before_group else None
         if new_param_value != old_value:
             changeset[camel(param)] = new_param_value
 
-    # prepare the new group
-    updated_group = before_group.copy()
-    updated_group.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_group = before_group.copy()
+    desired_group.update(changeset)
 
-    # if before_group is none, the group doesn't exist.
-    if before_group == {}:
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_group:
         if state == 'absent':
-            # nothing to do.
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
+            result['changed'] = False
+            result['end_state'] = {}
+            result['group'] = result['end_state']
             result['msg'] = 'Group does not exist; doing nothing.'
-            result['group'] = dict()
             module.exit_json(**result)
 
-        # for 'present', create a new group.
+        # Process a creation
         result['changed'] = True
+
         if name is None:
             module.fail_json(msg='name must be specified when creating a new group')
 
         if module._diff:
-            result['diff'] = dict(before='', after=updated_group)
+            result['diff'] = dict(before='', after=desired_group)
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # do it for real!
-        kc.create_group(updated_group, realm=realm)
+        # create it
+        kc.create_group(desired_group, realm=realm)
         after_group = kc.get_group_by_name(name, realm)
 
-        result['group'] = after_group
+        result['end_state'] = after_group
+        result['group'] = result['end_state']
+
         result['msg'] = 'Group {name} has been created with ID {id}'.format(name=after_group['name'],
                                                                             id=after_group['id'])
+        module.exit_json(**result)
 
     else:
         if state == 'present':
+            # Process an update
+
             # no changes
-            if updated_group == before_group:
+            if desired_group == before_group:
                 result['changed'] = False
-                result['group'] = updated_group
+                result['end_state'] = desired_group
+                result['group'] = result['end_state']
                 result['msg'] = "No changes required to group {name}.".format(name=before_group['name'])
                 module.exit_json(**result)
 
-            # update the existing group
+            # doing an update
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=before_group, after=updated_group)
+                result['diff'] = dict(before=before_group, after=desired_group)
 
             if module.check_mode:
                 module.exit_json(**result)
 
             # do the update
-            kc.update_group(updated_group, realm=realm)
+            kc.update_group(desired_group, realm=realm)
 
-            after_group = kc.get_group_by_groupid(updated_group['id'], realm=realm)
+            after_group = kc.get_group_by_groupid(desired_group['id'], realm=realm)
+
+            result['end_state'] = after_group
+            result['group'] = result['end_state']
 
-            result['group'] = after_group
             result['msg'] = "Group {id} has been updated".format(id=after_group['id'])
-
             module.exit_json(**result)
 
-        elif state == 'absent':
-            result['group'] = dict()
+        else:
+            # Process a deletion (because state was not 'present')
+            result['changed'] = True
 
             if module._diff:
                 result['diff'] = dict(before=before_group, after='')
@@ -353,14 +424,14 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete for real
+            # delete it
             gid = before_group['id']
             kc.delete_group(groupid=gid, realm=realm)
 
-            result['changed'] = True
-            result['msg'] = "Group {name} has been deleted".format(name=before_group['name'])
+            result['end_state'] = {}
+            result['group'] = result['end_state']
 
-            module.exit_json(**result)
+            result['msg'] = "Group {name} has been deleted".format(name=before_group['name'])
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_identity_provider.py

@@ -339,13 +339,13 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Identity provider my-idp has been created"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Identity provider my-idp has been created"
 
 proposed:
-    description: Representation of proposed changes to identity provider
+    description: Representation of proposed identity provider.
     returned: always
     type: dict
     sample: {
@@ -363,7 +363,7 @@ proposed:
     }
 
 existing:
-    description: Representation of existing identity provider
+    description: Representation of existing identity provider.
     returned: always
     type: dict
     sample: {
@@ -391,8 +391,8 @@ existing:
     }
 
 end_state:
-    description: Representation of identity provider after module execution
-    returned: always
+    description: Representation of identity provider after module execution.
+    returned: on success
     type: dict
     sample: {
         "addReadTokenRoleOnCreate": false,
@@ -416,7 +416,6 @@ end_state:
         "storeToken": false,
         "trustEmail": false,
     }
-
 '''
 
 from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
@@ -438,7 +437,7 @@ def get_identity_provider_with_mappers(kc, alias, realm):
     if idp is not None:
         idp['mappers'] = sorted(kc.get_identity_provider_mappers(alias, realm), key=lambda x: x.get('name'))
     if idp is None:
-        idp = dict()
+        idp = {}
     return idp
 
 
@@ -497,16 +496,16 @@ def main():
     alias = module.params.get('alias')
     state = module.params.get('state')
 
-    # convert module parameters to client representation parameters (if they belong in there)
+    # Filter and map the parameters names that apply to the identity provider.
     idp_params = [x for x in module.params
                   if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm', 'mappers'] and
                   module.params.get(x) is not None]
 
-    # does the identity provider already exist?
+    # See if it already exists in Keycloak
     before_idp = get_identity_provider_with_mappers(kc, alias, realm)
 
-    # build a changeset
-    changeset = dict()
+    # Build a proposed changeset from parameters given to this module
+    changeset = {}
 
     for param in idp_params:
         new_param_value = module.params.get(param)
@@ -539,37 +538,37 @@ def main():
                     changeset['mappers'] = list()
                 changeset['mappers'].append(new_mapper)
 
-    # prepare the new representation
-    updated_idp = before_idp.copy()
-    updated_idp.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_idp = before_idp.copy()
+    desired_idp.update(changeset)
 
     result['proposed'] = sanitize(changeset)
     result['existing'] = sanitize(before_idp)
 
-    # if before_idp is none, the identity provider doesn't exist.
-    if before_idp == dict():
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_idp:
         if state == 'absent':
-            # nothing to do.
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
             result['changed'] = False
-            result['end_state'] = dict()
+            result['end_state'] = {}
             result['msg'] = 'Identity provider does not exist; doing nothing.'
             module.exit_json(**result)
 
-        # for 'present', create a new identity provider.
+        # Process a creation
         result['changed'] = True
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize(updated_idp))
+            result['diff'] = dict(before='', after=sanitize(desired_idp))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # do it for real!
-        updated_idp = updated_idp.copy()
-        mappers = updated_idp.pop('mappers', [])
-        kc.create_identity_provider(updated_idp, realm)
+        # create it
+        desired_idp = desired_idp.copy()
+        mappers = desired_idp.pop('mappers', [])
+        kc.create_identity_provider(desired_idp, realm)
         for mapper in mappers:
             if mapper.get('identityProviderAlias') is None:
                 mapper['identityProviderAlias'] = alias
@@ -583,26 +582,28 @@ def main():
 
     else:
         if state == 'present':
+            # Process an update
+
             # no changes
-            if updated_idp == before_idp:
+            if desired_idp == before_idp:
                 result['changed'] = False
-                result['end_state'] = sanitize(updated_idp)
+                result['end_state'] = sanitize(desired_idp)
                 result['msg'] = "No changes required to identity provider {alias}.".format(alias=alias)
                 module.exit_json(**result)
 
-            # update the existing role
+            # doing an update
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=sanitize(before_idp), after=sanitize(updated_idp))
+                result['diff'] = dict(before=sanitize(before_idp), after=sanitize(desired_idp))
 
             if module.check_mode:
                 module.exit_json(**result)
 
             # do the update
-            updated_idp = updated_idp.copy()
-            updated_mappers = updated_idp.pop('mappers', [])
-            kc.update_identity_provider(updated_idp, realm)
+            desired_idp = desired_idp.copy()
+            updated_mappers = desired_idp.pop('mappers', [])
+            kc.update_identity_provider(desired_idp, realm)
             for mapper in updated_mappers:
                 if mapper.get('id') is not None:
                     kc.update_identity_provider_mapper(mapper, alias, realm)
@@ -622,6 +623,7 @@ def main():
             module.exit_json(**result)
 
         elif state == 'absent':
+            # Process a deletion
             result['changed'] = True
 
             if module._diff:
@@ -630,13 +632,12 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete for real
+            # delete it
             kc.delete_identity_provider(alias, realm)
 
-            result['end_state'] = dict()
+            result['end_state'] = {}
 
             result['msg'] = "Identity provider {alias} has been deleted".format(alias=alias)
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_realm.py

@@ -13,6 +13,7 @@ DOCUMENTATION = '''
 module: keycloak_realm
 
 short_description: Allows administration of Keycloak realm via Keycloak API
+
 version_added: 3.0.0
 
 
@@ -533,20 +534,21 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Realm testrealm has been updated"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Realm testrealm has been updated"
 
 proposed:
-    description: realm representation of proposed changes to realm
+    description: Representation of proposed realm.
     returned: always
     type: dict
     sample: {
       id: "test"
     }
+
 existing:
-    description: realm representation of existing realm (sample is truncated)
+    description: Representation of existing realm (sample is truncated).
     returned: always
     type: dict
     sample: {
@@ -555,9 +557,10 @@ existing:
             "request.object.signature.alg": "RS256",
         }
     }
+
 end_state:
-    description: realm representation of realm after module execution (sample is truncated)
-    returned: always
+    description: Representation of realm after module execution (sample is truncated).
+    returned: on success
     type: dict
     sample: {
         "adminUrl": "http://www.example.com/admin_url",
@@ -573,7 +576,7 @@ from ansible.module_utils.basic import AnsibleModule
 
 
 def sanitize_cr(realmrep):
-    """ Removes probably sensitive details from a realm representation
+    """ Removes probably sensitive details from a realm representation.
 
     :param realmrep: the realmrep dict to be sanitized
     :return: sanitized realmrep dict
@@ -676,6 +679,7 @@ def main():
         verify_email=dict(type='bool', aliases=['verifyEmail']),
         wait_increment_seconds=dict(type='int', aliases=['waitIncrementSeconds']),
     )
+
     argument_spec.update(meta_args)
 
     module = AnsibleModule(argument_spec=argument_spec,
@@ -699,95 +703,114 @@ def main():
 
     # convert module parameters to realm representation parameters (if they belong in there)
     params_to_ignore = list(keycloak_argument_spec().keys()) + ['state']
+
+    # Filter and map the parameters names that apply to the role
     realm_params = [x for x in module.params
                     if x not in params_to_ignore and
                     module.params.get(x) is not None]
 
     # See whether the realm already exists in Keycloak
-    before_realm = kc.get_realm_by_id(realm=realm) or {}
+    before_realm = kc.get_realm_by_id(realm=realm)
+
+    if before_realm is None:
+        before_realm = {}
 
     # Build a proposed changeset from parameters given to this module
-    changeset = dict()
+    changeset = {}
 
     for realm_param in realm_params:
         new_param_value = module.params.get(realm_param)
         changeset[camel(realm_param)] = new_param_value
 
-    # Whether creating or updating a realm, take the before-state and merge the changeset into it
-    updated_realm = before_realm.copy()
-    updated_realm.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_realm = before_realm.copy()
+    desired_realm.update(changeset)
 
     result['proposed'] = sanitize_cr(changeset)
     before_realm_sanitized = sanitize_cr(before_realm)
     result['existing'] = before_realm_sanitized
 
-    # If the realm does not exist yet, before_realm is still empty
+    # Cater for when it doesn't exist (an empty dict)
     if not before_realm:
         if state == 'absent':
-            # do nothing and exit
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
+            result['changed'] = False
+            result['end_state'] = {}
             result['msg'] = 'Realm does not exist, doing nothing.'
             module.exit_json(**result)
 
-        # create new realm
+        # Process a creation
         result['changed'] = True
-        if 'id' not in updated_realm:
+
+        if 'id' not in desired_realm:
             module.fail_json(msg='id needs to be specified when creating a new realm')
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize_cr(updated_realm))
+            result['diff'] = dict(before='', after=sanitize_cr(desired_realm))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        kc.create_realm(updated_realm)
-        after_realm = kc.get_realm_by_id(updated_realm['id'])
+        # create it
+        kc.create_realm(desired_realm)
+        after_realm = kc.get_realm_by_id(desired_realm['id'])
 
         result['end_state'] = sanitize_cr(after_realm)
 
-        result['msg'] = 'Realm %s has been created.' % updated_realm['id']
+        result['msg'] = 'Realm %s has been created.' % desired_realm['id']
         module.exit_json(**result)
+
     else:
         if state == 'present':
-            # update existing realm
+            # Process an update
+
+            # doing an update
             result['changed'] = True
             if module.check_mode:
                 # We can only compare the current realm with the proposed updates we have
                 if module._diff:
                     result['diff'] = dict(before=before_realm_sanitized,
-                                          after=sanitize_cr(updated_realm))
-                result['changed'] = (before_realm != updated_realm)
+                                          after=sanitize_cr(desired_realm))
+                result['changed'] = (before_realm != desired_realm)
 
                 module.exit_json(**result)
 
-            kc.update_realm(updated_realm, realm=realm)
+            # do the update
+            kc.update_realm(desired_realm, realm=realm)
 
             after_realm = kc.get_realm_by_id(realm=realm)
+
             if before_realm == after_realm:
                 result['changed'] = False
+
+            result['end_state'] = sanitize_cr(after_realm)
+
             if module._diff:
                 result['diff'] = dict(before=before_realm_sanitized,
                                       after=sanitize_cr(after_realm))
-            result['end_state'] = sanitize_cr(after_realm)
 
-            result['msg'] = 'Realm %s has been updated.' % updated_realm['id']
+            result['msg'] = 'Realm %s has been updated.' % desired_realm['id']
             module.exit_json(**result)
+
         else:
-            # Delete existing realm
+            # Process a deletion (because state was not 'present')
             result['changed'] = True
+
             if module._diff:
-                result['diff']['before'] = before_realm_sanitized
-                result['diff']['after'] = ''
+                result['diff'] = dict(before=before_realm_sanitized, after='')
 
             if module.check_mode:
                 module.exit_json(**result)
 
+            # delete it
             kc.delete_realm(realm=realm)
-            result['proposed'] = dict()
-            result['end_state'] = dict()
+
+            result['proposed'] = {}
+            result['end_state'] = {}
+
             result['msg'] = 'Realm %s has been deleted.' % before_realm['id']
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_role.py

@@ -149,20 +149,21 @@ EXAMPLES = '''
 
 RETURN = '''
 msg:
-  description: Message as to what action was taken
-  returned: always
-  type: str
-  sample: "Role myrole has been updated"
+    description: Message as to what action was taken.
+    returned: always
+    type: str
+    sample: "Role myrole has been updated"
 
 proposed:
-    description: Role representation of proposed changes to role
+    description: Representation of proposed role.
     returned: always
     type: dict
     sample: {
         "description": "My updated test description"
     }
+
 existing:
-    description: Role representation of existing role
+    description: Representation of existing role.
     returned: always
     type: dict
     sample: {
@@ -174,9 +175,10 @@ existing:
         "id": "561703dd-0f38-45ff-9a5a-0c978f794547",
         "name": "myrole"
     }
+
 end_state:
-    description: Role representation of role after module execution (sample is truncated)
-    returned: always
+    description: Representation of role after module execution (sample is truncated).
+    returned: on success
     type: dict
     sample: {
         "attributes": {},
@@ -201,6 +203,7 @@ def main():
     :return:
     """
     argument_spec = keycloak_argument_spec()
+
     meta_args = dict(
         state=dict(type='str', default='present', choices=['present', 'absent']),
         name=dict(type='str', required=True),
@@ -239,22 +242,22 @@ def main():
         for key, val in module.params['attributes'].items():
             module.params['attributes'][key] = [val] if not isinstance(val, list) else val
 
-    # convert module parameters to client representation parameters (if they belong in there)
+    # Filter and map the parameters names that apply to the role
     role_params = [x for x in module.params
                    if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm', 'client_id', 'composites'] and
                    module.params.get(x) is not None]
 
-    # does the role already exist?
+    # See if it already exists in Keycloak
     if clientid is None:
         before_role = kc.get_realm_role(name, realm)
     else:
         before_role = kc.get_client_role(name, clientid, realm)
 
     if before_role is None:
-        before_role = dict()
+        before_role = {}
 
-    # build a changeset
-    changeset = dict()
+    # Build a proposed changeset from parameters given to this module
+    changeset = {}
 
     for param in role_params:
         new_param_value = module.params.get(param)
@@ -262,42 +265,42 @@ def main():
         if new_param_value != old_value:
             changeset[camel(param)] = new_param_value
 
-    # prepare the new role
-    updated_role = before_role.copy()
-    updated_role.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_role = before_role.copy()
+    desired_role.update(changeset)
 
     result['proposed'] = changeset
     result['existing'] = before_role
 
-    # if before_role is none, the role doesn't exist.
-    if before_role == dict():
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_role:
         if state == 'absent':
-            # nothing to do.
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
             result['changed'] = False
-            result['end_state'] = dict()
-            result['msg'] = 'Role does not exist; doing nothing.'
+            result['end_state'] = {}
+            result['msg'] = 'Role does not exist, doing nothing.'
             module.exit_json(**result)
 
-        # for 'present', create a new role.
+        # Process a creation
         result['changed'] = True
 
         if name is None:
             module.fail_json(msg='name must be specified when creating a new role')
 
         if module._diff:
-            result['diff'] = dict(before='', after=updated_role)
+            result['diff'] = dict(before='', after=desired_role)
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # do it for real!
+        # create it
         if clientid is None:
-            kc.create_realm_role(updated_role, realm)
+            kc.create_realm_role(desired_role, realm)
             after_role = kc.get_realm_role(name, realm)
         else:
-            kc.create_client_role(updated_role, clientid, realm)
+            kc.create_client_role(desired_role, clientid, realm)
             after_role = kc.get_client_role(name, clientid, realm)
 
         result['end_state'] = after_role
@@ -307,28 +310,30 @@ def main():
 
     else:
         if state == 'present':
+            # Process an update
+
             # no changes
-            if updated_role == before_role:
+            if desired_role == before_role:
                 result['changed'] = False
-                result['end_state'] = updated_role
+                result['end_state'] = desired_role
                 result['msg'] = "No changes required to role {name}.".format(name=name)
                 module.exit_json(**result)
 
-            # update the existing role
+            # doing an update
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=before_role, after=updated_role)
+                result['diff'] = dict(before=before_role, after=desired_role)
 
             if module.check_mode:
                 module.exit_json(**result)
 
             # do the update
             if clientid is None:
-                kc.update_realm_role(updated_role, realm)
+                kc.update_realm_role(desired_role, realm)
                 after_role = kc.get_realm_role(name, realm)
             else:
-                kc.update_client_role(updated_role, clientid, realm)
+                kc.update_client_role(desired_role, clientid, realm)
                 after_role = kc.get_client_role(name, clientid, realm)
 
             result['end_state'] = after_role
@@ -336,7 +341,8 @@ def main():
             result['msg'] = "Role {name} has been updated".format(name=name)
             module.exit_json(**result)
 
-        elif state == 'absent':
+        else:
+            # Process a deletion (because state was not 'present')
             result['changed'] = True
 
             if module._diff:
@@ -345,16 +351,15 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete for real
+            # delete it
             if clientid is None:
                 kc.delete_realm_role(name, realm)
             else:
                 kc.delete_client_role(name, clientid, realm)
 
-            result['end_state'] = dict()
+            result['end_state'] = {}
 
             result['msg'] = "Role {name} has been deleted".format(name=name)
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_user_federation.py

@@ -64,6 +64,7 @@ options:
         choices:
             - ldap
             - kerberos
+            - sssd
 
     provider_type:
         description:
@@ -83,9 +84,10 @@ options:
     config:
         description:
             - Dict specifying the configuration options for the provider; the contents differ depending on
-              the value of I(provider_id). Examples are given below for C(ldap) and C(kerberos). It is easiest
-              to obtain valid config values by dumping an already-existing user federation configuration
-              through check-mode in the I(existing) field.
+              the value of I(provider_id). Examples are given below for C(ldap), C(kerberos) and C(sssd).
+              It is easiest to obtain valid config values by dumping an already-existing user federation
+              configuration through check-mode in the I(existing) field.
+            - The value C(sssd) has been supported since community.general 4.2.0.
         type: dict
         suboptions:
             enabled:
@@ -182,7 +184,7 @@ options:
                 description:
                     - For one level, the search applies only for users in the DNs specified by User DNs.
                       For subtree, the search applies to the whole subtree. See LDAP documentation for
-                      more details
+                      more details.
                 default: '1'
                 type: str
                 choices:
@@ -531,6 +533,22 @@ EXAMPLES = '''
         allowPasswordAuthentication: false
         updateProfileFirstLogin: false
 
+  - name: Create sssd user federation
+    community.general.keycloak_user_federation:
+      auth_keycloak_url: https://keycloak.example.com/auth
+      auth_realm: master
+      auth_username: admin
+      auth_password: password
+      realm: my-realm
+      name: my-sssd
+      state: present
+      provider_id: sssd
+      provider_type: org.keycloak.storage.UserStorageProvider
+      config:
+        priority: 0
+        enabled: true
+        cachePolicy: DEFAULT
+
   - name: Delete user federation
     community.general.keycloak_user_federation:
       auth_keycloak_url: https://keycloak.example.com/auth
@@ -551,7 +569,7 @@ msg:
     sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."
 
 proposed:
-    description: Representation of proposed changes to user federation.
+    description: Representation of proposed user federation.
     returned: always
     type: dict
     sample: {
@@ -648,7 +666,7 @@ existing:
 
 end_state:
     description: Representation of user federation after module execution.
-    returned: always
+    returned: on success
     type: dict
     sample: {
         "config": {
@@ -668,7 +686,6 @@ end_state:
         "providerId": "kerberos",
         "providerType": "org.keycloak.storage.UserStorageProvider"
     }
-
 '''
 
 from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
@@ -766,7 +783,7 @@ def main():
         realm=dict(type='str', default='master'),
         id=dict(type='str'),
         name=dict(type='str'),
-        provider_id=dict(type='str', aliases=['providerId'], choices=['ldap', 'kerberos']),
+        provider_id=dict(type='str', aliases=['providerId'], choices=['ldap', 'kerberos', 'sssd']),
         provider_type=dict(type='str', aliases=['providerType'], default='org.keycloak.storage.UserStorageProvider'),
         parent_id=dict(type='str', aliases=['parentId']),
         mappers=dict(type='list', elements='dict', options=mapper_spec),
@@ -808,12 +825,12 @@ def main():
                 mapper['config'] = dict((k, [str(v).lower() if not isinstance(v, str) else v])
                                         for k, v in mapper['config'].items() if mapper['config'][k] is not None)
 
-    # convert module parameters to client representation parameters (if they belong in there)
+    # Filter and map the parameters names that apply
     comp_params = [x for x in module.params
                    if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm', 'mappers'] and
                    module.params.get(x) is not None]
 
-    # does the user federation already exist?
+    # See if it already exists in Keycloak
     if cid is None:
         found = kc.get_components(urlencode(dict(type='org.keycloak.storage.UserStorageProvider', parent=realm, name=name)), realm)
         if len(found) > 1:
@@ -825,14 +842,14 @@ def main():
         before_comp = kc.get_component(cid, realm)
 
     if before_comp is None:
-        before_comp = dict()
+        before_comp = {}
 
     # if user federation exists, get associated mappers
-    if cid is not None and before_comp:
+    if cid is not None:
         before_comp['mappers'] = sorted(kc.get_components(urlencode(dict(parent=cid)), realm), key=lambda x: x.get('name'))
 
-    # build a changeset
-    changeset = dict()
+    # Build a proposed changeset from parameters given to this module
+    changeset = {}
 
     for param in comp_params:
         new_param_value = module.params.get(param)
@@ -844,18 +861,18 @@ def main():
 
     # special handling of mappers list to allow change detection
     if module.params.get('mappers') is not None:
-        if module.params['provider_id'] == 'kerberos':
-            module.fail_json(msg='Cannot configure mappers for Kerberos federations.')
+        if module.params['provider_id'] in ['kerberos', 'sssd']:
+            module.fail_json(msg='Cannot configure mappers for {type} provider.'.format(type=module.params['provider_id']))
         for change in module.params['mappers']:
             change = dict((k, v) for k, v in change.items() if change[k] is not None)
             if change.get('id') is None and change.get('name') is None:
                 module.fail_json(msg='Either `name` or `id` has to be specified on each mapper.')
             if cid is None:
-                old_mapper = dict()
+                old_mapper = {}
             elif change.get('id') is not None:
                 old_mapper = kc.get_component(change['id'], realm)
                 if old_mapper is None:
-                    old_mapper = dict()
+                    old_mapper = {}
             else:
                 found = kc.get_components(urlencode(dict(parent=cid, name=change['name'])), realm)
                 if len(found) > 1:
@@ -863,7 +880,7 @@ def main():
                 if len(found) == 1:
                     old_mapper = found[0]
                 else:
-                    old_mapper = dict()
+                    old_mapper = {}
             new_mapper = old_mapper.copy()
             new_mapper.update(change)
             if new_mapper != old_mapper:
@@ -871,56 +888,45 @@ def main():
                     changeset['mappers'] = list()
                 changeset['mappers'].append(new_mapper)
 
-    # prepare the new representation
-    updated_comp = before_comp.copy()
-    updated_comp.update(changeset)
+    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+    desired_comp = before_comp.copy()
+    desired_comp.update(changeset)
 
     result['proposed'] = sanitize(changeset)
     result['existing'] = sanitize(before_comp)
 
-    # if before_comp is none, the user federation doesn't exist.
-    if before_comp == dict():
+    # Cater for when it doesn't exist (an empty dict)
+    if not before_comp:
         if state == 'absent':
-            # nothing to do.
+            # Do nothing and exit
             if module._diff:
                 result['diff'] = dict(before='', after='')
             result['changed'] = False
-            result['end_state'] = dict()
+            result['end_state'] = {}
             result['msg'] = 'User federation does not exist; doing nothing.'
             module.exit_json(**result)
 
-        # for 'present', create a new user federation.
+        # Process a creation
         result['changed'] = True
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize(updated_comp))
+            result['diff'] = dict(before='', after=sanitize(desired_comp))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # do it for real!
-        updated_comp = updated_comp.copy()
-        updated_mappers = updated_comp.pop('mappers', [])
-        after_comp = kc.create_component(updated_comp, realm)
+        # create it
+        desired_comp = desired_comp.copy()
+        updated_mappers = desired_comp.pop('mappers', [])
+        after_comp = kc.create_component(desired_comp, realm)
 
         for mapper in updated_mappers:
-            found = kc.get_components(urlencode(dict(parent=cid, name=mapper['name'])), realm)
-            if len(found) > 1:
-                module.fail_json(msg='Found multiple mappers with name `{name}`. Cannot continue.'.format(name=mapper['name']))
-            if len(found) == 1:
-                old_mapper = found[0]
+            if mapper.get('id') is not None:
+                kc.update_component(mapper, realm)
             else:
-                old_mapper = {}
-
-            new_mapper = old_mapper.copy()
-            new_mapper.update(mapper)
-
-            if new_mapper.get('id') is not None:
-                kc.update_component(new_mapper, realm)
-            else:
-                if new_mapper.get('parentId') is None:
-                    new_mapper['parentId'] = after_comp['id']
-                mapper = kc.create_component(new_mapper, realm)
+                if mapper.get('parentId') is None:
+                    mapper['parentId'] = after_comp['id']
+                mapper = kc.create_component(mapper, realm)
 
         after_comp['mappers'] = updated_mappers
         result['end_state'] = sanitize(after_comp)
@@ -930,26 +936,28 @@ def main():
 
     else:
         if state == 'present':
+            # Process an update
+
             # no changes
-            if updated_comp == before_comp:
+            if desired_comp == before_comp:
                 result['changed'] = False
-                result['end_state'] = sanitize(updated_comp)
+                result['end_state'] = sanitize(desired_comp)
                 result['msg'] = "No changes required to user federation {id}.".format(id=cid)
                 module.exit_json(**result)
 
-            # update the existing role
+            # doing an update
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=sanitize(before_comp), after=sanitize(updated_comp))
+                result['diff'] = dict(before=sanitize(before_comp), after=sanitize(desired_comp))
 
             if module.check_mode:
                 module.exit_json(**result)
 
             # do the update
-            updated_comp = updated_comp.copy()
-            updated_mappers = updated_comp.pop('mappers', [])
-            kc.update_component(updated_comp, realm)
+            desired_comp = desired_comp.copy()
+            updated_mappers = desired_comp.pop('mappers', [])
+            kc.update_component(desired_comp, realm)
             after_comp = kc.get_component(cid, realm)
 
             for mapper in updated_mappers:
@@ -957,7 +965,7 @@ def main():
                     kc.update_component(mapper, realm)
                 else:
                     if mapper.get('parentId') is None:
-                        mapper['parentId'] = updated_comp['id']
+                        mapper['parentId'] = desired_comp['id']
                     mapper = kc.create_component(mapper, realm)
 
             after_comp['mappers'] = updated_mappers
@@ -967,6 +975,7 @@ def main():
             module.exit_json(**result)
 
         elif state == 'absent':
+            # Process a deletion
             result['changed'] = True
 
             if module._diff:
@@ -975,13 +984,12 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete for real
+            # delete it
             kc.delete_component(cid, realm)
 
-            result['end_state'] = dict()
+            result['end_state'] = {}
 
             result['msg'] = "User federation {id} has been deleted".format(id=cid)
-            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/ilo_redfish_config.py

@@ -0,0 +1 @@
+remote_management/redfish/ilo_redfish_config.py

plugins/modules/ilo_redfish_info.py

@@ -0,0 +1 @@
+remote_management/redfish/ilo_redfish_info.py

plugins/modules/monitoring/circonus_annotation.py

@@ -143,8 +143,7 @@ annotation:
 import json
 import time
 import traceback
-
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from distutils.version import LooseVersion
 
 REQUESTS_IMP_ERR = None
 try: