Release 3.0.0.

* lxd dynamic inventory and test data

* added ``merge_profile`` parameter to merge configurations from the play to an existing profile

* cosmetic changes

* added ``merge_profile`` parameter to merge configurations from the play to an existing profile

* cosmetic changes

* fix pylint errors

* fix flake8 warnings

* fix pep8 errors without "line to long"

* fix ansible tests

* fix typo

* fix version added

* fix lost of suggestions from felixfontein

* fix filter
fix ansible test errors

* delete test config

* delete 'notes:' and copy content to description

* move testdata
load testdata by path from config

* updated documentation

* fix test data and remove inventory branch

* fix spellings and rename lxd to community.general.lxd

* fix documentation

* remove selftest

* strip example data

* add unit test

* switch to ansible.module_utils.common.dict_transformations

* documentation cleanup

* move lxd_inventory.atd from files to fixtures

* update documentation
move lxd_inventory.atd

* rename self.groups to self dispose
remove dumpdata

* cleanup

* fix unittests
comment out dump_data, it breaks the unit tests

* fix pep8

* Apply suggestions from code review

* Update plugins/inventory/lxd.py

* add test if no groupby is selected

* rename disposed to groupby
remove unused constant
other suggested cleanups

* Use bundled ipaddress instead of own code.

* Update plugins/inventory/lxd.py

* Exceptions should not be eaten.

* Improve error handling for network range/address parsing.

* Fix typo.

* Make network range valid.

* Do not error when groupby is not a dict.

Co-authored-by: Frank Dornheim <“dornheim@posteo.de@users.noreply.github.com”>
Co-authored-by: Felix Fontein <felix@fontein.de>

.azure-pipelines/azure-pipelines.yml

@@ -14,24 +14,12 @@ pr:
 
 schedules:
   - cron: 0 8 * * *
-    displayName: Nightly (main)
+    displayName: Nightly
     always: true
     branches:
       include:
         - main
-  - cron: 0 10 * * *
-    displayName: Nightly (active stable branches)
-    always: true
-    branches:
-      include:
-        - stable-2
-        - stable-3
-  - cron: 0 11 * * 0
-    displayName: Weekly (old stable branches)
-    always: true
-    branches:
-      include:
-        - stable-1
+        - stable-*
 
 variables:
   - name: checkoutPath
@@ -124,7 +112,6 @@ stages:
             - test: 3.7
             - test: 3.8
             - test: 3.9
-            - test: '3.10'
   - stage: Units_2_11
     displayName: Units 2.11
     dependsOn: []
@@ -186,8 +173,8 @@ stages:
               test: macos/11.1
             - name: RHEL 7.9
               test: rhel/7.9
-            - name: RHEL 8.4
-              test: rhel/8.4
+            - name: RHEL 8.3
+              test: rhel/8.3
             - name: FreeBSD 12.2
               test: freebsd/12.2
             - name: FreeBSD 13.0
@@ -269,10 +256,10 @@ stages:
               test: centos7
             - name: CentOS 8
               test: centos8
+            - name: Fedora 32
+              test: fedora32
             - name: Fedora 33
               test: fedora33
-            - name: Fedora 34
-              test: fedora34
             - name: openSUSE 15 py2
               test: opensuse15py2
             - name: openSUSE 15 py3
@@ -295,7 +282,7 @@ stages:
           targets:
             - name: CentOS 8
               test: centos8
-            - name: Fedora 33
+            - name: Fedora 32
               test: fedora33
             - name: openSUSE 15 py3
               test: opensuse15

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

@@ -7,7 +7,7 @@ set -o pipefail -eu
 
 output_path="$1"
 
-curl --silent --show-error https://ansible-ci-files.s3.us-east-1.amazonaws.com/codecov/codecov.sh > codecov.sh
+curl --silent --show-error https://codecov.io/bash > codecov.sh
 
 for file in "${output_path}"/reports/coverage*.xml; do
     name="${file}"

.github/BOTMETA.yml

@@ -1,14 +1,17 @@
 automerge: true
 files:
   plugins/:
-    supershipit: quidame Ajpantuso
+    supershipit: aminvakil russoz
   changelogs/fragments/:
     support: community
   $actions:
     labels: action
-  $actions/system/iptables_state.py:
-    maintainers: quidame
-  $actions/system/shutdown.py:
+  $actions/aireos.py:
+    labels: aireos cisco networking
+  $actions/ironware.py:
+    maintainers: paulquack
+    labels: ironware networking
+  $actions/shutdown.py:
     maintainers: nitzmahone samdoran aminvakil
   $becomes/:
     labels: become
@@ -60,6 +63,8 @@ files:
     maintainers: giner
   $filters/from_csv.py:
     maintainers: Ajpantuso
+  $filters/hashids:
+    maintainers: Ajpantuso
   $filters/jc.py:
     maintainers: kellyjonbrazil
   $filters/list.py:
@@ -150,7 +155,6 @@ files:
   $module_utils/redfish_utils.py:
     maintainers: $team_redfish
     labels: redfish_utils
-  $module_utils/remote_management/dellemc/: rajeevarakkal
   $module_utils/remote_management/lxca/common.py: navalkp prabhosa
   $module_utils/scaleway.py:
     maintainers: $team_scaleway
@@ -194,8 +198,6 @@ files:
     maintainers: glitchcrab
   $modules/cloud/misc/cloud_init_data_facts.py:
     maintainers: resmo
-  $modules/cloud/misc/helm.py:
-    maintainers: flaper87
   $modules/cloud/misc/proxmox.py:
     maintainers: $team_virt UnderGreen
     labels: proxmox virt
@@ -223,7 +225,7 @@ files:
   $modules/cloud/misc/:
     ignore: ryansb
   $modules/cloud/misc/terraform.py:
-    maintainers: m-yosefpor rainerleber
+    maintainers: m-yosefpor
   $modules/cloud/misc/xenserver_facts.py:
     maintainers: caphrim007 cheese
     labels: xenserver_facts
@@ -344,6 +346,8 @@ files:
     maintainers: dareko
   $modules/files/archive.py:
     maintainers: bendoh
+  $modules/files/filesize.py:
+    maintainers: quidame
   $modules/files/ini_file.py:
     maintainers: jpmens noseka1
   $modules/files/iso_extract.py:
@@ -357,8 +361,6 @@ files:
     maintainers: dagwieers magnus919 tbielawa cmprescott sm4rk0
     labels: m:xml xml
     ignore: magnus919
-  $modules/identity/onepassword_facts.py:
-    maintainers: Rylon
   $modules/identity/ipa/:
     maintainers: $team_ipa
   $modules/identity/ipa/ipa_pwpolicy.py:
@@ -463,8 +465,6 @@ files:
     maintainers: akostyuk
   $modules/net_tools/ipwcli_dns.py:
     maintainers: cwollinger
-  $modules/net_tools/ldap/ldap_attr.py:
-    maintainers: jtyr
   $modules/net_tools/ldap/ldap_attrs.py:
     maintainers: drybjed jtyr noles
   $modules/net_tools/ldap/ldap_entry.py:
@@ -560,10 +560,9 @@ files:
   $modules/packaging/language/bundler.py:
     maintainers: thoiberg
   $modules/packaging/language/composer.py:
-    maintainers: dmtrs
-    ignore: resmo
+    maintainers: dmtrs resmo
   $modules/packaging/language/cpanm.py:
-    maintainers: fcuny
+    maintainers: fcuny russoz
   $modules/packaging/language/easy_install.py:
     maintainers: mattupstate
   $modules/packaging/language/gem.py:
@@ -708,17 +707,9 @@ files:
     labels: zypper
     ignore: dirtyharrycallahan robinro
   $modules/packaging/os/zypper_repository.py:
-    maintainers: $team_suse
-    labels: zypper
-    ignore: matze
+    maintainers: matze
   $modules/remote_management/cobbler/:
     maintainers: dagwieers
-  $modules/remote_management/dellemc/:
-    maintainers: rajeevarakkal
-  $modules/remote_management/dellemc/idrac_server_config_profile.py:
-    maintainers: jagadeeshnv
-  $modules/remote_management/dellemc/ome_device_info.py:
-    maintainers: Sajna-Shetty
   $modules/remote_management/hpilo/:
     maintainers: haad
     ignore: dagwieers
@@ -738,8 +729,6 @@ files:
     maintainers: evertmulder
   $modules/remote_management/manageiq/manageiq_tenant.py:
     maintainers: evertmulder
-  $modules/remote_management/oneview/oneview_datacenter_facts.py:
-    maintainers: aalexmonteiro madhav-bharadwaj ricardogpsf soodpr
   $modules/remote_management/oneview/:
     maintainers: adriane-cardozo fgbulsoni tmiotto
   $modules/remote_management/oneview/oneview_datacenter_info.py:
@@ -788,12 +777,6 @@ files:
     maintainers: yeukhon
   $modules/storage/emc/emc_vnx_sg_member.py:
     maintainers: remixtj
-  $modules/storage/glusterfs/:
-    maintainers: devyanikota
-  $modules/storage/glusterfs/gluster_peer.py:
-    maintainers: sac
-  $modules/storage/glusterfs/gluster_volume.py:
-    maintainers: rosmo
   $modules/storage/hpe3par/ss_3par_cpg.py:
     maintainers: farhan7500 gautamphegde
   $modules/storage/ibm/:
@@ -815,9 +798,6 @@ files:
     maintainers: johanwiren
   $modules/storage/zfs/zfs_delegate_admin.py:
     maintainers: natefoo
-  $modules/system/python_requirements_facts.py:
-    maintainers: willthames
-    ignore: ryansb
   $modules/system/aix:
     maintainers: $team_aix
     labels: aix
@@ -856,8 +836,6 @@ files:
     labels: interfaces_file
   $modules/system/iptables_state.py:
     maintainers: quidame
-  $modules/system/shutdown.py:
-    maintainers: nitzmahone samdoran aminvakil
   $modules/system/java_cert.py:
     maintainers: haad absynth76
   $modules/system/java_keystore.py:
@@ -950,10 +928,6 @@ files:
     labels: xfconf
   $modules/system/xfs_quota.py:
     maintainers: bushvin
-  $modules/web_infrastructure/jenkins_job_facts.py:
-    maintainers: stpierre
-  $modules/web_infrastructure/nginx_status_facts.py:
-    maintainers: resmo
   $modules/web_infrastructure/apache2_mod_proxy.py:
     maintainers: oboukili
   $modules/web_infrastructure/apache2_module.py:
