Release 2.2.0.

* fixed validation-modules for plugins/modules/cloud/heroku/heroku_collaborator.py

* fixed validation-modules for plugins/modules/cloud/linode/linode_v4.py

* fixed validation-modules for plugins/modules/remote_management/manageiq/manageiq_provider.py

* fixed validation-modules for plugins/modules/remote_management/manageiq/manageiq_policies.py

* fixed validation-modules for plugins/modules/remote_management/manageiq/manageiq_alert_profiles.py

* fixed validation-modules for plugins/modules/remote_management/manageiq/manageiq_tags.py

* fixed validation-modules for plugins/modules/cloud/opennebula/one_host.py

* fixed validation-modules for plugins/modules/cloud/opennebula/one_image_info.py

* fixed validation-modules for plugins/modules/cloud/opennebula/one_vm.py

* fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_lb.py

* fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_compute.py

* fixed validation-modules for plugins/modules/remote_management/oneview/oneview_network_set_info.py

* fixed validation-modules for plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py

* fixed validation-modules for plugins/modules/remote_management/oneview/oneview_datacenter_info.py

* fixed validation-modules for plugins/modules/remote_management/oneview/oneview_enclosure_info.py

* Tidy up sanity checks ignore lines modules (batch 7)

* added changelog fragment

* Missed a couple of lines in ingnore-2.11.txt

* fixed validation-modules for plugins/modules/cloud/packet/packet_volume_attachment.py

* Adjusted ignore files and changelog for packet_volume_attachment.py

* Rolled back ignore line for linode module

* Update plugins/modules/cloud/opennebula/one_image_info.py

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

* fixes from the PR

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

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

.azure-pipelines/README.md

@@ -0,0 +1,3 @@
+## Azure Pipelines Configuration
+
+Please see the [Documentation](https://github.com/ansible/community/wiki/Testing:-Azure-Pipelines) for more information.

.azure-pipelines/azure-pipelines.yml

@@ -0,0 +1,315 @@
+trigger:
+  batch: true
+  branches:
+    include:
+      - main
+      - stable-*
+
+pr:
+  autoCancel: true
+  branches:
+    include:
+      - main
+      - stable-*
+
+schedules:
+  - cron: 0 9 * * *
+    displayName: Nightly
+    always: true
+    branches:
+      include:
+        - main
+        - stable-*
+
+variables:
+  - name: checkoutPath
+    value: ansible_collections/community/general
+  - name: coverageBranches
+    value: main
+  - name: pipelinesCoverage
+    value: coverage
+  - name: entryPoint
+    value: tests/utils/shippable/shippable.sh
+  - name: fetchDepth
+    value: 0
+
+resources:
+  containers:
+    - container: default
+      image: quay.io/ansible/azure-pipelines-test-container:1.8.0
+
+pool: Standard
+
+stages:
+### Sanity
+  - stage: Sanity_devel
+    displayName: Sanity devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: devel/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+            - test: extra
+  - stage: Sanity_2_10
+    displayName: Sanity 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.10/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+  - stage: Sanity_2_9
+    displayName: Sanity 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Test {0}
+          testFormat: 2.9/sanity/{0}
+          targets:
+            - test: 1
+            - test: 2
+            - test: 3
+            - test: 4
+### Units
+  - stage: Units_devel
+    displayName: Units devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: devel/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_10
+    displayName: Units 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          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: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.9/units/{0}/1
+          targets:
+            - test: 2.6
+            - test: 2.7
+            - test: 3.5
+            - test: 3.6
+            - test: 3.7
+            - test: 3.8
+
+## Remote
+  - stage: Remote_devel
+    displayName: Remote devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/{0}
+          targets:
+            - name: macOS 11.1
+              test: macos/11.1
+            - name: RHEL 7.9
+              test: rhel/7.9
+            - name: RHEL 8.3
+              test: rhel/8.3
+            - name: FreeBSD 11.4
+              test: freebsd/11.4
+            - name: FreeBSD 12.2
+              test: freebsd/12.2
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Remote_2_10
+    displayName: Remote 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.10/{0}
+          targets:
+            - name: OS X 10.11
+              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
+  - stage: Remote_2_9
+    displayName: Remote 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.9/{0}
+          targets:
+            - name: RHEL 8.2
+              test: rhel/8.2
+            - name: FreeBSD 12.0
+              test: freebsd/12.0
+          groups:
+            - 1
+            - 2
+
+### Docker
+  - stage: Docker_devel
+    displayName: Docker devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: devel/linux/{0}
+          targets:
+            - name: CentOS 6
+              test: centos6
+            - name: CentOS 7
+              test: centos7
+            - name: CentOS 8
+              test: centos8
+            - name: Fedora 32
+              test: fedora32
+            - name: Fedora 33
+              test: fedora33
+            - name: openSUSE 15 py2
+              test: opensuse15py2
+            - name: openSUSE 15 py3
+              test: opensuse15
+            - name: Ubuntu 18.04
+              test: ubuntu1804
+            - name: Ubuntu 20.04
+              test: ubuntu2004
+          groups:
+            - 1
+            - 2
+            - 3
+  - stage: Docker_2_10
+    displayName: Docker 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        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:
+            - 2
+            - 3
+  - stage: Docker_2_9
+    displayName: Docker 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          testFormat: 2.9/linux/{0}
+          targets:
+            - name: CentOS 8
+              test: centos8
+            - name: Fedora 31
+              test: fedora31
+            - name: openSUSE 15 py3
+              test: opensuse15
+          groups:
+            - 2
+            - 3
+
+### Cloud
+  - stage: Cloud_devel
+    displayName: Cloud devel
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: devel/cloud/{0}/1
+          targets:
+            - test: 2.7
+            - test: 3.6
+  - stage: Cloud_2_10
+    displayName: Cloud 2.10
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.10/cloud/{0}/1
+          targets:
+            - test: 3.6
+  - stage: Cloud_2_9
+    displayName: Cloud 2.9
+    dependsOn: []
+    jobs:
+      - template: templates/matrix.yml
+        parameters:
+          nameFormat: Python {0}
+          testFormat: 2.9/cloud/{0}/1
+          targets:
+            - test: 3.6
+  - stage: Summary
+    condition: succeededOrFailed()
+    dependsOn:
+      - Sanity_devel
+      - Sanity_2_9
+      - Sanity_2_10
+      - Units_devel
+      - Units_2_9
+      - Units_2_10
+      - Remote_devel
+      - Remote_2_9
+      - Remote_2_10
+      - Docker_devel
+      - Docker_2_9
+      - Docker_2_10
+      - Cloud_devel
+      - Cloud_2_9
+      - Cloud_2_10
+    jobs:
+      - template: templates/coverage.yml

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

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# Aggregate code coverage results for later processing.
+
+set -o pipefail -eu
+
+agent_temp_directory="$1"
+
+PATH="${PWD}/bin:${PATH}"
+
+mkdir "${agent_temp_directory}/coverage/"
+
+options=(--venv --venv-system-site-packages --color -v)
+
+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.
+    # Doing so allows this script to work unmodified for multiple Ansible versions.
+    ansible-test coverage analyze targets generate "${agent_temp_directory}/coverage/coverage-analyze-targets.json" "${options[@]}"
+fi

.azure-pipelines/scripts/combine-coverage.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+"""
+Combine coverage data from multiple jobs, keeping the data only from the most recent attempt from each job.
+Coverage artifacts must be named using the format: "Coverage $(System.JobAttempt) {StableUniqueNameForEachJob}"
+The recommended coverage artifact name format is: Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)
+Keep in mind that Azure Pipelines does not enforce unique job display names (only names).
+It is up to pipeline authors to avoid name collisions when deviating from the recommended format.
+"""
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import re
+import shutil
+import sys
+
+
+def main():
+    """Main program entry point."""
+    source_directory = sys.argv[1]
+
+    if '/ansible_collections/' in os.getcwd():
+        output_path = "tests/output"
+    else:
+        output_path = "test/results"
+
+    destination_directory = os.path.join(output_path, 'coverage')
+
+    if not os.path.exists(destination_directory):
+        os.makedirs(destination_directory)
+
+    jobs = {}
+    count = 0
+
+    for name in os.listdir(source_directory):
+        match = re.search('^Coverage (?P<attempt>[0-9]+) (?P<label>.+)$', name)
+        label = match.group('label')
+        attempt = int(match.group('attempt'))
+        jobs[label] = max(attempt, jobs.get(label, 0))
+
+    for label, attempt in jobs.items():
+        name = 'Coverage {attempt} {label}'.format(label=label, attempt=attempt)
+        source = os.path.join(source_directory, name)
+        source_files = os.listdir(source)
+
+        for source_file in source_files:
+            source_path = os.path.join(source, source_file)
+            destination_path = os.path.join(destination_directory, source_file + '.' + label)
+            print('"%s" -> "%s"' % (source_path, destination_path))
+            shutil.copyfile(source_path, destination_path)
+            count += 1
+
+    print('Coverage file count: %d' % count)
+    print('##vso[task.setVariable variable=coverageFileCount]%d' % count)
+    print('##vso[task.setVariable variable=outputPath]%s' % output_path)
+
+
+if __name__ == '__main__':
+    main()

.azure-pipelines/scripts/process-results.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# Check the test results and set variables for use in later steps.
+
+set -o pipefail -eu
+
+if [[ "$PWD" =~ /ansible_collections/ ]]; then
+    output_path="tests/output"
+else
+    output_path="test/results"
+fi
+
+echo "##vso[task.setVariable variable=outputPath]${output_path}"
+
+if compgen -G "${output_path}"'/junit/*.xml' > /dev/null; then
+    echo "##vso[task.setVariable variable=haveTestResults]true"
+fi
+
+if compgen -G "${output_path}"'/bot/ansible-test-*' > /dev/null; then
+    echo "##vso[task.setVariable variable=haveBotResults]true"
+fi
+
+if compgen -G "${output_path}"'/coverage/*' > /dev/null; then
+    echo "##vso[task.setVariable variable=haveCoverageData]true"
+fi

.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://codecov.io/bash > 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

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+# Generate code coverage reports for uploading to Azure Pipelines and codecov.io.
+
+set -o pipefail -eu
+
+PATH="${PWD}/bin:${PATH}"
+
+if ! ansible-test --help >/dev/null 2>&1; then
+    # Install the devel version of ansible-test for generating code coverage reports.
+    # This is only used by Ansible Collections, which are typically tested against multiple Ansible versions (in separate jobs).
+    # Since a version of ansible-test is required that can work the output from multiple older releases, the devel version is used.
+    pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check
+fi
+
+ansible-test coverage xml --stub --venv --venv-system-site-packages --color -v

.azure-pipelines/scripts/run-tests.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+# Configure the test environment and run the tests.
+
+set -o pipefail -eu
+
+entry_point="$1"
+test="$2"
+read -r -a coverage_branches <<< "$3"  # space separated list of branches to run code coverage on for scheduled builds
+
+export COMMIT_MESSAGE
+export COMPLETE
+export COVERAGE
+export IS_PULL_REQUEST
+
+if [ "${SYSTEM_PULLREQUEST_TARGETBRANCH:-}" ]; then
+    IS_PULL_REQUEST=true
+    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD^2)
+else
+    IS_PULL_REQUEST=
+    COMMIT_MESSAGE=$(git log --format=%B -n 1 HEAD)
+fi
+
+COMPLETE=
+COVERAGE=
+
+if [ "${BUILD_REASON}" = "Schedule" ]; then
+    COMPLETE=yes
+
+    if printf '%s\n' "${coverage_branches[@]}" | grep -q "^${BUILD_SOURCEBRANCHNAME}$"; then
+        COVERAGE=yes
+    fi
+fi
+
+"${entry_point}" "${test}" 2>&1 | "$(dirname "$0")/time-command.py"

