Release 3.6.0.

Note: tastychutney is another github account of mine that was also added as a maintainer.
(cherry picked from commit 135faf4421)

Co-authored-by: Scott Anderson <scott@waymark.com>

.azure-pipelines/azure-pipelines.yml

@@ -68,19 +68,6 @@ stages:
             - test: 3
             - test: 4
             - test: extra
-  - stage: Sanity_2_12
-    displayName: Sanity 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Test {0}
-          testFormat: 2.12/sanity/{0}
-          targets:
-            - test: 1
-            - test: 2
-            - test: 3
-            - test: 4
   - stage: Sanity_2_11
     displayName: Sanity 2.11
     dependsOn: []
@@ -129,22 +116,6 @@ stages:
         parameters:
           nameFormat: Python {0}
           testFormat: devel/units/{0}/1
-          targets:
-            - test: 2.7
-            - test: 3.5
-            - test: 3.6
-            - test: 3.7
-            - test: 3.8
-            - test: 3.9
-            - test: '3.10'
-  - stage: Units_2_12
-    displayName: Units 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.12/units/{0}/1
           targets:
             - test: 2.6
             - test: 2.7
@@ -152,6 +123,7 @@ stages:
             - test: 3.6
             - test: 3.7
             - test: 3.8
+            - test: 3.9
             - test: '3.10'
   - stage: Units_2_11
     displayName: Units 2.11
@@ -178,8 +150,13 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.10/units/{0}/1
           targets:
+            - test: 2.6
             - test: 2.7
+            - test: 3.5
             - test: 3.6
+            - test: 3.7
+            - test: 3.8
+            - test: 3.9
   - stage: Units_2_9
     displayName: Units 2.9
     dependsOn: []
@@ -219,23 +196,6 @@ stages:
             - 1
             - 2
             - 3
-  - stage: Remote_2_12
-    displayName: Remote 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.12/{0}
-          targets:
-            - name: macOS 11.1
-              test: macos/11.1
-            - name: RHEL 8.4
-              test: rhel/8.4
-            - name: FreeBSD 13.0
-              test: freebsd/13.0
-          groups:
-            - 1
-            - 2
   - stage: Remote_2_11
     displayName: Remote 2.11
     dependsOn: []
@@ -244,6 +204,8 @@ stages:
         parameters:
           testFormat: 2.11/{0}
           targets:
+            - name: macOS 11.1
+              test: macos/11.1
             - name: RHEL 7.9
               test: rhel/7.9
             - name: RHEL 8.3
@@ -265,6 +227,14 @@ stages:
               test: osx/10.11
             - name: macOS 10.15
               test: macos/10.15
+            - name: macOS 11.1
+              test: macos/11.1
+            - name: RHEL 7.8
+              test: rhel/7.8
+            - name: RHEL 8.2
+              test: rhel/8.2
+            - name: FreeBSD 12.1
+              test: freebsd/12.1
           groups:
             - 1
             - 2
@@ -278,8 +248,6 @@ stages:
           targets:
             - name: RHEL 8.2
               test: rhel/8.2
-            - name: RHEL 7.8
-              test: rhel/7.8
             - name: FreeBSD 12.0
               test: freebsd/12.0
           groups:
@@ -295,12 +263,16 @@ stages:
         parameters:
           testFormat: devel/linux/{0}
           targets:
+            - name: CentOS 6
+              test: centos6
             - name: CentOS 7
               test: centos7
+            - name: CentOS 8
+              test: centos8
+            - name: Fedora 33
+              test: fedora33
             - name: Fedora 34
               test: fedora34
-            - name: Fedora 35
-              test: fedora35
             - name: openSUSE 15 py2
               test: opensuse15py2
             - name: openSUSE 15 py3
@@ -313,28 +285,6 @@ stages:
             - 1
             - 2
             - 3
-  - stage: Docker_2_12
-    displayName: Docker 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          testFormat: 2.12/linux/{0}
-          targets:
-            - name: CentOS 6
-              test: centos6
-            - name: CentOS 8
-              test: centos8
-            - name: Fedora 34
-              test: fedora34
-            - name: openSUSE 15 py3
-              test: opensuse15
-            - name: Ubuntu 20.04
-              test: ubuntu2004
-          groups:
-            - 1
-            - 2
-            - 3
   - stage: Docker_2_11
     displayName: Docker 2.11
     dependsOn: []
@@ -343,12 +293,14 @@ stages:
         parameters:
           testFormat: 2.11/linux/{0}
           targets:
-            - name: CentOS 7
-              test: centos7
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 33
               test: fedora33
-            - name: openSUSE 15 py2
-              test: opensuse15py2
+            - name: openSUSE 15 py3
+              test: opensuse15
+            - name: Ubuntu 20.04
+              test: ubuntu2004
           groups:
             - 2
             - 3
@@ -360,8 +312,12 @@ stages:
         parameters:
           testFormat: 2.10/linux/{0}
           targets:
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 32
               test: fedora32
+            - name: openSUSE 15 py3
+              test: opensuse15
             - name: Ubuntu 16.04
               test: ubuntu1604
           groups:
@@ -375,6 +331,8 @@ stages:
         parameters:
           testFormat: 2.9/linux/{0}
           targets:
+            - name: CentOS 8
+              test: centos8
             - name: Fedora 31
               test: fedora31
             - name: openSUSE 15 py3
@@ -392,17 +350,6 @@ stages:
         parameters:
           nameFormat: Python {0}
           testFormat: devel/cloud/{0}/1
-          targets:
-            - test: 2.7
-            - test: 3.9
-  - stage: Cloud_2_12
-    displayName: Cloud 2.12
-    dependsOn: []
-    jobs:
-      - template: templates/matrix.yml
-        parameters:
-          nameFormat: Python {0}
-          testFormat: 2.12/cloud/{0}/1
           targets:
             - test: 3.8
   - stage: Cloud_2_11
@@ -414,6 +361,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.11/cloud/{0}/1
           targets:
+            - test: 2.7
             - test: 3.6
   - stage: Cloud_2_10
     displayName: Cloud 2.10
@@ -424,7 +372,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.10/cloud/{0}/1
           targets:
-            - test: 3.5
+            - test: 3.6
   - stage: Cloud_2_9
     displayName: Cloud 2.9
     dependsOn: []
@@ -434,7 +382,7 @@ stages:
           nameFormat: Python {0}
           testFormat: 2.9/cloud/{0}/1
           targets:
-            - test: 2.7
+            - test: 3.6
   - stage: Summary
     condition: succeededOrFailed()
     dependsOn:
@@ -442,26 +390,21 @@ stages:
       - Sanity_2_9
       - Sanity_2_10
       - Sanity_2_11
-      - Sanity_2_12
       - Units_devel
       - Units_2_9
       - Units_2_10
       - Units_2_11
-      - Units_2_12
       - Remote_devel
       - Remote_2_9
       - Remote_2_10
       - Remote_2_11
-      - Remote_2_12
       - Docker_devel
       - Docker_2_9
       - Docker_2_10
       - Docker_2_11
-      - Docker_2_12
       - Cloud_devel
       - Cloud_2_9
       - Cloud_2_10
       - Cloud_2_11
-      - Cloud_2_12
     jobs:
       - template: templates/coverage.yml

.azure-pipelines/scripts/aggregate-coverage.sh

@@ -11,7 +11,7 @@ mkdir "${agent_temp_directory}/coverage/"
 
 options=(--venv --venv-system-site-packages --color -v)
 
-ansible-test coverage combine --group-by command --export "${agent_temp_directory}/coverage/" "${options[@]}"
+ansible-test coverage combine --export "${agent_temp_directory}/coverage/" "${options[@]}"
 
 if ansible-test coverage analyze targets generate --help >/dev/null 2>&1; then
     # Only analyze coverage if the installed version of ansible-test supports it.

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

@@ -1,101 +0,0 @@
-#!/usr/bin/env python
-"""
-Upload code coverage reports to codecov.io.
-Multiple coverage files from multiple languages are accepted and aggregated after upload.
-Python coverage, as well as PowerShell and Python stubs can all be uploaded.
-"""
-
-import argparse
-import dataclasses
-import pathlib
-import shutil
-import subprocess
-import tempfile
-import typing as t
-import urllib.request
-
-
-@dataclasses.dataclass(frozen=True)
-class CoverageFile:
-    name: str
-    path: pathlib.Path
-    flags: t.List[str]
-
-
-@dataclasses.dataclass(frozen=True)
-class Args:
-    dry_run: bool
-    path: pathlib.Path
-
-
-def parse_args() -> Args:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-n', '--dry-run', action='store_true')
-    parser.add_argument('path', type=pathlib.Path)
-
-    args = parser.parse_args()
-
-    # Store arguments in a typed dataclass
-    fields = dataclasses.fields(Args)
-    kwargs = {field.name: getattr(args, field.name) for field in fields}
-
-    return Args(**kwargs)
-
-
-def process_files(directory: pathlib.Path) -> t.Tuple[CoverageFile, ...]:
-    processed = []
-    for file in directory.joinpath('reports').glob('coverage*.xml'):
-        name = file.stem.replace('coverage=', '')
-
-        # Get flags from name
-        flags = name.replace('-powershell', '').split('=')  # Drop '-powershell' suffix
-        flags = [flag if not flag.startswith('stub') else flag.split('-')[0] for flag in flags]  # Remove "-01" from stub files
-
-        processed.append(CoverageFile(name, file, flags))
-
-    return tuple(processed)
-
-
-def upload_files(codecov_bin: pathlib.Path, files: t.Tuple[CoverageFile, ...], dry_run: bool = False) -> None:
-    for file in files:
-        cmd = [
-            str(codecov_bin),
-            '--name', file.name,
-            '--file', str(file.path),
-        ]
-        for flag in file.flags:
-            cmd.extend(['--flags', flag])
-
-        if dry_run:
-            print(f'DRY-RUN: Would run command: {cmd}')
-            continue
-
-        subprocess.run(cmd, check=True)
-
-
-def download_file(url: str, dest: pathlib.Path, flags: int, dry_run: bool = False) -> None:
-    if dry_run:
-        print(f'DRY-RUN: Would download {url} to {dest} and set mode to {flags:o}')
-        return
-
-    with urllib.request.urlopen(url) as resp:
-        with dest.open('w+b') as f:
-            # Read data in chunks rather than all at once
-            shutil.copyfileobj(resp, f, 64 * 1024)
-
-    dest.chmod(flags)
-
-
-def main():
-    args = parse_args()
-    url = 'https://ansible-ci-files.s3.amazonaws.com/codecov/linux/codecov'
-    with tempfile.TemporaryDirectory(prefix='codecov-') as tmpdir:
-        codecov_bin = pathlib.Path(tmpdir) / 'codecov'
-        download_file(url, codecov_bin, 0o755, args.dry_run)
-
-        files = process_files(args.path)
-        upload_files(codecov_bin, files, args.dry_run)
-
-
-if __name__ == '__main__':
-    main()

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

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# Upload code coverage reports to codecov.io.
+# Multiple coverage files from multiple languages are accepted and aggregated after upload.
+# Python coverage, as well as PowerShell and Python stubs can all be uploaded.
+
+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
+
+for file in "${output_path}"/reports/coverage*.xml; do
+    name="${file}"
+    name="${name##*/}"  # remove path
+    name="${name##coverage=}"  # remove 'coverage=' prefix if present
+    name="${name%.xml}"  # remove '.xml' suffix
+
+    bash codecov.sh \
+        -f "${file}" \
+        -n "${name}" \
+        -X coveragepy \
+        -X gcov \
+        -X fix \
+        -X search \
+        -X xcode \
+        || echo "Failed to upload code coverage report to codecov.io: ${file}"
+done

.azure-pipelines/scripts/report-coverage.sh

@@ -12,4 +12,4 @@ if ! ansible-test --help >/dev/null 2>&1; then
     pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check
 fi
 
-ansible-test coverage xml --group-by command --stub --venv --venv-system-site-packages --color -v
+ansible-test coverage xml --stub --venv --venv-system-site-packages --color -v

.azure-pipelines/templates/coverage.yml

@@ -33,7 +33,7 @@ jobs:
           summaryFileLocation: "$(outputPath)/reports/$(pipelinesCoverage).xml"
         displayName: Publish to Azure Pipelines
         condition: gt(variables.coverageFileCount, 0)
-      - bash: .azure-pipelines/scripts/publish-codecov.py "$(outputPath)"
+      - bash: .azure-pipelines/scripts/publish-codecov.sh "$(outputPath)"
         displayName: Publish to codecov.io
         condition: gt(variables.coverageFileCount, 0)
         continueOnError: true

.github/BOTMETA.yml

@@ -1,8 +1,7 @@
-notifications: true
 automerge: true
 files:
   plugins/:
-    supershipit: quidame
+    supershipit: quidame Ajpantuso
   changelogs/: {}
   changelogs/fragments/:
     support: community
@@ -49,9 +48,6 @@ files:
     maintainers: dagwieers
   $callbacks/diy.py:
     maintainers: theque5t
-  $callbacks/elastic.py:
-    maintainers: v1v
-    keywords: apm observability
   $callbacks/hipchat.py: {}
   $callbacks/jabber.py: {}
   $callbacks/loganalytics.py:
@@ -66,9 +62,6 @@ files:
   $callbacks/nrdp.py:
     maintainers: rverchere
   $callbacks/null.py: {}
-  $callbacks/opentelemetry.py:
-    maintainers: v1v
-    keywords: opentelemetry observability
   $callbacks/say.py:
     notify: chris-short
     maintainers: $team_macos
@@ -138,8 +131,6 @@ files:
   $filters/random_mac.py: {}
   $filters/time.py:
     maintainers: resmo
-  $filters/unicode_normalize.py:
-    maintainers: Ajpantuso
   $filters/version_sort.py:
     maintainers: ericzolf
   $inventories/:
@@ -157,14 +148,8 @@ files:
   $inventories/nmap.py: {}
   $inventories/online.py:
     maintainers: sieben
-  $inventories/opennebula.py:
-    maintainers: feldsam
-    labels: cloud opennebula
-    keywords: opennebula dynamic inventory script
   $inventories/proxmox.py:
     maintainers: $team_virt ilijamt
-  $inventories/icinga2.py:
-    maintainers: bongoeadgc6
   $inventories/scaleway.py:
     maintainers: $team_scaleway
     labels: cloud scaleway
@@ -175,8 +160,6 @@ files:
     labels: lookups
   $lookups/cartesian.py: {}
   $lookups/chef_databag.py: {}
-  $lookups/collection_version.py:
-    maintainers: felixfontein
   $lookups/consul_kv.py: {}
   $lookups/credstash.py: {}
   $lookups/cyberarkpassword.py:
@@ -190,7 +173,7 @@ files:
   $lookups/dnstxt.py:
     maintainers: jpmens
   $lookups/dsv.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus
   $lookups/etcd3.py:
     maintainers: eric-belhomme
   $lookups/etcd.py:
@@ -207,6 +190,9 @@ files:
   $lookups/manifold.py:
     maintainers: galanoff
     labels: manifold
+  $lookups/nios:
+    maintainers: $team_networking sganesh-infoblox
+    labels: infoblox networking
   $lookups/onepass:
     maintainers: samdoran
     labels: onepassword
@@ -219,13 +205,11 @@ files:
     maintainers: Akasurde
   $lookups/random_string.py:
     maintainers: Akasurde
-  $lookups/random_words.py:
-    maintainers: konstruktoid
   $lookups/redis.py:
     maintainers: $team_ansible_core jpmens
   $lookups/shelvefile.py: {}
   $lookups/tss.py:
-    maintainers: amigus endlesstrax
+    maintainers: amigus
   $module_utils/:
     labels: module_utils
   $module_utils/gitlab.py:
@@ -254,6 +238,9 @@ files:
   $module_utils/module_helper.py:
     maintainers: russoz
     labels: module_helper
+  $module_utils/net_tools/nios/api.py:
+    maintainers: $team_networking sganesh-infoblox
+    labels: infoblox networking
   $module_utils/oracle/oci_utils.py:
     maintainers: $team_oracle
     labels: cloud
@@ -471,20 +458,11 @@ files:
     maintainers: slok
   $modules/database/misc/redis_info.py:
     maintainers: levonet
-  $modules/database/misc/redis_data_info.py:
-    maintainers: paginabianca
-  $modules/database/misc/redis_data.py:
-    maintainers: paginabianca
-  $modules/database/misc/redis_data_incr.py:
-    maintainers: paginabianca
   $modules/database/misc/riak.py:
     maintainers: drewkerrigan jsmartin
   $modules/database/mssql/mssql_db.py:
     maintainers: vedit Jmainguy kenichi-ogawa-1988
     labels: mssql_db
-  $modules/database/mssql/mssql_script.py:
-    maintainers: kbudde
-    labels: mssql_script
   $modules/database/saphana/hana_query.py:
     maintainers: rainerleber
   $modules/database/vertica/:
@@ -534,8 +512,6 @@ files:
     maintainers: kris2kris
   $modules/identity/keycloak/keycloak_role.py:
     maintainers: laurpaum
-  $modules/identity/keycloak/keycloak_user_federation.py:
-    maintainers: laurpaum
   $modules/identity/onepassword_info.py:
     maintainers: Rylon
   $modules/identity/opendj/opendj_backendprop.py:
@@ -650,6 +626,31 @@ files:
     maintainers: amasolov nerzhul
   $modules/net_tools/pritunl/:
     maintainers: Lowess
+  $modules/net_tools/nios/:
+    maintainers: $team_networking
+    labels: infoblox networking
+  $modules/net_tools/nios/nios_a_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_aaaa_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_cname_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_fixed_address.py:
+    maintainers: sjaiswal
+  $modules/net_tools/nios/nios_member.py:
+    maintainers: krisvasudevan
+  $modules/net_tools/nios/nios_mx_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_naptr_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_nsgroup.py:
+    maintainers: ebirn sjaiswal
+  $modules/net_tools/nios/nios_ptr_record.py:
+    maintainers: clementtrebuchet
+  $modules/net_tools/nios/nios_srv_record.py:
+    maintainers: brampling
+  $modules/net_tools/nios/nios_txt_record.py:
+    maintainers: coreywan
   $modules/net_tools/nmcli.py:
     maintainers: alcamie101
   $modules/net_tools/snmp_facts.py:
@@ -739,8 +740,6 @@ files:
     ignore: jle64
   $modules/packaging/language/pip_package_info.py:
     maintainers: bcoca matburt maxamillion
-  $modules/packaging/language/pipx.py:
-    maintainers: russoz
   $modules/packaging/language/yarn.py:
     maintainers: chrishoffman verkaufer
   $modules/packaging/os/apk.py:
@@ -753,8 +752,6 @@ files:
     maintainers: evgkrsk
   $modules/packaging/os/copr.py:
     maintainers: schlupov
-  $modules/packaging/os/dnf_versionlock.py:
-    maintainers: moreda
   $modules/packaging/os/flatpak.py:
     maintainers: $team_flatpak
   $modules/packaging/os/flatpak_remote.py:
@@ -851,9 +848,6 @@ files:
   $modules/packaging/os/snap.py:
     maintainers: angristan vcarceler
     labels: snap
-  $modules/packaging/os/snap_alias.py:
-    maintainers: russoz
-    labels: snap
   $modules/packaging/os/sorcery.py:
     maintainers: vaygr
   $modules/packaging/os/svr4pkg.py:
@@ -1146,10 +1140,6 @@ files:
     maintainers: nerzhul
   $modules/web_infrastructure/rundeck_project.py:
     maintainers: nerzhul
-  $modules/web_infrastructure/rundeck_job_run.py:
-    maintainers: phsmith
-  $modules/web_infrastructure/rundeck_job_executions_info.py:
-    maintainers: phsmith
   $modules/web_infrastructure/sophos_utm/:
     maintainers: $team_e_spirit
     keywords: sophos utm
@@ -1171,8 +1161,6 @@ files:
     maintainers: inetfuture mattupstate
   $modules/web_infrastructure/taiga_issue.py:
     maintainers: lekum
-  $tests/a_module.py:
-    maintainers: felixfontein
 #########################
   tests/:
     labels: tests
@@ -1199,7 +1187,6 @@ macros:
   module_utils: plugins/module_utils
   modules: plugins/modules
   terminals: plugins/terminal
-  tests: plugins/test
   team_ansible_core:
   team_aix: MorrisA bcoca d-little flynn1973 gforster kairoaraujo marvin-sinister mator molekuul ramooncamacho wtcross
   team_bsd: JoergFiedler MacLemon bcoca dch jasperla mekanix opoplawski overhacked tuxillo
@@ -1207,7 +1194,7 @@ macros:
   team_cyberark_conjur: jvanderhoof ryanprior
   team_e_spirit: MatrixCrawler getjack
   team_flatpak: JayKayy oolongbrothers
-  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii sh0shin
+  team_gitlab: Lunik Shaps dj-wasabi marwatk waheedi zanssa scodeman metanovii
   team_hpux: bcoca davx8342
   team_huawei: QijunPan TommyLike edisonxiang freesky-edward hwDCN niuzhenguo xuxiaowei0512 yanzhangi zengchen1024 zhongjun2
   team_ipa: Akasurde Nosmoht fxfitz justchris1

.github/ISSUE_TEMPLATE/bug_report.yml

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

.github/ISSUE_TEMPLATE/documentation_report.yml

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

.github/ISSUE_TEMPLATE/feature_request.yml

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

.github/dependabot.yml

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

CONTRIBUTING.md

@@ -26,7 +26,6 @@ Also, consider taking up a valuable, reviewed, but abandoned pull request which
 * 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 :) )
-* Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed.
 
 You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst).
 
@@ -43,12 +42,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
 1. Please make sure that your new module or plugin is of interest to a larger audience. Very specialized modules or plugins that
    can only be used by very few people should better be added to more specialized collections.
 
-2. Please do not add more than one plugin/module in one PR, especially if it is the first plugin/module you are contributing.
-   That makes it easier for reviewers, and increases the chance that your PR will get merged. If you plan to contribute a group
-   of plugins/modules (say, more than a module and a corresponding ``_info`` module), please mention that in the first PR. In
-   such cases, you also have to think whether it is better to publish the group of plugins/modules in a new collection.
-
-3. When creating a new module or plugin, please make sure that you follow various guidelines:
+2. When creating a new module or plugin, please make sure that you follow various guidelines:
 
    - Follow [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html);
    - Follow [documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and
@@ -58,7 +52,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
    - Make sure that new plugins and modules have tests (unit tests, integration tests, or both); it is preferable to have some tests
      which run in CI.
 
-4. For modules and action plugins, make sure to create your module/plugin in the correct subdirectory, and create a symbolic link
+3. For modules and action plugins, make sure to create your module/plugin in the correct subdirectory, and create a symbolic link
    from `plugins/modules/` respectively `plugins/action/` to the actual module/plugin code. (Other plugin types should not use
    subdirectories.)
 
@@ -66,7 +60,7 @@ Creating new modules and plugins requires a bit more work than other Pull Reques
      (`DOCUMENTATION`, `EXAMPLES` and `RETURN`). The module must have the same name and directory path in `plugins/modules/`
      than the action plugin has in `plugins/action/`.
 
-5. Make sure to add a BOTMETA entry for your new module/plugin in `.github/BOTMETA.yml`. Search for other plugins/modules in the
+4. Make sure to add a BOTMETA entry for your new module/plugin in `.github/BOTMETA.yml`. Search for other plugins/modules in the
    same directory to see how entries could look. You should list all authors either as `maintainers` or under `ignore`. People
    listed as `maintainers` will be pinged for new issues and PRs that modify the module/plugin or its tests.
 

README.md

@@ -1,6 +1,6 @@
 # Community General Collection
 
-[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-4)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![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.
@@ -17,7 +17,7 @@ If you encounter abusive behavior violating the [Ansible Code of Conduct](https:
 
 ## Tested with Ansible
 
-Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
+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.
 
 ## External requirements
 
@@ -64,33 +64,19 @@ We are actively accepting new contributors.
 
 All types of contributions are very welcome.
 
-You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md)!
+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/stable-4/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
 
 You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
 
-Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/stable-4/CONTRIBUTING.md).
+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).
 