@@ -1051,5 +1025,5 @@ macros:
   team_rhn: FlossWare alikins barnabycourt vritant
   team_scaleway: QuentinBrosse abarbare jerome-quere kindermoumoute remyleone sieben
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel dcermak evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
+  team_suse: commel dcermak evrardjp lrupp toabctl AnderEnder alxgu andytom
   team_virt: joshainglis karmab tleguern Thulium-Drake Ajpantuso

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,135 @@
+---
+name: Bug report
+description: Create a report to help us improve
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      Verify first that your issue is not [already reported on GitHub][issue search].
+      Also test if the latest release and devel branch are affected too.
+      *Complete **all** sections as described, this form is processed automatically.*
+
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+
+
+- type: textarea
+  attributes:
+    label: Summary
+    description: Explain the problem briefly below.
+    placeholder: >-
+      When I try to do X with the collection from the main branch on GitHub, Y
+      breaks in a way Z under the env E. Here are all the details I know
+      about this problem...
+  validations:
+    required: true
+
+- type: dropdown
+  attributes:
+    label: Issue Type
+    # FIXME: Once GitHub allows defining the default choice, update this
+    options:
+    - Bug Report
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    # For smaller collections we could use a multi-select and hardcode the list
+    # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
+    # Select from list, filter as you type (`mysql` would only show the 3 mysql components)
+    # OR freeform - doesn't seem to be supported in adaptivecards
+    label: Component Name
+    description: >-
+      Write the short name of the module, plugin, task or feature below,
+      *use your best guess if unsure*.
+    placeholder: dnf, apt, yum, pip, user etc.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Ansible Version
+    description: >-
+      Paste verbatim output from `ansible --version` between
+      tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible --version
+
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Configuration
+    description: >-
+      If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
+      This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
+      Paste verbatim output from `ansible-config dump --only-changed` between quotes
+    value: |
+      ```console (paste below)
+      $ ansible-config dump --only-changed
+
+      ```
+
+
+- type: textarea
+  attributes:
+    label: OS / Environment
+    description: >-
+      Provide all relevant information below, e.g. target OS versions,
+      network device firmware, etc.
+    placeholder: RHEL 8, CentOS Stream etc.
+  validations:
+    required: false
+
+
+- type: textarea
+  attributes:
+    label: Steps to Reproduce
+    description: |
+      Describe exactly how to reproduce the problem, using a minimal test-case. It would *really* help us understand your problem if you could also pased any playbooks, configs and commands you used.
+
+      **HINT:** You can paste https://gist.github.com links for larger files.
+    value: |
+      <!--- Paste example playbooks or commands between quotes below -->
+      ```yaml (paste below)
+
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Expected Results
+    description: >-
+      Describe what you expected to happen when running the steps above.
+    placeholder: >-
+      I expected X to happen because I assumed Y.
+      that it did not.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Actual Results
+    description: |
+      Describe what actually happened. If possible run with extra verbosity (`-vvvv`).
+
+      Paste verbatim command output between quotes.
+    value: |
+      ```console (paste below)
+
+      ```
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
+      required: true
+...

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,27 @@
+---
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: false  # default: true
+contact_links:
+- name: Security bug report
+  url: https://docs.ansible.com/ansible-core/devel/community/reporting_bugs_and_features.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
+  about: |
+    Please learn how to report security vulnerabilities here.
+
+    For all security related bugs, email security@ansible.com
+    instead of using this issue tracker and you will receive
+    a prompt response.
+
+    For more information, see
+    https://docs.ansible.com/ansible/latest/community/reporting_bugs_and_features.html
+- name: Ansible Code of Conduct
+  url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
+  about: Be nice to other members of the community.
+- name: Talks to the community
+  url: https://docs.ansible.com/ansible/latest/community/communication.html?utm_medium=github&utm_source=issue_template_chooser#mailing-list-information
+  about: Please ask and answer usage questions here
+- name: Working groups
+  url: https://github.com/ansible/community/wiki
+  about: Interested in improving a specific area? Become a part of a working group!
+- name: For Enterprise
+  url: https://www.ansible.com/products/engine?utm_medium=github&utm_source=issue_template_chooser_ansible_collections
+  about: Red Hat offers support for the Ansible Automation Platform

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -0,0 +1,111 @@
+---
+name: Documentation Report
+description: Ask us about docs
+# NOTE: issue body is enabled to allow screenshots
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      Verify first that your issue is not [already reported on GitHub][issue search].
+      Also test if the latest release and devel branch are affected too.
+      *Complete **all** sections as described, this form is processed automatically.*
+
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+
+
+- type: textarea
+  attributes:
+    label: Summary
+    description: |
+      Explain the problem briefly below, add suggestions to wording or structure.
+
+      **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
+    placeholder: >-
+      I was reading the Collection documentation of version X and I'm having
+      problems understanding Y. It would be very helpful if that got
+      rephrased as Z.
+  validations:
+    required: true
+
+- type: dropdown
+  attributes:
+    label: Issue Type
+    # FIXME: Once GitHub allows defining the default choice, update this
+    options:
+    - Documentation Report
+  validations:
+    required: true
+
+- type: input
+  attributes:
+    label: Component Name
+    description: >-
+      Write the short name of the rst file, module, plugin, task or
+      feature below, *use your best guess if unsure*.
+    placeholder: mysql_user
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Ansible Version
+    description: >-
+      Paste verbatim output from `ansible --version` between
+      tripple backticks.
+    value: |
+      ```console (paste below)
+      $ ansible --version
+
+      ```
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Configuration
+    description: >-
+      Paste verbatim output from `ansible-config dump --only-changed` between quotes.
+    value: |
+      ```console (paste below)
+      $ ansible-config dump --only-changed
+
+      ```
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: OS / Environment
+    description: >-
+      Provide all relevant information below, e.g. OS version,
+      browser, etc.
+    placeholder: Fedora 33, Firefox etc.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Additional Information
+    description: |
+      Describe how this improves the documentation, e.g. before/after situation or screenshots.
+
+      **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
+
+      **HINT:** You can paste https://gist.github.com links for larger files.
+    placeholder: >-
+      When the improvement is applied, it makes it more straightforward
+      to understand X.
+  validations:
+    required: false
+
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
+      required: true
+...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,69 @@
+---
+name: Feature request
+description: Suggest an idea for this project
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      ⚠
+      Verify first that your issue is not [already reported on GitHub][issue search].
+      Also test if the latest release and devel branch are affected too.
+      *Complete **all** sections as described, this form is processed automatically.*
+
+      [issue search]: https://github.com/ansible-collections/community.general/search?q=is%3Aissue&type=issues
+
+
+- type: textarea
+  attributes:
+    label: Summary
+    description: Describe the new feature/improvement briefly below.
+    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.
+  validations:
+    required: true
+
+- type: dropdown
+  attributes:
+    label: Issue Type
+    # FIXME: Once GitHub allows defining the default choice, update this
+    options:
+    - Feature Idea
+  validations:
+    required: true
+
+- type: input
+  attributes:
+    label: Component Name
+    description: >-
+      Write the short name of the module, plugin, task or feature below,
+      *use your best guess if unsure*.
+    placeholder: dnf, apt, yum, pip, user etc.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Additional Information
+    description: |
+      Describe how the feature would be used, why it is needed and what it would solve.
+
+      **HINT:** You can paste https://gist.github.com links for larger files.
+    value: |
+      <!--- Paste example playbooks or commands between quotes below -->
+      ```yaml (paste below)
+
+      ```
+  validations:
+    required: false
+- type: checkboxes
+  attributes:
+    label: Code of Conduct
+    description: |
+      Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
+    options:
+    - label: I agree to follow the Ansible Code of Conduct
+      required: true
+...

.gitignore

@@ -1,6 +1,6 @@
 
-# Created by https://www.toptal.com/developers/gitignore/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
-# Edit at https://www.toptal.com/developers/gitignore?templates=git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
+# Created by https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
+# Edit at https://www.gitignore.io/?templates=git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
 
 ### dotenv ###
 .env
@@ -88,7 +88,7 @@ flycheck_*.el
 .nfs*
 
 ### PyCharm+all ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
@@ -98,9 +98,6 @@ flycheck_*.el
 .idea/**/dictionaries
 .idea/**/shelf
 
-# AWS User-specific
-.idea/**/aws.xml
-
 # Generated files
 .idea/**/contentModel.xml
 
@@ -121,9 +118,6 @@ flycheck_*.el
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
@@ -204,6 +198,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -230,25 +225,13 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
 .hypothesis/
 .pytest_cache/
-cover/
 
 # Translations
 *.mo
 *.pot
 
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
 # Scrapy stuff:
 .scrapy
 
@@ -256,19 +239,9 @@ instance/
 docs/_build/
 
 # PyBuilder
-.pybuilder/
 target/
 
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
 .python-version
 
 # pipenv
@@ -278,24 +251,12 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# Environments
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
 # Spyder project settings
 .spyderproject
 .spyproject
@@ -303,6 +264,10 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
+# Mr Developer
+.mr.developer.cfg
+.project
+
 # mkdocs documentation
 /site
 
@@ -314,16 +279,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
-!*.svg  # comment out if you don't need vector files
 [._]*.sw[a-p]
 [._]s[a-rt-v][a-z]
 [._]ss[a-gi-z]
@@ -341,13 +299,11 @@ tags
 [._]*.un~
 
 ### WebStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
 
-# AWS User-specific
-
 # Generated files
 
 # Sensitive or high-churn files
@@ -358,9 +314,6 @@ tags
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
@@ -396,27 +349,15 @@ tags
 # *.ipr
 
 # Sonarlint plugin
-# https://plugins.jetbrains.com/plugin/7973-sonarlint
 .idea/**/sonarlint/
 
 # SonarQube Plugin
-# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
 .idea/**/sonarIssues.xml
 
 # Markdown Navigator plugin
-# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
 .idea/**/markdown-navigator.xml
-.idea/**/markdown-navigator-enh.xml
 .idea/**/markdown-navigator/
 
-# Cache file creation bug
-# See https://youtrack.jetbrains.com/issue/JBR-2257
-.idea/$CACHE_FILE$
-
-# CodeStream plugin
-# https://plugins.jetbrains.com/plugin/12206-codestream
-.idea/codestream.xml
-
 ### Windows ###
 # Windows thumbnail cache files
 Thumbs.db
@@ -443,4 +384,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv
+# End of https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv

CONTRIBUTING.md

@@ -1,36 +0,0 @@
-# Contributing
-
-We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
-
-If you are a committer, also refer to the [collection's committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
-
-## Issue tracker
-
-Whether you are looking for an opportunity to contribute or you found a bug and already know how to solve it, please go to the [issue tracker](https://github.com/ansible-collections/community.general/issues).
-There you can find feature ideas to implement, reports about bugs to solve, or submit an issue to discuss your idea before implementing it which can help choose a right direction at the beginning of your work and potentially save a lot of time and effort.
-Also somebody may already have started discussing or working on implementing the same or a similar idea,
-so you can cooperate to create a better solution together.
-
-* If you are interested in starting with an easy issue, look for [issues with an `easyfix` label](https://github.com/ansible-collections/community.general/labels/easyfix).
-* Often issues that are waiting for contributors to pick up have [the `waiting_on_contributor` label](https://github.com/ansible-collections/community.general/labels/waiting_on_contributor).
-
-## Open pull requests
-
-Look through currently [open pull requests](https://github.com/ansible-collections/community.general/pulls).
-You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. And it is always worth saying that good reviews are often more valuable than pull requests themselves.
-Note that reviewing does not only mean code review, but also offering comments on new interfaces added to existing plugins/modules, interfaces of new plugins/modules, improving language (not everyone is a native english speaker), or testing bugfixes and new features!
-
-Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself.
-
-* 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 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 :) )
-
-You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst).
-
-## Test pull requests
-
-If you want to test a PR locally, refer to [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how do it quickly.
-
-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.

README.md

@@ -1,20 +1,12 @@
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-2)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-3)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
 
-This repository contains the `community.general` Ansible Collection. The collection is a part of the Ansible package and includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
+This repo contains the `community.general` Ansible Collection. The collection includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
 
 You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
 
-Please note that this collection does **not** support Windows targets. Only connection plugins included in this collection might support Windows targets, and will explicitly mention that in their documentation if they do so.
-
-## Code of Conduct
-
-We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
-
-If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
-
 ## Tested with Ansible
 
 Tested with the current Ansible 2.9, ansible-base 2.10 and ansible-core 2.11 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
@@ -29,9 +21,7 @@ Please check the included content on the [Ansible Galaxy page for this collectio
 
 ## Using this collection
 
-This collection is shipped with the Ansible package. So if you have it installed, no more action is required.
-
-If you have a minimal installation (only Ansible Core installed) or you want to use the latest version of the collection along with the whole Ansible package, you need to install the collection from [Ansible Galaxy](https://galaxy.ansible.com/community/general) manually with the `ansible-galaxy` command-line tool:
+Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI:
 
     ansible-galaxy collection install community.general
 
@@ -42,51 +32,38 @@ collections:
 - name: community.general
 ```
 
-Note that if you install the collection manually, it will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:
-
-```bash
-ansible-galaxy collection install community.general --upgrade
-```
-
-You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/community/general):
-
-```bash
-ansible-galaxy collection install community.general:==X.Y.Z
-```
-
 See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
 
 ## Contributing to this collection
 
-The content of this collection is made by good people just like you, a community of individuals collaborating on making the world better through developing automation software.
+If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
 
-We are actively accepting new contributors.
+For example, if you are working in the `~/dev` directory:
 
-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)!
-
-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.
+```
+cd ~/dev
+git clone git@github.com:ansible-collections/community.general.git collections/ansible_collections/community/general
+export COLLECTIONS_PATH=$(pwd)/collections:$COLLECTIONS_PATH
+```
 
 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).
-
 ### Running tests
 
 See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
 
 ### Communication
 
-We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed.
+We have a dedicated Working Group for Ansible development.
 
-Join us in the `#ansible` (general use questions and support), `#ansible-community` (community and collection development questions), and other [IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels) on [Libera.chat](https://libera.chat).
-
-We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
+You can find other people interested on the following Freenode IRC channels -
+- `#ansible` - For general use questions and support.
+- `#ansible-devel` - For discussions on developer topics and code related to features or bugs.
+- `#ansible-community` - For discussions on community topics and community meetings.
 
 For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
 
-For more information about communication, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+For more information about [communication](https://docs.ansible.com/ansible/latest/community/communication.html)
 
 ### Publishing New Version
 
@@ -99,7 +76,7 @@ Basic instructions without release branches:
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-2/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-3/CHANGELOG.rst).
 
 ## Roadmap
 

commit-rights.md

@@ -67,7 +67,6 @@ Individuals who have been asked to become a part of this group have generally be
 
 | Name                | GitHub ID            | IRC Nick           | Other                |
 | ------------------- | -------------------- | ------------------ | -------------------- |
-| Alexei Znamensky    | russoz               | russoz             |                      |
 | Andrew Klychkov     | andersson007         | andersson007_      |                      |
 | Felix Fontein       | felixfontein         | felixfontein       |                      |
 | John R Barker       | gundalow             | gundalow           |                      |

galaxy.yml

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

meta/runtime.yml

@@ -39,7 +39,7 @@ plugin_routing:
       redirect: community.hashi_vault.hashi_vault
   modules:
     ali_instance_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.ali_instance_info instead.
     docker_compose:
@@ -159,8 +159,7 @@ plugin_routing:
     gcpubsub_info:
       redirect: community.google.gcpubsub_info
     gcpubsub_facts:
-      redirect: community.google.gcpubsub_info
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.google.gcpubsub_info instead.
     gcspanner:
@@ -171,22 +170,23 @@ plugin_routing:
       tombstone:
         removal_version: 2.0.0
         warning_text: Use community.general.github_webhook and community.general.github_webhook_info instead.
-    gluster_heal_info:
-      deprecation:
-        removal_version: 3.0.0
-        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_heal_info instead.
-    gluster_peer:
-      deprecation:
-        removal_version: 3.0.0
-        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_peer instead.
-    gluster_volume:
-      deprecation:
-        removal_version: 3.0.0
-        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_volume instead.
-    helm:
-      deprecation:
-        removal_version: 3.0.0
-        warning_text: The helm module in community.general has been deprecated. Use community.kubernetes.helm instead.
+    # Adding tombstones burns the old name, so we simply remove the entries:
+    # gluster_heal_info:
+    #   tombstone:
+    #     removal_version: 3.0.0
+    #     warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_heal_info instead.
+    # gluster_peer:
+    #   tombstone:
+    #     removal_version: 3.0.0
+    #     warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_peer instead.
+    # gluster_volume:
+    #   tombstone:
+    #     removal_version: 3.0.0
+    #     warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_volume instead.
+    # helm:
+    #   tombstone:
+    #     removal_version: 3.0.0
+    #     warning_text: Use community.kubernetes.helm instead.
     hetzner_failover_ip:
       redirect: community.hrobot.failover_ip
     hetzner_failover_ip_info:
@@ -196,15 +196,19 @@ plugin_routing:
     hetzner_firewall_info:
       redirect: community.hrobot.firewall_info
     hpilo_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.hpilo_info instead.
+    idrac_firmware:
+      redirect: dellemc.openmanage.idrac_firmware
     idrac_redfish_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.idrac_redfish_info instead.
+    idrac_server_config_profile:
+      redirect: dellemc.openmanage.idrac_server_config_profile
     jenkins_job_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.jenkins_job_info instead.
     katello:
@@ -224,7 +228,7 @@ plugin_routing:
     kubevirt_vm:
       redirect: community.kubevirt.kubevirt_vm
     ldap_attr:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.ldap_attrs instead.
     logicmonitor:
@@ -236,11 +240,11 @@ plugin_routing:
         removal_version: 1.0.0
         warning_text: The logicmonitor_facts module is no longer maintained and the API used has been disabled in 2017.
     memset_memstore_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.memset_memstore_info instead.
     memset_server_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.memset_server_info instead.
     na_cdot_aggregate:
@@ -276,159 +280,161 @@ plugin_routing:
         removal_version: 2.0.0
         warning_text: Use netapp.ontap.na_ontap_volume instead.
     na_ontap_gather_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use netapp.ontap.na_ontap_info instead.
     nginx_status_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.nginx_status_info instead.
+    ome_device_info:
+      redirect: dellemc.openmanage.ome_device_info
     one_image_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.one_image_info instead.
     onepassword_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.onepassword_info instead.
     oneview_datacenter_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_datacenter_info instead.
     oneview_enclosure_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_enclosure_info instead.
     oneview_ethernet_network_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_ethernet_network_info instead.
     oneview_fc_network_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_fc_network_info instead.
     oneview_fcoe_network_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_fcoe_network_info instead.
     oneview_logical_interconnect_group_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_logical_interconnect_group_info instead.
     oneview_network_set_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_network_set_info instead.
     oneview_san_manager_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.oneview_san_manager_info instead.
     online_server_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.online_server_info instead.
     online_user_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.online_user_info instead.
     ovirt:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_vm instead.
     ovirt_affinity_label_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_affinity_label_info instead.
     ovirt_api_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_api_info instead.
     ovirt_cluster_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_cluster_info instead.
     ovirt_datacenter_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_datacenter_info instead.
     ovirt_disk_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_disk_info instead.
     ovirt_event_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_event_info instead.
     ovirt_external_provider_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_external_provider_info instead.
     ovirt_group_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_group_info instead.
     ovirt_host_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_host_info instead.
     ovirt_host_storage_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_host_storage_info instead.
     ovirt_network_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_network_info instead.
     ovirt_nic_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_nic_info instead.
     ovirt_permission_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_permission_info instead.
     ovirt_quota_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_quota_info instead.
     ovirt_scheduling_policy_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_scheduling_policy_info instead.
     ovirt_snapshot_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_snapshot_info instead.
     ovirt_storage_domain_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_storage_domain_info instead.
     ovirt_storage_template_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_storage_template_info instead.
     ovirt_storage_vm_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_storage_vm_info instead.
     ovirt_tag_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_tag_info instead.
     ovirt_template_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_template_info instead.
     ovirt_user_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_user_info instead.
     ovirt_vm_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_vm_info instead.
     ovirt_vmpool_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use ovirt.ovirt.ovirt_vmpool_info instead.
     postgresql_copy:
@@ -476,47 +482,47 @@ plugin_routing:
     postgresql_user:
       redirect: community.postgresql.postgresql_user
     purefa_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use purestorage.flasharray.purefa_info instead.
     purefb_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use purestorage.flashblade.purefb_info instead.
     python_requirements_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.python_requirements_info instead.
     redfish_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.redfish_info instead.
     scaleway_image_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_image_info instead.
     scaleway_ip_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_ip_info instead.
     scaleway_organization_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_organization_info instead.
     scaleway_security_group_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_security_group_info instead.
     scaleway_server_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_server_info instead.
     scaleway_snapshot_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_snapshot_info instead.
     scaleway_volume_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.scaleway_volume_info instead.
     sf_account_manager:
@@ -540,15 +546,15 @@ plugin_routing:
         removal_version: 2.0.0
         warning_text: Use netapp.elementsw.na_elementsw_volume instead.
     smartos_image_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.smartos_image_info instead.
     vertica_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.vertica_info instead.
     xenserver_guest_facts:
-      deprecation:
+      tombstone:
         removal_version: 3.0.0
         warning_text: Use community.general.xenserver_guest_info instead.
   doc_fragments:
@@ -565,6 +571,8 @@ plugin_routing:
     postgresql:
       redirect: community.postgresql.postgresql
   module_utils:
+    remote_management.dellemc.dellemc_idrac:
+      redirect: dellemc.openmanage.dellemc_idrac
     docker.common:
       redirect: community.docker.common
     docker.swarm:
@@ -579,6 +587,8 @@ plugin_routing:
       redirect: community.hrobot.robot
     kubevirt:
       redirect: community.kubevirt.kubevirt
+    remote_management.dellemc.ome:
+      redirect: dellemc.openmanage.ome
     postgresql:
       redirect: community.postgresql.postgresql
   callback:

plugins/action/system/iptables_state.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright: (c) 2020, quidame <quidame@poivron.org>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
@@ -8,7 +7,7 @@ __metaclass__ = type
 import time
 
 from ansible.plugins.action import ActionBase
-from ansible.errors import AnsibleActionFail, AnsibleConnectionFailure
+from ansible.errors import AnsibleError, AnsibleActionFail, AnsibleConnectionFailure
 from ansible.utils.vars import merge_hash
 from ansible.utils.display import Display
 
@@ -41,27 +40,19 @@ class ActionModule(ActionBase):
         "(=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
         "'ansible_timeout' (=%s) (recommended).")
 