.azure-pipelines/scripts/time-command.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""Prepends a relative timestamp to each input line from stdin and writes it to stdout."""
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import sys
+import time
+
+
+def main():
+    """Main program entry point."""
+    start = time.time()
+
+    sys.stdin.reconfigure(errors='surrogateescape')
+    sys.stdout.reconfigure(errors='surrogateescape')
+
+    for line in sys.stdin:
+        seconds = time.time() - start
+        sys.stdout.write('%02d:%02d %s' % (seconds // 60, seconds % 60, line))
+        sys.stdout.flush()
+
+
+if __name__ == '__main__':
+    main()

.azure-pipelines/templates/coverage.yml

@@ -0,0 +1,39 @@
+# This template adds a job for processing code coverage data.
+# It will upload results to Azure Pipelines and codecov.io.
+# Use it from a job stage that completes after all other jobs have completed.
+# This can be done by placing it in a separate summary stage that runs after the test stage(s) have completed.
+
+jobs:
+  - job: Coverage
+    displayName: Code Coverage
+    container: default
+    workspace:
+      clean: all
+    steps:
+      - checkout: self
+        fetchDepth: $(fetchDepth)
+        path: $(checkoutPath)
+      - task: DownloadPipelineArtifact@2
+        displayName: Download Coverage Data
+        inputs:
+          path: coverage/
+          patterns: "Coverage */*=coverage.combined"
+      - bash: .azure-pipelines/scripts/combine-coverage.py coverage/
+        displayName: Combine Coverage Data
+      - bash: .azure-pipelines/scripts/report-coverage.sh
+        displayName: Generate Coverage Report
+        condition: gt(variables.coverageFileCount, 0)
+      - task: PublishCodeCoverageResults@1
+        inputs:
+          codeCoverageTool: Cobertura
+          # Azure Pipelines only accepts a single coverage data file.
+          # That means only Python or PowerShell coverage can be uploaded, but not both.
+          # Set the "pipelinesCoverage" variable to determine which type is uploaded.
+          # Use "coverage" for Python and "coverage-powershell" for PowerShell.
+          summaryFileLocation: "$(outputPath)/reports/$(pipelinesCoverage).xml"
+        displayName: Publish to Azure Pipelines
+        condition: gt(variables.coverageFileCount, 0)
+      - bash: .azure-pipelines/scripts/publish-codecov.sh "$(outputPath)"
+        displayName: Publish to codecov.io
+        condition: gt(variables.coverageFileCount, 0)
+        continueOnError: true

.azure-pipelines/templates/matrix.yml

@@ -0,0 +1,55 @@
+# This template uses the provided targets and optional groups to generate a matrix which is then passed to the test template.
+# If this matrix template does not provide the required functionality, consider using the test template directly instead.
+
+parameters:
+  # A required list of dictionaries, one per test target.
+  # Each item in the list must contain a "test" or "name" key.
+  # Both may be provided. If one is omitted, the other will be used.
+  - name: targets
+    type: object
+
+  # An optional list of values which will be used to multiply the targets list into a matrix.
+  # Values can be strings or numbers.
+  - name: groups
+    type: object
+    default: []
+
+  # An optional format string used to generate the job name.
+  # - {0} is the name of an item in the targets list.
+  - name: nameFormat
+    type: string
+    default: "{0}"
+
+  # An optional format string used to generate the test name.
+  # - {0} is the name of an item in the targets list.
+  - name: testFormat
+    type: string
+    default: "{0}"
+
+  # An optional format string used to add the group to the job name.
+  # {0} is the formatted name of an item in the targets list.
+  # {{1}} is the group -- be sure to include the double "{{" and "}}".
+  - name: nameGroupFormat
+    type: string
+    default: "{0} - {{1}}"
+
+  # An optional format string used to add the group to the test name.
+  # {0} is the formatted test of an item in the targets list.
+  # {{1}} is the group -- be sure to include the double "{{" and "}}".
+  - name: testGroupFormat
+    type: string
+    default: "{0}/{{1}}"
+
+jobs:
+  - template: test.yml
+    parameters:
+      jobs:
+        - ${{ if eq(length(parameters.groups), 0) }}:
+          - ${{ each target in parameters.targets }}:
+            - name: ${{ format(parameters.nameFormat, coalesce(target.name, target.test)) }}
+              test: ${{ format(parameters.testFormat, coalesce(target.test, target.name)) }}
+        - ${{ if not(eq(length(parameters.groups), 0)) }}:
+          - ${{ each group in parameters.groups }}:
+            - ${{ each target in parameters.targets }}:
+              - name: ${{ format(format(parameters.nameGroupFormat, parameters.nameFormat), coalesce(target.name, target.test), group) }}
+                test: ${{ format(format(parameters.testGroupFormat, parameters.testFormat), coalesce(target.test, target.name), group) }}

.azure-pipelines/templates/test.yml

@@ -0,0 +1,45 @@
+# This template uses the provided list of jobs to create test one or more test jobs.
+# It can be used directly if needed, or through the matrix template.
+
+parameters:
+  # A required list of dictionaries, one per test job.
+  # Each item in the list must contain a "job" and "name" key.
+  - name: jobs
+    type: object
+
+jobs:
+  - ${{ each job in parameters.jobs }}:
+    - job: test_${{ replace(replace(replace(job.test, '/', '_'), '.', '_'), '-', '_') }}
+      displayName: ${{ job.name }}
+      container: default
+      workspace:
+        clean: all
+      steps:
+        - checkout: self
+          fetchDepth: $(fetchDepth)
+          path: $(checkoutPath)
+        - bash: .azure-pipelines/scripts/run-tests.sh "$(entryPoint)" "${{ job.test }}" "$(coverageBranches)"
+          displayName: Run Tests
+        - bash: .azure-pipelines/scripts/process-results.sh
+          condition: succeededOrFailed()
+          displayName: Process Results
+        - bash: .azure-pipelines/scripts/aggregate-coverage.sh "$(Agent.TempDirectory)"
+          condition: eq(variables.haveCoverageData, 'true')
+          displayName: Aggregate Coverage Data
+        - task: PublishTestResults@2
+          condition: eq(variables.haveTestResults, 'true')
+          inputs:
+            testResultsFiles: "$(outputPath)/junit/*.xml"
+          displayName: Publish Test Results
+        - task: PublishPipelineArtifact@1
+          condition: eq(variables.haveBotResults, 'true')
+          displayName: Publish Bot Results
+          inputs:
+            targetPath: "$(outputPath)/bot/"
+            artifactName: "Bot $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"
+        - task: PublishPipelineArtifact@1
+          condition: eq(variables.haveCoverageData, 'true')
+          displayName: Publish Coverage Data
+          inputs:
+            targetPath: "$(Agent.TempDirectory)/coverage/"
+            artifactName: "Coverage $(System.JobAttempt) $(System.StageDisplayName) $(System.JobDisplayName)"

.github/patchback.yml

@@ -0,0 +1,5 @@
+---
+backport_branch_prefix: patchback/backports/
+backport_label_prefix: backport-
+target_branch_prefix: stable-
+...

.github/settings.yml

@@ -1,61 +1,6 @@
-###
-# https://probot.github.io/apps/settings/
-#
-
 # DO NOT MODIFY
-# this is a copy of https://github.com/gundalow-collection/.github/blob/master/.github/settings.yml
-# Work around till https://github.com/probot/settings/pull/179 is merged
 
+# Settings: https://probot.github.io/apps/settings/
+# Pull settings from https://github.com/ansible-collections/.github/blob/master/.github/settings.yml
 
-
-repository:
-  # See https://developer.github.com/v3/repos/#edit for all available settings.
-  has_issues: true
-  has_wiki: false
-  has_pages: false
-  default_branch: master
-  allow_squash_merge: true
-  allow_merge_commit: false
-  allow_rebase_merge: true
-
-# Labels: define labels for Issues and Pull Requests
-labels:
-  - name: bug
-    color: fbca04
-    description: This issue/PR relates to a bug.
-  - name: feature
-    description: This issue/PR relates to a feature request.
-    color: 006b75
-  - name: migrated_from_ansible_ansible
-    color: 5319e7
-    description: This issue/PR was moved from gh/ansible/ansible
-
-branches:
-  - name: master
-    # https://developer.github.com/v3/repos/branches/#update-branch-protection
-    # Branch Protection settings. Set to null to disable
-    protection:
-      # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
-      required_pull_request_reviews:
-        # The number of approvals required. (1-6)
-        required_approving_review_count: 1
-        # Dismiss approved reviews automatically when a new commit is pushed.
-        dismiss_stale_reviews: true
-        # Blocks merge until code owners have reviewed.
-        require_code_owner_reviews: true
-        # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
-        dismissal_restrictions:
-          users: []
-          teams: []
-      # Required. Require status checks to pass before merging. Set to null to disable
-      required_status_checks:
-        # Required. Require branches to be up to date before merging.
-        strict: true
-        # Required. The list of status checks to require in order to merge into this branch
-        contexts: []
-      # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
-      enforce_admins: true
-      # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
-      #restrictions:
-      #  users: []
-      #  teams: []
+_extends: ".github"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,49 @@
+name: "Code scanning - action"
+
+on:
+  schedule:
+    - cron: '26 19 * * 1'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CHANGELOG.rst

@@ -0,0 +1,840 @@
+===============================
+Community General Release Notes
+===============================
+
+.. contents:: Topics
+
+This changelog describes changes after version 1.0.0.
+
+v2.2.0
+======
+
+Release Summary
+---------------
+
+Regular feature and bugfix release.
+
+Minor Changes
+-------------
+
+- bundler - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- consul - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- consul_acl - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- consul_io inventory script - conf options - allow custom configuration options via env variables (https://github.com/ansible-collections/community.general/pull/620).
+- consul_session - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- datadog_monitor - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- grove - the option ``message`` has been renamed to ``message_content``. The old name ``message`` is kept as an alias and will be removed for community.general 4.0.0. This was done because ``message`` is used internally by Ansible (https://github.com/ansible-collections/community.general/pull/1929).
+- heroku_collaborator - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- linode_v4 - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- manageiq_alert_profiles - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- manageiq_policies - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- manageiq_tags - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- manageiq_tags and manageiq_policies - added new parameter ``resource_id``. This parameter can be used instead of parameter ``resource_name`` (https://github.com/ansible-collections/community.general/pull/719).
+- module_helper module utils - ``CmdMixin.run_command()`` now accepts ``dict`` command arguments, providing the parameter and its value (https://github.com/ansible-collections/community.general/pull/1867).
+- one_host - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- one_image_info - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- one_vm - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- oneandone_firewall_policy - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- oneandone_load_balancer - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- oneandone_monitoring_policy - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- oneandone_private_network - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- oneandone_server - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- oneview_datacenter_info - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- oneview_enclosure_info - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- oneview_ethernet_network_info - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- oneview_network_set_info - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- profitbricks - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- profitbricks_volume - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- scaleway_compute - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- scaleway_lb - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1970).
+- sensu_check - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- sensu_client - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- sensu_handler - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- webfaction_domain - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- webfaction_site - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1885).
+- yum_versionlock - Do the lock/unlock concurrently to speed up (https://github.com/ansible-collections/community.general/pull/1912).
+
+Deprecated Features
+-------------------
+
+- apt_rpm - deprecated invalid parameter alias ``update-cache``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- composer - deprecated invalid parameter aliases ``working-dir``, ``global-command``, ``prefer-source``, ``prefer-dist``, ``no-dev``, ``no-scripts``, ``no-plugins``, ``optimize-autoloader``, ``classmap-authoritative``, ``apcu-autoloader``, ``ignore-platform-reqs``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- github_deploy_key - deprecated invalid parameter alias ``2fa_token``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- grove - the option ``message`` will be removed in community.general 4.0.0. Use the new option ``message_content`` instead (https://github.com/ansible-collections/community.general/pull/1929).
+- homebrew - deprecated invalid parameter alias ``update-brew``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- homebrew_cask - deprecated invalid parameter alias ``update-brew``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- opkg - deprecated invalid parameter alias ``update-cache``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- pacman - deprecated invalid parameter alias ``update-cache``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- puppet - deprecated undocumented parameter ``show_diff``, will be removed in 7.0.0. (https://github.com/ansible-collections/community.general/pull/1927).
+- runit - unused parameter ``dist`` marked for deprecation (https://github.com/ansible-collections/community.general/pull/1830).
+- slackpkg - deprecated invalid parameter alias ``update-cache``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- urmpi - deprecated invalid parameter aliases ``update-cache`` and ``no-recommends``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+- xbps - deprecated invalid parameter alias ``update-cache``, will be removed in 5.0.0 (https://github.com/ansible-collections/community.general/pull/1927).
+
+Bugfixes
+--------
+
+- bigpanda - actually use the ``deployment_message`` option (https://github.com/ansible-collections/community.general/pull/1928).
+- chef_databag lookup plugin - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- cloudforms inventory - fixed issue that non-existing (archived) VMs were synced (https://github.com/ansible-collections/community.general/pull/720).
+- cobbler_sync, cobbler_system - fix SSL/TLS certificate check when ``validate_certs`` set to ``false`` (https://github.com/ansible-collections/community.general/pull/1880).
+- consul_io inventory script - kv_groups - fix byte chain decoding for Python 3 (https://github.com/ansible-collections/community.general/pull/620).
+- deploy_helper - allow ``state=clean`` to be used without defining a ``release`` (https://github.com/ansible-collections/community.general/issues/1852).
+- diy callback plugin - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- idrac_redfish_command - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- idrac_redfish_config - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- idrac_redfish_info - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- imc_rest - explicitly logging out instead of registering the call in ```atexit``` (https://github.com/ansible-collections/community.general/issues/1735).
+- infoblox inventory script - make sure that the script also works with Ansible 2.9, and returns a more helpful error when community.general is not installed as part of Ansible 2.10/3 (https://github.com/ansible-collections/community.general/pull/1871).
+- ini_file - allows an empty string as a value for an option (https://github.com/ansible-collections/community.general/pull/1972).
+- lxc_container - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- lxd_container - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- manageiq_provider - wrapped ``dict.keys()`` with ``list`` for use in ``choices`` setting (https://github.com/ansible-collections/community.general/pull/1970).
+- memcached cache plugin - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- meta/runtime.yml - improve deprecation messages (https://github.com/ansible-collections/community.general/pull/1918).
+- net_tools.nios.api module_utils - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- nmcli - add ``method4`` and ``method6`` options (https://github.com/ansible-collections/community.general/pull/1894).
+- nmcli - ensure the ``slave-type`` option is passed to ``nmcli`` for type ``bond-slave`` (https://github.com/ansible-collections/community.general/pull/1882).
+- nsot inventory script - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- oci_vcn - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- oneandone_monitoring_policy - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- packet_volume_attachment - removed extraneous ``print`` call - old debug? (https://github.com/ansible-collections/community.general/pull/1970).
+- proxmox inventory - added handling of extra trailing slashes in the URL (https://github.com/ansible-collections/community.general/pull/1914).
+- proxmox_kvm - fix parameter ``vmid`` passed twice to ``exit_json`` while creating a virtual machine without cloning (https://github.com/ansible-collections/community.general/issues/1875, https://github.com/ansible-collections/community.general/pull/1895).
+- redfish_command - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- redfish_config - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- redhat_subscription - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- redis cache plugin - wrapped usages of ``keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- selective callback plugin - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- sensu_check - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- spotinst_aws_elastigroup - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- utm_utils module_utils - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- vdo - wrapped usages of ``dict.keys()`` in ``list()`` for Python 3 compatibility (https://github.com/ansible-collections/community.general/pull/1861).
+- xfs_quota - the feedback for initializing project quota using xfs_quota binary from ``xfsprogs`` has changed since the version it was written for (https://github.com/ansible-collections/community.general/pull/1596).
+- zfs - some ZFS properties could be passed when the dataset/volume did not exist, but would fail if the dataset already existed, even if the property matched what was specified in the ansible task (https://github.com/ansible-collections/community.general/issues/868, https://github.com/ansible-collections/community.general/pull/1833).
+
+New Plugins
+-----------
+
+Filter
+~~~~~~
+
+- version_sort - Sort a list according to version order instead of pure alphabetical one
+
+New Modules
+-----------
+
+Cloud
+~~~~~
+
+misc
+^^^^
+
+- proxmox_storage_info - Retrieve information about one or more Proxmox VE storages
+
+Source Control
+~~~~~~~~~~~~~~
+
+github
+^^^^^^
+
+- github_repo - Manage your repositories on Github
+
+gitlab
+^^^^^^
+
+- gitlab_project_members - Manage project members on GitLab Server
+
+Web Infrastructure
+~~~~~~~~~~~~~~~~~~
+
+- jenkins_build - Manage jenkins builds
+
+v2.1.1
+======
+
+Release Summary
+---------------
+
+Extraordinary bugfix release to fix a fatal bug in ``proxmox_kvm``.
+
+Bugfixes
+--------
+
+- proxmox_kvm - fix undefined local variable ``status`` when the parameter ``state`` is either ``stopped``, ``started``, ``restarted`` or ``absent`` (https://github.com/ansible-collections/community.general/pull/1847).
+
+v2.1.0
+======
+
+Release Summary
+---------------
+
+Regular feature and bugfix release.
+
+Minor Changes
+-------------
+
+- clc_* modules - elements of list parameters are now validated (https://github.com/ansible-collections/community.general/pull/1771).
+- datadog_monitor - add missing monitor types ``query alert``, ``trace-analytics alert``, ``rum alert`` (https://github.com/ansible-collections/community.general/pull/1723).
+- dnsimple - add CAA records to the whitelist of valid record types (https://github.com/ansible-collections/community.general/pull/1814).
+- dnsimple - elements of list parameters ``record_ids`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- gitlab_runner - elements of list parameters ``tag_list`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- homebrew_tap - add support to specify search path for ``brew`` executable (https://github.com/ansible-collections/community.general/issues/1702).
+- keycloak_client - elements of list parameters ``default_roles``, ``redirect_uris``, ``web_origins`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- librato_annotation - elements of list parameters ``links`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- lxd_container - ``client_key`` and ``client_cert`` are now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741).
+- lxd_container - elements of list parameter ``profiles`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- lxd_profile - ``client_key`` and ``client_cert`` are now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741).
+- lxd_profile - added ``merge_profile`` parameter to merge configurations from the play to an existing profile (https://github.com/ansible-collections/community.general/pull/1813).
+- mail - elements of list parameters ``to``, ``cc``, ``bcc``, ``attach``, ``headers`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- na_ontap_gather_facts - elements of list parameters ``gather_subset`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- nexmo - elements of list parameters ``dest`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- nsupdate - elements of list parameters ``value`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- oci_vcn - ``api_user_key_file`` is now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741).
+- omapi_host - elements of list parameters ``statements`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- onepassword_info - elements of list parameters ``search_terms`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- packet_device - elements of list parameters ``device_ids``, ``hostnames`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- pagerduty - elements of list parameters ``service`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- plugins/module_utils/oracle/oci_utils.py - elements of list parameter ``key_by`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- proxmox_kvm module - actually implemented ``vmid`` and ``status`` return values. Updated documentation to reflect current situation (https://github.com/ansible-collections/community.general/issues/1410, https://github.com/ansible-collections/community.general/pull/1715).
+- pubnub_blocks - elements of list parameters ``event_handlers`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- redfish modules - explicitly setting lists' elements to ``str`` (https://github.com/ansible-collections/community.general/pull/1761).
+- redfish_config - case insensitive search for situations where the hostname/FQDN case on iLO doesn't match variable's case (https://github.com/ansible-collections/community.general/pull/1744).
+- redhat_subscription - elements of list parameters ``pool_ids``, ``addons`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- rocketchat - elements of list parameters ``attachments`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- sendgrid - elements of list parameters ``to_addresses``, ``cc``, ``bcc``, ``attachments`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- sl_vm - elements of list parameters ``disks``, ``ssh_keys`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- slack - elements of list parameters ``attachments`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- statusio_maintenance - elements of list parameters ``components``, ``containers`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- timezone - add Gentoo and Alpine Linux support (https://github.com/ansible-collections/community.general/issues/781).
+- twilio - elements of list parameters ``to_numbers`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- vmadm - elements of list parameters ``disks``, ``nics``, ``resolvers``, ``filesystems`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+- xfconf - added option ``disable_facts`` to disable facts and its associated deprecation warning (https://github.com/ansible-collections/community.general/issues/1475).
+- xml - elements of list parameters ``add_children``, ``set_children`` are now validated (https://github.com/ansible-collections/community.general/pull/1795).
+
+Deprecated Features
+-------------------
+
+- xfconf - returning output as facts is deprecated, this will be removed in community.general 4.0.0. Please register the task output in a variable and use it instead. You can already switch to the new behavior now by using the new ``disable_facts`` option (https://github.com/ansible-collections/community.general/pull/1747).
+
+Bugfixes
+--------
+
+- aerospike_migration - fix typo that caused ``migrate_tx_key`` instead of ``migrate_rx_key`` being used (https://github.com/ansible-collections/community.general/pull/1739).
+- alternatives - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- beadm - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- cronvar - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- dconf - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- elasticsearch_plugin - ``state`` parameter choices must use ``list()`` in python3 (https://github.com/ansible-collections/community.general/pull/1830).
+- filesystem - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- filesystem - remove ``swap`` from list of FS supported by ``resizefs=yes`` (https://github.com/ansible-collections/community.general/issues/790).
+- git_config - prevent ``run_command`` from expanding values (https://github.com/ansible-collections/community.general/issues/1776).
+- gitlab_runner - parameter ``registration_token`` was required but is used only when ``state`` is ``present`` (https://github.com/ansible-collections/community.general/issues/1714).
+- hipchat - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- interfaces_file - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- iso_extract - use proper alias deprecation mechanism for ``thirsty`` alias of ``force`` (https://github.com/ansible-collections/community.general/pull/1830).
+- java_cert - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- kibana_plugin - ``state`` parameter choices must use ``list()`` in python3 (https://github.com/ansible-collections/community.general/pull/1830).
+- logstash_plugin - wrapped ``dict.keys()`` with ``list`` for use in ``choices`` setting (https://github.com/ansible-collections/community.general/pull/1830).
+- lvg - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- lvol - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- lxc - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- lxc_container - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- nios_host_record - allow DNS Bypass for views other than default (https://github.com/ansible-collections/community.general/issues/1786).
+- nomad_job_info - fix module failure when nomad client returns no jobs (https://github.com/ansible-collections/community.general/pull/1721).
+- parted - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- proxmox lxc - only add the features flag when module parameter ``features`` is set. Before an empty string was send to proxmox in case the parameter was not used, which required to use ``root@pam`` for module execution (https://github.com/ansible-collections/community.general/pull/1763).
+- proxmox* modules - refactored some parameter validation code into use of ``env_fallback``, ``required_if``, ``required_together``, ``required_one_of`` (https://github.com/ansible-collections/community.general/pull/1765).
+- proxmox_kvm - do not add ``args`` if ``proxmox_default_behavior`` is set to no_defaults  (https://github.com/ansible-collections/community.general/issues/1641).
+- proxmox_kvm - stop implicitly adding ``force`` equal to ``false``. Proxmox API requires not implemented parameters otherwise, and assumes ``force`` to be ``false`` by default anyways (https://github.com/ansible-collections/community.general/pull/1783).
+- redhat_subscription - ``mutually_exclusive`` was referring to parameter alias instead of name (https://github.com/ansible-collections/community.general/pull/1795).
+- riak - parameters ``wait_for_handoffs`` and ``wait_for_ring`` are ``int`` but the default value was ``false`` (https://github.com/ansible-collections/community.general/pull/1830).
+- rundeck_acl_policy - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- runit - removed unused code, and passing command as ``list`` instead of ``str`` to ``run_command()`` (https://github.com/ansible-collections/community.general/pull/1830).
+- selective callback plugin - adjust import so that the plugin also works with ansible-core 2.11 (https://github.com/ansible-collections/community.general/pull/1807).
+- statusio_maintenance - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- timezone - internal refactoring: replaced uses of ``_`` with ``dummy`` (https://github.com/ansible-collections/community.general/pull/1819).
+- zfs_delegate_admin - the elements of ``users``, ``groups`` and ``permissions`` are now enforced to be strings (https://github.com/ansible-collections/community.general/pull/1766).
+
+New Modules
+-----------
+
+Monitoring
+~~~~~~~~~~
+
+- statsd - Send metrics to StatsD
+
+v2.0.1
+======
+
+Release Summary
+---------------
+
+Bugfix and security bugfix (potential information leaks in multiple modules, CVE-2021-20191) release.
+
+Major Changes
+-------------
+
+- For community.general 3.0.0, the ``ome_device_info``, ``idrac_firmware`` and ``idrac_server_config_profile`` modules will be moved to the `dellemc.openmanage <https://galaxy.ansible.com/dellemc/openmanage>`_ collection.
+  A redirection will be inserted so that users using ansible-base 2.10 or newer do not have to change anything.
+
+  If you use Ansible 2.9 and explicitly use the DellEMC modules mentioned above from this collection, you will need to adjust your playbooks and roles to use FQCNs starting with ``dellemc.openmanage.`` instead of ``community.general.``,
+  for example replace ``community.general.ome_device_info`` in a task by ``dellemc.openmanage.ome_device_info``.
+
+  If you use ansible-base and installed ``community.general`` manually and rely on the DellEMC modules mentioned above, you have to make sure to install the ``dellemc.openmanage`` collection as well.
+  If you are using FQCNs, for example ``community.general.ome_device_info`` instead of ``ome_device_info``, it will continue working, but we still recommend to adjust the FQCNs as well.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- utm_proxy_auth_profile - the ``frontend_cookie_secret`` return value now contains a placeholder string instead of the module's ``frontend_cookie_secret`` parameter (https://github.com/ansible-collections/community.general/pull/1736).
+
+Security Fixes
+--------------
+
+- dnsmadeeasy - mark the ``account_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- gitlab_runner - mark the ``registration_token`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- hwc_ecs_instance - mark the ``admin_pass`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- ibm_sa_host - mark the ``iscsi_chap_secret`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- keycloak_* modules - mark the ``auth_client_secret`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- keycloak_client - mark the ``registration_access_token`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- librato_annotation - mark the ``api_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- logentries_msg - mark the ``token`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- module_utils/_netapp, na_ontap_gather_facts - enabled ``no_log`` for the options ``api_key`` and ``secret_key`` to prevent accidental disclosure (CVE-2021-20191, https://github.com/ansible-collections/community.general/pull/1725).
+- module_utils/identity/keycloak, keycloak_client, keycloak_clienttemplate, keycloak_group - enabled ``no_log`` for the option ``auth_client_secret`` to prevent accidental disclosure (CVE-2021-20191, https://github.com/ansible-collections/community.general/pull/1725).
+- nios_nsgroup - mark the ``tsig_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- oneandone_firewall_policy, oneandone_load_balancer, oneandone_monitoring_policy, oneandone_private_network, oneandone_public_ip - mark the ``auth_token`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- ovirt - mark the ``instance_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- ovirt - mark the ``instance_rootpw`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- pagerduty_alert - mark the ``api_key``, ``service_key`` and ``integration_key`` parameters as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- pagerduty_change - mark the ``integration_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- pingdom - mark the ``key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- pulp_repo - mark the ``feed_client_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- rax_clb_ssl - mark the ``private_key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- redfish_command - mark the ``update_creds.password`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- rollbar_deployment - mark the ``token`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- spotinst_aws_elastigroup - mark the ``multai_token`` and ``token`` parameters as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- stackdriver - mark the ``key`` parameter as ``no_log`` to avoid leakage of secrets (https://github.com/ansible-collections/community.general/pull/1736).
+- utm_proxy_auth_profile - enabled ``no_log`` for the option ``frontend_cookie_secret`` to prevent accidental disclosure (CVE-2021-20191, https://github.com/ansible-collections/community.general/pull/1725).
+- utm_proxy_auth_profile - mark the ``frontend_cookie_secret`` parameter as ``no_log`` to avoid leakage of secrets. This causes the ``utm_proxy_auth_profile`` return value to no longer containing the correct value, but a placeholder (https://github.com/ansible-collections/community.general/pull/1736).
+
+Bugfixes
+--------
+
+- filesystem - do not fail when ``resizefs=yes`` and ``fstype=xfs`` if there is nothing to do, even if the filesystem is not mounted. This only covers systems supporting access to unmounted XFS filesystems. Others will still fail (https://github.com/ansible-collections/community.general/issues/1457, https://github.com/ansible-collections/community.general/pull/1478).
+- gitlab_user - make updates to the ``isadmin``, ``password`` and ``confirm`` options of an already existing GitLab user work (https://github.com/ansible-collections/community.general/pull/1724).
+- parted - change the regex that decodes the partition size to better support different formats that parted uses. Change the regex that validates parted's version string (https://github.com/ansible-collections/community.general/pull/1695).
+- redfish_info module, redfish_utils module utils - add ``Name`` and ``Id`` properties to output of Redfish inventory commands (https://github.com/ansible-collections/community.general/issues/1650).
+- sensu-silence module - fix json parsing of sensu API responses on Python 3.5 (https://github.com/ansible-collections/community.general/pull/1703).
+
+v2.0.0
+======
+
+Release Summary
+---------------
+
+This is release 2.0.0 of ``community.general``, released on 2021-01-28.
+
+Major Changes
+-------------
+
+- The community.general collection no longer depends on the ansible.netcommon collection (https://github.com/ansible-collections/community.general/pull/1561).
+- The community.general collection no longer depends on the ansible.posix collection (https://github.com/ansible-collections/community.general/pull/1157).
+
+Minor Changes
+-------------
+
+- A new filter ``lists_mergeby`` to merge two lists of dictionaries by an attribute.
+  For example:
+
+  .. code-block:: yaml
+
+      [{'n': 'n1', 'p1': 'A', 'p2': 'F'},
+       {'n': 'n2', 'p2': 'B'}] | community.general.lists_mergeby(
+      [{'n': 'n1', 'p1': 'C'},
+       {'n': 'n2', 'p2': 'D'},
+       {'n': 'n3', 'p3': 'E'}], 'n') | list
+
+  evaluates to
+
+  .. code-block:: yaml
+
+      [{'n': 'n1', 'p1': 'C', 'p2': 'F'},
+       {'n': 'n2', 'p2': 'D'},
+       {'n': 'n3', 'p3': 'E'}]
+
+  (https://github.com/ansible-collections/community.general/pull/604).
+- Add new filter plugin ``dict_kv`` which returns a single key-value pair from two arguments. Useful for generating complex dictionaries without using loops. For example ``'value' | community.general.dict_kv('key'))`` evaluates to ``{'key': 'value'}`` (https://github.com/ansible-collections/community.general/pull/1264).
+- The collection dependencies were adjusted so that ``community.kubernetes`` is required to be of version 1.0.0 or newer (https://github.com/ansible-collections/community.general/pull/774).
+- The collection is now actively tested in CI with the latest Ansible 2.9 release.
+- airbrake_deployment - add ``version`` param; clarified docs on ``revision`` param (https://github.com/ansible-collections/community.general/pull/583).
+- apk - added ``no_cache`` option (https://github.com/ansible-collections/community.general/pull/548).
+- archive - fix paramater types (https://github.com/ansible-collections/community.general/pull/1039).
+- cloudflare_dns - add support for environment variable ``CLOUDFLARE_TOKEN`` (https://github.com/ansible-collections/community.general/pull/1238).
+- consul - added support for tcp checks (https://github.com/ansible-collections/community.general/issues/1128).
+- datadog - mark ``notification_message`` as ``no_log`` (https://github.com/ansible-collections/community.general/pull/1338).
+- datadog_monitor - add ``include_tags`` option (https://github.com/ansible/ansible/issues/57441).
+- dconf - update documentation and logic code refactor (https://github.com/ansible-collections/community.general/pull/1585).
+- django_manage - renamed parameter ``app_path`` to ``project_path``, adding ``app_path`` and ``chdir`` as aliases (https://github.com/ansible-collections/community.general/issues/1044).
+- facter - added option for ``arguments`` (https://github.com/ansible-collections/community.general/pull/768).
+- firewalld - the module has been moved to the ``ansible.posix`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/623).
+- git_config - added parameter and scope ``file`` allowing user to change parameters in a custom file (https://github.com/ansible-collections/community.general/issues/1021).
+- gitlab_project - add parameter ``lfs_enabled`` to specify Git LFS (https://github.com/ansible-collections/community.general/issues/1506).
+- gitlab_project - add support for merge_method on projects (https://github.com/ansible/ansible/pull/66813).
+- gitlab_project_variable - add support for ``environment_scope`` on projects variables (https://github.com/ansible-collections/community.general/pull/1197).
+- gitlab_runner - add ``owned`` option to allow non-admin use (https://github.com/ansible-collections/community.general/pull/1491).
+- gitlab_runners inventory plugin - permit environment variable input for ``server_url``, ``api_token`` and ``filter`` options (https://github.com/ansible-collections/community.general/pull/611).
+- haproxy - add options to dis/enable health and agent checks.  When health and agent checks are enabled for a service, a disabled service will re-enable itself automatically.  These options also change the state of the agent checks to match the requested state for the backend (https://github.com/ansible-collections/community.general/issues/684).
+- homebrew_cask - Homebrew will be deprecating use of ``brew cask`` commands as of version 2.6.0, see https://brew.sh/2020/12/01/homebrew-2.6.0/. Added logic to stop using ``brew cask`` for brew version >= 2.6.0 (https://github.com/ansible-collections/community.general/pull/1481).
+- homebrew_tap - provide error message to user when module fails (https://github.com/ansible-collections/community.general/issues/1411).
+- influxdb_retention_policy - add shard group duration parameter ``shard_group_duration`` (https://github.com/ansible-collections/community.general/pull/1590).
+- infoblox inventory script - use stderr for reporting errors, and allow use of environment for configuration (https://github.com/ansible-collections/community.general/pull/436).
+- ini_file - module now can create an empty section (https://github.com/ansible-collections/community.general/issues/479).
+- ipa_host - silence warning about non-secret ``random_password`` option not having ``no_log`` set (https://github.com/ansible-collections/community.general/pull/1339).
+- ipa_sudorule - added option to use command groups inside sudo rules (https://github.com/ansible-collections/community.general/issues/1555).
+- ipa_user - add ``userauthtype`` option (https://github.com/ansible-collections/community.general/pull/951).
+- ipa_user - silence warning about non-secret ``krbpasswordexpiration`` and ``update_password`` options not having ``no_log`` set (https://github.com/ansible-collections/community.general/pull/1339).
+- iptables_state - use FQCN when calling a module from action plugin (https://github.com/ansible-collections/community.general/pull/967).
+- jc - new filter to convert the output of many shell commands and file-types to JSON. Uses the jc library at https://github.com/kellyjonbrazil/jc. For example, filtering the STDOUT output of ``uname -a`` via ``{{ result.stdout | community.general.jc('uname') }}``. Requires Python 3.6+ (https://github.com/ansible-collections/community.general/pull/750).
+- jira - added the traceback output to ``fail_json()`` calls deriving from exceptions (https://github.com/ansible-collections/community.general/pull/1536).
+- ldap modules - allow to configure referral chasing (https://github.com/ansible-collections/community.general/pull/1618).
+- linode inventory plugin - add support for ``keyed_groups``, ``groups``, and ``compose`` options (https://github.com/ansible-collections/community.general/issues/1326).
+- linode inventory plugin - add support for ``tags`` option to filter instances by tag (https://github.com/ansible-collections/community.general/issues/1549).
+- linode_v4 - added support for Linode StackScript usage when creating instances (https://github.com/ansible-collections/community.general/issues/723).
+- log_plays callback - use v2 methods (https://github.com/ansible-collections/community.general/pull/442).
+- logstash callback - add ini config (https://github.com/ansible-collections/community.general/pull/610).
+- logstash callback - improve logstash message structure, needs to be enabled with the ``format_version`` option (https://github.com/ansible-collections/community.general/pull/641).
+- logstash callback - migrate to python3-logstash (https://github.com/ansible-collections/community.general/pull/641).
+- lvol - fix idempotency issue when using lvol with ``%VG`` or ``%PVS`` size options and VG is fully allocated (https://github.com/ansible-collections/community.general/pull/229).
+- lxd_container - added support of ``--target`` flag for cluster deployments (https://github.com/ansible-collections/community.general/issues/637).
+- make - add ``jobs`` parameter to allow specification of number of simultaneous jobs for make to run (https://github.com/ansible-collections/community.general/pull/1550).
+- maven_artifact - added ``client_cert`` and ``client_key`` parameters to the maven_artifact module (https://github.com/ansible-collections/community.general/issues/1123).
+- module_helper - added ModuleHelper class and a couple of convenience tools for module developers (https://github.com/ansible-collections/community.general/pull/1322).
+- module_helper module utils - multiple convenience features added (https://github.com/ansible-collections/community.general/pull/1480).
+- nagios - add the ``acknowledge`` action (https://github.com/ansible-collections/community.general/pull/820).
+- nagios - add the ``host`` and ``all`` values for the ``forced_check`` action (https://github.com/ansible-collections/community.general/pull/998).
+- nagios - add the ``service_check`` action (https://github.com/ansible-collections/community.general/pull/820).
+- nagios - rename the ``service_check`` action to ``forced_check`` since we now are able to check both a particular service, all services of a particular host and the host itself (https://github.com/ansible-collections/community.general/pull/998).
+- nios modules - clean up module argument spec processing (https://github.com/ansible-collections/community.general/pull/1598).
+- nios_network - no longer requires the ansible.netcommon collection (https://github.com/ansible-collections/community.general/pull/1561).
+- nmcli - add ``ipv4.routes``,  ``ipv4.route-metric`` and ``ipv4.never-default`` support (https://github.com/ansible-collections/community.general/pull/1260).
+- nmcli - add ``zone`` parameter (https://github.com/ansible-collections/community.general/issues/949, https://github.com/ansible-collections/community.general/pull/1426).
+- nmcli - add infiniband type support (https://github.com/ansible-collections/community.general/pull/1260).
+- nmcli - refactor internal methods for simplicity and enhance reuse to support existing and future connection types (https://github.com/ansible-collections/community.general/pull/1113).
+- nmcli - remove Python DBus and GTK Object library dependencies (https://github.com/ansible-collections/community.general/issues/1112).
+- nmcli - the ``dns4``, ``dns4_search``, ``dns6``, and ``dns6_search`` arguments are retained internally as lists (https://github.com/ansible-collections/community.general/pull/1113).
+- npm - add ``no-optional`` option (https://github.com/ansible-collections/community.general/issues/1421).
+- odbc - added a parameter ``commit`` which allows users to disable the explicit commit after the execute call (https://github.com/ansible-collections/community.general/pull/1139).
+- openbsd_pkg - added ``snapshot`` option (https://github.com/ansible-collections/community.general/pull/965).
+- pacman - improve group expansion speed: query list of pacman groups once (https://github.com/ansible-collections/community.general/pull/349).
+- pam_limits - add support for nice and priority limits (https://github.com/ansible/ansible/pull/47680).
+- pam_limits - adds check mode (https://github.com/ansible-collections/community.general/issues/827).
+- pam_limits - adds diff mode (https://github.com/ansible-collections/community.general/issues/828).
+- parted - accept negative numbers in ``part_start`` and ``part_end``
+- parted - add ``resize`` option to resize existing partitions (https://github.com/ansible-collections/community.general/pull/773).
+- passwordstore lookup plugin - added ``umask`` option to set the desired file permisions on creation. This is done via the ``PASSWORD_STORE_UMASK`` environment variable (https://github.com/ansible-collections/community.general/pull/1156).
+- pkgin - add support for installation of full versioned package names (https://github.com/ansible-collections/community.general/pull/1256).
+- pkgng - added ``stdout`` and ``stderr`` attributes to the result (https://github.com/ansible-collections/community.general/pull/560).
+- pkgng - added support for upgrading all packages using ``name: *, state: latest``, similar to other package providers (https://github.com/ansible-collections/community.general/pull/569).
+- pkgng - present the ``ignore_osver`` option to pkg (https://github.com/ansible-collections/community.general/pull/1243).
+- pkgutil - module can now accept a list of packages (https://github.com/ansible-collections/community.general/pull/799).
+- pkgutil - module has a new option, ``force``, equivalent to the ``-f`` option to the `pkgutil <http://pkgutil.net/>`_ command (https://github.com/ansible-collections/community.general/pull/799).
+- pkgutil - module now supports check mode (https://github.com/ansible-collections/community.general/pull/799).
+- portage - add ``getbinpkgonly`` option, remove unnecessary note on internal portage behaviour (getbinpkg=yes), and remove the undocumented exclusiveness of the pkg options as portage makes no such restriction (https://github.com/ansible-collections/community.general/pull/1169).
+- proxmox - add ``features`` option to LXC (https://github.com/ansible-collections/community.general/issues/816).
+- proxmox - add new ``proxmox_default_behavior`` option (https://github.com/ansible-collections/community.general/pull/850).
+- proxmox - add support for API tokens (https://github.com/ansible-collections/community.general/pull/1206).
+- proxmox - extract common code and documentation (https://github.com/ansible-collections/community.general/pull/1331).
+- proxmox - improve and extract more common documentation (https://github.com/ansible-collections/community.general/pull/1404).
+- proxmox inventory plugin - add environment variable passthrough (https://github.com/ansible-collections/community.general/pull/1645).
+- proxmox inventory plugin - ignore QEMU templates altogether instead of skipping the creation of the host in the inventory (https://github.com/ansible-collections/community.general/pull/1185).
+- proxmox_kvm - add cloud-init support (new options: ``cicustom``, ``cipassword``, ``citype``, ``ciuser``, ``ipconfig``, ``nameservers``, ``searchdomains``, ``sshkeys``) (https://github.com/ansible-collections/community.general/pull/797).
+- proxmox_kvm - add new ``proxmox_default_behavior`` option (https://github.com/ansible-collections/community.general/pull/850).
+- proxmox_kvm - add support for API tokens (https://github.com/ansible-collections/community.general/pull/1206).
+- proxmox_kvm - improve and extract more common documentation (https://github.com/ansible-collections/community.general/pull/1404).
+- proxmox_kvm - improve code readability (https://github.com/ansible-collections/community.general/pull/934).
+- proxmox_template - add support for API tokens (https://github.com/ansible-collections/community.general/pull/1206).
+- proxmox_template - download proxmox applicance templates (pveam) (https://github.com/ansible-collections/community.general/pull/1046).
+- proxmox_template - improve documentation (https://github.com/ansible-collections/community.general/pull/1404).
+- pushover - add device parameter (https://github.com/ansible-collections/community.general/pull/802).
+- redfish_command - add sub-command for ``EnableContinuousBootOverride`` and ``DisableBootOverride`` to allow setting BootSourceOverrideEnabled Redfish property (https://github.com/ansible-collections/community.general/issues/824).
+- redfish_command - support same reset actions on Managers as on Systems (https://github.com/ansible-collections/community.general/issues/901).
+- redis cache plugin - add redis sentinel functionality to cache plugin (https://github.com/ansible-collections/community.general/pull/1055).
+- redis cache plugin - make the redis cache keyset name configurable (https://github.com/ansible-collections/community.general/pull/1036).
+- rhn_register - added ``force`` parameter to allow forced registering (https://github.com/ansible-collections/community.general/issues/1454).
+- rundeck_acl_policy - add check for rundeck_acl_policy name parameter (https://github.com/ansible-collections/community.general/pull/612).
+- scaleway modules and inventory plugin - update regions and zones to add the new ones (https://github.com/ansible-collections/community.general/pull/1690).
+- slack - add support for sending messages built with block kit (https://github.com/ansible-collections/community.general/issues/380).
+- slack - add support for updating messages (https://github.com/ansible-collections/community.general/issues/304).
+- splunk callback - add an option to allow not to validate certificate from HEC (https://github.com/ansible-collections/community.general/pull/596).
+- splunk callback - new parameter ``include_milliseconds`` to add milliseconds to existing timestamp field (https://github.com/ansible-collections/community.general/pull/1462).
+- telegram - now can call any methods in Telegram bot API. Previously this module was hardcoded to use "SendMessage" only. Usage of "SendMessage" API method was also librated, and now you can specify any arguments you need, for example, "disable_notificaton" (https://github.com/ansible-collections/community.general/pull/1642).
+- terraform - add ``init_reconfigure`` option, which controls the ``-reconfigure`` flag (backend reconfiguration) (https://github.com/ansible-collections/community.general/pull/823).
+- xfconf - add arrays support (https://github.com/ansible/ansible/issues/46308).
+- xfconf - add support for ``double`` type (https://github.com/ansible-collections/community.general/pull/744).
+- xfconf - add support for ``uint`` type (https://github.com/ansible-collections/community.general/pull/696).
+- xfconf - removed unnecessary second execution of ``xfconf-query`` (https://github.com/ansible-collections/community.general/pull/1305).
+- xml - fixed issue were changed was returned when removing non-existent xpath (https://github.com/ansible-collections/community.general/pull/1007).
+- zypper_repository - proper failure when python-xml is missing (https://github.com/ansible-collections/community.general/pull/939).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- If you use Ansible 2.9 and the Google cloud plugins or modules from this collection, community.general 2.0.0 results in errors when trying to use the Google cloud content by FQCN, like ``community.general.gce_img``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your playbooks and roles manually to use the new FQCNs (``community.google.gce_img`` for the previous example) and to make sure that you have ``community.google`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install the ``community.google`` or ``google.cloud`` collections if you are using any of the Google cloud plugins or modules.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (such as community.google) must be installed for them to work.
+- If you use Ansible 2.9 and the Kubevirt plugins or modules from this collection, community.general 2.0.0 results in errors when trying to use the Kubevirt content by FQCN, like ``community.general.kubevirt_vm``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your playbooks and roles manually to use the new FQCNs (``community.kubevirt.kubevirt_vm`` for the previous example) and to make sure that you have ``community.kubevirt`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install the ``community.kubevirt`` collection if you are using any of the Kubevirt plugins or modules.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (such as community.google) must be installed for them to work.
+- If you use Ansible 2.9 and the ``docker`` plugins or modules from this collections, community.general 2.0.0 results in errors when trying to use the docker content by FQCN, like ``community.general.docker_container``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your playbooks and roles manually to use the new FQCNs (``community.docker.docker_container`` for the previous example) and to make sure that you have ``community.docker`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.docker`` if you are using any of the ``docker`` plugins or modules.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (community.docker) must be installed for them to work.
+- If you use Ansible 2.9 and the ``hashi_vault`` lookup plugin from this collections, community.general 2.0.0 results in errors when trying to use the Hashi Vault content by FQCN, like ``community.general.hashi_vault``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your inventories, variable files, playbooks and roles manually to use the new FQCN (``community.hashi_vault.hashi_vault``) and to make sure that you have ``community.hashi_vault`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.hashi_vault`` if you are using the ``hashi_vault`` plugin.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (community.hashi_vault) must be installed for them to work.
+- If you use Ansible 2.9 and the ``hetzner`` modules from this collections, community.general 2.0.0 results in errors when trying to use the hetzner content by FQCN, like ``community.general.hetzner_firewall``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your playbooks and roles manually to use the new FQCNs (``community.hrobot.firewall`` for the previous example) and to make sure that you have ``community.hrobot`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.hrobot`` if you are using any of the ``hetzner`` modules.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (community.hrobot) must be installed for them to work.
+- If you use Ansible 2.9 and the ``oc`` connection plugin from this collections, community.general 2.0.0 results in errors when trying to use the oc content by FQCN, like ``community.general.oc``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your inventories, variable files, playbooks and roles manually to use the new FQCN (``community.okd.oc``) and to make sure that you have ``community.okd`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.okd`` if you are using the ``oc`` plugin.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (community.okd) must be installed for them to work.
+- If you use Ansible 2.9 and the ``postgresql`` modules from this collections, community.general 2.0.0 results in errors when trying to use the postgresql content by FQCN, like ``community.general.postgresql_info``.
+  Since Ansible 2.9 is not able to use redirections, you will have to adjust your playbooks and roles manually to use the new FQCNs (``community.postgresql.postgresql_info`` for the previous example) and to make sure that you have ``community.postgresql`` installed.
+
+  If you use ansible-base 2.10 or newer and did not install Ansible 3.0.0, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.postgresql`` if you are using any of the ``postgresql`` modules.
+  While ansible-base 2.10 or newer can use the redirects that community.general 2.0.0 adds, the collection they point to (community.postgresql) must be installed for them to work.
+- The Google cloud inventory script ``gce.py`` has been migrated to the ``community.google`` collection. Install the ``community.google`` collection in order to continue using it.
+- archive - remove path folder itself when ``remove`` paramater is true (https://github.com/ansible-collections/community.general/issues/1041).
+- log_plays callback - add missing information to the logs generated by the callback plugin. This changes the log message format (https://github.com/ansible-collections/community.general/pull/442).
+- passwordstore lookup plugin - now parsing a password store entry as YAML if possible, skipping the first line (which by convention only contains the password and nothing else). If it cannot be parsed as YAML, the old ``key: value`` parser will be used to process the entry. Can break backwards compatibility if YAML formatted code was parsed in a non-YAML interpreted way, e.g. ``foo: [bar, baz]`` will become a list with two elements in the new version, but a string ``'[bar, baz]'`` in the old (https://github.com/ansible-collections/community.general/issues/1673).
+- pkgng - passing ``name: *`` with ``state: absent`` will no longer remove every installed package from the system. It is now a noop. (https://github.com/ansible-collections/community.general/pull/569).
+- pkgng - passing ``name: *`` with ``state: latest`` or ``state: present`` will no longer install every package from the configured package repositories. Instead, ``name: *, state: latest`` will upgrade all already-installed packages, and ``name: *, state: present`` is a noop. (https://github.com/ansible-collections/community.general/pull/569).
+- proxmox_kvm - recognize ``force=yes`` in conjunction with ``state=absent`` to forcibly remove a running VM (https://github.com/ansible-collections/community.general/pull/849).
+
+Deprecated Features
+-------------------
+
+- The ``gluster_heal_info``, ``gluster_peer`` and ``gluster_volume`` modules have migrated to the `gluster.gluster <https://galaxy.ansible.com/gluster/gluster>`_ collection. Ansible-base 2.10.1 adjusted the routing target to point to the modules in that collection, so we will remove these modules in community.general 3.0.0. If you use Ansible 2.9, or use FQCNs ``community.general.gluster_*`` in your playbooks and/or roles, please update them to use the modules from ``gluster.gluster`` instead.
+- The ldap_attr module has been deprecated and will be removed in a later release; use ldap_attrs instead.
+- django_manage - the parameter ``liveserver`` relates to a no longer maintained third-party module for django. It is now deprecated, and will be remove in community.general 3.0.0 (https://github.com/ansible-collections/community.general/pull/1154).
+- proxmox - the default of the new ``proxmox_default_behavior`` option will change from ``compatibility`` to ``no_defaults`` in community.general 4.0.0. Set the option to an explicit value to avoid a deprecation warning (https://github.com/ansible-collections/community.general/pull/850).
+- proxmox_kvm - the default of the new ``proxmox_default_behavior`` option will change from ``compatibility`` to ``no_defaults`` in community.general 4.0.0. Set the option to an explicit value to avoid a deprecation warning (https://github.com/ansible-collections/community.general/pull/850).
+- syspatch - deprecate the redundant ``apply`` argument (https://github.com/ansible-collections/community.general/pull/360).
+- xbps - the ``force`` option never had any effect. It is now deprecated, and will be removed in 3.0.0 (https://github.com/ansible-collections/community.general/pull/568).
+
+Removed Features (previously deprecated)
+----------------------------------------
+
+- All Google cloud modules and plugins have now been migrated away from this collection.
+  They can be found in either the `community.google <https://galaxy.ansible.com/community/google>`_ or `google.cloud <https://galaxy.ansible.com/google/cloud>`_ collections.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.gce_img`` → ``community.google.gce_img``) and make sure to install the community.google or google.cloud collections as appropriate.
+- All Kubevirt modules and plugins have now been migrated from community.general to the `community.kubevirt <https://galaxy.ansible.com/community/kubevirt>`_ Ansible collection.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.kubevirt_vm`` → ``community.kubevirt.kubevirt_vm``) and make sure to install the community.kubevirt collection.
+- All ``docker`` modules and plugins have been removed from this collection.
+  They have been migrated to the `community.docker <https://galaxy.ansible.com/community/docker>`_ collection.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.docker_container`` → ``community.docker.docker_container``) and make sure to install the community.docker collection.
+- All ``hetzner`` modules have been removed from this collection.
+  They have been migrated to the `community.hrobot <https://galaxy.ansible.com/community/hrobot>`_ collection.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.hetzner_firewall`` → ``community.hrobot.firewall``) and make sure to install the community.hrobot collection.
+- All ``postgresql`` modules have been removed from this collection.
+  They have been migrated to the `community.postgresql <https://galaxy.ansible.com/community/postgresql>`_ collection.
+
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.postgresql_info`` → ``community.postgresql.postgresql_info``) and make sure to install the community.postgresql collection.
+- The Google cloud inventory script ``gce.py`` has been migrated to the ``community.google`` collection. Install the ``community.google`` collection in order to continue using it.
+- The ``hashi_vault`` lookup plugin has been removed from this collection.
+  It has been migrated to the `community.hashi_vault <https://galaxy.ansible.com/community/hashi_vault>`_ collection.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.hashi_vault`` → ``community.hashi_vault.hashi_vault``) and make sure to install the community.hashi_vault collection.
+- The ``oc`` connection plugin has been removed from this collection.
+  It has been migrated to the `community.okd <https://galaxy.ansible.com/community/okd>`_ collection.
+  If you use ansible-base 2.10 or newer, redirections have been provided.
+
+  If you use Ansible 2.9 and installed this collection, you need to adjust the FQCNs (``community.general.oc`` → ``community.okd.oc``) and make sure to install the community.okd collection.
+- The deprecated ``actionable`` callback plugin has been removed. Use the ``ansible.builtin.default`` callback plugin with ``display_skipped_hosts = no`` and ``display_ok_hosts = no`` options instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``foreman`` module has been removed. Use the modules from the theforeman.foreman collection instead (https://github.com/ansible-collections/community.general/pull/1347) (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``full_skip`` callback plugin has been removed. Use the ``ansible.builtin.default`` callback plugin with ``display_skipped_hosts = no`` option instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``gcdns_record`` module has been removed. Use ``google.cloud.gcp_dns_resource_record_set`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcdns_zone`` module has been removed. Use ``google.cloud.gcp_dns_managed_zone`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gce`` module has been removed. Use ``google.cloud.gcp_compute_instance`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcp_backend_service`` module has been removed. Use ``google.cloud.gcp_compute_backend_service`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcp_forwarding_rule`` module has been removed. Use ``google.cloud.gcp_compute_forwarding_rule`` or ``google.cloud.gcp_compute_global_forwarding_rule`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcp_healthcheck`` module has been removed. Use ``google.cloud.gcp_compute_health_check``, ``google.cloud.gcp_compute_http_health_check`` or ``google.cloud.gcp_compute_https_health_check`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcp_target_proxy`` module has been removed. Use ``google.cloud.gcp_compute_target_http_proxy`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcp_url_map`` module has been removed. Use ``google.cloud.gcp_compute_url_map`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``gcspanner`` module has been removed. Use ``google.cloud.gcp_spanner_database`` and/or ``google.cloud.gcp_spanner_instance`` instead (https://github.com/ansible-collections/community.general/pull/1370).
+- The deprecated ``github_hooks`` module has been removed. Use ``community.general.github_webhook`` and ``community.general.github_webhook_info`` instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``katello`` module has been removed. Use the modules from the theforeman.foreman collection instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_aggregate`` module has been removed. Use netapp.ontap.na_ontap_aggregate instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_license`` module has been removed. Use netapp.ontap.na_ontap_license instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_lun`` module has been removed. Use netapp.ontap.na_ontap_lun instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_qtree`` module has been removed. Use netapp.ontap.na_ontap_qtree instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_svm`` module has been removed. Use netapp.ontap.na_ontap_svm instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_user_role`` module has been removed. Use netapp.ontap.na_ontap_user_role instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_user`` module has been removed. Use netapp.ontap.na_ontap_user instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``na_cdot_volume`` module has been removed. Use netapp.ontap.na_ontap_volume instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``sf_account_manager`` module has been removed. Use netapp.elementsw.na_elementsw_account instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``sf_check_connections`` module has been removed. Use netapp.elementsw.na_elementsw_check_connections instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``sf_snapshot_schedule_manager`` module has been removed. Use netapp.elementsw.na_elementsw_snapshot_schedule instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``sf_volume_access_group_manager`` module has been removed. Use netapp.elementsw.na_elementsw_access_group instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``sf_volume_manager`` module has been removed. Use netapp.elementsw.na_elementsw_volume instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The deprecated ``stderr`` callback plugin has been removed. Use the ``ansible.builtin.default`` callback plugin with ``display_failed_stderr = yes`` option instead (https://github.com/ansible-collections/community.general/pull/1347).
+- The redirect of the ``conjur_variable`` lookup plugin to ``cyberark.conjur.conjur_variable`` collection was removed (https://github.com/ansible-collections/community.general/pull/1346).
+- The redirect of the ``firewalld`` module and the ``firewalld`` module_utils to the ``ansible.posix`` collection was removed (https://github.com/ansible-collections/community.general/pull/1346).
+- The redirect to the ``community.digitalocean`` collection was removed for: the ``digital_ocean`` doc fragment, the ``digital_ocean`` module_utils, and the following modules: ``digital_ocean``, ``digital_ocean_account_facts``, ``digital_ocean_account_info``, ``digital_ocean_block_storage``, ``digital_ocean_certificate``, ``digital_ocean_certificate_facts``, ``digital_ocean_certificate_info``, ``digital_ocean_domain``, ``digital_ocean_domain_facts``, ``digital_ocean_domain_info``, ``digital_ocean_droplet``, ``digital_ocean_firewall_facts``, ``digital_ocean_firewall_info``, ``digital_ocean_floating_ip``, ``digital_ocean_floating_ip_facts``, ``digital_ocean_floating_ip_info``, ``digital_ocean_image_facts``, ``digital_ocean_image_info``, ``digital_ocean_load_balancer_facts``, ``digital_ocean_load_balancer_info``, ``digital_ocean_region_facts``, ``digital_ocean_region_info``, ``digital_ocean_size_facts``, ``digital_ocean_size_info``, ``digital_ocean_snapshot_facts``, ``digital_ocean_snapshot_info``, ``digital_ocean_sshkey``, ``digital_ocean_sshkey_facts``, ``digital_ocean_sshkey_info``, ``digital_ocean_tag``, ``digital_ocean_tag_facts``, ``digital_ocean_tag_info``, ``digital_ocean_volume_facts``, ``digital_ocean_volume_info`` (https://github.com/ansible-collections/community.general/pull/1346).
+- The redirect to the ``community.mysql`` collection was removed for: the ``mysql`` doc fragment, the ``mysql`` module_utils, and the following modules: ``mysql_db``, ``mysql_info``, ``mysql_query``, ``mysql_replication``, ``mysql_user``, ``mysql_variables`` (https://github.com/ansible-collections/community.general/pull/1346).
+- The redirect to the ``community.proxysql`` collection was removed for: the ``proxysql`` doc fragment, and the following modules: ``proxysql_backend_servers``, ``proxysql_global_variables``, ``proxysql_manage_config``, ``proxysql_mysql_users``, ``proxysql_query_rules``, ``proxysql_replication_hostgroups``, ``proxysql_scheduler`` (https://github.com/ansible-collections/community.general/pull/1346).
+- The redirect to the ``infinidat.infinibox`` collection was removed for: the ``infinibox`` doc fragment, the ``infinibox`` module_utils, and the following modules: ``infini_export``, ``infini_export_client``, ``infini_fs``, ``infini_host``, ``infini_pool``, ``infini_vol`` (https://github.com/ansible-collections/community.general/pull/1346).
+- conjur_variable lookup - has been moved to the ``cyberark.conjur`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/570).
+- digital_ocean_* - all DigitalOcean modules have been moved to the ``community.digitalocean`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/622).
+- infini_* - all infinidat modules have been moved to the ``infinidat.infinibox`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/607).
+- iptables_state - the ``ANSIBLE_ASYNC_DIR`` environment is no longer supported, use the ``async_dir`` shell option instead (https://github.com/ansible-collections/community.general/pull/1371).
+- logicmonitor - the module has been removed in 1.0.0 since it is unmaintained and the API used by the module has been turned off in 2017 (https://github.com/ansible-collections/community.general/issues/539, https://github.com/ansible-collections/community.general/pull/541).
+- logicmonitor_facts - the module has been removed in 1.0.0 since it is unmaintained and the API used by the module has been turned off in 2017 (https://github.com/ansible-collections/community.general/issues/539, https://github.com/ansible-collections/community.general/pull/541).
+- memcached cache plugin - do not import ``CacheModule``s directly. Use ``ansible.plugins.loader.cache_loader`` instead (https://github.com/ansible-collections/community.general/pull/1371).
+- mysql_* - all MySQL modules have been moved to the ``community.mysql`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/633).
+- proxysql_* - all ProxySQL modules have been moved to the ``community.proxysql`` collection. A redirection is active, which will be removed in version 2.0.0 (https://github.com/ansible-collections/community.general/pull/624).
+- redis cache plugin - do not import ``CacheModule``s directly. Use ``ansible.plugins.loader.cache_loader`` instead (https://github.com/ansible-collections/community.general/pull/1371).
+- xml - when ``content=attribute``, the ``attribute`` option is ignored (https://github.com/ansible-collections/community.general/pull/1371).
+
+Security Fixes
+--------------
+
+- bitbucket_pipeline_variable - **CVE-2021-20180** - hide user sensitive information which are marked as ``secured`` from logging into the console (https://github.com/ansible-collections/community.general/pull/1635).
+- snmp_facts - **CVE-2021-20178** - hide user sensitive information such as ``privkey`` and ``authkey`` from logging into the console (https://github.com/ansible-collections/community.general/pull/1621).
+
+Bugfixes
+--------
+
+- aerospike_migrations - handle exception when unstable-cluster is returned (https://github.com/ansible-collections/community.general/pull/900).
+- aix_filesystem - fix issues with ismount module_util pathing for Ansible 2.9 (https://github.com/ansible-collections/community.general/pull/567).
+- apache2_module - amend existing module identifier workaround to also apply to updated Shibboleth modules (https://github.com/ansible-collections/community.general/issues/1379).
+- beadm - fixed issue "list object has no attribute split" (https://github.com/ansible-collections/community.general/issues/791).
+- bigpanda - removed the dynamic default for ``host`` param (https://github.com/ansible-collections/community.general/pull/1423).
+- bitbucket_pipeline_variable - change pagination logic for pipeline variable get API (https://github.com/ansible-collections/community.general/issues/1425).
+- capabilities - fix for a newer version of libcap release (https://github.com/ansible-collections/community.general/pull/1061).
+- cobbler inventory plugin - ``name`` needed FQCN (https://github.com/ansible-collections/community.general/pull/722).
+- cobbler inventory script - add Python 3 support (https://github.com/ansible-collections/community.general/issues/638).
+- composer - fix bug in command idempotence with composer v2 (https://github.com/ansible-collections/community.general/issues/1179).
+- consul_kv lookup - fix ``ANSIBLE_CONSUL_URL`` environment variable handling (https://github.com/ansible/ansible/issues/51960).
+- consul_kv lookup - fix arguments handling (https://github.com/ansible-collections/community.general/pull/303).
+- digital_ocean_tag_info - fix crash when querying for an individual tag (https://github.com/ansible-collections/community.general/pull/615).
+- django_manage - fix idempotence for ``createcachetable`` (https://github.com/ansible-collections/community.general/pull/699).
+- dnsmadeeasy - fix HTTP 400 errors when creating a TXT record (https://github.com/ansible-collections/community.general/issues/1237).
+- doas become plugin - address a bug with the parameters handling that was breaking the plugin in community.general when ``become_flags`` and ``become_user`` were not explicitly specified (https://github.com/ansible-collections/community.general/pull/704).
+- dsv lookup - use correct dict usage (https://github.com/ansible-collections/community.general/pull/743).
+- dzdo become plugin - address a bug with the parameters handling that was breaking the plugin in community.general when ``become_user`` was not explicitly specified (https://github.com/ansible-collections/community.general/pull/708).
+- filesystem - add option ``state`` with default ``present``. When set to ``absent``, filesystem signatures are removed (https://github.com/ansible-collections/community.general/issues/355).
+- filesystem - resizefs of xfs filesystems is fixed. Filesystem needs to be mounted.
+- flatpak - use of the ``--non-interactive`` argument instead of ``-y`` when possible (https://github.com/ansible-collections/community.general/pull/1246).
+- gcp_storage_files lookup plugin - make sure that plugin errors out on initialization if the required library is not found, and not on load-time (https://github.com/ansible-collections/community.general/pull/1297).
+- gem - fix get_installed_versions: correctly parse ``default`` version (https://github.com/ansible-collections/community.general/pull/783).
+- git_config - now raises an error for non-existent repository paths (https://github.com/ansible-collections/community.general/issues/630).
+- git_config - using list instead of string as first parameter in the ``run_command()`` call (https://github.com/ansible-collections/community.general/issues/1021).
+- gitlab_group - added description parameter to ``createGroup()`` call (https://github.com/ansible-collections/community.general/issues/138).
+- gitlab_group_variable - support for GitLab pagination limitation by iterating over GitLab variable pages (https://github.com/ansible-collections/community.general/pull/968).
+- gitlab_project_variable - support for GitLab pagination limitation by iterating over GitLab variable pages (https://github.com/ansible-collections/community.general/pull/968).
+- gitlab_runner - fix compatiblity with some versions of python-gitlab (https://github.com/ansible-collections/community.general/pull/1491).
+- homebrew - add default search path for ``brew`` on Apple silicon hardware (https://github.com/ansible-collections/community.general/pull/1679).
+- homebrew - fix package name validation for packages containing hypen ``-`` (https://github.com/ansible-collections/community.general/issues/1037).
+- homebrew_cask - add default search path for ``brew`` on Apple silicon hardware (https://github.com/ansible-collections/community.general/pull/1679).
+- homebrew_cask - fix package name validation for casks containing hypen ``-`` (https://github.com/ansible-collections/community.general/issues/1037).
+- homebrew_cask - fixed issue where a cask with ``@`` in the name is incorrectly reported as invalid (https://github.com/ansible-collections/community.general/issues/733).
+- homebrew_tap - add default search path for ``brew`` on Apple silicon hardware (https://github.com/ansible-collections/community.general/pull/1679).
+- icinga2_host - fix returning error codes (https://github.com/ansible-collections/community.general/pull/335).
+- influxdb - fix usage of path for older version of python-influxdb (https://github.com/ansible-collections/community.general/issues/997).
+- ini_file - check for parameter ``value`` if ``state`` is ``present`` and ``allow_no_value`` is ``false`` (https://github.com/ansible-collections/community.general/issues/479).
+- interfaces_file - escape regular expression characters in old value (https://github.com/ansible-collections/community.general/issues/777).
+- inventory plugins - allow FQCN in ``plugin`` option (https://github.com/ansible-collections/community.general/pull/722).
+- ipa_hostgroup - fix an issue with load-balanced ipa and cookie handling with Python 3 (https://github.com/ansible-collections/community.general/issues/737).
+- iptables_state - fix race condition between module and its action plugin (https://github.com/ansible-collections/community.general/issues/1136).
+- jenkins_plugin - replace MD5 checksum verification with SHA1 due to MD5 being disabled on systems with FIPS-only algorithms enabled (https://github.com/ansible/ansible/issues/34304).
+- jira - ``fetch`` and ``search`` no longer indicate that something changed (https://github.com/ansible-collections/community.general/pull/1536).
+- jira - ensured parameter ``issue`` is mandatory for operation ``transition`` (https://github.com/ansible-collections/community.general/pull/1536).
+- jira - improve error message handling (https://github.com/ansible-collections/community.general/pull/311).
+- jira - improve error message handling with multiple errors (https://github.com/ansible-collections/community.general/pull/707).
+- jira - module no longer incorrectly reports change for information gathering operations (https://github.com/ansible-collections/community.general/pull/1536).
+- jira - provide error message raised from exception (https://github.com/ansible-collections/community.general/issues/1504).
+- jira - replaced custom parameter validation with ``required_if`` (https://github.com/ansible-collections/community.general/pull/1536).
+- json_query - handle ``AnsibleUnicode`` and ``AnsibleUnsafeText`` (https://github.com/ansible-collections/community.general/issues/320).
+- keycloak module_utils - provide meaningful error message to user when auth URL does not start with http or https (https://github.com/ansible-collections/community.general/issues/331).
+- launchd - fix for user-level services (https://github.com/ansible-collections/community.general/issues/896).
+- launchd - handle deprecated APIs like ``readPlist`` and ``writePlist`` in ``plistlib`` (https://github.com/ansible-collections/community.general/issues/1552).
+- ldap modules - add ``sasl_class`` parameter to support passwordless SASL authentication via GSSAPI (kerberos), next to external (https://github.com/ansible-collections/community.general/issues/1523).
+- ldap_entry - improvements in documentation, simplifications and replaced code with better ``AnsibleModule`` arguments (https://github.com/ansible-collections/community.general/pull/1516).
+- ldap_search - ignore returned referrals (https://github.com/ansible-collections/community.general/issues/1067).
+- ldap_search - the module no longer incorrectly reports a change (https://github.com/ansible-collections/community.general/issues/1040).
+- linode inventory plugin - make sure that plugin errors out on initialization if the required library is not found, and not on load-time (https://github.com/ansible-collections/community.general/pull/1297).
+- lldp - use ``get_bin_path`` to locate the ``lldpctl`` executable (https://github.com/ansible-collections/community.general/pull/1643).
+- lxc_container - fix the type of the ``container_config`` parameter. It is now processed as a list and not a string (https://github.com/ansible-collections/community.general/pull/216).
+- macports - fix failure to install a package whose name is contained within an already installed package's name or variant (https://github.com/ansible-collections/community.general/issues/1307).
+- make - fixed ``make`` parameter used for check mode when running a non-GNU ``make`` (https://github.com/ansible-collections/community.general/pull/1574).
+- mas - fix ``invalid literal`` when no app can be found (https://github.com/ansible-collections/community.general/pull/1436).
+- maven_artifact - handle timestamped snapshot version strings properly (https://github.com/ansible-collections/community.general/issues/709).
+- memcached cache plugin - make sure that plugin errors out on initialization if the required library is not found, and not on load-time (https://github.com/ansible-collections/community.general/pull/1297).
+- monit - add support for all monit service checks (https://github.com/ansible-collections/community.general/pull/1532).
+- monit - fix modules ability to determine the current state of the monitored process (https://github.com/ansible-collections/community.general/pull/1107).
+- nios_fixed_address, nios_host_record, nios_zone - removed redundant parameter aliases causing warning messages to incorrectly appear in task output (https://github.com/ansible-collections/community.general/issues/852).
+- nios_host_record - fix to remove ``aliases`` (CNAMES) for configuration comparison (https://github.com/ansible-collections/community.general/issues/1335).
+- nios_member - fix Python 3 compatibility with nios api ``member_normalize`` function (https://github.com/ansible-collections/community.general/issues/1526).
+- nmcli - cannot modify ``ifname`` after connection creation (https://github.com/ansible-collections/community.general/issues/1089).
+- nmcli - fix idempotetency when modifying an existing connection (https://github.com/ansible-collections/community.general/issues/481).
+- nmcli - remove ``bridge-slave`` from list of IP based connections ((https://github.com/ansible-collections/community.general/issues/1500).
+- nmcli - set ``C`` locale when executing ``nmcli`` (https://github.com/ansible-collections/community.general/issues/989).
+- nmcli - use consistent autoconnect parameters (https://github.com/ansible-collections/community.general/issues/459).
+- npm - handle json decode exception while parsing command line output (https://github.com/ansible-collections/community.general/issues/1614).
+- oc connection plugin - ``transport`` needed FQCN (https://github.com/ansible-collections/community.general/pull/722).
+- omapi_host - fix compatibility with Python 3 (https://github.com/ansible-collections/community.general/issues/787).
+- onepassword lookup plugin - updated to support password items, which place the password field directly in the payload's ``details`` attribute (https://github.com/ansible-collections/community.general/pull/1610).
+- osx_defaults - fix handling negative integers (https://github.com/ansible-collections/community.general/issues/134).
+- osx_defaults - unquote values and unescape double quotes when reading array values (https://github.com/ansible-collections/community.general/pull/358).
+- packet_net.py inventory script - fixed failure w.r.t. operating system retrieval by changing array subscription back to attribute access (https://github.com/ansible-collections/community.general/pull/891).
+- pacman - treat package names containing .zst as package files during installation (https://www.archlinux.org/news/now-using-zstandard-instead-of-xz-for-package-compression/, https://github.com/ansible-collections/community.general/pull/650).
+- pamd - added logic to retain the comment line (https://github.com/ansible-collections/community.general/issues/1394).
+- parted - fix creating partition when label is changed (https://github.com/ansible-collections/community.general/issues/522).
+- passwordstore lookup plugin - always use explicit ``show`` command to retrieve password. This ensures compatibility with ``gopass`` and avoids problems when password names equal ``pass`` commands (https://github.com/ansible-collections/community.general/pull/1493).
+- passwordstore lookup plugin - fix compatibility with gopass when used with ``create=true``. While pass returns 1 on a non-existent password, gopass returns 10, or 11, depending on whether a similar named password was stored. We now just check standard output and that the return code is not zero (https://github.com/ansible-collections/community.general/pull/1589).
+- pbrun become plugin - address a bug with the parameters handling that was breaking the plugin in community.general when ``become_user`` was not explicitly specified (https://github.com/ansible-collections/community.general/pull/708).
+- pkg5 - now works when Python 3 is used on the target (https://github.com/ansible-collections/community.general/pull/789).
+- profitbricks_nic - removed the dynamic default for ``name`` param (https://github.com/ansible-collections/community.general/pull/1423).
+- profitbricks_nic - replaced code with ``required`` and ``required_if`` (https://github.com/ansible-collections/community.general/pull/1423).
+- proxmox_kvm - defer error-checking for non-existent VMs in order to fix idempotency of tasks using ``state=absent`` and properly recognize a success (https://github.com/ansible-collections/community.general/pull/811).
+- proxmox_kvm - fix issue causing linked clones not being create by allowing ``format=unspecified`` (https://github.com/ansible-collections/community.general/issues/1027).
+- proxmox_kvm - ignore unsupported ``pool`` parameter on update (https://github.com/ansible-collections/community.general/pull/1258).
+- proxmox_kvm - improve handling of long-running tasks by creating a dedicated function (https://github.com/ansible-collections/community.general/pull/831).
+- redfish_info module, redfish_utils module utils - correct ``PartNumber`` property name in Redfish ``GetMemoryInventory`` command (https://github.com/ansible-collections/community.general/issues/1483).
+- redfish_info, redfish_config, redfish_command - Fix Redfish response payload decode on Python 3.5 (https://github.com/ansible-collections/community.general/issues/686)
+- redis - fixes parsing of config values which should not be converted to bytes (https://github.com/ansible-collections/community.general/pull/1079).
+- redis cache plugin - make sure that plugin errors out on initialization if the required library is not found, and not on load-time (https://github.com/ansible-collections/community.general/pull/1297).
+- rhn_channel - Python 2.7.5 fails if the certificate should not be validated. Fixed this by creating the correct ``ssl_context`` (https://github.com/ansible-collections/community.general/pull/470).
+- saltstack connection plugin - use ``hashutil.base64_decodefile`` to ensure that the file checksum is preserved (https://github.com/ansible-collections/community.general/pull/1472).
+- selective - mark task failed correctly (https://github.com/ansible/ansible/issues/63767).
+- sendgrid - update documentation and warn user about sendgrid Python library version (https://github.com/ansible-collections/community.general/issues/1553).
+- slack - avoid trying to update existing message when sending messages that contain the string "ts" (https://github.com/ansible-collections/community.general/issues/1097).
+- slack - fix ``xox[abp]`` token identification to capture everything after ``xox[abp]``, as the token is the only thing that should be in this argument (https://github.com/ansible-collections/community.general/issues/862).
+- snmp_facts - skip ``EndOfMibView`` values (https://github.com/ansible/ansible/issues/49044).
+- solaris_zone - fixed issue trying to configure zone in Python 3 (https://github.com/ansible-collections/community.general/issues/1081).
+- syslogger - update ``syslog.openlog`` API call for older Python versions, and improve error handling (https://github.com/ansible-collections/community.general/issues/953).
+- syspatch - fix bug where not setting ``apply=true`` would result in error (https://github.com/ansible-collections/community.general/pull/360).
+- terraform - fix ``init_reconfigure`` option for proper CLI args (https://github.com/ansible-collections/community.general/pull/1620).
+- terraform - fix incorrectly reporting a status of unchanged when number of resources added or destroyed are multiples of 10 (https://github.com/ansible-collections/community.general/issues/561).
+- terraform - improve result code checking when executing terraform commands (https://github.com/ansible-collections/community.general/pull/1632).
+- timezone - support Python3 on macos/darwin (https://github.com/ansible-collections/community.general/pull/945).
+- udm_user - removed the dynamic default for ``userexpiry`` param (https://github.com/ansible-collections/community.general/pull/1423).
+- utm_network_interface_address - changed param type from invalid 'boolean' to valid 'bool' (https://github.com/ansible-collections/community.general/pull/1423).
+- utm_proxy_exception - four parameters had elements types set as 'string' (invalid), changed to 'str' (https://github.com/ansible-collections/community.general/pull/1399).
+- vmadm - simplification of code (https://github.com/ansible-collections/community.general/pull/1415).
+- xfconf - add in missing return values that are specified in the documentation (https://github.com/ansible-collections/community.general/issues/1418).
+- xfconf - make it work in non-english locales (https://github.com/ansible-collections/community.general/pull/744).
+- xfconf - parameter ``value`` no longer required for state ``absent`` (https://github.com/ansible-collections/community.general/issues/1329).
+- xfconf - xfconf no longer passing the command args as a string, but rather as a list (https://github.com/ansible-collections/community.general/issues/1328).
+- yaml callback plugin - do not remove non-ASCII Unicode characters from multiline string output (https://github.com/ansible-collections/community.general/issues/1519).
+- yarn - fixed an index out of range error when no outdated packages where returned by yarn executable (see https://github.com/ansible-collections/community.general/pull/474).
+- yarn - fixed an too many values to unpack error when scoped packages are installed (see https://github.com/ansible-collections/community.general/pull/474).
+- zfs - fixed ``invalid character '@' in pool name"`` error when working with snapshots on a root zvol (https://github.com/ansible-collections/community.general/issues/932).
+- zypper - force ``LANG=C`` to as zypper is looking in XML output where attribute could be translated (https://github.com/ansible-collections/community.general/issues/1175).
+
+New Plugins
+-----------
+
+Inventory
+~~~~~~~~~
+
+- proxmox - Proxmox inventory source
+- stackpath_compute - StackPath Edge Computing inventory source
+
+New Modules
+-----------
+
+Cloud
+~~~~~
+
+misc
+^^^^
+
+- proxmox_domain_info - Retrieve information about one or more Proxmox VE domains
+- proxmox_group_info - Retrieve information about one or more Proxmox VE groups
+- proxmox_snap - Snapshot management of instances in Proxmox VE cluster
+- proxmox_user_info - Retrieve information about one or more Proxmox VE users
+
+scaleway
+^^^^^^^^
+
+- scaleway_database_backup - Scaleway database backups management module
+
+Clustering
+~~~~~~~~~~
+
+nomad
+^^^^^
+
+- nomad_job - Launch a Nomad Job
+- nomad_job_info - Get Nomad Jobs info
+
+Identity
+~~~~~~~~
+
+ipa
+^^^
+
+- ipa_pwpolicy - Manage FreeIPA password policies
+
+Monitoring
+~~~~~~~~~~
+
+- pagerduty_change - Track a code or infrastructure change as a PagerDuty change event
+- pagerduty_user - Manage a user account on PagerDuty
+
+datadog
+^^^^^^^
+
+- datadog_downtime - Manages Datadog downtimes
+
+Packaging
+~~~~~~~~~
+
+os
+^^
+
+- copr - Manage one of the Copr repositories
+- rpm_ostree_pkg - Install or uninstall overlay additional packages
+- yum_versionlock - Locks / unlocks a installed package(s) from being updated by yum package manager
+
+Source Control
+~~~~~~~~~~~~~~
+
+gitlab
+^^^^^^
+
+- gitlab_group_members - Manage group members on GitLab Server
+- gitlab_group_variable - Creates, updates, or deletes GitLab groups variables
+
+System
+~~~~~~
+
+- iptables_state - Save iptables state into a file or restore it from a file
+- shutdown - Shut down a machine
+- ssh_config - Manage SSH config for user
+- sysrc - Manage FreeBSD using sysrc
+- sysupgrade - Manage OpenBSD system upgrades

README.md

@@ -1,4 +1,98 @@
-[![GitHub Actions CI/CD build status — Collection test suite](https://github.com/ansible-collection-migration/community.general/workflows/Collection%20test%20suite/badge.svg?branch=master)](https://github.com/ansible-collection-migration/community.general/actions?query=workflow%3A%22Collection%20test%20suite%22)
+# Community General Collection
 
-Ansible Collection: community.general
-=================================================
+[![Build Status](https://dev.azure.com/ansible/community.general/_apis/build/status/CI?branchName=stable-2)](https://dev.azure.com/ansible/community.general/_build?definitionId=31)
+[![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general)
+
+This repo contains the `community.general` Ansible Collection. The collection includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
+
+You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
+
+## Tested with Ansible
+
+Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.
+
+## External requirements
+
+Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.
+
+## Included content
+
+Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/community/general) or the [documentation on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
+
+## Using this collection
+
+Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI:
+
+    ansible-galaxy collection install community.general
+
+You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
+
+```yaml
+collections:
+- name: community.general
+```
+
+See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
+
+## Contributing to this collection
+
+If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
+
+For example, if you are working in the `~/dev` directory:
+
+```
+cd ~/dev
+git clone git@github.com:ansible-collections/community.general.git collections/ansible_collections/community/general
+export COLLECTIONS_PATH=$(pwd)/collections:$COLLECTIONS_PATH
+```
+
+You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
+
+### Running tests
+
+See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
+
+### Communication
+
+We have a dedicated Working Group for Ansible development.
+
+You can find other people interested on the following Freenode IRC channels -
+- `#ansible` - For general use questions and support.
+- `#ansible-devel` - For discussions on developer topics and code related to features or bugs.
+- `#ansible-community` - For discussions on community topics and community meetings.
+
+For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
+
+For more information about [communication](https://docs.ansible.com/ansible/latest/community/communication.html)
+
+### Publishing New Version
+
+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-2/CHANGELOG.rst).
+
+## Roadmap
+
+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
+
+- [Ansible Collection overview](https://github.com/ansible-collections/overview)
+- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
+- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
+- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
+
+## Licensing
+
+GNU General Public License v3.0 or later.
+
+See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.

changelogs/.gitignore

@@ -0,0 +1 @@
+/.plugin-cache.yaml

changelogs/config.yaml

@@ -0,0 +1,29 @@
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+keep_fragments: false
+mention_ancestor: true
+flatmap: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+prelude_section_name: release_summary
+prelude_section_title: Release Summary
+sections:
+- - major_changes
+  - Major Changes
+- - minor_changes
+  - Minor Changes
+- - breaking_changes
+  - Breaking Changes / Porting Guide
+- - deprecated_features
+  - Deprecated Features
+- - removed_features
+  - Removed Features (previously deprecated)
+- - security_fixes
+  - Security Fixes
+- - bugfixes
+  - Bugfixes
+- - known_issues
+  - Known Issues
+title: Community General

galaxy.yml

@@ -1,28 +1,16 @@
 namespace: community
 name: general
-version: 0.1.0
+version: 2.2.0
 readme: README.md
-authors: null
+authors:
+  - Ansible (https://github.com/ansible)
 description: null
-license: GPL-3.0-or-later
 license_file: COPYING
-tags: null
-#dependencies:
-#  netapp.ontap: '>=0.1.0'
-#  community.kubernetes: '>=0.1.0'
-#  ovirt.ovirt: '>=0.1.0'
-#  ansible.netcommon: '>=0.1.0'
-#  cisco.mso: '>=0.1.0'
-#  ansible.posix: '>=0.1.0'
-#  cisco.aci: '>=0.1.0'
-#  cisco.intersight: '>=0.1.0'
-#  check_point.mgmt: '>=0.1.0'
-#  fortinet.fortios: '>=0.1.0'
-#  openstack.cloud: '>=0.1.0'
-#  google.cloud: '>=0.1.0'
-#  f5networks.f5_modules: '>=0.1.0'
+tags: [community]
+# NOTE: No dependencies are expected to be added here
+# dependencies:
 repository: https://github.com/ansible-collections/community.general
-documentation: https://github.com/ansible-collection-migration/community.general/tree/master/docs
+documentation: https://docs.ansible.com/ansible/latest/collections/community/general/
 homepage: https://github.com/ansible-collections/community.general
 issues: https://github.com/ansible-collections/community.general/issues
-type: flatmap
+#type: flatmap

meta/action_groups.yml

@@ -1,66 +0,0 @@
-docker:
-- docker_swarm
-- docker_image_facts
-- docker_service
-- docker_compose
-- docker_config
-- docker_container
-- docker_container_info
-- docker_host_info
-- docker_image
-- docker_image_info
-- docker_login
-- docker_network
-- docker_network_info
-- docker_node
-- docker_node_info
-- docker_prune
-- docker_secret
-- docker_swarm
-- docker_swarm_info
-- docker_swarm_service
-- docker_swarm_service_info
-- docker_volume
-- docker_volume_info
-k8s:
-- kubevirt_cdi_upload
-- kubevirt_preset
-- kubevirt_pvc
-- kubevirt_rs
-- kubevirt_template
-- kubevirt_vm
-os:
-- os_flavor_facts
-- os_image_facts
-- os_keystone_domain_facts
-- os_networks_facts
-- os_port_facts
-- os_project_facts
-- os_server_facts
-- os_subnets_facts
-- os_user_facts
-ovirt:
-- ovirt_affinity_label_facts
-- ovirt_api_facts
-- ovirt_cluster_facts
-- ovirt_datacenter_facts
-- ovirt_disk_facts
-- ovirt_event_facts
-- ovirt_external_provider_facts
-- ovirt_group_facts
-- ovirt_host_facts
-- ovirt_host_storage_facts
-- ovirt_network_facts
-- ovirt_nic_facts
-- ovirt_permission_facts
-- ovirt_quota_facts
-- ovirt_scheduling_policy_facts
-- ovirt_snapshot_facts
-- ovirt_storage_domain_facts
-- ovirt_storage_template_facts
-- ovirt_storage_vm_facts
-- ovirt_tag_facts
-- ovirt_template_facts
-- ovirt_user_facts
-- ovirt_vm_facts
-- ovirt_vmpool_facts

meta/routing.yml

@@ -1,962 +0,0 @@
-plugin_routing:
-  modules:
-    ali_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    cs_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    cs_zone_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_account_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_certificate_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_domain_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_firewall_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_floating_ip_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_load_balancer_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_region_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_size_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_snapshot_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_sshkey_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_tag_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    digital_ocean_volume_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    docker_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    docker_service:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcdns_record:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcdns_zone:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gce:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_backend_service:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_bigquery_dataset_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_bigquery_table_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_cloudbuild_trigger_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_address_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_backend_bucket_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_backend_service_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_disk_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_firewall_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_forwarding_rule_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_global_address_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_global_forwarding_rule_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_health_check_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_http_health_check_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_https_health_check_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_instance_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_instance_group_manager_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_instance_template_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_interconnect_attachment_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_region_disk_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_route_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_router_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_ssl_certificate_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_ssl_policy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_subnetwork_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_http_proxy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_https_proxy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_pool_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_ssl_proxy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_tcp_proxy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_target_vpn_gateway_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_url_map_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_compute_vpn_tunnel_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_container_cluster_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_container_node_pool_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_dns_managed_zone_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_dns_resource_record_set_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_forwarding_rule:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_healthcheck:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_iam_role_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_iam_service_account_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_pubsub_subscription_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_pubsub_topic_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_redis_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_resourcemanager_project_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_sourcerepo_repository_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_spanner_database_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_spanner_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_sql_database_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_sql_instance_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_sql_user_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_target_proxy:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_tpu_node_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcp_url_map:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcpubsub_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gcspanner:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    memset_memstore_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    memset_server_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    online_server_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    online_user_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    one_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_flavor_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_keystone_domain_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_networks_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_port_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_project_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_server_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_subnets_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    os_user_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_affinity_label_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_api_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_cluster_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_datacenter_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_disk_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_event_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_external_provider_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_host_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_host_storage_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_nic_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_permission_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_quota_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_scheduling_policy_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_snapshot_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_storage_domain_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_storage_template_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_storage_vm_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_tag_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_template_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_user_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_vm_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ovirt_vmpool_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_ip_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_organization_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_security_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_server_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_snapshot_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    scaleway_volume_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    smartos_image_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_account_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_dns_domain:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_dns_record:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_firewall_group:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_firewall_rule:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_server:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_ssh_key:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_startup_script:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vr_user:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_account_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_block_storage_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_dns_domain_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_firewall_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_os_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_plan_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_region_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_server_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_ssh_key_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_startup_script_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vultr_user_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    xenserver_guest_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    vertica_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    onepassword_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    zabbix_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    zabbix_host_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    ldap_attr:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_fc:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_l2:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_lldp:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_mcp:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_port_channel:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    aci_intf_policy_port_security:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_asm_policy:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_device_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_gtm_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_iapplx_package:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_security_address_list:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_security_port_list:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigip_traffic_group:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    bigiq_device_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_cluster:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_ospf:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_ospfarea:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_show:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_trunk:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vlag:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vlan:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vrouter:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vrouterbgp:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vrouterif:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    pn_vrouterlbif:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_admin:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_admpwd:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_cert_gen_ssh:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_check:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_commit:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_dag:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_dag_tags:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_import:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_interface:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_lic:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_loadcfg:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_match_rule:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_mgtconfig:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_nat_rule:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_object:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_op:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_pg:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_query_rules:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_restart:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_sag:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_security_rule:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    panos_set:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    osx_say:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    foreman:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    katello:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    hpilo_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_datacenter_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_enclosure_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_ethernet_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_fc_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_fcoe_network_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_logical_interconnect_group_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_network_set_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    oneview_san_manager_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    idrac_redfish_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    redfish_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    github_hooks:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    github_webhook_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gitlab_hooks:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    gluster_heal_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_aggregate:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_license:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_lun:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_qtree:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_svm:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_user:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_user_role:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_cdot_volume:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    na_ontap_gather_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    sf_account_manager:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    sf_check_connections:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    sf_snapshot_schedule_manager:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    sf_volume_access_group_manager:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    sf_volume_manager:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    purefa_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    purefb_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    python_requirements_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    jenkins_job_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details
-    nginx_status_facts:
-      deprecation:
-        removal_date: TBD
-        warning_text: see plugin documentation for details

meta/runtime.yml

@@ -0,0 +1,603 @@
+---
+requires_ansible: '>=2.9.10'
+action_groups:
+  ovirt:
+  - ovirt_affinity_label_facts
+  - ovirt_api_facts
+  - ovirt_cluster_facts
+  - ovirt_datacenter_facts
+  - ovirt_disk_facts
+  - ovirt_event_facts
+  - ovirt_external_provider_facts
+  - ovirt_group_facts
+  - ovirt_host_facts
+  - ovirt_host_storage_facts
+  - ovirt_network_facts
+  - ovirt_nic_facts
+  - ovirt_permission_facts
+  - ovirt_quota_facts
+  - ovirt_scheduling_policy_facts
+  - ovirt_snapshot_facts
+  - ovirt_storage_domain_facts
+  - ovirt_storage_template_facts
+  - ovirt_storage_vm_facts
+  - ovirt_tag_facts
+  - ovirt_template_facts
+  - ovirt_user_facts
+  - ovirt_vm_facts
+  - ovirt_vmpool_facts
+plugin_routing:
+  connection:
+    docker:
+      redirect: community.docker.docker
+    oc:
+      redirect: community.okd.oc
+  lookup:
+    gcp_storage_file:
+      redirect: community.google.gcp_storage_file
+    hashi_vault:
+      redirect: community.hashi_vault.hashi_vault
+  modules:
+    ali_instance_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.ali_instance_info instead.
+    docker_compose:
+      redirect: community.docker.docker_compose
+    docker_config:
+      redirect: community.docker.docker_config
+    docker_container:
+      redirect: community.docker.docker_container
+    docker_container_info:
+      redirect: community.docker.docker_container_info
+    docker_host_info:
+      redirect: community.docker.docker_host_info
+    docker_image:
+      redirect: community.docker.docker_image
+    docker_image_facts:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use community.docker.docker_image_info instead.
+    docker_image_info:
+      redirect: community.docker.docker_image_info
+    docker_login:
+      redirect: community.docker.docker_login
+    docker_network:
+      redirect: community.docker.docker_network
+    docker_network_info:
+      redirect: community.docker.docker_network_info
+    docker_node:
+      redirect: community.docker.docker_node
+    docker_node_info:
+      redirect: community.docker.docker_node_info
+    docker_prune:
+      redirect: community.docker.docker_prune
+    docker_secret:
+      redirect: community.docker.docker_secret
+    docker_service:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use community.docker.docker_compose instead.
+    docker_stack:
+      redirect: community.docker.docker_stack
+    docker_stack_info:
+      redirect: community.docker.docker_stack_info
+    docker_stack_task_info:
+      redirect: community.docker.docker_stack_task_info
+    docker_swarm:
+      redirect: community.docker.docker_swarm
+    docker_swarm_info:
+      redirect: community.docker.docker_swarm_info
+    docker_swarm_service:
+      redirect: community.docker.docker_swarm_service
+    docker_swarm_service_info:
+      redirect: community.docker.docker_swarm_service_info
+    docker_volume:
+      redirect: community.docker.docker_volume
+    docker_volume_info:
+      redirect: community.docker.docker_volume_info
+    foreman:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the modules from the theforeman.foreman collection instead.
+    gc_storage:
+      redirect: community.google.gc_storage
+    gcdns_record:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_dns_resource_record_set instead.
+    gcdns_zone:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_dns_managed_zone instead.
+    gce:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_instance instead.
+    gce_eip:
+      redirect: community.google.gce_eip
+    gce_img:
+      redirect: community.google.gce_img
+    gce_instance_template:
+      redirect: community.google.gce_instance_template
+    gce_labels:
+      redirect: community.google.gce_labels
+    gce_lb:
+      redirect: community.google.gce_lb
+    gce_mig:
+      redirect: community.google.gce_mig
+    gce_net:
+      redirect: community.google.gce_net
+    gce_pd:
+      redirect: community.google.gce_pd
+    gce_snapshot:
+      redirect: community.google.gce_snapshot
+    gce_tag:
+      redirect: community.google.gce_tag
+    gcp_backend_service:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_backend_service instead.
+    gcp_forwarding_rule:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_forwarding_rule or google.cloud.gcp_compute_global_forwarding_rule instead.
+    gcp_healthcheck:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_health_check, google.cloud.gcp_compute_http_health_check or google.cloud.gcp_compute_https_health_check instead.
+    gcp_target_proxy:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_target_http_proxy instead.
+    gcp_url_map:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_compute_url_map instead.
+    gcpubsub:
+      redirect: community.google.gcpubsub
+    gcpubsub_info:
+      redirect: community.google.gcpubsub_info
+    gcpubsub_facts:
+      redirect: community.google.gcpubsub_info
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.google.gcpubsub_info instead.
+    gcspanner:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use google.cloud.gcp_spanner_database and/or google.cloud.gcp_spanner_instance instead.
+    github_hooks:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use community.general.github_webhook and community.general.github_webhook_info instead.
+    gluster_heal_info:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_heal_info instead.
+    gluster_peer:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_peer instead.
+    gluster_volume:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: The gluster modules have migrated to the gluster.gluster collection. Use gluster.gluster.gluster_volume instead.
+    helm:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: The helm module in community.general has been deprecated. Use community.kubernetes.helm instead.
+    hetzner_failover_ip:
+      redirect: community.hrobot.failover_ip
+    hetzner_failover_ip_info:
+      redirect: community.hrobot.failover_ip_info
+    hetzner_firewall:
+      redirect: community.hrobot.firewall
+    hetzner_firewall_info:
+      redirect: community.hrobot.firewall_info
+    hpilo_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.hpilo_info instead.
+    idrac_redfish_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.idrac_redfish_info instead.
+    jenkins_job_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.jenkins_job_info instead.
+    katello:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the modules from the theforeman.foreman collection instead.
+    kubevirt_cdi_upload:
+      redirect: community.kubevirt.kubevirt_cdi_upload
+    kubevirt_preset:
+      redirect: community.kubevirt.kubevirt_preset
+    kubevirt_pvc:
+      redirect: community.kubevirt.kubevirt_pvc
+    kubevirt_rs:
+      redirect: community.kubevirt.kubevirt_rs
+    kubevirt_template:
+      redirect: community.kubevirt.kubevirt_template
+    kubevirt_vm:
+      redirect: community.kubevirt.kubevirt_vm
+    ldap_attr:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.ldap_attrs instead.
+    logicmonitor:
+      tombstone:
+        removal_version: 1.0.0
+        warning_text: The logicmonitor_facts module is no longer maintained and the API used has been disabled in 2017.
+    logicmonitor_facts:
+      tombstone:
+        removal_version: 1.0.0
+        warning_text: The logicmonitor_facts module is no longer maintained and the API used has been disabled in 2017.
+    memset_memstore_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.memset_memstore_info instead.
+    memset_server_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.memset_server_info instead.
+    na_cdot_aggregate:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_aggregate instead.
+    na_cdot_license:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_license instead.
+    na_cdot_lun:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_lun instead.
+    na_cdot_qtree:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_qtree instead.
+    na_cdot_svm:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_svm instead.
+    na_cdot_user:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_user instead.
+    na_cdot_user_role:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_user_role instead.
+    na_cdot_volume:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.ontap.na_ontap_volume instead.
+    na_ontap_gather_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use netapp.ontap.na_ontap_info instead.
+    nginx_status_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.nginx_status_info instead.
+    one_image_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.one_image_info instead.
+    onepassword_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.onepassword_info instead.
+    oneview_datacenter_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_datacenter_info instead.
+    oneview_enclosure_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_enclosure_info instead.
+    oneview_ethernet_network_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_ethernet_network_info instead.
+    oneview_fc_network_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_fc_network_info instead.
+    oneview_fcoe_network_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_fcoe_network_info instead.
+    oneview_logical_interconnect_group_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_logical_interconnect_group_info instead.
+    oneview_network_set_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_network_set_info instead.
+    oneview_san_manager_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.oneview_san_manager_info instead.
+    online_server_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.online_server_info instead.
+    online_user_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.online_user_info instead.
+    ovirt:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_vm instead.
+    ovirt_affinity_label_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_affinity_label_info instead.
+    ovirt_api_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_api_info instead.
+    ovirt_cluster_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_cluster_info instead.
+    ovirt_datacenter_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_datacenter_info instead.
+    ovirt_disk_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_disk_info instead.
+    ovirt_event_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_event_info instead.
+    ovirt_external_provider_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_external_provider_info instead.
+    ovirt_group_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_group_info instead.
+    ovirt_host_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_host_info instead.
+    ovirt_host_storage_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_host_storage_info instead.
+    ovirt_network_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_network_info instead.
+    ovirt_nic_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_nic_info instead.
+    ovirt_permission_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_permission_info instead.
+    ovirt_quota_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_quota_info instead.
+    ovirt_scheduling_policy_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_scheduling_policy_info instead.
+    ovirt_snapshot_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_snapshot_info instead.
+    ovirt_storage_domain_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_storage_domain_info instead.
+    ovirt_storage_template_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_storage_template_info instead.
+    ovirt_storage_vm_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_storage_vm_info instead.
+    ovirt_tag_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_tag_info instead.
+    ovirt_template_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_template_info instead.
+    ovirt_user_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_user_info instead.
+    ovirt_vm_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_vm_info instead.
+    ovirt_vmpool_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use ovirt.ovirt.ovirt_vmpool_info instead.
+    postgresql_copy:
+      redirect: community.postgresql.postgresql_copy
+    postgresql_db:
+      redirect: community.postgresql.postgresql_db
+    postgresql_ext:
+      redirect: community.postgresql.postgresql_ext
+    postgresql_idx:
+      redirect: community.postgresql.postgresql_idx
+    postgresql_info:
+      redirect: community.postgresql.postgresql_info
+    postgresql_lang:
+      redirect: community.postgresql.postgresql_lang
+    postgresql_membership:
+      redirect: community.postgresql.postgresql_membership
+    postgresql_owner:
+      redirect: community.postgresql.postgresql_owner
+    postgresql_pg_hba:
+      redirect: community.postgresql.postgresql_pg_hba
+    postgresql_ping:
+      redirect: community.postgresql.postgresql_ping
+    postgresql_privs:
+      redirect: community.postgresql.postgresql_privs
+    postgresql_publication:
+      redirect: community.postgresql.postgresql_publication
+    postgresql_query:
+      redirect: community.postgresql.postgresql_query
+    postgresql_schema:
+      redirect: community.postgresql.postgresql_schema
+    postgresql_sequence:
+      redirect: community.postgresql.postgresql_sequence
+    postgresql_set:
+      redirect: community.postgresql.postgresql_set
+    postgresql_slot:
+      redirect: community.postgresql.postgresql_slot
+    postgresql_subscription:
+      redirect: community.postgresql.postgresql_subscription
+    postgresql_table:
+      redirect: community.postgresql.postgresql_table
+    postgresql_tablespace:
+      redirect: community.postgresql.postgresql_tablespace
+    postgresql_user_obj_stat_info:
+      redirect: community.postgresql.postgresql_user_obj_stat_info
+    postgresql_user:
+      redirect: community.postgresql.postgresql_user
+    purefa_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use purestorage.flasharray.purefa_info instead.
+    purefb_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use purestorage.flashblade.purefb_info instead.
+    python_requirements_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.python_requirements_info instead.
+    redfish_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.redfish_info instead.
+    scaleway_image_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_image_info instead.
+    scaleway_ip_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_ip_info instead.
+    scaleway_organization_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_organization_info instead.
+    scaleway_security_group_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_security_group_info instead.
+    scaleway_server_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_server_info instead.
+    scaleway_snapshot_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_snapshot_info instead.
+    scaleway_volume_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.scaleway_volume_info instead.
+    sf_account_manager:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.elementsw.na_elementsw_account instead.
+    sf_check_connections:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.elementsw.na_elementsw_check_connections instead.
+    sf_snapshot_schedule_manager:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.elementsw.na_elementsw_snapshot_schedule instead.
+    sf_volume_access_group_manager:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.elementsw.na_elementsw_access_group instead.
+    sf_volume_manager:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use netapp.elementsw.na_elementsw_volume instead.
+    smartos_image_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.smartos_image_info instead.
+    vertica_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.vertica_info instead.
+    xenserver_guest_facts:
+      deprecation:
+        removal_version: 3.0.0
+        warning_text: Use community.general.xenserver_guest_info instead.
+  doc_fragments:
+    _gcp:
+      redirect: community.google._gcp
+    docker:
+      redirect: community.docker.docker
+    hetzner:
+      redirect: community.hrobot.robot
+    kubevirt_common_options:
+      redirect: community.kubevirt.kubevirt_common_options
+    kubevirt_vm_options:
+      redirect: community.kubevirt.kubevirt_vm_options
+    postgresql:
+      redirect: community.postgresql.postgresql
+  module_utils:
+    docker.common:
+      redirect: community.docker.common
+    docker.swarm:
+      redirect: community.docker.swarm
+    gcdns:
+      redirect: community.google.gcdns
+    gce:
+      redirect: community.google.gce
+    gcp:
+      redirect: community.google.gcp
+    hetzner:
+      redirect: community.hrobot.robot
+    kubevirt:
+      redirect: community.kubevirt.kubevirt
+    postgresql:
+      redirect: community.postgresql.postgresql
+  callback:
+    actionable:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts = no' and 'display_ok_hosts = no' options.
+    full_skip:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_skipped_hosts = no' option.
+    stderr:
+      tombstone:
+        removal_version: 2.0.0
+        warning_text: Use the 'default' callback plugin with 'display_failed_stderr = yes' option.
+  inventory:
+    docker_machine:
+      redirect: community.docker.docker_machine
+    docker_swarm:
+      redirect: community.docker.docker_swarm
+    kubevirt:
+      redirect: community.kubevirt.kubevirt

plugins/action/aireos.py

@@ -1,79 +0,0 @@
-#
-# (c) 2016 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.aireos.aireos import aireos_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'aireos_config' else False
-
-        if self._play_context.connection != 'local':
-            return dict(
-                failed=True,
-                msg='invalid connection specified, expected connection=local, '
-                    'got %s' % self._play_context.connection
-            )
-
-        provider = load_provider(aireos_provider_spec, self._task.args)
-
-        pc = copy.deepcopy(self._play_context)
-        pc.connection = 'network_cli'
-        pc.network_os = 'aireos'
-        pc.remote_addr = provider['host'] or self._play_context.remote_addr
-        pc.port = int(provider['port'] or self._play_context.port or 22)
-        pc.remote_user = provider['username'] or self._play_context.connection_user
-        pc.password = provider['password'] or self._play_context.password
-        command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-        display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-        connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-        connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-        socket_path = connection.run()
-        display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-        if not socket_path:
-            return {'failed': True,
-                    'msg': 'unable to open shell. Please see: ' +
-                           'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-        task_vars['ansible_socket'] = socket_path
-
-        if self._play_context.become_method == 'enable':
-            self._play_context.become = False
-            self._play_context.become_method = None
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-
-        return result

plugins/action/aruba.py

@@ -1,79 +0,0 @@
-#
-# (c) 2016 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.aruba.aruba import aruba_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'aruba_config' else False
-
-        if self._play_context.connection != 'local':
-            return dict(
-                failed=True,
-                msg='invalid connection specified, expected connection=local, '
-                    'got %s' % self._play_context.connection
-            )
-
-        provider = load_provider(aruba_provider_spec, self._task.args)
-
-        pc = copy.deepcopy(self._play_context)
-        pc.connection = 'network_cli'
-        pc.network_os = 'aruba'
-        pc.remote_addr = provider['host'] or self._play_context.remote_addr
-        pc.port = int(provider['port'] or self._play_context.port or 22)
-        pc.remote_user = provider['username'] or self._play_context.connection_user
-        pc.password = provider['password'] or self._play_context.password
-        pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-        command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-        display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-        connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-        connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-        socket_path = connection.run()
-        display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-        if not socket_path:
-            return {'failed': True,
-                    'msg': 'unable to open shell. Please see: ' +
-                           'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-        task_vars['ansible_socket'] = socket_path
-
-        if self._play_context.become_method == 'enable':
-            self._play_context.become = False
-            self._play_context.become_method = None
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/ce.py

@@ -1,89 +0,0 @@
-#
-# Copyright: (c) 2016, Red Hat Inc.
-
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.cloudengine.ce import ce_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-CLI_SUPPORTED_MODULES = ['ce_rollback', 'ce_mlag_interface', 'ce_startup', 'ce_config',
-                         'ce_command', 'ce_facts', 'ce_evpn_global', 'ce_evpn_bgp_rr',
-                         'ce_mtu', 'ce_evpn_bgp', 'ce_snmp_location', 'ce_snmp_contact',
-                         'ce_snmp_traps', 'ce_netstream_global', 'ce_netstream_aging',
-                         'ce_netstream_export', 'ce_netstream_template', 'ce_ntp_auth',
-                         'ce_stp', 'ce_vxlan_global', 'ce_vxlan_arp', 'ce_vxlan_gateway',
-                         'ce_acl_interface']
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'ce_config' else False
-        socket_path = None
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        if self._play_context.connection == 'local':
-            provider = load_provider(ce_provider_spec, self._task.args)
-            transport = provider['transport'] or 'cli'
-
-            display.vvvv('connection transport is %s' % transport, self._play_context.remote_addr)
-
-            if transport == 'cli':
-                pc = copy.deepcopy(self._play_context)
-                pc.connection = 'network_cli'
-                pc.network_os = 'ce'
-                pc.remote_addr = provider['host'] or self._play_context.remote_addr
-                pc.port = int(provider['port'] or self._play_context.port or 22)
-                pc.remote_user = provider['username'] or self._play_context.connection_user
-                pc.password = provider['password'] or self._play_context.password
-                command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-                self._task.args['provider'] = provider.update(
-                    host=pc.remote_addr,
-                    port=pc.port,
-                    username=pc.remote_user,
-                    password=pc.password
-                )
-                if module_name in ['ce_netconf'] or module_name not in CLI_SUPPORTED_MODULES:
-                    pc.connection = 'netconf'
-                display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-                connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-                connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-                socket_path = connection.run()
-                display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-                if not socket_path:
-                    return {'failed': True,
-                            'msg': 'unable to open shell. Please see: ' +
-                                   'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-                task_vars['ansible_socket'] = socket_path
-                # make sure a transport value is set in args
-                self._task.args['transport'] = transport
-                self._task.args['provider'] = provider
-        elif persistent_connection in ('netconf', 'network_cli'):
-            provider = self._task.args.get('provider', {})
-            if any(provider.values()):
-                display.warning('provider is unnecessary when using %s and will be ignored' % self._play_context.connection)
-                del self._task.args['provider']
-
-            if (persistent_connection == 'network_cli' and module_name not in CLI_SUPPORTED_MODULES) or \
-                    (persistent_connection == 'netconf' and module_name in CLI_SUPPORTED_MODULES):
-                return {'failed': True, 'msg': "Connection type '%s' is not valid for '%s' module."
-                        % (self._play_context.connection, self._task.action)}
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/ce_template.py

@@ -1,104 +0,0 @@
-#
-# Copyright 2015 Peter Sprygada <psprygada@ansible.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import os
-import time
-import glob
-from ansible.module_utils.six.moves.urllib.parse import urlsplit
-
-from ansible.module_utils._text import to_text
-from ansible_collections.community.general.plugins.action.ce import ActionModule as _ActionModule
-
-
-class ActionModule(_ActionModule):
-
-    def run(self, tmp=None, task_vars=None):
-
-        try:
-            self._handle_template()
-        except (ValueError, AttributeError) as exc:
-            return dict(failed=True, msg=exc.message)
-
-        result = super(ActionModule, self).run(tmp, task_vars)
-        del tmp  # tmp no longer has any effect
-
-        if self._task.args.get('backup') and result.get('__backup__'):
-            # User requested backup and no error occurred in module.
-            # NOTE: If there is a parameter error, __backup__ key may not be in results.
-            self._write_backup(task_vars['inventory_hostname'], result['__backup__'])
-
-        if '__backup__' in result:
-            del result['__backup__']
-
-        return result
-
-    def _get_working_path(self):
-        cwd = self._loader.get_basedir()
-        if self._task._role is not None:
-            cwd = self._task._role._role_path
-        return cwd
-
-    def _write_backup(self, host, contents):
-        backup_path = self._get_working_path() + '/backup'
-        if not os.path.exists(backup_path):
-            os.mkdir(backup_path)
-        for fn in glob.glob('%s/%s*' % (backup_path, host)):
-            os.remove(fn)
-        tstamp = time.strftime("%Y-%m-%d@%H:%M:%S", time.localtime(time.time()))
-        filename = '%s/%s_config.%s' % (backup_path, host, tstamp)
-        open(filename, 'w').write(contents)
-
-    def _handle_template(self):
-        src = self._task.args.get('src')
-        if not src:
-            raise ValueError('missing required arguments: src')
-
-        working_path = self._get_working_path()
-
-        if os.path.isabs(src) or urlsplit(src).scheme:
-            source = src
-        else:
-            source = self._loader.path_dwim_relative(working_path, 'templates', src)
-            if not source:
-                source = self._loader.path_dwim_relative(working_path, src)
-
-        if not os.path.exists(source):
-            return
-
-        try:
-            with open(source, 'r') as f:
-                template_data = to_text(f.read())
-        except IOError:
-            return dict(failed=True, msg='unable to load src file')
-
-        # Create a template search path in the following order:
-        # [working_path, self_role_path, dependent_role_paths, dirname(source)]
-        searchpath = [working_path]
-        if self._task._role is not None:
-            searchpath.append(self._task._role._role_path)
-            if hasattr(self._task, "_block:"):
-                dep_chain = self._task._block.get_dep_chain()
-                if dep_chain is not None:
-                    for role in dep_chain:
-                        searchpath.append(role._role_path)
-        searchpath.append(os.path.dirname(source))
-        with self._templar.set_temporary_context(searchpath=searchpath):
-            self._task.args['src'] = self._templar.template(template_data)

plugins/action/cnos.py

@@ -1,69 +0,0 @@
-# (C) 2017 Red Hat Inc.
-# Copyright (C) 2017 Lenovo.
-#
-# GNU General Public License v3.0+
-#
-# This program 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.
-#
-# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Contains Action Plugin methods for CNOS Config Module
-# Lenovo Networking
-#
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.cnos.cnos import cnos_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'cnos_config' else False
-
-        if self._play_context.connection == 'local':
-            provider = load_provider(cnos_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'cnos'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = provider['port'] or self._play_context.port or 22
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-            pc.become = provider['authorize'] or True
-            pc.become_pass = provider['auth_pass']
-            pc.become_method = 'enable'
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/edgeos_config.py

@@ -1,36 +0,0 @@
-#
-# Copyright 2018 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        self._config_module = True
-
-        if self._play_context.connection.split('.')[-1] != 'network_cli':
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module. Must use fully qualified'
-                                           ' name of network_cli connection type.' % self._play_context.connection}
-
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/action/enos.py

@@ -1,69 +0,0 @@
-# (C) 2017 Red Hat Inc.
-# Copyright (C) 2017 Lenovo.
-#
-# GNU General Public License v3.0+
-#
-# This program 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.
-#
-# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Contains Action Plugin methods for ENOS Config Module
-# Lenovo Networking
-#
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.enos.enos import enos_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'enos_config' else False
-
-        if self._play_context.connection == 'local':
-            provider = load_provider(enos_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'enos'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = provider['port'] or self._play_context.port or 22
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-            pc.become = provider['authorize'] or True
-            pc.become_pass = provider['auth_pass']
-            pc.become_method = 'enable'
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/exos.py

@@ -1,45 +0,0 @@
-#
-# Copyright 2015 Peter Sprygada <psprygada@ansible.com>
-#
-# 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
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-
-class ActionModule(ActionNetworkModule):
-
-    EXOS_NETWORK_CLI_MODULES = (
-        'exos_facts',
-        'exos_config',
-        'exos_command')
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'exos_config' else False
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        if persistent_connection not in ('network_cli', 'httpapi'):
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
-
-        if persistent_connection == 'network_cli' and module_name not in self.EXOS_NETWORK_CLI_MODULES:
-            return {'failed': True, 'msg': "Connection type %s is not valid for this module" % self._play_context.connection}
-
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/action/iptables_state.py

@@ -0,0 +1 @@
+./system/iptables_state.py

plugins/action/ironware.py

@@ -1,80 +0,0 @@
-#
-# (c) 2016 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible_collections.community.general.plugins.module_utils.network.ironware.ironware import ironware_provider_spec
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'ironware_config' else False
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        if persistent_connection == 'network_cli':
-            provider = self._task.args.get('provider', {})
-            if any(provider.values()):
-                display.warning('provider is unnecessary when using network_cli and will be ignored')
-                del self._task.args['provider']
-        elif self._play_context.connection == 'local':
-            provider = load_provider(ironware_provider_spec, self._task.args)
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'ironware'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            pc.become = provider['authorize'] or False
-            if pc.become:
-                pc.become_method = 'enable'
-            pc.become_pass = provider['auth_pass']
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-
-            command_timeout = int(provider['timeout']) if provider['timeout'] else connection.get_option('persistent_command_timeout')
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                               'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-        else:
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/nos_config.py

@@ -1,31 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        self._config_module = True
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/action/onyx_config.py

@@ -1,31 +0,0 @@
-#
-# (c) 2017, Red Hat, Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        self._config_module = True
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/action/shutdown.py

@@ -0,0 +1 @@
+./system/shutdown.py

plugins/action/slxos.py

@@ -1,40 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import re
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-PRIVATE_KEYS_RE = re.compile('__.+__')
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'slxos_config' else False
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        if persistent_connection not in ('network_cli'):
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/action/sros.py

@@ -1,77 +0,0 @@
-#
-# (c) 2016 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import sys
-import copy
-
-from ansible import constants as C
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-from ansible_collections.community.general.plugins.module_utils.network.sros.sros import sros_provider_spec
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import load_provider
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        self._config_module = True if module_name == 'sros_config' else False
-        if persistent_connection == 'network_cli':
-            provider = self._task.args.get('provider', {})
-            if any(provider.values()):
-                display.warning('provider is unnecessary when using network_cli and will be ignored')
-                del self._task.args['provider']
-        elif self._play_context.connection == 'local':
-            provider = load_provider(sros_provider_spec, self._task.args)
-
-            pc = copy.deepcopy(self._play_context)
-            pc.connection = 'network_cli'
-            pc.network_os = 'sros'
-            pc.remote_addr = provider['host'] or self._play_context.remote_addr
-            pc.port = int(provider['port'] or self._play_context.port or 22)
-            pc.remote_user = provider['username'] or self._play_context.connection_user
-            pc.password = provider['password'] or self._play_context.password
-            pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
-            command_timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
-
-            display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
-            connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin, task_uuid=self._task._uuid)
-            connection.set_options(direct={'persistent_command_timeout': command_timeout})
-
-            socket_path = connection.run()
-            display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
-            if not socket_path:
-                return {'failed': True,
-                        'msg': 'unable to open shell. Please see: ' +
-                        'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
-
-            task_vars['ansible_socket'] = socket_path
-        else:
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
-
-        result = super(ActionModule, self).run(task_vars=task_vars)
-        return result

plugins/action/system/iptables_state.py

@@ -0,0 +1,182 @@
+# Copyright: (c) 2020, quidame <quidame@poivron.org>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import time
+
+from ansible.plugins.action import ActionBase
+from ansible.errors import AnsibleError, AnsibleActionFail, AnsibleConnectionFailure
+from ansible.utils.vars import merge_hash
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class ActionModule(ActionBase):
+
+    # Keep internal params away from user interactions
+    _VALID_ARGS = frozenset(('path', 'state', 'table', 'noflush', 'counters', 'modprobe', 'ip_version', 'wait'))
+    DEFAULT_SUDOABLE = True
+
+    MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO = (
+        "This module doesn't support async>0 and poll>0 when its 'state' param "
+        "is set to 'restored'. To enable its rollback feature (that needs the "
+        "module to run asynchronously on the remote), please set task attribute "
+        "'poll' (=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
+    MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK = (
+        "Attempts to restore iptables state without rollback in case of mistake "
+        "may lead the ansible controller to loose access to the hosts and never "
+        "regain it before fixing firewall rules through a serial console, or any "
+        "other way except SSH. Please set task attribute 'poll' (=%s) to 0, and "
+        "'async' (=%s) to a value >2 and not greater than 'ansible_timeout' (=%s) "
+        "(recommended).")
+    MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT = (
+        "You attempt to restore iptables state with rollback in case of mistake, "
+        "but with settings that will lead this rollback to happen AFTER that the "
+        "controller will reach its own timeout. Please set task attribute 'poll' "
+        "(=%s) to 0, and 'async' (=%s) to a value >2 and not greater than "
+        "'ansible_timeout' (=%s) (recommended).")
+
+    def _async_result(self, module_args, task_vars, timeout):
+        '''
+        Retrieve results of the asynchonous task, and display them in place of
+        the async wrapper results (those with the ansible_job_id key).
+        '''
+        # At least one iteration is required, even if timeout is 0.
+        for i in range(max(1, timeout)):
+            async_result = self._execute_module(
+                module_name='ansible.builtin.async_status',
+                module_args=module_args,
+                task_vars=task_vars,
+                wrap_async=False)
+            if async_result['finished'] == 1:
+                break
+            time.sleep(min(1, timeout))
+
+        return async_result
+
+    def run(self, tmp=None, task_vars=None):
+
+        self._supports_check_mode = True
+        self._supports_async = True
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+        del tmp  # tmp no longer has any effect
+
+        if not result.get('skipped'):
+
+            # FUTURE: better to let _execute_module calculate this internally?
+            wrap_async = self._task.async_val and not self._connection.has_native_async
+
+            # Set short names for values we'll have to compare or reuse
+            task_poll = self._task.poll
+            task_async = self._task.async_val
+            check_mode = self._play_context.check_mode
+            max_timeout = self._connection._play_context.timeout
+            module_name = self._task.action
+            module_args = self._task.args
+
+            if module_args.get('state', None) == 'restored':
+                if not wrap_async:
+                    if not check_mode:
+                        display.warning(self.MSG_WARNING__NO_ASYNC_IS_NO_ROLLBACK % (
+                            task_poll,
+                            task_async,
+                            max_timeout))
+                elif task_poll:
+                    raise AnsibleActionFail(self.MSG_ERROR__ASYNC_AND_POLL_NOT_ZERO % (
+                        task_poll,
+                        task_async,
+                        max_timeout))
+                else:
+                    if task_async > max_timeout and not check_mode:
+                        display.warning(self.MSG_WARNING__ASYNC_GREATER_THAN_TIMEOUT % (
+                            task_poll,
+                            task_async,
+                            max_timeout))
+
+                    # inject the async directory based on the shell option into the
+                    # module args
+                    async_dir = self.get_shell_option('async_dir', default="~/.ansible_async")
+
+                    # Bind the loop max duration to consistent values on both
+                    # remote and local sides (if not the same, make the loop
+                    # longer on the controller); and set a backup file path.
+                    module_args['_timeout'] = task_async
+                    module_args['_back'] = '%s/iptables.state' % async_dir
+                    async_status_args = dict(_async_dir=async_dir)
+                    confirm_cmd = 'rm -f %s' % module_args['_back']
+                    starter_cmd = 'touch %s.starter' % module_args['_back']
+                    remaining_time = max(task_async, max_timeout)
+
+            # do work!
+            result = merge_hash(result, self._execute_module(module_args=module_args, task_vars=task_vars, wrap_async=wrap_async))
+
+            # Then the 3-steps "go ahead or rollback":
+            # 1. Catch early errors of the module (in asynchronous task) if any.
+            #    Touch a file on the target to signal the module to process now.
+            # 2. Reset connection to ensure a persistent one will not be reused.
+            # 3. Confirm the restored state by removing the backup on the remote.
+            #    Retrieve the results of the asynchronous task to return them.
+            if '_back' in module_args:
+                async_status_args['jid'] = result.get('ansible_job_id', None)
+                if async_status_args['jid'] is None:
+                    raise AnsibleActionFail("Unable to get 'ansible_job_id'.")
+
+                # Catch early errors due to missing mandatory option, bad
+                # option type/value, missing required system command, etc.
+                result = merge_hash(result, self._async_result(async_status_args, task_vars, 0))
+
+                # The module is aware to not process the main iptables-restore
+                # command before finding (and deleting) the 'starter' cookie on
+                # the host, so the previous query will not reach ssh timeout.
+                garbage = self._low_level_execute_command(starter_cmd, sudoable=self.DEFAULT_SUDOABLE)
+
+                # As the main command is not yet executed on the target, here
+                # 'finished' means 'failed before main command be executed'.
+                if not result['finished']:
+                    try:
+                        self._connection.reset()
+                    except AttributeError:
+                        pass
+
+                    for x in range(max_timeout):
+                        time.sleep(1)
+                        remaining_time -= 1
+                        # - AnsibleConnectionFailure covers rejected requests (i.e.
+                        #   by rules with '--jump REJECT')
+                        # - ansible_timeout is able to cover dropped requests (due
+                        #   to a rule or policy DROP) if not lower than async_val.
+                        try:
+                            garbage = self._low_level_execute_command(confirm_cmd, sudoable=self.DEFAULT_SUDOABLE)
+                            break
+                        except AnsibleConnectionFailure:
+                            continue
+
+                    result = merge_hash(result, self._async_result(async_status_args, task_vars, remaining_time))
+
+                # Cleanup async related stuff and internal params
+                for key in ('ansible_job_id', 'results_file', 'started', 'finished'):
+                    if result.get(key):
+                        del result[key]
+
+                if result.get('invocation', {}).get('module_args'):
+                    if '_timeout' in result['invocation']['module_args']:
+                        del result['invocation']['module_args']['_back']
+                        del result['invocation']['module_args']['_timeout']
+
+                async_status_args['mode'] = 'cleanup'
+                garbage = self._execute_module(
+                    module_name='ansible.builtin.async_status',
+                    module_args=async_status_args,
+                    task_vars=task_vars,
+                    wrap_async=False)
+
+        if not wrap_async:
+            # remove a temporary path we created
+            self._remove_tmp_path(self._connection._shell.tmpdir)
+
+        return result

plugins/action/system/shutdown.py

@@ -0,0 +1,211 @@
+# Copyright: (c) 2020, Amin Vakil <info@aminvakil.com>
+# Copyright: (c) 2016-2018, Matt Davis <mdavis@ansible.com>
+# Copyright: (c) 2018, Sam Doran <sdoran@redhat.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.errors import AnsibleError, AnsibleConnectionFailure
+from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.common.collections import is_string
+from ansible.plugins.action import ActionBase
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class TimedOutException(Exception):
+    pass
+
+
+class ActionModule(ActionBase):
+    TRANSFERS_FILES = False
+    _VALID_ARGS = frozenset((
+        'msg',
+        'delay',
+        'search_paths'
+    ))
+
+    DEFAULT_CONNECT_TIMEOUT = None
+    DEFAULT_PRE_SHUTDOWN_DELAY = 0
+    DEFAULT_SHUTDOWN_MESSAGE = 'Shut down initiated by Ansible'
+    DEFAULT_SHUTDOWN_COMMAND = 'shutdown'
+    DEFAULT_SHUTDOWN_COMMAND_ARGS = '-h {delay_min} "{message}"'
+    DEFAULT_SUDOABLE = True
+
+    SHUTDOWN_COMMANDS = {
+        'alpine': 'poweroff',
+        'vmkernel': 'halt',
+    }
+
+    SHUTDOWN_COMMAND_ARGS = {
+        'alpine': '',
+        'void': '-h +{delay_min} "{message}"',
+        'freebsd': '-h +{delay_sec}s "{message}"',
+        'linux': DEFAULT_SHUTDOWN_COMMAND_ARGS,
+        'macosx': '-h +{delay_min} "{message}"',
+        'openbsd': '-h +{delay_min} "{message}"',
+        'solaris': '-y -g {delay_sec} -i 5 "{message}"',
+        'sunos': '-y -g {delay_sec} -i 5 "{message}"',
+        'vmkernel': '-d {delay_sec}',
+        'aix': '-Fh',
+    }
+
+    def __init__(self, *args, **kwargs):
+        super(ActionModule, self).__init__(*args, **kwargs)
+
+    @property
+    def delay(self):
+        return self._check_delay('delay', self.DEFAULT_PRE_SHUTDOWN_DELAY)
+
+    def _check_delay(self, key, default):
+        """Ensure that the value is positive or zero"""
+        value = int(self._task.args.get(key, default))
+        if value < 0:
+            value = 0
+        return value
+
+    def _get_value_from_facts(self, variable_name, distribution, default_value):
+        """Get dist+version specific args first, then distribution, then family, lastly use default"""
+        attr = getattr(self, variable_name)
+        value = attr.get(
+            distribution['name'] + distribution['version'],
+            attr.get(
+                distribution['name'],
+                attr.get(
+                    distribution['family'],
+                    getattr(self, default_value))))
+        return value
+
+    def get_shutdown_command_args(self, distribution):
+        args = self._get_value_from_facts('SHUTDOWN_COMMAND_ARGS', distribution, 'DEFAULT_SHUTDOWN_COMMAND_ARGS')
+        # Convert seconds to minutes. If less that 60, set it to 0.
+        delay_sec = self.delay
+        shutdown_message = self._task.args.get('msg', self.DEFAULT_SHUTDOWN_MESSAGE)
+        return args.format(delay_sec=delay_sec, delay_min=delay_sec // 60, message=shutdown_message)
+
+    def get_distribution(self, task_vars):
+        # FIXME: only execute the module if we don't already have the facts we need
+        distribution = {}
+        display.debug('{action}: running setup module to get distribution'.format(action=self._task.action))
+        module_output = self._execute_module(
+            task_vars=task_vars,
+            module_name='ansible.legacy.setup',
+            module_args={'gather_subset': 'min'})
+        try:
+            if module_output.get('failed', False):
+                raise AnsibleError('Failed to determine system distribution. {0}, {1}'.format(
+                    to_native(module_output['module_stdout']).strip(),
+                    to_native(module_output['module_stderr']).strip()))
+            distribution['name'] = module_output['ansible_facts']['ansible_distribution'].lower()
+            distribution['version'] = to_text(module_output['ansible_facts']['ansible_distribution_version'].split('.')[0])
+            distribution['family'] = to_text(module_output['ansible_facts']['ansible_os_family'].lower())
+            display.debug("{action}: distribution: {dist}".format(action=self._task.action, dist=distribution))
+            return distribution
+        except KeyError as ke:
+            raise AnsibleError('Failed to get distribution information. Missing "{0}" in output.'.format(ke.args[0]))
+
+    def get_shutdown_command(self, task_vars, distribution):
+        shutdown_bin = self._get_value_from_facts('SHUTDOWN_COMMANDS', distribution, 'DEFAULT_SHUTDOWN_COMMAND')
+        default_search_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']
+        search_paths = self._task.args.get('search_paths', default_search_paths)
+
+        # FIXME: switch all this to user arg spec validation methods when they are available
+        # Convert bare strings to a list
+        if is_string(search_paths):
+            search_paths = [search_paths]
+
+        # Error if we didn't get a list
+        err_msg = "'search_paths' must be a string or flat list of strings, got {0}"
+        try:
+            incorrect_type = any(not is_string(x) for x in search_paths)
+            if not isinstance(search_paths, list) or incorrect_type:
+                raise TypeError
+        except TypeError:
+            raise AnsibleError(err_msg.format(search_paths))
+
+        display.debug('{action}: running find module looking in {paths} to get path for "{command}"'.format(
+            action=self._task.action,
+            command=shutdown_bin,
+            paths=search_paths))
+        find_result = self._execute_module(
+            task_vars=task_vars,
+            # prevent collection search by calling with ansible.legacy (still allows library/ override of find)
+            module_name='ansible.legacy.find',
+            module_args={
+                'paths': search_paths,
+                'patterns': [shutdown_bin],
+                'file_type': 'any'
+            }
+        )
+
+        full_path = [x['path'] for x in find_result['files']]
+        if not full_path:
+            raise AnsibleError('Unable to find command "{0}" in search paths: {1}'.format(shutdown_bin, search_paths))
+        self._shutdown_command = full_path[0]
+        return self._shutdown_command
+
+    def perform_shutdown(self, task_vars, distribution):
+        result = {}
+        shutdown_result = {}
+        shutdown_command = self.get_shutdown_command(task_vars, distribution)
+        shutdown_command_args = self.get_shutdown_command_args(distribution)
+        shutdown_command_exec = '{0} {1}'.format(shutdown_command, shutdown_command_args)
+
+        self.cleanup(force=True)
+        try:
+            display.vvv("{action}: shutting down server...".format(action=self._task.action))
+            display.debug("{action}: shutting down server with command '{command}'".format(action=self._task.action, command=shutdown_command_exec))
+            if self._play_context.check_mode:
+                shutdown_result['rc'] = 0
+            else:
+                shutdown_result = self._low_level_execute_command(shutdown_command_exec, sudoable=self.DEFAULT_SUDOABLE)
+        except AnsibleConnectionFailure as e:
+            # If the connection is closed too quickly due to the system being shutdown, carry on
+            display.debug('{action}: AnsibleConnectionFailure caught and handled: {error}'.format(action=self._task.action, error=to_text(e)))
+            shutdown_result['rc'] = 0
+
+        if shutdown_result['rc'] != 0:
+            result['failed'] = True
+            result['shutdown'] = False
+            result['msg'] = "Shutdown command failed. Error was {stdout}, {stderr}".format(
+                stdout=to_native(shutdown_result['stdout'].strip()),
+                stderr=to_native(shutdown_result['stderr'].strip()))
+            return result
+
+        result['failed'] = False
+        result['shutdown_command'] = shutdown_command_exec
+        return result
+
+    def run(self, tmp=None, task_vars=None):
+        self._supports_check_mode = True
+        self._supports_async = True
+
+        # If running with local connection, fail so we don't shutdown ourself
+        if self._connection.transport == 'local' and (not self._play_context.check_mode):
+            msg = 'Running {0} with local connection would shutdown the control node.'.format(self._task.action)
+            return {'changed': False, 'elapsed': 0, 'shutdown': False, 'failed': True, 'msg': msg}
+
+        if task_vars is None:
+            task_vars = {}
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+
+        if result.get('skipped', False) or result.get('failed', False):
+            return result
+
+        distribution = self.get_distribution(task_vars)
+
+        # Initiate shutdown
+        shutdown_result = self.perform_shutdown(task_vars, distribution)
+
+        if shutdown_result['failed']:
+            result = shutdown_result
+            return result
+
+        result['shutdown'] = True
+        result['changed'] = True
+        result['shutdown_command'] = shutdown_result['shutdown_command']
+
+        return result

plugins/action/voss.py

@@ -1,36 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-from ansible_collections.ansible.netcommon.plugins.action.network import ActionModule as ActionNetworkModule
-
-
-class ActionModule(ActionNetworkModule):
-
-    def run(self, tmp=None, task_vars=None):
-        del tmp  # tmp no longer has any effect
-
-        module_name = self._task.action.split('.')[-1]
-        self._config_module = True if module_name == 'voss_config' else False
-        persistent_connection = self._play_context.connection.split('.')[-1]
-
-        if persistent_connection not in ('network_cli'):
-            return {'failed': True, 'msg': 'Connection type %s is not valid for this module' % self._play_context.connection}
-        return super(ActionModule, self).run(task_vars=task_vars)

plugins/become/doas.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: doas
+    name: doas
     short_description: Do As user
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the doas utility.
@@ -40,7 +40,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_DOAS_EXE
         become_flags:
             description: Options to pass to doas
-            default:
+            default: ''
             ini:
               - section: privilege_escalation
                 key: become_flags
@@ -111,15 +111,14 @@ class BecomeModule(BecomeBase):
 
         self.prompt = True
 
-        become_exe = self.get_option('become_exe') or self.name
+        become_exe = self.get_option('become_exe')
 
-        flags = self.get_option('become_flags') or ''
+        flags = self.get_option('become_flags')
         if not self.get_option('become_pass') and '-n' not in flags:
             flags += ' -n'
 
-        user = self.get_option('become_user') or ''
-        if user:
-            user = '-u %s' % (user)
+        become_user = self.get_option('become_user')
+        user = '-u %s' % (become_user) if become_user else ''
 
         success_cmd = self._build_success_command(cmd, shell, noexe=True)
         executable = getattr(shell, 'executable', shell.SHELL_FAMILY)

plugins/become/dzdo.py

@@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: dzdo
+    name: dzdo
     short_description: Centrify's Direct Authorize
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the dzdo utility.
@@ -82,15 +82,14 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        becomecmd = self.get_option('become_exe') or self.name
+        becomecmd = self.get_option('become_exe')
 
-        flags = self.get_option('become_flags') or ''
+        flags = self.get_option('become_flags')
         if self.get_option('become_pass'):
             self.prompt = '[dzdo via ansible, key=%s] password:' % self._id
             flags = '%s -p "%s"' % (flags.replace('-n', ''), self.prompt)
 
-        user = self.get_option('become_user') or ''
-        if user:
-            user = '-u %s' % (user)
+        become_user = self.get_option('become_user')
+        user = '-u %s' % (become_user) if become_user else ''
 
         return ' '.join([becomecmd, flags, user, self._build_success_command(cmd, shell)])

plugins/become/ksu.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: ksu
+    name: ksu
     short_description: Kerberos substitute user
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the ksu utility.
@@ -113,7 +113,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        exe = self.get_option('become_exe') or self.name
-        flags = self.get_option('become_flags') or ''
-        user = self.get_option('become_user') or ''
+        exe = self.get_option('become_exe')
+
+        flags = self.get_option('become_flags')
+        user = self.get_option('become_user')
         return '%s %s %s -e %s ' % (exe, user, flags, self._build_success_command(cmd, shell))

plugins/become/machinectl.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: machinectl
+    name: machinectl
     short_description: Systemd's machinectl privilege escalation
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the machinectl utility.
@@ -13,6 +13,7 @@ DOCUMENTATION = '''
     options:
         become_user:
             description: User you 'become' to execute the task
+            default: ''
             ini:
               - section: privilege_escalation
                 key: become_user
@@ -80,7 +81,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe') or self.name
-        flags = self.get_option('become_flags') or ''
-        user = self.get_option('become_user') or ''
+        become = self.get_option('become_exe')
+
+        flags = self.get_option('become_flags')
+        user = self.get_option('become_user')
         return '%s -q shell %s %s@ %s' % (become, flags, user, cmd)

plugins/become/pbrun.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: pbrun
+    name: pbrun
     short_description: PowerBroker run
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the pbrun utility.
@@ -41,6 +41,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_PBRUN_EXE
         become_flags:
             description: Options to pass to pbrun
+            default: ''
             ini:
               - section: privilege_escalation
                 key: become_flags
@@ -93,11 +94,11 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        become_exe = self.get_option('become_exe') or self.name
-        flags = self.get_option('become_flags') or ''
-        user = self.get_option('become_user') or ''
-        if user:
-            user = '-u %s' % (user)
+        become_exe = self.get_option('become_exe')
+
+        flags = self.get_option('become_flags')
+        become_user = self.get_option('become_user')
+        user = '-u %s' % (become_user) if become_user else ''
         noexe = not self.get_option('wrap_exe')
 
         return ' '.join([become_exe, flags, user, self._build_success_command(cmd, shell, noexe=noexe)])

plugins/become/pfexec.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: pfexec
+    name: pfexec
     short_description: profile based execution
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the pfexec utility.
@@ -14,7 +14,7 @@ DOCUMENTATION = '''
         become_user:
             description:
                 - User you 'become' to execute the task
-                - This plugin ignores this setting as pfexec uses it's own ``exec_attr`` to figure this out,
+                - This plugin ignores this setting as pfexec uses it's own C(exec_attr) to figure this out,
                   but it is supplied here for Ansible to make decisions needed for the task execution, like file permissions.
             default: root
             ini:
@@ -80,8 +80,8 @@ DOCUMENTATION = '''
               - name: ansible_pfexec_wrap_execution
             env:
               - name: ANSIBLE_PFEXEC_WRAP_EXECUTION
-    note:
-      - This plugin ignores ``become_user`` as pfexec uses it's own ``exec_attr`` to figure this out.
+    notes:
+      - This plugin ignores I(become_user) as pfexec uses it's own C(exec_attr) to figure this out.
 '''
 
 from ansible.plugins.become import BecomeBase
@@ -97,7 +97,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        exe = self.get_option('become_exe') or self.name
+        exe = self.get_option('become_exe')
+
         flags = self.get_option('become_flags')
         noexe = not self.get_option('wrap_exe')
         return '%s %s "%s"' % (exe, flags, self._build_success_command(cmd, shell, noexe=noexe))

plugins/become/pmrun.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: pmrun
+    name: pmrun
     short_description: Privilege Manager run
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the pmrun utility.
@@ -27,6 +27,7 @@ DOCUMENTATION = '''
               - name: ANSIBLE_PMRUN_EXE
         become_flags:
             description: Options to pass to pmrun
+            default: ''
             ini:
               - section: privilege_escalation
                 key: become_flags
@@ -70,6 +71,7 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe') or self.name
-        flags = self.get_option('become_flags') or ''
+        become = self.get_option('become_exe')
+
+        flags = self.get_option('become_flags')
         return '%s %s %s' % (become, flags, shlex_quote(self._build_success_command(cmd, shell)))

plugins/become/sesu.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    become: sesu
+    name: sesu
     short_description: CA Privileged Access Manager
     description:
         - This become plugins allows your remote/login user to execute commands as another user via the sesu utility.
@@ -13,6 +13,7 @@ DOCUMENTATION = '''
     options:
         become_user:
             description: User you 'become' to execute the task
+            default: ''
             ini:
               - section: privilege_escalation
                 key: become_user
@@ -74,7 +75,7 @@ class BecomeModule(BecomeBase):
 
     name = 'community.general.sesu'
 
-    _prompt = 'Please enter your password:'
+    prompt = 'Please enter your password:'
     fail = missing = ('Sorry, try again with sesu.',)
 
     def build_become_command(self, cmd, shell):
@@ -83,7 +84,8 @@ class BecomeModule(BecomeBase):
         if not cmd:
             return cmd
 
-        become = self.get_option('become_exe') or self.name
-        flags = self.get_option('become_flags') or ''
-        user = self.get_option('become_user') or ''
+        become = self.get_option('become_exe')
+
+        flags = self.get_option('become_flags')
+        user = self.get_option('become_user')
         return '%s %s %s -c %s' % (become, flags, user, self._build_success_command(cmd, shell))

plugins/cache/jsonfile.py

@@ -1,62 +0,0 @@
-# (c) 2014, Brian Coca, Josh Drake, et al
-# (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    cache: jsonfile
-    short_description: JSON formatted files.
-    description:
-        - This cache uses JSON formatted, per host, files saved to the filesystem.
-    author: Ansible Core (@ansible-core)
-    options:
-      _uri:
-        required: True
-        description:
-          - Path in which the cache plugin will save the JSON files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-        ini:
-          - key: fact_caching_connection
-            section: defaults
-      _prefix:
-        description: User defined prefix to use when creating the JSON files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-        ini:
-          - key: fact_caching_prefix
-            section: defaults
-      _timeout:
-        default: 86400
-        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-        ini:
-          - key: fact_caching_timeout
-            section: defaults
-        type: integer
-'''
-
-import codecs
-import json
-
-from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder
-from ansible.plugins.cache import BaseFileCacheModule
-
-
-class CacheModule(BaseFileCacheModule):
-    """
-    A caching module backed by json files.
-    """
-
-    def _load(self, filepath):
-        # Valid JSON is always UTF-8 encoded.
-        with codecs.open(filepath, 'r', encoding='utf-8') as f:
-            return json.load(f, cls=AnsibleJSONDecoder)
-
-    def _dump(self, value, filepath):
-        with codecs.open(filepath, 'w', encoding='utf-8') as f:
-            f.write(json.dumps(value, cls=AnsibleJSONEncoder, sort_keys=True, indent=4))

plugins/cache/memcached.py

@@ -6,7 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    cache: memcached
+    author: Unknown (!UNKNOWN)
+    name: memcached
     short_description: Use memcached DB for cache
     description:
         - This cache uses JSON formatted, per host records saved in memcached.
@@ -52,12 +53,14 @@ from ansible import constants as C
 from ansible.errors import AnsibleError
 from ansible.module_utils.common._collections_compat import MutableSet
 from ansible.plugins.cache import BaseCacheModule
+from ansible.release import __version__ as ansible_base_version
 from ansible.utils.display import Display
 
 try:
     import memcache
+    HAS_MEMCACHE = True
 except ImportError:
-    raise AnsibleError("python-memcached is required for the memcached fact cache")
+    HAS_MEMCACHE = False
 
 display = Display()
 
@@ -159,7 +162,7 @@ class CacheModuleKeys(MutableSet):
         self._cache.set(self.PREFIX, self._keyset)
 
     def remove_by_timerange(self, s_min, s_max):
-        for k in self._keyset.keys():
+        for k in list(self._keyset.keys()):
             t = self._keyset[k]
             if s_min < t < s_max:
                 del self._keyset[k]
@@ -178,13 +181,17 @@ class CacheModule(BaseCacheModule):
             self._timeout = self.get_option('_timeout')
             self._prefix = self.get_option('_prefix')
         except KeyError:
-            display.deprecated('Rather than importing CacheModules directly, '
-                               'use ansible.plugins.loader.cache_loader', version='2.12')
+            # TODO: remove once we no longer support Ansible 2.9
+            if not ansible_base_version.startswith('2.9.'):
+                raise AnsibleError("Do not import CacheModules directly. Use ansible.plugins.loader.cache_loader instead.")
             if C.CACHE_PLUGIN_CONNECTION:
                 connection = C.CACHE_PLUGIN_CONNECTION.split(',')
             self._timeout = C.CACHE_PLUGIN_TIMEOUT
             self._prefix = C.CACHE_PLUGIN_PREFIX
 
+        if not HAS_MEMCACHE:
+            raise AnsibleError("python-memcached is required for the memcached fact cache")
+
         self._cache = {}
         self._db = ProxyClientPool(connection, debug=0)
         self._keys = CacheModuleKeys(self._db, self._db.get(CacheModuleKeys.PREFIX) or [])

plugins/cache/pickle.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    cache: pickle
+    name: pickle
     short_description: Pickle formatted files.
     description:
         - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.

plugins/cache/redis.py

@@ -5,7 +5,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    cache: redis
+    author: Unknown (!UNKNOWN)
+    name: redis
     short_description: Use Redis DB for cache
     description:
         - This cache uses JSON formatted, per host records saved in Redis.
@@ -15,6 +16,9 @@ DOCUMENTATION = '''
       _uri:
         description:
           - A colon separated string of connection information for Redis.
+          - The format is C(host:port:db:password), for example C(localhost:6379:0:changeme).
+          - To use encryption in transit, prefix the connection with C(tls://), as in C(tls://localhost:6379:0:changeme).
+          - To use redis sentinel, use separator C(;), for example C(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
         required: True
         env:
           - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
@@ -29,6 +33,23 @@ DOCUMENTATION = '''
         ini:
           - key: fact_caching_prefix
             section: defaults
+      _keyset_name:
+        description: User defined name for cache keyset name.
+        default: ansible_cache_keys
+        env:
+          - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
+        ini:
+          - key: fact_caching_redis_keyset_name
+            section: defaults
+        version_added: 1.3.0
+      _sentinel_service_name:
+        description: The redis sentinel service name (or referenced as cluster name).
+        env:
+          - name: ANSIBLE_CACHE_REDIS_SENTINEL
+        ini:
+          - key: fact_caching_redis_sentinel
+            section: defaults
+        version_added: 1.3.0
       _timeout:
         default: 86400
         description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
@@ -45,14 +66,17 @@ import json
 
 from ansible import constants as C
 from ansible.errors import AnsibleError
+from ansible.module_utils._text import to_native
 from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder
 from ansible.plugins.cache import BaseCacheModule
+from ansible.release import __version__ as ansible_base_version
 from ansible.utils.display import Display
 
 try:
     from redis import StrictRedis, VERSION
+    HAS_REDIS = True
 except ImportError:
-    raise AnsibleError("The 'redis' python module (version 2.4.5 or newer) is required for the redis fact cache, 'pip install redis'")
+    HAS_REDIS = False
 
 display = Display()
 
@@ -66,26 +90,81 @@ class CacheModule(BaseCacheModule):
     to expire keys. This mechanism is used or a pattern matched 'scan' for
     performance.
     """