-## Collection maintenance
-
-To learn how to maintain / become a maintainer of this collection, refer to:
-
-* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/stable-4/commit-rights.md).
-* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
-
-It is necessary for maintainers of this collection to be subscribed to:
-
-* The collection itself (the `Watch` button → `All Activity` in the upper right corner of the repository's homepage).
-* The "Changes Impacting Collection Contributors and Maintainers" [issue](https://github.com/ansible-collections/overview/issues/45).
-
-They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
-
-## Communication
+### 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.
 
@@ -100,21 +86,26 @@ We take part in the global quarterly [Ansible Contributor Summit](https://github
 
 For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
 
-For more information about communication, refer to Ansible's the [Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+For more information about communication, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
 
-## Publishing New Version
+### Publishing New Version
 
-See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection.
+Basic instructions without release branches:
+
+1. Create `changelogs/fragments/<version>.yml` with `release_summary:` section (which must be a string, not a list).
+2. Run `antsibull-changelog release --collection-flatmap yes`
+3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed.
+4. Tag the commit with `<version>`. Push changes and tag to the main repository.
 
 ## Release notes
 
-See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-4/CHANGELOG.rst).
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-3/CHANGELOG.rst).
 
 ## Roadmap
 
-In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
+See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning and deprecation.
 
-See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning, and deprecation.
+In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
 
 ## More information
 

commit-rights.md

@@ -69,6 +69,5 @@ Individuals who have been asked to become a part of this group have generally be
 | ------------------- | -------------------- | ------------------ | -------------------- |
 | Alexei Znamensky    | russoz               | russoz             |                      |
 | Andrew Klychkov     | andersson007         | andersson007_      |                      |
-| Andrew Pantuso      | Ajpantuso            | ajpantuso          |                      |
 | Felix Fontein       | felixfontein         | felixfontein       |                      |
 | John R Barker       | gundalow             | gundalow           |                      |

docs/docsite/extra-docs.yml

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

docs/docsite/rst/filter_guide.rst

@@ -751,34 +751,3 @@ To extract ports from all clusters with name containing 'server1':
         server_name_query: "domain.server[?contains(name,'server1')].port"
 
 .. note:: while using ``starts_with`` and ``contains``, you have to use `` to_json | from_json `` filter for correct parsing of data structure.
-
-Working with Unicode
----------------------
-
-`Unicode <https://unicode.org/main.html>`_ makes it possible to produce two strings which may be visually equivalent, but are comprised of distinctly different characters/character sequences. To address this ``Unicode`` defines `normalization forms <https://unicode.org/reports/tr15/>`_ which avoid these distinctions by choosing a unique character sequence for a given visual representation.
-
-You can use the ``community.general.unicode_normalize`` filter to normalize ``Unicode`` strings within your playbooks.
-
-.. code-block:: yaml+jinja
-
-    - name: Compare Unicode representations
-      debug:
-        msg: "{{ with_combining_character | community.general.unicode_normalize == without_combining_character }}"
-      vars:
-        with_combining_character: "{{ 'Mayagu\u0308ez' }}"
-        without_combining_character: Mayagüez
-
-This produces:
-
-.. code-block:: ansible-output
-
-    TASK [Compare Unicode representations] ********************************************************
-    ok: [localhost] => {
-        "msg": true
-    }
-
-The ``community.general.unicode_normalize`` filter accepts a keyword argument to select the ``Unicode`` form used to normalize the input string.
-
-:form: One of ``'NFC'`` (default), ``'NFD'``, ``'NFKC'``, or ``'NFKD'``. See the `Unicode reference <https://unicode.org/reports/tr15/>`_ for more information.
-
-.. versionadded:: 3.7.0

docs/docsite/rst/test_guide.rst

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

galaxy.yml

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

meta/runtime.yml

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

plugins/callback/counter_enabled.py

@@ -45,8 +45,6 @@ class CallbackModule(CallbackBase):
     _task_total = 0
     _host_counter = 1
     _host_total = 0
-    _current_batch_total = 0
-    _previous_batch_total = 0
 
     def __init__(self):
         super(CallbackModule, self).__init__()
@@ -78,11 +76,8 @@ class CallbackModule(CallbackBase):
         self._display.banner(msg)
         self._play = play
 
-        self._previous_batch_total = self._current_batch_total
-        self._current_batch_total = self._previous_batch_total + len(self._all_vars()['vars']['ansible_play_batch'])
         self._host_total = len(self._all_vars()['vars']['ansible_play_hosts_all'])
         self._task_total = len(self._play.get_tasks()[0])
-        self._task_counter = 1
 
     def v2_playbook_on_stats(self, stats):
         self._display.banner("PLAY RECAP")
@@ -150,7 +145,7 @@ class CallbackModule(CallbackBase):
             path = task.get_path()
             if path:
                 self._display.display("task path: %s" % path, color=C.COLOR_DEBUG)
-        self._host_counter = self._previous_batch_total
+        self._host_counter = 0
         self._task_counter += 1
 
     def v2_runner_on_ok(self, result):

plugins/callback/elastic.py

@@ -1,423 +0,0 @@
-# (C) 2021, Victor Martinez <VictorMartinezRubio@gmail.com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: elastic
-    type: notification
-    short_description: Create distributed traces for each Ansible task in Elastic APM
-    version_added: 3.8.0
-    description:
-      - This callback creates distributed traces for each Ansible task in Elastic APM.
-      - You can configure the plugin with environment variables.
-      - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-      apm_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: ELASTIC_APM_SERVICE_NAME
-      apm_server_url:
-        type: str
-        description:
-          - Use the APM server and its environment variables.
-        env:
-          - name: ELASTIC_APM_SERVER_URL
-      apm_secret_token:
-        type: str
-        description:
-          - Use the APM server token
-        env:
-          - name: ELASTIC_APM_SECRET_TOKEN
-      apm_api_key:
-        type: str
-        description:
-          - Use the APM API key
-        env:
-          - name: ELASTIC_APM_API_KEY
-      apm_verify_server_cert:
-        default: true
-        type: bool
-        description:
-          - Verifies the SSL certificate if an HTTPS connection.
-        env:
-          - name: ELASTIC_APM_VERIFY_SERVER_CERT
-      traceparent:
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-    requirements:
-      - elastic-apm (Python library)
-'''
-
-
-EXAMPLES = '''
-examples: |
-  Enable the plugin in ansible.cfg:
-    [defaults]
-    callbacks_enabled = community.general.elastic
-
-  Set the environment variable:
-    export ELASTIC_APM_SERVER_URL=<your APM server URL)>
-    export ELASTIC_APM_SERVICE_NAME=your_service_name
-    export ELASTIC_APM_API_KEY=your_APM_API_KEY
-'''
-
-import getpass
-import socket
-import time
-import uuid
-
-from collections import OrderedDict
-from os.path import basename
-
-from ansible.errors import AnsibleError, AnsibleRuntimeError
-from ansible.module_utils.six import raise_from
-from ansible.plugins.callback import CallbackBase
-
-try:
-    from elasticapm import Client, capture_span, trace_parent_from_string, instrument, label
-except ImportError as imp_exc:
-    ELASTIC_LIBRARY_IMPORT_ERROR = imp_exc
-else:
-    ELASTIC_LIBRARY_IMPORT_ERROR = None
-
-
-class TaskData:
-    """
-    Data about an individual task.
-    """
-
-    def __init__(self, uuid, name, path, play, action, args):
-        self.uuid = uuid
-        self.name = name
-        self.path = path
-        self.play = play
-        self.host_data = OrderedDict()
-        self.start = time.time()
-        self.action = action
-        self.args = args
-
-    def add_host(self, host):
-        if host.uuid in self.host_data:
-            if host.status == 'included':
-                # concatenate task include output from multiple items
-                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
-            else:
-                return
-
-        self.host_data[host.uuid] = host
-
-
-class HostData:
-    """
-    Data about an individual host.
-    """
-
-    def __init__(self, uuid, name, status, result):
-        self.uuid = uuid
-        self.name = name
-        self.status = status
-        self.result = result
-        self.finish = time.time()
-
-
-class ElasticSource(object):
-    def __init__(self, display):
-        self.ansible_playbook = ""
-        self.ansible_version = None
-        self.session = str(uuid.uuid4())
-        self.host = socket.gethostname()
-        try:
-            self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
-            self.ip_address = None
-        self.user = getpass.getuser()
-
-        self._display = display
-
-    def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
-
-        uuid = task._uuid
-
-        if uuid in tasks_data:
-            return
-
-        name = task.get_name().strip()
-        path = task.get_path()
-        action = task.action
-        args = None
-
-        if not task.no_log and not hide_task_arguments:
-            args = ', '.join(('%s=%s' % a for a in task.args.items()))
-
-        tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
-
-    def finish_task(self, tasks_data, status, result):
-        """ record the results of a task for a single host """
-
-        task_uuid = result._task._uuid
-
-        if hasattr(result, '_host') and result._host is not None:
-            host_uuid = result._host._uuid
-            host_name = result._host.name
-        else:
-            host_uuid = 'include'
-            host_name = 'include'
-
-        task = tasks_data[task_uuid]
-
-        if self.ansible_version is None and result._task_fields['args'].get('_ansible_version'):
-            self.ansible_version = result._task_fields['args'].get('_ansible_version')
-
-        task.add_host(HostData(host_uuid, host_name, status, result))
-
-    def generate_distributed_traces(self, tasks_data, status, end_time, traceparent, apm_service_name,
-                                    apm_server_url, apm_verify_server_cert, apm_secret_token, apm_api_key):
-        """ generate distributed traces from the collected TaskData and HostData """
-
-        tasks = []
-        parent_start_time = None
-        for task_uuid, task in tasks_data.items():
-            if parent_start_time is None:
-                parent_start_time = task.start
-            tasks.append(task)
-
-        apm_cli = self.init_apm_client(apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key)
-        if apm_cli:
-            instrument()  # Only call this once, as early as possible.
-            if traceparent:
-                parent = trace_parent_from_string(traceparent)
-                apm_cli.begin_transaction("Session", trace_parent=parent, start=parent_start_time)
-            else:
-                apm_cli.begin_transaction("Session", start=parent_start_time)
-            # Populate trace metadata attributes
-            if self.ansible_version is not None:
-                label(ansible_version=self.ansible_version)
-            label(ansible_session=self.session, ansible_host_name=self.host, ansible_host_user=self.user)
-            if self.ip_address is not None:
-                label(ansible_host_ip=self.ip_address)
-
-            for task_data in tasks:
-                for host_uuid, host_data in task_data.host_data.items():
-                    self.create_span_data(apm_cli, task_data, host_data)
-
-            apm_cli.end_transaction(name=__name__, result=status, duration=end_time - parent_start_time)
-
-    def create_span_data(self, apm_cli, task_data, host_data):
-        """ create the span with the given TaskData and HostData """
-
-        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
-
-        message = "success"
-        status = "success"
-        enriched_error_message = None
-        if host_data.status == 'included':
-            rc = 0
-        else:
-            res = host_data.result._result
-            rc = res.get('rc', 0)
-            if host_data.status == 'failed':
-                message = self.get_error_message(res)
-                enriched_error_message = self.enrich_error_message(res)
-                status = "failure"
-            elif host_data.status == 'skipped':
-                if 'skip_reason' in res:
-                    message = res['skip_reason']
-                else:
-                    message = 'skipped'
-                status = "unknown"
-
-        with capture_span(task_data.name,
-                          start=task_data.start,
-                          span_type="ansible.task.run",
-                          duration=host_data.finish - task_data.start,
-                          labels={"ansible.task.args": task_data.args,
-                                  "ansible.task.message": message,
-                                  "ansible.task.module": task_data.action,
-                                  "ansible.task.name": name,
-                                  "ansible.task.result": rc,
-                                  "ansible.task.host.name": host_data.name,
-                                  "ansible.task.host.status": host_data.status}) as span:
-            span.outcome = status
-            if 'failure' in status:
-                exception = AnsibleRuntimeError(message="{0}: {1} failed with error message {2}".format(task_data.action, name, enriched_error_message))
-                apm_cli.capture_exception(exc_info=(type(exception), exception, exception.__traceback__), handled=True)
-
-    def init_apm_client(self, apm_server_url, apm_service_name, apm_verify_server_cert, apm_secret_token, apm_api_key):
-        if apm_server_url:
-            return Client(service_name=apm_service_name,
-                          server_url=apm_server_url,
-                          verify_server_cert=False,
-                          secret_token=apm_secret_token,
-                          api_key=apm_api_key,
-                          use_elastic_traceparent_header=True,
-                          debug=True)
-
-    @staticmethod
-    def get_error_message(result):
-        if result.get('exception') is not None:
-            return ElasticSource._last_line(result['exception'])
-        return result.get('msg', 'failed')
-
-    @staticmethod
-    def _last_line(text):
-        lines = text.strip().split('\n')
-        return lines[-1]
-
-    @staticmethod
-    def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
-
-
-class CallbackModule(CallbackBase):
-    """
-    This callback creates distributed traces with Elastic APM.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.elastic'
-    CALLBACK_NEEDS_ENABLED = True
-
-    def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
-        self.hide_task_arguments = None
-        self.apm_service_name = None
-        self.ansible_playbook = None
-        self.traceparent = False
-        self.play_name = None
-        self.tasks_data = None
-        self.errors = 0
-        self.disabled = False
-
-        if ELASTIC_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('The `elastic-apm` must be installed to use this plugin'),
-                ELASTIC_LIBRARY_IMPORT_ERROR)
-
-        self.tasks_data = OrderedDict()
-
-        self.elastic = ElasticSource(display=self._display)
-
-    def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
-
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
-
-        self.apm_service_name = self.get_option('apm_service_name')
-        if not self.apm_service_name:
-            self.apm_service_name = 'ansible'
-
-        self.apm_server_url = self.get_option('apm_server_url')
-        self.apm_secret_token = self.get_option('apm_secret_token')
-        self.apm_api_key = self.get_option('apm_api_key')
-        self.apm_verify_server_cert = self.get_option('apm_verify_server_cert')
-        self.traceparent = self.get_option('traceparent')
-
-    def v2_playbook_on_start(self, playbook):
-        self.ansible_playbook = basename(playbook._file_name)
-
-    def v2_playbook_on_play_start(self, play):
-        self.play_name = play.get_name()
-
-    def v2_runner_on_no_hosts(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_cleanup_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_handler_task_start(self, task):
-        self.elastic.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        self.errors += 1
-        self.elastic.finish_task(
-            self.tasks_data,
-            'failed',
-            result
-        )
-
-    def v2_runner_on_ok(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'ok',
-            result
-        )
-
-    def v2_runner_on_skipped(self, result):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'skipped',
-            result
-        )
-
-    def v2_playbook_on_include(self, included_file):
-        self.elastic.finish_task(
-            self.tasks_data,
-            'included',
-            included_file
-        )
-
-    def v2_playbook_on_stats(self, stats):
-        if self.errors == 0:
-            status = "success"
-        else:
-            status = "failure"
-        self.elastic.generate_distributed_traces(
-            self.tasks_data,
-            status,
-            time.time(),
-            self.traceparent,
-            self.apm_service_name,
-            self.apm_server_url,
-            self.apm_verify_server_cert,
-            self.apm_secret_token,
-            self.apm_api_key
-        )
-
-    def v2_runner_on_async_failed(self, result, **kwargs):
-        self.errors += 1

plugins/callback/logstash.py

@@ -94,7 +94,6 @@ ansible.cfg: |
 
 import os
 import json
-from ansible import context
 import socket
 import uuid
 import logging
@@ -153,11 +152,11 @@ class CallbackModule(CallbackBase):
                 self.base_data['ansible_pre_command_output'] = os.popen(
                     self.ls_pre_command).read()
 
-            if context.CLIARGS is not None:
-                self.base_data['ansible_checkmode'] = context.CLIARGS.get('check')
-                self.base_data['ansible_tags'] = context.CLIARGS.get('tags')
-                self.base_data['ansible_skip_tags'] = context.CLIARGS.get('skip_tags')
-                self.base_data['inventory'] = context.CLIARGS.get('inventory')
+            if self._options is not None:
+                self.base_data['ansible_checkmode'] = self._options.check
+                self.base_data['ansible_tags'] = self._options.tags
+                self.base_data['ansible_skip_tags'] = self._options.skip_tags
+                self.base_data['inventory'] = self._options.inventory
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
         super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)

plugins/callback/opentelemetry.py

@@ -1,507 +0,0 @@
-# (C) 2021, Victor Martinez <VictorMartinezRubio@gmail.com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: opentelemetry
-    type: notification
-    short_description: Create distributed traces with OpenTelemetry
-    version_added: 3.7.0
-    description:
-      - This callback creates distributed traces for each Ansible task with OpenTelemetry.
-      - You can configure the OpenTelemetry exporter and SDK with environment variables.
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-      enable_from_environment:
-        type: str
-        description:
-          - Whether to enable this callback only if the given environment variable exists and it is set to C(true).
-          - This is handy when you use Configuration as Code and want to send distributed traces
-            if running in the CI rather when running Ansible locally.
-          - For such, it evaluates the given I(enable_from_environment) value as environment variable
-            and if set to true this plugin will be enabled.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
-        version_added: 3.8.0
-      otel_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: OTEL_SERVICE_NAME
-      traceparent:
-        default: None
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-    requirements:
-      - opentelemetry-api (Python library)
-      - opentelemetry-exporter-otlp (Python library)
-      - opentelemetry-sdk (Python library)
-'''
-
-
-EXAMPLES = '''
-examples: |
-  Enable the plugin in ansible.cfg:
-    [defaults]
-    callbacks_enabled = community.general.opentelemetry
-
-  Set the environment variable:
-    export OTEL_EXPORTER_OTLP_ENDPOINT=<your endpoint (OTLP/HTTP)>
-    export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
-    export OTEL_SERVICE_NAME=your_service_name
-'''
-
-import getpass
-import os
-import socket
-import sys
-import time
-import uuid
-
-from collections import OrderedDict
-from os.path import basename
-
-from ansible.errors import AnsibleError
-from ansible.module_utils.six import raise_from
-from ansible.module_utils.six.moves.urllib.parse import urlparse
-from ansible.plugins.callback import CallbackBase
-
-try:
-    from opentelemetry import trace
-    from opentelemetry.trace import SpanKind
-    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
-    from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-    from opentelemetry.trace.status import Status, StatusCode
-    from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
-    from opentelemetry.sdk.trace import TracerProvider
-    from opentelemetry.sdk.trace.export import (
-        BatchSpanProcessor
-    )
-    from opentelemetry.util._time import _time_ns
-except ImportError as imp_exc:
-    OTEL_LIBRARY_IMPORT_ERROR = imp_exc
-else:
-    OTEL_LIBRARY_IMPORT_ERROR = None
-
-
-class TaskData:
-    """
-    Data about an individual task.
-    """
-
-    def __init__(self, uuid, name, path, play, action, args):
-        self.uuid = uuid
-        self.name = name
-        self.path = path
-        self.play = play
-        self.host_data = OrderedDict()
-        if sys.version_info >= (3, 7):
-            self.start = time.time_ns()
-        else:
-            self.start = _time_ns()
-        self.action = action
-        self.args = args
-
-    def add_host(self, host):
-        if host.uuid in self.host_data:
-            if host.status == 'included':
-                # concatenate task include output from multiple items
-                host.result = '%s\n%s' % (self.host_data[host.uuid].result, host.result)
-            else:
-                return
-
-        self.host_data[host.uuid] = host
-
-
-class HostData:
-    """
-    Data about an individual host.
-    """
-
-    def __init__(self, uuid, name, status, result):
-        self.uuid = uuid
-        self.name = name
-        self.status = status
-        self.result = result
-        if sys.version_info >= (3, 7):
-            self.finish = time.time_ns()
-        else:
-            self.finish = _time_ns()
-
-
-class OpenTelemetrySource(object):
-    def __init__(self, display):
-        self.ansible_playbook = ""
-        self.ansible_version = None
-        self.session = str(uuid.uuid4())
-        self.host = socket.gethostname()
-        try:
-            self.ip_address = socket.gethostbyname(socket.gethostname())
-        except Exception as e:
-            self.ip_address = None
-        self.user = getpass.getuser()
-
-        self._display = display
-
-    def traceparent_context(self, traceparent):
-        carrier = dict()
-        carrier['traceparent'] = traceparent
-        return TraceContextTextMapPropagator().extract(carrier=carrier)
-
-    def start_task(self, tasks_data, hide_task_arguments, play_name, task):
-        """ record the start of a task for one or more hosts """
-
-        uuid = task._uuid
-
-        if uuid in tasks_data:
-            return
-
-        name = task.get_name().strip()
-        path = task.get_path()
-        action = task.action
-        args = None
-
-        if not task.no_log and not hide_task_arguments:
-            args = task.args
-
-        tasks_data[uuid] = TaskData(uuid, name, path, play_name, action, args)
-
-    def finish_task(self, tasks_data, status, result):
-        """ record the results of a task for a single host """
-
-        task_uuid = result._task._uuid
-
-        if hasattr(result, '_host') and result._host is not None:
-            host_uuid = result._host._uuid
-            host_name = result._host.name
-        else:
-            host_uuid = 'include'
-            host_name = 'include'
-
-        task = tasks_data[task_uuid]
-
-        if self.ansible_version is None and result._task_fields['args'].get('_ansible_version'):
-            self.ansible_version = result._task_fields['args'].get('_ansible_version')
-
-        task.add_host(HostData(host_uuid, host_name, status, result))
-
-    def generate_distributed_traces(self, otel_service_name, ansible_playbook, tasks_data, status, traceparent):
-        """ generate distributed traces from the collected TaskData and HostData """
-
-        tasks = []
-        parent_start_time = None
-        for task_uuid, task in tasks_data.items():
-            if parent_start_time is None:
-                parent_start_time = task.start
-            tasks.append(task)
-
-        trace.set_tracer_provider(
-            TracerProvider(
-                resource=Resource.create({SERVICE_NAME: otel_service_name})
-            )
-        )
-
-        processor = BatchSpanProcessor(OTLPSpanExporter())
-
-        trace.get_tracer_provider().add_span_processor(processor)
-
-        tracer = trace.get_tracer(__name__)
-
-        with tracer.start_as_current_span(ansible_playbook, context=self.traceparent_context(traceparent),
-                                          start_time=parent_start_time, kind=SpanKind.SERVER) as parent:
-            parent.set_status(status)
-            # Populate trace metadata attributes
-            if self.ansible_version is not None:
-                parent.set_attribute("ansible.version", self.ansible_version)
-            parent.set_attribute("ansible.session", self.session)
-            parent.set_attribute("ansible.host.name", self.host)
-            if self.ip_address is not None:
-                parent.set_attribute("ansible.host.ip", self.ip_address)
-            parent.set_attribute("ansible.host.user", self.user)
-            for task in tasks:
-                for host_uuid, host_data in task.host_data.items():
-                    with tracer.start_as_current_span(task.name, start_time=task.start, end_on_exit=False) as span:
-                        self.update_span_data(task, host_data, span)
-
-    def update_span_data(self, task_data, host_data, span):
-        """ update the span with the given TaskData and HostData """
-
-        name = '[%s] %s: %s' % (host_data.name, task_data.play, task_data.name)
-
-        message = 'success'
-        res = {}
-        rc = 0
-        status = Status(status_code=StatusCode.OK)
-        if host_data.status != 'included':
-            # Support loops
-            if 'results' in host_data.result._result:
-                if host_data.status == 'failed':
-                    message = self.get_error_message_from_results(host_data.result._result['results'], task_data.action)
-                    enriched_error_message = self.enrich_error_message_from_results(host_data.result._result['results'], task_data.action)
-            else:
-                res = host_data.result._result
-                rc = res.get('rc', 0)
-                message = self.get_error_message(res)
-                enriched_error_message = self.enrich_error_message(res)
-
-            if host_data.status == 'failed':
-                status = Status(status_code=StatusCode.ERROR, description=message)
-                # Record an exception with the task message
-                span.record_exception(BaseException(enriched_error_message))
-            elif host_data.status == 'skipped':
-                message = res['skip_reason'] if 'skip_reason' in res else 'skipped'
-                status = Status(status_code=StatusCode.UNSET)
-
-        span.set_status(status)
-        if isinstance(task_data.args, dict) and "gather_facts" not in task_data.action:
-            names = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.keys())
-            values = tuple(self.transform_ansible_unicode_to_str(k) for k in task_data.args.values())
-            self.set_span_attribute(span, ("ansible.task.args.name"), names)
-            self.set_span_attribute(span, ("ansible.task.args.value"), values)
-        self.set_span_attribute(span, "ansible.task.module", task_data.action)
-        self.set_span_attribute(span, "ansible.task.message", message)
-        self.set_span_attribute(span, "ansible.task.name", name)
-        self.set_span_attribute(span, "ansible.task.result", rc)
-        self.set_span_attribute(span, "ansible.task.host.name", host_data.name)
-        self.set_span_attribute(span, "ansible.task.host.status", host_data.status)
-        # This will allow to enrich the service map
-        self.add_attributes_for_service_map_if_possible(span, task_data)
-        span.end(end_time=host_data.finish)
-
-    def set_span_attribute(self, span, attributeName, attributeValue):
-        """ update the span attribute with the given attribute and value if not None """
-
-        if span is None and self._display is not None:
-            self._display.warning('span object is None. Please double check if that is expected.')
-        else:
-            if attributeValue is not None:
-                span.set_attribute(attributeName, attributeValue)
-
-    def add_attributes_for_service_map_if_possible(self, span, task_data):
-        """Update the span attributes with the service that the task interacted with, if possible."""
-
-        redacted_url = self.parse_and_redact_url_if_possible(task_data.args)
-        if redacted_url:
-            self.set_span_attribute(span, "http.url", redacted_url.geturl())
-
-    @staticmethod
-    def parse_and_redact_url_if_possible(args):
-        """Parse and redact the url, if possible."""
-
-        try:
-            parsed_url = urlparse(OpenTelemetrySource.url_from_args(args))
-        except ValueError:
-            return None
-
-        if OpenTelemetrySource.is_valid_url(parsed_url):
-            return OpenTelemetrySource.redact_user_password(parsed_url)
-        return None
-
-    @staticmethod
-    def url_from_args(args):
-        # the order matters
-        url_args = ("url", "api_url", "baseurl", "repo", "server_url", "chart_repo_url")
-        for arg in url_args:
-            if args.get(arg):
-                return args.get(arg)
-        return ""
-
-    @staticmethod
-    def redact_user_password(url):
-        return url._replace(netloc=url.hostname) if url.password else url
-
-    @staticmethod
-    def is_valid_url(url):
-        if all([url.scheme, url.netloc, url.hostname]):
-            return "{{" not in url.hostname
-        return False
-
-    @staticmethod
-    def transform_ansible_unicode_to_str(value):
-        parsed_url = urlparse(str(value))
-        if OpenTelemetrySource.is_valid_url(parsed_url):
-            return OpenTelemetrySource.redact_user_password(parsed_url).geturl()
-        return str(value)
-
-    @staticmethod
-    def get_error_message(result):
-        if result.get('exception') is not None:
-            return OpenTelemetrySource._last_line(result['exception'])
-        return result.get('msg', 'failed')
-
-    @staticmethod
-    def get_error_message_from_results(results, action):
-        for result in results:
-            if result.get('failed', False):
-                return ('{0}({1}) - {2}').format(action, result.get('item', 'none'), OpenTelemetrySource.get_error_message(result))
-
-    @staticmethod
-    def _last_line(text):
-        lines = text.strip().split('\n')
-        return lines[-1]
-
-    @staticmethod
-    def enrich_error_message(result):
-        message = result.get('msg', 'failed')
-        exception = result.get('exception')
-        stderr = result.get('stderr')
-        return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr)
-
-    @staticmethod
-    def enrich_error_message_from_results(results, action):
-        message = ""
-        for result in results:
-            if result.get('failed', False):
-                message = ('{0}({1}) - {2}\n{3}').format(action, result.get('item', 'none'), OpenTelemetrySource.enrich_error_message(result), message)
-        return message
-
-
-class CallbackModule(CallbackBase):
-    """
-    This callback creates distributed traces.
-    """
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'notification'
-    CALLBACK_NAME = 'community.general.opentelemetry'
-    CALLBACK_NEEDS_ENABLED = True
-
-    def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display=display)
-        self.hide_task_arguments = None
-        self.otel_service_name = None
-        self.ansible_playbook = None
-        self.play_name = None
-        self.tasks_data = None
-        self.errors = 0
-        self.disabled = False
-        self.traceparent = False
-
-        if OTEL_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('The `opentelemetry-api`, `opentelemetry-exporter-otlp` or `opentelemetry-sdk` must be installed to use this plugin'),
-                OTEL_LIBRARY_IMPORT_ERROR)
-
-        self.tasks_data = OrderedDict()
-
-        self.opentelemetry = OpenTelemetrySource(display=self._display)
-
-    def set_options(self, task_keys=None, var_options=None, direct=None):
-        super(CallbackModule, self).set_options(task_keys=task_keys,
-                                                var_options=var_options,
-                                                direct=direct)
-
-        environment_variable = self.get_option('enable_from_environment')
-        if environment_variable is not None and os.environ.get(environment_variable, 'false').lower() != 'true':
-            self.disabled = True
-            self._display.warning("The `enable_from_environment` option has been set and {0} is not enabled. "
-                                  "Disabling the `opentelemetry` callback plugin.".format(environment_variable))
-
-        self.hide_task_arguments = self.get_option('hide_task_arguments')
-
-        self.otel_service_name = self.get_option('otel_service_name')
-
-        if not self.otel_service_name:
-            self.otel_service_name = 'ansible'
-
-        # See https://github.com/open-telemetry/opentelemetry-specification/issues/740
-        self.traceparent = self.get_option('traceparent')
-
-    def v2_playbook_on_start(self, playbook):
-        self.ansible_playbook = basename(playbook._file_name)
-
-    def v2_playbook_on_play_start(self, play):
-        self.play_name = play.get_name()
-
-    def v2_runner_on_no_hosts(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_cleanup_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_playbook_on_handler_task_start(self, task):
-        self.opentelemetry.start_task(
-            self.tasks_data,
-            self.hide_task_arguments,
-            self.play_name,
-            task
-        )
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        self.errors += 1
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'failed',
-            result
-        )
-
-    def v2_runner_on_ok(self, result):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'ok',
-            result
-        )
-
-    def v2_runner_on_skipped(self, result):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'skipped',
-            result
-        )
-
-    def v2_playbook_on_include(self, included_file):
-        self.opentelemetry.finish_task(
-            self.tasks_data,
-            'included',
-            included_file
-        )
-
-    def v2_playbook_on_stats(self, stats):
-        if self.errors == 0:
-            status = Status(status_code=StatusCode.OK)
-        else:
-            status = Status(status_code=StatusCode.ERROR)
-        self.opentelemetry.generate_distributed_traces(
-            self.otel_service_name,
-            self.ansible_playbook,
-            self.tasks_data,
-            status,
-            self.traceparent
-        )
-
-    def v2_runner_on_async_failed(self, result, **kwargs):
-        self.errors += 1

plugins/callback/yaml.py

@@ -42,29 +42,28 @@ def should_use_block(value):
     return False
 
 
-class MyDumper(AnsibleDumper):
-    def represent_scalar(self, tag, value, style=None):
-        """Uses block style for multi-line strings"""
-        if style is None:
-            if should_use_block(value):
-                style = '|'
-                # we care more about readable than accuracy, so...
-                # ...no trailing space
-                value = value.rstrip()
-                # ...and non-printable characters
-                value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
-                # ...tabs prevent blocks from expanding
-                value = value.expandtabs()
-                # ...and odd bits of whitespace
-                value = re.sub(r'[\x0b\x0c\r]', '', value)
-                # ...as does trailing space
-                value = re.sub(r' +\n', '\n', value)
-            else:
-                style = self.default_style
-        node = yaml.representer.ScalarNode(tag, value, style=style)
-        if self.alias_key is not None:
-            self.represented_objects[self.alias_key] = node
-        return node
+def my_represent_scalar(self, tag, value, style=None):
+    """Uses block style for multi-line strings"""
+    if style is None:
+        if should_use_block(value):
+            style = '|'
+            # we care more about readable than accuracy, so...
+            # ...no trailing space
+            value = value.rstrip()
+            # ...and non-printable characters
+            value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+            # ...tabs prevent blocks from expanding
+            value = value.expandtabs()
+            # ...and odd bits of whitespace
+            value = re.sub(r'[\x0b\x0c\r]', '', value)
+            # ...as does trailing space
+            value = re.sub(r' +\n', '\n', value)
+        else:
+            style = self.default_style
+    node = yaml.representer.ScalarNode(tag, value, style=style)
+    if self.alias_key is not None:
+        self.represented_objects[self.alias_key] = node
+    return node
 
 
 class CallbackModule(Default):
@@ -80,6 +79,7 @@ class CallbackModule(Default):
 
     def __init__(self):
         super(CallbackModule, self).__init__()
+        yaml.representer.BaseRepresenter.represent_scalar = my_represent_scalar
 
     def _dump_results(self, result, indent=None, sort_keys=True, keep_invocation=False):
         if result.get('_ansible_no_log', False):
@@ -121,7 +121,7 @@ class CallbackModule(Default):
 
         if abridged_result:
             dumped += '\n'
-            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=MyDumper, default_flow_style=False))
+            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=AnsibleDumper, default_flow_style=False))
 
         # indent by a couple of spaces
         dumped = '\n  '.join(dumped.split('\n')).rstrip()

plugins/doc_fragments/_netapp.py

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