-    def _async_result(self, async_status_args, task_vars, timeout):
+    def _async_result(self, module_args, task_vars, timeout):
         '''
         Retrieve results of the asynchonous task, and display them in place of
         the async wrapper results (those with the ansible_job_id key).
         '''
-        async_status = self._task.copy()
-        async_status.args = async_status_args
-        async_status.action = 'ansible.builtin.async_status'
-        async_status.async_val = 0
-        async_action = self._shared_loader_obj.action_loader.get(
-            async_status.action, task=async_status, connection=self._connection,
-            play_context=self._play_context, loader=self._loader, templar=self._templar,
-            shared_loader_obj=self._shared_loader_obj)
-
-        if async_status.args['mode'] == 'cleanup':
-            return async_action.run(task_vars=task_vars)
-
         # At least one iteration is required, even if timeout is 0.
-        for dummy in range(max(1, timeout)):
-            async_result = async_action.run(task_vars=task_vars)
-            if async_result.get('finished', 0) == 1:
+        for i in range(max(1, timeout)):
+            async_result = self._execute_module(
+                module_name='ansible.builtin.async_status',
+                module_args=module_args,
+                task_vars=task_vars,
+                wrap_async=False)
+            if async_result['finished'] == 1:
                 break
             time.sleep(min(1, timeout))
 
@@ -85,6 +76,7 @@ class ActionModule(ActionBase):
             task_async = self._task.async_val
             check_mode = self._play_context.check_mode
             max_timeout = self._connection._play_context.timeout
+            module_name = self._task.action
             module_args = self._task.args
 
             if module_args.get('state', None) == 'restored':
@@ -115,7 +107,7 @@ class ActionModule(ActionBase):
                     # longer on the controller); and set a backup file path.
                     module_args['_timeout'] = task_async
                     module_args['_back'] = '%s/iptables.state' % async_dir
-                    async_status_args = dict(mode='status')
+                    async_status_args = dict(_async_dir=async_dir)
                     confirm_cmd = 'rm -f %s' % module_args['_back']
                     starter_cmd = 'touch %s.starter' % module_args['_back']
                     remaining_time = max(task_async, max_timeout)
@@ -141,7 +133,7 @@ class ActionModule(ActionBase):
                 # The module is aware to not process the main iptables-restore
                 # command before finding (and deleting) the 'starter' cookie on
                 # the host, so the previous query will not reach ssh timeout.
-                dummy = self._low_level_execute_command(starter_cmd, sudoable=self.DEFAULT_SUDOABLE)
+                garbage = self._low_level_execute_command(starter_cmd, sudoable=self.DEFAULT_SUDOABLE)
 
                 # As the main command is not yet executed on the target, here
                 # 'finished' means 'failed before main command be executed'.
@@ -151,7 +143,7 @@ class ActionModule(ActionBase):
                     except AttributeError:
                         pass
 
-                    for dummy in range(max_timeout):
+                    for x in range(max_timeout):
                         time.sleep(1)
                         remaining_time -= 1
                         # - AnsibleConnectionFailure covers rejected requests (i.e.
@@ -159,7 +151,7 @@ class ActionModule(ActionBase):
                         # - ansible_timeout is able to cover dropped requests (due
                         #   to a rule or policy DROP) if not lower than async_val.
                         try:
-                            dummy = self._low_level_execute_command(confirm_cmd, sudoable=self.DEFAULT_SUDOABLE)
+                            garbage = self._low_level_execute_command(confirm_cmd, sudoable=self.DEFAULT_SUDOABLE)
                             break
                         except AnsibleConnectionFailure:
                             continue
@@ -172,12 +164,16 @@ class ActionModule(ActionBase):
                         del result[key]
 
                 if result.get('invocation', {}).get('module_args'):
-                    for key in ('_back', '_timeout', '_async_dir', 'jid'):
-                        if result['invocation']['module_args'].get(key):
-                            del result['invocation']['module_args'][key]
+                    if '_timeout' in result['invocation']['module_args']:
+                        del result['invocation']['module_args']['_back']
+                        del result['invocation']['module_args']['_timeout']
 
                 async_status_args['mode'] = 'cleanup'
-                dummy = self._async_result(async_status_args, task_vars, 0)
+                garbage = self._execute_module(
+                    module_name='ansible.builtin.async_status',
+                    module_args=async_status_args,
+                    task_vars=task_vars,
+                    wrap_async=False)
 
         if not wrap_async:
             # remove a temporary path we created

plugins/action/system/shutdown.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright: (c) 2020, Amin Vakil <info@aminvakil.com>
 # Copyright: (c) 2016-2018, Matt Davis <mdavis@ansible.com>
 # Copyright: (c) 2018, Sam Doran <sdoran@redhat.com>

plugins/become/sudosu.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = """
-    name: sudosu
+    become: sudosu
     short_description: Run tasks using sudo su -
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the C(sudo) and C(su) utilities combined.

plugins/cache/memcached.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2014, Brian Coca, Josh Drake, et al
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/cache/pickle.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2017, Brian Coca
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/cache/redis.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2014, Brian Coca, Josh Drake, et al
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -62,7 +61,6 @@ DOCUMENTATION = '''
         type: integer
 '''
 
-import re
 import time
 import json
 
@@ -93,8 +91,6 @@ class CacheModule(BaseCacheModule):
     performance.
     """
     _sentinel_service_name = None
-    re_url_conn = re.compile(r'^([^:]+|\[[^]]+\]):(\d+):(\d+)(?::(.*))?$')
-    re_sent_conn = re.compile(r'^(.*):(\d+)$')
 
     def __init__(self, *args, **kwargs):
         uri = ''
@@ -134,18 +130,11 @@ class CacheModule(BaseCacheModule):
             self._db = self._get_sentinel_connection(uri, kw)
         # normal connection
         else:
-            connection = self._parse_connection(self.re_url_conn, uri)
+            connection = uri.split(':')
             self._db = StrictRedis(*connection, **kw)
 
         display.vv('Redis connection: %s' % self._db)
 