+    _sentinel_service_name = None
+
     def __init__(self, *args, **kwargs):
-        connection = []
+        uri = ''
 
         try:
             super(CacheModule, self).__init__(*args, **kwargs)
             if self.get_option('_uri'):
-                connection = self.get_option('_uri').split(':')
+                uri = self.get_option('_uri')
             self._timeout = float(self.get_option('_timeout'))
             self._prefix = self.get_option('_prefix')
+            self._keys_set = self.get_option('_keyset_name')
+            self._sentinel_service_name = self.get_option('_sentinel_service_name')
         except KeyError:
-            display.deprecated('Rather than importing CacheModules directly, '
-                               'use ansible.plugins.loader.cache_loader', version='2.12')
+            # TODO: remove once we no longer support Ansible 2.9
+            if not ansible_base_version.startswith('2.9.'):
+                raise AnsibleError("Do not import CacheModules directly. Use ansible.plugins.loader.cache_loader instead.")
             if C.CACHE_PLUGIN_CONNECTION:
-                connection = C.CACHE_PLUGIN_CONNECTION.split(':')
+                uri = C.CACHE_PLUGIN_CONNECTION
             self._timeout = float(C.CACHE_PLUGIN_TIMEOUT)
             self._prefix = C.CACHE_PLUGIN_PREFIX
