Modify files that contain reference to licenses/ that are no longer part of main branch.

* Add simplified_bsd.txt and adjust references.

* Add changelog.

(cherry picked from commit 0be68bf04b)

.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"

.gitignore

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

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
+
+If you are a committer, also refer to the [collection's committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
+
+## Issue tracker
+
+Whether you are looking for an opportunity to contribute or you found a bug and already know how to solve it, please go to the [issue tracker](https://github.com/ansible-collections/community.general/issues).
+There you can find feature ideas to implement, reports about bugs to solve, or submit an issue to discuss your idea before implementing it which can help choose a right direction at the beginning of your work and potentially save a lot of time and effort.
+Also somebody may already have started discussing or working on implementing the same or a similar idea,
+so you can cooperate to create a better solution together.
+
+* If you are interested in starting with an easy issue, look for [issues with an `easyfix` label](https://github.com/ansible-collections/community.general/labels/easyfix).
+* Often issues that are waiting for contributors to pick up have [the `waiting_on_contributor` label](https://github.com/ansible-collections/community.general/labels/waiting_on_contributor).
+
+## Open pull requests
+
+Look through currently [open pull requests](https://github.com/ansible-collections/community.general/pulls).
+You can help by reviewing them. Reviews help move pull requests to merge state. Some good pull requests cannot be merged only due to a lack of reviews. And it is always worth saying that good reviews are often more valuable than pull requests themselves.
+Note that reviewing does not only mean code review, but also offering comments on new interfaces added to existing plugins/modules, interfaces of new plugins/modules, improving language (not everyone is a native english speaker), or testing bugfixes and new features!
+
+Also, consider taking up a valuable, reviewed, but abandoned pull request which you could politely ask the original authors to complete yourself.
+
+* Try committing your changes with an informative but short commit message.
+* Do not squash your commits and force-push to your branch if not needed. Reviews of your pull request are much easier with individual commits to comprehend the pull request history. All commits of your pull request branch will be squashed into one commit by GitHub upon merge.
+* Do not add merge commits to your PR. The bot will complain and you will have to rebase ([instructions for rebasing](https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html)) to remove them before your PR can be merged. To avoid that git automatically does merges during pulls, you can configure it to do rebases instead by running `git config pull.rebase true` inside the respository checkout.
+* Make sure your PR includes a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#changelogs-how-to). (You must not include a fragment for new modules or new plugins, except for test and filter plugins. Also you shouldn't include one for docs-only changes. If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) )
+
+You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst).
+
+## Test pull requests
+
+If you want to test a PR locally, refer to [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how do it quickly.
+
+If you find any inconsistencies or places in this document which can be improved, feel free to raise an issue or pull request to fix it.

README.md

@@ -1,4 +1,130 @@
-[![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 repository contains the `community.general` Ansible Collection. The collection is a part of the Ansible package and includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
+
+You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/).
+
+Please note that this collection does **not** support Windows targets. Only connection plugins included in this collection might support Windows targets, and will explicitly mention that in their documentation if they do so.
+
+## Code of Conduct
+
+We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
+
+If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
+
+## Tested with Ansible
+
+Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11 and ansible-core 2.12 releases. 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
+
+This collection is shipped with the Ansible package. So if you have it installed, no more action is required.
+
+If you have a minimal installation (only Ansible Core installed) or you want to use the latest version of the collection along with the whole Ansible package, you need to install the collection from [Ansible Galaxy](https://galaxy.ansible.com/community/general) manually with the `ansible-galaxy` command-line tool:
+
+    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
+```
+
+Note that if you install the collection manually, it will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:
+
+```bash
+ansible-galaxy collection install community.general --upgrade
+```
+
+You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/community/general):
+
+```bash
+ansible-galaxy collection install community.general:==X.Y.Z
+```
+
+See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
+
+## Contributing to this collection
+
+The content of this collection is made by good people just like you, a community of individuals collaborating on making the world better through developing automation software.
+
+We are actively accepting new contributors.
+
+All types of contributions are very welcome.
+
+You don't know how to start? Refer to our [contribution guide](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md)!
+
+The current maintainers are listed in the [commit-rights.md](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md#people) file. If you have questions or need help, feel free to mention them in the proposals.
+
+You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
+
+Also for some notes specific to this collection see [our CONTRIBUTING documentation](https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md).
+
+### Running tests
+
+See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections).
+
+## Collection maintenance
+
+To learn how to maintain / become a maintainer of this collection, refer to:
+
+* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md).
+* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
+
+It is necessary for maintainers of this collection to be subscribed to:
+
+* The collection itself (the `Watch` button → `All Activity` in the upper right corner of the repository's homepage).
+* The "Changes Impacting Collection Contributors and Maintainers" [issue](https://github.com/ansible-collections/overview/issues/45).
+
+They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
+
+## Communication
+
+We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed.
+
+Join us in the `#ansible` (general use questions and support), `#ansible-community` (community and collection development questions), and other [IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels) on [Libera.chat](https://libera.chat).
+
+We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
+
+For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community).
+
+For more information about communication, refer to Ansible's the [Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+
+## Publishing New Version
+
+See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection.
+
+## Release notes
+
+See the [changelog](https://github.com/ansible-collections/community.general/blob/stable-2/CHANGELOG.rst).
+
+## Roadmap
+
+In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
+
+See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning, and deprecation.
+
+## 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

changelogs/fragments/simplified-bsd-license.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - Include ``simplified_bsd.txt`` license file for various module utils, the ``lxca_common`` docs fragment, and the ``utm_utils`` unit tests.

commit-rights.md

@@ -0,0 +1,74 @@
+Committers Guidelines for community.general
+===========================================
+
+This document is based on the [Ansible committer guidelines](https://github.com/ansible/ansible/blob/b57444af14062ec96e0af75fdfc2098c74fe2d9a/docs/docsite/rst/community/committer_guidelines.rst) ([latest version](https://docs.ansible.com/ansible/devel/community/committer_guidelines.html)).
+
+These are the guidelines for people with commit privileges on the Ansible Community General Collection GitHub repository. Please read the guidelines before you commit.
+
+These guidelines apply to everyone. At the same time, this is NOT a process document. So just use good judgment. You have been given commit access because we trust your judgment.
+
+That said, use the trust wisely.
+
+If you abuse the trust and break components and builds, and so on, the trust level falls and you may be asked not to commit or you may lose your commit privileges.
+
+Our workflow on GitHub
+----------------------
+
+As a committer, you may already know this, but our workflow forms a lot of our team policies. Please ensure you are aware of the following workflow steps:
+
+* Fork the repository upon which you want to do some work to your own personal repository
+* Work on the specific branch upon which you need to commit
+* Create a Pull Request back to the collection repository and await reviews
+* Adjust code as necessary based on the Comments provided
+* Ask someone from the other committers to do a final review and merge
+
+Sometimes, committers merge their own pull requests. This section is a set of guidelines. If you are changing a comma in a doc or making a very minor change, you can use your best judgement. This is another trust thing. The process is critical for any major change, but for little things or getting something done quickly, use your best judgement and make sure people on the team are aware of your work.
+
+Roles
+-----
+* Release managers: Merge pull requests to `stable-X` branches, create tags to do releases.
+* Committers: Fine to do PRs for most things, but we should have a timebox. Hanging PRs may merge on the judgement of these devs.
+* Module maintainers: Module maintainers own specific modules and have indirect commit access through the current module PR mechanisms. This is primary [ansibullbot](https://github.com/ansibullbot)'s `shipit` mechanism.
+
+General rules
+-------------
+Individuals with direct commit access to this collection repository are entrusted with powers that allow them to do a broad variety of things--probably more than we can write down. Rather than rules, treat these as general *guidelines*, individuals with this power are expected to use their best judgement.
+
+* Do NOTs:
+
+  - Do not commit directly.
+  - Do not merge your own PRs. Someone else should have a chance to review and approve the PR merge. You have a small amount of leeway here for very minor changes.
+  - Do not forget about non-standard / alternate environments. Consider the alternatives. Yes, people have bad/unusual/strange environments (like binaries from multiple init systems installed), but they are the ones who need us the most.
+  - Do not drag your community team members down. Discuss the technical merits of any pull requests you review. Avoid negativity and personal comments. For more guidance on being a good community member, read the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
+  - Do not forget about the maintenance burden. High-maintenance features may not be worth adding.
+  - Do not break playbooks. Always keep backwards compatibility in mind.
+  - Do not forget to keep it simple. Complexity breeds all kinds of problems.
+  - Do not merge to branches other than `main`, especially not to `stable-X`, if you do not have explicit permission to do so.
+  - Do not create tags. Tags are used in the release process, and should only be created by the people responsible for managing the stable branches.
+
+* Do:
+
+  - Squash, avoid merges whenever possible, use GitHub's squash commits or cherry pick if needed (bisect thanks you).
+  - Be active. Committers who have no activity on the project (through merges, triage, commits, and so on) will have their permissions suspended.
+  - Consider backwards compatibility (goes back to "do not break existing playbooks").
+  - Write tests. PRs with tests are looked at with more priority than PRs without tests that should have them included. While not all changes require tests, be sure to add them for bug fixes or functionality changes.
+  - Discuss with other committers, specially when you are unsure of something.
+  - Document! If your PR is a new feature or a change to behavior, make sure you've updated all associated documentation or have notified the right people to do so.
+  - Consider scope, sometimes a fix can be generalized.
+  - Keep it simple, then things are maintainable, debuggable and intelligible.
+
+Committers are expected to continue to follow the same community and contribution guidelines followed by the rest of the Ansible community.
+
+
+People
+------
+
+Individuals who have been asked to become a part of this group have generally been contributing in significant ways to the community.general collection for some time. Should they agree, they are requested to add their names and GitHub IDs to this file, in the section below, through a pull request. Doing so indicates that these individuals agree to act in the ways that their fellow committers trust that they will act.
+
+| Name                | GitHub ID            | IRC Nick           | Other                |
+| ------------------- | -------------------- | ------------------ | -------------------- |
+| Alexei Znamensky    | russoz               | russoz             |                      |
+| Andrew Klychkov     | andersson007         | andersson007_      |                      |
+| Andrew Pantuso      | Ajpantuso            | ajpantuso          |                      |
+| Felix Fontein       | felixfontein         | felixfontein       |                      |
+| John R Barker       | gundalow             | gundalow           |                      |

galaxy.yml

@@ -1,28 +1,16 @@
 namespace: community
 name: general
-version: 0.1.0
+version: 2.5.9
 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,610 @@
+---
+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
+  filter:
+    path_join:
+      # The ansible.builtin.path_join filter has been added in ansible-base 2.10.
+      # Since plugin routing is only available since ansible-base 2.10, this
+      # redirect will be used for ansible-base 2.10 or later, and the included
+      # path_join filter will be used for Ansible 2.9 or earlier.
+      redirect: ansible.builtin.path_join

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,186 @@
+# coding: utf-8 -*-
+# Copyright: (c) 2020, quidame <quidame@poivron.org>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import time
+
+from ansible.plugins.action import ActionBase
+from ansible.errors import 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, async_status_args, task_vars, timeout):
+        '''
+        Retrieve results of the asynchonous task, and display them in place of
+        the async wrapper results (those with the ansible_job_id key).
+        '''
+        async_status = self._task.copy()
+        async_status.args = async_status_args
+        async_status.action = 'ansible.builtin.async_status'
+        async_status.async_val = 0
+        async_action = self._shared_loader_obj.action_loader.get(
+            async_status.action, task=async_status, connection=self._connection,
+            play_context=self._play_context, loader=self._loader, templar=self._templar,
+            shared_loader_obj=self._shared_loader_obj)
+
+        if async_status.args['mode'] == 'cleanup':
+            return async_action.run(task_vars=task_vars)
+
+        # At least one iteration is required, even if timeout is 0.
+        for dummy in range(max(1, timeout)):
+            async_result = async_action.run(task_vars=task_vars)
+            if async_result.get('finished', 0) == 1:
+                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_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(mode='status')
+                    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.
+                dummy = 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 dummy 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:
+                            dummy = 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'):
+                    for key in ('_back', '_timeout', '_async_dir', 'jid'):
+                        if result['invocation']['module_args'].get(key):
+                            del result['invocation']['module_args'][key]
+
+                async_status_args['mode'] = 'cleanup'
+                dummy = self._async_result(async_status_args, task_vars, 0)
+
+        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,212 @@
+# coding: utf-8 -*-
+# Copyright: (c) 2020, Amin Vakil <info@aminvakil.com>
+# Copyright: (c) 2016-2018, Matt Davis <mdavis@ansible.com>
+# Copyright: (c) 2018, Sam Doran <sdoran@redhat.com>
+# 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/become/sudosu.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2021, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = """
+    name: sudosu
+    short_description: Run tasks using sudo su -
+    description:
+        - This become plugins allows your remote/login user to execute commands as another user via the C(sudo) and C(su) utilities combined.
+    author:
+    - Dag Wieers (@dagwieers)
+    version_added: 2.4.0
+    options:
+        become_user:
+            description: User you 'become' to execute the task.
+            default: root
+            ini:
+              - section: privilege_escalation
+                key: become_user
+              - section: sudo_become_plugin
+                key: user
+            vars:
+              - name: ansible_become_user
+              - name: ansible_sudo_user
+            env:
+              - name: ANSIBLE_BECOME_USER
+              - name: ANSIBLE_SUDO_USER
+        become_flags:
+            description: Options to pass to C(sudo).
+            default: -H -S -n
+            ini:
+              - section: privilege_escalation
+                key: become_flags
+              - section: sudo_become_plugin
+                key: flags
+            vars:
+              - name: ansible_become_flags
+              - name: ansible_sudo_flags
+            env:
+              - name: ANSIBLE_BECOME_FLAGS
+              - name: ANSIBLE_SUDO_FLAGS
+        become_pass:
+            description: Password to pass to C(sudo).
+            required: false
+            vars:
+              - name: ansible_become_password
+              - name: ansible_become_pass
+              - name: ansible_sudo_pass
+            env:
+              - name: ANSIBLE_BECOME_PASS
+              - name: ANSIBLE_SUDO_PASS
+            ini:
+              - section: sudo_become_plugin
+                key: password
+"""
+
+
+from ansible.plugins.become import BecomeBase
+
+
+class BecomeModule(BecomeBase):
+
+    name = 'community.general.sudosu'
+
+    # messages for detecting prompted password issues
+    fail = ('Sorry, try again.',)
+    missing = ('Sorry, a password is required to run sudo', 'sudo: a password is required')
+
+    def build_become_command(self, cmd, shell):
+        super(BecomeModule, self).build_become_command(cmd, shell)
+
+        if not cmd:
+            return cmd
+
+        becomecmd = 'sudo'
+
+        flags = self.get_option('become_flags') or ''
+        prompt = ''
+        if self.get_option('become_pass'):
+            self.prompt = '[sudo via ansible, key=%s] password:' % self._id
+            if flags:  # this could be simplified, but kept as is for now for backwards string matching
+                flags = flags.replace('-n', '')
+            prompt = '-p "%s"' % (self.prompt)
+
+        user = self.get_option('become_user') or ''
+        if user:
+            user = '%s' % (user)
+
+        return ' '.join([becomecmd, flags, prompt, 'su -l', 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

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) 2014, Brian Coca, Josh Drake, et al
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -6,7 +7,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 +54,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()
 
@@ -150,16 +154,16 @@ class CacheModuleKeys(MutableSet):
     def __len__(self):
         return len(self._keyset)
 
-    def add(self, key):
-        self._keyset[key] = time.time()
+    def add(self, value):
+        self._keyset[value] = time.time()
         self._cache.set(self.PREFIX, self._keyset)
 
-    def discard(self, key):
-        del self._keyset[key]
+    def discard(self, value):
+        del self._keyset[value]
         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 +182,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

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

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) 2014, Brian Coca, Josh Drake, et al
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -5,7 +6,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 +17,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 +34,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
@@ -40,19 +62,23 @@ DOCUMENTATION = '''
         type: integer
 '''
 
+import re
 import time
 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 +92,90 @@ class CacheModule(BaseCacheModule):
     to expire keys. This mechanism is used or a pattern matched 'scan' for
     performance.
     """
+    _sentinel_service_name = None
+    re_url_conn = re.compile(r'^([^:]+|\[[^]]+\]):(\d+):(\d+)(?::(.*))?$')
+    re_sent_conn = re.compile(r'^(.*):(\d+)$')
+
     def __init__(self, *args, **kwargs):
-        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 = self._parse_connection(self.re_url_conn, uri)
+            self._db = StrictRedis(*connection, **kw)
+
+        display.vv('Redis connection: %s' % self._db)
+
+    @staticmethod
+    def _parse_connection(re_patt, uri):
+        match = re_patt.match(uri)
+        if not match:
+            raise AnsibleError("Unable to parse connection string")
+        return match.groups()
+
+    def _get_sentinel_connection(self, uri, kw):
+        """
+        get sentinel connection details from _uri
+        """
+        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 = [self._parse_connection(self.re_sent_conn, shost) 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 +228,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

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

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

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

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

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

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

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

@@ -0,0 +1,235 @@
+# coding: utf-8 -*-
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = '''
+    name: loganalytics
+    type: aggregate
+    short_description: Posts task results to Azure Log Analytics
+    author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
+    description:
+      - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
+      - Credits to authors of splunk callback plugin.
+    version_added: "2.4.0"
+    requirements:
+      - Whitelisting this callback plugin.
+      - An Azure log analytics work space has been established.
+    options:
+      workspace_id:
+        description: Workspace ID of the Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_ID
+        ini:
+          - section: callback_loganalytics
+            key: workspace_id
+      shared_key:
+        description: Shared key to connect to Azure log analytics workspace.
+        required: true
+        env:
+          - name: WORKSPACE_SHARED_KEY
+        ini:
+          - section: callback_loganalytics
+            key: shared_key
+'''
+
+EXAMPLES = '''
+examples: |
+  Whitelist the plugin in ansible.cfg:
+    [defaults]
+    callback_whitelist = community.general.loganalytics
+  Set the environment variable:
+    export WORKSPACE_ID=01234567-0123-0123-0123-01234567890a
+    export WORKSPACE_SHARED_KEY=dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
+  Or configure the plugin in ansible.cfg in the callback_loganalytics block:
+    [callback_loganalytics]
+    workspace_id = 01234567-0123-0123-0123-01234567890a
+    shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
+'''
+
+import hashlib
+import hmac
+import base64
+import logging
+import json
+import uuid
+import socket
+import getpass
+
+from datetime import datetime
+from os.path import basename
+
+from ansible.module_utils.urls import open_url
+from ansible.parsing.ajson import AnsibleJSONEncoder
+from ansible.plugins.callback import CallbackBase
+
+
+class AzureLogAnalyticsSource(object):
+    def __init__(self):
+        self.ansible_check_mode = False
+        self.ansible_playbook = ""
+        self.ansible_version = ""
+        self.session = str(uuid.uuid4())
+        self.host = socket.gethostname()
+        self.user = getpass.getuser()
+        self.extra_vars = ""
+
+    def __build_signature(self, date, workspace_id, shared_key, content_length):
+        # Build authorisation signature for Azure log analytics API call
+        sigs = "POST\n{0}\napplication/json\nx-ms-date:{1}\n/api/logs".format(
+            str(content_length), date)
+        utf8_sigs = sigs.encode('utf-8')
+        decoded_shared_key = base64.b64decode(shared_key)
+        hmac_sha256_sigs = hmac.new(
+            decoded_shared_key, utf8_sigs, digestmod=hashlib.sha256).digest()
+        encoded_hash = base64.b64encode(hmac_sha256_sigs).decode('utf-8')
+        signature = "SharedKey {0}:{1}".format(workspace_id, encoded_hash)
+        return signature
+
+    def __build_workspace_url(self, workspace_id):
+        return "https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01".format(workspace_id)
+
+    def __rfc1123date(self):
+        return datetime.utcnow().strftime('%a, %d %b %Y %H:%M:%S GMT')
+
+    def send_event(self, workspace_id, shared_key, state, result, runtime):
+        if result._task_fields['args'].get('_ansible_check_mode') is True:
+            self.ansible_check_mode = True
+
+        if result._task_fields['args'].get('_ansible_version'):
+            self.ansible_version = \
+                result._task_fields['args'].get('_ansible_version')
+
+        if result._task._role:
+            ansible_role = str(result._task._role)
+        else:
+            ansible_role = None
+
+        data = {}
+        data['uuid'] = result._task._uuid
+        data['session'] = self.session
+        data['status'] = state
+        data['timestamp'] = self.__rfc1123date()
+        data['host'] = self.host
+        data['user'] = self.user
+        data['runtime'] = runtime
+        data['ansible_version'] = self.ansible_version
+        data['ansible_check_mode'] = self.ansible_check_mode
+        data['ansible_host'] = result._host.name
+        data['ansible_playbook'] = self.ansible_playbook
+        data['ansible_role'] = ansible_role
+        data['ansible_task'] = result._task_fields
+        # Removing args since it can contain sensitive data
+        if 'args' in data['ansible_task']:
+            data['ansible_task'].pop('args')
+        data['ansible_result'] = result._result
+        if 'content' in data['ansible_result']:
+            data['ansible_result'].pop('content')
+
+        # Adding extra vars info
+        data['extra_vars'] = self.extra_vars
+
+        # Preparing the playbook logs as JSON format and send to Azure log analytics
+        jsondata = json.dumps({'event': data}, cls=AnsibleJSONEncoder, sort_keys=True)
+        content_length = len(jsondata)
+        rfc1123date = self.__rfc1123date()
+        signature = self.__build_signature(rfc1123date, workspace_id, shared_key, content_length)
+        workspace_url = self.__build_workspace_url(workspace_id)
+
+        open_url(
+            workspace_url,
+            jsondata,
+            headers={
+                'content-type': 'application/json',
+                'Authorization': signature,
+                'Log-Type': 'ansible_playbook',
+                'x-ms-date': rfc1123date
+            },
+            method='POST'
+        )
+
+
+class CallbackModule(CallbackBase):
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'aggregate'
+    CALLBACK_NAME = 'loganalytics'
+    CALLBACK_NEEDS_WHITELIST = True
+
+    def __init__(self, display=None):
+        super(CallbackModule, self).__init__(display=display)
+        self.start_datetimes = {}  # Collect task start times
+        self.workspace_id = None
+        self.shared_key = None
+        self.loganalytics = AzureLogAnalyticsSource()
+
+    def _seconds_since_start(self, result):
+        return (
+            datetime.utcnow() -
+            self.start_datetimes[result._task._uuid]
+        ).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)
+        self.workspace_id = self.get_option('workspace_id')
+        self.shared_key = self.get_option('shared_key')
+
+    def v2_playbook_on_play_start(self, play):
+        vm = play.get_variable_manager()
+        extra_vars = vm.extra_vars
+        self.loganalytics.extra_vars = extra_vars
+
+    def v2_playbook_on_start(self, playbook):
+        self.loganalytics.ansible_playbook = basename(playbook._file_name)
+
+    def v2_playbook_on_task_start(self, task, is_conditional):
+        self.start_datetimes[task._uuid] = datetime.utcnow()
+
+    def v2_playbook_on_handler_task_start(self, task):
+        self.start_datetimes[task._uuid] = datetime.utcnow()
+
+    def v2_runner_on_ok(self, result, **kwargs):
+        self.loganalytics.send_event(
+            self.workspace_id,
+            self.shared_key,
+            'OK',
+            result,
+            self._seconds_since_start(result)
+        )
+
+    def v2_runner_on_skipped(self, result, **kwargs):
+        self.loganalytics.send_event(
+            self.workspace_id,
+            self.shared_key,
+            'SKIPPED',
+            result,
+            self._seconds_since_start(result)
+        )
+
+    def v2_runner_on_failed(self, result, **kwargs):
+        self.loganalytics.send_event(
+            self.workspace_id,
+            self.shared_key,
+            'FAILED',
+            result,
+            self._seconds_since_start(result)
+        )
+
+    def runner_on_async_failed(self, result, **kwargs):
+        self.loganalytics.send_event(
+            self.workspace_id,
+            self.shared_key,
+            'FAILED',
+            result,
+            self._seconds_since_start(result)
+        )
+
+    def v2_runner_on_unreachable(self, result, **kwargs):
+        self.loganalytics.send_event(
+            self.workspace_id,
+            self.shared_key,
+            'UNREACHABLE',
+            result,
+            self._seconds_since_start(result)
+        )

plugins/callback/logdna.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) 2018, Samir Musali <samir.musali@logdna.com>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
@@ -5,8 +6,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)
@@ -76,7 +78,7 @@ def get_mac():
 
 # Getting hostname of system:
 def get_hostname():
-    return str(socket.gethostname()).split('.local')[0]
+    return str(socket.gethostname()).split('.local', 1)[0]
 
 
 # Getting IP of system:

plugins/callback/logentries.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) 2015, Logentries.com, Jimmy Tang <jimmy.tang@logentries.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -5,7 +6,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 +77,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,14 @@
-# (C) 2016, Ievgen Khmelenko <ujenmr@gmail.com>
+# coding: utf-8 -*-
+# (C) 2020, Yevhen Khmelenko <ujenmr@gmail.com>
 # (C) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 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 +21,84 @@ 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
+from ansible import context
 import socket
 import uuid
-from datetime import datetime
-
 import logging
+from datetime import datetime
 
 try:
     import logstash
@@ -50,29 +110,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 +121,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 context.CLIARGS is not None:
+                self.base_data['ansible_checkmode'] = context.CLIARGS.get('check')
+                self.base_data['ansible_tags'] = context.CLIARGS.get('tags')
+                self.base_data['ansible_skip_tags'] = context.CLIARGS.get('skip_tags')
+                self.base_data['inventory'] = context.CLIARGS.get('inventory')
+
+    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 +195,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

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

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

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) Fastly, inc 2016
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@@ -6,8 +7,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 +32,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 +42,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 +68,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 +212,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

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

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

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

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
@@ -6,7 +7,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:
@@ -40,28 +42,29 @@ def should_use_block(value):
     return False
 
 
-def my_represent_scalar(self, tag, value, style=None):
-    """Uses block style for multi-line strings"""
-    if style is None:
-        if should_use_block(value):
-            style = '|'
-            # we care more about readable than accuracy, so...
-            # ...no trailing space
-            value = value.rstrip()
-            # ...and non-printable characters
-            value = ''.join(x for x in value if x in string.printable)
-            # ...tabs prevent blocks from expanding
-            value = value.expandtabs()
-            # ...and odd bits of whitespace
-            value = re.sub(r'[\x0b\x0c\r]', '', value)
-            # ...as does trailing space
-            value = re.sub(r' +\n', '\n', value)
-        else:
-            style = self.default_style
-    node = yaml.representer.ScalarNode(tag, value, style=style)
-    if self.alias_key is not None:
-        self.represented_objects[self.alias_key] = node
-    return node
+class MyDumper(AnsibleDumper):
+    def represent_scalar(self, tag, value, style=None):
+        """Uses block style for multi-line strings"""
+        if style is None:
+            if should_use_block(value):
+                style = '|'
+                # we care more about readable than accuracy, so...
+                # ...no trailing space
+                value = value.rstrip()
+                # ...and non-printable characters
+                value = ''.join(x for x in value if x in string.printable or ord(x) >= 0xA0)
+                # ...tabs prevent blocks from expanding
+                value = value.expandtabs()
+                # ...and odd bits of whitespace
+                value = re.sub(r'[\x0b\x0c\r]', '', value)
+                # ...as does trailing space
+                value = re.sub(r' +\n', '\n', value)
+            else:
+                style = self.default_style
+        node = yaml.representer.ScalarNode(tag, value, style=style)
+        if self.alias_key is not None:
+            self.represented_objects[self.alias_key] = node
+        return node
 
 
 class CallbackModule(Default):
@@ -77,7 +80,6 @@ class CallbackModule(Default):
 
     def __init__(self):
         super(CallbackModule, self).__init__()
-        yaml.representer.BaseRepresenter.represent_scalar = my_represent_scalar
 
     def _dump_results(self, result, indent=None, sort_keys=True, keep_invocation=False):
         if result.get('_ansible_no_log', False):
@@ -119,7 +121,7 @@ class CallbackModule(Default):
 
         if abridged_result:
             dumped += '\n'
-            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=AnsibleDumper, default_flow_style=False))
+            dumped += to_text(yaml.dump(abridged_result, allow_unicode=True, width=1000, Dumper=MyDumper, default_flow_style=False))
 
         # indent by a couple of spaces
         dumped = '\n  '.join(dumped.split('\n')).rstrip()

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'

plugins/connection/chroot.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 #
 # (c) 2013, Maykel Moya <mmoya@speedyrails.com>
@@ -9,8 +10,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    author: Maykel Moya <mmoya@speedyrails.com>
-    connection: chroot
+    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
+    name: chroot
     short_description: Interact with local chroot
     description:
         - Run commands or put/fetch files to an existing chroot on the Ansible controller.

plugins/connection/docker.py

@@ -1,356 +0,0 @@
-# Based on the chroot connection plugin by Maykel Moya
-#
-# (c) 2014, Lorin Hochstein
-# (c) 2015, Leendert Brouwer (https://github.com/objectified)
-# (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
-# Copyright (c) 2017 Ansible Project
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-DOCUMENTATION = '''
-    author:
-        - Lorin Hochestein
-        - Leendert Brouwer
-    connection: docker
-    short_description: Run tasks in docker containers
-    description:
-        - Run commands or put/fetch files to an existing docker container.
-    options:
-      remote_user:
-        description:
-            - The user to execute as inside the container
-        vars:
-            - name: ansible_user
-            - name: ansible_docker_user
-      docker_extra_args:
-        description:
-            - Extra arguments to pass to the docker command line
-        default: ''
-      remote_addr:
-        description:
-            - The name of the container you want to access.
-        default: inventory_hostname
-        vars:
-            - name: ansible_host
-            - name: ansible_docker_host
-'''
-
-import distutils.spawn
-import fcntl
-import os
-import os.path
-import subprocess
-import re
-
-from distutils.version import LooseVersion
-
-import ansible.constants as C
-from ansible.compat import selectors
-from ansible.errors import AnsibleError, AnsibleFileNotFound
-from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils._text import to_bytes, to_native, to_text
-from ansible.plugins.connection import ConnectionBase, BUFSIZE
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class Connection(ConnectionBase):
-    ''' Local docker based connections '''
-
-    transport = 'community.general.docker'
-    has_pipelining = True
-
-    def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
-
-        # Note: docker supports running as non-root in some configurations.
-        # (For instance, setting the UNIX socket file to be readable and
-        # writable by a specific UNIX group and then putting users into that
-        # group).  Therefore we don't check that the user is root when using
-        # this connection.  But if the user is getting a permission denied
-        # error it probably means that docker on their system is only
-        # configured to be connected to by root and they are not running as
-        # root.
-
-        # Windows uses Powershell modules
-        if getattr(self._shell, "_IS_WINDOWS", False):
-            self.module_implementation_preferences = ('.ps1', '.exe', '')
-
-        if 'docker_command' in kwargs:
-            self.docker_cmd = kwargs['docker_command']
-        else:
-            self.docker_cmd = distutils.spawn.find_executable('docker')
-            if not self.docker_cmd:
-                raise AnsibleError("docker command not found in PATH")
-
-        docker_version = self._get_docker_version()
-        if docker_version == u'dev':
-            display.warning(u'Docker version number is "dev". Will assume latest version.')
-        if docker_version != u'dev' and LooseVersion(docker_version) < LooseVersion(u'1.3'):
-            raise AnsibleError('docker connection type requires docker 1.3 or higher')
-
-        # The remote user we will request from docker (if supported)
-        self.remote_user = None
-        # The actual user which will execute commands in docker (if known)
-        self.actual_user = None
-
-        if self._play_context.remote_user is not None:
-            if docker_version == u'dev' or LooseVersion(docker_version) >= LooseVersion(u'1.7'):
-                # Support for specifying the exec user was added in docker 1.7
-                self.remote_user = self._play_context.remote_user
-                self.actual_user = self.remote_user
-            else:
-                self.actual_user = self._get_docker_remote_user()
-
-                if self.actual_user != self._play_context.remote_user:
-                    display.warning(u'docker {0} does not support remote_user, using container default: {1}'
-                                    .format(docker_version, self.actual_user or u'?'))
-        elif self._display.verbosity > 2:
-            # Since we're not setting the actual_user, look it up so we have it for logging later
-            # Only do this if display verbosity is high enough that we'll need the value
-            # This saves overhead from calling into docker when we don't need to
-            self.actual_user = self._get_docker_remote_user()
-
-    @staticmethod
-    def _sanitize_version(version):
-        return re.sub(u'[^0-9a-zA-Z.]', u'', version)
-
-    def _old_docker_version(self):
-        cmd_args = []
-        if self._play_context.docker_extra_args:
-            cmd_args += self._play_context.docker_extra_args.split(' ')
-
-        old_version_subcommand = ['version']
-
-        old_docker_cmd = [self.docker_cmd] + cmd_args + old_version_subcommand
-        p = subprocess.Popen(old_docker_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        cmd_output, err = p.communicate()
-
-        return old_docker_cmd, to_native(cmd_output), err, p.returncode
-
-    def _new_docker_version(self):
-        # no result yet, must be newer Docker version
-        cmd_args = []
-        if self._play_context.docker_extra_args:
-            cmd_args += self._play_context.docker_extra_args.split(' ')
-
-        new_version_subcommand = ['version', '--format', "'{{.Server.Version}}'"]
-
-        new_docker_cmd = [self.docker_cmd] + cmd_args + new_version_subcommand
-        p = subprocess.Popen(new_docker_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        cmd_output, err = p.communicate()
-        return new_docker_cmd, to_native(cmd_output), err, p.returncode
-
-    def _get_docker_version(self):
-
-        cmd, cmd_output, err, returncode = self._old_docker_version()
-        if returncode == 0:
-            for line in to_text(cmd_output, errors='surrogate_or_strict').split(u'\n'):
-                if line.startswith(u'Server version:'):  # old docker versions
-                    return self._sanitize_version(line.split()[2])
-
-        cmd, cmd_output, err, returncode = self._new_docker_version()
-        if returncode:
-            raise AnsibleError('Docker version check (%s) failed: %s' % (to_native(cmd), to_native(err)))
-
-        return self._sanitize_version(to_text(cmd_output, errors='surrogate_or_strict'))
-
-    def _get_docker_remote_user(self):
-        """ Get the default user configured in the docker container """
-        p = subprocess.Popen([self.docker_cmd, 'inspect', '--format', '{{.Config.User}}', self._play_context.remote_addr],
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-
-        out, err = p.communicate()
-        out = to_text(out, errors='surrogate_or_strict')
-
-        if p.returncode != 0:
-            display.warning(u'unable to retrieve default user from docker container: %s %s' % (out, to_text(err)))
-            return None
-
-        # The default exec user is root, unless it was changed in the Dockerfile with USER
-        return out.strip() or u'root'
-
-    def _build_exec_cmd(self, cmd):
-        """ Build the local docker exec command to run cmd on remote_host
-
-            If remote_user is available and is supported by the docker
-            version we are using, it will be provided to docker exec.
-        """
-
-        local_cmd = [self.docker_cmd]
-
-        if self._play_context.docker_extra_args:
-            local_cmd += self._play_context.docker_extra_args.split(' ')
-
-        local_cmd += [b'exec']
-
-        if self.remote_user is not None:
-            local_cmd += [b'-u', self.remote_user]
-
-        # -i is needed to keep stdin open which allows pipelining to work
-        local_cmd += [b'-i', self._play_context.remote_addr] + cmd
-
-        return local_cmd
-
-    def _connect(self, port=None):
-        """ Connect to the container. Nothing to do """
-        super(Connection, self)._connect()
-        if not self._connected:
-            display.vvv(u"ESTABLISH DOCKER CONNECTION FOR USER: {0}".format(
-                self.actual_user or u'?'), host=self._play_context.remote_addr
-            )
-            self._connected = True
-
-    def exec_command(self, cmd, in_data=None, sudoable=False):
-        """ Run a command on the docker host """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
-
-        local_cmd = self._build_exec_cmd([self._play_context.executable, '-c', cmd])
-
-        display.vvv(u"EXEC {0}".format(to_text(local_cmd)), host=self._play_context.remote_addr)
-        display.debug("opening command with Popen()")
-
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-
-        p = subprocess.Popen(
-            local_cmd,
-            stdin=subprocess.PIPE,
-            stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE,
-        )
-        display.debug("done running command with Popen()")
-
-        if self.become and self.become.expect_prompt() and sudoable:
-            fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) | os.O_NONBLOCK)
-            fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) | os.O_NONBLOCK)
-            selector = selectors.DefaultSelector()
-            selector.register(p.stdout, selectors.EVENT_READ)
-            selector.register(p.stderr, selectors.EVENT_READ)
-
-            become_output = b''
-            try:
-                while not self.become.check_success(become_output) and not self.become.check_password_prompt(become_output):
-                    events = selector.select(self._play_context.timeout)
-                    if not events:
-                        stdout, stderr = p.communicate()
-                        raise AnsibleError('timeout waiting for privilege escalation password prompt:\n' + to_native(become_output))
-
-                    for key, event in events:
-                        if key.fileobj == p.stdout:
-                            chunk = p.stdout.read()
-                        elif key.fileobj == p.stderr:
-                            chunk = p.stderr.read()
-
-                    if not chunk:
-                        stdout, stderr = p.communicate()
-                        raise AnsibleError('privilege output closed while waiting for password prompt:\n' + to_native(become_output))
-                    become_output += chunk
-            finally:
-                selector.close()
-
-            if not self.become.check_success(become_output):
-                become_pass = self.become.get_option('become_pass', playcontext=self._play_context)
-                p.stdin.write(to_bytes(become_pass, errors='surrogate_or_strict') + b'\n')
-            fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) & ~os.O_NONBLOCK)
-            fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) & ~os.O_NONBLOCK)
-
-        display.debug("getting output with communicate()")
-        stdout, stderr = p.communicate(in_data)
-        display.debug("done communicating")
-
-        display.debug("done with docker.exec_command()")
-        return (p.returncode, stdout, stderr)
-
-    def _prefix_login_path(self, remote_path):
-        ''' Make sure that we put files into a standard path
-
-            If a path is relative, then we need to choose where to put it.
-            ssh chooses $HOME but we aren't guaranteed that a home dir will
-            exist in any given chroot.  So for now we're choosing "/" instead.
-            This also happens to be the former default.
-
-            Can revisit using $HOME instead if it's a problem
-        '''
-        if not remote_path.startswith(os.path.sep):
-            remote_path = os.path.join(os.path.sep, remote_path)
-        return os.path.normpath(remote_path)
-
-    def put_file(self, in_path, out_path):
-        """ Transfer a file from local to docker container """
-        super(Connection, self).put_file(in_path, out_path)
-        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._play_context.remote_addr)
-
-        out_path = self._prefix_login_path(out_path)
-        if not os.path.exists(to_bytes(in_path, errors='surrogate_or_strict')):
-            raise AnsibleFileNotFound(
-                "file or module does not exist: %s" % to_native(in_path))
-
-        out_path = shlex_quote(out_path)
-        # Older docker doesn't have native support for copying files into
-        # running containers, so we use docker exec to implement this
-        # Although docker version 1.8 and later provide support, the
-        # owner and group of the files are always set to root
-        with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
-            if not os.fstat(in_file.fileno()).st_size:
-                count = ' count=0'
-            else:
-                count = ''
-            args = self._build_exec_cmd([self._play_context.executable, "-c", "dd of=%s bs=%s%s" % (out_path, BUFSIZE, count)])
-            args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
-            try:
-                p = subprocess.Popen(args, stdin=in_file,
-                                     stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-            except OSError:
-                raise AnsibleError("docker connection requires dd command in the container to put files")
-            stdout, stderr = p.communicate()
-
-            if p.returncode != 0:
-                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" %
-                                   (to_native(in_path), to_native(out_path), to_native(stdout), to_native(stderr)))
-
-    def fetch_file(self, in_path, out_path):
-        """ Fetch a file from container to local. """
-        super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._play_context.remote_addr)
-
-        in_path = self._prefix_login_path(in_path)
-        # out_path is the final file path, but docker takes a directory, not a
-        # file path
-        out_dir = os.path.dirname(out_path)
-
-        args = [self.docker_cmd, "cp", "%s:%s" % (self._play_context.remote_addr, in_path), out_dir]
-        args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
-
-        p = subprocess.Popen(args, stdin=subprocess.PIPE,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        p.communicate()
-
-        actual_out_path = os.path.join(out_dir, os.path.basename(in_path))
-
-        if p.returncode != 0:
-            # Older docker doesn't have native support for fetching files command `cp`
-            # If `cp` fails, try to use `dd` instead
-            args = self._build_exec_cmd([self._play_context.executable, "-c", "dd if=%s bs=%s" % (in_path, BUFSIZE)])
-            args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
-            with open(to_bytes(actual_out_path, errors='surrogate_or_strict'), 'wb') as out_file:
-                try:
-                    p = subprocess.Popen(args, stdin=subprocess.PIPE,
-                                         stdout=out_file, stderr=subprocess.PIPE)
-                except OSError:
-                    raise AnsibleError("docker connection requires dd command in the container to put files")
-                stdout, stderr = p.communicate()
-
-                if p.returncode != 0:
-                    raise AnsibleError("failed to fetch file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
-
-        # Rename if needed
-        if actual_out_path != out_path:
-            os.rename(to_bytes(actual_out_path, errors='strict'), to_bytes(out_path, errors='strict'))
-
-    def close(self):
-        """ Terminate the connection. Nothing to do for Docker"""
-        super(Connection, self).close()
-        self._connected = False

plugins/connection/funcd.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>
@@ -9,7 +10,7 @@ __metaclass__ = type
 
 DOCUMENTATION = '''
     author: Michael Scherer (@msherer) <misc@zarb.org>
-    connection: funcd
+    name: funcd
     short_description: Use funcd to connect to target
     description:
         - This transport permits you to use Ansible over Func.
@@ -37,12 +38,13 @@ import tempfile
 import shutil
 
 from ansible.errors import AnsibleError
+from ansible.plugins.connection import ConnectionBase
 from ansible.utils.display import Display
 
 display = Display()
 
 
-class Connection(object):
+class Connection(ConnectionBase):
     ''' Func-based connections '''
 
     has_pipelining = False

plugins/connection/iocage.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # Based on jail.py
 # (c) 2013, Michael Scherer <misc@zarb.org>
 # (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
@@ -9,8 +10,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    author: Stephan Lohse <dev-github@ploek.org>
-    connection: iocage
+    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
+    name: iocage
     short_description: Run tasks in iocage jails
     description:
         - Run commands or put/fetch files to an existing iocage jail

plugins/connection/jail.py

@@ -1,3 +1,4 @@
+# coding: utf-8 -*-
 # Based on local.py by Michael DeHaan <michael.dehaan@gmail.com>
 # and chroot.py by  Maykel Moya <mmoya@speedyrails.com>
 # Copyright (c) 2013, Michael Scherer <misc@zarb.org>
@@ -10,7 +11,7 @@ __metaclass__ = type
 
 DOCUMENTATION = '''
     author: Ansible Core Team
-    connection: jail
+    name: jail
     short_description: Run tasks in jails
     description:
         - Run commands or put/fetch files to an existing jail

plugins/connection/kubectl.py

@@ -1,355 +0,0 @@
-# Based on the docker connection plugin
-#
-# Connection plugin for configuring kubernetes containers with kubectl
-# (c) 2017, XuXinkun <xuxinkun@gmail.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
-
-DOCUMENTATION = '''
-    author:
-        - xuxinkun
-
-    connection: kubectl
-
-    short_description: Execute tasks in pods running on Kubernetes.
-
-    description:
-        - Use the kubectl exec command to run tasks in, or put/fetch files to, pods running on the Kubernetes
-          container platform.
-
-
-    requirements:
-      - kubectl (go binary)
-
-    options:
-      kubectl_pod:
-        description:
-          - Pod name. Required when the host name does not match pod name.
-        default: ''
-        vars:
-          - name: ansible_kubectl_pod
-        env:
-          - name: K8S_AUTH_POD
-      kubectl_container:
-        description:
-          - Container name. Required when a pod contains more than one container.
-        default: ''
-        vars:
-          - name: ansible_kubectl_container
-        env:
-          - name: K8S_AUTH_CONTAINER
-      kubectl_namespace:
-        description:
-          - The namespace of the pod
-        default: ''
-        vars:
-          - name: ansible_kubectl_namespace
-        env:
-          - name: K8S_AUTH_NAMESPACE
-      kubectl_extra_args:
-        description:
-          - Extra arguments to pass to the kubectl command line.
-        default: ''
-        vars:
-          - name: ansible_kubectl_extra_args
-        env:
-          - name: K8S_AUTH_EXTRA_ARGS
-      kubectl_kubeconfig:
-        description:
-          - Path to a kubectl config file. Defaults to I(~/.kube/config)
-        default: ''
-        vars:
-          - name: ansible_kubectl_kubeconfig
-          - name: ansible_kubectl_config
-        env:
-          - name: K8S_AUTH_KUBECONFIG
-      kubectl_context:
-        description:
-          - The name of a context found in the K8s config file.
-        default: ''
-        vars:
-          - name: ansible_kubectl_context
-        env:
-          - name: k8S_AUTH_CONTEXT
-      kubectl_host:
-        description:
-          - URL for accessing the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_host
-          - name: ansible_kubectl_server
-        env:
-          - name: K8S_AUTH_HOST
-          - name: K8S_AUTH_SERVER
-      kubectl_username:
-        description:
-          - Provide a username for authenticating with the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_username
-          - name: ansible_kubectl_user
-        env:
-          - name: K8S_AUTH_USERNAME
-      kubectl_password:
-        description:
-          - Provide a password for authenticating with the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_password
-        env:
-          - name: K8S_AUTH_PASSWORD
-      kubectl_token:
-        description:
-          - API authentication bearer token.
-        vars:
-          - name: ansible_kubectl_token
-          - name: ansible_kubectl_api_key
-        env:
-          - name: K8S_AUTH_TOKEN
-          - name: K8S_AUTH_API_KEY
-      client_cert:
-        description:
-          - Path to a certificate used to authenticate with the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_cert_file
-          - name: ansible_kubectl_client_cert
-        env:
-          - name: K8S_AUTH_CERT_FILE
-        aliases: [ kubectl_cert_file ]
-      client_key:
-        description:
-          - Path to a key file used to authenticate with the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_key_file
-          - name: ansible_kubectl_client_key
-        env:
-          - name: K8S_AUTH_KEY_FILE
-        aliases: [ kubectl_key_file ]
-      ca_cert:
-        description:
-          - Path to a CA certificate used to authenticate with the API.
-        default: ''
-        vars:
-          - name: ansible_kubectl_ssl_ca_cert
-          - name: ansible_kubectl_ca_cert
-        env:
-          - name: K8S_AUTH_SSL_CA_CERT
-        aliases: [ kubectl_ssl_ca_cert ]
-      validate_certs:
-        description:
-          - Whether or not to verify the API server's SSL certificate. Defaults to I(true).
-        default: ''
-        vars:
-          - name: ansible_kubectl_verify_ssl
-          - name: ansible_kubectl_validate_certs
-        env:
-          - name: K8S_AUTH_VERIFY_SSL
-        aliases: [ kubectl_verify_ssl ]
-'''
-
-import distutils.spawn
-import os
-import os.path
-import subprocess
-
-import ansible.constants as C
-from ansible.parsing.yaml.loader import AnsibleLoader
-from ansible.errors import AnsibleError, AnsibleFileNotFound
-from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils._text import to_bytes
-from ansible.plugins.connection import ConnectionBase, BUFSIZE
-from ansible.utils.display import Display
-
-display = Display()
-
-
-CONNECTION_TRANSPORT = 'kubectl'
-
-CONNECTION_OPTIONS = {
-    'kubectl_container': '-c',
-    'kubectl_namespace': '-n',
-    'kubectl_kubeconfig': '--kubeconfig',
-    'kubectl_context': '--context',
-    'kubectl_host': '--server',
-    'kubectl_username': '--username',
-    'kubectl_password': '--password',
-    'client_cert': '--client-certificate',
-    'client_key': '--client-key',
-    'ca_cert': '--certificate-authority',
-    'validate_certs': '--insecure-skip-tls-verify',
-    'kubectl_token': '--token'
-}
-
-
-class Connection(ConnectionBase):
-    ''' Local kubectl based connections '''
-
-    transport = CONNECTION_TRANSPORT
-    connection_options = CONNECTION_OPTIONS
-    documentation = DOCUMENTATION
-    has_pipelining = True
-    transport_cmd = None
-
-    def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
-
-        # Note: kubectl runs commands as the user that started the container.
-        # It is impossible to set the remote user for a kubectl connection.
-        cmd_arg = '{0}_command'.format(self.transport)
-        if cmd_arg in kwargs:
-            self.transport_cmd = kwargs[cmd_arg]
-        else:
-            self.transport_cmd = distutils.spawn.find_executable(self.transport)
-            if not self.transport_cmd:
-                raise AnsibleError("{0} command not found in PATH".format(self.transport))
-
-    def _build_exec_cmd(self, cmd):
-        """ Build the local kubectl exec command to run cmd on remote_host
-        """
-        local_cmd = [self.transport_cmd]
-
-        # Build command options based on doc string
-        doc_yaml = AnsibleLoader(self.documentation).get_single_data()
-        for key in doc_yaml.get('options'):
-            if key.endswith('verify_ssl') and self.get_option(key) != '':
-                # Translate verify_ssl to skip_verify_ssl, and output as string
-                skip_verify_ssl = not self.get_option(key)
-                local_cmd.append(u'{0}={1}'.format(self.connection_options[key], str(skip_verify_ssl).lower()))
-            elif not key.endswith('container') and self.get_option(key) and self.connection_options.get(key):
-                cmd_arg = self.connection_options[key]
-                local_cmd += [cmd_arg, self.get_option(key)]
-
-        extra_args_name = u'{0}_extra_args'.format(self.transport)
-        if self.get_option(extra_args_name):
-            local_cmd += self.get_option(extra_args_name).split(' ')
-
-        pod = self.get_option(u'{0}_pod'.format(self.transport))
-        if not pod:
-            pod = self._play_context.remote_addr
-        # -i is needed to keep stdin open which allows pipelining to work
-        local_cmd += ['exec', '-i', pod]
-
-        # if the pod has more than one container, then container is required
-        container_arg_name = u'{0}_container'.format(self.transport)
-        if self.get_option(container_arg_name):
-            local_cmd += ['-c', self.get_option(container_arg_name)]
-
-        local_cmd += ['--'] + cmd
-
-        return local_cmd
-
-    def _connect(self, port=None):
-        """ Connect to the container. Nothing to do """
-        super(Connection, self)._connect()
-        if not self._connected:
-            display.vvv(u"ESTABLISH {0} CONNECTION".format(self.transport), host=self._play_context.remote_addr)
-            self._connected = True
-
-    def exec_command(self, cmd, in_data=None, sudoable=False):
-        """ Run a command in the container """
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
-
-        local_cmd = self._build_exec_cmd([self._play_context.executable, '-c', cmd])
-
-        display.vvv("EXEC %s" % (local_cmd,), host=self._play_context.remote_addr)
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        p = subprocess.Popen(local_cmd, shell=False, stdin=subprocess.PIPE,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-
-        stdout, stderr = p.communicate(in_data)
-        return (p.returncode, stdout, stderr)
-
-    def _prefix_login_path(self, remote_path):
-        ''' Make sure that we put files into a standard path
-
-            If a path is relative, then we need to choose where to put it.
-            ssh chooses $HOME but we aren't guaranteed that a home dir will
-            exist in any given chroot.  So for now we're choosing "/" instead.
-            This also happens to be the former default.
-
-            Can revisit using $HOME instead if it's a problem
-        '''
-        if not remote_path.startswith(os.path.sep):
-            remote_path = os.path.join(os.path.sep, remote_path)
-        return os.path.normpath(remote_path)
-
-    def put_file(self, in_path, out_path):
-        """ Transfer a file from local to the container """
-        super(Connection, self).put_file(in_path, out_path)
-        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._play_context.remote_addr)
-
-        out_path = self._prefix_login_path(out_path)
-        if not os.path.exists(to_bytes(in_path, errors='surrogate_or_strict')):
-            raise AnsibleFileNotFound(
-                "file or module does not exist: %s" % in_path)
-
-        out_path = shlex_quote(out_path)
-        # kubectl doesn't have native support for copying files into
-        # running containers, so we use kubectl exec to implement this
-        with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
-            if not os.fstat(in_file.fileno()).st_size:
-                count = ' count=0'
-            else:
-                count = ''
-            args = self._build_exec_cmd([self._play_context.executable, "-c", "dd of=%s bs=%s%s" % (out_path, BUFSIZE, count)])
-            args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
-            try:
-                p = subprocess.Popen(args, stdin=in_file,
-                                     stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-            except OSError:
-                raise AnsibleError("kubectl connection requires dd command in the container to put files")
-            stdout, stderr = p.communicate()
-
-            if p.returncode != 0:
-                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
-
-    def fetch_file(self, in_path, out_path):
-        """ Fetch a file from container to local. """
-        super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._play_context.remote_addr)
-
-        in_path = self._prefix_login_path(in_path)
-        out_dir = os.path.dirname(out_path)
-
-        # kubectl doesn't have native support for fetching files from
-        # running containers, so we use kubectl exec to implement this
-        args = self._build_exec_cmd([self._play_context.executable, "-c", "dd if=%s bs=%s" % (in_path, BUFSIZE)])
-        args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
-        actual_out_path = os.path.join(out_dir, os.path.basename(in_path))
-        with open(to_bytes(actual_out_path, errors='surrogate_or_strict'), 'wb') as out_file:
-            try:
-                p = subprocess.Popen(args, stdin=subprocess.PIPE,
-                                     stdout=out_file, stderr=subprocess.PIPE)
-            except OSError:
-                raise AnsibleError(
-                    "{0} connection requires dd command in the container to fetch files".format(self.transport)
-                )
-            stdout, stderr = p.communicate()
-
-            if p.returncode != 0:
-                raise AnsibleError("failed to fetch file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
-
-        if actual_out_path != out_path:
-            os.rename(to_bytes(actual_out_path, errors='strict'), to_bytes(out_path, errors='strict'))
-
-    def close(self):
-        """ Terminate the connection. Nothing to do for kubectl"""
-        super(Connection, self).close()
-        self._connected = False

plugins/connection/libvirt_lxc.py

@@ -1,181 +0,0 @@
-# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
-# Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
-# (c) 2013, Michael Scherer <misc@zarb.org>
-# (c) 2015, Toshio Kuratomi <tkuratomi@ansible.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 = '''
-    author: Michael Scherer <misc@zarb.org>
-    connection: libvirt_lxc
-    short_description: Run tasks in lxc containers via libvirt
-    description:
-        - Run commands or put/fetch files to an existing lxc container using libvirt
-    options:
-      remote_addr:
-        description:
-            - Container identifier
-        default: The set user as per docker's configuration
-        vars:
-            - name: ansible_host
-            - name: ansible_libvirt_lxc_host
-'''
-
-import distutils.spawn
-import os
-import os.path
-import subprocess
-import traceback
-
-from ansible import constants as C
-from ansible.errors import AnsibleError
-from ansible.module_utils.six.moves import shlex_quote
-from ansible.module_utils._text import to_bytes
-from ansible.plugins.connection import ConnectionBase, BUFSIZE
-from ansible.utils.display import Display
-
-display = Display()
-
-
-class Connection(ConnectionBase):
-    ''' Local lxc based connections '''
-
-    transport = 'community.general.libvirt_lxc'
-    has_pipelining = True
-    # su currently has an undiagnosed issue with calculating the file
-    # checksums (so copy, for instance, doesn't work right)
-    # Have to look into that before re-enabling this
-    default_user = 'root'
-    has_tty = False
-
-    def __init__(self, play_context, new_stdin, *args, **kwargs):
-        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
-        self.lxc = self._play_context.remote_addr
-
-        self.virsh = self._search_executable('virsh')
-
-        self._check_domain(self.lxc)
-
-    def _search_executable(self, executable):
-        cmd = distutils.spawn.find_executable(executable)
-        if not cmd:
-            raise AnsibleError("%s command not found in PATH") % executable
-        return cmd
-
-    def _check_domain(self, domain):
-        p = subprocess.Popen([self.virsh, '-q', '-c', 'lxc:///', 'dominfo', to_bytes(domain)],
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        p.communicate()
-        if p.returncode:
-            raise AnsibleError("%s is not a lxc defined in libvirt" % domain)
-
-    def _connect(self):
-        ''' connect to the lxc; nothing to do here '''
-        super(Connection, self)._connect()
-        if not self._connected:
-            display.vvv("THIS IS A LOCAL LXC DIR", host=self.lxc)
-            self._connected = True
-
-    def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
-        ''' run a command on the chroot.  This is only needed for implementing
-        put_file() get_file() so that we don't have to read the whole file
-        into memory.
-
-        compared to exec_command() it looses some niceties like being able to
-        return the process's exit code immediately.
-        '''
-        executable = C.DEFAULT_EXECUTABLE.split()[0] if C.DEFAULT_EXECUTABLE else '/bin/sh'
-        local_cmd = [self.virsh, '-q', '-c', 'lxc:///', 'lxc-enter-namespace']
-
-        if C.DEFAULT_LIBVIRT_LXC_NOSECLABEL:
-            local_cmd += ['--noseclabel']
-
-        local_cmd += [self.lxc, '--', executable, '-c', cmd]
-
-        display.vvv("EXEC %s" % (local_cmd,), host=self.lxc)
-        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
-        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
-                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-
-        return p
-
-    def exec_command(self, cmd, in_data=None, sudoable=False):
-        ''' run a command on the chroot '''
-        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
-
-        p = self._buffered_exec_command(cmd)
-
-        stdout, stderr = p.communicate(in_data)
-        return (p.returncode, stdout, stderr)
-
-    def _prefix_login_path(self, remote_path):
-        ''' Make sure that we put files into a standard path
-
-            If a path is relative, then we need to choose where to put it.
-            ssh chooses $HOME but we aren't guaranteed that a home dir will
-            exist in any given chroot.  So for now we're choosing "/" instead.
-            This also happens to be the former default.
-
-            Can revisit using $HOME instead if it's a problem
-        '''
-        if not remote_path.startswith(os.path.sep):
-            remote_path = os.path.join(os.path.sep, remote_path)
-        return os.path.normpath(remote_path)
-
-    def put_file(self, in_path, out_path):
-        ''' transfer a file from local to lxc '''
-        super(Connection, self).put_file(in_path, out_path)
-        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.lxc)
-
-        out_path = shlex_quote(self._prefix_login_path(out_path))
-        try:
-            with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
-                if not os.fstat(in_file.fileno()).st_size:
-                    count = ' count=0'
-                else:
-                    count = ''
-                try:
-                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
-                except OSError:
-                    raise AnsibleError("chroot connection requires dd command in the chroot")
-                try:
-                    stdout, stderr = p.communicate()
-                except Exception:
-                    traceback.print_exc()
-                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
-                if p.returncode != 0:
-                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
-        except IOError:
-            raise AnsibleError("file or module does not exist at: %s" % in_path)
-
-    def fetch_file(self, in_path, out_path):
-        ''' fetch a file from lxc to local '''
-        super(Connection, self).fetch_file(in_path, out_path)
-        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.lxc)
-
-        in_path = shlex_quote(self._prefix_login_path(in_path))
-        try:
-            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
-        except OSError:
-            raise AnsibleError("chroot connection requires dd command in the chroot")
-
-        with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb+') as out_file:
-            try:
-                chunk = p.stdout.read(BUFSIZE)
-                while chunk:
-                    out_file.write(chunk)
-                    chunk = p.stdout.read(BUFSIZE)
-            except Exception:
-                traceback.print_exc()
-                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
-            stdout, stderr = p.communicate()
-            if p.returncode != 0:
-                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
-
-    def close(self):
-        ''' terminate the connection; nothing to do here '''
-        super(Connection, self).close()
-        self._connected = False