-    @staticmethod
-    def _parse_connection(re_patt, uri):
-        match = re_patt.match(uri)
-        if not match:
-            raise AnsibleError("Unable to parse connection string")
-        return match.groups()
-
     def _get_sentinel_connection(self, uri, kw):
         """
         get sentinel connection details from _uri
@@ -169,7 +158,7 @@ class CacheModule(BaseCacheModule):
             except IndexError:
                 pass  # password is optional
 
-        sentinels = [self._parse_connection(self.re_sent_conn, shost) for shost in connections]
+        sentinels = [tuple(shost.split(':')) for shost in connections]
         display.vv('\nUsing redis sentinels: %s' % sentinels)
         scon = Sentinel(sentinels, **kw)
         try:

plugins/cache/yaml.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2017, Brian Coca
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/context_demo.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/counter_enabled.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2018, Ivan Aragones Muniesa <ivan.aragones.muniesa@gmail.com>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 '''

plugins/callback/dense.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2016, Dag Wieers <dag@wieers.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/hipchat.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (C) 2014, Matt Martz <matt@sivel.net>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/jabber.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (C) 2016 maxn nikolaev.makc@gmail.com
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/log_plays.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/loganalytics.py

@@ -1,11 +1,10 @@
-# 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
 
 DOCUMENTATION = '''
-    name: loganalytics
+    callback: loganalytics
     type: aggregate
     short_description: Posts task results to Azure Log Analytics
     author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"

plugins/callback/logdna.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2018, Samir Musali <samir.musali@logdna.com>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/callback/logentries.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2015, Logentries.com, Jimmy Tang <jimmy.tang@logentries.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/logstash.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (C) 2020, Yevhen Khmelenko <ujenmr@gmail.com>
 # (C) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/null.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/callback/say.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/selective.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) Fastly, inc 2016
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/slack.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (C) 2014-2015, Matt Martz <matt@sivel.net>
 # (C) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/syslog_json.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/callback/unixy.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright: (c) 2017, Allyson Bowles <@akatch>
 # Copyright: (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/callback/yaml.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/connection/chroot.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 #
 # (c) 2013, Maykel Moya <mmoya@speedyrails.com>

plugins/connection/funcd.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>

plugins/connection/iocage.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on jail.py
 # (c) 2013, Michael Scherer <misc@zarb.org>
 # (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>

plugins/connection/jail.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on local.py by Michael DeHaan <michael.dehaan@gmail.com>
 # and chroot.py by  Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>

plugins/connection/lxc.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2015, Joerg Thalheim <joerg@higgsboson.tk>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/connection/lxd.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # (c) 2016 Matt Clay <matt@mystile.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/connection/qubes.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on the buildah connection plugin
 # Copyright (c) 2017 Ansible Project
 #               2018 Kushal Das

plugins/connection/saltstack.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # Based on func.py

plugins/connection/zone.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # and chroot.py     (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # and jail.py       (c) 2013, Michael Scherer <misc@zarb.org>

plugins/doc_fragments/hpe3par.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright: (c) 2018, Hewlett Packard Enterprise Development LP
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/doc_fragments/hwc.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright: (c) 2018, Huawei Inc.
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/doc_fragments/keycloak.py

@@ -30,7 +30,6 @@ options:
         description:
             - Keycloak realm name to authenticate to for API access.
         type: str
-        required: true
 
     auth_client_secret:
         description:
@@ -41,7 +40,6 @@ options:
         description:
             - Username to authenticate for API access with.
         type: str
-        required: true
         aliases:
           - username
 
@@ -49,10 +47,15 @@ options:
         description:
             - Password to authenticate for API access with.
         type: str
-        required: true
         aliases:
           - password
 
+    token:
+        description:
+            - Authentication token for Keycloak API.
+        type: str
+        version_added: 3.0.0
+
     validate_certs:
         description:
             - Verify TLS certificates (do not disable this in production).

plugins/doc_fragments/oracle.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/oracle_creatable_resource.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/oracle_display_name_option.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/oracle_name_option.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/oracle_tags.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/oracle_wait_options.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 # Copyright (c) 2018, Oracle and/or its affiliates.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

plugins/doc_fragments/ovirt_facts.py

@@ -1,59 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2016, Red Hat, Inc.
-# 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):
-
-    # info standard oVirt documentation fragment
-    DOCUMENTATION = r'''
-options:
-    fetch_nested:
-        description:
-            - If I(yes) the module will fetch additional data from the API.
-            - It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested attributes.
-              Only the attributes of the current entity. User can configure to fetch other
-              attributes of the nested entities by specifying C(nested_attributes).
-        type: bool
-        default: false
-    nested_attributes:
-        description:
-            - Specifies list of the attributes which should be fetched from the API.
-            - This parameter apply only when C(fetch_nested) is I(true).
-        type: list
-    auth:
-        description:
-            - "Dictionary with values needed to create HTTP/HTTPS connection to oVirt:"
-            - C(username)[I(required)] - The name of the user, something like I(admin@internal).
-              Default value is set by I(OVIRT_USERNAME) environment variable.
-            - "C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable."
-            - "C(url)- A string containing the API URL of the server, usually
-            something like `I(https://server.example.com/ovirt-engine/api)`. Default value is set by I(OVIRT_URL) environment variable.
-            Either C(url) or C(hostname) is required."
-            - "C(hostname) - A string containing the hostname of the server, usually
-            something like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment variable.
-            Either C(url) or C(hostname) is required."
-            - "C(token) - Token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable."
-            - "C(insecure) - A boolean flag that indicates if the server TLS
-            certificate and host name should be checked."
-            - "C(ca_file) - A PEM file containing the trusted CA certificates. The
-            certificate presented by the server will be verified using these CA
-            certificates. If `C(ca_file)` parameter is not set, system wide
-            CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable."
-            - "C(kerberos) - A boolean flag indicating if Kerberos authentication
-            should be used instead of the default basic authentication."
-            - "C(headers) - Dictionary of HTTP headers to be added to each API call."
-        type: dict
-        required: true
-requirements:
-  - python >= 2.7
-  - ovirt-engine-sdk-python >= 4.3.0
-notes:
-  - "In order to use this module you have to install oVirt Python SDK.
-     To ensure it's installed with correct version you can create the following task:
-     ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0"
-'''

plugins/doc_fragments/vexata.py

@@ -1,4 +1,3 @@
-# coding: utf-8 -*-
 #
 # Copyright: (c) 2019, Sandeep Kasargod <sandeep@vexata.com>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

plugins/filter/hashids.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2021, Andrew Pantuso (@ajpantuso) <ajpantuso@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible.errors import (
+    AnsibleError,
+    AnsibleFilterError,
+    AnsibleFilterTypeError,
+)
+
+from ansible.module_utils.common.text.converters import to_native
+from ansible.module_utils.common.collections import is_sequence
+
+try:
+    from hashids import Hashids
+    HAS_HASHIDS = True
+except ImportError:
+    HAS_HASHIDS = False
+
+
+def initialize_hashids(**kwargs):
+    if not HAS_HASHIDS:
+        raise AnsibleError("The hashids library must be installed in order to use this plugin")
+
+    params = dict((k, v) for k, v in kwargs.items() if v)
+
+    try:
+        return Hashids(**params)
+    except TypeError as e:
+        raise AnsibleFilterError(
+            "The provided parameters %s are invalid: %s" % (
+                ', '.join(["%s=%s" % (k, v) for k, v in params.items()]),
+                to_native(e)
+            )
+        )
+
+
+def hashids_encode(nums, salt=None, alphabet=None, min_length=None):
+    """Generates a YouTube-like hash from a sequence of ints
+
+       :nums: Sequence of one or more ints to hash
+       :salt: String to use as salt when hashing
+       :alphabet: String of 16 or more unique characters to produce a hash
+       :min_length: Minimum length of hash produced
+    """
+
+    hashids = initialize_hashids(
+        salt=salt,
+        alphabet=alphabet,
+        min_length=min_length
+    )
+
+    # Handles the case where a single int is not encapsulated in a list or tuple.
+    # User convenience seems preferable to strict typing in this case
+    # Also avoids obfuscated error messages related to single invalid inputs
+    if not is_sequence(nums):
+        nums = [nums]
+
+    try:
+        hashid = hashids.encode(*nums)
+    except TypeError as e:
+        raise AnsibleFilterTypeError(
+            "Data to encode must by a tuple or list of ints: %s" % to_native(e)
+        )
+
+    return hashid
+
+
+def hashids_decode(hashid, salt=None, alphabet=None, min_length=None):
+    """Decodes a YouTube-like hash to a sequence of ints
+
+       :hashid: Hash string to decode
+       :salt: String to use as salt when hashing
+       :alphabet: String of 16 or more unique characters to produce a hash
+       :min_length: Minimum length of hash produced
+    """
+
+    hashids = initialize_hashids(
+        salt=salt,
+        alphabet=alphabet,
+        min_length=min_length
+    )
+    nums = hashids.decode(hashid)
+    return list(nums)
+
+
+class FilterModule(object):
+
+    def filters(self):
+        return {
+            'hashids_encode': hashids_encode,
+            'hashids_decode': hashids_decode,
+        }

plugins/filter/json_query.py

@@ -35,11 +35,9 @@ def json_query(data, expr):
         raise AnsibleError('You need to install "jmespath" prior to running '
                            'json_query filter')
 
-    # Hack to handle Ansible Unsafe text, AnsibleMapping and AnsibleSequence
+    # Hack to handle Ansible String Types
     # See issue: https://github.com/ansible-collections/community.general/issues/320
     jmespath.functions.REVERSE_TYPES_MAP['string'] = jmespath.functions.REVERSE_TYPES_MAP['string'] + ('AnsibleUnicode', 'AnsibleUnsafeText', )
-    jmespath.functions.REVERSE_TYPES_MAP['array'] = jmespath.functions.REVERSE_TYPES_MAP['array'] + ('AnsibleSequence', )
-    jmespath.functions.REVERSE_TYPES_MAP['object'] = jmespath.functions.REVERSE_TYPES_MAP['object'] + ('AnsibleMapping', )
     try:
         return jmespath.search(expr, data)
     except jmespath.exceptions.JMESPathError as e:

plugins/inventory/lxd.py

@@ -0,0 +1,950 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2021, Frank Dornheim <dornheim@posteo.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 = r'''
+    name: community.general.lxd
+    short_description: Returns Ansible inventory from lxd host
+    description:
+        - Get inventory from the lxd.
+        - Uses a YAML configuration file that ends with 'lxd.(yml|yaml)'.
+    version_added: "3.0.0"
+    author: "Frank Dornheim (@conloos)"
+    options:
+        plugin:
+            description: Token that ensures this is a source file for the 'lxd' plugin.
+            required: true
+            choices: [ 'community.general.lxd' ]
+        url:
+            description:
+            - The unix domain socket path or the https URL for the lxd server.
+            - Sockets in filesystem have to start with C(unix:).
+            - Mostly C(unix:/var/lib/lxd/unix.socket) or C(unix:/var/snap/lxd/common/lxd/unix.socket).
+            default: unix:/var/snap/lxd/common/lxd/unix.socket
+            type: str
+        client_key:
+            description:
+            - The client certificate key file path.
+            aliases: [ key_file ]
+            default: $HOME/.config/lxc/client.key
+            type: path
+        client_cert:
+            description:
+            - The client certificate file path.
+            aliases: [ cert_file ]
+            default: $HOME/.config/lxc/client.crt
+            type: path
+        trust_password:
+            description:
+            - The client trusted password.
+            - You need to set this password on the lxd server before
+                running this module using the following command
+                C(lxc config set core.trust_password <some random password>)
+                See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).
+            - 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.
+            type: str
+            default: none
+            choices: [ 'STOPPED', 'STARTING', 'RUNNING', 'none' ]
+        prefered_container_network_interface:
+            description:
+            - If a container has multiple network interfaces, select which one is the prefered as pattern.
+            - Combined with the first number that can be found e.g. 'eth' + 0.
+            type: str
+            default: eth
+        prefered_container_network_family:
+            description:
+            - If a container has multiple network interfaces, which one is the prefered by family.
+            - Specify C(inet) for IPv4 and C(inet6) for IPv6.
+            type: str
+            default: inet
+            choices: [ 'inet', 'inet6' ]
+        groupby:
+            description:
+            - Create groups by the following keywords C(location), C(pattern), C(network_range), C(os), C(release), C(profile), C(vlanid).
+            - See example for syntax.
+            type: json
+'''
+
+EXAMPLES = '''
+# simple lxd.yml
+plugin: community.general.lxd
+url: unix:/var/snap/lxd/common/lxd/unix.socket
+
+# simple lxd.yml including filter
+plugin: community.general.lxd
+url: unix:/var/snap/lxd/common/lxd/unix.socket
+state: RUNNING
+
+# 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
+'''
+
+import binascii
+import json
+import re
+import time
+import os
+import socket
+from ansible.plugins.inventory import BaseInventoryPlugin
+from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.common.dict_transformations import dict_merge
+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
+
+
+class InventoryModule(BaseInventoryPlugin):
+    DEBUG = 4
+    NAME = 'community.general.lxd'
+    SNAP_SOCKET_URL = 'unix:/var/snap/lxd/common/lxd/unix.socket'
+    SOCKET_URL = 'unix:/var/lib/lxd/unix.socket'
+
+    @staticmethod
+    def load_json_data(path):
+        """Load json data
+
+        Load json data from file
+
+        Args:
+            list(path): Path elements
+            str(file_name): Filename of data
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            dict(json_data): json data"""
+        try:
+            with open(path, 'r') as json_file:
+                return json.load(json_file)
+        except (IOError, json.decoder.JSONDecodeError) as err:
+            raise AnsibleParserError('Could not load the test data from {0}: {1}'.format(to_native(path), to_native(err)))
+
+    def save_json_data(self, path, file_name=None):
+        """save data as json
+
+        Save data as json file
+
+        Args:
+            list(path): Path elements
+            str(file_name): Filename of data
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+
+        if file_name:
+            path.append(file_name)
+        else:
+            prefix = 'lxd_data-'
+            time_stamp = time.strftime('%Y%m%d-%H%M%S')
+            suffix = '.atd'
+            path.append(prefix + time_stamp + suffix)
+
+        try:
+            cwd = os.path.abspath(os.path.dirname(__file__))
+            with open(os.path.abspath(os.path.join(cwd, *path)), 'w') as json_file:
+                json.dump(self.data, json_file)
+        except IOError as err:
+            raise AnsibleParserError('Could not save data: {0}'.format(to_native(err)))
+
+    def verify_file(self, path):
+        """Check the config
+
+        Return true/false if the config-file is valid for this plugin
+
+        Args:
+            str(path): path to the config
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            bool(valid): is valid"""
+        valid = False
+        if super(InventoryModule, self).verify_file(path):
+            if path.endswith(('lxd.yaml', 'lxd.yml')):
+                valid = True
+            else:
+                self.display.vvv('Inventory source not ending in "lxd.yaml" or "lxd.yml"')
+        return valid
+
+    @staticmethod
+    def validate_url(url):
+        """validate url
+
+        check whether the url is correctly formatted
+
+        Args:
+            url
+        Kwargs:
+            None
+        Raises:
+            AnsibleError
+        Returns:
+            bool"""
+        if not isinstance(url, str):
+            return False
+        if not url.startswith(('unix:', 'https:')):
+            raise AnsibleError('URL is malformed: {0}'.format(to_native(url)))
+        return True
+
+    def _connect_to_socket(self):
+        """connect to lxd socket
+
+        Connect to lxd socket by provided url or defaults
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            AnsibleError
+        Returns:
+            None"""
+        error_storage = {}
+        url_list = [self.get_option('url'), self.SNAP_SOCKET_URL, self.SOCKET_URL]
+        urls = (url for url in url_list if self.validate_url(url))
+        for url in urls:
+            try:
+                socket_connection = LXDClient(url, self.client_key, self.client_cert, self.debug)
+                return socket_connection
+            except LXDClientException as err:
+                error_storage[url] = err
+        raise AnsibleError('No connection to the socket: {0}'.format(to_native(error_storage)))
+
+    def _get_networks(self):
+        """Get Networknames
+
+        Returns all network config names
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            list(names): names of all network_configs"""
+        # e.g. {'type': 'sync',
+        #       'status': 'Success',
+        #       'status_code': 200,
+        #       'operation': '',
+        #       'error_code': 0,
+        #       'error': '',
+        #       'metadata': ['/1.0/networks/lxdbr0']}
+        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
+
+        Returns all containernames
+
+        Args:
+            None
+        Kwargs:
+            None
+        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']]
+
+    def _get_config(self, branch, name):
+        """Get inventory of container
+
+        Get config of container
+
+        Args:
+            str(branch): Name oft the API-Branch
+            str(name): Name of Container
+        Kwargs:
+            None
+        Source:
+            https://github.com/lxc/lxd/blob/master/doc/rest-api.md
+        Raises:
+            None
+        Returns:
+            dict(config): Config of the container"""
+        config = {}
+        if isinstance(branch, (tuple, list)):
+            config[name] = {branch[1]: self.socket.do('GET', '/1.0/{0}/{1}/{2}'.format(to_native(branch[0]), to_native(name), to_native(branch[1])))}
+        else:
+            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
+
+        Iterate through the different branches of the containers and collect Informations.
+
+        Args:
+            list(names): List of container names
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+        # tuple(('instances','metadata/templates')) to get section in branch
+        # e.g. /1.0/instances/<name>/metadata/templates
+        branches = ['containers', ('instances', 'state')]
+        container_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)
+
+    def get_network_data(self, names):
+        """Create Inventory of the container
+
+        Iterate through the different branches of the containers and collect Informations.
+
+        Args:
+            list(names): List of container names
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+        # tuple(('instances','metadata/templates')) to get section in branch
+        # e.g. /1.0/instances/<name>/metadata/templates
+        branches = [('networks', 'state')]
+        network_config = {}
+        for branch in branches:
+            for name in names:
+                try:
+                    network_config['networks'] = self._get_config(branch, name)
+                except LXDClientException:
+                    network_config['networks'] = {name: None}
+                self.data = dict_merge(network_config, self.data)
+
+    def extract_network_information_from_container_config(self, container_name):
+        """Returns the network interface configuration
+
+        Returns the network ipv4 and ipv6 config of the container without local-link
+
+        Args:
+            str(container_name): Name oft he container
+        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))
+        network_configuration = None
+        if container_network_interfaces:
+            network_configuration = {}
+            gen_interface_names = [interface_name for interface_name in container_network_interfaces if interface_name != 'lo']
+            for interface_name in gen_interface_names:
+                gen_address = [address for address in container_network_interfaces[interface_name]['addresses'] if address.get('scope') != 'link']
+                network_configuration[interface_name] = []
+                for address in gen_address:
+                    address_set = {}
+                    address_set['family'] = address.get('family')
+                    address_set['address'] = address.get('address')
+                    address_set['netmask'] = address.get('netmask')
+                    address_set['combined'] = address.get('address') + '/' + address.get('netmask')
+                    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
+
+        Helper to get the prefered interface provide by neme pattern from 'prefered_container_network_interface'.
+
+        Args:
+            str(containe_name): name of container
+        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))
+        prefered_interface = None  # init
+        if container_network_interfaces:  # container 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)]
+            selected_interfaces = []  # init
+            for interface in net_generator:
+                selected_interfaces.append(interface)
+            if len(selected_interfaces) > 0:
+                prefered_interface = sorted(selected_interfaces)[0]
+        return prefered_interface
+
+    def get_container_vlans(self, container_name):
+        """Get VLAN(s) from container
+
+        Helper to get the VLAN_ID from the container
+
+        Args:
+            str(containe_name): name of container
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+        # get network device configuration and store {network: vlan_id}
+        network_vlans = {}
+        for network in self._get_data_entry('networks'):
+            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
+        # 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)))
+        for device in devices:
+            if 'network' in devices[device]:
+                if devices[device]['network'] in network_vlans:
+                    vlan_ids[devices[device].get('network')] = network_vlans[devices[device].get('network')]
+        return vlan_ids if vlan_ids else None
+
+    def _get_data_entry(self, path, data=None, delimiter='/'):
+        """Helper to get data
+
+        Helper to get data from self.data by a path like 'path/to/target'
+        Attention: Escaping of the delimiter is not (yet) provided.
+
+        Args:
+            str(path): path to nested dict
+        Kwargs:
+            dict(data): datastore
+            str(delimiter): delimiter in Path.
+        Raises:
+            None
+        Returns:
+            *(value)"""
+        try:
+            if not data:
+                data = self.data
+            if delimiter in path:
+                path = path.split(delimiter)
+
+            if isinstance(path, list) and len(path) > 1:
+                data = data[path.pop(0)]
+                path = delimiter.join(path)
+                return self._get_data_entry(path, data, delimiter)  # recursion
+            return data[path]
+        except KeyError:
+            return None
+
+    def _set_data_entry(self, container_name, key, value, path=None):
+        """Helper to save data
+
+        Helper to save the data in self.data
+        Detect if data is allready in branch and use dict_merge() to prevent that branch is overwritten.
+
+        Args:
+            str(container_name): name of container
+            str(key): same as dict
+            *(value): same as dict
+        Kwargs:
+            str(path): path to branch-part
+        Raises:
+            AnsibleParserError
+        Returns:
+            None"""
+        if not path:
+            path = self.data['inventory']
+        if container_name not in path:
+            path[container_name] = {}
+
+        try:
+            if isinstance(value, dict) and key in path[container_name]:
+                path[container_name] = dict_merge(value, path[container_name][key])
+            else:
+                path[container_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):
+        """Process configuration information
+
+        Preparation of the data
+
+        Args:
+            dict(configs): Container configurations
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+        # create branch "inventory"
+        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))
+
+    def build_inventory_network(self, container_name):
+        """Add the network interfaces of the container 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>'
+
+        Args:
+            str(container_name): name of container
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+
+        def interface_selection(container_name):
+            """Select container Interface for inventory
+
+            Logic:
+                - get preferred_interface & prefered_container_network_family -> str(IP)
+                - first Interface from: network_interfaces prefered_container_network_family -> str(IP)
+
+            Args:
+                str(container_name): name of container
+            Kwargs:
+                None
+            Raises:
+                None
+            Returns:
+                dict(interface_name: ip)"""
+            prefered_interface = self._get_data_entry('inventory/{0}/preferred_interface'.format(container_name))  # name or None
+            prefered_container_network_family = self.prefered_container_network_family
+
+            ip_address = ''
+            if prefered_interface:
+                interface = self._get_data_entry('inventory/{0}/network_interfaces/{1}'.format(container_name, prefered_interface))
+                for config in interface:
+                    if config['family'] == prefered_container_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
+            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))
+        else:
+            self.inventory.set_variable(container_name, 'ansible_connection', 'local')
+
+    def build_inventory_hosts(self):
+        """Build host-part dynamic inventory
+
+        Build the host-part of the dynamic inventory.
+        Add Hosts and host_vars to the inventory.
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+        for container_name in self.data['inventory']:
+            # Only consider containers that match the "state" filter, if self.state is not None
+            if self.filter:
+                if self.filter.lower() != self._get_data_entry('inventory/{0}/state'.format(container_name)).lower():
+                    continue
+            # add container
+            self.inventory.add_host(container_name)
+            # add network informations
+            self.build_inventory_network(container_name)
+            # add os
+            self.inventory.set_variable(container_name, 'ansible_lxd_os', self._get_data_entry('inventory/{0}/os'.format(container_name)).lower())
+            # add release
+            self.inventory.set_variable(container_name, 'ansible_lxd_release', self._get_data_entry('inventory/{0}/release'.format(container_name)).lower())
+            # add profile
+            self.inventory.set_variable(container_name, 'ansible_lxd_profile', self._get_data_entry('inventory/{0}/profile'.format(container_name)))
+            # add state
+            self.inventory.set_variable(container_name, 'ansible_lxd_state', self._get_data_entry('inventory/{0}/state'.format(container_name)).lower())
+            # add location information
+            if self._get_data_entry('inventory/{0}/location'.format(container_name)) != "none":  # wrong type by lxd 'none' != 'None'
+                self.inventory.set_variable(container_name, 'ansible_lxd_location', self._get_data_entry('inventory/{0}/location'.format(container_name)))
+            # add VLAN_ID information
+            if self._get_data_entry('inventory/{0}/vlan_ids'.format(container_name)):
+                self.inventory.set_variable(container_name, 'ansible_lxd_vlan_ids', self._get_data_entry('inventory/{0}/vlan_ids'.format(container_name)))
+
+    def build_inventory_groups_location(self, group_name):
+        """create group by attribute: location
+
+        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)
+
+        for container_name in self.inventory.hosts:
+            if 'ansible_lxd_location' in self.inventory.get_host(container_name).get_vars():
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups_pattern(self, group_name):
+        """create group by name pattern
+
+        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)
+
+        regex_pattern = self.groupby[group_name].get('attribute')
+
+        for container_name in self.inventory.hosts:
+            result = re.search(regex_pattern, container_name)
+            if result:
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups_network_range(self, group_name):
+        """check if IP is in network-class
+
+        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)
+
+        try:
+            network = ipaddress.ip_network(to_text(self.groupby[group_name].get('attribute')))
+        except ValueError as err:
+            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]:
+                        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)
+                        except ValueError:
+                            # Ignore invalid IP addresses returned by lxd
+                            pass
+
+    def build_inventory_groups_os(self, group_name):
+        """create group by attribute: os
+
+        Args:
+            str(group_name): Group name
+        Kwargs:
+            Noneself.data['inventory'][container_name][interface]
+        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_containers = [
+            container_name for container_name in self.inventory.hosts
+            if 'ansible_lxd_os' in self.inventory.get_host(container_name).get_vars()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(container_name).get_vars().get('ansible_lxd_os'):
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups_release(self, group_name):
+        """create group by attribute: release
+
+        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_containers = [
+            container_name for container_name in self.inventory.hosts
+            if 'ansible_lxd_release' in self.inventory.get_host(container_name).get_vars()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() == self.inventory.get_host(container_name).get_vars().get('ansible_lxd_release'):
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups_profile(self, group_name):
+        """create group by attribute: profile
+
+        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_containers = [
+            container_name for container_name in self.inventory.hosts.keys()
+            if 'ansible_lxd_profile' in self.inventory.get_host(container_name).get_vars().keys()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute').lower() in self.inventory.get_host(container_name).get_vars().get('ansible_lxd_profile'):
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups_vlanid(self, group_name):
+        """create group by attribute: vlanid
+
+        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_containers = [
+            container_name for container_name in self.inventory.hosts.keys()
+            if 'ansible_lxd_vlan_ids' in self.inventory.get_host(container_name).get_vars().keys()]
+        for container_name in gen_containers:
+            if self.groupby[group_name].get('attribute') in self.inventory.get_host(container_name).get_vars().get('ansible_lxd_vlan_ids').values():
+                self.inventory.add_child(group_name, container_name)
+
+    def build_inventory_groups(self):
+        """Build group-part dynamic inventory
+
+        Build the group-part of the dynamic inventory.
+        Add groups to the inventory.
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+
+        def group_type(group_name):
+            """create groups defined by lxd.yml or defaultvalues
+
+            create groups defined by lxd.yml or defaultvalues
+            supportetd:
+                * 'location'
+                * 'pattern'
+                * 'network_range'
+                * 'os'
+                * 'release'
+                * 'profile'
+                * 'vlanid'
+
+            Args:
+                str(group_name): Group name
+            Kwargs:
+                None
+            Raises:
+                None
+            Returns:
+                None"""
+
+            # Due to the compatibility with python 2 no use of map
+            if self.groupby[group_name].get('type') == 'location':
+                self.build_inventory_groups_location(group_name)
+            elif self.groupby[group_name].get('type') == 'pattern':
+                self.build_inventory_groups_pattern(group_name)
+            elif self.groupby[group_name].get('type') == 'network_range':
+                self.build_inventory_groups_network_range(group_name)
+            elif self.groupby[group_name].get('type') == 'os':
+                self.build_inventory_groups_os(group_name)
+            elif self.groupby[group_name].get('type') == 'release':
+                self.build_inventory_groups_release(group_name)
+            elif self.groupby[group_name].get('type') == 'profile':
+                self.build_inventory_groups_profile(group_name)
+            elif self.groupby[group_name].get('type') == 'vlanid':
+                self.build_inventory_groups_vlanid(group_name)
+            else:
+                raise AnsibleParserError('Unknown group type: {0}'.format(to_native(group_name)))
+
+        if self.groupby:
+            for group_name in self.groupby:
+                if not group_name.isalnum():
+                    raise AnsibleParserError('Invalid character(s) in groupname: {0}'.format(to_native(group_name)))
+                group_type(group_name)
+
+    def build_inventory(self):
+        """Build dynamic inventory
+
+        Build the dynamic inventory.
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+
+        self.build_inventory_hosts()
+        self.build_inventory_groups()
+
+    def _populate(self):
+        """Return the hosts and groups
+
+        Returns the processed container configurations from the lxd import
+
+        Args:
+            None
+        Kwargs:
+            None
+        Raises:
+            None
+        Returns:
+            None"""
+
+        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_network_data(self._get_networks())
+
+        self.extract_information_from_container_configs()
+
+        # self.display.vvv(self.save_json_data([os.path.abspath(__file__)]))
+
+        self.build_inventory()
+
+    def parse(self, inventory, loader, path, cache):
+        """Return dynamic inventory from source
+
+        Returns the processed inventory from the lxd import
+
+        Args:
+            str(inventory): inventory object with existing data and
+                            the methods to add hosts/groups/variables
+                            to inventory
+            str(loader):    Ansible's DataLoader
+            str(path):      path to the config
+            bool(cache):    use or avoid caches
+        Kwargs:
+            None
+        Raises:
+            AnsibleParserError
+        Returns:
+            None"""
+
+        super(InventoryModule, self).parse(inventory, loader, path, cache=False)
+        # Read the inventory YAML file
+        self._read_config_data(path)
+        try:
+            self.client_key = self.get_option('client_key')
+            self.client_cert = self.get_option('client_cert')
+            self.debug = self.DEBUG
+            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')
+            if self.get_option('state').lower() == 'none':  # none in config is str()
+                self.filter = None
+            else:
+                self.filter = self.get_option('state').lower()
+            self.trust_password = self.get_option('trust_password')
+            self.url = self.get_option('url')
+        except Exception as err:
+            raise AnsibleParserError(
+                'All correct options required: {0}'.format(to_native(err)))
+        # Call our internal helper to populate the dynamic inventory
+        self._populate()

plugins/inventory/nmap.py

@@ -130,7 +130,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                 # This occurs if the cache_key is not in the cache or if the cache_key expired, so the cache needs to be updated
                 cache_needs_update = True
 
-        if not user_cache_setting or cache_needs_update:
+        if cache_needs_update:
             # setup command
             cmd = [self._nmap]
             if not self._options['ports']:
@@ -207,7 +207,6 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
             except Exception as e:
                 raise AnsibleParserError("failed to parse %s: %s " % (to_native(path), to_native(e)))
 
-        if cache_needs_update:
             self._cache[cache_key] = results
 
         self._populate(results)

plugins/inventory/proxmox.py

@@ -70,6 +70,13 @@ DOCUMENTATION = '''
         description: Gather LXC/QEMU configuration facts.
         default: no
         type: bool
+      want_proxmox_nodes_ansible_host:
+        version_added: 3.0.0
+        description:
+          - Whether to set C(ansbile_host) for proxmox nodes.
+          - When set to C(true) (default), will use the first available interface. This can be different from what you expect.
+        default: true
+        type: bool
       strict:
         version_added: 2.5.0
       compose:
@@ -234,13 +241,22 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                 )
             )['result']
 
+            if "error" in ifaces:
+                if "class" in ifaces["error"]:
+                    # This happens on Windows, even though qemu agent is running, the IP address
+                    # cannot be fetched, as it's unsupported, also a command disabled can happen.
+                    errorClass = ifaces["error"]["class"]
+                    if errorClass in ["Unsupported"]:
+                        self.display.v("Retrieving network interfaces from guest agents on windows with older qemu-guest-agents is not supported")
+                    elif errorClass in ["CommandDisabled"]:
+                        self.display.v("Retrieving network interfaces from guest agents has been disabled")
+                return result
+
             for iface in ifaces:
                 result.append({
                     'name': iface['name'],
-                    'mac-address': iface['hardware-address'],
-                    'ip-addresses': [
-                        "%s/%s" % (ip['ip-address'], ip['prefix']) for ip in iface['ip-addresses']
-                    ]
+                    'mac-address': iface['hardware-address'] if 'hardware-address' in iface else '',
+                    'ip-addresses': ["%s/%s" % (ip['ip-address'], ip['prefix']) for ip in iface['ip-addresses']] if 'ip-addresses' in iface else []
                 })
         except requests.HTTPError:
             pass
@@ -353,12 +369,10 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                 if node['type'] == 'node':
                     self.inventory.add_child(nodes_group, node['node'])
 
-                if node['status'] == 'offline':
-                    continue
-
                 # get node IP address
-                ip = self._get_node_ip(node['node'])
-                self.inventory.set_variable(node['node'], 'ansible_host', ip)
+                if self.get_option("want_proxmox_nodes_ansible_host"):
+                    ip = self._get_node_ip(node['node'])
+                    self.inventory.set_variable(node['node'], 'ansible_host', ip)
 
                 # get LXC containers for this node
                 node_lxc_group = self.to_safe('%s%s' % (self.get_option('group_prefix'), ('%s_lxc' % node['node']).lower()))
@@ -386,7 +400,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                 node_qemu_group = self.to_safe('%s%s' % (self.get_option('group_prefix'), ('%s_qemu' % node['node']).lower()))
                 self.inventory.add_group(node_qemu_group)
                 for qemu in self._get_qemu_per_node(node['node']):
-                    if qemu.get('template'):
+                    if qemu['template']:
                         continue
 
                     self.inventory.add_host(qemu['name'])

plugins/inventory/scaleway.py

@@ -1,24 +1,24 @@
-# Copyright: (c) 2017 Ansible Project
+# Copyright (c) 2017 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 = r'''
+DOCUMENTATION = '''
     name: scaleway
     author:
       - Remy Leone (@sieben)
     short_description: Scaleway inventory source
     description:
-        - Get inventory hosts from Scaleway.
+        - Get inventory hosts from Scaleway
     options:
         plugin:
-            description: Token that ensures this is a source file for the 'scaleway' plugin.
+            description: token that ensures this is a source file for the 'scaleway' plugin.
             required: True
             choices: ['scaleway', 'community.general.scaleway']
         regions:
-            description: Filter results on a specific Scaleway region.
+            description: Filter results on a specific Scaleway region
             type: list
             default:
                 - ams1
@@ -26,13 +26,11 @@ DOCUMENTATION = r'''
                 - par2
                 - waw1
         tags:
-            description: Filter results on a specific tag.
+            description: Filter results on a specific tag
             type: list
         oauth_token:
             required: True
-            description:
-            - Scaleway OAuth token.
-            - More details on L(how to generate token, https://www.scaleway.com/en/docs/generate-api-keys/).
+            description: Scaleway OAuth token.
             env:
                 # in order of precedence
                 - name: SCW_TOKEN
@@ -50,14 +48,14 @@ DOCUMENTATION = r'''
                 - hostname
                 - id
         variables:
-            description: 'Set individual variables: keys are variable names and
+            description: 'set individual variables: keys are variable names and
                           values are templates. Any value returned by the
                           L(Scaleway API, https://developer.scaleway.com/#servers-server-get)
                           can be used.'
             type: dict
 '''
 
-EXAMPLES = r'''
+EXAMPLES = '''
 # scaleway_inventory.yml file in YAML format
 # Example command line: ansible-inventory --list -i scaleway_inventory.yml
 
@@ -83,15 +81,6 @@ regions:
   - par1
 variables:
   ansible_host: public_ip.address
-
-# Using static strings as variables
-plugin: community.general.scaleway
-hostnames:
-  - hostname
-variables:
-  ansible_host: public_ip.address
-  ansible_connection: "'ssh'"
-  ansible_user: "'admin'"
 '''
 
 import json
@@ -100,7 +89,7 @@ from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, parse_pagination_link
 from ansible.module_utils.urls import open_url
-from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils._text import to_native
 
 import ansible.module_utils.six.moves.urllib.parse as urllib_parse
 
@@ -116,7 +105,7 @@ def _fetch_information(token, url):
         except Exception as e:
             raise AnsibleError("Error while fetching %s: %s" % (url, to_native(e)))
         try:
-            raw_json = json.loads(to_text(response.read()))
+            raw_json = json.loads(response.read())
         except ValueError:
             raise AnsibleError("Incorrect JSON payload")
 
@@ -241,7 +230,8 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
 
         if not matching_tags:
             return set()
-        return matching_tags.union((server_zone,))
+        else:
+            return matching_tags.union((server_zone,))
 
     def _filter_host(self, host_infos, hostname_preferences):
 

plugins/inventory/stackpath_compute.py

@@ -10,8 +10,6 @@ DOCUMENTATION = '''
     name: stackpath_compute
     short_description: StackPath Edge Computing inventory source
     version_added: 1.2.0
-    author:
-        - UNKNOWN (@shayrybak)
     extends_documentation_fragment:
         - inventory_cache
         - constructed
@@ -104,13 +102,13 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
             raise AnsibleError("plugin doesn't match this plugin")
         try:
             client_id = config['client_id']
-            if len(client_id) != 32:
+            if client_id != 32:
                 raise AnsibleError("client_id must be 32 characters long")
         except KeyError:
             raise AnsibleError("config missing client_id, a required option")
         try:
             client_secret = config['client_secret']
-            if len(client_secret) != 64:
+            if client_secret != 64:
                 raise AnsibleError("client_secret must be 64 characters long")
         except KeyError:
             raise AnsibleError("config missing client_id, a required option")

plugins/lookup/consul_kv.py

@@ -171,10 +171,10 @@ class LookupModule(LookupBase):
 
         paramvals = {
             'key': params[0],
-            'token': self.get_option('token'),
-            'recurse': self.get_option('recurse'),
-            'index': self.get_option('index'),
-            'datacenter': self.get_option('datacenter')
+            'token': None,
+            'recurse': False,
+            'index': None,
+            'datacenter': None
         }
 
         # parameters specified?

plugins/lookup/tss.py

@@ -103,26 +103,17 @@ EXAMPLES = r"""
                 | items2dict(key_name='slug',
                              value_name='itemValue'))['password']
             }}