+            self._keys_set = 'ansible_cache_keys'
+
+        if not HAS_REDIS:
+            raise AnsibleError("The 'redis' python module (version 2.4.5 or newer) is required for the redis fact cache, 'pip install redis'")
 
         self._cache = {}
-        self._db = StrictRedis(*connection)
-        self._keys_set = 'ansible_cache_keys'
+        kw = {}
+
+        # tls connection
+        tlsprefix = 'tls://'
+        if uri.startswith(tlsprefix):
+            kw['ssl'] = True
+            uri = uri[len(tlsprefix):]
+
+        # redis sentinel connection
+        if self._sentinel_service_name:
+            self._db = self._get_sentinel_connection(uri, kw)
+        # normal connection
+        else:
+            connection = uri.split(':')
+            self._db = StrictRedis(*connection, **kw)
+
+        display.vv('Redis connection: %s' % self._db)
+
+    def _get_sentinel_connection(self, uri, kw):
+        """
+        get sentinel connection details from _uri
+        """
+        try:
+            from redis.sentinel import Sentinel
+        except ImportError:
+            raise AnsibleError("The 'redis' python module (version 2.9.0 or newer) is required to use redis sentinel.")
+
+        if ';' not in uri:
+            raise AnsibleError('_uri does not have sentinel syntax.')
+
+        # format: "localhost:26379;localhost2:26379;0:changeme"
+        connections = uri.split(';')
+        connection_args = connections.pop(-1)
+        if len(connection_args) > 0:  # hanle if no db nr is given
+            connection_args = connection_args.split(':')
+            kw['db'] = connection_args.pop(0)
+            try:
+                kw['password'] = connection_args.pop(0)
+            except IndexError:
+                pass  # password is optional
+
+        sentinels = [tuple(shost.split(':')) for shost in connections]
+        display.vv('\nUsing redis sentinels: %s' % sentinels)
+        scon = Sentinel(sentinels, **kw)
+        try:
+            return scon.master_for(self._sentinel_service_name, socket_timeout=0.2)
+        except Exception as exc:
+            raise AnsibleError('Could not connect to redis sentinel: %s' % to_native(exc))
 
     def _make_key(self, key):
         return self._prefix + key