plugins/doc_fragments/bitbucket.py

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

plugins/doc_fragments/nios.py

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

plugins/doc_fragments/redis.py

@@ -1,57 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-
-class ModuleDocFragment(object):
-    # Common parameters for Redis modules
-    DOCUMENTATION = r'''
-options:
-  login_host:
-    description:
-      - Specify the target host running the database.
-    default: localhost
-    type: str
-  login_port:
-    description:
-      - Specify the port to connect to.
-    default: 6379
-    type: int
-  login_user:
-    description:
-      - Specify the user to authenticate with.
-      - Requires L(redis,https://pypi.org/project/redis) >= 3.4.0.
-    type: str
-  login_password:
-    description:
-      - Specify the password to authenticate with.
-      - Usually not used when target is localhost.
-    type: str
-  tls:
-    description:
-      - Specify whether or not to use TLS for the connection.
-    type: bool
-    default: true
-  validate_certs:
-    description:
-      - Specify whether or not to validate TLS certificates.
-      - This should only be turned off for personally controlled sites or with
-        C(localhost) as target.
-    type: bool
-    default: true
-  ca_certs:
-    description:
-      - Path to root certificates file. If not set and I(tls) is
-        set to C(true), certifi ca-certificates will be used.
-    type: str
-requirements: [ "redis", "certifi" ]
-
-notes:
-  - Requires the C(redis) Python package on the remote host. You can
-    install it with pip (C(pip install redis)) or with a package manager.
-    Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
-'''

plugins/doc_fragments/rundeck.py

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Phillipe Smith <phsmithcc@gmail.com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-
-class ModuleDocFragment(object):
-
-    # Standard files documentation fragment
-    DOCUMENTATION = r'''
-options:
-  url:
-    type: str
-    description:
-      - Rundeck instance URL.
-    required: true
-  api_version:
-    type: int
-    description:
-      - Rundeck API version to be used.
-      - API version must be at least 14.
-    default: 39
-  api_token:
-    type: str
-    description:
-      - Rundeck User API Token.
-    required: true
-'''

plugins/filter/unicode_normalize.py

@@ -1,40 +0,0 @@
-# -*- 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 unicodedata import normalize
-
-from ansible.errors import AnsibleFilterError, AnsibleFilterTypeError
-from ansible.module_utils.six import text_type
-
-
-def unicode_normalize(data, form='NFC'):
-    """Applies normalization to 'unicode' strings.
-
-    Args:
-        data: A unicode string piped into the Jinja filter
-        form: One of ('NFC', 'NFD', 'NFKC', 'NFKD').
-              See https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize for more information.
-
-    Returns:
-        A normalized unicode string of the specified 'form'.
-    """
-
-    if not isinstance(data, text_type):
-        raise AnsibleFilterTypeError("%s is not a valid input type" % type(data))
-
-    if form not in ('NFC', 'NFD', 'NFKC', 'NFKD'):
-        raise AnsibleFilterError("%s is not a valid form" % form)
-
-    return normalize(form, data)
-
-
-class FilterModule(object):
-    def filters(self):
-        return {
-            'unicode_normalize': unicode_normalize,
-        }

plugins/inventory/icinga2.py

@@ -1,222 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021, Cliff Hults <cliff.hlts@gmail.com>
-# Copyright (c) 2021 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    name: icinga2
-    short_description: Icinga2 inventory source
-    version_added: 3.7.0
-    author:
-        - Cliff Hults (@BongoEADGC6) <cliff.hults@gmail.com>
-    description:
-        - Get inventory hosts from the Icinga2 API.
-        - "Uses a configuration file as an inventory source, it must end in
-          C(.icinga2.yml) or C(.icinga2.yaml)."
-    options:
-      plugin:
-        description: Name of the plugin.
-        required: true
-        type: string
-        choices: ['community.general.icinga2']
-      url:
-        description: Root URL of Icinga2 API.
-        type: string
-        required: true
-      user:
-        description: Username to query the API.
-        type: string
-        required: true
-      password:
-        description: Password to query the API.
-        type: string
-        required: true
-      host_filter:
-        description: An Icinga2 API valid host filter.
-        type: string
-        required: false
-      validate_certs:
-        description: Enables or disables SSL certificate verification.
-        type: boolean
-        default: true
-'''
-
-EXAMPLES = r'''
-# my.icinga2.yml
-plugin: community.general.icinga2
-url: http://localhost:5665
-user: ansible
-password: secure
-host_filter: \"linux-servers\" in host.groups
-validate_certs: false
-'''
-
-import json
-
-from ansible.errors import AnsibleParserError
-from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
-from ansible.module_utils.urls import open_url
-
-
-class InventoryModule(BaseInventoryPlugin, Constructable):
-    ''' Host inventory parser for ansible using Icinga2 as source. '''
-
-    NAME = 'community.general.icinga2'
-
-    def __init__(self):
-
-        super(InventoryModule, self).__init__()
-
-        # from config
-        self.icinga2_url = None
-        self.icinga2_user = None
-        self.icinga2_password = None
-        self.ssl_verify = None
-        self.host_filter = None
-
-        self.cache_key = None
-        self.use_cache = None
-
-    def verify_file(self, path):
-        valid = False
-        if super(InventoryModule, self).verify_file(path):
-            if path.endswith(('icinga2.yaml', 'icinga2.yml')):
-                valid = True
-            else:
-                self.display.vvv('Skipping due to inventory source not ending in "icinga2.yaml" nor "icinga2.yml"')
-        return valid
-
-    def _api_connect(self):
-        self.headers = {
-            'User-Agent': "ansible-icinga2-inv",
-            'Accept': "application/json",
-        }
-        api_status_url = self.icinga2_url + "/status"
-        request_args = {
-            'headers': self.headers,
-            'url_username': self.icinga2_user,
-            'url_password': self.icinga2_password,
-            'validate_certs': self.ssl_verify
-        }
-        open_url(api_status_url, **request_args)
-
-    def _post_request(self, request_url, data=None):
-        self.display.vvv("Requested URL: %s" % request_url)
-        request_args = {
-            'headers': self.headers,
-            'url_username': self.icinga2_user,
-            'url_password': self.icinga2_password,
-            'validate_certs': self.ssl_verify
-        }
-        if data is not None:
-            request_args['data'] = json.dumps(data)
-        self.display.vvv("Request Args: %s" % request_args)
-        response = open_url(request_url, **request_args)
-        response_body = response.read()
-        json_data = json.loads(response_body.decode('utf-8'))
-        if 200 <= response.status <= 299:
-            return json_data
-        if response.status == 404 and json_data['status'] == "No objects found.":
-            raise AnsibleParserError(
-                "API returned no data -- Response: %s - %s"
-                % (response.status, json_data['status']))
-        if response.status == 401:
-            raise AnsibleParserError(
-                "API was unable to complete query -- Response: %s - %s"
-                % (response.status, json_data['status']))
-        if response.status == 500:
-            raise AnsibleParserError(
-                "API Response - %s - %s"
-                % (json_data['status'], json_data['errors']))
-        raise AnsibleParserError(
-            "Unexpected data returned - %s - %s"
-            % (json_data['status'], json_data['errors']))
-
-    def _query_hosts(self, hosts=None, attrs=None, joins=None, host_filter=None):
-        query_hosts_url = "{0}/objects/hosts".format(self.icinga2_url)
-        self.headers['X-HTTP-Method-Override'] = 'GET'
-        data_dict = dict()
-        if hosts:
-            data_dict['hosts'] = hosts
-        if attrs is not None:
-            data_dict['attrs'] = attrs
-        if joins is not None:
-            data_dict['joins'] = joins
-        if host_filter is not None:
-            data_dict['filter'] = host_filter.replace("\\\"", "\"")
-            self.display.vvv(host_filter)
-        host_dict = self._post_request(query_hosts_url, data_dict)
-        return host_dict['results']
-
-    def get_inventory_from_icinga(self):
-        """Query for all hosts """
-        self.display.vvv("Querying Icinga2 for inventory")
-        query_args = {
-            "attrs": ["address", "state_type", "state", "groups"],
-        }
-        if self.host_filter is not None:
-            query_args['host_filter'] = self.host_filter
-        # Icinga2 API Call
-        results_json = self._query_hosts(**query_args)
-        # Manipulate returned API data to Ansible inventory spec
-        ansible_inv = self._convert_inv(results_json)
-        return ansible_inv
-
-    def _populate(self):
-        groups = self._to_json(self.get_inventory_from_icinga())
-        return groups
-
-    def _to_json(self, in_dict):
-        """Convert dictionary to JSON"""
-        return json.dumps(in_dict, sort_keys=True, indent=2)
-
-    def _convert_inv(self, json_data):
-        """Convert Icinga2 API data to JSON format for Ansible"""
-        groups_dict = {"_meta": {"hostvars": {}}}
-        for entry in json_data:
-            host_name = entry['name']
-            host_attrs = entry['attrs']
-            if host_attrs['state'] == 0:
-                host_attrs['state'] = 'on'
-            else:
-                host_attrs['state'] = 'off'
-            host_groups = host_attrs['groups']
-            host_addr = host_attrs['address']
-            self.inventory.add_host(host_addr)
-            for group in host_groups:
-                if group not in self.inventory.groups.keys():
-                    self.inventory.add_group(group)
-                self.inventory.add_child(group, host_addr)
-            self.inventory.set_variable(host_addr, 'address', host_addr)
-            self.inventory.set_variable(host_addr, 'hostname', host_name)
-            self.inventory.set_variable(host_addr, 'state',
-                                        host_attrs['state'])
-            self.inventory.set_variable(host_addr, 'state_type',
-                                        host_attrs['state_type'])
-        return groups_dict
-
-    def parse(self, inventory, loader, path, cache=True):
-
-        super(InventoryModule, self).parse(inventory, loader, path)
-
-        # read config from file, this sets 'options'
-        self._read_config_data(path)
-
-        # Store the options from the YAML file
-        self.icinga2_url = self.get_option('url').rstrip('/') + '/v1'
-        self.icinga2_user = self.get_option('user')
-        self.icinga2_password = self.get_option('password')
-        self.ssl_verify = self.get_option('validate_certs')
-        self.host_filter = self.get_option('host_filter')
-        # Not currently enabled
-        # self.cache_key = self.get_cache_key(path)
-        # self.use_cache = cache and self.get_option('cache')
-
-        # Test connection to API
-        self._api_connect()
-
-        # Call our internal helper to populate the dynamic inventory
-        self._populate()

plugins/inventory/linode.py

@@ -29,7 +29,8 @@ DOCUMENTATION = r'''
         ip_style:
             description: Populate hostvars with all information available from the Linode APIv4.
             type: string
-            default: plain
+            default:
+                - plain
             choices:
                 - plain
                 - api

plugins/inventory/lxd.py

@@ -13,8 +13,6 @@ DOCUMENTATION = r'''
         - Uses a YAML configuration file that ends with 'lxd.(yml|yaml)'.
     version_added: "3.0.0"
     author: "Frank Dornheim (@conloos)"
-    requirements:
-        - ipaddress
     options:
         plugin:
             description: Token that ensures this is a source file for the 'lxd' plugin.
@@ -126,17 +124,10 @@ import socket
 from ansible.plugins.inventory import BaseInventoryPlugin
 from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.module_utils.common.dict_transformations import dict_merge
-from ansible.module_utils.six import raise_from
 from ansible.errors import AnsibleError, AnsibleParserError
+from ansible_collections.community.general.plugins.module_utils.compat import ipaddress
 from ansible_collections.community.general.plugins.module_utils.lxd import LXDClient, LXDClientException
 
-try:
-    import ipaddress
-except ImportError as exc:
-    IPADDRESS_IMPORT_ERROR = exc
-else:
-    IPADDRESS_IMPORT_ERROR = None
-
 
 class InventoryModule(BaseInventoryPlugin):
     DEBUG = 4
@@ -933,10 +924,6 @@ class InventoryModule(BaseInventoryPlugin):
             AnsibleParserError
         Returns:
             None"""
-        if IPADDRESS_IMPORT_ERROR:
-            raise_from(
-                AnsibleError('another_library must be installed to use this plugin'),
-                IPADDRESS_IMPORT_ERROR)
 
         super(InventoryModule, self).parse(inventory, loader, path, cache=False)
         # Read the inventory YAML file

plugins/inventory/opennebula.py

@@ -1,239 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (c) 2020, FELDSAM s.r.o. - FeldHost™ <support@feldhost.cz>
-# 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: opennebula
-    author:
-        - Kristian Feldsam (@feldsam)
-    short_description: OpenNebula inventory source
-    version_added: "3.8.0"
-    extends_documentation_fragment:
-        - constructed
-    description:
-        - Get inventory hosts from OpenNebula cloud.
-        - Uses an YAML configuration file ending with either I(opennebula.yml) or I(opennebula.yaml)
-          to set parameter values.
-        - Uses I(api_authfile), C(~/.one/one_auth), or C(ONE_AUTH) pointing to a OpenNebula credentials file.
-    options:
-        plugin:
-            description: Token that ensures this is a source file for the 'opennebula' plugin.
-            type: string
-            required: true
-            choices: [ community.general.opennebula ]
-        api_url:
-            description:
-              - URL of the OpenNebula RPC server.
-              - It is recommended to use HTTPS so that the username/password are not
-                transferred over the network unencrypted.
-              - If not set then the value of the C(ONE_URL) environment variable is used.
-            env:
-              - name: ONE_URL
-            required: True
-            type: string
-        api_username:
-            description:
-              - Name of the user to login into the OpenNebula RPC server. If not set
-                then the value of the C(ONE_USERNAME) environment variable is used.
-            env:
-              - name: ONE_USERNAME
-            type: string
-        api_password:
-            description:
-              - Password or a token of the user to login into OpenNebula RPC server.
-              - If not set, the value of the C(ONE_PASSWORD) environment variable is used.
-            env:
-              - name: ONE_PASSWORD
-            required: False
-            type: string
-        api_authfile:
-            description:
-              - If both I(api_username) or I(api_password) are not set, then it will try
-                authenticate with ONE auth file. Default path is C(~/.one/one_auth).
-              - Set environment variable C(ONE_AUTH) to override this path.
-            env:
-              - name: ONE_AUTH
-            required: False
-            type: string
-        hostname:
-            description: Field to match the hostname. Note C(v4_first_ip) corresponds to the first IPv4 found on VM.
-            type: string
-            default: v4_first_ip
-            choices:
-                - v4_first_ip
-                - v6_first_ip
-                - name
-        filter_by_label:
-            description: Only return servers filtered by this label.
-            type: string
-        group_by_labels:
-            description: Create host groups by vm labels
-            type: bool
-            default: True
-'''
-
-EXAMPLES = r'''
-# inventory_opennebula.yml file in YAML format
-# Example command line: ansible-inventory --list -i inventory_opennebula.yml
-
-# Pass a label filter to the API
-plugin: community.general.opennebula
-api_url: https://opennebula:2633/RPC2
-filter_by_label: Cache
-'''
-
-try:
-    import pyone
-
-    HAS_PYONE = True
-except ImportError:
-    HAS_PYONE = False
-
-from ansible.errors import AnsibleError
-from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
-from ansible.module_utils._text import to_native
-
-from collections import namedtuple
-import os
-
-
-class InventoryModule(BaseInventoryPlugin, Constructable):
-    NAME = 'community.general.opennebula'
-
-    def verify_file(self, path):
-        valid = False
-        if super(InventoryModule, self).verify_file(path):
-            if path.endswith(('opennebula.yaml', 'opennebula.yml')):
-                valid = True
-        return valid
-
-    def _get_connection_info(self):
-        url = self.get_option('api_url')
-        username = self.get_option('api_username')
-        password = self.get_option('api_password')
-        authfile = self.get_option('api_authfile')
-
-        if not username and not password:
-            if authfile is None:
-                authfile = os.path.join(os.environ.get("HOME"), ".one", "one_auth")
-            try:
-                with open(authfile, "r") as fp:
-                    authstring = fp.read().rstrip()
-                username, password = authstring.split(":")
-            except (OSError, IOError):
-                raise AnsibleError("Could not find or read ONE_AUTH file at '{e}'".format(e=authfile))
-            except Exception:
-                raise AnsibleError("Error occurs when reading ONE_AUTH file at '{e}'".format(e=authfile))
-
-        auth_params = namedtuple('auth', ('url', 'username', 'password'))
-
-        return auth_params(url=url, username=username, password=password)
-
-    def _get_vm_ipv4(self, vm):
-        nic = vm.TEMPLATE.get('NIC')
-
-        if isinstance(nic, dict):
-            nic = [nic]
-
-        for net in nic:
-            return net['IP']
-
-        return False
-
-    def _get_vm_ipv6(self, vm):
-        nic = vm.TEMPLATE.get('NIC')
-
-        if isinstance(nic, dict):
-            nic = [nic]
-
-        for net in nic:
-            if net.get('IP6_GLOBAL'):
-                return net['IP6_GLOBAL']
-
-        return False
-
-    def _get_vm_pool(self):
-        auth = self._get_connection_info()
-
-        if not (auth.username and auth.password):
-            raise AnsibleError('API Credentials missing. Check OpenNebula inventory file.')
-        else:
-            one_client = pyone.OneServer(auth.url, session=auth.username + ':' + auth.password)
-
-        # get hosts (VMs)
-        try:
-            vm_pool = one_client.vmpool.infoextended(-2, -1, -1, 3)
-        except Exception as e:
-            raise AnsibleError("Something happened during XML-RPC call: {e}".format(e=to_native(e)))
-
-        return vm_pool
-
-    def _retrieve_servers(self, label_filter=None):
-        vm_pool = self._get_vm_pool()
-
-        result = []
-
-        # iterate over hosts
-        for vm in vm_pool.VM:
-            server = vm.USER_TEMPLATE
-
-            labels = []
-            if vm.USER_TEMPLATE.get('LABELS'):
-                labels = [s for s in vm.USER_TEMPLATE.get('LABELS') if s == ',' or s == '-' or s.isalnum() or s.isspace()]
-                labels = ''.join(labels)
-                labels = labels.replace(' ', '_')
-                labels = labels.replace('-', '_')
-                labels = labels.split(',')
-
-            # filter by label
-            if label_filter is not None:
-                if label_filter not in labels:
-                    continue
-
-            server['name'] = vm.NAME
-            server['LABELS'] = labels
-            server['v4_first_ip'] = self._get_vm_ipv4(vm)
-            server['v6_first_ip'] = self._get_vm_ipv6(vm)
-
-            result.append(server)
-
-        return result
-
-    def _populate(self):
-        hostname_preference = self.get_option('hostname')
-        group_by_labels = self.get_option('group_by_labels')
-
-        # Add a top group 'one'
-        self.inventory.add_group(group='all')
-
-        filter_by_label = self.get_option('filter_by_label')
-        for server in self._retrieve_servers(filter_by_label):
-            # check for labels
-            if group_by_labels and server['LABELS']:
-                for label in server['LABELS']:
-                    self.inventory.add_group(group=label)
-                    self.inventory.add_host(host=server['name'], group=label)
-
-            self.inventory.add_host(host=server['name'], group='all')
-
-            for attribute, value in server.items():
-                self.inventory.set_variable(server['name'], attribute, value)
-
-            if hostname_preference != 'name':
-                self.inventory.set_variable(server['name'], 'ansible_host', server[hostname_preference])
-
-            if server.get('SSH_PORT'):
-                self.inventory.set_variable(server['name'], 'ansible_port', server['SSH_PORT'])
-
-    def parse(self, inventory, loader, path, cache=True):
-        if not HAS_PYONE:
-            raise AnsibleError('OpenNebula Inventory plugin requires pyone to work!')
-
-        super(InventoryModule, self).parse(inventory, loader, path)
-        self._read_config_data(path=path)
-
-        self._populate()

plugins/lookup/collection_version.py

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

plugins/lookup/nios.py

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

plugins/lookup/nios_next_ip.py

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

plugins/lookup/nios_next_network.py

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

plugins/lookup/random_words.py

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

plugins/lookup/tss.py

@@ -36,20 +36,19 @@ options:
         ini:
             - section: tss_lookup
               key: username
+        required: true
     password:
-        description:
-            - The password associated with the supplied username.
-            - Required when I(token) is not provided.
+        description: The password associated with the supplied username.
         env:
             - name: TSS_PASSWORD
         ini:
             - section: tss_lookup
               key: password
+        required: true
     domain:
         default: ""
         description:
           - The domain with which to request the OAuth2 Access Grant.
-          - Optional when I(token) is not provided.
           - Requires C(python-tss-sdk) version 1.0.0 or greater.
         env:
             - name: TSS_DOMAIN
@@ -58,17 +57,6 @@ options:
               key: domain
         required: false
         version_added: 3.6.0
-    token:
-        description:
-          - Existing token for Thycotic authorizer.
-          - If provided, I(username) and I(password) are not needed.
-          - Requires C(python-tss-sdk) version 1.0.0 or greater.
-        env:
-            - name: TSS_TOKEN
-        ini:
-            - section: tss_lookup
-              key: token
-        version_added: 3.7.0
     api_path_uri:
         default: /api/v1
         description: The path to append to the base URL to form a valid REST
@@ -95,6 +83,18 @@ _list:
 """
 
 EXAMPLES = r"""
+- hosts: localhost
+  vars:
+      secret: "{{ lookup('community.general.tss', 1) }}"
+  tasks:
+      - ansible.builtin.debug:
+          msg: >
+            the password is {{
+              (secret['items']
+                | items2dict(key_name='slug',
+                             value_name='itemValue'))['password']
+            }}
+
 - hosts: localhost
   vars:
       secret: >-
@@ -116,39 +116,10 @@ EXAMPLES = r"""
                              value_name='itemValue'))['password']
             }}
 
-- hosts: localhost
-  vars:
-      secret: >-
-        {{
-            lookup(
-                'community.general.tss',
-                102,
-                base_url='https://secretserver.domain.com/SecretServer/',
-                username='user.name',
-                password='password',
-                domain='domain'
-            )
-        }}
-  tasks:
-      - ansible.builtin.debug:
-          msg: >
-            the password is {{
-              (secret['items']
-                | items2dict(key_name='slug',
-                             value_name='itemValue'))['password']
-            }}
-
 - hosts: localhost
   vars:
       secret_password: >-
-        {{
-            ((lookup(
-                'community.general.tss',
-                102,
-                base_url='https://secretserver.domain.com/SecretServer/',
-                token='thycotic_access_token',
-            )  | from_json).get('items') | items2dict(key_name='slug', value_name='itemValue'))['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 }}
@@ -171,13 +142,12 @@ except ImportError:
     HAS_TSS_SDK = False
 
 try:
-    from thycotic.secrets.server import PasswordGrantAuthorizer, DomainPasswordGrantAuthorizer, AccessTokenAuthorizer
+    from thycotic.secrets.server import PasswordGrantAuthorizer, DomainPasswordGrantAuthorizer
 
     HAS_TSS_AUTHORIZER = True
 except ImportError:
     PasswordGrantAuthorizer = None
     DomainPasswordGrantAuthorizer = None
-    AccessTokenAuthorizer = None
     HAS_TSS_AUTHORIZER = False
 
 
@@ -239,11 +209,6 @@ class TSSClientV1(TSSClient):
 
     @staticmethod
     def _get_authorizer(**server_parameters):
-        if server_parameters.get("token"):
-            return AccessTokenAuthorizer(
-                server_parameters["token"],
-            )
-
         if server_parameters.get("domain"):
             return DomainPasswordGrantAuthorizer(
                 server_parameters["base_url"],
@@ -273,7 +238,6 @@ class LookupModule(LookupBase):
             username=self.get_option("username"),
             password=self.get_option("password"),
             domain=self.get_option("domain"),
-            token=self.get_option("token"),
             api_path_uri=self.get_option("api_path_uri"),
             token_path_uri=self.get_option("token_path_uri"),
         )

plugins/module_utils/_netapp.py

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

plugins/module_utils/identity/keycloak/keycloak.py

@@ -83,9 +83,6 @@ URL_IDENTITY_PROVIDER = "{url}/admin/realms/{realm}/identity-provider/instances/
 URL_IDENTITY_PROVIDER_MAPPERS = "{url}/admin/realms/{realm}/identity-provider/instances/{alias}/mappers"
 URL_IDENTITY_PROVIDER_MAPPER = "{url}/admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id}"
 
-URL_COMPONENTS = "{url}/admin/realms/{realm}/components"
-URL_COMPONENT = "{url}/admin/realms/{realm}/components/{id}"
-
 
 def keycloak_argument_spec():
     """
@@ -1031,7 +1028,7 @@ class KeycloakAPI(object):
         :param name: Name of the role to fetch.
         :param realm: Realm in which the role resides; default 'master'.
         """
-        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=quote(name))
+        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=name)
         try:
             return json.loads(to_native(open_url(role_url, method="GET", headers=self.restheaders,
                                                  validate_certs=self.validate_certs).read()))
@@ -1065,7 +1062,7 @@ class KeycloakAPI(object):
         :param rolerep: A RoleRepresentation of the updated role.
         :return HTTPResponse object on success
         """
-        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=quote(rolerep['name']))
+        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=rolerep['name'])
         try:
             return open_url(role_url, method='PUT', headers=self.restheaders,
                             data=json.dumps(rolerep), validate_certs=self.validate_certs)