-
-- hosts: localhost
-  vars:
-      secret_password: >-
-        {{ ((lookup('community.general.tss', 1) | from_json).get('items') | items2dict(key_name='slug', value_name='itemValue'))['password'] }}"
-  tasks:
-      - ansible.builtin.debug:
-          msg: the password is {{ secret_password }}
 """
-from distutils.version import LooseVersion
+
 from ansible.errors import AnsibleError, AnsibleOptionsError
 
 sdk_is_missing = False
 
 try:
-    from thycotic import __version__ as sdk_version
     from thycotic.secrets.server import (
         SecretServer,
+        SecretServerAccessError,
         SecretServerError,
-        PasswordGrantAuthorizer,
     )
 except ImportError:
     sdk_is_missing = True
@@ -137,20 +128,7 @@ display = Display()
 class LookupModule(LookupBase):
     @staticmethod
     def Client(server_parameters):
-
-        if LooseVersion(sdk_version) < LooseVersion('1.0.0'):
-            return SecretServer(**server_parameters)
-        else:
-            authorizer = PasswordGrantAuthorizer(
-                server_parameters["base_url"],
-                server_parameters["username"],
-                server_parameters["password"],
-                server_parameters["token_path_uri"],
-            )
-
-            return SecretServer(
-                server_parameters["base_url"], authorizer, server_parameters["api_path_uri"]
-            )
+        return SecretServer(**server_parameters)
 
     def run(self, terms, variables, **kwargs):
         if sdk_is_missing:

plugins/module_utils/_mount.py

@@ -48,10 +48,6 @@
 # agrees to be bound by the terms and conditions of this License
 # Agreement.
 
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
-
 import os
 
 

plugins/module_utils/_ovirt.py

@@ -1,871 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (c) 2016 Red Hat, Inc.
-#
-# 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
-
-import inspect
-import os
-import time
-
-from abc import ABCMeta, abstractmethod
-from datetime import datetime
-from distutils.version import LooseVersion
-
-from ansible_collections.community.general.plugins.module_utils.cloud import CloudRetry
-from ansible.module_utils.common._collections_compat import Mapping
-
-try:
-    from enum import Enum  # enum is a ovirtsdk4 requirement
-    import ovirtsdk4 as sdk
-    import ovirtsdk4.version as sdk_version
-    import ovirtsdk4.types as otypes
-    HAS_SDK = LooseVersion(sdk_version.VERSION) >= LooseVersion('4.3.0')
-except ImportError:
-    HAS_SDK = False
-
-
-BYTES_MAP = {
-    'kib': 2**10,
-    'mib': 2**20,
-    'gib': 2**30,
-    'tib': 2**40,
-    'pib': 2**50,
-}
-
-
-def check_sdk(module):
-    if not HAS_SDK:
-        module.fail_json(
-            msg='ovirtsdk4 version 4.3.0 or higher is required for this module'
-        )
-
-
-def get_dict_of_struct(struct, connection=None, fetch_nested=False, attributes=None):
-    """
-    Convert SDK Struct type into dictionary.
-    """
-    res = {}
-
-    def resolve_href(value):
-        # Fetch nested values of struct:
-        try:
-            value = connection.follow_link(value)
-        except sdk.Error:
-            value = None
-        nested_obj = dict(
-            (attr, convert_value(getattr(value, attr)))
-            for attr in attributes if getattr(value, attr, None) is not None
-        )
-        nested_obj['id'] = getattr(value, 'id', None)
-        nested_obj['href'] = getattr(value, 'href', None)
-        return nested_obj
-
-    def remove_underscore(val):
-        if val.startswith('_'):
-            val = val[1:]
-            remove_underscore(val)
-        return val
-
-    def convert_value(value):
-        nested = False
-
-        if isinstance(value, sdk.Struct):
-            if not fetch_nested or not value.href:
-                return get_dict_of_struct(value)
-            return resolve_href(value)
-
-        elif isinstance(value, Enum) or isinstance(value, datetime):
-            return str(value)
-        elif isinstance(value, list) or isinstance(value, sdk.List):
-            if isinstance(value, sdk.List) and fetch_nested and value.href:
-                try:
-                    value = connection.follow_link(value)
-                    nested = True
-                except sdk.Error:
-                    value = []
-
-            ret = []
-            for i in value:
-                if isinstance(i, sdk.Struct):
-                    if not nested and fetch_nested and i.href:
-                        ret.append(resolve_href(i))
-                    elif not nested:
-                        ret.append(get_dict_of_struct(i))
-                    else:
-                        nested_obj = dict(
-                            (attr, convert_value(getattr(i, attr)))
-                            for attr in attributes if getattr(i, attr, None)
-                        )
-                        nested_obj['id'] = getattr(i, 'id', None)
-                        ret.append(nested_obj)
-                elif isinstance(i, Enum):
-                    ret.append(str(i))
-                else:
-                    ret.append(i)
-            return ret
-        else:
-            return value
-
-    if struct is not None:
-        for key, value in struct.__dict__.items():
-            if value is None:
-                continue
-
-            key = remove_underscore(key)
-            res[key] = convert_value(value)
-
-    return res
-
-
-def engine_version(connection):
-    """
-    Return string representation of oVirt engine version.
-    """
-    engine_api = connection.system_service().get()
-    engine_version = engine_api.product_info.version
-    return '%s.%s' % (engine_version.major, engine_version.minor)
-
-
-def create_connection(auth):
-    """
-    Create a connection to Python SDK, from task `auth` parameter.
-    If user doesnt't have SSO token the `auth` dictionary has following parameters mandatory:
-     url, username, password
-
-    If user has SSO token the `auth` dictionary has following parameters mandatory:
-     url, token
-
-    The `ca_file` parameter is mandatory in case user want to use secure connection,
-    in case user want to use insecure connection, it's mandatory to send insecure=True.
-
-    :param auth: dictionary which contains needed values for connection creation
-    :return: Python SDK connection
-    """
-
-    url = auth.get('url')
-    if url is None and auth.get('hostname') is not None:
-        url = 'https://{0}/ovirt-engine/api'.format(auth.get('hostname'))
-
-    return sdk.Connection(
-        url=url,
-        username=auth.get('username'),
-        password=auth.get('password'),
-        ca_file=auth.get('ca_file', None),
-        insecure=auth.get('insecure', False),
-        token=auth.get('token', None),
-        kerberos=auth.get('kerberos', None),
-        headers=auth.get('headers', None),
-    )
-
-
-def convert_to_bytes(param):
-    """
-    This method convert units to bytes, which follow IEC standard.
-
-    :param param: value to be converted
-    """
-    if param is None:
-        return None
-
-    # Get rid of whitespaces:
-    param = ''.join(param.split())
-
-    # Convert to bytes:
-    if len(param) > 3 and param[-3].lower() in ['k', 'm', 'g', 't', 'p']:
-        return int(param[:-3]) * BYTES_MAP.get(param[-3:].lower(), 1)
-    elif param.isdigit():
-        return int(param) * 2**10
-    else:
-        raise ValueError(
-            "Unsupported value(IEC supported): '{value}'".format(value=param)
-        )
-
-
-def follow_link(connection, link):
-    """
-    This method returns the entity of the element which link points to.
-
-    :param connection: connection to the Python SDK
-    :param link: link of the entity
-    :return: entity which link points to
-    """
-
-    if link:
-        return connection.follow_link(link)
-    else:
-        return None
-
-
-def get_link_name(connection, link):
-    """
-    This method returns the name of the element which link points to.
-
-    :param connection: connection to the Python SDK
-    :param link: link of the entity
-    :return: name of the entity, which link points to
-    """
-
-    if link:
-        return connection.follow_link(link).name
-    else:
-        return None
-
-
-def equal(param1, param2, ignore_case=False):
-    """
-    Compare two parameters and return if they are equal.
-    This parameter doesn't run equal operation if first parameter is None.
-    With this approach we don't run equal operation in case user don't
-    specify parameter in their task.
-
-    :param param1: user inputted parameter
-    :param param2: value of entity parameter
-    :return: True if parameters are equal or first parameter is None, otherwise False
-    """
-    if param1 is not None:
-        if ignore_case:
-            return param1.lower() == param2.lower()
-        return param1 == param2
-    return True
-
-
-def search_by_attributes(service, list_params=None, **kwargs):
-    """
-    Search for the entity by attributes. Nested entities don't support search
-    via REST, so in case using search for nested entity we return all entities
-    and filter them by specified attributes.
-    """
-    list_params = list_params or {}
-    # Check if 'list' method support search(look for search parameter):
-    if 'search' in inspect.getargspec(service.list)[0]:
-        res = service.list(
-            # There must be double quotes around name, because some oVirt resources it's possible to create then with space in name.
-            search=' and '.join('{0}="{1}"'.format(k, v) for k, v in kwargs.items()),
-            **list_params
-        )
-    else:
-        res = [
-            e for e in service.list(**list_params) if len([
-                k for k, v in kwargs.items() if getattr(e, k, None) == v
-            ]) == len(kwargs)
-        ]
-
-    res = res or [None]
-    return res[0]
-
-
-def search_by_name(service, name, **kwargs):
-    """
-    Search for the entity by its name. Nested entities don't support search
-    via REST, so in case using search for nested entity we return all entities
-    and filter them by name.
-
-    :param service: service of the entity
-    :param name: name of the entity
-    :return: Entity object returned by Python SDK
-    """
-    # Check if 'list' method support search(look for search parameter):
-    if 'search' in inspect.getargspec(service.list)[0]:
-        res = service.list(
-            # There must be double quotes around name, because some oVirt resources it's possible to create then with space in name.
-            search='name="{name}"'.format(name=name)
-        )
-    else:
-        res = [e for e in service.list() if e.name == name]
-
-    if kwargs:
-        res = [
-            e for e in service.list() if len([
-                k for k, v in kwargs.items() if getattr(e, k, None) == v
-            ]) == len(kwargs)
-        ]
-
-    res = res or [None]
-    return res[0]
-
-
-def get_entity(service, get_params=None):
-    """
-    Ignore SDK Error in case of getting an entity from service.
-    """
-    entity = None
-    try:
-        if get_params is not None:
-            entity = service.get(**get_params)
-        else:
-            entity = service.get()
-    except sdk.Error:
-        # We can get here 404, we should ignore it, in case
-        # of removing entity for example.
-        pass
-    return entity
-
-
-def get_id_by_name(service, name, raise_error=True, ignore_case=False):
-    """
-    Search an entity ID by it's name.
-    """
-    entity = search_by_name(service, name)
-
-    if entity is not None:
-        return entity.id
-
-    if raise_error:
-        raise Exception("Entity '%s' was not found." % name)
-
-
-def wait(
-    service,
-    condition,
-    fail_condition=lambda e: False,
-    timeout=180,
-    wait=True,
-    poll_interval=3,
-):
-    """
-    Wait until entity fulfill expected condition.
-
-    :param service: service of the entity
-    :param condition: condition to be fulfilled
-    :param fail_condition: if this condition is true, raise Exception
-    :param timeout: max time to wait in seconds
-    :param wait: if True wait for condition, if False don't wait
-    :param poll_interval: Number of seconds we should wait until next condition check
-    """
-    # Wait until the desired state of the entity:
-    if wait:
-        start = time.time()
-        while time.time() < start + timeout:
-            # Exit if the condition of entity is valid:
-            entity = get_entity(service)
-            if condition(entity):
-                return
-            elif fail_condition(entity):
-                raise Exception("Error while waiting on result state of the entity.")
-
-            # Sleep for `poll_interval` seconds if none of the conditions apply:
-            time.sleep(float(poll_interval))
-
-        raise Exception("Timeout exceed while waiting on result state of the entity.")
-
-
-def __get_auth_dict():
-    OVIRT_URL = os.environ.get('OVIRT_URL')
-    OVIRT_HOSTNAME = os.environ.get('OVIRT_HOSTNAME')
-    OVIRT_USERNAME = os.environ.get('OVIRT_USERNAME')
-    OVIRT_PASSWORD = os.environ.get('OVIRT_PASSWORD')
-    OVIRT_TOKEN = os.environ.get('OVIRT_TOKEN')
-    OVIRT_CAFILE = os.environ.get('OVIRT_CAFILE')
-    OVIRT_INSECURE = OVIRT_CAFILE is None
-
-    env_vars = None
-    if OVIRT_URL is None and OVIRT_HOSTNAME is not None:
-        OVIRT_URL = 'https://{0}/ovirt-engine/api'.format(OVIRT_HOSTNAME)
-    if OVIRT_URL and ((OVIRT_USERNAME and OVIRT_PASSWORD) or OVIRT_TOKEN):
-        env_vars = {
-            'url': OVIRT_URL,
-            'username': OVIRT_USERNAME,
-            'password': OVIRT_PASSWORD,
-            'insecure': OVIRT_INSECURE,
-            'token': OVIRT_TOKEN,
-            'ca_file': OVIRT_CAFILE,
-        }
-    if env_vars is not None:
-        auth = dict(default=env_vars, type='dict')
-    else:
-        auth = dict(required=True, type='dict')
-
-    return auth
-
-
-def ovirt_info_full_argument_spec(**kwargs):
-    """
-    Extend parameters of info module with parameters which are common to all
-    oVirt info modules.
-
-    :param kwargs: kwargs to be extended
-    :return: extended dictionary with common parameters
-    """
-    spec = dict(
-        auth=__get_auth_dict(),
-        fetch_nested=dict(default=False, type='bool'),
-        nested_attributes=dict(type='list', default=list()),
-    )
-    spec.update(kwargs)
-    return spec
-
-
-# Left for third-party module compatibility
-def ovirt_facts_full_argument_spec(**kwargs):
-    """
-    This is deprecated. Please use ovirt_info_full_argument_spec instead!
-
-    :param kwargs: kwargs to be extended
-    :return: extended dictionary with common parameters
-    """
-    return ovirt_info_full_argument_spec(**kwargs)
-
-
-def ovirt_full_argument_spec(**kwargs):
-    """
-    Extend parameters of module with parameters which are common to all oVirt modules.
-
-    :param kwargs: kwargs to be extended
-    :return: extended dictionary with common parameters
-    """
-    spec = dict(
-        auth=__get_auth_dict(),
-        timeout=dict(default=180, type='int'),
-        wait=dict(default=True, type='bool'),
-        poll_interval=dict(default=3, type='int'),
-        fetch_nested=dict(default=False, type='bool'),
-        nested_attributes=dict(type='list', default=list()),
-    )
-    spec.update(kwargs)
-    return spec
-
-
-def check_params(module):
-    """
-    Most modules must have either `name` or `id` specified.
-    """
-    if module.params.get('name') is None and module.params.get('id') is None:
-        module.fail_json(msg='"name" or "id" is required')
-
-
-def engine_supported(connection, version):
-    return LooseVersion(engine_version(connection)) >= LooseVersion(version)
-
-
-def check_support(version, connection, module, params):
-    """
-    Check if parameters used by user are supported by oVirt Python SDK
-    and oVirt engine.
-    """
-    api_version = LooseVersion(engine_version(connection))
-    version = LooseVersion(version)
-    for param in params:
-        if module.params.get(param) is not None:
-            return LooseVersion(sdk_version.VERSION) >= version and api_version >= version
-
-    return True
-
-
-class BaseModule(object):
-    """
-    This is base class for oVirt modules. oVirt modules should inherit this
-    class and override method to customize specific needs of the module.
-    The only abstract method of this class is `build_entity`, which must
-    to be implemented in child class.
-    """
-    __metaclass__ = ABCMeta
-
-    def __init__(self, connection, module, service, changed=False):
-        self._connection = connection
-        self._module = module
-        self._service = service
-        self._changed = changed
-        self._diff = {'after': dict(), 'before': dict()}
-
-    @property
-    def changed(self):
-        return self._changed
-
-    @changed.setter
-    def changed(self, changed):
-        if not self._changed:
-            self._changed = changed
-
-    @abstractmethod
-    def build_entity(self):
-        """
-        This method should return oVirt Python SDK type, which we want to
-        create or update, initialized by values passed by Ansible module.
-
-        For example if we want to create VM, we will return following:
-          types.Vm(name=self._module.params['vm_name'])
-
-        :return: Specific instance of sdk.Struct.
-        """
-        pass
-
-    def param(self, name, default=None):
-        """
-        Return a module parameter specified by it's name.
-        """
-        return self._module.params.get(name, default)
-
-    def update_check(self, entity):
-        """
-        This method handle checks whether the entity values are same as values
-        passed to ansible module. By default we don't compare any values.
-
-        :param entity: Entity we want to compare with Ansible module values.
-        :return: True if values are same, so we don't need to update the entity.
-        """
-        return True
-
-    def pre_create(self, entity):
-        """
-        This method is called right before entity is created.
-
-        :param entity: Entity to be created or updated.
-        """
-        pass
-
-    def post_create(self, entity):
-        """
-        This method is called right after entity is created.
-
-        :param entity: Entity which was created.
-        """
-        pass
-
-    def post_update(self, entity):
-        """
-        This method is called right after entity is updated.
-
-        :param entity: Entity which was updated.
-        """
-        pass
-
-    def diff_update(self, after, update):
-        for k, v in update.items():
-            if isinstance(v, Mapping):
-                after[k] = self.diff_update(after.get(k, dict()), v)
-            else:
-                after[k] = update[k]
-        return after
-
-    def create(
-        self,
-        entity=None,
-        result_state=None,
-        fail_condition=lambda e: False,
-        search_params=None,
-        update_params=None,
-        _wait=None,
-        force_create=False,
-        **kwargs
-    ):
-        """
-        Method which is called when state of the entity is 'present'. If user
-        don't provide `entity` parameter the entity is searched using
-        `search_params` parameter. If entity is found it's updated, whether
-        the entity should be updated is checked by `update_check` method.
-        The corresponding updated entity is build by `build_entity` method.
-
-        Function executed after entity is created can optionally be specified
-        in `post_create` parameter. Function executed after entity is updated
-        can optionally be specified in `post_update` parameter.
-
-        :param entity: Entity we want to update, if exists.
-        :param result_state: State which should entity has in order to finish task.
-        :param fail_condition: Function which checks incorrect state of entity, if it returns `True` Exception is raised.
-        :param search_params: Dictionary of parameters to be used for search.
-        :param update_params: The params which should be passed to update method.
-        :param kwargs: Additional parameters passed when creating entity.
-        :return: Dictionary with values returned by Ansible module.
-        """
-        if entity is None and not force_create:
-            entity = self.search_entity(search_params)
-
-        self.pre_create(entity)
-
-        if entity:
-            # Entity exists, so update it:
-            entity_service = self._service.service(entity.id)
-            if not self.update_check(entity):
-                new_entity = self.build_entity()
-                if not self._module.check_mode:
-                    update_params = update_params or {}
-                    updated_entity = entity_service.update(
-                        new_entity,
-                        **update_params
-                    )
-                    self.post_update(entity)
-
-                # Update diffs only if user specified --diff parameter,
-                # so we don't useless overload API:
-                if self._module._diff:
-                    before = get_dict_of_struct(
-                        entity,
-                        self._connection,
-                        fetch_nested=True,
-                        attributes=['name'],
-                    )
-                    after = before.copy()
-                    self.diff_update(after, get_dict_of_struct(new_entity))
-                    self._diff['before'] = before
-                    self._diff['after'] = after
-
-                self.changed = True
-        else:
-            # Entity don't exists, so create it:
-            if not self._module.check_mode:
-                entity = self._service.add(
-                    self.build_entity(),
-                    **kwargs
-                )
-                self.post_create(entity)
-            self.changed = True
-
-        if not self._module.check_mode:
-            # Wait for the entity to be created and to be in the defined state:
-            entity_service = self._service.service(entity.id)
-
-            def state_condition(entity):
-                return entity
-
-            if result_state:
-
-                def state_condition(entity):
-                    return entity and entity.status == result_state
-
-            wait(
-                service=entity_service,
-                condition=state_condition,
-                fail_condition=fail_condition,
-                wait=_wait if _wait is not None else self._module.params['wait'],
-                timeout=self._module.params['timeout'],
-                poll_interval=self._module.params['poll_interval'],
-            )
-
-        return {
-            'changed': self.changed,
-            'id': getattr(entity, 'id', None),
-            type(entity).__name__.lower(): get_dict_of_struct(
-                struct=entity,
-                connection=self._connection,
-                fetch_nested=self._module.params.get('fetch_nested'),
-                attributes=self._module.params.get('nested_attributes'),
-            ),
-            'diff': self._diff,
-        }
-
-    def pre_remove(self, entity):
-        """
-        This method is called right before entity is removed.
-
-        :param entity: Entity which we want to remove.
-        """
-        pass
-
-    def entity_name(self, entity):
-        return "{e_type} '{e_name}'".format(
-            e_type=type(entity).__name__.lower(),
-            e_name=getattr(entity, 'name', None),
-        )
-
-    def remove(self, entity=None, search_params=None, **kwargs):
-        """
-        Method which is called when state of the entity is 'absent'. If user
-        don't provide `entity` parameter the entity is searched using
-        `search_params` parameter. If entity is found it's removed.
-
-        Function executed before remove is executed can optionally be specified
-        in `pre_remove` parameter.
-
-        :param entity: Entity we want to remove.
-        :param search_params: Dictionary of parameters to be used for search.
-        :param kwargs: Additional parameters passed when removing entity.
-        :return: Dictionary with values returned by Ansible module.
-        """
-        if entity is None:
-            entity = self.search_entity(search_params)
-
-        if entity is None:
-            return {
-                'changed': self.changed,
-                'msg': "Entity wasn't found."
-            }
-
-        self.pre_remove(entity)
-
-        entity_service = self._service.service(entity.id)
-        if not self._module.check_mode:
-            entity_service.remove(**kwargs)
-            wait(
-                service=entity_service,
-                condition=lambda entity: not entity,
-                wait=self._module.params['wait'],
-                timeout=self._module.params['timeout'],
-                poll_interval=self._module.params['poll_interval'],
-            )
-        self.changed = True
-
-        return {
-            'changed': self.changed,
-            'id': entity.id,
-            type(entity).__name__.lower(): get_dict_of_struct(
-                struct=entity,
-                connection=self._connection,
-                fetch_nested=self._module.params.get('fetch_nested'),
-                attributes=self._module.params.get('nested_attributes'),
-            ),
-        }
-
-    def action(
-        self,
-        action,
-        entity=None,
-        action_condition=lambda e: e,
-        wait_condition=lambda e: e,
-        fail_condition=lambda e: False,
-        pre_action=lambda e: e,
-        post_action=lambda e: None,
-        search_params=None,
-        **kwargs
-    ):
-        """
-        This method is executed when we want to change the state of some oVirt
-        entity. The action to be executed on oVirt service is specified by
-        `action` parameter. Whether the action should be executed can be
-        specified by passing `action_condition` parameter. State which the
-        entity should be in after execution of the action can be specified
-        by `wait_condition` parameter.
-
-        Function executed before an action on entity can optionally be specified
-        in `pre_action` parameter. Function executed after an action on entity can
-        optionally be specified in `post_action` parameter.
-
-        :param action: Action which should be executed by service on entity.
-        :param entity: Entity we want to run action on.
-        :param action_condition: Function which is executed when checking if action should be executed.
-        :param fail_condition: Function which checks incorrect state of entity, if it returns `True` Exception is raised.
-        :param wait_condition: Function which is executed when waiting on result state.
-        :param pre_action: Function which is executed before running the action.
-        :param post_action: Function which is executed after running the action.
-        :param search_params: Dictionary of parameters to be used for search.
-        :param kwargs: Additional parameters passed to action.
-        :return: Dictionary with values returned by Ansible module.
-        """
-        if entity is None:
-            entity = self.search_entity(search_params)
-
-        entity = pre_action(entity)
-
-        if entity is None:
-            self._module.fail_json(
-                msg="Entity not found, can't run action '{0}'.".format(
-                    action
-                )
-            )
-
-        entity_service = self._service.service(entity.id)
-        entity = entity_service.get()
-        if action_condition(entity):
-            if not self._module.check_mode:
-                getattr(entity_service, action)(**kwargs)
-            self.changed = True
-
-        post_action(entity)
-
-        wait(
-            service=self._service.service(entity.id),
-            condition=wait_condition,
-            fail_condition=fail_condition,
-            wait=self._module.params['wait'],
-            timeout=self._module.params['timeout'],
-            poll_interval=self._module.params['poll_interval'],
-        )
-        return {
-            'changed': self.changed,
-            'id': entity.id,
-            type(entity).__name__.lower(): get_dict_of_struct(
-                struct=entity,
-                connection=self._connection,
-                fetch_nested=self._module.params.get('fetch_nested'),
-                attributes=self._module.params.get('nested_attributes'),
-            ),
-            'diff': self._diff,
-        }
-
-    def wait_for_import(self, condition=lambda e: True):
-        if self._module.params['wait']:
-            start = time.time()
-            timeout = self._module.params['timeout']
-            poll_interval = self._module.params['poll_interval']
-            while time.time() < start + timeout:
-                entity = self.search_entity()
-                if entity and condition(entity):
-                    return entity
-                time.sleep(poll_interval)
-
-    def search_entity(self, search_params=None, list_params=None):
-        """
-        Always first try to search by `ID`, if ID isn't specified,
-        check if user constructed special search in `search_params`,
-        if not search by `name`.
-        """
-        entity = None
-
-        if 'id' in self._module.params and self._module.params['id'] is not None:
-            entity = get_entity(self._service.service(self._module.params['id']), get_params=list_params)
-        elif search_params is not None:
-            entity = search_by_attributes(self._service, list_params=list_params, **search_params)
-        elif self._module.params.get('name') is not None:
-            entity = search_by_attributes(self._service, list_params=list_params, name=self._module.params['name'])
-
-        return entity
-
-    def _get_major(self, full_version):
-        if full_version is None or full_version == "":
-            return None
-        if isinstance(full_version, otypes.Version):
-            return int(full_version.major)
-        return int(full_version.split('.')[0])
-
-    def _get_minor(self, full_version):
-        if full_version is None or full_version == "":
-            return None
-        if isinstance(full_version, otypes.Version):
-            return int(full_version.minor)
-        return int(full_version.split('.')[1])
-
-
-def _sdk4_error_maybe():
-    """
-    Allow for ovirtsdk4 not being installed.
-    """
-    if HAS_SDK:
-        return sdk.Error
-    return type(None)
-
-
-class OvirtRetry(CloudRetry):
-    base_class = _sdk4_error_maybe()
-
-    @staticmethod
-    def status_code_from_exception(error):
-        return error.code
-
-    @staticmethod
-    def found(response_code, catch_extra_error_codes=None):
-        # This is a list of error codes to retry.
-        retry_on = [
-            # HTTP status: Conflict
-            409,
-        ]
-        if catch_extra_error_codes:
-            retry_on.extend(catch_extra_error_codes)
-
-        return response_code in retry_on

plugins/module_utils/identity/keycloak/keycloak.py

@@ -30,12 +30,16 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 import json
+import traceback
 
 from ansible.module_utils.urls import open_url
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.six.moves.urllib.error import HTTPError
 from ansible.module_utils._text import to_native
 
+URL_REALMS = "{url}/admin/realms"
+URL_REALM = "{url}/admin/realms/{realm}"
+
 URL_TOKEN = "{url}/realms/{realm}/protocol/openid-connect/token"
 URL_CLIENT = "{url}/admin/realms/{realm}/clients/{id}"
 URL_CLIENTS = "{url}/admin/realms/{realm}/clients"
@@ -57,11 +61,12 @@ def keycloak_argument_spec():
     return dict(
         auth_keycloak_url=dict(type='str', aliases=['url'], required=True, no_log=False),
         auth_client_id=dict(type='str', default='admin-cli'),
-        auth_realm=dict(type='str', required=True),
+        auth_realm=dict(type='str'),
         auth_client_secret=dict(type='str', default=None, no_log=True),
-        auth_username=dict(type='str', aliases=['username'], required=True),
-        auth_password=dict(type='str', aliases=['password'], required=True, no_log=True),
-        validate_certs=dict(type='bool', default=True)
+        auth_username=dict(type='str', aliases=['username']),
+        auth_password=dict(type='str', aliases=['password'], no_log=True),
+        validate_certs=dict(type='bool', default=True),
+        token=dict(type='str', no_log=True),
     )
 
 
@@ -73,41 +78,58 @@ class KeycloakError(Exception):
     pass
 
 
-def get_token(base_url, validate_certs, auth_realm, client_id,
-              auth_username, auth_password, client_secret):
+def get_token(module_params):
+    """ Obtains connection header with token for the authentication,
+        token already given or obtained from credentials
+        :param module_params: parameters of the module
+        :return: connection header
+    """
+    token = module_params.get('token')
+    base_url = module_params.get('auth_keycloak_url')
+
     if not base_url.lower().startswith(('http', 'https')):
         raise KeycloakError("auth_url '%s' should either start with 'http' or 'https'." % base_url)
-    auth_url = URL_TOKEN.format(url=base_url, realm=auth_realm)
-    temp_payload = {
-        'grant_type': 'password',
-        'client_id': client_id,
-        'client_secret': client_secret,
-        'username': auth_username,
-        'password': auth_password,
-    }
-    # Remove empty items, for instance missing client_secret
-    payload = dict(
-        (k, v) for k, v in temp_payload.items() if v is not None)
-    try:
-        r = json.loads(to_native(open_url(auth_url, method='POST',
-                                          validate_certs=validate_certs,
-                                          data=urlencode(payload)).read()))
-    except ValueError as e:
-        raise KeycloakError(
-            'API returned invalid JSON when trying to obtain access token from %s: %s'
-            % (auth_url, str(e)))
-    except Exception as e:
-        raise KeycloakError('Could not obtain access token from %s: %s'
-                            % (auth_url, str(e)))
 
-    try:
-        return {
-            'Authorization': 'Bearer ' + r['access_token'],
-            'Content-Type': 'application/json'
+    if token is None:
+        base_url = module_params.get('auth_keycloak_url')
+        validate_certs = module_params.get('validate_certs')
+        auth_realm = module_params.get('auth_realm')
+        client_id = module_params.get('auth_client_id')
+        auth_username = module_params.get('auth_username')
+        auth_password = module_params.get('auth_password')
+        client_secret = module_params.get('auth_client_secret')
+        auth_url = URL_TOKEN.format(url=base_url, realm=auth_realm)
+        temp_payload = {
+            'grant_type': 'password',
+            'client_id': client_id,
+            'client_secret': client_secret,
+            'username': auth_username,
+            'password': auth_password,
         }
-    except KeyError:
-        raise KeycloakError(
-            'Could not obtain access token from %s' % auth_url)
+        # Remove empty items, for instance missing client_secret
+        payload = dict(
+            (k, v) for k, v in temp_payload.items() if v is not None)
+        try:
+            r = json.loads(to_native(open_url(auth_url, method='POST',
+                                              validate_certs=validate_certs,
+                                              data=urlencode(payload)).read()))
+        except ValueError as e:
+            raise KeycloakError(
+                'API returned invalid JSON when trying to obtain access token from %s: %s'
+                % (auth_url, str(e)))
+        except Exception as e:
+            raise KeycloakError('Could not obtain access token from %s: %s'
+                                % (auth_url, str(e)))
+
+        try:
+            token = r['access_token']
+        except KeyError:
+            raise KeycloakError(
+                'Could not obtain access token from %s' % auth_url)
+    return {
+        'Authorization': 'Bearer ' + token,
+        'Content-Type': 'application/json'
+    }
 
 
 class KeycloakAPI(object):
@@ -120,6 +142,75 @@ class KeycloakAPI(object):
         self.validate_certs = self.module.params.get('validate_certs')
         self.restheaders = connection_header
 
+    def get_realm_by_id(self, realm='master'):
+        """ Obtain realm representation by id
+
+        :param realm: realm id
+        :return: dict of real, representation or None if none matching exist
+        """
+        realm_url = URL_REALM.format(url=self.baseurl, realm=realm)
+
+        try:
+            return json.loads(to_native(open_url(realm_url, method='GET', headers=self.restheaders,
+                                                 validate_certs=self.validate_certs).read()))
+
+        except HTTPError as e:
+            if e.code == 404:
+                return None
+            else:
+                self.module.fail_json(msg='Could not obtain realm %s: %s' % (realm, str(e)),
+                                      exception=traceback.format_exc())
+        except ValueError as e:
+            self.module.fail_json(msg='API returned incorrect JSON when trying to obtain realm %s: %s' % (realm, str(e)),
+                                  exception=traceback.format_exc())
+        except Exception as e:
+            self.module.fail_json(msg='Could not obtain realm %s: %s' % (realm, str(e)),
+                                  exception=traceback.format_exc())
+
+    def update_realm(self, realmrep, realm="master"):
+        """ Update an existing realm
+        :param realmrep: corresponding (partial/full) realm representation with updates
+        :param realm: realm to be updated in Keycloak
+        :return: HTTPResponse object on success
+        """
+        realm_url = URL_REALM.format(url=self.baseurl, realm=realm)
+
+        try:
+            return open_url(realm_url, method='PUT', headers=self.restheaders,
+                            data=json.dumps(realmrep), validate_certs=self.validate_certs)
+        except Exception as e:
+            self.module.fail_json(msg='Could not update realm %s: %s' % (realm, str(e)),
+                                  exception=traceback.format_exc())
+
+    def create_realm(self, realmrep):
+        """ Create a realm in keycloak
+        :param realmrep: Realm representation of realm to be created.
+        :return: HTTPResponse object on success
+        """
+        realm_url = URL_REALMS.format(url=self.baseurl)
+
+        try:
+            return open_url(realm_url, method='POST', headers=self.restheaders,
+                            data=json.dumps(realmrep), validate_certs=self.validate_certs)
+        except Exception as e:
+            self.module.fail_json(msg='Could not create realm %s: %s' % (realmrep['id'], str(e)),
+                                  exception=traceback.format_exc())
+
+    def delete_realm(self, realm="master"):
+        """ Delete a realm from Keycloak
+
+        :param realm: realm to be deleted
+        :return: HTTPResponse object on success
+        """
+        realm_url = URL_REALM.format(url=self.baseurl, realm=realm)
+
+        try:
+            return open_url(realm_url, method='DELETE', headers=self.restheaders,
+                            validate_certs=self.validate_certs)
+        except Exception as e:
+            self.module.fail_json(msg='Could not delete realm %s: %s' % (realm, str(e)),
+                                  exception=traceback.format_exc())
+
     def get_clients(self, realm='master', filter=None):
         """ Obtains client representations for clients in a realm
 