@@ -138,14 +217,12 @@ class CacheModule(BaseCacheModule):
         self._db.zrem(self._keys_set, key)
 
     def flush(self):
-        for key in self.keys():
+        for key in list(self.keys()):
             self.delete(key)
 
     def copy(self):
         # TODO: there is probably a better way to do this in redis
-        ret = dict()
-        for key in self.keys():
-            ret[key] = self.get(key)
+        ret = dict([(k, self.get(k)) for k in self.keys()])
         return ret
 
     def __getstate__(self):

plugins/cache/yaml.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    cache: yaml
+    name: yaml
     short_description: YAML formatted files.
     description:
         - This cache uses YAML formatted, per host, files saved to the filesystem.

plugins/callback/actionable.py

@@ -1,60 +0,0 @@
-# (c) 2015, Andrew Gaffney <andrew@agaffney.org>
-# (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    callback: actionable
-    type: stdout
-    short_description: shows only items that need attention
-    description:
-      - Use this callback when you dont care about OK nor Skipped.
-      - This callback suppresses any non Failed or Changed status.
-    deprecated:
-        why: The 'default' callback plugin now supports this functionality
-        removed_in: '2.11'
-        alternative: "'default' callback plugin with 'display_skipped_hosts = no' and 'display_ok_hosts = no' options"
-    extends_documentation_fragment:
-      - default_callback
-    requirements:
-      - set as stdout callback in configuration
-    # Override defaults from 'default' callback plugin
-    options:
-      display_skipped_hosts:
-        name: Show skipped hosts
-        description: "Toggle to control displaying skipped task/host results in a task"
-        type: bool
-        default: no
-        env:
-          - name: DISPLAY_SKIPPED_HOSTS
-            deprecated:
-              why: environment variables without "ANSIBLE_" prefix are deprecated
-              version: "2.12"
-              alternatives: the "ANSIBLE_DISPLAY_SKIPPED_HOSTS" environment variable
-          - name: ANSIBLE_DISPLAY_SKIPPED_HOSTS
-        ini:
-          - key: display_skipped_hosts
-            section: defaults
-      display_ok_hosts:
-        name: Show 'ok' hosts
-        description: "Toggle to control displaying 'ok' task/host results in a task"
-        type: bool
-        default: no
-        env:
-          - name: ANSIBLE_DISPLAY_OK_HOSTS
-        ini:
-          - key: display_ok_hosts
-            section: defaults
-'''
-
-from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
-
-
-class CallbackModule(CallbackModule_default):
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.actionable'

plugins/callback/cgroup_memory_recap.py

@@ -6,13 +6,10 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
-                    'supported_by': 'community'}
-
 DOCUMENTATION = '''