@@ -1079,7 +1076,7 @@ class KeycloakAPI(object):
         :param name: The name of the role.
         :param realm: The realm in which this role resides, default "master".
         """
-        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=quote(name))
+        role_url = URL_REALM_ROLE.format(url=self.baseurl, realm=realm, name=name)
         try:
             return open_url(role_url, method='DELETE', headers=self.restheaders,
                             validate_certs=self.validate_certs)
@@ -1122,7 +1119,7 @@ class KeycloakAPI(object):
         if cid is None:
             self.module.fail_json(msg='Could not find client %s in realm %s'
                                       % (clientid, realm))
-        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=quote(name))
+        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=name)
         try:
             return json.loads(to_native(open_url(role_url, method="GET", headers=self.restheaders,
                                                  validate_certs=self.validate_certs).read()))
@@ -1168,7 +1165,7 @@ class KeycloakAPI(object):
         if cid is None:
             self.module.fail_json(msg='Could not find client %s in realm %s'
                                       % (clientid, realm))
-        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=quote(rolerep['name']))
+        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=rolerep['name'])
         try:
             return open_url(role_url, method='PUT', headers=self.restheaders,
                             data=json.dumps(rolerep), validate_certs=self.validate_certs)
@@ -1187,7 +1184,7 @@ class KeycloakAPI(object):
         if cid is None:
             self.module.fail_json(msg='Could not find client %s in realm %s'
                                       % (clientid, realm))
-        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=quote(name))
+        role_url = URL_CLIENT_ROLE.format(url=self.baseurl, realm=realm, id=cid, name=name)
         try:
             return open_url(role_url, method='DELETE', headers=self.restheaders,
                             validate_certs=self.validate_certs)
@@ -1604,93 +1601,3 @@ class KeycloakAPI(object):
         except Exception as e:
             self.module.fail_json(msg='Unable to delete mapper %s for identity provider %s in realm %s: %s'
                                       % (mid, alias, realm, str(e)))
-
-    def get_components(self, filter=None, realm='master'):
-        """ Fetch representations for components in a realm
-        :param realm: realm to be queried
-        :param filter: search filter
-        :return: list of representations for components
-        """
-        comps_url = URL_COMPONENTS.format(url=self.baseurl, realm=realm)
-        if filter is not None:
-            comps_url += '?%s' % filter
-
-        try:
-            return json.loads(to_native(open_url(comps_url, method='GET', headers=self.restheaders,
-                                                 validate_certs=self.validate_certs).read()))
-        except ValueError as e:
-            self.module.fail_json(msg='API returned incorrect JSON when trying to obtain list of components for realm %s: %s'
-                                      % (realm, str(e)))
-        except Exception as e:
-            self.module.fail_json(msg='Could not obtain list of components for realm %s: %s'
-                                      % (realm, str(e)))
-
-    def get_component(self, cid, realm='master'):
-        """ Fetch component representation from a realm using its cid.
-        If the component does not exist, None is returned.
-        :param cid: Unique ID of the component to fetch.
-        :param realm: Realm in which the component resides; default 'master'.
-        """
-        comp_url = URL_COMPONENT.format(url=self.baseurl, realm=realm, id=cid)
-        try:
-            return json.loads(to_native(open_url(comp_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 fetch component %s in realm %s: %s'
-                                          % (cid, realm, str(e)))
-        except Exception as e:
-            self.module.fail_json(msg='Could not fetch component %s in realm %s: %s'
-                                      % (cid, realm, str(e)))
-
-    def create_component(self, comprep, realm='master'):
-        """ Create an component.
-        :param comprep: Component representation of the component to be created.
-        :param realm: Realm in which this component resides, default "master".
-        :return: Component representation of the created component
-        """
-        comps_url = URL_COMPONENTS.format(url=self.baseurl, realm=realm)
-        try:
-            resp = open_url(comps_url, method='POST', headers=self.restheaders,
-                            data=json.dumps(comprep), validate_certs=self.validate_certs)
-            comp_url = resp.getheader('Location')
-            if comp_url is None:
-                self.module.fail_json(msg='Could not create component in realm %s: %s'
-                                          % (realm, 'unexpected response'))
-            return json.loads(to_native(open_url(comp_url, method="GET", headers=self.restheaders,
-                                                 validate_certs=self.validate_certs).read()))
-        except Exception as e:
-            self.module.fail_json(msg='Could not create component in realm %s: %s'
-                                      % (realm, str(e)))
-
-    def update_component(self, comprep, realm='master'):
-        """ Update an existing component.
-        :param comprep: Component representation of the component to be updated.
-        :param realm: Realm in which this component resides, default "master".
-        :return HTTPResponse object on success
-        """
-        cid = comprep.get('id')
-        if cid is None:
-            self.module.fail_json(msg='Cannot update component without id')
-        comp_url = URL_COMPONENT.format(url=self.baseurl, realm=realm, id=cid)
-        try:
-            return open_url(comp_url, method='PUT', headers=self.restheaders,
-                            data=json.dumps(comprep), validate_certs=self.validate_certs)
-        except Exception as e:
-            self.module.fail_json(msg='Could not update component %s in realm %s: %s'
-                                      % (cid, realm, str(e)))
-
-    def delete_component(self, cid, realm='master'):
-        """ Delete an component.
-        :param cid: Unique ID of the component.
-        :param realm: Realm in which this component resides, default "master".
-        """
-        comp_url = URL_COMPONENT.format(url=self.baseurl, realm=realm, id=cid)
-        try:
-            return open_url(comp_url, method='DELETE', headers=self.restheaders,
-                            validate_certs=self.validate_certs)
-        except Exception as e:
-            self.module.fail_json(msg='Unable to delete component %s in realm %s: %s'
-                                      % (cid, realm, str(e)))

plugins/module_utils/ipa.py

@@ -31,7 +31,6 @@ def _env_then_dns_fallback(*args, **kwargs):
         result = env_fallback(*args, **kwargs)
         if result == '':
             raise AnsibleFallbackNotFound
-        return result
     except AnsibleFallbackNotFound:
         # If no host was given, we try to guess it from IPA.
         # The ipa-ca entry is a standard entry that IPA will have set for
@@ -179,10 +178,10 @@ class IPAClient(object):
                 result.append(key)
         return result
 
-    def modify_if_diff(self, name, ipa_list, module_list, add_method, remove_method, item=None, append=None):
+    def modify_if_diff(self, name, ipa_list, module_list, add_method, remove_method, item=None):
         changed = False
         diff = list(set(ipa_list) - set(module_list))
-        if append is not True and len(diff) > 0:
+        if len(diff) > 0:
             changed = True
             if not self.module.check_mode:
                 if item:

plugins/module_utils/mh/mixins/cmd.py

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

plugins/module_utils/net_tools/nios/api.py

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

plugins/module_utils/redfish_utils.py

@@ -29,7 +29,7 @@ FAIL_MSG = 'Issuing a data modification command without specifying the '\
 class RedfishUtils(object):
 
     def __init__(self, creds, root_uri, timeout, module, resource_id=None,
-                 data_modification=False, strip_etag_quotes=False):
+                 data_modification=False):
         self.root_uri = root_uri
         self.creds = creds
         self.timeout = timeout
@@ -37,7 +37,6 @@ class RedfishUtils(object):
         self.service_root = '/redfish/v1/'
         self.resource_id = resource_id
         self.data_modification = data_modification
-        self.strip_etag_quotes = strip_etag_quotes
         self._init_session()
 
     def _auth_params(self, headers):
@@ -122,8 +121,6 @@ class RedfishUtils(object):
             if not etag:
                 etag = r['data'].get('@odata.etag')
             if etag:
-                if self.strip_etag_quotes:
-                    etag = etag.strip('"')
                 req_headers['If-Match'] = etag
         username, password, basic_auth = self._auth_params(req_headers)
         try:
@@ -979,8 +976,6 @@ class RedfishUtils(object):
             payload['Password'] = user.get('account_password')
         if user.get('account_roleid'):
             payload['RoleId'] = user.get('account_roleid')
-        if user.get('account_id'):
-            payload['Id'] = user.get('account_id')
 
         response = self.post_request(self.root_uri + self.accounts_uri, payload)
         if not response['ret']:
@@ -1605,6 +1600,9 @@ class RedfishUtils(object):
         cur_boot_next = boot.get('BootNext')
         cur_override_mode = boot.get('BootSourceOverrideMode')
 
+        if not boot_override_mode:
+            boot_override_mode = cur_override_mode
+
         if override_enabled == 'Disabled':
             payload = {
                 'Boot': {
@@ -1640,18 +1638,16 @@ class RedfishUtils(object):
                 }
             }
         else:
-            if (cur_enabled == override_enabled and target == bootdevice and
-                    (cur_override_mode == boot_override_mode or not boot_override_mode)):
+            if cur_enabled == override_enabled and target == bootdevice and cur_override_mode == boot_override_mode:
                 # If properties are already set, no changes needed
                 return {'ret': True, 'changed': False}
             payload = {
                 'Boot': {
                     'BootSourceOverrideEnabled': override_enabled,
+                    'BootSourceOverrideMode': boot_override_mode,
                     'BootSourceOverrideTarget': bootdevice
                 }
             }
-            if boot_override_mode:
-                payload['Boot']['BootSourceOverrideMode'] = boot_override_mode
 
         response = self.patch_request(self.root_uri + self.systems_uri, payload)
         if response['ret'] is False:
@@ -2761,9 +2757,7 @@ class RedfishUtils(object):
             if isinstance(set_value, dict):
                 for subprop in payload[property].keys():
                     if subprop not in target_ethernet_current_setting[property]:
-                        # Not configured already; need to apply the request
-                        need_change = True
-                        break
+                        return {'ret': False, 'msg': "Sub-property %s in nic_config is invalid" % subprop}
                     sub_set_value = payload[property][subprop]
                     sub_cur_value = target_ethernet_current_setting[property][subprop]
                     if sub_set_value != sub_cur_value:
@@ -2777,9 +2771,7 @@ class RedfishUtils(object):
                 for i in range(len(set_value)):
                     for subprop in payload[property][i].keys():
                         if subprop not in target_ethernet_current_setting[property][i]:
-                            # Not configured already; need to apply the request
-                            need_change = True
-                            break
+                            return {'ret': False, 'msg': "Sub-property %s in nic_config is invalid" % subprop}
                         sub_set_value = payload[property][i][subprop]
                         sub_cur_value = target_ethernet_current_setting[property][i][subprop]
                         if sub_set_value != sub_cur_value:

plugins/module_utils/redis.py

@@ -1,93 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import absolute_import, division, print_function
-
-from ansible.module_utils.basic import missing_required_lib
-__metaclass__ = type
-
-import traceback
-
-REDIS_IMP_ERR = None
-try:
-    from redis import Redis
-    from redis import __version__ as redis_version
-    HAS_REDIS_PACKAGE = True
-except ImportError:
-    REDIS_IMP_ERR = traceback.format_exc()
-    HAS_REDIS_PACKAGE = False
-
-try:
-    import certifi
-    HAS_CERTIFI_PACKAGE = True
-except ImportError:
-    CERTIFI_IMPORT_ERROR = traceback.format_exc()
-    HAS_CERTIFI_PACKAGE = False
-
-
-def fail_imports(module):
-    errors = []
-    traceback = []
-    if not HAS_REDIS_PACKAGE:
-        errors.append(missing_required_lib('redis'))
-        traceback.append(REDIS_IMP_ERR)
-    if not HAS_CERTIFI_PACKAGE:
-        errors.append(missing_required_lib('certifi'))
-        traceback.append(CERTIFI_IMPORT_ERROR)
-    if errors:
-        module.fail_json(errors=errors, traceback='\n'.join(traceback))
-
-
-def redis_auth_argument_spec():
-    return dict(
-        login_host=dict(type='str',
-                        default='localhost',),
-        login_user=dict(type='str'),
-        login_password=dict(type='str',
-                            no_log=True
-                            ),
-        login_port=dict(type='int', default=6379),
-        tls=dict(type='bool',
-                 default=True),
-        validate_certs=dict(type='bool',
-                            default=True
-                            ),
-        ca_certs=dict(type='str')
-    )
-
-
-class RedisAnsible(object):
-    '''Base class for Redis module'''
-
-    def __init__(self, module):
-        self.module = module
-        self.connection = self._connect()
-
-    def _connect(self):
-        login_host = self.module.params['login_host']
-        login_user = self.module.params['login_user']
-        login_password = self.module.params['login_password']
-        login_port = self.module.params['login_port']
-        tls = self.module.params['tls']
-        validate_certs = 'required' if self.module.params['validate_certs'] else None
-        ca_certs = self.module.params['ca_certs']
-        if tls and ca_certs is None:
-            ca_certs = str(certifi.where())
-        if tuple(map(int, redis_version.split('.'))) < (3, 4, 0) and login_user is not None:
-            self.module.fail_json(
-                msg='The option `username` in only supported with redis >= 3.4.0.')
-        params = {'host': login_host,
-                  'port': login_port,
-                  'password': login_password,
-                  'ssl_ca_certs': ca_certs,
-                  'ssl_cert_reqs': validate_certs,
-                  'ssl': tls}
-        if login_user is not None:
-            params['username'] = login_user
-        try:
-            return Redis(**params)
-        except Exception as e:
-            self.module.fail_json(msg='{0}'.format(str(e)))
-        return None

plugins/module_utils/rundeck.py

@@ -1,94 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Phillipe Smith <phsmithcc@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
-
-import json
-
-from ansible.module_utils.urls import fetch_url, url_argument_spec
-from ansible.module_utils.common.text.converters import to_native
-
-
-def api_argument_spec():
-    '''
-    Creates an argument spec that can be used with any module
-    that will be requesting content via Rundeck API
-    '''
-    api_argument_spec = url_argument_spec()
-    api_argument_spec.update(dict(
-        url=dict(required=True, type="str"),
-        api_version=dict(type="int", default=39),
-        api_token=dict(required=True, type="str", no_log=True)
-    ))
-
-    return api_argument_spec
-
-
-def api_request(module, endpoint, data=None, method="GET"):
-    """Manages Rundeck API requests via HTTP(S)
-
-    :arg module:   The AnsibleModule (used to get url, api_version, api_token, etc).
-    :arg endpoint: The API endpoint to be used.
-    :kwarg data:   The data to be sent (in case of POST/PUT).
-    :kwarg method: "POST", "PUT", etc.
-
-    :returns: A tuple of (**response**, **info**). Use ``response.read()`` to read the data.
-        The **info** contains the 'status' and other meta data. When a HttpError (status >= 400)
-        occurred then ``info['body']`` contains the error response data::
-
-    Example::
-
-        data={...}
-        resp, info = fetch_url(module,
-                               "http://rundeck.example.org",
-                               data=module.jsonify(data),
-                               method="POST")
-        status_code = info["status"]
-        body = resp.read()
-        if status_code >= 400 :
-            body = info['body']
-    """
-
-    response, info = fetch_url(
-        module=module,
-        url="%s/api/%s/%s" % (
-            module.params["url"],
-            module.params["api_version"],
-            endpoint
-        ),
-        data=json.dumps(data),
-        method=method,
-        headers={
-            "Content-Type": "application/json",
-            "Accept": "application/json",
-            "X-Rundeck-Auth-Token": module.params["api_token"]
-        }
-    )
-
-    if info["status"] == 403:
-        module.fail_json(msg="Token authorization failed",
-                         execution_info=json.loads(info["body"]))
-    if info["status"] == 409:
-        module.fail_json(msg="Job executions limit reached",
-                         execution_info=json.loads(info["body"]))
-    elif info["status"] >= 500:
-        module.fail_json(msg="Rundeck API error",
-                         execution_info=json.loads(info["body"]))
-
-    try:
-        content = response.read()
-        json_response = json.loads(content)
-        return json_response, info
-    except AttributeError as error:
-        module.fail_json(msg="Rundeck API request error",
-                         exception=to_native(error),
-                         execution_info=info)
-    except ValueError as error:
-        module.fail_json(
-            msg="No valid JSON response",
-            exception=to_native(error),
-            execution_info=content
-        )

plugins/module_utils/source_control/bitbucket.py

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

plugins/modules/cloud/lxd/lxd_container.py

@@ -23,47 +23,40 @@ options:
         required: true
     architecture:
         description:
-          - 'The architecture for the container (for example C(x86_64) or C(i686)).
-            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
+          - The architecture for the container (e.g. "x86_64" or "i686").
+            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1)
         type: str
         required: false
     config:
         description:
-          - 'The config for the container (for example C({"limits.cpu": "2"})).
-            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
-          - If the container already exists and its "config" values in metadata
-            obtained from GET /1.0/containers/<name>
+          - 'The config for the container (e.g. {"limits.cpu": "2"}).
+            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1)'
+          - If the container already exists and its "config" value in metadata
+            obtained from
+            GET /1.0/containers/<name>
             U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#10containersname)
-            are different, this module tries to apply the configurations.
-          - The keys starting with C(volatile.) are ignored for this comparison when I(ignore_volatile_options=true).
+            are different, they this module tries to apply the configurations.
+          - The key starts with 'volatile.' are ignored for this comparison.
+          - Not all config values are supported to apply the existing container.
+            Maybe you need to delete and recreate a container.
         type: dict
         required: false
-    ignore_volatile_options:
-        description:
-          - If set to C(true), options starting with C(volatile.) are ignored. As a result,
-            they are reapplied for each execution.
-          - This default behavior can be changed by setting this option to C(false).
-          - The current default value C(true) is deprecated since community.general 4.0.0,
-            and will change to C(false) in community.general 6.0.0.
-        type: bool
-        required: false
-        version_added: 3.7.0
     profiles:
         description:
-          - Profile to be used by the container.
+          - Profile to be used by the container
         type: list
         elements: str
     devices:
         description:
           - 'The devices for the container
-            (for example C({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})).
-            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).'
+            (e.g. { "rootfs": { "path": "/dev/kvm", "type": "unix-char" }).
+            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1)'
         type: dict
         required: false
     ephemeral:
         description:
-          - Whether or not the container is ephemeral (for example C(true) or C(false)).
-            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1).
+          - Whether or not the container is ephemeral (e.g. true or false).
+            See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1)
         required: false
         type: bool
     source:
@@ -75,7 +68,7 @@ options:
                     "protocol": "lxd",
                     "alias": "ubuntu/xenial/amd64" }).'
           - 'See U(https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1) for complete API documentation.'
-          - 'Note that C(protocol) accepts two choices: C(lxd) or C(simplestreams).'
+          - 'Note that C(protocol) accepts two choices: C(lxd) or C(simplestreams)'
         required: false
         type: dict
     state:
@@ -151,10 +144,10 @@ options:
     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/).'
+          - You need to set this password on the LXD server before
+            running this module using the following command.
+            lxc config set core.trust_password <some random password>
+            See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/)
           - If trust_password is set, this module send a request for
             authentication before sending any requests.
         required: false
@@ -183,7 +176,6 @@ EXAMPLES = '''
     - name: Create a started container
       community.general.lxd_container:
         name: mycontainer
-        ignore_volatile_options: true
         state: started
         source:
           type: image
@@ -217,7 +209,6 @@ EXAMPLES = '''
     - name: Create a started container
       community.general.lxd_container:
         name: mycontainer
-        ignore_volatile_options: true
         state: started
         source:
           type: image
@@ -288,7 +279,6 @@ EXAMPLES = '''
     - name: Create LXD container
       community.general.lxd_container:
         name: new-container-1
-        ignore_volatile_options: true
         state: started
         source:
           type: image
@@ -299,7 +289,6 @@ EXAMPLES = '''
     - name: Create container on another node
       community.general.lxd_container:
         name: new-container-2
-        ignore_volatile_options: true
         state: started
         source:
           type: image
@@ -568,7 +557,7 @@ class LXDContainerManagement(object):
     def _needs_to_change_container_config(self, key):
         if key not in self.config:
             return False
-        if key == 'config' and self.ignore_volatile_options:  # the old behavior is to ignore configurations by keyword "volatile"
+        if key == 'config':
             old_configs = dict((k, v) for k, v in self.old_container_json['metadata'][key].items() if not k.startswith('volatile.'))
             for k, v in self.config['config'].items():
                 if k not in old_configs:
@@ -576,14 +565,6 @@ class LXDContainerManagement(object):
                 if old_configs[k] != v:
                     return True
             return False
-        elif key == 'config':  # next default behavior
-            old_configs = dict((k, v) for k, v in self.old_container_json['metadata'][key].items())
-            for k, v in self.config['config'].items():
-                if k not in old_configs:
-                    return True
-                if old_configs[k] != v:
-                    return True
-            return False
         else:
             old_configs = self.old_container_json['metadata'][key]
             return self.config[key] != old_configs
@@ -625,7 +606,6 @@ class LXDContainerManagement(object):
         try:
             if self.trust_password is not None:
                 self.client.authenticate(self.trust_password)
-            self.ignore_volatile_options = self.module.params.get('ignore_volatile_options')
 
             self.old_container_json = self._get_container_json()
             self.old_state = self._container_json_to_module_state(self.old_container_json)
@@ -671,9 +651,6 @@ def main():
             config=dict(
                 type='dict',
             ),
-            ignore_volatile_options=dict(
-                type='bool',
-            ),
             devices=dict(
                 type='dict',
             ),
@@ -727,15 +704,6 @@ def main():
         supports_check_mode=False,
     )
 
-    if module.params['ignore_volatile_options'] is None:
-        module.params['ignore_volatile_options'] = True
-        module.deprecate(
-            'If the keyword "volatile" is used in a playbook in the config'
-            'section, a "changed" message will appear with every run, even without a change'
-            'to the playbook.'
-            'This will change in the future. Please test your scripts'
-            'by "ignore_volatile_options: false". To keep the old behavior, set that option explicitly to "true"',
-            version='6.0.0', collection_name='community.general')
     lxd_manage = LXDContainerManagement(module=module)
     lxd_manage.run()
 

plugins/modules/cloud/misc/proxmox.py

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

plugins/modules/cloud/misc/proxmox_group_info.py

@@ -131,7 +131,7 @@ def main():
     group = module.params['group']
 
     if group:
-        groups = [proxmox.get_group(groupid=group)]
+        groups = [proxmox.get_group(group=group)]
     else:
         groups = proxmox.get_groups()
     result['proxmox_groups'] = [group.group for group in groups]

plugins/modules/cloud/misc/proxmox_kvm.py

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

plugins/modules/cloud/misc/proxmox_tasks_info.py

@@ -1,186 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Andreas Botzner (@paginabianca) <andreas at botzner dot com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
-
-
-DOCUMENTATION = r'''
----
-module: proxmox_tasks_info
-short_description: Retrieve information about one or more Proxmox VE tasks
-version_added: 3.8.0
-description:
-  - Retrieve information about one or more Proxmox VE tasks.
-author: 'Andreas Botzner (@paginabianca) <andreas at botzner dot com>'
-options:
-  node:
-    description:
-      - Node where to get tasks.
-    required: true
-    type: str
-  task:
-    description:
-      - Return specific task.
-    aliases: ['upid', 'name']
-    type: str
-extends_documentation_fragment:
-    - community.general.proxmox.documentation
-'''
-
-
-EXAMPLES = '''
-- name: List tasks on node01
-  community.general.proxmox_task_info:
-    api_host: proxmoxhost
-    api_user: root@pam
-    api_password: '{{ password | default(omit) }}'
-    api_token_id: '{{ token_id | default(omit) }}'
-    api_token_secret: '{{ token_secret | default(omit) }}'
-    node: node01
-  register: result
-
-- name: Retrieve information about specific tasks on node01
-  community.general.proxmox_task_info:
-    api_host: proxmoxhost
-    api_user: root@pam
-    api_password: '{{ password | default(omit) }}'
-    api_token_id: '{{ token_id | default(omit) }}'
-    api_token_secret: '{{ token_secret | default(omit) }}'
-    task: 'UPID:node01:00003263:16167ACE:621EE230:srvreload:networking:root@pam:'
-    node: node01
-  register: proxmox_tasks
-'''
-
-
-RETURN = '''
-proxmox_tasks:
-    description: List of tasks.
-    returned: on success
-    type: list
-    elements: dict
-    contains:
-      id:
-        description: ID of the task.
-        returned: on success
-        type: str
-      node:
-        description: Node name.
-        returned: on success
-        type: str
-      pid:
-        description: PID of the task.
-        returned: on success
-        type: int
-      pstart:
-        description: pastart of the task.
-        returned: on success
-        type: int
-      starttime:
-        description: Starting time of the task.
-        returned: on success
-        type: int
-      type:
-        description: Type of the task.
-        returned: on success
-        type: str
-      upid:
-        description: UPID of the task.
-        returned: on success
-        type: str
-      user:
-        description: User that owns the task.
-        returned: on success
-        type: str
-      endtime:
-        description: Endtime of the task.
-        returned: on success, can be absent
-        type: int
-      status:
-        description: Status of the task.
-        returned: on success, can be absent
-        type: str
-      failed:
-        description: If the task failed.
-        returned: when status is defined
-        type: bool
-msg:
-    description: Short message.
-    returned: on failure
-    type: str
-    sample: 'Task: UPID:xyz:xyz does not exist on node: proxmoxnode'
-'''
-
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib
-from ansible_collections.community.general.plugins.module_utils.proxmox import (
-    proxmox_auth_argument_spec, ProxmoxAnsible, HAS_PROXMOXER, PROXMOXER_IMP_ERR)
-
-
-class ProxmoxTaskInfoAnsible(ProxmoxAnsible):
-    def get_task(self, upid, node):
-        tasks = self.get_tasks(node)
-        for task in tasks:
-            if task.info['upid'] == upid:
-                return [task]
-
-    def get_tasks(self, node):
-        tasks = self.proxmox_api.nodes(node).tasks.get()
-        return [ProxmoxTask(task) for task in tasks]
-
-
-class ProxmoxTask:
-    def __init__(self, task):
-        self.info = dict()
-        for k, v in task.items():
-            if k == 'status' and isinstance(v, str):
-                self.info[k] = v
-                if v != 'OK':
-                    self.info['failed'] = True
-            else:
-                self.info[k] = v
-
-
-def proxmox_task_info_argument_spec():
-    return dict(
-        task=dict(type='str', aliases=['upid', 'name'], required=False),
-        node=dict(type='str', required=True),
-    )
-
-
-def main():
-    module_args = proxmox_auth_argument_spec()
-    task_info_args = proxmox_task_info_argument_spec()
-    module_args.update(task_info_args)
-
-    module = AnsibleModule(
-        argument_spec=module_args,
-        required_together=[('api_token_id', 'api_token_secret'),
-                           ('api_user', 'api_password')],
-        required_one_of=[('api_password', 'api_token_id')],
-        supports_check_mode=True)
-    result = dict(changed=False)
-
-    if not HAS_PROXMOXER:
-        module.fail_json(msg=missing_required_lib(
-            'proxmoxer'), exception=PROXMOXER_IMP_ERR)
-    proxmox = ProxmoxTaskInfoAnsible(module)
-    upid = module.params['task']
-    node = module.params['node']
-    if upid:
-        tasks = proxmox.get_task(upid=upid, node=node)
-    else:
-        tasks = proxmox.get_tasks(node=node)
-    if tasks is not None:
-        result['proxmox_tasks'] = [task.info for task in tasks]
-        module.exit_json(**result)
-    else:
-        result['msg'] = 'Task: {0} does not exist on node: {1}.'.format(
-            upid, node)
-        module.fail_json(**result)
-
-
-if __name__ == '__main__':
-    main()

plugins/modules/cloud/misc/terraform.py

@@ -137,11 +137,6 @@ options:
     type: bool
     default: false
     version_added: '3.3.0'
-  parallelism:
-    description:
-      - Restrict concurrent operations when Terraform applies the plan.
-    type: int
-    version_added: '3.8.0'
 notes:
    - To just run a `terraform plan`, use check mode.
 requirements: [ "terraform" ]
@@ -368,7 +363,6 @@ def main():
             init_reconfigure=dict(type='bool', default=False),
             overwrite_init=dict(type='bool', default=True),
             check_destroy=dict(type='bool', default=False),
-            parallelism=dict(type='int'),
         ),
         required_if=[('state', 'planned', ['plan_file'])],
         supports_check_mode=True,
@@ -421,9 +415,6 @@ def main():
     elif state == 'absent':
         command.extend(DESTROY_ARGS)
 
-    if state == 'present' and module.params.get('parallelism') is not None:
-        command.append('-parallelism=%d' % module.params.get('parallelism'))
-
     variables_args = []
     for k, v in variables.items():
         variables_args.extend([

plugins/modules/cloud/opennebula/one_image.py

@@ -306,7 +306,7 @@ def rename_image(module, client, image, new_name):
 
     tmp_image = get_image_by_name(module, client, new_name)
     if tmp_image:
-        module.fail_json(msg="Name '" + new_name + "' is already taken by IMAGE with id=" + str(tmp_image.ID))
+        module.fail_json(msg="Name '" + new_name + "' is already taken by IMAGE with id=" + str(tmp_image.id))
 
     if not module.check_mode:
         client.image.rename(image.ID, new_name)

plugins/modules/cloud/scaleway/scaleway_security_group_rule.py

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

plugins/modules/clustering/consul/consul.py

@@ -84,7 +84,7 @@ options:
         description:
           - the address to advertise that the service will be listening on.
             This value will be passed as the I(address) parameter to Consul's
-            C(/v1/agent/service/register) API method, so refer to the Consul API
+            U(/v1/agent/service/register) API method, so refer to the Consul API
             documentation for further details.
     tags:
         type: list

plugins/modules/database/misc/redis_data.py

@@ -1,249 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-module: redis_data
-short_description: Set key value pairs in Redis
-version_added: 3.7.0
-description:
-   - Set key value pairs in Redis database.
-author: "Andreas Botzner (@paginabianca)"
-options:
-    key:
-        description:
-            - Database key.
-        required: true
-        type: str
-    value:
-        description:
-            - Value that key should be set to.
-        required: false
-        type: str
-    expiration:
-        description:
-            - Expiration time in milliseconds.
-              Setting this flag will always result in a change in the database.
-        required: false
-        type: int
-    non_existing:
-        description:
-            - Only set key if it does not already exist.
-        required: false
-        type: bool
-    existing:
-        description:
-            - Only set key if it already exists.
-        required: false
-        type: bool
-    keep_ttl:
-        description:
-            - Retain the time to live associated with the key.
-        required: false
-        type: bool
-    state:
-        description:
-            - State of the key.
-        default: present
-        type: str
-        choices:
-            - present
-            - absent
-
-extends_documentation_fragment:
-  - community.general.redis.documentation
-
-seealso:
-    - module: community.general.redis_data_info
-    - module: community.general.redis
-'''
-
-EXAMPLES = '''
-- name: Set key foo=bar on localhost with no username
-  community.general.redis_data:
-    login_host: localhost
-    login_password: supersecret
-    key: foo
-    value: bar
-    state: present
-
-- name: Set key foo=bar if non existing with expiration of 30s
-  community.general.redis_data:
-    login_host: localhost
-    login_password: supersecret
-    key: foo
-    value: bar
-    non_existing: true
-    expiration: 30000
-    state: present
-
-- name: Set key foo=bar if existing and keep current TTL
-  community.general.redis_data:
-    login_host: localhost
-    login_password: supersecret
-    key: foo
-    value: bar
-    existing: true
-    keep_ttl: true
-
-- name: Set key foo=bar on redishost with custom ca-cert file
-  community.general.redis_data:
-    login_host: redishost
-    login_password: supersecret
-    login_user: someuser
-    validate_certs: true
-    ssl_ca_certs: /path/to/ca/certs
-    key: foo
-    value: bar
-
-- name: Delete key foo on localhost with no username
-  community.general.redis_data:
-    login_host: localhost
-    login_password: supersecret
-    key: foo
-    state: absent
-'''
-
-RETURN = '''
-old_value:
-  description: Value of key before setting.
-  returned: on_success if state is C(present) and key exists in database.
-  type: str
-  sample: 'old_value_of_key'
-value:
-  description: Value key was set to.
-  returned: on success if state is C(present).
-  type: str
-  sample: 'new_value_of_key'
-msg:
-  description: A short message.
-  returned: always
-  type: str
-  sample: 'Set key: foo to bar'
-'''
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.community.general.plugins.module_utils.redis import (
-    fail_imports, redis_auth_argument_spec, RedisAnsible)
-
-
-def main():
-    redis_auth_args = redis_auth_argument_spec()
-    module_args = dict(
-        key=dict(type='str', required=True, no_log=False),
-        value=dict(type='str', required=False),
-        expiration=dict(type='int', required=False),
-        non_existing=dict(type='bool', required=False),
-        existing=dict(type='bool', required=False),
-        keep_ttl=dict(type='bool', required=False),
-        state=dict(type='str', default='present',
-                   choices=['present', 'absent']),
-    )
-    module_args.update(redis_auth_args)
-
-    module = AnsibleModule(
-        argument_spec=module_args,
-        supports_check_mode=True,
-        required_if=[('state', 'present', ('value',))],
-        mutually_exclusive=[['non_existing', 'existing'],
-                            ['keep_ttl', 'expiration']],)
-    fail_imports(module)
-
-    redis = RedisAnsible(module)
-
-    key = module.params['key']
-    value = module.params['value']
-    px = module.params['expiration']
-    nx = module.params['non_existing']
-    xx = module.params['existing']
-    keepttl = module.params['keep_ttl']
-    state = module.params['state']
-    set_args = {'name': key, 'value': value, 'px': px,
-                'nx': nx, 'xx': xx, 'keepttl': keepttl}
-
-    result = {'changed': False}
-
-    old_value = None
-    try:
-        old_value = redis.connection.get(key)
-    except Exception as e:
-        msg = 'Failed to get value of key: {0} with exception: {1}'.format(
-            key, str(e))
-        result['msg'] = msg
-        module.fail_json(**result)
-
-    if state == 'absent':
-        if module.check_mode:
-            if old_value is None:
-                msg = 'Key: {0} not present'.format(key)
-                result['msg'] = msg
-                module.exit_json(**result)
-            else:
-                msg = 'Deleted key: {0}'.format(key)
-                result['msg'] = msg
-                module.exit_json(**result)
-        try:
-            ret = redis.connection.delete(key)
-            if ret == 0:
-                msg = 'Key: {0} not present'.format(key)
-                result['msg'] = msg
-                module.exit_json(**result)
-            else:
-                msg = 'Deleted key: {0}'.format(key)
-                result['msg'] = msg
-                result['changed'] = True
-                module.exit_json(**result)
-        except Exception as e:
-            msg = 'Failed to delete key: {0} with exception: {1}'.format(
-                key, str(e))
-            result['msg'] = msg
-            module.fail_json(**result)
-
-    old_value = None
-    try:
-        old_value = redis.connection.get(key)
-    except Exception as e:
-        msg = 'Failed to get value of key: {0} with exception: {1}'.format(
-            key, str(e))
-        result['msg'] = msg
-        module.fail_json(**result)
-
-    result['old_value'] = old_value
-    if old_value == value and keepttl is not False and px is None:
-        msg = 'Key {0} already has desired value'.format(key)
-        result['msg'] = msg
-        result['value'] = value
-        module.exit_json(**result)
-    if module.check_mode:
-        result['msg'] = 'Set key: {0}'.format(key)
-        result['value'] = value
-        module.exit_json(**result)
-    try:
-        ret = redis.connection.set(**set_args)
-        if ret is None:
-            if nx:
-                msg = 'Could not set key: {0}. Key already present.'.format(
-                    key)
-            else:
-                msg = 'Could not set key: {0}. Key not present.'.format(key)
-            result['msg'] = msg
-            module.fail_json(**result)
-        msg = 'Set key: {0}'.format(key)
-        result['msg'] = msg
-        result['changed'] = True
-        result['value'] = value
-        module.exit_json(**result)
-    except Exception as e:
-        msg = 'Failed to set key: {0} with exception: {2}'.format(key, str(e))
-        result['msg'] = msg
-        module.fail_json(**result)
-
-
-if __name__ == '__main__':
-    main()

plugins/modules/database/misc/redis_data_incr.py

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

plugins/modules/database/misc/redis_data_info.py

@@ -1,111 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-module: redis_data_info
-short_description: Get value of key in Redis database
-version_added: 3.7.0
-description:
-  - Get value of keys in Redis database.
-author: "Andreas Botzner (@paginabianca)"
-options:
-  key:
-    description:
-      - Database key.
-    type: str
-    required: true
-
-extends_documentation_fragment:
-  - community.general.redis
-
-seealso:
-  - module: community.general.redis_info
-  - module: community.general.redis
-'''
-
-EXAMPLES = '''
-- name: Get key foo=bar from loalhost with no username
-  community.general.redis_data_info:
-    login_host: localhost
-    login_password: supersecret
-    key: foo
-
-- name: Get key foo=bar on redishost with custom ca-cert file
-  community.general.redis_data_info:
-    login_host: redishost
-    login_password: supersecret
-    login_user: somuser
-    validate_certs: true
-    ssl_ca_certs: /path/to/ca/certs
-    key: foo
-'''
-
-RETURN = '''
-exists:
-  description: If they key exists in the database.
-  returned: on success
-  type: bool
-value:
-  description: Value key was set to.
-  returned: if existing
-  type: str
-  sample: 'value_of_some_key'
-msg:
-  description: A short message.
-  returned: always
-  type: str
-  sample: 'Got key: foo with value: bar'
-'''
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.community.general.plugins.module_utils.redis import (
-    fail_imports, redis_auth_argument_spec, RedisAnsible)
-
-
-def main():
-    redis_auth_args = redis_auth_argument_spec()
-    module_args = dict(
-        key=dict(type='str', required=True, no_log=False),
-    )
-    module_args.update(redis_auth_args)
-
-    module = AnsibleModule(
-        argument_spec=module_args,
-        supports_check_mode=True,
-    )
-    fail_imports(module)
-
-    redis = RedisAnsible(module)
-
-    key = module.params['key']
-    result = {'changed': False}
-
-    value = None
-    try:
-        value = redis.connection.get(key)
-    except Exception as e:
-        msg = 'Failed to get value of key "{0}" with exception: {1}'.format(
-            key, str(e))
-        result['msg'] = msg
-        module.fail_json(**result)
-
-    if value is None:
-        msg = 'Key "{0}" does not exist in database'.format(key)
-        result['exists'] = False
-    else:
-        msg = 'Got key "{0}"'.format(key)
-        result['value'] = value
-        result['exists'] = True
-    result['msg'] = msg
-    module.exit_json(**result)
-
-
-if __name__ == '__main__':
-    main()

plugins/modules/database/mssql/mssql_script.py

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

plugins/modules/dnf_versionlock.py

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

plugins/modules/files/archive.py

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

plugins/modules/files/xattr.py

@@ -158,7 +158,7 @@ def _run_xattr(module, cmd, check_rc=True):
         if line.startswith('#') or line == '':
             pass
         elif '=' in line:
-            (key, val) = line.split('=', 1)
+            (key, val) = line.split('=')
             result[key] = val.strip('"')
         else:
             result[line] = ''

plugins/modules/identity/ipa/ipa_config.py

@@ -72,12 +72,6 @@ options:
     aliases: ["searchtimelimit"]
     type: int
     version_added: '2.5.0'
-  ipaselinuxusermaporder:
-    description: The SELinux user map order (order in increasing priority of SELinux users).
-    aliases: ["selinuxusermaporder"]
-    type: list
-    elements: str
-    version_added: '3.7.0'
   ipauserauthtype:
     description: The authentication type to use by default.
     aliases: ["userauthtype"]
@@ -187,18 +181,6 @@ EXAMPLES = r'''
     ipa_host: localhost
     ipa_user: admin
     ipa_pass: supersecret
-
-- name: Ensure the SELinux user map order is set
-  community.general.ipa_config:
-    ipaselinuxusermaporder:
-      - "guest_u:s0"
-      - "xguest_u:s0"
-      - "user_u:s0"
-      - "staff_u:s0-s0:c0.c1023"
-      - "unconfined_u:s0-s0:c0.c1023"
-    ipa_host: localhost
-    ipa_user: admin
-    ipa_pass: supersecret
 '''
 
 RETURN = r'''
@@ -231,8 +213,8 @@ def get_config_dict(ipaconfigstring=None, ipadefaultloginshell=None,
                     ipagroupsearchfields=None, ipahomesrootdir=None,
                     ipakrbauthzdata=None, ipamaxusernamelength=None,
                     ipapwdexpadvnotify=None, ipasearchrecordslimit=None,
-                    ipasearchtimelimit=None, ipaselinuxusermaporder=None,
-                    ipauserauthtype=None, ipausersearchfields=None):
+                    ipasearchtimelimit=None, ipauserauthtype=None,
+                    ipausersearchfields=None):
     config = {}
     if ipaconfigstring is not None:
         config['ipaconfigstring'] = ipaconfigstring
@@ -256,8 +238,6 @@ def get_config_dict(ipaconfigstring=None, ipadefaultloginshell=None,
         config['ipasearchrecordslimit'] = str(ipasearchrecordslimit)
     if ipasearchtimelimit is not None:
         config['ipasearchtimelimit'] = str(ipasearchtimelimit)
-    if ipaselinuxusermaporder is not None:
-        config['ipaselinuxusermaporder'] = '$'.join(ipaselinuxusermaporder)
     if ipauserauthtype is not None:
         config['ipauserauthtype'] = ipauserauthtype
     if ipausersearchfields is not None:
@@ -283,7 +263,6 @@ def ensure(module, client):
         ipapwdexpadvnotify=module.params.get('ipapwdexpadvnotify'),
         ipasearchrecordslimit=module.params.get('ipasearchrecordslimit'),
         ipasearchtimelimit=module.params.get('ipasearchtimelimit'),
-        ipaselinuxusermaporder=module.params.get('ipaselinuxusermaporder'),
         ipauserauthtype=module.params.get('ipauserauthtype'),
         ipausersearchfields=module.params.get('ipausersearchfields'),
     )
@@ -325,8 +304,6 @@ def main():
         ipapwdexpadvnotify=dict(type='int', aliases=['pwdexpadvnotify']),
         ipasearchrecordslimit=dict(type='int', aliases=['searchrecordslimit']),
         ipasearchtimelimit=dict(type='int', aliases=['searchtimelimit']),
-        ipaselinuxusermaporder=dict(type='list', elements='str',
-                                    aliases=['selinuxusermaporder']),
         ipauserauthtype=dict(type='list', elements='str',
                              aliases=['userauthtype'],
                              choices=["password", "radius", "otp", "pkinit",

plugins/modules/identity/ipa/ipa_group.py

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

plugins/modules/identity/keycloak/keycloak_authentication.py

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

plugins/modules/identity/keycloak/keycloak_client.py

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

plugins/modules/identity/keycloak/keycloak_client_rolemapping.py

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

plugins/modules/identity/keycloak/keycloak_clientscope.py

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

plugins/modules/identity/keycloak/keycloak_clienttemplate.py

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

plugins/modules/identity/keycloak/keycloak_group.py

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

plugins/modules/identity/keycloak/keycloak_identity_provider.py

@@ -295,20 +295,6 @@ EXAMPLES = '''
       clientAuthMethod: client_secret_post
       clientId: my-client
       clientSecret: secret
-      syncMode: FORCE
-    mappers:
-      - name: first_name
-        identityProviderMapper: oidc-user-attribute-idp-mapper
-        config:
-          claim: first_name
-          user.attribute: first_name
-          syncMode: INHERIT
-      - name: last_name
-        identityProviderMapper: oidc-user-attribute-idp-mapper
-        config:
-          claim: last_name
-          user.attribute: last_name
-          syncMode: INHERIT
 
 - name: Create SAML identity provider, authentication with credentials
   community.general.keycloak_identity_provider:
@@ -327,25 +313,17 @@ EXAMPLES = '''
       singleSignOnServiceUrl: https://idp.example.com/login
       wantAuthnRequestsSigned: true
       wantAssertionsSigned: true
-    mappers:
-      - name: roles
-        identityProviderMapper: saml-user-attribute-idp-mapper
-        config:
-          user.attribute: roles
-          attribute.friendly.name: User Roles
-          attribute.name: roles
-          syncMode: INHERIT
 '''
 
 RETURN = '''
 msg:
-    description: Message as to what action was taken.
-    returned: always
-    type: str
-    sample: "Identity provider my-idp has been created"
+  description: Message as to what action was taken
+  returned: always
+  type: str
+  sample: "Identity provider my-idp has been created"
 
 proposed:
-    description: Representation of proposed identity provider.
+    description: Representation of proposed changes to identity provider
     returned: always
     type: dict
     sample: {
@@ -363,7 +341,7 @@ proposed:
     }
 
 existing:
-    description: Representation of existing identity provider.
+    description: Representation of existing identity provider
     returned: always
     type: dict
     sample: {
@@ -391,8 +369,8 @@ existing:
     }
 
 end_state:
-    description: Representation of identity provider after module execution.
-    returned: on success
+    description: Representation of identity provider after module execution
+    returned: always
     type: dict
     sample: {
         "addReadTokenRoleOnCreate": false,
@@ -416,20 +394,21 @@ end_state:
         "storeToken": false,
         "trustEmail": false,
     }
+
 '''
 
 from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
     keycloak_argument_spec, get_token, KeycloakError
 from ansible.module_utils.basic import AnsibleModule
-from copy import deepcopy
 
 
 def sanitize(idp):
-    idpcopy = deepcopy(idp)
-    if 'config' in idpcopy:
-        if 'clientSecret' in idpcopy['config']:
-            idpcopy['clientSecret'] = '**********'
-    return idpcopy
+    result = idp.copy()
+    if 'config' in result:
+        result['config'] = sanitize(result['config'])
+    if 'clientSecret' in result:
+        result['clientSecret'] = '**********'
+    return result
 
 
 def get_identity_provider_with_mappers(kc, alias, realm):
@@ -437,7 +416,7 @@ def get_identity_provider_with_mappers(kc, alias, realm):
     if idp is not None:
         idp['mappers'] = sorted(kc.get_identity_provider_mappers(alias, realm), key=lambda x: x.get('name'))
     if idp is None:
-        idp = {}
+        idp = dict()
     return idp
 
 
@@ -496,16 +475,16 @@ def main():
     alias = module.params.get('alias')
     state = module.params.get('state')
 
-    # Filter and map the parameters names that apply to the identity provider.
+    # convert module parameters to client representation parameters (if they belong in there)
     idp_params = [x for x in module.params
                   if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm', 'mappers'] and
                   module.params.get(x) is not None]
 
-    # See if it already exists in Keycloak
+    # does the identity provider already exist?
     before_idp = get_identity_provider_with_mappers(kc, alias, realm)
 
-    # Build a proposed changeset from parameters given to this module
-    changeset = {}
+    # build a changeset
+    changeset = dict()
 
     for param in idp_params:
         new_param_value = module.params.get(param)
@@ -514,64 +493,51 @@ def main():
             changeset[camel(param)] = new_param_value
 
     # special handling of mappers list to allow change detection
+    changeset['mappers'] = before_idp.get('mappers', list())
     if module.params.get('mappers') is not None:
-        for change in module.params['mappers']:
-            change = dict((k, v) for k, v in change.items() if change[k] is not None)
-            if change.get('id') is None and change.get('name') is None:
-                module.fail_json(msg='Either `name` or `id` has to be specified on each mapper.')
-            if before_idp == dict():
-                old_mapper = dict()
-            elif change.get('id') is not None:
-                old_mapper = kc.get_identity_provider_mapper(change['id'], alias, realm)
-                if old_mapper is None:
-                    old_mapper = dict()
+        for new_mapper in module.params.get('mappers'):
+            old_mapper = next((x for x in changeset['mappers'] if x['name'] == new_mapper['name']), None)
+            new_mapper = dict((k, v) for k, v in new_mapper.items() if new_mapper[k] is not None)
+            if old_mapper is not None:
+                old_mapper.update(new_mapper)
             else:
-                found = [x for x in kc.get_identity_provider_mappers(alias, realm) if x['name'] == change['name']]
-                if len(found) == 1:
-                    old_mapper = found[0]
-                else:
-                    old_mapper = dict()
-            new_mapper = old_mapper.copy()
-            new_mapper.update(change)
-            if new_mapper != old_mapper:
-                if changeset.get('mappers') is None:
-                    changeset['mappers'] = list()
                 changeset['mappers'].append(new_mapper)
+        # remove mappers if not present in module params
+        changeset['mappers'] = [x for x in changeset['mappers']
+                                if [y for y in module.params.get('mappers', []) if y['name'] == x['name']] != []]
 
-    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
-    desired_idp = before_idp.copy()
-    desired_idp.update(changeset)
+    # prepare the new representation
+    updated_idp = before_idp.copy()
+    updated_idp.update(changeset)
 
     result['proposed'] = sanitize(changeset)
     result['existing'] = sanitize(before_idp)
 
-    # Cater for when it doesn't exist (an empty dict)
-    if not before_idp:
+    # if before_idp is none, the identity provider doesn't exist.
+    if before_idp == dict():
         if state == 'absent':
-            # Do nothing and exit
+            # nothing to do.
             if module._diff:
                 result['diff'] = dict(before='', after='')
             result['changed'] = False
-            result['end_state'] = {}
+            result['end_state'] = dict()
             result['msg'] = 'Identity provider does not exist; doing nothing.'
             module.exit_json(**result)
 
-        # Process a creation
+        # for 'present', create a new identity provider.
         result['changed'] = True
 
         if module._diff:
-            result['diff'] = dict(before='', after=sanitize(desired_idp))
+            result['diff'] = dict(before='', after=sanitize(updated_idp))
 
         if module.check_mode:
             module.exit_json(**result)
 
-        # create it
-        desired_idp = desired_idp.copy()
-        mappers = desired_idp.pop('mappers', [])
-        kc.create_identity_provider(desired_idp, realm)
+        # do it for real!
+        updated_idp = updated_idp.copy()
+        mappers = updated_idp.pop('mappers', [])
+        kc.create_identity_provider(updated_idp, realm)
         for mapper in mappers:
-            if mapper.get('identityProviderAlias') is None:
-                mapper['identityProviderAlias'] = alias
             kc.create_identity_provider_mapper(mapper, alias, realm)
         after_idp = get_identity_provider_with_mappers(kc, alias, realm)
 
@@ -582,34 +548,30 @@ def main():
 
     else:
         if state == 'present':
-            # Process an update
-
             # no changes
-            if desired_idp == before_idp:
+            if updated_idp == before_idp:
                 result['changed'] = False
-                result['end_state'] = sanitize(desired_idp)
+                result['end_state'] = sanitize(updated_idp)
                 result['msg'] = "No changes required to identity provider {alias}.".format(alias=alias)
                 module.exit_json(**result)
 
-            # doing an update
+            # update the existing role
             result['changed'] = True
 
             if module._diff:
-                result['diff'] = dict(before=sanitize(before_idp), after=sanitize(desired_idp))
+                result['diff'] = dict(before=sanitize(before_idp), after=sanitize(updated_idp))
 
             if module.check_mode:
                 module.exit_json(**result)
 
             # do the update
-            desired_idp = desired_idp.copy()
-            updated_mappers = desired_idp.pop('mappers', [])
-            kc.update_identity_provider(desired_idp, realm)
+            updated_idp = updated_idp.copy()
+            updated_mappers = updated_idp.pop('mappers', [])
+            kc.update_identity_provider(updated_idp, realm)
             for mapper in updated_mappers:
                 if mapper.get('id') is not None:
                     kc.update_identity_provider_mapper(mapper, alias, realm)
                 else:
-                    if mapper.get('identityProviderAlias') is None:
-                        mapper['identityProviderAlias'] = alias
                     kc.create_identity_provider_mapper(mapper, alias, realm)
             for mapper in [x for x in before_idp['mappers']
                            if [y for y in updated_mappers if y["name"] == x['name']] == []]:
@@ -623,7 +585,6 @@ def main():
             module.exit_json(**result)
 
         elif state == 'absent':
-            # Process a deletion
             result['changed'] = True
 
             if module._diff:
@@ -632,12 +593,13 @@ def main():
             if module.check_mode:
                 module.exit_json(**result)
 
-            # delete it
+            # delete for real
             kc.delete_identity_provider(alias, realm)
 
-            result['end_state'] = {}
+            result['end_state'] = dict()
 
             result['msg'] = "Identity provider {alias} has been deleted".format(alias=alias)
+            module.exit_json(**result)
 
     module.exit_json(**result)
 

plugins/modules/identity/keycloak/keycloak_realm.py

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

plugins/modules/identity/keycloak/keycloak_role.py

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

plugins/modules/identity/keycloak/keycloak_user_federation.py

@@ -1,980 +0,0 @@
-#!/usr/bin/python
-# -*- 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 = '''
----
-module: keycloak_user_federation
-
-short_description: Allows administration of Keycloak user federations via Keycloak API
-
-version_added: 3.7.0
-
-description:
-    - This module allows you to add, remove or modify Keycloak user federations via the Keycloak REST API.
-      It requires access to the REST API via OpenID Connect; the user connecting and the client being
-      used must have the requisite access rights. In a default Keycloak installation, admin-cli
-      and an admin user would work, as would a separate client definition with the scope tailored
-      to your needs and a user having the expected roles.
-
-    - The names of module options are snake_cased versions of the camelCase ones found in the
-      Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/15.0/rest-api/index.html).
-
-
-options:
-    state:
-        description:
-            - State of the user federation.
-            - On C(present), the user federation will be created if it does not yet exist, or updated with
-              the parameters you provide.
-            - On C(absent), the user federation will be removed if it exists.
-        default: 'present'
-        type: str
-        choices:
-            - present
-            - absent
-
-    realm:
-        description:
-            - The Keycloak realm under which this user federation resides.
-        default: 'master'
-        type: str
-
-    id:
-        description:
-            - The unique ID for this user federation. If left empty, the user federation will be searched
-              by its I(name).
-        type: str
-
-    name:
-        description:
-            - Display name of provider when linked in admin console.
-        type: str
-
-    provider_id:
-        description:
-            - Provider for this user federation.
-        aliases:
-            - providerId
-        type: str
-        choices:
-            - ldap
-            - kerberos
-
-    provider_type:
-        description:
-            - Component type for user federation (only supported value is C(org.keycloak.storage.UserStorageProvider)).
-        aliases:
-            - providerType
-        default: org.keycloak.storage.UserStorageProvider
-        type: str
-
-    parent_id:
-        description:
-            - Unique ID for the parent of this user federation. Realm ID will be automatically used if left blank.
-        aliases:
-            - parentId
-        type: str
-
-    config:
-        description:
-            - Dict specifying the configuration options for the provider; the contents differ depending on
-              the value of I(provider_id). Examples are given below for C(ldap) and C(kerberos). It is easiest
-              to obtain valid config values by dumping an already-existing user federation configuration
-              through check-mode in the I(existing) field.
-        type: dict
-        suboptions:
-            enabled:
-                description:
-                    - Enable/disable this user federation.
-                default: true
-                type: bool
-
-            priority:
-                description:
-                    - Priority of provider when doing a user lookup. Lowest first.
-                default: 0
-                type: int
-
-            importEnabled:
-                description:
-                    - If C(true), LDAP users will be imported into Keycloak DB and synced by the configured
-                      sync policies.
-                default: true
-                type: bool
-
-            editMode:
-                description:
-                    - C(READ_ONLY) is a read-only LDAP store. C(WRITABLE) means data will be synced back to LDAP
-                      on demand. C(UNSYNCED) means user data will be imported, but not synced back to LDAP.
-                type: str
-                choices:
-                    - READ_ONLY
-                    - WRITABLE
-                    - UNSYNCED
-
-            syncRegistrations:
-                description:
-                    - Should newly created users be created within LDAP store? Priority effects which
-                      provider is chosen to sync the new user.
-                default: false
-                type: bool
-
-            vendor:
-                description:
-                    - LDAP vendor (provider).
-                type: str
-
-            usernameLDAPAttribute:
-                description:
-                    - Name of LDAP attribute, which is mapped as Keycloak username. For many LDAP server
-                      vendors it can be C(uid). For Active directory it can be C(sAMAccountName) or C(cn).
-                      The attribute should be filled for all LDAP user records you want to import from
-                      LDAP to Keycloak.
-                type: str
-
-            rdnLDAPAttribute:
-                description:
-                    - Name of LDAP attribute, which is used as RDN (top attribute) of typical user DN.
-                      Usually it's the same as Username LDAP attribute, however it is not required. For
-                      example for Active directory, it is common to use C(cn) as RDN attribute when
-                      username attribute might be C(sAMAccountName).
-                type: str
-
-            uuidLDAPAttribute:
-                description:
-                    - Name of LDAP attribute, which is used as unique object identifier (UUID) for objects
-                      in LDAP. For many LDAP server vendors, it is C(entryUUID); however some are different.
-                      For example for Active directory it should be C(objectGUID). If your LDAP server does
-                      not support the notion of UUID, you can use any other attribute that is supposed to
-                      be unique among LDAP users in tree.
-                type: str
-
-            userObjectClasses:
-                description:
-                    - All values of LDAP objectClass attribute for users in LDAP divided by comma.
-                      For example C(inetOrgPerson, organizationalPerson). Newly created Keycloak users
-                      will be written to LDAP with all those object classes and existing LDAP user records
-                      are found just if they contain all those object classes.
-                type: str
-
-            connectionUrl:
-                description:
-                    - Connection URL to your LDAP server.
-                type: str
-
-            usersDn:
-                description:
-                    - Full DN of LDAP tree where your users are. This DN is the parent of LDAP users.
-                type: str
-
-            customUserSearchFilter:
-                description:
-                    - Additional LDAP Filter for filtering searched users. Leave this empty if you don't
-                      need additional filter.
-                type: str
-
-            searchScope:
-                description:
-                    - For one level, the search applies only for users in the DNs specified by User DNs.
-                      For subtree, the search applies to the whole subtree. See LDAP documentation for
-                      more details.
-                default: '1'
-                type: str
-                choices:
-                    - '1'
-                    - '2'
-
-            authType:
-                description:
-                    - Type of the Authentication method used during LDAP Bind operation. It is used in
-                      most of the requests sent to the LDAP server.
-                default: 'none'
-                type: str
-                choices:
-                    - none
-                    - simple
-
-            bindDn:
-                description:
-                    - DN of LDAP user which will be used by Keycloak to access LDAP server.
-                type: str
-
-            bindCredential:
-                description:
-                    - Password of LDAP admin.
-                type: str
-
-            startTls:
-                description:
-                    - Encrypts the connection to LDAP using STARTTLS, which will disable connection pooling.
-                default: false
-                type: bool
-
-            usePasswordModifyExtendedOp:
-                description:
-                    - Use the LDAPv3 Password Modify Extended Operation (RFC-3062). The password modify
-                      extended operation usually requires that LDAP user already has password in the LDAP
-                      server. So when this is used with 'Sync Registrations', it can be good to add also
-                      'Hardcoded LDAP attribute mapper' with randomly generated initial password.
-                default: false
-                type: bool
-
-            validatePasswordPolicy:
-                description:
-                    - Determines if Keycloak should validate the password with the realm password policy
-                      before updating it.
-                default: false
-                type: bool
-
-            trustEmail:
-                description:
-                    - If enabled, email provided by this provider is not verified even if verification is
-                      enabled for the realm.
-                default: false
-                type: bool
-
-            useTruststoreSpi:
-                description:
-                    - Specifies whether LDAP connection will use the truststore SPI with the truststore
-                      configured in standalone.xml/domain.xml. C(Always) means that it will always use it.
-                      C(Never) means that it will not use it. C(Only for ldaps) means that it will use if
-                      your connection URL use ldaps. Note even if standalone.xml/domain.xml is not
-                      configured, the default Java cacerts or certificate specified by
-                      C(javax.net.ssl.trustStore) property will be used.
-                default: ldapsOnly
-                type: str
-                choices:
-                    - always
-                    - ldapsOnly
-                    - never
-
-            connectionTimeout:
-                description:
-                    - LDAP Connection Timeout in milliseconds.
-                type: int
-
-            readTimeout:
-                description:
-                    - LDAP Read Timeout in milliseconds. This timeout applies for LDAP read operations.
-                type: int
-
-            pagination:
-                description:
-                    - Does the LDAP server support pagination.
-                default: true
-                type: bool
-
-            connectionPooling:
-                description:
-                    - Determines if Keycloak should use connection pooling for accessing LDAP server.
-                default: true
-                type: bool
-
-            connectionPoolingAuthentication:
-                description:
-                    - A list of space-separated authentication types of connections that may be pooled.
-                type: str
-                choices:
-                    - none
-                    - simple
-                    - DIGEST-MD5
-
-            connectionPoolingDebug:
-                description:
-                    - A string that indicates the level of debug output to produce. Example valid values are
-                      C(fine) (trace connection creation and removal) and C(all) (all debugging information).
-                type: str
-
-            connectionPoolingInitSize:
-                description:
-                    - The number of connections per connection identity to create when initially creating a
-                      connection for the identity.
-                type: int
-
-            connectionPoolingMaxSize:
-                description:
-                    - The maximum number of connections per connection identity that can be maintained
-                      concurrently.
-                type: int
-
-            connectionPoolingPrefSize:
-                description:
-                    - The preferred number of connections per connection identity that should be maintained
-                      concurrently.
-                type: int
-
-            connectionPoolingProtocol:
-                description:
-                    - A list of space-separated protocol types of connections that may be pooled.
-                      Valid types are C(plain) and C(ssl).
-                type: str
-
-            connectionPoolingTimeout:
-                description:
-                    - The number of milliseconds that an idle connection may remain in the pool without
-                      being closed and removed from the pool.
-                type: int
-
-            allowKerberosAuthentication:
-                description:
-                    - Enable/disable HTTP authentication of users with SPNEGO/Kerberos tokens. The data
-                      about authenticated users will be provisioned from this LDAP server.
-                default: false
-                type: bool
-
-            kerberosRealm:
-                description:
-                    - Name of kerberos realm.
-                type: str
-
-            serverPrincipal:
-                description:
-                    - Full name of server principal for HTTP service including server and domain name. For
-                      example C(HTTP/host.foo.org@FOO.ORG). Use C(*) to accept any service principal in the
-                      KeyTab file.
-                type: str
-
-            keyTab:
-                description:
-                    - Location of Kerberos KeyTab file containing the credentials of server principal. For
-                      example C(/etc/krb5.keytab).
-                type: str
-
-            debug:
-                description:
-                    - Enable/disable debug logging to standard output for Krb5LoginModule.
-                type: bool
-
-            useKerberosForPasswordAuthentication:
-                description:
-                    - Use Kerberos login module for authenticate username/password against Kerberos server
-                      instead of authenticating against LDAP server with Directory Service API.
-                default: false
-                type: bool
-
-            allowPasswordAuthentication:
-                description:
-                    - Enable/disable possibility of username/password authentication against Kerberos database.
-                type: bool
-
-            batchSizeForSync:
-                description:
-                    - Count of LDAP users to be imported from LDAP to Keycloak within a single transaction.
-                default: 1000
-                type: int
-
-            fullSyncPeriod:
-                description:
-                    - Period for full synchronization in seconds.
-                default: -1
-                type: int
-
-            changedSyncPeriod:
-                description:
-                    - Period for synchronization of changed or newly created LDAP users in seconds.
-                default: -1
-                type: int
-
-            updateProfileFirstLogin:
-                description:
-                    - Update profile on first login.
-                type: bool
-
-            cachePolicy:
-                description:
-                    - Cache Policy for this storage provider.
-                type: str
-                default: 'DEFAULT'
-                choices:
-                    - DEFAULT
-                    - EVICT_DAILY
-                    - EVICT_WEEKLY
-                    - MAX_LIFESPAN
-                    - NO_CACHE
-
-            evictionDay:
-                description:
-                    - Day of the week the entry will become invalid on.
-                type: str
-
-            evictionHour:
-                description:
-                    - Hour of day the entry will become invalid on.
-                type: str
-
-            evictionMinute:
-                description:
-                    - Minute of day the entry will become invalid on.
-                type: str
-
-            maxLifespan:
-                description:
-                    - Max lifespan of cache entry in milliseconds.
-                type: int
-
-    mappers:
-        description:
-            - A list of dicts defining mappers associated with this Identity Provider.
-        type: list
-        elements: dict
-        suboptions:
-            id:
-                description:
-                    - Unique ID of this mapper.
-                type: str
-
-            name:
-                description:
-                    - Name of the mapper. If no ID is given, the mapper will be searched by name.
-                type: str
-
-            parentId:
-                description:
-                    - Unique ID for the parent of this mapper. ID of the user federation will automatically
-                      be used if left blank.
-                type: str
-
-            providerId:
-                description:
-                    - The mapper type for this mapper (for instance C(user-attribute-ldap-mapper)).
-                type: str
-
-            providerType:
-                description:
-                    - Component type for this mapper (only supported value is C(org.keycloak.storage.ldap.mappers.LDAPStorageMapper)).
-                type: str
-
-            config:
-                description:
-                    - Dict specifying the configuration options for the mapper; the contents differ
-                      depending on the value of I(identityProviderMapper).
-                type: dict
-
-extends_documentation_fragment:
-- community.general.keycloak
-
-author:
-    - Laurent Paumier (@laurpaum)
-'''
-
-EXAMPLES = '''
-  - name: Create LDAP user federation
-    community.general.keycloak_user_federation:
-      auth_keycloak_url: https://keycloak.example.com/auth
-      auth_realm: master
-      auth_username: admin
-      auth_password: password
-      realm: my-realm
-      name: my-ldap
-      state: present
-      provider_id: ldap
-      provider_type: org.keycloak.storage.UserStorageProvider
-      config:
-        priority: 0
-        enabled: true
-        cachePolicy: DEFAULT
-        batchSizeForSync: 1000
-        editMode: READ_ONLY
-        importEnabled: true
-        syncRegistrations: false
-        vendor: other
-        usernameLDAPAttribute: uid
-        rdnLDAPAttribute: uid
-        uuidLDAPAttribute: entryUUID
-        userObjectClasses: inetOrgPerson, organizationalPerson
-        connectionUrl: ldaps://ldap.example.com:636
-        usersDn: ou=Users,dc=example,dc=com
-        authType: simple
-        bindDn: cn=directory reader
-        bindCredential: password
-        searchScope: 1
-        validatePasswordPolicy: false
-        trustEmail: false
-        useTruststoreSpi: ldapsOnly
-        connectionPooling: true
-        pagination: true
-        allowKerberosAuthentication: false
-        debug: false
-        useKerberosForPasswordAuthentication: false
-      mappers:
-        - name: "full name"
-          providerId: "full-name-ldap-mapper"
-          providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
-          config:
-            ldap.full.name.attribute: cn
-            read.only: true
-            write.only: false
-
-  - name: Create Kerberos user federation
-    community.general.keycloak_user_federation:
-      auth_keycloak_url: https://keycloak.example.com/auth
-      auth_realm: master
-      auth_username: admin
-      auth_password: password
-      realm: my-realm
-      name: my-kerberos
-      state: present
-      provider_id: kerberos
-      provider_type: org.keycloak.storage.UserStorageProvider
-      config:
-        priority: 0
-        enabled: true
-        cachePolicy: DEFAULT
-        kerberosRealm: EXAMPLE.COM
-        serverPrincipal: HTTP/host.example.com@EXAMPLE.COM
-        keyTab: keytab
-        allowPasswordAuthentication: false
-        updateProfileFirstLogin: false
-
-  - name: Delete user federation
-    community.general.keycloak_user_federation:
-      auth_keycloak_url: https://keycloak.example.com/auth
-      auth_realm: master
-      auth_username: admin
-      auth_password: password
-      realm: my-realm
-      name: my-federation
-      state: absent
-
-'''
-
-RETURN = '''
-msg:
-    description: Message as to what action was taken.
-    returned: always
-    type: str
-    sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."
-
-proposed:
-    description: Representation of proposed user federation.
-    returned: always
-    type: dict
-    sample: {
-        "config": {
-            "allowKerberosAuthentication": "false",
-            "authType": "simple",
-            "batchSizeForSync": "1000",
-            "bindCredential": "**********",
-            "bindDn": "cn=directory reader",
-            "cachePolicy": "DEFAULT",
-            "connectionPooling": "true",
-            "connectionUrl": "ldaps://ldap.example.com:636",
-            "debug": "false",
-            "editMode": "READ_ONLY",
-            "enabled": "true",
-            "importEnabled": "true",
-            "pagination": "true",
-            "priority": "0",
-            "rdnLDAPAttribute": "uid",
-            "searchScope": "1",
-            "syncRegistrations": "false",
-            "trustEmail": "false",
-            "useKerberosForPasswordAuthentication": "false",
-            "useTruststoreSpi": "ldapsOnly",
-            "userObjectClasses": "inetOrgPerson, organizationalPerson",
-            "usernameLDAPAttribute": "uid",
-            "usersDn": "ou=Users,dc=example,dc=com",
-            "uuidLDAPAttribute": "entryUUID",
-            "validatePasswordPolicy": "false",
-            "vendor": "other"
-        },
-        "name": "ldap",
-        "providerId": "ldap",
-        "providerType": "org.keycloak.storage.UserStorageProvider"
-    }
-
-existing:
-    description: Representation of existing user federation.
-    returned: always
-    type: dict
-    sample: {
-        "config": {
-            "allowKerberosAuthentication": "false",
-            "authType": "simple",
-            "batchSizeForSync": "1000",
-            "bindCredential": "**********",
-            "bindDn": "cn=directory reader",
-            "cachePolicy": "DEFAULT",
-            "changedSyncPeriod": "-1",
-            "connectionPooling": "true",
-            "connectionUrl": "ldaps://ldap.example.com:636",
-            "debug": "false",
-            "editMode": "READ_ONLY",
-            "enabled": "true",
-            "fullSyncPeriod": "-1",
-            "importEnabled": "true",
-            "pagination": "true",
-            "priority": "0",
-            "rdnLDAPAttribute": "uid",
-            "searchScope": "1",
-            "syncRegistrations": "false",
-            "trustEmail": "false",
-            "useKerberosForPasswordAuthentication": "false",
-            "useTruststoreSpi": "ldapsOnly",
-            "userObjectClasses": "inetOrgPerson, organizationalPerson",
-            "usernameLDAPAttribute": "uid",
-            "usersDn": "ou=Users,dc=example,dc=com",
-            "uuidLDAPAttribute": "entryUUID",
-            "validatePasswordPolicy": "false",
-            "vendor": "other"
-        },
-        "id": "01122837-9047-4ae4-8ca0-6e2e891a765f",
-        "mappers": [
-            {
-                "config": {
-                    "always.read.value.from.ldap": "false",
-                    "is.mandatory.in.ldap": "false",
-                    "ldap.attribute": "mail",
-                    "read.only": "true",
-                    "user.model.attribute": "email"
-                },
-                "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f",
-                "name": "email",
-                "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f",
-                "providerId": "user-attribute-ldap-mapper",
-                "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
-            }
-        ],
-        "name": "myfed",
-        "parentId": "myrealm",
-        "providerId": "ldap",
-        "providerType": "org.keycloak.storage.UserStorageProvider"
-    }
-
-end_state:
-    description: Representation of user federation after module execution.
-    returned: on success
-    type: dict
-    sample: {
-        "config": {
-            "allowPasswordAuthentication": "false",
-            "cachePolicy": "DEFAULT",
-            "enabled": "true",
-            "kerberosRealm": "EXAMPLE.COM",
-            "keyTab": "/etc/krb5.keytab",
-            "priority": "0",
-            "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM",
-            "updateProfileFirstLogin": "false"
-        },
-        "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122",
-        "mappers": [],
-        "name": "kerberos",
-        "parentId": "myrealm",
-        "providerId": "kerberos",
-        "providerType": "org.keycloak.storage.UserStorageProvider"
-    }
-'''
-
-from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
-    keycloak_argument_spec, get_token, KeycloakError
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlencode
-from copy import deepcopy
-
-
-def sanitize(comp):
-    compcopy = deepcopy(comp)
-    if 'config' in compcopy:
-        compcopy['config'] = dict((k, v[0]) for k, v in compcopy['config'].items())
-        if 'bindCredential' in compcopy['config']:
-            compcopy['config']['bindCredential'] = '**********'
-    if 'mappers' in compcopy:
-        for mapper in compcopy['mappers']:
-            if 'config' in mapper:
-                mapper['config'] = dict((k, v[0]) for k, v in mapper['config'].items())
-    return compcopy
-
-
-def main():
-    """
-    Module execution
-
-    :return:
-    """
-    argument_spec = keycloak_argument_spec()
-
-    config_spec = dict(
-        allowKerberosAuthentication=dict(type='bool', default=False),
-        allowPasswordAuthentication=dict(type='bool'),
-        authType=dict(type='str', choices=['none', 'simple'], default='none'),
-        batchSizeForSync=dict(type='int', default=1000),
-        bindCredential=dict(type='str', no_log=True),
-        bindDn=dict(type='str'),
-        cachePolicy=dict(type='str', choices=['DEFAULT', 'EVICT_DAILY', 'EVICT_WEEKLY', 'MAX_LIFESPAN', 'NO_CACHE'], default='DEFAULT'),
-        changedSyncPeriod=dict(type='int', default=-1),
-        connectionPooling=dict(type='bool', default=True),
-        connectionPoolingAuthentication=dict(type='str', choices=['none', 'simple', 'DIGEST-MD5']),
-        connectionPoolingDebug=dict(type='str'),
-        connectionPoolingInitSize=dict(type='int'),
-        connectionPoolingMaxSize=dict(type='int'),
-        connectionPoolingPrefSize=dict(type='int'),
-        connectionPoolingProtocol=dict(type='str'),
-        connectionPoolingTimeout=dict(type='int'),
-        connectionTimeout=dict(type='int'),
-        connectionUrl=dict(type='str'),
-        customUserSearchFilter=dict(type='str'),
-        debug=dict(type='bool'),
-        editMode=dict(type='str', choices=['READ_ONLY', 'WRITABLE', 'UNSYNCED']),
-        enabled=dict(type='bool', default=True),
-        evictionDay=dict(type='str'),
-        evictionHour=dict(type='str'),
-        evictionMinute=dict(type='str'),
-        fullSyncPeriod=dict(type='int', default=-1),
-        importEnabled=dict(type='bool', default=True),
-        kerberosRealm=dict(type='str'),
-        keyTab=dict(type='str', no_log=False),
-        maxLifespan=dict(type='int'),
-        pagination=dict(type='bool', default=True),
-        priority=dict(type='int', default=0),
-        rdnLDAPAttribute=dict(type='str'),
-        readTimeout=dict(type='int'),
-        searchScope=dict(type='str', choices=['1', '2'], default='1'),
-        serverPrincipal=dict(type='str'),
-        startTls=dict(type='bool', default=False),
-        syncRegistrations=dict(type='bool', default=False),
-        trustEmail=dict(type='bool', default=False),
-        updateProfileFirstLogin=dict(type='bool'),
-        useKerberosForPasswordAuthentication=dict(type='bool', default=False),
-        usePasswordModifyExtendedOp=dict(type='bool', default=False, no_log=False),
-        useTruststoreSpi=dict(type='str', choices=['always', 'ldapsOnly', 'never'], default='ldapsOnly'),
-        userObjectClasses=dict(type='str'),
-        usernameLDAPAttribute=dict(type='str'),
-        usersDn=dict(type='str'),
-        uuidLDAPAttribute=dict(type='str'),
-        validatePasswordPolicy=dict(type='bool', default=False),
-        vendor=dict(type='str'),
-    )
-
-    mapper_spec = dict(
-        id=dict(type='str'),
-        name=dict(type='str'),
-        parentId=dict(type='str'),
-        providerId=dict(type='str'),
-        providerType=dict(type='str'),
-        config=dict(type='dict'),
-    )
-
-    meta_args = dict(
-        config=dict(type='dict', options=config_spec),
-        state=dict(type='str', default='present', choices=['present', 'absent']),
-        realm=dict(type='str', default='master'),
-        id=dict(type='str'),
-        name=dict(type='str'),
-        provider_id=dict(type='str', aliases=['providerId'], choices=['ldap', 'kerberos']),
-        provider_type=dict(type='str', aliases=['providerType'], default='org.keycloak.storage.UserStorageProvider'),
-        parent_id=dict(type='str', aliases=['parentId']),
-        mappers=dict(type='list', elements='dict', options=mapper_spec),
-    )
-
-    argument_spec.update(meta_args)
-
-    module = AnsibleModule(argument_spec=argument_spec,
-                           supports_check_mode=True,
-                           required_one_of=([['id', 'name'],
-                                             ['token', 'auth_realm', 'auth_username', 'auth_password']]),
-                           required_together=([['auth_realm', 'auth_username', 'auth_password']]))
-
-    result = dict(changed=False, msg='', diff={}, proposed={}, existing={}, end_state={})
-
-    # Obtain access token, initialize API
-    try:
-        connection_header = get_token(module.params)
-    except KeycloakError as e:
-        module.fail_json(msg=str(e))
-
-    kc = KeycloakAPI(module, connection_header)
-
-    realm = module.params.get('realm')
-    state = module.params.get('state')
-    config = module.params.get('config')
-    mappers = module.params.get('mappers')
-    cid = module.params.get('id')
-    name = module.params.get('name')
-
-    # Keycloak API expects config parameters to be arrays containing a single string element
-    if config is not None:
-        module.params['config'] = dict((k, [str(v).lower() if not isinstance(v, str) else v])
-                                       for k, v in config.items() if config[k] is not None)
-
-    if mappers is not None:
-        for mapper in mappers:
-            if mapper.get('config') is not None:
-                mapper['config'] = dict((k, [str(v).lower() if not isinstance(v, str) else v])
-                                        for k, v in mapper['config'].items() if mapper['config'][k] is not None)
-
-    # Filter and map the parameters names that apply
-    comp_params = [x for x in module.params
-                   if x not in list(keycloak_argument_spec().keys()) + ['state', 'realm', 'mappers'] and
-                   module.params.get(x) is not None]
-
-    # See if it already exists in Keycloak
-    if cid is None:
-        found = kc.get_components(urlencode(dict(type='org.keycloak.storage.UserStorageProvider', parent=realm, name=name)), realm)
-        if len(found) > 1:
-            module.fail_json(msg='No ID given and found multiple user federations with name `{name}`. Cannot continue.'.format(name=name))
-        before_comp = next(iter(found), None)
-        if before_comp is not None:
-            cid = before_comp['id']
-    else:
-        before_comp = kc.get_component(cid, realm)
-
-    if before_comp is None:
-        before_comp = {}
-
-    # if user federation exists, get associated mappers
-    if cid is not None:
-        before_comp['mappers'] = sorted(kc.get_components(urlencode(dict(parent=cid)), realm), key=lambda x: x.get('name'))
-
-    # Build a proposed changeset from parameters given to this module
-    changeset = {}
-
-    for param in comp_params:
-        new_param_value = module.params.get(param)
-        old_value = before_comp[camel(param)] if camel(param) in before_comp else None
-        if param == 'mappers':
-            new_param_value = [dict((k, v) for k, v in x.items() if x[k] is not None) for x in new_param_value]
-        if new_param_value != old_value:
-            changeset[camel(param)] = new_param_value
-
-    # special handling of mappers list to allow change detection
-    if module.params.get('mappers') is not None:
-        if module.params['provider_id'] == 'kerberos':
-            module.fail_json(msg='Cannot configure mappers for Kerberos federations.')
-        for change in module.params['mappers']:
-            change = dict((k, v) for k, v in change.items() if change[k] is not None)
-            if change.get('id') is None and change.get('name') is None:
-                module.fail_json(msg='Either `name` or `id` has to be specified on each mapper.')
-            if cid is None:
-                old_mapper = {}
-            elif change.get('id') is not None:
-                old_mapper = kc.get_component(change['id'], realm)
-                if old_mapper is None:
-                    old_mapper = {}
-            else:
-                found = kc.get_components(urlencode(dict(parent=cid, name=change['name'])), realm)
-                if len(found) > 1:
-                    module.fail_json(msg='Found multiple mappers with name `{name}`. Cannot continue.'.format(name=change['name']))
-                if len(found) == 1:
-                    old_mapper = found[0]
-                else:
-                    old_mapper = {}
-            new_mapper = old_mapper.copy()
-            new_mapper.update(change)
-            if new_mapper != old_mapper:
-                if changeset.get('mappers') is None:
-                    changeset['mappers'] = list()
-                changeset['mappers'].append(new_mapper)
-
-    # Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
-    desired_comp = before_comp.copy()
-    desired_comp.update(changeset)
-
-    result['proposed'] = sanitize(changeset)
-    result['existing'] = sanitize(before_comp)
-
-    # Cater for when it doesn't exist (an empty dict)
-    if not before_comp:
-        if state == 'absent':
-            # Do nothing and exit
-            if module._diff:
-                result['diff'] = dict(before='', after='')
-            result['changed'] = False
-            result['end_state'] = {}
-            result['msg'] = 'User federation does not exist; doing nothing.'
-            module.exit_json(**result)
-
-        # Process a creation
-        result['changed'] = True
-
-        if module._diff:
-            result['diff'] = dict(before='', after=sanitize(desired_comp))
-
-        if module.check_mode:
-            module.exit_json(**result)
-
-        # create it
-        desired_comp = desired_comp.copy()
-        updated_mappers = desired_comp.pop('mappers', [])
-        after_comp = kc.create_component(desired_comp, realm)
-
-        for mapper in updated_mappers:
-            if mapper.get('id') is not None:
-                kc.update_component(mapper, realm)
-            else:
-                if mapper.get('parentId') is None:
-                    mapper['parentId'] = after_comp['id']
-                mapper = kc.create_component(mapper, realm)
-
-        after_comp['mappers'] = updated_mappers
-        result['end_state'] = sanitize(after_comp)
-
-        result['msg'] = "User federation {id} has been created".format(id=after_comp['id'])
-        module.exit_json(**result)
-
-    else:
-        if state == 'present':
-            # Process an update
-
-            # no changes
-            if desired_comp == before_comp:
-                result['changed'] = False
-                result['end_state'] = sanitize(desired_comp)
-                result['msg'] = "No changes required to user federation {id}.".format(id=cid)
-                module.exit_json(**result)
-
-            # doing an update
-            result['changed'] = True
-
-            if module._diff:
-                result['diff'] = dict(before=sanitize(before_comp), after=sanitize(desired_comp))
-
-            if module.check_mode:
-                module.exit_json(**result)
-
-            # do the update
-            desired_comp = desired_comp.copy()
-            updated_mappers = desired_comp.pop('mappers', [])
-            kc.update_component(desired_comp, realm)
-            after_comp = kc.get_component(cid, realm)
-
-            for mapper in updated_mappers:
-                if mapper.get('id') is not None:
-                    kc.update_component(mapper, realm)
-                else:
-                    if mapper.get('parentId') is None:
-                        mapper['parentId'] = desired_comp['id']
-                    mapper = kc.create_component(mapper, realm)
-
-            after_comp['mappers'] = updated_mappers
-            result['end_state'] = sanitize(after_comp)
-
-            result['msg'] = "User federation {id} has been updated".format(id=cid)
-            module.exit_json(**result)
-
-        elif state == 'absent':
-            # Process a deletion
-            result['changed'] = True
-
-            if module._diff:
-                result['diff'] = dict(before=sanitize(before_comp), after='')
-
-            if module.check_mode:
-                module.exit_json(**result)
-
-            # delete it
-            kc.delete_component(cid, realm)
-
-            result['end_state'] = {}
-
-            result['msg'] = "User federation {id} has been deleted".format(id=cid)
-
-    module.exit_json(**result)
-
-
-if __name__ == '__main__':
-    main()

plugins/modules/keycloak_user_federation.py

@@ -1 +0,0 @@
-identity/keycloak/keycloak_user_federation.py

plugins/modules/mssql_script.py

@@ -1 +0,0 @@
-./database/mssql/mssql_script.py

plugins/modules/net_tools/dnsimple.py

@@ -82,8 +82,6 @@ options:
     version_added: 3.5.0
 requirements:
   - "dnsimple >= 1.0.0"
-notes:
-  - "Support for C(dnsimple < 2) is deprecated and will be removed in community.general 5.0.0."
 author: "Alex Coomans (@drcapulet)"
 '''
 
@@ -94,6 +92,13 @@ EXAMPLES = '''
     account_api_token: dummyapitoken
   delegate_to: localhost
 
+- name: Fetch my.com domain records
+  community.general.dnsimple:
+    domain: my.com
+    state: present
+  delegate_to: localhost
+  register: records
+
 - name: Delete a domain
   community.general.dnsimple:
     domain: my.com
@@ -397,11 +402,6 @@ def main():
         if DNSIMPLE_MAJOR_VERSION > 1:
             ds = DNSimpleV2(account_email, account_api_token, sandbox, module)
         else:
-            module.deprecate(
-                'Support for python-dnsimple < 2 is deprecated. '
-                'Update python-dnsimple to version >= 2.0.0',
-                version='5.0.0', collection_name='community.general'
-            )
             ds = DNSimpleV1(account_email, account_api_token, sandbox, module)
         # Let's figure out what operation we want to do
         # No domain, return a list

plugins/modules/net_tools/ldap/ldap_search.py

@@ -106,10 +106,11 @@ def main():
         module.fail_json(msg=missing_required_lib('python-ldap'),
                          exception=LDAP_IMP_ERR)
 
-    try:
-        LdapSearch(module).main()
-    except Exception as exception:
-        module.fail_json(msg="Attribute action failed.", details=to_native(exception))
+    if not module.check_mode:
+        try:
+            LdapSearch(module).main()
+        except Exception as exception:
+            module.fail_json(msg="Attribute action failed.", details=to_native(exception))
 
     module.exit_json(changed=False)
 

plugins/modules/net_tools/nios/nios_a_record.py

@@ -0,0 +1,179 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_a_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS A records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_a_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of A record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:a) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this A record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  ipv4addr:
+    description:
+      - Configures the IPv4 address for this A record. Users can dynamically
+        allocate ipv4 address to A record by passing dictionary containing,
+        I(nios_next_ip) and I(CIDR network range). See example
+    aliases:
+      - ipv4
+    type: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this A record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure an A record
+  community.general.nios_a_record:
+    name: a.ansible.com
+    ipv4: 192.168.10.1
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing A record
+  community.general.nios_a_record:
+    name: a.ansible.com
+    ipv4: 192.168.10.1
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove an A record from the system
+  community.general.nios_a_record:
+    name: a.ansible.com
+    ipv4: 192.168.10.1
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Update an A record name
+  community.general.nios_a_record:
+    name: {new_name: a_new.ansible.com, old_name: a.ansible.com}
+    ipv4: 192.168.10.1
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Dynamically add a record to next available ip
+  community.general.nios_a_record:
+    name: a.ansible.com
+    ipv4: {nios_next_ip: 192.168.10.0/24}
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_A_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        ipv4addr=dict(aliases=['ipv4'], ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_A_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_aaaa_record.py

@@ -0,0 +1,166 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_aaaa_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS AAAA records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_aaaa_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of AAAA record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:aaaa) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this AAAA record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  ipv6addr:
+    description:
+      - Configures the IPv6 address for this AAAA record.
+    aliases:
+      - ipv6
+    type: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this AAAA record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure an AAAA record
+  community.general.nios_aaaa_record:
+    name: aaaa.ansible.com
+    ipv6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing AAAA record
+  community.general.nios_aaaa_record:
+    name: aaaa.ansible.com
+    ipv6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove an AAAA record from the system
+  community.general.nios_aaaa_record:
+    name: aaaa.ansible.com
+    ipv6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Update an AAAA record name
+  community.general.nios_aaaa_record:
+    name: {new_name: aaaa_new.ansible.com, old_name: aaaa.ansible.com}
+    ipv6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_AAAA_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        ipv6addr=dict(aliases=['ipv6'], ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_AAAA_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_cname_record.py

@@ -0,0 +1,155 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_cname_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS CNAME records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_cname_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of CNAME record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:cname) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this CNAME record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  canonical:
+    description:
+      - Configures the canonical name for this CNAME record.
+    aliases:
+      - cname
+    type: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this CNAME record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure a CNAME record
+  community.general.nios_cname_record:
+    name: cname.ansible.com
+    canonical: realhost.ansible.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing CNAME record
+  community.general.nios_cname_record:
+    name: cname.ansible.com
+    canonical: realhost.ansible.com
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove a CNAME record from the system
+  community.general.nios_cname_record:
+    name: cname.ansible.com
+    canonical: realhost.ansible.com
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_CNAME_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        canonical=dict(aliases=['cname'], ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_CNAME_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_dns_view.py

@@ -0,0 +1,150 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_dns_view
+author: "Peter Sprygada (@privateip)"
+short_description: Configure Infoblox NIOS DNS views
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_dns_view
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of DNS view objects from
+    Infoblox NIOS servers.  This module manages NIOS C(view) objects
+    using the Infoblox WAPI interface over REST.
+  - Updates instances of DNS view object from Infoblox NIOS servers.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system. User can also update the hostname as it is possible
+        to pass a dict containing I(new_name), I(old_name). See examples.
+    required: true
+    aliases:
+      - view
+    type: str
+  network_view:
+    description:
+      - Specifies the name of the network view to assign the configured
+        DNS view to.  The network view must already be configured on the
+        target system.
+    default: default
+    type: str
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    required: false
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    required: false
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    required: false
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure a new dns view instance
+  community.general.nios_dns_view:
+    name: ansible-dns
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update the comment for dns view
+  community.general.nios_dns_view:
+    name: ansible-dns
+    comment: this is an example comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove the dns view instance
+  community.general.nios_dns_view:
+    name: ansible-dns
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update the dns view instance
+  community.general.nios_dns_view:
+    name: {new_name: ansible-dns-new, old_name: ansible-dns}
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_DNS_VIEW
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    ib_spec = dict(
+        name=dict(required=True, aliases=['view'], ib_req=True),
+        network_view=dict(default='default', ib_req=True),
+
+        extattrs=dict(type='dict'),
+        comment=dict()
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_DNS_VIEW, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_fixed_address.py

@@ -0,0 +1,301 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_fixed_address
+author: "Sumit Jaiswal (@sjaiswal)"
+short_description: Configure Infoblox NIOS DHCP Fixed Address
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_fixed_address
+    removed_in: 5.0.0
+description:
+  - A fixed address is a specific IP address that a DHCP server
+    always assigns when a lease request comes from a particular
+    MAC address of the client.
+  - Supports both IPV4 and IPV6 internet protocols
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the hostname with which fixed DHCP ip-address is stored
+        for respective mac.
+    required: true
+    type: str
+  ipaddr:
+    description:
+      - IPV4/V6 address of the fixed address.
+    required: true
+    type: str
+  mac:
+    description:
+      - The MAC address of the interface.
+    required: true
+    type: str
+  network:
+    description:
+      - Specifies the network range in which ipaddr exists.
+    required: true
+    type: str
+  network_view:
+    description:
+      - Configures the name of the network view to associate with this
+        configured instance.
+    required: false
+    default: default
+    type: str
+  options:
+    description:
+      - Configures the set of DHCP options to be included as part of
+        the configured network instance.  This argument accepts a list
+        of values (see suboptions).  When configuring suboptions at
+        least one of C(name) or C(num) must be specified.
+    type: list
+    elements: dict
+    suboptions:
+      name:
+        description:
+          - The name of the DHCP option to configure
+        type: str
+      num:
+        description:
+          - The number of the DHCP option to configure
+        type: int
+      value:
+        description:
+          - The value of the DHCP option specified by C(name)
+        required: true
+        type: str
+      use_option:
+        description:
+          - Only applies to a subset of options (see NIOS API documentation)
+        type: bool
+        default: 'yes'
+      vendor_class:
+        description:
+          - The name of the space this DHCP option is associated to
+        default: DHCP
+        type: str
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure ipv4 dhcp fixed address
+  community.general.nios_fixed_address:
+    name: ipv4_fixed
+    ipaddr: 192.168.10.1
+    mac: 08:6d:41:e8:fd:e8
+    network: 192.168.10.0/24
+    network_view: default
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Configure a ipv6 dhcp fixed address
+  community.general.nios_fixed_address:
+    name: ipv6_fixed
+    ipaddr: fe80::1/10
+    mac: 08:6d:41:e8:fd:e8
+    network: fe80::/64
+    network_view: default
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Set dhcp options for a ipv4 fixed address
+  community.general.nios_fixed_address:
+    name: ipv4_fixed
+    ipaddr: 192.168.10.1
+    mac: 08:6d:41:e8:fd:e8
+    network: 192.168.10.0/24
+    network_view: default
+    comment: this is a test comment
+    options:
+      - name: domain-name
+        value: ansible.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove a ipv4 dhcp fixed address
+  community.general.nios_fixed_address:
+    name: ipv4_fixed
+    ipaddr: 192.168.10.1
+    mac: 08:6d:41:e8:fd:e8
+    network: 192.168.10.0/24
+    network_view: default
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+import socket
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.six import iteritems
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_IPV4_FIXED_ADDRESS, NIOS_IPV6_FIXED_ADDRESS
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def validate_ip_address(address):
+    try:
+        socket.inet_aton(address)
+    except socket.error:
+        return False
+    return address.count(".") == 3
+
+
+def validate_ip_v6_address(address):
+    try:
+        socket.inet_pton(socket.AF_INET6, address)
+    except socket.error:
+        return False
+    return True
+
+
+def options(module):
+    ''' Transforms the module argument into a valid WAPI struct
+    This function will transform the options argument into a structure that
+    is a valid WAPI structure in the format of:
+        {
+            name: <value>,
+            num: <value>,
+            value: <value>,
+            use_option: <value>,
+            vendor_class: <value>
+        }
+    It will remove any options that are set to None since WAPI will error on
+    that condition.  The use_option field only applies
+    to special options that are displayed separately from other options and
+    have a use flag. This function removes the use_option flag from all
+    other options. It will also verify that either `name` or `num` is
+    set in the structure but does not validate the values are equal.
+    The remainder of the value validation is performed by WAPI
+    '''
+    special_options = ['routers', 'router-templates', 'domain-name-servers',
+                       'domain-name', 'broadcast-address', 'broadcast-address-offset',
+                       'dhcp-lease-time', 'dhcp6.name-servers']
+    options = list()
+    for item in module.params['options']:
+        opt = dict([(k, v) for k, v in iteritems(item) if v is not None])
+        if 'name' not in opt and 'num' not in opt:
+            module.fail_json(msg='one of `name` or `num` is required for option value')
+        if opt['name'] not in special_options:
+            del opt['use_option']
+        options.append(opt)
+    return options
+
+
+def validate_ip_addr_type(ip, arg_spec, module):
+    '''This function will check if the argument ip is type v4/v6 and return appropriate infoblox network type
+    '''
+    check_ip = ip.split('/')
+
+    if validate_ip_address(check_ip[0]) and 'ipaddr' in arg_spec:
+        arg_spec['ipv4addr'] = arg_spec.pop('ipaddr')
+        module.params['ipv4addr'] = module.params.pop('ipaddr')
+        return NIOS_IPV4_FIXED_ADDRESS, arg_spec, module
+    elif validate_ip_v6_address(check_ip[0]) and 'ipaddr' in arg_spec:
+        arg_spec['ipv6addr'] = arg_spec.pop('ipaddr')
+        module.params['ipv6addr'] = module.params.pop('ipaddr')
+        return NIOS_IPV6_FIXED_ADDRESS, arg_spec, module
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    option_spec = dict(
+        # one of name or num is required; enforced by the function options()
+        name=dict(),
+        num=dict(type='int'),
+
+        value=dict(required=True),
+
+        use_option=dict(type='bool', default=True),
+        vendor_class=dict(default='DHCP')
+    )
+
+    ib_spec = dict(
+        name=dict(required=True),
+        ipaddr=dict(required=True, ib_req=True),
+        mac=dict(required=True, ib_req=True),
+        network=dict(required=True),
+        network_view=dict(default='default'),
+
+        options=dict(type='list', elements='dict', options=option_spec, transform=options),
+
+        extattrs=dict(type='dict'),
+        comment=dict()
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    # to get the argument ipaddr
+    obj_filter = dict([(k, module.params[k]) for k, v in iteritems(ib_spec) if v.get('ib_req')])
+    # to modify argument based on ipaddr type i.e. IPV4/IPV6
+    fixed_address_ip_type, ib_spec, module = validate_ip_addr_type(obj_filter['ipaddr'], ib_spec, module)
+
+    wapi = WapiModule(module)
+
+    result = wapi.run(fixed_address_ip_type, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_host_record.py

@@ -0,0 +1,361 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_host_record
+author: "Peter Sprygada (@privateip)"
+short_description: Configure Infoblox NIOS host records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_host_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of host record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:host) objects
+    using the Infoblox WAPI interface over REST.
+  - Updates instances of host record object from Infoblox NIOS servers.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system. User can also update the hostname as it is possible
+        to pass a dict containing I(new_name), I(old_name). See examples.
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this host record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  configure_for_dns:
+    description:
+      - Sets the DNS to particular parent. If user needs to bypass DNS
+        user can make the value to false.
+    type: bool
+    required: false
+    default: true
+    aliases:
+      - dns
+  ipv4addrs:
+    description:
+      - Configures the IPv4 addresses for this host record.  This argument
+        accepts a list of values (see suboptions)
+    aliases:
+      - ipv4
+    type: list
+    elements: dict
+    suboptions:
+      ipv4addr:
+        description:
+          - Configures the IPv4 address for the host record. Users can dynamically
+            allocate ipv4 address to host record by passing dictionary containing,
+            I(nios_next_ip) and I(CIDR network range). If user wants to add or
+            remove the ipv4 address from existing record, I(add/remove)
+            params need to be used. See examples
+        required: true
+        aliases:
+          - address
+        type: str
+      configure_for_dhcp:
+        description:
+          - Configure the host_record over DHCP instead of DNS, if user
+            changes it to true, user need to mention MAC address to configure
+        required: false
+        aliases:
+          - dhcp
+        type: bool
+      mac:
+        description:
+          - Configures the hardware MAC address for the host record. If user makes
+            DHCP to true, user need to mention MAC address.
+        required: false
+        type: str
+      add:
+        description:
+          - If user wants to add the ipv4 address to an existing host record.
+            Note that with I(add) user will have to keep the I(state) as I(present),
+            as new IP address is allocated to existing host record. See examples.
+        type: bool
+        required: false
+        version_added: '0.2.0'
+      remove:
+        description:
+          - If user wants to remove the ipv4 address from an existing host record.
+            Note that with I(remove) user will have to change the I(state) to I(absent),
+            as IP address is de-allocated from an existing host record. See examples.
+        type: bool
+        required: false
+        version_added: '0.2.0'
+  ipv6addrs:
+    description:
+      - Configures the IPv6 addresses for the host record.  This argument
+        accepts a list of values (see options)
+    aliases:
+      - ipv6
+    type: list
+    elements: dict
+    suboptions:
+      ipv6addr:
+        description:
+          - Configures the IPv6 address for the host record
+        required: true
+        aliases:
+          - address
+        type: str
+      configure_for_dhcp:
+        description:
+          - Configure the host_record over DHCP instead of DNS, if user
+            changes it to true, user need to mention MAC address to configure
+        required: false
+        type: bool
+      mac:
+        description:
+          - Configures the hardware MAC address for the host record. If user makes
+            DHCP to true, user need to mention MAC address.
+        required: false
+        type: str
+  aliases:
+    description:
+      - Configures an optional list of additional aliases to add to the host
+        record. These are equivalent to CNAMEs but held within a host
+        record. Must be in list format.
+    type: list
+    elements: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this host record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure an ipv4 host record
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: 192.168.10.1
+    aliases:
+      - cname.ansible.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Add a comment to an existing host record
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: 192.168.10.1
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove a host record from the system
+  community.general.nios_host_record:
+    name: host.ansible.com
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update an ipv4 host record
+  community.general.nios_host_record:
+    name: {new_name: host-new.ansible.com, old_name: host.ansible.com}
+    ipv4:
+      - address: 192.168.10.1
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Create an ipv4 host record bypassing DNS
+  community.general.nios_host_record:
+    name: new_host
+    ipv4:
+      - address: 192.168.10.1
+    dns: false
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Create an ipv4 host record over DHCP
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: 192.168.10.1
+        dhcp: true
+        mac: 00-80-C8-E3-4C-BD
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Dynamically add host record to next available ip
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: {nios_next_ip: 192.168.10.0/24}
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Add ip to host record
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: 192.168.10.2
+        add: true
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove ip to host record
+  community.general.nios_host_record:
+    name: host.ansible.com
+    ipv4:
+      - address: 192.168.10.1
+        remove: true
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.six import iteritems
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_HOST_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def ipaddr(module, key, filtered_keys=None):
+    ''' Transforms the input value into a struct supported by WAPI
+    This function will transform the input from the playbook into a struct
+    that is valid for WAPI in the form of:
+        {
+            ipv4addr: <value>,
+            mac: <value>
+        }
+    This function does not validate the values are properly formatted or in
+    the acceptable range, that is left to WAPI.
+    '''
+    filtered_keys = filtered_keys or list()
+    objects = list()
+    for item in module.params[key]:
+        objects.append(dict([(k, v) for k, v in iteritems(item) if v is not None and k not in filtered_keys]))
+    return objects
+
+
+def ipv4addrs(module):
+    return ipaddr(module, 'ipv4addrs', filtered_keys=['address', 'dhcp'])
+
+
+def ipv6addrs(module):
+    return ipaddr(module, 'ipv6addrs', filtered_keys=['address', 'dhcp'])
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    ipv4addr_spec = dict(
+        ipv4addr=dict(required=True, aliases=['address']),
+        configure_for_dhcp=dict(type='bool', required=False, aliases=['dhcp']),
+        mac=dict(required=False),
+        add=dict(type='bool', required=False),
+        remove=dict(type='bool', required=False)
+    )
+
+    ipv6addr_spec = dict(
+        ipv6addr=dict(required=True, aliases=['address']),
+        configure_for_dhcp=dict(type='bool', required=False),
+        mac=dict(required=False)
+    )
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        ipv4addrs=dict(type='list', aliases=['ipv4'], elements='dict', options=ipv4addr_spec, transform=ipv4addrs),
+        ipv6addrs=dict(type='list', aliases=['ipv6'], elements='dict', options=ipv6addr_spec, transform=ipv6addrs),
+        configure_for_dns=dict(type='bool', default=True, required=False, aliases=['dns'], ib_req=True),
+        aliases=dict(type='list', elements='str'),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_HOST_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_member.py

@@ -0,0 +1,574 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_member
+author: "Krishna Vasudevan (@krisvasudevan)"
+short_description: Configure Infoblox NIOS members
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_member
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes Infoblox NIOS servers.  This module manages NIOS C(member) objects using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  host_name:
+    description:
+      - Specifies the host name of the member to either add or remove from
+        the NIOS instance.
+    required: true
+    aliases:
+      - name
+    type: str
+  vip_setting:
+    description:
+      - Configures the network settings for the grid member.
+    type: list
+    elements: dict
+    suboptions:
+      address:
+        description:
+          - The IPv4 Address of the Grid Member
+        type: str
+      subnet_mask:
+        description:
+          - The subnet mask for the Grid Member
+        type: str
+      gateway:
+        description:
+          - The default gateway for the Grid Member
+        type: str
+  ipv6_setting:
+    description:
+      - Configures the IPv6 settings for the grid member.
+    type: list
+    elements: dict
+    suboptions:
+      virtual_ip:
+        description:
+          - The IPv6 Address of the Grid Member
+        type: str
+      cidr_prefix:
+        description:
+          - The IPv6 CIDR prefix for the Grid Member
+        type: int
+      gateway:
+        description:
+          - The gateway address for the Grid Member
+        type: str
+  config_addr_type:
+    description:
+      - Address configuration type (IPV4/IPV6/BOTH)
+    default: IPV4
+    type: str
+  comment:
+    description:
+      - A descriptive comment of the Grid member.
+    type: str
+  extattrs:
+    description:
+      - Extensible attributes associated with the object.
+    type: dict
+  enable_ha:
+    description:
+      - If set to True, the member has two physical nodes (HA pair).
+    type: bool
+    default: false
+  router_id:
+    description:
+      - Virtual router identifier. Provide this ID if "ha_enabled" is set to "true". This is a unique VRID number (from 1 to 255) for the local subnet.
+    type: int
+  lan2_enabled:
+    description:
+      - When set to "true", the LAN2 port is enabled as an independent port or as a port for failover purposes.
+    type: bool
+    default: false
+  lan2_port_setting:
+    description:
+      - Settings for the Grid member LAN2 port if 'lan2_enabled' is set to "true".
+    type: list
+    elements: dict
+    suboptions:
+      enabled:
+        description:
+          - If set to True, then it has its own IP settings.
+        type: bool
+      network_setting:
+        description:
+          - If the 'enable' field is set to True, this defines IPv4 network settings for LAN2.
+        type: list
+        elements: dict
+        suboptions:
+          address:
+            description:
+              - The IPv4 Address of LAN2
+            type: str
+          subnet_mask:
+            description:
+              - The subnet mask of LAN2
+            type: str
+          gateway:
+            description:
+              - The default gateway of LAN2
+            type: str
+      v6_network_setting:
+        description:
+          - If the 'enable' field is set to True, this defines IPv6 network settings for LAN2.
+        type: list
+        elements: dict
+        suboptions:
+          virtual_ip:
+            description:
+              - The IPv6 Address of LAN2
+            type: str
+          cidr_prefix:
+            description:
+              - The IPv6 CIDR prefix of LAN2
+            type: int
+          gateway:
+            description:
+              - The gateway address of LAN2
+            type: str
+  platform:
+    description:
+      - Configures the Hardware Platform.
+    default: INFOBLOX
+    type: str
+  node_info:
+    description:
+      - Configures the node information list with detailed status report on the operations of the Grid Member.
+    type: list
+    elements: dict
+    suboptions:
+      lan2_physical_setting:
+        description:
+          - Physical port settings for the LAN2 interface.
+        type: list
+        elements: dict
+        suboptions:
+          auto_port_setting_enabled:
+            description:
+              - Enable or disalbe the auto port setting.
+            type: bool
+          duplex:
+            description:
+              - The port duplex; if speed is 1000, duplex must be FULL.
+            type: str
+          speed:
+            description:
+              - The port speed; if speed is 1000, duplex is FULL.
+            type: str
+      lan_ha_port_setting:
+        description:
+          - LAN/HA port settings for the node.
+        type: list
+        elements: dict
+        suboptions:
+          ha_ip_address:
+            description:
+              - HA IP address.
+            type: str
+          ha_port_setting:
+            description:
+              - Physical port settings for the HA interface.
+            type: list
+            elements: dict
+            suboptions:
+              auto_port_setting_enabled:
+                description:
+                  - Enable or disalbe the auto port setting.
+                type: bool
+              duplex:
+                description:
+                  - The port duplex; if speed is 1000, duplex must be FULL.
+                type: str
+              speed:
+                description:
+                  - The port speed; if speed is 1000, duplex is FULL.
+                type: str
+          lan_port_setting:
+            description:
+              - Physical port settings for the LAN interface.
+            type: list
+            elements: dict
+            suboptions:
+              auto_port_setting_enabled:
+                description:
+                  - Enable or disalbe the auto port setting.
+                type: bool
+              duplex:
+                description:
+                  - The port duplex; if speed is 1000, duplex must be FULL.
+                type: str
+              speed:
+                description:
+                  - The port speed; if speed is 1000, duplex is FULL.
+                type: str
+          mgmt_ipv6addr:
+            description:
+              - Public IPv6 address for the LAN1 interface.
+            type: str
+          mgmt_lan:
+            description:
+              - Public IPv4 address for the LAN1 interface.
+            type: str
+      mgmt_network_setting:
+        description:
+          - Network settings for the MGMT port of the node.
+        type: list
+        elements: dict
+        suboptions:
+          address:
+            description:
+              - The IPv4 Address of MGMT
+            type: str
+          subnet_mask:
+            description:
+              - The subnet mask of MGMT
+            type: str
+          gateway:
+            description:
+              - The default gateway of MGMT
+            type: str
+      v6_mgmt_network_setting:
+        description:
+          - The network settings for the IPv6 MGMT port of the node.
+        type: list
+        elements: dict
+        suboptions:
+          virtual_ip:
+            description:
+              - The IPv6 Address of MGMT
+            type: str
+          cidr_prefix:
+            description:
+              - The IPv6 CIDR prefix of MGMT
+            type: int
+          gateway:
+            description:
+              - The gateway address of MGMT
+            type: str
+  mgmt_port_setting:
+    description:
+      - Settings for the member MGMT port.
+    type: list
+    elements: dict
+    suboptions:
+      enabled:
+        description:
+          - Determines if MGMT port settings should be enabled.
+        type: bool
+      security_access_enabled:
+        description:
+          - Determines if security access on the MGMT port is enabled or not.
+        type: bool
+      vpn_enabled:
+        description:
+          - Determines if VPN on the MGMT port is enabled or not.
+        type: bool
+  upgrade_group:
+    description:
+      - The name of the upgrade group to which this Grid member belongs.
+    default: Default
+    type: str
+  use_syslog_proxy_setting:
+    description:
+      - Use flag for external_syslog_server_enable , syslog_servers, syslog_proxy_setting, syslog_size
+    type: bool
+  external_syslog_server_enable:
+    description:
+      - Determines if external syslog servers should be enabled
+    type: bool
+  syslog_servers:
+    description:
+      - The list of external syslog servers.
+    type: list
+    elements: dict
+    suboptions:
+      address:
+        description:
+          - The server address.
+        type: str
+      category_list:
+        description:
+          - The list of all syslog logging categories.
+        type: list
+        elements: str
+      connection_type:
+        description:
+          - The connection type for communicating with this server.(STCP/TCP?UDP)
+        default: UDP
+        type: str
+      local_interface:
+        description:
+          - The local interface through which the appliance sends syslog messages to the syslog server.(ANY/LAN/MGMT)
+        default: ANY
+        type: str
+      message_node_id:
+        description:
+          - Identify the node in the syslog message. (HOSTNAME/IP_HOSTNAME/LAN/MGMT)
+        default: LAN
+        type: str
+      message_source:
+        description:
+          - The source of syslog messages to be sent to the external syslog server.
+        default: ANY
+        type: str
+      only_category_list:
+        description:
+          - The list of selected syslog logging categories. The appliance forwards syslog messages that belong to the selected categories.
+        type: bool
+      port:
+        description:
+          - The port this server listens on.
+        default: 514
+        type: int
+      severity:
+        description:
+          - The severity filter. The appliance sends log messages of the specified severity and above to the external syslog server.
+        default: DEBUG
+        type: str
+  pre_provisioning:
+    description:
+      - Pre-provisioning information.
+    type: list
+    elements: dict
+    suboptions:
+      hardware_info:
+        description:
+          - An array of structures that describe the hardware being pre-provisioned.
+        type: list
+        elements: dict
+        suboptions:
+          hwmodel:
+            description:
+              - Hardware model
+            type: str
+          hwtype:
+            description:
+              - Hardware type.
+            type: str
+      licenses:
+        description:
+          - An array of license types.
+        type: list
+        elements: str
+  create_token:
+    description:
+      - Flag for initiating a create token request for pre-provisioned members.
+    type: bool
+    default: False
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Add a member to the grid with IPv4 address
+  community.general.nios_member:
+    host_name: member01.localdomain
+    vip_setting:
+      - address: 192.168.1.100
+        subnet_mask: 255.255.255.0
+        gateway: 192.168.1.1
+    config_addr_type: IPV4
+    platform: VNIOS
+    comment: "Created by Ansible"
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Add a HA member to the grid
+  community.general.nios_member:
+    host_name: memberha.localdomain
+    vip_setting:
+      - address: 192.168.1.100
+        subnet_mask: 255.255.255.0
+        gateway: 192.168.1.1
+    config_addr_type: IPV4
+    platform: VNIOS
+    enable_ha: true
+    router_id: 150
+    node_info:
+      - lan_ha_port_setting:
+         - ha_ip_address: 192.168.1.70
+           mgmt_lan: 192.168.1.80
+      - lan_ha_port_setting:
+         - ha_ip_address: 192.168.1.71
+           mgmt_lan: 192.168.1.81
+    comment: "Created by Ansible"
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update the member with pre-provisioning details specified
+  community.general.nios_member:
+    name: member01.localdomain
+    pre_provisioning:
+      - hardware_info:
+         - hwmodel: IB-VM-820
+           hwtype: IB-VNIOS
+        licenses:
+         - dns
+         - dhcp
+         - enterprise
+         - vnios
+    comment: "Updated by Ansible"
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove the member
+  community.general.nios_member:
+    name: member01.localdomain
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_MEMBER
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    ipv4_spec = dict(
+        address=dict(),
+        subnet_mask=dict(),
+        gateway=dict(),
+    )
+
+    ipv6_spec = dict(
+        virtual_ip=dict(),
+        cidr_prefix=dict(type='int'),
+        gateway=dict(),
+    )
+
+    port_spec = dict(
+        auto_port_setting_enabled=dict(type='bool'),
+        duplex=dict(),
+        speed=dict(),
+    )
+
+    lan2_port_spec = dict(
+        enabled=dict(type='bool'),
+        network_setting=dict(type='list', elements='dict', options=ipv4_spec),
+        v6_network_setting=dict(type='list', elements='dict', options=ipv6_spec),
+    )
+
+    ha_port_spec = dict(
+        ha_ip_address=dict(),
+        ha_port_setting=dict(type='list', elements='dict', options=port_spec),
+        lan_port_setting=dict(type='list', elements='dict', options=port_spec),
+        mgmt_lan=dict(),
+        mgmt_ipv6addr=dict(),
+    )
+
+    node_spec = dict(
+        lan2_physical_setting=dict(type='list', elements='dict', options=port_spec),
+        lan_ha_port_setting=dict(type='list', elements='dict', options=ha_port_spec),
+        mgmt_network_setting=dict(type='list', elements='dict', options=ipv4_spec),
+        v6_mgmt_network_setting=dict(type='list', elements='dict', options=ipv6_spec),
+    )
+
+    mgmt_port_spec = dict(
+        enabled=dict(type='bool'),
+        security_access_enabled=dict(type='bool'),
+        vpn_enabled=dict(type='bool'),
+    )
+
+    syslog_spec = dict(
+        address=dict(),
+        category_list=dict(type='list', elements='str'),
+        connection_type=dict(default='UDP'),
+        local_interface=dict(default='ANY'),
+        message_node_id=dict(default='LAN'),
+        message_source=dict(default='ANY'),
+        only_category_list=dict(type='bool'),
+        port=dict(type='int', default=514),
+        severity=dict(default='DEBUG'),
+    )
+
+    hw_spec = dict(
+        hwmodel=dict(),
+        hwtype=dict(),
+    )
+
+    pre_prov_spec = dict(
+        hardware_info=dict(type='list', elements='dict', options=hw_spec),
+        licenses=dict(type='list', elements='str'),
+    )
+
+    ib_spec = dict(
+        host_name=dict(required=True, aliases=['name'], ib_req=True),
+        vip_setting=dict(type='list', elements='dict', options=ipv4_spec),
+        ipv6_setting=dict(type='list', elements='dict', options=ipv6_spec),
+        config_addr_type=dict(default='IPV4'),
+        comment=dict(),
+        enable_ha=dict(type='bool', default=False),
+        router_id=dict(type='int'),
+        lan2_enabled=dict(type='bool', default=False),
+        lan2_port_setting=dict(type='list', elements='dict', options=lan2_port_spec),
+        platform=dict(default='INFOBLOX'),
+        node_info=dict(type='list', elements='dict', options=node_spec),
+        mgmt_port_setting=dict(type='list', elements='dict', options=mgmt_port_spec),
+        upgrade_group=dict(default='Default'),
+        use_syslog_proxy_setting=dict(type='bool'),
+        external_syslog_server_enable=dict(type='bool'),
+        syslog_servers=dict(type='list', elements='dict', options=syslog_spec),
+        pre_provisioning=dict(type='list', elements='dict', options=pre_prov_spec),
+        extattrs=dict(type='dict'),
+        create_token=dict(type='bool', default=False),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_MEMBER, ib_spec)
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_mx_record.py

@@ -0,0 +1,163 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_mx_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS MX records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_mx_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of MX record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:mx) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this a record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  mail_exchanger:
+    description:
+      - Configures the mail exchanger FQDN for this MX record.
+    aliases:
+      - mx
+    type: str
+  preference:
+    description:
+      - Configures the preference (0-65535) for this MX record.
+    type: int
+  ttl:
+    description:
+      - Configures the TTL to be associated with this host record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure an MX record
+  community.general.nios_mx_record:
+    name: ansible.com
+    mx: mailhost.ansible.com
+    preference: 0
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing MX record
+  community.general.nios_mx_record:
+    name: ansible.com
+    mx: mailhost.ansible.com
+    preference: 0
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove an MX record from the system
+  community.general.nios_mx_record:
+    name: ansible.com
+    mx: mailhost.ansible.com
+    preference: 0
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_MX_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        mail_exchanger=dict(aliases=['mx'], ib_req=True),
+        preference=dict(type='int', ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_MX_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_naptr_record.py

@@ -0,0 +1,200 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_naptr_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS NAPTR records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_naptr_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of NAPTR record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:naptr) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox_client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this a record with. The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  order:
+    description:
+      - Configures the order (0-65535) for this NAPTR record. This parameter
+        specifies the order in which the NAPTR rules are applied when
+        multiple rules are present.
+    type: int
+  preference:
+    description:
+      - Configures the preference (0-65535) for this NAPTR record. The
+        preference field determines the order NAPTR records are processed
+        when multiple records with the same order parameter are present.
+    type: int
+  replacement:
+    description:
+      - Configures the replacement field for this NAPTR record.
+        For nonterminal NAPTR records, this field specifies the
+        next domain name to look up.
+    type: str
+  services:
+    description:
+      - Configures the services field (128 characters maximum) for this
+        NAPTR record. The services field contains protocol and service
+        identifiers, such as "http+E2U" or "SIPS+D2T".
+    required: false
+    type: str
+  flags:
+    description:
+      - Configures the flags field for this NAPTR record. These control the
+        interpretation of the fields for an NAPTR record object. Supported
+        values for the flags field are "U", "S", "P" and "A".
+    required: false
+    type: str
+  regexp:
+    description:
+      - Configures the regexp field for this NAPTR record. This is the
+        regular expression-based rewriting rule of the NAPTR record. This
+        should be a POSIX compliant regular expression, including the
+        substitution rule and flags. Refer to RFC 2915 for the field syntax
+        details.
+    required: false
+    type: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this NAPTR record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure a NAPTR record
+  community.general.nios_naptr_record:
+    name: '*.subscriber-100.ansiblezone.com'
+    order: 1000
+    preference: 10
+    replacement: replacement1.network.ansiblezone.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing NAPTR record
+  community.general.nios_naptr_record:
+    name: '*.subscriber-100.ansiblezone.com'
+    order: 1000
+    preference: 10
+    replacement: replacement1.network.ansiblezone.com
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove a NAPTR record from the system
+  community.general.nios_naptr_record:
+    name: '*.subscriber-100.ansiblezone.com'
+    order: 1000
+    preference: 10
+    replacement: replacement1.network.ansiblezone.com
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        order=dict(type='int', ib_req=True),
+        preference=dict(type='int', ib_req=True),
+        replacement=dict(ib_req=True),
+        services=dict(),
+        flags=dict(),
+        regexp=dict(),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run('record:naptr', ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_network.py

@@ -0,0 +1,334 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_network
+author: "Peter Sprygada (@privateip)"
+short_description: Configure Infoblox NIOS network object
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_network
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of network objects from
+    Infoblox NIOS servers.  This module manages NIOS C(network) objects
+    using the Infoblox WAPI interface over REST.
+  - Supports both IPV4 and IPV6 internet protocols
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  network:
+    description:
+      - Specifies the network to add or remove from the system.  The value
+        should use CIDR notation.
+    required: true
+    aliases:
+      - name
+      - cidr
+    type: str
+  network_view:
+    description:
+      - Configures the name of the network view to associate with this
+        configured instance.
+    default: default
+    type: str
+  options:
+    description:
+      - Configures the set of DHCP options to be included as part of
+        the configured network instance.  This argument accepts a list
+        of values (see suboptions).  When configuring suboptions at
+        least one of C(name) or C(num) must be specified.
+    type: list
+    elements: dict
+    suboptions:
+      name:
+        description:
+          - The name of the DHCP option to configure. The standard options are
+            C(router), C(router-templates), C(domain-name-servers), C(domain-name),
+            C(broadcast-address), C(broadcast-address-offset), C(dhcp-lease-time),
+            and C(dhcp6.name-servers).
+        type: str
+      num:
+        description:
+          - The number of the DHCP option to configure
+        type: int
+      value:
+        description:
+          - The value of the DHCP option specified by C(name)
+        required: true
+        type: str
+      use_option:
+        description:
+          - Only applies to a subset of options (see NIOS API documentation)
+        type: bool
+        default: 'yes'
+      vendor_class:
+        description:
+          - The name of the space this DHCP option is associated to
+        default: DHCP
+        type: str
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  container:
+    description:
+      - If set to true it'll create the network container to be added or removed
+        from the system.
+    type: bool
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure a network ipv4
+  community.general.nios_network:
+    network: 192.168.10.0/24
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Configure a network ipv6
+  community.general.nios_network:
+    network: fe80::/64
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Set dhcp options for a network ipv4
+  community.general.nios_network:
+    network: 192.168.10.0/24
+    comment: this is a test comment
+    options:
+      - name: domain-name
+        value: ansible.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove a network ipv4
+  community.general.nios_network:
+    network: 192.168.10.0/24
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Configure a ipv4 network container
+  community.general.nios_network:
+    network: 192.168.10.0/24
+    container: true
+    comment: test network container
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Configure a ipv6 network container
+  community.general.nios_network:
+    network: fe80::/64
+    container: true
+    comment: test network container
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove a ipv4 network container
+  community.general.nios_network:
+    networkr: 192.168.10.0/24
+    container: true
+    comment: test network container
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+import socket
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.six import iteritems
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_IPV4_NETWORK, NIOS_IPV6_NETWORK
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_IPV4_NETWORK_CONTAINER, NIOS_IPV6_NETWORK_CONTAINER
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+# The following function validate_ip_address has been taken from
+# https://github.com/ansible-collections/ansible.netcommon/blob/20124ecbb420daa0f5bb9cdaa865a952657aa0e7/plugins/module_utils/network/common/utils.py#L496
+# The code there is licensed under BSD 2-clause.
+# Copyright (c) 2016 Red Hat Inc.
+def validate_ip_address(address):
+    try:
+        socket.inet_aton(address)
+    except socket.error:
+        return False
+    return address.count(".") == 3
+
+
+# The following function validate_ip_v6_address has been taken from
+# https://github.com/ansible-collections/ansible.netcommon/blob/20124ecbb420daa0f5bb9cdaa865a952657aa0e7/plugins/module_utils/network/common/utils.py#L504
+# The code there is licensed under BSD 2-clause.
+# Copyright (c) 2016 Red Hat Inc.
+def validate_ip_v6_address(address):
+    try:
+        socket.inet_pton(socket.AF_INET6, address)
+    except socket.error:
+        return False
+    return True
+
+
+def options(module):
+    ''' Transforms the module argument into a valid WAPI struct
+    This function will transform the options argument into a structure that
+    is a valid WAPI structure in the format of:
+        {
+            name: <value>,
+            num: <value>,
+            value: <value>,
+            use_option: <value>,
+            vendor_class: <value>
+        }
+    It will remove any options that are set to None since WAPI will error on
+    that condition.  It will also verify that either `name` or `num` is
+    set in the structure but does not validate the values are equal.
+    The remainder of the value validation is performed by WAPI
+    '''
+    options = list()
+    for item in module.params['options']:
+        opt = dict([(k, v) for k, v in iteritems(item) if v is not None])
+        if 'name' not in opt and 'num' not in opt:
+            module.fail_json(msg='one of `name` or `num` is required for option value')
+        options.append(opt)
+    return options
+
+
+def check_ip_addr_type(obj_filter, ib_spec):
+    '''This function will check if the argument ip is type v4/v6 and return appropriate infoblox
+       network/networkcontainer type
+    '''
+
+    ip = obj_filter['network']
+    if 'container' in obj_filter and obj_filter['container']:
+        check_ip = ip.split('/')
+        del ib_spec['container']  # removing the container key from post arguments
+        del ib_spec['options']  # removing option argument as for network container it's not supported
+        if validate_ip_address(check_ip[0]):
+            return NIOS_IPV4_NETWORK_CONTAINER, ib_spec
+        elif validate_ip_v6_address(check_ip[0]):
+            return NIOS_IPV6_NETWORK_CONTAINER, ib_spec
+    else:
+        check_ip = ip.split('/')
+        del ib_spec['container']  # removing the container key from post arguments
+        if validate_ip_address(check_ip[0]):
+            return NIOS_IPV4_NETWORK, ib_spec
+        elif validate_ip_v6_address(check_ip[0]):
+            return NIOS_IPV6_NETWORK, ib_spec
+
+
+def check_vendor_specific_dhcp_option(module, ib_spec):
+    '''This function will check if the argument dhcp option belongs to vendor-specific and if yes then will remove
+     use_options flag which is not supported with vendor-specific dhcp options.
+    '''
+    for key, value in iteritems(ib_spec):
+        if isinstance(module.params[key], list):
+            temp_dict = module.params[key][0]
+            if 'num' in temp_dict:
+                if temp_dict['num'] in (43, 124, 125):
+                    del module.params[key][0]['use_option']
+    return ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    option_spec = dict(
+        # one of name or num is required; enforced by the function options()
+        name=dict(),
+        num=dict(type='int'),
+
+        value=dict(required=True),
+
+        use_option=dict(type='bool', default=True),
+        vendor_class=dict(default='DHCP')
+    )
+
+    ib_spec = dict(
+        network=dict(required=True, aliases=['name', 'cidr'], ib_req=True),
+        network_view=dict(default='default', ib_req=True),
+
+        options=dict(type='list', elements='dict', options=option_spec, transform=options),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+        container=dict(type='bool', ib_req=True)
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    # to get the argument ipaddr
+    obj_filter = dict([(k, module.params[k]) for k, v in iteritems(ib_spec) if v.get('ib_req')])
+    network_type, ib_spec = check_ip_addr_type(obj_filter, ib_spec)
+
+    wapi = WapiModule(module)
+    # to check for vendor specific dhcp option
+    ib_spec = check_vendor_specific_dhcp_option(module, ib_spec)
+
+    result = wapi.run(network_type, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_network_view.py

@@ -0,0 +1,138 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_network_view
+author: "Peter Sprygada (@privateip)"
+short_description: Configure Infoblox NIOS network views
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_network_view
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of network view objects from
+    Infoblox NIOS servers.  This module manages NIOS C(networkview) objects
+    using the Infoblox WAPI interface over REST.
+  - Updates instances of network view object from Infoblox NIOS servers.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system. User can also update the hostname as it is possible
+        to pass a dict containing I(new_name), I(old_name). See examples.
+    required: true
+    aliases:
+      - network_view
+    type: str
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure a new network view
+  community.general.nios_network_view:
+    name: ansible
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update the comment for network view
+  community.general.nios_network_view:
+    name: ansible
+    comment: this is an example comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Remove the network view
+  community.general.nios_network_view:
+    name: ansible
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+- name: Update a existing network view
+  community.general.nios_network_view:
+    name: {new_name: ansible-new, old_name: ansible}
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_NETWORK_VIEW
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+    ib_spec = dict(
+        name=dict(required=True, aliases=['network_view'], ib_req=True),
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_NETWORK_VIEW, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_nsgroup.py

@@ -0,0 +1,446 @@
+#!/usr/bin/python
+# -*- 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 = '''
+---
+module: nios_nsgroup
+short_description: Configure InfoBlox DNS Nameserver Groups
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_nsgroup
+    removed_in: 5.0.0
+extends_documentation_fragment:
+- community.general.nios
+
+author:
+  - Erich Birngruber (@ebirn)
+  - Sumit Jaiswal (@sjaiswal)
+description:
+  - Adds and/or removes nameserver groups form Infoblox NIOS servers.
+    This module manages NIOS C(nsgroup) objects using the Infoblox. WAPI interface over REST.
+requirements:
+  - infoblox_client
+options:
+  name:
+    description:
+      - Specifies the name of the NIOS nameserver group to be managed.
+    required: true
+    type: str
+  grid_primary:
+    description:
+      - This host is to be used as primary server in this nameserver group. It must be a grid member.
+        This option is required when setting I(use_external_primaries) to C(false).
+    type: list
+    elements: dict
+    suboptions:
+      name:
+        description:
+          - Provide the name of the grid member to identify the host.
+        required: true
+        type: str
+      enable_preferred_primaries:
+        description:
+          - This flag represents whether the preferred_primaries field values of this member are used (see Infoblox WAPI docs).
+        default: false
+        type: bool
+      grid_replicate:
+        description:
+          - Use DNS zone transfers if set to C(True) or ID Grid Replication if set to C(False).
+        type: bool
+        default: false
+      lead:
+        description:
+          - This flag controls if the grid lead secondary nameserver performs zone transfers to non lead secondaries.
+        type: bool
+        default: false
+      stealth:
+        description:
+          - Configure the external nameserver as stealth server (without NS record) in the zones.
+        type: bool
+        default: false
+      preferred_primaries:
+        description:
+          - Provide a list of elements like in I(external_primaries) to set the precedence of preferred primary nameservers.
+        type: list
+        elements: dict
+        suboptions:
+          address:
+            description:
+              - Configures the IP address of the preferred primary nameserver.
+            required: true
+            type: str
+          name:
+            description:
+              - Set a label for the preferred primary nameserver.
+            required: true
+            type: str
+          stealth:
+            description:
+              - Configure the preferred primary nameserver as stealth server (without NS record) in the zones.
+            type: bool
+            default: false
+          tsig_key_name:
+            description:
+              - Sets a label for the I(tsig_key) value.
+            required: true
+            type: str
+          tsig_key_alg:
+            description:
+              - Provides the algorithm used for the I(tsig_key) in use.
+            choices: ['HMAC-MD5', 'HMAC-SHA256']
+            default: 'HMAC-MD5'
+            type: str
+          tsig_key:
+            description:
+              - Set a DNS TSIG key for the nameserver to secure zone transfers (AFXRs).
+            type: str
+  grid_secondaries:
+    description:
+     - Configures the list of grid member hosts that act as secondary nameservers.
+       This option is required when setting I(use_external_primaries) to C(true).
+    type: list
+    elements: dict
+    suboptions:
+      name:
+        description:
+          - Provide the name of the grid member to identify the host.
+        required: true
+        type: str
+      enable_preferred_primaries:
+        description:
+          - This flag represents whether the preferred_primaries field values of this member are used (see Infoblox WAPI docs).
+        default: false
+        type: bool
+      grid_replicate:
+        description:
+          - Use DNS zone transfers if set to C(True) or ID Grid Replication if set to C(False)
+        type: bool
+        default: false
+      lead:
+        description:
+          - This flag controls if the grid lead secondary nameserver performs zone transfers to non lead secondaries.
+        type: bool
+        default: false
+      stealth:
+        description:
+          - Configure the external nameserver as stealth server (without NS record) in the zones.
+        type: bool
+        default: false
+      preferred_primaries:
+        description:
+          - Provide a list of elements like in I(external_primaries) to set the precedence of preferred primary nameservers.
+        type: list
+        elements: dict
+        suboptions:
+          address:
+            description:
+              - Configures the IP address of the preferred primary nameserver.
+            required: true
+            type: str
+          name:
+            description:
+              - Set a label for the preferred primary nameserver.
+            required: true
+            type: str
+          stealth:
+            description:
+              - Configure the preferred primary nameserver as stealth server (without NS record) in the zones.
+            type: bool
+            default: false
+          tsig_key_name:
+            description:
+              - Sets a label for the I(tsig_key) value.
+            type: str
+            required: true
+          tsig_key_alg:
+            description:
+              - Provides the algorithm used for the I(tsig_key) in use.
+            choices: ['HMAC-MD5', 'HMAC-SHA256']
+            default: 'HMAC-MD5'
+            type: str
+          tsig_key:
+            description:
+              - Set a DNS TSIG key for the nameserver to secure zone transfers (AFXRs).
+            type: str
+  is_grid_default:
+    description:
+      - If set to C(True) this nsgroup will become the default nameserver group for new zones.
+    type: bool
+    required: false
+    default: false
+  use_external_primary:
+    description:
+      - This flag controls whether the group is using an external primary nameserver.
+        Note that modification of this field requires passing values for I(grid_secondaries) and I(external_primaries).
+    type: bool
+    required: false
+    default: false
+  external_primaries:
+    description:
+      - Configures a list of external nameservers (non-members of the grid).
+        This option is required when setting I(use_external_primaries) to C(true).
+    type: list
+    elements: dict
+    suboptions:
+      address:
+        description:
+          - Configures the IP address of the external nameserver
+        required: true
+        type: str
+      name:
+        description:
+          - Set a label for the external nameserver
+        required: true
+        type: str
+      stealth:
+        description:
+          - Configure the external nameserver as stealth server (without NS record) in the zones.
+        type: bool
+        default: false
+      tsig_key_name:
+        description:
+          - Sets a label for the I(tsig_key) value
+        type: str
+        required: true
+      tsig_key_alg:
+        description:
+          - Provides the algorithm used for the I(tsig_key) in use.
+        choices: ['HMAC-MD5', 'HMAC-SHA256']
+        default: 'HMAC-MD5'
+        type: str
+      tsig_key:
+        description:
+          - Set a DNS TSIG key for the nameserver to secure zone transfers (AFXRs).
+        type: str
+    required: false
+  external_secondaries:
+    description:
+      - Allows to provide a list of external secondary nameservers, that are not members of the grid.
+    type: list
+    elements: dict
+    suboptions:
+      address:
+        description:
+          - Configures the IP address of the external nameserver
+        required: true
+        type: str
+      name:
+        description:
+          - Set a label for the external nameserver
+        required: true
+        type: str
+      stealth:
+        description:
+          - Configure the external nameserver as stealth server (without NS record) in the zones.
+        type: bool
+        default: false
+      tsig_key_name:
+        description:
+          - Sets a label for the I(tsig_key) value
+        type: str
+        required: true
+      tsig_key_alg:
+        description:
+          - Provides the algorithm used for the I(tsig_key) in use.
+        choices: ['HMAC-MD5', 'HMAC-SHA256']
+        default: 'HMAC-MD5'
+        type: str
+      tsig_key:
+        description:
+          - Set a DNS TSIG key for the nameserver to secure zone transfers (AFXRs).
+        type: str
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    required: false
+    type: str
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    required: false
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    choices: [present, absent]
+    default: present
+    type: str
+    '''
+
+EXAMPLES = '''
+- name: Create simple infoblox nameserver group
+  community.general.nios_nsgroup:
+    name: my-simple-group
+    comment: "this is a simple nameserver group"
+    grid_primary:
+      - name: infoblox-test.example.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Create infoblox nameserver group with external primaries
+  community.general.nios_nsgroup:
+    name: my-example-group
+    use_external_primary: true
+    comment: "this is my example nameserver group"
+    external_primaries: "{{ ext_nameservers }}"
+    grid_secondaries:
+      - name: infoblox-test.example.com
+        lead: True
+        preferred_primaries: "{{ ext_nameservers }}"
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Delete infoblox nameserver group
+  community.general.nios_nsgroup:
+    name: my-simple-group
+    comment: "this is a simple nameserver group"
+    grid_primary:
+      - name: infoblox-test.example.com
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_NSGROUP
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+# from infoblox documentation
+# Fields List
+# Field         Type            Req     R/O     Base    Search
+# comment               String          N       N       Y       : = ~
+# extattrs              Extattr         N       N       N       ext
+# external_primaries    [struct]        N       N       N       N/A
+# external_secondaries  [struct]        N       N       N       N/A
+# grid_primary          [struct]        N       N       N       N/A
+# grid_secondaries      [struct]        N       N       N       N/A
+# is_grid_default       Bool            N       N       N       N/A
+# is_multimaster        Bool            N       Y       N       N/A
+# name                  String          Y               N       Y       : = ~
+# use_external_primary  Bool            N       N       N       N/A
+
+
+def main():
+    '''entrypoint for module execution.'''
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent']),
+    )
+
+    # cleanup tsig fields
+    def clean_tsig(ext):
+        if 'tsig_key' in ext and not ext['tsig_key']:
+            del ext['tsig_key']
+        if 'tsig_key' not in ext and 'tsig_key_name' in ext and not ext['tsig_key_name']:
+            del ext['tsig_key_name']
+        if 'tsig_key' not in ext and 'tsig_key_alg' in ext:
+            del ext['tsig_key_alg']
+
+    def clean_grid_member(member):
+        if member['preferred_primaries']:
+            for ext in member['preferred_primaries']:
+                clean_tsig(ext)
+        if member['enable_preferred_primaries'] is False:
+            del member['enable_preferred_primaries']
+            del member['preferred_primaries']
+        if member['lead'] is False:
+            del member['lead']
+        if member['grid_replicate'] is False:
+            del member['grid_replicate']
+
+    def ext_primaries_transform(module):
+        if module.params['external_primaries']:
+            for ext in module.params['external_primaries']:
+                clean_tsig(ext)
+        return module.params['external_primaries']
+
+    def ext_secondaries_transform(module):
+        if module.params['external_secondaries']:
+            for ext in module.params['external_secondaries']:
+                clean_tsig(ext)
+        return module.params['external_secondaries']
+
+    def grid_primary_preferred_transform(module):
+        for member in module.params['grid_primary']:
+            clean_grid_member(member)
+        return module.params['grid_primary']
+
+    def grid_secondaries_preferred_primaries_transform(module):
+        for member in module.params['grid_secondaries']:
+            clean_grid_member(member)
+        return module.params['grid_secondaries']
+
+    extserver_spec = dict(
+        address=dict(required=True),
+        name=dict(required=True),
+        stealth=dict(type='bool', default=False),
+        tsig_key=dict(no_log=True),
+        tsig_key_alg=dict(choices=['HMAC-MD5', 'HMAC-SHA256'], default='HMAC-MD5'),
+        tsig_key_name=dict(required=True)
+    )
+
+    memberserver_spec = dict(
+        name=dict(required=True, ),
+        enable_preferred_primaries=dict(type='bool', default=False),
+        grid_replicate=dict(type='bool', default=False),
+        lead=dict(type='bool', default=False),
+        preferred_primaries=dict(type='list', elements='dict', options=extserver_spec, default=[]),
+        stealth=dict(type='bool', default=False),
+    )
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        grid_primary=dict(type='list', elements='dict', options=memberserver_spec,
+                          transform=grid_primary_preferred_transform),
+        grid_secondaries=dict(type='list', elements='dict', options=memberserver_spec,
+                              transform=grid_secondaries_preferred_primaries_transform),
+        external_primaries=dict(type='list', elements='dict', options=extserver_spec, transform=ext_primaries_transform),
+        external_secondaries=dict(type='list', elements='dict', options=extserver_spec,
+                                  transform=ext_secondaries_transform),
+        is_grid_default=dict(type='bool', default=False),
+        use_external_primary=dict(type='bool', default=False),
+        extattrs=dict(),
+        comment=dict(),
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_NSGROUP, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_ptr_record.py

@@ -0,0 +1,168 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_ptr_record
+author: "Trebuchet Clement (@clementtrebuchet)"
+short_description: Configure Infoblox NIOS PTR records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_ptr_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of PTR record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:ptr) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox_client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - The name of the DNS PTR record in FQDN format to add or remove from
+        the system.
+        The field is required only for an PTR object in Forward Mapping Zone.
+    required: false
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this a record with. The DNS
+        view must already be configured on the system
+    required: false
+    aliases:
+      - dns_view
+    type: str
+  ipv4addr:
+    description:
+      - The IPv4 Address of the record. Mutually exclusive with the ipv6addr.
+    aliases:
+      - ipv4
+    type: str
+  ipv6addr:
+    description:
+      - The IPv6 Address of the record. Mutually exclusive with the ipv4addr.
+    aliases:
+      - ipv6
+    type: str
+  ptrdname:
+    description:
+      - The domain name of the DNS PTR record in FQDN format.
+    type: str
+  ttl:
+    description:
+      - Time To Live (TTL) value for the record.
+        A 32-bit unsigned integer that represents the duration, in seconds, that the record is valid (cached).
+        Zero indicates that the record should not be cached.
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance. Maximum 256 characters.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Create a PTR Record
+  community.general.nios_ptr_record:
+    ipv4: 192.168.10.1
+    ptrdname: host.ansible.com
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Delete a PTR Record
+  community.general.nios_ptr_record:
+    ipv4: 192.168.10.1
+    ptrdname: host.ansible.com
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_PTR_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    # Module entry point
+    ib_spec = dict(
+        name=dict(required=False),
+        view=dict(aliases=['dns_view'], ib_req=True),
+        ipv4addr=dict(aliases=['ipv4'], ib_req=True),
+        ipv6addr=dict(aliases=['ipv6'], ib_req=True),
+        ptrdname=dict(ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    mutually_exclusive = [('ipv4addr', 'ipv6addr')]
+    required_one_of = [
+        ['ipv4addr', 'ipv6addr']
+    ]
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           mutually_exclusive=mutually_exclusive,
+                           supports_check_mode=True,
+                           required_one_of=required_one_of)
+
+    if module.params['ipv4addr']:
+        del ib_spec['ipv6addr']
+    elif module.params['ipv6addr']:
+        del ib_spec['ipv4addr']
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_PTR_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_srv_record.py

@@ -0,0 +1,177 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_srv_record
+author: "Blair Rampling (@brampling)"
+short_description: Configure Infoblox NIOS SRV records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_srv_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of SRV record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:srv) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox-client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this a record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  port:
+    description:
+      - Configures the port (0-65535) of this SRV record.
+    type: int
+  priority:
+    description:
+      - Configures the priority (0-65535) for this SRV record.
+    type: int
+  target:
+    description:
+      - Configures the target FQDN for this SRV record.
+    type: str
+  weight:
+    description:
+      - Configures the weight (0-65535) for this SRV record.
+    type: int
+  ttl:
+    description:
+      - Configures the TTL to be associated with this host record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+- name: Configure an SRV record
+  community.general.nios_srv_record:
+    name: _sip._tcp.service.ansible.com
+    port: 5080
+    priority: 10
+    target: service1.ansible.com
+    weight: 10
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Add a comment to an existing SRV record
+  community.general.nios_srv_record:
+    name: _sip._tcp.service.ansible.com
+    port: 5080
+    priority: 10
+    target: service1.ansible.com
+    weight: 10
+    comment: this is a test comment
+    state: present
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+
+- name: Remove an SRV record from the system
+  community.general.nios_srv_record:
+    name: _sip._tcp.service.ansible.com
+    port: 5080
+    priority: 10
+    target: service1.ansible.com
+    weight: 10
+    state: absent
+    provider:
+      host: "{{ inventory_hostname_short }}"
+      username: admin
+      password: admin
+  connection: local
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import NIOS_SRV_RECORD
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+
+        port=dict(type='int', ib_req=True),
+        priority=dict(type='int', ib_req=True),
+        target=dict(ib_req=True),
+        weight=dict(type='int', ib_req=True),
+
+        ttl=dict(type='int'),
+
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run(NIOS_SRV_RECORD, ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

plugins/modules/net_tools/nios/nios_txt_record.py

@@ -0,0 +1,140 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2018 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
+
+DOCUMENTATION = '''
+---
+module: nios_txt_record
+author: "Corey Wanless (@coreywan)"
+short_description: Configure Infoblox NIOS txt records
+deprecated:
+    why: Please install the infoblox.nios_modules collection and use the corresponding module from it.
+    alternative: infoblox.nios_modules.nios_txt_record
+    removed_in: 5.0.0
+description:
+  - Adds and/or removes instances of txt record objects from
+    Infoblox NIOS servers.  This module manages NIOS C(record:txt) objects
+    using the Infoblox WAPI interface over REST.
+requirements:
+  - infoblox_client
+extends_documentation_fragment:
+- community.general.nios
+
+options:
+  name:
+    description:
+      - Specifies the fully qualified hostname to add or remove from
+        the system
+    required: true
+    type: str
+  view:
+    description:
+      - Sets the DNS view to associate this tst record with.  The DNS
+        view must already be configured on the system
+    default: default
+    aliases:
+      - dns_view
+    type: str
+  text:
+    description:
+      - Text associated with the record. It can contain up to 255 bytes
+        per substring, up to a total of 512 bytes. To enter leading,
+        trailing, or embedded spaces in the text, add quotes around the
+        text to preserve the spaces.
+    type: str
+  ttl:
+    description:
+      - Configures the TTL to be associated with this tst record
+    type: int
+  extattrs:
+    description:
+      - Allows for the configuration of Extensible Attributes on the
+        instance of the object.  This argument accepts a set of key / value
+        pairs for configuration.
+    type: dict
+  comment:
+    description:
+      - Configures a text string comment to be associated with the instance
+        of this object.  The provided text string will be configured on the
+        object instance.
+    type: str
+  state:
+    description:
+      - Configures the intended state of the instance of the object on
+        the NIOS server.  When this value is set to C(present), the object
+        is configured on the device and when this value is set to C(absent)
+        the value is removed (if necessary) from the device.
+    default: present
+    choices:
+      - present
+      - absent
+    type: str
+'''
+
+EXAMPLES = '''
+    - name: Ensure a text Record Exists
+      community.general.nios_txt_record:
+        name: fqdn.txt.record.com
+        text: mytext
+        state: present
+        view: External
+        provider:
+          host: "{{ inventory_hostname_short }}"
+          username: admin
+          password: admin
+
+    - name: Ensure a text Record does not exist
+      community.general.nios_txt_record:
+        name: fqdn.txt.record.com
+        text: mytext
+        state: absent
+        view: External
+        provider:
+          host: "{{ inventory_hostname_short }}"
+          username: admin
+          password: admin
+'''
+
+RETURN = ''' # '''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiModule
+from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import normalize_ib_spec
+
+
+def main():
+    ''' Main entry point for module execution
+    '''
+
+    ib_spec = dict(
+        name=dict(required=True, ib_req=True),
+        view=dict(default='default', aliases=['dns_view'], ib_req=True),
+        text=dict(ib_req=True),
+        ttl=dict(type='int'),
+        extattrs=dict(type='dict'),
+        comment=dict(),
+    )
+
+    argument_spec = dict(
+        provider=dict(required=True),
+        state=dict(default='present', choices=['present', 'absent'])
+    )
+
+    argument_spec.update(normalize_ib_spec(ib_spec))
+    argument_spec.update(WapiModule.provider_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           supports_check_mode=True)
+
+    wapi = WapiModule(module)
+    result = wapi.run('record:txt', ib_spec)
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()