plugins/module_utils/module_helper.py

@@ -487,16 +487,13 @@ class CmdMixin(object):
     def run_command(self, extra_params=None, params=None, *args, **kwargs):
         self.vars.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)
         env_update = dict(options.get('environ_update', {}))
+        options['check_rc'] = options.get('check_rc', self.check_rc)
         if self.force_lang:
-            env_update.update({
-                'LANGUAGE': self.force_lang,
-                'LC_ALL': self.force_lang,
-            })
+            env_update.update({'LANGUAGE': self.force_lang})
             self.update_output(force_lang=self.force_lang)
             options['environ_update'] = env_update
+        options.update(kwargs)
         rc, out, err = self.module.run_command(self.vars.cmd_args, *args, **options)
         self.update_output(rc=rc, stdout=out, stderr=err)
         return self.process_command_output(rc, out, err)

plugins/module_utils/oneview.py

@@ -201,7 +201,7 @@ class OneViewModuleBase(object):
 
     resource_client = None
 
-    def __init__(self, additional_arg_spec=None, validate_etag_support=False, supports_check_mode=False):
+    def __init__(self, additional_arg_spec=None, validate_etag_support=False):
         """
         OneViewModuleBase constructor.
 
@@ -210,7 +210,7 @@ class OneViewModuleBase(object):
         """
         argument_spec = self._build_argument_spec(additional_arg_spec, validate_etag_support)
 