-    callback: cgroup_memory_recap
-    callback_type: aggregate
+    author: Unknown (!UNKNOWN)
+    name: cgroup_memory_recap
+    type: aggregate
     requirements:
       - whitelist in configuration
       - cgroups

plugins/callback/context_demo.py

@@ -6,7 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: context_demo
+    author: Unknown (!UNKNOWN)
+    name: context_demo
     type: aggregate
     short_description: demo callback that adds play/task context
     description:

plugins/callback/counter_enabled.py

@@ -6,14 +6,10 @@
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
-from ansible import constants as C
-from ansible.plugins.callback import CallbackBase
-from ansible.utils.color import colorize, hostcolor
-from ansible.template import Templar
-from ansible.playbook.task_include import TaskInclude
 
 DOCUMENTATION = '''
-    callback: counter_enabled
+    author: Unknown (!UNKNOWN)
+    name: counter_enabled
     type: stdout
     short_description: adds counters to the output items (tasks and hosts/task)
     description:
@@ -26,6 +22,12 @@ DOCUMENTATION = '''
       - set as stdout callback in ansible.cfg  (stdout_callback = counter_enabled)
 '''
 
+from ansible import constants as C
+from ansible.plugins.callback import CallbackBase
+from ansible.utils.color import colorize, hostcolor
+from ansible.template import Templar
+from ansible.playbook.task_include import TaskInclude
+
 
 class CallbackModule(CallbackBase):
 

plugins/callback/dense.py

@@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-callback: dense
+name: dense
 type: stdout
 short_description: minimal stdout output
 extends_documentation_fragment:
@@ -144,7 +144,7 @@ colors = dict(
 states = ('skipped', 'ok', 'changed', 'failed', 'unreachable')
 
 
-class CallbackModule_dense(CallbackModule_default):
+class CallbackModule(CallbackModule_default):
 
     '''
     This is the dense callback interface, where screen estate is still valued.
@@ -497,5 +497,3 @@ class CallbackModule_dense(CallbackModule_default):
 # When using -vv or higher, simply do the default action
 if display.verbosity >= 2 or not HAS_OD:
     CallbackModule = CallbackModule_default
-else:
-    CallbackModule = CallbackModule_dense

plugins/callback/full_skip.py

@@ -1,75 +0,0 @@
-# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
-# (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    callback: full_skip
-    type: stdout
-    short_description: suppresses tasks if all hosts skipped
-    description:
-      - Use this plugin when you do not care about any output for tasks that were completely skipped
-    deprecated:
-        why: The 'default' callback plugin now supports this functionality
-        removed_in: '2.11'
-        alternative: "'default' callback plugin with 'display_skipped_hosts = no' option"
-    extends_documentation_fragment:
-      - default_callback
-    requirements:
-      - set as stdout in configuration
-'''
-
-from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
-
-
-class CallbackModule(CallbackModule_default):
-
-    '''
-    This is the default callback interface, which simply prints messages
-    to stdout when new callback events are received.
-    '''
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.full_skip'
-
-    def v2_runner_on_skipped(self, result):
-        self.outlines = []
-
-    def v2_playbook_item_on_skipped(self, result):
-        self.outlines = []
-
-    def v2_runner_item_on_skipped(self, result):
-        self.outlines = []
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-        self.display()
-        super(CallbackModule, self).v2_runner_on_failed(result, ignore_errors)
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        self.outlines = []
-        self.outlines.append("TASK [%s]" % task.get_name().strip())
-        if self._display.verbosity >= 2:
-            path = task.get_path()
-            if path:
-                self.outlines.append("task path: %s" % path)
-
-    def v2_playbook_item_on_ok(self, result):
-        self.display()
-        super(CallbackModule, self).v2_playbook_item_on_ok(result)
-
-    def v2_runner_on_ok(self, result):
-        self.display()
-        super(CallbackModule, self).v2_runner_on_ok(result)
-
-    def display(self):
-        if len(self.outlines) == 0:
-            return
-        (first, rest) = self.outlines[0], self.outlines[1:]
-        self._display.banner(first)
-        for line in rest:
-            self._display.display(line)
-        self.outlines = []

plugins/callback/hipchat.py

@@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: hipchat
-    callback_type: notification
+    author: Unknown (!UNKNOWN)
+    name: hipchat
+    type: notification
     requirements:
       - whitelist in configuration.
       - prettytable (python lib)
@@ -172,8 +173,7 @@ class CallbackModule(CallbackBase):
         # Displays info about playbook being started by a person on an
         # inventory, as well as Tags, Skip Tags and Limits
         if not self.printed_playbook:
-            self.playbook_name, _ = os.path.splitext(
-                os.path.basename(self.play.playbook.filename))
+            self.playbook_name, dummy = os.path.splitext(os.path.basename(self.play.playbook.filename))
             host_list = self.play.playbook.inventory.host_list
             inventory = os.path.basename(os.path.realpath(host_list))
             self.send_msg("%s: Playbook initiated by %s against %s" %

plugins/callback/jabber.py

@@ -6,7 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: jabber
+    author: Unknown (!UNKNOWN)
+    name: jabber
     type: notification
     short_description: post task events to a jabber server
     description:

plugins/callback/log_plays.py

@@ -6,7 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: log_plays
+    author: Unknown (!UNKNOWN)
+    name: log_plays
     type: notification
     short_description: write playbook output to log file
     description:
@@ -53,7 +54,7 @@ class CallbackModule(CallbackBase):
     CALLBACK_NEEDS_WHITELIST = True
 
     TIME_FORMAT = "%b %d %Y %H:%M:%S"
-    MSG_FORMAT = "%(now)s - %(category)s - %(data)s\n\n"
+    MSG_FORMAT = "%(now)s - %(playbook)s - %(task_name)s - %(task_action)s - %(category)s - %(data)s\n\n"
 
     def __init__(self):
 
@@ -67,7 +68,8 @@ class CallbackModule(CallbackBase):
         if not os.path.exists(self.log_folder):
             makedirs_safe(self.log_folder)
 
-    def log(self, host, category, data):
+    def log(self, result, category):
+        data = result._result
         if isinstance(data, MutableMapping):
             if '_ansible_verbose_override' in data:
                 # avoid logging extraneous data
@@ -79,30 +81,43 @@ class CallbackModule(CallbackBase):
                 if invocation is not None:
                     data = json.dumps(invocation) + " => %s " % data
 
-        path = os.path.join(self.log_folder, host)
+        path = os.path.join(self.log_folder, result._host.get_name())
         now = time.strftime(self.TIME_FORMAT, time.localtime())
 
-        msg = to_bytes(self.MSG_FORMAT % dict(now=now, category=category, data=data))
+        msg = to_bytes(
+            self.MSG_FORMAT
+            % dict(
+                now=now,
+                playbook=self.playbook,
+                task_name=result._task.name,
+                task_action=result._task.action,
+                category=category,
+                data=data,
+            )
+        )
         with open(path, "ab") as fd:
             fd.write(msg)
 
-    def runner_on_failed(self, host, res, ignore_errors=False):
-        self.log(host, 'FAILED', res)
+    def v2_runner_on_failed(self, result, ignore_errors=False):
+        self.log(result, 'FAILED')
 
-    def runner_on_ok(self, host, res):
-        self.log(host, 'OK', res)
+    def v2_runner_on_ok(self, result):
+        self.log(result, 'OK')
 
-    def runner_on_skipped(self, host, item=None):
-        self.log(host, 'SKIPPED', '...')
+    def v2_runner_on_skipped(self, result):
+        self.log(result, 'SKIPPED')
 
-    def runner_on_unreachable(self, host, res):
-        self.log(host, 'UNREACHABLE', res)
+    def v2_runner_on_unreachable(self, result):
+        self.log(result, 'UNREACHABLE')
 
-    def runner_on_async_failed(self, host, res, jid):
-        self.log(host, 'ASYNC_FAILED', res)
+    def v2_runner_on_async_failed(self, result):
+        self.log(result, 'ASYNC_FAILED')
 
-    def playbook_on_import_for_host(self, host, imported_file):
-        self.log(host, 'IMPORTED', imported_file)
+    def v2_playbook_on_start(self, playbook):
+        self.playbook = playbook._file_name
 
-    def playbook_on_not_import_for_host(self, host, missing_file):
-        self.log(host, 'NOTIMPORTED', missing_file)
+    def v2_playbook_on_import_for_host(self, result, imported_file):
+        self.log(result, 'IMPORTED', imported_file)
+
+    def v2_playbook_on_not_import_for_host(self, result, missing_file):
+        self.log(result, 'NOTIMPORTED', missing_file)

plugins/callback/logdna.py

@@ -5,8 +5,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: logdna
-    callback_type: aggregate
+    author: Unknown (!UNKNOWN)
+    name: logdna
+    type: aggregate
     short_description: Sends playbook logs to LogDNA
     description:
       - This callback will report logs from playbook actions, tasks, and events to LogDNA (https://app.logdna.com)

plugins/callback/logentries.py

@@ -5,7 +5,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: logentries
+    author: Unknown (!UNKNOWN)
+    name: logentries
     type: notification
     short_description: Sends events to Logentries
     description:
@@ -75,7 +76,7 @@ examples: >
   To enable, add this to your ansible.cfg file in the defaults block
 
     [defaults]
-    callback_whitelist = logentries
+    callback_whitelist = community.general.logentries
 
   Either set the environment variables
     export LOGENTRIES_API=data.logentries.com

plugins/callback/logstash.py

@@ -1,12 +1,13 @@
-# (C) 2016, Ievgen Khmelenko <ujenmr@gmail.com>
+# (C) 2020, Yevhen Khmelenko <ujenmr@gmail.com>
 # (C) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    callback: logstash
+DOCUMENTATION = r'''
+    author: Yevhen Khmelenko (@ujenmr)
+    name: logstash
     type: notification
     short_description: Sends events to Logstash
     description:
@@ -19,26 +20,83 @@ DOCUMENTATION = '''
         description: Address of the Logstash server
         env:
           - name: LOGSTASH_SERVER
+        ini:
+          - section: callback_logstash
+            key: server
+            version_added: 1.0.0
         default: localhost
       port:
         description: Port on which logstash is listening
         env:
             - name: LOGSTASH_PORT
+        ini:
+          - section: callback_logstash
+            key: port
+            version_added: 1.0.0
         default: 5000
       type:
         description: Message type
         env:
           - name: LOGSTASH_TYPE
+        ini:
+          - section: callback_logstash
+            key: type
+            version_added: 1.0.0
         default: ansible
+      pre_command:
+        description: Executes command before run and result put to ansible_pre_command_output field.
+        version_added: 2.0.0
+        ini:
+          - section: callback_logstash
+            key: pre_command
+        env:
+          - name: LOGSTASH_PRE_COMMAND
+      format_version:
+        description: Logging format
+        type: str
+        version_added: 2.0.0
+        ini:
+          - section: callback_logstash
+            key: format_version
+        env:
+          - name: LOGSTASH_FORMAT_VERSION
+        default: v1
+        choices:
+          - v1
+          - v2
+
+'''
+
+EXAMPLES = r'''
+ansible.cfg: |
+    # Enable Callback plugin
+    [defaults]
+        callback_whitelist = community.general.logstash
+
+    [callback_logstash]
+        server = logstash.example.com
+        port = 5000
+        pre_command = git rev-parse HEAD
+        type = ansible
+
+11-input-tcp.conf: |
+    # Enable Logstash TCP Input
+    input {
+            tcp {
+                port => 5000
+                codec => json
+                add_field => { "[@metadata][beat]" => "notify" }
+                add_field => { "[@metadata][type]" => "ansible" }
+            }
+        }
 '''
 
 import os
 import json
 import socket
 import uuid
-from datetime import datetime
-
 import logging
+from datetime import datetime
 
 try:
     import logstash
@@ -50,29 +108,6 @@ from ansible.plugins.callback import CallbackBase
 
 
 class CallbackModule(CallbackBase):
-    """
-    ansible logstash callback plugin
-    ansible.cfg:
-        callback_plugins   = <path_to_callback_plugins_folder>
-        callback_whitelist = logstash
-    and put the plugin in <path_to_callback_plugins_folder>
-
-    logstash config:
-        input {
-            tcp {
-                port => 5000
-                codec => json
-            }
-        }
-
-    Requires:
-        python-logstash
-
-    This plugin makes use of the following environment variables:
-        LOGSTASH_SERVER   (optional): defaults to localhost
-        LOGSTASH_PORT     (optional): defaults to 5000
-        LOGSTASH_TYPE     (optional): defaults to ansible
-    """
 
     CALLBACK_VERSION = 2.0
     CALLBACK_TYPE = 'aggregate'
@@ -84,35 +119,67 @@ class CallbackModule(CallbackBase):
 
         if not HAS_LOGSTASH:
             self.disabled = True
-            self._display.warning("The required python-logstash is not installed. "
-                                  "pip install python-logstash")
-        else:
+            self._display.warning("The required python-logstash/python3-logstash is not installed. "
+                                  "pip install python-logstash for Python 2"
+                                  "pip install python3-logstash for Python 3")
+
+        self.start_time = datetime.utcnow()
+
+    def _init_plugin(self):
+        if not self.disabled:
             self.logger = logging.getLogger('python-logstash-logger')
             self.logger.setLevel(logging.DEBUG)
 
             self.handler = logstash.TCPLogstashHandler(
-                os.getenv('LOGSTASH_SERVER', 'localhost'),
-                int(os.getenv('LOGSTASH_PORT', 5000)),
+                self.ls_server,
+                self.ls_port,
                 version=1,
-                message_type=os.getenv('LOGSTASH_TYPE', 'ansible')
+                message_type=self.ls_type
             )
 
             self.logger.addHandler(self.handler)
             self.hostname = socket.gethostname()
-            self.session = str(uuid.uuid1())
+            self.session = str(uuid.uuid4())
             self.errors = 0
-        self.start_time = datetime.utcnow()
+
+            self.base_data = {
+                'session': self.session,
+                'host': self.hostname
+            }
+
+            if self.ls_pre_command is not None:
+                self.base_data['ansible_pre_command_output'] = os.popen(
+                    self.ls_pre_command).read()
+
+            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)
+
+        self.ls_server = self.get_option('server')
+        self.ls_port = int(self.get_option('port'))
+        self.ls_type = self.get_option('type')
+        self.ls_pre_command = self.get_option('pre_command')
+        self.ls_format_version = self.get_option('format_version')
+
+        self._init_plugin()
 
     def v2_playbook_on_start(self, playbook):
-        self.playbook = playbook._file_name
-        data = {
-            'status': "OK",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "start",
-            'ansible_playbook': self.playbook,
-        }
-        self.logger.info("ansible start", extra=data)
+        data = self.base_data.copy()
+        data['ansible_type'] = "start"
+        data['status'] = "OK"
+        data['ansible_playbook'] = playbook._file_name
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info(
+                "START PLAYBOOK | %s", data['ansible_playbook'], extra=data
+            )
+        else:
+            self.logger.info("ansible start", extra=data)
 
     def v2_playbook_on_stats(self, stats):
         end_time = datetime.utcnow()
@@ -126,103 +193,201 @@ class CallbackModule(CallbackBase):
         else:
             status = "FAILED"
 
-        data = {
-            'status': status,
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "finish",
-            'ansible_playbook': self.playbook,
-            'ansible_playbook_duration': runtime.total_seconds(),
-            'ansible_result': json.dumps(summarize_stat),
-        }
-        self.logger.info("ansible stats", extra=data)
+        data = self.base_data.copy()
+        data['ansible_type'] = "finish"
+        data['status'] = status
+        data['ansible_playbook_duration'] = runtime.total_seconds()
+        data['ansible_result'] = json.dumps(summarize_stat)  # deprecated field
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info(
+                "FINISH PLAYBOOK | %s", json.dumps(summarize_stat), extra=data
+            )
+        else:
+            self.logger.info("ansible stats", extra=data)
+
+    def v2_playbook_on_play_start(self, play):
+        self.play_id = str(play._uuid)
+
+        if play.name:
+            self.play_name = play.name
+
+        data = self.base_data.copy()
+        data['ansible_type'] = "start"
+        data['status'] = "OK"
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info("START PLAY | %s", self.play_name, extra=data)
+        else:
+            self.logger.info("ansible play", extra=data)
+
+    def v2_playbook_on_task_start(self, task, is_conditional):
+        self.task_id = str(task._uuid)
+
+    '''
+    Tasks and handler tasks are dealt with here
+    '''
 
     def v2_runner_on_ok(self, result, **kwargs):
-        data = {
-            'status': "OK",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "task",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'ansible_task': result._task,
-            'ansible_result': self._dump_results(result._result)
-        }
-        self.logger.info("ansible ok", extra=data)
+        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+
+        data = self.base_data.copy()
+        if task_name == 'setup':
+            data['ansible_type'] = "setup"
+            data['status'] = "OK"
+            data['ansible_host'] = result._host.name
+            data['ansible_play_id'] = self.play_id
+            data['ansible_play_name'] = self.play_name
+            data['ansible_task'] = task_name
+            data['ansible_facts'] = self._dump_results(result._result)
+
+            if (self.ls_format_version == "v2"):
+                self.logger.info(
+                    "SETUP FACTS | %s", self._dump_results(result._result), extra=data
+                )
+            else:
+                self.logger.info("ansible facts", extra=data)
+        else:
+            if 'changed' in result._result.keys():
+                data['ansible_changed'] = result._result['changed']
+            else:
+                data['ansible_changed'] = False
+
+            data['ansible_type'] = "task"
+            data['status'] = "OK"
+            data['ansible_host'] = result._host.name
+            data['ansible_play_id'] = self.play_id
+            data['ansible_play_name'] = self.play_name
+            data['ansible_task'] = task_name
+            data['ansible_task_id'] = self.task_id
+            data['ansible_result'] = self._dump_results(result._result)
+
+            if (self.ls_format_version == "v2"):
+                self.logger.info(
+                    "TASK OK | %s | RESULT | %s",
+                    task_name, self._dump_results(result._result), extra=data
+                )
+            else:
+                self.logger.info("ansible ok", extra=data)
 
     def v2_runner_on_skipped(self, result, **kwargs):
-        data = {
-            'status': "SKIPPED",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "task",
-            'ansible_playbook': self.playbook,
-            'ansible_task': result._task,
-            'ansible_host': result._host.name
-        }
-        self.logger.info("ansible skipped", extra=data)
+        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+
+        data = self.base_data.copy()
+        data['ansible_type'] = "task"
+        data['status'] = "SKIPPED"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['ansible_task'] = task_name
+        data['ansible_task_id'] = self.task_id
+        data['ansible_result'] = self._dump_results(result._result)
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info("TASK SKIPPED | %s", task_name, extra=data)
+        else:
+            self.logger.info("ansible skipped", extra=data)
 
     def v2_playbook_on_import_for_host(self, result, imported_file):
-        data = {
-            'status': "IMPORTED",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "import",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'imported_file': imported_file
-        }
-        self.logger.info("ansible import", extra=data)
+        data = self.base_data.copy()
+        data['ansible_type'] = "import"
+        data['status'] = "IMPORTED"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['imported_file'] = imported_file
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info("IMPORT | %s", imported_file, extra=data)
+        else:
+            self.logger.info("ansible import", extra=data)
 
     def v2_playbook_on_not_import_for_host(self, result, missing_file):
-        data = {
-            'status': "NOT IMPORTED",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "import",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'missing_file': missing_file
-        }
-        self.logger.info("ansible import", extra=data)
+        data = self.base_data.copy()
+        data['ansible_type'] = "import"
+        data['status'] = "NOT IMPORTED"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['imported_file'] = missing_file
+
+        if (self.ls_format_version == "v2"):
+            self.logger.info("NOT IMPORTED | %s", missing_file, extra=data)
+        else:
+            self.logger.info("ansible import", extra=data)
 
     def v2_runner_on_failed(self, result, **kwargs):
-        data = {
-            'status': "FAILED",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "task",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'ansible_task': result._task,
-            'ansible_result': self._dump_results(result._result)
-        }
+        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+
+        data = self.base_data.copy()
+        if 'changed' in result._result.keys():
+            data['ansible_changed'] = result._result['changed']
+        else:
+            data['ansible_changed'] = False
+
+        data['ansible_type'] = "task"
+        data['status'] = "FAILED"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['ansible_task'] = task_name
+        data['ansible_task_id'] = self.task_id
+        data['ansible_result'] = self._dump_results(result._result)
+
         self.errors += 1
-        self.logger.error("ansible failed", extra=data)
+        if (self.ls_format_version == "v2"):
+            self.logger.error(
+                "TASK FAILED | %s | HOST | %s | RESULT | %s",
+                task_name, self.hostname,
+                self._dump_results(result._result), extra=data
+            )
+        else:
+            self.logger.error("ansible failed", extra=data)
 
     def v2_runner_on_unreachable(self, result, **kwargs):
-        data = {
-            'status': "UNREACHABLE",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "task",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'ansible_task': result._task,
-            'ansible_result': self._dump_results(result._result)
-        }
-        self.logger.error("ansible unreachable", extra=data)
+        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+
+        data = self.base_data.copy()
+        data['ansible_type'] = "task"
+        data['status'] = "UNREACHABLE"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['ansible_task'] = task_name
+        data['ansible_task_id'] = self.task_id
+        data['ansible_result'] = self._dump_results(result._result)
+
+        self.errors += 1
+        if (self.ls_format_version == "v2"):
+            self.logger.error(
+                "UNREACHABLE | %s | HOST | %s | RESULT | %s",
+                task_name, self.hostname,
+                self._dump_results(result._result), extra=data
+            )
+        else:
+            self.logger.error("ansible unreachable", extra=data)
 
     def v2_runner_on_async_failed(self, result, **kwargs):
-        data = {
-            'status': "FAILED",
-            'host': self.hostname,
-            'session': self.session,
-            'ansible_type': "task",
-            'ansible_playbook': self.playbook,
-            'ansible_host': result._host.name,
-            'ansible_task': result._task,
-            'ansible_result': self._dump_results(result._result)
-        }
+        task_name = str(result._task).replace('TASK: ', '').replace('HANDLER: ', '')
+
+        data = self.base_data.copy()
+        data['ansible_type'] = "task"
+        data['status'] = "FAILED"
+        data['ansible_host'] = result._host.name
+        data['ansible_play_id'] = self.play_id
+        data['ansible_play_name'] = self.play_name
+        data['ansible_task'] = task_name
+        data['ansible_task_id'] = self.task_id
+        data['ansible_result'] = self._dump_results(result._result)
+
         self.errors += 1
-        self.logger.error("ansible async", extra=data)
+        if (self.ls_format_version == "v2"):
+            self.logger.error(
+                "ASYNC FAILED | %s | HOST | %s | RESULT | %s",
+                task_name, self.hostname,
+                self._dump_results(result._result), extra=data
+            )
+        else:
+            self.logger.error("ansible async", extra=data)

plugins/callback/mail.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-callback: mail
+name: mail
 type: notification
 short_description: Sends failure events via email
 description:
@@ -52,7 +52,7 @@ options:
     ini:
         - section: callback_mail
           key: bcc
-note:
+notes:
 - "TODO: expand configuration options now that plugins can leverage Ansible's configuration"
 '''
 

plugins/callback/nrdp.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: nrdp
+    name: nrdp
     type: notification
     author: "Remi VERCHERE (@rverchere)"
     short_description: post task result to a nagios server through nrdp

plugins/callback/null.py

@@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: 'null'
-    callback_type: stdout
+    author: Unknown (!UNKNOWN)
+    name: 'null'
+    type: stdout
     requirements:
       - set as main display callback
     short_description: Don't display stuff to screen

plugins/callback/say.py

@@ -7,7 +7,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: say
+    author: Unknown (!UNKNOWN)
+    name: say
     type: notification
     requirements:
       - whitelisting in configuration
@@ -16,7 +17,7 @@ DOCUMENTATION = '''
     description:
       - This plugin will use the 'say' or 'espeak' program to "speak" about play events.
     notes:
-      - In 2.8, this callback has been renamed from C(osx_say) into M(say).
+      - In 2.8, this callback has been renamed from C(osx_say) into M(community.general.say).
 '''
 
 import distutils.spawn

plugins/callback/selective.py

@@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: selective
-    callback_type: stdout
+    author: Unknown (!UNKNOWN)
+    name: selective
+    type: stdout
     requirements:
       - set as main display callback
     short_description: only print certain tasks
@@ -30,8 +31,8 @@ DOCUMENTATION = '''
 '''
 
 EXAMPLES = """
-  - debug: msg="This will not be printed"
-  - debug: msg="But this will"
+  - ansible.builtin.debug: msg="This will not be printed"
+  - ansible.builtin.debug: msg="But this will"
     tags: [print_action]
 """
 
@@ -40,7 +41,16 @@ import difflib
 from ansible import constants as C
 from ansible.plugins.callback import CallbackBase
 from ansible.module_utils._text import to_text
-from ansible.utils.color import codeCodes
+
+try:
+    codeCodes = C.COLOR_CODES
+except AttributeError:
+    # This constant was moved to ansible.constants in
+    # https://github.com/ansible/ansible/commit/1202dd000f10b0e8959019484f1c3b3f9628fc67
+    # (will be included in ansible-core 2.11.0). For older Ansible/ansible-base versions,
+    # we include from the original location.
+    from ansible.utils.color import codeCodes
+
 
 DONT_COLORIZE = False
 COLORS = {
@@ -57,7 +67,7 @@ COLORS = {
 
 def dict_diff(prv, nxt):
     """Return a dict of keys that differ with another config object."""
-    keys = set(prv.keys() + nxt.keys())
+    keys = set(list(prv.keys()) + list(nxt.keys()))
     result = {}
     for k in keys:
         if prv.get(k) != nxt.get(k):
@@ -201,7 +211,7 @@ class CallbackModule(CallbackBase):
                                      )
             if 'results' in result._result:
                 for r in result._result['results']:
-                    failed = 'failed' in r
+                    failed = 'failed' in r and r['failed']
 
                     stderr = [r.get('exception', None), r.get('module_stderr', None)]
                     stderr = "\n".join([e for e in stderr if e]).strip()

plugins/callback/slack.py

@@ -7,8 +7,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: slack
-    callback_type: notification
+    author: Unknown (!UNKNOWN)
+    name: slack
+    type: notification
     requirements:
       - whitelist in configuration
       - prettytable (python library)

plugins/callback/splunk.py

@@ -18,10 +18,10 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: splunk
+    name: splunk
     type: aggregate
     short_description: Sends task result events to Splunk HTTP Event Collector
-    author: "Stuart Hirst <support@convergingdata.com>"
+    author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
     description:
       - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
       - The companion Splunk Monitoring & Diagnostics App is available here "https://splunkbase.splunk.com/app/4023/"
@@ -45,13 +45,36 @@ DOCUMENTATION = '''
         ini:
           - section: callback_splunk
             key: authtoken
+      validate_certs:
+        description: Whether to validate certificates for connections to HEC. It is not recommended to set to
+                     C(false) except when you are sure that nobody can intercept the connection
+                     between this plugin and HEC, as setting it to C(false) allows man-in-the-middle attacks!
+        env:
+          - name: SPLUNK_VALIDATE_CERTS
+        ini:
+          - section: callback_splunk
+            key: validate_certs
+        type: bool
+        default: true
+        version_added: '1.0.0'
+      include_milliseconds:
+        description: Whether to include milliseconds as part of the generated timestamp field in the event
+                     sent to the Splunk HTTP collector
+        env:
+          - name: SPLUNK_INCLUDE_MILLISECONDS
+        ini:
+          - section: callback_splunk
+            key: include_milliseconds
+        type: bool
+        default: false
+        version_added: 2.0.0
 '''
 
 EXAMPLES = '''
 examples: >
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
-    callback_whitelist = splunk
+    callback_whitelist = community.general.splunk
   Set the environment variable
     export SPLUNK_URL=http://mysplunkinstance.datapaas.io:8088/services/collector/event
     export SPLUNK_AUTHTOKEN=f23blad6-5965-4537-bf69-5b5a545blabla88
@@ -84,7 +107,7 @@ class SplunkHTTPCollectorSource(object):
         self.ip_address = socket.gethostbyname(socket.gethostname())
         self.user = getpass.getuser()
 
-    def send_event(self, url, authtoken, state, result, runtime):
+    def send_event(self, url, authtoken, validate_certs, include_milliseconds, state, result, runtime):
         if result._task_fields['args'].get('_ansible_check_mode') is True:
             self.ansible_check_mode = True
 
@@ -104,8 +127,13 @@ class SplunkHTTPCollectorSource(object):
         data['uuid'] = result._task._uuid
         data['session'] = self.session
         data['status'] = state
-        data['timestamp'] = datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S '
-                                                       '+0000')
+
+        if include_milliseconds:
+            time_format = '%Y-%m-%d %H:%M:%S.%f +0000'
+        else:
+            time_format = '%Y-%m-%d %H:%M:%S +0000'
+
+        data['timestamp'] = datetime.utcnow().strftime(time_format)
         data['host'] = self.host
         data['ip_address'] = self.ip_address
         data['user'] = self.user
@@ -129,7 +157,8 @@ class SplunkHTTPCollectorSource(object):
                 'Content-type': 'application/json',
                 'Authorization': 'Splunk ' + authtoken
             },
-            method='POST'
+            method='POST',
+            validate_certs=validate_certs
         )
 
 
@@ -144,6 +173,8 @@ class CallbackModule(CallbackBase):
         self.start_datetimes = {}  # Collect task start times
         self.url = None
         self.authtoken = None
+        self.validate_certs = None
+        self.include_milliseconds = None
         self.splunk = SplunkHTTPCollectorSource()
 
     def _runtime(self, result):
@@ -153,7 +184,9 @@ class CallbackModule(CallbackBase):
         ).total_seconds()
 
     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)
+        super(CallbackModule, self).set_options(task_keys=task_keys,
+                                                var_options=var_options,
+                                                direct=direct)
 
         self.url = self.get_option('url')
 
@@ -175,6 +208,10 @@ class CallbackModule(CallbackBase):
                                   '`SPLUNK_AUTHTOKEN` environment variable or '
                                   'in the ansible.cfg file.')
 
+        self.validate_certs = self.get_option('validate_certs')
+
+        self.include_milliseconds = self.get_option('include_milliseconds')
+
     def v2_playbook_on_start(self, playbook):
         self.splunk.ansible_playbook = basename(playbook._file_name)
 