-        self.module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=supports_check_mode)
+        self.module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
         self._check_hpe_oneview_sdk()
         self._create_oneview_client()

plugins/module_utils/redfish_utils.py

@@ -19,11 +19,10 @@ PATCH_HEADERS = {'content-type': 'application/json', 'accept': 'application/json
                  'OData-Version': '4.0'}
 DELETE_HEADERS = {'accept': 'application/json', 'OData-Version': '4.0'}
 
-DEPRECATE_MSG = 'Issuing a data modification command without specifying the '\
-                'ID of the target %(resource)s resource when there is more '\
-                'than one %(resource)s will use the first one in the '\
-                'collection. Use the `resource_id` option to specify the '\
-                'target %(resource)s ID'
+FAIL_MSG = 'Issuing a data modification command without specifying the '\
+           'ID of the target %(resource)s resource when there is more '\
+           'than one %(resource)s is no longer allowed. Use the `resource_id` '\
+           'option to specify the target %(resource)s ID.'
 
 
 class RedfishUtils(object):
@@ -267,8 +266,7 @@ class RedfishUtils(object):
                         'ret': False,
                         'msg': "System resource %s not found" % self.resource_id}
             elif len(self.systems_uris) > 1:
-                self.module.deprecate(DEPRECATE_MSG % {'resource': 'System'},
-                                      version='3.0.0', collection_name='community.general')  # was Ansible 2.14
+                self.module.fail_json(msg=FAIL_MSG % {'resource': 'System'})
         return {'ret': True}
 
     def _find_updateservice_resource(self):