@@ -188,6 +225,8 @@ class CallbackModule(CallbackBase):
         self.splunk.send_event(
             self.url,
             self.authtoken,
+            self.validate_certs,
+            self.include_milliseconds,
             'OK',
             result,
             self._runtime(result)
@@ -197,6 +236,8 @@ class CallbackModule(CallbackBase):
         self.splunk.send_event(
             self.url,
             self.authtoken,
+            self.validate_certs,
+            self.include_milliseconds,
             'SKIPPED',
             result,
             self._runtime(result)
@@ -206,6 +247,8 @@ class CallbackModule(CallbackBase):
         self.splunk.send_event(
             self.url,
             self.authtoken,
+            self.validate_certs,
+            self.include_milliseconds,
             'FAILED',
             result,
             self._runtime(result)
@@ -215,6 +258,8 @@ class CallbackModule(CallbackBase):
         self.splunk.send_event(
             self.url,
             self.authtoken,
+            self.validate_certs,
+            self.include_milliseconds,
             'FAILED',
             result,
             self._runtime(result)
@@ -224,6 +269,8 @@ class CallbackModule(CallbackBase):
         self.splunk.send_event(
             self.url,
             self.authtoken,
+            self.validate_certs,
+            self.include_milliseconds,
             'UNREACHABLE',
             result,
             self._runtime(result)

plugins/callback/stderr.py

@@ -1,70 +0,0 @@
-# (c) 2017, Frederic Van Espen <github@freh.be>
-# (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    callback: stderr
-    callback_type: stdout
-    requirements:
-      - set as main display callback
-    short_description: Splits output, sending failed tasks to stderr
-    deprecated:
-        why: The 'default' callback plugin now supports this functionality
-        removed_in: '2.11'
-        alternative: "'default' callback plugin with 'display_failed_stderr = yes' option"
-    extends_documentation_fragment:
-      - default_callback
-    description:
-        - This is the stderr callback plugin, it behaves like the default callback plugin but sends error output to stderr.
-        - Also it does not output skipped host/task/item status
-'''
-
-from ansible import constants as C
-from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
-
-
-class CallbackModule(CallbackModule_default):
-
-    '''
-    This is the stderr callback plugin, which reuses the default
-    callback plugin but sends error output to stderr.
-    '''
-
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'community.general.stderr'
-
-    def __init__(self):
-
-        self.super_ref = super(CallbackModule, self)
-        self.super_ref.__init__()
-
-    def v2_runner_on_failed(self, result, ignore_errors=False):
-
-        delegated_vars = result._result.get('_ansible_delegated_vars', None)
-        self._clean_results(result._result, result._task.action)
-
-        if self._play.strategy == 'free' and self._last_task_banner != result._task._uuid:
-            self._print_task_banner(result._task)
-
-        self._handle_exception(result._result, use_stderr=True)
-        self._handle_warnings(result._result)
-
-        if result._task.loop and 'results' in result._result:
-            self._process_items(result)
-
-        else:
-            if delegated_vars:
-                self._display.display("fatal: [%s -> %s]: FAILED! => %s" % (result._host.get_name(), delegated_vars['ansible_host'],
-                                                                            self._dump_results(result._result)), color=C.COLOR_ERROR,
-                                      stderr=True)
-            else:
-                self._display.display("fatal: [%s]: FAILED! => %s" % (result._host.get_name(), self._dump_results(result._result)),
-                                      color=C.COLOR_ERROR, stderr=True)
-
-        if ignore_errors:
-            self._display.display("...ignoring", color=C.COLOR_SKIP)

plugins/callback/sumologic.py

@@ -18,7 +18,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-callback: sumologic
+name: sumologic
 type: aggregate
 short_description: Sends task result events to Sumologic
 author: "Ryan Currah (@ryancurrah)"
@@ -42,7 +42,7 @@ EXAMPLES = '''
 examples: >
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
-    callback_whitelist = sumologic
+    callback_whitelist = community.general.sumologic
 
   Set the environment variable
     export SUMOLOGIC_URL=https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==

plugins/callback/syslog_json.py

@@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: syslog_json
-    callback_type: notification
+    author: Unknown (!UNKNOWN)
+    name: syslog_json
+    type: notification
     requirements:
       - whitelist in configuration
     short_description: sends JSON events to syslog
@@ -66,7 +67,9 @@ class CallbackModule(CallbackBase):
 
         super(CallbackModule, self).__init__()
 
-        self.set_options()
+    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)
 
         syslog_host = self.get_option("server")
         syslog_port = int(self.get_option("port"))

plugins/callback/unixy.py

@@ -7,9 +7,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: unixy
+    name: unixy
     type: stdout
-    author: Allyson Bowles <@akatch>
+    author: Allyson Bowles (@akatch)
     short_description: condensed Ansible output
     description:
       - Consolidated Ansible output in the style of LINUX/UNIX startup logs.

plugins/callback/yaml.py

@@ -6,7 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: yaml
+    author: Unknown (!UNKNOWN)
+    name: yaml
     type: stdout
     short_description: yaml-ized Ansible screen output
     description:
@@ -49,7 +50,7 @@ def my_represent_scalar(self, tag, value, style=None):
             # ...no trailing space
             value = value.rstrip()
             # ...and non-printable characters
-            value = ''.join(x for x in value if x in string.printable)
+            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

plugins/cliconf/aireos.py

@@ -1,95 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: aireos
-short_description: Use aireos cliconf to run command on Cisco WLC platform
-description:
-  - This aireos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Cisco WLC network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'aireos'
-        reply = self.get('show sysinfo')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Product Version\.* (.*)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'System Name\.* (.*)', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        reply = self.get('show inventory')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'DESCR: \"(.*)\"', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running', 'startup'):
-            return self.invalid_params("fetching configuration from %s is not supported" % source)
-        if source == 'running':
-            cmd = 'show run-config commands'
-        else:
-            cmd = 'show run-config startup-commands'
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain(['config'], to_list(command), ['end']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            self._update_cli_prompt_context(config_context=')#')

plugins/cliconf/apconos.py

@@ -1,72 +0,0 @@
-# (C) 2018 Red Hat Inc.
-# Copyright (C) 2019 APCON.
-#
-# GNU General Public License v3.0+
-#
-# This program 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.
-#
-# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Contains CLIConf Plugin methods for apconos Modules
-# APCON Networking
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-author: "David Li (@davidlee-ap)"
-cliconf: apconos
-short_description: Use apconos cliconf to run command on APCON network devices
-description:
-  - This apconos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from APCON network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'apconos'
-        reply = self.get(b'show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-        if data:
-            device_info['network_os_version'] = self.parse_version(data)
-            device_info['network_os_model'] = self.parse_model(data)
-
-        return device_info
-
-    def parse_version(self, data):
-        return ""
-
-    def parse_model(self, data):
-        return ""
-
-    @enable_mode
-    def get_config(self, source='running', format='text'):
-        pass
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, check_all=check_all)
-
-    def get_capabilities(self):
-        return json.dumps(self.get_device_info())

plugins/cliconf/aruba.py

@@ -1,95 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: aruba
-short_description: Use aruba cliconf to run command on Aruba platform
-description:
-  - This aruba plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Aruba network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'aruba'
-        reply = self.get('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Version (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'^MODEL: (\S+)\),', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        reply = self.get('show hostname')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'^Hostname is (.+)', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running', 'startup'):
-            return self.invalid_params("fetching configuration from %s is not supported" % source)
-        if source == 'running':
-            cmd = 'show running-config all'
-        else:
-            cmd = 'show configuration'
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain(['configure terminal'], to_list(command), ['end']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            self._update_cli_prompt_context(config_context=')#')

plugins/cliconf/ce.py

@@ -1,121 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: ce
-short_description: Use ce cliconf to run command on HUAWEI CloudEngine platform
-description:
-  - This ce plugin provides low level abstraction apis for
-    sending and receiving CLI commands from HUAWEI CloudEngine network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'ce'
-        reply = self.get('display version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'^Huawei.+\n.+\Version\s+(\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1).strip(',')
-
-        match = re.search(r'^Huawei(.+)\n.+\(\S+\s+\S+\)', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'HUAWEI\s+(\S+)\s+uptime', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running'):
-            return self.invalid_params("fetching configuration from %s is not supported" % source)
-
-        if not flags:
-            flags = []
-
-        cmd = 'display current-configuration'
-
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        results = []
-        for cmd in chain(['configure terminal'], to_list(command), ['end']):
-            if isinstance(cmd, dict):
-                command = cmd['command']
-                prompt = cmd['prompt']
-                answer = cmd['answer']
-                newline = cmd.get('newline', True)
-            else:
-                command = cmd
-                prompt = None
-                answer = None
-                newline = True
-
-            results.append(self.send_command(command, prompt, answer, False, newline))
-        return results[1:-1]
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            out = self._connection.get_prompt()
-
-            if out is None:
-                raise AnsibleConnectionFailure(message=u'cli prompt is not identified from the last received'
-                                                       u' response window: %s' % self._connection._last_recv_window)
-
-            prompt = to_text(out, errors='surrogate_then_replace').strip()
-            while prompt.endswith(']'):
-                self._connection.queue_message('vvvv', 'wrong context, sending return to device')
-                if prompt.startswith('[*'):
-                    self._connection.exec_command('clear configuration candidate')
-                self._connection.exec_command('return')
-                out = self._connection.get_prompt()
-                prompt = to_text(out, errors='surrogate_then_replace').strip()

plugins/cliconf/cnos.py

@@ -1,135 +0,0 @@
-# (C) 2017 Red Hat Inc.
-# Copyright (C) 2017 Lenovo.
-#
-# GNU General Public License v3.0+
-#
-# This program 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.
-#
-# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Contains CLIConf Plugin methods for CNOS Modules
-# Lenovo Networking
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: cnos
-short_description: Use cnos cliconf to run command on Lenovo CNOS platform
-description:
-  - This cnos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Lenovo CNOS network devices.
-'''
-
-import re
-import json
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils.common._collections_compat import Mapping
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'cnos'
-        reply = self.get('show sys-info')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-        host = self.get('show hostname')
-        hostname = to_text(host, errors='surrogate_or_strict').strip()
-        if data:
-            device_info['network_os_version'] = self.parse_version(data)
-            device_info['network_os_model'] = self.parse_model(data)
-            device_info['network_os_hostname'] = hostname
-
-        return device_info
-
-    def parse_version(self, data):
-        for line in data.split('\n'):
-            line = line.strip()
-            match = re.match(r'System Software Revision (.*?)',
-                             line, re.M | re.I)
-            if match:
-                vers = line.split(':')
-                ver = vers[1].strip()
-                return ver
-        return "NA"
-
-    def parse_model(self, data):
-        for line in data.split('\n'):
-            line = line.strip()
-            match = re.match(r'System Model (.*?)', line, re.M | re.I)
-            if match:
-                mdls = line.split(':')
-                mdl = mdls[1].strip()
-                return mdl
-        return "NA"
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running', 'startup'):
-            msg = "fetching configuration from %s is not supported"
-            return self.invalid_params(msg % source)
-        if source == 'running':
-            cmd = 'show running-config'
-        else:
-            cmd = 'show startup-config'
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, candidate=None, commit=True,
-                    replace=None, comment=None):
-        resp = {}
-        results = []
-        requests = []
-        if commit:
-            self.send_command('configure terminal')
-            for line in to_list(candidate):
-                if not isinstance(line, Mapping):
-                    line = {'command': line}
-
-                cmd = line['command']
-                if cmd != 'end' and cmd[0] != '!':
-                    results.append(self.send_command(**line))
-                    requests.append(cmd)
-
-            self.send_command('end')
-        else:
-            raise ValueError('check mode is not supported')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            out = self._connection.get_prompt()
-
-            if out is None:
-                raise AnsibleConnectionFailure(message=u'cli prompt is not identified from the last received'
-                                                       u' response window: %s' % self._connection._last_recv_window)
-
-            if to_text(out, errors='surrogate_then_replace').strip().endswith(')#'):
-                self._connection.queue_message('vvvv', 'In Config mode, sending exit to device')
-                self._connection.send_command('exit')
-            else:
-                self._connection.send_command('enable')

plugins/cliconf/edgeos.py

@@ -1,114 +0,0 @@
-# Copyright: (c) 2018, 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 = '''
----
-cliconf: edgeos
-short_description: Use edgeos cliconf to run command on EdgeOS platform
-description:
-  - This edgeos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Ubiquiti EdgeOS network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible.module_utils.common._collections_compat import Mapping
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'edgeos'
-        reply = self.get('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Version:\s*v?(\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'HW model:\s*(\S+)', data)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        reply = self.get('show host name')
-        device_info['network_os_hostname'] = to_text(reply, errors='surrogate_or_strict').strip()
-
-        return device_info
-
-    def get_config(self, source='running', format='text', flags=None):
-        return self.send_command('show configuration commands')
-
-    def edit_config(self, candidate=None, commit=True, replace=False, comment=None):
-        for cmd in chain(['configure'], to_list(candidate)):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def commit(self, comment=None):
-        if comment:
-            command = 'commit comment "{0}"'.format(comment)
-        else:
-            command = 'commit'
-        self.send_command(command)
-
-    def discard_changes(self, *args, **kwargs):
-        self.send_command('discard')
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                raise ValueError("'output' value %s is not supported for run_commands" % output)
-
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc:
-                    raise
-                out = getattr(e, 'err', e)
-
-            responses.append(out)
-
-        return responses
-
-    def get_device_operations(self):
-        return {
-            'supports_diff_replace': False,
-            'supports_commit': True,
-            'supports_rollback': False,
-            'supports_defaults': False,
-            'supports_onbox_diff': False,
-            'supports_commit_comment': True,
-            'supports_multiline_delimiter': False,
-            'supports_diff_match': False,
-            'supports_diff_ignore_lines': False,
-            'supports_generate_diff': False,
-            'supports_replace': False
-        }
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        result['rpc'] += ['commit', 'discard_changes', 'run_commands']
-        result['device_operations'] = self.get_device_operations()
-        return json.dumps(result)

plugins/cliconf/edgeswitch.py

@@ -1,141 +0,0 @@
-#
-# (c) 2018 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: edgeswitch
-short_description: Use edgeswitch cliconf to run command on EdgeSwitch platform
-description:
-  - This edgeswitch plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Ubiquiti EdgeSwitch network devices.
-'''
-
-import re
-import time
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import dumps
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-from ansible.module_utils.common._collections_compat import Mapping
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'edgeswitch'
-        reply = self.get(command='show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Software Version\.+ (.*)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1).strip(',')
-
-        match = re.search(r'^Machine Model\.+ (.*)', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'System Name\.+ (.*)', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', flags=None):
-        if source not in ('running', 'startup'):
-            raise ValueError("fetching configuration from %s is not supported" % source)
-
-        if source == 'running':
-            cmd = 'show running-config '
-        else:
-            cmd = 'show startup-config '
-
-        if flags:
-            cmd += ' '.join(to_list(flags))
-            cmd = cmd.strip()
-
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, commands):
-        resp = {}
-
-        results = []
-        requests = []
-        self.send_command('configure')
-        for line in to_list(commands):
-            if not isinstance(line, Mapping):
-                line = {'command': line}
-
-            cmd = line['command']
-            if cmd != 'end' and cmd[0] != '!':
-                results.append(self.send_command(**line))
-                requests.append(cmd)
-
-        self.send_command('end')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command=None, prompt=None, answer=None, sendonly=False, output=None, newline=True, check_all=False):
-        if not command:
-            raise ValueError('must provide value of command to execute')
-        if output:
-            raise ValueError("'output' value %s is not supported for get" % output)
-
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        result['rpc'] += ['run_commands']
-        return json.dumps(result)
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                raise ValueError("'output' value %s is not supported for run_commands" % output)
-
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc:
-                    raise
-                out = getattr(e, 'err', e)
-
-            responses.append(out)
-
-        return responses

plugins/cliconf/enos.py

@@ -1,103 +0,0 @@
-# (C) 2017 Red Hat Inc.
-# Copyright (C) 2017 Lenovo.
-#
-# GNU General Public License v3.0+
-#
-# This program 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.
-#
-# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-#
-# Contains CLIConf Plugin methods for ENOS Modules
-# Lenovo Networking
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: enos
-short_description: Use enos cliconf to run command on Lenovo ENOS platform
-description:
-  - This enos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Lenovo ENOS network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'enos'
-        reply = self.get('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'^Software Version (.*?) ', data, re.M | re.I)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'^Lenovo RackSwitch (\S+)', data, re.M | re.I)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'^(.+) uptime', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-        else:
-            device_info['network_os_hostname'] = "NA"
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running', 'startup'):
-            msg = "fetching configuration from %s is not supported"
-            return self.invalid_params(msg % source)
-        if source == 'running':
-            cmd = 'show running-config'
-        else:
-            cmd = 'show startup-config'
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain(['configure terminal'], to_list(command), ['end']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            out = self._connection.get_prompt()
-
-            if out is None:
-                raise AnsibleConnectionFailure(message=u'cli prompt is not identified from the last received'
-                                                       u' response window: %s' % self._connection._last_recv_window)
-
-            if to_text(out, errors='surrogate_then_replace').strip().endswith(')#'):
-                self._connection.queue_message('vvvv', 'In Config mode, sending exit to device')
-                self._connection.send_command('exit')
-            else:
-                self._connection.send_command('enable')

plugins/cliconf/eric_eccli.py

@@ -1,97 +0,0 @@
-#
-# Copyright (c) 2019 Ericsson AB.
-#
-# 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: Ericsson IPOS OAM team
-cliconf: eccli
-short_description: Use eccli cliconf to run command on Ericsson ECCLI platform
-description:
-  - This eccli plugin provides low level abstraction APIs for
-    sending and receiving CLI commands from Ericsson ECCLI network devices.
-'''
-
-from ansible.module_utils.common._collections_compat import Mapping
-import collections
-import re
-import time
-import json
-
-from itertools import chain
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible.module_utils.six import iteritems
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, dumps
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_config(self, source='running', flags=None, format=None):
-        return
-
-    def edit_config(self, candidate=None, commit=True, replace=None, comment=None):
-        return
-
-    def get(self, command=None, prompt=None, answer=None, sendonly=False, output=None, newline=True, check_all=False):
-        if not command:
-            raise ValueError('must provide value of command to execute')
-        if output:
-            raise ValueError("'output' value %s is not supported for get" % output)
-
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_device_info(self):
-        device_info = {}
-        device_info['network_os'] = 'eric_eccli'
-        return device_info
-
-    def get_capabilities(self):
-        result = dict()
-        result['rpc'] = self.get_base_rpc() + ['run_commands']
-        result['network_api'] = 'cliconf'
-        result['device_info'] = self.get_device_info()
-        return json.dumps(result)
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                raise ValueError("'output' value %s is not supported for run_commands" % output)
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc:
-                    raise
-                out = getattr(e, 'err', e)
-
-            responses.append(out)
-
-        return responses

plugins/cliconf/exos.py

@@ -1,229 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: exos
-short_description: Use exos cliconf to run command on Extreme EXOS platform
-description:
-  - This exos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Extreme EXOS network devices.
-'''
-
-import re
-import json
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.module_utils.connection import ConnectionError
-from ansible.module_utils.common._collections_compat import Mapping
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, dumps
-from ansible.plugins.cliconf import CliconfBase
-
-
-class Cliconf(CliconfBase):
-
-    def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
-        diff = {}
-        device_operations = self.get_device_operations()
-        option_values = self.get_option_values()
-
-        if candidate is None and device_operations['supports_generate_diff']:
-            raise ValueError("candidate configuration is required to generate diff")
-
-        if diff_match not in option_values['diff_match']:
-            raise ValueError("'match' value %s in invalid, valid values are %s" % (diff_match, ', '.join(option_values['diff_match'])))
-
-        if diff_replace not in option_values['diff_replace']:
-            raise ValueError("'replace' value %s in invalid, valid values are %s" % (diff_replace, ', '.join(option_values['diff_replace'])))
-
-        # prepare candidate configuration
-        candidate_obj = NetworkConfig(indent=1)
-        candidate_obj.load(candidate)
-
-        if running and diff_match != 'none' and diff_replace != 'config':
-            # running configuration
-            running_obj = NetworkConfig(indent=1, contents=running, ignore_lines=diff_ignore_lines)
-            configdiffobjs = candidate_obj.difference(running_obj, path=path, match=diff_match, replace=diff_replace)
-
-        else:
-            configdiffobjs = candidate_obj.items
-
-        diff['config_diff'] = dumps(configdiffobjs, 'commands') if configdiffobjs else ''
-        return diff
-
-    def get_device_info(self):
-        device_info = {}
-        device_info['network_os'] = 'exos'
-
-        reply = self.run_commands({'command': 'show switch detail', 'output': 'text'})
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'ExtremeXOS version  (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'System Type: +(\S+)', data)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'SysName: +(\S+)', data)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_default_flag(self):
-        # The flag to modify the command to collect configuration with defaults
-        return 'detail'
-
-    def get_config(self, source='running', format='text', flags=None):
-        options_values = self.get_option_values()
-        if format not in options_values['format']:
-            raise ValueError("'format' value %s is invalid. Valid values are %s" % (format, ','.join(options_values['format'])))
-
-        lookup = {'running': 'show configuration', 'startup': 'debug cfgmgr show configuration file'}
-        if source not in lookup:
-            raise ValueError("fetching configuration from %s is not supported" % source)
-
-        cmd = {'command': lookup[source], 'output': 'text'}
-
-        if source == 'startup':
-            reply = self.run_commands({'command': 'show switch', 'format': 'text'})
-            data = to_text(reply, errors='surrogate_or_strict').strip()
-            match = re.search(r'Config Selected: +(\S+)\.cfg', data, re.MULTILINE)
-            if match:
-                cmd['command'] += match.group(1)
-            else:
-                # No Startup(/Selected) Config
-                return {}
-
-        cmd['command'] += ' '.join(to_list(flags))
-        cmd['command'] = cmd['command'].strip()
-
-        return self.run_commands(cmd)[0]
-
-    def edit_config(self, candidate=None, commit=True, replace=None, diff=False, comment=None):
-        resp = {}
-        operations = self.get_device_operations()
-        self.check_edit_config_capability(operations, candidate, commit, replace, comment)
-        results = []
-        requests = []
-
-        if commit:
-            for line in to_list(candidate):
-                if not isinstance(line, Mapping):
-                    line = {'command': line}
-                results.append(self.send_command(**line))
-                requests.append(line['command'])
-        else:
-            raise ValueError('check mode is not supported')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, output=None, newline=True, check_all=False):
-        if output:
-            command = self._get_command_with_output(command, output)
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                cmd['command'] = self._get_command_with_output(cmd['command'], output)
-
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc is True:
-                    raise
-                out = getattr(e, 'err', e)
-
-            if out is not None:
-                try:
-                    out = to_text(out, errors='surrogate_or_strict').strip()
-                except UnicodeError:
-                    raise ConnectionError(message=u'Failed to decode output from %s: %s' % (cmd, to_text(out)))
-
-                if output and output == 'json':
-                    try:
-                        out = json.loads(out)
-                    except ValueError:
-                        raise ConnectionError('Response was not valid JSON, got {0}'.format(
-                            to_text(out)
-                        ))
-                responses.append(out)
-
-        return responses
-
-    def get_device_operations(self):
-        return {
-            'supports_diff_replace': False,         # identify if config should be merged or replaced is supported
-            'supports_commit': False,               # identify if commit is supported by device or not
-            'supports_rollback': False,             # identify if rollback is supported or not
-            'supports_defaults': True,              # identify if fetching running config with default is supported
-            'supports_commit_comment': False,       # identify if adding comment to commit is supported of not
-            'supports_onbox_diff': False,           # identify if on box diff capability is supported or not
-            'supports_generate_diff': True,         # identify if diff capability is supported within plugin
-            'supports_multiline_delimiter': False,  # identify if multiline delimiter is supported within config
-            'supports_diff_match': True,            # identify if match is supported
-            'supports_diff_ignore_lines': True,     # identify if ignore line in diff is supported
-            'supports_config_replace': False,       # identify if running config replace with candidate config is supported
-            'supports_admin': False,                # identify if admin configure mode is supported or not
-            'supports_commit_label': False,         # identify if commit label is supported or not
-            'supports_replace': False
-        }
-
-    def get_option_values(self):
-        return {
-            'format': ['text', 'json'],
-            'diff_match': ['line', 'strict', 'exact', 'none'],
-            'diff_replace': ['line', 'block'],
-            'output': ['text', 'json']
-        }
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        result['rpc'] += ['run_commmands', 'get_default_flag', 'get_diff']
-        result['device_operations'] = self.get_device_operations()
-        result['device_info'] = self.get_device_info()
-        result.update(self.get_option_values())
-        return json.dumps(result)
-
-    def _get_command_with_output(self, command, output):
-        if output not in self.get_option_values().get('output'):
-            raise ValueError("'output' value is %s is invalid. Valid values are %s" % (output, ','.join(self.get_option_values().get('output'))))
-
-        if output == 'json' and not command.startswith('run script cli2json.py'):
-            cmd = 'run script cli2json.py %s' % command
-        else:
-            cmd = command
-        return cmd

plugins/cliconf/icx.py

@@ -1,314 +0,0 @@
-# Copyright: (c) 2019, 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 = '''
----
-author: Ruckus Wireless (@Commscope)
-cliconf: icx
-short_description: Use icx cliconf to run command on Ruckus ICX platform
-description:
-  - This icx plugin provides low level abstraction APIs for
-    sending and receiving CLI commands from Ruckus ICX network devices.
-'''
-
-
-import re
-import time
-import json
-import os
-
-from itertools import chain
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible.module_utils.six import iteritems
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, dumps
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-from ansible.module_utils.common._collections_compat import Mapping
-
-
-class Cliconf(CliconfBase):
-
-    @enable_mode
-    def get_config(self, source='running', flags=None, format=None, compare=None):
-        if source not in ('running', 'startup'):
-            raise ValueError("fetching configuration from %s is not supported" % source)
-
-        if format:
-            raise ValueError("'format' value %s is not supported for get_config" % format)
-
-        if not flags:
-            flags = []
-
-        if compare is False:
-            return ''
-        else:
-            if source == 'running':
-                cmd = 'show running-config '
-            else:
-                cmd = 'show configuration '
-
-            cmd += ' '.join(to_list(flags))
-            cmd = cmd.strip()
-
-            return self.send_command(cmd)
-
-    def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
-        """
-        Generate diff between candidate and running configuration. If the
-        remote host supports onbox diff capabilities ie. supports_onbox_diff in that case
-        candidate and running configurations are not required to be passed as argument.
-        In case if onbox diff capability is not supported candidate argument is mandatory
-        and running argument is optional.
-        :param candidate: The configuration which is expected to be present on remote host.
-        :param running: The base configuration which is used to generate diff.
-        :param diff_match: Instructs how to match the candidate configuration with current device configuration
-                      Valid values are 'line', 'strict', 'exact', 'none'.
-                      'line' - commands are matched line by line
-                      'strict' - command lines are matched with respect to position
-                      'exact' - command lines must be an equal match
-                      'none' - will not compare the candidate configuration with the running configuration
-        :param diff_ignore_lines: Use this argument to specify one or more lines that should be
-                                  ignored during the diff.  This is used for lines in the configuration
-                                  that are automatically updated by the system.  This argument takes
-                                  a list of regular expressions or exact line matches.
-        :param path: The ordered set of parents that uniquely identify the section or hierarchy
-                     the commands should be checked against.  If the parents argument
-                     is omitted, the commands are checked against the set of top
-                    level or global commands.
-        :param diff_replace: Instructs on the way to perform the configuration on the device.
-                        If the replace argument is set to I(line) then the modified lines are
-                        pushed to the device in configuration mode.  If the replace argument is
-                        set to I(block) then the entire command block is pushed to the device in
-                        configuration mode if any line is not correct.
-        :return: Configuration diff in  json format.
-               {
-                   'config_diff': '',
-                   'banner_diff': {}
-               }
-
-        """
-        diff = {}
-        device_operations = self.get_device_operations()
-        option_values = self.get_option_values()
-
-        if candidate is None and device_operations['supports_generate_diff']:
-            raise ValueError("candidate configuration is required to generate diff")
-
-        if diff_match not in option_values['diff_match']:
-            raise ValueError("'match' value %s in invalid, valid values are %s" % (diff_match, ', '.join(option_values['diff_match'])))
-
-        if diff_replace not in option_values['diff_replace']:
-            raise ValueError("'replace' value %s in invalid, valid values are %s" % (diff_replace, ', '.join(option_values['diff_replace'])))
-
-        # prepare candidate configuration
-        candidate_obj = NetworkConfig(indent=1)
-        want_src, want_banners = self._extract_banners(candidate)
-        candidate_obj.load(want_src)
-
-        if running and diff_match != 'none':
-            # running configuration
-            have_src, have_banners = self._extract_banners(running)
-
-            running_obj = NetworkConfig(indent=1, contents=have_src, ignore_lines=diff_ignore_lines)
-            configdiffobjs = candidate_obj.difference(running_obj, path=path, match=diff_match, replace=diff_replace)
-
-        else:
-            configdiffobjs = candidate_obj.items
-            have_banners = {}
-
-        diff['config_diff'] = dumps(configdiffobjs, 'commands') if configdiffobjs else ''
-
-        banners = self._diff_banners(want_banners, have_banners)
-        diff['banner_diff'] = banners if banners else {}
-        return diff
-
-    @enable_mode
-    def edit_config(self, candidate=None, commit=True, replace=None, comment=None):
-        resp = {}
-        operations = self.get_device_operations()
-        self.check_edit_config_capability(operations, candidate, commit, replace, comment)
-
-        results = []
-        requests = []
-        if commit:
-            prompt = self._connection.get_prompt()
-            if (b'(config-if' in prompt) or (b'(config' in prompt) or (b'(config-lag-if' in prompt):
-                self.send_command('end')
-
-            self.send_command('configure terminal')
-
-            for line in to_list(candidate):
-                if not isinstance(line, Mapping):
-                    line = {'command': line}
-
-                cmd = line['command']
-                if cmd != 'end' and cmd[0] != '!':
-                    results.append(self.send_command(**line))
-                    requests.append(cmd)
-
-            self.send_command('end')
-        else:
-            raise ValueError('check mode is not supported')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command=None, prompt=None, answer=None, sendonly=False, output=None, check_all=False):
-        if not command:
-            raise ValueError('must provide value of command to execute')
-        if output:
-            raise ValueError("'output' value %s is not supported for get" % output)
-
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, check_all=check_all)
-
-    def scp(self, command=None, scp_user=None, scp_pass=None):
-        if not command:
-            raise ValueError('must provide value of command to execute')
-        prompt = ["User name:", "Password:"]
-        if(scp_pass is None):
-            answer = [scp_user, self._connection._play_context.password]
-        else:
-            answer = [scp_user, scp_pass]
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=False, check_all=True)
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'icx'
-        reply = self.get(command='show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Version (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1).strip(',')
-
-        match = re.search(r'^Cisco (.+) \(revision', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'^(.+) uptime', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_device_operations(self):
-        return {
-            'supports_diff_replace': True,
-            'supports_commit': False,
-            'supports_rollback': False,
-            'supports_defaults': True,
-            'supports_onbox_diff': False,
-            'supports_commit_comment': False,
-            'supports_multiline_delimiter': True,
-            'supports_diff_match': True,
-            'supports_diff_ignore_lines': True,
-            'supports_generate_diff': True,
-            'supports_replace': False
-        }
-
-    def get_option_values(self):
-        return {
-            'format': ['text'],
-            'diff_match': ['line', 'strict', 'exact', 'none'],
-            'diff_replace': ['line', 'block'],
-            'output': []
-        }
-
-    def get_capabilities(self):
-        result = dict()
-        result['rpc'] = self.get_base_rpc() + ['edit_banner', 'get_diff', 'run_commands', 'get_defaults_flag']
-        result['network_api'] = 'cliconf'
-        result['device_operations'] = self.get_device_operations()
-        result.update(self.get_option_values())
-        return json.dumps(result)
-
-    def edit_banner(self, candidate=None, multiline_delimiter="@", commit=True):
-        """
-        Edit banner on remote device
-        :param banners: Banners to be loaded in json format
-        :param multiline_delimiter: Line delimiter for banner
-        :param commit: Boolean value that indicates if the device candidate
-               configuration should be  pushed in the running configuration or discarded.
-        :param diff: Boolean flag to indicate if configuration that is applied on remote host should
-                     generated and returned in response or not
-        :return: Returns response of executing the configuration command received
-             from remote host
-        """
-        resp = {}
-        banners_obj = json.loads(candidate)
-        results = []
-        requests = []
-        if commit:
-            for key, value in iteritems(banners_obj):
-                key += ' %s' % multiline_delimiter
-                self.send_command('config terminal', sendonly=True)
-                for cmd in [key, value, multiline_delimiter]:
-                    obj = {'command': cmd, 'sendonly': True}
-                    results.append(self.send_command(**obj))
-                    requests.append(cmd)
-
-                self.send_command('end', sendonly=True)
-                time.sleep(0.1)
-                results.append(self.send_command('\n'))
-                requests.append('\n')
-
-        resp['request'] = requests
-        resp['response'] = results
-
-        return resp
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                raise ValueError("'output' value %s is not supported for run_commands" % output)
-
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc:
-                    raise
-                out = getattr(e, 'err', to_text(e))
-
-            responses.append(out)
-
-        return responses
-
-    def _extract_banners(self, config):
-        banners = {}
-        banner_cmds = re.findall(r'^banner (\w+)', config, re.M)
-        for cmd in banner_cmds:
-            regex = r'banner %s \$(.+?)(?=\$)' % cmd
-            match = re.search(regex, config, re.S)
-            if match:
-                key = 'banner %s' % cmd
-                banners[key] = match.group(1).strip()
-
-        for cmd in banner_cmds:
-            regex = r'banner %s \$(.+?)(?=\$)' % cmd
-            match = re.search(regex, config, re.S)
-            if match:
-                config = config.replace(str(match.group(1)), '')
-
-        config = re.sub(r'banner \w+ \$\$', '!! banner removed', config)
-        return config, banners
-
-    def _diff_banners(self, want, have):
-        candidate = {}
-        for key, value in iteritems(want):
-            if value != have.get(key):
-                candidate[key] = value
-        return candidate

plugins/cliconf/ironware.py

@@ -1,95 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: ironware
-short_description: Use ironware cliconf to run command on Extreme Ironware platform
-description:
-  - This ironware plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Extreme Ironware network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'ironware'
-        reply = self.send_command('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'IronWare : Version (\S+),', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'^(?:System Mode\:|System\:) (CES|CER|MLX|XMR)', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running', 'startup'):
-            raise ValueError("fetching configuration from %s is not supported" % source)
-
-        if source == 'running':
-            cmd = 'show running-config'
-            if flags is not None:
-                cmd += ' ' + ' '.join(flags)
-
-        else:
-            cmd = 'show configuration'
-            if flags is not None:
-                raise ValueError("flags are only supported with running-config")
-
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain(['configure terminal'], to_list(command), ['end']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)
-
-    def set_cli_prompt_context(self):
-        """
-        Make sure we are in the operational cli mode
-        :return: None
-        """
-        if self._connection.connected:
-            self._update_cli_prompt_context(config_context=')#')

plugins/cliconf/netvisor.py

@@ -1,74 +0,0 @@
-#
-# (c) 2016 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: netvisor
-short_description: Use netvisor cliconf to run command on Pluribus netvisor platform
-description:
-  - This netvisor plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Pluribus netvisor devices.
-'''
-
-import json
-from ansible.plugins.cliconf import CliconfBase
-
-
-class Cliconf(CliconfBase):
-
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running'):
-            return self.invalid_params("fetching configuration from %s is not supported" % source)
-        cmd = 'show running-config'
-        return self.send_command(cmd)
-
-    def edit_config(self, command):
-        return
-
-    def get(self, command=None, prompt=None, answer=None, sendonly=False, output=None, newline=True, check_all=False):
-        if not command:
-            raise ValueError('must provide value of command to execute')
-        if output:
-            raise ValueError("'output' value %s is not supported for get" % output)
-
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_option_values(self):
-        return {
-            'format': ['text'],
-            'diff_match': ['line', 'strict', 'exact', 'none'],
-            'diff_replace': ['line', 'block'],
-            'output': []
-        }
-
-    def get_capabilities(self):
-        result = dict()
-        result['rpc'] = self.get_base_rpc()
-        result['network_api'] = 'cliconf'
-        result['device_info'] = self.get_device_info()
-        result.update(self.get_option_values())
-        return json.dumps(result)
-
-    def get_device_info(self):
-        device_info = {}
-        device_info['network_os'] = 'netvisor'
-
-        return device_info

plugins/cliconf/nos.py

@@ -1,112 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: nos
-short_description: Use nos cliconf to run command on Extreme NOS platform
-description:
-  - This nos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Extreme NOS network devices.
-'''
-
-import re
-import json
-
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'nos'
-        reply = self.get('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'Network Operating System Version: (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        reply = self.get('show chassis')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'^Chassis Name:(\s+)(\S+)', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(2)
-
-        reply = self.get('show running-config | inc "switch-attributes host-name"')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'switch-attributes host-name (\S+)', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_config(self, source='running', flags=None):
-        if source not in 'running':
-            raise ValueError("fetching configuration from %s is not supported" % source)
-        if source == 'running':
-            cmd = 'show running-config'
-
-        flags = [] if flags is None else flags
-        cmd += ' '.join(flags)
-        cmd = cmd.strip()
-
-        return self.send_command(cmd)
-
-    def edit_config(self, command):
-        resp = {}
-        results = []
-        requests = []
-        self.send_command('configure terminal')
-        for cmd in to_list(command):
-            if isinstance(cmd, dict):
-                command = cmd['command']
-                prompt = cmd['prompt']
-                answer = cmd['answer']
-                newline = cmd.get('newline', True)
-            else:
-                command = cmd
-                prompt = None
-                answer = None
-                newline = True
-
-            if cmd != 'end' and cmd[0] != '!':
-                results.append(self.send_command(command, prompt, answer, False, newline))
-                requests.append(cmd)
-
-        self.send_command('end')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)

plugins/cliconf/onyx.py

@@ -1,77 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: onyx
-short_description: Use onyx cliconf to run command on Mellanox ONYX platform
-description:
-  - This onyx plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Mellanox ONYX network devices.
-'''
-
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        reply = self.get('show version | json-print')
-        data = json.loads(reply)
-        device_info['network_os'] = data['Product name']
-        device_info['network_os_version'] = data['Product release']
-        device_info['network_os_version_summary'] = data['Version summary']
-        device_info['network_os_model'] = data['Product model']
-
-        reply = self.get('show hosts | include Hostname')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-        hostname = data.split(':')[1]
-        hostname = hostname.strip()
-        device_info['network_os_hostname'] = hostname
-
-        return device_info
-
-    @enable_mode
-    def get_config(self, source='running', format='text', flags=None):
-        if source not in ('running',):
-            return self.invalid_params("fetching configuration from %s is not supported" % source)
-        cmd = 'show running-config'
-        return self.send_command(cmd)
-
-    @enable_mode
-    def edit_config(self, command):
-        for cmd in chain(['configure terminal'], to_list(command), ['exit']):
-            self.send_command(cmd)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)

plugins/cliconf/routeros.py

@@ -1,78 +0,0 @@
-#
-# (c) 2017 Red Hat Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: routeros
-short_description: Use routeros cliconf to run command on MikroTik RouterOS platform
-description:
-  - This routeros plugin provides low level abstraction apis for
-    sending and receiving CLI commands from MikroTik RouterOS network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-        device_info['network_os'] = 'RouterOS'
-
-        resource = self.get('/system resource print')
-        data = to_text(resource, errors='surrogate_or_strict').strip()
-        match = re.search(r'version: (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        routerboard = self.get('/system routerboard print')
-        data = to_text(routerboard, errors='surrogate_or_strict').strip()
-        match = re.search(r'model: (.+)$', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        identity = self.get('/system identity print')
-        data = to_text(identity, errors='surrogate_or_strict').strip()
-        match = re.search(r'name: (.+)$', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_config(self, source='running', format='text', flags=None):
-        return
-
-    def edit_config(self, command):
-        return
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)

plugins/cliconf/slxos.py

@@ -1,104 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: slxos
-short_description: Use slxos cliconf to run command on Extreme SLX-OS platform
-description:
-  - This slxos plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Extreme SLX-OS network devices.
-'''
-
-import re
-import json
-
-from itertools import chain
-
-from ansible.module_utils._text import to_bytes, to_text
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible.plugins.cliconf import CliconfBase
-
-
-class Cliconf(CliconfBase):
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'slxos'
-        reply = self.get('show version')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'SLX\-OS Operating System Version: (\S+)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        reply = self.get('show chassis')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'^Chassis Name:(\s+)(\S+)', data, re.M)
-        if match:
-            device_info['network_os_model'] = match.group(2)
-
-        reply = self.get('show running-config | inc "switch-attributes host-name"')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'switch-attributes host-name (\S+)', data, re.M)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_config(self, source='running', flags=None):
-        if source not in ('running', 'startup'):
-            raise ValueError("fetching configuration from %s is not supported" % source)
-        if source == 'running':
-            cmd = 'show running-config'
-        else:
-            cmd = 'show startup-config'
-
-        flags = [] if flags is None else flags
-        cmd += ' '.join(flags)
-        cmd = cmd.strip()
-
-        return self.send_command(cmd)
-
-    def edit_config(self, command):
-        for cmd in chain(['configure terminal'], to_list(command), ['end']):
-            if isinstance(cmd, dict):
-                command = cmd['command']
-                prompt = cmd['prompt']
-                answer = cmd['answer']
-                newline = cmd.get('newline', True)
-            else:
-                command = cmd
-                prompt = None
-                answer = None
-                newline = True
-
-            self.send_command(command, prompt, answer, False, newline)
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        return json.dumps(result)

plugins/cliconf/voss.py

@@ -1,235 +0,0 @@
-#
-# (c) 2018 Extreme Networks Inc.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
----
-cliconf: voss
-short_description: Use voss cliconf to run command on Extreme VOSS platform
-description:
-  - This voss plugin provides low level abstraction apis for
-    sending and receiving CLI commands from Extreme VOSS network devices.
-'''
-
-import re
-import json
-
-from ansible.errors import AnsibleConnectionFailure
-from ansible.module_utils._text import to_text
-from ansible.module_utils.common._collections_compat import Mapping
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, dumps
-from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list
-from ansible_collections.community.general.plugins.module_utils.network.voss.voss import VossNetworkConfig
-from ansible.plugins.cliconf import CliconfBase, enable_mode
-
-
-class Cliconf(CliconfBase):
-
-    @enable_mode
-    def get_config(self, source='running', flags=None, format=None):
-        if source not in ('running', 'startup'):
-            raise ValueError("fetching configuration from %s is not supported" % source)
-
-        if format:
-            raise ValueError("'format' value %s is not supported for get_config" % format)
-
-        if not flags:
-            flags = []
-        if source == 'running':
-            cmd = 'show running-config '
-            cmd += ' '.join(to_list(flags))
-            cmd = cmd.strip()
-        else:
-            cmd = 'more /intflash/config.cfg'
-
-        return self.send_command(cmd)
-
-    def get_diff(self, candidate=None, running=None, diff_match='line', diff_ignore_lines=None, path=None, diff_replace='line'):
-        """
-        Generate diff between candidate and running configuration. If the
-        remote host supports onbox diff capabilities ie. supports_onbox_diff in that case
-        candidate and running configurations are not required to be passed as argument.
-        In case if onbox diff capability is not supported candidate argument is mandatory
-        and running argument is optional.
-        :param candidate: The configuration which is expected to be present on remote host.
-        :param running: The base configuration which is used to generate diff.
-        :param diff_match: Instructs how to match the candidate configuration with current device configuration
-                      Valid values are 'line', 'strict', 'exact', 'none'.
-                      'line' - commands are matched line by line
-                      'strict' - command lines are matched with respect to position
-                      'exact' - command lines must be an equal match
-                      'none' - will not compare the candidate configuration with the running configuration
-        :param diff_ignore_lines: Use this argument to specify one or more lines that should be
-                                  ignored during the diff.  This is used for lines in the configuration
-                                  that are automatically updated by the system.  This argument takes
-                                  a list of regular expressions or exact line matches.
-        :param path: The ordered set of parents that uniquely identify the section or hierarchy
-                     the commands should be checked against.  If the parents argument
-                     is omitted, the commands are checked against the set of top
-                    level or global commands.
-        :param diff_replace: Instructs on the way to perform the configuration on the device.
-                        If the replace argument is set to I(line) then the modified lines are
-                        pushed to the device in configuration mode.  If the replace argument is
-                        set to I(block) then the entire command block is pushed to the device in
-                        configuration mode if any line is not correct.
-        :return: Configuration diff in  json format.
-               {
-                   'config_diff': '',
-               }
-
-        """
-        diff = {}
-
-        device_operations = self.get_device_operations()
-        option_values = self.get_option_values()
-
-        if candidate is None and device_operations['supports_generate_diff']:
-            raise ValueError("candidate configuration is required to generate diff")
-
-        if diff_match not in option_values['diff_match']:
-            raise ValueError("'match' value %s in invalid, valid values are %s" % (diff_match, ', '.join(option_values['diff_match'])))
-
-        if diff_replace not in option_values['diff_replace']:
-            raise ValueError("'replace' value %s in invalid, valid values are %s" % (diff_replace, ', '.join(option_values['diff_replace'])))
-
-        # prepare candidate configuration
-        candidate_obj = VossNetworkConfig(indent=0, ignore_lines=diff_ignore_lines)
-        candidate_obj.load(candidate)
-
-        if running and diff_match != 'none':
-            # running configuration
-            running_obj = VossNetworkConfig(indent=0, contents=running, ignore_lines=diff_ignore_lines)
-            configdiffobjs = candidate_obj.difference(running_obj, path=path, match=diff_match, replace=diff_replace)
-
-        else:
-            configdiffobjs = candidate_obj.items
-
-        diff['config_diff'] = dumps(configdiffobjs, 'commands') if configdiffobjs else ''
-        diff['diff_path'] = path
-        diff['diff_replace'] = diff_replace
-        return diff
-
-    @enable_mode
-    def edit_config(self, candidate=None, commit=True, replace=None, comment=None):
-        resp = {}
-        operations = self.get_device_operations()
-        self.check_edit_config_capability(operations, candidate, commit, replace, comment)
-
-        results = []
-        requests = []
-        if commit:
-            self.send_command('configure terminal')
-            for line in to_list(candidate):
-                if not isinstance(line, Mapping):
-                    line = {'command': line}
-
-                cmd = line['command']
-                if cmd != 'end' and cmd[0] != '!':
-                    results.append(self.send_command(**line))
-                    requests.append(cmd)
-
-            self.send_command('end')
-        else:
-            raise ValueError('check mode is not supported')
-
-        resp['request'] = requests
-        resp['response'] = results
-        return resp
-
-    def get(self, command, prompt=None, answer=None, sendonly=False, newline=True, check_all=False):
-        return self.send_command(command=command, prompt=prompt, answer=answer, sendonly=sendonly, newline=newline, check_all=check_all)
-
-    def get_device_info(self):
-        device_info = {}
-
-        device_info['network_os'] = 'voss'
-        reply = self.get(command='show sys-info')
-        data = to_text(reply, errors='surrogate_or_strict').strip()
-
-        match = re.search(r'SysDescr\s+: \S+ \((\S+)\)', data)
-        if match:
-            device_info['network_os_version'] = match.group(1)
-
-        match = re.search(r'Chassis\s+: (\S+)', data)
-        if match:
-            device_info['network_os_model'] = match.group(1)
-
-        match = re.search(r'SysName\s+: (\S+)', data)
-        if match:
-            device_info['network_os_hostname'] = match.group(1)
-
-        return device_info
-
-    def get_device_operations(self):
-        return {
-            'supports_diff_replace': True,
-            'supports_commit': False,
-            'supports_rollback': False,
-            'supports_defaults': True,
-            'supports_onbox_diff': False,
-            'supports_commit_comment': False,
-            'supports_multiline_delimiter': False,
-            'supports_diff_match': True,
-            'supports_diff_ignore_lines': True,
-            'supports_generate_diff': True,
-            'supports_replace': False
-        }
-
-    def get_option_values(self):
-        return {
-            'format': ['text'],
-            'diff_match': ['line', 'strict', 'exact', 'none'],
-            'diff_replace': ['line', 'block'],
-            'output': []
-        }
-
-    def get_capabilities(self):
-        result = super(Cliconf, self).get_capabilities()
-        result['rpc'] += ['get_diff', 'run_commands', 'get_defaults_flag']
-        result['device_operations'] = self.get_device_operations()
-        result.update(self.get_option_values())
-        return json.dumps(result)
-
-    def run_commands(self, commands=None, check_rc=True):
-        if commands is None:
-            raise ValueError("'commands' value is required")
-
-        responses = list()
-        for cmd in to_list(commands):
-            if not isinstance(cmd, Mapping):
-                cmd = {'command': cmd}
-
-            output = cmd.pop('output', None)
-            if output:
-                raise ValueError("'output' value %s is not supported for run_commands" % output)
-
-            try:
-                out = self.send_command(**cmd)
-            except AnsibleConnectionFailure as e:
-                if check_rc:
-                    raise
-                out = getattr(e, 'err', e)
-
-            responses.append(out)
-
-        return responses
-
-    def get_defaults_flag(self):
-        return 'verbose'