@@ -318,8 +316,7 @@ class RedfishUtils(object):
                         'ret': False,
                         'msg': "Chassis resource %s not found" % self.resource_id}
             elif len(self.chassis_uris) > 1:
-                self.module.deprecate(DEPRECATE_MSG % {'resource': 'Chassis'},
-                                      version='3.0.0', collection_name='community.general')  # was Ansible 2.14
+                self.module.fail_json(msg=FAIL_MSG % {'resource': 'Chassis'})
         return {'ret': True}
 
     def _find_managers_resource(self):
@@ -348,8 +345,7 @@ class RedfishUtils(object):
                         'ret': False,
                         'msg': "Manager resource %s not found" % self.resource_id}
             elif len(self.manager_uris) > 1:
-                self.module.deprecate(DEPRECATE_MSG % {'resource': 'Manager'},
-                                      version='3.0.0', collection_name='community.general')  # was Ansible 2.14
+                self.module.fail_json(msg=FAIL_MSG % {'resource': 'Manager'})
         return {'ret': True}
 
     def _get_all_action_info_values(self, action):
@@ -1586,14 +1582,13 @@ class RedfishUtils(object):
 
         boot = data[key]
 
-        if override_enabled != 'Disabled':
-            annotation = 'BootSourceOverrideTarget@Redfish.AllowableValues'
-            if annotation in boot:
-                allowable_values = boot[annotation]
-                if isinstance(allowable_values, list) and bootdevice not in allowable_values:
-                    return {'ret': False,
-                            'msg': "Boot device %s not in list of allowable values (%s)" %
-                                   (bootdevice, allowable_values)}
+        annotation = 'BootSourceOverrideTarget@Redfish.AllowableValues'
+        if annotation in boot:
+            allowable_values = boot[annotation]
+            if isinstance(allowable_values, list) and bootdevice not in allowable_values:
+                return {'ret': False,
+                        'msg': "Boot device %s not in list of allowable values (%s)" %
+                               (bootdevice, allowable_values)}
 
         # read existing values
         cur_enabled = boot.get('BootSourceOverrideEnabled')

plugins/module_utils/remote_management/dellemc/dellemc_idrac.py

@@ -1,56 +0,0 @@
-# -*- coding: utf-8 -*-
-
-#
-# Dell EMC OpenManage Ansible Modules
-# Version 1.0
-# Copyright (C) 2018 Dell Inc.
-
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
-# Other trademarks may be trademarks of their respective owners.
-#
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-try:
-    from omsdk.sdkinfra import sdkinfra
-    from omsdk.sdkcreds import UserCredentials
-    from omsdk.sdkfile import FileOnShare, file_share_manager
-    from omsdk.sdkprotopref import ProtoPreference, ProtocolEnum
-    from omsdk.http.sdkwsmanbase import WsManOptions
-    HAS_OMSDK = True
-except ImportError:
-    HAS_OMSDK = False
-
-
-class iDRACConnection:
-
-    def __init__(self, module_params):
-        if not HAS_OMSDK:
-            raise ImportError("Dell EMC OMSDK library is required for this module")
-        self.idrac_ip = module_params['idrac_ip']
-        self.idrac_user = module_params['idrac_user']
-        self.idrac_pwd = module_params['idrac_password']
-        self.idrac_port = module_params['idrac_port']
-        if not all((self.idrac_ip, self.idrac_user, self.idrac_pwd)):
-            raise ValueError("hostname, username and password required")
-        self.handle = None
-        self.creds = UserCredentials(self.idrac_user, self.idrac_pwd)
-        self.pOp = WsManOptions(port=self.idrac_port)
-        self.sdk = sdkinfra()
-        if self.sdk is None:
-            msg = "Could not initialize iDRAC drivers."
-            raise RuntimeError(msg)
-
-    def __enter__(self):
-        self.sdk.importPath()
-        self.handle = self.sdk.get_driver(self.sdk.driver_enum.iDRAC, self.idrac_ip, self.creds, pOptions=self.pOp)
-        if self.handle is None:
-            msg = "Could not find device driver for iDRAC with IP Address: {0}".format(self.idrac_ip)
-            raise RuntimeError(msg)
-        return self.handle
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.handle.disconnect()
-        return False

plugins/module_utils/remote_management/dellemc/ome.py

@@ -1,163 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Dell EMC OpenManage Ansible Modules
-# Version 1.3
-# Copyright (C) 2019 Dell Inc. or its subsidiaries. All Rights Reserved.
-#
-# 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 json
-from ansible.module_utils.urls import open_url, ConnectionError, SSLValidationError
-from ansible.module_utils.six.moves.urllib.error import URLError, HTTPError
-from ansible.module_utils.six.moves.urllib.parse import urlencode
-
-SESSION_RESOURCE_COLLECTION = {
-    "SESSION": "SessionService/Sessions",
-    "SESSION_ID": "SessionService/Sessions('{Id}')",
-}
-
-
-class OpenURLResponse(object):
-    """Handles HTTPResponse"""
-
-    def __init__(self, resp):
-        self.body = None
-        self.resp = resp
-        if self.resp:
-            self.body = self.resp.read()
-
-    @property
-    def json_data(self):
-        try:
-            return json.loads(self.body)
-        except ValueError:
-            raise ValueError("Unable to parse json")
-
-    @property
-    def status_code(self):
-        return self.resp.getcode()
-
-    @property
-    def success(self):
-        return self.status_code in (200, 201, 202, 204)
-
-    @property
-    def token_header(self):
-        return self.resp.headers.get('X-Auth-Token')
-
-
-class RestOME(object):
-    """Handles OME API requests"""
-
-    def __init__(self, module_params=None, req_session=False):
-        self.module_params = module_params
-        self.hostname = self.module_params["hostname"]
-        self.username = self.module_params["username"]
-        self.password = self.module_params["password"]
-        self.port = self.module_params["port"]
-        self.req_session = req_session
-        self.session_id = None
-        self.protocol = 'https'
-        self._headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
-
-    def _get_base_url(self):
-        """builds base url"""
-        return '{0}://{1}:{2}/api'.format(self.protocol, self.hostname, self.port)
-
-    def _build_url(self, path, query_param=None):
-        """builds complete url"""
-        url = path
-        base_uri = self._get_base_url()
-        if path:
-            url = '{0}/{1}'.format(base_uri, path)
-        if query_param:
-            url += "?{0}".format(urlencode(query_param))
-        return url
-
-    def _url_common_args_spec(self, method, api_timeout, headers=None):
-        """Creates an argument common spec"""
-        req_header = self._headers
-        if headers:
-            req_header.update(headers)
-        url_kwargs = {
-            "method": method,
-            "validate_certs": False,
-            "use_proxy": True,
-            "headers": req_header,
-            "timeout": api_timeout,
-            "follow_redirects": 'all',
-        }
-        return url_kwargs
-
-    def _args_without_session(self, method, api_timeout=30, headers=None):
-        """Creates an argument spec in case of basic authentication"""
-        req_header = self._headers
-        if headers:
-            req_header.update(headers)
-        url_kwargs = self._url_common_args_spec(method, api_timeout, headers=headers)
-        url_kwargs["url_username"] = self.username
-        url_kwargs["url_password"] = self.password
-        url_kwargs["force_basic_auth"] = True
-        return url_kwargs
-
-    def _args_with_session(self, method, api_timeout=30, headers=None):
-        """Creates an argument spec, in case of authentication with session"""
-        url_kwargs = self._url_common_args_spec(method, api_timeout, headers=headers)
-        url_kwargs["force_basic_auth"] = False
-        return url_kwargs
-
-    def invoke_request(self, method, path, data=None, query_param=None, headers=None,
-                       api_timeout=30, dump=True):
-        """
-        Sends a request via open_url
-        Returns :class:`OpenURLResponse` object.
-        :arg method: HTTP verb to use for the request
-        :arg path: path to request without query parameter
-        :arg data: (optional) Payload to send with the request
-        :arg query_param: (optional) Dictionary of query parameter to send with request
-        :arg headers: (optional) Dictionary of HTTP Headers to send with the
-            request
-        :arg api_timeout: (optional) How long to wait for the server to send
-            data before giving up
-        :arg dump: (Optional) boolean value for dumping payload data.
-        :returns: OpenURLResponse
-        """
-        try:
-            if 'X-Auth-Token' in self._headers:
-                url_kwargs = self._args_with_session(method, api_timeout, headers=headers)
-            else:
-                url_kwargs = self._args_without_session(method, api_timeout, headers=headers)
-            if data and dump:
-                data = json.dumps(data)
-            url = self._build_url(path, query_param=query_param)
-            resp = open_url(url, data=data, **url_kwargs)
-            resp_data = OpenURLResponse(resp)
-        except (HTTPError, URLError, SSLValidationError, ConnectionError) as err:
-            raise err
-        return resp_data
-
-    def __enter__(self):
-        """Creates sessions by passing it to header"""
-        if self.req_session:
-            payload = {'UserName': self.username,
-                       'Password': self.password,
-                       'SessionType': 'API', }
-            path = SESSION_RESOURCE_COLLECTION["SESSION"]
-            resp = self.invoke_request('POST', path, data=payload)
-            if resp and resp.success:
-                self.session_id = resp.json_data.get("Id")
-                self._headers["X-Auth-Token"] = resp.token_header
-            else:
-                msg = "Could not create the session"
-                raise ConnectionError(msg)
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        """Deletes a session id, which is in use for request"""
-        if self.session_id:
-            path = SESSION_RESOURCE_COLLECTION["SESSION_ID"].format(Id=self.session_id)
-            self.invoke_request('DELETE', path)
-        return False