?????????? ????????? - ??????????????? - /home/agenciai/public_html/cd38d8/ansible.zip
???????
PK � �[ @B!f f ansible.cfgnu �[��� # Since Ansible 2.12 (core): # To generate an example config file (a "disabled" one with all default settings, commented out): # $ ansible-config init --disabled > ansible.cfg # # Also you can now have a more complete file by including existing plugins: # ansible-config init --disabled -t all > ansible.cfg # For previous versions of Ansible you can check for examples in the 'stable' branches of each version # Note that this file was always incomplete and lagging changes to configuration settings # for example, for 2.9: https://github.com/ansible/ansible/blob/stable-2.9/examples/ansible.cfg PK � �[�}~� � hostsnu �[��� # This is the default ansible 'hosts' file. # # It should live in /etc/ansible/hosts # # - Comments begin with the '#' character # - Blank lines are ignored # - Groups of hosts are delimited by [header] elements # - You can enter hostnames or ip addresses # - A hostname/ip can be a member of multiple groups # Ex 1: Ungrouped hosts, specify before any group headers: ## green.example.com ## blue.example.com ## 192.168.100.1 ## 192.168.100.10 # Ex 2: A collection of hosts belonging to the 'webservers' group: ## [webservers] ## alpha.example.org ## beta.example.org ## 192.168.1.100 ## 192.168.1.110 # If you have multiple hosts following a pattern, you can specify # them like this: ## www[001:006].example.com # You can also use ranges for multiple hosts: ## db-[99:101]-node.example.com # Ex 3: A collection of database servers in the 'dbservers' group: ## [dbservers] ## ## db01.intranet.mydomain.net ## db02.intranet.mydomain.net ## 10.25.1.56 ## 10.25.1.57 # Ex4: Multiple hosts arranged into groups such as 'Debian' and 'openSUSE': ## [Debian] ## alpha.example.org ## beta.example.org ## [openSUSE] ## green.example.com ## blue.example.com PK $�!\�8�~� � B collections/ansible_collections/community/general/commit-rights.mdnu �[��� <!-- Copyright (c) Ansible Project GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) SPDX-License-Identifier: GPL-3.0-or-later --> 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 | | PK $�!\I�t�Z# Z# A collections/ansible_collections/community/general/CONTRIBUTING.mdnu �[��� <!-- Copyright (c) Ansible Project GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) SPDX-License-Identifier: GPL-3.0-or-later --> # 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 repository checkout. * Make sure your PR includes a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#creating-changelog-fragments). (You must not include a fragment for new modules or new plugins. Also you shouldn't include one for docs-only changes. If you're not sure, simply don't include one, we'll tell you whether one is needed or not :) ) * Avoid reformatting unrelated parts of the codebase in your PR. These types of changes will likely be requested for reversion, create additional work for reviewers, and may cause approval to be delayed. You can also read [our Quick-start development guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst). ## 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. ## Run sanity, unit or integration tests locally You have to check out the repository into a specific path structure to be able to run `ansible-test`. The path to the git checkout must end with `.../ansible_collections/community/general`. Please see [our testing guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst) for instructions on how to check out the repository into a correct path structure. The short version of these instructions is: ```.bash mkdir -p ~/dev/ansible_collections/community git clone https://github.com/ansible-collections/community.general.git ~/dev/ansible_collections/community/general cd ~/dev/ansible_collections/community/general ``` Then you can run `ansible-test` (which is a part of [ansible-core](https://pypi.org/project/ansible-core/)) inside the checkout. The following example commands expect that you have installed Docker or Podman. Note that Podman has only been supported by more recent ansible-core releases. If you are using Docker, the following will work with Ansible 2.9+. The following commands show how to run sanity tests: ```.bash # Run sanity tests for all files in the collection: ansible-test sanity --docker -v # Run sanity tests for the given files and directories: ansible-test sanity --docker -v plugins/modules/system/pids.py tests/integration/targets/pids/ ``` The following commands show how to run unit tests: ```.bash # Run all unit tests: ansible-test units --docker -v # Run all unit tests for one Python version (a lot faster): ansible-test units --docker -v --python 3.8 # Run a specific unit test (for the nmcli module) for one Python version: ansible-test units --docker -v --python 3.8 tests/unit/plugins/modules/net_tools/test_nmcli.py ``` The following commands show how to run integration tests: ```.bash # Run integration tests for the interfaces_files module in a Docker container using the # fedora35 operating system image (the supported images depend on your ansible-core version): ansible-test integration --docker fedora35 -v interfaces_file # Run integration tests for the flattened lookup **without any isolation**: ansible-test integration -v lookup_flattened ``` If you are unsure about the integration test target name for a module or plugin, you can take a look in `tests/integration/targets/`. Tests for plugins have the plugin type prepended. ## Creating new modules or plugins Creating new modules and plugins requires a bit more work than other Pull Requests. 1. Please make sure that your new module or plugin is of interest to a larger audience. Very specialized modules or plugins that can only be used by very few people should better be added to more specialized collections. 2. Please do not add more than one plugin/module in one PR, especially if it is the first plugin/module you are contributing. That makes it easier for reviewers, and increases the chance that your PR will get merged. If you plan to contribute a group of plugins/modules (say, more than a module and a corresponding ``_info`` module), please mention that in the first PR. In such cases, you also have to think whether it is better to publish the group of plugins/modules in a new collection. 3. When creating a new module or plugin, please make sure that you follow various guidelines: - Follow [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html); - Follow [documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and the [Ansible style guide](https://docs.ansible.com/ansible/devel/dev_guide/style_guide/index.html#style-guide); - Make sure your modules and plugins are [GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0-standalone.html) licensed (new module_utils can also be [BSD-2-clause](https://opensource.org/licenses/BSD-2-Clause) licensed); - Make sure that new plugins and modules have tests (unit tests, integration tests, or both); it is preferable to have some tests which run in CI. 4. Action plugins need to be accompanied by a module, even if the module file only contains documentation (`DOCUMENTATION`, `EXAMPLES` and `RETURN`). The module must have the same name and directory path in `plugins/modules/` than the action plugin has in `plugins/action/`. 5. Make sure to add a BOTMETA entry for your new module/plugin in `.github/BOTMETA.yml`. Search for other plugins/modules in the same directory to see how entries could look. You should list all authors either as `maintainers` or under `ignore`. People listed as `maintainers` will be pinged for new issues and PRs that modify the module/plugin or its tests. When you add a new plugin/module, we expect that you perform maintainer duty for at least some time after contributing it. PK $�!\�/C� � H collections/ansible_collections/community/general/changelogs/config.yamlnu �[��� --- # Copyright (c) Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later 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 PK $�!\�稼ʷ ʷ K collections/ansible_collections/community/general/changelogs/changelog.yamlnu �[��� ancestor: 6.0.0 releases: 7.0.0: changes: breaking_changes: - 'If you are not using this collection as part of Ansible, but installed (and/or upgraded) community.general manually, you need to make sure to also install ``community.sap_libs`` if you are using any of the ``sapcar_extract``, ``sap_task_list_execute``, and ``hana_query`` modules. Without that collection installed, the redirects for these modules do not work. ' - 'ModuleHelper module utils - when the module sets output variables named ``msg``, ``exception``, ``output``, ``vars``, or ``changed``, the actual output will prefix those names with ``_`` (underscore symbol) only when they clash with output variables generated by ModuleHelper itself, which only occurs when handling exceptions. Please note that this breaking change does not require a new major release since before this release, it was not possible to add such variables to the output `due to a bug <https://github.com/ansible-collections/community.general/pull/5755>`__ (https://github.com/ansible-collections/community.general/pull/5765). ' - gconftool2 - fix processing of ``gconftool-2`` when ``key`` does not exist, returning ``null`` instead of empty string for both ``value`` and ``previous_value`` return values (https://github.com/ansible-collections/community.general/issues/6028). - gitlab_runner - the default of ``access_level_on_creation`` changed from ``false`` to ``true`` (https://github.com/ansible-collections/community.general/pull/6428). - ldap_search - convert all string-like values to UTF-8 (https://github.com/ansible-collections/community.general/issues/5704, https://github.com/ansible-collections/community.general/pull/6473). - nmcli - the default of the ``hairpin`` option changed from ``true`` to ``false`` (https://github.com/ansible-collections/community.general/pull/6428). - proxmox - the default of the ``unprivileged`` option changed from ``false`` to ``true`` (https://github.com/ansible-collections/community.general/pull/6428). bugfixes: - ModuleHelper - fix bug when adjusting the name of reserved output variables (https://github.com/ansible-collections/community.general/pull/5755). - alternatives - support subcommands on Fedora 37, which uses ``follower`` instead of ``slave`` (https://github.com/ansible-collections/community.general/pull/5794). - ansible_galaxy_install - set default to raise exception if command's return code is different from zero (https://github.com/ansible-collections/community.general/pull/5680). - ansible_galaxy_install - try ``C.UTF-8`` and then fall back to ``en_US.UTF-8`` before failing (https://github.com/ansible-collections/community.general/pull/5680). - archive - avoid deprecated exception class on Python 3 (https://github.com/ansible-collections/community.general/pull/6180). - archive - reduce RAM usage by generating CRC32 checksum over chunks (https://github.com/ansible-collections/community.general/pull/6274). - bitwarden lookup plugin - clarify what to do, if the bitwarden vault is not unlocked (https://github.com/ansible-collections/community.general/pull/5811). - cartesian and flattened lookup plugins - adjust to parameter deprecation in ansible-core 2.14's ``listify_lookup_plugin_terms`` helper function (https://github.com/ansible-collections/community.general/pull/6074). - chroot connection plugin - add ``inventory_hostname`` to vars under ``remote_addr``. This is needed for compatibility with ansible-core 2.13 (https://github.com/ansible-collections/community.general/pull/5570). - cloudflare_dns - fixed the idempotency for SRV DNS records (https://github.com/ansible-collections/community.general/pull/5972). - cloudflare_dns - fixed the possiblity of setting a root-level SRV DNS record (https://github.com/ansible-collections/community.general/pull/5972). - cmd_runner module utils - fixed bug when handling default cases in ``cmd_runner_fmt.as_map()`` (https://github.com/ansible-collections/community.general/pull/5538). - cmd_runner module utils - formatting arguments ``cmd_runner_fmt.as_fixed()`` was expecting an non-existing argument (https://github.com/ansible-collections/community.general/pull/5538). - dependent lookup plugin - avoid warning on deprecated parameter for ``Templar.template()`` (https://github.com/ansible-collections/community.general/pull/5543). - deps module utils - do not fail when dependency cannot be found (https://github.com/ansible-collections/community.general/pull/6479). - dig lookup plugin - correctly handle DNSKEY record type's ``algorithm`` field (https://github.com/ansible-collections/community.general/pull/5914). - flatpak - fixes idempotency detection issues. In some cases the module could fail to properly detect already existing Flatpaks because of a parameter witch only checks the installed apps (https://github.com/ansible-collections/community.general/pull/6289). - gconftool2 - fix ``changed`` result always being ``true`` (https://github.com/ansible-collections/community.general/issues/6028). - gconftool2 - remove requirement of parameter ``value`` when ``state=absent`` (https://github.com/ansible-collections/community.general/issues/6028). - gem - fix force parameter not being passed to gem command when uninstalling (https://github.com/ansible-collections/community.general/pull/5822). - gem - fix hang due to interactive prompt for confirmation on specific version uninstall (https://github.com/ansible-collections/community.general/pull/5751). - github_webhook - fix always changed state when no secret is provided (https://github.com/ansible-collections/community.general/pull/5994). - gitlab_deploy_key - also update ``title`` and not just ``can_push`` (https://github.com/ansible-collections/community.general/pull/5888). - gitlab_group_variables - fix dropping variables accidentally when GitLab introduced new properties (https://github.com/ansible-collections/community.general/pull/5667). - gitlab_project_variables - fix dropping variables accidentally when GitLab introduced new properties (https://github.com/ansible-collections/community.general/pull/5667). - gitlab_runner - fix ``KeyError`` on runner creation and update (https://github.com/ansible-collections/community.general/issues/6112). - icinga2_host - fix the data structure sent to Icinga to make use of host templates and template vars (https://github.com/ansible-collections/community.general/pull/6286). - idrac_redfish_command - allow user to specify ``resource_id`` for ``CreateBiosConfigJob`` to specify an exact manager (https://github.com/ansible-collections/community.general/issues/2090). - influxdb_user - fix running in check mode when the user does not exist yet (https://github.com/ansible-collections/community.general/pull/6111). - ini_file - make ``section`` parameter not required so it is possible to pass ``null`` as a value. This only was possible in the past due to a bug in ansible-core that now has been fixed (https://github.com/ansible-collections/community.general/pull/6404). - interfaces_file - fix reading options in lines not starting with a space (https://github.com/ansible-collections/community.general/issues/6120). - jail connection plugin - add ``inventory_hostname`` to vars under ``remote_addr``. This is needed for compatibility with ansible-core 2.13 (https://github.com/ansible-collections/community.general/pull/6118). - jenkins_build - fix the logical flaw when deleting a Jenkins build (https://github.com/ansible-collections/community.general/pull/5514). - jenkins_plugin - fix error due to undefined variable when updates file is not downloaded (https://github.com/ansible-collections/community.general/pull/6100). - keycloak - improve error messages (https://github.com/ansible-collections/community.general/pull/6318). - keycloak_client - fix accidental replacement of value for attribute ``saml.signing.private.key`` with ``no_log`` in wrong contexts (https://github.com/ansible-collections/community.general/pull/5934). - keycloak_client_rolemapping - calculate ``proposed`` and ``after`` return values properly (https://github.com/ansible-collections/community.general/pull/5619). - keycloak_client_rolemapping - remove only listed mappings with ``state=absent`` (https://github.com/ansible-collections/community.general/pull/5619). - keycloak_user_federation - fixes federation creation issue. When a new federation was created and at the same time a default / standard mapper was also changed / updated the creation process failed as a bad None set variable led to a bad malformed url request (https://github.com/ansible-collections/community.general/pull/5750). - 'keycloak_user_federation - fixes idempotency detection issues. In some cases the module could fail to properly detect already existing user federations because of a buggy seemingly superflous extra query parameter (https://github.com/ansible-collections/community.general/pull/5732). ' - loganalytics callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - logdna callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - logstash callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - lxc_container - fix the arguments of the lxc command which broke the creation and cloning of containers (https://github.com/ansible-collections/community.general/issues/5578). - lxd_* modules, lxd inventory plugin - fix TLS/SSL certificate validation problems by using the correct purpose when creating the TLS context (https://github.com/ansible-collections/community.general/issues/5616, https://github.com/ansible-collections/community.general/pull/6034). - memset - fix memset urlerror handling (https://github.com/ansible-collections/community.general/pull/6114). - nmcli - fix change handling of values specified as an integer 0 (https://github.com/ansible-collections/community.general/pull/5431). - nmcli - fix failure to handle WIFI settings when connection type not specified (https://github.com/ansible-collections/community.general/pull/5431). - nmcli - fix improper detection of changes to ``wifi.wake-on-wlan`` (https://github.com/ansible-collections/community.general/pull/5431). - nmcli - fixed idempotency issue for bridge connections. Module forced default value of ``bridge.priority`` to nmcli if not set; if ``bridge.stp`` is disabled nmcli ignores it and keep default (https://github.com/ansible-collections/community.general/issues/3216, https://github.com/ansible-collections/community.general/issues/4683). - nmcli - fixed idempotency issue when module params is set to ``may_fail4=false`` and ``method4=disabled``; in this case nmcli ignores change and keeps their own default value ``yes`` (https://github.com/ansible-collections/community.general/pull/6106). - nmcli - implemented changing mtu value on vlan interfaces (https://github.com/ansible-collections/community.general/issues/4387). - nmcli - order is significant for lists of addresses (https://github.com/ansible-collections/community.general/pull/6048). - nsupdate - fix zone lookup. The SOA record for an existing zone is returned as an answer RR and not as an authority RR (https://github.com/ansible-collections/community.general/issues/5817, https://github.com/ansible-collections/community.general/pull/5818). - one_vm - avoid splitting labels that are ``None`` (https://github.com/ansible-collections/community.general/pull/5489). - one_vm - fix syntax error when creating VMs with a more complex template (https://github.com/ansible-collections/community.general/issues/6225). - onepassword lookup plugin - Changed to ignore errors from "op account get" calls. Previously, errors would prevent auto-signin code from executing (https://github.com/ansible-collections/community.general/pull/5942). - onepassword_raw - add missing parameter to plugin documentation (https://github.com/ansible-collections/community.general/issues/5506). - opkg - fix issue that ``force=reinstall`` would not reinstall an existing package (https://github.com/ansible-collections/community.general/pull/5705). - opkg - fixes bug when using ``update_cache=true`` (https://github.com/ansible-collections/community.general/issues/6004). - passwordstore lookup plugin - make compatible with ansible-core 2.16 (https://github.com/ansible-collections/community.general/pull/6447). - pipx - fixed handling of ``install_deps=true`` with ``state=latest`` and ``state=upgrade`` (https://github.com/ansible-collections/community.general/pull/6303). - 'portage - update the logic for generating the emerge command arguments to ensure that ``withbdeps: false`` results in a passing an ``n`` argument with the ``--with-bdeps`` emerge flag (https://github.com/ansible-collections/community.general/issues/6451, https://github.com/ansible-collections/community.general/pull/6456).' - proxmox inventory plugin - fix bug while templating when using templates for the ``url``, ``user``, ``password``, ``token_id``, or ``token_secret`` options (https://github.com/ansible-collections/community.general/pull/5640). - proxmox inventory plugin - handle tags delimited by semicolon instead of comma, which happens from Proxmox 7.3 on (https://github.com/ansible-collections/community.general/pull/5602). - proxmox_disk - avoid duplicate ``vmid`` reference (https://github.com/ansible-collections/community.general/issues/5492, https://github.com/ansible-collections/community.general/pull/5493). - proxmox_disk - fixed issue with read timeout on import action (https://github.com/ansible-collections/community.general/pull/5803). - proxmox_disk - fixed possible issues with redundant ``vmid`` parameter (https://github.com/ansible-collections/community.general/issues/5492, https://github.com/ansible-collections/community.general/pull/5672). - proxmox_nic - fixed possible issues with redundant ``vmid`` parameter (https://github.com/ansible-collections/community.general/issues/5492, https://github.com/ansible-collections/community.general/pull/5672). - puppet - handling ``noop`` parameter was not working at all, now it is has been fixed (https://github.com/ansible-collections/community.general/issues/6452, https://github.com/ansible-collections/community.general/issues/6458). - redfish_utils - removed basic auth HTTP header when performing a GET on the service root resource and when performing a POST to the session collection (https://github.com/ansible-collections/community.general/issues/5886). - redhat_subscription - do not ignore ``consumer_name`` and other variables if ``activationkey`` is specified (https://github.com/ansible-collections/community.general/issues/3486, https://github.com/ansible-collections/community.general/pull/5627). - redhat_subscription - do not pass arguments to ``subscription-manager register`` for things already configured; now a specified ``rhsm_baseurl`` is properly set for subscription-manager (https://github.com/ansible-collections/community.general/pull/5583). - redhat_subscription - do not use D-Bus for registering when ``environment`` is specified, so it possible to specify again the environment names for registering, as the D-Bus APIs work only with IDs (https://github.com/ansible-collections/community.general/pull/6319). - redhat_subscription - try to unregister only when already registered when ``force_register`` is specified (https://github.com/ansible-collections/community.general/issues/6258, https://github.com/ansible-collections/community.general/pull/6259). - redhat_subscription - use the right D-Bus options for environments when registering a CentOS Stream 8 system and using ``environment`` (https://github.com/ansible-collections/community.general/pull/6275). - redhat_subscription, rhsm_release, rhsm_repository - cleanly fail when not running as root, rather than hanging on an interactive ``console-helper`` prompt; they all interact with ``subscription-manager``, which already requires to be run as root (https://github.com/ansible-collections/community.general/issues/734, https://github.com/ansible-collections/community.general/pull/6211). - rhsm_release - make ``release`` parameter not required so it is possible to pass ``null`` as a value. This only was possible in the past due to a bug in ansible-core that now has been fixed (https://github.com/ansible-collections/community.general/pull/6401). - rundeck module utils - fix errors caused by the API empty responses (https://github.com/ansible-collections/community.general/pull/6300) - rundeck_acl_policy - fix ``TypeError - byte indices must be integers or slices, not str`` error caused by empty API response. Update the module to use ``module_utils.rundeck`` functions (https://github.com/ansible-collections/community.general/pull/5887, https://github.com/ansible-collections/community.general/pull/6300). - rundeck_project - update the module to use ``module_utils.rundeck`` functions (https://github.com/ansible-collections/community.general/issues/5742) (https://github.com/ansible-collections/community.general/pull/6300) - snap_alias - module would only recognize snap names containing letter, numbers or the underscore character, failing to identify valid snap names such as ``lxd.lxc`` (https://github.com/ansible-collections/community.general/pull/6361). - splunk callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - sumologic callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - syslog_json callback plugin - adjust type of callback to ``notification``, it was incorrectly classified as ``aggregate`` before (https://github.com/ansible-collections/community.general/pull/5761). - terraform - fix ``current`` workspace never getting appended to the ``all`` key in the ``workspace_ctf`` object (https://github.com/ansible-collections/community.general/pull/5735). - terraform - fix ``terraform init`` failure when there are multiple workspaces on the remote backend and when ``default`` workspace is missing by setting ``TF_WORKSPACE`` environmental variable to the value of ``workspace`` when used (https://github.com/ansible-collections/community.general/pull/5735). - terraform - fix broken ``warn()`` call (https://github.com/ansible-collections/community.general/pull/6497). - terraform and timezone - slight refactoring to avoid linter reporting potentially undefined variables (https://github.com/ansible-collections/community.general/pull/5933). - terraform module - disable ANSI escape sequences during validation phase (https://github.com/ansible-collections/community.general/pull/5843). - tss lookup plugin - allow to download secret attachments. Previously, we could not download secret attachments but now use ``fetch_attachments`` and ``file_download_path`` variables to download attachments (https://github.com/ansible-collections/community.general/issues/6224). - unixy callback plugin - fix plugin to work with ansible-core 2.14 by using Ansible's configuration manager for handling options (https://github.com/ansible-collections/community.general/issues/5600). - unixy callback plugin - fix typo introduced when updating to use Ansible's configuration manager for handling options (https://github.com/ansible-collections/community.general/issues/5600). - various plugins and modules - remove unnecessary imports (https://github.com/ansible-collections/community.general/pull/5940). - vdo - now uses ``yaml.safe_load()`` to parse command output instead of the deprecated ``yaml.load()`` which is potentially unsafe. Using ``yaml.load()`` without explicitely setting a ``Loader=`` is also an error in pyYAML 6.0 (https://github.com/ansible-collections/community.general/pull/5632). - vmadm - fix for index out of range error in ``get_vm_uuid`` (https://github.com/ansible-collections/community.general/pull/5628). - xenorchestra inventory plugin - fix failure to receive objects from server due to not checking the id of the response (https://github.com/ansible-collections/community.general/pull/6227). - xfs_quota - in case of a project quota, the call to ``xfs_quota`` did not initialize/reset the project (https://github.com/ansible-collections/community.general/issues/5143). - xml - fixed a bug where empty ``children`` list would not be set (https://github.com/ansible-collections/community.general/pull/5808). - yarn - fix ``global=true`` to check for the configured global folder instead of assuming the default (https://github.com/ansible-collections/community.general/pull/5829) - yarn - fix ``global=true`` to not fail when `executable` wasn't specified (https://github.com/ansible-collections/community.general/pull/6132) - yarn - fix ``state=absent`` not working with ``global=true`` when the package does not include a binary (https://github.com/ansible-collections/community.general/pull/5829) - yarn - fix ``state=latest`` not working with ``global=true`` (https://github.com/ansible-collections/community.general/issues/5712). - yarn - fixes bug where yarn module tasks would fail when warnings were emitted from Yarn. The ``yarn.list`` method was not filtering out warnings (https://github.com/ansible-collections/community.general/issues/6127). - zfs_delegate_admin - zfs allow output can now be parsed when uids/gids are not known to the host system (https://github.com/ansible-collections/community.general/pull/5943). - zypper - make package managing work on readonly filesystem of openSUSE MicroOS (https://github.com/ansible-collections/community.general/pull/5615). deprecated_features: - ModuleHelper module_utils - ``deps`` mixin for MH classes deprecated in favour of using the ``deps`` module_utils (https://github.com/ansible-collections/community.general/pull/6465). - consul - deprecate using parameters unused for ``state=absent`` (https://github.com/ansible-collections/community.general/pull/5772). - gitlab_runner - the default of the new option ``access_level_on_creation`` will change from ``false`` to ``true`` in community.general 7.0.0. This will cause ``access_level`` to be used during runner registration as well, and not only during updates (https://github.com/ansible-collections/community.general/pull/5908). - gitlab_runner - the option ``access_level`` will lose its default value in community.general 8.0.0. From that version on, you have set this option to ``ref_protected`` explicitly, if you want to have a protected runner (https://github.com/ansible-collections/community.general/issues/5925). - manageiq_policies - deprecate ``state=list`` in favour of using ``community.general.manageiq_policies_info`` (https://github.com/ansible-collections/community.general/pull/5721). - manageiq_tags - deprecate ``state=list`` in favour of using ``community.general.manageiq_tags_info`` (https://github.com/ansible-collections/community.general/pull/5727). - rax - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax module utils - module utils code relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_cbs - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_cbs_attachments - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_cdb - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_cdb_database - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_cdb_user - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_clb - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_clb_nodes - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_clb_ssl - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_dns - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_dns_record - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_facts - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_files - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_files_objects - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_identity - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_keypair - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_meta - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_mon_alarm - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_mon_check - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_mon_entity - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_mon_notification - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_mon_notification_plan - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_network - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_queue - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_scaling_group - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - rax_scaling_policy - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752). - 'rhn_channel, rhn_register - RHN hosted at redhat.com was discontinued years ago, and Spacewalk 5 (which uses RHN) is EOL since 2020, May 31st; while these modules could work on Uyuni / SUSE Manager (fork of Spacewalk 5), we have not heard about anyone using them in those setups. Hence, these modules are deprecated, and will be removed in community.general 10.0.0 in case there are no reports about being still useful, and potentially no one that steps up to maintain them (https://github.com/ansible-collections/community.general/pull/6493). ' minor_changes: - apache2_module - add module argument ``warn_mpm_absent`` to control whether warning are raised in some edge cases (https://github.com/ansible-collections/community.general/pull/5793). - apt_rpm - adds ``clean``, ``dist_upgrade`` and ``update_kernel`` parameters for clear caches, complete upgrade system, and upgrade kernel packages (https://github.com/ansible-collections/community.general/pull/5867). - bitwarden lookup plugin - can now retrieve secrets from custom fields (https://github.com/ansible-collections/community.general/pull/5694). - bitwarden lookup plugin - implement filtering results by ``collection_id`` parameter (https://github.com/ansible-collections/community.general/issues/5849). - cmd_runner module utils - ``cmd_runner_fmt.as_bool()`` can now take an extra parameter to format when value is false (https://github.com/ansible-collections/community.general/pull/5647). - cpanm - minor change, use feature from ``ModuleHelper`` (https://github.com/ansible-collections/community.general/pull/6385). - 'dconf - be forgiving about boolean values: convert them to GVariant booleans automatically (https://github.com/ansible-collections/community.general/pull/6206).' - dconf - if ``gi.repository.GLib`` is missing, try to respawn in a Python interpreter that has it (https://github.com/ansible-collections/community.general/pull/6491). - dconf - minor refactoring improving parameters and dependencies validation (https://github.com/ansible-collections/community.general/pull/6336). - dconf - parse GVariants for equality comparison when the Python module ``gi.repository`` is available (https://github.com/ansible-collections/community.general/pull/6049). - deps module utils - add function ``failed()`` providing the ability to check the dependency check result without triggering an exception (https://github.com/ansible-collections/community.general/pull/6383). - dig lookup plugin - Support multiple domains to be queried as indicated in docs (https://github.com/ansible-collections/community.general/pull/6334). - dig lookup plugin - support CAA record type (https://github.com/ansible-collections/community.general/pull/5913). - dnsimple - set custom User-Agent for API requests to DNSimple (https://github.com/ansible-collections/community.general/pull/5927). - dnsimple_info - minor refactor in the code (https://github.com/ansible-collections/community.general/pull/6440). - flatpak_remote - add new boolean option ``enabled``. It controls, whether the remote is enabled or not (https://github.com/ansible-collections/community.general/pull/5926). - gconftool2 - refactor using ``ModuleHelper`` and ``CmdRunner`` (https://github.com/ansible-collections/community.general/pull/5545). - gitlab_group_variable, gitlab_project_variable - refactor function out to module utils (https://github.com/ansible-collections/community.general/pull/6384). - gitlab_project - add ``builds_access_level``, ``container_registry_access_level`` and ``forking_access_level`` options (https://github.com/ansible-collections/community.general/pull/5706). - gitlab_project - add ``releases_access_level``, ``environments_access_level``, ``feature_flags_access_level``, ``infrastructure_access_level``, ``monitor_access_level``, and ``security_and_compliance_access_level`` options (https://github.com/ansible-collections/community.general/pull/5986). - gitlab_project - add new option ``topics`` for adding topics to GitLab projects (https://github.com/ansible-collections/community.general/pull/6278). - gitlab_runner - add new boolean option ``access_level_on_creation``. It controls, whether the value of ``access_level`` is used for runner registration or not. The option ``access_level`` has been ignored on registration so far and was only used on updates (https://github.com/ansible-collections/community.general/issues/5907, https://github.com/ansible-collections/community.general/pull/5908). - gitlab_runner - allow to register group runner (https://github.com/ansible-collections/community.general/pull/3935). - homebrew_cask - allows passing ``--greedy`` option to ``upgrade_all`` (https://github.com/ansible-collections/community.general/pull/6267). - idrac_redfish_command - add ``job_id`` to ``CreateBiosConfigJob`` response (https://github.com/ansible-collections/community.general/issues/5603). - ilo_redfish_utils module utils - change implementation of DNS Server IP and NTP Server IP update (https://github.com/ansible-collections/community.general/pull/5804). - ipa_group - allow to add and remove external users with the ``external_user`` option (https://github.com/ansible-collections/community.general/pull/5897). - ipa_hostgroup - add ``append`` parameter for adding a new hosts to existing hostgroups without changing existing hostgroup members (https://github.com/ansible-collections/community.general/pull/6203). - iptables_state - minor refactoring within the module (https://github.com/ansible-collections/community.general/pull/5844). - java_certs - add more detailed error output when extracting certificate from PKCS12 fails (https://github.com/ansible-collections/community.general/pull/5550). - jc filter plugin - added the ability to use parser plugins (https://github.com/ansible-collections/community.general/pull/6043). - jenkins_plugin - refactor code to module util to fix sanity check (https://github.com/ansible-collections/community.general/pull/5565). - jira - add worklog functionality (https://github.com/ansible-collections/community.general/issues/6209, https://github.com/ansible-collections/community.general/pull/6210). - keycloak_authentication - add flow type option to sub flows to allow the creation of 'form-flow' sub flows like in Keycloak's built-in registration flow (https://github.com/ansible-collections/community.general/pull/6318). - keycloak_group - add new optional module parameter ``parents`` to properly handle keycloak subgroups (https://github.com/ansible-collections/community.general/pull/5814). - keycloak_user_federation - make ``org.keycloak.storage.ldap.mappers.LDAPStorageMapper`` the default value for mappers ``providerType`` (https://github.com/ansible-collections/community.general/pull/5863). - ldap modules - add ``ca_path`` option (https://github.com/ansible-collections/community.general/pull/6185). - ldap modules - add ``xorder_discovery`` option (https://github.com/ansible-collections/community.general/issues/6045, https://github.com/ansible-collections/community.general/pull/6109). - ldap_search - the new ``base64_attributes`` allows to specify which attribute values should be Base64 encoded (https://github.com/ansible-collections/community.general/pull/6473). - lxd_container - add diff and check mode (https://github.com/ansible-collections/community.general/pull/5866). - lxd_project - refactored code out to module utils to clear sanity check (https://github.com/ansible-collections/community.general/pull/5549). - make - add ``command`` return value to the module output (https://github.com/ansible-collections/community.general/pull/6160). - mattermost, rocketchat, slack - replace missing default favicon with docs.ansible.com favicon (https://github.com/ansible-collections/community.general/pull/5928). - mksysb - improved the output of the module in case of errors (https://github.com/ansible-collections/community.general/issues/6263). - modprobe - add ``persistent`` option (https://github.com/ansible-collections/community.general/issues/4028, https://github.com/ansible-collections/community.general/pull/542). - module_helper module utils - updated the imports to make more MH features available at ``plugins/module_utils/module_helper.py`` (https://github.com/ansible-collections/community.general/pull/6464). - mssql_script - allow for ``GO`` statement to be mixed-case for scripts not using strict syntax (https://github.com/ansible-collections/community.general/pull/6457). - mssql_script - handle error condition for empty resultsets to allow for non-returning SQL statements (for example ``UPDATE`` and ``INSERT``) (https://github.com/ansible-collections/community.general/pull/6457). - mssql_script - improve batching logic to allow a wider variety of input scripts. For example, SQL scripts slurped from Windows machines which may contain carriage return (''\r'') characters (https://github.com/ansible-collections/community.general/pull/6457). - nmap inventory plugin - add new option ``open`` for only returning open ports (https://github.com/ansible-collections/community.general/pull/6200). - nmap inventory plugin - add new option ``port`` for port specific scan (https://github.com/ansible-collections/community.general/pull/6165). - nmap inventory plugin - add new options ``udp_scan``, ``icmp_timestamp``, and ``dns_resolve`` for different types of scans (https://github.com/ansible-collections/community.general/pull/5566). - nmap inventory plugin - added environment variables for configure ``address`` and ``exclude`` (https://github.com/ansible-collections/community.general/issues/6351). - nmcli - add ``default`` and ``default-or-eui64`` to the list of valid choices for ``addr_gen_mode6`` parameter (https://github.com/ansible-collections/community.general/pull/5974). - nmcli - add ``macvlan`` connection type (https://github.com/ansible-collections/community.general/pull/6312). - nmcli - add support for ``team.runner-fast-rate`` parameter for ``team`` connections (https://github.com/ansible-collections/community.general/issues/6065). - nmcli - new module option ``slave_type`` added to allow creation of various types of slave devices (https://github.com/ansible-collections/community.general/issues/473, https://github.com/ansible-collections/community.general/pull/6108). - one_vm - add a new ``updateconf`` option which implements the ``one.vm.updateconf`` API call (https://github.com/ansible-collections/community.general/pull/5812). - openbsd_pkg - set ``TERM`` to ``'dumb'`` in ``execute_command()`` to make module less dependant on the ``TERM`` environment variable set on the Ansible controller (https://github.com/ansible-collections/community.general/pull/6149). - opkg - allow installing a package in a certain version (https://github.com/ansible-collections/community.general/pull/5688). - opkg - refactored module to use ``CmdRunner`` for executing ``opkg`` (https://github.com/ansible-collections/community.general/pull/5718). - osx_defaults - include stderr in error messages (https://github.com/ansible-collections/community.general/pull/6011). - pipx - add ``system_site_packages`` parameter to give application access to system-wide packages (https://github.com/ansible-collections/community.general/pull/6308). - pipx - ensure ``include_injected`` parameter works with ``state=upgrade`` and ``state=latest`` (https://github.com/ansible-collections/community.general/pull/6212). - pipx - optional ``install_apps`` parameter added to install applications from injected packages (https://github.com/ansible-collections/community.general/pull/6198). - proxmox - added new module parameter ``tags`` for use with PVE 7+ (https://github.com/ansible-collections/community.general/pull/5714). - proxmox - suppress urllib3 ``InsecureRequestWarnings`` when ``validate_certs`` option is ``false`` (https://github.com/ansible-collections/community.general/pull/5931). - proxmox_kvm - add new ``archive`` parameter. This is needed to create a VM from an archive (backup) (https://github.com/ansible-collections/community.general/pull/6159). - proxmox_kvm - adds ``migrate`` parameter to manage online migrations between hosts (https://github.com/ansible-collections/community.general/pull/6448) - puppet - add new options ``skip_tags`` to exclude certain tagged resources during a puppet agent or apply (https://github.com/ansible-collections/community.general/pull/6293). - puppet - refactored module to use ``CmdRunner`` for executing ``puppet`` (https://github.com/ansible-collections/community.general/pull/5612). - rax_scaling_group - refactored out code to the ``rax`` module utils to clear the sanity check (https://github.com/ansible-collections/community.general/pull/5563). - redfish_command - add ``PerformRequestedOperations`` command to perform any operations necessary to continue the update flow (https://github.com/ansible-collections/community.general/issues/4276). - redfish_command - add ``update_apply_time`` to ``SimpleUpdate`` command (https://github.com/ansible-collections/community.general/issues/3910). - redfish_command - add ``update_status`` to output of ``SimpleUpdate`` command to allow a user monitor the update in progress (https://github.com/ansible-collections/community.general/issues/4276). - redfish_command - adding ``EnableSecureBoot`` functionality (https://github.com/ansible-collections/community.general/pull/5899). - redfish_command - adding ``VerifyBiosAttributes`` functionality (https://github.com/ansible-collections/community.general/pull/5900). - redfish_info - add ``GetUpdateStatus`` command to check the progress of a previous update request (https://github.com/ansible-collections/community.general/issues/4276). - redfish_info - adds commands to retrieve the HPE ThermalConfiguration and FanPercentMinimum settings from iLO (https://github.com/ansible-collections/community.general/pull/6208). - redfish_utils module utils - added PUT (``put_request()``) functionality (https://github.com/ansible-collections/community.general/pull/5490). - redhat_subscription - add a ``server_proxy_scheme`` parameter to configure the scheme for the proxy server (https://github.com/ansible-collections/community.general/pull/5662). - redhat_subscription - adds ``token`` parameter for subscription-manager authentication using Red Hat API token (https://github.com/ansible-collections/community.general/pull/5725). - redhat_subscription - credentials (``username``, ``activationkey``, and so on) are required now only if a system needs to be registered, or ``force_register`` is specified (https://github.com/ansible-collections/community.general/pull/5664). - redhat_subscription - the registration is done using the D-Bus ``rhsm`` service instead of spawning a ``subscription-manager register`` command, if possible; this avoids passing plain-text credentials as arguments to ``subscription-manager register``, which can be seen while that command runs (https://github.com/ansible-collections/community.general/pull/6122). - sefcontext - add support for path substitutions (https://github.com/ansible-collections/community.general/issues/1193). - shutdown - if no shutdown commands are found in the ``search_paths`` then the module will attempt to shutdown the system using ``systemctl shutdown`` (https://github.com/ansible-collections/community.general/issues/4269, https://github.com/ansible-collections/community.general/pull/6171). - slack - add option ``prepend_hash`` which allows to control whether a ``#`` is prepended to ``channel_id``. The current behavior (value ``auto``) is to prepend ``#`` unless some specific prefixes are found. That list of prefixes is incomplete, and there does not seem to exist a documented condition on when exactly ``#`` must not be prepended. We recommend to explicitly set ``prepend_hash=always`` or ``prepend_hash=never`` to avoid any ambiguity (https://github.com/ansible-collections/community.general/pull/5629). - snap - minor refactor when executing module (https://github.com/ansible-collections/community.general/pull/5773). - snap - refactor module to use ``CmdRunner`` to execute external commands (https://github.com/ansible-collections/community.general/pull/6468). - snap_alias - refactor code to module utils (https://github.com/ansible-collections/community.general/pull/6441). - snap_alias - refactored module to use ``CmdRunner`` to execute ``snap`` (https://github.com/ansible-collections/community.general/pull/5486). - spotinst_aws_elastigroup - add ``elements`` attribute when missing in ``list`` parameters (https://github.com/ansible-collections/community.general/pull/5553). - ssh_config - add ``host_key_algorithms`` option (https://github.com/ansible-collections/community.general/pull/5605). - ssh_config - add ``proxyjump`` option (https://github.com/ansible-collections/community.general/pull/5970). - ssh_config - refactor code to module util to fix sanity check (https://github.com/ansible-collections/community.general/pull/5720). - ssh_config - vendored StormSSH's config parser to avoid having to install StormSSH to use the module (https://github.com/ansible-collections/community.general/pull/6117). - sudoers - add ``setenv`` parameters to support passing environment variables via sudo. (https://github.com/ansible-collections/community.general/pull/5883) - sudoers - adds ``host`` parameter for setting hostname restrictions in sudoers rules (https://github.com/ansible-collections/community.general/issues/5702). - terraform - remove state file check condition and error block, because in the native implementation of terraform will not cause errors due to the non-existent file (https://github.com/ansible-collections/community.general/pull/6296). - udm_dns_record - minor refactor to the code (https://github.com/ansible-collections/community.general/pull/6382). - udm_share - added ``elements`` attribute to ``list`` type parameters (https://github.com/ansible-collections/community.general/pull/5557). - udm_user - add ``elements`` attribute when missing in ``list`` parameters (https://github.com/ansible-collections/community.general/pull/5559). - znode module - optional ``use_tls`` parameter added for encrypted communication (https://github.com/ansible-collections/community.general/issues/6154). release_summary: This is release 7.0.0 of ``community.general``, released on 2023-05-09. removed_features: - 'All ``sap`` modules have been removed from this collection. They have been migrated to the `community.sap_libs <https://galaxy.ansible.com/community/sap_libs>`_ collection. Redirections have been provided. Following modules are affected: - sapcar_extract - sap_task_list_execute - hana_query ' - cmd_runner module utils - the ``fmt`` alias of ``cmd_runner_fmt`` has been removed. Use ``cmd_runner_fmt`` instead (https://github.com/ansible-collections/community.general/pull/6428). - newrelic_deployment - the ``appname`` and ``environment`` options have been removed. They did not do anything (https://github.com/ansible-collections/community.general/pull/6428). - puppet - the alias ``show-diff`` of the ``show_diff`` option has been removed. Use ``show_diff`` instead (https://github.com/ansible-collections/community.general/pull/6428). - 'xfconf - generating facts was deprecated in community.general 3.0.0, however three factoids, ``property``, ``channel`` and ``value`` continued to be generated by mistake. This behaviour has been removed and ``xfconf`` generate no facts whatsoever (https://github.com/ansible-collections/community.general/pull/5502). ' - 'xfconf - generating facts was deprecated in community.general 3.0.0, however two factoids, ``previous_value`` and ``type`` continued to be generated by mistake. This behaviour has been removed and ``xfconf`` generate no facts whatsoever (https://github.com/ansible-collections/community.general/pull/5502). ' fragments: - 2090-idrac-redfish-resource-id-fix.yml - 3216-nmcli-bridge-idempotency-fix.yml - 3910-redfish-add-operation-apply-time-to-simple-update.yml - 3935-add-gitlab-group-runner.yml - 4028-modprobe-persistent-option.yml - 4276-redfish-command-updates-for-full-simple-update-workflow.yml - 4387-nmcli-mtu-for-vlan-connection-fix.yml - 473-nmcli-slave-type-implemented.yml - 5143-fix-xfs-quota-project-init.yml - 5431-nmcli-wifi.yml - 5486-snap-alias-cmd-runner.yml - 5489-nonetype-in-get-vm-by-label.yml - 5490-adding-put-functionality.yml - 5493-proxmox.yml - 5502-xfconf-facts-deprecation.yml - 5506-onepassword_raw-missing-param.yml - 5514-fix-logical-flaw-when-deleting-jenkins-build.yml - 5538-cmd-runner-as-fixed.yml - 5543-dependent-template.yml - 5545-gconftool-cmd-runner.yml - 5549-lxd-project-sanity.yml - 5550-java_certs-not-enough-info-on-error.yml - 5553-spotinst-aws-elasticgroup-sanity.yml - 5557-udm-share-sanity.yml - 5559-udm-user-sanity.yml - 5563-rax-scaling-group-sanity.yml - 5565-jenkins-plugin-sanity.yml - 5566-additional-flags-nmap.yml - 5570-chroot-plugin-fix-default-inventory_hostname.yml - 5583-redhat_subscription-subscribe-parameters.yaml - 5592-redirect-remove-sap-modules.yml - 5601-unixy-callback-use-config-manager.yml - 5602-proxmox-tags.yml - 5603-redfish-idrac-job-id-in-response.yml - 5605-ssh-config-add-host-key-algorithms.yaml - 5612-puppet-cmd-runner.yml - 5615-zypper-transactional-update.yml - 5619-keycloak-improvements.yml - 5627-redhat_subscription-subscribe-parameters-2.yaml - 5628-fix-vmadm-off-by-one.yml - 5629-add-prepend-hash-option-for-channel-id.yml - 5632-vdo-Use-yaml-safe-load-instead-of-yaml-load.yml - 5640-fix-typo-proxmox-inventory.yml - 5647-cmd-runner-as-bool-false.yml - 5659-fix-lxc_container-command.yml - 5662-redhat_subscription-server_proxy_scheme.yaml - 5664-redhat_subscription-credentials-when-needed.yaml - 5666-gitlab-variables.yml - 5672-proxmox.yml - 5680-ansible_galaxy_install-fx-locale.yaml - 5688-opkg-module-install-certain-version.yml - 5694-add-custom-fields-to-bitwarden.yml - 5703-sudoers-host-support.yml - 5705-opkg-fix-force-reinstall.yml - 5706-add-builds-forks-container-registry.yml - 5714-proxmox-lxc-tag-support.yml - 5718-opkg-refactor.yaml - 5719-xfconf-facts-deprecation.yml - 5720-ssh_config-plugin-sanity.yml - 5721-manageiq-policies-deprecate-list-state.yaml - 5725-redhat_subscription-add-red-hat-api-token.yml - 5727-manageiq-tags-deprecate-list-state.yaml - 5732-bugfix-keycloak-userfed-idempotency.yml - 5735-terraform-init-fix-when-default-workspace-doesnt-exists.yaml - 5744-unixy-callback-fix-config-manager-typo.yml - 5750-bugfixing-keycloak-usrfed-fail-when-update-default-mapper-simultaneously.yml - 5751-gem-fix-uninstall-hang.yml - 5752-rax-deprecation.yml - 5755-mh-fix-output-conflict.yml - 5761-callback-types.yml - 5765-mh-lax-output-conflict.yml - 5772-consul-deprecate-params-when-absent.yml - 5773-snap-mh-execute.yml - 5793-apache2-module-npm-warnings.yml - 5794-alternatives-fedora37.yml - 5803-proxmox-read-timeout.yml - 5804-minor-changes-to-hpe-ilo-collection.yml - 5808-xml-children-parameter-does-not-exist.yml - 5811-clarify-bitwarden-error.yml - 5812-implement-updateconf-api-call.yml - 5814-support-keycloak-subgroups.yml - 5818-nsupdate-fix-zone-lookup.yml - 5822-gem-uninstall-force.yml - 5829-fix-yarn-global.yml - 5830-sefcontext-path-subs.yml - 5843-terraform-validate-no-color.yml - 5844-iptables-state-refactor.yml - 5851-lookup-bitwarden-add-filter-by-collection-id-parameter.yml - 5863-providerType-defaulted-keycloak_userfed-mappers.yml - 5866-lxd_container-diff-and-check-mode.yml - 5867-apt_rpm-add-clean-and-upgrade.yml - 5883-sudoers-add-support-for-setenv-parameter.yml - 5886-redfish-correct-basic-auth-usage-on-session-creation.yml - 5888-update-key-title.yml - 5897-ipa_group-add-external-users.yml - 5899-adding-enablesecureboot-functionality-to-redfish-config.yml - 5900-adding-verifybiosattribute-fucntionality-to-redfish-command.yml - 5907-fix-gitlab_runner-not-idempotent.yml - 5913-dig-caa.yml - 5914-dig-dnskey.yml - 5915-suppress-urllib3-insecure-request-warnings.yml - 5925-align_gitlab_runner_access_level_default_with_gitlab.yml - 5926-flatpak-remote-enabled.yml - 5927-set-user-agent-dnsimple.yml - 5928-fix-favicon-url.yml - 5933-linting.yml - 5934-fix-keycloak-sanitize_cr.yml - 5942-onepassword-ignore-errors-from-op-account-get.yml - 5943-zfs_delegate_admin-fix-zfs-allow-cannot-parse-unknown-uid-gid.yml - 5970-add-proxyjump-option-to-ssh-config.yml - 5972-cloudflare-dns-srv-record.yml - 5974-nmcli_add_new_addr_gen_mode6_options.yml - 5985-add-new-gitlab-api-features.yml - 5994-github-webhook-secret.yml - 6011-osx-defaults-errors.yml - 6034-lxd-tls.yml - 6043-jc_plugin_parser_support.yml - 6045-xorder-discovery.yml - 6048-nmcli-addres-order.yml - 6049-dconf-strings.yml - 6065-nmcli-add-runner-fast-rate-option.yml - 6074-loader_in_listify.yml.yml - 6100-jenkins_plugin.yml - 6106-nmcli-ipv4-mayfail-idempotency-fix.yml - 6111-influxdb_user-check-mode.yaml - 6112-fix_key_error_in_gitlab_runner_creation_update.yml - 6114-memset-add-url-error-handling.yml - 6117-remove-stormssh-depend.yml - 6118-jail-plugin-fix-default-inventory_hostname.yml - 6119-opkg-update.yaml - 6122-redhat_subscription-subscribe-via-dbus.yaml - 6127-yarn-ignore-warnings.yml - 6131-fix-interfaces_file-for-no-leading-spaces.yml - 6138-fix-yarn-global.yml - 6149-openbsd_pkg-term.yml - 6154-znode-optional-tls.yml - 6158-create-proxmox-vm-from-archive.yml - 6160-add-command-make-output.yml - 6165-nmap-port.yml - 6171-shutdown-using-systemd.yml - 6180-replace-deprecated-badzipfile.yml - 6192-allow-empty-resultsets.yml - 6198-pipx-inject-install-apps.yml - 6199-archive-generate-checksum-in-chunks.yml - 6200-adding-open-option-to-nmap.yml - 6203-add-append-option-to-ipa-hostgroup.yml - 6206-dconf-booleans.yml - 6208-hpe-thermal-fan-percent.yaml - 6210-add-worklog-functionality-to-jira.yml - 6211-rhsm-require-root.yml - 6212-pipx-include-injected.yml - 6224-download-certificate-via-api-bugfix.yml - 6227-xen-orchestra-check-response-id.yml - 6259-redhat_subscription-fix-force.yaml - 6267-homebrew-cask-upgrade-all-greedy.yml - 6269-mksysb-output.yml - 6270-gconftool2-changed.yml - 6275-redhat_subscription-fix-environments-centos.yaml - 6277-add-topics-gitlab-project.yml - 6286-icinga2_host-template-and-template-vars.yml - 6289-bugfix-flatpak-check-if-already-installed.yml - 6293-add-puppet-skip-tags-option.yaml - 6294-fix-one_vm-instantiation.yml - 6296-LanceNero-Terraform_statefile_check.yml - 6300-rundeck-modules-fixes-and-improvements.yml - 6303-pipx-fix-state-latest-and-add-system-site-packages.yml - 6308-pipx-add-system-site-packages.yml - 6312-nmcli-add-macvlan-connection-type.yml - 6318-add-form-flow.yml - 6319-redhat_subscription-fix-environment-parameter.yaml - 6334-dig-support-multiple-domains.yml - 6336-dconf-refactor.yml - 6351-support-env-variables-to-nmap-dynamic-inventoiry.yaml - 6361-snap-alias-regex-bugfix.yml - 6382-udm-dns-record-refactor.yml - 6383-deps-failed.yml - 6384-gitlab-refactor.yml - 6385-cpan-mh-feat.yml - 6401-rhsm_release-required.yml - 6404-ini_file-section.yml - 6428-removals.yml - 6440-dnsimple-info-refactor.yml - 6441-snap_alias-refactor.yml - 6448-proxmox-kvm-migration-support.yml - 6456-fix-portage-withbdeps-false.yml - 6458-puppet-noop.yml - 6464-mh-imports.yml - 6465-mh-deps-deprecation.yml - 6468-snap-cmdrunner.yml - 6473-ldap_search.yml - 6491-dconf-respawn.yml - 6493-deprecate-rhn-modules.yml - 6497-terraform-fix.yml - 7.0.0.yml - deps.yml - passwordstore-lock.yml - remove-unneeded-imports.yml - xxxx-ldap-ca-cert-file.yml modules: - description: Query btrfs filesystem info name: btrfs_info namespace: '' - description: Manage btrfs subvolumes name: btrfs_subvolume namespace: '' - description: Manage project badges on GitLab Server name: gitlab_project_badge namespace: '' - description: Manages Out-Of-Band controllers using Redfish APIs name: ilo_redfish_command namespace: '' - description: Retrieve IP geolocation and other facts of a host's IP address using the ipbase.com API name: ipbase_info namespace: '' - description: Manage KDE configuration files name: kdeconfig namespace: '' - description: Allows administration of Keycloak client authorization scopes via Keycloak API name: keycloak_authz_authorization_scope namespace: '' - description: Set the type of aclientscope in realm or client via Keycloak API name: keycloak_clientscope_type namespace: '' - description: Retrieve client secret via Keycloak API name: keycloak_clientsecret_info namespace: '' - description: Regenerate Keycloak client secret via Keycloak API name: keycloak_clientsecret_regenerate namespace: '' - description: Manages Out-Of-Band controllers using Open Composable API (OCAPI) name: ocapi_command namespace: '' - description: Manages Out-Of-Band controllers using Open Composable API (OCAPI) name: ocapi_info namespace: '' plugins: lookup: - description: merge variables with a certain suffix name: merge_variables namespace: null release_date: '2023-05-09' 7.0.1: changes: bugfixes: - nmcli - fix bond option ``xmit_hash_policy`` (https://github.com/ansible-collections/community.general/pull/6527). - portage - fix ``changed_use`` and ``newuse`` not triggering rebuilds (https://github.com/ansible-collections/community.general/issues/6008, https://github.com/ansible-collections/community.general/pull/6548). - proxmox_tasks_info - remove ``api_user`` + ``api_password`` constraint from ``required_together`` as it causes to require ``api_password`` even when API token param is used (https://github.com/ansible-collections/community.general/issues/6201). - zypper - added handling of zypper exitcode 102. Changed state is set correctly now and rc 102 is still preserved to be evaluated by the playbook (https://github.com/ansible-collections/community.general/pull/6534). release_summary: Bugfix release for Ansible 8.0.0rc1. fragments: - 6527-nmcli-bond-fix-xmit_hash_policy.yml - 6534-zypper-exitcode-102-handled.yaml - 6548-portage-changed_use-newuse.yml - 6554-proxmox-tasks-info-fix-required-password.yaml - 7.0.1.yml release_date: '2023-05-22' 7.1.0: changes: bugfixes: - MH DependencyMixin module utils - deprecation notice was popping up for modules not using dependencies (https://github.com/ansible-collections/community.general/pull/6644, https://github.com/ansible-collections/community.general/issues/6639). - csv module utils - detects and remove unicode BOM markers from incoming CSV content (https://github.com/ansible-collections/community.general/pull/6662). - gitlab_group - the module passed parameters to the API call even when not set. The module is now filtering out ``None`` values to remediate this (https://github.com/ansible-collections/community.general/pull/6712). - icinga2_host - fix a key error when updating an existing host (https://github.com/ansible-collections/community.general/pull/6748). - ini_file - add the ``follow`` paramter to follow the symlinks instead of replacing them (https://github.com/ansible-collections/community.general/pull/6546). - ini_file - fix a bug where the inactive options were not used when possible (https://github.com/ansible-collections/community.general/pull/6575). - keycloak module utils - fix ``is_struct_included`` handling of lists of lists/dictionaries (https://github.com/ansible-collections/community.general/pull/6688). - keycloak module utils - the function ``get_user_by_username`` now return the user representation or ``None`` as stated in the documentation (https://github.com/ansible-collections/community.general/pull/6758). - proxmox_kvm - allow creation of VM with existing name but new vmid (https://github.com/ansible-collections/community.general/issues/6155, https://github.com/ansible-collections/community.general/pull/6709). - 'rhsm_repository - when using the ``purge`` option, the ``repositories`` dictionary element in the returned JSON is now properly updated according to the pruning operation (https://github.com/ansible-collections/community.general/pull/6676). ' - tss lookup plugin - fix multiple issues when using ``fetch_attachments=true`` (https://github.com/ansible-collections/community.general/pull/6720). deprecated_features: - CmdRunner module utils - deprecate ``cmd_runner_fmt.as_default_type()`` formatter (https://github.com/ansible-collections/community.general/pull/6601). - MH VarsMixin module utils - deprecates ``VarsMixin`` and supporting classes in favor of plain ``vardict`` module util (https://github.com/ansible-collections/community.general/pull/6649). - cpanm - value ``compatibility`` is deprecated as default for parameter ``mode`` (https://github.com/ansible-collections/community.general/pull/6512). - 'redhat module utils - the ``module_utils.redhat`` module is deprecated, as effectively unused: the ``Rhsm``, ``RhsmPool``, and ``RhsmPools`` classes will be removed in community.general 9.0.0; the ``RegistrationBase`` class will be removed in community.general 10.0.0 together with the ``rhn_register`` module, as it is the only user of this class; this means that the whole ``module_utils.redhat`` module will be dropped in community.general 10.0.0, so importing it without even using anything of it will fail (https://github.com/ansible-collections/community.general/pull/6663). ' - 'redhat_subscription - the ``autosubscribe`` alias for the ``auto_attach`` option has been deprecated for many years, although only in the documentation. Officially mark this alias as deprecated, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6646). ' - 'redhat_subscription - the ``pool`` option is deprecated in favour of the more precise and flexible ``pool_ids`` option (https://github.com/ansible-collections/community.general/pull/6650). ' - 'rhsm_repository - ``state=present`` has not been working as expected for many years, and it seems it was not noticed so far; also, "presence" is not really a valid concept for subscription repositories, which can only be enabled or disabled. Hence, mark the ``present`` and ``absent`` values of the ``state`` option as deprecated, slating them for removal in community.general 10.0.0 (https://github.com/ansible-collections/community.general/pull/6673). ' known_issues: - Ansible markup will show up in raw form on ansible-doc text output for ansible-core before 2.15. If you have trouble deciphering the documentation markup, please upgrade to ansible-core 2.15 (or newer), or read the HTML documentation on https://docs.ansible.com/ansible/devel/collections/community/general/ (https://github.com/ansible-collections/community.general/pull/6539). minor_changes: - The collection will start using semantic markup (https://github.com/ansible-collections/community.general/pull/6539). - VarDict module utils - add method ``VarDict.as_dict()`` to convert to a plain ``dict`` object (https://github.com/ansible-collections/community.general/pull/6602). - cobbler inventory plugin - add ``inventory_hostname`` option to allow using the system name for the inventory hostname (https://github.com/ansible-collections/community.general/pull/6502). - cobbler inventory plugin - add ``want_ip_addresses`` option to collect all interface DNS name to IP address mapping (https://github.com/ansible-collections/community.general/pull/6711). - cobbler inventory plugin - add primary IP addess to ``cobbler_ipv4_address`` and IPv6 address to ``cobbler_ipv6_address`` host variable (https://github.com/ansible-collections/community.general/pull/6711). - cobbler inventory plugin - add warning for systems with empty profiles (https://github.com/ansible-collections/community.general/pull/6502). - copr - respawn module to use the system python interpreter when the ``dnf`` python module is not available in ``ansible_python_interpreter`` (https://github.com/ansible-collections/community.general/pull/6522). - datadog_monitor - adds ``notification_preset_name``, ``renotify_occurrences`` and ``renotify_statuses`` parameters (https://github.com/ansible-collections/community.general/issues/6521,https://github.com/ansible-collections/community.general/issues/5823). - filesystem - add ``uuid`` parameter for UUID change feature (https://github.com/ansible-collections/community.general/pull/6680). - keycloak_client_rolemapping - adds support for subgroups with additional parameter ``parents`` (https://github.com/ansible-collections/community.general/pull/6687). - keycloak_role - add composite roles support for realm and client roles (https://github.com/ansible-collections/community.general/pull/6469). - ldap_* - add new arguments ``client_cert`` and ``client_key`` to the LDAP modules in order to allow certificate authentication (https://github.com/ansible-collections/community.general/pull/6668). - ldap_search - add a new ``page_size`` option to enable paged searches (https://github.com/ansible-collections/community.general/pull/6648). - lvg - add ``active`` and ``inactive`` values to the ``state`` option for active state management feature (https://github.com/ansible-collections/community.general/pull/6682). - lvg - add ``reset_vg_uuid``, ``reset_pv_uuid`` options for UUID reset feature (https://github.com/ansible-collections/community.general/pull/6682). - mas - disable sign-in check for macOS 12+ as ``mas account`` is non-functional (https://github.com/ansible-collections/community.general/pull/6520). - onepassword lookup plugin - add service account support (https://github.com/ansible-collections/community.general/issues/6635, https://github.com/ansible-collections/community.general/pull/6660). - onepassword_raw lookup plugin - add service account support (https://github.com/ansible-collections/community.general/issues/6635, https://github.com/ansible-collections/community.general/pull/6660). - opentelemetry callback plugin - add span attributes in the span event (https://github.com/ansible-collections/community.general/pull/6531). - opkg - remove default value ``""`` for parameter ``force`` as it causes the same behaviour of not having that parameter (https://github.com/ansible-collections/community.general/pull/6513). - proxmox - support ``timezone`` parameter at container creation (https://github.com/ansible-collections/community.general/pull/6510). - proxmox inventory plugin - add composite variables support for Proxmox nodes (https://github.com/ansible-collections/community.general/issues/6640). - proxmox_kvm - added support for ``tpmstate0`` parameter to configure TPM (Trusted Platform Module) disk. TPM is required for Windows 11 installations (https://github.com/ansible-collections/community.general/pull/6533). - proxmox_kvm - re-use ``timeout`` module param to forcefully shutdown a virtual machine when ``state`` is ``stopped`` (https://github.com/ansible-collections/community.general/issues/6257). - proxmox_snap - add ``retention`` parameter to delete old snapshots (https://github.com/ansible-collections/community.general/pull/6576). - redfish_command - add ``MultipartHTTPPushUpdate`` command (https://github.com/ansible-collections/community.general/issues/6471, https://github.com/ansible-collections/community.general/pull/6612). - 'redhat_subscription - the internal ``RegistrationBase`` class was folded into the other internal ``Rhsm`` class, as the separation had no purpose anymore (https://github.com/ansible-collections/community.general/pull/6658). ' - 'rhsm_release - improve/harden the way ``subscription-manager`` is run; no behaviour change is expected (https://github.com/ansible-collections/community.general/pull/6669). ' - snap - module is now aware of channel when deciding whether to install or refresh the snap (https://github.com/ansible-collections/community.general/pull/6435, https://github.com/ansible-collections/community.general/issues/1606). - sorcery - minor refactor (https://github.com/ansible-collections/community.general/pull/6525). - tss lookup plugin - allow to fetch secret IDs which are in a folder based on folder ID. Previously, we could not fetch secrets based on folder ID but now use ``fetch_secret_ids_from_folder`` option to indicate to fetch secret IDs based on folder ID (https://github.com/ansible-collections/community.general/issues/6223). release_summary: 'Regular bugfix and feature release. From this version on, community.general is using the new `Ansible semantic markup <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#semantic-markup-within-module-documentation>`__ in its documentation. If you look at documentation with the ansible-doc CLI tool from ansible-core before 2.15, please note that it does not render the markup correctly. You should be still able to read it in most cases, but you need ansible-core 2.15 or later to see it as it is intended. Alternatively you can look at `the devel docsite <https://docs.ansible.com/ansible/devel/collections/community/general/>`__ for the rendered HTML version of the documentation of the latest release. ' fragments: - 6223-get-secret-ids-by-folderid.yml - 6435-snap-channel-aware.yml - 6469-add-composites-support-for-keycloak-role.yml - 6471-redfish-add-multipart-http-push-command.yml - 6502-cobbler-inventory_hostname.yml - 6510-proxmox-create-support_timezone.yaml - 6512-cpanm-default-mode.yml - 6513-opkg-default-force.yml - 6520-mas-disable-signin.yaml - 6522-copr-respawn.yaml - 6523-datadog-monitor-notification-preset-name-and-renotify.yaml - 6525-sorcery-import.yaml - 6531-opentelemetry-add-event-attributes.yml - 6533-proxmox_kvm-tpmstate0-support.yaml - 6539-semantic-markup.yml - 6568-fix-get-user-by-username-in-keycloak-module-utils.yml - 6570-handle-shutdown-timeout.yaml - 6576-proxmox-snap-allow-to-remove-old-snapshots.yml - 6601-cmdrunner-deprecate-default-type.yml - 6602-vardict-as-dict.yml - 6640-proxmox-composite-variables-support.yml - 6644-dependencymixin-fix.yml - 6646-redhat_subscription-deprecate-autosubscribe.yml - 6648_ldap_search_page_size.yml - 6649-varsmixin-deprecation.yml - 6650-redhat_subscription-deprecate-pool.yml - 6658-redhat_subscription-internal-rhsm-refactor.yml - 6660-onepassword-lookup-service-account.yaml - 6662-csv-bom.yml - 6663-deprecate-module_utils-redhat.yml - 6668-ldap-client-cert.yml - 6669-rhsm_release-internal-sub-man-exec.yml - 6673-rhsm_repository-deprecate-present-absent.yml - 6676-rhsm_repository-fix-returned-repositories-with-purge.yml - 6680-filesystem-uuid-change.yml - 6682-lvg-clonesupport.yml - 6687-support-subgroups-for-keycloak-client-rolemapping.yml - 6688-is-struct-included-bug-in-keycloak-py.yml - 6709-proxmox-create-vm-with-existing-name.yml - 6711-cobbler-ip-address.yml - 6712-gitlab_group-filtered-for-none-values.yml - 6720-tss-fix-fetch-attachments.yml - 6748-icinga2_host-datafix.yml - 7.1.0.yml - ini_file-preserve-symlink.yml - ini_file-use-inactive-options-when-possible.yml modules: - description: Creates, updates, or deletes GitLab instance variables name: gitlab_instance_variable namespace: '' - description: Create, update, or delete GitLab merge requests name: gitlab_merge_request namespace: '' - description: Allows administration of Keycloak authentication required actions name: keycloak_authentication_required_actions namespace: '' - description: Create and configure a user in Keycloak name: keycloak_user namespace: '' - description: Renames LVM volume groups name: lvg_rename namespace: '' - description: Pool management for Proxmox VE cluster name: proxmox_pool namespace: '' - description: Add or delete members from Proxmox VE cluster pools name: proxmox_pool_member namespace: '' release_date: '2023-06-20' 7.2.0: changes: bugfixes: - cobbler inventory plugin - fix calculation of cobbler_ipv4/6_address (https://github.com/ansible-collections/community.general/pull/6925). - datadog_downtime - presence of ``rrule`` param lead to the Datadog API returning Bad Request due to a missing recurrence type (https://github.com/ansible-collections/community.general/pull/6811). - ipa_dnszone - fix 'idnsallowsyncptr' key error for reverse zone (https://github.com/ansible-collections/community.general/pull/6906, https://github.com/ansible-collections/community.general/issues/6905). - keycloak_authentication - fix Keycloak authentication flow (step or sub-flow) indexing during update, if not specified by the user (https://github.com/ansible-collections/community.general/pull/6734). - locale_gen - now works for locales without the underscore character such as ``C.UTF-8`` (https://github.com/ansible-collections/community.general/pull/6774, https://github.com/ansible-collections/community.general/issues/5142, https://github.com/ansible-collections/community.general/issues/4305). - machinectl become plugin - mark plugin as ``require_tty`` to automatically disable pipelining, with which this plugin is not compatible (https://github.com/ansible-collections/community.general/issues/6932, https://github.com/ansible-collections/community.general/pull/6935). - nmcli - fix support for empty list (in compare and scrape) (https://github.com/ansible-collections/community.general/pull/6769). - openbsd_pkg - the pkg_info(1) behavior has changed in OpenBSD >7.3. The error message ``Can't find`` should not lead to an error case (https://github.com/ansible-collections/community.general/pull/6785). - pacman - module recognizes the output of ``yay`` running as ``root`` (https://github.com/ansible-collections/community.general/pull/6713). - proxmox - fix error when a configuration had no ``template`` field (https://github.com/ansible-collections/community.general/pull/6838, https://github.com/ansible-collections/community.general/issues/5372). - proxmox module utils - add logic to detect whether an old Promoxer complains about the ``token_name`` and ``token_value`` parameters and provide a better error message when that happens (https://github.com/ansible-collections/community.general/pull/6839, https://github.com/ansible-collections/community.general/issues/5371). - proxmox_disk - fix unable to create ``cdrom`` media due to ``size`` always being appended (https://github.com/ansible-collections/community.general/pull/6770). - proxmox_kvm - ``absent`` state with ``force`` specified failed to stop the VM due to the ``timeout`` value not being passed to ``stop_vm`` (https://github.com/ansible-collections/community.general/pull/6827). - proxmox_kvm - ``restarted`` state did not actually restart a VM in some VM configurations. The state now uses the Proxmox reboot endpoint instead of calling the ``stop_vm`` and ``start_vm`` functions (https://github.com/ansible-collections/community.general/pull/6773). - proxmox_template - require ``requests_toolbelt`` module to fix issue with uploading large templates (https://github.com/ansible-collections/community.general/issues/5579, https://github.com/ansible-collections/community.general/pull/6757). - redfish_info - fix ``ListUsers`` to not show empty account slots (https://github.com/ansible-collections/community.general/issues/6771, https://github.com/ansible-collections/community.general/pull/6772). - refish_utils module utils - changing variable names to avoid issues occuring when fetching Volumes data (https://github.com/ansible-collections/community.general/pull/6883). - snap - assume default track ``latest`` in parameter ``channel`` when not specified (https://github.com/ansible-collections/community.general/pull/6835, https://github.com/ansible-collections/community.general/issues/6821). - snap - fix the processing of the commands' output, stripping spaces and newlines from it (https://github.com/ansible-collections/community.general/pull/6826, https://github.com/ansible-collections/community.general/issues/6803). deprecated_features: - flowdock - module relies entirely on no longer responsive API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6930). - proxmox - old feature flag ``proxmox_default_behavior`` will be removed in community.general 10.0.0 (https://github.com/ansible-collections/community.general/pull/6836). - stackdriver - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6887). - webfaction_app - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6909). - webfaction_db - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6909). - webfaction_domain - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6909). - webfaction_mailbox - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6909). - webfaction_site - module relies entirely on no longer existent API endpoints, and it will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/6909). minor_changes: - cobbler inventory plugin - convert Ansible unicode strings to native Python unicode strings before passing user/password to XMLRPC client (https://github.com/ansible-collections/community.general/pull/6923). - consul_session - drops requirement for the ``python-consul`` library to communicate with the Consul API, instead relying on the existing ``requests`` library requirement (https://github.com/ansible-collections/community.general/pull/6755). - gitlab_project_variable - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6928). - gitlab_runner - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6927). - htpasswd - the parameter ``crypt_scheme`` is being renamed as ``hash_scheme`` and added as an alias to it (https://github.com/ansible-collections/community.general/pull/6841). - keycloak_authentication - added provider ID choices, since Keycloak supports only those two specific ones (https://github.com/ansible-collections/community.general/pull/6763). - keyring - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6927). - locale_gen - module has been refactored to use ``ModuleHelper`` and ``CmdRunner`` (https://github.com/ansible-collections/community.general/pull/6903). - locale_gen - module now using ``CmdRunner`` to execute external commands (https://github.com/ansible-collections/community.general/pull/6820). - make - add new ``targets`` parameter allowing multiple targets to be used with ``make`` (https://github.com/ansible-collections/community.general/pull/6882, https://github.com/ansible-collections/community.general/issues/4919). - nmcli - add support for ``ipv4.dns-options`` and ``ipv6.dns-options`` (https://github.com/ansible-collections/community.general/pull/6902). - npm - minor improvement on parameter validation (https://github.com/ansible-collections/community.general/pull/6848). - opkg - add ``executable`` parameter allowing to specify the path of the ``opkg`` command (https://github.com/ansible-collections/community.general/pull/6862). - pubnub_blocks - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6928). - redfish_command - add ``account_types`` and ``oem_account_types`` as optional inputs to ``AddUser`` (https://github.com/ansible-collections/community.general/issues/6823, https://github.com/ansible-collections/community.general/pull/6871). - redfish_info - add ``AccountTypes`` and ``OEMAccountTypes`` to the output of ``ListUsers`` (https://github.com/ansible-collections/community.general/issues/6823, https://github.com/ansible-collections/community.general/pull/6871). - redfish_info - adds ``ProcessorArchitecture`` to CPU inventory (https://github.com/ansible-collections/community.general/pull/6864). - redfish_info - fix for ``GetVolumeInventory``, Controller name was getting populated incorrectly and duplicates were seen in the volumes retrieved (https://github.com/ansible-collections/community.general/pull/6719). - 'rhsm_repository - the interaction with ``subscription-manager`` was refactored by grouping things together, removing unused bits, and hardening the way it is run; also, the parsing of ``subscription-manager repos --list`` was improved and made slightly faster; no behaviour change is expected (https://github.com/ansible-collections/community.general/pull/6783, https://github.com/ansible-collections/community.general/pull/6837). ' - scaleway_security_group_rule - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6928). - snap - add option ``dangerous`` to the module, that will map into the command line argument ``--dangerous``, allowing unsigned snap files to be installed (https://github.com/ansible-collections/community.general/pull/6908, https://github.com/ansible-collections/community.general/issues/5715). - tss lookup plugin - allow to fetch secret by path. Previously, we could not fetch secret by path but now use ``secret_path`` option to indicate to fetch secret by secret path (https://github.com/ansible-collections/community.general/pull/6881). - xenserver_guest_info - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6928). - xenserver_guest_powerstate - minor refactor removing unnecessary code statements (https://github.com/ansible-collections/community.general/pull/6928). - yum_versionlock - add support to pin specific package versions instead of only the package itself (https://github.com/ansible-collections/community.general/pull/6861, https://github.com/ansible-collections/community.general/issues/4470). release_summary: Regular bugfix and feature release. fragments: - 6713-yay-become.yml - 6719-redfish-utils-fix-for-get-volume-inventory.yml - 6734-keycloak-auth-management-indexing.yml - 6755-refactor-consul-session-to-use-requests-lib-instead-of-consul.yml - 6757-proxmox-template-fix-upload-error.yml - 6763-keycloak-auth-provider-choices.yml - 6769-nmcli-fix-empty-list.yml - 6770-proxmox_disk_create_cdrom.yml - 6771-redfish-filter-empty-account-slots.yml - 6773-proxmox_kvm-restarted-state-bug-fix.yaml - 6774-locale-gen-fix.yml - 6783-6837-rhsm_repository-internal-refactor.yml - 6785-openbsd_pkg_pkg_info_handling.yml - 6811-datadog-downtime-rrule-type.yaml - 6820-locale-gen-cmdrunner.yml - 6823-redfish-add-account-type-management.yml - 6826-snap-out-strip.yml - 6827-proxmox_kvm-force-delete-bug-fix.yaml - 6835-snap-missing-track.yml - 6836-proxmox-deprecate-compatibility.yml - 6838-proxmox-dict-template.yml - 6839-promoxer-tokens.yml - 6841-htpasswd-crypt-scheme.yml - 6848-npm-required-if.yml - 6861-yum_versionlock_minor_change_add-pinning-specific-versions.yml - 6862-opkg-exec.yml - 6864-redfish-utils-fix-for-processorarchitecture-in-cpu-inventory.yaml - 6882-make-multiple-targets.yml - 6883-redfish-utils-changing-variable-names-in-get-volume-inventory.yml - 6887-deprecate-stackdrive.yml - 6902-added-support-in-nmcli-for-ipvx-dns-options.yml - 6903-locale-gen-refactor.yml - 6905-ipa_dnszone-key-error-fix.yml - 6908-snap-dangerous.yml - 6909-deprecate-webfaction.yml - 6923-cobbler-inventory_unicode.yml - 6925-cobbler-inventory-bugfix.yml - 6927-pylint-comments.yml - 6928-noqa-comments.yml - 6930-deprecate-flowdock.yml - 6935-machinectl-become.yml - 7.2.0.yml - get-secret-by-path.yml modules: - description: Manipulate Consul policies name: consul_policy namespace: '' - description: Allows administration of Keycloak client authorization permissions via Keycloak API name: keycloak_authz_permission namespace: '' - description: Query Keycloak client authorization permissions information name: keycloak_authz_permission_info namespace: '' - description: Retrieve information about one or more Proxmox VE virtual machines name: proxmox_vm_info namespace: '' plugins: lookup: - description: Retrieve secrets from Bitwarden Secrets Manager name: bitwarden_secrets_manager namespace: null release_date: '2023-07-17' 7.2.1: changes: bugfixes: - cmd_runner module utils - when a parameter in ``argument_spec`` has no type, meaning it is implicitly a ``str``, ``CmdRunner`` would fail trying to find the ``type`` key in that dictionary (https://github.com/ansible-collections/community.general/pull/6968). - ejabberd_user - provide meaningful error message when the ``ejabberdctl`` command is not found (https://github.com/ansible-collections/community.general/pull/7028, https://github.com/ansible-collections/community.general/issues/6949). - proxmox module utils - fix proxmoxer library version check (https://github.com/ansible-collections/community.general/issues/6974, https://github.com/ansible-collections/community.general/issues/6975, https://github.com/ansible-collections/community.general/pull/6980). - proxmox_kvm - when ``name`` option is provided without ``vmid`` and VM with that name already exists then no new VM will be created (https://github.com/ansible-collections/community.general/issues/6911, https://github.com/ansible-collections/community.general/pull/6981). - rundeck - fix ``TypeError`` on 404 API response (https://github.com/ansible-collections/community.general/pull/6983). release_summary: Bugfix release. fragments: - 6949-ejabberdctl-error.yml - 6968-cmdrunner-implicit-type.yml - 6980-proxmox-fix-token-auth.yml - 6981-proxmox-fix-vm-creation-when-only-name-provided.yml - 6983-rundeck-fix-typerrror-on-404-api-response.yml - 7.2.1.yml release_date: '2023-07-31' 7.3.0: changes: bugfixes: - bitwarden lookup plugin - the plugin made assumptions about the structure of a Bitwarden JSON object which may have been broken by an update in the Bitwarden API. Remove assumptions, and allow queries for general fields such as ``notes`` (https://github.com/ansible-collections/community.general/pull/7061). - ejabberd_user - module was failing to detect whether user was already created and/or password was changed (https://github.com/ansible-collections/community.general/pull/7033). - keycloak module util - fix missing ``http_agent``, ``timeout``, and ``validate_certs`` ``open_url()`` parameters (https://github.com/ansible-collections/community.general/pull/7067). - keycloak_client inventory plugin - fix missing client secret (https://github.com/ansible-collections/community.general/pull/6931). - lvol - add support for percentage of origin size specification when creating snapshot volumes (https://github.com/ansible-collections/community.general/issues/1630, https://github.com/ansible-collections/community.general/pull/7053). - lxc connection plugin - now handles ``remote_addr`` defaulting to ``inventory_hostname`` correctly (https://github.com/ansible-collections/community.general/pull/7104). - oci_utils module utils - avoid direct type comparisons (https://github.com/ansible-collections/community.general/pull/7085). - proxmox_user_info - avoid direct type comparisons (https://github.com/ansible-collections/community.general/pull/7085). - snap - fix crash when multiple snaps are specified and one has ``---`` in its description (https://github.com/ansible-collections/community.general/pull/7046). - sorcery - fix interruption of the multi-stage process (https://github.com/ansible-collections/community.general/pull/7012). - sorcery - fix queue generation before the whole system rebuild (https://github.com/ansible-collections/community.general/pull/7012). - sorcery - latest state no longer triggers update_cache (https://github.com/ansible-collections/community.general/pull/7012). deprecated_features: - ejabberd_user - deprecate the parameter ``logging`` in favour of producing more detailed information in the module output (https://github.com/ansible-collections/community.general/pull/7043). minor_changes: - chroot connection plugin - add ``disable_root_check`` option (https://github.com/ansible-collections/community.general/pull/7099). - ejabberd_user - module now using ``CmdRunner`` to execute external command (https://github.com/ansible-collections/community.general/pull/7075). - ipa_config - add module parameters to manage FreeIPA user and group objectclasses (https://github.com/ansible-collections/community.general/pull/7019). - ipa_config - adds ``idp`` choice to ``ipauserauthtype`` parameter's choices (https://github.com/ansible-collections/community.general/pull/7051). - npm - module now using ``CmdRunner`` to execute external commands (https://github.com/ansible-collections/community.general/pull/6989). - proxmox_kvm - enabled force restart of VM, bringing the ``force`` parameter functionality in line with what is described in the docs (https://github.com/ansible-collections/community.general/pull/6914). - proxmox_vm_info - ``node`` parameter is no longer required. Information can be obtained for the whole cluster (https://github.com/ansible-collections/community.general/pull/6976). - proxmox_vm_info - non-existing provided by name/vmid VM would return empty results instead of failing (https://github.com/ansible-collections/community.general/pull/7049). - redfish_config - add ``DeleteAllVolumes`` command to allow deletion of all volumes on servers (https://github.com/ansible-collections/community.general/pull/6814). - redfish_utils - use ``Controllers`` key in redfish data to obtain Storage controllers properties (https://github.com/ansible-collections/community.general/pull/7081). - redfish_utils module utils - add support for ``PowerCycle`` reset type for ``redfish_command`` responses feature (https://github.com/ansible-collections/community.general/issues/7083). - redfish_utils module utils - add support for following ``@odata.nextLink`` pagination in ``software_inventory`` responses feature (https://github.com/ansible-collections/community.general/pull/7020). - shutdown - use ``shutdown -p ...`` with FreeBSD to halt and power off machine (https://github.com/ansible-collections/community.general/pull/7102). - sorcery - add grimoire (repository) management support (https://github.com/ansible-collections/community.general/pull/7012). release_summary: Feature and bugfix release. fragments: - 6814-redfish-config-add-delete-all-volumes.yml - 6914-proxmox_kvm-enable-force-restart.yml - 6931-keycloak_client-inventory-bugfix.yml - 6976-proxmox-vm-info-not-require-node.yml - 6989-npm-cmdrunner.yml - 7.3.0.yml - 7012-sorcery-grimoire-mgmt.yml - 7019-ipa_config-user-and-group-objectclasses.yml - 7020-redfish-utils-pagination.yml - 7033-ejabberd-user-bugs.yml - 7043-ejabberd-user-deprecate-logging.yml - 7046-snap-newline-before-separator.yml - 7049-proxmox-vm-info-empty-results.yml - 7051-ipa-config-new-choice-idp-to-ipauserauthtype.yml - 7061-fix-bitwarden-get_field.yml - 7067-keycloak-api-paramerter-fix.yml - 7075-ejabberd-user-cmdrunner.yml - 7081-redfish-utils-fix-for-storagecontrollers-deprecated-key.yaml - 7085-sanity.yml - 7099-chroot-disable-root-check-option.yml - 7102-freebsd-shutdown-p.yml - 7104_fix_lxc_remoteaddr_default.yml - 7113-redfish-utils-power-cycle.yml - lvol-pct-of-origin.yml release_date: '2023-08-15' 7.4.0: changes: bugfixes: - CmdRunner module utils - does not attempt to resolve path if executable is a relative or absolute path (https://github.com/ansible-collections/community.general/pull/7200). - nmap inventory plugin - now uses ``get_option`` in all cases to get its configuration information (https://github.com/ansible-collections/community.general/pull/7119). - nsupdate - fix a possible ``list index out of range`` exception (https://github.com/ansible-collections/community.general/issues/836). - oci_utils module util - fix inappropriate logical comparison expressions and makes them simpler. The previous checks had logical short circuits (https://github.com/ansible-collections/community.general/pull/7125). - pritunl module utils - fix incorrect URL parameter for orgnization add method (https://github.com/ansible-collections/community.general/pull/7161). - snap - an exception was being raised when snap list was empty (https://github.com/ansible-collections/community.general/pull/7124, https://github.com/ansible-collections/community.general/issues/7120). minor_changes: - cobbler inventory plugin - add ``exclude_mgmt_classes`` and ``include_mgmt_classes`` options to exclude or include hosts based on management classes (https://github.com/ansible-collections/community.general/pull/7184). - cpanm - minor refactor when creating the ``CmdRunner`` object (https://github.com/ansible-collections/community.general/pull/7231). - gitlab_group_variable - add support for ``raw`` variables suboption (https://github.com/ansible-collections/community.general/pull/7132). - gitlab_project_variable - add support for ``raw`` variables suboption (https://github.com/ansible-collections/community.general/pull/7132). - jenkins_build - add new ``detach`` option, which allows the module to exit successfully as long as the build is created (default functionality is still waiting for the build to end before exiting) (https://github.com/ansible-collections/community.general/pull/7204). - jenkins_build - add new ``time_between_checks`` option, which allows to configure the wait time between requests to the Jenkins server (https://github.com/ansible-collections/community.general/pull/7204). - make - allows ``params`` to be used without value (https://github.com/ansible-collections/community.general/pull/7180). - nmap inventory plugin - now has a ``use_arp_ping`` option to allow the user to disable the default ARP ping query for a more reliable form (https://github.com/ansible-collections/community.general/pull/7119). - pagerduty - adds in option to use v2 API for creating pagerduty incidents (https://github.com/ansible-collections/community.general/issues/6151) - pritunl module utils - ensure ``validate_certs`` parameter is honoured in all methods (https://github.com/ansible-collections/community.general/pull/7156). - redfish_info - report ``Id`` in the output of ``GetManagerInventory`` (https://github.com/ansible-collections/community.general/pull/7140). - redfish_utils module utils - support ``Volumes`` in response for ``GetDiskInventory`` (https://github.com/ansible-collections/community.general/pull/6819). - unixy callback plugin - add support for ``check_mode_markers`` option (https://github.com/ansible-collections/community.general/pull/7179). release_summary: Bugfix and feature release. fragments: - 6819-redfish-utils-add-links-parameter-for-get_disk_inventory.yml - 7.4.0.yml - 7118-nmap_inv_plugin_no_arp_option.yml - 7124-snap-empty-list.yml - 7125-fix-inappropriate-comparison.yml - 7132-gitlab-raw-variables.yml - 7140-id-getmanagerinv-output.yml - 7156-ensure-validate-certs-parameter-is-honoured.yml - 7161-fix-incorrect-post-parameter.yml - 7179-unixy-support-checkmode-markers.yml - 7180-make_params_without_value.yml - 7184-cobbler-mgmt-classes.yml - 7200-cmd-runner-abs-path.yml - 7219-fix-nsupdate-cname.yaml - 7231-cpanm-adjustments.yml - improvements-to-jenkins-build-module.yml - update-v2-pagerduty-alert.yml modules: - description: Get information about Jenkins builds name: jenkins_build_info namespace: '' - description: Manage node.js packages with pnpm name: pnpm namespace: '' release_date: '2023-09-11' 7.5.0: changes: bugfixes: - gitlab_group_variable - deleted all variables when used with ``purge=true`` due to missing ``raw`` property in KNOWN attributes (https://github.com/ansible-collections/community.general/issues/7250). - gitlab_project_variable - deleted all variables when used with ``purge=true`` due to missing ``raw`` property in KNOWN attributes (https://github.com/ansible-collections/community.general/issues/7250). - ldap_search - fix string normalization and the ``base64_attributes`` option on Python 3 (https://github.com/ansible-collections/community.general/issues/5704, https://github.com/ansible-collections/community.general/pull/7264). - lxc connection plugin - properly evaluate options (https://github.com/ansible-collections/community.general/pull/7369). - mail - skip headers containing equals characters due to missing ``maxsplit`` on header key/value parsing (https://github.com/ansible-collections/community.general/pull/7303). - nmap inventory plugin - fix ``get_option`` calls (https://github.com/ansible-collections/community.general/pull/7323). - onepassword - fix KeyError exception when trying to access value of a field that is not filled out in OnePassword item (https://github.com/ansible-collections/community.general/pull/7241). - snap - change the change detection mechanism from "parsing installation" to "comparing end state with initial state" (https://github.com/ansible-collections/community.general/pull/7340, https://github.com/ansible-collections/community.general/issues/7265). - terraform - prevents ``-backend-config`` option double encapsulating with ``shlex_quote`` function. (https://github.com/ansible-collections/community.general/pull/7301). deprecated_features: - The next major release, community.general 8.0.0, will drop support for ansible-core 2.11 and 2.12, which have been End of Life for some time now. This means that this collection no longer supports Python 2.6 on the target. Individual content might still work with unsupported ansible-core versions, but that can change at any time. Also please note that from now on, for every new major community.general release, we will drop support for all ansible-core versions that have been End of Life for more than a few weeks on the date of the major release (https://github.com/ansible-community/community-topics/discussions/271, https://github.com/ansible-collections/community.general/pull/7259). - redfish_info, redfish_config, redfish_command - the default value ``10`` for the ``timeout`` option is deprecated and will change to ``60`` in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/7295). minor_changes: - cargo - add option ``executable``, which allows user to specify path to the cargo binary (https://github.com/ansible-collections/community.general/pull/7352). - cargo - add option ``locked`` which allows user to specify install the locked version of dependency instead of latest compatible version (https://github.com/ansible-collections/community.general/pull/6134). - dig lookup plugin - add TCP option to enable the use of TCP connection during DNS lookup (https://github.com/ansible-collections/community.general/pull/7343). - 'gitlab_group - add option ``force_delete`` (default: false) which allows delete group even if projects exists in it (https://github.com/ansible-collections/community.general/pull/7364).' - ini_file - add ``ignore_spaces`` option (https://github.com/ansible-collections/community.general/pull/7273). - newrelic_deployment - add option ``app_name_exact_match``, which filters results for the exact app_name provided (https://github.com/ansible-collections/community.general/pull/7355). - onepassword lookup plugin - introduce ``account_id`` option which allows specifying which account to use (https://github.com/ansible-collections/community.general/pull/7308). - onepassword_raw lookup plugin - introduce ``account_id`` option which allows specifying which account to use (https://github.com/ansible-collections/community.general/pull/7308). - parted - on resize, use ``--fix`` option if available (https://github.com/ansible-collections/community.general/pull/7304). - pnpm - set correct version when state is latest or version is not mentioned. Resolves previous idempotency problem (https://github.com/ansible-collections/community.general/pull/7339). - proxmox - add ``vmid`` (and ``taskid`` when possible) to return values (https://github.com/ansible-collections/community.general/pull/7263). - random_string - added new ``ignore_similar_chars`` and ``similar_chars`` option to ignore certain chars (https://github.com/ansible-collections/community.general/pull/7242). - redfish_command - add new option ``update_oem_params`` for the ``MultipartHTTPPushUpdate`` command (https://github.com/ansible-collections/community.general/issues/7331). - redfish_config - add ``CreateVolume`` command to allow creation of volumes on servers (https://github.com/ansible-collections/community.general/pull/6813). - redfish_config - adding ``SetSecureBoot`` command (https://github.com/ansible-collections/community.general/pull/7129). - redfish_info - add support for ``GetBiosRegistries`` command (https://github.com/ansible-collections/community.general/pull/7144). - redfish_info - adds ``LinkStatus`` to NIC inventory (https://github.com/ansible-collections/community.general/pull/7318). - redis_info - refactor the redis_info module to use the redis module_utils enabling to pass TLS parameters to the Redis client (https://github.com/ansible-collections/community.general/pull/7267). - supervisorctl - allow to stop matching running processes before removing them with ``stop_before_removing=true`` (https://github.com/ansible-collections/community.general/pull/7284). release_summary: 'Regular bugfix and feature release. Please note that this is the last minor 7.x.0 release. Further releases with major version 7 will be bugfix releases 7.5.y. ' fragments: - 6134-add-locked-option-for-cargo.yml - 6813-redfish-config-add-create-volume.yml - 7.5.0.yml - 7129-adding_set_secure_boot_command_to_redfish_config.yml - 7144-add-getbiosregistry-command-to-redfish-info.yml - 7241-prevent-key-error-when-value-does-not-exist.yml - 7242_ignore_similar_chars.yml - 7251-gitlab-variables-deleteing-all-variables.yml - 7263-proxmox-return-vmid-and-taskid.yaml - 7264-ldap_search-strings.yml - 7267-redis_info.yml - 7273-ini_file_ignore_spaces.yml - 7284-supervisorctl-stop-before-remove.yaml - 7295-adding_deprecation_for_timeout_in_redfish_info_config_command.yml - 7301-fix-backend-config-string-encapsulation.yml - 7303-mail-incorrect-header-parsing.yml - 7304-prevent-parted-warnings.yml - 7308-onepassword-multi-acc.yml - 7318-add-linkstatus-attribute-to-nic-inventory.yml - 7323-nmap.yml - 7330-redfish-utils-oem-params.yml - 7339-pnpm-correct-version-when-state-latest.yml - 7340-snap-fix.yml - 7343-dig-tcp-option.yml - 7352-add-executable-option-for-cargo.yml - 7355-newrelic-deployment-add-exact-name.yml - 7364-add-option-force-gitlab-group.yml - 7369-fix-lxc-options.yml - deprecate-ansible-core-2.11-2.12.yml modules: - description: Manipulate Consul roles name: consul_role namespace: '' - description: Set default handler for MIME type, for applications using Gnome GIO name: gio_mime namespace: '' - description: Allows administration of Keycloak client custom Javascript policies via Keycloak API name: keycloak_authz_custom_policy namespace: '' - description: Allows administration of Keycloak realm keys via Keycloak API name: keycloak_realm_key namespace: '' - description: Manage services on Source Mage GNU/Linux name: simpleinit_msb namespace: '' release_date: '2023-10-09' PK $�!\��� � S collections/ansible_collections/community/general/changelogs/changelog.yaml.licensenu �[��� GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) SPDX-License-Identifier: GPL-3.0-or-later SPDX-FileCopyrightText: Ansible Project PK $�!\muz�~ �~ B collections/ansible_collections/community/general/meta/runtime.ymlnu �[��� --- # Copyright (c) Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later requires_ansible: '>=2.11.0' 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 nios: redirect: infoblox.nios_modules.nios_lookup nios_next_ip: redirect: infoblox.nios_modules.nios_next_ip nios_next_network: redirect: infoblox.nios_modules.nios_next_network modules: rax_cbs_attachments: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_cbs: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_cdb_database: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_cdb_user: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_cdb: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_clb_nodes: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_clb_ssl: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_clb: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_dns_record: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_dns: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_facts: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_files_objects: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_files: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_identity: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_keypair: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_meta: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_mon_alarm: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_mon_check: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_mon_entity: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_mon_notification_plan: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_mon_notification: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_network: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_queue: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_scaling_group: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rax_scaling_policy: deprecation: removal_version: 9.0.0 warning_text: This module relies on the deprecated package pyrax. rhn_channel: deprecation: removal_version: 10.0.0 warning_text: RHN is EOL, please contact the community.general maintainers if still using this; see the module documentation for more details. rhn_register: deprecation: removal_version: 10.0.0 warning_text: RHN is EOL, please contact the community.general maintainers if still using this; see the module documentation for more details. database.aerospike.aerospike_migrations: redirect: community.general.aerospike_migrations deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aerospike_migrations modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.airbrake_deployment: redirect: community.general.airbrake_deployment deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.airbrake_deployment modules. This has never been supported or documented, and will stop working in community.general 9.0.0. stackdriver: deprecation: removal_version: 9.0.0 warning_text: > This module relies on HTTPS APIs that do not exist anymore, and any new development in the direction of providing an alternative should happen in the context of the google.cloud collection. system.aix_devices: redirect: community.general.aix_devices deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aix_devices modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.aix_filesystem: redirect: community.general.aix_filesystem deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aix_filesystem modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.aix_inittab: redirect: community.general.aix_inittab deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aix_inittab modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.aix_lvg: redirect: community.general.aix_lvg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aix_lvg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.aix_lvol: redirect: community.general.aix_lvol deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.aix_lvol modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.alerta_customer: redirect: community.general.alerta_customer deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.alerta_customer modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.alicloud.ali_instance: redirect: community.general.ali_instance deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ali_instance modules. This has never been supported or documented, and will stop working in community.general 9.0.0. ali_instance_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.ali_instance_info instead. cloud.alicloud.ali_instance_info: redirect: community.general.ali_instance_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ali_instance_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.alternatives: redirect: community.general.alternatives deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.alternatives modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.ansible_galaxy_install: redirect: community.general.ansible_galaxy_install deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ansible_galaxy_install modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.apache2_mod_proxy: redirect: community.general.apache2_mod_proxy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.apache2_mod_proxy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.apache2_module: redirect: community.general.apache2_module deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.apache2_module modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.apk: redirect: community.general.apk deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.apk modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.apt_repo: redirect: community.general.apt_repo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.apt_repo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.apt_rpm: redirect: community.general.apt_rpm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.apt_rpm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.archive: redirect: community.general.archive deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.archive modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.atomic.atomic_container: redirect: community.general.atomic_container deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.atomic_container modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.atomic.atomic_host: redirect: community.general.atomic_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.atomic_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.atomic.atomic_image: redirect: community.general.atomic_image deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.atomic_image modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.awall: redirect: community.general.awall deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.awall modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.beadm: redirect: community.general.beadm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.beadm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.bearychat: redirect: community.general.bearychat deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bearychat modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.bigpanda: redirect: community.general.bigpanda deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bigpanda modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.bitbucket.bitbucket_access_key: redirect: community.general.bitbucket_access_key deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bitbucket_access_key modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.bitbucket.bitbucket_pipeline_key_pair: redirect: community.general.bitbucket_pipeline_key_pair deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bitbucket_pipeline_key_pair modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.bitbucket.bitbucket_pipeline_known_host: redirect: community.general.bitbucket_pipeline_known_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bitbucket_pipeline_known_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.bitbucket.bitbucket_pipeline_variable: redirect: community.general.bitbucket_pipeline_variable deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bitbucket_pipeline_variable modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.bower: redirect: community.general.bower deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bower modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.bundler: redirect: community.general.bundler deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bundler modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.bzr: redirect: community.general.bzr deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.bzr modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.campfire: redirect: community.general.campfire deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.campfire modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.capabilities: redirect: community.general.capabilities deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.capabilities modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.cargo: redirect: community.general.cargo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cargo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.catapult: redirect: community.general.catapult deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.catapult modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.circonus_annotation: redirect: community.general.circonus_annotation deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.circonus_annotation modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cisco_spark: redirect: community.general.cisco_webex notification.cisco_spark: redirect: community.general.cisco_webex deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cisco_webex modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.cisco_webex: redirect: community.general.cisco_webex deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cisco_webex modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_aa_policy: redirect: community.general.clc_aa_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_aa_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_alert_policy: redirect: community.general.clc_alert_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_alert_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_blueprint_package: redirect: community.general.clc_blueprint_package deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_blueprint_package modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_firewall_policy: redirect: community.general.clc_firewall_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_firewall_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_group: redirect: community.general.clc_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_loadbalancer: redirect: community.general.clc_loadbalancer deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_loadbalancer modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_modify_server: redirect: community.general.clc_modify_server deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_modify_server modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_publicip: redirect: community.general.clc_publicip deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_publicip modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_server: redirect: community.general.clc_server deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_server modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.centurylink.clc_server_snapshot: redirect: community.general.clc_server_snapshot deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.clc_server_snapshot modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.cloud_init_data_facts: redirect: community.general.cloud_init_data_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cloud_init_data_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.cloudflare_dns: redirect: community.general.cloudflare_dns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cloudflare_dns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.cobbler.cobbler_sync: redirect: community.general.cobbler_sync deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cobbler_sync modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.cobbler.cobbler_system: redirect: community.general.cobbler_system deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cobbler_system modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.composer: redirect: community.general.composer deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.composer modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.consul.consul: redirect: community.general.consul deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.consul modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.consul.consul_acl: redirect: community.general.consul_acl deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.consul_acl modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.consul.consul_kv: redirect: community.general.consul_kv deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.consul_kv modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.consul.consul_session: redirect: community.general.consul_session deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.consul_session modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.copr: redirect: community.general.copr deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.copr modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.cpanm: redirect: community.general.cpanm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cpanm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.cronvar: redirect: community.general.cronvar deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.cronvar modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.crypttab: redirect: community.general.crypttab deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.crypttab modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.datadog.datadog_downtime: redirect: community.general.datadog_downtime deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.datadog_downtime modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.datadog.datadog_event: redirect: community.general.datadog_event deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.datadog_event modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.datadog.datadog_monitor: redirect: community.general.datadog_monitor deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.datadog_monitor modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.dconf: redirect: community.general.dconf deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dconf modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.deploy_helper: redirect: community.general.deploy_helper deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.deploy_helper modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.dimensiondata.dimensiondata_network: redirect: community.general.dimensiondata_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dimensiondata_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.dimensiondata.dimensiondata_vlan: redirect: community.general.dimensiondata_vlan deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dimensiondata_vlan modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.discord: redirect: community.general.discord deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.discord modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.django_manage: redirect: community.general.django_manage deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.django_manage modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.dnf_versionlock: redirect: community.general.dnf_versionlock deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dnf_versionlock modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.dnsimple: redirect: community.general.dnsimple deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dnsimple modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.dnsimple_info: redirect: community.general.dnsimple_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dnsimple_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.dnsmadeeasy: redirect: community.general.dnsmadeeasy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dnsmadeeasy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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 system.dpkg_divert: redirect: community.general.dpkg_divert deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.dpkg_divert modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.easy_install: redirect: community.general.easy_install deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.easy_install modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.ejabberd_user: redirect: community.general.ejabberd_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ejabberd_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.elasticsearch_plugin: redirect: community.general.elasticsearch_plugin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.elasticsearch_plugin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.emc.emc_vnx_sg_member: redirect: community.general.emc_vnx_sg_member deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.emc_vnx_sg_member modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.etcd3: redirect: community.general.etcd3 deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.etcd3 modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.facter: redirect: community.general.facter deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.facter modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.filesize: redirect: community.general.filesize deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.filesize modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.filesystem: redirect: community.general.filesystem deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.filesystem modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.flatpak: redirect: community.general.flatpak deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.flatpak modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.flatpak_remote: redirect: community.general.flatpak_remote deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.flatpak_remote modules. This has never been supported or documented, and will stop working in community.general 9.0.0. flowdock: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. notification.flowdock: redirect: community.general.flowdock deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.flowdock modules. This has never been supported or documented, and will stop working in community.general 9.0.0. foreman: tombstone: removal_version: 2.0.0 warning_text: Use the modules from the theforeman.foreman collection instead. net_tools.gandi_livedns: redirect: community.general.gandi_livedns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gandi_livedns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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 system.gconftool2: redirect: community.general.gconftool2 deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gconftool2 modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.gconftool2_info: redirect: community.general.gconftool2_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gconftool2_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.google.gcpubsub_info instead. gcpubsub_info: redirect: community.google.gcpubsub_info gcspanner: tombstone: removal_version: 2.0.0 warning_text: Use google.cloud.gcp_spanner_database and/or google.cloud.gcp_spanner_instance instead. packaging.language.gem: redirect: community.general.gem deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gem modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.git_config: redirect: community.general.git_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.git_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_deploy_key: redirect: community.general.github_deploy_key deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_deploy_key modules. This has never been supported or documented, and will stop working in community.general 9.0.0. github_hooks: tombstone: removal_version: 2.0.0 warning_text: Use community.general.github_webhook and community.general.github_webhook_info instead. source_control.github.github_issue: redirect: community.general.github_issue deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_issue modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_key: redirect: community.general.github_key deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_key modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_release: redirect: community.general.github_release deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_release modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_repo: redirect: community.general.github_repo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_repo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_webhook: redirect: community.general.github_webhook deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_webhook modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.github.github_webhook_info: redirect: community.general.github_webhook_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.github_webhook_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_branch: redirect: community.general.gitlab_branch deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_branch modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_deploy_key: redirect: community.general.gitlab_deploy_key deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_deploy_key modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_group: redirect: community.general.gitlab_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_group_members: redirect: community.general.gitlab_group_members deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_group_members modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_group_variable: redirect: community.general.gitlab_group_variable deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_group_variable modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_hook: redirect: community.general.gitlab_hook deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_hook modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_project: redirect: community.general.gitlab_project deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_project modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_project_members: redirect: community.general.gitlab_project_members deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_project_members modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_project_variable: redirect: community.general.gitlab_project_variable deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_project_variable modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_protected_branch: redirect: community.general.gitlab_protected_branch deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_protected_branch modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_runner: redirect: community.general.gitlab_runner deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_runner modules. This has never been supported or documented, and will stop working in community.general 9.0.0. source_control.gitlab.gitlab_user: redirect: community.general.gitlab_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gitlab_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.grove: redirect: community.general.grove deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.grove modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.gunicorn: redirect: community.general.gunicorn deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.gunicorn modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.saphana.hana_query: redirect: community.general.hana_query deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hana_query modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.haproxy: redirect: community.general.haproxy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.haproxy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.heroku.heroku_collaborator: redirect: community.general.heroku_collaborator deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.heroku_collaborator modules. This has never been supported or documented, and will stop working in community.general 9.0.0. hana_query: redirect: community.sap_libs.sap_hdbsql 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 source_control.hg: redirect: community.general.hg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.hipchat: redirect: community.general.hipchat deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hipchat modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.homebrew: redirect: community.general.homebrew deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.homebrew modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.homebrew_cask: redirect: community.general.homebrew_cask deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.homebrew_cask modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.homebrew_tap: redirect: community.general.homebrew_tap deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.homebrew_tap modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.homectl: redirect: community.general.homectl deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.homectl modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.honeybadger_deployment: redirect: community.general.honeybadger_deployment deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.honeybadger_deployment modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.hpilo.hpilo_boot: redirect: community.general.hpilo_boot deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hpilo_boot modules. This has never been supported or documented, and will stop working in community.general 9.0.0. hpilo_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.hpilo_info instead. remote_management.hpilo.hpilo_info: redirect: community.general.hpilo_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hpilo_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.hpilo.hponcfg: redirect: community.general.hponcfg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hponcfg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.htpasswd: redirect: community.general.htpasswd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.htpasswd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_ecs_instance: redirect: community.general.hwc_ecs_instance deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_ecs_instance modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_evs_disk: redirect: community.general.hwc_evs_disk deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_evs_disk modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_network_vpc: redirect: community.general.hwc_network_vpc deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_network_vpc modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_smn_topic: redirect: community.general.hwc_smn_topic deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_smn_topic modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_eip: redirect: community.general.hwc_vpc_eip deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_eip modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_peering_connect: redirect: community.general.hwc_vpc_peering_connect deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_peering_connect modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_port: redirect: community.general.hwc_vpc_port deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_port modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_private_ip: redirect: community.general.hwc_vpc_private_ip deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_private_ip modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_route: redirect: community.general.hwc_vpc_route deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_route modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_security_group: redirect: community.general.hwc_vpc_security_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_security_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_security_group_rule: redirect: community.general.hwc_vpc_security_group_rule deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_security_group_rule modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.huawei.hwc_vpc_subnet: redirect: community.general.hwc_vpc_subnet deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.hwc_vpc_subnet modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_domain: redirect: community.general.ibm_sa_domain deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_domain modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_host: redirect: community.general.ibm_sa_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_host_ports: redirect: community.general.ibm_sa_host_ports deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_host_ports modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_pool: redirect: community.general.ibm_sa_pool deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_pool modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_vol: redirect: community.general.ibm_sa_vol deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_vol modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.ibm.ibm_sa_vol_map: redirect: community.general.ibm_sa_vol_map deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ibm_sa_vol_map modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.icinga2_feature: redirect: community.general.icinga2_feature deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.icinga2_feature modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.icinga2_host: redirect: community.general.icinga2_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.icinga2_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. idrac_firmware: redirect: dellemc.openmanage.idrac_firmware remote_management.redfish.idrac_redfish_command: redirect: community.general.idrac_redfish_command deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.idrac_redfish_command modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.idrac_redfish_config: redirect: community.general.idrac_redfish_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.idrac_redfish_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. idrac_redfish_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.idrac_redfish_info instead. remote_management.redfish.idrac_redfish_info: redirect: community.general.idrac_redfish_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.idrac_redfish_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. idrac_server_config_profile: redirect: dellemc.openmanage.idrac_server_config_profile remote_management.redfish.ilo_redfish_config: redirect: community.general.ilo_redfish_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ilo_redfish_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.ilo_redfish_info: redirect: community.general.ilo_redfish_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ilo_redfish_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.imc.imc_rest: redirect: community.general.imc_rest deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.imc_rest modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.smartos.imgadm: redirect: community.general.imgadm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.imgadm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.infinity.infinity: redirect: community.general.infinity deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.infinity modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.influxdb.influxdb_database: redirect: community.general.influxdb_database deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.influxdb_database modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.influxdb.influxdb_query: redirect: community.general.influxdb_query deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.influxdb_query modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.influxdb.influxdb_retention_policy: redirect: community.general.influxdb_retention_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.influxdb_retention_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.influxdb.influxdb_user: redirect: community.general.influxdb_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.influxdb_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.influxdb.influxdb_write: redirect: community.general.influxdb_write deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.influxdb_write modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.ini_file: redirect: community.general.ini_file deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ini_file modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.installp: redirect: community.general.installp deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.installp modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.interfaces_file: redirect: community.general.interfaces_file deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.interfaces_file modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ip_netns: redirect: community.general.ip_netns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ip_netns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_config: redirect: community.general.ipa_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_dnsrecord: redirect: community.general.ipa_dnsrecord deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_dnsrecord modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_dnszone: redirect: community.general.ipa_dnszone deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_dnszone modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_group: redirect: community.general.ipa_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_hbacrule: redirect: community.general.ipa_hbacrule deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_hbacrule modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_host: redirect: community.general.ipa_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_hostgroup: redirect: community.general.ipa_hostgroup deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_hostgroup modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_otpconfig: redirect: community.general.ipa_otpconfig deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_otpconfig modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_otptoken: redirect: community.general.ipa_otptoken deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_otptoken modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_pwpolicy: redirect: community.general.ipa_pwpolicy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_pwpolicy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_role: redirect: community.general.ipa_role deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_role modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_service: redirect: community.general.ipa_service deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_service modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_subca: redirect: community.general.ipa_subca deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_subca modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_sudocmd: redirect: community.general.ipa_sudocmd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_sudocmd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_sudocmdgroup: redirect: community.general.ipa_sudocmdgroup deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_sudocmdgroup modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_sudorule: redirect: community.general.ipa_sudorule deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_sudorule modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_user: redirect: community.general.ipa_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.ipa.ipa_vault: redirect: community.general.ipa_vault deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipa_vault modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ipify_facts: redirect: community.general.ipify_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipify_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ipinfoio_facts: redirect: community.general.ipinfoio_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipinfoio_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.ipmi.ipmi_boot: redirect: community.general.ipmi_boot deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipmi_boot modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.ipmi.ipmi_power: redirect: community.general.ipmi_power deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipmi_power modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.iptables_state: redirect: community.general.iptables_state deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.iptables_state modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ipwcli_dns: redirect: community.general.ipwcli_dns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ipwcli_dns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.irc: redirect: community.general.irc deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.irc modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.iso_create: redirect: community.general.iso_create deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.iso_create modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.iso_extract: redirect: community.general.iso_extract deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.iso_extract modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.iso_customize: redirect: community.general.iso_customize deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.iso_customize modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.jabber: redirect: community.general.jabber deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jabber modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.java_cert: redirect: community.general.java_cert deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.java_cert modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.java_keystore: redirect: community.general.java_keystore deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.java_keystore modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jboss: redirect: community.general.jboss deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jboss modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jenkins_build: redirect: community.general.jenkins_build deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jenkins_build modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jenkins_job: redirect: community.general.jenkins_job deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jenkins_job modules. This has never been supported or documented, and will stop working in community.general 9.0.0. jenkins_job_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.jenkins_job_info instead. web_infrastructure.jenkins_job_info: redirect: community.general.jenkins_job_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jenkins_job_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jenkins_plugin: redirect: community.general.jenkins_plugin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jenkins_plugin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jenkins_script: redirect: community.general.jenkins_script deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jenkins_script modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.jira: redirect: community.general.jira deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.jira modules. This has never been supported or documented, and will stop working in community.general 9.0.0. katello: tombstone: removal_version: 2.0.0 warning_text: Use the modules from the theforeman.foreman collection instead. system.kernel_blacklist: redirect: community.general.kernel_blacklist deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.kernel_blacklist modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_authentication: redirect: community.general.keycloak_authentication deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_authentication modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_client: redirect: community.general.keycloak_client deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_client modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_client_rolemapping: redirect: community.general.keycloak_client_rolemapping deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_client_rolemapping modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_clientscope: redirect: community.general.keycloak_clientscope deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_clientscope modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_clienttemplate: redirect: community.general.keycloak_clienttemplate deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_clienttemplate modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_group: redirect: community.general.keycloak_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_identity_provider: redirect: community.general.keycloak_identity_provider deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_identity_provider modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_realm: redirect: community.general.keycloak_realm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_realm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_realm_info: redirect: community.general.keycloak_realm_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_realm_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_role: redirect: community.general.keycloak_role deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_role modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_user_federation: redirect: community.general.keycloak_user_federation deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_user_federation modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.keycloak.keycloak_user_rolemapping: redirect: community.general.keycloak_user_rolemapping deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keycloak_user_rolemapping modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.keyring: redirect: community.general.keyring deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keyring modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.keyring_info: redirect: community.general.keyring_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.keyring_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.kibana_plugin: redirect: community.general.kibana_plugin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.kibana_plugin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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 system.launchd: redirect: community.general.launchd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.launchd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.layman: redirect: community.general.layman deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.layman modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.lbu: redirect: community.general.lbu deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lbu modules. This has never been supported or documented, and will stop working in community.general 9.0.0. ldap_attr: tombstone: removal_version: 3.0.0 warning_text: Use community.general.ldap_attrs instead. net_tools.ldap.ldap_attrs: redirect: community.general.ldap_attrs deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ldap_attrs modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ldap.ldap_entry: redirect: community.general.ldap_entry deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ldap_entry modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ldap.ldap_passwd: redirect: community.general.ldap_passwd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ldap_passwd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.ldap.ldap_search: redirect: community.general.ldap_search deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ldap_search modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.librato_annotation: redirect: community.general.librato_annotation deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.librato_annotation modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.linode.linode: redirect: community.general.linode deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.linode modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.linode.linode_v4: redirect: community.general.linode_v4 deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.linode_v4 modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.listen_ports_facts: redirect: community.general.listen_ports_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.listen_ports_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.lldp: redirect: community.general.lldp deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lldp modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.locale_gen: redirect: community.general.locale_gen deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.locale_gen modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.logentries: redirect: community.general.logentries deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.logentries modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.logentries_msg: redirect: community.general.logentries_msg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.logentries_msg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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. monitoring.logstash_plugin: redirect: community.general.logstash_plugin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.logstash_plugin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.lvg: redirect: community.general.lvg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lvg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.lvol: redirect: community.general.lvol deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lvol modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.lxc.lxc_container: redirect: community.general.lxc_container deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxc_container modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.lxca.lxca_cmms: redirect: community.general.lxca_cmms deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxca_cmms modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.lxca.lxca_nodes: redirect: community.general.lxca_nodes deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxca_nodes modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.lxd.lxd_container: redirect: community.general.lxd_container deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxd_container modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.lxd.lxd_profile: redirect: community.general.lxd_profile deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxd_profile modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.lxd.lxd_project: redirect: community.general.lxd_project deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.lxd_project modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.macports: redirect: community.general.macports deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.macports modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.mail: redirect: community.general.mail deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mail modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.make: redirect: community.general.make deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.make modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_alert_profiles: redirect: community.general.manageiq_alert_profiles deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_alert_profiles modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_alerts: redirect: community.general.manageiq_alerts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_alerts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_group: redirect: community.general.manageiq_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_policies: redirect: community.general.manageiq_policies deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_policies modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_policies_info: redirect: community.general.manageiq_policies_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_policies_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_provider: redirect: community.general.manageiq_provider deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_provider modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_tags: redirect: community.general.manageiq_tags deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_tags modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_tags_info: redirect: community.general.manageiq_tags_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_tags_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_tenant: redirect: community.general.manageiq_tenant deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_tenant modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.manageiq.manageiq_user: redirect: community.general.manageiq_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.manageiq_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.mas: redirect: community.general.mas deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mas modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.matrix: redirect: community.general.matrix deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.matrix modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.mattermost: redirect: community.general.mattermost deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mattermost modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.maven_artifact: redirect: community.general.maven_artifact deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.maven_artifact modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.memset.memset_dns_reload: redirect: community.general.memset_dns_reload deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_dns_reload modules. This has never been supported or documented, and will stop working in community.general 9.0.0. memset_memstore_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.memset_memstore_info instead. cloud.memset.memset_memstore_info: redirect: community.general.memset_memstore_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_memstore_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. memset_server_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.memset_server_info instead. cloud.memset.memset_server_info: redirect: community.general.memset_server_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_server_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.memset.memset_zone: redirect: community.general.memset_zone deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_zone modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.memset.memset_zone_domain: redirect: community.general.memset_zone_domain deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_zone_domain modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.memset.memset_zone_record: redirect: community.general.memset_zone_record deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.memset_zone_record modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.mksysb: redirect: community.general.mksysb deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mksysb modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.modprobe: redirect: community.general.modprobe deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.modprobe modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.monit: redirect: community.general.monit deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.monit modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.mqtt: redirect: community.general.mqtt deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mqtt modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.mssql.mssql_db: redirect: community.general.mssql_db deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mssql_db modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.mssql.mssql_script: redirect: community.general.mssql_script deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.mssql_script modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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: tombstone: removal_version: 3.0.0 warning_text: Use netapp.ontap.na_ontap_info instead. monitoring.nagios: redirect: community.general.nagios deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nagios modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.netcup_dns: redirect: community.general.netcup_dns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.netcup_dns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.newrelic_deployment: redirect: community.general.newrelic_deployment deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.newrelic_deployment modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.nexmo: redirect: community.general.nexmo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nexmo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. nginx_status_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.nginx_status_info instead. web_infrastructure.nginx_status_info: redirect: community.general.nginx_status_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nginx_status_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.smartos.nictagadm: redirect: community.general.nictagadm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nictagadm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. nios_a_record: redirect: infoblox.nios_modules.nios_a_record nios_aaaa_record: redirect: infoblox.nios_modules.nios_aaaa_record nios_cname_record: redirect: infoblox.nios_modules.nios_cname_record nios_dns_view: redirect: infoblox.nios_modules.nios_dns_view nios_fixed_address: redirect: infoblox.nios_modules.nios_fixed_address nios_host_record: redirect: infoblox.nios_modules.nios_host_record nios_member: redirect: infoblox.nios_modules.nios_member nios_mx_record: redirect: infoblox.nios_modules.nios_mx_record nios_naptr_record: redirect: infoblox.nios_modules.nios_naptr_record nios_network: redirect: infoblox.nios_modules.nios_network nios_network_view: redirect: infoblox.nios_modules.nios_network_view nios_nsgroup: redirect: infoblox.nios_modules.nios_nsgroup nios_ptr_record: redirect: infoblox.nios_modules.nios_ptr_record nios_srv_record: redirect: infoblox.nios_modules.nios_srv_record nios_txt_record: redirect: infoblox.nios_modules.nios_txt_record nios_zone: redirect: infoblox.nios_modules.nios_zone net_tools.nmcli: redirect: community.general.nmcli deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nmcli modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.nomad.nomad_job: redirect: community.general.nomad_job deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nomad_job modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.nomad.nomad_job_info: redirect: community.general.nomad_job_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nomad_job_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.nosh: redirect: community.general.nosh deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nosh modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.npm: redirect: community.general.npm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.npm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.nsupdate: redirect: community.general.nsupdate deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.nsupdate modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oracle.oci_vcn: redirect: community.general.oci_vcn deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oci_vcn modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.odbc: redirect: community.general.odbc deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.odbc modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.office_365_connector_card: redirect: community.general.office_365_connector_card deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.office_365_connector_card modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.ohai: redirect: community.general.ohai deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ohai modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.omapi_host: redirect: community.general.omapi_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.omapi_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. ome_device_info: redirect: dellemc.openmanage.ome_device_info cloud.opennebula.one_host: redirect: community.general.one_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.opennebula.one_image: redirect: community.general.one_image deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_image modules. This has never been supported or documented, and will stop working in community.general 9.0.0. one_image_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.one_image_info instead. cloud.opennebula.one_image_info: redirect: community.general.one_image_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_image_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.opennebula.one_service: redirect: community.general.one_service deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_service modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.opennebula.one_template: redirect: community.general.one_template deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_template modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.opennebula.one_vm: redirect: community.general.one_vm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.one_vm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_firewall_policy: redirect: community.general.oneandone_firewall_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_firewall_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_load_balancer: redirect: community.general.oneandone_load_balancer deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_load_balancer modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_monitoring_policy: redirect: community.general.oneandone_monitoring_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_monitoring_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_private_network: redirect: community.general.oneandone_private_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_private_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_public_ip: redirect: community.general.oneandone_public_ip deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_public_ip modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.oneandone.oneandone_server: redirect: community.general.oneandone_server deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneandone_server modules. This has never been supported or documented, and will stop working in community.general 9.0.0. onepassword_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.onepassword_info instead. identity.onepassword_info: redirect: community.general.onepassword_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.onepassword_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_datacenter_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_datacenter_info instead. remote_management.oneview.oneview_datacenter_info: redirect: community.general.oneview_datacenter_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_datacenter_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_enclosure_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_enclosure_info instead. remote_management.oneview.oneview_enclosure_info: redirect: community.general.oneview_enclosure_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_enclosure_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_ethernet_network: redirect: community.general.oneview_ethernet_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_ethernet_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_ethernet_network_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_ethernet_network_info instead. remote_management.oneview.oneview_ethernet_network_info: redirect: community.general.oneview_ethernet_network_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_ethernet_network_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_fc_network: redirect: community.general.oneview_fc_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_fc_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_fc_network_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_fc_network_info instead. remote_management.oneview.oneview_fc_network_info: redirect: community.general.oneview_fc_network_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_fc_network_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_fcoe_network: redirect: community.general.oneview_fcoe_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_fcoe_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_fcoe_network_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_fcoe_network_info instead. remote_management.oneview.oneview_fcoe_network_info: redirect: community.general.oneview_fcoe_network_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_fcoe_network_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_logical_interconnect_group: redirect: community.general.oneview_logical_interconnect_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_logical_interconnect_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_logical_interconnect_group_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_logical_interconnect_group_info instead. remote_management.oneview.oneview_logical_interconnect_group_info: redirect: community.general.oneview_logical_interconnect_group_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_logical_interconnect_group_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_network_set: redirect: community.general.oneview_network_set deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_network_set modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_network_set_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_network_set_info instead. remote_management.oneview.oneview_network_set_info: redirect: community.general.oneview_network_set_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_network_set_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.oneview.oneview_san_manager: redirect: community.general.oneview_san_manager deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_san_manager modules. This has never been supported or documented, and will stop working in community.general 9.0.0. oneview_san_manager_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.oneview_san_manager_info instead. remote_management.oneview.oneview_san_manager_info: redirect: community.general.oneview_san_manager_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.oneview_san_manager_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. online_server_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.online_server_info instead. cloud.online.online_server_info: redirect: community.general.online_server_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.online_server_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. online_user_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.online_user_info instead. cloud.online.online_user_info: redirect: community.general.online_user_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.online_user_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.open_iscsi: redirect: community.general.open_iscsi deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.open_iscsi modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.openbsd_pkg: redirect: community.general.openbsd_pkg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.openbsd_pkg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. identity.opendj.opendj_backendprop: redirect: community.general.opendj_backendprop deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.opendj_backendprop modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.openwrt_init: redirect: community.general.openwrt_init deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.openwrt_init modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.opkg: redirect: community.general.opkg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.opkg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.osx_defaults: redirect: community.general.osx_defaults deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.osx_defaults modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.ovh.ovh_ip_failover: redirect: community.general.ovh_ip_failover deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ovh_ip_failover modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.ovh.ovh_ip_loadbalancing_backend: redirect: community.general.ovh_ip_loadbalancing_backend deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ovh_ip_loadbalancing_backend modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.ovh.ovh_monthly_billing: redirect: community.general.ovh_monthly_billing deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ovh_monthly_billing modules. This has never been supported or documented, and will stop working in community.general 9.0.0. ovirt: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_vm instead. ovirt_affinity_label_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_affinity_label_info instead. ovirt_api_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_api_info instead. ovirt_cluster_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_cluster_info instead. ovirt_datacenter_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_datacenter_info instead. ovirt_disk_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_disk_info instead. ovirt_event_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_event_info instead. ovirt_external_provider_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_external_provider_info instead. ovirt_group_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_group_info instead. ovirt_host_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_host_info instead. ovirt_host_storage_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_host_storage_info instead. ovirt_network_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_network_info instead. ovirt_nic_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_nic_info instead. ovirt_permission_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_permission_info instead. ovirt_quota_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_quota_info instead. ovirt_scheduling_policy_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_scheduling_policy_info instead. ovirt_snapshot_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_snapshot_info instead. ovirt_storage_domain_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_storage_domain_info instead. ovirt_storage_template_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_storage_template_info instead. ovirt_storage_vm_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_storage_vm_info instead. ovirt_tag_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_tag_info instead. ovirt_template_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_template_info instead. ovirt_user_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_user_info instead. ovirt_vm_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_vm_info instead. ovirt_vmpool_facts: tombstone: removal_version: 3.0.0 warning_text: Use ovirt.ovirt.ovirt_vmpool_info instead. clustering.pacemaker_cluster: redirect: community.general.pacemaker_cluster deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pacemaker_cluster modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_device: redirect: community.general.packet_device deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_device modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_ip_subnet: redirect: community.general.packet_ip_subnet deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_ip_subnet modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_project: redirect: community.general.packet_project deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_project modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_sshkey: redirect: community.general.packet_sshkey deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_sshkey modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_volume: redirect: community.general.packet_volume deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_volume modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.packet.packet_volume_attachment: redirect: community.general.packet_volume_attachment deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.packet_volume_attachment modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pacman: redirect: community.general.pacman deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pacman modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pacman_key: redirect: community.general.pacman_key deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pacman_key modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.pagerduty: redirect: community.general.pagerduty deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pagerduty modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.pagerduty_alert: redirect: community.general.pagerduty_alert deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pagerduty_alert modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.pagerduty_change: redirect: community.general.pagerduty_change deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pagerduty_change modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.pagerduty_user: redirect: community.general.pagerduty_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pagerduty_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.pam_limits: redirect: community.general.pam_limits deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pam_limits modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.pamd: redirect: community.general.pamd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pamd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.parted: redirect: community.general.parted deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.parted modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.pear: redirect: community.general.pear deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pear modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.pids: redirect: community.general.pids deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pids modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.pingdom: redirect: community.general.pingdom deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pingdom modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.pip_package_info: redirect: community.general.pip_package_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pip_package_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.pipx: redirect: community.general.pipx deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pipx modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.pipx_info: redirect: community.general.pipx_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pipx_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pkg5: redirect: community.general.pkg5 deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pkg5 modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pkg5_publisher: redirect: community.general.pkg5_publisher deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pkg5_publisher modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pkgin: redirect: community.general.pkgin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pkgin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pkgng: redirect: community.general.pkgng deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pkgng modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pkgutil: redirect: community.general.pkgutil deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pkgutil modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.pmem.pmem: redirect: community.general.pmem deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pmem modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.portage: redirect: community.general.portage deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.portage modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.portinstall: redirect: community.general.portinstall deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.portinstall modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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: redirect: community.postgresql.postgresql_user postgresql_user_obj_stat_info: redirect: community.postgresql.postgresql_user_obj_stat_info net_tools.pritunl.pritunl_org: redirect: community.general.pritunl_org deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pritunl_org modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.pritunl.pritunl_org_info: redirect: community.general.pritunl_org_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pritunl_org_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.pritunl.pritunl_user: redirect: community.general.pritunl_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pritunl_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.pritunl.pritunl_user_info: redirect: community.general.pritunl_user_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pritunl_user_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.profitbricks.profitbricks: redirect: community.general.profitbricks deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.profitbricks modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.profitbricks.profitbricks_datacenter: redirect: community.general.profitbricks_datacenter deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.profitbricks_datacenter modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.profitbricks.profitbricks_nic: redirect: community.general.profitbricks_nic deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.profitbricks_nic modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.profitbricks.profitbricks_volume: redirect: community.general.profitbricks_volume deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.profitbricks_volume modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.profitbricks.profitbricks_volume_attachments: redirect: community.general.profitbricks_volume_attachments deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.profitbricks_volume_attachments modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox: redirect: community.general.proxmox deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_disk: redirect: community.general.proxmox_disk deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_disk modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_domain_info: redirect: community.general.proxmox_domain_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_domain_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_group_info: redirect: community.general.proxmox_group_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_group_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_kvm: redirect: community.general.proxmox_kvm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_kvm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_nic: redirect: community.general.proxmox_nic deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_nic modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_snap: redirect: community.general.proxmox_snap deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_snap modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_storage_info: redirect: community.general.proxmox_storage_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_storage_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_tasks_info: redirect: community.general.proxmox_tasks_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_tasks_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_template: redirect: community.general.proxmox_template deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_template modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.proxmox_user_info: redirect: community.general.proxmox_user_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.proxmox_user_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.pubnub.pubnub_blocks: redirect: community.general.pubnub_blocks deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pubnub_blocks modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.pulp_repo: redirect: community.general.pulp_repo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pulp_repo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.puppet: redirect: community.general.puppet deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.puppet modules. This has never been supported or documented, and will stop working in community.general 9.0.0. purefa_facts: tombstone: removal_version: 3.0.0 warning_text: Use purestorage.flasharray.purefa_info instead. purefb_facts: tombstone: removal_version: 3.0.0 warning_text: Use purestorage.flashblade.purefb_info instead. notification.pushbullet: redirect: community.general.pushbullet deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pushbullet modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.pushover: redirect: community.general.pushover deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.pushover modules. This has never been supported or documented, and will stop working in community.general 9.0.0. python_requirements_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.python_requirements_info instead. system.python_requirements_info: redirect: community.general.python_requirements_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.python_requirements_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax: redirect: community.general.rax deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_cbs: redirect: community.general.rax_cbs deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_cbs modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_cbs_attachments: redirect: community.general.rax_cbs_attachments deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_cbs_attachments modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_cdb: redirect: community.general.rax_cdb deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_cdb modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_cdb_database: redirect: community.general.rax_cdb_database deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_cdb_database modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_cdb_user: redirect: community.general.rax_cdb_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_cdb_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_clb: redirect: community.general.rax_clb deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_clb modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_clb_nodes: redirect: community.general.rax_clb_nodes deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_clb_nodes modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_clb_ssl: redirect: community.general.rax_clb_ssl deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_clb_ssl modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_dns: redirect: community.general.rax_dns deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_dns modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_dns_record: redirect: community.general.rax_dns_record deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_dns_record modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_facts: redirect: community.general.rax_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_files: redirect: community.general.rax_files deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_files modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_files_objects: redirect: community.general.rax_files_objects deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_files_objects modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_identity: redirect: community.general.rax_identity deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_identity modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_keypair: redirect: community.general.rax_keypair deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_keypair modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_meta: redirect: community.general.rax_meta deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_meta modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_mon_alarm: redirect: community.general.rax_mon_alarm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_mon_alarm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_mon_check: redirect: community.general.rax_mon_check deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_mon_check modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_mon_entity: redirect: community.general.rax_mon_entity deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_mon_entity modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_mon_notification: redirect: community.general.rax_mon_notification deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_mon_notification modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_mon_notification_plan: redirect: community.general.rax_mon_notification_plan deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_mon_notification_plan modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_network: redirect: community.general.rax_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_queue: redirect: community.general.rax_queue deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_queue modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_scaling_group: redirect: community.general.rax_scaling_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_scaling_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.rackspace.rax_scaling_policy: redirect: community.general.rax_scaling_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rax_scaling_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.read_csv: redirect: community.general.read_csv deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.read_csv modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.redfish_command: redirect: community.general.redfish_command deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redfish_command modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.redfish_config: redirect: community.general.redfish_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redfish_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. redfish_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.redfish_info instead. remote_management.redfish.redfish_info: redirect: community.general.redfish_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redfish_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. sapcar_extract: redirect: community.sap_libs.sapcar_extract sap_task_list_execute: redirect: community.sap_libs.sap_task_list_execute packaging.os.redhat_subscription: redirect: community.general.redhat_subscription deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redhat_subscription modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.redis: redirect: community.general.redis deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redis modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.redis_data: redirect: community.general.redis_data deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redis_data modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.redis_data_incr: redirect: community.general.redis_data_incr deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redis_data_incr modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.redis_data_info: redirect: community.general.redis_data_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redis_data_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.redis_info: redirect: community.general.redis_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.redis_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.rhevm: redirect: community.general.rhevm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rhevm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.rhn_channel: redirect: community.general.rhn_channel deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rhn_channel modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.rhn_register: redirect: community.general.rhn_register deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rhn_register modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.rhsm_release: redirect: community.general.rhsm_release deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rhsm_release modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.rhsm_repository: redirect: community.general.rhsm_repository deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rhsm_repository modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.misc.riak: redirect: community.general.riak deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.riak modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.rocketchat: redirect: community.general.rocketchat deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rocketchat modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.rollbar_deployment: redirect: community.general.rollbar_deployment deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rollbar_deployment modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.rpm_ostree_pkg: redirect: community.general.rpm_ostree_pkg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rpm_ostree_pkg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.rundeck_acl_policy: redirect: community.general.rundeck_acl_policy deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rundeck_acl_policy modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.rundeck_job_executions_info: redirect: community.general.rundeck_job_executions_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rundeck_job_executions_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.rundeck_job_run: redirect: community.general.rundeck_job_run deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rundeck_job_run modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.rundeck_project: redirect: community.general.rundeck_project deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.rundeck_project modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.runit: redirect: community.general.runit deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.runit modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.sap_task_list_execute: redirect: community.general.sap_task_list_execute deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sap_task_list_execute modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.sapcar_extract: redirect: community.general.sapcar_extract deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sapcar_extract modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.say: redirect: community.general.say deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.say modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_compute: redirect: community.general.scaleway_compute deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_compute modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_compute_private_network: redirect: community.general.scaleway_compute_private_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_compute_private_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_container_registry: redirect: community.general.scaleway_container_registry deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_container_registry modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_container_registry_info: redirect: community.general.scaleway_container_registry_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_container_registry_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_database_backup: redirect: community.general.scaleway_database_backup deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_database_backup modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_function_namespace: redirect: community.general.scaleway_function_namespace deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_function_namespace modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_function_namespace_info: redirect: community.general.scaleway_function_namespace_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_function_namespace_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_image_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_image_info instead. cloud.scaleway.scaleway_image_info: redirect: community.general.scaleway_image_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_image_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_ip: redirect: community.general.scaleway_ip deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_ip modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_ip_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_ip_info instead. cloud.scaleway.scaleway_ip_info: redirect: community.general.scaleway_ip_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_ip_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_lb: redirect: community.general.scaleway_lb deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_lb modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_organization_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_organization_info instead. cloud.scaleway.scaleway_organization_info: redirect: community.general.scaleway_organization_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_organization_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_private_network: redirect: community.general.scaleway_private_network deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_private_network modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_security_group: redirect: community.general.scaleway_security_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_security_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_security_group_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_security_group_info instead. cloud.scaleway.scaleway_security_group_info: redirect: community.general.scaleway_security_group_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_security_group_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_security_group_rule: redirect: community.general.scaleway_security_group_rule deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_security_group_rule modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_server_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_server_info instead. cloud.scaleway.scaleway_server_info: redirect: community.general.scaleway_server_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_server_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_snapshot_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_snapshot_info instead. cloud.scaleway.scaleway_snapshot_info: redirect: community.general.scaleway_snapshot_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_snapshot_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_sshkey: redirect: community.general.scaleway_sshkey deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_sshkey modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_user_data: redirect: community.general.scaleway_user_data deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_user_data modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.scaleway.scaleway_volume: redirect: community.general.scaleway_volume deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_volume modules. This has never been supported or documented, and will stop working in community.general 9.0.0. scaleway_volume_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.scaleway_volume_info instead. cloud.scaleway.scaleway_volume_info: redirect: community.general.scaleway_volume_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.scaleway_volume_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.sefcontext: redirect: community.general.sefcontext deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sefcontext modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.selinux_permissive: redirect: community.general.selinux_permissive deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.selinux_permissive modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.selogin: redirect: community.general.selogin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.selogin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.sendgrid: redirect: community.general.sendgrid deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sendgrid modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.sensu.sensu_check: redirect: community.general.sensu_check deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sensu_check modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.sensu.sensu_client: redirect: community.general.sensu_client deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sensu_client modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.sensu.sensu_handler: redirect: community.general.sensu_handler deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sensu_handler modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.sensu.sensu_silence: redirect: community.general.sensu_silence deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sensu_silence modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.sensu.sensu_subscription: redirect: community.general.sensu_subscription deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sensu_subscription modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.seport: redirect: community.general.seport deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.seport modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.serverless: redirect: community.general.serverless deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.serverless modules. This has never been supported or documented, and will stop working in community.general 9.0.0. 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. system.shutdown: redirect: community.general.shutdown deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.shutdown modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.softlayer.sl_vm: redirect: community.general.sl_vm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sl_vm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.slack: redirect: community.general.slack deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.slack modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.slackpkg: redirect: community.general.slackpkg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.slackpkg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. smartos_image_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.smartos_image_info instead. cloud.smartos.smartos_image_info: redirect: community.general.smartos_image_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.smartos_image_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.snap: redirect: community.general.snap deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.snap modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.snap_alias: redirect: community.general.snap_alias deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.snap_alias modules. This has never been supported or documented, and will stop working in community.general 9.0.0. net_tools.snmp_facts: redirect: community.general.snmp_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.snmp_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.solaris_zone: redirect: community.general.solaris_zone deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.solaris_zone modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.sorcery: redirect: community.general.sorcery deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sorcery modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.spectrum_device: redirect: community.general.spectrum_device deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.spectrum_device modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.spectrum_model_attrs: redirect: community.general.spectrum_model_attrs deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.spectrum_model_attrs modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.spotinst.spotinst_aws_elastigroup: redirect: community.general.spotinst_aws_elastigroup deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.spotinst_aws_elastigroup modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.hpe3par.ss_3par_cpg: redirect: community.general.ss_3par_cpg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ss_3par_cpg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.ssh_config: redirect: community.general.ssh_config deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ssh_config modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.stackdriver: redirect: community.general.stackdriver deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.stackdriver modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.stacki.stacki_host: redirect: community.general.stacki_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.stacki_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.statsd: redirect: community.general.statsd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.statsd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.statusio_maintenance: redirect: community.general.statusio_maintenance deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.statusio_maintenance modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.sudoers: redirect: community.general.sudoers deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sudoers modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.supervisorctl: redirect: community.general.supervisorctl deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.supervisorctl modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.svc: redirect: community.general.svc deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.svc modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.svr4pkg: redirect: community.general.svr4pkg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.svr4pkg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.swdepot: redirect: community.general.swdepot deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.swdepot modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.swupd: redirect: community.general.swupd deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.swupd modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.syslogger: redirect: community.general.syslogger deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.syslogger modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.syspatch: redirect: community.general.syspatch deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.syspatch modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.sysrc: redirect: community.general.sysrc deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sysrc modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.sysupgrade: redirect: community.general.sysupgrade deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.sysupgrade modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.taiga_issue: redirect: community.general.taiga_issue deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.taiga_issue modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.telegram: redirect: community.general.telegram deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.telegram modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.terraform: redirect: community.general.terraform deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.terraform modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.timezone: redirect: community.general.timezone deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.timezone modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.twilio: redirect: community.general.twilio deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.twilio modules. This has never been supported or documented, and will stop working in community.general 9.0.0. notification.typetalk: redirect: community.general.typetalk deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.typetalk modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.univention.udm_dns_record: redirect: community.general.udm_dns_record deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.udm_dns_record modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.univention.udm_dns_zone: redirect: community.general.udm_dns_zone deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.udm_dns_zone modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.univention.udm_group: redirect: community.general.udm_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.udm_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.univention.udm_share: redirect: community.general.udm_share deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.udm_share modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.univention.udm_user: redirect: community.general.udm_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.udm_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.ufw: redirect: community.general.ufw deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.ufw modules. This has never been supported or documented, and will stop working in community.general 9.0.0. monitoring.uptimerobot: redirect: community.general.uptimerobot deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.uptimerobot modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.urpmi: redirect: community.general.urpmi deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.urpmi modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_aaa_group: redirect: community.general.utm_aaa_group deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_aaa_group modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_aaa_group_info: redirect: community.general.utm_aaa_group_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_aaa_group_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_ca_host_key_cert: redirect: community.general.utm_ca_host_key_cert deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_ca_host_key_cert modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_ca_host_key_cert_info: redirect: community.general.utm_ca_host_key_cert_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_ca_host_key_cert_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_dns_host: redirect: community.general.utm_dns_host deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_dns_host modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_network_interface_address: redirect: community.general.utm_network_interface_address deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_network_interface_address modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_network_interface_address_info: redirect: community.general.utm_network_interface_address_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_network_interface_address_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_auth_profile: redirect: community.general.utm_proxy_auth_profile deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_auth_profile modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_exception: redirect: community.general.utm_proxy_exception deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_exception modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_frontend: redirect: community.general.utm_proxy_frontend deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_frontend modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_frontend_info: redirect: community.general.utm_proxy_frontend_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_frontend_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_location: redirect: community.general.utm_proxy_location deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_location modules. This has never been supported or documented, and will stop working in community.general 9.0.0. web_infrastructure.sophos_utm.utm_proxy_location_info: redirect: community.general.utm_proxy_location_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.utm_proxy_location_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.vdo: redirect: community.general.vdo deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vdo modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.vertica.vertica_configuration: redirect: community.general.vertica_configuration deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vertica_configuration modules. This has never been supported or documented, and will stop working in community.general 9.0.0. vertica_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.vertica_info instead. database.vertica.vertica_info: redirect: community.general.vertica_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vertica_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.vertica.vertica_role: redirect: community.general.vertica_role deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vertica_role modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.vertica.vertica_schema: redirect: community.general.vertica_schema deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vertica_schema modules. This has never been supported or documented, and will stop working in community.general 9.0.0. database.vertica.vertica_user: redirect: community.general.vertica_user deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vertica_user modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.vexata.vexata_eg: redirect: community.general.vexata_eg deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vexata_eg modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.vexata.vexata_volume: redirect: community.general.vexata_volume deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vexata_volume modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.smartos.vmadm: redirect: community.general.vmadm deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.vmadm modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.wakeonlan: redirect: community.general.wakeonlan deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.wakeonlan modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.wdc_redfish_command: redirect: community.general.wdc_redfish_command deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.wdc_redfish_command modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.redfish.wdc_redfish_info: redirect: community.general.wdc_redfish_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.wdc_redfish_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. webfaction_app: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. cloud.webfaction.webfaction_app: redirect: community.general.webfaction_app deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.webfaction_app modules. This has never been supported or documented, and will stop working in community.general 9.0.0. webfaction_db: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. cloud.webfaction.webfaction_db: redirect: community.general.webfaction_db deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.webfaction_db modules. This has never been supported or documented, and will stop working in community.general 9.0.0. webfaction_domain: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. cloud.webfaction.webfaction_domain: redirect: community.general.webfaction_domain deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.webfaction_domain modules. This has never been supported or documented, and will stop working in community.general 9.0.0. webfaction_mailbox: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. cloud.webfaction.webfaction_mailbox: redirect: community.general.webfaction_mailbox deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.webfaction_mailbox modules. This has never been supported or documented, and will stop working in community.general 9.0.0. webfaction_site: deprecation: removal_version: 9.0.0 warning_text: This module relies on HTTPS APIs that do not exist anymore and there is no clear path to update. cloud.webfaction.webfaction_site: redirect: community.general.webfaction_site deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.webfaction_site modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.xattr: redirect: community.general.xattr deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xattr modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.xbps: redirect: community.general.xbps deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xbps modules. This has never been supported or documented, and will stop working in community.general 9.0.0. remote_management.lenovoxcc.xcc_redfish_command: redirect: community.general.xcc_redfish_command deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xcc_redfish_command modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.misc.xenserver_facts: redirect: community.general.xenserver_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xenserver_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.xenserver.xenserver_guest: redirect: community.general.xenserver_guest deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xenserver_guest modules. This has never been supported or documented, and will stop working in community.general 9.0.0. xenserver_guest_facts: tombstone: removal_version: 3.0.0 warning_text: Use community.general.xenserver_guest_info instead. cloud.xenserver.xenserver_guest_info: redirect: community.general.xenserver_guest_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xenserver_guest_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. cloud.xenserver.xenserver_guest_powerstate: redirect: community.general.xenserver_guest_powerstate deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xenserver_guest_powerstate modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.xfconf: redirect: community.general.xfconf deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xfconf modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.xfconf_info: redirect: community.general.xfconf_info deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xfconf_info modules. This has never been supported or documented, and will stop working in community.general 9.0.0. system.xfs_quota: redirect: community.general.xfs_quota deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xfs_quota modules. This has never been supported or documented, and will stop working in community.general 9.0.0. files.xml: redirect: community.general.xml deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.xml modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.language.yarn: redirect: community.general.yarn deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.yarn modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.yum_versionlock: redirect: community.general.yum_versionlock deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.yum_versionlock modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.zfs.zfs: redirect: community.general.zfs deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zfs modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.zfs.zfs_delegate_admin: redirect: community.general.zfs_delegate_admin deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zfs_delegate_admin modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.zfs.zfs_facts: redirect: community.general.zfs_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zfs_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. clustering.znode: redirect: community.general.znode deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.znode modules. This has never been supported or documented, and will stop working in community.general 9.0.0. storage.zfs.zpool_facts: redirect: community.general.zpool_facts deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zpool_facts modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.zypper: redirect: community.general.zypper deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zypper modules. This has never been supported or documented, and will stop working in community.general 9.0.0. packaging.os.zypper_repository: redirect: community.general.zypper_repository deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.zypper_repository modules. This has never been supported or documented, and will stop working in community.general 9.0.0. doc_fragments: rackspace: deprecation: removal_version: 9.0.0 warning_text: This doc fragment is used by rax modules, that rely on the deprecated package pyrax. _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 nios: redirect: infoblox.nios_modules.nios postgresql: redirect: community.postgresql.postgresql module_utils: rax: deprecation: removal_version: 9.0.0 warning_text: This module util relies on the deprecated package pyrax. 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 net_tools.nios.api: redirect: infoblox.nios_modules.api postgresql: redirect: community.postgresql.postgresql remote_management.dellemc.dellemc_idrac: redirect: dellemc.openmanage.dellemc_idrac remote_management.dellemc.ome: redirect: dellemc.openmanage.ome 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. osx_say: redirect: community.general.say 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. This was mostly # relevant before community.general 5.0.0, when community.general also # supported Ansible 2.9. Back then, the included path_join filter was used # for Ansible 2.9 or earlier. Now we only will have the redirect until we # eventually will deprecate and then remove it. redirect: ansible.builtin.path_join action: system.iptables_state: redirect: community.general.iptables_state deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.iptables_state action. This has never been supported or documented, and will stop working in community.general 9.0.0. system.shutdown: redirect: community.general.shutdown deprecation: removal_version: 9.0.0 warning_text: You are using an internal name to access the community.general.shutdown action. This has never been supported or documented, and will stop working in community.general 9.0.0. PK $�!\ m��L L ? collections/ansible_collections/community/general/MANIFEST.jsonnu �[��� { "collection_info": { "namespace": "community", "name": "general", "version": "7.5.0", "authors": [ "Ansible (https://github.com/ansible)" ], "readme": "README.md", "tags": [ "community" ], "description": null, "license": [], "license_file": "COPYING", "dependencies": {}, "repository": "https://github.com/ansible-collections/community.general", "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" }, "file_manifest_file": { "name": "FILES.json", "ftype": "file", "chksum_type": "sha256", "chksum_sha256": "8501111832552fa388afde8422cc48690904d20038e04c2b115de245588e03ca", "format": 1 }, "format": 1 }PK $�!\���| [ collections/ansible_collections/community/general/plugins/modules/honeybadger_deployment.pynu �[��� # -*- coding: utf-8 -*- # Copyright 2014 Benjamin Curtis <benjamin.curtis@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: honeybadger_deployment author: "Benjamin Curtis (@stympy)" short_description: Notify Honeybadger.io about app deployments description: - Notify Honeybadger.io about app deployments (see U(http://docs.honeybadger.io/article/188-deployment-tracking)). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: token: type: str description: - API token. required: true environment: type: str description: - The environment name, typically 'production', 'staging', etc. required: true user: type: str description: - The username of the person doing the deployment repo: type: str description: - URL of the project repository revision: type: str description: - A hash, number, tag, or other identifier showing what revision was deployed url: type: str description: - Optional URL to submit the notification to. default: "https://api.honeybadger.io/v1/deploys" validate_certs: description: - If V(false), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true ''' EXAMPLES = ''' - name: Notify Honeybadger.io about an app deployment community.general.honeybadger_deployment: token: AAAAAA environment: staging user: ansible revision: b6826b8 repo: 'git@github.com:user/repo.git' ''' RETURN = '''# ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.urls import fetch_url # =========================================== # Module execution. # def main(): module = AnsibleModule( argument_spec=dict( token=dict(required=True, no_log=True), environment=dict(required=True), user=dict(required=False), repo=dict(required=False), revision=dict(required=False), url=dict(required=False, default='https://api.honeybadger.io/v1/deploys'), validate_certs=dict(default=True, type='bool'), ), supports_check_mode=True ) params = {} if module.params["environment"]: params["deploy[environment]"] = module.params["environment"] if module.params["user"]: params["deploy[local_username]"] = module.params["user"] if module.params["repo"]: params["deploy[repository]"] = module.params["repo"] if module.params["revision"]: params["deploy[revision]"] = module.params["revision"] params["api_key"] = module.params["token"] url = module.params.get('url') # If we're in check mode, just exit pretending like we succeeded if module.check_mode: module.exit_json(changed=True) try: data = urlencode(params) response, info = fetch_url(module, url, data=data) except Exception as e: module.fail_json(msg='Unable to notify Honeybadger: %s' % to_native(e), exception=traceback.format_exc()) else: if info['status'] == 201: module.exit_json(changed=True) else: module.fail_json(msg="HTTP result code: %d connecting to %s" % (info['status'], url)) if __name__ == '__main__': main() PK $�!\�qI�: : X collections/ansible_collections/community/general/plugins/modules/utm_proxy_exception.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Sebastian Schenzel <sebastian.schenzel@mailbox.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: utm_proxy_exception author: - Sebastian Schenzel (@RickS-C137) short_description: Create, update or destroy reverse_proxy exception entry in Sophos UTM description: - Create, update or destroy a reverse_proxy exception entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. attributes: check_mode: support: none diff_mode: support: none options: name: description: - The name of the object. Will be used to identify the entry required: true type: str op: description: - The operand to be used with the entries of the path parameter default: 'AND' choices: - 'AND' - 'OR' required: false type: str path: description: - The paths the exception in the reverse proxy is defined for type: list elements: str default: [] required: false skip_custom_threats_filters: description: - A list of threats to be skipped type: list elements: str default: [] required: false skip_threats_filter_categories: description: - Define which categories of threats are skipped type: list elements: str default: [] required: false skipav: description: - Skip the Antivirus Scanning default: false type: bool required: false skipbadclients: description: - Block clients with bad reputation default: false type: bool required: false skipcookie: description: - Skip the Cookie Signing check default: false type: bool required: false skipform: description: - Enable form hardening default: false type: bool required: false skipform_missingtoken: description: - Enable form hardening with missing tokens default: false type: bool required: false skiphtmlrewrite: description: - Protection against SQL default: false type: bool required: false skiptft: description: - Enable true file type control default: false type: bool required: false skipurl: description: - Enable static URL hardening default: false type: bool required: false source: description: - Define which categories of threats are skipped type: list elements: str default: [] required: false status: description: - Status of the exception rule set default: true type: bool required: false extends_documentation_fragment: - community.general.utm - community.general.attributes ''' EXAMPLES = """ - name: Create UTM proxy_exception community.general.utm_proxy_exception: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestExceptionEntry backend: REF_OBJECT_STRING state: present - name: Remove UTM proxy_exception community.general.utm_proxy_exception: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestExceptionEntry state: absent """ RETURN = """ result: description: The utm object that was created returned: success type: complex contains: _ref: description: The reference name of the object type: str _locked: description: Whether or not the object is currently locked type: bool _type: description: The type of the object type: str name: description: The name of the object type: str comment: description: The optional comment string type: str op: description: The operand to be used with the entries of the path parameter type: str path: description: The paths the exception in the reverse proxy is defined for type: list skip_custom_threats_filters: description: A list of threats to be skipped type: list skip_threats_filter_categories: description: Define which categories of threats are skipped type: list skipav: description: Skip the Antivirus Scanning type: bool skipbadclients: description: Block clients with bad reputation type: bool skipcookie: description: Skip the Cookie Signing check type: bool skipform: description: Enable form hardening type: bool skipform_missingtoken: description: Enable form hardening with missing tokens type: bool skiphtmlrewrite: description: Protection against SQL type: bool skiptft: description: Enable true file type control type: bool skipurl: description: Enable static URL hardening type: bool source: description: Define which categories of threats are skipped type: list """ from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule from ansible.module_utils.common.text.converters import to_native def main(): endpoint = "reverse_proxy/exception" key_to_check_for_changes = ["op", "path", "skip_custom_threats_filters", "skip_threats_filter_categories", "skipav", "comment", "skipbadclients", "skipcookie", "skipform", "status", "skipform_missingtoken", "skiphtmlrewrite", "skiptft", "skipurl", "source"] module = UTMModule( argument_spec=dict( name=dict(type='str', required=True), op=dict(type='str', required=False, default='AND', choices=['AND', 'OR']), path=dict(type='list', elements='str', required=False, default=[]), skip_custom_threats_filters=dict(type='list', elements='str', required=False, default=[]), skip_threats_filter_categories=dict(type='list', elements='str', required=False, default=[]), skipav=dict(type='bool', required=False, default=False), skipbadclients=dict(type='bool', required=False, default=False), skipcookie=dict(type='bool', required=False, default=False), skipform=dict(type='bool', required=False, default=False), skipform_missingtoken=dict(type='bool', required=False, default=False), skiphtmlrewrite=dict(type='bool', required=False, default=False), skiptft=dict(type='bool', required=False, default=False), skipurl=dict(type='bool', required=False, default=False), source=dict(type='list', elements='str', required=False, default=[]), status=dict(type='bool', required=False, default=True), ) ) try: UTM(module, endpoint, key_to_check_for_changes).execute() except Exception as e: module.fail_json(msg=to_native(e)) if __name__ == '__main__': main() PK $�!\�h�a P collections/ansible_collections/community/general/plugins/modules/pritunl_org.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Florian Dambrine <android.florian@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: pritunl_org author: Florian Dambrine (@Lowess) version_added: 2.5.0 short_description: Manages Pritunl Organizations using the Pritunl API description: - A module to manage Pritunl organizations using the Pritunl API. extends_documentation_fragment: - community.general.pritunl - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: type: str required: true aliases: - org description: - The name of the organization to manage in Pritunl. force: type: bool default: false description: - If O(force) is V(true) and O(state) is V(absent), the module will delete the organization, no matter if it contains users or not. By default O(force) is V(false), which will cause the module to fail the deletion of the organization when it contains users. state: type: str default: 'present' choices: - present - absent description: - If V(present), the module adds organization O(name) to Pritunl. If V(absent), attempt to delete the organization from Pritunl (please read about O(force) usage). """ EXAMPLES = """ - name: Ensure the organization named MyOrg exists community.general.pritunl_org: state: present name: MyOrg - name: Ensure the organization named MyOrg does not exist community.general.pritunl_org: state: absent name: MyOrg """ RETURN = """ response: description: JSON representation of a Pritunl Organization. returned: success type: dict sample: { "auth_api": false, "name": "Foo", "auth_token": null, "user_count": 0, "auth_secret": null, "id": "csftwlu6uhralzi2dpmhekz3", } """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.dict_transformations import dict_merge from ansible_collections.community.general.plugins.module_utils.net_tools.pritunl.api import ( PritunlException, delete_pritunl_organization, post_pritunl_organization, list_pritunl_organizations, get_pritunl_settings, pritunl_argument_spec, ) def add_pritunl_organization(module): result = {} org_name = module.params.get("name") org_obj_list = list_pritunl_organizations( **dict_merge( get_pritunl_settings(module), {"filters": {"name": org_name}}, ) ) # If the organization already exists if len(org_obj_list) > 0: result["changed"] = False result["response"] = org_obj_list[0] else: # Otherwise create it response = post_pritunl_organization( **dict_merge( get_pritunl_settings(module), {"organization_name": org_name}, ) ) result["changed"] = True result["response"] = response module.exit_json(**result) def remove_pritunl_organization(module): result = {} org_name = module.params.get("name") force = module.params.get("force") org_obj_list = [] org_obj_list = list_pritunl_organizations( **dict_merge( get_pritunl_settings(module), { "filters": {"name": org_name}, }, ) ) # No organization found if len(org_obj_list) == 0: result["changed"] = False result["response"] = {} else: # Otherwise attempt to delete it org = org_obj_list[0] # Only accept deletion under specific conditions if force or org["user_count"] == 0: response = delete_pritunl_organization( **dict_merge( get_pritunl_settings(module), {"organization_id": org["id"]}, ) ) result["changed"] = True result["response"] = response else: module.fail_json( msg=( "Can not remove organization '%s' with %d attached users. " "Either set 'force' option to true or remove active users " "from the organization" ) % (org_name, org["user_count"]) ) module.exit_json(**result) def main(): argument_spec = pritunl_argument_spec() argument_spec.update( dict( name=dict(required=True, type="str", aliases=["org"]), force=dict(required=False, type="bool", default=False), state=dict( required=False, choices=["present", "absent"], default="present" ), ) ) module = AnsibleModule(argument_spec=argument_spec) state = module.params.get("state") try: if state == "present": add_pritunl_organization(module) elif state == "absent": remove_pritunl_organization(module) except PritunlException as e: module.fail_json(msg=to_native(e)) if __name__ == "__main__": main() PK $�!\A8L�� � V collections/ansible_collections/community/general/plugins/modules/memset_dns_reload.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Simon Weald <ansible@simonweald.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: memset_dns_reload author: "Simon Weald (@glitchcrab)" short_description: Request reload of Memset's DNS infrastructure, notes: - DNS reload requests are a best-effort service provided by Memset; these generally happen every 15 minutes by default, however you can request an immediate reload if later tasks rely on the records being created. An API key generated via the Memset customer control panel is required with the following minimum scope - C(dns.reload). If you wish to poll the job status to wait until the reload has completed, then C(job.status) is also required. description: - Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: api_key: required: true type: str description: - The API key obtained from the Memset control panel. poll: default: false type: bool description: - Boolean value, if set will poll the reload job's status and return when the job has completed (unless the 30 second timeout is reached first). If the timeout is reached then the task will not be marked as failed, but stderr will indicate that the polling failed. ''' EXAMPLES = ''' - name: Submit DNS reload and poll community.general.memset_dns_reload: api_key: 5eb86c9196ab03919abcf03857163741 poll: true delegate_to: localhost ''' RETURN = ''' --- memset_api: description: Raw response from the Memset API. returned: always type: complex contains: error: description: Whether the job ended in error state. returned: always type: bool sample: true finished: description: Whether the job completed before the result was returned. returned: always type: bool sample: true id: description: Job ID. returned: always type: str sample: "c9cc8ad2a3e3fb8c63ed83c424928ef8" status: description: Job status. returned: always type: str sample: "DONE" type: description: Job type. returned: always type: str sample: "dns" ''' from time import sleep from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.memset import memset_api_call def poll_reload_status(api_key=None, job_id=None, payload=None): ''' We poll the `job.status` endpoint every 5 seconds up to a maximum of 6 times. This is a relatively arbitrary choice of timeout, however requests rarely take longer than 15 seconds to complete. ''' memset_api, stderr, msg = None, None, None payload['id'] = job_id api_method = 'job.status' _has_failed, _msg, response = memset_api_call(api_key=api_key, api_method=api_method, payload=payload) while not response.json()['finished']: counter = 0 while counter < 6: sleep(5) _has_failed, msg, response = memset_api_call(api_key=api_key, api_method=api_method, payload=payload) counter += 1 if response.json()['error']: # the reload job was submitted but polling failed. Don't return this as an overall task failure. stderr = "Reload submitted successfully, but the Memset API returned a job error when attempting to poll the reload status." else: memset_api = response.json() msg = None return memset_api, msg, stderr def reload_dns(args=None): ''' DNS reloads are a single API call and therefore there's not much which can go wrong outside of auth errors. ''' retvals, payload = dict(), dict() has_changed, has_failed = False, False memset_api, msg, stderr = None, None, None api_method = 'dns.reload' has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) if has_failed: # this is the first time the API is called; incorrect credentials will # manifest themselves at this point so we need to ensure the user is # informed of the reason. retvals['failed'] = has_failed if response.status_code is not None: retvals['memset_api'] = response.json() else: retvals['stderr'] = response.stderr retvals['msg'] = msg return retvals # set changed to true if the reload request was accepted. has_changed = True memset_api = msg # empty msg var as we don't want to return the API's json response twice. msg = None if args['poll']: # hand off to the poll function. job_id = response.json()['id'] memset_api, msg, stderr = poll_reload_status(api_key=args['api_key'], job_id=job_id, payload=payload) # assemble return variables. retvals['failed'] = has_failed retvals['changed'] = has_changed for val in ['msg', 'stderr', 'memset_api']: if val is not None: retvals[val] = eval(val) return retvals def main(): global module module = AnsibleModule( argument_spec=dict( api_key=dict(required=True, type='str', no_log=True), poll=dict(required=False, default=False, type='bool') ), supports_check_mode=False ) # populate the dict with the user-provided vars. args = dict() for key, arg in module.params.items(): args[key] = arg retvals = reload_dns(args) if retvals['failed']: module.fail_json(**retvals) else: module.exit_json(**retvals) if __name__ == '__main__': main() PK $�!\� �) �) P collections/ansible_collections/community/general/plugins/modules/scaleway_lb.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway Load-balancer management module # # Copyright (C) 2018 Online SAS. # https://www.scaleway.com # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_lb short_description: Scaleway load-balancer management module author: Remy Leone (@remyleone) description: - "This module manages load-balancers on Scaleway." extends_documentation_fragment: - community.general.scaleway - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - Name of the load-balancer. required: true description: type: str description: - Description of the load-balancer. required: true organization_id: type: str description: - Organization identifier. required: true state: type: str description: - Indicate desired state of the instance. default: present choices: - present - absent region: type: str description: - Scaleway zone. required: true choices: - nl-ams - fr-par - pl-waw tags: type: list elements: str default: [] description: - List of tags to apply to the load-balancer. wait: description: - Wait for the load-balancer to reach its desired state before returning. type: bool default: false wait_timeout: type: int description: - Time to wait for the load-balancer to reach the expected state. required: false default: 300 wait_sleep_time: type: int description: - Time to wait before every attempt to check the state of the load-balancer. required: false default: 3 ''' EXAMPLES = ''' - name: Create a load-balancer community.general.scaleway_lb: name: foobar state: present organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42 region: fr-par tags: - hello - name: Delete a load-balancer community.general.scaleway_lb: name: foobar state: absent organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42 region: fr-par ''' RETURNS = ''' { "scaleway_lb": { "backend_count": 0, "frontend_count": 0, "description": "Description of my load-balancer", "id": "00000000-0000-0000-0000-000000000000", "instances": [ { "id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.1", "region": "fr-par", "status": "ready" }, { "id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.2", "region": "fr-par", "status": "ready" } ], "ip": [ { "id": "00000000-0000-0000-0000-000000000000", "ip_address": "192.168.0.1", "lb_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "organization_id": "00000000-0000-0000-0000-000000000000", "reverse": "" } ], "name": "lb_ansible_test", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "status": "ready", "tags": [ "first_tag", "second_tag" ] } } ''' import datetime import time from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_REGIONS, SCALEWAY_ENDPOINT, scaleway_argument_spec, Scaleway STABLE_STATES = ( "ready", "absent" ) MUTABLE_ATTRIBUTES = ( "name", "description" ) def payload_from_wished_lb(wished_lb): return { "organization_id": wished_lb["organization_id"], "name": wished_lb["name"], "tags": wished_lb["tags"], "description": wished_lb["description"] } def fetch_state(api, lb): api.module.debug("fetch_state of load-balancer: %s" % lb["id"]) response = api.get(path=api.api_path + "/%s" % lb["id"]) if response.status_code == 404: return "absent" if not response.ok: msg = 'Error during state fetching: (%s) %s' % (response.status_code, response.json) api.module.fail_json(msg=msg) try: api.module.debug("Load-balancer %s in state: %s" % (lb["id"], response.json["status"])) return response.json["status"] except KeyError: api.module.fail_json(msg="Could not fetch state in %s" % response.json) def wait_to_complete_state_transition(api, lb, force_wait=False): wait = api.module.params["wait"] if not (wait or force_wait): return wait_timeout = api.module.params["wait_timeout"] wait_sleep_time = api.module.params["wait_sleep_time"] start = datetime.datetime.utcnow() end = start + datetime.timedelta(seconds=wait_timeout) while datetime.datetime.utcnow() < end: api.module.debug("We are going to wait for the load-balancer to finish its transition") state = fetch_state(api, lb) if state in STABLE_STATES: api.module.debug("It seems that the load-balancer is not in transition anymore.") api.module.debug("load-balancer in state: %s" % fetch_state(api, lb)) break time.sleep(wait_sleep_time) else: api.module.fail_json(msg="Server takes too long to finish its transition") def lb_attributes_should_be_changed(target_lb, wished_lb): diff = dict((attr, wished_lb[attr]) for attr in MUTABLE_ATTRIBUTES if target_lb[attr] != wished_lb[attr]) if diff: return dict((attr, wished_lb[attr]) for attr in MUTABLE_ATTRIBUTES) else: return diff def present_strategy(api, wished_lb): changed = False response = api.get(path=api.api_path) if not response.ok: api.module.fail_json(msg='Error getting load-balancers [{0}: {1}]'.format( response.status_code, response.json['message'])) lbs_list = response.json["lbs"] lb_lookup = dict((lb["name"], lb) for lb in lbs_list) if wished_lb["name"] not in lb_lookup.keys(): changed = True if api.module.check_mode: return changed, {"status": "A load-balancer would be created."} # Create Load-balancer api.warn(payload_from_wished_lb(wished_lb)) creation_response = api.post(path=api.api_path, data=payload_from_wished_lb(wished_lb)) if not creation_response.ok: msg = "Error during lb creation: %s: '%s' (%s)" % (creation_response.info['msg'], creation_response.json['message'], creation_response.json) api.module.fail_json(msg=msg) wait_to_complete_state_transition(api=api, lb=creation_response.json) response = api.get(path=api.api_path + "/%s" % creation_response.json["id"]) return changed, response.json target_lb = lb_lookup[wished_lb["name"]] patch_payload = lb_attributes_should_be_changed(target_lb=target_lb, wished_lb=wished_lb) if not patch_payload: return changed, target_lb changed = True if api.module.check_mode: return changed, {"status": "Load-balancer attributes would be changed."} lb_patch_response = api.put(path=api.api_path + "/%s" % target_lb["id"], data=patch_payload) if not lb_patch_response.ok: api.module.fail_json(msg='Error during load-balancer attributes update: [{0}: {1}]'.format( lb_patch_response.status_code, lb_patch_response.json['message'])) wait_to_complete_state_transition(api=api, lb=target_lb) return changed, lb_patch_response.json def absent_strategy(api, wished_lb): response = api.get(path=api.api_path) changed = False status_code = response.status_code lbs_json = response.json lbs_list = lbs_json["lbs"] if not response.ok: api.module.fail_json(msg='Error getting load-balancers [{0}: {1}]'.format( status_code, response.json['message'])) lb_lookup = dict((lb["name"], lb) for lb in lbs_list) if wished_lb["name"] not in lb_lookup.keys(): return changed, {} target_lb = lb_lookup[wished_lb["name"]] changed = True if api.module.check_mode: return changed, {"status": "Load-balancer would be destroyed"} wait_to_complete_state_transition(api=api, lb=target_lb, force_wait=True) response = api.delete(path=api.api_path + "/%s" % target_lb["id"]) if not response.ok: api.module.fail_json(msg='Error deleting load-balancer [{0}: {1}]'.format( response.status_code, response.json)) wait_to_complete_state_transition(api=api, lb=target_lb) return changed, response.json state_strategy = { "present": present_strategy, "absent": absent_strategy } def core(module): region = module.params["region"] wished_load_balancer = { "state": module.params["state"], "name": module.params["name"], "description": module.params["description"], "tags": module.params["tags"], "organization_id": module.params["organization_id"] } module.params['api_url'] = SCALEWAY_ENDPOINT api = Scaleway(module=module) api.api_path = "lb/v1/regions/%s/lbs" % region changed, summary = state_strategy[wished_load_balancer["state"]](api=api, wished_lb=wished_load_balancer) module.exit_json(changed=changed, scaleway_lb=summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( name=dict(required=True), description=dict(required=True), region=dict(required=True, choices=SCALEWAY_REGIONS), state=dict(choices=list(state_strategy.keys()), default='present'), tags=dict(type="list", elements="str", default=[]), organization_id=dict(required=True), wait=dict(type="bool", default=False), wait_timeout=dict(type="int", default=300), wait_sleep_time=dict(type="int", default=3), )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\ at~� ~� K collections/ansible_collections/community/general/plugins/modules/pacman.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2012, Afterburn <https://github.com/afterburn> # Copyright (c) 2013, Aaron Bull Schaefer <aaron@elasticdog.com> # Copyright (c) 2015, Indrajit Raychaudhuri <irc+code@indrajit.com> # Copyright (c) 2022, Jean Raby <jean@raby.sh> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: pacman short_description: Manage packages with I(pacman) description: - Manage packages with the I(pacman) package manager, which is used by Arch Linux and its variants. author: - Indrajit Raychaudhuri (@indrajitr) - Aaron Bull Schaefer (@elasticdog) <aaron@elasticdog.com> - Maxime de Roucy (@tchernomax) - Jean Raby (@jraby) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: name: description: - Name or list of names of the package(s) or file(s) to install, upgrade, or remove. Cannot be used in combination with O(upgrade). aliases: [ package, pkg ] type: list elements: str state: description: - Whether to install (V(present) or V(installed), V(latest)), or remove (V(absent) or V(removed)) a package. - V(present) and V(installed) will simply ensure that a desired package is installed. - V(latest) will update the specified package if it is not of the latest available version. - V(absent) and V(removed) will remove the specified package. default: present choices: [ absent, installed, latest, present, removed ] type: str force: description: - When removing packages, forcefully remove them, without any checks. Same as O(extra_args="--nodeps --nodeps"). - When combined with O(update_cache), force a refresh of all package databases. Same as O(update_cache_extra_args="--refresh --refresh"). default: false type: bool remove_nosave: description: - When removing packages, do not save modified configuration files as C(.pacsave) files. (passes C(--nosave) to pacman) version_added: 4.6.0 default: false type: bool executable: description: - Path of the binary to use. This can either be C(pacman) or a pacman compatible AUR helper. - Pacman compatibility is unfortunately ill defined, in particular, this modules makes extensive use of the C(--print-format) directive which is known not to be implemented by some AUR helpers (notably, C(yay)). - Beware that AUR helpers might behave unexpectedly and are therefore not recommended. default: pacman type: str version_added: 3.1.0 extra_args: description: - Additional option to pass to pacman when enforcing O(state). default: '' type: str update_cache: description: - Whether or not to refresh the master package lists. - This can be run as part of a package installation or as a separate step. - If not specified, it defaults to V(false). - Please note that this option only had an influence on the module's C(changed) state if O(name) and O(upgrade) are not specified before community.general 5.0.0. See the examples for how to keep the old behavior. type: bool update_cache_extra_args: description: - Additional option to pass to pacman when enforcing O(update_cache). default: '' type: str upgrade: description: - Whether or not to upgrade the whole system. Cannot be used in combination with O(name). - If not specified, it defaults to V(false). type: bool upgrade_extra_args: description: - Additional option to pass to pacman when enforcing O(upgrade). default: '' type: str reason: description: - The install reason to set for the packages. choices: [ dependency, explicit ] type: str version_added: 5.4.0 reason_for: description: - Set the install reason for V(all) packages or only for V(new) packages. - In case of O(state=latest) already installed packages which will be updated to a newer version are not counted as V(new). default: new choices: [ all, new ] type: str version_added: 5.4.0 notes: - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name) option. - To use an AUR helper (O(executable) option), a few extra setup steps might be required beforehand. For example, a dedicated build user with permissions to install packages could be necessary. - > In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error: C(error: target not found: <pkg>). """ RETURN = """ packages: description: - A list of packages that have been changed. - Before community.general 4.5.0 this was only returned when O(upgrade=true). In community.general 4.5.0, it was sometimes omitted when the package list is empty, but since community.general 4.6.0 it is always returned when O(name) is specified or O(upgrade=true). returned: success and O(name) is specified or O(upgrade=true) type: list elements: str sample: [ package, other-package ] cache_updated: description: - The changed status of C(pacman -Sy). - Useful when O(name) or O(upgrade=true) are specified next to O(update_cache=true). returned: success, when O(update_cache=true) type: bool sample: false version_added: 4.6.0 stdout: description: - Output from pacman. returned: success, when needed type: str sample: ":: Synchronizing package databases... core is up to date :: Starting full system upgrade..." version_added: 4.1.0 stderr: description: - Error output from pacman. returned: success, when needed type: str sample: "warning: libtool: local (2.4.6+44+gb9b44533-14) is newer than core (2.4.6+42+gb88cebd5-15)\nwarning ..." version_added: 4.1.0 """ EXAMPLES = """ - name: Install package foo from repo community.general.pacman: name: foo state: present - name: Install package bar from file community.general.pacman: name: ~/bar-1.0-1-any.pkg.tar.xz state: present - name: Install package foo from repo and bar from file community.general.pacman: name: - foo - ~/bar-1.0-1-any.pkg.tar.xz state: present - name: Install package from AUR using a Pacman compatible AUR helper community.general.pacman: name: foo state: present executable: yay extra_args: --builddir /var/cache/yay - name: Upgrade package foo # The 'changed' state of this call will indicate whether the cache was # updated *or* whether foo was installed/upgraded. community.general.pacman: name: foo state: latest update_cache: true - name: Remove packages foo and bar community.general.pacman: name: - foo - bar state: absent - name: Recursively remove package baz community.general.pacman: name: baz state: absent extra_args: --recursive - name: Run the equivalent of "pacman -Sy" as a separate step community.general.pacman: update_cache: true - name: Run the equivalent of "pacman -Su" as a separate step community.general.pacman: upgrade: true - name: Run the equivalent of "pacman -Syu" as a separate step # Since community.general 5.0.0 the 'changed' state of this call # will be 'true' in case the cache was updated, or when a package # was updated. # # The previous behavior was to only indicate whether something was # upgraded. To keep the old behavior, add the following to the task: # # register: result # changed_when: result.packages | length > 0 community.general.pacman: update_cache: true upgrade: true - name: Run the equivalent of "pacman -Rdd", force remove package baz community.general.pacman: name: baz state: absent force: true - name: Install foo as dependency and leave reason untouched if already installed community.general.pacman: name: foo state: present reason: dependency reason_for: new - name: Run the equivalent of "pacman -S --asexplicit", mark foo as explicit and install it if not present community.general.pacman: name: foo state: present reason: explicit reason_for: all """ import re import shlex from ansible.module_utils.basic import AnsibleModule from collections import defaultdict, namedtuple class Package(object): def __init__(self, name, source, source_is_URL=False): self.name = name self.source = source self.source_is_URL = source_is_URL def __eq__(self, o): return self.name == o.name and self.source == o.source and self.source_is_URL == o.source_is_URL def __lt__(self, o): return self.name < o.name def __repr__(self): return 'Package("%s", "%s", %s)' % (self.name, self.source, self.source_is_URL) VersionTuple = namedtuple("VersionTuple", ["current", "latest"]) class Pacman(object): def __init__(self, module): self.m = module self.m.run_command_environ_update = dict(LC_ALL="C") p = self.m.params self._msgs = [] self._stdouts = [] self._stderrs = [] self.changed = False self.exit_params = {} self.pacman_path = self.m.get_bin_path(p["executable"], True) self._cached_database = None # Normalize for old configs if p["state"] == "installed": self.target_state = "present" elif p["state"] == "removed": self.target_state = "absent" else: self.target_state = p["state"] def add_exit_infos(self, msg=None, stdout=None, stderr=None): if msg: self._msgs.append(msg) if stdout: self._stdouts.append(stdout) if stderr: self._stderrs.append(stderr) def _set_mandatory_exit_params(self): msg = "\n".join(self._msgs) stdouts = "\n".join(self._stdouts) stderrs = "\n".join(self._stderrs) if stdouts: self.exit_params["stdout"] = stdouts if stderrs: self.exit_params["stderr"] = stderrs self.exit_params["msg"] = msg # mandatory, but might be empty def fail(self, msg=None, stdout=None, stderr=None, **kwargs): self.add_exit_infos(msg, stdout, stderr) self._set_mandatory_exit_params() if kwargs: self.exit_params.update(**kwargs) self.m.fail_json(**self.exit_params) def success(self): self._set_mandatory_exit_params() self.m.exit_json(changed=self.changed, **self.exit_params) def run(self): if self.m.params["update_cache"]: self.update_package_db() if not (self.m.params["name"] or self.m.params["upgrade"]): self.success() self.inventory = self._build_inventory() if self.m.params["upgrade"]: self.upgrade() self.success() if self.m.params["name"]: pkgs = self.package_list() if self.target_state == "absent": self.remove_packages(pkgs) self.success() else: self.install_packages(pkgs) self.success() # This shouldn't happen... self.fail("This is a bug") def install_packages(self, pkgs): pkgs_to_install = [] pkgs_to_install_from_url = [] pkgs_to_set_reason = [] for p in pkgs: if self.m.params["reason"] and ( p.name not in self.inventory["pkg_reasons"] or self.m.params["reason_for"] == "all" and self.inventory["pkg_reasons"][p.name] != self.m.params["reason"] ): pkgs_to_set_reason.append(p.name) if p.source_is_URL: # URL packages bypass the latest / upgradable_pkgs test # They go through the dry-run to let pacman decide if they will be installed pkgs_to_install_from_url.append(p) continue if ( p.name not in self.inventory["installed_pkgs"] or self.target_state == "latest" and p.name in self.inventory["upgradable_pkgs"] ): pkgs_to_install.append(p) if len(pkgs_to_install) == 0 and len(pkgs_to_install_from_url) == 0 and len(pkgs_to_set_reason) == 0: self.exit_params["packages"] = [] self.add_exit_infos("package(s) already installed") return cmd_base = [ self.pacman_path, "--noconfirm", "--noprogressbar", "--needed", ] if self.m.params["extra_args"]: cmd_base.extend(self.m.params["extra_args"]) def _build_install_diff(pacman_verb, pkglist): # Dry run to build the installation diff cmd = cmd_base + [pacman_verb, "--print-format", "%n %v"] + [p.source for p in pkglist] rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: self.fail("Failed to list package(s) to install", cmd=cmd, stdout=stdout, stderr=stderr) name_ver = [l.strip() for l in stdout.splitlines()] before = [] after = [] to_be_installed = [] for p in name_ver: # With Pacman v6.0.1 - libalpm v13.0.1, --upgrade outputs "loading packages..." on stdout. strip that. # When installing from URLs, pacman can also output a 'nothing to do' message. strip that too. if "loading packages" in p or "there is nothing to do" in p or 'Avoid running' in p: continue name, version = p.split() if name in self.inventory["installed_pkgs"]: before.append("%s-%s-%s" % (name, self.inventory["installed_pkgs"][name], self.inventory["pkg_reasons"][name])) if name in pkgs_to_set_reason: after.append("%s-%s-%s" % (name, version, self.m.params["reason"])) elif name in self.inventory["pkg_reasons"]: after.append("%s-%s-%s" % (name, version, self.inventory["pkg_reasons"][name])) else: after.append("%s-%s" % (name, version)) to_be_installed.append(name) return (to_be_installed, before, after) before = [] after = [] installed_pkgs = [] if pkgs_to_install: p, b, a = _build_install_diff("--sync", pkgs_to_install) installed_pkgs.extend(p) before.extend(b) after.extend(a) if pkgs_to_install_from_url: p, b, a = _build_install_diff("--upgrade", pkgs_to_install_from_url) installed_pkgs.extend(p) before.extend(b) after.extend(a) if len(installed_pkgs) == 0 and len(pkgs_to_set_reason) == 0: # This can happen with URL packages if pacman decides there's nothing to do self.exit_params["packages"] = [] self.add_exit_infos("package(s) already installed") return self.changed = True self.exit_params["diff"] = { "before": "\n".join(sorted(before)) + "\n" if before else "", "after": "\n".join(sorted(after)) + "\n" if after else "", } changed_reason_pkgs = [p for p in pkgs_to_set_reason if p not in installed_pkgs] if self.m.check_mode: self.add_exit_infos("Would have installed %d packages" % (len(installed_pkgs) + len(changed_reason_pkgs))) self.exit_params["packages"] = sorted(installed_pkgs + changed_reason_pkgs) return # actually do it def _install_packages_for_real(pacman_verb, pkglist): cmd = cmd_base + [pacman_verb] + [p.source for p in pkglist] rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: self.fail("Failed to install package(s)", cmd=cmd, stdout=stdout, stderr=stderr) self.add_exit_infos(stdout=stdout, stderr=stderr) self._invalidate_database() if pkgs_to_install: _install_packages_for_real("--sync", pkgs_to_install) if pkgs_to_install_from_url: _install_packages_for_real("--upgrade", pkgs_to_install_from_url) # set reason if pkgs_to_set_reason: cmd = [self.pacman_path, "--noconfirm", "--database"] if self.m.params["reason"] == "dependency": cmd.append("--asdeps") else: cmd.append("--asexplicit") cmd.extend(pkgs_to_set_reason) rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: self.fail("Failed to install package(s)", cmd=cmd, stdout=stdout, stderr=stderr) self.add_exit_infos(stdout=stdout, stderr=stderr) self.exit_params["packages"] = sorted(installed_pkgs + changed_reason_pkgs) self.add_exit_infos("Installed %d package(s)" % (len(installed_pkgs) + len(changed_reason_pkgs))) def remove_packages(self, pkgs): # filter out pkgs that are already absent pkg_names_to_remove = [p.name for p in pkgs if p.name in self.inventory["installed_pkgs"]] if len(pkg_names_to_remove) == 0: self.exit_params["packages"] = [] self.add_exit_infos("package(s) already absent") return # There's something to do, set this in advance self.changed = True cmd_base = [self.pacman_path, "--remove", "--noconfirm", "--noprogressbar"] cmd_base += self.m.params["extra_args"] cmd_base += ["--nodeps", "--nodeps"] if self.m.params["force"] else [] # nosave_args conflicts with --print-format. Added later. # https://github.com/ansible-collections/community.general/issues/4315 # This is a bit of a TOCTOU but it is better than parsing the output of # pacman -R, which is different depending on the user config (VerbosePkgLists) # Start by gathering what would be removed cmd = cmd_base + ["--print-format", "%n-%v"] + pkg_names_to_remove rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: self.fail("failed to list package(s) to remove", cmd=cmd, stdout=stdout, stderr=stderr) removed_pkgs = stdout.split() self.exit_params["packages"] = removed_pkgs self.exit_params["diff"] = { "before": "\n".join(removed_pkgs) + "\n", # trailing \n to avoid diff complaints "after": "", } if self.m.check_mode: self.exit_params["packages"] = removed_pkgs self.add_exit_infos("Would have removed %d packages" % len(removed_pkgs)) return nosave_args = ["--nosave"] if self.m.params["remove_nosave"] else [] cmd = cmd_base + nosave_args + pkg_names_to_remove rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: self.fail("failed to remove package(s)", cmd=cmd, stdout=stdout, stderr=stderr) self._invalidate_database() self.exit_params["packages"] = removed_pkgs self.add_exit_infos("Removed %d package(s)" % len(removed_pkgs), stdout=stdout, stderr=stderr) def upgrade(self): """Runs pacman --sync --sysupgrade if there are upgradable packages""" if len(self.inventory["upgradable_pkgs"]) == 0: self.add_exit_infos("Nothing to upgrade") return self.changed = True # there are upgrades, so there will be changes # Build diff based on inventory first. diff = {"before": "", "after": ""} for pkg, versions in self.inventory["upgradable_pkgs"].items(): diff["before"] += "%s-%s\n" % (pkg, versions.current) diff["after"] += "%s-%s\n" % (pkg, versions.latest) self.exit_params["diff"] = diff self.exit_params["packages"] = self.inventory["upgradable_pkgs"].keys() if self.m.check_mode: self.add_exit_infos( "%d packages would have been upgraded" % (len(self.inventory["upgradable_pkgs"])) ) else: cmd = [ self.pacman_path, "--sync", "--sysupgrade", "--quiet", "--noconfirm", ] if self.m.params["upgrade_extra_args"]: cmd += self.m.params["upgrade_extra_args"] rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) self._invalidate_database() if rc == 0: self.add_exit_infos("System upgraded", stdout=stdout, stderr=stderr) else: self.fail("Could not upgrade", cmd=cmd, stdout=stdout, stderr=stderr) def _list_database(self): """runs pacman --sync --list with some caching""" if self._cached_database is None: dummy, packages, dummy = self.m.run_command([self.pacman_path, '--sync', '--list'], check_rc=True) self._cached_database = packages.splitlines() return self._cached_database def _invalidate_database(self): """invalidates the pacman --sync --list cache""" self._cached_database = None def update_package_db(self): """runs pacman --sync --refresh""" if self.m.check_mode: self.add_exit_infos("Would have updated the package db") self.changed = True self.exit_params["cache_updated"] = True return cmd = [ self.pacman_path, "--sync", "--refresh", ] if self.m.params["update_cache_extra_args"]: cmd += self.m.params["update_cache_extra_args"] if self.m.params["force"]: cmd += ["--refresh"] else: # Dump package database to get contents before update pre_state = sorted(self._list_database()) rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) self._invalidate_database() if self.m.params["force"]: # Always changed when force=true self.exit_params["cache_updated"] = True else: # Dump package database to get contents after update post_state = sorted(self._list_database()) # If contents changed, set changed=true self.exit_params["cache_updated"] = pre_state != post_state if self.exit_params["cache_updated"]: self.changed = True if rc == 0: self.add_exit_infos("Updated package db", stdout=stdout, stderr=stderr) else: self.fail("could not update package db", cmd=cmd, stdout=stdout, stderr=stderr) def package_list(self): """Takes the input package list and resolves packages groups to their package list using the inventory, extracts package names from packages given as files or URLs using calls to pacman Returns the expanded/resolved list as a list of Package """ pkg_list = [] for pkg in self.m.params["name"]: if not pkg: continue is_URL = False if pkg in self.inventory["available_groups"]: # Expand group members for group_member in self.inventory["available_groups"][pkg]: pkg_list.append(Package(name=group_member, source=group_member)) elif pkg in self.inventory["available_pkgs"] or pkg in self.inventory["installed_pkgs"]: # Just a regular pkg, either available in the repositories, # or locally installed, which we need to know for absent state pkg_list.append(Package(name=pkg, source=pkg)) else: # Last resort, call out to pacman to extract the info, # pkg is possibly in the <repo>/<pkgname> format, or a filename or a URL # Start with <repo>/<pkgname> case cmd = [self.pacman_path, "--sync", "--print-format", "%n", pkg] rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: # fallback to filename / URL cmd = [self.pacman_path, "--upgrade", "--print-format", "%n", pkg] rc, stdout, stderr = self.m.run_command(cmd, check_rc=False) if rc != 0: if self.target_state == "absent": continue # Don't bark for unavailable packages when trying to remove them else: self.fail( msg="Failed to list package %s" % (pkg), cmd=cmd, stdout=stdout, stderr=stderr, rc=rc, ) # With Pacman v6.0.1 - libalpm v13.0.1, --upgrade outputs " filename_without_extension downloading..." if the URL is unseen. # In all cases, pacman outputs "loading packages..." on stdout. strip both stdout = stdout.splitlines()[-1] is_URL = True pkg_name = stdout.strip() pkg_list.append(Package(name=pkg_name, source=pkg, source_is_URL=is_URL)) return pkg_list def _build_inventory(self): """Build a cache datastructure used for all pkg lookups Returns a dict: { "installed_pkgs": {pkgname: version}, "installed_groups": {groupname: set(pkgnames)}, "available_pkgs": {pkgname: version}, "available_groups": {groupname: set(pkgnames)}, "upgradable_pkgs": {pkgname: (current_version,latest_version)}, "pkg_reasons": {pkgname: reason}, } Fails the module if a package requested for install cannot be found """ installed_pkgs = {} dummy, stdout, dummy = self.m.run_command([self.pacman_path, "--query"], check_rc=True) # Format of a line: "pacman 6.0.1-2" query_re = re.compile(r'^\s*(?P<pkg>\S+)\s+(?P<ver>\S+)\s*$') for l in stdout.splitlines(): query_match = query_re.match(l) if not query_match: continue pkg, ver = query_match.groups() installed_pkgs[pkg] = ver installed_groups = defaultdict(set) dummy, stdout, dummy = self.m.run_command( [self.pacman_path, "--query", "--groups"], check_rc=True ) # Format of lines: # base-devel file # base-devel findutils # ... query_groups_re = re.compile(r'^\s*(?P<group>\S+)\s+(?P<pkg>\S+)\s*$') for l in stdout.splitlines(): query_groups_match = query_groups_re.match(l) if not query_groups_match: continue group, pkgname = query_groups_match.groups() installed_groups[group].add(pkgname) available_pkgs = {} database = self._list_database() # Format of a line: "core pacman 6.0.1-2" for l in database: l = l.strip() if not l: continue repo, pkg, ver = l.split()[:3] available_pkgs[pkg] = ver available_groups = defaultdict(set) dummy, stdout, dummy = self.m.run_command( [self.pacman_path, "--sync", "--groups", "--groups"], check_rc=True ) # Format of lines: # vim-plugins vim-airline # vim-plugins vim-airline-themes # vim-plugins vim-ale # ... sync_groups_re = re.compile(r'^\s*(?P<group>\S+)\s+(?P<pkg>\S+)\s*$') for l in stdout.splitlines(): sync_groups_match = sync_groups_re.match(l) if not sync_groups_match: continue group, pkg = sync_groups_match.groups() available_groups[group].add(pkg) upgradable_pkgs = {} rc, stdout, stderr = self.m.run_command( [self.pacman_path, "--query", "--upgrades"], check_rc=False ) stdout = stdout.splitlines() if stdout and "Avoid running" in stdout[0]: stdout = stdout[1:] stdout = "\n".join(stdout) # non-zero exit with nothing in stdout -> nothing to upgrade, all good # stderr can have warnings, so not checked here if rc == 1 and not stdout: pass # nothing to upgrade elif rc == 0: # Format of lines: # strace 5.14-1 -> 5.15-1 # systemd 249.7-1 -> 249.7-2 [ignored] for l in stdout.splitlines(): l = l.strip() if not l: continue if "[ignored]" in l or "Avoid running" in l: continue s = l.split() if len(s) != 4: self.fail(msg="Invalid line: %s" % l) pkg = s[0] current = s[1] latest = s[3] upgradable_pkgs[pkg] = VersionTuple(current=current, latest=latest) else: # stuff in stdout but rc!=0, abort self.fail( "Couldn't get list of packages available for upgrade", stdout=stdout, stderr=stderr, rc=rc, ) pkg_reasons = {} dummy, stdout, dummy = self.m.run_command([self.pacman_path, "--query", "--explicit"], check_rc=True) # Format of a line: "pacman 6.0.1-2" for l in stdout.splitlines(): l = l.strip() if not l: continue pkg = l.split()[0] pkg_reasons[pkg] = "explicit" dummy, stdout, dummy = self.m.run_command([self.pacman_path, "--query", "--deps"], check_rc=True) # Format of a line: "pacman 6.0.1-2" for l in stdout.splitlines(): l = l.strip() if not l: continue pkg = l.split()[0] pkg_reasons[pkg] = "dependency" return dict( installed_pkgs=installed_pkgs, installed_groups=installed_groups, available_pkgs=available_pkgs, available_groups=available_groups, upgradable_pkgs=upgradable_pkgs, pkg_reasons=pkg_reasons, ) def setup_module(): module = AnsibleModule( argument_spec=dict( name=dict(type="list", elements="str", aliases=["pkg", "package"]), state=dict( type="str", default="present", choices=["present", "installed", "latest", "absent", "removed"], ), force=dict(type="bool", default=False), remove_nosave=dict(type="bool", default=False), executable=dict(type="str", default="pacman"), extra_args=dict(type="str", default=""), upgrade=dict(type="bool"), upgrade_extra_args=dict(type="str", default=""), update_cache=dict(type="bool"), update_cache_extra_args=dict(type="str", default=""), reason=dict(type="str", choices=["explicit", "dependency"]), reason_for=dict(type="str", default="new", choices=["new", "all"]), ), required_one_of=[["name", "update_cache", "upgrade"]], mutually_exclusive=[["name", "upgrade"]], supports_check_mode=True, ) # Split extra_args as the shell would for easier handling later for str_args in ["extra_args", "upgrade_extra_args", "update_cache_extra_args"]: module.params[str_args] = shlex.split(module.params[str_args]) return module def main(): Pacman(setup_module()).run() if __name__ == "__main__": main() PK $�!\A���+ �+ P collections/ansible_collections/community/general/plugins/modules/memset_zone.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Simon Weald <ansible@simonweald.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: memset_zone author: "Simon Weald (@glitchcrab)" short_description: Creates and deletes Memset DNS zones notes: - Zones can be thought of as a logical group of domains, all of which share the same DNS records (i.e. they point to the same IP). An API key generated via the Memset customer control panel is needed with the following minimum scope - C(dns.zone_create), C(dns.zone_delete), C(dns.zone_list). description: - Manage DNS zones in a Memset account. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: required: true description: - Indicates desired state of resource. type: str choices: [ absent, present ] api_key: required: true description: - The API key obtained from the Memset control panel. type: str name: required: true description: - The zone nickname; usually the same as the main domain. Ensure this value has at most 250 characters. type: str aliases: [ nickname ] ttl: description: - The default TTL for all records created in the zone. This must be a valid int from U(https://www.memset.com/apidocs/methods_dns.html#dns.zone_create). type: int default: 0 choices: [ 0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400 ] force: required: false default: false type: bool description: - Forces deletion of a zone and all zone domains/zone records it contains. ''' EXAMPLES = ''' # Create the zone 'test' - name: Create zone community.general.memset_zone: name: test state: present api_key: 5eb86c9196ab03919abcf03857163741 ttl: 300 delegate_to: localhost # Force zone deletion - name: Force delete zone community.general.memset_zone: name: test state: absent api_key: 5eb86c9196ab03919abcf03857163741 force: true delegate_to: localhost ''' RETURN = ''' memset_api: description: Zone info from the Memset API returned: when state == present type: complex contains: domains: description: List of domains in this zone returned: always type: list sample: [] id: description: Zone id returned: always type: str sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c" nickname: description: Zone name returned: always type: str sample: "example.com" records: description: List of DNS records for domains in this zone returned: always type: list sample: [] ttl: description: Default TTL for domains in this zone returned: always type: int sample: 300 ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.memset import check_zone from ansible_collections.community.general.plugins.module_utils.memset import get_zone_id from ansible_collections.community.general.plugins.module_utils.memset import memset_api_call def api_validation(args=None): ''' Perform some validation which will be enforced by Memset's API (see: https://www.memset.com/apidocs/methods_dns.html#dns.zone_record_create) ''' # zone domain length must be less than 250 chars. if len(args['name']) > 250: stderr = 'Zone name must be less than 250 characters in length.' module.fail_json(failed=True, msg=stderr, stderr=stderr) def check(args=None): ''' Support for running with check mode. ''' retvals = dict() api_method = 'dns.zone_list' has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) zone_exists, counter = check_zone(data=response, name=args['name']) # set changed to true if the operation would cause a change. has_changed = ((zone_exists and args['state'] == 'absent') or (not zone_exists and args['state'] == 'present')) retvals['changed'] = has_changed retvals['failed'] = has_failed return retvals def create_zone(args=None, zone_exists=None, payload=None): ''' At this point we already know whether the zone exists, so we just need to make the API reflect the desired state. ''' has_changed, has_failed = False, False msg, memset_api = None, None if not zone_exists: payload['ttl'] = args['ttl'] payload['nickname'] = args['name'] api_method = 'dns.zone_create' has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload) if not has_failed: has_changed = True else: api_method = 'dns.zone_list' _has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) for zone in response.json(): if zone['nickname'] == args['name']: break if zone['ttl'] != args['ttl']: # update the zone if the desired TTL is different. payload['id'] = zone['id'] payload['ttl'] = args['ttl'] api_method = 'dns.zone_update' has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload) if not has_failed: has_changed = True # populate return var with zone info. api_method = 'dns.zone_list' _has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) zone_exists, msg, counter, zone_id = get_zone_id(zone_name=args['name'], current_zones=response.json()) if zone_exists: payload = dict() payload['id'] = zone_id api_method = 'dns.zone_info' _has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload) memset_api = response.json() return has_failed, has_changed, memset_api, msg def delete_zone(args=None, zone_exists=None, payload=None): ''' Deletion requires extra sanity checking as the zone cannot be deleted if it contains domains or records. Setting force=true will override this behaviour. ''' has_changed, has_failed = False, False msg, memset_api = None, None if zone_exists: api_method = 'dns.zone_list' _has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload) counter = 0 for zone in response.json(): if zone['nickname'] == args['name']: counter += 1 if counter == 1: for zone in response.json(): if zone['nickname'] == args['name']: zone_id = zone['id'] domain_count = len(zone['domains']) record_count = len(zone['records']) if (domain_count > 0 or record_count > 0) and args['force'] is False: # we need to fail out if force was not explicitly set. stderr = 'Zone contains domains or records and force was not used.' has_failed = True has_changed = False module.fail_json(failed=has_failed, changed=has_changed, msg=msg, stderr=stderr, rc=1) api_method = 'dns.zone_delete' payload['id'] = zone_id has_failed, msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method, payload=payload) if not has_failed: has_changed = True # return raw JSON from API in named var and then unset msg var so we aren't returning the same thing twice. memset_api = msg msg = None else: # zone names are not unique, so we cannot safely delete the requested # zone at this time. has_failed = True has_changed = False msg = 'Unable to delete zone as multiple zones with the same name exist.' else: has_failed, has_changed = False, False return has_failed, has_changed, memset_api, msg def create_or_delete(args=None): ''' We need to perform some initial sanity checking and also look up required info before handing it off to create or delete. ''' retvals, payload = dict(), dict() has_failed, has_changed = False, False msg, memset_api, stderr = None, None, None # get the zones and check if the relevant zone exists. api_method = 'dns.zone_list' _has_failed, _msg, response = memset_api_call(api_key=args['api_key'], api_method=api_method) if _has_failed: # this is the first time the API is called; incorrect credentials will # manifest themselves at this point so we need to ensure the user is # informed of the reason. retvals['failed'] = _has_failed retvals['msg'] = _msg if response.stderr is not None: retvals['stderr'] = response.stderr return retvals zone_exists, _msg, counter, _zone_id = get_zone_id(zone_name=args['name'], current_zones=response.json()) if args['state'] == 'present': has_failed, has_changed, memset_api, msg = create_zone(args=args, zone_exists=zone_exists, payload=payload) elif args['state'] == 'absent': has_failed, has_changed, memset_api, msg = delete_zone(args=args, zone_exists=zone_exists, payload=payload) retvals['failed'] = has_failed retvals['changed'] = has_changed for val in ['msg', 'stderr', 'memset_api']: if val is not None: retvals[val] = eval(val) return retvals def main(): global module module = AnsibleModule( argument_spec=dict( state=dict(required=True, choices=['present', 'absent'], type='str'), api_key=dict(required=True, type='str', no_log=True), name=dict(required=True, aliases=['nickname'], type='str'), ttl=dict(required=False, default=0, choices=[0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400], type='int'), force=dict(required=False, default=False, type='bool') ), supports_check_mode=True ) # populate the dict with the user-provided vars. args = dict() for key, arg in module.params.items(): args[key] = arg args['check_mode'] = module.check_mode # validate some API-specific limitations. api_validation(args=args) if module.check_mode: retvals = check(args) else: retvals = create_or_delete(args) if retvals['failed']: module.fail_json(**retvals) else: module.exit_json(**retvals) if __name__ == '__main__': main() PK $�!\L��͛ � M collections/ansible_collections/community/general/plugins/modules/campfire.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: campfire short_description: Send a message to Campfire description: - Send a message to Campfire. - Messages with newlines will result in a "Paste" message being sent. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: subscription: type: str description: - The subscription name to use. required: true token: type: str description: - API token. required: true room: type: str description: - Room number to which the message should be sent. required: true msg: type: str description: - The message body. required: true notify: type: str description: - Send a notification sound before the message. required: false choices: ["56k", "bell", "bezos", "bueller", "clowntown", "cottoneyejoe", "crickets", "dadgummit", "dangerzone", "danielsan", "deeper", "drama", "greatjob", "greyjoy", "guarantee", "heygirl", "horn", "horror", "inconceivable", "live", "loggins", "makeitso", "noooo", "nyan", "ohmy", "ohyeah", "pushit", "rimshot", "rollout", "rumble", "sax", "secret", "sexyback", "story", "tada", "tmyk", "trololo", "trombone", "unix", "vuvuzela", "what", "whoomp", "yeah", "yodel"] # informational: requirements for nodes requirements: [ ] author: "Adam Garside (@fabulops)" ''' EXAMPLES = ''' - name: Send a message to Campfire community.general.campfire: subscription: foo token: 12345 room: 123 msg: Task completed. - name: Send a message to Campfire community.general.campfire: subscription: foo token: 12345 room: 123 notify: loggins msg: Task completed ... with feeling. ''' try: from html import escape as html_escape except ImportError: # Python-3.2 or later import cgi def html_escape(text, quote=True): return cgi.escape(text, quote) from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def main(): module = AnsibleModule( argument_spec=dict( subscription=dict(required=True), token=dict(required=True, no_log=True), room=dict(required=True), msg=dict(required=True), notify=dict(required=False, choices=["56k", "bell", "bezos", "bueller", "clowntown", "cottoneyejoe", "crickets", "dadgummit", "dangerzone", "danielsan", "deeper", "drama", "greatjob", "greyjoy", "guarantee", "heygirl", "horn", "horror", "inconceivable", "live", "loggins", "makeitso", "noooo", "nyan", "ohmy", "ohyeah", "pushit", "rimshot", "rollout", "rumble", "sax", "secret", "sexyback", "story", "tada", "tmyk", "trololo", "trombone", "unix", "vuvuzela", "what", "whoomp", "yeah", "yodel"]), ), supports_check_mode=False ) subscription = module.params["subscription"] token = module.params["token"] room = module.params["room"] msg = module.params["msg"] notify = module.params["notify"] URI = "https://%s.campfirenow.com" % subscription NSTR = "<message><type>SoundMessage</type><body>%s</body></message>" MSTR = "<message><body>%s</body></message>" AGENT = "Ansible/1.2" # Hack to add basic auth username and password the way fetch_url expects module.params['url_username'] = token module.params['url_password'] = 'X' target_url = '%s/room/%s/speak.xml' % (URI, room) headers = {'Content-Type': 'application/xml', 'User-agent': AGENT} # Send some audible notification if requested if notify: response, info = fetch_url(module, target_url, data=NSTR % html_escape(notify), headers=headers) if info['status'] not in [200, 201]: module.fail_json(msg="unable to send msg: '%s', campfire api" " returned error code: '%s'" % (notify, info['status'])) # Send the message response, info = fetch_url(module, target_url, data=MSTR % html_escape(msg), headers=headers) if info['status'] not in [200, 201]: module.fail_json(msg="unable to send msg: '%s', campfire api" " returned error code: '%s'" % (msg, info['status'])) module.exit_json(changed=True, room=room, msg=msg, notify=notify) if __name__ == '__main__': main() PK $�!\�#Y�, �, I collections/ansible_collections/community/general/plugins/modules/xbps.pynu �[��� # -*- coding: utf-8 -*- # Copyright 2016 Dino Occhialini <dino.occhialini@gmail.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: xbps short_description: Manage packages with XBPS description: - Manage packages with the XBPS package manager. author: - "Dino Occhialini (@dinoocch)" - "Michael Aldridge (@the-maldridge)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the package to install, upgrade, or remove. aliases: [pkg,package] type: list elements: str state: description: - Desired state of the package. default: "present" choices: ["present", "absent", "latest", "installed", "removed"] type: str recurse: description: - When removing a package, also remove its dependencies, provided that they are not required by other packages and were not explicitly installed by a user. type: bool default: false update_cache: description: - Whether or not to refresh the master package lists. This can be run as part of a package installation or as a separate step. type: bool default: true upgrade: description: - Whether or not to upgrade whole system type: bool default: false upgrade_xbps: description: - Whether or not to upgrade the xbps package when necessary. Before installing new packages, xbps requires the user to update the xbps package itself. Thus when this option is set to V(false), upgrades and installations will fail when xbps is not up to date. type: bool default: true version_added: '0.2.0' ''' EXAMPLES = ''' - name: Install package foo (automatically updating the xbps package if needed) community.general.xbps: name: foo state: present - name: Upgrade package foo community.general.xbps: name: foo state: latest update_cache: true - name: Remove packages foo and bar community.general.xbps: name: - foo - bar state: absent - name: Recursively remove package foo community.general.xbps: name: foo state: absent recurse: true - name: Update package cache community.general.xbps: update_cache: true - name: Upgrade packages community.general.xbps: upgrade: true - name: Install a package, failing if the xbps package is out of date community.general.xbps: name: foo state: present upgrade_xbps: false ''' RETURN = ''' msg: description: Message about results returned: success type: str sample: "System Upgraded" packages: description: Packages that are affected/would be affected type: list sample: ["ansible"] returned: success ''' import os from ansible.module_utils.basic import AnsibleModule def is_installed(xbps_output): """Returns package install state""" return bool(len(xbps_output)) def query_package(module, xbps_path, name, state="present"): """Returns Package info""" if state == "present": lcmd = "%s %s" % (xbps_path['query'], name) lrc, lstdout, lstderr = module.run_command(lcmd, check_rc=False) if not is_installed(lstdout): # package is not installed locally return False, False rcmd = "%s -Sun" % (xbps_path['install']) rrc, rstdout, rstderr = module.run_command(rcmd, check_rc=False) if rrc == 0 or rrc == 17: """Return True to indicate that the package is installed locally, and the result of the version number comparison to determine if the package is up-to-date""" return True, name not in rstdout return False, False def update_package_db(module, xbps_path): """Returns True if update_package_db changed""" cmd = "%s -S" % (xbps_path['install']) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc != 0: module.fail_json(msg="Could not update package db") if "avg rate" in stdout: return True else: return False def upgrade_xbps(module, xbps_path, exit_on_success=False): cmdupgradexbps = "%s -uy xbps" % (xbps_path['install']) rc, stdout, stderr = module.run_command(cmdupgradexbps, check_rc=False) if rc != 0: module.fail_json(msg='Could not upgrade xbps itself') def upgrade(module, xbps_path): """Returns true is full upgrade succeeds""" cmdupgrade = "%s -uy" % (xbps_path['install']) cmdneedupgrade = "%s -un" % (xbps_path['install']) rc, stdout, stderr = module.run_command(cmdneedupgrade, check_rc=False) if rc == 0: if len(stdout.splitlines()) == 0: module.exit_json(changed=False, msg='Nothing to upgrade') elif module.check_mode: module.exit_json(changed=True, msg='Would have performed upgrade') else: rc, stdout, stderr = module.run_command(cmdupgrade, check_rc=False) if rc == 0: module.exit_json(changed=True, msg='System upgraded') elif rc == 16 and module.params['upgrade_xbps']: upgrade_xbps(module, xbps_path) # avoid loops by not trying self-upgrade again module.params['upgrade_xbps'] = False upgrade(module, xbps_path) else: module.fail_json(msg="Could not upgrade") else: module.fail_json(msg="Could not upgrade") def remove_packages(module, xbps_path, packages): """Returns true if package removal succeeds""" changed_packages = [] # Using a for loop in case of error, we can report the package that failed for package in packages: # Query the package first, to see if we even need to remove installed, updated = query_package(module, xbps_path, package) if not installed: continue cmd = "%s -y %s" % (xbps_path['remove'], package) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc != 0: module.fail_json(msg="failed to remove %s" % (package)) changed_packages.append(package) if len(changed_packages) > 0: module.exit_json(changed=True, msg="removed %s package(s)" % len(changed_packages), packages=changed_packages) module.exit_json(changed=False, msg="package(s) already absent") def install_packages(module, xbps_path, state, packages): """Returns true if package install succeeds.""" toInstall = [] for i, package in enumerate(packages): """If the package is installed and state == present or state == latest and is up-to-date then skip""" installed, updated = query_package(module, xbps_path, package) if installed and (state == 'present' or (state == 'latest' and updated)): continue toInstall.append(package) if len(toInstall) == 0: module.exit_json(changed=False, msg="Nothing to Install") cmd = "%s -y %s" % (xbps_path['install'], " ".join(toInstall)) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc == 16 and module.params['upgrade_xbps']: upgrade_xbps(module, xbps_path) # avoid loops by not trying self-update again module.params['upgrade_xbps'] = False install_packages(module, xbps_path, state, packages) elif rc != 0 and not (state == 'latest' and rc == 17): module.fail_json(msg="failed to install %s packages(s)" % (len(toInstall)), packages=toInstall) module.exit_json(changed=True, msg="installed %s package(s)" % (len(toInstall)), packages=toInstall) def check_packages(module, xbps_path, packages, state): """Returns change status of command""" would_be_changed = [] for package in packages: installed, updated = query_package(module, xbps_path, package) if ((state in ["present", "latest"] and not installed) or (state == "absent" and installed) or (state == "latest" and not updated)): would_be_changed.append(package) if would_be_changed: if state == "absent": state = "removed" module.exit_json(changed=True, msg="%s package(s) would be %s" % ( len(would_be_changed), state), packages=would_be_changed) else: module.exit_json(changed=False, msg="package(s) already %s" % state, packages=[]) def update_cache(module, xbps_path, upgrade_planned): """Update package cache""" if module.check_mode: if upgrade_planned: return module.exit_json( changed=True, msg='Would have updated the package cache' ) changed = update_package_db(module, xbps_path) if not upgrade_planned: module.exit_json(changed=changed, msg=( 'Updated the package master lists' if changed else 'Package list already up to date' )) def main(): """Returns, calling appropriate command""" module = AnsibleModule( argument_spec=dict( name=dict(default=None, aliases=['pkg', 'package'], type='list', elements='str'), state=dict(default='present', choices=['present', 'installed', 'latest', 'absent', 'removed']), recurse=dict(default=False, type='bool'), upgrade=dict(default=False, type='bool'), update_cache=dict(default=True, type='bool'), upgrade_xbps=dict(default=True, type='bool'), ), required_one_of=[['name', 'update_cache', 'upgrade']], supports_check_mode=True) xbps_path = dict() xbps_path['install'] = module.get_bin_path('xbps-install', True) xbps_path['query'] = module.get_bin_path('xbps-query', True) xbps_path['remove'] = module.get_bin_path('xbps-remove', True) if not os.path.exists(xbps_path['install']): module.fail_json(msg="cannot find xbps, in path %s" % (xbps_path['install'])) p = module.params # normalize the state parameter if p['state'] in ['present', 'installed']: p['state'] = 'present' elif p['state'] in ['absent', 'removed']: p['state'] = 'absent' if p['update_cache']: update_cache(module, xbps_path, (p['name'] or p['upgrade'])) if p['upgrade']: upgrade(module, xbps_path) if p['name']: pkgs = p['name'] if module.check_mode: check_packages(module, xbps_path, pkgs, p['state']) if p['state'] in ['present', 'latest']: install_packages(module, xbps_path, p['state'], pkgs) elif p['state'] == 'absent': remove_packages(module, xbps_path, pkgs) if __name__ == "__main__": main() PK $�!\�S^n& n& S collections/ansible_collections/community/general/plugins/modules/simpleinit_msb.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2023, Vlad Glagolev <scm@vaygr.net> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: simpleinit_msb short_description: Manage services on Source Mage GNU/Linux version_added: 7.5.0 description: - Controls services on remote hosts using C(simpleinit-msb). notes: - This module needs ansible-core 2.15.5 or newer. Older versions have a broken and insufficient daemonize functionality. author: "Vlad Glagolev (@vaygr)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - Name of the service. required: true aliases: ['service'] state: type: str required: false choices: [ running, started, stopped, restarted, reloaded ] description: - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the service. V(reloaded) will always reload. - At least one of O(state) and O(enabled) are required. - Note that V(reloaded) will start the service if it is not already started, even if your chosen init system would not normally. enabled: type: bool required: false description: - Whether the service should start on boot. - At least one of O(state) and O(enabled) are required. ''' EXAMPLES = ''' - name: Example action to start service httpd, if not running community.general.simpleinit_msb: name: httpd state: started - name: Example action to stop service httpd, if running community.general.simpleinit_msb: name: httpd state: stopped - name: Example action to restart service httpd, in all cases community.general.simpleinit_msb: name: httpd state: restarted - name: Example action to reload service httpd, in all cases community.general.simpleinit_msb: name: httpd state: reloaded - name: Example action to enable service httpd, and not touch the running state community.general.simpleinit_msb: name: httpd enabled: true ''' import os import re from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.service import daemonize class SimpleinitMSB(object): """ Main simpleinit-msb service manipulation class """ def __init__(self, module): self.module = module self.name = module.params['name'] self.state = module.params['state'] self.enable = module.params['enabled'] self.changed = False self.running = None self.action = None self.telinit_cmd = None self.svc_change = False def execute_command(self, cmd, daemon=False): if not daemon: return self.module.run_command(cmd) else: return daemonize(self.module, cmd) def check_service_changed(self): if self.state and self.running is None: self.module.fail_json(msg="failed determining service state, possible typo of service name?") # Find out if state has changed if not self.running and self.state in ["started", "running", "reloaded"]: self.svc_change = True elif self.running and self.state in ["stopped", "reloaded"]: self.svc_change = True elif self.state == "restarted": self.svc_change = True if self.module.check_mode and self.svc_change: self.module.exit_json(changed=True, msg='service state changed') def modify_service_state(self): # Only do something if state will change if self.svc_change: # Control service if self.state in ['started', 'running']: self.action = "start" elif not self.running and self.state == 'reloaded': self.action = "start" elif self.state == 'stopped': self.action = "stop" elif self.state == 'reloaded': self.action = "reload" elif self.state == 'restarted': self.action = "restart" if self.module.check_mode: self.module.exit_json(changed=True, msg='changing service state') return self.service_control() else: # If nothing needs to change just say all is well rc = 0 err = '' out = '' return rc, out, err def get_service_tools(self): paths = ['/sbin', '/usr/sbin', '/bin', '/usr/bin'] binaries = ['telinit'] location = dict() for binary in binaries: location[binary] = self.module.get_bin_path(binary, opt_dirs=paths) if location.get('telinit', False) and os.path.exists("/etc/init.d/smgl_init"): self.telinit_cmd = location['telinit'] if self.telinit_cmd is None: self.module.fail_json(msg='cannot find telinit script for simpleinit-msb, aborting...') def get_service_status(self): self.action = "status" rc, status_stdout, status_stderr = self.service_control() if self.running is None and status_stdout.count('\n') <= 1: cleanout = status_stdout.lower().replace(self.name.lower(), '') if "is not running" in cleanout: self.running = False elif "is running" in cleanout: self.running = True return self.running def service_enable(self): # Check if the service is already enabled/disabled if not self.enable ^ self.service_enabled(): return action = "boot" + ("enable" if self.enable else "disable") (rc, out, err) = self.execute_command("%s %s %s" % (self.telinit_cmd, action, self.name)) self.changed = True for line in err.splitlines(): if self.enable and line.find('already enabled') != -1: self.changed = False break if not self.enable and line.find('already disabled') != -1: self.changed = False break if not self.changed: return return (rc, out, err) def service_enabled(self): self.service_exists() (rc, out, err) = self.execute_command("%s %sd" % (self.telinit_cmd, self.enable)) service_enabled = False if self.enable else True rex = re.compile(r'^%s$' % self.name) for line in out.splitlines(): if rex.match(line): service_enabled = True if self.enable else False break return service_enabled def service_exists(self): (rc, out, err) = self.execute_command("%s list" % self.telinit_cmd) service_exists = False rex = re.compile(r'^\w+\s+%s$' % self.name) for line in out.splitlines(): if rex.match(line): service_exists = True break if not service_exists: self.module.fail_json(msg='telinit could not find the requested service: %s' % self.name) def service_control(self): self.service_exists() svc_cmd = "%s run %s" % (self.telinit_cmd, self.name) rc_state, stdout, stderr = self.execute_command("%s %s" % (svc_cmd, self.action), daemon=True) return (rc_state, stdout, stderr) def build_module(): return AnsibleModule( argument_spec=dict( name=dict(required=True, aliases=['service']), state=dict(choices=['running', 'started', 'stopped', 'restarted', 'reloaded']), enabled=dict(type='bool'), ), supports_check_mode=True, required_one_of=[['state', 'enabled']], ) def main(): module = build_module() service = SimpleinitMSB(module) rc = 0 out = '' err = '' result = {} result['name'] = service.name # Find service management tools service.get_service_tools() # Enable/disable service startup at boot if requested if service.module.params['enabled'] is not None: service.service_enable() result['enabled'] = service.enable if module.params['state'] is None: # Not changing the running state, so bail out now. result['changed'] = service.changed module.exit_json(**result) result['state'] = service.state service.get_service_status() # Calculate if request will change service state service.check_service_changed() # Modify service state if necessary (rc, out, err) = service.modify_service_state() if rc != 0: if err: module.fail_json(msg=err) else: module.fail_json(msg=out) result['changed'] = service.changed | service.svc_change if service.module.params['enabled'] is not None: result['enabled'] = service.module.params['enabled'] if not service.module.params['state']: status = service.get_service_status() if status is None: result['state'] = 'absent' elif status is False: result['state'] = 'started' else: result['state'] = 'stopped' else: # as we may have just bounced the service the service command may not # report accurate state at this moment so just show what we ran if service.module.params['state'] in ['started', 'restarted', 'running', 'reloaded']: result['state'] = 'started' else: result['state'] = 'stopped' module.exit_json(**result) if __name__ == '__main__': main() PK $�!\>�}�; ; T collections/ansible_collections/community/general/plugins/modules/interfaces_file.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2016, Roman Belyakovsky <ihryamzik () gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: interfaces_file short_description: Tweak settings in /etc/network/interfaces files extends_documentation_fragment: - ansible.builtin.files - community.general.attributes description: - Manage (add, remove, change) individual interface options in an interfaces-style file without having to manage the file as a whole with, say, M(ansible.builtin.template) or M(ansible.builtin.assemble). Interface has to be presented in a file. - Read information about interfaces from interfaces-styled files attributes: check_mode: support: full diff_mode: support: none options: dest: type: path description: - Path to the interfaces file default: /etc/network/interfaces iface: type: str description: - Name of the interface, required for value changes or option remove address_family: type: str description: - Address family of the interface, useful if same interface name is used for both inet and inet6 option: type: str description: - Name of the option, required for value changes or option remove value: type: str description: - If O(option) is not presented for the O(iface) and O(state) is V(present) option will be added. If O(option) already exists and is not V(pre-up), V(up), V(post-up) or V(down), it's value will be updated. V(pre-up), V(up), V(post-up) and V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option set are supported backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool default: false state: type: str description: - If set to V(absent) the option or section will be removed if present instead of created. default: "present" choices: [ "present", "absent" ] notes: - If option is defined multiple times last one will be updated but all will be deleted in case of an absent state requirements: [] author: "Roman Belyakovsky (@hryamzik)" ''' RETURN = ''' dest: description: destination file/path returned: success type: str sample: "/etc/network/interfaces" ifaces: description: interfaces dictionary returned: success type: complex contains: ifaces: description: interface dictionary returned: success type: dict contains: eth0: description: Name of the interface returned: success type: dict contains: address_family: description: interface address family returned: success type: str sample: "inet" method: description: interface method returned: success type: str sample: "manual" mtu: description: other options, all values returned as strings returned: success type: str sample: "1500" pre-up: description: list of C(pre-up) scripts returned: success type: list sample: - "route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1" - "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2" up: description: list of C(up) scripts returned: success type: list sample: - "route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1" - "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2" post-up: description: list of C(post-up) scripts returned: success type: list sample: - "route add -net 10.10.10.0/24 gw 10.10.10.1 dev eth1" - "route add -net 10.10.11.0/24 gw 10.10.11.1 dev eth2" down: description: list of C(down) scripts returned: success type: list sample: - "route del -net 10.10.10.0/24 gw 10.10.10.1 dev eth1" - "route del -net 10.10.11.0/24 gw 10.10.11.1 dev eth2" ... ''' EXAMPLES = ''' - name: Set eth1 mtu configuration value to 8000 community.general.interfaces_file: dest: /etc/network/interfaces.d/eth1.cfg iface: eth1 option: mtu value: 8000 backup: true state: present register: eth1_cfg ''' import os import re import tempfile from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes def lineDict(line): return {'line': line, 'line_type': 'unknown'} def optionDict(line, iface, option, value, address_family): return {'line': line, 'iface': iface, 'option': option, 'value': value, 'line_type': 'option', 'address_family': address_family} def getValueFromLine(s): spaceRe = re.compile(r'\s+') m = list(spaceRe.finditer(s))[-1] valueEnd = m.start() option = s.split()[0] optionStart = s.find(option) optionLen = len(option) return s[optionLen + optionStart:].strip() def read_interfaces_file(module, filename): with open(filename, 'r') as f: return read_interfaces_lines(module, f) def read_interfaces_lines(module, line_strings): lines = [] ifaces = {} currently_processing = None i = 0 for line in line_strings: i += 1 words = line.split() if len(words) < 1: lines.append(lineDict(line)) continue if words[0][0] == "#": lines.append(lineDict(line)) continue if words[0] == "mapping": # currmap = calloc(1, sizeof *currmap); lines.append(lineDict(line)) currently_processing = "MAPPING" elif words[0] == "source": lines.append(lineDict(line)) currently_processing = "NONE" elif words[0] == "source-dir": lines.append(lineDict(line)) currently_processing = "NONE" elif words[0] == "source-directory": lines.append(lineDict(line)) currently_processing = "NONE" elif words[0] == "iface": currif = { "pre-up": [], "up": [], "down": [], "post-up": [] } iface_name = words[1] try: currif['address_family'] = words[2] except IndexError: currif['address_family'] = None address_family = currif['address_family'] try: currif['method'] = words[3] except IndexError: currif['method'] = None ifaces[iface_name] = currif lines.append({'line': line, 'iface': iface_name, 'line_type': 'iface', 'params': currif, 'address_family': address_family}) currently_processing = "IFACE" elif words[0] == "auto": lines.append(lineDict(line)) currently_processing = "NONE" elif words[0].startswith("allow-"): lines.append(lineDict(line)) currently_processing = "NONE" elif words[0] == "no-auto-down": lines.append(lineDict(line)) currently_processing = "NONE" elif words[0] == "no-scripts": lines.append(lineDict(line)) currently_processing = "NONE" else: if currently_processing == "IFACE": option_name = words[0] value = getValueFromLine(line) lines.append(optionDict(line, iface_name, option_name, value, address_family)) if option_name in ["pre-up", "up", "down", "post-up"]: currif[option_name].append(value) else: currif[option_name] = value elif currently_processing == "MAPPING": lines.append(lineDict(line)) elif currently_processing == "NONE": lines.append(lineDict(line)) else: module.fail_json(msg="misplaced option %s in line %d" % (line, i)) return None, None return lines, ifaces def get_interface_options(iface_lines): return [i for i in iface_lines if i['line_type'] == 'option'] def get_target_options(iface_options, option): return [i for i in iface_options if i['option'] == option] def update_existing_option_line(target_option, value): old_line = target_option['line'] old_value = target_option['value'] prefix_start = old_line.find(target_option["option"]) optionLen = len(target_option["option"]) old_value_position = re.search(r"\s+".join(map(re.escape, old_value.split())), old_line[prefix_start + optionLen:]) start = old_value_position.start() + prefix_start + optionLen end = old_value_position.end() + prefix_start + optionLen line = old_line[:start] + value + old_line[end:] return line def set_interface_option(module, lines, iface, option, raw_value, state, address_family=None): value = str(raw_value) changed = False iface_lines = [item for item in lines if "iface" in item and item["iface"] == iface] if address_family is not None: iface_lines = [item for item in iface_lines if "address_family" in item and item["address_family"] == address_family] if len(iface_lines) < 1: # interface not found module.fail_json(msg="Error: interface %s not found" % iface) return changed, None iface_options = get_interface_options(iface_lines) target_options = get_target_options(iface_options, option) if state == "present": if len(target_options) < 1: changed = True # add new option last_line_dict = iface_lines[-1] changed, lines = addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_options, address_family) else: if option in ["pre-up", "up", "down", "post-up"]: if len(list(filter(lambda i: i['value'] == value, target_options))) < 1: changed, lines = addOptionAfterLine(option, value, iface, lines, target_options[-1], iface_options, address_family) else: # if more than one option found edit the last one if target_options[-1]['value'] != value: changed = True target_option = target_options[-1] line = update_existing_option_line(target_option, value) address_family = target_option['address_family'] index = len(lines) - lines[::-1].index(target_option) - 1 lines[index] = optionDict(line, iface, option, value, address_family) elif state == "absent": if len(target_options) >= 1: if option in ["pre-up", "up", "down", "post-up"] and value is not None and value != "None": for target_option in [ito for ito in target_options if ito['value'] == value]: changed = True lines = [ln for ln in lines if ln != target_option] else: changed = True for target_option in target_options: lines = [ln for ln in lines if ln != target_option] else: module.fail_json(msg="Error: unsupported state %s, has to be either present or absent" % state) return changed, lines def addOptionAfterLine(option, value, iface, lines, last_line_dict, iface_options, address_family): # Changing method of interface is not an addition if option == 'method': changed = False for ln in lines: if ln.get('line_type', '') == 'iface' and ln.get('iface', '') == iface and value != ln.get('params', {}).get('method', ''): changed = True ln['line'] = re.sub(ln.get('params', {}).get('method', '') + '$', value, ln.get('line')) ln['params']['method'] = value return changed, lines last_line = last_line_dict['line'] prefix_start = last_line.find(last_line.split()[0]) suffix_start = last_line.rfind(last_line.split()[-1]) + len(last_line.split()[-1]) prefix = last_line[:prefix_start] if len(iface_options) < 1: # interface has no options, ident prefix += " " line = prefix + "%s %s" % (option, value) + last_line[suffix_start:] option_dict = optionDict(line, iface, option, value, address_family) index = len(lines) - lines[::-1].index(last_line_dict) lines.insert(index, option_dict) return True, lines def write_changes(module, lines, dest): tmpfd, tmpfile = tempfile.mkstemp() with os.fdopen(tmpfd, 'wb') as f: f.write(to_bytes(''.join(lines), errors='surrogate_or_strict')) module.atomic_move(tmpfile, os.path.realpath(dest)) def main(): module = AnsibleModule( argument_spec=dict( dest=dict(type='path', default='/etc/network/interfaces'), iface=dict(type='str'), address_family=dict(type='str'), option=dict(type='str'), value=dict(type='str'), backup=dict(type='bool', default=False), state=dict(type='str', default='present', choices=['absent', 'present']), ), add_file_common_args=True, supports_check_mode=True, required_by=dict( option=('iface',), ), ) dest = module.params['dest'] iface = module.params['iface'] address_family = module.params['address_family'] option = module.params['option'] value = module.params['value'] backup = module.params['backup'] state = module.params['state'] if option is not None and state == "present" and value is None: module.fail_json(msg="Value must be set if option is defined and state is 'present'") lines, ifaces = read_interfaces_file(module, dest) changed = False if option is not None: changed, lines = set_interface_option(module, lines, iface, option, value, state, address_family) if changed: dummy, ifaces = read_interfaces_lines(module, [d['line'] for d in lines if 'line' in d]) if changed and not module.check_mode: if backup: module.backup_local(dest) write_changes(module, [d['line'] for d in lines if 'line' in d], dest) module.exit_json(dest=dest, changed=changed, ifaces=ifaces) if __name__ == '__main__': main() PK $�!\�L�qi! i! N collections/ansible_collections/community/general/plugins/modules/nomad_job.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, FERREIRA Christophe <christophe.ferreira@cnaf.fr> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: nomad_job author: FERREIRA Christophe (@chris93111) version_added: "1.3.0" short_description: Launch a Nomad Job description: - Launch a Nomad job. - Stop a Nomad job. - Force start a Nomad job requirements: - python-nomad extends_documentation_fragment: - community.general.nomad - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of job for delete, stop and start job without source. - Name of job for delete, stop and start job without source. - Either this or O(content) must be specified. type: str state: description: - Deploy or remove job. choices: ["present", "absent"] required: true type: str force_start: description: - Force job to started. type: bool default: false content: description: - Content of Nomad job. - Either this or O(name) must be specified. type: str content_format: description: - Type of content of Nomad job. choices: ["hcl", "json"] default: hcl type: str seealso: - name: Nomad jobs documentation description: Complete documentation for Nomad API jobs. link: https://www.nomadproject.io/api-docs/jobs/ ''' EXAMPLES = ''' - name: Create job community.general.nomad_job: host: localhost state: present content: "{{ lookup('ansible.builtin.file', 'job.hcl') }}" timeout: 120 - name: Stop job community.general.nomad_job: host: localhost state: absent name: api - name: Force job to start community.general.nomad_job: host: localhost state: present name: api timeout: 120 force_start: true ''' import json from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native import_nomad = None try: import nomad import_nomad = True except ImportError: import_nomad = False def run(): module = AnsibleModule( argument_spec=dict( host=dict(required=True, type='str'), state=dict(required=True, choices=['present', 'absent']), use_ssl=dict(type='bool', default=True), timeout=dict(type='int', default=5), validate_certs=dict(type='bool', default=True), client_cert=dict(type='path'), client_key=dict(type='path'), namespace=dict(type='str'), name=dict(type='str'), content_format=dict(choices=['hcl', 'json'], default='hcl'), content=dict(type='str'), force_start=dict(type='bool', default=False), token=dict(type='str', no_log=True) ), supports_check_mode=True, mutually_exclusive=[ ["name", "content"] ], required_one_of=[ ['name', 'content'] ] ) if not import_nomad: module.fail_json(msg=missing_required_lib("python-nomad")) certificate_ssl = (module.params.get('client_cert'), module.params.get('client_key')) nomad_client = nomad.Nomad( host=module.params.get('host'), secure=module.params.get('use_ssl'), timeout=module.params.get('timeout'), verify=module.params.get('validate_certs'), cert=certificate_ssl, namespace=module.params.get('namespace'), token=module.params.get('token') ) if module.params.get('state') == "present": if module.params.get('name') and not module.params.get('force_start'): module.fail_json(msg='For start job with name, force_start is needed') changed = False if module.params.get('content'): if module.params.get('content_format') == 'json': job_json = module.params.get('content') try: job_json = json.loads(job_json) except ValueError as e: module.fail_json(msg=to_native(e)) job = dict() job['job'] = job_json try: job_id = job_json.get('ID') if job_id is None: module.fail_json(msg="Cannot retrieve job with ID None") plan = nomad_client.job.plan_job(job_id, job, diff=True) if not plan['Diff'].get('Type') == "None": changed = True if not module.check_mode: result = nomad_client.jobs.register_job(job) else: result = plan else: result = plan except Exception as e: module.fail_json(msg=to_native(e)) if module.params.get('content_format') == 'hcl': try: job_hcl = module.params.get('content') job_json = nomad_client.jobs.parse(job_hcl) job = dict() job['job'] = job_json except nomad.api.exceptions.BadRequestNomadException as err: msg = str(err.nomad_resp.reason) + " " + str(err.nomad_resp.text) module.fail_json(msg=to_native(msg)) try: job_id = job_json.get('ID') plan = nomad_client.job.plan_job(job_id, job, diff=True) if not plan['Diff'].get('Type') == "None": changed = True if not module.check_mode: result = nomad_client.jobs.register_job(job) else: result = plan else: result = plan except Exception as e: module.fail_json(msg=to_native(e)) if module.params.get('force_start'): try: job = dict() if module.params.get('name'): job_name = module.params.get('name') else: job_name = job_json['Name'] job_json = nomad_client.job.get_job(job_name) if job_json['Status'] == 'running': result = job_json else: job_json['Status'] = 'running' job_json['Stop'] = False job['job'] = job_json if not module.check_mode: result = nomad_client.jobs.register_job(job) else: result = nomad_client.validate.validate_job(job) if not result.status_code == 200: module.fail_json(msg=to_native(result.text)) result = json.loads(result.text) changed = True except Exception as e: module.fail_json(msg=to_native(e)) if module.params.get('state') == "absent": try: if not module.params.get('name') is None: job_name = module.params.get('name') else: if module.params.get('content_format') == 'hcl': job_json = nomad_client.jobs.parse(module.params.get('content')) job_name = job_json['Name'] if module.params.get('content_format') == 'json': job_json = module.params.get('content') job_name = job_json['Name'] job = nomad_client.job.get_job(job_name) if job['Status'] == 'dead': changed = False result = job else: if not module.check_mode: result = nomad_client.job.deregister_job(job_name) else: result = job changed = True except Exception as e: module.fail_json(msg=to_native(e)) module.exit_json(changed=changed, result=result) def main(): run() if __name__ == "__main__": main() PK $�!\�9�x/ x/ J collections/ansible_collections/community/general/plugins/modules/beadm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Adam Števko <adam.stevko@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: beadm short_description: Manage ZFS boot environments on FreeBSD/Solaris/illumos systems description: - Create, delete or activate ZFS boot environments. - Mount and unmount ZFS boot environments. author: Adam Števko (@xen0l) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - ZFS boot environment name. type: str required: true aliases: [ "be" ] snapshot: description: - If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment. type: str description: description: - Associate a description with a new boot environment. This option is available only on Solarish platforms. type: str options: description: - Create the datasets for new BE with specific ZFS properties. - Multiple options can be specified. - This option is available only on Solarish platforms. type: str mountpoint: description: - Path where to mount the ZFS boot environment. type: path state: description: - Create or delete ZFS boot environment. type: str choices: [ absent, activated, mounted, present, unmounted ] default: present force: description: - Specifies if the unmount should be forced. type: bool default: false ''' EXAMPLES = r''' - name: Create ZFS boot environment community.general.beadm: name: upgrade-be state: present - name: Create ZFS boot environment from existing inactive boot environment community.general.beadm: name: upgrade-be snapshot: be@old state: present - name: Create ZFS boot environment with compression enabled and description "upgrade" community.general.beadm: name: upgrade-be options: "compression=on" description: upgrade state: present - name: Delete ZFS boot environment community.general.beadm: name: old-be state: absent - name: Mount ZFS boot environment on /tmp/be community.general.beadm: name: BE mountpoint: /tmp/be state: mounted - name: Unmount ZFS boot environment community.general.beadm: name: BE state: unmounted - name: Activate ZFS boot environment community.general.beadm: name: upgrade-be state: activated ''' RETURN = r''' name: description: BE name returned: always type: str sample: pre-upgrade snapshot: description: ZFS snapshot to create BE from returned: always type: str sample: rpool/ROOT/oi-hipster@fresh description: description: BE description returned: always type: str sample: Upgrade from 9.0 to 10.0 options: description: BE additional options returned: always type: str sample: compression=on mountpoint: description: BE mountpoint returned: always type: str sample: /mnt/be state: description: state of the target returned: always type: str sample: present force: description: If forced action is wanted returned: always type: bool sample: false ''' import os from ansible.module_utils.basic import AnsibleModule class BE(object): def __init__(self, module): self.module = module self.name = module.params['name'] self.snapshot = module.params['snapshot'] self.description = module.params['description'] self.options = module.params['options'] self.mountpoint = module.params['mountpoint'] self.state = module.params['state'] self.force = module.params['force'] self.is_freebsd = os.uname()[0] == 'FreeBSD' def _beadm_list(self): cmd = [self.module.get_bin_path('beadm'), 'list', '-H'] if '@' in self.name: cmd.append('-s') return self.module.run_command(cmd) def _find_be_by_name(self, out): if '@' in self.name: for line in out.splitlines(): if self.is_freebsd: check = line.split() if check == []: continue full_name = check[0].split('/') if full_name == []: continue check[0] = full_name[len(full_name) - 1] if check[0] == self.name: return check else: check = line.split(';') if check[0] == self.name: return check else: for line in out.splitlines(): if self.is_freebsd: check = line.split() if check[0] == self.name: return check else: check = line.split(';') if check[0] == self.name: return check return None def exists(self): (rc, out, dummy) = self._beadm_list() if rc == 0: if self._find_be_by_name(out): return True else: return False else: return False def is_activated(self): (rc, out, dummy) = self._beadm_list() if rc == 0: line = self._find_be_by_name(out) if line is None: return False if self.is_freebsd: if 'R' in line[1]: return True else: if 'R' in line[2]: return True return False def activate_be(self): cmd = [self.module.get_bin_path('beadm'), 'activate', self.name] return self.module.run_command(cmd) def create_be(self): cmd = [self.module.get_bin_path('beadm'), 'create'] if self.snapshot: cmd.extend(['-e', self.snapshot]) if not self.is_freebsd: if self.description: cmd.extend(['-d', self.description]) if self.options: cmd.extend(['-o', self.options]) cmd.append(self.name) return self.module.run_command(cmd) def destroy_be(self): cmd = [self.module.get_bin_path('beadm'), 'destroy', '-F', self.name] return self.module.run_command(cmd) def is_mounted(self): (rc, out, dummy) = self._beadm_list() if rc == 0: line = self._find_be_by_name(out) if line is None: return False if self.is_freebsd: # On FreeBSD, we exclude currently mounted BE on /, as it is # special and can be activated even if it is mounted. That is not # possible with non-root BEs. if line[2] != '-' and line[2] != '/': return True else: if line[3]: return True return False def mount_be(self): cmd = [self.module.get_bin_path('beadm'), 'mount', self.name] if self.mountpoint: cmd.append(self.mountpoint) return self.module.run_command(cmd) def unmount_be(self): cmd = [self.module.get_bin_path('beadm'), 'unmount'] if self.force: cmd.append('-f') cmd.append(self.name) return self.module.run_command(cmd) def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True, aliases=['be']), snapshot=dict(type='str'), description=dict(type='str'), options=dict(type='str'), mountpoint=dict(type='path'), state=dict(type='str', default='present', choices=['absent', 'activated', 'mounted', 'present', 'unmounted']), force=dict(type='bool', default=False), ), supports_check_mode=True, ) be = BE(module) rc = None out = '' err = '' result = {} result['name'] = be.name result['state'] = be.state if be.snapshot: result['snapshot'] = be.snapshot if be.description: result['description'] = be.description if be.options: result['options'] = be.options if be.mountpoint: result['mountpoint'] = be.mountpoint if be.state == 'absent': # beadm on FreeBSD and Solarish systems differs in delete behaviour in # that we are not allowed to delete activated BE on FreeBSD while on # Solarish systems we cannot delete BE if it is mounted. We add mount # check for both platforms as BE should be explicitly unmounted before # being deleted. On FreeBSD, we also check if the BE is activated. if be.exists(): if not be.is_mounted(): if module.check_mode: module.exit_json(changed=True) if be.is_freebsd: if be.is_activated(): module.fail_json(msg='Unable to remove active BE!') (rc, out, err) = be.destroy_be() if rc != 0: module.fail_json(msg='Error while destroying BE: "%s"' % err, name=be.name, stderr=err, rc=rc) else: module.fail_json(msg='Unable to remove BE as it is mounted!') elif be.state == 'present': if not be.exists(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = be.create_be() if rc != 0: module.fail_json(msg='Error while creating BE: "%s"' % err, name=be.name, stderr=err, rc=rc) elif be.state == 'activated': if not be.is_activated(): if module.check_mode: module.exit_json(changed=True) # On FreeBSD, beadm is unable to activate mounted BEs, so we add # an explicit check for that case. if be.is_freebsd: if be.is_mounted(): module.fail_json(msg='Unable to activate mounted BE!') (rc, out, err) = be.activate_be() if rc != 0: module.fail_json(msg='Error while activating BE: "%s"' % err, name=be.name, stderr=err, rc=rc) elif be.state == 'mounted': if not be.is_mounted(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = be.mount_be() if rc != 0: module.fail_json(msg='Error while mounting BE: "%s"' % err, name=be.name, stderr=err, rc=rc) elif be.state == 'unmounted': if be.is_mounted(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = be.unmount_be() if rc != 0: module.fail_json(msg='Error while unmounting BE: "%s"' % err, name=be.name, stderr=err, rc=rc) if rc is None: result['changed'] = False else: result['changed'] = True if out: result['stdout'] = out if err: result['stderr'] = err module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�|�g�6 �6 L collections/ansible_collections/community/general/plugins/modules/cronvar.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # Cronvar Plugin: The goal of this plugin is to provide an idempotent # method for set cron variable values. It should play well with the # existing cron module as well as allow for manually added variables. # Each variable entered will be preceded with a comment describing the # variable so that it can be found later. This is required to be # present in order for this plugin to find/modify the variable # This module is based on the crontab module. from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: cronvar short_description: Manage variables in crontabs description: - Use this module to manage crontab variables. - This module allows you to create, update, or delete cron variable definitions. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - Name of the crontab variable. type: str required: true value: description: - The value to set this variable to. - Required if O(state=present). type: str insertafter: description: - If specified, the variable will be inserted after the variable specified. - Used with O(state=present). type: str insertbefore: description: - Used with O(state=present). If specified, the variable will be inserted just before the variable specified. type: str state: description: - Whether to ensure that the variable is present or absent. type: str choices: [ absent, present ] default: present user: description: - The specific user whose crontab should be modified. - This parameter defaults to V(root) when unset. type: str cron_file: description: - If specified, uses this file instead of an individual user's crontab. - Without a leading V(/), this is assumed to be in C(/etc/cron.d). - With a leading V(/), this is taken as absolute. type: str backup: description: - If set, create a backup of the crontab before it is modified. The location of the backup is returned in the C(backup) variable by this module. # TODO: C() above should be RV(), but return values have not been documented! type: bool default: false requirements: - cron author: - Doug Luce (@dougluce) ''' EXAMPLES = r''' - name: Ensure entry like "EMAIL=doug@ansibmod.con.com" exists community.general.cronvar: name: EMAIL value: doug@ansibmod.con.com - name: Ensure a variable does not exist. This may remove any variable named "LEGACY" community.general.cronvar: name: LEGACY state: absent - name: Add a variable to a file under /etc/cron.d community.general.cronvar: name: LOGFILE value: /var/log/yum-autoupdate.log user: root cron_file: ansible_yum-autoupdate ''' import os import platform import pwd import re import shlex import sys import tempfile from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves import shlex_quote class CronVarError(Exception): pass class CronVar(object): """ CronVar object to write variables to crontabs. user - the user of the crontab (defaults to root) cron_file - a cron file under /etc/cron.d """ def __init__(self, module, user=None, cron_file=None): self.module = module self.user = user self.lines = None self.wordchars = ''.join(chr(x) for x in range(128) if chr(x) not in ('=', "'", '"',)) self.cron_cmd = self.module.get_bin_path('crontab', required=True) if cron_file: self.cron_file = "" if os.path.isabs(cron_file): self.cron_file = cron_file else: self.cron_file = os.path.join('/etc/cron.d', cron_file) else: self.cron_file = None self.read() def read(self): # Read in the crontab from the system self.lines = [] if self.cron_file: # read the cronfile try: f = open(self.cron_file, 'r') self.lines = f.read().splitlines() f.close() except IOError: # cron file does not exist return except Exception: raise CronVarError("Unexpected error:", sys.exc_info()[0]) else: # using safely quoted shell for now, but this really should be two non-shell calls instead. FIXME (rc, out, err) = self.module.run_command(self._read_user_execute(), use_unsafe_shell=True) if rc != 0 and rc != 1: # 1 can mean that there are no jobs. raise CronVarError("Unable to read crontab") lines = out.splitlines() count = 0 for l in lines: if count > 2 or (not re.match(r'# DO NOT EDIT THIS FILE - edit the master and reinstall.', l ) and not re.match(r'# \(/tmp/.*installed on.*\)', l) and not re.match(r'# \(.*version.*\)', l)): self.lines.append(l) count += 1 def log_message(self, message): self.module.debug('ansible: "%s"' % message) def write(self, backup_file=None): """ Write the crontab to the system. Saves all information. """ if backup_file: fileh = open(backup_file, 'w') elif self.cron_file: fileh = open(self.cron_file, 'w') else: filed, path = tempfile.mkstemp(prefix='crontab') fileh = os.fdopen(filed, 'w') fileh.write(self.render()) fileh.close() # return if making a backup if backup_file: return # Add the entire crontab back to the user crontab if not self.cron_file: # quoting shell args for now but really this should be two non-shell calls. FIXME (rc, out, err) = self.module.run_command(self._write_execute(path), use_unsafe_shell=True) os.unlink(path) if rc != 0: self.module.fail_json(msg=err) def remove_variable_file(self): try: os.unlink(self.cron_file) return True except OSError: # cron file does not exist return False except Exception: raise CronVarError("Unexpected error:", sys.exc_info()[0]) def parse_for_var(self, line): lexer = shlex.shlex(line) lexer.wordchars = self.wordchars varname = lexer.get_token() is_env_var = lexer.get_token() == '=' value = ''.join(lexer) if is_env_var: return (varname, value) raise CronVarError("Not a variable.") def find_variable(self, name): for l in self.lines: try: (varname, value) = self.parse_for_var(l) if varname == name: return value except CronVarError: pass return None def get_var_names(self): var_names = [] for l in self.lines: try: var_name, dummy = self.parse_for_var(l) var_names.append(var_name) except CronVarError: pass return var_names def add_variable(self, name, value, insertbefore, insertafter): if insertbefore is None and insertafter is None: # Add the variable to the top of the file. self.lines.insert(0, "%s=%s" % (name, value)) else: newlines = [] for l in self.lines: try: varname, dummy = self.parse_for_var(l) # Throws if not a var line if varname == insertbefore: newlines.append("%s=%s" % (name, value)) newlines.append(l) elif varname == insertafter: newlines.append(l) newlines.append("%s=%s" % (name, value)) else: raise CronVarError # Append. except CronVarError: newlines.append(l) self.lines = newlines def remove_variable(self, name): self.update_variable(name, None, remove=True) def update_variable(self, name, value, remove=False): newlines = [] for l in self.lines: try: varname, dummy = self.parse_for_var(l) # Throws if not a var line if varname != name: raise CronVarError # Append. if not remove: newlines.append("%s=%s" % (name, value)) except CronVarError: newlines.append(l) self.lines = newlines def render(self): """ Render a proper crontab """ result = '\n'.join(self.lines) if result and result[-1] not in ['\n', '\r']: result += '\n' return result def _read_user_execute(self): """ Returns the command line for reading a crontab """ user = '' if self.user: if platform.system() == 'SunOS': return "su %s -c '%s -l'" % (shlex_quote(self.user), shlex_quote(self.cron_cmd)) elif platform.system() == 'AIX': return "%s -l %s" % (shlex_quote(self.cron_cmd), shlex_quote(self.user)) elif platform.system() == 'HP-UX': return "%s %s %s" % (self.cron_cmd, '-l', shlex_quote(self.user)) elif pwd.getpwuid(os.getuid())[0] != self.user: user = '-u %s' % shlex_quote(self.user) return "%s %s %s" % (self.cron_cmd, user, '-l') def _write_execute(self, path): """ Return the command line for writing a crontab """ user = '' if self.user: if platform.system() in ['SunOS', 'HP-UX', 'AIX']: return "chown %s %s ; su '%s' -c '%s %s'" % ( shlex_quote(self.user), shlex_quote(path), shlex_quote(self.user), self.cron_cmd, shlex_quote(path)) elif pwd.getpwuid(os.getuid())[0] != self.user: user = '-u %s' % shlex_quote(self.user) return "%s %s %s" % (self.cron_cmd, user, shlex_quote(path)) # ================================================== def main(): # The following example playbooks: # # - community.general.cronvar: name="SHELL" value="/bin/bash" # # - name: Set the email # community.general.cronvar: name="EMAILTO" value="doug@ansibmod.con.com" # # - name: Get rid of the old new host variable # community.general.cronvar: name="NEW_HOST" state=absent # # Would produce: # SHELL = /bin/bash # EMAILTO = doug@ansibmod.con.com module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True), value=dict(type='str'), user=dict(type='str'), cron_file=dict(type='str'), insertafter=dict(type='str'), insertbefore=dict(type='str'), state=dict(type='str', default='present', choices=['absent', 'present']), backup=dict(type='bool', default=False), ), mutually_exclusive=[['insertbefore', 'insertafter']], supports_check_mode=False, ) name = module.params['name'] value = module.params['value'] user = module.params['user'] cron_file = module.params['cron_file'] insertafter = module.params['insertafter'] insertbefore = module.params['insertbefore'] state = module.params['state'] backup = module.params['backup'] ensure_present = state == 'present' changed = False res_args = dict() # Ensure all files generated are only writable by the owning user. Primarily relevant for the cron_file option. os.umask(int('022', 8)) cronvar = CronVar(module, user, cron_file) module.debug('cronvar instantiated - name: "%s"' % name) # --- user input validation --- if name is None and ensure_present: module.fail_json(msg="You must specify 'name' to insert a new cron variable") if value is None and ensure_present: module.fail_json(msg="You must specify 'value' to insert a new cron variable") if name is None and not ensure_present: module.fail_json(msg="You must specify 'name' to remove a cron variable") # if requested make a backup before making a change if backup: dummy, backup_file = tempfile.mkstemp(prefix='cronvar') cronvar.write(backup_file) if cronvar.cron_file and not name and not ensure_present: changed = cronvar.remove_job_file() module.exit_json(changed=changed, cron_file=cron_file, state=state) old_value = cronvar.find_variable(name) if ensure_present: if old_value is None: cronvar.add_variable(name, value, insertbefore, insertafter) changed = True elif old_value != value: cronvar.update_variable(name, value) changed = True else: if old_value is not None: cronvar.remove_variable(name) changed = True res_args = { "vars": cronvar.get_var_names(), "changed": changed } if changed: cronvar.write() # retain the backup only if crontab or cron file have changed if backup: if changed: res_args['backup_file'] = backup_file else: os.unlink(backup_file) if cron_file: res_args['cron_file'] = cron_file module.exit_json(**res_args) if __name__ == '__main__': main() PK $�!\!,Kx�� �� K collections/ansible_collections/community/general/plugins/modules/one_vm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Milan Ilic <milani@nordeus.com> # Copyright (c) 2019, Jan Meerkamp <meerkamp@dvv.de> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # Make coding more python3-ish from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: one_vm short_description: Creates or terminates OpenNebula instances description: - Manages OpenNebula instances requirements: - pyone extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: api_url: description: - URL of the OpenNebula RPC server. - It is recommended to use HTTPS so that the username/password are not transferred over the network unencrypted. - If not set then the value of the E(ONE_URL) environment variable is used. type: str api_username: description: - Name of the user to login into the OpenNebula RPC server. If not set then the value of the E(ONE_USERNAME) environment variable is used. type: str api_password: description: - Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment variable is used. if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default path is "~/.one/one_auth". - Set environment variable E(ONE_AUTH) to override this path. type: str template_name: description: - Name of VM template to use to create a new instace type: str template_id: description: - ID of a VM template to use to create a new instance type: int vm_start_on_hold: description: - Set to true to put vm on hold while creating default: false type: bool instance_ids: description: - 'A list of instance ids used for states: V(absent), V(running), V(rebooted), V(poweredoff).' aliases: ['ids'] type: list elements: int state: description: - V(present) - create instances from a template specified with C(template_id)/C(template_name). - V(running) - run instances - V(poweredoff) - power-off instances - V(rebooted) - reboot instances - V(absent) - terminate instances choices: ["present", "absent", "running", "rebooted", "poweredoff"] default: present type: str hard: description: - Reboot, power-off or terminate instances C(hard). default: false type: bool wait: description: - Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to be in running state it doesn't mean that you will be able to SSH on that machine only that boot process have started on that instance, see 'wait_for' example for details. default: true type: bool wait_timeout: description: - How long before wait gives up, in seconds default: 300 type: int attributes: description: - A dictionary of key/value attributes to add to new instances, or for setting C(state) of instances with these attributes. - Keys are case insensitive and OpenNebula automatically converts them to upper case. - Be aware C(NAME) is a special attribute which sets the name of the VM when it's deployed. - C(#) character(s) can be appended to the C(NAME) and the module will automatically add indexes to the names of VMs. - For example':' C(NAME':' foo-###) would create VMs with names C(foo-000), C(foo-001),... - When used with O(count_attributes) and O(exact_count) the module will match the base name without the index part. default: {} type: dict labels: description: - A list of labels to associate with new instances, or for setting C(state) of instances with these labels. default: [] type: list elements: str count_attributes: description: - A dictionary of key/value attributes that can only be used with O(exact_count) to determine how many nodes based on a specific attributes criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section. type: dict count_labels: description: - A list of labels that can only be used with O(exact_count) to determine how many nodes based on a specific labels criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section. type: list elements: str count: description: - Number of instances to launch default: 1 type: int exact_count: description: - Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances are either created or terminated based on this value. - 'B(NOTE:) Instances with the least IDs will be terminated first.' type: int mode: description: - Set permission mode of the instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing to group and others. type: str owner_id: description: - ID of the user which will be set as the owner of the instance type: int group_id: description: - ID of the group which will be set as the group of the instance type: int memory: description: - The size of the memory for new instances (in MB, GB, ...) type: str disk_size: description: - The size of the disk created for new instances (in MB, GB, TB,...). - 'B(NOTE:) If The Template hats Multiple Disks the Order of the Sizes is matched against the order specified in O(template_id)/O(template_name).' type: list elements: str cpu: description: - Percentage of CPU divided by 100 required for the new instance. Half a processor is written 0.5. type: float vcpu: description: - Number of CPUs (cores) new VM will have. type: int networks: description: - A list of dictionaries with network parameters. See examples for more details. default: [] type: list elements: dict disk_saveas: description: - Creates an image from a VM disk. - It is a dictionary where you have to specify C(name) of the new image. - Optionally you can specify C(disk_id) of the disk you want to save. By default C(disk_id) is 0. - 'B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to be in the C(poweredoff) state.' - Also this operation will fail if an image with specified C(name) already exists. type: dict persistent: description: - Create a private persistent copy of the template plus any image defined in DISK, and instantiate that copy. default: false type: bool version_added: '0.2.0' datastore_id: description: - Name of Datastore to use to create a new instace version_added: '0.2.0' type: int datastore_name: description: - Name of Datastore to use to create a new instace version_added: '0.2.0' type: str updateconf: description: - When O(instance_ids) is provided, updates running VMs with the C(updateconf) API call. - When new VMs are being created, emulates the C(updateconf) API call via direct template merge. - Allows for complete modifications of the C(CONTEXT) attribute. type: dict version_added: 6.3.0 author: - "Milan Ilic (@ilicmilan)" - "Jan Meerkamp (@meerkampdvv)" ''' EXAMPLES = ''' - name: Create a new instance community.general.one_vm: template_id: 90 register: result - name: Print VM properties ansible.builtin.debug: msg: result - name: Deploy a new VM on hold community.general.one_vm: template_name: 'app1_template' vm_start_on_hold: 'True' - name: Deploy a new VM and set its name to 'foo' community.general.one_vm: template_name: 'app1_template' attributes: name: foo - name: Deploy a new VM and set its group_id and mode community.general.one_vm: template_id: 90 group_id: 16 mode: 660 - name: Deploy a new VM as persistent community.general.one_vm: template_id: 90 persistent: true - name: Change VM's permissions to 640 community.general.one_vm: instance_ids: 5 mode: 640 - name: Deploy 2 new instances and set memory, vcpu, disk_size and 3 networks community.general.one_vm: template_id: 15 disk_size: 35.2 GB memory: 4 GB vcpu: 4 count: 2 networks: - NETWORK_ID: 27 - NETWORK: "default-network" NETWORK_UNAME: "app-user" SECURITY_GROUPS: "120,124" - NETWORK_ID: 27 SECURITY_GROUPS: "10" - name: Deploy a new instance which uses a Template with two Disks community.general.one_vm: template_id: 42 disk_size: - 35.2 GB - 50 GB memory: 4 GB vcpu: 4 count: 1 networks: - NETWORK_ID: 27 - name: "Deploy an new instance with attribute 'bar: bar1' and set its name to 'foo'" community.general.one_vm: template_id: 53 attributes: name: foo bar: bar1 - name: "Enforce that 2 instances with attributes 'foo1: app1' and 'foo2: app2' are deployed" community.general.one_vm: template_id: 53 attributes: foo1: app1 foo2: app2 exact_count: 2 count_attributes: foo1: app1 foo2: app2 - name: Enforce that 4 instances with an attribute 'bar' are deployed community.general.one_vm: template_id: 53 attributes: name: app bar: bar2 exact_count: 4 count_attributes: bar: # Deploy 2 new instances with attribute 'foo: bar' and labels 'app1' and 'app2' and names in format 'fooapp-##' # Names will be: fooapp-00 and fooapp-01 - name: Deploy 2 new instances community.general.one_vm: template_id: 53 attributes: name: fooapp-## foo: bar labels: - app1 - app2 count: 2 # Deploy 2 new instances with attribute 'app: app1' and names in format 'fooapp-###' # Names will be: fooapp-002 and fooapp-003 - name: Deploy 2 new instances community.general.one_vm: template_id: 53 attributes: name: fooapp-### app: app1 count: 2 # Reboot all instances with name in format 'fooapp-#' # Instances 'fooapp-00', 'fooapp-01', 'fooapp-002' and 'fooapp-003' will be rebooted - name: Reboot all instances with names in a certain format community.general.one_vm: attributes: name: fooapp-# state: rebooted # Enforce that only 1 instance with name in format 'fooapp-#' is deployed # The task will delete oldest instances, so only the 'fooapp-003' will remain - name: Enforce that only 1 instance with name in a certain format is deployed community.general.one_vm: template_id: 53 exact_count: 1 count_attributes: name: fooapp-# - name: Deploy an new instance with a network community.general.one_vm: template_id: 53 networks: - NETWORK_ID: 27 register: vm - name: Wait for SSH to come up ansible.builtin.wait_for_connection: delegate_to: '{{ vm.instances[0].networks[0].ip }}' - name: Terminate VMs by ids community.general.one_vm: instance_ids: - 153 - 160 state: absent - name: Reboot all VMs that have labels 'foo' and 'app1' community.general.one_vm: labels: - foo - app1 state: rebooted - name: "Fetch all VMs that have name 'foo' and attribute 'app: bar'" community.general.one_vm: attributes: name: foo app: bar register: results - name: Deploy 2 new instances with labels 'foo1' and 'foo2' community.general.one_vm: template_name: app_template labels: - foo1 - foo2 count: 2 - name: Enforce that only 1 instance with label 'foo1' will be running community.general.one_vm: template_name: app_template labels: - foo1 exact_count: 1 count_labels: - foo1 - name: Terminate all instances that have attribute foo community.general.one_vm: template_id: 53 exact_count: 0 count_attributes: foo: - name: "Power-off the VM and save VM's disk with id=0 to the image with name 'foo-image'" community.general.one_vm: instance_ids: 351 state: poweredoff disk_saveas: name: foo-image - name: "Save VM's disk with id=1 to the image with name 'bar-image'" community.general.one_vm: instance_ids: 351 disk_saveas: name: bar-image disk_id: 1 - name: "Deploy 2 new instances with a custom 'start script'" community.general.one_vm: template_name: app_template count: 2 updateconf: CONTEXT: START_SCRIPT: ip r r 169.254.16.86/32 dev eth0 - name: "Add a custom 'start script' to a running VM" community.general.one_vm: instance_ids: 351 updateconf: CONTEXT: START_SCRIPT: ip r r 169.254.16.86/32 dev eth0 - name: "Update SSH public keys inside the VM's context" community.general.one_vm: instance_ids: 351 updateconf: CONTEXT: SSH_PUBLIC_KEY: |- ssh-rsa ... ssh-ed25519 ... ''' RETURN = ''' instances_ids: description: a list of instances ids whose state is changed or which are fetched with O(instance_ids) option. type: list returned: success sample: [ 1234, 1235 ] instances: description: a list of instances info whose state is changed or which are fetched with O(instance_ids) option. type: complex returned: success contains: vm_id: description: vm id type: int sample: 153 vm_name: description: vm name type: str sample: foo template_id: description: vm's template id type: int sample: 153 group_id: description: vm's group id type: int sample: 1 group_name: description: vm's group name type: str sample: one-users owner_id: description: vm's owner id type: int sample: 143 owner_name: description: vm's owner name type: str sample: app-user mode: description: vm's mode type: str returned: success sample: 660 state: description: state of an instance type: str sample: ACTIVE lcm_state: description: lcm state of an instance that is only relevant when the state is ACTIVE type: str sample: RUNNING cpu: description: Percentage of CPU divided by 100 type: float sample: 0.2 vcpu: description: Number of CPUs (cores) type: int sample: 2 memory: description: The size of the memory in MB type: str sample: 4096 MB disk_size: description: The size of the disk in MB type: str sample: 20480 MB networks: description: a list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC type: list sample: [ { "ip": "10.120.5.33", "mac": "02:00:0a:78:05:21", "name": "default-test-private", "security_groups": "0,10" }, { "ip": "10.120.5.34", "mac": "02:00:0a:78:05:22", "name": "default-test-private", "security_groups": "0" } ] uptime_h: description: Uptime of the instance in hours type: int sample: 35 labels: description: A list of string labels that are associated with the instance type: list sample: [ "foo", "spec-label" ] attributes: description: A dictionary of key/values attributes that are associated with the instance type: dict sample: { "HYPERVISOR": "kvm", "LOGO": "images/logos/centos.png", "TE_GALAXY": "bar", "USER_INPUTS": null } updateconf: description: A dictionary of key/values attributes that are set with the updateconf API call. type: dict version_added: 6.3.0 sample: { "OS": { "ARCH": "x86_64" }, "CONTEXT": { "START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0", "SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..." } } tagged_instances: description: - A list of instances info based on a specific attributes and/or - labels that are specified with O(count_attributes) and O(count_labels) - options. type: complex returned: success contains: vm_id: description: vm id type: int sample: 153 vm_name: description: vm name type: str sample: foo template_id: description: vm's template id type: int sample: 153 group_id: description: vm's group id type: int sample: 1 group_name: description: vm's group name type: str sample: one-users owner_id: description: vm's user id type: int sample: 143 owner_name: description: vm's user name type: str sample: app-user mode: description: vm's mode type: str returned: success sample: 660 state: description: state of an instance type: str sample: ACTIVE lcm_state: description: lcm state of an instance that is only relevant when the state is ACTIVE type: str sample: RUNNING cpu: description: Percentage of CPU divided by 100 type: float sample: 0.2 vcpu: description: Number of CPUs (cores) type: int sample: 2 memory: description: The size of the memory in MB type: str sample: 4096 MB disk_size: description: The size of the disk in MB type: list sample: [ "20480 MB", "10240 MB" ] networks: description: a list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC type: list sample: [ { "ip": "10.120.5.33", "mac": "02:00:0a:78:05:21", "name": "default-test-private", "security_groups": "0,10" }, { "ip": "10.120.5.34", "mac": "02:00:0a:78:05:22", "name": "default-test-private", "security_groups": "0" } ] uptime_h: description: Uptime of the instance in hours type: int sample: 35 labels: description: A list of string labels that are associated with the instance type: list sample: [ "foo", "spec-label" ] attributes: description: A dictionary of key/values attributes that are associated with the instance type: dict sample: { "HYPERVISOR": "kvm", "LOGO": "images/logos/centos.png", "TE_GALAXY": "bar", "USER_INPUTS": null } updateconf: description: A dictionary of key/values attributes that are set with the updateconf API call type: dict version_added: 6.3.0 sample: { "OS": { "ARCH": "x86_64" }, "CONTEXT": { "START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0", "SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..." } } ''' try: import pyone HAS_PYONE = True except ImportError: HAS_PYONE = False import os from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.dict_transformations import dict_merge from ansible_collections.community.general.plugins.module_utils.opennebula import flatten, render UPDATECONF_ATTRIBUTES = { "OS": ["ARCH", "MACHINE", "KERNEL", "INITRD", "BOOTLOADER", "BOOT", "SD_DISK_BUS", "UUID"], "FEATURES": ["ACPI", "PAE", "APIC", "LOCALTIME", "HYPERV", "GUEST_AGENT"], "INPUT": ["TYPE", "BUS"], "GRAPHICS": ["TYPE", "LISTEN", "PASSWD", "KEYMAP"], "RAW": ["DATA", "DATA_VMX", "TYPE"], "CONTEXT": [], } def check_updateconf(module, to_check): '''Checks if attributes are compatible with one.vm.updateconf API call.''' for attr, subattributes in to_check.items(): if attr not in UPDATECONF_ATTRIBUTES: module.fail_json(msg="'{0:}' is not a valid VM attribute.".format(attr)) if not UPDATECONF_ATTRIBUTES[attr]: continue for subattr in subattributes: if subattr not in UPDATECONF_ATTRIBUTES[attr]: module.fail_json(msg="'{0:}' is not a valid VM subattribute of '{1:}'".format(subattr, attr)) def parse_updateconf(vm_template): '''Extracts 'updateconf' attributes from a VM template.''' updateconf = {} for attr, subattributes in vm_template.items(): if attr not in UPDATECONF_ATTRIBUTES: continue tmp = {} for subattr, value in subattributes.items(): if UPDATECONF_ATTRIBUTES[attr] and subattr not in UPDATECONF_ATTRIBUTES[attr]: continue tmp[subattr] = value if tmp: updateconf[attr] = tmp return updateconf def get_template(module, client, predicate): pool = client.templatepool.info(-2, -1, -1, -1) # Filter -2 means fetch all templates user can Use found = 0 found_template = None template_name = '' for template in pool.VMTEMPLATE: if predicate(template): found = found + 1 found_template = template template_name = template.NAME if found == 0: return None elif found > 1: module.fail_json(msg='There are more templates with name: ' + template_name) return found_template def get_template_by_name(module, client, template_name): return get_template(module, client, lambda template: (template.NAME == template_name)) def get_template_by_id(module, client, template_id): return get_template(module, client, lambda template: (template.ID == template_id)) def get_template_id(module, client, requested_id, requested_name): template = get_template_by_id(module, client, requested_id) if requested_id is not None else get_template_by_name(module, client, requested_name) if template: return template.ID else: return None def get_datastore(module, client, predicate): pool = client.datastorepool.info() found = 0 found_datastore = None datastore_name = '' for datastore in pool.DATASTORE: if predicate(datastore): found = found + 1 found_datastore = datastore datastore_name = datastore.NAME if found == 0: return None elif found > 1: module.fail_json(msg='There are more datastores with name: ' + datastore_name) return found_datastore def get_datastore_by_name(module, client, datastore_name): return get_datastore(module, client, lambda datastore: (datastore.NAME == datastore_name)) def get_datastore_by_id(module, client, datastore_id): return get_datastore(module, client, lambda datastore: (datastore.ID == datastore_id)) def get_datastore_id(module, client, requested_id, requested_name): datastore = get_datastore_by_id(module, client, requested_id) if requested_id else get_datastore_by_name(module, client, requested_name) if datastore: return datastore.ID else: return None def get_vm_by_id(client, vm_id): try: vm = client.vm.info(int(vm_id)) except BaseException: return None return vm def get_vms_by_ids(module, client, state, ids): vms = [] for vm_id in ids: vm = get_vm_by_id(client, vm_id) if vm is None and state != 'absent': module.fail_json(msg='There is no VM with id=' + str(vm_id)) vms.append(vm) return vms def get_vm_info(client, vm): vm = client.vm.info(vm.ID) networks_info = [] disk_size = [] if 'DISK' in vm.TEMPLATE: if isinstance(vm.TEMPLATE['DISK'], list): for disk in vm.TEMPLATE['DISK']: disk_size.append(disk['SIZE'] + ' MB') else: disk_size.append(vm.TEMPLATE['DISK']['SIZE'] + ' MB') if 'NIC' in vm.TEMPLATE: if isinstance(vm.TEMPLATE['NIC'], list): for nic in vm.TEMPLATE['NIC']: networks_info.append({ 'ip': nic.get('IP', ''), 'mac': nic.get('MAC', ''), 'name': nic.get('NETWORK', ''), 'security_groups': nic.get('SECURITY_GROUPS', '') }) else: networks_info.append({ 'ip': vm.TEMPLATE['NIC'].get('IP', ''), 'mac': vm.TEMPLATE['NIC'].get('MAC', ''), 'name': vm.TEMPLATE['NIC'].get('NETWORK', ''), 'security_groups': vm.TEMPLATE['NIC'].get('SECURITY_GROUPS', '') }) import time current_time = time.localtime() vm_start_time = time.localtime(vm.STIME) vm_uptime = time.mktime(current_time) - time.mktime(vm_start_time) vm_uptime /= (60 * 60) permissions_str = parse_vm_permissions(client, vm) # LCM_STATE is VM's sub-state that is relevant only when STATE is ACTIVE vm_lcm_state = None if vm.STATE == VM_STATES.index('ACTIVE'): vm_lcm_state = LCM_STATES[vm.LCM_STATE] vm_labels, vm_attributes = get_vm_labels_and_attributes_dict(client, vm.ID) updateconf = parse_updateconf(vm.TEMPLATE) info = { 'template_id': int(vm.TEMPLATE['TEMPLATE_ID']), 'vm_id': vm.ID, 'vm_name': vm.NAME, 'state': VM_STATES[vm.STATE], 'lcm_state': vm_lcm_state, 'owner_name': vm.UNAME, 'owner_id': vm.UID, 'networks': networks_info, 'disk_size': disk_size, 'memory': vm.TEMPLATE['MEMORY'] + ' MB', 'vcpu': vm.TEMPLATE['VCPU'], 'cpu': vm.TEMPLATE['CPU'], 'group_name': vm.GNAME, 'group_id': vm.GID, 'uptime_h': int(vm_uptime), 'attributes': vm_attributes, 'mode': permissions_str, 'labels': vm_labels, 'updateconf': updateconf, } return info def parse_vm_permissions(client, vm): vm_PERMISSIONS = client.vm.info(vm.ID).PERMISSIONS owner_octal = int(vm_PERMISSIONS.OWNER_U) * 4 + int(vm_PERMISSIONS.OWNER_M) * 2 + int(vm_PERMISSIONS.OWNER_A) group_octal = int(vm_PERMISSIONS.GROUP_U) * 4 + int(vm_PERMISSIONS.GROUP_M) * 2 + int(vm_PERMISSIONS.GROUP_A) other_octal = int(vm_PERMISSIONS.OTHER_U) * 4 + int(vm_PERMISSIONS.OTHER_M) * 2 + int(vm_PERMISSIONS.OTHER_A) permissions = str(owner_octal) + str(group_octal) + str(other_octal) return permissions def set_vm_permissions(module, client, vms, permissions): changed = False for vm in vms: vm = client.vm.info(vm.ID) old_permissions = parse_vm_permissions(client, vm) changed = changed or old_permissions != permissions if not module.check_mode and old_permissions != permissions: permissions_str = bin(int(permissions, base=8))[2:] # 600 -> 110000000 mode_bits = [int(d) for d in permissions_str] try: client.vm.chmod( vm.ID, mode_bits[0], mode_bits[1], mode_bits[2], mode_bits[3], mode_bits[4], mode_bits[5], mode_bits[6], mode_bits[7], mode_bits[8]) except pyone.OneAuthorizationException: module.fail_json(msg="Permissions changing is unsuccessful, but instances are present if you deployed them.") return changed def set_vm_ownership(module, client, vms, owner_id, group_id): changed = False for vm in vms: vm = client.vm.info(vm.ID) if owner_id is None: owner_id = vm.UID if group_id is None: group_id = vm.GID changed = changed or owner_id != vm.UID or group_id != vm.GID if not module.check_mode and (owner_id != vm.UID or group_id != vm.GID): try: client.vm.chown(vm.ID, owner_id, group_id) except pyone.OneAuthorizationException: module.fail_json(msg="Ownership changing is unsuccessful, but instances are present if you deployed them.") return changed def update_vm(module, client, vm, updateconf_dict): changed = False if not updateconf_dict: return changed before = client.vm.info(vm.ID).TEMPLATE client.vm.updateconf(vm.ID, render(updateconf_dict), 1) # 1: Merge new template with the existing one. after = client.vm.info(vm.ID).TEMPLATE changed = before != after return changed def update_vms(module, client, vms, *args): changed = False for vm in vms: changed = update_vm(module, client, vm, *args) or changed return changed def get_size_in_MB(module, size_str): SYMBOLS = ['B', 'KB', 'MB', 'GB', 'TB'] s = size_str init = size_str num = "" while s and s[0:1].isdigit() or s[0:1] == '.': num += s[0] s = s[1:] num = float(num) symbol = s.strip() if symbol not in SYMBOLS: module.fail_json(msg="Cannot interpret %r %r %d" % (init, symbol, num)) prefix = {'B': 1} for i, s in enumerate(SYMBOLS[1:]): prefix[s] = 1 << (i + 1) * 10 size_in_bytes = int(num * prefix[symbol]) size_in_MB = size_in_bytes / (1024 * 1024) return size_in_MB def create_vm(module, client, template_id, attributes_dict, labels_list, disk_size, network_attrs_list, vm_start_on_hold, vm_persistent, updateconf_dict): if attributes_dict: vm_name = attributes_dict.get('NAME', '') template = client.template.info(template_id).TEMPLATE disk_count = len(flatten(template.get('DISK', []))) if disk_size: size_count = len(flatten(disk_size)) # check if the number of disks is correct if disk_count != size_count: module.fail_json(msg='This template has ' + str(disk_count) + ' disks but you defined ' + str(size_count)) vm_extra_template = dict_merge(template or {}, attributes_dict or {}) vm_extra_template = dict_merge(vm_extra_template, { 'LABELS': ','.join(labels_list), 'NIC': flatten(network_attrs_list, extract=True), 'DISK': flatten([ disk if not size else dict_merge(disk, { 'SIZE': str(int(get_size_in_MB(module, size))), }) for disk, size in zip( flatten(template.get('DISK', [])), flatten(disk_size or [None] * disk_count), ) if disk is not None ], extract=True) }) vm_extra_template = dict_merge(vm_extra_template, updateconf_dict or {}) try: vm_id = client.template.instantiate(template_id, vm_name, vm_start_on_hold, render(vm_extra_template), vm_persistent) except pyone.OneException as e: module.fail_json(msg=str(e)) vm = get_vm_by_id(client, vm_id) return get_vm_info(client, vm) def generate_next_index(vm_filled_indexes_list, num_sign_cnt): counter = 0 cnt_str = str(counter).zfill(num_sign_cnt) while cnt_str in vm_filled_indexes_list: counter = counter + 1 cnt_str = str(counter).zfill(num_sign_cnt) return cnt_str def get_vm_labels_and_attributes_dict(client, vm_id): vm_USER_TEMPLATE = client.vm.info(vm_id).USER_TEMPLATE attrs_dict = {} labels_list = [] for key, value in vm_USER_TEMPLATE.items(): if key != 'LABELS': attrs_dict[key] = value else: if key is not None and value is not None: labels_list = value.split(',') return labels_list, attrs_dict def get_all_vms_by_attributes(client, attributes_dict, labels_list): pool = client.vmpool.info(-2, -1, -1, -1).VM vm_list = [] name = '' if attributes_dict: name = attributes_dict.pop('NAME', '') if name != '': base_name = name[:len(name) - name.count('#')] # Check does the name have indexed format with_hash = name.endswith('#') for vm in pool: if vm.NAME.startswith(base_name): if with_hash and vm.NAME[len(base_name):].isdigit(): # If the name has indexed format and after base_name it has only digits it'll be matched vm_list.append(vm) elif not with_hash and vm.NAME == name: # If the name is not indexed it has to be same vm_list.append(vm) pool = vm_list import copy vm_list = copy.copy(pool) for vm in pool: remove_list = [] vm_labels_list, vm_attributes_dict = get_vm_labels_and_attributes_dict(client, vm.ID) if attributes_dict and len(attributes_dict) > 0: for key, val in attributes_dict.items(): if key in vm_attributes_dict: if val and vm_attributes_dict[key] != val: remove_list.append(vm) break else: remove_list.append(vm) break vm_list = list(set(vm_list).difference(set(remove_list))) remove_list = [] if labels_list and len(labels_list) > 0: for label in labels_list: if label not in vm_labels_list: remove_list.append(vm) break vm_list = list(set(vm_list).difference(set(remove_list))) return vm_list def create_count_of_vms(module, client, template_id, count, attributes_dict, labels_list, disk_size, network_attrs_list, wait, wait_timeout, vm_start_on_hold, vm_persistent, updateconf_dict): new_vms_list = [] vm_name = '' if attributes_dict: vm_name = attributes_dict.get('NAME', '') if module.check_mode: return True, [], [] # Create list of used indexes vm_filled_indexes_list = None num_sign_cnt = vm_name.count('#') if vm_name != '' and num_sign_cnt > 0: vm_list = get_all_vms_by_attributes(client, {'NAME': vm_name}, None) base_name = vm_name[:len(vm_name) - num_sign_cnt] vm_name = base_name # Make list which contains used indexes in format ['000', '001',...] vm_filled_indexes_list = list((vm.NAME[len(base_name):].zfill(num_sign_cnt)) for vm in vm_list) while count > 0: new_vm_name = vm_name # Create indexed name if vm_filled_indexes_list is not None: next_index = generate_next_index(vm_filled_indexes_list, num_sign_cnt) vm_filled_indexes_list.append(next_index) new_vm_name += next_index # Update NAME value in the attributes in case there is index attributes_dict['NAME'] = new_vm_name new_vm_dict = create_vm(module, client, template_id, attributes_dict, labels_list, disk_size, network_attrs_list, vm_start_on_hold, vm_persistent, updateconf_dict) new_vm_id = new_vm_dict.get('vm_id') new_vm = get_vm_by_id(client, new_vm_id) new_vms_list.append(new_vm) count -= 1 if vm_start_on_hold: if wait: for vm in new_vms_list: wait_for_hold(module, client, vm, wait_timeout) else: if wait: for vm in new_vms_list: wait_for_running(module, client, vm, wait_timeout) return True, new_vms_list, [] def create_exact_count_of_vms(module, client, template_id, exact_count, attributes_dict, count_attributes_dict, labels_list, count_labels_list, disk_size, network_attrs_list, hard, wait, wait_timeout, vm_start_on_hold, vm_persistent, updateconf_dict): vm_list = get_all_vms_by_attributes(client, count_attributes_dict, count_labels_list) vm_count_diff = exact_count - len(vm_list) changed = vm_count_diff != 0 new_vms_list = [] instances_list = [] tagged_instances_list = vm_list if module.check_mode: return changed, instances_list, tagged_instances_list if vm_count_diff > 0: # Add more VMs changed, instances_list, tagged_instances = create_count_of_vms(module, client, template_id, vm_count_diff, attributes_dict, labels_list, disk_size, network_attrs_list, wait, wait_timeout, vm_start_on_hold, vm_persistent, updateconf_dict) tagged_instances_list += instances_list elif vm_count_diff < 0: # Delete surplus VMs old_vms_list = [] while vm_count_diff < 0: old_vm = vm_list.pop(0) old_vms_list.append(old_vm) terminate_vm(module, client, old_vm, hard) vm_count_diff += 1 if wait: for vm in old_vms_list: wait_for_done(module, client, vm, wait_timeout) instances_list = old_vms_list # store only the remaining instances old_vms_set = set(old_vms_list) tagged_instances_list = [vm for vm in vm_list if vm not in old_vms_set] return changed, instances_list, tagged_instances_list VM_STATES = ['INIT', 'PENDING', 'HOLD', 'ACTIVE', 'STOPPED', 'SUSPENDED', 'DONE', '', 'POWEROFF', 'UNDEPLOYED', 'CLONING', 'CLONING_FAILURE'] LCM_STATES = ['LCM_INIT', 'PROLOG', 'BOOT', 'RUNNING', 'MIGRATE', 'SAVE_STOP', 'SAVE_SUSPEND', 'SAVE_MIGRATE', 'PROLOG_MIGRATE', 'PROLOG_RESUME', 'EPILOG_STOP', 'EPILOG', 'SHUTDOWN', 'STATE13', 'STATE14', 'CLEANUP_RESUBMIT', 'UNKNOWN', 'HOTPLUG', 'SHUTDOWN_POWEROFF', 'BOOT_UNKNOWN', 'BOOT_POWEROFF', 'BOOT_SUSPENDED', 'BOOT_STOPPED', 'CLEANUP_DELETE', 'HOTPLUG_SNAPSHOT', 'HOTPLUG_NIC', 'HOTPLUG_SAVEAS', 'HOTPLUG_SAVEAS_POWEROFF', 'HOTPULG_SAVEAS_SUSPENDED', 'SHUTDOWN_UNDEPLOY'] def wait_for_state(module, client, vm, wait_timeout, state_predicate): import time start_time = time.time() while (time.time() - start_time) < wait_timeout: vm = client.vm.info(vm.ID) state = vm.STATE lcm_state = vm.LCM_STATE if state_predicate(state, lcm_state): return vm elif state not in [VM_STATES.index('INIT'), VM_STATES.index('PENDING'), VM_STATES.index('HOLD'), VM_STATES.index('ACTIVE'), VM_STATES.index('CLONING'), VM_STATES.index('POWEROFF')]: module.fail_json(msg='Action is unsuccessful. VM state: ' + VM_STATES[state]) time.sleep(1) module.fail_json(msg="Wait timeout has expired!") def wait_for_running(module, client, vm, wait_timeout): return wait_for_state(module, client, vm, wait_timeout, lambda state, lcm_state: (state in [VM_STATES.index('ACTIVE')] and lcm_state in [LCM_STATES.index('RUNNING')])) def wait_for_done(module, client, vm, wait_timeout): return wait_for_state(module, client, vm, wait_timeout, lambda state, lcm_state: (state in [VM_STATES.index('DONE')])) def wait_for_hold(module, client, vm, wait_timeout): return wait_for_state(module, client, vm, wait_timeout, lambda state, lcm_state: (state in [VM_STATES.index('HOLD')])) def wait_for_poweroff(module, client, vm, wait_timeout): return wait_for_state(module, client, vm, wait_timeout, lambda state, lcm_state: (state in [VM_STATES.index('POWEROFF')])) def terminate_vm(module, client, vm, hard=False): changed = False if not vm: return changed changed = True if not module.check_mode: if hard: client.vm.action('terminate-hard', vm.ID) else: client.vm.action('terminate', vm.ID) return changed def terminate_vms(module, client, vms, hard): changed = False for vm in vms: changed = terminate_vm(module, client, vm, hard) or changed return changed def poweroff_vm(module, client, vm, hard): vm = client.vm.info(vm.ID) changed = False lcm_state = vm.LCM_STATE state = vm.STATE if lcm_state not in [LCM_STATES.index('SHUTDOWN'), LCM_STATES.index('SHUTDOWN_POWEROFF')] and state not in [VM_STATES.index('POWEROFF')]: changed = True if changed and not module.check_mode: if not hard: client.vm.action('poweroff', vm.ID) else: client.vm.action('poweroff-hard', vm.ID) return changed def poweroff_vms(module, client, vms, hard): changed = False for vm in vms: changed = poweroff_vm(module, client, vm, hard) or changed return changed def reboot_vms(module, client, vms, wait_timeout, hard): if not module.check_mode: # Firstly, power-off all instances for vm in vms: vm = client.vm.info(vm.ID) lcm_state = vm.LCM_STATE state = vm.STATE if lcm_state not in [LCM_STATES.index('SHUTDOWN_POWEROFF')] and state not in [VM_STATES.index('POWEROFF')]: poweroff_vm(module, client, vm, hard) # Wait for all to be power-off for vm in vms: wait_for_poweroff(module, client, vm, wait_timeout) for vm in vms: resume_vm(module, client, vm) return True def resume_vm(module, client, vm): vm = client.vm.info(vm.ID) changed = False state = vm.STATE if state in [VM_STATES.index('HOLD')]: changed = release_vm(module, client, vm) return changed lcm_state = vm.LCM_STATE if lcm_state == LCM_STATES.index('SHUTDOWN_POWEROFF'): module.fail_json(msg="Cannot perform action 'resume' because this action is not available " + "for LCM_STATE: 'SHUTDOWN_POWEROFF'. Wait for the VM to shutdown properly") if lcm_state not in [LCM_STATES.index('RUNNING')]: changed = True if changed and not module.check_mode: client.vm.action('resume', vm.ID) return changed def resume_vms(module, client, vms): changed = False for vm in vms: changed = resume_vm(module, client, vm) or changed return changed def release_vm(module, client, vm): vm = client.vm.info(vm.ID) changed = False state = vm.STATE if state != VM_STATES.index('HOLD'): module.fail_json(msg="Cannot perform action 'release' because this action is not available " + "because VM is not in state 'HOLD'.") else: changed = True if changed and not module.check_mode: client.vm.action('release', vm.ID) return changed def check_name_attribute(module, attributes): if attributes.get("NAME"): import re if re.match(r'^[^#]+#*$', attributes.get("NAME")) is None: module.fail_json(msg="Ilegal 'NAME' attribute: '" + attributes.get("NAME") + "' .Signs '#' are allowed only at the end of the name and the name cannot contain only '#'.") TEMPLATE_RESTRICTED_ATTRIBUTES = ["CPU", "VCPU", "OS", "FEATURES", "MEMORY", "DISK", "NIC", "INPUT", "GRAPHICS", "CONTEXT", "CREATED_BY", "CPU_COST", "DISK_COST", "MEMORY_COST", "TEMPLATE_ID", "VMID", "AUTOMATIC_DS_REQUIREMENTS", "DEPLOY_FOLDER", "LABELS"] def check_attributes(module, attributes): for key in attributes.keys(): if key in TEMPLATE_RESTRICTED_ATTRIBUTES: module.fail_json(msg='Restricted attribute `' + key + '` cannot be used when filtering VMs.') # Check the format of the name attribute check_name_attribute(module, attributes) def disk_save_as(module, client, vm, disk_saveas, wait_timeout): if not disk_saveas.get('name'): module.fail_json(msg="Key 'name' is required for 'disk_saveas' option") image_name = disk_saveas.get('name') disk_id = disk_saveas.get('disk_id', 0) if not module.check_mode: if vm.STATE != VM_STATES.index('POWEROFF'): module.fail_json(msg="'disksaveas' option can be used only when the VM is in 'POWEROFF' state") try: client.vm.disksaveas(vm.ID, disk_id, image_name, 'OS', -1) except pyone.OneException as e: module.fail_json(msg=str(e)) wait_for_poweroff(module, client, vm, wait_timeout) # wait for VM to leave the hotplug_saveas_poweroff state def get_connection_info(module): url = module.params.get('api_url') username = module.params.get('api_username') password = module.params.get('api_password') if not url: url = os.environ.get('ONE_URL') if not username: username = os.environ.get('ONE_USERNAME') if not password: password = os.environ.get('ONE_PASSWORD') if not username: if not password: authfile = os.environ.get('ONE_AUTH') if authfile is None: authfile = os.path.join(os.environ.get("HOME"), ".one", "one_auth") try: with open(authfile, "r") as fp: authstring = fp.read().rstrip() username = authstring.split(":")[0] password = authstring.split(":")[1] except (OSError, IOError): module.fail_json(msg=("Could not find or read ONE_AUTH file at '%s'" % authfile)) except Exception: module.fail_json(msg=("Error occurs when read ONE_AUTH file at '%s'" % authfile)) if not url: module.fail_json(msg="Opennebula API url (api_url) is not specified") from collections import namedtuple auth_params = namedtuple('auth', ('url', 'username', 'password')) return auth_params(url=url, username=username, password=password) def main(): fields = { "api_url": {"required": False, "type": "str"}, "api_username": {"required": False, "type": "str"}, "api_password": {"required": False, "type": "str", "no_log": True}, "instance_ids": {"required": False, "aliases": ['ids'], "type": "list", "elements": "int"}, "template_name": {"required": False, "type": "str"}, "template_id": {"required": False, "type": "int"}, "vm_start_on_hold": {"default": False, "type": "bool"}, "state": { "default": "present", "choices": ['present', 'absent', 'rebooted', 'poweredoff', 'running'], "type": "str" }, "mode": {"required": False, "type": "str"}, "owner_id": {"required": False, "type": "int"}, "group_id": {"required": False, "type": "int"}, "wait": {"default": True, "type": "bool"}, "wait_timeout": {"default": 300, "type": "int"}, "hard": {"default": False, "type": "bool"}, "memory": {"required": False, "type": "str"}, "cpu": {"required": False, "type": "float"}, "vcpu": {"required": False, "type": "int"}, "disk_size": {"required": False, "type": "list", "elements": "str"}, "datastore_name": {"required": False, "type": "str"}, "datastore_id": {"required": False, "type": "int"}, "networks": {"default": [], "type": "list", "elements": "dict"}, "count": {"default": 1, "type": "int"}, "exact_count": {"required": False, "type": "int"}, "attributes": {"default": {}, "type": "dict"}, "count_attributes": {"required": False, "type": "dict"}, "labels": {"default": [], "type": "list", "elements": "str"}, "count_labels": {"required": False, "type": "list", "elements": "str"}, "disk_saveas": {"type": "dict"}, "persistent": {"default": False, "type": "bool"}, "updateconf": {"type": "dict"}, } module = AnsibleModule(argument_spec=fields, mutually_exclusive=[ ['template_id', 'template_name', 'instance_ids'], ['template_id', 'template_name', 'disk_saveas'], ['instance_ids', 'count_attributes', 'count'], ['instance_ids', 'count_labels', 'count'], ['instance_ids', 'exact_count'], ['instance_ids', 'attributes'], ['instance_ids', 'labels'], ['disk_saveas', 'attributes'], ['disk_saveas', 'labels'], ['exact_count', 'count'], ['count', 'hard'], ['instance_ids', 'cpu'], ['instance_ids', 'vcpu'], ['instance_ids', 'memory'], ['instance_ids', 'disk_size'], ['instance_ids', 'networks'], ['persistent', 'disk_size'] ], supports_check_mode=True) if not HAS_PYONE: module.fail_json(msg='This module requires pyone to work!') auth = get_connection_info(module) params = module.params instance_ids = params.get('instance_ids') requested_template_name = params.get('template_name') requested_template_id = params.get('template_id') put_vm_on_hold = params.get('vm_start_on_hold') state = params.get('state') permissions = params.get('mode') owner_id = params.get('owner_id') group_id = params.get('group_id') wait = params.get('wait') wait_timeout = params.get('wait_timeout') hard = params.get('hard') memory = params.get('memory') cpu = params.get('cpu') vcpu = params.get('vcpu') disk_size = params.get('disk_size') requested_datastore_id = params.get('datastore_id') requested_datastore_name = params.get('datastore_name') networks = params.get('networks') count = params.get('count') exact_count = params.get('exact_count') attributes = params.get('attributes') count_attributes = params.get('count_attributes') labels = params.get('labels') count_labels = params.get('count_labels') disk_saveas = params.get('disk_saveas') persistent = params.get('persistent') updateconf = params.get('updateconf') if not (auth.username and auth.password): module.warn("Credentials missing") else: one_client = pyone.OneServer(auth.url, session=auth.username + ':' + auth.password) if attributes: attributes = dict((key.upper(), value) for key, value in attributes.items()) check_attributes(module, attributes) if count_attributes: count_attributes = dict((key.upper(), value) for key, value in count_attributes.items()) if not attributes: import copy module.warn('When you pass `count_attributes` without `attributes` option when deploying, `attributes` option will have same values implicitly.') attributes = copy.copy(count_attributes) check_attributes(module, count_attributes) if updateconf: check_updateconf(module, updateconf) if count_labels and not labels: module.warn('When you pass `count_labels` without `labels` option when deploying, `labels` option will have same values implicitly.') labels = count_labels # Fetch template template_id = None if requested_template_id is not None or requested_template_name: template_id = get_template_id(module, one_client, requested_template_id, requested_template_name) if template_id is None: if requested_template_id is not None: module.fail_json(msg='There is no template with template_id: ' + str(requested_template_id)) elif requested_template_name: module.fail_json(msg="There is no template with name: " + requested_template_name) # Fetch datastore datastore_id = None if requested_datastore_id or requested_datastore_name: datastore_id = get_datastore_id(module, one_client, requested_datastore_id, requested_datastore_name) if datastore_id is None: if requested_datastore_id: module.fail_json(msg='There is no datastore with datastore_id: ' + str(requested_datastore_id)) elif requested_datastore_name: module.fail_json(msg="There is no datastore with name: " + requested_datastore_name) else: attributes['SCHED_DS_REQUIREMENTS'] = 'ID=' + str(datastore_id) if exact_count and template_id is None: module.fail_json(msg='Option `exact_count` needs template_id or template_name') if exact_count is not None and not (count_attributes or count_labels): module.fail_json(msg='Either `count_attributes` or `count_labels` has to be specified with option `exact_count`.') if (count_attributes or count_labels) and exact_count is None: module.fail_json(msg='Option `exact_count` has to be specified when either `count_attributes` or `count_labels` is used.') if template_id is not None and state != 'present': module.fail_json(msg="Only state 'present' is valid for the template") if memory: attributes['MEMORY'] = str(int(get_size_in_MB(module, memory))) if cpu: attributes['CPU'] = str(cpu) if vcpu: attributes['VCPU'] = str(vcpu) if exact_count is not None and state != 'present': module.fail_json(msg='The `exact_count` option is valid only for the `present` state') if exact_count is not None and exact_count < 0: module.fail_json(msg='`exact_count` cannot be less than 0') if count <= 0: module.fail_json(msg='`count` has to be greater than 0') if permissions is not None: import re if re.match("^[0-7]{3}$", permissions) is None: module.fail_json(msg="Option `mode` has to have exactly 3 digits and be in the octet format e.g. 600") if exact_count is not None: # Deploy an exact count of VMs changed, instances_list, tagged_instances_list = create_exact_count_of_vms(module, one_client, template_id, exact_count, attributes, count_attributes, labels, count_labels, disk_size, networks, hard, wait, wait_timeout, put_vm_on_hold, persistent, updateconf) vms = tagged_instances_list elif template_id is not None and state == 'present': # Deploy count VMs changed, instances_list, tagged_instances_list = create_count_of_vms(module, one_client, template_id, count, attributes, labels, disk_size, networks, wait, wait_timeout, put_vm_on_hold, persistent, updateconf) # instances_list - new instances # tagged_instances_list - all instances with specified `count_attributes` and `count_labels` vms = instances_list else: # Fetch data of instances, or change their state if not (instance_ids or attributes or labels): module.fail_json(msg="At least one of `instance_ids`,`attributes`,`labels` must be passed!") if memory or cpu or vcpu or disk_size or networks: module.fail_json(msg="Parameters as `memory`, `cpu`, `vcpu`, `disk_size` and `networks` you can only set when deploying a VM!") if hard and state not in ['rebooted', 'poweredoff', 'absent', 'present']: module.fail_json(msg="The 'hard' option can be used only for one of these states: 'rebooted', 'poweredoff', 'absent' and 'present'") vms = [] tagged = False changed = False if instance_ids: vms = get_vms_by_ids(module, one_client, state, instance_ids) else: tagged = True vms = get_all_vms_by_attributes(one_client, attributes, labels) if len(vms) == 0 and state != 'absent' and state != 'present': module.fail_json(msg='There are no instances with specified `instance_ids`, `attributes` and/or `labels`') if len(vms) == 0 and state == 'present' and not tagged: module.fail_json(msg='There are no instances with specified `instance_ids`.') if tagged and state == 'absent': module.fail_json(msg='Option `instance_ids` is required when state is `absent`.') if state == 'absent': changed = terminate_vms(module, one_client, vms, hard) elif state == 'rebooted': changed = reboot_vms(module, one_client, vms, wait_timeout, hard) elif state == 'poweredoff': changed = poweroff_vms(module, one_client, vms, hard) elif state == 'running': changed = resume_vms(module, one_client, vms) instances_list = vms tagged_instances_list = [] if permissions is not None: changed = set_vm_permissions(module, one_client, vms, permissions) or changed if owner_id is not None or group_id is not None: changed = set_vm_ownership(module, one_client, vms, owner_id, group_id) or changed if template_id is None and updateconf is not None: changed = update_vms(module, one_client, vms, updateconf) or changed if wait and not module.check_mode and state != 'present': wait_for = { 'absent': wait_for_done, 'rebooted': wait_for_running, 'poweredoff': wait_for_poweroff, 'running': wait_for_running } for vm in vms: if vm is not None: wait_for[state](module, one_client, vm, wait_timeout) if disk_saveas is not None: if len(vms) == 0: module.fail_json(msg="There is no VM whose disk will be saved.") disk_save_as(module, one_client, vms[0], disk_saveas, wait_timeout) changed = True # instances - a list of instances info whose state is changed or which are fetched with C(instance_ids) option instances = list(get_vm_info(one_client, vm) for vm in instances_list if vm is not None) instances_ids = list(vm.ID for vm in instances_list if vm is not None) # tagged_instances - A list of instances info based on a specific attributes and/or labels that are specified with C(count_attributes) and C(count_labels) tagged_instances = list(get_vm_info(one_client, vm) for vm in tagged_instances_list if vm is not None) result = {'changed': changed, 'instances': instances, 'instances_ids': instances_ids, 'tagged_instances': tagged_instances} module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�"$�ff ff N collections/ansible_collections/community/general/plugins/modules/pulp_repo.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Joe Adams <@sysadmind> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: pulp_repo author: "Joe Adams (@sysadmind)" short_description: Add or remove Pulp repos from a remote host description: - Add or remove Pulp repos from a remote host. - Note, this is for Pulp 2 only. attributes: check_mode: support: full diff_mode: support: none options: add_export_distributor: description: - Whether or not to add the export distributor to new C(rpm) repositories. type: bool default: false feed: description: - Upstream feed URL to receive updates from. type: str force_basic_auth: description: - httplib2, the library used by the M(ansible.builtin.uri) module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request. type: bool default: false generate_sqlite: description: - Boolean flag to indicate whether sqlite files should be generated during a repository publish. required: false type: bool default: false feed_ca_cert: description: - CA certificate string used to validate the feed source SSL certificate. This can be the file content or the path to the file. type: str aliases: [ importer_ssl_ca_cert ] feed_client_cert: description: - Certificate used as the client certificate when synchronizing the repository. This is used to communicate authentication information to the feed source. The value to this option must be the full path to the certificate. The specified file may be the certificate itself or a single file containing both the certificate and private key. This can be the file content or the path to the file. type: str aliases: [ importer_ssl_client_cert ] feed_client_key: description: - Private key to the certificate specified in O(feed_client_cert), assuming it is not included in the certificate file itself. This can be the file content or the path to the file. type: str aliases: [ importer_ssl_client_key ] name: description: - Name of the repo to add or remove. This correlates to repo-id in Pulp. required: true type: str aliases: [ repo ] proxy_host: description: - Proxy url setting for the pulp repository importer. This is in the format scheme://host. required: false default: null type: str proxy_port: description: - Proxy port setting for the pulp repository importer. required: false default: null type: str proxy_username: description: - Proxy username for the pulp repository importer. required: false default: null type: str proxy_password: description: - Proxy password for the pulp repository importer. required: false default: null type: str publish_distributor: description: - Distributor to use when O(state=publish). The default is to publish all distributors. type: str pulp_host: description: - URL of the pulp server to connect to. default: https://127.0.0.1 type: str relative_url: description: - Relative URL for the local repository. It's required when state=present. type: str repo_type: description: - Repo plugin type to use (that is, V(rpm), V(docker)). default: rpm type: str repoview: description: - Whether to generate repoview files for a published repository. Setting this to V(true) automatically activates O(generate_sqlite). required: false type: bool default: false serve_http: description: - Make the repo available over HTTP. type: bool default: false serve_https: description: - Make the repo available over HTTPS. type: bool default: true state: description: - The repo state. A state of V(sync) will queue a sync of the repo. This is asynchronous but not delayed like a scheduled sync. A state of V(publish) will use the repository's distributor to publish the content. default: present choices: [ "present", "absent", "sync", "publish" ] type: str url_password: description: - The password for use in HTTP basic authentication to the pulp API. If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used. url_username: description: - The username for use in HTTP basic authentication to the pulp API. validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true wait_for_completion: description: - Wait for asynchronous tasks to complete before returning. type: bool default: false notes: - This module can currently only create distributors and importers on rpm repositories. Contributions to support other repo types are welcome. extends_documentation_fragment: - ansible.builtin.url - community.general.attributes ''' EXAMPLES = ''' - name: Create a new repo with name 'my_repo' community.general.pulp_repo: name: my_repo relative_url: my/repo state: present - name: Create a repo with a feed and a relative URL community.general.pulp_repo: name: my_centos_updates repo_type: rpm feed: http://mirror.centos.org/centos/6/updates/x86_64/ relative_url: centos/6/updates url_username: admin url_password: admin force_basic_auth: true state: present - name: Remove a repo from the pulp server community.general.pulp_repo: name: my_old_repo repo_type: rpm state: absent ''' RETURN = ''' repo: description: Name of the repo that the action was performed on. returned: success type: str sample: my_repo ''' import json import os from time import sleep # import module snippets from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url from ansible.module_utils.urls import url_argument_spec class pulp_server(object): """ Class to interact with a Pulp server """ def __init__(self, module, pulp_host, repo_type, wait_for_completion=False): self.module = module self.host = pulp_host self.repo_type = repo_type self.repo_cache = dict() self.wait_for_completion = wait_for_completion def check_repo_exists(self, repo_id): try: self.get_repo_config_by_id(repo_id) except IndexError: return False else: return True def compare_repo_distributor_config(self, repo_id, **kwargs): repo_config = self.get_repo_config_by_id(repo_id) for distributor in repo_config['distributors']: for key, value in kwargs.items(): if key not in distributor['config'].keys(): return False if not distributor['config'][key] == value: return False return True def compare_repo_importer_config(self, repo_id, **kwargs): repo_config = self.get_repo_config_by_id(repo_id) for importer in repo_config['importers']: for key, value in kwargs.items(): if value is not None: if key not in importer['config'].keys(): return False if not importer['config'][key] == value: return False return True def create_repo( self, repo_id, relative_url, feed=None, generate_sqlite=False, serve_http=False, serve_https=True, proxy_host=None, proxy_port=None, proxy_username=None, proxy_password=None, repoview=False, ssl_ca_cert=None, ssl_client_cert=None, ssl_client_key=None, add_export_distributor=False ): url = "%s/pulp/api/v2/repositories/" % self.host data = dict() data['id'] = repo_id data['distributors'] = [] if self.repo_type == 'rpm': yum_distributor = dict() yum_distributor['distributor_id'] = "yum_distributor" yum_distributor['distributor_type_id'] = "yum_distributor" yum_distributor['auto_publish'] = True yum_distributor['distributor_config'] = dict() yum_distributor['distributor_config']['http'] = serve_http yum_distributor['distributor_config']['https'] = serve_https yum_distributor['distributor_config']['relative_url'] = relative_url yum_distributor['distributor_config']['repoview'] = repoview yum_distributor['distributor_config']['generate_sqlite'] = generate_sqlite or repoview data['distributors'].append(yum_distributor) if add_export_distributor: export_distributor = dict() export_distributor['distributor_id'] = "export_distributor" export_distributor['distributor_type_id'] = "export_distributor" export_distributor['auto_publish'] = False export_distributor['distributor_config'] = dict() export_distributor['distributor_config']['http'] = serve_http export_distributor['distributor_config']['https'] = serve_https export_distributor['distributor_config']['relative_url'] = relative_url export_distributor['distributor_config']['repoview'] = repoview export_distributor['distributor_config']['generate_sqlite'] = generate_sqlite or repoview data['distributors'].append(export_distributor) data['importer_type_id'] = "yum_importer" data['importer_config'] = dict() if feed: data['importer_config']['feed'] = feed if proxy_host: data['importer_config']['proxy_host'] = proxy_host if proxy_port: data['importer_config']['proxy_port'] = proxy_port if proxy_username: data['importer_config']['proxy_username'] = proxy_username if proxy_password: data['importer_config']['proxy_password'] = proxy_password if ssl_ca_cert: data['importer_config']['ssl_ca_cert'] = ssl_ca_cert if ssl_client_cert: data['importer_config']['ssl_client_cert'] = ssl_client_cert if ssl_client_key: data['importer_config']['ssl_client_key'] = ssl_client_key data['notes'] = { "_repo-type": "rpm-repo" } response, info = fetch_url( self.module, url, data=json.dumps(data), method='POST') if info['status'] != 201: self.module.fail_json( msg="Failed to create repo.", status_code=info['status'], response=info['msg'], url=url) else: return True def delete_repo(self, repo_id): url = "%s/pulp/api/v2/repositories/%s/" % (self.host, repo_id) response, info = fetch_url(self.module, url, data='', method='DELETE') if info['status'] != 202: self.module.fail_json( msg="Failed to delete repo.", status_code=info['status'], response=info['msg'], url=url) if self.wait_for_completion: self.verify_tasks_completed(json.load(response)) return True def get_repo_config_by_id(self, repo_id): if repo_id not in self.repo_cache.keys(): repo_array = [x for x in self.repo_list if x['id'] == repo_id] self.repo_cache[repo_id] = repo_array[0] return self.repo_cache[repo_id] def publish_repo(self, repo_id, publish_distributor): url = "%s/pulp/api/v2/repositories/%s/actions/publish/" % (self.host, repo_id) # If there's no distributor specified, we will publish them all if publish_distributor is None: repo_config = self.get_repo_config_by_id(repo_id) for distributor in repo_config['distributors']: data = dict() data['id'] = distributor['id'] response, info = fetch_url( self.module, url, data=json.dumps(data), method='POST') if info['status'] != 202: self.module.fail_json( msg="Failed to publish the repo.", status_code=info['status'], response=info['msg'], url=url, distributor=distributor['id']) else: data = dict() data['id'] = publish_distributor response, info = fetch_url( self.module, url, data=json.dumps(data), method='POST') if info['status'] != 202: self.module.fail_json( msg="Failed to publish the repo", status_code=info['status'], response=info['msg'], url=url, distributor=publish_distributor) if self.wait_for_completion: self.verify_tasks_completed(json.load(response)) return True def sync_repo(self, repo_id): url = "%s/pulp/api/v2/repositories/%s/actions/sync/" % (self.host, repo_id) response, info = fetch_url(self.module, url, data='', method='POST') if info['status'] != 202: self.module.fail_json( msg="Failed to schedule a sync of the repo.", status_code=info['status'], response=info['msg'], url=url) if self.wait_for_completion: self.verify_tasks_completed(json.load(response)) return True def update_repo_distributor_config(self, repo_id, **kwargs): url = "%s/pulp/api/v2/repositories/%s/distributors/" % (self.host, repo_id) repo_config = self.get_repo_config_by_id(repo_id) for distributor in repo_config['distributors']: distributor_url = "%s%s/" % (url, distributor['id']) data = dict() data['distributor_config'] = dict() for key, value in kwargs.items(): data['distributor_config'][key] = value response, info = fetch_url( self.module, distributor_url, data=json.dumps(data), method='PUT') if info['status'] != 202: self.module.fail_json( msg="Failed to set the relative url for the repository.", status_code=info['status'], response=info['msg'], url=url) def update_repo_importer_config(self, repo_id, **kwargs): url = "%s/pulp/api/v2/repositories/%s/importers/" % (self.host, repo_id) data = dict() importer_config = dict() for key, value in kwargs.items(): if value is not None: importer_config[key] = value data['importer_config'] = importer_config if self.repo_type == 'rpm': data['importer_type_id'] = "yum_importer" response, info = fetch_url( self.module, url, data=json.dumps(data), method='POST') if info['status'] != 202: self.module.fail_json( msg="Failed to set the repo importer configuration", status_code=info['status'], response=info['msg'], importer_config=importer_config, url=url) def set_repo_list(self): url = "%s/pulp/api/v2/repositories/?details=true" % self.host response, info = fetch_url(self.module, url, method='GET') if info['status'] != 200: self.module.fail_json( msg="Request failed", status_code=info['status'], response=info['msg'], url=url) self.repo_list = json.load(response) def verify_tasks_completed(self, response_dict): for task in response_dict['spawned_tasks']: task_url = "%s%s" % (self.host, task['_href']) while True: response, info = fetch_url( self.module, task_url, data='', method='GET') if info['status'] != 200: self.module.fail_json( msg="Failed to check async task status.", status_code=info['status'], response=info['msg'], url=task_url) task_dict = json.load(response) if task_dict['state'] == 'finished': return True if task_dict['state'] == 'error': self.module.fail_json(msg="Asynchronous task failed to complete.", error=task_dict['error']) sleep(2) def main(): argument_spec = url_argument_spec() argument_spec.update( add_export_distributor=dict(default=False, type='bool'), feed=dict(), generate_sqlite=dict(default=False, type='bool'), feed_ca_cert=dict(aliases=['importer_ssl_ca_cert']), feed_client_cert=dict(aliases=['importer_ssl_client_cert']), feed_client_key=dict(aliases=['importer_ssl_client_key'], no_log=True), name=dict(required=True, aliases=['repo']), proxy_host=dict(), proxy_port=dict(), proxy_username=dict(), proxy_password=dict(no_log=True), publish_distributor=dict(), pulp_host=dict(default="https://127.0.0.1"), relative_url=dict(), repo_type=dict(default="rpm"), repoview=dict(default=False, type='bool'), serve_http=dict(default=False, type='bool'), serve_https=dict(default=True, type='bool'), state=dict( default="present", choices=['absent', 'present', 'sync', 'publish']), wait_for_completion=dict(default=False, type="bool")) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True) add_export_distributor = module.params['add_export_distributor'] feed = module.params['feed'] generate_sqlite = module.params['generate_sqlite'] importer_ssl_ca_cert = module.params['feed_ca_cert'] importer_ssl_client_cert = module.params['feed_client_cert'] importer_ssl_client_key = module.params['feed_client_key'] proxy_host = module.params['proxy_host'] proxy_port = module.params['proxy_port'] proxy_username = module.params['proxy_username'] proxy_password = module.params['proxy_password'] publish_distributor = module.params['publish_distributor'] pulp_host = module.params['pulp_host'] relative_url = module.params['relative_url'] repo = module.params['name'] repo_type = module.params['repo_type'] repoview = module.params['repoview'] serve_http = module.params['serve_http'] serve_https = module.params['serve_https'] state = module.params['state'] wait_for_completion = module.params['wait_for_completion'] if (state == 'present') and (not relative_url): module.fail_json(msg="When state is present, relative_url is required.") # Ensure that the importer_ssl_* is the content and not a file path if importer_ssl_ca_cert is not None: importer_ssl_ca_cert_file_path = os.path.abspath(importer_ssl_ca_cert) if os.path.isfile(importer_ssl_ca_cert_file_path): importer_ssl_ca_cert_file_object = open(importer_ssl_ca_cert_file_path, 'r') try: importer_ssl_ca_cert = importer_ssl_ca_cert_file_object.read() finally: importer_ssl_ca_cert_file_object.close() if importer_ssl_client_cert is not None: importer_ssl_client_cert_file_path = os.path.abspath(importer_ssl_client_cert) if os.path.isfile(importer_ssl_client_cert_file_path): importer_ssl_client_cert_file_object = open(importer_ssl_client_cert_file_path, 'r') try: importer_ssl_client_cert = importer_ssl_client_cert_file_object.read() finally: importer_ssl_client_cert_file_object.close() if importer_ssl_client_key is not None: importer_ssl_client_key_file_path = os.path.abspath(importer_ssl_client_key) if os.path.isfile(importer_ssl_client_key_file_path): importer_ssl_client_key_file_object = open(importer_ssl_client_key_file_path, 'r') try: importer_ssl_client_key = importer_ssl_client_key_file_object.read() finally: importer_ssl_client_key_file_object.close() server = pulp_server(module, pulp_host, repo_type, wait_for_completion=wait_for_completion) server.set_repo_list() repo_exists = server.check_repo_exists(repo) changed = False if state == 'absent' and repo_exists: if not module.check_mode: server.delete_repo(repo) changed = True if state == 'sync': if not repo_exists: module.fail_json(msg="Repository was not found. The repository can not be synced.") if not module.check_mode: server.sync_repo(repo) changed = True if state == 'publish': if not repo_exists: module.fail_json(msg="Repository was not found. The repository can not be published.") if not module.check_mode: server.publish_repo(repo, publish_distributor) changed = True if state == 'present': if not repo_exists: if not module.check_mode: server.create_repo( repo_id=repo, relative_url=relative_url, feed=feed, generate_sqlite=generate_sqlite, serve_http=serve_http, serve_https=serve_https, proxy_host=proxy_host, proxy_port=proxy_port, proxy_username=proxy_username, proxy_password=proxy_password, repoview=repoview, ssl_ca_cert=importer_ssl_ca_cert, ssl_client_cert=importer_ssl_client_cert, ssl_client_key=importer_ssl_client_key, add_export_distributor=add_export_distributor) changed = True else: # Check to make sure all the settings are correct # The importer config gets overwritten on set and not updated, so # we set the whole config at the same time. if not server.compare_repo_importer_config( repo, feed=feed, proxy_host=proxy_host, proxy_port=proxy_port, proxy_username=proxy_username, proxy_password=proxy_password, ssl_ca_cert=importer_ssl_ca_cert, ssl_client_cert=importer_ssl_client_cert, ssl_client_key=importer_ssl_client_key ): if not module.check_mode: server.update_repo_importer_config( repo, feed=feed, proxy_host=proxy_host, proxy_port=proxy_port, proxy_username=proxy_username, proxy_password=proxy_password, ssl_ca_cert=importer_ssl_ca_cert, ssl_client_cert=importer_ssl_client_cert, ssl_client_key=importer_ssl_client_key) changed = True if relative_url is not None: if not server.compare_repo_distributor_config( repo, relative_url=relative_url ): if not module.check_mode: server.update_repo_distributor_config( repo, relative_url=relative_url) changed = True if not server.compare_repo_distributor_config(repo, generate_sqlite=generate_sqlite): if not module.check_mode: server.update_repo_distributor_config(repo, generate_sqlite=generate_sqlite) changed = True if not server.compare_repo_distributor_config(repo, repoview=repoview): if not module.check_mode: server.update_repo_distributor_config(repo, repoview=repoview) changed = True if not server.compare_repo_distributor_config(repo, http=serve_http): if not module.check_mode: server.update_repo_distributor_config(repo, http=serve_http) changed = True if not server.compare_repo_distributor_config(repo, https=serve_https): if not module.check_mode: server.update_repo_distributor_config(repo, https=serve_https) changed = True module.exit_json(changed=changed, repo=repo) if __name__ == '__main__': main() PK $�!\u�{��- �- S collections/ansible_collections/community/general/plugins/modules/vertica_schema.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: vertica_schema short_description: Adds or removes Vertica database schema and roles description: - Adds or removes Vertica database schema and, optionally, roles with schema access privileges. - A schema will not be removed until all the objects have been dropped. - In such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: schema: description: - Name of the schema to add or remove. required: true aliases: ['name'] type: str usage_roles: description: - Comma separated list of roles to create and grant usage access to the schema. aliases: ['usage_role'] type: str create_roles: description: - Comma separated list of roles to create and grant usage and create access to the schema. aliases: ['create_role'] type: str owner: description: - Name of the user to set as owner of the schema. type: str state: description: - Whether to create V(present), or drop V(absent) a schema. default: present choices: ['present', 'absent'] type: str db: description: - Name of the Vertica database. type: str cluster: description: - Name of the Vertica cluster. default: localhost type: str port: description: - Vertica cluster port to connect to. default: '5433' type: str login_user: description: - The username used to authenticate with. default: dbadmin type: str login_password: description: - The password used to authenticate with. type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: [ 'unixODBC', 'pyodbc' ] author: "Dariusz Owczarek (@dareko)" ''' EXAMPLES = """ - name: Creating a new vertica schema community.general.vertica_schema: name=schema_name db=db_name state=present - name: Creating a new schema with specific schema owner community.general.vertica_schema: name=schema_name owner=dbowner db=db_name state=present - name: Creating a new schema with roles community.general.vertica_schema: name=schema_name create_roles=schema_name_all usage_roles=schema_name_ro,schema_name_rw db=db_name state=present """ import traceback PYODBC_IMP_ERR = None try: import pyodbc except ImportError: PYODBC_IMP_ERR = traceback.format_exc() pyodbc_found = False else: pyodbc_found = True from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native class NotSupportedError(Exception): pass class CannotDropError(Exception): pass # module specific functions def get_schema_facts(cursor, schema=''): facts = {} cursor.execute(""" select schema_name, schema_owner, create_time from schemata where not is_system_schema and schema_name not in ('public', 'TxtIndex') and (? = '' or schema_name ilike ?) """, schema, schema) while True: rows = cursor.fetchmany(100) if not rows: break for row in rows: facts[row.schema_name.lower()] = { 'name': row.schema_name, 'owner': row.schema_owner, 'create_time': str(row.create_time), 'usage_roles': [], 'create_roles': []} cursor.execute(""" select g.object_name as schema_name, r.name as role_name, lower(g.privileges_description) privileges_description from roles r join grants g on g.grantee_id = r.role_id and g.object_type='SCHEMA' and g.privileges_description like '%USAGE%' and g.grantee not in ('public', 'dbadmin') and (? = '' or g.object_name ilike ?) """, schema, schema) while True: rows = cursor.fetchmany(100) if not rows: break for row in rows: schema_key = row.schema_name.lower() if 'create' in row.privileges_description: facts[schema_key]['create_roles'].append(row.role_name) else: facts[schema_key]['usage_roles'].append(row.role_name) return facts def update_roles(schema_facts, cursor, schema, existing, required, create_existing, create_required): for role in set(existing + create_existing) - set(required + create_required): cursor.execute("drop role {0} cascade".format(role)) for role in set(create_existing) - set(create_required): cursor.execute("revoke create on schema {0} from {1}".format(schema, role)) for role in set(required + create_required) - set(existing + create_existing): cursor.execute("create role {0}".format(role)) cursor.execute("grant usage on schema {0} to {1}".format(schema, role)) for role in set(create_required) - set(create_existing): cursor.execute("grant create on schema {0} to {1}".format(schema, role)) def check(schema_facts, schema, usage_roles, create_roles, owner): schema_key = schema.lower() if schema_key not in schema_facts: return False if owner and owner.lower() == schema_facts[schema_key]['owner'].lower(): return False if sorted(usage_roles) != sorted(schema_facts[schema_key]['usage_roles']): return False if sorted(create_roles) != sorted(schema_facts[schema_key]['create_roles']): return False return True def present(schema_facts, cursor, schema, usage_roles, create_roles, owner): schema_key = schema.lower() if schema_key not in schema_facts: query_fragments = ["create schema {0}".format(schema)] if owner: query_fragments.append("authorization {0}".format(owner)) cursor.execute(' '.join(query_fragments)) update_roles(schema_facts, cursor, schema, [], usage_roles, [], create_roles) schema_facts.update(get_schema_facts(cursor, schema)) return True else: changed = False if owner and owner.lower() != schema_facts[schema_key]['owner'].lower(): raise NotSupportedError(( "Changing schema owner is not supported. " "Current owner: {0}." ).format(schema_facts[schema_key]['owner'])) if sorted(usage_roles) != sorted(schema_facts[schema_key]['usage_roles']) or \ sorted(create_roles) != sorted(schema_facts[schema_key]['create_roles']): update_roles(schema_facts, cursor, schema, schema_facts[schema_key]['usage_roles'], usage_roles, schema_facts[schema_key]['create_roles'], create_roles) changed = True if changed: schema_facts.update(get_schema_facts(cursor, schema)) return changed def absent(schema_facts, cursor, schema, usage_roles, create_roles): schema_key = schema.lower() if schema_key in schema_facts: update_roles(schema_facts, cursor, schema, schema_facts[schema_key]['usage_roles'], [], schema_facts[schema_key]['create_roles'], []) try: cursor.execute("drop schema {0} restrict".format(schema_facts[schema_key]['name'])) except pyodbc.Error: raise CannotDropError("Dropping schema failed due to dependencies.") del schema_facts[schema_key] return True else: return False # module logic def main(): module = AnsibleModule( argument_spec=dict( schema=dict(required=True, aliases=['name']), usage_roles=dict(aliases=['usage_role']), create_roles=dict(aliases=['create_role']), owner=dict(), state=dict(default='present', choices=['absent', 'present']), db=dict(), cluster=dict(default='localhost'), port=dict(default='5433'), login_user=dict(default='dbadmin'), login_password=dict(no_log=True), ), supports_check_mode=True) if not pyodbc_found: module.fail_json(msg=missing_required_lib('pyodbc'), exception=PYODBC_IMP_ERR) schema = module.params['schema'] usage_roles = [] if module.params['usage_roles']: usage_roles = module.params['usage_roles'].split(',') usage_roles = filter(None, usage_roles) create_roles = [] if module.params['create_roles']: create_roles = module.params['create_roles'].split(',') create_roles = filter(None, create_roles) owner = module.params['owner'] state = module.params['state'] db = '' if module.params['db']: db = module.params['db'] changed = False try: dsn = ( "Driver=Vertica;" "Server={0};" "Port={1};" "Database={2};" "User={3};" "Password={4};" "ConnectionLoadBalance={5}" ).format(module.params['cluster'], module.params['port'], db, module.params['login_user'], module.params['login_password'], 'true') db_conn = pyodbc.connect(dsn, autocommit=True) cursor = db_conn.cursor() except Exception as e: module.fail_json(msg="Unable to connect to database: {0}.".format(to_native(e))) try: schema_facts = get_schema_facts(cursor) if module.check_mode: changed = not check(schema_facts, schema, usage_roles, create_roles, owner) elif state == 'absent': try: changed = absent(schema_facts, cursor, schema, usage_roles, create_roles) except pyodbc.Error as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) elif state == 'present': try: changed = present(schema_facts, cursor, schema, usage_roles, create_roles, owner) except pyodbc.Error as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) except NotSupportedError as e: module.fail_json(msg=to_native(e), ansible_facts={'vertica_schemas': schema_facts}) except CannotDropError as e: module.fail_json(msg=to_native(e), ansible_facts={'vertica_schemas': schema_facts}) except SystemExit: # avoid catching this on python 2.4 raise except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) module.exit_json(changed=changed, schema=schema, ansible_facts={'vertica_schemas': schema_facts}) if __name__ == '__main__': main() PK $�!\Xn̹� � T collections/ansible_collections/community/general/plugins/modules/xenserver_guest.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Bojan Vitnik <bvitnik@mainstream.rs> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: xenserver_guest short_description: Manages virtual machines running on Citrix Hypervisor/XenServer host or pool description: > This module can be used to create new virtual machines from templates or other virtual machines, modify various virtual machine components like network and disk, rename a virtual machine and remove a virtual machine with associated components. author: - Bojan Vitnik (@bvitnik) <bvitnik@mainstream.rs> notes: - Minimal supported version of XenServer is 5.6. - Module was tested with XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 and 8.0. - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub: U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)' - 'If no scheme is specified in O(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are accessing XenServer host in trusted environment or use C(https://) scheme explicitly.' - 'To use C(https://) scheme for O(hostname) you have to either import host certificate to your OS certificate store or use O(validate_certs=false) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.' - 'Network configuration inside a guest OS, by using O(networks[].type), O(networks[].ip), O(networks[].gateway) etc. parameters, is supported on XenServer 7.0 or newer for Windows guests by using official XenServer Guest agent support for network configuration. The module will try to detect if such support is available and utilize it, else it will use a custom method of configuration via xenstore. Since XenServer Guest agent only support None and Static types of network configuration, where None means DHCP configured interface, O(networks[].type) and O(networks[].type6) values V(none) and V(dhcp) have same effect. More info here: U(https://www.citrix.com/community/citrix-developer/citrix-hypervisor-developer/citrix-hypervisor-developing-products/citrix-hypervisor-staticip.html)' - 'On platforms without official support for network configuration inside a guest OS, network parameters will be written to xenstore C(vm-data/networks/<vif_device>) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) tools on \*nix guests or trough WMI interface on Windows guests. They can also be found in VM facts C(instance.xenstore_data) key as returned by the module. It is up to the user to implement a boot time scripts or custom agent that will read the parameters from xenstore and configure network with given parameters. Take note that for xenstore data to become available inside a guest, a VM restart is needed hence module will require VM restart if any parameter is changed. This is a limitation of XenAPI and xenstore. Considering these limitations, network configuration trough xenstore is most useful for bootstraping newly deployed VMs, much less for reconfiguring existing ones. More info here: U(https://support.citrix.com/article/CTX226713)' requirements: - python >= 2.6 - XenAPI attributes: check_mode: support: full diff_mode: support: none options: state: description: - Specify the state VM should be in. - If O(state) is set to V(present) and VM exists, ensure the VM configuration conforms to given parameters. - If O(state) is set to V(present) and VM does not exist, then VM is deployed with given parameters. - If O(state) is set to V(absent) and VM exists, then VM is removed with its associated components. - If O(state) is set to V(poweredon) and VM does not exist, then VM is deployed with given parameters and powered on automatically. type: str default: present choices: [ present, absent, poweredon ] name: description: - Name of the VM to work with. - VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found. - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage. - This parameter is case sensitive. type: str aliases: [ name_label ] name_desc: description: - VM description. type: str uuid: description: - UUID of the VM to manage if known. This is XenServer's unique identifier. - It is required if name is not unique. - Please note that a supplied UUID will be ignored on VM creation, as XenServer creates the UUID internally. type: str template: description: - Name of a template, an existing VM (must be shut down) or a snapshot that should be used to create VM. - Templates/VMs/snapshots on XenServer do not necessarily have unique names. The module will fail if multiple templates with same name are found. - In case of multiple templates/VMs/snapshots with same name, use O(template_uuid) to uniquely specify source template. - If VM already exists, this setting will be ignored. - This parameter is case sensitive. type: str aliases: [ template_src ] template_uuid: description: - UUID of a template, an existing VM or a snapshot that should be used to create VM. - It is required if template name is not unique. type: str is_template: description: - Convert VM to template. type: bool default: false folder: description: - Destination folder for VM. - This parameter is case sensitive. - 'Example:' - ' folder: /folder1/folder2' type: str hardware: description: - Manage VM's hardware parameters. VM needs to be shut down to reconfigure these parameters. type: dict suboptions: num_cpus: description: - Number of CPUs. type: int num_cpu_cores_per_socket: description: - Number of Cores Per Socket. O(hardware.num_cpus) has to be a multiple of O(hardware.num_cpu_cores_per_socket). type: int memory_mb: description: - Amount of memory in MB. type: int disks: description: - A list of disks to add to VM. - All parameters are case sensitive. - Removing or detaching existing disks of VM is not supported. - New disks are required to have either a O(disks[].size) or one of O(ignore:disks[].size_[tb,gb,mb,kb,b]) parameters specified. - VM needs to be shut down to reconfigure disk size. type: list elements: dict aliases: [ disk ] suboptions: size: description: - 'Disk size with unit. Unit must be: V(b), V(kb), V(mb), V(gb), V(tb). VM needs to be shut down to reconfigure this parameter.' - If no unit is specified, size is assumed to be in bytes. type: str size_b: description: - Disk size in bytes. type: str size_kb: description: - Disk size in kilobytes. type: str size_mb: description: - Disk size in megabytes. type: str size_gb: description: - Disk size in gigabytes. type: str size_tb: description: - Disk size in terabytes. type: str name: description: - Disk name. type: str aliases: [ name_label ] name_desc: description: - Disk description. type: str sr: description: - Storage Repository to create disk on. If not specified, will use default SR. Cannot be used for moving disk to other SR. type: str sr_uuid: description: - UUID of a SR to create disk on. Use if SR name is not unique. type: str cdrom: description: - A CD-ROM configuration for the VM. - All parameters are case sensitive. type: dict suboptions: type: description: - The type of CD-ROM. With V(none) the CD-ROM device will be present but empty. type: str choices: [ none, iso ] iso_name: description: - 'The file name of an ISO image from one of the XenServer ISO Libraries (implies O(cdrom.type=iso)).' - Required if O(cdrom.type) is set to V(iso). type: str networks: description: - A list of networks (in the order of the NICs). - All parameters are case sensitive. - Name is required for new NICs. Other parameters are optional in all cases. type: list elements: dict aliases: [ network ] suboptions: name: description: - Name of a XenServer network to attach the network interface to. type: str aliases: [ name_label ] mac: description: - Customize MAC address of the interface. type: str type: description: - Type of IPv4 assignment. Value V(none) means whatever is default for OS. - On some operating systems it could be DHCP configured (e.g. Windows) or unconfigured interface (e.g. Linux). type: str choices: [ none, dhcp, static ] ip: description: - 'Static IPv4 address (implies O(networks[].type=static)). Can include prefix in format C(<IPv4 address>/<prefix>) instead of using C(netmask).' type: str netmask: description: - Static IPv4 netmask required for O(networks[].ip) if prefix is not specified. type: str gateway: description: - Static IPv4 gateway. type: str type6: description: - Type of IPv6 assignment. Value V(none) means whatever is default for OS. type: str choices: [ none, dhcp, static ] ip6: description: - 'Static IPv6 address (implies O(networks[].type6=static)) with prefix in format C(<IPv6 address>/<prefix>).' type: str gateway6: description: - Static IPv6 gateway. type: str home_server: description: - Name of a XenServer host that will be a Home Server for the VM. - This parameter is case sensitive. type: str custom_params: description: - Define a list of custom VM params to set on VM. - Useful for advanced users familiar with managing VM params trough xe CLI. - A custom value object takes two fields O(custom_params[].key) and O(custom_params[].value) (see example below). type: list elements: dict suboptions: key: description: - VM param name. type: str required: true value: description: - VM param value. type: raw required: true wait_for_ip_address: description: - Wait until XenServer detects an IP address for the VM. If O(state) is set to V(absent), this parameter is ignored. - This requires XenServer Tools to be preinstalled on the VM to work properly. type: bool default: false state_change_timeout: description: - 'By default, module will wait indefinitely for VM to accquire an IP address if O(wait_for_ip_address=true).' - If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change. - In case of timeout, module will generate an error message. type: int default: 0 linked_clone: description: - Whether to create a Linked Clone from the template, existing VM or snapshot. If no, will create a full copy. - This is equivalent to C(Use storage-level fast disk clone) option in XenCenter. type: bool default: false force: description: - Ignore warnings and complete the actions. - This parameter is useful for removing VM in running state or reconfiguring VM params that require VM to be shut down. type: bool default: false extends_documentation_fragment: - community.general.xenserver.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Create a VM from a template community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" validate_certs: false folder: /testvms name: testvm_2 state: poweredon template: CentOS 7 disks: - size_gb: 10 sr: my_sr hardware: num_cpus: 6 num_cpu_cores_per_socket: 3 memory_mb: 512 cdrom: type: iso iso_name: guest-tools.iso networks: - name: VM Network mac: aa:bb:dd:aa:00:14 wait_for_ip_address: true delegate_to: localhost register: deploy - name: Create a VM template community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" validate_certs: false folder: /testvms name: testvm_6 is_template: true disk: - size_gb: 10 sr: my_sr hardware: memory_mb: 512 num_cpus: 1 delegate_to: localhost register: deploy - name: Rename a VM (requires the VM's UUID) community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" uuid: 421e4592-c069-924d-ce20-7e7533fab926 name: new_name state: present delegate_to: localhost - name: Remove a VM by UUID community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" uuid: 421e4592-c069-924d-ce20-7e7533fab926 state: absent delegate_to: localhost - name: Modify custom params (boot order) community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" name: testvm_8 state: present custom_params: - key: HVM_boot_params value: { "order": "ndc" } delegate_to: localhost - name: Customize network parameters community.general.xenserver_guest: hostname: "{{ xenserver_hostname }}" username: "{{ xenserver_username }}" password: "{{ xenserver_password }}" name: testvm_10 networks: - name: VM Network ip: 192.168.1.100/24 gateway: 192.168.1.1 - type: dhcp delegate_to: localhost ''' RETURN = r''' instance: description: Metadata about the VM returned: always type: dict sample: { "cdrom": { "type": "none" }, "customization_agent": "native", "disks": [ { "name": "testvm_11-0", "name_desc": "", "os_device": "xvda", "size": 42949672960, "sr": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "0" }, { "name": "testvm_11-1", "name_desc": "", "os_device": "xvdb", "size": 42949672960, "sr": "Local storage", "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075", "vbd_userdevice": "1" } ], "domid": "56", "folder": "", "hardware": { "memory_mb": 8192, "num_cpu_cores_per_socket": 2, "num_cpus": 4 }, "home_server": "", "is_template": false, "name": "testvm_11", "name_desc": "", "networks": [ { "gateway": "192.168.0.254", "gateway6": "fc00::fffe", "ip": "192.168.0.200", "ip6": [ "fe80:0000:0000:0000:e9cb:625a:32c5:c291", "fc00:0000:0000:0000:0000:0000:0000:0001" ], "mac": "ba:91:3a:48:20:76", "mtu": "1500", "name": "Pool-wide network associated with eth1", "netmask": "255.255.255.128", "prefix": "25", "prefix6": "64", "vif_device": "0" } ], "other_config": { "base_template_name": "Windows Server 2016 (64-bit)", "import_task": "OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5", "install-methods": "cdrom", "instant": "true", "mac_seed": "f83e8d8a-cfdc-b105-b054-ef5cb416b77e" }, "platform": { "acpi": "1", "apic": "true", "cores-per-socket": "2", "device_id": "0002", "hpet": "true", "nx": "true", "pae": "true", "timeoffset": "-25200", "vga": "std", "videoram": "8", "viridian": "true", "viridian_reference_tsc": "true", "viridian_time_ref_count": "true" }, "state": "poweredon", "uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda", "xenstore_data": { "vm-data": "" } } changes: description: Detected or made changes to VM returned: always type: list sample: [ { "hardware": [ "num_cpus" ] }, { "disks_changed": [ [], [ "size" ] ] }, { "disks_new": [ { "name": "new-disk", "name_desc": "", "position": 2, "size_gb": "4", "vbd_userdevice": "2" } ] }, { "cdrom": [ "type", "iso_name" ] }, { "networks_changed": [ [ "mac" ], ] }, { "networks_new": [ { "name": "Pool-wide network associated with eth2", "position": 1, "vif_device": "1" } ] }, "need_poweredoff" ] ''' import re HAS_XENAPI = False try: import XenAPI HAS_XENAPI = True except ImportError: pass from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.network import is_mac from ansible.module_utils import six from ansible_collections.community.general.plugins.module_utils.xenserver import ( xenserver_common_argument_spec, XenServerObject, get_object_ref, gather_vm_params, gather_vm_facts, set_vm_power_state, wait_for_vm_ip_address, is_valid_ip_addr, is_valid_ip_netmask, is_valid_ip_prefix, ip_prefix_to_netmask, ip_netmask_to_prefix, is_valid_ip6_addr, is_valid_ip6_prefix) class XenServerVM(XenServerObject): """Class for managing XenServer VM. Attributes: vm_ref (str): XAPI reference to VM. vm_params (dict): A dictionary with VM parameters as returned by gather_vm_params() function. """ def __init__(self, module): """Inits XenServerVM using module parameters. Args: module: Reference to Ansible module object. """ super(XenServerVM, self).__init__(module) self.vm_ref = get_object_ref(self.module, self.module.params['name'], self.module.params['uuid'], obj_type="VM", fail=False, msg_prefix="VM search: ") self.gather_params() def exists(self): """Returns True if VM exists, else False.""" return True if self.vm_ref is not None else False def gather_params(self): """Gathers all VM parameters available in XAPI database.""" self.vm_params = gather_vm_params(self.module, self.vm_ref) def gather_facts(self): """Gathers and returns VM facts.""" return gather_vm_facts(self.module, self.vm_params) def set_power_state(self, power_state): """Controls VM power state.""" state_changed, current_state = set_vm_power_state(self.module, self.vm_ref, power_state, self.module.params['state_change_timeout']) # If state has changed, update vm_params. if state_changed: self.vm_params['power_state'] = current_state.capitalize() return state_changed def wait_for_ip_address(self): """Waits for VM to acquire an IP address.""" self.vm_params['guest_metrics'] = wait_for_vm_ip_address(self.module, self.vm_ref, self.module.params['state_change_timeout']) def deploy(self): """Deploys new VM from template.""" # Safety check. if self.exists(): self.module.fail_json(msg="Called deploy on existing VM!") try: templ_ref = get_object_ref(self.module, self.module.params['template'], self.module.params['template_uuid'], obj_type="template", fail=True, msg_prefix="VM deploy: ") # Is this an existing running VM? if self.xapi_session.xenapi.VM.get_power_state(templ_ref).lower() != 'halted': self.module.fail_json(msg="VM deploy: running VM cannot be used as a template!") # Find a SR we can use for VM.copy(). We use SR of the first disk # if specified or default SR if not specified. disk_params_list = self.module.params['disks'] sr_ref = None if disk_params_list: disk_params = disk_params_list[0] disk_sr_uuid = disk_params.get('sr_uuid') disk_sr = disk_params.get('sr') if disk_sr_uuid is not None or disk_sr is not None: sr_ref = get_object_ref(self.module, disk_sr, disk_sr_uuid, obj_type="SR", fail=True, msg_prefix="VM deploy disks[0]: ") if not sr_ref: if self.default_sr_ref != "OpaqueRef:NULL": sr_ref = self.default_sr_ref else: self.module.fail_json(msg="VM deploy disks[0]: no default SR found! You must specify SR explicitly.") # VM name could be an empty string which is bad. if self.module.params['name'] is not None and not self.module.params['name']: self.module.fail_json(msg="VM deploy: VM name must not be an empty string!") # Support for Ansible check mode. if self.module.check_mode: return # Now we can instantiate VM. We use VM.clone for linked_clone and # VM.copy for non linked_clone. if self.module.params['linked_clone']: self.vm_ref = self.xapi_session.xenapi.VM.clone(templ_ref, self.module.params['name']) else: self.vm_ref = self.xapi_session.xenapi.VM.copy(templ_ref, self.module.params['name'], sr_ref) # Description is copied over from template so we reset it. self.xapi_session.xenapi.VM.set_name_description(self.vm_ref, "") # If template is one of built-in XenServer templates, we have to # do some additional steps. # Note: VM.get_is_default_template() is supported from XenServer 7.2 # onward so we use an alternative way. templ_other_config = self.xapi_session.xenapi.VM.get_other_config(templ_ref) if "default_template" in templ_other_config and templ_other_config['default_template']: # other_config of built-in XenServer templates have a key called # 'disks' with the following content: # disks: <provision><disk bootable="true" device="0" size="10737418240" sr="" type="system"/></provision> # This value of other_data is copied to cloned or copied VM and # it prevents provisioning of VM because sr is not specified and # XAPI returns an error. To get around this, we remove the # 'disks' key and add disks to VM later ourselves. vm_other_config = self.xapi_session.xenapi.VM.get_other_config(self.vm_ref) if "disks" in vm_other_config: del vm_other_config['disks'] self.xapi_session.xenapi.VM.set_other_config(self.vm_ref, vm_other_config) # At this point we have VM ready for provisioning. self.xapi_session.xenapi.VM.provision(self.vm_ref) # After provisioning we can prepare vm_params for reconfigure(). self.gather_params() # VM is almost ready. We just need to reconfigure it... self.reconfigure() # Power on VM if needed. if self.module.params['state'] == "poweredon": self.set_power_state("poweredon") except XenAPI.Failure as f: self.module.fail_json(msg="XAPI ERROR: %s" % f.details) def reconfigure(self): """Reconfigures an existing VM. Returns: list: parameters that were reconfigured. """ # Safety check. if not self.exists(): self.module.fail_json(msg="Called reconfigure on non existing VM!") config_changes = self.get_changes() vm_power_state_save = self.vm_params['power_state'].lower() if "need_poweredoff" in config_changes and vm_power_state_save != 'halted' and not self.module.params['force']: self.module.fail_json(msg="VM reconfigure: VM has to be in powered off state to reconfigure but force was not specified!") # Support for Ansible check mode. if self.module.check_mode: return config_changes if "need_poweredoff" in config_changes and vm_power_state_save != 'halted' and self.module.params['force']: self.set_power_state("shutdownguest") try: for change in config_changes: if isinstance(change, six.string_types): if change == "name": self.xapi_session.xenapi.VM.set_name_label(self.vm_ref, self.module.params['name']) elif change == "name_desc": self.xapi_session.xenapi.VM.set_name_description(self.vm_ref, self.module.params['name_desc']) elif change == "folder": self.xapi_session.xenapi.VM.remove_from_other_config(self.vm_ref, 'folder') if self.module.params['folder']: self.xapi_session.xenapi.VM.add_to_other_config(self.vm_ref, 'folder', self.module.params['folder']) elif change == "home_server": if self.module.params['home_server']: host_ref = self.xapi_session.xenapi.host.get_by_name_label(self.module.params['home_server'])[0] else: host_ref = "OpaqueRef:NULL" self.xapi_session.xenapi.VM.set_affinity(self.vm_ref, host_ref) elif isinstance(change, dict): if change.get('hardware'): for hardware_change in change['hardware']: if hardware_change == "num_cpus": num_cpus = int(self.module.params['hardware']['num_cpus']) if num_cpus < int(self.vm_params['VCPUs_at_startup']): self.xapi_session.xenapi.VM.set_VCPUs_at_startup(self.vm_ref, str(num_cpus)) self.xapi_session.xenapi.VM.set_VCPUs_max(self.vm_ref, str(num_cpus)) else: self.xapi_session.xenapi.VM.set_VCPUs_max(self.vm_ref, str(num_cpus)) self.xapi_session.xenapi.VM.set_VCPUs_at_startup(self.vm_ref, str(num_cpus)) elif hardware_change == "num_cpu_cores_per_socket": self.xapi_session.xenapi.VM.remove_from_platform(self.vm_ref, 'cores-per-socket') num_cpu_cores_per_socket = int(self.module.params['hardware']['num_cpu_cores_per_socket']) if num_cpu_cores_per_socket > 1: self.xapi_session.xenapi.VM.add_to_platform(self.vm_ref, 'cores-per-socket', str(num_cpu_cores_per_socket)) elif hardware_change == "memory_mb": memory_b = str(int(self.module.params['hardware']['memory_mb']) * 1048576) vm_memory_static_min_b = str(min(int(memory_b), int(self.vm_params['memory_static_min']))) self.xapi_session.xenapi.VM.set_memory_limits(self.vm_ref, vm_memory_static_min_b, memory_b, memory_b, memory_b) elif change.get('disks_changed'): vm_disk_params_list = [disk_params for disk_params in self.vm_params['VBDs'] if disk_params['type'] == "Disk"] position = 0 for disk_change_list in change['disks_changed']: for disk_change in disk_change_list: vdi_ref = self.xapi_session.xenapi.VDI.get_by_uuid(vm_disk_params_list[position]['VDI']['uuid']) if disk_change == "name": self.xapi_session.xenapi.VDI.set_name_label(vdi_ref, self.module.params['disks'][position]['name']) elif disk_change == "name_desc": self.xapi_session.xenapi.VDI.set_name_description(vdi_ref, self.module.params['disks'][position]['name_desc']) elif disk_change == "size": self.xapi_session.xenapi.VDI.resize(vdi_ref, str(self.get_normalized_disk_size(self.module.params['disks'][position], "VM reconfigure disks[%s]: " % position))) position += 1 elif change.get('disks_new'): for position, disk_userdevice in change['disks_new']: disk_params = self.module.params['disks'][position] disk_name = disk_params['name'] if disk_params.get('name') else "%s-%s" % (self.vm_params['name_label'], position) disk_name_desc = disk_params['name_desc'] if disk_params.get('name_desc') else "" if disk_params.get('sr_uuid'): sr_ref = self.xapi_session.xenapi.SR.get_by_uuid(disk_params['sr_uuid']) elif disk_params.get('sr'): sr_ref = self.xapi_session.xenapi.SR.get_by_name_label(disk_params['sr'])[0] else: sr_ref = self.default_sr_ref disk_size = str(self.get_normalized_disk_size(self.module.params['disks'][position], "VM reconfigure disks[%s]: " % position)) new_disk_vdi = { "name_label": disk_name, "name_description": disk_name_desc, "SR": sr_ref, "virtual_size": disk_size, "type": "user", "sharable": False, "read_only": False, "other_config": {}, } new_disk_vbd = { "VM": self.vm_ref, "VDI": None, "userdevice": disk_userdevice, "bootable": False, "mode": "RW", "type": "Disk", "empty": False, "other_config": {}, "qos_algorithm_type": "", "qos_algorithm_params": {}, } new_disk_vbd['VDI'] = self.xapi_session.xenapi.VDI.create(new_disk_vdi) vbd_ref_new = self.xapi_session.xenapi.VBD.create(new_disk_vbd) if self.vm_params['power_state'].lower() == "running": self.xapi_session.xenapi.VBD.plug(vbd_ref_new) elif change.get('cdrom'): vm_cdrom_params_list = [cdrom_params for cdrom_params in self.vm_params['VBDs'] if cdrom_params['type'] == "CD"] # If there is no CD present, we have to create one. if not vm_cdrom_params_list: # We will try to place cdrom at userdevice position # 3 (which is default) if it is not already occupied # else we will place it at first allowed position. cdrom_userdevices_allowed = self.xapi_session.xenapi.VM.get_allowed_VBD_devices(self.vm_ref) if "3" in cdrom_userdevices_allowed: cdrom_userdevice = "3" else: cdrom_userdevice = cdrom_userdevices_allowed[0] cdrom_vbd = { "VM": self.vm_ref, "VDI": "OpaqueRef:NULL", "userdevice": cdrom_userdevice, "bootable": False, "mode": "RO", "type": "CD", "empty": True, "other_config": {}, "qos_algorithm_type": "", "qos_algorithm_params": {}, } cdrom_vbd_ref = self.xapi_session.xenapi.VBD.create(cdrom_vbd) else: cdrom_vbd_ref = self.xapi_session.xenapi.VBD.get_by_uuid(vm_cdrom_params_list[0]['uuid']) cdrom_is_empty = self.xapi_session.xenapi.VBD.get_empty(cdrom_vbd_ref) for cdrom_change in change['cdrom']: if cdrom_change == "type": cdrom_type = self.module.params['cdrom']['type'] if cdrom_type == "none" and not cdrom_is_empty: self.xapi_session.xenapi.VBD.eject(cdrom_vbd_ref) elif cdrom_type == "host": # Unimplemented! pass elif cdrom_change == "iso_name": if not cdrom_is_empty: self.xapi_session.xenapi.VBD.eject(cdrom_vbd_ref) cdrom_vdi_ref = self.xapi_session.xenapi.VDI.get_by_name_label(self.module.params['cdrom']['iso_name'])[0] self.xapi_session.xenapi.VBD.insert(cdrom_vbd_ref, cdrom_vdi_ref) elif change.get('networks_changed'): position = 0 for network_change_list in change['networks_changed']: if network_change_list: vm_vif_params = self.vm_params['VIFs'][position] network_params = self.module.params['networks'][position] vif_ref = self.xapi_session.xenapi.VIF.get_by_uuid(vm_vif_params['uuid']) network_ref = self.xapi_session.xenapi.network.get_by_uuid(vm_vif_params['network']['uuid']) vif_recreated = False if "name" in network_change_list or "mac" in network_change_list: # To change network or MAC, we destroy old # VIF and then create a new one with changed # parameters. That's how XenCenter does it. # Copy all old parameters to new VIF record. vif = { "device": vm_vif_params['device'], "network": network_ref, "VM": vm_vif_params['VM'], "MAC": vm_vif_params['MAC'], "MTU": vm_vif_params['MTU'], "other_config": vm_vif_params['other_config'], "qos_algorithm_type": vm_vif_params['qos_algorithm_type'], "qos_algorithm_params": vm_vif_params['qos_algorithm_params'], "locking_mode": vm_vif_params['locking_mode'], "ipv4_allowed": vm_vif_params['ipv4_allowed'], "ipv6_allowed": vm_vif_params['ipv6_allowed'], } if "name" in network_change_list: network_ref_new = self.xapi_session.xenapi.network.get_by_name_label(network_params['name'])[0] vif['network'] = network_ref_new vif['MTU'] = self.xapi_session.xenapi.network.get_MTU(network_ref_new) if "mac" in network_change_list: vif['MAC'] = network_params['mac'].lower() if self.vm_params['power_state'].lower() == "running": self.xapi_session.xenapi.VIF.unplug(vif_ref) self.xapi_session.xenapi.VIF.destroy(vif_ref) vif_ref_new = self.xapi_session.xenapi.VIF.create(vif) if self.vm_params['power_state'].lower() == "running": self.xapi_session.xenapi.VIF.plug(vif_ref_new) vif_ref = vif_ref_new vif_recreated = True if self.vm_params['customization_agent'] == "native": vif_reconfigure_needed = False if "type" in network_change_list: network_type = network_params['type'].capitalize() vif_reconfigure_needed = True else: network_type = vm_vif_params['ipv4_configuration_mode'] if "ip" in network_change_list: network_ip = network_params['ip'] vif_reconfigure_needed = True elif vm_vif_params['ipv4_addresses']: network_ip = vm_vif_params['ipv4_addresses'][0].split('/')[0] else: network_ip = "" if "prefix" in network_change_list: network_prefix = "/%s" % network_params['prefix'] vif_reconfigure_needed = True elif vm_vif_params['ipv4_addresses'] and vm_vif_params['ipv4_addresses'][0]: network_prefix = "/%s" % vm_vif_params['ipv4_addresses'][0].split('/')[1] else: network_prefix = "" if "gateway" in network_change_list: network_gateway = network_params['gateway'] vif_reconfigure_needed = True else: network_gateway = vm_vif_params['ipv4_gateway'] if vif_recreated or vif_reconfigure_needed: self.xapi_session.xenapi.VIF.configure_ipv4(vif_ref, network_type, "%s%s" % (network_ip, network_prefix), network_gateway) vif_reconfigure_needed = False if "type6" in network_change_list: network_type6 = network_params['type6'].capitalize() vif_reconfigure_needed = True else: network_type6 = vm_vif_params['ipv6_configuration_mode'] if "ip6" in network_change_list: network_ip6 = network_params['ip6'] vif_reconfigure_needed = True elif vm_vif_params['ipv6_addresses']: network_ip6 = vm_vif_params['ipv6_addresses'][0].split('/')[0] else: network_ip6 = "" if "prefix6" in network_change_list: network_prefix6 = "/%s" % network_params['prefix6'] vif_reconfigure_needed = True elif vm_vif_params['ipv6_addresses'] and vm_vif_params['ipv6_addresses'][0]: network_prefix6 = "/%s" % vm_vif_params['ipv6_addresses'][0].split('/')[1] else: network_prefix6 = "" if "gateway6" in network_change_list: network_gateway6 = network_params['gateway6'] vif_reconfigure_needed = True else: network_gateway6 = vm_vif_params['ipv6_gateway'] if vif_recreated or vif_reconfigure_needed: self.xapi_session.xenapi.VIF.configure_ipv6(vif_ref, network_type6, "%s%s" % (network_ip6, network_prefix6), network_gateway6) elif self.vm_params['customization_agent'] == "custom": vif_device = vm_vif_params['device'] # A user could have manually changed network # or mac e.g. trough XenCenter and then also # make those changes in playbook manually. # In that case, module will not detect any # changes and info in xenstore_data will # become stale. For that reason we always # update name and mac in xenstore_data. # Since we handle name and mac differently, # we have to remove them from # network_change_list. network_change_list_tmp = [net_chg for net_chg in network_change_list if net_chg not in ['name', 'mac']] for network_change in network_change_list_tmp + ['name', 'mac']: self.xapi_session.xenapi.VM.remove_from_xenstore_data(self.vm_ref, "vm-data/networks/%s/%s" % (vif_device, network_change)) if network_params.get('name'): network_name = network_params['name'] else: network_name = vm_vif_params['network']['name_label'] self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/%s" % (vif_device, 'name'), network_name) if network_params.get('mac'): network_mac = network_params['mac'].lower() else: network_mac = vm_vif_params['MAC'].lower() self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/%s" % (vif_device, 'mac'), network_mac) for network_change in network_change_list_tmp: self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/%s" % (vif_device, network_change), network_params[network_change]) position += 1 elif change.get('networks_new'): for position, vif_device in change['networks_new']: network_params = self.module.params['networks'][position] network_ref = self.xapi_session.xenapi.network.get_by_name_label(network_params['name'])[0] network_name = network_params['name'] network_mac = network_params['mac'] if network_params.get('mac') else "" network_type = network_params.get('type') network_ip = network_params['ip'] if network_params.get('ip') else "" network_prefix = network_params['prefix'] if network_params.get('prefix') else "" network_netmask = network_params['netmask'] if network_params.get('netmask') else "" network_gateway = network_params['gateway'] if network_params.get('gateway') else "" network_type6 = network_params.get('type6') network_ip6 = network_params['ip6'] if network_params.get('ip6') else "" network_prefix6 = network_params['prefix6'] if network_params.get('prefix6') else "" network_gateway6 = network_params['gateway6'] if network_params.get('gateway6') else "" vif = { "device": vif_device, "network": network_ref, "VM": self.vm_ref, "MAC": network_mac, "MTU": self.xapi_session.xenapi.network.get_MTU(network_ref), "other_config": {}, "qos_algorithm_type": "", "qos_algorithm_params": {}, } vif_ref_new = self.xapi_session.xenapi.VIF.create(vif) if self.vm_params['power_state'].lower() == "running": self.xapi_session.xenapi.VIF.plug(vif_ref_new) if self.vm_params['customization_agent'] == "native": if network_type and network_type == "static": self.xapi_session.xenapi.VIF.configure_ipv4(vif_ref_new, "Static", "%s/%s" % (network_ip, network_prefix), network_gateway) if network_type6 and network_type6 == "static": self.xapi_session.xenapi.VIF.configure_ipv6(vif_ref_new, "Static", "%s/%s" % (network_ip6, network_prefix6), network_gateway6) elif self.vm_params['customization_agent'] == "custom": # We first have to remove any existing data # from xenstore_data because there could be # some old leftover data from some interface # that once occupied same device location as # our new interface. for network_param in ['name', 'mac', 'type', 'ip', 'prefix', 'netmask', 'gateway', 'type6', 'ip6', 'prefix6', 'gateway6']: self.xapi_session.xenapi.VM.remove_from_xenstore_data(self.vm_ref, "vm-data/networks/%s/%s" % (vif_device, network_param)) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/name" % vif_device, network_name) # We get MAC from VIF itself instead of # networks.mac because it could be # autogenerated. vm_vif_mac = self.xapi_session.xenapi.VIF.get_MAC(vif_ref_new) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/mac" % vif_device, vm_vif_mac) if network_type: self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/type" % vif_device, network_type) if network_type == "static": self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/ip" % vif_device, network_ip) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/prefix" % vif_device, network_prefix) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/netmask" % vif_device, network_netmask) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/gateway" % vif_device, network_gateway) if network_type6: self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/type6" % vif_device, network_type6) if network_type6 == "static": self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/ip6" % vif_device, network_ip6) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/prefix6" % vif_device, network_prefix6) self.xapi_session.xenapi.VM.add_to_xenstore_data(self.vm_ref, "vm-data/networks/%s/gateway6" % vif_device, network_gateway6) elif change.get('custom_params'): for position in change['custom_params']: custom_param_key = self.module.params['custom_params'][position]['key'] custom_param_value = self.module.params['custom_params'][position]['value'] self.xapi_session.xenapi_request("VM.set_%s" % custom_param_key, (self.vm_ref, custom_param_value)) if self.module.params['is_template']: self.xapi_session.xenapi.VM.set_is_a_template(self.vm_ref, True) elif "need_poweredoff" in config_changes and self.module.params['force'] and vm_power_state_save != 'halted': self.set_power_state("poweredon") # Gather new params after reconfiguration. self.gather_params() except XenAPI.Failure as f: self.module.fail_json(msg="XAPI ERROR: %s" % f.details) return config_changes def destroy(self): """Removes an existing VM with associated disks""" # Safety check. if not self.exists(): self.module.fail_json(msg="Called destroy on non existing VM!") if self.vm_params['power_state'].lower() != 'halted' and not self.module.params['force']: self.module.fail_json(msg="VM destroy: VM has to be in powered off state to destroy but force was not specified!") # Support for Ansible check mode. if self.module.check_mode: return # Make sure that VM is poweredoff before we can destroy it. self.set_power_state("poweredoff") try: # Destroy VM! self.xapi_session.xenapi.VM.destroy(self.vm_ref) vm_disk_params_list = [disk_params for disk_params in self.vm_params['VBDs'] if disk_params['type'] == "Disk"] # Destroy all VDIs associated with VM! for vm_disk_params in vm_disk_params_list: vdi_ref = self.xapi_session.xenapi.VDI.get_by_uuid(vm_disk_params['VDI']['uuid']) self.xapi_session.xenapi.VDI.destroy(vdi_ref) except XenAPI.Failure as f: self.module.fail_json(msg="XAPI ERROR: %s" % f.details) def get_changes(self): """Finds VM parameters that differ from specified ones. This method builds a dictionary with hierarchy of VM parameters that differ from those specified in module parameters. Returns: list: VM parameters that differ from those specified in module parameters. """ # Safety check. if not self.exists(): self.module.fail_json(msg="Called get_changes on non existing VM!") need_poweredoff = False if self.module.params['is_template']: need_poweredoff = True try: # This VM could be a template or a snapshot. In that case we fail # because we can't reconfigure them or it would just be too # dangerous. if self.vm_params['is_a_template'] and not self.vm_params['is_a_snapshot']: self.module.fail_json(msg="VM check: targeted VM is a template! Template reconfiguration is not supported.") if self.vm_params['is_a_snapshot']: self.module.fail_json(msg="VM check: targeted VM is a snapshot! Snapshot reconfiguration is not supported.") # Let's build a list of parameters that changed. config_changes = [] # Name could only differ if we found an existing VM by uuid. if self.module.params['name'] is not None and self.module.params['name'] != self.vm_params['name_label']: if self.module.params['name']: config_changes.append('name') else: self.module.fail_json(msg="VM check name: VM name cannot be an empty string!") if self.module.params['name_desc'] is not None and self.module.params['name_desc'] != self.vm_params['name_description']: config_changes.append('name_desc') # Folder parameter is found in other_config. vm_other_config = self.vm_params['other_config'] vm_folder = vm_other_config.get('folder', '') if self.module.params['folder'] is not None and self.module.params['folder'] != vm_folder: config_changes.append('folder') if self.module.params['home_server'] is not None: if (self.module.params['home_server'] and (not self.vm_params['affinity'] or self.module.params['home_server'] != self.vm_params['affinity']['name_label'])): # Check existence only. Ignore return value. get_object_ref(self.module, self.module.params['home_server'], uuid=None, obj_type="home server", fail=True, msg_prefix="VM check home_server: ") config_changes.append('home_server') elif not self.module.params['home_server'] and self.vm_params['affinity']: config_changes.append('home_server') config_changes_hardware = [] if self.module.params['hardware']: num_cpus = self.module.params['hardware'].get('num_cpus') if num_cpus is not None: # Kept for compatibility with older Ansible versions that # do not support subargument specs. try: num_cpus = int(num_cpus) except ValueError as e: self.module.fail_json(msg="VM check hardware.num_cpus: parameter should be an integer value!") if num_cpus < 1: self.module.fail_json(msg="VM check hardware.num_cpus: parameter should be greater than zero!") # We can use VCPUs_at_startup or VCPUs_max parameter. I'd # say the former is the way to go but this needs # confirmation and testing. if num_cpus != int(self.vm_params['VCPUs_at_startup']): config_changes_hardware.append('num_cpus') # For now, we don't support hotpluging so VM has to be in # poweredoff state to reconfigure. need_poweredoff = True num_cpu_cores_per_socket = self.module.params['hardware'].get('num_cpu_cores_per_socket') if num_cpu_cores_per_socket is not None: # Kept for compatibility with older Ansible versions that # do not support subargument specs. try: num_cpu_cores_per_socket = int(num_cpu_cores_per_socket) except ValueError as e: self.module.fail_json(msg="VM check hardware.num_cpu_cores_per_socket: parameter should be an integer value!") if num_cpu_cores_per_socket < 1: self.module.fail_json(msg="VM check hardware.num_cpu_cores_per_socket: parameter should be greater than zero!") if num_cpus and num_cpus % num_cpu_cores_per_socket != 0: self.module.fail_json(msg="VM check hardware.num_cpus: parameter should be a multiple of hardware.num_cpu_cores_per_socket!") vm_platform = self.vm_params['platform'] vm_cores_per_socket = int(vm_platform.get('cores-per-socket', 1)) if num_cpu_cores_per_socket != vm_cores_per_socket: config_changes_hardware.append('num_cpu_cores_per_socket') # For now, we don't support hotpluging so VM has to be # in poweredoff state to reconfigure. need_poweredoff = True memory_mb = self.module.params['hardware'].get('memory_mb') if memory_mb is not None: # Kept for compatibility with older Ansible versions that # do not support subargument specs. try: memory_mb = int(memory_mb) except ValueError as e: self.module.fail_json(msg="VM check hardware.memory_mb: parameter should be an integer value!") if memory_mb < 1: self.module.fail_json(msg="VM check hardware.memory_mb: parameter should be greater than zero!") # There are multiple memory parameters: # - memory_dynamic_max # - memory_dynamic_min # - memory_static_max # - memory_static_min # - memory_target # # memory_target seems like a good candidate but it returns 0 for # halted VMs so we can't use it. # # I decided to use memory_dynamic_max and memory_static_max # and use whichever is larger. This strategy needs validation # and testing. # # XenServer stores memory size in bytes so we need to divide # it by 1024*1024 = 1048576. if memory_mb != int(max(int(self.vm_params['memory_dynamic_max']), int(self.vm_params['memory_static_max'])) / 1048576): config_changes_hardware.append('memory_mb') # For now, we don't support hotpluging so VM has to be in # poweredoff state to reconfigure. need_poweredoff = True if config_changes_hardware: config_changes.append({"hardware": config_changes_hardware}) config_changes_disks = [] config_new_disks = [] # Find allowed userdevices. vbd_userdevices_allowed = self.xapi_session.xenapi.VM.get_allowed_VBD_devices(self.vm_ref) if self.module.params['disks']: # Get the list of all disk. Filter out any CDs found. vm_disk_params_list = [disk_params for disk_params in self.vm_params['VBDs'] if disk_params['type'] == "Disk"] # Number of disks defined in module params have to be same or # higher than a number of existing disks attached to the VM. # We don't support removal or detachment of disks. if len(self.module.params['disks']) < len(vm_disk_params_list): self.module.fail_json(msg="VM check disks: provided disks configuration has less disks than the target VM (%d < %d)!" % (len(self.module.params['disks']), len(vm_disk_params_list))) # Find the highest disk occupied userdevice. if not vm_disk_params_list: vm_disk_userdevice_highest = "-1" else: vm_disk_userdevice_highest = vm_disk_params_list[-1]['userdevice'] for position in range(len(self.module.params['disks'])): if position < len(vm_disk_params_list): vm_disk_params = vm_disk_params_list[position] else: vm_disk_params = None disk_params = self.module.params['disks'][position] disk_size = self.get_normalized_disk_size(self.module.params['disks'][position], "VM check disks[%s]: " % position) disk_name = disk_params.get('name') if disk_name is not None and not disk_name: self.module.fail_json(msg="VM check disks[%s]: disk name cannot be an empty string!" % position) # If this is an existing disk. if vm_disk_params and vm_disk_params['VDI']: disk_changes = [] if disk_name and disk_name != vm_disk_params['VDI']['name_label']: disk_changes.append('name') disk_name_desc = disk_params.get('name_desc') if disk_name_desc is not None and disk_name_desc != vm_disk_params['VDI']['name_description']: disk_changes.append('name_desc') if disk_size: if disk_size > int(vm_disk_params['VDI']['virtual_size']): disk_changes.append('size') need_poweredoff = True elif disk_size < int(vm_disk_params['VDI']['virtual_size']): self.module.fail_json(msg="VM check disks[%s]: disk size is smaller than existing (%d bytes < %s bytes). " "Reducing disk size is not allowed!" % (position, disk_size, vm_disk_params['VDI']['virtual_size'])) config_changes_disks.append(disk_changes) # If this is a new disk. else: if not disk_size: self.module.fail_json(msg="VM check disks[%s]: no valid disk size specification found!" % position) disk_sr_uuid = disk_params.get('sr_uuid') disk_sr = disk_params.get('sr') if disk_sr_uuid is not None or disk_sr is not None: # Check existence only. Ignore return value. get_object_ref(self.module, disk_sr, disk_sr_uuid, obj_type="SR", fail=True, msg_prefix="VM check disks[%s]: " % position) elif self.default_sr_ref == 'OpaqueRef:NULL': self.module.fail_json(msg="VM check disks[%s]: no default SR found! You must specify SR explicitly." % position) if not vbd_userdevices_allowed: self.module.fail_json(msg="VM check disks[%s]: maximum number of devices reached!" % position) disk_userdevice = None # We need to place a new disk right above the highest # placed existing disk to maintain relative disk # positions pairable with disk specifications in # module params. That place must not be occupied by # some other device like CD-ROM. for userdevice in vbd_userdevices_allowed: if int(userdevice) > int(vm_disk_userdevice_highest): disk_userdevice = userdevice vbd_userdevices_allowed.remove(userdevice) vm_disk_userdevice_highest = userdevice break # If no place was found. if disk_userdevice is None: # Highest occupied place could be a CD-ROM device # so we have to include all devices regardless of # type when calculating out-of-bound position. disk_userdevice = str(int(self.vm_params['VBDs'][-1]['userdevice']) + 1) self.module.fail_json(msg="VM check disks[%s]: new disk position %s is out of bounds!" % (position, disk_userdevice)) # For new disks we only track their position. config_new_disks.append((position, disk_userdevice)) # We should append config_changes_disks to config_changes only # if there is at least one changed disk, else skip. for disk_change in config_changes_disks: if disk_change: config_changes.append({"disks_changed": config_changes_disks}) break if config_new_disks: config_changes.append({"disks_new": config_new_disks}) config_changes_cdrom = [] if self.module.params['cdrom']: # Get the list of all CD-ROMs. Filter out any regular disks # found. If we found no existing CD-ROM, we will create it # later else take the first one found. vm_cdrom_params_list = [cdrom_params for cdrom_params in self.vm_params['VBDs'] if cdrom_params['type'] == "CD"] # If no existing CD-ROM is found, we will need to add one. # We need to check if there is any userdevice allowed. if not vm_cdrom_params_list and not vbd_userdevices_allowed: self.module.fail_json(msg="VM check cdrom: maximum number of devices reached!") cdrom_type = self.module.params['cdrom'].get('type') cdrom_iso_name = self.module.params['cdrom'].get('iso_name') # If cdrom.iso_name is specified but cdrom.type is not, # then set cdrom.type to 'iso', unless cdrom.iso_name is # an empty string, in that case set cdrom.type to 'none'. if not cdrom_type: if cdrom_iso_name: cdrom_type = "iso" elif cdrom_iso_name is not None: cdrom_type = "none" self.module.params['cdrom']['type'] = cdrom_type # If type changed. if cdrom_type and (not vm_cdrom_params_list or cdrom_type != self.get_cdrom_type(vm_cdrom_params_list[0])): config_changes_cdrom.append('type') if cdrom_type == "iso": # Check if ISO exists. # Check existence only. Ignore return value. get_object_ref(self.module, cdrom_iso_name, uuid=None, obj_type="ISO image", fail=True, msg_prefix="VM check cdrom.iso_name: ") # Is ISO image changed? if (cdrom_iso_name and (not vm_cdrom_params_list or not vm_cdrom_params_list[0]['VDI'] or cdrom_iso_name != vm_cdrom_params_list[0]['VDI']['name_label'])): config_changes_cdrom.append('iso_name') if config_changes_cdrom: config_changes.append({"cdrom": config_changes_cdrom}) config_changes_networks = [] config_new_networks = [] # Find allowed devices. vif_devices_allowed = self.xapi_session.xenapi.VM.get_allowed_VIF_devices(self.vm_ref) if self.module.params['networks']: # Number of VIFs defined in module params have to be same or # higher than a number of existing VIFs attached to the VM. # We don't support removal of VIFs. if len(self.module.params['networks']) < len(self.vm_params['VIFs']): self.module.fail_json(msg="VM check networks: provided networks configuration has less interfaces than the target VM (%d < %d)!" % (len(self.module.params['networks']), len(self.vm_params['VIFs']))) # Find the highest occupied device. if not self.vm_params['VIFs']: vif_device_highest = "-1" else: vif_device_highest = self.vm_params['VIFs'][-1]['device'] for position in range(len(self.module.params['networks'])): if position < len(self.vm_params['VIFs']): vm_vif_params = self.vm_params['VIFs'][position] else: vm_vif_params = None network_params = self.module.params['networks'][position] network_name = network_params.get('name') if network_name is not None and not network_name: self.module.fail_json(msg="VM check networks[%s]: network name cannot be an empty string!" % position) if network_name: # Check existence only. Ignore return value. get_object_ref(self.module, network_name, uuid=None, obj_type="network", fail=True, msg_prefix="VM check networks[%s]: " % position) network_mac = network_params.get('mac') if network_mac is not None: network_mac = network_mac.lower() if not is_mac(network_mac): self.module.fail_json(msg="VM check networks[%s]: specified MAC address '%s' is not valid!" % (position, network_mac)) # IPv4 reconfiguration. network_type = network_params.get('type') network_ip = network_params.get('ip') network_netmask = network_params.get('netmask') network_prefix = None # If networks.ip is specified and networks.type is not, # then set networks.type to 'static'. if not network_type and network_ip: network_type = "static" # XenServer natively supports only 'none' and 'static' # type with 'none' being the same as 'dhcp'. if self.vm_params['customization_agent'] == "native" and network_type and network_type == "dhcp": network_type = "none" if network_type and network_type == "static": if network_ip is not None: network_ip_split = network_ip.split('/') network_ip = network_ip_split[0] if network_ip and not is_valid_ip_addr(network_ip): self.module.fail_json(msg="VM check networks[%s]: specified IPv4 address '%s' is not valid!" % (position, network_ip)) if len(network_ip_split) > 1: network_prefix = network_ip_split[1] if not is_valid_ip_prefix(network_prefix): self.module.fail_json(msg="VM check networks[%s]: specified IPv4 prefix '%s' is not valid!" % (position, network_prefix)) if network_netmask is not None: if not is_valid_ip_netmask(network_netmask): self.module.fail_json(msg="VM check networks[%s]: specified IPv4 netmask '%s' is not valid!" % (position, network_netmask)) network_prefix = ip_netmask_to_prefix(network_netmask, skip_check=True) elif network_prefix is not None: network_netmask = ip_prefix_to_netmask(network_prefix, skip_check=True) # If any parameter is overridden at this point, update it. if network_type: network_params['type'] = network_type if network_ip: network_params['ip'] = network_ip if network_netmask: network_params['netmask'] = network_netmask if network_prefix: network_params['prefix'] = network_prefix network_gateway = network_params.get('gateway') # Gateway can be an empty string (when removing gateway # configuration) but if it is not, it should be validated. if network_gateway and not is_valid_ip_addr(network_gateway): self.module.fail_json(msg="VM check networks[%s]: specified IPv4 gateway '%s' is not valid!" % (position, network_gateway)) # IPv6 reconfiguration. network_type6 = network_params.get('type6') network_ip6 = network_params.get('ip6') network_prefix6 = None # If networks.ip6 is specified and networks.type6 is not, # then set networks.type6 to 'static'. if not network_type6 and network_ip6: network_type6 = "static" # XenServer natively supports only 'none' and 'static' # type with 'none' being the same as 'dhcp'. if self.vm_params['customization_agent'] == "native" and network_type6 and network_type6 == "dhcp": network_type6 = "none" if network_type6 and network_type6 == "static": if network_ip6 is not None: network_ip6_split = network_ip6.split('/') network_ip6 = network_ip6_split[0] if network_ip6 and not is_valid_ip6_addr(network_ip6): self.module.fail_json(msg="VM check networks[%s]: specified IPv6 address '%s' is not valid!" % (position, network_ip6)) if len(network_ip6_split) > 1: network_prefix6 = network_ip6_split[1] if not is_valid_ip6_prefix(network_prefix6): self.module.fail_json(msg="VM check networks[%s]: specified IPv6 prefix '%s' is not valid!" % (position, network_prefix6)) # If any parameter is overridden at this point, update it. if network_type6: network_params['type6'] = network_type6 if network_ip6: network_params['ip6'] = network_ip6 if network_prefix6: network_params['prefix6'] = network_prefix6 network_gateway6 = network_params.get('gateway6') # Gateway can be an empty string (when removing gateway # configuration) but if it is not, it should be validated. if network_gateway6 and not is_valid_ip6_addr(network_gateway6): self.module.fail_json(msg="VM check networks[%s]: specified IPv6 gateway '%s' is not valid!" % (position, network_gateway6)) # If this is an existing VIF. if vm_vif_params and vm_vif_params['network']: network_changes = [] if network_name and network_name != vm_vif_params['network']['name_label']: network_changes.append('name') if network_mac and network_mac != vm_vif_params['MAC'].lower(): network_changes.append('mac') if self.vm_params['customization_agent'] == "native": if network_type and network_type != vm_vif_params['ipv4_configuration_mode'].lower(): network_changes.append('type') if network_type and network_type == "static": if network_ip and (not vm_vif_params['ipv4_addresses'] or not vm_vif_params['ipv4_addresses'][0] or network_ip != vm_vif_params['ipv4_addresses'][0].split('/')[0]): network_changes.append('ip') if network_prefix and (not vm_vif_params['ipv4_addresses'] or not vm_vif_params['ipv4_addresses'][0] or network_prefix != vm_vif_params['ipv4_addresses'][0].split('/')[1]): network_changes.append('prefix') network_changes.append('netmask') if network_gateway is not None and network_gateway != vm_vif_params['ipv4_gateway']: network_changes.append('gateway') if network_type6 and network_type6 != vm_vif_params['ipv6_configuration_mode'].lower(): network_changes.append('type6') if network_type6 and network_type6 == "static": if network_ip6 and (not vm_vif_params['ipv6_addresses'] or not vm_vif_params['ipv6_addresses'][0] or network_ip6 != vm_vif_params['ipv6_addresses'][0].split('/')[0]): network_changes.append('ip6') if network_prefix6 and (not vm_vif_params['ipv6_addresses'] or not vm_vif_params['ipv6_addresses'][0] or network_prefix6 != vm_vif_params['ipv6_addresses'][0].split('/')[1]): network_changes.append('prefix6') if network_gateway6 is not None and network_gateway6 != vm_vif_params['ipv6_gateway']: network_changes.append('gateway6') elif self.vm_params['customization_agent'] == "custom": vm_xenstore_data = self.vm_params['xenstore_data'] if network_type and network_type != vm_xenstore_data.get('vm-data/networks/%s/type' % vm_vif_params['device'], "none"): network_changes.append('type') need_poweredoff = True if network_type and network_type == "static": if network_ip and network_ip != vm_xenstore_data.get('vm-data/networks/%s/ip' % vm_vif_params['device'], ""): network_changes.append('ip') need_poweredoff = True if network_prefix and network_prefix != vm_xenstore_data.get('vm-data/networks/%s/prefix' % vm_vif_params['device'], ""): network_changes.append('prefix') network_changes.append('netmask') need_poweredoff = True if network_gateway is not None and network_gateway != vm_xenstore_data.get('vm-data/networks/%s/gateway' % vm_vif_params['device'], ""): network_changes.append('gateway') need_poweredoff = True if network_type6 and network_type6 != vm_xenstore_data.get('vm-data/networks/%s/type6' % vm_vif_params['device'], "none"): network_changes.append('type6') need_poweredoff = True if network_type6 and network_type6 == "static": if network_ip6 and network_ip6 != vm_xenstore_data.get('vm-data/networks/%s/ip6' % vm_vif_params['device'], ""): network_changes.append('ip6') need_poweredoff = True if network_prefix6 and network_prefix6 != vm_xenstore_data.get('vm-data/networks/%s/prefix6' % vm_vif_params['device'], ""): network_changes.append('prefix6') need_poweredoff = True if network_gateway6 is not None and network_gateway6 != vm_xenstore_data.get('vm-data/networks/%s/gateway6' % vm_vif_params['device'], ""): network_changes.append('gateway6') need_poweredoff = True config_changes_networks.append(network_changes) # If this is a new VIF. else: if not network_name: self.module.fail_json(msg="VM check networks[%s]: network name is required for new network interface!" % position) if network_type and network_type == "static" and network_ip and not network_netmask: self.module.fail_json(msg="VM check networks[%s]: IPv4 netmask or prefix is required for new network interface!" % position) if network_type6 and network_type6 == "static" and network_ip6 and not network_prefix6: self.module.fail_json(msg="VM check networks[%s]: IPv6 prefix is required for new network interface!" % position) # Restart is needed if we are adding new network # interface with IP/gateway parameters specified # and custom agent is used. if self.vm_params['customization_agent'] == "custom": for parameter in ['type', 'ip', 'prefix', 'gateway', 'type6', 'ip6', 'prefix6', 'gateway6']: if network_params.get(parameter): need_poweredoff = True break if not vif_devices_allowed: self.module.fail_json(msg="VM check networks[%s]: maximum number of network interfaces reached!" % position) # We need to place a new network interface right above the # highest placed existing interface to maintain relative # positions pairable with network interface specifications # in module params. vif_device = str(int(vif_device_highest) + 1) if vif_device not in vif_devices_allowed: self.module.fail_json(msg="VM check networks[%s]: new network interface position %s is out of bounds!" % (position, vif_device)) vif_devices_allowed.remove(vif_device) vif_device_highest = vif_device # For new VIFs we only track their position. config_new_networks.append((position, vif_device)) # We should append config_changes_networks to config_changes only # if there is at least one changed network, else skip. for network_change in config_changes_networks: if network_change: config_changes.append({"networks_changed": config_changes_networks}) break if config_new_networks: config_changes.append({"networks_new": config_new_networks}) config_changes_custom_params = [] if self.module.params['custom_params']: for position in range(len(self.module.params['custom_params'])): custom_param = self.module.params['custom_params'][position] custom_param_key = custom_param['key'] custom_param_value = custom_param['value'] if custom_param_key not in self.vm_params: self.module.fail_json(msg="VM check custom_params[%s]: unknown VM param '%s'!" % (position, custom_param_key)) if custom_param_value != self.vm_params[custom_param_key]: # We only need to track custom param position. config_changes_custom_params.append(position) if config_changes_custom_params: config_changes.append({"custom_params": config_changes_custom_params}) if need_poweredoff: config_changes.append('need_poweredoff') return config_changes except XenAPI.Failure as f: self.module.fail_json(msg="XAPI ERROR: %s" % f.details) def get_normalized_disk_size(self, disk_params, msg_prefix=""): """Parses disk size parameters and returns disk size in bytes. This method tries to parse disk size module parameters. It fails with an error message if size cannot be parsed. Args: disk_params (dist): A dictionary with disk parameters. msg_prefix (str): A string error messages should be prefixed with (default: ""). Returns: int: disk size in bytes if disk size is successfully parsed or None if no disk size parameters were found. """ # There should be only single size spec but we make a list of all size # specs just in case. Priority is given to 'size' but if not found, we # check for 'size_tb', 'size_gb', 'size_mb' etc. and use first one # found. disk_size_spec = [x for x in disk_params.keys() if disk_params[x] is not None and (x.startswith('size_') or x == 'size')] if disk_size_spec: try: # size if "size" in disk_size_spec: size_regex = re.compile(r'(\d+(?:\.\d+)?)\s*(.*)') disk_size_m = size_regex.match(disk_params['size']) if disk_size_m: size = disk_size_m.group(1) unit = disk_size_m.group(2) else: raise ValueError # size_tb, size_gb, size_mb, size_kb, size_b else: size = disk_params[disk_size_spec[0]] unit = disk_size_spec[0].split('_')[-1] if not unit: unit = "b" else: unit = unit.lower() if re.match(r'\d+\.\d+', size): # We found float value in string, let's typecast it. if unit == "b": # If we found float but unit is bytes, we get the integer part only. size = int(float(size)) else: size = float(size) else: # We found int value in string, let's typecast it. size = int(size) if not size or size < 0: raise ValueError except (TypeError, ValueError, NameError): # Common failure self.module.fail_json(msg="%sfailed to parse disk size! Please review value provided using documentation." % msg_prefix) disk_units = dict(tb=4, gb=3, mb=2, kb=1, b=0) if unit in disk_units: return int(size * (1024 ** disk_units[unit])) else: self.module.fail_json(msg="%s'%s' is not a supported unit for disk size! Supported units are ['%s']." % (msg_prefix, unit, "', '".join(sorted(disk_units.keys(), key=lambda key: disk_units[key])))) else: return None @staticmethod def get_cdrom_type(vm_cdrom_params): """Returns VM CD-ROM type.""" # TODO: implement support for detecting type host. No server to test # this on at the moment. if vm_cdrom_params['empty']: return "none" else: return "iso" def main(): argument_spec = xenserver_common_argument_spec() argument_spec.update( state=dict(type='str', default='present', choices=['present', 'absent', 'poweredon']), name=dict(type='str', aliases=['name_label']), name_desc=dict(type='str'), uuid=dict(type='str'), template=dict(type='str', aliases=['template_src']), template_uuid=dict(type='str'), is_template=dict(type='bool', default=False), folder=dict(type='str'), hardware=dict( type='dict', options=dict( num_cpus=dict(type='int'), num_cpu_cores_per_socket=dict(type='int'), memory_mb=dict(type='int'), ), ), disks=dict( type='list', elements='dict', options=dict( size=dict(type='str'), size_tb=dict(type='str'), size_gb=dict(type='str'), size_mb=dict(type='str'), size_kb=dict(type='str'), size_b=dict(type='str'), name=dict(type='str', aliases=['name_label']), name_desc=dict(type='str'), sr=dict(type='str'), sr_uuid=dict(type='str'), ), aliases=['disk'], mutually_exclusive=[ ['size', 'size_tb', 'size_gb', 'size_mb', 'size_kb', 'size_b'], ['sr', 'sr_uuid'], ], ), cdrom=dict( type='dict', options=dict( type=dict(type='str', choices=['none', 'iso']), iso_name=dict(type='str'), ), required_if=[ ['type', 'iso', ['iso_name']], ], ), networks=dict( type='list', elements='dict', options=dict( name=dict(type='str', aliases=['name_label']), mac=dict(type='str'), type=dict(type='str', choices=['none', 'dhcp', 'static']), ip=dict(type='str'), netmask=dict(type='str'), gateway=dict(type='str'), type6=dict(type='str', choices=['none', 'dhcp', 'static']), ip6=dict(type='str'), gateway6=dict(type='str'), ), aliases=['network'], required_if=[ ['type', 'static', ['ip']], ['type6', 'static', ['ip6']], ], ), home_server=dict(type='str'), custom_params=dict( type='list', elements='dict', options=dict( key=dict(type='str', required=True, no_log=False), value=dict(type='raw', required=True), ), ), wait_for_ip_address=dict(type='bool', default=False), state_change_timeout=dict(type='int', default=0), linked_clone=dict(type='bool', default=False), force=dict(type='bool', default=False), ) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, required_one_of=[ ['name', 'uuid'], ], mutually_exclusive=[ ['template', 'template_uuid'], ], ) result = {'failed': False, 'changed': False} vm = XenServerVM(module) # Find existing VM if vm.exists(): if module.params['state'] == "absent": vm.destroy() result['changed'] = True elif module.params['state'] == "present": config_changes = vm.reconfigure() if config_changes: result['changed'] = True # Make new disk and network changes more user friendly # and informative. for change in config_changes: if isinstance(change, dict): if change.get('disks_new'): disks_new = [] for position, userdevice in change['disks_new']: disk_new_params = {"position": position, "vbd_userdevice": userdevice} disk_params = module.params['disks'][position] for k in disk_params.keys(): if disk_params[k] is not None: disk_new_params[k] = disk_params[k] disks_new.append(disk_new_params) if disks_new: change['disks_new'] = disks_new elif change.get('networks_new'): networks_new = [] for position, device in change['networks_new']: network_new_params = {"position": position, "vif_device": device} network_params = module.params['networks'][position] for k in network_params.keys(): if network_params[k] is not None: network_new_params[k] = network_params[k] networks_new.append(network_new_params) if networks_new: change['networks_new'] = networks_new result['changes'] = config_changes elif module.params['state'] in ["poweredon", "poweredoff", "restarted", "shutdownguest", "rebootguest", "suspended"]: result['changed'] = vm.set_power_state(module.params['state']) elif module.params['state'] != "absent": vm.deploy() result['changed'] = True if module.params['wait_for_ip_address'] and module.params['state'] != "absent": vm.wait_for_ip_address() result['instance'] = vm.gather_facts() if result['failed']: module.fail_json(**result) else: module.exit_json(**result) if __name__ == '__main__': main() PK $�!\��y�� � S collections/ansible_collections/community/general/plugins/modules/rpm_ostree_pkg.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Dusty Mabe <dusty@dustymabe.com> # Copyright (c) 2018, Ansible Project # Copyright (c) 2021, Abhijeet Kasurde <akasurde@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: rpm_ostree_pkg short_description: Install or uninstall overlay additional packages version_added: "2.0.0" description: - Install or uninstall overlay additional packages using C(rpm-ostree) command. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - Name of overlay package to install or remove. required: true type: list elements: str aliases: [ pkg ] state: description: - State of the overlay package. - V(present) simply ensures that a desired package is installed. - V(absent) removes the specified package. choices: [ 'absent', 'present' ] default: 'present' type: str author: - Dusty Mabe (@dustymabe) - Abhijeet Kasurde (@Akasurde) ''' EXAMPLES = r''' - name: Install overlay package community.general.rpm_ostree_pkg: name: nfs-utils state: present - name: Remove overlay package community.general.rpm_ostree_pkg: name: nfs-utils state: absent ''' RETURN = r''' rc: description: Return code of rpm-ostree command. returned: always type: int sample: 0 changed: description: State changes. returned: always type: bool sample: true action: description: Action performed. returned: always type: str sample: 'install' packages: description: A list of packages specified. returned: always type: list sample: ['nfs-utils'] stdout: description: Stdout of rpm-ostree command. returned: always type: str sample: 'Staging deployment...done\n...' stderr: description: Stderr of rpm-ostree command. returned: always type: str sample: '' cmd: description: Full command used for performed action. returned: always type: str sample: 'rpm-ostree uninstall --allow-inactive --idempotent --unchanged-exit-77 nfs-utils' ''' from ansible.module_utils.basic import AnsibleModule class RpmOstreePkg: def __init__(self, module): self.module = module self.params = module.params self.state = module.params['state'] def ensure(self): results = dict( rc=0, changed=False, action='', packages=[], stdout='', stderr='', cmd='', ) # Ensure rpm-ostree command exists cmd = [self.module.get_bin_path('rpm-ostree', required=True)] # Decide action to perform if self.state in ('present'): results['action'] = 'install' cmd.append('install') elif self.state in ('absent'): results['action'] = 'uninstall' cmd.append('uninstall') # Additional parameters cmd.extend(['--allow-inactive', '--idempotent', '--unchanged-exit-77']) for pkg in self.params['name']: cmd.append(pkg) results['packages'].append(pkg) rc, out, err = self.module.run_command(cmd) results.update(dict( rc=rc, cmd=' '.join(cmd), stdout=out, stderr=err, )) # A few possible options: # - rc=0 - succeeded in making a change # - rc=77 - no change was needed # - rc=? - error if rc == 0: results['changed'] = True elif rc == 77: results['changed'] = False results['rc'] = 0 else: self.module.fail_json(msg='non-zero return code', **results) self.module.exit_json(**results) def main(): module = AnsibleModule( argument_spec=dict( state=dict( default="present", choices=['absent', 'present'] ), name=dict( aliases=["pkg"], required=True, type='list', elements='str', ), ), ) rpm_ostree_pkg = RpmOstreePkg(module) rpm_ostree_pkg.ensure() if __name__ == '__main__': main() PK $�!\ �%�B �B N collections/ansible_collections/community/general/plugins/modules/clc_group.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2015 CenturyLink # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: clc_group short_description: Create/delete Server Groups at Centurylink Cloud description: - Create or delete Server Groups at Centurylink Centurylink Cloud extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name of the Server Group type: str required: true description: description: - A description of the Server Group type: str required: false parent: description: - The parent group of the server group. If parent is not provided, it creates the group at top level. type: str required: false location: description: - Datacenter to create the group in. If location is not provided, the group gets created in the default datacenter associated with the account type: str required: false state: description: - Whether to create or delete the group type: str default: present choices: ['present', 'absent'] wait: description: - Whether to wait for the tasks to finish before returning. type: bool default: true required: false requirements: - python = 2.7 - requests >= 2.5.0 - clc-sdk author: "CLC Runner (@clc-runner)" notes: - To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud - CLC_V2_API_USERNAME, the account login id for the centurylink cloud - CLC_V2_API_PASSWORD, the account password for the centurylink cloud - Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account login and password via the HTTP api call @ https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, the API token generated from https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, the account alias associated with the centurylink cloud - Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment. ''' EXAMPLES = ''' # Create a Server Group --- - name: Create Server Group hosts: localhost gather_facts: false connection: local tasks: - name: Create / Verify a Server Group at CenturyLink Cloud community.general.clc_group: name: My Cool Server Group parent: Default Group state: present register: clc - name: Debug ansible.builtin.debug: var: clc # Delete a Server Group - name: Delete Server Group hosts: localhost gather_facts: false connection: local tasks: - name: Delete / Verify Absent a Server Group at CenturyLink Cloud community.general.clc_group: name: My Cool Server Group parent: Default Group state: absent register: clc - name: Debug ansible.builtin.debug: var: clc ''' RETURN = ''' group: description: The group information returned: success type: dict sample: { "changeInfo":{ "createdBy":"service.wfad", "createdDate":"2015-07-29T18:52:47Z", "modifiedBy":"service.wfad", "modifiedDate":"2015-07-29T18:52:47Z" }, "customFields":[ ], "description":"test group", "groups":[ ], "id":"bb5f12a3c6044ae4ad0a03e73ae12cd1", "links":[ { "href":"/v2/groups/wfad", "rel":"createGroup", "verbs":[ "POST" ] }, { "href":"/v2/servers/wfad", "rel":"createServer", "verbs":[ "POST" ] }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1", "rel":"self", "verbs":[ "GET", "PATCH", "DELETE" ] }, { "href":"/v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0", "id":"086ac1dfe0b6411989e8d1b77c4065f0", "rel":"parentGroup" }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/defaults", "rel":"defaults", "verbs":[ "GET", "POST" ] }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/billing", "rel":"billing" }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/archive", "rel":"archiveGroupAction" }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/statistics", "rel":"statistics" }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/upcomingScheduledActivities", "rel":"upcomingScheduledActivities" }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/horizontalAutoscalePolicy", "rel":"horizontalAutoscalePolicyMapping", "verbs":[ "GET", "PUT", "DELETE" ] }, { "href":"/v2/groups/wfad/bb5f12a3c6044ae4ad0a03e73ae12cd1/scheduledActivities", "rel":"scheduledActivities", "verbs":[ "GET", "POST" ] } ], "locationId":"UC1", "name":"test group", "status":"active", "type":"default" } ''' __version__ = '${version}' import os import traceback from ansible_collections.community.general.plugins.module_utils.version import LooseVersion REQUESTS_IMP_ERR = None try: import requests except ImportError: REQUESTS_IMP_ERR = traceback.format_exc() REQUESTS_FOUND = False else: REQUESTS_FOUND = True # # Requires the clc-python-sdk. # sudo pip install clc-sdk # CLC_IMP_ERR = None try: import clc as clc_sdk from clc import CLCException except ImportError: CLC_IMP_ERR = traceback.format_exc() CLC_FOUND = False clc_sdk = None else: CLC_FOUND = True from ansible.module_utils.basic import AnsibleModule, missing_required_lib class ClcGroup(object): clc = None root_group = None def __init__(self, module): """ Construct module """ self.clc = clc_sdk self.module = module self.group_dict = {} if not CLC_FOUND: self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR) if not REQUESTS_FOUND: self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR) if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'): self.module.fail_json( msg='requests library version should be >= 2.5.0') self._set_user_agent(self.clc) def process_request(self): """ Execute the main code path, and handle the request :return: none """ location = self.module.params.get('location') group_name = self.module.params.get('name') parent_name = self.module.params.get('parent') group_description = self.module.params.get('description') state = self.module.params.get('state') self._set_clc_credentials_from_env() self.group_dict = self._get_group_tree_for_datacenter( datacenter=location) if state == "absent": changed, group, requests = self._ensure_group_is_absent( group_name=group_name, parent_name=parent_name) if requests: self._wait_for_requests_to_complete(requests) else: changed, group = self._ensure_group_is_present( group_name=group_name, parent_name=parent_name, group_description=group_description) try: group = group.data except AttributeError: group = group_name self.module.exit_json(changed=changed, group=group) @staticmethod def _define_module_argument_spec(): """ Define the argument spec for the ansible module :return: argument spec dictionary """ argument_spec = dict( name=dict(required=True), description=dict(), parent=dict(), location=dict(), state=dict(default='present', choices=['present', 'absent']), wait=dict(type='bool', default=True)) return argument_spec def _set_clc_credentials_from_env(self): """ Set the CLC Credentials on the sdk by reading environment variables :return: none """ env = os.environ v2_api_token = env.get('CLC_V2_API_TOKEN', False) v2_api_username = env.get('CLC_V2_API_USERNAME', False) v2_api_passwd = env.get('CLC_V2_API_PASSWD', False) clc_alias = env.get('CLC_ACCT_ALIAS', False) api_url = env.get('CLC_V2_API_URL', False) if api_url: self.clc.defaults.ENDPOINT_URL_V2 = api_url if v2_api_token and clc_alias: self.clc._LOGIN_TOKEN_V2 = v2_api_token self.clc._V2_ENABLED = True self.clc.ALIAS = clc_alias elif v2_api_username and v2_api_passwd: self.clc.v2.SetCredentials( api_username=v2_api_username, api_passwd=v2_api_passwd) else: return self.module.fail_json( msg="You must set the CLC_V2_API_USERNAME and CLC_V2_API_PASSWD " "environment variables") def _ensure_group_is_absent(self, group_name, parent_name): """ Ensure that group_name is absent by deleting it if necessary :param group_name: string - the name of the clc server group to delete :param parent_name: string - the name of the parent group for group_name :return: changed, group """ changed = False group = [] results = [] if self._group_exists(group_name=group_name, parent_name=parent_name): if not self.module.check_mode: group.append(group_name) result = self._delete_group(group_name) results.append(result) changed = True return changed, group, results def _delete_group(self, group_name): """ Delete the provided server group :param group_name: string - the server group to delete :return: none """ response = None group, parent = self.group_dict.get(group_name) try: response = group.Delete() except CLCException as ex: self.module.fail_json(msg='Failed to delete group :{0}. {1}'.format( group_name, ex.response_text )) return response def _ensure_group_is_present( self, group_name, parent_name, group_description): """ Checks to see if a server group exists, creates it if it doesn't. :param group_name: the name of the group to validate/create :param parent_name: the name of the parent group for group_name :param group_description: a short description of the server group (used when creating) :return: (changed, group) - changed: Boolean- whether a change was made, group: A clc group object for the group """ if not self.root_group: raise AssertionError("Implementation Error: Root Group not set") parent = parent_name if parent_name is not None else self.root_group.name description = group_description changed = False group = group_name parent_exists = self._group_exists(group_name=parent, parent_name=None) child_exists = self._group_exists( group_name=group_name, parent_name=parent) if parent_exists and child_exists: group, parent = self.group_dict[group_name] changed = False elif parent_exists and not child_exists: if not self.module.check_mode: group = self._create_group( group=group, parent=parent, description=description) changed = True else: self.module.fail_json( msg="parent group: " + parent + " does not exist") return changed, group def _create_group(self, group, parent, description): """ Create the provided server group :param group: clc_sdk.Group - the group to create :param parent: clc_sdk.Parent - the parent group for {group} :param description: string - a text description of the group :return: clc_sdk.Group - the created group """ response = None (parent, grandparent) = self.group_dict[parent] try: response = parent.Create(name=group, description=description) except CLCException as ex: self.module.fail_json(msg='Failed to create group :{0}. {1}'.format( group, ex.response_text)) return response def _group_exists(self, group_name, parent_name): """ Check to see if a group exists :param group_name: string - the group to check :param parent_name: string - the parent of group_name :return: boolean - whether the group exists """ result = False if group_name in self.group_dict: (group, parent) = self.group_dict[group_name] if parent_name is None or parent_name == parent.name: result = True return result def _get_group_tree_for_datacenter(self, datacenter=None): """ Walk the tree of groups for a datacenter :param datacenter: string - the datacenter to walk (ex: 'UC1') :return: a dictionary of groups and parents """ self.root_group = self.clc.v2.Datacenter( location=datacenter).RootGroup() return self._walk_groups_recursive( parent_group=None, child_group=self.root_group) def _walk_groups_recursive(self, parent_group, child_group): """ Walk a parent-child tree of groups, starting with the provided child group :param parent_group: clc_sdk.Group - the parent group to start the walk :param child_group: clc_sdk.Group - the child group to start the walk :return: a dictionary of groups and parents """ result = {str(child_group): (child_group, parent_group)} groups = child_group.Subgroups().groups if len(groups) > 0: for group in groups: if group.type != 'default': continue result.update(self._walk_groups_recursive(child_group, group)) return result def _wait_for_requests_to_complete(self, requests_lst): """ Waits until the CLC requests are complete if the wait argument is True :param requests_lst: The list of CLC request objects :return: none """ if not self.module.params['wait']: return for request in requests_lst: request.WaitUntilComplete() for request_details in request.requests: if request_details.Status() != 'succeeded': self.module.fail_json( msg='Unable to process group request') @staticmethod def _set_user_agent(clc): if hasattr(clc, 'SetRequestsSession'): agent_string = "ClcAnsibleModule/" + __version__ ses = requests.Session() ses.headers.update({"Api-Client": agent_string}) ses.headers['User-Agent'] += " " + agent_string clc.SetRequestsSession(ses) def main(): """ The main function. Instantiates the module and calls process_request. :return: none """ module = AnsibleModule( argument_spec=ClcGroup._define_module_argument_spec(), supports_check_mode=True) clc_group = ClcGroup(module) clc_group.process_request() if __name__ == '__main__': main() PK $�!\�"�VJ VJ Q collections/ansible_collections/community/general/plugins/modules/ipa_sudorule.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_sudorule author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA sudo rule description: - Add, modify or delete sudo rule within IPA server using IPA API. attributes: check_mode: support: full diff_mode: support: none options: cn: description: - Canonical name. - Can not be changed as it is the unique identifier. required: true aliases: ['name'] type: str cmdcategory: description: - Command category the rule applies to. choices: ['all'] type: str cmd: description: - List of commands assigned to the rule. - If an empty list is passed all commands will be removed from the rule. - If option is omitted commands will not be checked or changed. type: list elements: str cmdgroup: description: - List of command groups assigned to the rule. - If an empty list is passed all command groups will be removed from the rule. - If option is omitted command groups will not be checked or changed. type: list elements: str version_added: 2.0.0 description: description: - Description of the sudo rule. type: str host: description: - List of hosts assigned to the rule. - If an empty list is passed all hosts will be removed from the rule. - If option is omitted hosts will not be checked or changed. - Option O(hostcategory) must be omitted to assign hosts. type: list elements: str hostcategory: description: - Host category the rule applies to. - If V(all) is passed one must omit O(host) and O(hostgroup). - Option O(host) and O(hostgroup) must be omitted to assign V(all). choices: ['all'] type: str hostgroup: description: - List of host groups assigned to the rule. - If an empty list is passed all host groups will be removed from the rule. - If option is omitted host groups will not be checked or changed. - Option O(hostcategory) must be omitted to assign host groups. type: list elements: str runasextusers: description: - List of external RunAs users type: list elements: str version_added: 2.3.0 runasusercategory: description: - RunAs User category the rule applies to. choices: ['all'] type: str runasgroupcategory: description: - RunAs Group category the rule applies to. choices: ['all'] type: str sudoopt: description: - List of options to add to the sudo rule. type: list elements: str user: description: - List of users assigned to the rule. - If an empty list is passed all users will be removed from the rule. - If option is omitted users will not be checked or changed. type: list elements: str usercategory: description: - User category the rule applies to. choices: ['all'] type: str usergroup: description: - List of user groups assigned to the rule. - If an empty list is passed all user groups will be removed from the rule. - If option is omitted user groups will not be checked or changed. type: list elements: str state: description: State to ensure. default: present choices: ['absent', 'disabled', 'enabled', 'present'] type: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked for a password. community.general.ipa_sudorule: name: sudo_all_nopasswd cmdcategory: all description: Allow to run every command with sudo without password hostcategory: all sudoopt: - '!authenticate' usercategory: all ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure user group developers can run every command on host group db-server as well as on host db01.example.com. community.general.ipa_sudorule: name: sudo_dev_dbserver description: Allow developers to run every command with sudo on all database server cmdcategory: all host: - db01.example.com hostgroup: - db-server sudoopt: - '!authenticate' usergroup: - developers ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure user group operations can run any commands that is part of operations-cmdgroup on any host as user root. community.general.ipa_sudorule: name: sudo_operations_all description: Allow operators to run any commands that is part of operations-cmdgroup on any host as user root. cmdgroup: - operations-cmdgroup hostcategory: all runasextusers: - root sudoopt: - '!authenticate' usergroup: - operators ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' sudorule: description: Sudorule as returned by IPA returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class SudoRuleIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(SudoRuleIPAClient, self).__init__(module, host, port, protocol) def sudorule_find(self, name): return self._post_json(method='sudorule_find', name=None, item={'all': True, 'cn': name}) def sudorule_add(self, name, item): return self._post_json(method='sudorule_add', name=name, item=item) def sudorule_add_runasuser(self, name, item): return self._post_json(method='sudorule_add_runasuser', name=name, item={'user': item}) def sudorule_remove_runasuser(self, name, item): return self._post_json(method='sudorule_remove_runasuser', name=name, item={'user': item}) def sudorule_mod(self, name, item): return self._post_json(method='sudorule_mod', name=name, item=item) def sudorule_del(self, name): return self._post_json(method='sudorule_del', name=name) def sudorule_add_option(self, name, item): return self._post_json(method='sudorule_add_option', name=name, item=item) def sudorule_add_option_ipasudoopt(self, name, item): return self.sudorule_add_option(name=name, item={'ipasudoopt': item}) def sudorule_remove_option(self, name, item): return self._post_json(method='sudorule_remove_option', name=name, item=item) def sudorule_remove_option_ipasudoopt(self, name, item): return self.sudorule_remove_option(name=name, item={'ipasudoopt': item}) def sudorule_add_host(self, name, item): return self._post_json(method='sudorule_add_host', name=name, item=item) def sudorule_add_host_host(self, name, item): return self.sudorule_add_host(name=name, item={'host': item}) def sudorule_add_host_hostgroup(self, name, item): return self.sudorule_add_host(name=name, item={'hostgroup': item}) def sudorule_remove_host(self, name, item): return self._post_json(method='sudorule_remove_host', name=name, item=item) def sudorule_remove_host_host(self, name, item): return self.sudorule_remove_host(name=name, item={'host': item}) def sudorule_remove_host_hostgroup(self, name, item): return self.sudorule_remove_host(name=name, item={'hostgroup': item}) def sudorule_add_allow_command(self, name, item): return self._post_json(method='sudorule_add_allow_command', name=name, item={'sudocmd': item}) def sudorule_add_allow_command_group(self, name, item): return self._post_json(method='sudorule_add_allow_command', name=name, item={'sudocmdgroup': item}) def sudorule_remove_allow_command(self, name, item): return self._post_json(method='sudorule_remove_allow_command', name=name, item=item) def sudorule_add_user(self, name, item): return self._post_json(method='sudorule_add_user', name=name, item=item) def sudorule_add_user_user(self, name, item): return self.sudorule_add_user(name=name, item={'user': item}) def sudorule_add_user_group(self, name, item): return self.sudorule_add_user(name=name, item={'group': item}) def sudorule_remove_user(self, name, item): return self._post_json(method='sudorule_remove_user', name=name, item=item) def sudorule_remove_user_user(self, name, item): return self.sudorule_remove_user(name=name, item={'user': item}) def sudorule_remove_user_group(self, name, item): return self.sudorule_remove_user(name=name, item={'group': item}) def get_sudorule_dict(cmdcategory=None, description=None, hostcategory=None, ipaenabledflag=None, usercategory=None, runasgroupcategory=None, runasusercategory=None): data = {} if cmdcategory is not None: data['cmdcategory'] = cmdcategory if description is not None: data['description'] = description if hostcategory is not None: data['hostcategory'] = hostcategory if ipaenabledflag is not None: data['ipaenabledflag'] = ipaenabledflag if usercategory is not None: data['usercategory'] = usercategory if runasusercategory is not None: data['ipasudorunasusercategory'] = runasusercategory if runasgroupcategory is not None: data['ipasudorunasgroupcategory'] = runasgroupcategory return data def category_changed(module, client, category_name, ipa_sudorule): if ipa_sudorule.get(category_name, None) == ['all']: if not module.check_mode: # cn is returned as list even with only a single value. client.sudorule_mod(name=ipa_sudorule.get('cn')[0], item={category_name: None}) return True return False def ensure(module, client): state = module.params['state'] name = module.params['cn'] cmd = module.params['cmd'] cmdgroup = module.params['cmdgroup'] cmdcategory = module.params['cmdcategory'] host = module.params['host'] hostcategory = module.params['hostcategory'] hostgroup = module.params['hostgroup'] runasusercategory = module.params['runasusercategory'] runasgroupcategory = module.params['runasgroupcategory'] runasextusers = module.params['runasextusers'] if state in ['present', 'enabled']: ipaenabledflag = 'TRUE' else: ipaenabledflag = 'FALSE' sudoopt = module.params['sudoopt'] user = module.params['user'] usercategory = module.params['usercategory'] usergroup = module.params['usergroup'] module_sudorule = get_sudorule_dict(cmdcategory=cmdcategory, description=module.params['description'], hostcategory=hostcategory, ipaenabledflag=ipaenabledflag, usercategory=usercategory, runasusercategory=runasusercategory, runasgroupcategory=runasgroupcategory) ipa_sudorule = client.sudorule_find(name=name) changed = False if state in ['present', 'disabled', 'enabled']: if not ipa_sudorule: changed = True if not module.check_mode: ipa_sudorule = client.sudorule_add(name=name, item=module_sudorule) else: diff = client.get_diff(ipa_sudorule, module_sudorule) if len(diff) > 0: changed = True if not module.check_mode: if 'hostcategory' in diff: if ipa_sudorule.get('memberhost_host', None) is not None: client.sudorule_remove_host_host(name=name, item=ipa_sudorule.get('memberhost_host')) if ipa_sudorule.get('memberhost_hostgroup', None) is not None: client.sudorule_remove_host_hostgroup(name=name, item=ipa_sudorule.get('memberhost_hostgroup')) client.sudorule_mod(name=name, item=module_sudorule) if cmd is not None: changed = category_changed(module, client, 'cmdcategory', ipa_sudorule) or changed if not module.check_mode: client.sudorule_add_allow_command(name=name, item=cmd) if cmdgroup is not None: changed = category_changed(module, client, 'cmdcategory', ipa_sudorule) or changed if not module.check_mode: client.sudorule_add_allow_command_group(name=name, item=cmdgroup) if runasusercategory is not None: changed = category_changed(module, client, 'iparunasusercategory', ipa_sudorule) or changed if runasgroupcategory is not None: changed = category_changed(module, client, 'iparunasgroupcategory', ipa_sudorule) or changed if host is not None: changed = category_changed(module, client, 'hostcategory', ipa_sudorule) or changed changed = client.modify_if_diff(name, ipa_sudorule.get('memberhost_host', []), host, client.sudorule_add_host_host, client.sudorule_remove_host_host) or changed if hostgroup is not None: changed = category_changed(module, client, 'hostcategory', ipa_sudorule) or changed changed = client.modify_if_diff(name, ipa_sudorule.get('memberhost_hostgroup', []), hostgroup, client.sudorule_add_host_hostgroup, client.sudorule_remove_host_hostgroup) or changed if sudoopt is not None: # client.modify_if_diff does not work as each option must be removed/added by its own ipa_list = ipa_sudorule.get('ipasudoopt', []) module_list = sudoopt diff = list(set(ipa_list) - set(module_list)) if len(diff) > 0: changed = True if not module.check_mode: for item in diff: client.sudorule_remove_option_ipasudoopt(name, item) diff = list(set(module_list) - set(ipa_list)) if len(diff) > 0: changed = True if not module.check_mode: for item in diff: client.sudorule_add_option_ipasudoopt(name, item) if runasextusers is not None: ipa_sudorule_run_as_user = ipa_sudorule.get('ipasudorunasextuser', []) diff = list(set(ipa_sudorule_run_as_user) - set(runasextusers)) if len(diff) > 0: changed = True if not module.check_mode: for item in diff: client.sudorule_remove_runasuser(name=name, item=item) diff = list(set(runasextusers) - set(ipa_sudorule_run_as_user)) if len(diff) > 0: changed = True if not module.check_mode: for item in diff: client.sudorule_add_runasuser(name=name, item=item) if user is not None: changed = category_changed(module, client, 'usercategory', ipa_sudorule) or changed changed = client.modify_if_diff(name, ipa_sudorule.get('memberuser_user', []), user, client.sudorule_add_user_user, client.sudorule_remove_user_user) or changed if usergroup is not None: changed = category_changed(module, client, 'usercategory', ipa_sudorule) or changed changed = client.modify_if_diff(name, ipa_sudorule.get('memberuser_group', []), usergroup, client.sudorule_add_user_group, client.sudorule_remove_user_group) or changed else: if ipa_sudorule: changed = True if not module.check_mode: client.sudorule_del(name) return changed, client.sudorule_find(name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cmd=dict(type='list', elements='str'), cmdgroup=dict(type='list', elements='str'), cmdcategory=dict(type='str', choices=['all']), cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), host=dict(type='list', elements='str'), hostcategory=dict(type='str', choices=['all']), hostgroup=dict(type='list', elements='str'), runasusercategory=dict(type='str', choices=['all']), runasgroupcategory=dict(type='str', choices=['all']), sudoopt=dict(type='list', elements='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), user=dict(type='list', elements='str'), usercategory=dict(type='str', choices=['all']), usergroup=dict(type='list', elements='str'), runasextusers=dict(type='list', elements='str')) module = AnsibleModule(argument_spec=argument_spec, mutually_exclusive=[['cmdcategory', 'cmd'], ['cmdcategory', 'cmdgroup'], ['hostcategory', 'host'], ['hostcategory', 'hostgroup'], ['usercategory', 'user'], ['usercategory', 'usergroup']], supports_check_mode=True) client = SudoRuleIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, sudorule = ensure(module, client) module.exit_json(changed=changed, sudorule=sudorule) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\�"�N ! ! U collections/ansible_collections/community/general/plugins/modules/profitbricks_nic.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: profitbricks_nic short_description: Create or Remove a NIC description: - This module allows you to create or restore a volume snapshot. This module has a dependency on profitbricks >= 1.0.0 extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: datacenter: description: - The datacenter in which to operate. type: str required: true server: description: - The server name or ID. type: str required: true name: description: - The name or ID of the NIC. This is only required on deletes, but not on create. - If not specified, it defaults to a value based on UUID4. type: str lan: description: - The LAN to place the NIC on. You can pass a LAN that doesn't exist and it will be created. Required on create. type: str subscription_user: description: - The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable. type: str required: true subscription_password: description: - THe ProfitBricks password. Overrides the PB_PASSWORD environment variable. type: str required: true wait: description: - wait for the operation to complete before returning required: false default: true type: bool wait_timeout: description: - how long before wait gives up, in seconds type: int default: 600 state: description: - Indicate desired state of the resource - "The available choices are: V(present), V(absent)." type: str required: false default: 'present' requirements: [ "profitbricks" ] author: Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com> ''' EXAMPLES = ''' - name: Create a NIC community.general.profitbricks_nic: datacenter: Tardis One server: node002 lan: 2 wait_timeout: 500 state: present - name: Remove a NIC community.general.profitbricks_nic: datacenter: Tardis One server: node002 name: 7341c2454f wait_timeout: 500 state: absent ''' import re import uuid import time HAS_PB_SDK = True try: from profitbricks.client import ProfitBricksService, NIC except ImportError: HAS_PB_SDK = False from ansible.module_utils.basic import AnsibleModule uuid_match = re.compile( r'[\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}', re.I) def _make_default_name(): return str(uuid.uuid4()).replace('-', '')[:10] def _wait_for_completion(profitbricks, promise, wait_timeout, msg): if not promise: return wait_timeout = time.time() + wait_timeout while wait_timeout > time.time(): time.sleep(5) operation_result = profitbricks.get_request( request_id=promise['requestId'], status=True) if operation_result['metadata']['status'] == "DONE": return elif operation_result['metadata']['status'] == "FAILED": raise Exception( 'Request failed to complete ' + msg + ' "' + str( promise['requestId']) + '" to complete.') raise Exception( 'Timed out waiting for async operation ' + msg + ' "' + str( promise['requestId'] ) + '" to complete.') def create_nic(module, profitbricks): """ Creates a NIC. module : AnsibleModule object profitbricks: authenticated profitbricks object. Returns: True if the nic creates, false otherwise """ datacenter = module.params.get('datacenter') server = module.params.get('server') lan = module.params.get('lan') name = module.params.get('name') if name is None: name = _make_default_name() wait = module.params.get('wait') wait_timeout = module.params.get('wait_timeout') # Locate UUID for Datacenter if not (uuid_match.match(datacenter)): datacenter_list = profitbricks.list_datacenters() for d in datacenter_list['items']: dc = profitbricks.get_datacenter(d['id']) if datacenter == dc['properties']['name']: datacenter = d['id'] break # Locate UUID for Server if not (uuid_match.match(server)): server_list = profitbricks.list_servers(datacenter) for s in server_list['items']: if server == s['properties']['name']: server = s['id'] break try: n = NIC( name=name, lan=lan ) nic_response = profitbricks.create_nic(datacenter, server, n) if wait: _wait_for_completion(profitbricks, nic_response, wait_timeout, "create_nic") return nic_response except Exception as e: module.fail_json(msg="failed to create the NIC: %s" % str(e)) def delete_nic(module, profitbricks): """ Removes a NIC module : AnsibleModule object profitbricks: authenticated profitbricks object. Returns: True if the NIC was removed, false otherwise """ datacenter = module.params.get('datacenter') server = module.params.get('server') name = module.params.get('name') if name is None: name = _make_default_name() # Locate UUID for Datacenter if not (uuid_match.match(datacenter)): datacenter_list = profitbricks.list_datacenters() for d in datacenter_list['items']: dc = profitbricks.get_datacenter(d['id']) if datacenter == dc['properties']['name']: datacenter = d['id'] break # Locate UUID for Server server_found = False if not (uuid_match.match(server)): server_list = profitbricks.list_servers(datacenter) for s in server_list['items']: if server == s['properties']['name']: server_found = True server = s['id'] break if not server_found: return False # Locate UUID for NIC nic_found = False if not (uuid_match.match(name)): nic_list = profitbricks.list_nics(datacenter, server) for n in nic_list['items']: if name == n['properties']['name']: nic_found = True name = n['id'] break if not nic_found: return False try: nic_response = profitbricks.delete_nic(datacenter, server, name) return nic_response except Exception as e: module.fail_json(msg="failed to remove the NIC: %s" % str(e)) def main(): module = AnsibleModule( argument_spec=dict( datacenter=dict(required=True), server=dict(required=True), name=dict(), lan=dict(), subscription_user=dict(required=True), subscription_password=dict(required=True, no_log=True), wait=dict(type='bool', default=True), wait_timeout=dict(type='int', default=600), state=dict(default='present'), ), required_if=( ('state', 'absent', ['name']), ('state', 'present', ['lan']), ) ) if not HAS_PB_SDK: module.fail_json(msg='profitbricks required for this module') subscription_user = module.params.get('subscription_user') subscription_password = module.params.get('subscription_password') profitbricks = ProfitBricksService( username=subscription_user, password=subscription_password) state = module.params.get('state') if state == 'absent': try: (changed) = delete_nic(module, profitbricks) module.exit_json(changed=changed) except Exception as e: module.fail_json(msg='failed to set nic state: %s' % str(e)) elif state == 'present': try: (nic_dict) = create_nic(module, profitbricks) module.exit_json(nics=nic_dict) # @FIXME changed not calculated? except Exception as e: module.fail_json(msg='failed to set nic state: %s' % str(e)) if __name__ == '__main__': main() PK $�!\ u� � K collections/ansible_collections/community/general/plugins/modules/mksysb.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Alexei Znamensky (@russoz) <russoz@gmail.com> # Copyright (c) 2017, Kairo Araujo <kairo@kairo.eti.br> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- author: Kairo Araujo (@kairoaraujo) module: mksysb short_description: Generates AIX mksysb rootvg backups description: - This module manages a basic AIX mksysb (image) of rootvg. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: backup_crypt_files: description: - Backup encrypted files. type: bool default: true backup_dmapi_fs: description: - Back up DMAPI filesystem files. type: bool default: true create_map_files: description: - Creates a new MAP files. type: bool default: false exclude_files: description: - Excludes files using C(/etc/rootvg.exclude). type: bool default: false exclude_wpar_files: description: - Excludes WPAR files. type: bool default: false extended_attrs: description: - Backup extended attributes. type: bool default: true name: type: str description: - Backup name required: true new_image_data: description: - Creates a new file data. type: bool default: true software_packing: description: - Exclude files from packing option listed in C(/etc/exclude_packing.rootvg). type: bool default: false storage_path: type: str description: - Storage path where the mksysb will stored. required: true use_snapshot: description: - Creates backup using snapshots. type: bool default: false ''' EXAMPLES = ''' - name: Running a backup image mksysb community.general.mksysb: name: myserver storage_path: /repository/images exclude_files: true exclude_wpar_files: true ''' RETURN = ''' changed: description: Return changed for mksysb actions as true or false. returned: always type: bool msg: description: Return message regarding the action. returned: always type: str ''' import os from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper class MkSysB(ModuleHelper): module = dict( argument_spec=dict( backup_crypt_files=dict(type='bool', default=True), backup_dmapi_fs=dict(type='bool', default=True), create_map_files=dict(type='bool', default=False), exclude_files=dict(type='bool', default=False), exclude_wpar_files=dict(type='bool', default=False), extended_attrs=dict(type='bool', default=True), name=dict(type='str', required=True), new_image_data=dict(type='bool', default=True), software_packing=dict(type='bool', default=False), storage_path=dict(type='str', required=True), use_snapshot=dict(type='bool', default=False) ), supports_check_mode=True, ) command_args_formats = dict( create_map_files=cmd_runner_fmt.as_bool("-m"), use_snapshot=cmd_runner_fmt.as_bool("-T"), exclude_files=cmd_runner_fmt.as_bool("-e"), exclude_wpar_files=cmd_runner_fmt.as_bool("-G"), new_image_data=cmd_runner_fmt.as_bool("-i"), software_packing=cmd_runner_fmt.as_bool_not("-p"), extended_attrs=cmd_runner_fmt.as_bool("-a"), backup_crypt_files=cmd_runner_fmt.as_bool_not("-Z"), backup_dmapi_fs=cmd_runner_fmt.as_bool("-A"), combined_path=cmd_runner_fmt.as_func(cmd_runner_fmt.unpack_args(lambda p, n: ["%s/%s" % (p, n)])), ) def __init_module__(self): if not os.path.isdir(self.vars.storage_path): self.do_raise("Storage path %s is not valid." % self.vars.storage_path) def __run__(self): def process(rc, out, err): if rc != 0: self.do_raise("mksysb failed: {0}".format(out)) runner = CmdRunner( self.module, ['mksysb', '-X'], self.command_args_formats, ) with runner(['create_map_files', 'use_snapshot', 'exclude_files', 'exclude_wpar_files', 'software_packing', 'extended_attrs', 'backup_crypt_files', 'backup_dmapi_fs', 'new_image_data', 'combined_path'], output_process=process, check_mode_skip=True) as ctx: ctx.run(combined_path=[self.vars.storage_path, self.vars.name]) if self.verbosity >= 4: self.vars.run_info = ctx.run_info self.changed = True def main(): MkSysB.execute() if __name__ == '__main__': main() PK $�!\4 &@f f W collections/ansible_collections/community/general/plugins/modules/proxmox_tasks_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Andreas Botzner (@paginabianca) <andreas at botzner dot com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: proxmox_tasks_info short_description: Retrieve information about one or more Proxmox VE tasks version_added: 3.8.0 description: - Retrieve information about one or more Proxmox VE tasks. author: 'Andreas Botzner (@paginabianca) <andreas at botzner dot com>' options: node: description: - Node where to get tasks. required: true type: str task: description: - Return specific task. aliases: ['upid', 'name'] type: str extends_documentation_fragment: - community.general.proxmox.documentation - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: List tasks on node01 community.general.proxmox_task_info: api_host: proxmoxhost api_user: root@pam api_password: '{{ password | default(omit) }}' api_token_id: '{{ token_id | default(omit) }}' api_token_secret: '{{ token_secret | default(omit) }}' node: node01 register: result - name: Retrieve information about specific tasks on node01 community.general.proxmox_task_info: api_host: proxmoxhost api_user: root@pam api_password: '{{ password | default(omit) }}' api_token_id: '{{ token_id | default(omit) }}' api_token_secret: '{{ token_secret | default(omit) }}' task: 'UPID:node01:00003263:16167ACE:621EE230:srvreload:networking:root@pam:' node: node01 register: proxmox_tasks ''' RETURN = ''' proxmox_tasks: description: List of tasks. returned: on success type: list elements: dict contains: id: description: ID of the task. returned: on success type: str node: description: Node name. returned: on success type: str pid: description: PID of the task. returned: on success type: int pstart: description: pastart of the task. returned: on success type: int starttime: description: Starting time of the task. returned: on success type: int type: description: Type of the task. returned: on success type: str upid: description: UPID of the task. returned: on success type: str user: description: User that owns the task. returned: on success type: str endtime: description: Endtime of the task. returned: on success, can be absent type: int status: description: Status of the task. returned: on success, can be absent type: str failed: description: If the task failed. returned: when status is defined type: bool msg: description: Short message. returned: on failure type: str sample: 'Task: UPID:xyz:xyz does not exist on node: proxmoxnode' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.proxmox import ( proxmox_auth_argument_spec, ProxmoxAnsible) class ProxmoxTaskInfoAnsible(ProxmoxAnsible): def get_task(self, upid, node): tasks = self.get_tasks(node) for task in tasks: if task.info['upid'] == upid: return [task] def get_tasks(self, node): tasks = self.proxmox_api.nodes(node).tasks.get() return [ProxmoxTask(task) for task in tasks] class ProxmoxTask: def __init__(self, task): self.info = dict() for k, v in task.items(): if k == 'status' and isinstance(v, str): self.info[k] = v if v != 'OK': self.info['failed'] = True else: self.info[k] = v def proxmox_task_info_argument_spec(): return dict( task=dict(type='str', aliases=['upid', 'name'], required=False), node=dict(type='str', required=True), ) def main(): module_args = proxmox_auth_argument_spec() task_info_args = proxmox_task_info_argument_spec() module_args.update(task_info_args) module = AnsibleModule( argument_spec=module_args, required_together=[('api_token_id', 'api_token_secret')], required_one_of=[('api_password', 'api_token_id')], supports_check_mode=True) result = dict(changed=False) proxmox = ProxmoxTaskInfoAnsible(module) upid = module.params['task'] node = module.params['node'] if upid: tasks = proxmox.get_task(upid=upid, node=node) else: tasks = proxmox.get_tasks(node=node) if tasks is not None: result['proxmox_tasks'] = [task.info for task in tasks] module.exit_json(**result) else: result['msg'] = 'Task: {0} does not exist on node: {1}.'.format( upid, node) module.fail_json(**result) if __name__ == '__main__': main() PK $�!\����0 �0 L collections/ansible_collections/community/general/plugins/modules/flatpak.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017 John Kwiatkoski (@JayKayy) <jkwiat40@gmail.com> # Copyright (c) 2018 Alexander Bethke (@oolongbrothers) <oolongbrothers@gmx.net> # Copyright (c) 2017 Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: flatpak short_description: Manage flatpaks description: - Allows users to add or remove flatpaks. - See the M(community.general.flatpak_remote) module for managing flatpak remotes. author: - John Kwiatkoski (@JayKayy) - Alexander Bethke (@oolongbrothers) requirements: - flatpak extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: executable: description: - The path to the C(flatpak) executable to use. - By default, this module looks for the C(flatpak) executable on the path. type: path default: flatpak method: description: - The installation method to use. - Defines if the C(flatpak) is supposed to be installed globally for the whole V(system) or only for the current V(user). type: str choices: [ system, user ] default: system name: description: - The name of the flatpak to manage. To operate on several packages this can accept a list of packages. - When used with O(state=present), O(name) can be specified as a URL to a C(flatpakref) file or the unique reverse DNS name that identifies a flatpak. - Both C(https://) and C(http://) URLs are supported. - When supplying a reverse DNS name, you can use the O(remote) option to specify on what remote to look for the flatpak. An example for a reverse DNS name is C(org.gnome.gedit). - When used with O(state=absent), it is recommended to specify the name in the reverse DNS format. - When supplying a URL with O(state=absent), the module will try to match the installed flatpak based on the name of the flatpakref to remove it. However, there is no guarantee that the names of the flatpakref file and the reverse DNS name of the installed flatpak do match. type: list elements: str required: true no_dependencies: description: - If installing runtime dependencies should be omitted or not - This parameter is primarily implemented for integration testing this module. There might however be some use cases where you would want to have this, like when you are packaging your own flatpaks. type: bool default: false version_added: 3.2.0 remote: description: - The flatpak remote (repository) to install the flatpak from. - By default, V(flathub) is assumed, but you do need to add the flathub flatpak_remote before you can use this. - See the M(community.general.flatpak_remote) module for managing flatpak remotes. type: str default: flathub state: description: - Indicates the desired package state. choices: [ absent, present ] type: str default: present ''' EXAMPLES = r''' - name: Install the spotify flatpak community.general.flatpak: name: https://s3.amazonaws.com/alexlarsson/spotify-repo/spotify.flatpakref state: present - name: Install the gedit flatpak package without dependencies (not recommended) community.general.flatpak: name: https://git.gnome.org/browse/gnome-apps-nightly/plain/gedit.flatpakref state: present no_dependencies: true - name: Install the gedit package from flathub for current user community.general.flatpak: name: org.gnome.gedit state: present method: user - name: Install the Gnome Calendar flatpak from the gnome remote system-wide community.general.flatpak: name: org.gnome.Calendar state: present remote: gnome - name: Install multiple packages community.general.flatpak: name: - org.gimp.GIMP - org.inkscape.Inkscape - org.mozilla.firefox - name: Remove the gedit flatpak community.general.flatpak: name: org.gnome.gedit state: absent - name: Remove multiple packages community.general.flatpak: name: - org.gimp.GIMP - org.inkscape.Inkscape - org.mozilla.firefox state: absent ''' RETURN = r''' command: description: The exact flatpak command that was executed returned: When a flatpak command has been executed type: str sample: "/usr/bin/flatpak install --user --nontinteractive flathub org.gnome.Calculator" msg: description: Module error message returned: failure type: str sample: "Executable '/usr/local/bin/flatpak' was not found on the system." rc: description: Return code from flatpak binary returned: When a flatpak command has been executed type: int sample: 0 stderr: description: Error output from flatpak binary returned: When a flatpak command has been executed type: str sample: "error: Error searching remote flathub: Can't find ref org.gnome.KDE" stdout: description: Output from flatpak binary returned: When a flatpak command has been executed type: str sample: "org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n" ''' from ansible.module_utils.six.moves.urllib.parse import urlparse from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.version import LooseVersion OUTDATED_FLATPAK_VERSION_ERROR_MESSAGE = "Unknown option --columns=application" def install_flat(module, binary, remote, names, method, no_dependencies): """Add new flatpaks.""" global result # pylint: disable=global-variable-not-assigned uri_names = [] id_names = [] for name in names: if name.startswith('http://') or name.startswith('https://'): uri_names.append(name) else: id_names.append(name) base_command = [binary, "install", "--{0}".format(method)] flatpak_version = _flatpak_version(module, binary) if LooseVersion(flatpak_version) < LooseVersion('1.1.3'): base_command += ["-y"] else: base_command += ["--noninteractive"] if no_dependencies: base_command += ["--no-deps"] if uri_names: command = base_command + uri_names _flatpak_command(module, module.check_mode, command) if id_names: command = base_command + [remote] + id_names _flatpak_command(module, module.check_mode, command) result['changed'] = True def uninstall_flat(module, binary, names, method): """Remove existing flatpaks.""" global result # pylint: disable=global-variable-not-assigned installed_flat_names = [ _match_installed_flat_name(module, binary, name, method) for name in names ] command = [binary, "uninstall"] flatpak_version = _flatpak_version(module, binary) if LooseVersion(flatpak_version) < LooseVersion('1.1.3'): command += ["-y"] else: command += ["--noninteractive"] command += ["--{0}".format(method)] + installed_flat_names _flatpak_command(module, module.check_mode, command) result['changed'] = True def flatpak_exists(module, binary, names, method): """Check if the flatpaks are installed.""" command = [binary, "list", "--{0}".format(method)] output = _flatpak_command(module, False, command) installed = [] not_installed = [] for name in names: parsed_name = _parse_flatpak_name(name).lower() if parsed_name in output.lower(): installed.append(name) else: not_installed.append(name) return installed, not_installed def _match_installed_flat_name(module, binary, name, method): # This is a difficult function, since if the user supplies a flatpakref url, # we have to rely on a naming convention: # The flatpakref file name needs to match the flatpak name global result # pylint: disable=global-variable-not-assigned parsed_name = _parse_flatpak_name(name) # Try running flatpak list with columns feature command = [binary, "list", "--{0}".format(method), "--app", "--columns=application"] _flatpak_command(module, False, command, ignore_failure=True) if result['rc'] != 0 and OUTDATED_FLATPAK_VERSION_ERROR_MESSAGE in result['stderr']: # Probably flatpak before 1.2 matched_flatpak_name = \ _match_flat_using_flatpak_column_feature(module, binary, parsed_name, method) else: # Probably flatpak >= 1.2 matched_flatpak_name = \ _match_flat_using_outdated_flatpak_format(module, binary, parsed_name, method) if matched_flatpak_name: return matched_flatpak_name else: result['msg'] = "Flatpak removal failed: Could not match any installed flatpaks to " +\ "the name `{0}`. ".format(_parse_flatpak_name(name)) +\ "If you used a URL, try using the reverse DNS name of the flatpak" module.fail_json(**result) def _match_flat_using_outdated_flatpak_format(module, binary, parsed_name, method): global result # pylint: disable=global-variable-not-assigned command = [binary, "list", "--{0}".format(method), "--app", "--columns=application"] output = _flatpak_command(module, False, command) for row in output.split('\n'): if parsed_name.lower() == row.lower(): return row def _match_flat_using_flatpak_column_feature(module, binary, parsed_name, method): global result # pylint: disable=global-variable-not-assigned command = [binary, "list", "--{0}".format(method), "--app"] output = _flatpak_command(module, False, command) for row in output.split('\n'): if parsed_name.lower() in row.lower(): return row.split()[0] def _parse_flatpak_name(name): if name.startswith('http://') or name.startswith('https://'): file_name = urlparse(name).path.split('/')[-1] file_name_without_extension = file_name.split('.')[0:-1] common_name = ".".join(file_name_without_extension) else: common_name = name return common_name def _flatpak_version(module, binary): global result # pylint: disable=global-variable-not-assigned command = [binary, "--version"] output = _flatpak_command(module, False, command) version_number = output.split()[1] return version_number def _flatpak_command(module, noop, command, ignore_failure=False): global result # pylint: disable=global-variable-not-assigned result['command'] = ' '.join(command) if noop: result['rc'] = 0 return "" result['rc'], result['stdout'], result['stderr'] = module.run_command( command, check_rc=not ignore_failure ) return result['stdout'] def main(): # This module supports check mode module = AnsibleModule( argument_spec=dict( name=dict(type='list', elements='str', required=True), remote=dict(type='str', default='flathub'), method=dict(type='str', default='system', choices=['user', 'system']), state=dict(type='str', default='present', choices=['absent', 'present']), no_dependencies=dict(type='bool', default=False), executable=dict(type='path', default='flatpak') ), supports_check_mode=True, ) name = module.params['name'] state = module.params['state'] remote = module.params['remote'] no_dependencies = module.params['no_dependencies'] method = module.params['method'] executable = module.params['executable'] binary = module.get_bin_path(executable, None) global result result = dict( changed=False ) # If the binary was not found, fail the operation if not binary: module.fail_json(msg="Executable '%s' was not found on the system." % executable, **result) installed, not_installed = flatpak_exists(module, binary, name, method) if state == 'present' and not_installed: install_flat(module, binary, remote, not_installed, method, no_dependencies) elif state == 'absent' and installed: uninstall_flat(module, binary, installed, method) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�E9% 9% H collections/ansible_collections/community/general/plugins/modules/irc.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Jan-Piet Mens <jpmens () gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: irc short_description: Send a message to an IRC channel or a nick description: - Send a message to an IRC channel or a nick. This is a very simplistic implementation. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: server: type: str description: - IRC server name/address default: localhost port: type: int description: - IRC server port number default: 6667 nick: type: str description: - Nickname to send the message from. May be shortened, depending on server's NICKLEN setting. default: ansible msg: type: str description: - The message body. required: true topic: type: str description: - Set the channel topic color: type: str description: - Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none"). Added 11 more colors in version 2.0. default: "none" choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan", "light_blue", "pink", "gray", "light_gray"] aliases: [colour] channel: type: str description: - Channel name. One of nick_to or channel needs to be set. When both are set, the message will be sent to both of them. nick_to: type: list elements: str description: - A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them. key: type: str description: - Channel key passwd: type: str description: - Server password timeout: type: int description: - Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop default: 30 use_ssl: description: - Designates whether TLS/SSL should be used when connecting to the IRC server type: bool default: false part: description: - Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages. type: bool default: true style: type: str description: - Text style for the message. Note italic does not work on some clients choices: [ "bold", "underline", "reverse", "italic", "none" ] default: none # informational: requirements for nodes requirements: [ socket ] author: - "Jan-Piet Mens (@jpmens)" - "Matt Martz (@sivel)" ''' EXAMPLES = ''' - name: Send a message to an IRC channel from nick ansible community.general.irc: server: irc.example.net channel: #t1 msg: Hello world - name: Send a message to an IRC channel local_action: module: irc port: 6669 server: irc.example.net channel: #t1 msg: 'All finished at {{ ansible_date_time.iso8601 }}' color: red nick: ansibleIRC - name: Send a message to an IRC channel local_action: module: irc port: 6669 server: irc.example.net channel: #t1 nick_to: - nick1 - nick2 msg: 'All finished at {{ ansible_date_time.iso8601 }}' color: red nick: ansibleIRC ''' # =========================================== # IRC module support methods. # import re import socket import ssl import time import traceback from ansible.module_utils.common.text.converters import to_native, to_bytes from ansible.module_utils.basic import AnsibleModule def send_msg(msg, server='localhost', port='6667', channel=None, nick_to=None, key=None, topic=None, nick="ansible", color='none', passwd=False, timeout=30, use_ssl=False, part=True, style=None): '''send message to IRC''' nick_to = [] if nick_to is None else nick_to colornumbers = { 'white': "00", 'black': "01", 'blue': "02", 'green': "03", 'red': "04", 'brown': "05", 'purple': "06", 'orange': "07", 'yellow': "08", 'light_green': "09", 'teal': "10", 'light_cyan': "11", 'light_blue': "12", 'pink': "13", 'gray': "14", 'light_gray': "15", } stylechoices = { 'bold': "\x02", 'underline': "\x1F", 'reverse': "\x16", 'italic': "\x1D", } try: styletext = stylechoices[style] except Exception: styletext = "" try: colornumber = colornumbers[color] colortext = "\x03" + colornumber except Exception: colortext = "" message = styletext + colortext + msg irc = socket.socket(socket.AF_INET, socket.SOCK_STREAM) if use_ssl: irc = ssl.wrap_socket(irc) irc.connect((server, int(port))) if passwd: irc.send(to_bytes('PASS %s\r\n' % passwd)) irc.send(to_bytes('NICK %s\r\n' % nick)) irc.send(to_bytes('USER %s %s %s :ansible IRC\r\n' % (nick, nick, nick))) motd = '' start = time.time() while 1: motd += to_native(irc.recv(1024)) # The server might send back a shorter nick than we specified (due to NICKLEN), # so grab that and use it from now on (assuming we find the 00[1-4] response). match = re.search(r'^:\S+ 00[1-4] (?P<nick>\S+) :', motd, flags=re.M) if match: nick = match.group('nick') break elif time.time() - start > timeout: raise Exception('Timeout waiting for IRC server welcome response') time.sleep(0.5) if channel: if key: irc.send(to_bytes('JOIN %s %s\r\n' % (channel, key))) else: irc.send(to_bytes('JOIN %s\r\n' % channel)) join = '' start = time.time() while 1: join += to_native(irc.recv(1024)) if re.search(r'^:\S+ 366 %s %s :' % (nick, channel), join, flags=re.M | re.I): break elif time.time() - start > timeout: raise Exception('Timeout waiting for IRC JOIN response') time.sleep(0.5) if topic is not None: irc.send(to_bytes('TOPIC %s :%s\r\n' % (channel, topic))) time.sleep(1) if nick_to: for nick in nick_to: irc.send(to_bytes('PRIVMSG %s :%s\r\n' % (nick, message))) if channel: irc.send(to_bytes('PRIVMSG %s :%s\r\n' % (channel, message))) time.sleep(1) if part: if channel: irc.send(to_bytes('PART %s\r\n' % channel)) irc.send(to_bytes('QUIT\r\n')) time.sleep(1) irc.close() # =========================================== # Main # def main(): module = AnsibleModule( argument_spec=dict( server=dict(default='localhost'), port=dict(type='int', default=6667), nick=dict(default='ansible'), nick_to=dict(required=False, type='list', elements='str'), msg=dict(required=True), color=dict(default="none", aliases=['colour'], choices=["white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan", "light_blue", "pink", "gray", "light_gray", "none"]), style=dict(default="none", choices=["underline", "reverse", "bold", "italic", "none"]), channel=dict(required=False), key=dict(no_log=True), topic=dict(), passwd=dict(no_log=True), timeout=dict(type='int', default=30), part=dict(type='bool', default=True), use_ssl=dict(type='bool', default=False) ), supports_check_mode=True, required_one_of=[['channel', 'nick_to']] ) server = module.params["server"] port = module.params["port"] nick = module.params["nick"] nick_to = module.params["nick_to"] msg = module.params["msg"] color = module.params["color"] channel = module.params["channel"] topic = module.params["topic"] if topic and not channel: module.fail_json(msg="When topic is specified, a channel is required.") key = module.params["key"] passwd = module.params["passwd"] timeout = module.params["timeout"] use_ssl = module.params["use_ssl"] part = module.params["part"] style = module.params["style"] try: send_msg(msg, server, port, channel, nick_to, key, topic, nick, color, passwd, timeout, use_ssl, part, style) except Exception as e: module.fail_json(msg="unable to send to IRC: %s" % to_native(e), exception=traceback.format_exc()) module.exit_json(changed=False, channel=channel, nick=nick, msg=msg) if __name__ == '__main__': main() PK $�!\J.& ( ( O collections/ansible_collections/community/general/plugins/modules/github_key.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: github_key short_description: Manage GitHub access keys description: - Creates, removes, or updates GitHub access keys. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: token: description: - GitHub Access Token with permission to list and create public keys. required: true type: str name: description: - SSH key name required: true type: str pubkey: description: - SSH public key value. Required when O(state=present). type: str state: description: - Whether to remove a key, ensure that it exists, or update its value. choices: ['present', 'absent'] default: 'present' type: str force: description: - The default is V(true), which will replace the existing remote key if it is different than O(pubkey). If V(false), the key will only be set if no key with the given O(name) exists. type: bool default: true author: Robert Estelle (@erydo) ''' RETURN = ''' deleted_keys: description: An array of key objects that were deleted. Only present on state=absent type: list returned: When state=absent sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false}] matching_keys: description: An array of keys matching the specified name. Only present on state=present type: list returned: When state=present sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false}] key: description: Metadata about the key just created. Only present on state=present type: dict returned: success sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false} ''' EXAMPLES = ''' - name: Read SSH public key to authorize ansible.builtin.shell: cat /home/foo/.ssh/id_rsa.pub register: ssh_pub_key - name: Authorize key with GitHub local_action: module: github_key name: Access Key for Some Machine token: '{{ github_access_token }}' pubkey: '{{ ssh_pub_key.stdout }}' # Alternatively, a single task can be used reading a key from a file on the controller - name: Authorize key with GitHub community.general.github_key: name: Access Key for Some Machine token: '{{ github_access_token }}' pubkey: "{{ lookup('ansible.builtin.file', '/home/foo/.ssh/id_rsa.pub') }}" ''' import json import re from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url API_BASE = 'https://api.github.com' class GitHubResponse(object): def __init__(self, response, info): self.content = response.read() self.info = info def json(self): return json.loads(self.content) def links(self): links = {} if 'link' in self.info: link_header = self.info['link'] matches = re.findall('<([^>]+)>; rel="([^"]+)"', link_header) for url, rel in matches: links[rel] = url return links class GitHubSession(object): def __init__(self, module, token): self.module = module self.token = token def request(self, method, url, data=None): headers = { 'Authorization': 'token %s' % self.token, 'Content-Type': 'application/json', 'Accept': 'application/vnd.github.v3+json', } response, info = fetch_url( self.module, url, method=method, data=data, headers=headers) if not (200 <= info['status'] < 400): self.module.fail_json( msg=(" failed to send request %s to %s: %s" % (method, url, info['msg']))) return GitHubResponse(response, info) def get_all_keys(session): url = API_BASE + '/user/keys' result = [] while url: r = session.request('GET', url) result.extend(r.json()) url = r.links().get('next') return result def create_key(session, name, pubkey, check_mode): if check_mode: from datetime import datetime now = datetime.utcnow() return { 'id': 0, 'key': pubkey, 'title': name, 'url': 'http://example.com/CHECK_MODE_GITHUB_KEY', 'created_at': datetime.strftime(now, '%Y-%m-%dT%H:%M:%SZ'), 'read_only': False, 'verified': False } else: return session.request( 'POST', API_BASE + '/user/keys', data=json.dumps({'title': name, 'key': pubkey})).json() def delete_keys(session, to_delete, check_mode): if check_mode: return for key in to_delete: session.request('DELETE', API_BASE + '/user/keys/%s' % key["id"]) def ensure_key_absent(session, name, check_mode): to_delete = [key for key in get_all_keys(session) if key['title'] == name] delete_keys(session, to_delete, check_mode=check_mode) return {'changed': bool(to_delete), 'deleted_keys': to_delete} def ensure_key_present(module, session, name, pubkey, force, check_mode): all_keys = get_all_keys(session) matching_keys = [k for k in all_keys if k['title'] == name] deleted_keys = [] new_signature = pubkey.split(' ')[1] for key in all_keys: existing_signature = key['key'].split(' ')[1] if new_signature == existing_signature and key['title'] != name: module.fail_json(msg=( "another key with the same content is already registered " "under the name |{0}|").format(key['title'])) if matching_keys and force and matching_keys[0]['key'].split(' ')[1] != new_signature: delete_keys(session, matching_keys, check_mode=check_mode) (deleted_keys, matching_keys) = (matching_keys, []) if not matching_keys: key = create_key(session, name, pubkey, check_mode=check_mode) else: key = matching_keys[0] return { 'changed': bool(deleted_keys or not matching_keys), 'deleted_keys': deleted_keys, 'matching_keys': matching_keys, 'key': key } def main(): argument_spec = { 'token': {'required': True, 'no_log': True}, 'name': {'required': True}, 'pubkey': {}, 'state': {'choices': ['present', 'absent'], 'default': 'present'}, 'force': {'default': True, 'type': 'bool'}, } module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) token = module.params['token'] name = module.params['name'] state = module.params['state'] force = module.params['force'] pubkey = module.params.get('pubkey') if pubkey: pubkey_parts = pubkey.split(' ') # Keys consist of a protocol, the key data, and an optional comment. if len(pubkey_parts) < 2: module.fail_json(msg='"pubkey" parameter has an invalid format') elif state == 'present': module.fail_json(msg='"pubkey" is required when state=present') session = GitHubSession(module, token) if state == 'present': result = ensure_key_present(module, session, name, pubkey, force=force, check_mode=module.check_mode) elif state == 'absent': result = ensure_key_absent(session, name, check_mode=module.check_mode) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\E|�� � R collections/ansible_collections/community/general/plugins/modules/gitlab_branch.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Werner Dijkerman (ikben@werner-dijkerman.nl) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: gitlab_branch short_description: Create or delete a branch version_added: 4.2.0 description: - This module allows to create or delete branches. author: - paytroff (@paytroff) requirements: - python >= 2.7 - python-gitlab >= 2.3.0 extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: state: description: - Create or delete branch. default: present type: str choices: ["present", "absent"] project: description: - The path or name of the project. required: true type: str branch: description: - The name of the branch that needs to be created. required: true type: str ref_branch: description: - Reference branch to create from. - This must be specified if O(state=present). type: str ''' EXAMPLES = ''' - name: Create branch branch2 from main community.general.gitlab_branch: api_url: https://gitlab.com api_token: secret_access_token project: "group1/project1" branch: branch2 ref_branch: main state: present - name: Delete branch branch2 community.general.gitlab_branch: api_url: https://gitlab.com api_token: secret_access_token project: "group1/project1" branch: branch2 state: absent ''' RETURN = ''' ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.api import basic_auth_argument_spec from ansible_collections.community.general.plugins.module_utils.version import LooseVersion from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, gitlab_authentication, gitlab, ensure_gitlab_package ) class GitlabBranch(object): def __init__(self, module, project, gitlab_instance): self.repo = gitlab_instance self._module = module self.project = self.get_project(project) def get_project(self, project): try: return self.repo.projects.get(project) except Exception as e: return False def get_branch(self, branch): try: return self.project.branches.get(branch) except Exception as e: return False def create_branch(self, branch, ref_branch): return self.project.branches.create({'branch': branch, 'ref': ref_branch}) def delete_branch(self, branch): return branch.delete() def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update( project=dict(type='str', required=True), branch=dict(type='str', required=True), ref_branch=dict(type='str', required=False), state=dict(type='str', default="present", choices=["absent", "present"]), ) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'] ], required_if=[ ['state', 'present', ['ref_branch'], True], ], supports_check_mode=False ) ensure_gitlab_package(module) project = module.params['project'] branch = module.params['branch'] ref_branch = module.params['ref_branch'] state = module.params['state'] gitlab_version = gitlab.__version__ if LooseVersion(gitlab_version) < LooseVersion('2.3.0'): module.fail_json(msg="community.general.gitlab_proteched_branch requires python-gitlab Python module >= 2.3.0 (installed version: [%s])." " Please upgrade python-gitlab to version 2.3.0 or above." % gitlab_version) gitlab_instance = gitlab_authentication(module) this_gitlab = GitlabBranch(module=module, project=project, gitlab_instance=gitlab_instance) this_branch = this_gitlab.get_branch(branch) if not this_branch and state == "present": r_branch = this_gitlab.get_branch(ref_branch) if not r_branch: module.fail_json(msg="Ref branch {b} not exist.".format(b=ref_branch)) this_gitlab.create_branch(branch, ref_branch) module.exit_json(changed=True, msg="Created the branch {b}.".format(b=branch)) elif this_branch and state == "present": module.exit_json(changed=False, msg="Branch {b} already exist".format(b=branch)) elif this_branch and state == "absent": try: this_gitlab.delete_branch(this_branch) module.exit_json(changed=True, msg="Branch {b} deleted.".format(b=branch)) except Exception as e: module.fail_json(msg="Error delete branch.", exception=traceback.format_exc()) else: module.exit_json(changed=False, msg="No changes are needed.") if __name__ == '__main__': main() PK $�!\}� O,L ,L \ collections/ansible_collections/community/general/plugins/modules/keycloak_authentication.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, INSPQ <philippe.gauthier@inspq.qc.ca> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: keycloak_authentication short_description: Configure authentication in Keycloak description: - This module actually can only make a copy of an existing authentication flow, add an execution to it and configure it. - It can also delete the flow. version_added: "3.3.0" attributes: check_mode: support: full diff_mode: support: full options: realm: description: - The name of the realm in which is the authentication. required: true type: str alias: description: - Alias for the authentication flow. required: true type: str description: description: - Description of the flow. type: str providerId: description: - C(providerId) for the new flow when not copied from an existing flow. choices: [ "basic-flow", "client-flow" ] type: str copyFrom: description: - C(flowAlias) of the authentication flow to use for the copy. type: str authenticationExecutions: description: - Configuration structure for the executions. type: list elements: dict suboptions: providerId: description: - C(providerID) for the new flow when not copied from an existing flow. type: str displayName: description: - Name of the execution or subflow to create or update. type: str requirement: description: - Control status of the subflow or execution. choices: [ "REQUIRED", "ALTERNATIVE", "DISABLED", "CONDITIONAL" ] type: str flowAlias: description: - Alias of parent flow. type: str authenticationConfig: description: - Describe the config of the authentication. type: dict index: description: - Priority order of the execution. type: int subFlowType: description: - For new subflows, optionally specify the type. - Is only used at creation. choices: ["basic-flow", "form-flow"] default: "basic-flow" type: str version_added: 6.6.0 state: description: - Control if the authentication flow must exists or not. choices: [ "present", "absent" ] default: present type: str force: type: bool default: false description: - If V(true), allows to remove the authentication flow and recreate it. extends_documentation_fragment: - community.general.keycloak - community.general.attributes author: - Philippe Gauthier (@elfelip) - Gaëtan Daubresse (@Gaetan2907) ''' EXAMPLES = ''' - name: Create an authentication flow from first broker login and add an execution to it. community.general.keycloak_authentication: auth_keycloak_url: http://localhost:8080/auth auth_realm: master auth_username: admin auth_password: password realm: master alias: "Copy of first broker login" copyFrom: "first broker login" authenticationExecutions: - providerId: "test-execution1" requirement: "REQUIRED" authenticationConfig: alias: "test.execution1.property" config: test1.property: "value" - providerId: "test-execution2" requirement: "REQUIRED" authenticationConfig: alias: "test.execution2.property" config: test2.property: "value" state: present - name: Re-create the authentication flow community.general.keycloak_authentication: auth_keycloak_url: http://localhost:8080/auth auth_realm: master auth_username: admin auth_password: password realm: master alias: "Copy of first broker login" copyFrom: "first broker login" authenticationExecutions: - providerId: "test-provisioning" requirement: "REQUIRED" authenticationConfig: alias: "test.provisioning.property" config: test.provisioning.property: "value" state: present force: true - name: Create an authentication flow with subflow containing an execution. community.general.keycloak_authentication: auth_keycloak_url: http://localhost:8080/auth auth_realm: master auth_username: admin auth_password: password realm: master alias: "Copy of first broker login" copyFrom: "first broker login" authenticationExecutions: - providerId: "test-execution1" requirement: "REQUIRED" - displayName: "New Subflow" requirement: "REQUIRED" - providerId: "auth-cookie" requirement: "REQUIRED" flowAlias: "New Sublow" state: present - name: Remove authentication. community.general.keycloak_authentication: auth_keycloak_url: http://localhost:8080/auth auth_realm: master auth_username: admin auth_password: password realm: master alias: "Copy of first broker login" state: absent ''' RETURN = ''' msg: description: Message as to what action was taken. returned: always type: str end_state: description: Representation of the authentication after module execution. returned: on success type: dict sample: { "alias": "Copy of first broker login", "authenticationExecutions": [ { "alias": "review profile config", "authenticationConfig": { "alias": "review profile config", "config": { "update.profile.on.first.login": "missing" }, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7" }, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": [ "REQUIRED", "ALTERNATIVE", "DISABLED" ] } ], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true } ''' from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak \ import KeycloakAPI, keycloak_argument_spec, get_token, KeycloakError, is_struct_included from ansible.module_utils.basic import AnsibleModule def find_exec_in_executions(searched_exec, executions): """ Search if exec is contained in the executions. :param searched_exec: Execution to search for. :param executions: List of executions. :return: Index of the execution, -1 if not found.. """ for i, existing_exec in enumerate(executions, start=0): if ("providerId" in existing_exec and "providerId" in searched_exec and existing_exec["providerId"] == searched_exec["providerId"] or "displayName" in existing_exec and "displayName" in searched_exec and existing_exec["displayName"] == searched_exec["displayName"]): return i return -1 def create_or_update_executions(kc, config, realm='master'): """ Create or update executions for an authentication flow. :param kc: Keycloak API access. :param config: Representation of the authentication flow including it's executions. :param realm: Realm :return: tuple (changed, dict(before, after) WHERE bool changed indicates if changes have been made dict(str, str) shows state before and after creation/update """ try: changed = False after = "" before = "" if "authenticationExecutions" in config: # Get existing executions on the Keycloak server for this alias existing_executions = kc.get_executions_representation(config, realm=realm) for new_exec_index, new_exec in enumerate(config["authenticationExecutions"], start=0): if new_exec["index"] is not None: new_exec_index = new_exec["index"] exec_found = False # Get flowalias parent if given if new_exec["flowAlias"] is not None: flow_alias_parent = new_exec["flowAlias"] else: flow_alias_parent = config["alias"] # Check if same providerId or displayName name between existing and new execution exec_index = find_exec_in_executions(new_exec, existing_executions) if exec_index != -1: # Remove key that doesn't need to be compared with existing_exec exclude_key = ["flowAlias", "subFlowType"] for index_key, key in enumerate(new_exec, start=0): if new_exec[key] is None: exclude_key.append(key) # Compare the executions to see if it need changes if not is_struct_included(new_exec, existing_executions[exec_index], exclude_key) or exec_index != new_exec_index: exec_found = True if new_exec['index'] is None: new_exec_index = exec_index before += str(existing_executions[exec_index]) + '\n' id_to_update = existing_executions[exec_index]["id"] # Remove exec from list in case 2 exec with same name existing_executions[exec_index].clear() elif new_exec["providerId"] is not None: kc.create_execution(new_exec, flowAlias=flow_alias_parent, realm=realm) exec_found = True exec_index = new_exec_index id_to_update = kc.get_executions_representation(config, realm=realm)[exec_index]["id"] after += str(new_exec) + '\n' elif new_exec["displayName"] is not None: kc.create_subflow(new_exec["displayName"], flow_alias_parent, realm=realm, flowType=new_exec["subFlowType"]) exec_found = True exec_index = new_exec_index id_to_update = kc.get_executions_representation(config, realm=realm)[exec_index]["id"] after += str(new_exec) + '\n' if exec_found: changed = True if exec_index != -1: # Update the existing execution updated_exec = { "id": id_to_update } # add the execution configuration if new_exec["authenticationConfig"] is not None: kc.add_authenticationConfig_to_execution(updated_exec["id"], new_exec["authenticationConfig"], realm=realm) for key in new_exec: # remove unwanted key for the next API call if key not in ("flowAlias", "authenticationConfig", "subFlowType"): updated_exec[key] = new_exec[key] if new_exec["requirement"] is not None: kc.update_authentication_executions(flow_alias_parent, updated_exec, realm=realm) diff = exec_index - new_exec_index kc.change_execution_priority(updated_exec["id"], diff, realm=realm) after += str(kc.get_executions_representation(config, realm=realm)[new_exec_index]) + '\n' return changed, dict(before=before, after=after) except Exception as e: kc.module.fail_json(msg='Could not create or update executions for authentication flow %s in realm %s: %s' % (config["alias"], realm, str(e))) def main(): """ Module execution :return: """ argument_spec = keycloak_argument_spec() meta_args = dict( realm=dict(type='str', required=True), alias=dict(type='str', required=True), providerId=dict(type='str', choices=["basic-flow", "client-flow"]), description=dict(type='str'), copyFrom=dict(type='str'), authenticationExecutions=dict(type='list', elements='dict', options=dict( providerId=dict(type='str'), displayName=dict(type='str'), requirement=dict(choices=["REQUIRED", "ALTERNATIVE", "DISABLED", "CONDITIONAL"], type='str'), flowAlias=dict(type='str'), authenticationConfig=dict(type='dict'), index=dict(type='int'), subFlowType=dict(choices=["basic-flow", "form-flow"], default='basic-flow', type='str'), )), state=dict(choices=["absent", "present"], default='present'), force=dict(type='bool', default=False), ) argument_spec.update(meta_args) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, required_one_of=([['token', 'auth_realm', 'auth_username', 'auth_password']]), required_together=([['auth_realm', 'auth_username', 'auth_password']]) ) result = dict(changed=False, msg='', flow={}) # Obtain access token, initialize API try: connection_header = get_token(module.params) except KeycloakError as e: module.fail_json(msg=str(e)) kc = KeycloakAPI(module, connection_header) realm = module.params.get('realm') state = module.params.get('state') force = module.params.get('force') new_auth_repr = { "alias": module.params.get("alias"), "copyFrom": module.params.get("copyFrom"), "providerId": module.params.get("providerId"), "authenticationExecutions": module.params.get("authenticationExecutions"), "description": module.params.get("description"), "builtIn": module.params.get("builtIn"), "subflow": module.params.get("subflow"), } auth_repr = kc.get_authentication_flow_by_alias(alias=new_auth_repr["alias"], realm=realm) # Cater for when it doesn't exist (an empty dict) if not auth_repr: if state == 'absent': # Do nothing and exit if module._diff: result['diff'] = dict(before='', after='') result['changed'] = False result['end_state'] = {} result['msg'] = new_auth_repr["alias"] + ' absent' module.exit_json(**result) elif state == 'present': # Process a creation result['changed'] = True if module._diff: result['diff'] = dict(before='', after=new_auth_repr) if module.check_mode: module.exit_json(**result) # If copyFrom is defined, create authentication flow from a copy if "copyFrom" in new_auth_repr and new_auth_repr["copyFrom"] is not None: auth_repr = kc.copy_auth_flow(config=new_auth_repr, realm=realm) else: # Create an empty authentication flow auth_repr = kc.create_empty_auth_flow(config=new_auth_repr, realm=realm) # If the authentication still not exist on the server, raise an exception. if auth_repr is None: result['msg'] = "Authentication just created not found: " + str(new_auth_repr) module.fail_json(**result) # Configure the executions for the flow create_or_update_executions(kc=kc, config=new_auth_repr, realm=realm) # Get executions created exec_repr = kc.get_executions_representation(config=new_auth_repr, realm=realm) if exec_repr is not None: auth_repr["authenticationExecutions"] = exec_repr result['end_state'] = auth_repr else: if state == 'present': # Process an update if force: # If force option is true # Delete the actual authentication flow result['changed'] = True if module._diff: result['diff'] = dict(before=auth_repr, after=new_auth_repr) if module.check_mode: module.exit_json(**result) kc.delete_authentication_flow_by_id(id=auth_repr["id"], realm=realm) # If copyFrom is defined, create authentication flow from a copy if "copyFrom" in new_auth_repr and new_auth_repr["copyFrom"] is not None: auth_repr = kc.copy_auth_flow(config=new_auth_repr, realm=realm) else: # Create an empty authentication flow auth_repr = kc.create_empty_auth_flow(config=new_auth_repr, realm=realm) # If the authentication still not exist on the server, raise an exception. if auth_repr is None: result['msg'] = "Authentication just created not found: " + str(new_auth_repr) module.fail_json(**result) # Configure the executions for the flow if module.check_mode: module.exit_json(**result) changed, diff = create_or_update_executions(kc=kc, config=new_auth_repr, realm=realm) result['changed'] |= changed if module._diff: result['diff'] = diff # Get executions created exec_repr = kc.get_executions_representation(config=new_auth_repr, realm=realm) if exec_repr is not None: auth_repr["authenticationExecutions"] = exec_repr result['end_state'] = auth_repr else: # Process a deletion (because state was not 'present') result['changed'] = True if module._diff: result['diff'] = dict(before=auth_repr, after='') if module.check_mode: module.exit_json(**result) # delete it kc.delete_authentication_flow_by_id(id=auth_repr["id"], realm=realm) result['msg'] = 'Authentication flow: {alias} id: {id} is deleted'.format(alias=new_auth_repr['alias'], id=auth_repr["id"]) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\��uX�. �. P collections/ansible_collections/community/general/plugins/modules/jenkins_job.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: jenkins_job short_description: Manage jenkins jobs description: - Manage Jenkins jobs by using Jenkins REST API. requirements: - "python-jenkins >= 0.4.12" author: "Sergio Millan Rodriguez (@sermilrod)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: config: type: str description: - config in XML format. - Required if job does not yet exist. - Mutually exclusive with O(enabled). - Considered if O(state=present). required: false enabled: description: - Whether the job should be enabled or disabled. - Mutually exclusive with O(config). - Considered if O(state=present). type: bool required: false name: type: str description: - Name of the Jenkins job. required: true password: type: str description: - Password to authenticate with the Jenkins server. required: false state: type: str description: - Attribute that specifies if the job has to be created or deleted. required: false default: present choices: ['present', 'absent'] token: type: str description: - API token used to authenticate alternatively to password. required: false url: type: str description: - URL where the Jenkins server is accessible. required: false default: http://localhost:8080 user: type: str description: - User to authenticate with the Jenkins server. required: false validate_certs: type: bool default: true description: - If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. - The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY). version_added: 2.3.0 ''' EXAMPLES = ''' - name: Create a jenkins job using basic authentication community.general.jenkins_job: config: "{{ lookup('file', 'templates/test.xml') }}" name: test password: admin url: http://localhost:8080 user: admin - name: Create a jenkins job using the token community.general.jenkins_job: config: "{{ lookup('template', 'templates/test.xml.j2') }}" name: test token: asdfasfasfasdfasdfadfasfasdfasdfc url: http://localhost:8080 user: admin - name: Delete a jenkins job using basic authentication community.general.jenkins_job: name: test password: admin state: absent url: http://localhost:8080 user: admin - name: Delete a jenkins job using the token community.general.jenkins_job: name: test token: asdfasfasfasdfasdfadfasfasdfasdfc state: absent url: http://localhost:8080 user: admin - name: Disable a jenkins job using basic authentication community.general.jenkins_job: name: test password: admin enabled: false url: http://localhost:8080 user: admin - name: Disable a jenkins job using the token community.general.jenkins_job: name: test token: asdfasfasfasdfasdfadfasfasdfasdfc enabled: false url: http://localhost:8080 user: admin ''' RETURN = ''' --- name: description: Name of the jenkins job. returned: success type: str sample: test-job state: description: State of the jenkins job. returned: success type: str sample: present enabled: description: Whether the jenkins job is enabled or not. returned: success type: bool sample: true user: description: User used for authentication. returned: success type: str sample: admin url: description: Url to connect to the Jenkins server. returned: success type: str sample: https://jenkins.mydomain.com ''' import os import traceback import xml.etree.ElementTree as ET JENKINS_IMP_ERR = None try: import jenkins python_jenkins_installed = True except ImportError: JENKINS_IMP_ERR = traceback.format_exc() python_jenkins_installed = False from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native class JenkinsJob(object): def __init__(self, module): self.module = module self.config = module.params.get('config') self.name = module.params.get('name') self.password = module.params.get('password') self.state = module.params.get('state') self.enabled = module.params.get('enabled') self.token = module.params.get('token') self.user = module.params.get('user') self.jenkins_url = module.params.get('url') self.server = self.get_jenkins_connection() self.result = { 'changed': False, 'url': self.jenkins_url, 'name': self.name, 'user': self.user, 'state': self.state, 'diff': { 'before': "", 'after': "" } } self.EXCL_STATE = "excluded state" if not module.params['validate_certs']: os.environ['PYTHONHTTPSVERIFY'] = '0' def get_jenkins_connection(self): try: if self.user and self.password: return jenkins.Jenkins(self.jenkins_url, self.user, self.password) elif self.user and self.token: return jenkins.Jenkins(self.jenkins_url, self.user, self.token) elif self.user and not (self.password or self.token): return jenkins.Jenkins(self.jenkins_url, self.user) else: return jenkins.Jenkins(self.jenkins_url) except Exception as e: self.module.fail_json(msg='Unable to connect to Jenkins server, %s' % to_native(e), exception=traceback.format_exc()) def get_job_status(self): try: response = self.server.get_job_info(self.name) if "color" not in response: return self.EXCL_STATE else: return to_native(response['color']) except Exception as e: self.module.fail_json(msg='Unable to fetch job information, %s' % to_native(e), exception=traceback.format_exc()) def job_exists(self): try: return bool(self.server.job_exists(self.name)) except Exception as e: self.module.fail_json(msg='Unable to validate if job exists, %s for %s' % (to_native(e), self.jenkins_url), exception=traceback.format_exc()) def get_config(self): return job_config_to_string(self.config) def get_current_config(self): return job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) def has_config_changed(self): # config is optional, if not provided we keep the current config as is if self.config is None: return False config_file = self.get_config() machine_file = self.get_current_config() self.result['diff']['after'] = config_file self.result['diff']['before'] = machine_file if machine_file != config_file: return True return False def present_job(self): if self.config is None and self.enabled is None: self.module.fail_json(msg='one of the following params is required on state=present: config,enabled') if not self.job_exists(): self.create_job() else: self.update_job() def has_state_changed(self, status): # Keep in current state if enabled arg_spec is not given if self.enabled is None: return False return (self.enabled is False and status != "disabled") or (self.enabled is True and status == "disabled") def switch_state(self): if self.enabled is False: self.server.disable_job(self.name) else: self.server.enable_job(self.name) def update_job(self): try: status = self.get_job_status() # Handle job config if self.has_config_changed(): self.result['changed'] = True if not self.module.check_mode: self.server.reconfig_job(self.name, self.get_config()) # Handle job disable/enable elif status != self.EXCL_STATE and self.has_state_changed(status): self.result['changed'] = True if not self.module.check_mode: self.switch_state() except Exception as e: self.module.fail_json(msg='Unable to reconfigure job, %s for %s' % (to_native(e), self.jenkins_url), exception=traceback.format_exc()) def create_job(self): if self.config is None: self.module.fail_json(msg='missing required param: config') self.result['changed'] = True try: config_file = self.get_config() self.result['diff']['after'] = config_file if not self.module.check_mode: self.server.create_job(self.name, config_file) except Exception as e: self.module.fail_json(msg='Unable to create job, %s for %s' % (to_native(e), self.jenkins_url), exception=traceback.format_exc()) def absent_job(self): if self.job_exists(): self.result['changed'] = True self.result['diff']['before'] = self.get_current_config() if not self.module.check_mode: try: self.server.delete_job(self.name) except Exception as e: self.module.fail_json(msg='Unable to delete job, %s for %s' % (to_native(e), self.jenkins_url), exception=traceback.format_exc()) def get_result(self): result = self.result if self.job_exists(): result['enabled'] = self.get_job_status() != "disabled" else: result['enabled'] = None return result def test_dependencies(module): if not python_jenkins_installed: module.fail_json( msg=missing_required_lib("python-jenkins", url="https://python-jenkins.readthedocs.io/en/latest/install.html"), exception=JENKINS_IMP_ERR) def job_config_to_string(xml_str): return ET.tostring(ET.fromstring(xml_str)).decode('ascii') def main(): module = AnsibleModule( argument_spec=dict( config=dict(type='str', required=False), name=dict(type='str', required=True), password=dict(type='str', required=False, no_log=True), state=dict(type='str', required=False, choices=['present', 'absent'], default="present"), enabled=dict(required=False, type='bool'), token=dict(type='str', required=False, no_log=True), url=dict(type='str', required=False, default="http://localhost:8080"), user=dict(type='str', required=False), validate_certs=dict(type='bool', default=True), ), mutually_exclusive=[ ['password', 'token'], ['config', 'enabled'], ], supports_check_mode=True, ) test_dependencies(module) jenkins_job = JenkinsJob(module) if module.params.get('state') == "present": jenkins_job.present_job() else: jenkins_job.absent_job() result = jenkins_job.get_result() module.exit_json(**result) if __name__ == '__main__': main() PK $�!\ yh=�x �x R collections/ansible_collections/community/general/plugins/modules/lxd_container.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Hiroaki Nakamura <hnakamur@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: lxd_container short_description: Manage LXD instances description: - Management of LXD containers and virtual machines. author: "Hiroaki Nakamura (@hnakamur)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full version_added: 6.4.0 diff_mode: support: full version_added: 6.4.0 options: name: description: - Name of an instance. type: str required: true project: description: - 'Project of an instance. See U(https://documentation.ubuntu.com/lxd/en/latest/projects/).' required: false type: str version_added: 4.8.0 architecture: description: - 'The architecture for the instance (for example V(x86_64) or V(i686)). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).' type: str required: false config: description: - 'The config for the instance (for example V({"limits.cpu": "2"})). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).' - If the instance already exists and its "config" values in metadata obtained from the LXD API U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get) are different, then this module tries to apply the configurations U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_put). - The keys starting with C(volatile.) are ignored for this comparison when O(ignore_volatile_options=true). type: dict required: false ignore_volatile_options: description: - If set to V(true), options starting with C(volatile.) are ignored. As a result, they are reapplied for each execution. - This default behavior can be changed by setting this option to V(false). - The default value changed from V(true) to V(false) in community.general 6.0.0. type: bool required: false default: false version_added: 3.7.0 profiles: description: - Profile to be used by the instance. type: list elements: str devices: description: - 'The devices for the instance (for example V({ "rootfs": { "path": "/dev/kvm", "type": "unix-char" }})). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get).' type: dict required: false ephemeral: description: - Whether or not the instance is ephemeral (for example V(true) or V(false)). See U(https://documentation.ubuntu.com/lxd/en/latest/api/#/instances/instance_get). required: false type: bool source: description: - 'The source for the instance (for example V({ "type": "image", "mode": "pull", "server": "https://images.linuxcontainers.org", "protocol": "lxd", "alias": "ubuntu/xenial/amd64" })).' - 'See U(https://documentation.ubuntu.com/lxd/en/latest/api/) for complete API documentation.' - 'Note that C(protocol) accepts two choices: V(lxd) or V(simplestreams).' required: false type: dict state: choices: - started - stopped - restarted - absent - frozen description: - Define the state of an instance. required: false default: started type: str target: description: - For cluster deployments. Will attempt to create an instance on a target node. If the instance exists elsewhere in a cluster, then it will not be replaced or moved. The name should respond to same name of the node you see in C(lxc cluster list). type: str required: false version_added: 1.0.0 timeout: description: - A timeout for changing the state of the instance. - This is also used as a timeout for waiting until IPv4 addresses are set to the all network interfaces in the instance after starting or restarting. required: false default: 30 type: int type: description: - Instance type can be either V(virtual-machine) or V(container). required: false default: container choices: - container - virtual-machine type: str version_added: 4.1.0 wait_for_ipv4_addresses: description: - If this is V(true), the C(lxd_container) waits until IPv4 addresses are set to the all network interfaces in the instance after starting or restarting. required: false default: false type: bool wait_for_container: description: - If set to V(true), the tasks will wait till the task reports a success status when performing container operations. default: false type: bool version_added: 4.4.0 force_stop: description: - If this is V(true), the C(lxd_container) forces to stop the instance when it stops or restarts the instance. required: false default: false type: bool url: description: - The unix domain socket path or the https URL for the LXD server. required: false default: unix:/var/lib/lxd/unix.socket type: str snap_url: description: - The unix domain socket path when LXD is installed by snap package manager. required: false default: unix:/var/snap/lxd/common/lxd/unix.socket type: str client_key: description: - The client certificate key file path. - If not specified, it defaults to C(${HOME}/.config/lxc/client.key). required: false aliases: [ key_file ] type: path client_cert: description: - The client certificate file path. - If not specified, it defaults to C(${HOME}/.config/lxc/client.crt). required: false aliases: [ cert_file ] type: path trust_password: description: - The client trusted password. - 'You need to set this password on the LXD server before running this module using the following command: C(lxc config set core.trust_password <some random password>). See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).' - If trust_password is set, this module send a request for authentication before sending any requests. required: false type: str notes: - Instances can be a container or a virtual machine, both of them must have unique name. If you attempt to create an instance with a name that already existed in the users namespace the module will simply return as "unchanged". - There are two ways to run commands inside a container or virtual machine, using the command module or using the ansible lxd connection plugin bundled in Ansible >= 2.1, the later requires python to be installed in the instance which can be done with the command module. - You can copy a file from the host to the instance with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the P(community.general.lxd#connection) connection plugin. See the example below. - You can copy a file in the created instance to the localhost with C(command=lxc file pull instance_name/dir/filename filename). See the first example below. ''' EXAMPLES = ''' # An example for creating a Ubuntu container and install python - hosts: localhost connection: local tasks: - name: Create a started container community.general.lxd_container: name: mycontainer ignore_volatile_options: true state: started source: type: image mode: pull server: https://images.linuxcontainers.org protocol: lxd # if you get a 404, try setting protocol: simplestreams alias: ubuntu/xenial/amd64 profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 - name: Check python is installed in container delegate_to: mycontainer ansible.builtin.raw: dpkg -s python register: python_install_check failed_when: python_install_check.rc not in [0, 1] changed_when: false - name: Install python in container delegate_to: mycontainer ansible.builtin.raw: apt-get install -y python when: python_install_check.rc == 1 # An example for creating an Ubuntu 14.04 container using an image fingerprint. # This requires changing 'server' and 'protocol' key values, replacing the # 'alias' key with with 'fingerprint' and supplying an appropriate value that # matches the container image you wish to use. - hosts: localhost connection: local tasks: - name: Create a started container community.general.lxd_container: name: mycontainer ignore_volatile_options: true state: started source: type: image mode: pull # Provides current (and older) Ubuntu images with listed fingerprints server: https://cloud-images.ubuntu.com/releases # Protocol used by 'ubuntu' remote (as shown by 'lxc remote list') protocol: simplestreams # This provides an Ubuntu 14.04 LTS amd64 image from 20150814. fingerprint: e9a8bdfab6dc profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 # An example for creating container in project other than default - hosts: localhost connection: local tasks: - name: Create a started container in project mytestproject community.general.lxd_container: name: mycontainer project: mytestproject ignore_volatile_options: true state: started source: protocol: simplestreams type: image mode: pull server: https://images.linuxcontainers.org alias: ubuntu/20.04/cloud profiles: ["default"] wait_for_ipv4_addresses: true timeout: 600 # An example for deleting a container - hosts: localhost connection: local tasks: - name: Delete a container community.general.lxd_container: name: mycontainer state: absent type: container # An example for restarting a container - hosts: localhost connection: local tasks: - name: Restart a container community.general.lxd_container: name: mycontainer state: restarted type: container # An example for restarting a container using https to connect to the LXD server - hosts: localhost connection: local tasks: - name: Restart a container community.general.lxd_container: url: https://127.0.0.1:8443 # These client_cert and client_key values are equal to the default values. #client_cert: "{{ lookup('env', 'HOME') }}/.config/lxc/client.crt" #client_key: "{{ lookup('env', 'HOME') }}/.config/lxc/client.key" trust_password: mypassword name: mycontainer state: restarted # Note your container must be in the inventory for the below example. # # [containers] # mycontainer ansible_connection=lxd # - hosts: - mycontainer tasks: - name: Copy /etc/hosts in the created container to localhost with name "mycontainer-hosts" ansible.builtin.fetch: src: /etc/hosts dest: /tmp/mycontainer-hosts flat: true # An example for LXD cluster deployments. This example will create two new container on specific # nodes - 'node01' and 'node02'. In 'target:', 'node01' and 'node02' are names of LXD cluster # members that LXD cluster recognizes, not ansible inventory names, see: 'lxc cluster list'. # LXD API calls can be made to any LXD member, in this example, we send API requests to #'node01.example.com', which matches ansible inventory name. - hosts: node01.example.com tasks: - name: Create LXD container community.general.lxd_container: name: new-container-1 ignore_volatile_options: true state: started source: type: image mode: pull alias: ubuntu/xenial/amd64 target: node01 - name: Create container on another node community.general.lxd_container: name: new-container-2 ignore_volatile_options: true state: started source: type: image mode: pull alias: ubuntu/xenial/amd64 target: node02 # An example for creating a virtual machine - hosts: localhost connection: local tasks: - name: Create container on another node community.general.lxd_container: name: new-vm-1 type: virtual-machine state: started ignore_volatile_options: true wait_for_ipv4_addresses: true profiles: ["default"] source: protocol: simplestreams type: image mode: pull server: https://images.linuxcontainers.org alias: debian/11 timeout: 600 ''' RETURN = ''' addresses: description: Mapping from the network device name to a list of IPv4 addresses in the instance. returned: when state is started or restarted type: dict sample: {"eth0": ["10.155.92.191"]} old_state: description: The old state of the instance. returned: when state is started or restarted type: str sample: "stopped" logs: description: The logs of requests and responses. returned: when ansible-playbook is invoked with -vvvv. type: list sample: "(too long to be placed here)" actions: description: List of actions performed for the instance. returned: success type: list sample: ["create", "start"] ''' import copy import datetime import os import time from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.lxd import LXDClient, LXDClientException from ansible.module_utils.six.moves.urllib.parse import urlencode # LXD_ANSIBLE_STATES is a map of states that contain values of methods used # when a particular state is evoked. LXD_ANSIBLE_STATES = { 'started': '_started', 'stopped': '_stopped', 'restarted': '_restarted', 'absent': '_destroyed', 'frozen': '_frozen', } # ANSIBLE_LXD_STATES is a map of states of lxd containers to the Ansible # lxc_container module state parameter value. ANSIBLE_LXD_STATES = { 'Running': 'started', 'Stopped': 'stopped', 'Frozen': 'frozen', } # ANSIBLE_LXD_DEFAULT_URL is a default value of the lxd endpoint ANSIBLE_LXD_DEFAULT_URL = 'unix:/var/lib/lxd/unix.socket' # CONFIG_PARAMS is a list of config attribute names. CONFIG_PARAMS = [ 'architecture', 'config', 'devices', 'ephemeral', 'profiles', 'source' ] # CONFIG_CREATION_PARAMS is a list of attribute names that are only applied # on instance creation. CONFIG_CREATION_PARAMS = ['source'] class LXDContainerManagement(object): def __init__(self, module): """Management of LXC containers via Ansible. :param module: Processed Ansible Module. :type module: ``object`` """ self.module = module self.name = self.module.params['name'] self.project = self.module.params['project'] self._build_config() self.state = self.module.params['state'] self.timeout = self.module.params['timeout'] self.wait_for_ipv4_addresses = self.module.params['wait_for_ipv4_addresses'] self.force_stop = self.module.params['force_stop'] self.addresses = None self.target = self.module.params['target'] self.wait_for_container = self.module.params['wait_for_container'] self.type = self.module.params['type'] # LXD Rest API provides additional endpoints for creating containers and virtual-machines. self.api_endpoint = None if self.type == 'container': self.api_endpoint = '/1.0/containers' elif self.type == 'virtual-machine': self.api_endpoint = '/1.0/virtual-machines' self.key_file = self.module.params.get('client_key') if self.key_file is None: self.key_file = '{0}/.config/lxc/client.key'.format(os.environ['HOME']) self.cert_file = self.module.params.get('client_cert') if self.cert_file is None: self.cert_file = '{0}/.config/lxc/client.crt'.format(os.environ['HOME']) self.debug = self.module._verbosity >= 4 try: if self.module.params['url'] != ANSIBLE_LXD_DEFAULT_URL: self.url = self.module.params['url'] elif os.path.exists(self.module.params['snap_url'].replace('unix:', '')): self.url = self.module.params['snap_url'] else: self.url = self.module.params['url'] except Exception as e: self.module.fail_json(msg=e.msg) try: self.client = LXDClient( self.url, key_file=self.key_file, cert_file=self.cert_file, debug=self.debug ) except LXDClientException as e: self.module.fail_json(msg=e.msg) self.trust_password = self.module.params.get('trust_password', None) self.actions = [] self.diff = {'before': {}, 'after': {}} self.old_instance_json = {} self.old_sections = {} def _build_config(self): self.config = {} for attr in CONFIG_PARAMS: param_val = self.module.params.get(attr, None) if param_val is not None: self.config[attr] = param_val def _get_instance_json(self): url = '{0}/{1}'.format(self.api_endpoint, self.name) if self.project: url = '{0}?{1}'.format(url, urlencode(dict(project=self.project))) return self.client.do('GET', url, ok_error_codes=[404]) def _get_instance_state_json(self): url = '{0}/{1}/state'.format(self.api_endpoint, self.name) if self.project: url = '{0}?{1}'.format(url, urlencode(dict(project=self.project))) return self.client.do('GET', url, ok_error_codes=[404]) @staticmethod def _instance_json_to_module_state(resp_json): if resp_json['type'] == 'error': return 'absent' return ANSIBLE_LXD_STATES[resp_json['metadata']['status']] def _change_state(self, action, force_stop=False): url = '{0}/{1}/state'.format(self.api_endpoint, self.name) if self.project: url = '{0}?{1}'.format(url, urlencode(dict(project=self.project))) body_json = {'action': action, 'timeout': self.timeout} if force_stop: body_json['force'] = True if not self.module.check_mode: return self.client.do('PUT', url, body_json=body_json) def _create_instance(self): url = self.api_endpoint url_params = dict() if self.target: url_params['target'] = self.target if self.project: url_params['project'] = self.project if url_params: url = '{0}?{1}'.format(url, urlencode(url_params)) config = self.config.copy() config['name'] = self.name if not self.module.check_mode: self.client.do('POST', url, config, wait_for_container=self.wait_for_container) self.actions.append('create') def _start_instance(self): self._change_state('start') self.actions.append('start') def _stop_instance(self): self._change_state('stop', self.force_stop) self.actions.append('stop') def _restart_instance(self): self._change_state('restart', self.force_stop) self.actions.append('restart') def _delete_instance(self): url = '{0}/{1}'.format(self.api_endpoint, self.name) if self.project: url = '{0}?{1}'.format(url, urlencode(dict(project=self.project))) if not self.module.check_mode: self.client.do('DELETE', url) self.actions.append('delete') def _freeze_instance(self): self._change_state('freeze') self.actions.append('freeze') def _unfreeze_instance(self): self._change_state('unfreeze') self.actions.append('unfreeze') def _instance_ipv4_addresses(self, ignore_devices=None): ignore_devices = ['lo'] if ignore_devices is None else ignore_devices data = (self._get_instance_state_json() or {}).get('metadata', None) or {} network = dict((k, v) for k, v in (data.get('network', None) or {}).items() if k not in ignore_devices) addresses = dict((k, [a['address'] for a in v['addresses'] if a['family'] == 'inet']) for k, v in network.items()) return addresses @staticmethod def _has_all_ipv4_addresses(addresses): return len(addresses) > 0 and all(len(v) > 0 for v in addresses.values()) def _get_addresses(self): try: due = datetime.datetime.now() + datetime.timedelta(seconds=self.timeout) while datetime.datetime.now() < due: time.sleep(1) addresses = self._instance_ipv4_addresses() if self._has_all_ipv4_addresses(addresses) or self.module.check_mode: self.addresses = addresses return except LXDClientException as e: e.msg = 'timeout for getting IPv4 addresses' raise def _started(self): if self.old_state == 'absent': self._create_instance() self._start_instance() else: if self.old_state == 'frozen': self._unfreeze_instance() elif self.old_state == 'stopped': self._start_instance() if self._needs_to_apply_instance_configs(): self._apply_instance_configs() if self.wait_for_ipv4_addresses: self._get_addresses() def _stopped(self): if self.old_state == 'absent': self._create_instance() else: if self.old_state == 'stopped': if self._needs_to_apply_instance_configs(): self._start_instance() self._apply_instance_configs() self._stop_instance() else: if self.old_state == 'frozen': self._unfreeze_instance() if self._needs_to_apply_instance_configs(): self._apply_instance_configs() self._stop_instance() def _restarted(self): if self.old_state == 'absent': self._create_instance() self._start_instance() else: if self.old_state == 'frozen': self._unfreeze_instance() if self._needs_to_apply_instance_configs(): self._apply_instance_configs() self._restart_instance() if self.wait_for_ipv4_addresses: self._get_addresses() def _destroyed(self): if self.old_state != 'absent': if self.old_state == 'frozen': self._unfreeze_instance() if self.old_state != 'stopped': self._stop_instance() self._delete_instance() def _frozen(self): if self.old_state == 'absent': self._create_instance() self._start_instance() self._freeze_instance() else: if self.old_state == 'stopped': self._start_instance() if self._needs_to_apply_instance_configs(): self._apply_instance_configs() self._freeze_instance() def _needs_to_change_instance_config(self, key): if key not in self.config: return False if key == 'config': # self.old_sections is already filtered for volatile keys if necessary old_configs = dict(self.old_sections.get(key, None) or {}) for k, v in self.config['config'].items(): if k not in old_configs: return True if old_configs[k] != v: return True return False else: old_configs = self.old_sections.get(key, {}) return self.config[key] != old_configs def _needs_to_apply_instance_configs(self): for param in set(CONFIG_PARAMS) - set(CONFIG_CREATION_PARAMS): if self._needs_to_change_instance_config(param): return True return False def _apply_instance_configs(self): old_metadata = copy.deepcopy(self.old_instance_json).get('metadata', None) or {} body_json = {} for param in set(CONFIG_PARAMS) - set(CONFIG_CREATION_PARAMS): if param in old_metadata: body_json[param] = old_metadata[param] if self._needs_to_change_instance_config(param): if param == 'config': body_json['config'] = body_json.get('config', None) or {} for k, v in self.config['config'].items(): body_json['config'][k] = v else: body_json[param] = self.config[param] self.diff['after']['instance'] = body_json url = '{0}/{1}'.format(self.api_endpoint, self.name) if self.project: url = '{0}?{1}'.format(url, urlencode(dict(project=self.project))) if not self.module.check_mode: self.client.do('PUT', url, body_json=body_json) self.actions.append('apply_instance_configs') def run(self): """Run the main method.""" try: if self.trust_password is not None: self.client.authenticate(self.trust_password) self.ignore_volatile_options = self.module.params.get('ignore_volatile_options') self.old_instance_json = self._get_instance_json() self.old_sections = dict( (section, content) if not isinstance(content, dict) else (section, dict((k, v) for k, v in content.items() if not (self.ignore_volatile_options and k.startswith('volatile.')))) for section, content in (self.old_instance_json.get('metadata', None) or {}).items() if section in set(CONFIG_PARAMS) - set(CONFIG_CREATION_PARAMS) ) self.diff['before']['instance'] = self.old_sections # preliminary, will be overwritten in _apply_instance_configs() if called self.diff['after']['instance'] = self.config self.old_state = self._instance_json_to_module_state(self.old_instance_json) self.diff['before']['state'] = self.old_state self.diff['after']['state'] = self.state action = getattr(self, LXD_ANSIBLE_STATES[self.state]) action() state_changed = len(self.actions) > 0 result_json = { 'log_verbosity': self.module._verbosity, 'changed': state_changed, 'old_state': self.old_state, 'actions': self.actions, 'diff': self.diff, } if self.client.debug: result_json['logs'] = self.client.logs if self.addresses is not None: result_json['addresses'] = self.addresses self.module.exit_json(**result_json) except LXDClientException as e: state_changed = len(self.actions) > 0 fail_params = { 'msg': e.msg, 'changed': state_changed, 'actions': self.actions, 'diff': self.diff, } if self.client.debug: fail_params['logs'] = e.kwargs['logs'] self.module.fail_json(**fail_params) def main(): """Ansible Main module.""" module = AnsibleModule( argument_spec=dict( name=dict( type='str', required=True, ), project=dict( type='str', ), architecture=dict( type='str', ), config=dict( type='dict', ), ignore_volatile_options=dict( type='bool', default=False, ), devices=dict( type='dict', ), ephemeral=dict( type='bool', ), profiles=dict( type='list', elements='str', ), source=dict( type='dict', ), state=dict( choices=list(LXD_ANSIBLE_STATES.keys()), default='started', ), target=dict( type='str', ), timeout=dict( type='int', default=30 ), type=dict( type='str', default='container', choices=['container', 'virtual-machine'], ), wait_for_container=dict( type='bool', default=False, ), wait_for_ipv4_addresses=dict( type='bool', default=False, ), force_stop=dict( type='bool', default=False, ), url=dict( type='str', default=ANSIBLE_LXD_DEFAULT_URL, ), snap_url=dict( type='str', default='unix:/var/snap/lxd/common/lxd/unix.socket', ), client_key=dict( type='path', aliases=['key_file'], ), client_cert=dict( type='path', aliases=['cert_file'], ), trust_password=dict(type='str', no_log=True), ), supports_check_mode=True, ) lxd_manage = LXDContainerManagement(module=module) lxd_manage.run() if __name__ == '__main__': main() PK $�!\v�LY� � M collections/ansible_collections/community/general/plugins/modules/typetalk.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: typetalk short_description: Send a message to typetalk description: - Send a message to typetalk using typetalk API extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: client_id: type: str description: - OAuth2 client ID required: true client_secret: type: str description: - OAuth2 client secret required: true topic: type: int description: - topic id to post message required: true msg: type: str description: - message body required: true requirements: [ json ] author: "Takashi Someda (@tksmd)" ''' EXAMPLES = ''' - name: Send a message to typetalk community.general.typetalk: client_id: 12345 client_secret: 12345 topic: 1 msg: install completed ''' import json from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.urls import fetch_url, ConnectionError def do_request(module, url, params, headers=None): data = urlencode(params) if headers is None: headers = dict() headers = dict(headers, **{ 'User-Agent': 'Ansible/typetalk module', }) r, info = fetch_url(module, url, data=data, headers=headers) if info['status'] != 200: exc = ConnectionError(info['msg']) exc.code = info['status'] raise exc return r def get_access_token(module, client_id, client_secret): params = { 'client_id': client_id, 'client_secret': client_secret, 'grant_type': 'client_credentials', 'scope': 'topic.post' } res = do_request(module, 'https://typetalk.com/oauth2/access_token', params) return json.load(res)['access_token'] def send_message(module, client_id, client_secret, topic, msg): """ send message to typetalk """ try: access_token = get_access_token(module, client_id, client_secret) url = 'https://typetalk.com/api/v1/topics/%d' % topic headers = { 'Authorization': 'Bearer %s' % access_token, } do_request(module, url, {'message': msg}, headers) return True, {'access_token': access_token} except ConnectionError as e: return False, e def main(): module = AnsibleModule( argument_spec=dict( client_id=dict(required=True), client_secret=dict(required=True, no_log=True), topic=dict(required=True, type='int'), msg=dict(required=True), ), supports_check_mode=False ) if not json: module.fail_json(msg="json module is required") client_id = module.params["client_id"] client_secret = module.params["client_secret"] topic = module.params["topic"] msg = module.params["msg"] res, error = send_message(module, client_id, client_secret, topic, msg) if not res: module.fail_json(msg='fail to send message with response code %s' % error.code) module.exit_json(changed=True, topic=topic, msg=msg) if __name__ == '__main__': main() PK $�!\ ��n� � [ collections/ansible_collections/community/general/plugins/modules/scaleway_function_info.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway Serverless function info module # # Copyright (c) 2022, Guillaume MARTINEZ <lunik@tiwabbit.fr> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_function_info short_description: Retrieve information on Scaleway Function version_added: 6.0.0 author: Guillaume MARTINEZ (@Lunik) description: - This module return information about a function on Scaleway account. extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module options: namespace_id: type: str description: - Container namespace identifier. required: true region: type: str description: - Scaleway region to use (for example C(fr-par)). required: true choices: - fr-par - nl-ams - pl-waw name: type: str description: - Name of the function. required: true ''' EXAMPLES = ''' - name: Get a function info community.general.scaleway_function_info: namespace_id: '{{ scw_function_namespace }}' region: fr-par name: my-awesome-function register: function_info_task ''' RETURN = ''' function: description: The function information. returned: always type: dict sample: cpu_limit: 140 description: Function used for testing scaleway_function ansible module domain_name: fnansibletestfxamabuc-fn-ansible-test.functions.fnc.fr-par.scw.cloud environment_variables: MY_VAR: my_value error_message: null handler: handler.handle http_option: "" id: ceb64dc4-4464-4196-8e20-ecef705475d3 max_scale: 5 memory_limit: 256 min_scale: 0 name: fn-ansible-test namespace_id: 82737d8d-0ebb-4d89-b0ad-625876eca50d privacy: public region: fr-par runtime: python310 runtime_message: "" secret_environment_variables: - key: MY_SECRET_VAR value: $argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg status: created timeout: 300s ''' from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway ) from ansible.module_utils.basic import AnsibleModule def info_strategy(api, wished_fn): fn_list = api.fetch_all_resources("functions") fn_lookup = dict((fn["name"], fn) for fn in fn_list) if wished_fn["name"] not in fn_lookup: msg = "Error during function lookup: Unable to find function named '%s' in namespace '%s'" % (wished_fn["name"], wished_fn["namespace_id"]) api.module.fail_json(msg=msg) target_fn = fn_lookup[wished_fn["name"]] response = api.get(path=api.api_path + "/%s" % target_fn["id"]) if not response.ok: msg = "Error during function lookup: %s: '%s' (%s)" % (response.info['msg'], response.json['message'], response.json) api.module.fail_json(msg=msg) return response.json def core(module): region = module.params["region"] wished_function = { "namespace_id": module.params["namespace_id"], "name": module.params["name"] } api = Scaleway(module=module) api.api_path = "functions/v1beta1/regions/%s/functions" % region summary = info_strategy(api=api, wished_fn=wished_function) module.exit_json(changed=False, function=summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( namespace_id=dict(type='str', required=True), region=dict(type='str', required=True, choices=SCALEWAY_REGIONS), name=dict(type='str', required=True) )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\�K �% % M collections/ansible_collections/community/general/plugins/modules/composer.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Dimitrios Tydeas Mengidis <tydeas.dr@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: composer author: - "Dimitrios Tydeas Mengidis (@dmtrs)" - "René Moser (@resmo)" short_description: Dependency Manager for PHP description: - > Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: command: type: str description: - Composer command like "install", "update" and so on. default: install arguments: type: str description: - Composer arguments like required package, version and so on. default: '' executable: type: path description: - Path to PHP Executable on the remote host, if PHP is not in PATH. aliases: [ php_path ] working_dir: type: path description: - Directory of your project (see --working-dir). This is required when the command is not run globally. - Will be ignored if O(global_command=true). global_command: description: - Runs the specified command globally. type: bool default: false prefer_source: description: - Forces installation from package sources when possible (see --prefer-source). default: false type: bool prefer_dist: description: - Forces installation from package dist even for dev versions (see --prefer-dist). default: false type: bool no_dev: description: - Disables installation of require-dev packages (see --no-dev). default: true type: bool no_scripts: description: - Skips the execution of all scripts defined in composer.json (see --no-scripts). default: false type: bool no_plugins: description: - Disables all plugins (see --no-plugins). default: false type: bool optimize_autoloader: description: - Optimize autoloader during autoloader dump (see --optimize-autoloader). - Convert PSR-0/4 autoloading to classmap to get a faster autoloader. - Recommended especially for production, but can take a bit of time to run. default: true type: bool classmap_authoritative: description: - Autoload classes from classmap only. - Implicitly enable optimize_autoloader. - Recommended especially for production, but can take a bit of time to run. default: false type: bool apcu_autoloader: description: - Uses APCu to cache found/not-found classes default: false type: bool ignore_platform_reqs: description: - Ignore php, hhvm, lib-* and ext-* requirements and force the installation even if the local machine does not fulfill these. default: false type: bool composer_executable: type: path description: - Path to composer executable on the remote host, if composer is not in E(PATH) or a custom composer is needed. version_added: 3.2.0 requirements: - php - composer installed in bin path (recommended /usr/local/bin) or specified in O(composer_executable) notes: - Default options that are always appended in each execution are --no-ansi, --no-interaction and --no-progress if available. - We received reports about issues on macOS if composer was installed by Homebrew. Please use the official install method to avoid issues. ''' EXAMPLES = ''' - name: Download and installs all libs and dependencies outlined in the /path/to/project/composer.lock community.general.composer: command: install working_dir: /path/to/project - name: Install a new package community.general.composer: command: require arguments: my/package working_dir: /path/to/project - name: Clone and install a project with all dependencies community.general.composer: command: create-project arguments: package/package /path/to/project ~1.0 working_dir: /path/to/project prefer_dist: true - name: Install a package globally community.general.composer: command: require global_command: true arguments: my/package ''' import re from ansible.module_utils.basic import AnsibleModule def parse_out(string): return re.sub(r"\s+", " ", string).strip() def has_changed(string): for no_change in ["Nothing to install or update", "Nothing to install, update or remove"]: if no_change in string: return False return True def get_available_options(module, command='install'): # get all available options from a composer command using composer help to json rc, out, err = composer_command(module, "help %s" % command, arguments="--no-interaction --format=json") if rc != 0: output = parse_out(err) module.fail_json(msg=output) command_help_json = module.from_json(out) return command_help_json['definition']['options'] def composer_command(module, command, arguments="", options=None, global_command=False): if options is None: options = [] if module.params['executable'] is None: php_path = module.get_bin_path("php", True, ["/usr/local/bin"]) else: php_path = module.params['executable'] if module.params['composer_executable'] is None: composer_path = module.get_bin_path("composer", True, ["/usr/local/bin"]) else: composer_path = module.params['composer_executable'] cmd = "%s %s %s %s %s %s" % (php_path, composer_path, "global" if global_command else "", command, " ".join(options), arguments) return module.run_command(cmd) def main(): module = AnsibleModule( argument_spec=dict( command=dict(default="install", type="str"), arguments=dict(default="", type="str"), executable=dict(type="path", aliases=["php_path"]), working_dir=dict(type="path"), global_command=dict(default=False, type="bool"), prefer_source=dict(default=False, type="bool"), prefer_dist=dict(default=False, type="bool"), no_dev=dict(default=True, type="bool"), no_scripts=dict(default=False, type="bool"), no_plugins=dict(default=False, type="bool"), apcu_autoloader=dict(default=False, type="bool"), optimize_autoloader=dict(default=True, type="bool"), classmap_authoritative=dict(default=False, type="bool"), ignore_platform_reqs=dict(default=False, type="bool"), composer_executable=dict(type="path"), ), required_if=[('global_command', False, ['working_dir'])], supports_check_mode=True ) # Get composer command with fallback to default command = module.params['command'] if re.search(r"\s", command): module.fail_json(msg="Use the 'arguments' param for passing arguments with the 'command'") arguments = module.params['arguments'] global_command = module.params['global_command'] available_options = get_available_options(module=module, command=command) options = [] # Default options default_options = [ 'no-ansi', 'no-interaction', 'no-progress', ] for option in default_options: if option in available_options: option = "--%s" % option options.append(option) if not global_command: options.extend(['--working-dir', "'%s'" % module.params['working_dir']]) option_params = { 'prefer_source': 'prefer-source', 'prefer_dist': 'prefer-dist', 'no_dev': 'no-dev', 'no_scripts': 'no-scripts', 'no_plugins': 'no-plugins', 'apcu_autoloader': 'acpu-autoloader', 'optimize_autoloader': 'optimize-autoloader', 'classmap_authoritative': 'classmap-authoritative', 'ignore_platform_reqs': 'ignore-platform-reqs', } for param, option in option_params.items(): if module.params.get(param) and option in available_options: option = "--%s" % option options.append(option) if module.check_mode: if 'dry-run' in available_options: options.append('--dry-run') else: module.exit_json(skipped=True, msg="command '%s' does not support check mode, skipping" % command) rc, out, err = composer_command(module, command, arguments, options, global_command) if rc != 0: output = parse_out(err) module.fail_json(msg=output, stdout=err) else: # Composer version > 1.0.0-alpha9 now use stderr for standard notification messages output = parse_out(out + err) module.exit_json(changed=has_changed(output), msg=output, stdout=out + err) if __name__ == '__main__': main() PK $�!\����S S Y collections/ansible_collections/community/general/plugins/modules/oneview_fcoe_network.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_fcoe_network short_description: Manage OneView FCoE Network resources description: - Provides an interface to manage FCoE Network resources. Can create, update, or delete. requirements: - "python >= 2.7.9" - "hpOneView >= 4.0.0" author: "Felipe Bulsoni (@fgbulsoni)" attributes: check_mode: support: none diff_mode: support: none options: state: description: - Indicates the desired state for the FCoE Network resource. V(present) will ensure data properties are compliant with OneView. V(absent) will remove the resource from OneView, if it exists. type: str default: present choices: ['present', 'absent'] data: description: - List with FCoE Network properties. type: dict required: true extends_documentation_fragment: - community.general.oneview - community.general.oneview.validateetag - community.general.attributes ''' EXAMPLES = ''' - name: Ensure that FCoE Network is present using the default configuration community.general.oneview_fcoe_network: config: '/etc/oneview/oneview_config.json' state: present data: name: Test FCoE Network vlanId: 201 delegate_to: localhost - name: Update the FCOE network scopes community.general.oneview_fcoe_network: config: '/etc/oneview/oneview_config.json' state: present data: name: New FCoE Network scopeUris: - '/rest/scopes/00SC123456' - '/rest/scopes/01SC123456' delegate_to: localhost - name: Ensure that FCoE Network is absent community.general.oneview_fcoe_network: config: '/etc/oneview/oneview_config.json' state: absent data: name: New FCoE Network delegate_to: localhost ''' RETURN = ''' fcoe_network: description: Has the facts about the OneView FCoE Networks. returned: On state 'present'. Can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class FcoeNetworkModule(OneViewModuleBase): MSG_CREATED = 'FCoE Network created successfully.' MSG_UPDATED = 'FCoE Network updated successfully.' MSG_DELETED = 'FCoE Network deleted successfully.' MSG_ALREADY_PRESENT = 'FCoE Network is already present.' MSG_ALREADY_ABSENT = 'FCoE Network is already absent.' RESOURCE_FACT_NAME = 'fcoe_network' def __init__(self): additional_arg_spec = dict(data=dict(required=True, type='dict'), state=dict(default='present', choices=['present', 'absent'])) super(FcoeNetworkModule, self).__init__(additional_arg_spec=additional_arg_spec, validate_etag_support=True) self.resource_client = self.oneview_client.fcoe_networks def execute_module(self): resource = self.get_by_name(self.data.get('name')) if self.state == 'present': return self.__present(resource) elif self.state == 'absent': return self.resource_absent(resource) def __present(self, resource): scope_uris = self.data.pop('scopeUris', None) result = self.resource_present(resource, self.RESOURCE_FACT_NAME) if scope_uris is not None: result = self.resource_scopes_set(result, 'fcoe_network', scope_uris) return result def main(): FcoeNetworkModule().run() if __name__ == '__main__': main() PK $�!\R�#�L L T collections/ansible_collections/community/general/plugins/modules/icinga2_feature.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Loic Blot <loic.blot@unix-experience.fr> # Copyright (c) 2018, Ansible Project # Sponsored by Infopro Digital. http://www.infopro-digital.com/ # Sponsored by E.T.A.I. http://www.etai.fr/ # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: icinga2_feature short_description: Manage Icinga2 feature description: - This module can be used to enable or disable an Icinga2 feature. author: "Loic Blot (@nerzhul)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - This is the feature name to enable or disable. required: true state: type: str description: - If set to V(present) and feature is disabled, then feature is enabled. - If set to V(present) and feature is already enabled, then nothing is changed. - If set to V(absent) and feature is enabled, then feature is disabled. - If set to V(absent) and feature is already disabled, then nothing is changed. choices: [ "present", "absent" ] default: present ''' EXAMPLES = ''' - name: Enable ido-pgsql feature community.general.icinga2_feature: name: ido-pgsql state: present - name: Disable api feature community.general.icinga2_feature: name: api state: absent ''' RETURN = ''' # ''' import re from ansible.module_utils.basic import AnsibleModule class Icinga2FeatureHelper: def __init__(self, module): self.module = module self._icinga2 = module.get_bin_path('icinga2', True) self.feature_name = self.module.params['name'] self.state = self.module.params['state'] def _exec(self, args): cmd = [self._icinga2, 'feature'] rc, out, err = self.module.run_command(cmd + args, check_rc=True) return rc, out def manage(self): rc, out = self._exec(["list"]) if rc != 0: self.module.fail_json(msg="Unable to list icinga2 features. " "Ensure icinga2 is installed and present in binary path.") # If feature is already in good state, just exit if (re.search("Disabled features:.* %s[ \n]" % self.feature_name, out) and self.state == "absent") or \ (re.search("Enabled features:.* %s[ \n]" % self.feature_name, out) and self.state == "present"): self.module.exit_json(changed=False) if self.module.check_mode: self.module.exit_json(changed=True) feature_enable_str = "enable" if self.state == "present" else "disable" rc, out = self._exec([feature_enable_str, self.feature_name]) change_applied = False if self.state == "present": if rc != 0: self.module.fail_json(msg="Failed to %s feature %s." " icinga2 command returned %s" % (feature_enable_str, self.feature_name, out)) if re.search("already enabled", out) is None: change_applied = True else: if rc == 0: change_applied = True # RC is not 0 for this already disabled feature, handle it as no change applied elif re.search("Cannot disable feature '%s'. Target file .* does not exist" % self.feature_name, out): change_applied = False else: self.module.fail_json(msg="Failed to disable feature. Command returns %s" % out) self.module.exit_json(changed=change_applied) def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True), state=dict(type='str', choices=["present", "absent"], default="present") ), supports_check_mode=True ) module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C') Icinga2FeatureHelper(module).manage() if __name__ == '__main__': main() PK $�!\�A��� � N collections/ansible_collections/community/general/plugins/modules/ipa_vault.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Juan Manuel Parrilla <jparrill@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_vault author: Juan Manuel Parrilla (@jparrill) short_description: Manage FreeIPA vaults description: - Add, modify and delete vaults and secret vaults. - KRA service should be enabled to use this module. attributes: check_mode: support: full diff_mode: support: none options: cn: description: - Vault name. - Can not be changed as it is the unique identifier. required: true aliases: ["name"] type: str description: description: - Description. type: str ipavaulttype: description: - Vault types are based on security level. default: "symmetric" choices: ["asymmetric", "standard", "symmetric"] aliases: ["vault_type"] type: str ipavaultpublickey: description: - Public key. aliases: ["vault_public_key"] type: str ipavaultsalt: description: - Vault Salt. aliases: ["vault_salt"] type: str username: description: - Any user can own one or more user vaults. - Mutually exclusive with service. aliases: ["user"] type: list elements: str service: description: - Any service can own one or more service vaults. - Mutually exclusive with user. type: str state: description: - State to ensure. default: "present" choices: ["absent", "present"] type: str replace: description: - Force replace the existent vault on IPA server. type: bool default: false choices: ["True", "False"] validate_certs: description: - Validate IPA server certificates. type: bool default: true extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure vault is present community.general.ipa_vault: name: vault01 vault_type: standard user: user01 ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret validate_certs: false - name: Ensure vault is present for Admin user community.general.ipa_vault: name: vault01 vault_type: standard ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure vault is absent community.general.ipa_vault: name: vault01 vault_type: standard user: user01 state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Modify vault if already exists community.general.ipa_vault: name: vault01 vault_type: standard description: "Vault for test" ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret replace: true - name: Get vault info if already exists community.general.ipa_vault: name: vault01 ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' vault: description: Vault as returned by IPA API returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class VaultIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(VaultIPAClient, self).__init__(module, host, port, protocol) def vault_find(self, name): return self._post_json(method='vault_find', name=None, item={'all': True, 'cn': name}) def vault_add_internal(self, name, item): return self._post_json(method='vault_add_internal', name=name, item=item) def vault_mod_internal(self, name, item): return self._post_json(method='vault_mod_internal', name=name, item=item) def vault_del(self, name): return self._post_json(method='vault_del', name=name) def get_vault_dict(description=None, vault_type=None, vault_salt=None, vault_public_key=None, service=None): vault = {} if description is not None: vault['description'] = description if vault_type is not None: vault['ipavaulttype'] = vault_type if vault_salt is not None: vault['ipavaultsalt'] = vault_salt if vault_public_key is not None: vault['ipavaultpublickey'] = vault_public_key if service is not None: vault['service'] = service return vault def get_vault_diff(client, ipa_vault, module_vault, module): return client.get_diff(ipa_data=ipa_vault, module_data=module_vault) def ensure(module, client): state = module.params['state'] name = module.params['cn'] user = module.params['username'] replace = module.params['replace'] module_vault = get_vault_dict(description=module.params['description'], vault_type=module.params['ipavaulttype'], vault_salt=module.params['ipavaultsalt'], vault_public_key=module.params['ipavaultpublickey'], service=module.params['service']) ipa_vault = client.vault_find(name=name) changed = False if state == 'present': if not ipa_vault: # New vault changed = True if not module.check_mode: ipa_vault = client.vault_add_internal(name, item=module_vault) else: # Already exists if replace: diff = get_vault_diff(client, ipa_vault, module_vault, module) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_vault.get(key) client.vault_mod_internal(name=name, item=data) else: if ipa_vault: changed = True if not module.check_mode: client.vault_del(name) return changed, client.vault_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), ipavaulttype=dict(type='str', default='symmetric', choices=['standard', 'symmetric', 'asymmetric'], aliases=['vault_type']), ipavaultsalt=dict(type='str', aliases=['vault_salt']), ipavaultpublickey=dict(type='str', aliases=['vault_public_key']), service=dict(type='str'), replace=dict(type='bool', default=False, choices=[True, False]), state=dict(type='str', default='present', choices=['present', 'absent']), username=dict(type='list', elements='str', aliases=['user'])) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, mutually_exclusive=[['username', 'service']]) client = VaultIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, vault = ensure(module, client) module.exit_json(changed=changed, vault=vault) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\��C� L collections/ansible_collections/community/general/plugins/modules/rax_cdb.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: rax_cdb short_description: Create/delete or resize a Rackspace Cloud Databases instance description: - creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be 'running'. The name option needs to be unique since it's used to identify the instance. attributes: check_mode: support: none diff_mode: support: none options: name: type: str description: - Name of the databases server instance required: true flavor: type: int description: - flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB) default: 1 volume: type: int description: - Volume size of the database 1-150GB default: 2 cdb_type: type: str description: - type of instance (i.e. MySQL, MariaDB, Percona) default: MySQL aliases: ['type'] cdb_version: type: str description: - version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6) - "The available choices are: V(5.1), V(5.6) and V(10)." default: '5.6' aliases: ['version'] state: type: str description: - Indicate desired state of the resource choices: ['present', 'absent'] default: present wait: description: - wait for the instance to be in state 'running' before returning type: bool default: false wait_timeout: type: int description: - how long before wait gives up, in seconds default: 300 author: "Simon JAILLET (@jails)" extends_documentation_fragment: - community.general.rackspace - community.general.rackspace.openstack - community.general.attributes ''' EXAMPLES = ''' - name: Build a Cloud Databases gather_facts: false tasks: - name: Server build request local_action: module: rax_cdb credentials: ~/.raxpub region: IAD name: db-server1 flavor: 1 volume: 2 cdb_type: MySQL cdb_version: 5.6 wait: true state: present register: rax_db_server ''' try: import pyrax HAS_PYRAX = True except ImportError: HAS_PYRAX = False from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.rax import rax_argument_spec, rax_required_together, rax_to_dict, setup_rax_module def find_instance(name): cdb = pyrax.cloud_databases instances = cdb.list() if instances: for instance in instances: if instance.name == name: return instance return False def save_instance(module, name, flavor, volume, cdb_type, cdb_version, wait, wait_timeout): for arg, value in dict(name=name, flavor=flavor, volume=volume, type=cdb_type, version=cdb_version ).items(): if not value: module.fail_json(msg='%s is required for the "rax_cdb"' ' module' % arg) if not (volume >= 1 and volume <= 150): module.fail_json(msg='volume is required to be between 1 and 150') cdb = pyrax.cloud_databases flavors = [] for item in cdb.list_flavors(): flavors.append(item.id) if not (flavor in flavors): module.fail_json(msg='unexisting flavor reference "%s"' % str(flavor)) changed = False instance = find_instance(name) if not instance: action = 'create' try: instance = cdb.create(name=name, flavor=flavor, volume=volume, type=cdb_type, version=cdb_version) except Exception as e: module.fail_json(msg='%s' % e.message) else: changed = True else: action = None if instance.volume.size != volume: action = 'resize' if instance.volume.size > volume: module.fail_json(changed=False, action=action, msg='The new volume size must be larger than ' 'the current volume size', cdb=rax_to_dict(instance)) instance.resize_volume(volume) changed = True if int(instance.flavor.id) != flavor: action = 'resize' pyrax.utils.wait_until(instance, 'status', 'ACTIVE', attempts=wait_timeout) instance.resize(flavor) changed = True if wait: pyrax.utils.wait_until(instance, 'status', 'ACTIVE', attempts=wait_timeout) if wait and instance.status != 'ACTIVE': module.fail_json(changed=changed, action=action, cdb=rax_to_dict(instance), msg='Timeout waiting for "%s" databases instance to ' 'be created' % name) module.exit_json(changed=changed, action=action, cdb=rax_to_dict(instance)) def delete_instance(module, name, wait, wait_timeout): if not name: module.fail_json(msg='name is required for the "rax_cdb" module') changed = False instance = find_instance(name) if not instance: module.exit_json(changed=False, action='delete') try: instance.delete() except Exception as e: module.fail_json(msg='%s' % e.message) else: changed = True if wait: pyrax.utils.wait_until(instance, 'status', 'SHUTDOWN', attempts=wait_timeout) if wait and instance.status != 'SHUTDOWN': module.fail_json(changed=changed, action='delete', cdb=rax_to_dict(instance), msg='Timeout waiting for "%s" databases instance to ' 'be deleted' % name) module.exit_json(changed=changed, action='delete', cdb=rax_to_dict(instance)) def rax_cdb(module, state, name, flavor, volume, cdb_type, cdb_version, wait, wait_timeout): # act on the state if state == 'present': save_instance(module, name, flavor, volume, cdb_type, cdb_version, wait, wait_timeout) elif state == 'absent': delete_instance(module, name, wait, wait_timeout) def main(): argument_spec = rax_argument_spec() argument_spec.update( dict( name=dict(type='str', required=True), flavor=dict(type='int', default=1), volume=dict(type='int', default=2), cdb_type=dict(type='str', default='MySQL', aliases=['type']), cdb_version=dict(type='str', default='5.6', aliases=['version']), state=dict(default='present', choices=['present', 'absent']), wait=dict(type='bool', default=False), wait_timeout=dict(type='int', default=300), ) ) module = AnsibleModule( argument_spec=argument_spec, required_together=rax_required_together(), ) if not HAS_PYRAX: module.fail_json(msg='pyrax is required for this module') name = module.params.get('name') flavor = module.params.get('flavor') volume = module.params.get('volume') cdb_type = module.params.get('cdb_type') cdb_version = module.params.get('cdb_version') state = module.params.get('state') wait = module.params.get('wait') wait_timeout = module.params.get('wait_timeout') setup_rax_module(module, pyrax) rax_cdb(module, state, name, flavor, volume, cdb_type, cdb_version, wait, wait_timeout) if __name__ == '__main__': main() PK $�!\�F? ? c collections/ansible_collections/community/general/plugins/modules/keycloak_authz_permission_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Eike Frost <ei@kefro.st> # Copyright (c) 2021, Christophe Gilles <christophe.gilles54@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or # https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: keycloak_authz_permission_info version_added: 7.2.0 short_description: Query Keycloak client authorization permissions information description: - This module allows querying information about Keycloak client authorization permissions from the resources endpoint via the Keycloak REST API. Authorization permissions are only available if a client has Authorization enabled. - This module requires access to the REST API via OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. - The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. U(https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/) options: name: description: - Name of the authorization permission to create. type: str required: true client_id: description: - The clientId of the keycloak client that should have the authorization scope. - This is usually a human-readable name of the Keycloak client. type: str required: true realm: description: - The name of the Keycloak realm the Keycloak client is in. type: str required: true extends_documentation_fragment: - community.general.keycloak - community.general.attributes - community.general.attributes.info_module author: - Samuli Seppänen (@mattock) ''' EXAMPLES = ''' - name: Query Keycloak authorization permission community.general.keycloak_authz_permission_info: name: ScopePermission client_id: myclient realm: myrealm auth_keycloak_url: http://localhost:8080/auth auth_username: keycloak auth_password: keycloak auth_realm: master ''' RETURN = ''' msg: description: Message as to what action was taken. returned: always type: str queried_state: description: State of the resource (a policy) as seen by Keycloak. returned: on success type: complex contains: id: description: ID of the authorization permission. type: str sample: 9da05cd2-b273-4354-bbd8-0c133918a454 name: description: Name of the authorization permission. type: str sample: ResourcePermission description: description: Description of the authorization permission. type: str sample: Resource Permission type: description: Type of the authorization permission. type: str sample: resource decisionStrategy: description: The decision strategy. type: str sample: UNANIMOUS logic: description: The logic used for the permission (part of the payload, but has a fixed value). type: str sample: POSITIVE config: description: Configuration of the permission (empty in all observed cases). type: dict sample: {} ''' from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, \ keycloak_argument_spec, get_token, KeycloakError from ansible.module_utils.basic import AnsibleModule def main(): """ Module execution :return: """ argument_spec = keycloak_argument_spec() meta_args = dict( name=dict(type='str', required=True), client_id=dict(type='str', required=True), realm=dict(type='str', required=True) ) argument_spec.update(meta_args) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, required_one_of=( [['token', 'auth_realm', 'auth_username', 'auth_password']]), required_together=([['auth_realm', 'auth_username', 'auth_password']])) # Convenience variables name = module.params.get('name') client_id = module.params.get('client_id') realm = module.params.get('realm') result = dict(changed=False, msg='', queried_state={}) # Obtain access token, initialize API try: connection_header = get_token(module.params) except KeycloakError as e: module.fail_json(msg=str(e)) kc = KeycloakAPI(module, connection_header) # Get id of the client based on client_id cid = kc.get_client_id(client_id, realm=realm) if not cid: module.fail_json(msg='Invalid client %s for realm %s' % (client_id, realm)) # Get current state of the permission using its name as the search # filter. This returns False if it is not found. permission = kc.get_authz_permission_by_name( name=name, client_id=cid, realm=realm) result['queried_state'] = permission module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�]�� � T collections/ansible_collections/community/general/plugins/modules/redis_data_incr.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Andreas Botzner <andreas at botzner dot com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: redis_data_incr short_description: Increment keys in Redis version_added: 4.0.0 description: - Increment integers or float keys in Redis database and get new value. - Default increment for all keys is 1. For specific increments use the O(increment_int) and O(increment_float) options. author: "Andreas Botzner (@paginabianca)" attributes: check_mode: support: partial details: - For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise the module will fail. - When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present, 0.0 is used as value. diff_mode: support: none options: key: description: - Database key. type: str required: true increment_int: description: - Integer amount to increment the key by. required: false type: int increment_float: description: - Float amount to increment the key by. - This only works with keys that contain float values in their string representation. type: float required: false extends_documentation_fragment: - community.general.redis.documentation - community.general.attributes seealso: - module: community.general.redis_data - module: community.general.redis_data_info - module: community.general.redis ''' EXAMPLES = ''' - name: Increment integer key foo on localhost with no username and print new value community.general.redis_data_incr: login_host: localhost login_password: supersecret key: foo increment_int: 1 register: result - name: Print new value debug: var: result.value - name: Increment float key foo by 20.4 community.general.redis_data_incr: login_host: redishost login_user: redisuser login_password: somepass key: foo increment_float: '20.4' ''' RETURN = ''' value: description: Incremented value of key returned: on success type: float sample: '4039.4' msg: description: A short message. returned: always type: str sample: 'Incremented key: foo by 20.4 to 65.9' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.redis import ( fail_imports, redis_auth_argument_spec, RedisAnsible) def main(): redis_auth_args = redis_auth_argument_spec() module_args = dict( key=dict(type='str', required=True, no_log=False), increment_int=dict(type='int', required=False), increment_float=dict(type='float', required=False), ) module_args.update(redis_auth_args) module = AnsibleModule( argument_spec=module_args, supports_check_mode=True, mutually_exclusive=[['increment_int', 'increment_float']], ) fail_imports(module) redis = RedisAnsible(module) key = module.params['key'] increment_float = module.params['increment_float'] increment_int = module.params['increment_int'] increment = 1 if increment_float is not None: increment = increment_float elif increment_int is not None: increment = increment_int result = {'changed': False} if module.check_mode: value = 0.0 try: res = redis.connection.get(key) if res is not None: value = float(res) except ValueError as e: msg = 'Value: {0} of key: {1} is not incrementable(int or float)'.format( res, key) result['msg'] = msg module.fail_json(**result) except Exception as e: msg = 'Failed to get value of key: {0} with exception: {1}'.format( key, str(e)) result['msg'] = msg module.fail_json(**result) msg = 'Incremented key: {0} by {1} to {2}'.format( key, increment, value + increment) result['msg'] = msg result['value'] = float(value + increment) module.exit_json(**result) if increment_float is not None: try: value = redis.connection.incrbyfloat(key, increment) msg = 'Incremented key: {0} by {1} to {2}'.format( key, increment, value) result['msg'] = msg result['value'] = float(value) result['changed'] = True module.exit_json(**result) except Exception as e: msg = 'Failed to increment key: {0} by {1} with exception: {2}'.format( key, increment, str(e)) result['msg'] = msg module.fail_json(**result) elif increment_int is not None: try: value = redis.connection.incrby(key, increment) msg = 'Incremented key: {0} by {1} to {2}'.format( key, increment, value) result['msg'] = msg result['value'] = float(value) result['changed'] = True module.exit_json(**result) except Exception as e: msg = 'Failed to increment key: {0} by {1} with exception: {2}'.format( key, increment, str(e)) result['msg'] = msg module.fail_json(**result) else: try: value = redis.connection.incr(key) msg = 'Incremented key: {0} to {1}'.format(key, value) result['msg'] = msg result['value'] = float(value) result['changed'] = True module.exit_json(**result) except Exception as e: msg = 'Failed to increment key: {0} with exception: {1}'.format( key, str(e)) result['msg'] = msg module.fail_json(**result) if __name__ == '__main__': main() PK $�!\�R� � I collections/ansible_collections/community/general/plugins/modules/ohai.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2012, Michael DeHaan <michael.dehaan@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ohai short_description: Returns inventory data from I(Ohai) description: - Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html)) on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: {} notes: [] requirements: [ "ohai" ] author: - "Ansible Core Team" - "Michael DeHaan (@mpdehaan)" ''' EXAMPLES = ''' # Retrieve (ohai) data from all Web servers and store in one-file per host ansible webservers -m ohai --tree=/tmp/ohaidata ''' import json from ansible.module_utils.basic import AnsibleModule def main(): module = AnsibleModule( argument_spec=dict() ) cmd = ["/usr/bin/env", "ohai"] rc, out, err = module.run_command(cmd, check_rc=True) module.exit_json(**json.loads(out)) if __name__ == '__main__': main() PK $�!\T-�� � L collections/ansible_collections/community/general/plugins/modules/selogin.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Petr Lautrbach <plautrba@redhat.com> # Based on seport.py module (c) 2014, Dan Keder <dan.keder@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: selogin short_description: Manages linux user to SELinux user mapping description: - Manages linux user to SELinux user mapping extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: login: type: str description: - a Linux user required: true seuser: type: str description: - SELinux user name selevel: type: str aliases: [ serange ] description: - MLS/MCS Security Range (MLS/MCS Systems only) SELinux Range for SELinux login mapping defaults to the SELinux user record range. default: s0 state: type: str description: - Desired mapping value. default: present choices: [ 'present', 'absent' ] reload: description: - Reload SELinux policy after commit. type: bool default: true ignore_selinux_state: description: - Run independent of selinux runtime state type: bool default: false notes: - The changes are persistent across reboots - Not tested on any debian based system requirements: [ 'libselinux', 'policycoreutils' ] author: - Dan Keder (@dankeder) - Petr Lautrbach (@bachradsusi) - James Cassell (@jamescassell) ''' EXAMPLES = ''' - name: Modify the default user on the system to the guest_u user community.general.selogin: login: __default__ seuser: guest_u state: present - name: Assign gijoe user on an MLS machine a range and to the staff_u user community.general.selogin: login: gijoe seuser: staff_u serange: SystemLow-Secret state: present - name: Assign all users in the engineering group to the staff_u user community.general.selogin: login: '%engineering' seuser: staff_u state: present ''' RETURN = r''' # Default return values ''' import traceback SELINUX_IMP_ERR = None try: import selinux HAVE_SELINUX = True except ImportError: SELINUX_IMP_ERR = traceback.format_exc() HAVE_SELINUX = False SEOBJECT_IMP_ERR = None try: import seobject HAVE_SEOBJECT = True except ImportError: SEOBJECT_IMP_ERR = traceback.format_exc() HAVE_SEOBJECT = False from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native def semanage_login_add(module, login, seuser, do_reload, serange='s0', sestore=''): """ Add linux user to SELinux user mapping :type module: AnsibleModule :param module: Ansible module :type login: str :param login: a Linux User or a Linux group if it begins with % :type seuser: str :param proto: An SELinux user ('__default__', 'unconfined_u', 'staff_u', ...), see 'semanage login -l' :type serange: str :param serange: SELinux MLS/MCS range (defaults to 's0') :type do_reload: bool :param do_reload: Whether to reload SELinux policy after commit :type sestore: str :param sestore: SELinux store :rtype: bool :return: True if the policy was changed, otherwise False """ try: selogin = seobject.loginRecords(sestore) selogin.set_reload(do_reload) change = False all_logins = selogin.get_all() # module.fail_json(msg="%s: %s %s" % (all_logins, login, sestore)) # for local_login in all_logins: if login not in all_logins.keys(): change = True if not module.check_mode: selogin.add(login, seuser, serange) else: if all_logins[login][0] != seuser or all_logins[login][1] != serange: change = True if not module.check_mode: selogin.modify(login, seuser, serange) except (ValueError, KeyError, OSError, RuntimeError) as e: module.fail_json(msg="%s: %s\n" % (e.__class__.__name__, to_native(e)), exception=traceback.format_exc()) return change def semanage_login_del(module, login, seuser, do_reload, sestore=''): """ Delete linux user to SELinux user mapping :type module: AnsibleModule :param module: Ansible module :type login: str :param login: a Linux User or a Linux group if it begins with % :type seuser: str :param proto: An SELinux user ('__default__', 'unconfined_u', 'staff_u', ...), see 'semanage login -l' :type do_reload: bool :param do_reload: Whether to reload SELinux policy after commit :type sestore: str :param sestore: SELinux store :rtype: bool :return: True if the policy was changed, otherwise False """ try: selogin = seobject.loginRecords(sestore) selogin.set_reload(do_reload) change = False all_logins = selogin.get_all() # module.fail_json(msg="%s: %s %s" % (all_logins, login, sestore)) if login in all_logins.keys(): change = True if not module.check_mode: selogin.delete(login) except (ValueError, KeyError, OSError, RuntimeError) as e: module.fail_json(msg="%s: %s\n" % (e.__class__.__name__, to_native(e)), exception=traceback.format_exc()) return change def get_runtime_status(ignore_selinux_state=False): return True if ignore_selinux_state is True else selinux.is_selinux_enabled() def main(): module = AnsibleModule( argument_spec=dict( ignore_selinux_state=dict(type='bool', default=False), login=dict(type='str', required=True), seuser=dict(type='str'), selevel=dict(type='str', aliases=['serange'], default='s0'), state=dict(type='str', default='present', choices=['absent', 'present']), reload=dict(type='bool', default=True), ), required_if=[ ["state", "present", ["seuser"]] ], supports_check_mode=True ) if not HAVE_SELINUX: module.fail_json(msg=missing_required_lib("libselinux"), exception=SELINUX_IMP_ERR) if not HAVE_SEOBJECT: module.fail_json(msg=missing_required_lib("seobject from policycoreutils"), exception=SEOBJECT_IMP_ERR) ignore_selinux_state = module.params['ignore_selinux_state'] if not get_runtime_status(ignore_selinux_state): module.fail_json(msg="SELinux is disabled on this host.") login = module.params['login'] seuser = module.params['seuser'] serange = module.params['selevel'] state = module.params['state'] do_reload = module.params['reload'] result = { 'login': login, 'seuser': seuser, 'serange': serange, 'state': state, } if state == 'present': result['changed'] = semanage_login_add(module, login, seuser, do_reload, serange) elif state == 'absent': result['changed'] = semanage_login_del(module, login, seuser, do_reload) else: module.fail_json(msg='Invalid value of argument "state": {0}'.format(state)) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\D�t�l l P collections/ansible_collections/community/general/plugins/modules/stackdriver.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' deprecated: removed_in: 9.0.0 why: the endpoints this module relies on do not exist any more and do not resolve to IPs in DNS. alternative: no known alternative at this point module: stackdriver short_description: Send code deploy and annotation events to stackdriver description: - Send code deploy and annotation events to Stackdriver author: "Ben Whaley (@bwhaley)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: key: type: str description: - API key. required: true event: type: str description: - The type of event to send, either annotation or deploy choices: ['annotation', 'deploy'] required: true revision_id: type: str description: - The revision of the code that was deployed. Required for deploy events deployed_by: type: str description: - The person or robot responsible for deploying the code default: "Ansible" deployed_to: type: str description: - "The environment code was deployed to. (ie: development, staging, production)" repository: type: str description: - The repository (or project) deployed msg: type: str description: - The contents of the annotation message, in plain text. Limited to 256 characters. Required for annotation. annotated_by: type: str description: - The person or robot who the annotation should be attributed to. default: "Ansible" level: type: str description: - one of INFO/WARN/ERROR, defaults to INFO if not supplied. May affect display. choices: ['INFO', 'WARN', 'ERROR'] default: 'INFO' instance_id: type: str description: - id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown event_epoch: type: str description: - "Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this." ''' EXAMPLES = ''' - name: Send a code deploy event to stackdriver community.general.stackdriver: key: AAAAAA event: deploy deployed_to: production deployed_by: leeroyjenkins repository: MyWebApp revision_id: abcd123 - name: Send an annotation event to stackdriver community.general.stackdriver: key: AAAAAA event: annotation msg: Greetings from Ansible annotated_by: leeroyjenkins level: WARN instance_id: i-abcd1234 ''' # =========================================== # Stackdriver module specific support methods. # import json import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.urls import fetch_url def send_deploy_event(module, key, revision_id, deployed_by='Ansible', deployed_to=None, repository=None): """Send a deploy event to Stackdriver""" deploy_api = "https://event-gateway.stackdriver.com/v1/deployevent" params = {} params['revision_id'] = revision_id params['deployed_by'] = deployed_by if deployed_to: params['deployed_to'] = deployed_to if repository: params['repository'] = repository return do_send_request(module, deploy_api, params, key) def send_annotation_event(module, key, msg, annotated_by='Ansible', level=None, instance_id=None, event_epoch=None): """Send an annotation event to Stackdriver""" annotation_api = "https://event-gateway.stackdriver.com/v1/annotationevent" params = {} params['message'] = msg if annotated_by: params['annotated_by'] = annotated_by if level: params['level'] = level if instance_id: params['instance_id'] = instance_id if event_epoch: params['event_epoch'] = event_epoch return do_send_request(module, annotation_api, params, key) def do_send_request(module, url, params, key): data = json.dumps(params) headers = { 'Content-Type': 'application/json', 'x-stackdriver-apikey': key } response, info = fetch_url(module, url, headers=headers, data=data, method='POST') if info['status'] != 200: module.fail_json(msg="Unable to send msg: %s" % info['msg']) # =========================================== # Module execution. # def main(): module = AnsibleModule( argument_spec=dict( # @TODO add types key=dict(required=True, no_log=True), event=dict(required=True, choices=['deploy', 'annotation']), msg=dict(), revision_id=dict(), annotated_by=dict(default='Ansible'), level=dict(default='INFO', choices=['INFO', 'WARN', 'ERROR']), instance_id=dict(), event_epoch=dict(), # @TODO int? deployed_by=dict(default='Ansible'), deployed_to=dict(), repository=dict(), ), supports_check_mode=True ) key = module.params["key"] event = module.params["event"] # Annotation params msg = module.params["msg"] annotated_by = module.params["annotated_by"] level = module.params["level"] instance_id = module.params["instance_id"] event_epoch = module.params["event_epoch"] # Deploy params revision_id = module.params["revision_id"] deployed_by = module.params["deployed_by"] deployed_to = module.params["deployed_to"] repository = module.params["repository"] ################################################################## # deploy requires revision_id # annotation requires msg # We verify these manually ################################################################## if event == 'deploy': if not revision_id: module.fail_json(msg="revision_id required for deploy events") try: send_deploy_event(module, key, revision_id, deployed_by, deployed_to, repository) except Exception as e: module.fail_json(msg="unable to sent deploy event: %s" % to_native(e), exception=traceback.format_exc()) if event == 'annotation': if not msg: module.fail_json(msg="msg required for annotation events") try: send_annotation_event(module, key, msg, annotated_by, level, instance_id, event_epoch) except Exception as e: module.fail_json(msg="unable to sent annotation event: %s" % to_native(e), exception=traceback.format_exc()) changed = True module.exit_json(changed=changed, deployed_by=deployed_by) if __name__ == '__main__': main() PK $�!\3��{�M �M J collections/ansible_collections/community/general/plugins/modules/slack.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Lee Goolsbee <lgoolsbee@atlassian.com> # Copyright (c) 2020, Michal Middleton <mm.404@icloud.com> # Copyright (c) 2017, Steve Pletcher <steve@steve-pletcher.com> # Copyright (c) 2016, René Moser <mail@renemoser.net> # Copyright (c) 2015, Stefan Berggren <nsg@nsg.cc> # Copyright (c) 2014, Ramon de la Fuente <ramon@delafuente.nl> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ module: slack short_description: Send Slack notifications description: - The M(community.general.slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration author: "Ramon de la Fuente (@ramondelafuente)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: domain: type: str description: - Slack (sub)domain for your environment without protocol. (For example V(example.slack.com).) In Ansible 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information. token: type: str description: - Slack integration token. This authenticates you to the slack service. Make sure to use the correct type of token, depending on what method you use. - "Webhook token: Prior to Ansible 1.8, a token looked like V(3Ffe373sfhRE6y42Fg3rvf4GlK). In Ansible 1.8 and above, Ansible adapts to the new slack API where tokens look like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack does that the old format will stop working. ** Please keep in mind the tokens are not the API tokens but are the webhook tokens. In slack these are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks can be added in that area. In some cases this may be locked by your Slack admin and you must request access. It is there that the incoming webhooks can be added. The key is on the end of the URL given to you in that section." - "WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-), V(xoxb-) or V(xoxa-), for example V(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive thread_id. See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information." required: true msg: type: str description: - Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands should be converted to HTML entities (e.g. & to &) before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more. channel: type: str description: - Channel to send the message to. If absent, the message goes to the channel selected for the O(token). thread_id: description: - Optional. Timestamp of parent message to thread this message. https://api.slack.com/docs/message-threading type: str message_id: description: - Optional. Message ID to edit, instead of posting a new message. - If supplied O(channel) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel_id }}) to get RV(ignore:channel_id) from previous task run. - Corresponds to C(ts) in the Slack API (U(https://api.slack.com/messaging/modifying)). type: str version_added: 1.2.0 username: type: str description: - This is the sender of the message. default: "Ansible" icon_url: type: str description: - URL for the message sender's icon. default: https://docs.ansible.com/favicon.ico icon_emoji: type: str description: - Emoji for the message sender. See Slack documentation for options. - If O(icon_emoji) is set, O(icon_url) will not be used. link_names: type: int description: - Automatically create links for channels and usernames in O(msg). default: 1 choices: - 1 - 0 parse: type: str description: - Setting for the message parser at Slack choices: - 'full' - 'none' validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true color: type: str description: - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message. - Allowed values for color can be one of 'normal', 'good', 'warning', 'danger', any valid 3 digit or 6 digit hex color value. - Specifying value in hex is supported since Ansible 2.8. default: 'normal' attachments: type: list elements: dict description: - Define a list of attachments. This list mirrors the Slack JSON API. - For more information, see U(https://api.slack.com/docs/attachments). blocks: description: - Define a list of blocks. This list mirrors the Slack JSON API. - For more information, see U(https://api.slack.com/block-kit). type: list elements: dict version_added: 1.0.0 prepend_hash: type: str description: - Setting for automatically prepending a V(#) symbol on the passed in O(channel). - The V(auto) method prepends a V(#) unless O(channel) starts with one of V(#), V(@), V(C0), V(GF), V(G0), V(CP). These prefixes only cover a small set of the prefixes that should not have a V(#) prepended. Since an exact condition which O(channel) values must not have the V(#) prefix is not known, the value V(auto) for this option will be deprecated in the future. It is best to explicitly set O(prepend_hash=always) or O(prepend_hash=never) to obtain the needed behavior. choices: - 'always' - 'never' - 'auto' default: 'auto' version_added: 6.1.0 """ EXAMPLES = """ - name: Send notification message via Slack community.general.slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} completed' delegate_to: localhost - name: Send notification message via Slack all options community.general.slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} completed' channel: '#ansible' thread_id: '1539917263.000100' username: 'Ansible on {{ inventory_hostname }}' icon_url: http://www.example.com/some-image-file.png link_names: 0 parse: 'none' delegate_to: localhost - name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in Slack community.general.slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} is alive!' color: good username: '' icon_url: '' - name: Insert a color bar in front of the message with valid hex color value community.general.slack: token: thetoken/generatedby/slack msg: 'This message uses color in hex value' color: '#00aacc' username: '' icon_url: '' - name: Use the attachments API community.general.slack: token: thetoken/generatedby/slack attachments: - text: Display my system load on host A and B color: '#ff00dd' title: System load fields: - title: System A value: "load average: 0,74, 0,66, 0,63" short: true - title: System B value: 'load average: 5,16, 4,64, 2,43' short: true - name: Use the blocks API community.general.slack: token: thetoken/generatedby/slack blocks: - type: section text: type: mrkdwn text: |- *System load* Display my system load on host A and B - type: context elements: - type: mrkdwn text: |- *System A* load average: 0,74, 0,66, 0,63 - type: mrkdwn text: |- *System B* load average: 5,16, 4,64, 2,43 - name: Send a message with a link using Slack markup community.general.slack: token: thetoken/generatedby/slack msg: We sent this message using <https://www.ansible.com|Ansible>! - name: Send a message with angle brackets and ampersands community.general.slack: token: thetoken/generatedby/slack msg: This message has <brackets> & ampersands in plain text. - name: Initial Threaded Slack message community.general.slack: channel: '#ansible' token: xoxb-1234-56789abcdefghijklmnop msg: 'Starting a thread with my initial post.' register: slack_response - name: Add more info to thread community.general.slack: channel: '#ansible' token: xoxb-1234-56789abcdefghijklmnop thread_id: "{{ slack_response['ts'] }}" color: good msg: 'And this is my threaded response!' - name: Send a message to be edited later on community.general.slack: token: thetoken/generatedby/slack channel: '#ansible' msg: Deploying something... register: slack_response - name: Edit message community.general.slack: token: thetoken/generatedby/slack # The 'channel' option does not accept the channel name. It must use the 'channel_id', # which can be retrieved for example from 'slack_response' from the previous task. channel: "{{ slack_response.channel }}" msg: Deployment complete! message_id: "{{ slack_response.ts }}" """ import re from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.urls import fetch_url OLD_SLACK_INCOMING_WEBHOOK = 'https://%s/services/hooks/incoming-webhook?token=%s' SLACK_INCOMING_WEBHOOK = 'https://hooks.slack.com/services/%s' SLACK_POSTMESSAGE_WEBAPI = 'https://slack.com/api/chat.postMessage' SLACK_UPDATEMESSAGE_WEBAPI = 'https://slack.com/api/chat.update' SLACK_CONVERSATIONS_HISTORY_WEBAPI = 'https://slack.com/api/conversations.history' # Escaping quotes and apostrophes to avoid ending string prematurely in ansible call. # We do not escape other characters used as Slack metacharacters (e.g. &, <, >). escape_table = { '"': "\"", "'": "\'", } def is_valid_hex_color(color_choice): if re.match(r'^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$', color_choice): return True return False def escape_quotes(text): """Backslash any quotes within text.""" return "".join(escape_table.get(c, c) for c in text) def recursive_escape_quotes(obj, keys): """Recursively escape quotes inside supplied keys inside block kit objects""" if isinstance(obj, dict): escaped = {} for k, v in obj.items(): if isinstance(v, str) and k in keys: escaped[k] = escape_quotes(v) else: escaped[k] = recursive_escape_quotes(v, keys) elif isinstance(obj, list): escaped = [recursive_escape_quotes(v, keys) for v in obj] else: escaped = obj return escaped def build_payload_for_slack(text, channel, thread_id, username, icon_url, icon_emoji, link_names, parse, color, attachments, blocks, message_id, prepend_hash): payload = {} if color == "normal" and text is not None: payload = dict(text=escape_quotes(text)) elif text is not None: # With a custom color we have to set the message as attachment, and explicitly turn markdown parsing on for it. payload = dict(attachments=[dict(text=escape_quotes(text), color=color, mrkdwn_in=["text"])]) if channel is not None: if prepend_hash == 'auto': if channel.startswith(('#', '@', 'C0', 'GF', 'G0', 'CP')): payload['channel'] = channel else: payload['channel'] = '#' + channel elif prepend_hash == 'always': payload['channel'] = '#' + channel elif prepend_hash == 'never': payload['channel'] = channel if thread_id is not None: payload['thread_ts'] = thread_id if username is not None: payload['username'] = username if icon_emoji is not None: payload['icon_emoji'] = icon_emoji else: payload['icon_url'] = icon_url if link_names is not None: payload['link_names'] = link_names if parse is not None: payload['parse'] = parse if message_id is not None: payload['ts'] = message_id if attachments is not None: if 'attachments' not in payload: payload['attachments'] = [] if attachments is not None: attachment_keys_to_escape = [ 'title', 'text', 'author_name', 'pretext', 'fallback', ] for attachment in attachments: for key in attachment_keys_to_escape: if key in attachment: attachment[key] = escape_quotes(attachment[key]) if 'fallback' not in attachment: attachment['fallback'] = attachment['text'] payload['attachments'].append(attachment) if blocks is not None: block_keys_to_escape = [ 'text', 'alt_text' ] payload['blocks'] = recursive_escape_quotes(blocks, block_keys_to_escape) return payload def get_slack_message(module, token, channel, ts): headers = { 'Content-Type': 'application/json; charset=UTF-8', 'Accept': 'application/json', 'Authorization': 'Bearer ' + token } qs = urlencode({ 'channel': channel, 'ts': ts, 'limit': 1, 'inclusive': 'true', }) url = SLACK_CONVERSATIONS_HISTORY_WEBAPI + '?' + qs response, info = fetch_url(module=module, url=url, headers=headers, method='GET') if info['status'] != 200: module.fail_json(msg="failed to get slack message") data = module.from_json(response.read()) if len(data['messages']) < 1: module.fail_json(msg="no messages matching ts: %s" % ts) if len(data['messages']) > 1: module.fail_json(msg="more than 1 message matching ts: %s" % ts) return data['messages'][0] def do_notify_slack(module, domain, token, payload): use_webapi = False if token.count('/') >= 2: # New style webhook token slack_uri = SLACK_INCOMING_WEBHOOK % token elif re.match(r'^xox[abp]-\S+$', token): slack_uri = SLACK_UPDATEMESSAGE_WEBAPI if 'ts' in payload else SLACK_POSTMESSAGE_WEBAPI use_webapi = True else: if not domain: module.fail_json(msg="Slack has updated its webhook API. You need to specify a token of the form " "XXXX/YYYY/ZZZZ in your playbook") slack_uri = OLD_SLACK_INCOMING_WEBHOOK % (domain, token) headers = { 'Content-Type': 'application/json; charset=UTF-8', 'Accept': 'application/json', } if use_webapi: headers['Authorization'] = 'Bearer ' + token data = module.jsonify(payload) response, info = fetch_url(module=module, url=slack_uri, headers=headers, method='POST', data=data) if info['status'] != 200: if use_webapi: obscured_incoming_webhook = slack_uri else: obscured_incoming_webhook = SLACK_INCOMING_WEBHOOK % '[obscured]' module.fail_json(msg=" failed to send %s to %s: %s" % (data, obscured_incoming_webhook, info['msg'])) # each API requires different handling if use_webapi: return module.from_json(response.read()) else: return {'webhook': 'ok'} def main(): module = AnsibleModule( argument_spec=dict( domain=dict(type='str'), token=dict(type='str', required=True, no_log=True), msg=dict(type='str'), channel=dict(type='str'), thread_id=dict(type='str'), username=dict(type='str', default='Ansible'), icon_url=dict(type='str', default='https://docs.ansible.com/favicon.ico'), icon_emoji=dict(type='str'), link_names=dict(type='int', default=1, choices=[0, 1]), parse=dict(type='str', choices=['none', 'full']), validate_certs=dict(default=True, type='bool'), color=dict(type='str', default='normal'), attachments=dict(type='list', elements='dict'), blocks=dict(type='list', elements='dict'), message_id=dict(type='str'), prepend_hash=dict(type='str', default='auto', choices=['always', 'never', 'auto']), ), supports_check_mode=True, ) domain = module.params['domain'] token = module.params['token'] text = module.params['msg'] channel = module.params['channel'] thread_id = module.params['thread_id'] username = module.params['username'] icon_url = module.params['icon_url'] icon_emoji = module.params['icon_emoji'] link_names = module.params['link_names'] parse = module.params['parse'] color = module.params['color'] attachments = module.params['attachments'] blocks = module.params['blocks'] message_id = module.params['message_id'] prepend_hash = module.params['prepend_hash'] color_choices = ['normal', 'good', 'warning', 'danger'] if color not in color_choices and not is_valid_hex_color(color): module.fail_json(msg="Color value specified should be either one of %r " "or any valid hex value with length 3 or 6." % color_choices) changed = True # if updating an existing message, we can check if there's anything to update if message_id is not None: changed = False msg = get_slack_message(module, token, channel, message_id) for key in ('icon_url', 'icon_emoji', 'link_names', 'color', 'attachments', 'blocks'): if msg.get(key) != module.params.get(key): changed = True break # if check mode is active, we shouldn't do anything regardless. # if changed=False, we don't need to do anything, so don't do it. if module.check_mode or not changed: module.exit_json(changed=changed, ts=msg['ts'], channel=msg['channel']) elif module.check_mode: module.exit_json(changed=changed) payload = build_payload_for_slack(text, channel, thread_id, username, icon_url, icon_emoji, link_names, parse, color, attachments, blocks, message_id, prepend_hash) slack_response = do_notify_slack(module, domain, token, payload) if 'ok' in slack_response: # Evaluate WebAPI response if slack_response['ok']: # return payload as a string for backwards compatibility payload_json = module.jsonify(payload) module.exit_json(changed=changed, ts=slack_response['ts'], channel=slack_response['channel'], api=slack_response, payload=payload_json) else: module.fail_json(msg="Slack API error", error=slack_response['error']) else: # Exit with plain OK from WebHook, since we don't have more information # If we get 200 from webhook, the only answer is OK module.exit_json(msg="OK") if __name__ == '__main__': main() PK $�!\V�� � L collections/ansible_collections/community/general/plugins/modules/pingdom.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: pingdom short_description: Pause/unpause Pingdom alerts description: - This module will let you pause/unpause Pingdom alerts author: - "Dylan Silva (@thaumos)" - "Justin Johns (!UNKNOWN)" requirements: - "This pingdom python library: https://github.com/mbabineau/pingdom-python" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: state: type: str description: - Define whether or not the check should be running or paused. required: true choices: [ "running", "paused", "started", "stopped" ] checkid: type: str description: - Pingdom ID of the check. required: true uid: type: str description: - Pingdom user ID. required: true passwd: type: str description: - Pingdom user password. required: true key: type: str description: - Pingdom API key. required: true notes: - This module does not yet have support to add/remove checks. ''' EXAMPLES = ''' - name: Pause the check with the ID of 12345 community.general.pingdom: uid: example@example.com passwd: password123 key: apipassword123 checkid: 12345 state: paused - name: Unpause the check with the ID of 12345 community.general.pingdom: uid: example@example.com passwd: password123 key: apipassword123 checkid: 12345 state: running ''' import traceback PINGDOM_IMP_ERR = None try: import pingdom HAS_PINGDOM = True except Exception: PINGDOM_IMP_ERR = traceback.format_exc() HAS_PINGDOM = False from ansible.module_utils.basic import AnsibleModule, missing_required_lib def pause(checkid, uid, passwd, key): c = pingdom.PingdomConnection(uid, passwd, key) c.modify_check(checkid, paused=True) check = c.get_check(checkid) name = check.name result = check.status # if result != "paused": # api output buggy - accept raw exception for now # return (True, name, result) return (False, name, result) def unpause(checkid, uid, passwd, key): c = pingdom.PingdomConnection(uid, passwd, key) c.modify_check(checkid, paused=False) check = c.get_check(checkid) name = check.name result = check.status # if result != "up": # api output buggy - accept raw exception for now # return (True, name, result) return (False, name, result) def main(): module = AnsibleModule( argument_spec=dict( state=dict(required=True, choices=['running', 'paused', 'started', 'stopped']), checkid=dict(required=True), uid=dict(required=True), passwd=dict(required=True, no_log=True), key=dict(required=True, no_log=True), ) ) if not HAS_PINGDOM: module.fail_json(msg=missing_required_lib("pingdom"), exception=PINGDOM_IMP_ERR) checkid = module.params['checkid'] state = module.params['state'] uid = module.params['uid'] passwd = module.params['passwd'] key = module.params['key'] if (state == "paused" or state == "stopped"): (rc, name, result) = pause(checkid, uid, passwd, key) if (state == "running" or state == "started"): (rc, name, result) = unpause(checkid, uid, passwd, key) if rc != 0: module.fail_json(checkid=checkid, name=name, status=result) module.exit_json(checkid=checkid, name=name, status=result) if __name__ == '__main__': main() PK $�!\N݊�O �O N collections/ansible_collections/community/general/plugins/modules/java_cert.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, RSD Services S.A # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: java_cert short_description: Uses keytool to import/remove certificate to/from java keystore (cacerts) description: - This is a wrapper module around keytool, which can be used to import certificates and optionally private keys to a given java keystore, or remove them from it. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: cert_url: description: - Basic URL to fetch SSL certificate from. - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate. type: str cert_port: description: - Port to connect to URL. - This will be used to create server URL:PORT. type: int default: 443 cert_path: description: - Local path to load certificate from. - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate. type: path cert_alias: description: - Imported certificate alias. - The alias is used when checking for the presence of a certificate in the keystore. type: str trust_cacert: description: - Trust imported cert as CAcert. type: bool default: false version_added: '0.2.0' pkcs12_path: description: - Local path to load PKCS12 keystore from. - Unlike O(cert_url) and O(cert_path), the PKCS12 keystore embeds the private key matching the certificate, and is used to import both the certificate and its private key into the java keystore. - Exactly one of O(cert_url), O(cert_path), or O(pkcs12_path) is required to load certificate. type: path pkcs12_password: description: - Password for importing from PKCS12 keystore. type: str pkcs12_alias: description: - Alias in the PKCS12 keystore. type: str keystore_path: description: - Path to keystore. type: path keystore_pass: description: - Keystore password. type: str required: true keystore_create: description: - Create keystore if it does not exist. type: bool default: false keystore_type: description: - Keystore type (JCEKS, JKS). type: str executable: description: - Path to keytool binary if not used we search in PATH for it. type: str default: keytool state: description: - Defines action which can be either certificate import or removal. - When state is present, the certificate will always idempotently be inserted into the keystore, even if there already exists a cert alias that is different. type: str choices: [ absent, present ] default: present requirements: [openssl, keytool] author: - Adam Hamsik (@haad) ''' EXAMPLES = r''' - name: Import SSL certificate from google.com to a given cacerts keystore community.general.java_cert: cert_url: google.com cert_port: 443 keystore_path: /usr/lib/jvm/jre7/lib/security/cacerts keystore_pass: changeit state: present - name: Remove certificate with given alias from a keystore community.general.java_cert: cert_url: google.com keystore_path: /usr/lib/jvm/jre7/lib/security/cacerts keystore_pass: changeit executable: /usr/lib/jvm/jre7/bin/keytool state: absent - name: Import trusted CA from SSL certificate community.general.java_cert: cert_path: /opt/certs/rootca.crt keystore_path: /tmp/cacerts keystore_pass: changeit keystore_create: true state: present cert_alias: LE_RootCA trust_cacert: true - name: Import SSL certificate from google.com to a keystore, create it if it doesn't exist community.general.java_cert: cert_url: google.com keystore_path: /tmp/cacerts keystore_pass: changeit keystore_create: true state: present - name: Import a pkcs12 keystore with a specified alias, create it if it doesn't exist community.general.java_cert: pkcs12_path: "/tmp/importkeystore.p12" cert_alias: default keystore_path: /opt/wildfly/standalone/configuration/defaultkeystore.jks keystore_pass: changeit keystore_create: true state: present - name: Import SSL certificate to JCEKS keystore community.general.java_cert: pkcs12_path: "/tmp/importkeystore.p12" pkcs12_alias: default pkcs12_password: somepass cert_alias: default keystore_path: /opt/someapp/security/keystore.jceks keystore_type: "JCEKS" keystore_pass: changeit keystore_create: true state: present ''' RETURN = r''' msg: description: Output from stdout of keytool command after execution of given command. returned: success type: str sample: "Module require existing keystore at keystore_path '/tmp/test/cacerts'" rc: description: Keytool command execution return value. returned: success type: int sample: "0" cmd: description: Executed command to get action done. returned: success type: str sample: "keytool -importcert -noprompt -keystore" ''' import os import tempfile import re # import module snippets from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlparse from ansible.module_utils.six.moves.urllib.request import getproxies def _get_keystore_type_keytool_parameters(keystore_type): ''' Check that custom keystore is presented in parameters ''' if keystore_type: return ["-storetype", keystore_type] return [] def _check_cert_present(module, executable, keystore_path, keystore_pass, alias, keystore_type): ''' Check if certificate with alias is present in keystore located at keystore_path ''' test_cmd = [ executable, "-list", "-keystore", keystore_path, "-alias", alias, "-rfc" ] test_cmd += _get_keystore_type_keytool_parameters(keystore_type) (check_rc, stdout, dummy) = module.run_command(test_cmd, data=keystore_pass, check_rc=False) if check_rc == 0: return (True, stdout) return (False, '') def _get_certificate_from_url(module, executable, url, port, pem_certificate_output): remote_cert_pem_chain = _download_cert_url(module, executable, url, port) with open(pem_certificate_output, 'w') as f: f.write(remote_cert_pem_chain) def _get_first_certificate_from_x509_file(module, pem_certificate_file, pem_certificate_output, openssl_bin): """ Read a X509 certificate chain file and output the first certificate in the list """ extract_cmd = [ openssl_bin, "x509", "-in", pem_certificate_file, "-out", pem_certificate_output ] (extract_rc, dummy, extract_stderr) = module.run_command(extract_cmd, check_rc=False) if extract_rc != 0: # trying der encoded file extract_cmd += ["-inform", "der"] (extract_rc, dummy, extract_stderr) = module.run_command(extract_cmd, check_rc=False) if extract_rc != 0: # this time it's a real failure module.fail_json(msg="Internal module failure, cannot extract certificate, error: %s" % extract_stderr, rc=extract_rc, cmd=extract_cmd) return extract_rc def _get_digest_from_x509_file(module, pem_certificate_file, openssl_bin): """ Read a X509 certificate file and output sha256 digest using openssl """ # cleanup file before to compare (dummy, tmp_certificate) = tempfile.mkstemp() module.add_cleanup_file(tmp_certificate) _get_first_certificate_from_x509_file(module, pem_certificate_file, tmp_certificate, openssl_bin) dgst_cmd = [ openssl_bin, "dgst", "-r", "-sha256", tmp_certificate ] (dgst_rc, dgst_stdout, dgst_stderr) = module.run_command(dgst_cmd, check_rc=False) if dgst_rc != 0: module.fail_json(msg="Internal module failure, cannot compute digest for certificate, error: %s" % dgst_stderr, rc=dgst_rc, cmd=dgst_cmd) return dgst_stdout.split(' ')[0] def _export_public_cert_from_pkcs12(module, executable, pkcs_file, alias, password, dest): """ Runs keytools to extract the public cert from a PKCS12 archive and write it to a file. """ export_cmd = [ executable, "-list", "-noprompt", "-keystore", pkcs_file, "-alias", alias, "-storetype", "pkcs12", "-rfc" ] (export_rc, export_stdout, export_err) = module.run_command(export_cmd, data=password, check_rc=False) if export_rc != 0: module.fail_json(msg="Internal module failure, cannot extract public certificate from PKCS12, message: %s" % export_stdout, stderr=export_err, rc=export_rc) with open(dest, 'w') as f: f.write(export_stdout) def get_proxy_settings(scheme='https'): """ Returns a tuple containing (proxy_host, proxy_port). (False, False) if no proxy is found """ proxy_url = getproxies().get(scheme, '') if not proxy_url: return (False, False) else: parsed_url = urlparse(proxy_url) if parsed_url.scheme: (proxy_host, proxy_port) = parsed_url.netloc.split(':') else: (proxy_host, proxy_port) = parsed_url.path.split(':') return (proxy_host, proxy_port) def build_proxy_options(): """ Returns list of valid proxy options for keytool """ (proxy_host, proxy_port) = get_proxy_settings() no_proxy = os.getenv("no_proxy") proxy_opts = [] if proxy_host: proxy_opts.extend(["-J-Dhttps.proxyHost=%s" % proxy_host, "-J-Dhttps.proxyPort=%s" % proxy_port]) if no_proxy is not None: # For Java's nonProxyHosts property, items are separated by '|', # and patterns have to start with "*". non_proxy_hosts = no_proxy.replace(',', '|') non_proxy_hosts = re.sub(r'(^|\|)\.', r'\1*.', non_proxy_hosts) # The property name is http.nonProxyHosts, there is no # separate setting for HTTPS. proxy_opts.extend(["-J-Dhttp.nonProxyHosts=%s" % non_proxy_hosts]) return proxy_opts def _download_cert_url(module, executable, url, port): """ Fetches the certificate from the remote URL using `keytool -printcert...` The PEM formatted string is returned """ proxy_opts = build_proxy_options() fetch_cmd = [executable, "-printcert", "-rfc", "-sslserver"] + proxy_opts + ["%s:%d" % (url, port)] # Fetch SSL certificate from remote host. (fetch_rc, fetch_out, fetch_err) = module.run_command(fetch_cmd, check_rc=False) if fetch_rc != 0: module.fail_json(msg="Internal module failure, cannot download certificate, error: %s" % fetch_err, rc=fetch_rc, cmd=fetch_cmd) return fetch_out def import_pkcs12_path(module, executable, pkcs12_path, pkcs12_pass, pkcs12_alias, keystore_path, keystore_pass, keystore_alias, keystore_type): ''' Import pkcs12 from path into keystore located on keystore_path as alias ''' import_cmd = [ executable, "-importkeystore", "-noprompt", "-srcstoretype", "pkcs12", "-srckeystore", pkcs12_path, "-srcalias", pkcs12_alias, "-destkeystore", keystore_path, "-destalias", keystore_alias ] import_cmd += _get_keystore_type_keytool_parameters(keystore_type) secret_data = "%s\n%s" % (keystore_pass, pkcs12_pass) # Password of a new keystore must be entered twice, for confirmation if not os.path.exists(keystore_path): secret_data = "%s\n%s" % (keystore_pass, secret_data) # Use local certificate from local path and import it to a java keystore (import_rc, import_out, import_err) = module.run_command(import_cmd, data=secret_data, check_rc=False) diff = {'before': '\n', 'after': '%s\n' % keystore_alias} if import_rc == 0 and os.path.exists(keystore_path): module.exit_json(changed=True, msg=import_out, rc=import_rc, cmd=import_cmd, stdout=import_out, error=import_err, diff=diff) else: module.fail_json(msg=import_out, rc=import_rc, cmd=import_cmd, error=import_err) def import_cert_path(module, executable, path, keystore_path, keystore_pass, alias, keystore_type, trust_cacert): ''' Import certificate from path into keystore located on keystore_path as alias ''' import_cmd = [ executable, "-importcert", "-noprompt", "-keystore", keystore_path, "-file", path, "-alias", alias ] import_cmd += _get_keystore_type_keytool_parameters(keystore_type) if trust_cacert: import_cmd.extend(["-trustcacerts"]) # Use local certificate from local path and import it to a java keystore (import_rc, import_out, import_err) = module.run_command(import_cmd, data="%s\n%s" % (keystore_pass, keystore_pass), check_rc=False) diff = {'before': '\n', 'after': '%s\n' % alias} if import_rc == 0: module.exit_json(changed=True, msg=import_out, rc=import_rc, cmd=import_cmd, stdout=import_out, error=import_err, diff=diff) else: module.fail_json(msg=import_out, rc=import_rc, cmd=import_cmd) def delete_cert(module, executable, keystore_path, keystore_pass, alias, keystore_type, exit_after=True): ''' Delete certificate identified with alias from keystore on keystore_path ''' del_cmd = [ executable, "-delete", "-noprompt", "-keystore", keystore_path, "-alias", alias ] del_cmd += _get_keystore_type_keytool_parameters(keystore_type) # Delete SSL certificate from keystore (del_rc, del_out, del_err) = module.run_command(del_cmd, data=keystore_pass, check_rc=True) if exit_after: diff = {'before': '%s\n' % alias, 'after': None} module.exit_json(changed=True, msg=del_out, rc=del_rc, cmd=del_cmd, stdout=del_out, error=del_err, diff=diff) def test_keytool(module, executable): ''' Test if keytool is actually executable or not ''' module.run_command([executable], check_rc=True) def test_keystore(module, keystore_path): ''' Check if we can access keystore as file or not ''' if keystore_path is None: keystore_path = '' if not os.path.exists(keystore_path) and not os.path.isfile(keystore_path): # Keystore doesn't exist we want to create it module.fail_json(changed=False, msg="Module require existing keystore at keystore_path '%s'" % keystore_path) def main(): argument_spec = dict( cert_url=dict(type='str'), cert_path=dict(type='path'), pkcs12_path=dict(type='path'), pkcs12_password=dict(type='str', no_log=True), pkcs12_alias=dict(type='str'), cert_alias=dict(type='str'), cert_port=dict(type='int', default=443), keystore_path=dict(type='path'), keystore_pass=dict(type='str', required=True, no_log=True), trust_cacert=dict(type='bool', default=False), keystore_create=dict(type='bool', default=False), keystore_type=dict(type='str'), executable=dict(type='str', default='keytool'), state=dict(type='str', default='present', choices=['absent', 'present']), ) module = AnsibleModule( argument_spec=argument_spec, required_if=[['state', 'present', ('cert_path', 'cert_url', 'pkcs12_path'), True], ['state', 'absent', ('cert_url', 'cert_alias'), True]], required_together=[['keystore_path', 'keystore_pass']], mutually_exclusive=[ ['cert_url', 'cert_path', 'pkcs12_path'] ], supports_check_mode=True, ) url = module.params.get('cert_url') path = module.params.get('cert_path') port = module.params.get('cert_port') pkcs12_path = module.params.get('pkcs12_path') pkcs12_pass = module.params.get('pkcs12_password', '') pkcs12_alias = module.params.get('pkcs12_alias', '1') cert_alias = module.params.get('cert_alias') or url trust_cacert = module.params.get('trust_cacert') keystore_path = module.params.get('keystore_path') keystore_pass = module.params.get('keystore_pass') keystore_create = module.params.get('keystore_create') keystore_type = module.params.get('keystore_type') executable = module.params.get('executable') state = module.params.get('state') # openssl dependency resolution openssl_bin = module.get_bin_path('openssl', True) if path and not cert_alias: module.fail_json(changed=False, msg="Using local path import from %s requires alias argument." % keystore_path) test_keytool(module, executable) if not keystore_create: test_keystore(module, keystore_path) alias_exists, alias_exists_output = _check_cert_present( module, executable, keystore_path, keystore_pass, cert_alias, keystore_type) (dummy, new_certificate) = tempfile.mkstemp() (dummy, old_certificate) = tempfile.mkstemp() module.add_cleanup_file(new_certificate) module.add_cleanup_file(old_certificate) if state == 'absent' and alias_exists: if module.check_mode: module.exit_json(changed=True) # delete and exit delete_cert(module, executable, keystore_path, keystore_pass, cert_alias, keystore_type) # dump certificate to enroll in the keystore on disk and compute digest if state == 'present': # The alias exists in the keystore so we must now compare the SHA256 hash of the # public certificate already in the keystore, and the certificate we are wanting to add if alias_exists: with open(old_certificate, "w") as f: f.write(alias_exists_output) keystore_cert_digest = _get_digest_from_x509_file(module, old_certificate, openssl_bin) else: keystore_cert_digest = '' if pkcs12_path: # Extracting certificate with openssl _export_public_cert_from_pkcs12(module, executable, pkcs12_path, pkcs12_alias, pkcs12_pass, new_certificate) elif path: # Extracting the X509 digest is a bit easier. Keytool will print the PEM # certificate to stdout so we don't need to do any transformations. new_certificate = path elif url: # Getting the X509 digest from a URL is the same as from a path, we just have # to download the cert first _get_certificate_from_url(module, executable, url, port, new_certificate) new_cert_digest = _get_digest_from_x509_file(module, new_certificate, openssl_bin) if keystore_cert_digest != new_cert_digest: if module.check_mode: module.exit_json(changed=True) if alias_exists: # The certificate in the keystore does not match with the one we want to be present # The existing certificate must first be deleted before we insert the correct one delete_cert(module, executable, keystore_path, keystore_pass, cert_alias, keystore_type, exit_after=False) if pkcs12_path: import_pkcs12_path(module, executable, pkcs12_path, pkcs12_pass, pkcs12_alias, keystore_path, keystore_pass, cert_alias, keystore_type) else: import_cert_path(module, executable, new_certificate, keystore_path, keystore_pass, cert_alias, keystore_type, trust_cacert) module.exit_json(changed=False) if __name__ == "__main__": main() PK $�!\�<��e e Q collections/ansible_collections/community/general/plugins/modules/github_issue.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017-18, Abhijeet Kasurde <akasurde@redhat.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: github_issue short_description: View GitHub issue description: - View GitHub issue for a given repository and organization. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: repo: description: - Name of repository from which issue needs to be retrieved. required: true type: str organization: description: - Name of the GitHub organization in which the repository is hosted. required: true type: str issue: description: - Issue number for which information is required. required: true type: int action: description: - Get various details about issue depending upon action specified. default: 'get_status' choices: - 'get_status' type: str author: - Abhijeet Kasurde (@Akasurde) ''' RETURN = ''' issue_status: description: State of the GitHub issue type: str returned: success sample: open, closed ''' EXAMPLES = ''' - name: Check if GitHub issue is closed or not community.general.github_issue: organization: ansible repo: ansible issue: 23642 action: get_status register: r - name: Take action depending upon issue status ansible.builtin.debug: msg: Do something when issue 23642 is open when: r.issue_status == 'open' ''' import json from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def main(): module = AnsibleModule( argument_spec=dict( organization=dict(required=True), repo=dict(required=True), issue=dict(type='int', required=True), action=dict(choices=['get_status'], default='get_status'), ), supports_check_mode=True, ) organization = module.params['organization'] repo = module.params['repo'] issue = module.params['issue'] action = module.params['action'] result = dict() headers = { 'Content-Type': 'application/json', 'Accept': 'application/vnd.github.v3+json', } url = "https://api.github.com/repos/%s/%s/issues/%s" % (organization, repo, issue) response, info = fetch_url(module, url, headers=headers) if not (200 <= info['status'] < 400): if info['status'] == 404: module.fail_json(msg="Failed to find issue %s" % issue) module.fail_json(msg="Failed to send request to %s: %s" % (url, info['msg'])) gh_obj = json.loads(response.read()) if action == 'get_status' or action is None: if module.check_mode: result.update(changed=True) else: result.update(changed=True, issue_status=gh_obj['state']) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�B�� � W collections/ansible_collections/community/general/plugins/modules/manageiq_tags_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Daniel Korn <korndaniel1@gmail.com> # Copyright (c) 2017, Yaacov Zamir <yzamir@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: manageiq_tags_info version_added: 5.8.0 short_description: Retrieve resource tags in ManageIQ extends_documentation_fragment: - community.general.manageiq - community.general.attributes - community.general.attributes.info_module author: Alexei Znamensky (@russoz) description: - This module supports retrieving resource tags from ManageIQ. options: resource_type: type: str description: - The relevant resource type in ManageIQ. required: true choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template', 'template', 'tenant', 'user'] resource_name: type: str description: - The name of the resource at which tags will be controlled. - Must be specified if O(resource_id) is not set. Both options are mutually exclusive. resource_id: description: - The ID of the resource at which tags will be controlled. - Must be specified if O(resource_name) is not set. Both options are mutually exclusive. type: int ''' EXAMPLES = ''' - name: List current tags for a provider in ManageIQ. community.general.manageiq_tags_info: resource_name: 'EngLab' resource_type: 'provider' manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' register: result ''' RETURN = ''' tags: description: List of tags associated with the resource. returned: on success type: list elements: dict ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.manageiq import ( ManageIQ, ManageIQTags, manageiq_argument_spec, manageiq_entities ) def main(): argument_spec = dict( resource_id=dict(type='int'), resource_name=dict(type='str'), resource_type=dict(required=True, type='str', choices=list(manageiq_entities().keys())), ) # add the manageiq connection arguments to the arguments argument_spec.update(manageiq_argument_spec()) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[["resource_id", "resource_name"]], required_one_of=[["resource_id", "resource_name"]], supports_check_mode=True, ) resource_id = module.params['resource_id'] resource_type_key = module.params['resource_type'] resource_name = module.params['resource_name'] # get the action and resource type resource_type = manageiq_entities()[resource_type_key] manageiq = ManageIQ(module) # query resource id, fail if resource does not exist if resource_id is None: resource_id = manageiq.query_resource_id(resource_type, resource_name) manageiq_tags = ManageIQTags(manageiq, resource_type, resource_id) # return a list of current tags for this object current_tags = manageiq_tags.query_resource_tags() res_args = dict(changed=False, tags=current_tags) module.exit_json(**res_args) if __name__ == "__main__": main() PK $�!\� �V * * U collections/ansible_collections/community/general/plugins/modules/datadog_downtime.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Datadog, Inc # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: datadog_downtime short_description: Manages Datadog downtimes version_added: 2.0.0 description: - Manages downtimes within Datadog. - Options as described on U(https://docs.datadoghq.com/api/v1/downtimes/). author: - Datadog (@Datadog) requirements: - datadog-api-client - Python 3.6+ extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: api_key: description: - Your Datadog API key. required: true type: str api_host: description: - The URL to the Datadog API. - This value can also be set with the E(DATADOG_HOST) environment variable. required: false default: https://api.datadoghq.com type: str app_key: description: - Your Datadog app key. required: true type: str state: description: - The designated state of the downtime. required: false choices: ["present", "absent"] default: present type: str id: description: - The identifier of the downtime. - If empty, a new downtime gets created, otherwise it is either updated or deleted depending of the O(state). - To keep your playbook idempotent, you should save the identifier in a file and read it in a lookup. type: int monitor_tags: description: - A list of monitor tags to which the downtime applies. - The resulting downtime applies to monitors that match ALL provided monitor tags. type: list elements: str scope: description: - A list of scopes to which the downtime applies. - The resulting downtime applies to sources that matches ALL provided scopes. type: list elements: str monitor_id: description: - The ID of the monitor to mute. If not provided, the downtime applies to all monitors. type: int downtime_message: description: - A message to include with notifications for this downtime. - Email notifications can be sent to specific users by using the same "@username" notation as events. type: str start: type: int description: - POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. end: type: int description: - POSIX timestamp to end the downtime. If not provided, the downtime is in effect until you cancel it. timezone: description: - The timezone for the downtime. type: str rrule: description: - The C(RRULE) standard for defining recurring events. - For example, to have a recurring event on the first day of each month, select a type of rrule and set the C(FREQ) to C(MONTHLY) and C(BYMONTHDAY) to C(1). - Most common rrule options from the iCalendar Spec are supported. - Attributes specifying the duration in C(RRULE) are not supported (for example C(DTSTART), C(DTEND), C(DURATION)). type: str """ EXAMPLES = """ - name: Create a downtime register: downtime_var community.general.datadog_downtime: state: present monitor_tags: - "foo:bar" downtime_message: "Downtime for foo:bar" scope: "test" api_key: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" app_key: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" # Lookup the id in the file and ignore errors if the file doesn't exits, so downtime gets created id: "{{ lookup('file', inventory_hostname ~ '_downtime_id.txt', errors='ignore') }}" - name: Save downtime id to file for later updates and idempotence delegate_to: localhost copy: content: "{{ downtime.downtime.id }}" dest: "{{ inventory_hostname ~ '_downtime_id.txt' }}" """ RETURN = """ # Returns the downtime JSON dictionary from the API response under the C(downtime) key. # See https://docs.datadoghq.com/api/v1/downtimes/#schedule-a-downtime for more details. downtime: description: The downtime returned by the API. type: dict returned: always sample: { "active": true, "canceled": null, "creator_id": 1445416, "disabled": false, "downtime_type": 2, "end": null, "id": 1055751000, "message": "Downtime for foo:bar", "monitor_id": null, "monitor_tags": [ "foo:bar" ], "parent_id": null, "recurrence": null, "scope": [ "test" ], "start": 1607015009, "timezone": "UTC", "updater_id": null } """ import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib # Import Datadog DATADOG_IMP_ERR = None HAS_DATADOG = True try: from datadog_api_client.v1 import Configuration, ApiClient, ApiException from datadog_api_client.v1.api.downtimes_api import DowntimesApi from datadog_api_client.v1.model.downtime import Downtime from datadog_api_client.v1.model.downtime_recurrence import DowntimeRecurrence except ImportError: DATADOG_IMP_ERR = traceback.format_exc() HAS_DATADOG = False def main(): module = AnsibleModule( argument_spec=dict( api_key=dict(required=True, no_log=True), api_host=dict(required=False, default="https://api.datadoghq.com"), app_key=dict(required=True, no_log=True), state=dict(required=False, choices=["present", "absent"], default="present"), monitor_tags=dict(required=False, type="list", elements="str"), scope=dict(required=False, type="list", elements="str"), monitor_id=dict(required=False, type="int"), downtime_message=dict(required=False, no_log=True), start=dict(required=False, type="int"), end=dict(required=False, type="int"), timezone=dict(required=False, type="str"), rrule=dict(required=False, type="str"), id=dict(required=False, type="int"), ) ) # Prepare Datadog if not HAS_DATADOG: module.fail_json(msg=missing_required_lib("datadog-api-client"), exception=DATADOG_IMP_ERR) configuration = Configuration( host=module.params["api_host"], api_key={ "apiKeyAuth": module.params["api_key"], "appKeyAuth": module.params["app_key"] } ) with ApiClient(configuration) as api_client: api_client.user_agent = "ansible_collection/community_general (module_name datadog_downtime) {0}".format( api_client.user_agent ) api_instance = DowntimesApi(api_client) # Validate api and app keys try: api_instance.list_downtimes(current_only=True) except ApiException as e: module.fail_json(msg="Failed to connect Datadog server using given app_key and api_key: {0}".format(e)) if module.params["state"] == "present": schedule_downtime(module, api_client) elif module.params["state"] == "absent": cancel_downtime(module, api_client) def _get_downtime(module, api_client): api = DowntimesApi(api_client) downtime = None if module.params["id"]: try: downtime = api.get_downtime(module.params["id"]) except ApiException as e: module.fail_json(msg="Failed to retrieve downtime with id {0}: {1}".format(module.params["id"], e)) return downtime def build_downtime(module): downtime = Downtime() if module.params["monitor_tags"]: downtime.monitor_tags = module.params["monitor_tags"] if module.params["scope"]: downtime.scope = module.params["scope"] if module.params["monitor_id"]: downtime.monitor_id = module.params["monitor_id"] if module.params["downtime_message"]: downtime.message = module.params["downtime_message"] if module.params["start"]: downtime.start = module.params["start"] if module.params["end"]: downtime.end = module.params["end"] if module.params["timezone"]: downtime.timezone = module.params["timezone"] if module.params["rrule"]: downtime.recurrence = DowntimeRecurrence( rrule=module.params["rrule"], type="rrule", ) return downtime def _post_downtime(module, api_client): api = DowntimesApi(api_client) downtime = build_downtime(module) try: resp = api.create_downtime(downtime) module.params["id"] = resp.id module.exit_json(changed=True, downtime=resp.to_dict()) except ApiException as e: module.fail_json(msg="Failed to create downtime: {0}".format(e)) def _equal_dicts(a, b, ignore_keys): ka = set(a).difference(ignore_keys) kb = set(b).difference(ignore_keys) return ka == kb and all(a[k] == b[k] for k in ka) def _update_downtime(module, current_downtime, api_client): api = DowntimesApi(api_client) downtime = build_downtime(module) try: if current_downtime.disabled: resp = api.create_downtime(downtime) else: resp = api.update_downtime(module.params["id"], downtime) if _equal_dicts( resp.to_dict(), current_downtime.to_dict(), ["active", "creator_id", "updater_id"] ): module.exit_json(changed=False, downtime=resp.to_dict()) else: module.exit_json(changed=True, downtime=resp.to_dict()) except ApiException as e: module.fail_json(msg="Failed to update downtime: {0}".format(e)) def schedule_downtime(module, api_client): downtime = _get_downtime(module, api_client) if downtime is None: _post_downtime(module, api_client) else: _update_downtime(module, downtime, api_client) def cancel_downtime(module, api_client): downtime = _get_downtime(module, api_client) api = DowntimesApi(api_client) if downtime is None: module.exit_json(changed=False) try: api.cancel_downtime(downtime["id"]) except ApiException as e: module.fail_json(msg="Failed to create downtime: {0}".format(e)) module.exit_json(changed=True) if __name__ == "__main__": main() PK $�!\�V��; ; I collections/ansible_collections/community/general/plugins/modules/make.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Linus Unnebäck <linus@folkdatorn.se> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: make short_description: Run targets in a Makefile requirements: - make author: Linus Unnebäck (@LinusU) <linus@folkdatorn.se> description: - Run targets in a Makefile. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: chdir: description: - Change to this directory before running make. type: path required: true file: description: - Use a custom Makefile. type: path jobs: description: - Set the number of make jobs to run concurrently. - Typically if set, this would be the number of processors and/or threads available to the machine. - This is not supported by all make implementations. type: int version_added: 2.0.0 make: description: - Use a specific make binary. type: path version_added: '0.2.0' params: description: - Any extra parameters to pass to make. - If the value is empty, only the key will be used. For example, V(FOO:) will produce V(FOO), not V(FOO=). type: dict target: description: - The target to run. - Typically this would be something like V(install), V(test), or V(all). - O(target) and O(targets) are mutually exclusive. type: str targets: description: - The list of targets to run. - Typically this would be something like V(install), V(test), or V(all). - O(target) and O(targets) are mutually exclusive. type: list elements: str version_added: 7.2.0 ''' EXAMPLES = r''' - name: Build the default target community.general.make: chdir: /home/ubuntu/cool-project - name: Run 'install' target as root community.general.make: chdir: /home/ubuntu/cool-project target: install become: true - name: Build 'all' target with extra arguments community.general.make: chdir: /home/ubuntu/cool-project target: all params: NUM_THREADS: 4 BACKEND: lapack - name: Build 'all' target with a custom Makefile community.general.make: chdir: /home/ubuntu/cool-project target: all file: /some-project/Makefile - name: build arm64 kernel on FreeBSD, with 16 parallel jobs community.general.make: chdir: /usr/src jobs: 16 target: buildkernel params: # This adds -DWITH_FDT to the command line: -DWITH_FDT: # The following adds TARGET=arm64 TARGET_ARCH=aarch64 to the command line: TARGET: arm64 TARGET_ARCH: aarch64 ''' RETURN = r''' chdir: description: - The value of the module parameter O(chdir). type: str returned: success command: description: - The command built and executed by the module. type: str returned: success version_added: 6.5.0 file: description: - The value of the module parameter O(file). type: str returned: success jobs: description: - The value of the module parameter O(jobs). type: int returned: success params: description: - The value of the module parameter O(params). type: dict returned: success target: description: - The value of the module parameter O(target). type: str returned: success targets: description: - The value of the module parameter O(targets). type: str returned: success version_added: 7.2.0 ''' from ansible.module_utils.six import iteritems from ansible.module_utils.six.moves import shlex_quote from ansible.module_utils.basic import AnsibleModule def run_command(command, module, check_rc=True): """ Run a command using the module, return the result code and std{err,out} content. :param command: list of command arguments :param module: Ansible make module instance :return: return code, stdout content, stderr content """ rc, out, err = module.run_command(command, check_rc=check_rc, cwd=module.params['chdir']) return rc, sanitize_output(out), sanitize_output(err) def sanitize_output(output): """ Sanitize the output string before we pass it to module.fail_json. Defaults the string to empty if it is None, else strips trailing newlines. :param output: output to sanitize :return: sanitized output """ if output is None: return '' else: return output.rstrip("\r\n") def main(): module = AnsibleModule( argument_spec=dict( target=dict(type='str'), targets=dict(type='list', elements='str'), params=dict(type='dict'), chdir=dict(type='path', required=True), file=dict(type='path'), make=dict(type='path'), jobs=dict(type='int'), ), mutually_exclusive=[('target', 'targets')], supports_check_mode=True, ) make_path = module.params['make'] if make_path is None: # Build up the invocation of `make` we are going to use # For non-Linux OSes, prefer gmake (GNU make) over make make_path = module.get_bin_path('gmake', required=False) if not make_path: # Fall back to system make make_path = module.get_bin_path('make', required=True) if module.params['params'] is not None: make_parameters = [k + (('=' + str(v)) if v is not None else '') for k, v in iteritems(module.params['params'])] else: make_parameters = [] # build command: # handle any make specific arguments included in params base_command = [make_path] if module.params['jobs'] is not None: jobs = str(module.params['jobs']) base_command.extend(["-j", jobs]) if module.params['file'] is not None: base_command.extend(["-f", module.params['file']]) # add make target if module.params['target']: base_command.append(module.params['target']) elif module.params['targets']: base_command.extend(module.params['targets']) # add makefile parameters base_command.extend(make_parameters) # Check if the target is already up to date rc, out, err = run_command(base_command + ['-q'], module, check_rc=False) if module.check_mode: # If we've been asked to do a dry run, we only need # to report whether or not the target is up to date changed = (rc != 0) else: if rc == 0: # The target is up to date, so we don't have to # do anything changed = False else: # The target isn't up to date, so we need to run it rc, out, err = run_command(base_command, module, check_rc=True) changed = True # We don't report the return code, as if this module failed # we would be calling fail_json from run_command, so even if # we had a non-zero return code, we did not fail. However, if # we report a non-zero return code here, we will be marked as # failed regardless of what we signal using the failed= kwarg. module.exit_json( changed=changed, failed=False, stdout=out, stderr=err, target=module.params['target'], targets=module.params['targets'], params=module.params['params'], chdir=module.params['chdir'], file=module.params['file'], jobs=module.params['jobs'], command=' '.join([shlex_quote(part) for part in base_command]), ) if __name__ == '__main__': main() PK $�!\-_��;# ;# O collections/ansible_collections/community/general/plugins/modules/ldap_entry.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Peter Sagerson <psagers@ignorare.net> # Copyright (c) 2016, Jiri Tyr <jiri.tyr@gmail.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ldap_entry short_description: Add or remove LDAP entries description: - Add or remove LDAP entries. This module only asserts the existence or non-existence of an LDAP entry, not its attributes. To assert the attribute values of an entry, see M(community.general.ldap_attrs). notes: - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu install for example, which includes a cn=peercred,cn=external,cn=auth ACL rule allowing root to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw). author: - Jiri Tyr (@jtyr) requirements: - python-ldap attributes: check_mode: support: full diff_mode: support: none options: attributes: description: - If O(state=present), attributes necessary to create an entry. Existing entries are never modified. To assert specific attribute values on an existing entry, use M(community.general.ldap_attrs) module instead. - Each attribute value can be a string for single-valued attributes or a list of strings for multi-valued attributes. - If you specify values for this option in YAML, please note that you can improve readability for long string values by using YAML block modifiers as seen in the examples for this module. - Note that when using values that YAML/ansible-core interprets as other types, like V(yes), V(no) (booleans), or V(2.10) (float), make sure to quote them if these are meant to be strings. Otherwise the wrong values may be sent to LDAP. type: dict default: {} objectClass: description: - If O(state=present), value or list of values to use when creating the entry. It can either be a string or an actual list of strings. type: list elements: str state: description: - The target state of the entry. choices: [present, absent] default: present type: str recursive: description: - If O(state=delete), a flag indicating whether a single entry or the whole branch must be deleted. type: bool default: false version_added: 4.6.0 extends_documentation_fragment: - community.general.ldap.documentation - community.general.attributes ''' EXAMPLES = """ - name: Make sure we have a parent entry for users community.general.ldap_entry: dn: ou=users,dc=example,dc=com objectClass: organizationalUnit - name: Make sure we have an admin user community.general.ldap_entry: dn: cn=admin,dc=example,dc=com objectClass: - simpleSecurityObject - organizationalRole attributes: description: An LDAP administrator userPassword: "{SSHA}tabyipcHzhwESzRaGA7oQ/SDoBZQOGND" - name: Set possible values for attributes elements community.general.ldap_entry: dn: cn=admin,dc=example,dc=com objectClass: - simpleSecurityObject - organizationalRole attributes: description: An LDAP Administrator roleOccupant: - cn=Chocs Puddington,ou=Information Technology,dc=example,dc=com - cn=Alice Stronginthebrain,ou=Information Technology,dc=example,dc=com olcAccess: - >- {0}to attrs=userPassword,shadowLastChange by self write by anonymous auth by dn="cn=admin,dc=example,dc=com" write by * none' - >- {1}to dn.base="dc=example,dc=com" by dn="cn=admin,dc=example,dc=com" write by * read - name: Get rid of an old entry community.general.ldap_entry: dn: ou=stuff,dc=example,dc=com state: absent server_uri: ldap://localhost/ bind_dn: cn=admin,dc=example,dc=com bind_pw: password # # The same as in the previous example but with the authentication details # stored in the ldap_auth variable: # # ldap_auth: # server_uri: ldap://localhost/ # bind_dn: cn=admin,dc=example,dc=com # bind_pw: password # # In the example below, 'args' is a task keyword, passed at the same level as the module - name: Get rid of an old entry community.general.ldap_entry: dn: ou=stuff,dc=example,dc=com state: absent args: "{{ ldap_auth }}" """ RETURN = """ # Default return values """ import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native, to_bytes from ansible_collections.community.general.plugins.module_utils.ldap import LdapGeneric, gen_specs, ldap_required_together LDAP_IMP_ERR = None try: import ldap.modlist import ldap.controls HAS_LDAP = True except ImportError: LDAP_IMP_ERR = traceback.format_exc() HAS_LDAP = False class LdapEntry(LdapGeneric): def __init__(self, module): LdapGeneric.__init__(self, module) # Shortcuts self.state = self.module.params['state'] self.recursive = self.module.params['recursive'] # Add the objectClass into the list of attributes self.module.params['attributes']['objectClass'] = ( self.module.params['objectClass']) # Load attributes if self.state == 'present': self.attrs = self._load_attrs() def _load_attrs(self): """ Turn attribute's value to array. """ attrs = {} for name, value in self.module.params['attributes'].items(): if isinstance(value, list): attrs[name] = list(map(to_bytes, value)) else: attrs[name] = [to_bytes(value)] return attrs def add(self): """ If self.dn does not exist, returns a callable that will add it. """ def _add(): self.connection.add_s(self.dn, modlist) if not self._is_entry_present(): modlist = ldap.modlist.addModlist(self.attrs) action = _add else: action = None return action def delete(self): """ If self.dn exists, returns a callable that will delete either the item itself if the recursive option is not set or the whole branch if it is. """ def _delete(): self.connection.delete_s(self.dn) def _delete_recursive(): """ Attempt recurive deletion using the subtree-delete control. If that fails, do it manually. """ try: subtree_delete = ldap.controls.ValueLessRequestControl('1.2.840.113556.1.4.805') self.connection.delete_ext_s(self.dn, serverctrls=[subtree_delete]) except ldap.NOT_ALLOWED_ON_NONLEAF: search = self.connection.search_s(self.dn, ldap.SCOPE_SUBTREE, attrlist=('dn',)) search.reverse() for entry in search: self.connection.delete_s(entry[0]) if self._is_entry_present(): if self.recursive: action = _delete_recursive else: action = _delete else: action = None return action def _is_entry_present(self): try: self.connection.search_s(self.dn, ldap.SCOPE_BASE) except ldap.NO_SUCH_OBJECT: is_present = False else: is_present = True return is_present def main(): module = AnsibleModule( argument_spec=gen_specs( attributes=dict(default={}, type='dict'), objectClass=dict(type='list', elements='str'), state=dict(default='present', choices=['present', 'absent']), recursive=dict(default=False, type='bool'), ), required_if=[('state', 'present', ['objectClass'])], supports_check_mode=True, required_together=ldap_required_together(), ) if not HAS_LDAP: module.fail_json(msg=missing_required_lib('python-ldap'), exception=LDAP_IMP_ERR) state = module.params['state'] # Instantiate the LdapEntry object ldap = LdapEntry(module) # Get the action function if state == 'present': action = ldap.add() elif state == 'absent': action = ldap.delete() # Perform the action if action is not None and not module.check_mode: try: action() except Exception as e: module.fail_json(msg="Entry action failed.", details=to_native(e), exception=traceback.format_exc()) module.exit_json(changed=(action is not None)) if __name__ == '__main__': main() PK $�!\j/ x� � U collections/ansible_collections/community/general/plugins/modules/pagerduty_change.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Adam Vaughan (@adamvaughan) avaughan@pagerduty.com # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: pagerduty_change short_description: Track a code or infrastructure change as a PagerDuty change event version_added: 1.3.0 description: - This module will let you create a PagerDuty change event each time the module is run. - This is not an idempotent action and a new change event will be created each time it is run. author: - Adam Vaughan (@adamvaughan) requirements: - PagerDuty integration key extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full details: - Check mode simply does nothing except returning C(changed=true) in case the O(url) seems to be correct. diff_mode: support: none options: integration_key: description: - The integration key that identifies the service the change was made to. This can be found by adding an integration to a service in PagerDuty. required: true type: str summary: description: - A short description of the change that occurred. required: true type: str source: description: - The source of the change event. default: Ansible type: str user: description: - The name of the user or process that triggered this deployment. type: str repo: description: - The URL of the project repository. required: false type: str revision: description: - An identifier of the revision being deployed, typically a number or SHA from a version control system. required: false type: str environment: description: - The environment name, typically V(production), V(staging), and so on. required: false type: str link_url: description: - A URL where more information about the deployment can be obtained. required: false type: str link_text: description: - Descriptive text for a URL where more information about the deployment can be obtained. required: false type: str url: description: - URL to submit the change event to. required: false default: https://events.pagerduty.com/v2/change/enqueue type: str validate_certs: description: - If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false default: true type: bool ''' EXAMPLES = ''' - name: Track the deployment as a PagerDuty change event community.general.pagerduty_change: integration_key: abc123abc123abc123abc123abc123ab summary: The application was deployed - name: Track the deployment as a PagerDuty change event with more details community.general.pagerduty_change: integration_key: abc123abc123abc123abc123abc123ab summary: The application was deployed source: Ansible Deploy user: ansible repo: github.com/ansible/ansible revision: '4.2' environment: production link_url: https://github.com/ansible-collections/community.general/pull/1269 link_text: View changes on GitHub ''' from ansible.module_utils.urls import fetch_url from ansible.module_utils.basic import AnsibleModule from datetime import datetime def main(): module = AnsibleModule( argument_spec=dict( integration_key=dict(required=True, type='str', no_log=True), summary=dict(required=True, type='str'), source=dict(required=False, default='Ansible', type='str'), user=dict(required=False, type='str'), repo=dict(required=False, type='str'), revision=dict(required=False, type='str'), environment=dict(required=False, type='str'), link_url=dict(required=False, type='str'), link_text=dict(required=False, type='str'), url=dict(required=False, default='https://events.pagerduty.com/v2/change/enqueue', type='str'), validate_certs=dict(default=True, type='bool') ), supports_check_mode=True ) # API documented at https://developer.pagerduty.com/docs/events-api-v2/send-change-events/ url = module.params['url'] headers = {'Content-Type': 'application/json'} if module.check_mode: _response, info = fetch_url( module, url, headers=headers, method='POST') if info['status'] == 400: module.exit_json(changed=True) else: module.fail_json( msg='Checking the PagerDuty change event API returned an unexpected response: %d' % (info['status'])) custom_details = {} if module.params['user']: custom_details['user'] = module.params['user'] if module.params['repo']: custom_details['repo'] = module.params['repo'] if module.params['revision']: custom_details['revision'] = module.params['revision'] if module.params['environment']: custom_details['environment'] = module.params['environment'] now = datetime.utcnow() timestamp = now.strftime("%Y-%m-%dT%H:%M:%S.%fZ") payload = { 'summary': module.params['summary'], 'source': module.params['source'], 'timestamp': timestamp, 'custom_details': custom_details } event = { 'routing_key': module.params['integration_key'], 'payload': payload } if module.params['link_url']: link = { 'href': module.params['link_url'] } if module.params['link_text']: link['text'] = module.params['link_text'] event['links'] = [link] _response, info = fetch_url( module, url, data=module.jsonify(event), headers=headers, method='POST') if info['status'] == 202: module.exit_json(changed=True) else: module.fail_json( msg='Creating PagerDuty change event failed with %d' % (info['status'])) if __name__ == '__main__': main() PK $�!\���9" 9" P collections/ansible_collections/community/general/plugins/modules/github_repo.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Álvaro Torres Cogollo # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: github_repo short_description: Manage your repositories on Github version_added: 2.2.0 description: - Manages Github repositories using PyGithub library. - Authentication can be done with O(access_token) or with O(username) and O(password). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: username: description: - Username used for authentication. - This is only needed when not using O(access_token). type: str required: false password: description: - Password used for authentication. - This is only needed when not using O(access_token). type: str required: false access_token: description: - Token parameter for authentication. - This is only needed when not using O(username) and O(password). type: str required: false name: description: - Repository name. type: str required: true description: description: - Description for the repository. - Defaults to empty if O(force_defaults=true), which is the default in this module. - Defaults to empty if O(force_defaults=false) when creating a new repository. - This is only used when O(state) is V(present). type: str required: false private: description: - Whether the repository should be private or not. - Defaults to V(false) if O(force_defaults=true), which is the default in this module. - Defaults to V(false) if O(force_defaults=false) when creating a new repository. - This is only used when O(state=present). type: bool required: false state: description: - Whether the repository should exist or not. type: str default: present choices: [ absent, present ] required: false organization: description: - Organization for the repository. - When O(state=present), the repository will be created in the current user profile. type: str required: false api_url: description: - URL to the GitHub API if not using github.com but you own instance. type: str default: 'https://api.github.com' version_added: "3.5.0" force_defaults: description: - Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the default. - The default for this option will be deprecated in a future version of this collection, and eventually change to V(false). type: bool default: true required: false version_added: 4.1.0 requirements: - PyGithub>=1.54 notes: - For Python 3, PyGithub>=1.54 should be used. - "For Python 3.5, PyGithub==1.54 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020)." - "For Python 2.7, PyGithub==1.45 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019)." author: - Álvaro Torres Cogollo (@atorrescogollo) ''' EXAMPLES = ''' - name: Create a Github repository community.general.github_repo: access_token: mytoken organization: MyOrganization name: myrepo description: "Just for fun" private: true state: present force_defaults: false register: result - name: Delete the repository community.general.github_repo: username: octocat password: password organization: MyOrganization name: myrepo state: absent register: result ''' RETURN = ''' repo: description: Repository information as JSON. See U(https://docs.github.com/en/rest/reference/repos#get-a-repository). returned: success and O(state=present) type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib GITHUB_IMP_ERR = None try: from github import Github, GithubException, GithubObject from github.GithubException import UnknownObjectException HAS_GITHUB_PACKAGE = True except Exception: GITHUB_IMP_ERR = traceback.format_exc() HAS_GITHUB_PACKAGE = False def authenticate(username=None, password=None, access_token=None, api_url=None): if not api_url: return None if access_token: return Github(base_url=api_url, login_or_token=access_token) else: return Github(base_url=api_url, login_or_token=username, password=password) def create_repo(gh, name, organization=None, private=None, description=None, check_mode=False): result = dict( changed=False, repo=dict()) if organization: target = gh.get_organization(organization) else: target = gh.get_user() repo = None try: repo = target.get_repo(name=name) result['repo'] = repo.raw_data except UnknownObjectException: if not check_mode: repo = target.create_repo( name=name, private=GithubObject.NotSet if private is None else private, description=GithubObject.NotSet if description is None else description, ) result['repo'] = repo.raw_data result['changed'] = True changes = {} if private is not None: if repo is None or repo.raw_data['private'] != private: changes['private'] = private if description is not None: if repo is None or repo.raw_data['description'] not in (description, description or None): changes['description'] = description if changes: if not check_mode: repo.edit(**changes) result['repo'].update({ 'private': repo._private.value if not check_mode else private, 'description': repo._description.value if not check_mode else description, }) result['changed'] = True return result def delete_repo(gh, name, organization=None, check_mode=False): result = dict(changed=False) if organization: target = gh.get_organization(organization) else: target = gh.get_user() try: repo = target.get_repo(name=name) if not check_mode: repo.delete() result['changed'] = True except UnknownObjectException: pass return result def run_module(params, check_mode=False): if params['force_defaults']: params['description'] = params['description'] or '' params['private'] = params['private'] or False gh = authenticate( username=params['username'], password=params['password'], access_token=params['access_token'], api_url=params['api_url']) if params['state'] == "absent": return delete_repo( gh=gh, name=params['name'], organization=params['organization'], check_mode=check_mode ) else: return create_repo( gh=gh, name=params['name'], organization=params['organization'], private=params['private'], description=params['description'], check_mode=check_mode ) def main(): module_args = dict( username=dict(type='str'), password=dict(type='str', no_log=True), access_token=dict(type='str', no_log=True), name=dict(type='str', required=True), state=dict(type='str', required=False, default="present", choices=["present", "absent"]), organization=dict(type='str', required=False, default=None), private=dict(type='bool'), description=dict(type='str'), api_url=dict(type='str', required=False, default='https://api.github.com'), force_defaults=dict(type='bool', default=True), ) module = AnsibleModule( argument_spec=module_args, supports_check_mode=True, required_together=[('username', 'password')], required_one_of=[('username', 'access_token')], mutually_exclusive=[('username', 'access_token')] ) if not HAS_GITHUB_PACKAGE: module.fail_json(msg=missing_required_lib( "PyGithub"), exception=GITHUB_IMP_ERR) try: result = run_module(module.params, module.check_mode) module.exit_json(**result) except GithubException as e: module.fail_json(msg="Github error. {0}".format(repr(e))) except Exception as e: module.fail_json(msg="Unexpected error. {0}".format(repr(e))) if __name__ == '__main__': main() PK $�!\2��� 8 8 O collections/ansible_collections/community/general/plugins/modules/ipa_config.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Fran Fitzpatrick <francis.x.fitzpatrick@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_config author: Fran Fitzpatrick (@fxfitz) short_description: Manage Global FreeIPA Configuration Settings description: - Modify global configuration settings of a FreeIPA Server. attributes: check_mode: support: full diff_mode: support: none options: ipaconfigstring: description: Extra hashes to generate in password plug-in. aliases: ["configstring"] type: list elements: str choices: ["AllowNThash", "KDC:Disable Last Success", "KDC:Disable Lockout", "KDC:Disable Default Preauth for SPNs"] version_added: '2.5.0' ipadefaultloginshell: description: Default shell for new users. aliases: ["loginshell"] type: str ipadefaultemaildomain: description: Default e-mail domain for new users. aliases: ["emaildomain"] type: str ipadefaultprimarygroup: description: Default group for new users. aliases: ["primarygroup"] type: str version_added: '2.5.0' ipagroupobjectclasses: description: A list of group objectclasses. aliases: ["groupobjectclasses"] type: list elements: str version_added: '7.3.0' ipagroupsearchfields: description: A list of fields to search in when searching for groups. aliases: ["groupsearchfields"] type: list elements: str version_added: '2.5.0' ipahomesrootdir: description: Default location of home directories. aliases: ["homesrootdir"] type: str version_added: '2.5.0' ipakrbauthzdata: description: Default types of PAC supported for services. aliases: ["krbauthzdata"] type: list elements: str choices: ["MS-PAC", "PAD", "nfs:NONE"] version_added: '2.5.0' ipamaxusernamelength: description: Maximum length of usernames. aliases: ["maxusernamelength"] type: int version_added: '2.5.0' ipapwdexpadvnotify: description: Notice of impending password expiration, in days. aliases: ["pwdexpadvnotify"] type: int version_added: '2.5.0' ipasearchrecordslimit: description: Maximum number of records to search (-1 or 0 is unlimited). aliases: ["searchrecordslimit"] type: int version_added: '2.5.0' ipasearchtimelimit: description: Maximum amount of time (seconds) for a search (-1 or 0 is unlimited). aliases: ["searchtimelimit"] type: int version_added: '2.5.0' ipaselinuxusermaporder: description: The SELinux user map order (order in increasing priority of SELinux users). aliases: ["selinuxusermaporder"] type: list elements: str version_added: '3.7.0' ipauserauthtype: description: - The authentication type to use by default. - The choice V(idp) has been added in community.general 7.3.0. aliases: ["userauthtype"] choices: ["password", "radius", "otp", "pkinit", "hardened", "idp", "disabled"] type: list elements: str version_added: '2.5.0' ipauserobjectclasses: description: A list of user objectclasses. aliases: ["userobjectclasses"] type: list elements: str version_added: '7.3.0' ipausersearchfields: description: A list of fields to search in when searching for users. aliases: ["usersearchfields"] type: list elements: str version_added: '2.5.0' extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure password plugin features DC:Disable Last Success and KDC:Disable Lockout are enabled community.general.ipa_config: ipaconfigstring: ["KDC:Disable Last Success", "KDC:Disable Lockout"] ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the default login shell is bash community.general.ipa_config: ipadefaultloginshell: /bin/bash ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the default e-mail domain is ansible.com community.general.ipa_config: ipadefaultemaildomain: ansible.com ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the default primary group is set to ipausers community.general.ipa_config: ipadefaultprimarygroup: ipausers ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the group search fields are set to 'cn,description' community.general.ipa_config: ipagroupsearchfields: ['cn', 'description'] ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the home directory location is set to /home community.general.ipa_config: ipahomesrootdir: /home ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the default types of PAC supported for services is set to MS-PAC and PAD community.general.ipa_config: ipakrbauthzdata: ["MS-PAC", "PAD"] ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the maximum user name length is set to 32 community.general.ipa_config: ipamaxusernamelength: 32 ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the password expiration notice is set to 4 days community.general.ipa_config: ipapwdexpadvnotify: 4 ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the search record limit is set to 100 community.general.ipa_config: ipasearchrecordslimit: 100 ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the search time limit is set to 2 seconds community.general.ipa_config: ipasearchtimelimit: 2 ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the default user auth type is password community.general.ipa_config: ipauserauthtype: ['password'] ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the user search fields is set to 'uid,givenname,sn,ou,title' community.general.ipa_config: ipausersearchfields: ['uid', 'givenname', 'sn', 'ou', 'title'] ipa_host: localhost ipa_user: admin ipa_pass: supersecret - name: Ensure the SELinux user map order is set community.general.ipa_config: ipaselinuxusermaporder: - "guest_u:s0" - "xguest_u:s0" - "user_u:s0" - "staff_u:s0-s0:c0.c1023" - "unconfined_u:s0-s0:c0.c1023" ipa_host: localhost ipa_user: admin ipa_pass: supersecret ''' RETURN = r''' config: description: Configuration as returned by IPA API. returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class ConfigIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(ConfigIPAClient, self).__init__(module, host, port, protocol) def config_show(self): return self._post_json(method='config_show', name=None) def config_mod(self, name, item): return self._post_json(method='config_mod', name=name, item=item) def get_config_dict(ipaconfigstring=None, ipadefaultloginshell=None, ipadefaultemaildomain=None, ipadefaultprimarygroup=None, ipagroupsearchfields=None, ipagroupobjectclasses=None, ipahomesrootdir=None, ipakrbauthzdata=None, ipamaxusernamelength=None, ipapwdexpadvnotify=None, ipasearchrecordslimit=None, ipasearchtimelimit=None, ipaselinuxusermaporder=None, ipauserauthtype=None, ipausersearchfields=None, ipauserobjectclasses=None): config = {} if ipaconfigstring is not None: config['ipaconfigstring'] = ipaconfigstring if ipadefaultloginshell is not None: config['ipadefaultloginshell'] = ipadefaultloginshell if ipadefaultemaildomain is not None: config['ipadefaultemaildomain'] = ipadefaultemaildomain if ipadefaultprimarygroup is not None: config['ipadefaultprimarygroup'] = ipadefaultprimarygroup if ipagroupobjectclasses is not None: config['ipagroupobjectclasses'] = ipagroupobjectclasses if ipagroupsearchfields is not None: config['ipagroupsearchfields'] = ','.join(ipagroupsearchfields) if ipahomesrootdir is not None: config['ipahomesrootdir'] = ipahomesrootdir if ipakrbauthzdata is not None: config['ipakrbauthzdata'] = ipakrbauthzdata if ipamaxusernamelength is not None: config['ipamaxusernamelength'] = str(ipamaxusernamelength) if ipapwdexpadvnotify is not None: config['ipapwdexpadvnotify'] = str(ipapwdexpadvnotify) if ipasearchrecordslimit is not None: config['ipasearchrecordslimit'] = str(ipasearchrecordslimit) if ipasearchtimelimit is not None: config['ipasearchtimelimit'] = str(ipasearchtimelimit) if ipaselinuxusermaporder is not None: config['ipaselinuxusermaporder'] = '$'.join(ipaselinuxusermaporder) if ipauserauthtype is not None: config['ipauserauthtype'] = ipauserauthtype if ipauserobjectclasses is not None: config['ipauserobjectclasses'] = ipauserobjectclasses if ipausersearchfields is not None: config['ipausersearchfields'] = ','.join(ipausersearchfields) return config def get_config_diff(client, ipa_config, module_config): return client.get_diff(ipa_data=ipa_config, module_data=module_config) def ensure(module, client): module_config = get_config_dict( ipaconfigstring=module.params.get('ipaconfigstring'), ipadefaultloginshell=module.params.get('ipadefaultloginshell'), ipadefaultemaildomain=module.params.get('ipadefaultemaildomain'), ipadefaultprimarygroup=module.params.get('ipadefaultprimarygroup'), ipagroupobjectclasses=module.params.get('ipagroupobjectclasses'), ipagroupsearchfields=module.params.get('ipagroupsearchfields'), ipahomesrootdir=module.params.get('ipahomesrootdir'), ipakrbauthzdata=module.params.get('ipakrbauthzdata'), ipamaxusernamelength=module.params.get('ipamaxusernamelength'), ipapwdexpadvnotify=module.params.get('ipapwdexpadvnotify'), ipasearchrecordslimit=module.params.get('ipasearchrecordslimit'), ipasearchtimelimit=module.params.get('ipasearchtimelimit'), ipaselinuxusermaporder=module.params.get('ipaselinuxusermaporder'), ipauserauthtype=module.params.get('ipauserauthtype'), ipausersearchfields=module.params.get('ipausersearchfields'), ipauserobjectclasses=module.params.get('ipauserobjectclasses'), ) ipa_config = client.config_show() diff = get_config_diff(client, ipa_config, module_config) changed = False new_config = {} for module_key in diff: if module_config.get(module_key) != ipa_config.get(module_key, None): changed = True new_config.update({module_key: module_config.get(module_key)}) if changed and not module.check_mode: client.config_mod(name=None, item=new_config) return changed, client.config_show() def main(): argument_spec = ipa_argument_spec() argument_spec.update( ipaconfigstring=dict(type='list', elements='str', choices=['AllowNThash', 'KDC:Disable Last Success', 'KDC:Disable Lockout', 'KDC:Disable Default Preauth for SPNs'], aliases=['configstring']), ipadefaultloginshell=dict(type='str', aliases=['loginshell']), ipadefaultemaildomain=dict(type='str', aliases=['emaildomain']), ipadefaultprimarygroup=dict(type='str', aliases=['primarygroup']), ipagroupobjectclasses=dict(type='list', elements='str', aliases=['groupobjectclasses']), ipagroupsearchfields=dict(type='list', elements='str', aliases=['groupsearchfields']), ipahomesrootdir=dict(type='str', aliases=['homesrootdir']), ipakrbauthzdata=dict(type='list', elements='str', choices=['MS-PAC', 'PAD', 'nfs:NONE'], aliases=['krbauthzdata']), ipamaxusernamelength=dict(type='int', aliases=['maxusernamelength']), ipapwdexpadvnotify=dict(type='int', aliases=['pwdexpadvnotify']), ipasearchrecordslimit=dict(type='int', aliases=['searchrecordslimit']), ipasearchtimelimit=dict(type='int', aliases=['searchtimelimit']), ipaselinuxusermaporder=dict(type='list', elements='str', aliases=['selinuxusermaporder']), ipauserauthtype=dict(type='list', elements='str', aliases=['userauthtype'], choices=["password", "radius", "otp", "pkinit", "hardened", "idp", "disabled"]), ipausersearchfields=dict(type='list', elements='str', aliases=['usersearchfields']), ipauserobjectclasses=dict(type='list', elements='str', aliases=['userobjectclasses']), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True ) client = ConfigIPAClient( module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot'] ) try: client.login( username=module.params['ipa_user'], password=module.params['ipa_pass'] ) changed, user = ensure(module, client) module.exit_json(changed=changed, user=user) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\�ϑ�� � I collections/ansible_collections/community/general/plugins/modules/pkg5.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Peter Oliver <ansible@mavit.org.uk> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: pkg5 author: - Peter Oliver (@mavit) short_description: Manages packages with the Solaris 11 Image Packaging System description: - IPS packages are the native packages in Solaris 11 and higher. notes: - The naming of IPS packages is explained at U(http://www.oracle.com/technetwork/articles/servers-storage-admin/ips-package-versioning-2232906.html). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - An FRMI of the package(s) to be installed/removed/updated. - Multiple packages may be specified, separated by V(,). required: true type: list elements: str state: description: - Whether to install (V(present), V(latest)), or remove (V(absent)) a package. choices: [ absent, latest, present, installed, removed, uninstalled ] default: present type: str accept_licenses: description: - Accept any licences. type: bool default: false aliases: [ accept, accept_licences ] be_name: description: - Creates a new boot environment with the given name. type: str refresh: description: - Refresh publishers before execution. type: bool default: true ''' EXAMPLES = ''' - name: Install Vim community.general.pkg5: name: editor/vim - name: Install Vim without refreshing publishers community.general.pkg5: name: editor/vim refresh: false - name: Remove finger daemon community.general.pkg5: name: service/network/finger state: absent - name: Install several packages at once community.general.pkg5: name: - /file/gnu-findutils - /text/gnu-grep ''' import re from ansible.module_utils.basic import AnsibleModule def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='list', elements='str', required=True), state=dict(type='str', default='present', choices=['absent', 'installed', 'latest', 'present', 'removed', 'uninstalled']), accept_licenses=dict(type='bool', default=False, aliases=['accept', 'accept_licences']), be_name=dict(type='str'), refresh=dict(type='bool', default=True), ), supports_check_mode=True, ) params = module.params packages = [] # pkg(5) FRMIs include a comma before the release number, but # AnsibleModule will have split this into multiple items for us. # Try to spot where this has happened and fix it. for fragment in params['name']: if re.search(r'^\d+(?:\.\d+)*', fragment) and packages and re.search(r'@[^,]*$', packages[-1]): packages[-1] += ',' + fragment else: packages.append(fragment) if params['state'] in ['present', 'installed']: ensure(module, 'present', packages, params) elif params['state'] in ['latest']: ensure(module, 'latest', packages, params) elif params['state'] in ['absent', 'uninstalled', 'removed']: ensure(module, 'absent', packages, params) def ensure(module, state, packages, params): response = { 'results': [], 'msg': '', } behaviour = { 'present': { 'filter': lambda p: not is_installed(module, p), 'subcommand': 'install', }, 'latest': { 'filter': lambda p: ( not is_installed(module, p) or not is_latest(module, p) ), 'subcommand': 'install', }, 'absent': { 'filter': lambda p: is_installed(module, p), 'subcommand': 'uninstall', }, } if module.check_mode: dry_run = ['-n'] else: dry_run = [] if params['accept_licenses']: accept_licenses = ['--accept'] else: accept_licenses = [] if params['be_name']: beadm = ['--be-name=' + module.params['be_name']] else: beadm = [] if params['refresh']: no_refresh = [] else: no_refresh = ['--no-refresh'] to_modify = list(filter(behaviour[state]['filter'], packages)) if to_modify: rc, out, err = module.run_command(['pkg', behaviour[state]['subcommand']] + dry_run + accept_licenses + beadm + no_refresh + ['-q', '--'] + to_modify) response['rc'] = rc response['results'].append(out) response['msg'] += err response['changed'] = True if rc == 4: response['changed'] = False response['failed'] = False elif rc != 0: module.fail_json(**response) module.exit_json(**response) def is_installed(module, package): rc, out, err = module.run_command(['pkg', 'list', '--', package]) return not bool(int(rc)) def is_latest(module, package): rc, out, err = module.run_command(['pkg', 'list', '-u', '--', package]) return bool(int(rc)) if __name__ == '__main__': main() PK $�!\�����1 �1 J collections/ansible_collections/community/general/plugins/modules/sl_vm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: sl_vm short_description: Create or cancel a virtual instance in SoftLayer description: - Creates or cancels SoftLayer instances. - When created, optionally waits for it to be 'running'. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: instance_id: description: - Instance Id of the virtual instance to perform action option. type: str hostname: description: - Hostname to be provided to a virtual instance. type: str domain: description: - Domain name to be provided to a virtual instance. type: str datacenter: description: - Datacenter for the virtual instance to be deployed. type: str choices: - ams01 - ams03 - che01 - dal01 - dal05 - dal06 - dal09 - dal10 - dal12 - dal13 - fra02 - fra04 - fra05 - hkg02 - hou02 - lon02 - lon04 - lon06 - mel01 - mex01 - mil01 - mon01 - osl01 - par01 - sao01 - sea01 - seo01 - sjc01 - sjc03 - sjc04 - sng01 - syd01 - syd04 - tok02 - tor01 - wdc01 - wdc04 - wdc06 - wdc07 tags: description: - Tag or list of tags to be provided to a virtual instance. type: str hourly: description: - Flag to determine if the instance should be hourly billed. type: bool default: true private: description: - Flag to determine if the instance should be private only. type: bool default: false dedicated: description: - Flag to determine if the instance should be deployed in dedicated space. type: bool default: false local_disk: description: - Flag to determine if local disk should be used for the new instance. type: bool default: true cpus: description: - Count of cpus to be assigned to new virtual instance. type: int choices: [1, 2, 4, 8, 16, 32, 56] memory: description: - Amount of memory to be assigned to new virtual instance. type: int choices: [1024, 2048, 4096, 6144, 8192, 12288, 16384, 32768, 49152, 65536, 131072, 247808] flavor: description: - Specify which SoftLayer flavor template to use instead of cpus and memory. version_added: '0.2.0' type: str disks: description: - List of disk sizes to be assigned to new virtual instance. default: [ 25 ] type: list elements: int os_code: description: - OS Code to be used for new virtual instance. type: str image_id: description: - Image Template to be used for new virtual instance. type: str nic_speed: description: - NIC Speed to be assigned to new virtual instance. choices: [10, 100, 1000] type: int public_vlan: description: - VLAN by its Id to be assigned to the public NIC. type: str private_vlan: description: - VLAN by its Id to be assigned to the private NIC. type: str ssh_keys: description: - List of ssh keys by their Id to be assigned to a virtual instance. type: list elements: str default: [] post_uri: description: - URL of a post provisioning script to be loaded and executed on virtual instance. type: str state: description: - Create, or cancel a virtual instance. - Specify V(present) for create, V(absent) to cancel. choices: [ absent, present ] default: present type: str wait: description: - Flag used to wait for active status before returning. type: bool default: true wait_time: description: - Time in seconds before wait returns. default: 600 type: int requirements: - python >= 2.6 - softlayer >= 4.1.1 author: - Matt Colton (@mcltn) ''' EXAMPLES = ''' - name: Build instance hosts: localhost gather_facts: false tasks: - name: Build instance request community.general.sl_vm: hostname: instance-1 domain: anydomain.com datacenter: dal09 tags: ansible-module-test hourly: true private: false dedicated: false local_disk: true cpus: 1 memory: 1024 disks: [25] os_code: UBUNTU_LATEST wait: false - name: Build additional instances hosts: localhost gather_facts: false tasks: - name: Build instances request community.general.sl_vm: hostname: "{{ item.hostname }}" domain: "{{ item.domain }}" datacenter: "{{ item.datacenter }}" tags: "{{ item.tags }}" hourly: "{{ item.hourly }}" private: "{{ item.private }}" dedicated: "{{ item.dedicated }}" local_disk: "{{ item.local_disk }}" cpus: "{{ item.cpus }}" memory: "{{ item.memory }}" disks: "{{ item.disks }}" os_code: "{{ item.os_code }}" ssh_keys: "{{ item.ssh_keys }}" wait: "{{ item.wait }}" with_items: - hostname: instance-2 domain: anydomain.com datacenter: dal09 tags: - ansible-module-test - ansible-module-test-replicas hourly: true private: false dedicated: false local_disk: true cpus: 1 memory: 1024 disks: - 25 - 100 os_code: UBUNTU_LATEST ssh_keys: [] wait: true - hostname: instance-3 domain: anydomain.com datacenter: dal09 tags: - ansible-module-test - ansible-module-test-replicas hourly: true private: false dedicated: false local_disk: true cpus: 1 memory: 1024 disks: - 25 - 100 os_code: UBUNTU_LATEST ssh_keys: [] wait: true - name: Cancel instances hosts: localhost gather_facts: false tasks: - name: Cancel by tag community.general.sl_vm: state: absent tags: ansible-module-test ''' # TODO: Disabled RETURN as it is breaking the build for docs. Needs to be fixed. RETURN = '''# ''' import json import time try: import SoftLayer from SoftLayer import VSManager HAS_SL = True vsManager = VSManager(SoftLayer.create_client_from_env()) except ImportError: HAS_SL = False from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import string_types # TODO: get this info from API STATES = ['present', 'absent'] DATACENTERS = ['ams01', 'ams03', 'che01', 'dal01', 'dal05', 'dal06', 'dal09', 'dal10', 'dal12', 'dal13', 'fra02', 'fra04', 'fra05', 'hkg02', 'hou02', 'lon02', 'lon04', 'lon06', 'mel01', 'mex01', 'mil01', 'mon01', 'osl01', 'par01', 'sao01', 'sea01', 'seo01', 'sjc01', 'sjc03', 'sjc04', 'sng01', 'syd01', 'syd04', 'tok02', 'tor01', 'wdc01', 'wdc04', 'wdc06', 'wdc07'] CPU_SIZES = [1, 2, 4, 8, 16, 32, 56] MEMORY_SIZES = [1024, 2048, 4096, 6144, 8192, 12288, 16384, 32768, 49152, 65536, 131072, 247808] INITIALDISK_SIZES = [25, 100] LOCALDISK_SIZES = [25, 100, 150, 200, 300] SANDISK_SIZES = [10, 20, 25, 30, 40, 50, 75, 100, 125, 150, 175, 200, 250, 300, 350, 400, 500, 750, 1000, 1500, 2000] NIC_SPEEDS = [10, 100, 1000] def create_virtual_instance(module): instances = vsManager.list_instances( hostname=module.params.get('hostname'), domain=module.params.get('domain'), datacenter=module.params.get('datacenter') ) if instances: return False, None # Check if OS or Image Template is provided (Can't be both, defaults to OS) if (module.params.get('os_code') is not None and module.params.get('os_code') != ''): module.params['image_id'] = '' elif (module.params.get('image_id') is not None and module.params.get('image_id') != ''): module.params['os_code'] = '' module.params['disks'] = [] # Blank out disks since it will use the template else: return False, None tags = module.params.get('tags') if isinstance(tags, list): tags = ','.join(map(str, module.params.get('tags'))) instance = vsManager.create_instance( hostname=module.params.get('hostname'), domain=module.params.get('domain'), cpus=module.params.get('cpus'), memory=module.params.get('memory'), flavor=module.params.get('flavor'), hourly=module.params.get('hourly'), datacenter=module.params.get('datacenter'), os_code=module.params.get('os_code'), image_id=module.params.get('image_id'), local_disk=module.params.get('local_disk'), disks=module.params.get('disks'), ssh_keys=module.params.get('ssh_keys'), nic_speed=module.params.get('nic_speed'), private=module.params.get('private'), public_vlan=module.params.get('public_vlan'), private_vlan=module.params.get('private_vlan'), dedicated=module.params.get('dedicated'), post_uri=module.params.get('post_uri'), tags=tags, ) if instance is not None and instance['id'] > 0: return True, instance else: return False, None def wait_for_instance(module, id): instance = None completed = False wait_timeout = time.time() + module.params.get('wait_time') while not completed and wait_timeout > time.time(): try: completed = vsManager.wait_for_ready(id, 10, 2) if completed: instance = vsManager.get_instance(id) except Exception: completed = False return completed, instance def cancel_instance(module): canceled = True if module.params.get('instance_id') is None and (module.params.get('tags') or module.params.get('hostname') or module.params.get('domain')): tags = module.params.get('tags') if isinstance(tags, string_types): tags = [module.params.get('tags')] instances = vsManager.list_instances(tags=tags, hostname=module.params.get('hostname'), domain=module.params.get('domain')) for instance in instances: try: vsManager.cancel_instance(instance['id']) except Exception: canceled = False elif module.params.get('instance_id') and module.params.get('instance_id') != 0: try: vsManager.cancel_instance(instance['id']) except Exception: canceled = False else: return False, None return canceled, None def main(): module = AnsibleModule( argument_spec=dict( instance_id=dict(type='str'), hostname=dict(type='str'), domain=dict(type='str'), datacenter=dict(type='str', choices=DATACENTERS), tags=dict(type='str'), hourly=dict(type='bool', default=True), private=dict(type='bool', default=False), dedicated=dict(type='bool', default=False), local_disk=dict(type='bool', default=True), cpus=dict(type='int', choices=CPU_SIZES), memory=dict(type='int', choices=MEMORY_SIZES), flavor=dict(type='str'), disks=dict(type='list', elements='int', default=[25]), os_code=dict(type='str'), image_id=dict(type='str'), nic_speed=dict(type='int', choices=NIC_SPEEDS), public_vlan=dict(type='str'), private_vlan=dict(type='str'), ssh_keys=dict(type='list', elements='str', default=[], no_log=False), post_uri=dict(type='str'), state=dict(type='str', default='present', choices=STATES), wait=dict(type='bool', default=True), wait_time=dict(type='int', default=600), ) ) if not HAS_SL: module.fail_json(msg='softlayer python library required for this module') if module.params.get('state') == 'absent': (changed, instance) = cancel_instance(module) elif module.params.get('state') == 'present': (changed, instance) = create_virtual_instance(module) if module.params.get('wait') is True and instance: (changed, instance) = wait_for_instance(module, instance['id']) module.exit_json(changed=changed, instance=json.loads(json.dumps(instance, default=lambda o: o.__dict__))) if __name__ == '__main__': main() PK $�!\�C�b b J collections/ansible_collections/community/general/plugins/modules/vmadm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Jasper Lievisse Adriaanse <j@jasper.la> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: vmadm short_description: Manage SmartOS virtual machines and zones description: - Manage SmartOS virtual machines through vmadm(1M). author: Jasper Lievisse Adriaanse (@jasperla) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: archive_on_delete: required: false description: - When enabled, the zone dataset will be mounted on C(/zones/archive) upon removal. type: bool autoboot: required: false description: - Whether or not a VM is booted when the system is rebooted. type: bool brand: choices: [ joyent, joyent-minimal, lx, kvm, bhyve ] default: joyent description: - Type of virtual machine. The V(bhyve) option was added in community.general 0.2.0. type: str boot: required: false description: - Set the boot order for KVM VMs. type: str cpu_cap: required: false description: - Sets a limit on the amount of CPU time that can be used by a VM. Use V(0) for no cap. type: int cpu_shares: required: false description: - Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other VMs on the system. type: int cpu_type: required: false choices: [ qemu64, host ] default: qemu64 description: - Control the type of virtual CPU exposed to KVM VMs. type: str customer_metadata: required: false description: - Metadata to be set and associated with this VM, this contain customer modifiable keys. type: dict delegate_dataset: required: false description: - Whether to delegate a ZFS dataset to an OS VM. type: bool disk_driver: required: false description: - Default value for a virtual disk model for KVM guests. type: str disks: required: false description: - A list of disks to add, valid properties are documented in vmadm(1M). type: list elements: dict dns_domain: required: false description: - Domain value for C(/etc/hosts). type: str docker: required: false description: - Docker images need this flag enabled along with the O(brand) set to C(lx). type: bool filesystems: required: false description: - Mount additional filesystems into an OS VM. type: list elements: dict firewall_enabled: required: false description: - Enables the firewall, allowing fwadm(1M) rules to be applied. type: bool force: required: false description: - Force a particular action (i.e. stop or delete a VM). type: bool fs_allowed: required: false description: - Comma separated list of filesystem types this zone is allowed to mount. type: str hostname: required: false description: - Zone/VM hostname. type: str image_uuid: required: false description: - Image UUID. type: str indestructible_delegated: required: false description: - Adds an C(@indestructible) snapshot to delegated datasets. type: bool indestructible_zoneroot: required: false description: - Adds an C(@indestructible) snapshot to zoneroot. type: bool internal_metadata: required: false description: - Metadata to be set and associated with this VM, this contains operator generated keys. type: dict internal_metadata_namespace: required: false description: - List of namespaces to be set as C(internal_metadata-only); these namespaces will come from O(internal_metadata) rather than O(customer_metadata). type: str kernel_version: required: false description: - Kernel version to emulate for LX VMs. type: str limit_priv: required: false description: - Set (comma separated) list of privileges the zone is allowed to use. type: str maintain_resolvers: required: false description: - Resolvers in C(/etc/resolv.conf) will be updated when updating the O(resolvers) property. type: bool max_locked_memory: required: false description: - Total amount of memory (in MiBs) on the host that can be locked by this VM. type: int max_lwps: required: false description: - Maximum number of lightweight processes this VM is allowed to have running. type: int max_physical_memory: required: false description: - Maximum amount of memory (in MiBs) on the host that the VM is allowed to use. type: int max_swap: required: false description: - Maximum amount of virtual memory (in MiBs) the VM is allowed to use. type: int mdata_exec_timeout: required: false description: - Timeout in seconds (or 0 to disable) for the C(svc:/smartdc/mdata:execute) service that runs user-scripts in the zone. type: int name: required: false aliases: [ alias ] description: - Name of the VM. vmadm(1M) uses this as an optional name. type: str nic_driver: required: false description: - Default value for a virtual NIC model for KVM guests. type: str nics: required: false description: - A list of nics to add, valid properties are documented in vmadm(1M). type: list elements: dict nowait: required: false description: - Consider the provisioning complete when the VM first starts, rather than when the VM has rebooted. type: bool qemu_opts: required: false description: - Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only be used for debugging. type: str qemu_extra_opts: required: false description: - Additional qemu cmdline arguments for KVM guests. type: str quota: required: false description: - Quota on zone filesystems (in MiBs). type: int ram: required: false description: - Amount of virtual RAM for a KVM guest (in MiBs). type: int resolvers: required: false description: - List of resolvers to be put into C(/etc/resolv.conf). type: list elements: str routes: required: false description: - Dictionary that maps destinations to gateways, these will be set as static routes in the VM. type: dict spice_opts: required: false description: - Addition options for SPICE-enabled KVM VMs. type: str spice_password: required: false description: - Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global Zone. type: str state: choices: [ present, running, absent, deleted, stopped, created, restarted, rebooted ] default: running description: - States for the VM to be in. Please note that V(present), V(stopped) and V(restarted) operate on a VM that is currently provisioned. V(present) means that the VM will be created if it was absent, and that it will be in a running state. V(absent) will shutdown the zone before removing it. V(stopped) means the zone will be created if it does not exist already, before shutting it down. type: str tmpfs: required: false description: - Amount of memory (in MiBs) that will be available in the VM for the C(/tmp) filesystem. type: int uuid: required: false description: - UUID of the VM. Can either be a full UUID or V(*) for all VMs. type: str vcpus: required: false description: - Number of virtual CPUs for a KVM guest. type: int vga: required: false description: - Specify VGA emulation used by KVM VMs. type: str virtio_txburst: required: false description: - Number of packets that can be sent in a single flush of the tx queue of virtio NICs. type: int virtio_txtimer: required: false description: - Timeout (in nanoseconds) for the TX timer of virtio NICs. type: int vnc_password: required: false description: - Password required to connect to VNC. By default no password is set. Please note this can be read from the Global Zone. type: str vnc_port: required: false description: - TCP port to listen of the VNC server. Or set V(0) for random, or V(-1) to disable. type: int zfs_data_compression: required: false description: - Specifies compression algorithm used for this VMs data dataset. This option only has effect on delegated datasets. type: str zfs_data_recsize: required: false description: - Suggested block size (power of 2) for files in the delegated dataset's filesystem. type: int zfs_filesystem_limit: required: false description: - Maximum number of filesystems the VM can have. type: int zfs_io_priority: required: false description: - IO throttle priority value relative to other VMs. type: int zfs_root_compression: required: false description: - Specifies compression algorithm used for this VMs root dataset. This option only has effect on the zoneroot dataset. type: str zfs_root_recsize: required: false description: - Suggested block size (power of 2) for files in the zoneroot dataset's filesystem. type: int zfs_snapshot_limit: required: false description: - Number of snapshots the VM can have. type: int zpool: required: false description: - ZFS pool the VM's zone dataset will be created in. type: str requirements: - python >= 2.6 ''' EXAMPLES = ''' - name: Create SmartOS zone community.general.vmadm: brand: joyent state: present alias: fw_zone image_uuid: 95f265b8-96b2-11e6-9597-972f3af4b6d5 firewall_enabled: true indestructible_zoneroot: true nics: - nic_tag: admin ip: dhcp primary: true internal_metadata: root_pw: 'secret' quota: 1 - name: Delete a zone community.general.vmadm: alias: test_zone state: deleted - name: Stop all zones community.general.vmadm: uuid: '*' state: stopped ''' RETURN = ''' uuid: description: UUID of the managed VM. returned: always type: str sample: 'b217ab0b-cf57-efd8-cd85-958d0b80be33' alias: description: Alias of the managed VM. returned: When addressing a VM by alias. type: str sample: 'dns-zone' state: description: State of the target, after execution. returned: success type: str sample: 'running' ''' import json import os import re import tempfile import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native # While vmadm(1M) supports a -E option to return any errors in JSON, the # generated JSON does not play well with the JSON parsers of Python. # The returned message contains '\n' as part of the stacktrace, # which breaks the parsers. def get_vm_prop(module, uuid, prop): # Lookup a property for the given VM. # Returns the property, or None if not found. cmd = [module.vmadm, 'lookup', '-j', '-o', prop, 'uuid={0}'.format(uuid)] (rc, stdout, stderr) = module.run_command(cmd) if rc != 0: module.fail_json( msg='Could not perform lookup of {0} on {1}'.format(prop, uuid), exception=stderr) try: stdout_json = json.loads(stdout) except Exception as e: module.fail_json( msg='Invalid JSON returned by vmadm for uuid lookup of {0}'.format(prop), details=to_native(e), exception=traceback.format_exc()) if stdout_json: return stdout_json[0].get(prop) def get_vm_uuid(module, alias): # Lookup the uuid that goes with the given alias. # Returns the uuid or '' if not found. cmd = [module.vmadm, 'lookup', '-j', '-o', 'uuid', 'alias={0}'.format(alias)] (rc, stdout, stderr) = module.run_command(cmd) if rc != 0: module.fail_json( msg='Could not retrieve UUID of {0}'.format(alias), exception=stderr) # If no VM was found matching the given alias, we get back an empty array. # That is not an error condition as we might be explicitly checking it's # absence. try: stdout_json = json.loads(stdout) except Exception as e: module.fail_json( msg='Invalid JSON returned by vmadm for uuid lookup of {0}'.format(alias), details=to_native(e), exception=traceback.format_exc()) if stdout_json: return stdout_json[0].get('uuid') def get_all_vm_uuids(module): # Retrieve the UUIDs for all VMs. cmd = [module.vmadm, 'lookup', '-j', '-o', 'uuid'] (rc, stdout, stderr) = module.run_command(cmd) if rc != 0: module.fail_json(msg='Failed to get VMs list', exception=stderr) try: stdout_json = json.loads(stdout) return [v['uuid'] for v in stdout_json] except Exception as e: module.fail_json(msg='Could not retrieve VM UUIDs', details=to_native(e), exception=traceback.format_exc()) def new_vm(module, uuid, vm_state): payload_file = create_payload(module, uuid) (rc, dummy, stderr) = vmadm_create_vm(module, payload_file) if rc != 0: changed = False module.fail_json(msg='Could not create VM', exception=stderr) else: changed = True # 'vmadm create' returns all output to stderr... match = re.match('Successfully created VM (.*)', stderr) if match: vm_uuid = match.groups()[0] if not is_valid_uuid(vm_uuid): module.fail_json(msg='Invalid UUID for VM {0}?'.format(vm_uuid)) else: module.fail_json(msg='Could not retrieve UUID of newly created(?) VM') # Now that the VM is created, ensure it is in the desired state (if not 'running') if vm_state != 'running': ret = set_vm_state(module, vm_uuid, vm_state) if not ret: module.fail_json(msg='Could not set VM {0} to state {1}'.format(vm_uuid, vm_state)) try: os.unlink(payload_file) except Exception as e: # Since the payload may contain sensitive information, fail hard # if we cannot remove the file so the operator knows about it. module.fail_json(msg='Could not remove temporary JSON payload file {0}: {1}'.format(payload_file, to_native(e)), exception=traceback.format_exc()) return changed, vm_uuid def vmadm_create_vm(module, payload_file): # Create a new VM using the provided payload. cmd = [module.vmadm, 'create', '-f', payload_file] return module.run_command(cmd) def set_vm_state(module, vm_uuid, vm_state): p = module.params # Check if the VM is already in the desired state. state = get_vm_prop(module, vm_uuid, 'state') if state and (state == vm_state): return None # Lookup table for the state to be in, and which command to use for that. # vm_state: [vmadm commandm, forceable?] cmds = { 'stopped': ['stop', True], 'running': ['start', False], 'deleted': ['delete', True], 'rebooted': ['reboot', False] } command, forceable = cmds[vm_state] force = ['-F'] if p['force'] and forceable else [] cmd = [module.vmadm, command] + force + [vm_uuid] (dummy, dummy, stderr) = module.run_command(cmd) match = re.match('^Successfully.*', stderr) return match is not None def create_payload(module, uuid): # Create the JSON payload (vmdef) and return the filename. # Filter out the few options that are not valid VM properties. module_options = ['force', 'state'] # @TODO make this a simple {} comprehension as soon as py2 is ditched # @TODO {k: v for k, v in p.items() if k not in module_options} vmdef = dict([(k, v) for k, v in module.params.items() if k not in module_options and v]) try: vmdef_json = json.dumps(vmdef) except Exception as e: module.fail_json( msg='Could not create valid JSON payload', exception=traceback.format_exc()) # Create the temporary file that contains our payload, and set tight # permissions for it may container sensitive information. try: # XXX: When there's a way to get the current ansible temporary directory # drop the mkstemp call and rely on ANSIBLE_KEEP_REMOTE_FILES to retain # the payload (thus removing the `save_payload` option). fname = tempfile.mkstemp()[1] os.chmod(fname, 0o400) with open(fname, 'w') as fh: fh.write(vmdef_json) except Exception as e: module.fail_json(msg='Could not save JSON payload: %s' % to_native(e), exception=traceback.format_exc()) return fname def vm_state_transition(module, uuid, vm_state): ret = set_vm_state(module, uuid, vm_state) # Whether the VM changed state. if ret is None: return False elif ret: return True else: module.fail_json(msg='Failed to set VM {0} to state {1}'.format(uuid, vm_state)) def is_valid_uuid(uuid): return re.match('^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$', uuid, re.IGNORECASE) is not None def validate_uuids(module): failed = [ name for name, pvalue in [(x, module.params[x]) for x in ['uuid', 'image_uuid']] if pvalue and pvalue != '*' and not is_valid_uuid(pvalue) ] if failed: module.fail_json(msg='No valid UUID(s) found for: {0}'.format(", ".join(failed))) def manage_all_vms(module, vm_state): # Handle operations for all VMs, which can by definition only # be state transitions. state = module.params['state'] if state == 'created': module.fail_json(msg='State "created" is only valid for tasks with a single VM') # If any of the VMs has a change, the task as a whole has a change. any_changed = False # First get all VM uuids and for each check their state, and adjust it if needed. for uuid in get_all_vm_uuids(module): current_vm_state = get_vm_prop(module, uuid, 'state') if not current_vm_state and vm_state == 'deleted': any_changed = False else: if module.check_mode: if (not current_vm_state) or (get_vm_prop(module, uuid, 'state') != state): any_changed = True else: any_changed = vm_state_transition(module, uuid, vm_state) or any_changed return any_changed def main(): # In order to reduce the clutter and boilerplate for trivial options, # abstract the vmadm properties and build the dict of arguments later. # Dict of all options that are simple to define based on their type. # They're not required and have a default of None. properties = { 'str': [ 'boot', 'disk_driver', 'dns_domain', 'fs_allowed', 'hostname', 'image_uuid', 'internal_metadata_namespace', 'kernel_version', 'limit_priv', 'nic_driver', 'qemu_opts', 'qemu_extra_opts', 'spice_opts', 'uuid', 'vga', 'zfs_data_compression', 'zfs_root_compression', 'zpool' ], 'bool': [ 'archive_on_delete', 'autoboot', 'delegate_dataset', 'docker', 'firewall_enabled', 'force', 'indestructible_delegated', 'indestructible_zoneroot', 'maintain_resolvers', 'nowait' ], 'int': [ 'cpu_cap', 'cpu_shares', 'max_locked_memory', 'max_lwps', 'max_physical_memory', 'max_swap', 'mdata_exec_timeout', 'quota', 'ram', 'tmpfs', 'vcpus', 'virtio_txburst', 'virtio_txtimer', 'vnc_port', 'zfs_data_recsize', 'zfs_filesystem_limit', 'zfs_io_priority', 'zfs_root_recsize', 'zfs_snapshot_limit' ], 'dict': ['customer_metadata', 'internal_metadata', 'routes'], } # Start with the options that are not as trivial as those above. options = dict( state=dict( default='running', type='str', choices=['present', 'running', 'absent', 'deleted', 'stopped', 'created', 'restarted', 'rebooted'] ), name=dict( type='str', aliases=['alias'] ), brand=dict( default='joyent', type='str', choices=['joyent', 'joyent-minimal', 'lx', 'kvm', 'bhyve'] ), cpu_type=dict( default='qemu64', type='str', choices=['host', 'qemu64'] ), # Regular strings, however these require additional options. spice_password=dict(type='str', no_log=True), vnc_password=dict(type='str', no_log=True), disks=dict(type='list', elements='dict'), nics=dict(type='list', elements='dict'), resolvers=dict(type='list', elements='str'), filesystems=dict(type='list', elements='dict'), ) # Add our 'simple' options to options dict. for type in properties: for p in properties[type]: option = dict(type=type) options[p] = option module = AnsibleModule( argument_spec=options, supports_check_mode=True, required_one_of=[['name', 'uuid']] ) module.vmadm = module.get_bin_path('vmadm', required=True) p = module.params uuid = p['uuid'] state = p['state'] # Translate the state parameter into something we can use later on. if state in ['present', 'running']: vm_state = 'running' elif state in ['stopped', 'created']: vm_state = 'stopped' elif state in ['absent', 'deleted']: vm_state = 'deleted' elif state in ['restarted', 'rebooted']: vm_state = 'rebooted' result = {'state': state} # While it's possible to refer to a given VM by it's `alias`, it's easier # to operate on VMs by their UUID. So if we're not given a `uuid`, look # it up. if not uuid: uuid = get_vm_uuid(module, p['name']) # Bit of a chicken and egg problem here for VMs with state == deleted. # If they're going to be removed in this play, we have to lookup the # uuid. If they're already deleted there's nothing to lookup. # So if state == deleted and get_vm_uuid() returned '', the VM is already # deleted and there's nothing else to do. if uuid is None and vm_state == 'deleted': result['name'] = p['name'] module.exit_json(**result) validate_uuids(module) if p['name']: result['name'] = p['name'] result['uuid'] = uuid if uuid == '*': result['changed'] = manage_all_vms(module, vm_state) module.exit_json(**result) # The general flow is as follows: # - first the current state of the VM is obtained by it's UUID. # - If the state was not found and the desired state is 'deleted', return. # - If the state was not found, it means the VM has to be created. # Subsequently the VM will be set to the desired state (i.e. stopped) # - Otherwise, it means the VM exists already and we operate on it's # state (i.e. reboot it.) # # In the future it should be possible to query the VM for a particular # property as a valid state (i.e. queried) so the result can be # registered. # Also, VMs should be able to get their properties updated. # Managing VM snapshots should be part of a standalone module. # First obtain the VM state to determine what needs to be done with it. current_vm_state = get_vm_prop(module, uuid, 'state') # First handle the case where the VM should be deleted and is not present. if not current_vm_state and vm_state == 'deleted': result['changed'] = False elif module.check_mode: # Shortcut for check mode, if there is no VM yet, it will need to be created. # Or, if the VM is not in the desired state yet, it needs to transition. result['changed'] = (not current_vm_state) or (get_vm_prop(module, uuid, 'state') != state) elif not current_vm_state: # No VM was found that matched the given ID (alias or uuid), so we create it. result['changed'], result['uuid'] = new_vm(module, uuid, vm_state) else: # VM was found, operate on its state directly. result['changed'] = vm_state_transition(module, uuid, vm_state) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\���� � U collections/ansible_collections/community/general/plugins/modules/ipa_sudocmdgroup.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_sudocmdgroup author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA sudo command group description: - Add, modify or delete sudo command group within IPA server using IPA API. attributes: check_mode: support: full diff_mode: support: none options: cn: description: - Sudo Command Group. aliases: ['name'] required: true type: str description: description: - Group description. type: str state: description: State to ensure. default: present choices: ['absent', 'disabled', 'enabled', 'present'] type: str sudocmd: description: - List of sudo commands to assign to the group. - If an empty list is passed all assigned commands will be removed from the group. - If option is omitted sudo commands will not be checked or changed. type: list elements: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure sudo command group exists community.general.ipa_sudocmdgroup: name: group01 description: Group of important commands sudocmd: - su ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure sudo command group does not exist community.general.ipa_sudocmdgroup: name: group01 state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' sudocmdgroup: description: Sudo command group as returned by IPA API returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class SudoCmdGroupIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(SudoCmdGroupIPAClient, self).__init__(module, host, port, protocol) def sudocmdgroup_find(self, name): return self._post_json(method='sudocmdgroup_find', name=None, item={'all': True, 'cn': name}) def sudocmdgroup_add(self, name, item): return self._post_json(method='sudocmdgroup_add', name=name, item=item) def sudocmdgroup_mod(self, name, item): return self._post_json(method='sudocmdgroup_mod', name=name, item=item) def sudocmdgroup_del(self, name): return self._post_json(method='sudocmdgroup_del', name=name) def sudocmdgroup_add_member(self, name, item): return self._post_json(method='sudocmdgroup_add_member', name=name, item=item) def sudocmdgroup_add_member_sudocmd(self, name, item): return self.sudocmdgroup_add_member(name=name, item={'sudocmd': item}) def sudocmdgroup_remove_member(self, name, item): return self._post_json(method='sudocmdgroup_remove_member', name=name, item=item) def sudocmdgroup_remove_member_sudocmd(self, name, item): return self.sudocmdgroup_remove_member(name=name, item={'sudocmd': item}) def get_sudocmdgroup_dict(description=None): data = {} if description is not None: data['description'] = description return data def get_sudocmdgroup_diff(client, ipa_sudocmdgroup, module_sudocmdgroup): return client.get_diff(ipa_data=ipa_sudocmdgroup, module_data=module_sudocmdgroup) def ensure(module, client): name = module.params['cn'] state = module.params['state'] sudocmd = module.params['sudocmd'] module_sudocmdgroup = get_sudocmdgroup_dict(description=module.params['description']) ipa_sudocmdgroup = client.sudocmdgroup_find(name=name) changed = False if state == 'present': if not ipa_sudocmdgroup: changed = True if not module.check_mode: ipa_sudocmdgroup = client.sudocmdgroup_add(name=name, item=module_sudocmdgroup) else: diff = get_sudocmdgroup_diff(client, ipa_sudocmdgroup, module_sudocmdgroup) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_sudocmdgroup.get(key) client.sudocmdgroup_mod(name=name, item=data) if sudocmd is not None: changed = client.modify_if_diff(name, ipa_sudocmdgroup.get('member_sudocmd', []), sudocmd, client.sudocmdgroup_add_member_sudocmd, client.sudocmdgroup_remove_member_sudocmd) else: if ipa_sudocmdgroup: changed = True if not module.check_mode: client.sudocmdgroup_del(name=name) return changed, client.sudocmdgroup_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), sudocmd=dict(type='list', elements='str')) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = SudoCmdGroupIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, sudocmdgroup = ensure(module, client) module.exit_json(changed=changed, sudorule=sudocmdgroup) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\�Q�g� � K collections/ansible_collections/community/general/plugins/modules/facter.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2012, Michael DeHaan <michael.dehaan@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: facter short_description: Runs the discovery program C(facter) on the remote system description: - Runs the C(facter) discovery program (U(https://github.com/puppetlabs/facter)) on the remote system, returning JSON data that can be useful for inventory purposes. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: arguments: description: - Specifies arguments for facter. type: list elements: str requirements: - facter - ruby-json author: - Ansible Core Team - Michael DeHaan ''' EXAMPLES = ''' # Example command-line invocation # ansible www.example.net -m facter - name: Execute facter no arguments community.general.facter: - name: Execute facter with arguments community.general.facter: arguments: - -p - system_uptime - timezone - is_virtual ''' import json from ansible.module_utils.basic import AnsibleModule def main(): module = AnsibleModule( argument_spec=dict( arguments=dict(required=False, type='list', elements='str') ) ) facter_path = module.get_bin_path( 'facter', opt_dirs=['/opt/puppetlabs/bin']) cmd = [facter_path, "--json"] if module.params['arguments']: cmd += module.params['arguments'] rc, out, err = module.run_command(cmd, check_rc=True) module.exit_json(**json.loads(out)) if __name__ == '__main__': main() PK $�!\��$~D D I collections/ansible_collections/community/general/plugins/modules/opkg.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Patrick Pelletier <pp.pelletier@gmail.com> # Based on pacman (Afterburn) and pkgin (Shaun Zinck) modules # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: opkg author: "Patrick Pelletier (@skinp)" short_description: Package manager for OpenWrt and Openembedded/Yocto based Linux distributions description: - Manages ipk packages for OpenWrt and Openembedded/Yocto based Linux distributions extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - Name of package(s) to install/remove. - C(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works on Yocto based Linux distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0. aliases: [pkg] required: true type: list elements: str state: description: - State of the package. choices: [ 'present', 'absent', 'installed', 'removed' ] default: present type: str force: description: - The C(opkg --force) parameter used. - Passing V("") as value and not passing any value at all have both the same effect of B(not) using any C(--force-) parameter. choices: - "" - "depends" - "maintainer" - "reinstall" - "overwrite" - "downgrade" - "space" - "postinstall" - "remove" - "checksum" - "removal-of-dependent-packages" type: str update_cache: description: - Update the package DB first. default: false type: bool executable: description: - The executable location for C(opkg). type: path version_added: 7.2.0 requirements: - opkg - python ''' EXAMPLES = ''' - name: Install foo community.general.opkg: name: foo state: present - name: Install foo in version 1.2 (opkg>=0.3.2 on Yocto based Linux distributions) community.general.opkg: name: foo=1.2 state: present - name: Update cache and install foo community.general.opkg: name: foo state: present update_cache: true - name: Remove foo community.general.opkg: name: foo state: absent - name: Remove foo and bar community.general.opkg: name: - foo - bar state: absent - name: Install foo using overwrite option forcibly community.general.opkg: name: foo state: present force: overwrite ''' import os from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper class Opkg(StateModuleHelper): module = dict( argument_spec=dict( name=dict(aliases=["pkg"], required=True, type="list", elements="str"), state=dict(default="present", choices=["present", "installed", "absent", "removed"]), force=dict(choices=["", "depends", "maintainer", "reinstall", "overwrite", "downgrade", "space", "postinstall", "remove", "checksum", "removal-of-dependent-packages"]), update_cache=dict(default=False, type='bool'), executable=dict(type="path"), ), ) def __init_module__(self): self.vars.set("install_c", 0, output=False, change=True) self.vars.set("remove_c", 0, output=False, change=True) state_map = dict( query="list-installed", present="install", installed="install", absent="remove", removed="remove", ) def _force(value): if value == "": value = None return cmd_runner_fmt.as_optval("--force-")(value, ctx_ignore_none=True) dir, cmd = os.path.split(self.vars.executable) if self.vars.executable else (None, "opkg") self.runner = CmdRunner( self.module, command=cmd, arg_formats=dict( package=cmd_runner_fmt.as_list(), state=cmd_runner_fmt.as_map(state_map), force=cmd_runner_fmt.as_func(_force), update_cache=cmd_runner_fmt.as_bool("update"), ), path_prefix=dir, ) if self.vars.update_cache: rc, dummy, dummy = self.runner("update_cache").run() if rc != 0: self.do_raise("could not update package db") @staticmethod def split_name_and_version(package): """ Split the name and the version when using the NAME=VERSION syntax """ splitted = package.split('=', 1) if len(splitted) == 1: return splitted[0], None else: return splitted[0], splitted[1] def _package_in_desired_state(self, name, want_installed, version=None): dummy, out, dummy = self.runner("state package").run(state="query", package=name) has_package = out.startswith(name + " - %s" % ("" if not version else (version + " "))) return want_installed == has_package def state_present(self): with self.runner("state force package") as ctx: for package in self.vars.name: pkg_name, pkg_version = self.split_name_and_version(package) if not self._package_in_desired_state(pkg_name, want_installed=True, version=pkg_version) or self.vars.force == "reinstall": ctx.run(package=package) if not self._package_in_desired_state(pkg_name, want_installed=True, version=pkg_version): self.do_raise("failed to install %s" % package) self.vars.install_c += 1 if self.verbosity >= 4: self.vars.run_info = ctx.run_info if self.vars.install_c > 0: self.vars.msg = "installed %s package(s)" % (self.vars.install_c) else: self.vars.msg = "package(s) already present" def state_absent(self): with self.runner("state force package") as ctx: for package in self.vars.name: package, dummy = self.split_name_and_version(package) if not self._package_in_desired_state(package, want_installed=False): ctx.run(package=package) if not self._package_in_desired_state(package, want_installed=False): self.do_raise("failed to remove %s" % package) self.vars.remove_c += 1 if self.verbosity >= 4: self.vars.run_info = ctx.run_info if self.vars.remove_c > 0: self.vars.msg = "removed %s package(s)" % (self.vars.remove_c) else: self.vars.msg = "package(s) already absent" state_installed = state_present state_removed = state_absent def main(): Opkg.execute() if __name__ == '__main__': main() PK $�!\�� -V> V> Z collections/ansible_collections/community/general/plugins/modules/gitlab_group_variable.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Florent Madiot (scodeman@scode.io) # Based on code: # Copyright (c) 2019, Markus Bergholz (markuman@gmail.com) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' module: gitlab_group_variable short_description: Creates, updates, or deletes GitLab groups variables version_added: 1.2.0 description: - Creates a group variable if it does not exist. - When a group variable does exist, its value will be updated when the values are different. - Variables which are untouched in the playbook, but are not untouched in the GitLab group, they stay untouched (O(purge=false)) or will be deleted (O(purge=true)). author: - Florent Madiot (@scodeman) requirements: - python >= 2.7 - python-gitlab python module extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - Create or delete group variable. default: present type: str choices: ["present", "absent"] group: description: - The path and name of the group. required: true type: str purge: description: - When set to V(true), delete all variables which are not untouched in the task. default: false type: bool vars: description: - When the list element is a simple key-value pair, masked, raw and protected will be set to false. - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full control about whether a value should be masked, raw, protected or both. - Support for group variables requires GitLab >= 9.5. - Support for environment_scope requires GitLab Premium >= 13.11. - Support for protected values requires GitLab >= 9.3. - Support for masked values requires GitLab >= 11.10. - Support for raw values requires GitLab >= 15.7. - A C(value) must be a string or a number. - Field C(variable_type) must be a string with either V(env_var), which is the default, or V(file). - When a value is masked, it must be in Base64 and have a length of at least 8 characters. See GitLab documentation on acceptable values for a masked variable (U(https://docs.gitlab.com/ce/ci/variables/#masked-variables)). default: {} type: dict variables: version_added: 4.5.0 description: - A list of dictionaries that represents CI/CD variables. - This modules works internal with this sructure, even if the older O(vars) parameter is used. default: [] type: list elements: dict suboptions: name: description: - The name of the variable. type: str required: true value: description: - The variable value. - Required when O(state=present). type: str masked: description: - Wether variable value is masked or not. type: bool default: false protected: description: - Wether variable value is protected or not. type: bool default: false raw: description: - Wether variable value is raw or not. - Support for raw values requires GitLab >= 15.7. type: bool default: false version_added: '7.4.0' variable_type: description: - Wether a variable is an environment variable (V(env_var)) or a file (V(file)). type: str choices: [ "env_var", "file" ] default: env_var environment_scope: description: - The scope for the variable. type: str default: '*' ''' EXAMPLES = r''' - name: Set or update some CI/CD variables community.general.gitlab_group_variable: api_url: https://gitlab.com api_token: secret_access_token group: scodeman/testgroup/ purge: false variables: - name: ACCESS_KEY_ID value: abc123 - name: SECRET_ACCESS_KEY value: 3214cbad masked: true protected: true variable_type: env_var environment_scope: production - name: Set or update some CI/CD variables with raw value community.general.gitlab_group_variable: api_url: https://gitlab.com api_token: secret_access_token group: scodeman/testgroup/ purge: false vars: ACCESS_KEY_ID: abc123 SECRET_ACCESS_KEY: value: 3214cbad masked: true protected: true raw: true variable_type: env_var environment_scope: '*' - name: Set or update some CI/CD variables with expandable value community.general.gitlab_group_variable: api_url: https://gitlab.com api_token: secret_access_token group: scodeman/testgroup/ purge: false vars: ACCESS_KEY_ID: abc123 SECRET_ACCESS_KEY: value: '$MY_OTHER_VARIABLE' masked: true protected: true raw: false variable_type: env_var environment_scope: '*' - name: Delete one variable community.general.gitlab_group_variable: api_url: https://gitlab.com api_token: secret_access_token group: scodeman/testgroup/ state: absent vars: ACCESS_KEY_ID: abc123 ''' RETURN = r''' group_variable: description: Four lists of the variablenames which were added, updated, removed or exist. returned: always type: dict contains: added: description: A list of variables which were created. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] untouched: description: A list of variables which exist. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] removed: description: A list of variables which were deleted. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] updated: description: A list of variables whose values were changed. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.api import basic_auth_argument_spec from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, gitlab_authentication, ensure_gitlab_package, filter_returned_variables, vars_to_variables ) class GitlabGroupVariables(object): def __init__(self, module, gitlab_instance): self.repo = gitlab_instance self.group = self.get_group(module.params['group']) self._module = module def get_group(self, group_name): return self.repo.groups.get(group_name) def list_all_group_variables(self): page_nb = 1 variables = [] vars_page = self.group.variables.list(page=page_nb) while len(vars_page) > 0: variables += vars_page page_nb += 1 vars_page = self.group.variables.list(page=page_nb) return variables def create_variable(self, var_obj): if self._module.check_mode: return True var = { "key": var_obj.get('key'), "value": var_obj.get('value'), "masked": var_obj.get('masked'), "protected": var_obj.get('protected'), "raw": var_obj.get('raw'), "variable_type": var_obj.get('variable_type'), } if var_obj.get('environment_scope') is not None: var["environment_scope"] = var_obj.get('environment_scope') self.group.variables.create(var) return True def update_variable(self, var_obj): if self._module.check_mode: return True self.delete_variable(var_obj) self.create_variable(var_obj) return True def delete_variable(self, var_obj): if self._module.check_mode: return True self.group.variables.delete(var_obj.get('key'), filter={'environment_scope': var_obj.get('environment_scope')}) return True def compare(requested_variables, existing_variables, state): # we need to do this, because it was determined in a previous version - more or less buggy # basically it is not necessary and might results in more/other bugs! # but it is required and only relevant for check mode!! # logic represents state 'present' when not purge. all other can be derived from that # untouched => equal in both # updated => name and scope are equal # added => name and scope does not exist untouched = list() updated = list() added = list() if state == 'present': existing_key_scope_vars = list() for item in existing_variables: existing_key_scope_vars.append({'key': item.get('key'), 'environment_scope': item.get('environment_scope')}) for var in requested_variables: if var in existing_variables: untouched.append(var) else: compare_item = {'key': var.get('name'), 'environment_scope': var.get('environment_scope')} if compare_item in existing_key_scope_vars: updated.append(var) else: added.append(var) return untouched, updated, added def native_python_main(this_gitlab, purge, requested_variables, state, module): change = False return_value = dict(added=list(), updated=list(), removed=list(), untouched=list()) gitlab_keys = this_gitlab.list_all_group_variables() before = [x.attributes for x in gitlab_keys] gitlab_keys = this_gitlab.list_all_group_variables() existing_variables = filter_returned_variables(gitlab_keys) for item in requested_variables: item['key'] = item.pop('name') item['value'] = str(item.get('value')) if item.get('protected') is None: item['protected'] = False if item.get('raw') is None: item['raw'] = False if item.get('masked') is None: item['masked'] = False if item.get('environment_scope') is None: item['environment_scope'] = '*' if item.get('variable_type') is None: item['variable_type'] = 'env_var' if module.check_mode: untouched, updated, added = compare(requested_variables, existing_variables, state) if state == 'present': add_or_update = [x for x in requested_variables if x not in existing_variables] for item in add_or_update: try: if this_gitlab.create_variable(item): return_value['added'].append(item) except Exception: if this_gitlab.update_variable(item): return_value['updated'].append(item) if purge: # refetch and filter gitlab_keys = this_gitlab.list_all_group_variables() existing_variables = filter_returned_variables(gitlab_keys) remove = [x for x in existing_variables if x not in requested_variables] for item in remove: if this_gitlab.delete_variable(item): return_value['removed'].append(item) elif state == 'absent': # value does not matter on removing variables. # key and environment scope are sufficient for item in existing_variables: item.pop('value') item.pop('variable_type') for item in requested_variables: item.pop('value') item.pop('variable_type') if not purge: remove_requested = [x for x in requested_variables if x in existing_variables] for item in remove_requested: if this_gitlab.delete_variable(item): return_value['removed'].append(item) else: for item in existing_variables: if this_gitlab.delete_variable(item): return_value['removed'].append(item) if module.check_mode: return_value = dict(added=added, updated=updated, removed=return_value['removed'], untouched=untouched) if len(return_value['added'] + return_value['removed'] + return_value['updated']) > 0: change = True gitlab_keys = this_gitlab.list_all_group_variables() after = [x.attributes for x in gitlab_keys] return change, return_value, before, after def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update( group=dict(type='str', required=True), purge=dict(type='bool', required=False, default=False), vars=dict(type='dict', required=False, default=dict(), no_log=True), # please mind whenever changing the variables dict to also change module_utils/gitlab.py's # KNOWN dict in filter_returned_variables or bad evil will happen variables=dict(type='list', elements='dict', required=False, default=list(), options=dict( name=dict(type='str', required=True), value=dict(type='str', no_log=True), masked=dict(type='bool', default=False), protected=dict(type='bool', default=False), raw=dict(type='bool', default=False), environment_scope=dict(type='str', default='*'), variable_type=dict(type='str', default='env_var', choices=["env_var", "file"]) )), state=dict(type='str', default="present", choices=["absent", "present"]), ) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ['vars', 'variables'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'] ], supports_check_mode=True ) ensure_gitlab_package(module) purge = module.params['purge'] var_list = module.params['vars'] state = module.params['state'] if var_list: variables = vars_to_variables(var_list, module) else: variables = module.params['variables'] if state == 'present': if any(x['value'] is None for x in variables): module.fail_json(msg='value parameter is required in state present') gitlab_instance = gitlab_authentication(module) this_gitlab = GitlabGroupVariables(module=module, gitlab_instance=gitlab_instance) changed, raw_return_value, before, after = native_python_main(this_gitlab, purge, variables, state, module) # postprocessing for item in after: item.pop('group_id') item['name'] = item.pop('key') for item in before: item.pop('group_id') item['name'] = item.pop('key') untouched_key_name = 'key' if not module.check_mode: untouched_key_name = 'name' raw_return_value['untouched'] = [x for x in before if x in after] added = [x.get('key') for x in raw_return_value['added']] updated = [x.get('key') for x in raw_return_value['updated']] removed = [x.get('key') for x in raw_return_value['removed']] untouched = [x.get(untouched_key_name) for x in raw_return_value['untouched']] return_value = dict(added=added, updated=updated, removed=removed, untouched=untouched) module.exit_json(changed=changed, group_variable=return_value) if __name__ == '__main__': main() PK $�!\5�.~ ~ N collections/ansible_collections/community/general/plugins/modules/syslogger.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Tim Rightnour <thegarbledone@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: syslogger short_description: Log messages in the syslog description: - Uses syslog to add log entries to the host. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: msg: type: str description: - This is the message to place in syslog. required: true priority: type: str description: - Set the log priority. choices: [ "emerg", "alert", "crit", "err", "warning", "notice", "info", "debug" ] default: "info" facility: type: str description: - Set the log facility. choices: [ "kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ] default: "daemon" log_pid: description: - Log the PID in brackets. type: bool default: false ident: description: - Specify the name of application name which is sending the log to syslog. type: str default: 'ansible_syslogger' version_added: '0.2.0' author: - Tim Rightnour (@garbled1) ''' EXAMPLES = r''' - name: Simple Usage community.general.syslogger: msg: "I will end up as daemon.info" - name: Send a log message with err priority and user facility with log_pid community.general.syslogger: msg: "Hello from Ansible" priority: "err" facility: "user" log_pid: true - name: Specify the name of application which is sending log message community.general.syslogger: ident: "MyApp" msg: "I want to believe" priority: "alert" ''' RETURN = r''' ident: description: Name of application sending the message to log returned: always type: str sample: "ansible_syslogger" version_added: '0.2.0' priority: description: Priority level returned: always type: str sample: "daemon" facility: description: Syslog facility returned: always type: str sample: "info" log_pid: description: Log PID status returned: always type: bool sample: true msg: description: Message sent to syslog returned: always type: str sample: "Hello from Ansible" ''' import syslog import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native def get_facility(facility): return { 'kern': syslog.LOG_KERN, 'user': syslog.LOG_USER, 'mail': syslog.LOG_MAIL, 'daemon': syslog.LOG_DAEMON, 'auth': syslog.LOG_AUTH, 'lpr': syslog.LOG_LPR, 'news': syslog.LOG_NEWS, 'uucp': syslog.LOG_UUCP, 'cron': syslog.LOG_CRON, 'syslog': syslog.LOG_SYSLOG, 'local0': syslog.LOG_LOCAL0, 'local1': syslog.LOG_LOCAL1, 'local2': syslog.LOG_LOCAL2, 'local3': syslog.LOG_LOCAL3, 'local4': syslog.LOG_LOCAL4, 'local5': syslog.LOG_LOCAL5, 'local6': syslog.LOG_LOCAL6, 'local7': syslog.LOG_LOCAL7 }.get(facility, syslog.LOG_DAEMON) def get_priority(priority): return { 'emerg': syslog.LOG_EMERG, 'alert': syslog.LOG_ALERT, 'crit': syslog.LOG_CRIT, 'err': syslog.LOG_ERR, 'warning': syslog.LOG_WARNING, 'notice': syslog.LOG_NOTICE, 'info': syslog.LOG_INFO, 'debug': syslog.LOG_DEBUG }.get(priority, syslog.LOG_INFO) def main(): # define the available arguments/parameters that a user can pass to # the module module_args = dict( ident=dict(type='str', default='ansible_syslogger'), msg=dict(type='str', required=True), priority=dict(type='str', required=False, choices=["emerg", "alert", "crit", "err", "warning", "notice", "info", "debug"], default='info'), facility=dict(type='str', required=False, choices=["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7"], default='daemon'), log_pid=dict(type='bool', required=False, default=False) ) module = AnsibleModule( argument_spec=module_args, ) result = dict( changed=False, ident=module.params['ident'], priority=module.params['priority'], facility=module.params['facility'], log_pid=module.params['log_pid'], msg=module.params['msg'] ) # do the logging try: syslog.openlog(module.params['ident'], syslog.LOG_PID if module.params['log_pid'] else 0, get_facility(module.params['facility'])) syslog.syslog(get_priority(module.params['priority']), module.params['msg']) syslog.closelog() result['changed'] = True except Exception as exc: module.fail_json(error='Failed to write to syslog %s' % to_native(exc), exception=traceback.format_exc(), **result) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\T Zv�' �' P collections/ansible_collections/community/general/plugins/modules/aix_devices.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, 2018 Kairo Araujo <kairo@kairo.eti.br> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- author: - Kairo Araujo (@kairoaraujo) module: aix_devices short_description: Manages AIX devices description: - This module discovers, defines, removes and modifies attributes of AIX devices. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: attributes: description: - A list of device attributes. type: dict device: description: - The name of the device. - V(all) is valid to rescan C(available) all devices (AIX cfgmgr command). type: str force: description: - Forces action. type: bool default: false recursive: description: - Removes or defines a device and children devices. type: bool default: false state: description: - Controls the device state. - V(available) (alias V(present)) rescan a specific device or all devices (when O(device) is not specified). - V(removed) (alias V(absent) removes a device. - V(defined) changes device to Defined state. type: str choices: [ available, defined, removed ] default: available ''' EXAMPLES = r''' - name: Scan new devices community.general.aix_devices: device: all state: available - name: Scan new virtual devices (vio0) community.general.aix_devices: device: vio0 state: available - name: Removing IP alias to en0 community.general.aix_devices: device: en0 attributes: delalias4: 10.0.0.100,255.255.255.0 - name: Removes ent2 community.general.aix_devices: device: ent2 state: removed - name: Put device en2 in Defined community.general.aix_devices: device: en2 state: defined - name: Removes ent4 (inexistent). community.general.aix_devices: device: ent4 state: removed - name: Put device en4 in Defined (inexistent) community.general.aix_devices: device: en4 state: defined - name: Put vscsi1 and children devices in Defined state. community.general.aix_devices: device: vscsi1 recursive: true state: defined - name: Removes vscsi1 and children devices. community.general.aix_devices: device: vscsi1 recursive: true state: removed - name: Changes en1 mtu to 9000 and disables arp. community.general.aix_devices: device: en1 attributes: mtu: 900 arp: 'off' state: available - name: Configure IP, netmask and set en1 up. community.general.aix_devices: device: en1 attributes: netaddr: 192.168.0.100 netmask: 255.255.255.0 state: up state: available - name: Adding IP alias to en0 community.general.aix_devices: device: en0 attributes: alias4: 10.0.0.100,255.255.255.0 state: available ''' RETURN = r''' # ''' from ansible.module_utils.basic import AnsibleModule def _check_device(module, device): """ Check if device already exists and the state. Args: module: Ansible module. device: device to be checked. Returns: bool, device state """ lsdev_cmd = module.get_bin_path('lsdev', True) rc, lsdev_out, err = module.run_command(["%s" % lsdev_cmd, '-C', '-l', "%s" % device]) if rc != 0: module.fail_json(msg="Failed to run lsdev", rc=rc, err=err) if lsdev_out: device_state = lsdev_out.split()[1] return True, device_state device_state = None return False, device_state def _check_device_attr(module, device, attr): """ Args: module: Ansible module. device: device to check attributes. attr: attribute to be checked. Returns: """ lsattr_cmd = module.get_bin_path('lsattr', True) rc, lsattr_out, err = module.run_command(["%s" % lsattr_cmd, '-El', "%s" % device, '-a', "%s" % attr]) hidden_attrs = ['delalias4', 'delalias6'] if rc == 255: if attr in hidden_attrs: current_param = '' else: current_param = None return current_param elif rc != 0: module.fail_json(msg="Failed to run lsattr: %s" % err, rc=rc, err=err) current_param = lsattr_out.split()[1] return current_param def discover_device(module, device): """ Discover AIX devices.""" cfgmgr_cmd = module.get_bin_path('cfgmgr', True) if device is not None: device = "-l %s" % device else: device = '' changed = True msg = '' if not module.check_mode: rc, cfgmgr_out, err = module.run_command(["%s" % cfgmgr_cmd, "%s" % device]) changed = True msg = cfgmgr_out return changed, msg def change_device_attr(module, attributes, device, force): """ Change AIX device attribute. """ attr_changed = [] attr_not_changed = [] attr_invalid = [] chdev_cmd = module.get_bin_path('chdev', True) for attr in list(attributes.keys()): new_param = attributes[attr] current_param = _check_device_attr(module, device, attr) if current_param is None: attr_invalid.append(attr) elif current_param != new_param: if force: cmd = ["%s" % chdev_cmd, '-l', "%s" % device, '-a', "%s=%s" % (attr, attributes[attr]), "%s" % force] else: cmd = ["%s" % chdev_cmd, '-l', "%s" % device, '-a', "%s=%s" % (attr, attributes[attr])] if not module.check_mode: rc, chdev_out, err = module.run_command(cmd) if rc != 0: module.exit_json(msg="Failed to run chdev.", rc=rc, err=err) attr_changed.append(attributes[attr]) else: attr_not_changed.append(attributes[attr]) if len(attr_changed) > 0: changed = True attr_changed_msg = "Attributes changed: %s. " % ','.join(attr_changed) else: changed = False attr_changed_msg = '' if len(attr_not_changed) > 0: attr_not_changed_msg = "Attributes already set: %s. " % ','.join(attr_not_changed) else: attr_not_changed_msg = '' if len(attr_invalid) > 0: attr_invalid_msg = "Invalid attributes: %s " % ', '.join(attr_invalid) else: attr_invalid_msg = '' msg = "%s%s%s" % (attr_changed_msg, attr_not_changed_msg, attr_invalid_msg) return changed, msg def remove_device(module, device, force, recursive, state): """ Puts device in defined state or removes device. """ state_opt = { 'removed': '-d', 'absent': '-d', 'defined': '' } recursive_opt = { True: '-R', False: '' } recursive = recursive_opt[recursive] state = state_opt[state] changed = True msg = '' rmdev_cmd = module.get_bin_path('rmdev', True) if not module.check_mode: if state: rc, rmdev_out, err = module.run_command(["%s" % rmdev_cmd, "-l", "%s" % device, "%s" % recursive, "%s" % force]) else: rc, rmdev_out, err = module.run_command(["%s" % rmdev_cmd, "-l", "%s" % device, "%s" % recursive]) if rc != 0: module.fail_json(msg="Failed to run rmdev", rc=rc, err=err) msg = rmdev_out return changed, msg def main(): module = AnsibleModule( argument_spec=dict( attributes=dict(type='dict'), device=dict(type='str'), force=dict(type='bool', default=False), recursive=dict(type='bool', default=False), state=dict(type='str', default='available', choices=['available', 'defined', 'removed']), ), supports_check_mode=True, ) force_opt = { True: '-f', False: '', } attributes = module.params['attributes'] device = module.params['device'] force = force_opt[module.params['force']] recursive = module.params['recursive'] state = module.params['state'] result = dict( changed=False, msg='', ) if state == 'available' or state == 'present': if attributes: # change attributes on device device_status, device_state = _check_device(module, device) if device_status: result['changed'], result['msg'] = change_device_attr(module, attributes, device, force) else: result['msg'] = "Device %s does not exist." % device else: # discovery devices (cfgmgr) if device and device != 'all': device_status, device_state = _check_device(module, device) if device_status: # run cfgmgr on specific device result['changed'], result['msg'] = discover_device(module, device) else: result['msg'] = "Device %s does not exist." % device else: result['changed'], result['msg'] = discover_device(module, device) elif state == 'removed' or state == 'absent' or state == 'defined': if not device: result['msg'] = "device is required to removed or defined state." else: # Remove device check_device, device_state = _check_device(module, device) if check_device: if state == 'defined' and device_state == 'Defined': result['changed'] = False result['msg'] = 'Device %s already in Defined' % device else: result['changed'], result['msg'] = remove_device(module, device, force, recursive, state) else: result['msg'] = "Device %s does not exist." % device else: result['msg'] = "Unexpected state %s." % state module.fail_json(**result) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\j=+$db db O collections/ansible_collections/community/general/plugins/modules/filesystem.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, quidame <quidame@poivron.org> # Copyright (c) 2013, Alexander Bulimov <lazywolf0@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- author: - Alexander Bulimov (@abulimov) - quidame (@quidame) module: filesystem short_description: Makes a filesystem description: - This module creates a filesystem. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - If O(state=present), the filesystem is created if it doesn't already exist, that is the default behaviour if O(state) is omitted. - If O(state=absent), filesystem signatures on O(dev) are wiped if it contains a filesystem (as known by C(blkid)). - When O(state=absent), all other options but O(dev) are ignored, and the module does not fail if the device O(dev) doesn't actually exist. type: str choices: [ present, absent ] default: present version_added: 1.3.0 fstype: choices: [ btrfs, ext2, ext3, ext4, ext4dev, f2fs, lvm, ocfs2, reiserfs, xfs, vfat, swap, ufs ] description: - Filesystem type to be created. This option is required with O(state=present) (or if O(state) is omitted). - ufs support has been added in community.general 3.4.0. type: str aliases: [type] dev: description: - Target path to block device (Linux) or character device (FreeBSD) or regular file (both). - When setting Linux-specific filesystem types on FreeBSD, this module only works when applying to regular files, aka disk images. - Currently V(lvm) (Linux-only) and V(ufs) (FreeBSD-only) do not support a regular file as their target O(dev). - Support for character devices on FreeBSD has been added in community.general 3.4.0. type: path required: true aliases: [device] force: description: - If V(true), allows to create new filesystem on devices that already has filesystem. type: bool default: false resizefs: description: - If V(true), if the block device and filesystem size differ, grow the filesystem into the space. - Supported for C(btrfs), C(ext2), C(ext3), C(ext4), C(ext4dev), C(f2fs), C(lvm), C(xfs), C(ufs) and C(vfat) filesystems. Attempts to resize other filesystem types will fail. - XFS Will only grow if mounted. Currently, the module is based on commands from C(util-linux) package to perform operations, so resizing of XFS is not supported on FreeBSD systems. - vFAT will likely fail if C(fatresize < 1.04). - Mutually exclusive with O(uuid). type: bool default: false opts: description: - List of options to be passed to C(mkfs) command. type: str uuid: description: - Set filesystem's UUID to the given value. - The UUID options specified in O(opts) take precedence over this value. - See xfs_admin(8) (C(xfs)), tune2fs(8) (C(ext2), C(ext3), C(ext4), C(ext4dev)) for possible values. - For O(fstype=lvm) the value is ignored, it resets the PV UUID if set. - Supported for O(fstype) being one of C(ext2), C(ext3), C(ext4), C(ext4dev), C(lvm), or C(xfs). - This is B(not idempotent). Specifying this option will always result in a change. - Mutually exclusive with O(resizefs). type: str version_added: 7.1.0 requirements: - Uses specific tools related to the O(fstype) for creating or resizing a filesystem (from packages e2fsprogs, xfsprogs, dosfstools, and so on). - Uses generic tools mostly related to the Operating System (Linux or FreeBSD) or available on both, as C(blkid). - On FreeBSD, either C(util-linux) or C(e2fsprogs) package is required. notes: - Potential filesystems on O(dev) are checked using C(blkid). In case C(blkid) is unable to detect a filesystem (and in case C(fstyp) on FreeBSD is also unable to detect a filesystem), this filesystem is overwritten even if O(force) is V(false). - On FreeBSD systems, both C(e2fsprogs) and C(util-linux) packages provide a C(blkid) command that is compatible with this module. However, these packages conflict with each other, and only the C(util-linux) package provides the command required to not fail when O(state=absent). seealso: - module: community.general.filesize - module: ansible.posix.mount - name: xfs_admin(8) manpage for Linux description: Manual page of the GNU/Linux's xfs_admin implementation link: https://man7.org/linux/man-pages/man8/xfs_admin.8.html - name: tune2fs(8) manpage for Linux description: Manual page of the GNU/Linux's tune2fs implementation link: https://man7.org/linux/man-pages/man8/tune2fs.8.html ''' EXAMPLES = ''' - name: Create a ext2 filesystem on /dev/sdb1 community.general.filesystem: fstype: ext2 dev: /dev/sdb1 - name: Create a ext4 filesystem on /dev/sdb1 and check disk blocks community.general.filesystem: fstype: ext4 dev: /dev/sdb1 opts: -cc - name: Blank filesystem signature on /dev/sdb1 community.general.filesystem: dev: /dev/sdb1 state: absent - name: Create a filesystem on top of a regular file community.general.filesystem: dev: /path/to/disk.img fstype: vfat - name: Reset an xfs filesystem UUID on /dev/sdb1 community.general.filesystem: fstype: xfs dev: /dev/sdb1 uuid: generate - name: Reset an ext4 filesystem UUID on /dev/sdb1 community.general.filesystem: fstype: ext4 dev: /dev/sdb1 uuid: random - name: Reset an LVM filesystem (PV) UUID on /dev/sdc community.general.filesystem: fstype: lvm dev: /dev/sdc uuid: random ''' import os import platform import re import stat from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.version import LooseVersion class Device(object): def __init__(self, module, path): self.module = module self.path = path def size(self): """ Return size in bytes of device. Returns int """ statinfo = os.stat(self.path) if stat.S_ISBLK(statinfo.st_mode): blockdev_cmd = self.module.get_bin_path("blockdev", required=True) dummy, out, dummy = self.module.run_command([blockdev_cmd, "--getsize64", self.path], check_rc=True) devsize_in_bytes = int(out) elif stat.S_ISCHR(statinfo.st_mode) and platform.system() == 'FreeBSD': diskinfo_cmd = self.module.get_bin_path("diskinfo", required=True) dummy, out, dummy = self.module.run_command([diskinfo_cmd, self.path], check_rc=True) devsize_in_bytes = int(out.split()[2]) elif os.path.isfile(self.path): devsize_in_bytes = os.path.getsize(self.path) else: self.module.fail_json(changed=False, msg="Target device not supported: %s" % self) return devsize_in_bytes def get_mountpoint(self): """Return (first) mountpoint of device. Returns None when not mounted.""" cmd_findmnt = self.module.get_bin_path("findmnt", required=True) # find mountpoint rc, mountpoint, dummy = self.module.run_command([cmd_findmnt, "--mtab", "--noheadings", "--output", "TARGET", "--source", self.path], check_rc=False) if rc != 0: mountpoint = None else: mountpoint = mountpoint.split('\n')[0] return mountpoint def __str__(self): return self.path class Filesystem(object): MKFS = None MKFS_FORCE_FLAGS = [] MKFS_SET_UUID_OPTIONS = None MKFS_SET_UUID_EXTRA_OPTIONS = [] INFO = None GROW = None GROW_MAX_SPACE_FLAGS = [] GROW_MOUNTPOINT_ONLY = False CHANGE_UUID = None CHANGE_UUID_OPTION = None CHANGE_UUID_OPTION_HAS_ARG = True LANG_ENV = {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'} def __init__(self, module): self.module = module @property def fstype(self): return type(self).__name__ def get_fs_size(self, dev): """Return size in bytes of filesystem on device (integer). Should query the info with a per-fstype command that can access the device whenever it is mounted or not, and parse the command output. Parser must ensure to return an integer, or raise a ValueError. """ raise NotImplementedError() def create(self, opts, dev, uuid=None): if self.module.check_mode: return if uuid and self.MKFS_SET_UUID_OPTIONS: if not (set(self.MKFS_SET_UUID_OPTIONS) & set(opts)): opts += [self.MKFS_SET_UUID_OPTIONS[0], uuid] + self.MKFS_SET_UUID_EXTRA_OPTIONS mkfs = self.module.get_bin_path(self.MKFS, required=True) cmd = [mkfs] + self.MKFS_FORCE_FLAGS + opts + [str(dev)] self.module.run_command(cmd, check_rc=True) if uuid and self.CHANGE_UUID and self.MKFS_SET_UUID_OPTIONS is None: self.change_uuid(new_uuid=uuid, dev=dev) def wipefs(self, dev): if self.module.check_mode: return # wipefs comes with util-linux package (as 'blockdev' & 'findmnt' above) # that is ported to FreeBSD. The use of dd as a portable fallback is # not doable here if it needs get_mountpoint() (to prevent corruption of # a mounted filesystem), since 'findmnt' is not available on FreeBSD, # even in util-linux port for this OS. wipefs = self.module.get_bin_path('wipefs', required=True) cmd = [wipefs, "--all", str(dev)] self.module.run_command(cmd, check_rc=True) def grow_cmd(self, target): """Build and return the resizefs commandline as list.""" cmdline = [self.module.get_bin_path(self.GROW, required=True)] cmdline += self.GROW_MAX_SPACE_FLAGS + [target] return cmdline def grow(self, dev): """Get dev and fs size and compare. Returns stdout of used command.""" devsize_in_bytes = dev.size() try: fssize_in_bytes = self.get_fs_size(dev) except NotImplementedError: self.module.fail_json(msg="module does not support resizing %s filesystem yet" % self.fstype) except ValueError as err: self.module.warn("unable to process %s output '%s'" % (self.INFO, to_native(err))) self.module.fail_json(msg="unable to process %s output for %s" % (self.INFO, dev)) if not fssize_in_bytes < devsize_in_bytes: self.module.exit_json(changed=False, msg="%s filesystem is using the whole device %s" % (self.fstype, dev)) elif self.module.check_mode: self.module.exit_json(changed=True, msg="resizing filesystem %s on device %s" % (self.fstype, dev)) if self.GROW_MOUNTPOINT_ONLY: mountpoint = dev.get_mountpoint() if not mountpoint: self.module.fail_json(msg="%s needs to be mounted for %s operations" % (dev, self.fstype)) grow_target = mountpoint else: grow_target = str(dev) dummy, out, dummy = self.module.run_command(self.grow_cmd(grow_target), check_rc=True) return out def change_uuid_cmd(self, new_uuid, target): """Build and return the UUID change command line as list.""" cmdline = [self.module.get_bin_path(self.CHANGE_UUID, required=True)] if self.CHANGE_UUID_OPTION_HAS_ARG: cmdline += [self.CHANGE_UUID_OPTION, new_uuid, target] else: cmdline += [self.CHANGE_UUID_OPTION, target] return cmdline def change_uuid(self, new_uuid, dev): """Change filesystem UUID. Returns stdout of used command""" if self.module.check_mode: self.module.exit_json(change=True, msg='Changing %s filesystem UUID on device %s' % (self.fstype, dev)) dummy, out, dummy = self.module.run_command(self.change_uuid_cmd(new_uuid=new_uuid, target=str(dev)), check_rc=True) return out class Ext(Filesystem): MKFS_FORCE_FLAGS = ['-F'] MKFS_SET_UUID_OPTIONS = ['-U'] INFO = 'tune2fs' GROW = 'resize2fs' CHANGE_UUID = 'tune2fs' CHANGE_UUID_OPTION = "-U" def get_fs_size(self, dev): """Get Block count and Block size and return their product.""" cmd = self.module.get_bin_path(self.INFO, required=True) dummy, out, dummy = self.module.run_command([cmd, '-l', str(dev)], check_rc=True, environ_update=self.LANG_ENV) block_count = block_size = None for line in out.splitlines(): if 'Block count:' in line: block_count = int(line.split(':')[1].strip()) elif 'Block size:' in line: block_size = int(line.split(':')[1].strip()) if None not in (block_size, block_count): break else: raise ValueError(repr(out)) return block_size * block_count class Ext2(Ext): MKFS = 'mkfs.ext2' class Ext3(Ext): MKFS = 'mkfs.ext3' class Ext4(Ext): MKFS = 'mkfs.ext4' class XFS(Filesystem): MKFS = 'mkfs.xfs' MKFS_FORCE_FLAGS = ['-f'] INFO = 'xfs_info' GROW = 'xfs_growfs' GROW_MOUNTPOINT_ONLY = True CHANGE_UUID = "xfs_admin" CHANGE_UUID_OPTION = "-U" def get_fs_size(self, dev): """Get bsize and blocks and return their product.""" cmdline = [self.module.get_bin_path(self.INFO, required=True)] # Depending on the versions, xfs_info is able to get info from the # device, whenever it is mounted or not, or only if unmounted, or # only if mounted, or not at all. For any version until now, it is # able to query info from the mountpoint. So try it first, and use # device as the last resort: it may or may not work. mountpoint = dev.get_mountpoint() if mountpoint: cmdline += [mountpoint] else: cmdline += [str(dev)] dummy, out, dummy = self.module.run_command(cmdline, check_rc=True, environ_update=self.LANG_ENV) block_size = block_count = None for line in out.splitlines(): col = line.split('=') if col[0].strip() == 'data': if col[1].strip() == 'bsize': block_size = int(col[2].split()[0]) if col[2].split()[1] == 'blocks': block_count = int(col[3].split(',')[0]) if None not in (block_size, block_count): break else: raise ValueError(repr(out)) return block_size * block_count class Reiserfs(Filesystem): MKFS = 'mkfs.reiserfs' MKFS_FORCE_FLAGS = ['-q'] class Btrfs(Filesystem): MKFS = 'mkfs.btrfs' INFO = 'btrfs' GROW = 'btrfs' GROW_MAX_SPACE_FLAGS = ['filesystem', 'resize', 'max'] GROW_MOUNTPOINT_ONLY = True def __init__(self, module): super(Btrfs, self).__init__(module) mkfs = self.module.get_bin_path(self.MKFS, required=True) dummy, stdout, stderr = self.module.run_command([mkfs, '--version'], check_rc=True) match = re.search(r" v([0-9.]+)", stdout) if not match: # v0.20-rc1 use stderr match = re.search(r" v([0-9.]+)", stderr) if match: # v0.20-rc1 doesn't have --force parameter added in following version v3.12 if LooseVersion(match.group(1)) >= LooseVersion('3.12'): self.MKFS_FORCE_FLAGS = ['-f'] else: # assume version is greater or equal to 3.12 self.MKFS_FORCE_FLAGS = ['-f'] self.module.warn('Unable to identify mkfs.btrfs version (%r, %r)' % (stdout, stderr)) def get_fs_size(self, dev): """Return size in bytes of filesystem on device (integer).""" mountpoint = dev.get_mountpoint() if not mountpoint: self.module.fail_json(msg="%s needs to be mounted for %s operations" % (dev, self.fstype)) dummy, stdout, dummy = self.module.run_command([self.module.get_bin_path(self.INFO), 'filesystem', 'usage', '-b', mountpoint], check_rc=True) for line in stdout.splitlines(): if "Device size" in line: return int(line.split()[-1]) raise ValueError(repr(stdout)) class Ocfs2(Filesystem): MKFS = 'mkfs.ocfs2' MKFS_FORCE_FLAGS = ['-Fx'] class F2fs(Filesystem): MKFS = 'mkfs.f2fs' INFO = 'dump.f2fs' GROW = 'resize.f2fs' def __init__(self, module): super(F2fs, self).__init__(module) mkfs = self.module.get_bin_path(self.MKFS, required=True) dummy, out, dummy = self.module.run_command([mkfs, os.devnull], check_rc=False, environ_update=self.LANG_ENV) # Looking for " F2FS-tools: mkfs.f2fs Ver: 1.10.0 (2018-01-30)" # mkfs.f2fs displays version since v1.2.0 match = re.search(r"F2FS-tools: mkfs.f2fs Ver: ([0-9.]+) \(", out) if match is not None: # Since 1.9.0, mkfs.f2fs check overwrite before make filesystem # before that version -f switch wasn't used if LooseVersion(match.group(1)) >= LooseVersion('1.9.0'): self.MKFS_FORCE_FLAGS = ['-f'] def get_fs_size(self, dev): """Get sector size and total FS sectors and return their product.""" cmd = self.module.get_bin_path(self.INFO, required=True) dummy, out, dummy = self.module.run_command([cmd, str(dev)], check_rc=True, environ_update=self.LANG_ENV) sector_size = sector_count = None for line in out.splitlines(): if 'Info: sector size = ' in line: # expected: 'Info: sector size = 512' sector_size = int(line.split()[4]) elif 'Info: total FS sectors = ' in line: # expected: 'Info: total FS sectors = 102400 (50 MB)' sector_count = int(line.split()[5]) if None not in (sector_size, sector_count): break else: raise ValueError(repr(out)) return sector_size * sector_count class VFAT(Filesystem): INFO = 'fatresize' GROW = 'fatresize' GROW_MAX_SPACE_FLAGS = ['-s', 'max'] def __init__(self, module): super(VFAT, self).__init__(module) if platform.system() == 'FreeBSD': self.MKFS = 'newfs_msdos' else: self.MKFS = 'mkfs.vfat' def get_fs_size(self, dev): """Get and return size of filesystem, in bytes.""" cmd = self.module.get_bin_path(self.INFO, required=True) dummy, out, dummy = self.module.run_command([cmd, '--info', str(dev)], check_rc=True, environ_update=self.LANG_ENV) fssize = None for line in out.splitlines()[1:]: parts = line.split(':', 1) if len(parts) < 2: continue param, value = parts if param.strip() in ('Size', 'Cur size'): fssize = int(value.strip()) break else: raise ValueError(repr(out)) return fssize class LVM(Filesystem): MKFS = 'pvcreate' MKFS_FORCE_FLAGS = ['-f'] MKFS_SET_UUID_OPTIONS = ['-u', '--uuid'] MKFS_SET_UUID_EXTRA_OPTIONS = ['--norestorefile'] INFO = 'pvs' GROW = 'pvresize' CHANGE_UUID = 'pvchange' CHANGE_UUID_OPTION = '-u' CHANGE_UUID_OPTION_HAS_ARG = False def get_fs_size(self, dev): """Get and return PV size, in bytes.""" cmd = self.module.get_bin_path(self.INFO, required=True) dummy, size, dummy = self.module.run_command([cmd, '--noheadings', '-o', 'pv_size', '--units', 'b', '--nosuffix', str(dev)], check_rc=True) pv_size = int(size) return pv_size class Swap(Filesystem): MKFS = 'mkswap' MKFS_FORCE_FLAGS = ['-f'] class UFS(Filesystem): MKFS = 'newfs' INFO = 'dumpfs' GROW = 'growfs' GROW_MAX_SPACE_FLAGS = ['-y'] def get_fs_size(self, dev): """Get providersize and fragment size and return their product.""" cmd = self.module.get_bin_path(self.INFO, required=True) dummy, out, dummy = self.module.run_command([cmd, str(dev)], check_rc=True, environ_update=self.LANG_ENV) fragmentsize = providersize = None for line in out.splitlines(): if line.startswith('fsize'): fragmentsize = int(line.split()[1]) elif 'providersize' in line: providersize = int(line.split()[-1]) if None not in (fragmentsize, providersize): break else: raise ValueError(repr(out)) return fragmentsize * providersize FILESYSTEMS = { 'ext2': Ext2, 'ext3': Ext3, 'ext4': Ext4, 'ext4dev': Ext4, 'f2fs': F2fs, 'reiserfs': Reiserfs, 'xfs': XFS, 'btrfs': Btrfs, 'vfat': VFAT, 'ocfs2': Ocfs2, 'LVM2_member': LVM, 'swap': Swap, 'ufs': UFS, } def main(): friendly_names = { 'lvm': 'LVM2_member', } fstypes = set(FILESYSTEMS.keys()) - set(friendly_names.values()) | set(friendly_names.keys()) # There is no "single command" to manipulate filesystems, so we map them all out and their options module = AnsibleModule( argument_spec=dict( state=dict(type='str', default='present', choices=['present', 'absent']), fstype=dict(type='str', aliases=['type'], choices=list(fstypes)), dev=dict(type='path', required=True, aliases=['device']), opts=dict(type='str'), force=dict(type='bool', default=False), resizefs=dict(type='bool', default=False), uuid=dict(type='str', required=False), ), required_if=[ ('state', 'present', ['fstype']) ], mutually_exclusive=[ ('resizefs', 'uuid'), ], supports_check_mode=True, ) state = module.params['state'] dev = module.params['dev'] fstype = module.params['fstype'] opts = module.params['opts'] force = module.params['force'] resizefs = module.params['resizefs'] uuid = module.params['uuid'] mkfs_opts = [] if opts is not None: mkfs_opts = opts.split() changed = False if not os.path.exists(dev): msg = "Device %s not found." % dev if state == "present": module.fail_json(msg=msg) else: module.exit_json(msg=msg) dev = Device(module, dev) # In case blkid/fstyp isn't able to identify an existing filesystem, device # is considered as empty, then this existing filesystem would be overwritten # even if force isn't enabled. cmd = module.get_bin_path('blkid', required=True) rc, raw_fs, err = module.run_command([cmd, '-c', os.devnull, '-o', 'value', '-s', 'TYPE', str(dev)]) fs = raw_fs.strip() if not fs and platform.system() == 'FreeBSD': cmd = module.get_bin_path('fstyp', required=True) rc, raw_fs, err = module.run_command([cmd, str(dev)]) fs = raw_fs.strip() if state == "present": if fstype in friendly_names: fstype = friendly_names[fstype] try: klass = FILESYSTEMS[fstype] except KeyError: module.fail_json(changed=False, msg="module does not support this filesystem (%s) yet." % fstype) filesystem = klass(module) if uuid and not (filesystem.CHANGE_UUID or filesystem.MKFS_SET_UUID_OPTIONS): module.fail_json(changed=False, msg="module does not support UUID option for this filesystem (%s) yet." % fstype) same_fs = fs and FILESYSTEMS.get(fs) == FILESYSTEMS[fstype] if same_fs and not resizefs and not uuid and not force: module.exit_json(changed=False) elif same_fs: if resizefs: if not filesystem.GROW: module.fail_json(changed=False, msg="module does not support resizing %s filesystem yet." % fstype) out = filesystem.grow(dev) module.exit_json(changed=True, msg=out) elif uuid: out = filesystem.change_uuid(new_uuid=uuid, dev=dev) module.exit_json(changed=True, msg=out) elif fs and not force: module.fail_json(msg="'%s' is already used as %s, use force=true to overwrite" % (dev, fs), rc=rc, err=err) # create fs filesystem.create(opts=mkfs_opts, dev=dev, uuid=uuid) changed = True elif fs: # wipe fs signatures filesystem = Filesystem(module) filesystem.wipefs(dev) changed = True module.exit_json(changed=changed) if __name__ == '__main__': main() PK $�!\GH�- - U collections/ansible_collections/community/general/plugins/modules/wdc_redfish_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2022 Western Digital Corporation # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: wdc_redfish_info short_description: Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs version_added: 5.4.0 description: - Builds Redfish URIs locally and sends them to remote OOB controllers to get information back. extends_documentation_fragment: - community.general.attributes - community.general.attributes.info_module options: category: required: true description: - Category to execute on OOB controller. type: str command: required: true description: - List of commands to execute on OOB controller. type: list elements: str baseuri: description: - Base URI of OOB controller. Must include this or O(ioms). type: str ioms: description: - List of IOM FQDNs for the enclosure. Must include this or O(baseuri). type: list elements: str username: description: - User for authentication with OOB controller. type: str password: description: - Password for authentication with OOB controller. type: str auth_token: description: - Security token for authentication with OOB controller. type: str timeout: description: - Timeout in seconds for URL requests to OOB controller. default: 10 type: int notes: - In the inventory, you can specify baseuri or ioms. See the EXAMPLES section. - ioms is a list of FQDNs for the enclosure's IOMs. author: Mike Moerk (@mikemoerk) ''' EXAMPLES = ''' - name: Get Simple Update Status with individual IOMs specified community.general.wdc_redfish_info: category: Update command: SimpleUpdateStatus ioms: - iom1.wdc.com - iom2.wdc.com username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}" - name: Get Simple Update Status with baseuri specified community.general.wdc_redfish_info: category: Update command: SimpleUpdateStatus baseuri: "iom1.wdc.com" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}" ''' RETURN = ''' Description: description: Firmware update status description. returned: always type: str sample: Ready for FW update ErrorCode: description: Numeric error code for firmware update status. Non-zero indicates an error condition. returned: always type: int sample: 0 EstimatedRemainingMinutes: description: Estimated number of minutes remaining in firmware update operation. returned: always type: int sample: 20 StatusCode: description: Firmware update status code. returned: always type: int sample: 2 ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.wdc_redfish_utils import WdcRedfishUtils CATEGORY_COMMANDS_ALL = { "Update": ["SimpleUpdateStatus"] } def main(): result = {} module = AnsibleModule( argument_spec=dict( category=dict(required=True), command=dict(required=True, type='list', elements='str'), ioms=dict(type='list', elements='str'), baseuri=dict(), username=dict(), password=dict(no_log=True), auth_token=dict(no_log=True), timeout=dict(type='int', default=10) ), required_together=[ ('username', 'password'), ], required_one_of=[ ('username', 'auth_token'), ('baseuri', 'ioms') ], mutually_exclusive=[ ('username', 'auth_token'), ], supports_check_mode=True ) category = module.params['category'] command_list = module.params['command'] # admin credentials used for authentication creds = {'user': module.params['username'], 'pswd': module.params['password'], 'token': module.params['auth_token']} # timeout timeout = module.params['timeout'] # Check that Category is valid if category not in CATEGORY_COMMANDS_ALL: module.fail_json(msg=to_native("Invalid Category '%s'. Valid Categories = %s" % (category, sorted(CATEGORY_COMMANDS_ALL.keys())))) # Check that all commands are valid for cmd in command_list: # Fail if even one command given is invalid if cmd not in CATEGORY_COMMANDS_ALL[category]: module.fail_json(msg=to_native("Invalid Command '%s'. Valid Commands = %s" % (cmd, CATEGORY_COMMANDS_ALL[category]))) # Build root URI(s) if module.params.get("baseuri") is not None: root_uris = ["https://" + module.params['baseuri']] else: root_uris = [ "https://" + iom for iom in module.params['ioms'] ] rf_utils = WdcRedfishUtils(creds, root_uris, timeout, module, resource_id=None, data_modification=False ) # Organize by Categories / Commands if category == "Update": # execute only if we find UpdateService resources resource = rf_utils._find_updateservice_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "SimpleUpdateStatus": simple_update_status_result = rf_utils.get_simple_update_status() if simple_update_status_result['ret'] is False: module.fail_json(msg=to_native(result['msg'])) else: del simple_update_status_result['ret'] result["simple_update_status"] = simple_update_status_result module.exit_json(changed=False, redfish_facts=result) if __name__ == '__main__': main() PK $�!\N=.�K1 K1 S collections/ansible_collections/community/general/plugins/modules/consul_session.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Steve Gargan <steve.gargan@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: consul_session short_description: Manipulate consul sessions description: - Allows the addition, modification and deletion of sessions in a consul cluster. These sessions can then be used in conjunction with key value pairs to implement distributed locks. In depth documentation for working with sessions can be found at http://www.consul.io/docs/internals/sessions.html requirements: - requests author: - Steve Gargan (@sgargan) - Håkon Lerring (@Hakon) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: id: description: - ID of the session, required when O(state) is either V(info) or V(remove). type: str state: description: - Whether the session should be present i.e. created if it doesn't exist, or absent, removed if present. If created, the O(id) for the session is returned in the output. If V(absent), O(id) is required to remove the session. Info for a single session, all the sessions for a node or all available sessions can be retrieved by specifying V(info), V(node) or V(list) for the O(state); for V(node) or V(info), the node O(name) or session O(id) is required as parameter. choices: [ absent, info, list, node, present ] type: str default: present name: description: - The name that should be associated with the session. Required when O(state=node) is used. type: str delay: description: - The optional lock delay that can be attached to the session when it is created. Locks for invalidated sessions ar blocked from being acquired until this delay has expired. Durations are in seconds. type: int default: 15 node: description: - The name of the node that with which the session will be associated. by default this is the name of the agent. type: str datacenter: description: - The name of the datacenter in which the session exists or should be created. type: str checks: description: - Checks that will be used to verify the session health. If all the checks fail, the session will be invalidated and any locks associated with the session will be release and can be acquired once the associated lock delay has expired. type: list elements: str host: description: - The host of the consul agent defaults to localhost. type: str default: localhost port: description: - The port on which the consul agent is running. type: int default: 8500 scheme: description: - The protocol scheme on which the consul agent is running. type: str default: http validate_certs: description: - Whether to verify the TLS certificate of the consul agent. type: bool default: true behavior: description: - The optional behavior that can be attached to the session when it is created. This controls the behavior when a session is invalidated. choices: [ delete, release ] type: str default: release ttl: description: - Specifies the duration of a session in seconds (between 10 and 86400). type: int version_added: 5.4.0 token: description: - The token key identifying an ACL rule set that controls access to the key value pair. type: str version_added: 5.6.0 ''' EXAMPLES = ''' - name: Register basic session with consul community.general.consul_session: name: session1 - name: Register a session with an existing check community.general.consul_session: name: session_with_check checks: - existing_check_name - name: Register a session with lock_delay community.general.consul_session: name: session_with_delay delay: 20s - name: Retrieve info about session by id community.general.consul_session: id: session_id state: info - name: Retrieve active sessions community.general.consul_session: state: list - name: Register session with a ttl community.general.consul_session: name: session-with-ttl ttl: 600 # sec ''' from ansible.module_utils.basic import AnsibleModule try: import requests from requests.exceptions import ConnectionError has_requests = True except ImportError: has_requests = False def execute(module): state = module.params.get('state') if state in ['info', 'list', 'node']: lookup_sessions(module) elif state == 'present': update_session(module) else: remove_session(module) class RequestError(Exception): pass def handle_consul_response_error(response): if 400 <= response.status_code < 600: raise RequestError('%d %s' % (response.status_code, response.content)) def get_consul_url(module): return '%s://%s:%s/v1' % (module.params.get('scheme'), module.params.get('host'), module.params.get('port')) def get_auth_headers(module): if 'token' in module.params and module.params.get('token') is not None: return {'X-Consul-Token': module.params.get('token')} else: return {} def list_sessions(module, datacenter): url = '%s/session/list' % get_consul_url(module) headers = get_auth_headers(module) response = requests.get( url, headers=headers, params={ 'dc': datacenter}, verify=module.params.get('validate_certs')) handle_consul_response_error(response) return response.json() def list_sessions_for_node(module, node, datacenter): url = '%s/session/node/%s' % (get_consul_url(module), node) headers = get_auth_headers(module) response = requests.get( url, headers=headers, params={ 'dc': datacenter}, verify=module.params.get('validate_certs')) handle_consul_response_error(response) return response.json() def get_session_info(module, session_id, datacenter): url = '%s/session/info/%s' % (get_consul_url(module), session_id) headers = get_auth_headers(module) response = requests.get( url, headers=headers, params={ 'dc': datacenter}, verify=module.params.get('validate_certs')) handle_consul_response_error(response) return response.json() def lookup_sessions(module): datacenter = module.params.get('datacenter') state = module.params.get('state') try: if state == 'list': sessions_list = list_sessions(module, datacenter) # Ditch the index, this can be grabbed from the results if sessions_list and len(sessions_list) >= 2: sessions_list = sessions_list[1] module.exit_json(changed=True, sessions=sessions_list) elif state == 'node': node = module.params.get('node') sessions = list_sessions_for_node(module, node, datacenter) module.exit_json(changed=True, node=node, sessions=sessions) elif state == 'info': session_id = module.params.get('id') session_by_id = get_session_info(module, session_id, datacenter) module.exit_json(changed=True, session_id=session_id, sessions=session_by_id) except Exception as e: module.fail_json(msg="Could not retrieve session info %s" % e) def create_session(module, name, behavior, ttl, node, lock_delay, datacenter, checks): url = '%s/session/create' % get_consul_url(module) headers = get_auth_headers(module) create_data = { "LockDelay": lock_delay, "Node": node, "Name": name, "Checks": checks, "Behavior": behavior, } if ttl is not None: create_data["TTL"] = "%ss" % str(ttl) # TTL is in seconds response = requests.put( url, headers=headers, params={ 'dc': datacenter}, json=create_data, verify=module.params.get('validate_certs')) handle_consul_response_error(response) create_session_response_dict = response.json() return create_session_response_dict["ID"] def update_session(module): name = module.params.get('name') delay = module.params.get('delay') checks = module.params.get('checks') datacenter = module.params.get('datacenter') node = module.params.get('node') behavior = module.params.get('behavior') ttl = module.params.get('ttl') try: session = create_session(module, name=name, behavior=behavior, ttl=ttl, node=node, lock_delay=delay, datacenter=datacenter, checks=checks ) module.exit_json(changed=True, session_id=session, name=name, behavior=behavior, ttl=ttl, delay=delay, checks=checks, node=node) except Exception as e: module.fail_json(msg="Could not create/update session %s" % e) def destroy_session(module, session_id): url = '%s/session/destroy/%s' % (get_consul_url(module), session_id) headers = get_auth_headers(module) response = requests.put( url, headers=headers, verify=module.params.get('validate_certs')) handle_consul_response_error(response) return response.content == "true" def remove_session(module): session_id = module.params.get('id') try: destroy_session(module, session_id) module.exit_json(changed=True, session_id=session_id) except Exception as e: module.fail_json(msg="Could not remove session with id '%s' %s" % ( session_id, e)) def test_dependencies(module): if not has_requests: raise ImportError( "requests required for this module. See https://pypi.org/project/requests/") def main(): argument_spec = dict( checks=dict(type='list', elements='str'), delay=dict(type='int', default='15'), behavior=dict( type='str', default='release', choices=[ 'release', 'delete']), ttl=dict(type='int'), host=dict(type='str', default='localhost'), port=dict(type='int', default=8500), scheme=dict(type='str', default='http'), validate_certs=dict(type='bool', default=True), id=dict(type='str'), name=dict(type='str'), node=dict(type='str'), state=dict( type='str', default='present', choices=[ 'absent', 'info', 'list', 'node', 'present']), datacenter=dict(type='str'), token=dict(type='str', no_log=True), ) module = AnsibleModule( argument_spec=argument_spec, required_if=[ ('state', 'node', ['name']), ('state', 'info', ['id']), ('state', 'remove', ['id']), ], supports_check_mode=False ) test_dependencies(module) try: execute(module) except ConnectionError as e: module.fail_json(msg='Could not connect to consul agent at %s:%s, error was %s' % ( module.params.get('host'), module.params.get('port'), e)) except Exception as e: module.fail_json(msg=str(e)) if __name__ == '__main__': main() PK $�!\�+tW�� �� K collections/ansible_collections/community/general/plugins/modules/nagios.pynu �[��� # -*- coding: utf-8 -*- # # This file is largely copied from the Nagios module included in the # Func project. Original copyright follows: # # func-nagios - Schedule downtime and enables/disable notifications # Copyright 2011, Red Hat, Inc. # Tim Bielawa <tbielawa@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: nagios short_description: Perform common tasks in Nagios related to downtime and notifications description: - "The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts." - The C(nagios) module is not idempotent. - All actions require the O(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on. - You can specify multiple services at once by separating them with commas, .e.g. O(services=httpd,nfs,puppet). - When specifying what service to handle there is a special service value, O(host), which will handle alerts/downtime/acknowledge for the I(host itself), for example O(services=host). This keyword may not be given with other services at the same time. B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.) To schedule downtime for all services on particular host use keyword "all", for example O(services=all). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: action: description: - Action to take. - servicegroup options were added in 2.0. - delete_downtime options were added in 2.2. - The V(acknowledge) and V(forced_check) actions were added in community.general 1.2.0. required: true choices: [ "downtime", "delete_downtime", "enable_alerts", "disable_alerts", "silence", "unsilence", "silence_nagios", "unsilence_nagios", "command", "servicegroup_service_downtime", "servicegroup_host_downtime", "acknowledge", "forced_check" ] type: str host: description: - Host to operate on in Nagios. type: str cmdfile: description: - Path to the nagios I(command file) (FIFO pipe). Only required if auto-detection fails. type: str author: description: - Author to leave downtime comments as. Only used when O(action) is V(downtime) or V(acknowledge). type: str default: Ansible comment: description: - Comment when O(action) is V(downtime) or V(acknowledge). type: str default: Scheduling downtime start: description: - When downtime should start, in C(time_t) format (epoch seconds). version_added: '0.2.0' type: str minutes: description: - Minutes to schedule downtime for. - Only usable with O(action=downtime). type: int default: 30 services: description: - What to manage downtime/alerts for. Separate multiple services with commas. - "B(Required) option when O(action) is one of: V(downtime), V(acknowledge), V(forced_check), V(enable_alerts), V(disable_alerts)." aliases: [ "service" ] type: str servicegroup: description: - The Servicegroup we want to set downtimes/alerts for. - B(Required) option when using the V(servicegroup_service_downtime) and V(servicegroup_host_downtime) O(action). type: str command: description: - The raw command to send to nagios, which should not include the submitted time header or the line-feed. - B(Required) option when using the V(command) O(action). type: str author: "Tim Bielawa (@tbielawa)" ''' EXAMPLES = ''' - name: Set 30 minutes of apache downtime community.general.nagios: action: downtime minutes: 30 service: httpd host: '{{ inventory_hostname }}' - name: Schedule an hour of HOST downtime community.general.nagios: action: downtime minutes: 60 service: host host: '{{ inventory_hostname }}' - name: Schedule an hour of HOST downtime starting at 2019-04-23T02:00:00+00:00 community.general.nagios: action: downtime start: 1555984800 minutes: 60 service: host host: '{{ inventory_hostname }}' - name: Schedule an hour of HOST downtime, with a comment describing the reason community.general.nagios: action: downtime minutes: 60 service: host host: '{{ inventory_hostname }}' comment: Rebuilding machine - name: Schedule downtime for ALL services on HOST community.general.nagios: action: downtime minutes: 45 service: all host: '{{ inventory_hostname }}' - name: Schedule downtime for a few services community.general.nagios: action: downtime services: frob,foobar,qeuz host: '{{ inventory_hostname }}' - name: Set 30 minutes downtime for all services in servicegroup foo community.general.nagios: action: servicegroup_service_downtime minutes: 30 servicegroup: foo host: '{{ inventory_hostname }}' - name: Set 30 minutes downtime for all host in servicegroup foo community.general.nagios: action: servicegroup_host_downtime minutes: 30 servicegroup: foo host: '{{ inventory_hostname }}' - name: Delete all downtime for a given host community.general.nagios: action: delete_downtime host: '{{ inventory_hostname }}' service: all - name: Delete all downtime for HOST with a particular comment community.general.nagios: action: delete_downtime host: '{{ inventory_hostname }}' service: host comment: Planned maintenance - name: Acknowledge an HOST with a particular comment community.general.nagios: action: acknowledge service: host host: '{{ inventory_hostname }}' comment: 'power outage - see casenr 12345' - name: Acknowledge an active service problem for the httpd service with a particular comment community.general.nagios: action: acknowledge service: httpd host: '{{ inventory_hostname }}' comment: 'service crashed - see casenr 12345' - name: Reset a passive service check for snmp trap community.general.nagios: action: forced_check service: snmp host: '{{ inventory_hostname }}' - name: Force an active service check for the httpd service community.general.nagios: action: forced_check service: httpd host: '{{ inventory_hostname }}' - name: Force an active service check for all services of a particular host community.general.nagios: action: forced_check service: all host: '{{ inventory_hostname }}' - name: Force an active service check for a particular host community.general.nagios: action: forced_check service: host host: '{{ inventory_hostname }}' - name: Enable SMART disk alerts community.general.nagios: action: enable_alerts service: smart host: '{{ inventory_hostname }}' - name: Disable httpd and nfs alerts community.general.nagios: action: disable_alerts service: httpd,nfs host: '{{ inventory_hostname }}' - name: Disable HOST alerts community.general.nagios: action: disable_alerts service: host host: '{{ inventory_hostname }}' - name: Silence ALL alerts community.general.nagios: action: silence host: '{{ inventory_hostname }}' - name: Unsilence all alerts community.general.nagios: action: unsilence host: '{{ inventory_hostname }}' - name: Shut up nagios community.general.nagios: action: silence_nagios - name: Annoy me negios community.general.nagios: action: unsilence_nagios - name: Command something community.general.nagios: action: command command: DISABLE_FAILURE_PREDICTION ''' import time import os.path import stat from ansible.module_utils.basic import AnsibleModule def which_cmdfile(): locations = [ # rhel '/etc/nagios/nagios.cfg', # debian '/etc/nagios3/nagios.cfg', # older debian '/etc/nagios2/nagios.cfg', # bsd, solaris '/usr/local/etc/nagios/nagios.cfg', # groundwork it monitoring '/usr/local/groundwork/nagios/etc/nagios.cfg', # open monitoring distribution '/omd/sites/oppy/tmp/nagios/nagios.cfg', # ??? '/usr/local/nagios/etc/nagios.cfg', '/usr/local/nagios/nagios.cfg', '/opt/nagios/etc/nagios.cfg', '/opt/nagios/nagios.cfg', # icinga on debian/ubuntu '/etc/icinga/icinga.cfg', # icinga installed from source (default location) '/usr/local/icinga/etc/icinga.cfg', ] for path in locations: if os.path.exists(path): for line in open(path): if line.startswith('command_file'): return line.split('=')[1].strip() return None def main(): ACTION_CHOICES = [ 'downtime', 'delete_downtime', 'silence', 'unsilence', 'enable_alerts', 'disable_alerts', 'silence_nagios', 'unsilence_nagios', 'command', 'servicegroup_host_downtime', 'servicegroup_service_downtime', 'acknowledge', 'forced_check', ] module = AnsibleModule( argument_spec=dict( action=dict(type='str', required=True, choices=ACTION_CHOICES), author=dict(type='str', default='Ansible'), comment=dict(type='str', default='Scheduling downtime'), host=dict(type='str'), servicegroup=dict(type='str'), start=dict(type='str'), minutes=dict(type='int', default=30), cmdfile=dict(type='str', default=which_cmdfile()), services=dict(type='str', aliases=['service']), command=dict(type='str'), ), required_if=[ ('action', 'downtime', ['host', 'services']), ('action', 'delete_downtime', ['host', 'services']), ('action', 'silence', ['host']), ('action', 'unsilence', ['host']), ('action', 'enable_alerts', ['host', 'services']), ('action', 'disable_alerts', ['host', 'services']), ('action', 'command', ['command']), ('action', 'servicegroup_host_downtime', ['host', 'servicegroup']), ('action', 'servicegroup_service_downtime', ['host', 'servicegroup']), ('action', 'acknowledge', ['host', 'services']), ('action', 'forced_check', ['host', 'services']), ], ) if not module.params['cmdfile']: module.fail_json(msg='unable to locate nagios.cfg') ansible_nagios = Nagios(module, **module.params) if module.check_mode: module.exit_json(changed=True) else: ansible_nagios.act() class Nagios(object): """ Perform common tasks in Nagios related to downtime and notifications. The complete set of external commands Nagios handles is documented on their website: http://old.nagios.org/developerinfo/externalcommands/commandlist.php Note that in the case of `schedule_svc_downtime`, `enable_svc_notifications`, and `disable_svc_notifications`, the service argument should be passed as a list. """ def __init__(self, module, **kwargs): self.module = module self.action = kwargs['action'] self.author = kwargs['author'] self.comment = kwargs['comment'] self.host = kwargs['host'] self.servicegroup = kwargs['servicegroup'] if kwargs['start'] is not None: self.start = int(kwargs['start']) else: self.start = None self.minutes = kwargs['minutes'] self.cmdfile = kwargs['cmdfile'] self.command = kwargs['command'] if (kwargs['services'] is None) or (kwargs['services'] == 'host') or (kwargs['services'] == 'all'): self.services = kwargs['services'] else: self.services = kwargs['services'].split(',') self.command_results = [] def _now(self): """ The time in seconds since 12:00:00AM Jan 1, 1970 """ return int(time.time()) def _write_command(self, cmd): """ Write the given command to the Nagios command file """ if not os.path.exists(self.cmdfile): self.module.fail_json(msg='nagios command file does not exist', cmdfile=self.cmdfile) if not stat.S_ISFIFO(os.stat(self.cmdfile).st_mode): self.module.fail_json(msg='nagios command file is not a fifo file', cmdfile=self.cmdfile) try: with open(self.cmdfile, 'w') as fp: fp.write(cmd) fp.flush() self.command_results.append(cmd.strip()) except IOError: self.module.fail_json(msg='unable to write to nagios command file', cmdfile=self.cmdfile) def _fmt_dt_str(self, cmd, host, duration, author=None, comment=None, start=None, svc=None, fixed=1, trigger=0): """ Format an external-command downtime string. cmd - Nagios command ID host - Host schedule downtime on duration - Minutes to schedule downtime for author - Name to file the downtime as comment - Reason for running this command (upgrade, reboot, etc) start - Start of downtime in seconds since 12:00AM Jan 1 1970 Default is to use the entry time (now) svc - Service to schedule downtime for, omit when for host downtime fixed - Start now if 1, start when a problem is detected if 0 trigger - Optional ID of event to start downtime from. Leave as 0 for fixed downtime. Syntax: [submitted] COMMAND;<host_name>;[<service_description>] <start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>; <comment> """ entry_time = self._now() if start is None: start = entry_time hdr = "[%s] %s;%s;" % (entry_time, cmd, host) duration_s = (duration * 60) end = start + duration_s if not author: author = self.author if not comment: comment = self.comment if svc is not None: dt_args = [svc, str(start), str(end), str(fixed), str(trigger), str(duration_s), author, comment] else: # Downtime for a host if no svc specified dt_args = [str(start), str(end), str(fixed), str(trigger), str(duration_s), author, comment] dt_arg_str = ";".join(dt_args) dt_str = hdr + dt_arg_str + "\n" return dt_str def _fmt_ack_str(self, cmd, host, author=None, comment=None, svc=None, sticky=0, notify=1, persistent=0): """ Format an external-command acknowledge string. cmd - Nagios command ID host - Host schedule downtime on author - Name to file the downtime as comment - Reason for running this command (upgrade, reboot, etc) svc - Service to schedule downtime for, omit when for host downtime sticky - the acknowledgement will remain until the host returns to an UP state if set to 1 notify - a notification will be sent out to contacts persistent - survive across restarts of the Nagios process Syntax: [submitted] COMMAND;<host_name>;[<service_description>] <sticky>;<notify>;<persistent>;<author>;<comment> """ entry_time = self._now() hdr = "[%s] %s;%s;" % (entry_time, cmd, host) if not author: author = self.author if not comment: comment = self.comment if svc is not None: ack_args = [svc, str(sticky), str(notify), str(persistent), author, comment] else: # Downtime for a host if no svc specified ack_args = [str(sticky), str(notify), str(persistent), author, comment] ack_arg_str = ";".join(ack_args) ack_str = hdr + ack_arg_str + "\n" return ack_str def _fmt_dt_del_str(self, cmd, host, svc=None, start=None, comment=None): """ Format an external-command downtime deletion string. cmd - Nagios command ID host - Host to remove scheduled downtime from comment - Reason downtime was added (upgrade, reboot, etc) start - Start of downtime in seconds since 12:00AM Jan 1 1970 svc - Service to remove downtime for, omit to remove all downtime for the host Syntax: [submitted] COMMAND;<host_name>; [<service_desription>];[<start_time>];[<comment>] """ entry_time = self._now() hdr = "[%s] %s;%s;" % (entry_time, cmd, host) if comment is None: comment = self.comment dt_del_args = [] if svc is not None: dt_del_args.append(svc) else: dt_del_args.append('') if start is not None: dt_del_args.append(str(start)) else: dt_del_args.append('') if comment is not None: dt_del_args.append(comment) else: dt_del_args.append('') dt_del_arg_str = ";".join(dt_del_args) dt_del_str = hdr + dt_del_arg_str + "\n" return dt_del_str def _fmt_chk_str(self, cmd, host, svc=None, start=None): """ Format an external-command forced host or service check string. cmd - Nagios command ID host - Host to check service from svc - Service to check start - check time Syntax: [submitted] COMMAND;<host_name>;[<service_description>];<check_time> """ entry_time = self._now() hdr = "[%s] %s;%s;" % (entry_time, cmd, host) if start is None: start = entry_time + 3 if svc is None: chk_args = [str(start)] else: chk_args = [svc, str(start)] chk_arg_str = ";".join(chk_args) chk_str = hdr + chk_arg_str + "\n" return chk_str def _fmt_notif_str(self, cmd, host=None, svc=None): """ Format an external-command notification string. cmd - Nagios command ID. host - Host to en/disable notifications on.. A value is not required for global downtime svc - Service to schedule downtime for. A value is not required for host downtime. Syntax: [submitted] COMMAND;<host_name>[;<service_description>] """ entry_time = self._now() notif_str = "[%s] %s" % (entry_time, cmd) if host is not None: notif_str += ";%s" % host if svc is not None: notif_str += ";%s" % svc notif_str += "\n" return notif_str def schedule_svc_downtime(self, host, services=None, minutes=30, start=None): """ This command is used to schedule downtime for a particular service. During the specified downtime, Nagios will not send notifications out about the service. Syntax: SCHEDULE_SVC_DOWNTIME;<host_name>;<service_description> <start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>; <comment> """ cmd = "SCHEDULE_SVC_DOWNTIME" if services is None: services = [] for service in services: dt_cmd_str = self._fmt_dt_str(cmd, host, minutes, start=start, svc=service) self._write_command(dt_cmd_str) def schedule_host_downtime(self, host, minutes=30, start=None): """ This command is used to schedule downtime for a particular host. During the specified downtime, Nagios will not send notifications out about the host. Syntax: SCHEDULE_HOST_DOWNTIME;<host_name>;<start_time>;<end_time>; <fixed>;<trigger_id>;<duration>;<author>;<comment> """ cmd = "SCHEDULE_HOST_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, host, minutes, start=start) self._write_command(dt_cmd_str) def acknowledge_svc_problem(self, host, services=None): """ This command is used to acknowledge a particular service problem. By acknowledging the current problem, future notifications for the same servicestate are disabled Syntax: ACKNOWLEDGE_SVC_PROBLEM;<host_name>;<service_description>; <sticky>;<notify>;<persistent>;<author>;<comment> """ cmd = "ACKNOWLEDGE_SVC_PROBLEM" if services is None: services = [] for service in services: ack_cmd_str = self._fmt_ack_str(cmd, host, svc=service) self._write_command(ack_cmd_str) def acknowledge_host_problem(self, host): """ This command is used to acknowledge a particular host problem. By acknowledging the current problem, future notifications for the same servicestate are disabled Syntax: ACKNOWLEDGE_HOST_PROBLEM;<host_name>;<sticky>;<notify>; <persistent>;<author>;<comment> """ cmd = "ACKNOWLEDGE_HOST_PROBLEM" ack_cmd_str = self._fmt_ack_str(cmd, host) self._write_command(ack_cmd_str) def schedule_forced_host_check(self, host): """ This command schedules a forced active check for a particular host. Syntax: SCHEDULE_FORCED_HOST_CHECK;<host_name>;<check_time> """ cmd = "SCHEDULE_FORCED_HOST_CHECK" chk_cmd_str = self._fmt_chk_str(cmd, host, svc=None) self._write_command(chk_cmd_str) def schedule_forced_host_svc_check(self, host): """ This command schedules a forced active check for all services associated with a particular host. Syntax: SCHEDULE_FORCED_HOST_SVC_CHECKS;<host_name>;<check_time> """ cmd = "SCHEDULE_FORCED_HOST_SVC_CHECKS" chk_cmd_str = self._fmt_chk_str(cmd, host, svc=None) self._write_command(chk_cmd_str) def schedule_forced_svc_check(self, host, services=None): """ This command schedules a forced active check for a particular service. Syntax: SCHEDULE_FORCED_SVC_CHECK;<host_name>;<service_description>;<check_time> """ cmd = "SCHEDULE_FORCED_SVC_CHECK" if services is None: services = [] for service in services: chk_cmd_str = self._fmt_chk_str(cmd, host, svc=service) self._write_command(chk_cmd_str) def schedule_host_svc_downtime(self, host, minutes=30, start=None): """ This command is used to schedule downtime for all services associated with a particular host. During the specified downtime, Nagios will not send notifications out about the host. SCHEDULE_HOST_SVC_DOWNTIME;<host_name>;<start_time>;<end_time>; <fixed>;<trigger_id>;<duration>;<author>;<comment> """ cmd = "SCHEDULE_HOST_SVC_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, host, minutes, start=start) self._write_command(dt_cmd_str) def delete_host_downtime(self, host, services=None, comment=None): """ This command is used to remove scheduled downtime for a particular host. Syntax: DEL_DOWNTIME_BY_HOST_NAME;<host_name>; [<service_desription>];[<start_time>];[<comment>] """ cmd = "DEL_DOWNTIME_BY_HOST_NAME" if services is None: dt_del_cmd_str = self._fmt_dt_del_str(cmd, host, comment=comment) self._write_command(dt_del_cmd_str) else: for service in services: dt_del_cmd_str = self._fmt_dt_del_str(cmd, host, svc=service, comment=comment) self._write_command(dt_del_cmd_str) def schedule_hostgroup_host_downtime(self, hostgroup, minutes=30, start=None): """ This command is used to schedule downtime for all hosts in a particular hostgroup. During the specified downtime, Nagios will not send notifications out about the hosts. Syntax: SCHEDULE_HOSTGROUP_HOST_DOWNTIME;<hostgroup_name>;<start_time>; <end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> """ cmd = "SCHEDULE_HOSTGROUP_HOST_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, hostgroup, minutes, start=start) self._write_command(dt_cmd_str) def schedule_hostgroup_svc_downtime(self, hostgroup, minutes=30, start=None): """ This command is used to schedule downtime for all services in a particular hostgroup. During the specified downtime, Nagios will not send notifications out about the services. Note that scheduling downtime for services does not automatically schedule downtime for the hosts those services are associated with. Syntax: SCHEDULE_HOSTGROUP_SVC_DOWNTIME;<hostgroup_name>;<start_time>; <end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> """ cmd = "SCHEDULE_HOSTGROUP_SVC_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, hostgroup, minutes, start=start) self._write_command(dt_cmd_str) def schedule_servicegroup_host_downtime(self, servicegroup, minutes=30, start=None): """ This command is used to schedule downtime for all hosts in a particular servicegroup. During the specified downtime, Nagios will not send notifications out about the hosts. Syntax: SCHEDULE_SERVICEGROUP_HOST_DOWNTIME;<servicegroup_name>; <start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>; <comment> """ cmd = "SCHEDULE_SERVICEGROUP_HOST_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, servicegroup, minutes, start=start) self._write_command(dt_cmd_str) def schedule_servicegroup_svc_downtime(self, servicegroup, minutes=30, start=None): """ This command is used to schedule downtime for all services in a particular servicegroup. During the specified downtime, Nagios will not send notifications out about the services. Note that scheduling downtime for services does not automatically schedule downtime for the hosts those services are associated with. Syntax: SCHEDULE_SERVICEGROUP_SVC_DOWNTIME;<servicegroup_name>; <start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>; <comment> """ cmd = "SCHEDULE_SERVICEGROUP_SVC_DOWNTIME" dt_cmd_str = self._fmt_dt_str(cmd, servicegroup, minutes, start=start) self._write_command(dt_cmd_str) def disable_host_svc_notifications(self, host): """ This command is used to prevent notifications from being sent out for all services on the specified host. Note that this command does not disable notifications from being sent out about the host. Syntax: DISABLE_HOST_SVC_NOTIFICATIONS;<host_name> """ cmd = "DISABLE_HOST_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, host) self._write_command(notif_str) def disable_host_notifications(self, host): """ This command is used to prevent notifications from being sent out for the specified host. Note that this command does not disable notifications for services associated with this host. Syntax: DISABLE_HOST_NOTIFICATIONS;<host_name> """ cmd = "DISABLE_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, host) self._write_command(notif_str) def disable_svc_notifications(self, host, services=None): """ This command is used to prevent notifications from being sent out for the specified service. Note that this command does not disable notifications from being sent out about the host. Syntax: DISABLE_SVC_NOTIFICATIONS;<host_name>;<service_description> """ cmd = "DISABLE_SVC_NOTIFICATIONS" if services is None: services = [] for service in services: notif_str = self._fmt_notif_str(cmd, host, svc=service) self._write_command(notif_str) def disable_servicegroup_host_notifications(self, servicegroup): """ This command is used to prevent notifications from being sent out for all hosts in the specified servicegroup. Note that this command does not disable notifications for services associated with hosts in this service group. Syntax: DISABLE_SERVICEGROUP_HOST_NOTIFICATIONS;<servicegroup_name> """ cmd = "DISABLE_SERVICEGROUP_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, servicegroup) self._write_command(notif_str) def disable_servicegroup_svc_notifications(self, servicegroup): """ This command is used to prevent notifications from being sent out for all services in the specified servicegroup. Note that this does not prevent notifications from being sent out about the hosts in this servicegroup. Syntax: DISABLE_SERVICEGROUP_SVC_NOTIFICATIONS;<servicegroup_name> """ cmd = "DISABLE_SERVICEGROUP_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, servicegroup) self._write_command(notif_str) def disable_hostgroup_host_notifications(self, hostgroup): """ Disables notifications for all hosts in a particular hostgroup. Note that this does not disable notifications for the services associated with the hosts in the hostgroup - see the DISABLE_HOSTGROUP_SVC_NOTIFICATIONS command for that. Syntax: DISABLE_HOSTGROUP_HOST_NOTIFICATIONS;<hostgroup_name> """ cmd = "DISABLE_HOSTGROUP_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, hostgroup) self._write_command(notif_str) def disable_hostgroup_svc_notifications(self, hostgroup): """ Disables notifications for all services associated with hosts in a particular hostgroup. Note that this does not disable notifications for the hosts in the hostgroup - see the DISABLE_HOSTGROUP_HOST_NOTIFICATIONS command for that. Syntax: DISABLE_HOSTGROUP_SVC_NOTIFICATIONS;<hostgroup_name> """ cmd = "DISABLE_HOSTGROUP_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, hostgroup) self._write_command(notif_str) def enable_host_notifications(self, host): """ Enables notifications for a particular host. Note that this command does not enable notifications for services associated with this host. Syntax: ENABLE_HOST_NOTIFICATIONS;<host_name> """ cmd = "ENABLE_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, host) self._write_command(notif_str) def enable_host_svc_notifications(self, host): """ Enables notifications for all services on the specified host. Note that this does not enable notifications for the host. Syntax: ENABLE_HOST_SVC_NOTIFICATIONS;<host_name> """ cmd = "ENABLE_HOST_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, host) nagios_return = self._write_command(notif_str) if nagios_return: return notif_str else: return "Fail: could not write to the command file" def enable_svc_notifications(self, host, services=None): """ Enables notifications for a particular service. Note that this does not enable notifications for the host. Syntax: ENABLE_SVC_NOTIFICATIONS;<host_name>;<service_description> """ cmd = "ENABLE_SVC_NOTIFICATIONS" if services is None: services = [] nagios_return = True return_str_list = [] for service in services: notif_str = self._fmt_notif_str(cmd, host, svc=service) nagios_return = self._write_command(notif_str) and nagios_return return_str_list.append(notif_str) if nagios_return: return return_str_list else: return "Fail: could not write to the command file" def enable_hostgroup_host_notifications(self, hostgroup): """ Enables notifications for all hosts in a particular hostgroup. Note that this command does not enable notifications for services associated with the hosts in this hostgroup. Syntax: ENABLE_HOSTGROUP_HOST_NOTIFICATIONS;<hostgroup_name> """ cmd = "ENABLE_HOSTGROUP_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, hostgroup) nagios_return = self._write_command(notif_str) if nagios_return: return notif_str else: return "Fail: could not write to the command file" def enable_hostgroup_svc_notifications(self, hostgroup): """ Enables notifications for all services that are associated with hosts in a particular hostgroup. Note that this does not enable notifications for the hosts in this hostgroup. Syntax: ENABLE_HOSTGROUP_SVC_NOTIFICATIONS;<hostgroup_name> """ cmd = "ENABLE_HOSTGROUP_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, hostgroup) nagios_return = self._write_command(notif_str) if nagios_return: return notif_str else: return "Fail: could not write to the command file" def enable_servicegroup_host_notifications(self, servicegroup): """ Enables notifications for all hosts that have services that are members of a particular servicegroup. Note that this command does not enable notifications for services associated with the hosts in this servicegroup. Syntax: ENABLE_SERVICEGROUP_HOST_NOTIFICATIONS;<servicegroup_name> """ cmd = "ENABLE_SERVICEGROUP_HOST_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, servicegroup) nagios_return = self._write_command(notif_str) if nagios_return: return notif_str else: return "Fail: could not write to the command file" def enable_servicegroup_svc_notifications(self, servicegroup): """ Enables notifications for all services that are members of a particular servicegroup. Note that this does not enable notifications for the hosts in this servicegroup. Syntax: ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS;<servicegroup_name> """ cmd = "ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS" notif_str = self._fmt_notif_str(cmd, servicegroup) nagios_return = self._write_command(notif_str) if nagios_return: return notif_str else: return "Fail: could not write to the command file" def silence_host(self, host): """ This command is used to prevent notifications from being sent out for the host and all services on the specified host. This is equivalent to calling disable_host_svc_notifications and disable_host_notifications. Syntax: DISABLE_HOST_SVC_NOTIFICATIONS;<host_name> Syntax: DISABLE_HOST_NOTIFICATIONS;<host_name> """ cmd = [ "DISABLE_HOST_SVC_NOTIFICATIONS", "DISABLE_HOST_NOTIFICATIONS" ] nagios_return = True return_str_list = [] for c in cmd: notif_str = self._fmt_notif_str(c, host) nagios_return = self._write_command(notif_str) and nagios_return return_str_list.append(notif_str) if nagios_return: return return_str_list else: return "Fail: could not write to the command file" def unsilence_host(self, host): """ This command is used to enable notifications for the host and all services on the specified host. This is equivalent to calling enable_host_svc_notifications and enable_host_notifications. Syntax: ENABLE_HOST_SVC_NOTIFICATIONS;<host_name> Syntax: ENABLE_HOST_NOTIFICATIONS;<host_name> """ cmd = [ "ENABLE_HOST_SVC_NOTIFICATIONS", "ENABLE_HOST_NOTIFICATIONS" ] nagios_return = True return_str_list = [] for c in cmd: notif_str = self._fmt_notif_str(c, host) nagios_return = self._write_command(notif_str) and nagios_return return_str_list.append(notif_str) if nagios_return: return return_str_list else: return "Fail: could not write to the command file" def silence_nagios(self): """ This command is used to disable notifications for all hosts and services in nagios. This is a 'SHUT UP, NAGIOS' command """ cmd = 'DISABLE_NOTIFICATIONS' self._write_command(self._fmt_notif_str(cmd)) def unsilence_nagios(self): """ This command is used to enable notifications for all hosts and services in nagios. This is a 'OK, NAGIOS, GO'' command """ cmd = 'ENABLE_NOTIFICATIONS' self._write_command(self._fmt_notif_str(cmd)) def nagios_cmd(self, cmd): """ This sends an arbitrary command to nagios It prepends the submitted time and appends a \n You just have to provide the properly formatted command """ pre = '[%s]' % int(time.time()) post = '\n' cmdstr = '%s %s%s' % (pre, cmd, post) self._write_command(cmdstr) def act(self): """ Figure out what you want to do from ansible, and then do the needful (at the earliest). """ # host or service downtime? if self.action == 'downtime': if self.services == 'host': self.schedule_host_downtime(self.host, minutes=self.minutes, start=self.start) elif self.services == 'all': self.schedule_host_svc_downtime(self.host, minutes=self.minutes, start=self.start) else: self.schedule_svc_downtime(self.host, services=self.services, minutes=self.minutes, start=self.start) elif self.action == 'acknowledge': if self.services == 'host': self.acknowledge_host_problem(self.host) else: self.acknowledge_svc_problem(self.host, services=self.services) elif self.action == 'delete_downtime': if self.services == 'host': self.delete_host_downtime(self.host) elif self.services == 'all': self.delete_host_downtime(self.host, comment='') else: self.delete_host_downtime(self.host, services=self.services) elif self.action == 'forced_check': if self.services == 'host': self.schedule_forced_host_check(self.host) elif self.services == 'all': self.schedule_forced_host_svc_check(self.host) else: self.schedule_forced_svc_check(self.host, services=self.services) elif self.action == "servicegroup_host_downtime": if self.servicegroup: self.schedule_servicegroup_host_downtime(servicegroup=self.servicegroup, minutes=self.minutes, start=self.start) elif self.action == "servicegroup_service_downtime": if self.servicegroup: self.schedule_servicegroup_svc_downtime(servicegroup=self.servicegroup, minutes=self.minutes, start=self.start) # toggle the host AND service alerts elif self.action == 'silence': self.silence_host(self.host) elif self.action == 'unsilence': self.unsilence_host(self.host) # toggle host/svc alerts elif self.action == 'enable_alerts': if self.services == 'host': self.enable_host_notifications(self.host) elif self.services == 'all': self.enable_host_svc_notifications(self.host) else: self.enable_svc_notifications(self.host, services=self.services) elif self.action == 'disable_alerts': if self.services == 'host': self.disable_host_notifications(self.host) elif self.services == 'all': self.disable_host_svc_notifications(self.host) else: self.disable_svc_notifications(self.host, services=self.services) elif self.action == 'silence_nagios': self.silence_nagios() elif self.action == 'unsilence_nagios': self.unsilence_nagios() elif self.action == 'command': self.nagios_cmd(self.command) # wtf? else: self.module.fail_json(msg="unknown action specified: '%s'" % self.action) self.module.exit_json(nagios_commands=self.command_results, changed=True) if __name__ == '__main__': main() PK $�!\�T�4� � O collections/ansible_collections/community/general/plugins/modules/netcup_dns.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018 Nicolai Buchwitz <nb@tipi-net.de> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: netcup_dns notes: [] short_description: Manage Netcup DNS records description: - "Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)." extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: api_key: description: - "API key for authentication, must be obtained via the netcup CCP (U(https://ccp.netcup.net))." required: true type: str api_password: description: - "API password for authentication, must be obtained via the netcup CCP (U(https://ccp.netcup.net))." required: true type: str customer_id: description: - Netcup customer id. required: true type: int domain: description: - Domainname the records should be added / removed. required: true type: str record: description: - Record to add or delete, supports wildcard (V(*)). Default is V(@) (that is, the zone name). default: "@" aliases: [ name ] type: str type: description: - Record type. choices: ['A', 'AAAA', 'MX', 'CNAME', 'CAA', 'SRV', 'TXT', 'TLSA', 'NS', 'DS'] required: true type: str value: description: - Record value. required: true type: str solo: type: bool default: false description: - Whether the record should be the only one for that record type and record name. Only use with O(state=present). - This will delete all other records with the same record name and type. priority: description: - Record priority. Required for O(type=MX). required: false type: int state: description: - Whether the record should exist or not. required: false default: present choices: [ 'present', 'absent' ] type: str timeout: description: - HTTP(S) connection timeout in seconds. default: 5 type: int version_added: 5.7.0 requirements: - "nc-dnsapi >= 0.1.3" author: "Nicolai Buchwitz (@nbuchwitz)" ''' EXAMPLES = ''' - name: Create a record of type A community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." domain: "example.com" name: "mail" type: "A" value: "127.0.0.1" - name: Delete that record community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." domain: "example.com" name: "mail" type: "A" value: "127.0.0.1" state: absent - name: Create a wildcard record community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." domain: "example.com" name: "*" type: "A" value: "127.0.1.1" - name: Set the MX record for example.com community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." domain: "example.com" type: "MX" value: "mail.example.com" - name: Set a record and ensure that this is the only one community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." name: "demo" domain: "example.com" type: "AAAA" value: "::1" solo: true - name: Increase the connection timeout to avoid problems with an unstable connection community.general.netcup_dns: api_key: "..." api_password: "..." customer_id: "..." domain: "example.com" name: "mail" type: "A" value: "127.0.0.1" timeout: 30 ''' RETURN = ''' records: description: list containing all records returned: success type: complex contains: name: description: the record name returned: success type: str sample: fancy-hostname type: description: the record type returned: succcess type: str sample: A value: description: the record destination returned: success type: str sample: 127.0.0.1 priority: description: the record priority (only relevant if type=MX) returned: success type: int sample: 0 id: description: internal id of the record returned: success type: int sample: 12345 ''' import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib NCDNSAPI_IMP_ERR = None try: import nc_dnsapi from nc_dnsapi import DNSRecord HAS_NCDNSAPI = True except ImportError: NCDNSAPI_IMP_ERR = traceback.format_exc() HAS_NCDNSAPI = False def main(): module = AnsibleModule( argument_spec=dict( api_key=dict(required=True, no_log=True), api_password=dict(required=True, no_log=True), customer_id=dict(required=True, type='int'), domain=dict(required=True), record=dict(required=False, default='@', aliases=['name']), type=dict(required=True, choices=['A', 'AAAA', 'MX', 'CNAME', 'CAA', 'SRV', 'TXT', 'TLSA', 'NS', 'DS']), value=dict(required=True), priority=dict(required=False, type='int'), solo=dict(required=False, type='bool', default=False), state=dict(required=False, choices=['present', 'absent'], default='present'), timeout=dict(required=False, type='int', default=5), ), supports_check_mode=True ) if not HAS_NCDNSAPI: module.fail_json(msg=missing_required_lib('nc-dnsapi'), exception=NCDNSAPI_IMP_ERR) api_key = module.params.get('api_key') api_password = module.params.get('api_password') customer_id = module.params.get('customer_id') domain = module.params.get('domain') record_type = module.params.get('type') record = module.params.get('record') value = module.params.get('value') priority = module.params.get('priority') solo = module.params.get('solo') state = module.params.get('state') timeout = module.params.get('timeout') if record_type == 'MX' and not priority: module.fail_json(msg="record type MX required the 'priority' argument") has_changed = False all_records = [] try: with nc_dnsapi.Client(customer_id, api_key, api_password, timeout) as api: all_records = api.dns_records(domain) record = DNSRecord(record, record_type, value, priority=priority) # try to get existing record record_exists = False for r in all_records: if r == record: record_exists = True record = r break if state == 'present': if solo: obsolete_records = [r for r in all_records if r.hostname == record.hostname and r.type == record.type and not r.destination == record.destination] if obsolete_records: if not module.check_mode: all_records = api.delete_dns_records(domain, obsolete_records) has_changed = True if not record_exists: if not module.check_mode: all_records = api.add_dns_record(domain, record) has_changed = True elif state == 'absent' and record_exists: if not module.check_mode: all_records = api.delete_dns_record(domain, record) has_changed = True except Exception as ex: module.fail_json(msg=str(ex)) module.exit_json(changed=has_changed, result={"records": [record_data(r) for r in all_records]}) def record_data(r): return {"name": r.hostname, "type": r.type, "value": r.destination, "priority": r.priority, "id": r.id} if __name__ == '__main__': main() PK $�!\�{� � W collections/ansible_collections/community/general/plugins/modules/ilo_redfish_config.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021-2022 Hewlett Packard Enterprise, Inc. All rights reserved. # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ilo_redfish_config short_description: Sets or updates configuration attributes on HPE iLO with Redfish OEM extensions version_added: 4.2.0 description: - Builds Redfish URIs locally and sends them to iLO to set or update a configuration attribute. - For use with HPE iLO operations that require Redfish OEM extensions. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: category: required: true type: str description: - Command category to execute on iLO. choices: ['Manager'] command: required: true description: - List of commands to execute on iLO. type: list elements: str baseuri: required: true description: - Base URI of iLO. type: str username: description: - Username for authenticating to iLO. type: str password: description: - Password for authenticating to iLO. type: str auth_token: description: - Security token for authenticating to iLO. type: str timeout: description: - Timeout in seconds for HTTP requests to iLO. default: 10 type: int attribute_name: required: true description: - Name of the attribute to be configured. type: str attribute_value: required: false description: - Value of the attribute to be configured. type: str author: - "Bhavya B (@bhavya06)" ''' EXAMPLES = ''' - name: Disable WINS Registration community.general.ilo_redfish_config: category: Manager command: SetWINSReg baseuri: 15.X.X.X username: Admin password: Testpass123 attribute_name: WINSRegistration - name: Set Time Zone community.general.ilo_redfish_config: category: Manager command: SetTimeZone baseuri: 15.X.X.X username: Admin password: Testpass123 attribute_name: TimeZone attribute_value: Chennai - name: Set NTP Servers community.general.ilo_redfish_config: category: Manager command: SetNTPServers baseuri: 15.X.X.X username: Admin password: Testpass123 attribute_name: StaticNTPServers attribute_value: X.X.X.X ''' RETURN = ''' msg: description: Message with action result or error description returned: always type: str sample: "Action was successful" ''' CATEGORY_COMMANDS_ALL = { "Manager": ["SetTimeZone", "SetDNSserver", "SetDomainName", "SetNTPServers", "SetWINSReg"] } from ansible_collections.community.general.plugins.module_utils.ilo_redfish_utils import iLORedfishUtils from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native def main(): result = {} module = AnsibleModule( argument_spec=dict( category=dict(required=True, choices=list( CATEGORY_COMMANDS_ALL.keys())), command=dict(required=True, type='list', elements='str'), baseuri=dict(required=True), username=dict(), password=dict(no_log=True), auth_token=dict(no_log=True), attribute_name=dict(required=True), attribute_value=dict(type='str'), timeout=dict(type='int', default=10) ), required_together=[ ('username', 'password'), ], required_one_of=[ ('username', 'auth_token'), ], mutually_exclusive=[ ('username', 'auth_token'), ], supports_check_mode=False ) category = module.params['category'] command_list = module.params['command'] creds = {"user": module.params['username'], "pswd": module.params['password'], "token": module.params['auth_token']} timeout = module.params['timeout'] root_uri = "https://" + module.params['baseuri'] rf_utils = iLORedfishUtils(creds, root_uri, timeout, module) mgr_attributes = {'mgr_attr_name': module.params['attribute_name'], 'mgr_attr_value': module.params['attribute_value']} changed = False offending = [ cmd for cmd in command_list if cmd not in CATEGORY_COMMANDS_ALL[category]] if offending: module.fail_json(msg=to_native("Invalid Command(s): '%s'. Allowed Commands = %s" % ( offending, CATEGORY_COMMANDS_ALL[category]))) if category == "Manager": resource = rf_utils._find_managers_resource() if not resource['ret']: module.fail_json(msg=to_native(resource['msg'])) dispatch = dict( SetTimeZone=rf_utils.set_time_zone, SetDNSserver=rf_utils.set_dns_server, SetDomainName=rf_utils.set_domain_name, SetNTPServers=rf_utils.set_ntp_server, SetWINSReg=rf_utils.set_wins_registration ) for command in command_list: result[command] = dispatch[command](mgr_attributes) if 'changed' in result[command]: changed |= result[command]['changed'] module.exit_json(ilo_redfish_config=result, changed=changed) if __name__ == '__main__': main() PK $�!\ �J��# �# W collections/ansible_collections/community/general/plugins/modules/rax_scaling_policy.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: rax_scaling_policy short_description: Manipulate Rackspace Cloud Autoscale Scaling Policy description: - Manipulate Rackspace Cloud Autoscale Scaling Policy attributes: check_mode: support: none diff_mode: support: none options: at: type: str description: - The UTC time when this policy will be executed. The time must be formatted according to C(yyyy-MM-dd'T'HH:mm:ss.SSS) such as V(2013-05-19T08:07:08Z) change: type: int description: - The change, either as a number of servers or as a percentage, to make in the scaling group. If this is a percentage, you must set O(is_percent) to V(true) also. cron: type: str description: - The time when the policy will be executed, as a cron entry. For example, if this is parameter is set to V(1 0 * * *). cooldown: type: int description: - The period of time, in seconds, that must pass before any scaling can occur after the previous scaling. Must be an integer between 0 and 86400 (24 hrs). default: 300 desired_capacity: type: int description: - The desired server capacity of the scaling the group; that is, how many servers should be in the scaling group. is_percent: description: - Whether the value in O(change) is a percent value default: false type: bool name: type: str description: - Name to give the policy required: true policy_type: type: str description: - The type of policy that will be executed for the current release. choices: - webhook - schedule required: true scaling_group: type: str description: - Name of the scaling group that this policy will be added to required: true state: type: str description: - Indicate desired state of the resource choices: - present - absent default: present author: "Matt Martz (@sivel)" extends_documentation_fragment: - community.general.rackspace - community.general.rackspace.openstack - community.general.attributes ''' EXAMPLES = ''' --- - hosts: localhost gather_facts: false connection: local tasks: - community.general.rax_scaling_policy: credentials: ~/.raxpub region: ORD at: '2013-05-19T08:07:08Z' change: 25 cooldown: 300 is_percent: true name: ASG Test Policy - at policy_type: schedule scaling_group: ASG Test register: asps_at - community.general.rax_scaling_policy: credentials: ~/.raxpub region: ORD cron: '1 0 * * *' change: 25 cooldown: 300 is_percent: true name: ASG Test Policy - cron policy_type: schedule scaling_group: ASG Test register: asp_cron - community.general.rax_scaling_policy: credentials: ~/.raxpub region: ORD cooldown: 300 desired_capacity: 5 name: ASG Test Policy - webhook policy_type: webhook scaling_group: ASG Test register: asp_webhook ''' try: import pyrax HAS_PYRAX = True except ImportError: HAS_PYRAX = False from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.rax import (UUID, rax_argument_spec, rax_required_together, rax_to_dict, setup_rax_module) def rax_asp(module, at=None, change=0, cron=None, cooldown=300, desired_capacity=0, is_percent=False, name=None, policy_type=None, scaling_group=None, state='present'): changed = False au = pyrax.autoscale if not au: module.fail_json(msg='Failed to instantiate client. This ' 'typically indicates an invalid region or an ' 'incorrectly capitalized region name.') try: UUID(scaling_group) except ValueError: try: sg = au.find(name=scaling_group) except Exception as e: module.fail_json(msg='%s' % e.message) else: try: sg = au.get(scaling_group) except Exception as e: module.fail_json(msg='%s' % e.message) if state == 'present': policies = filter(lambda p: name == p.name, sg.list_policies()) if len(policies) > 1: module.fail_json(msg='No unique policy match found by name') if at: args = dict(at=at) elif cron: args = dict(cron=cron) else: args = None if not policies: try: policy = sg.add_policy(name, policy_type=policy_type, cooldown=cooldown, change=change, is_percent=is_percent, desired_capacity=desired_capacity, args=args) changed = True except Exception as e: module.fail_json(msg='%s' % e.message) else: policy = policies[0] kwargs = {} if policy_type != policy.type: kwargs['policy_type'] = policy_type if cooldown != policy.cooldown: kwargs['cooldown'] = cooldown if hasattr(policy, 'change') and change != policy.change: kwargs['change'] = change if hasattr(policy, 'changePercent') and is_percent is False: kwargs['change'] = change kwargs['is_percent'] = False elif hasattr(policy, 'change') and is_percent is True: kwargs['change'] = change kwargs['is_percent'] = True if hasattr(policy, 'desiredCapacity') and change: kwargs['change'] = change elif ((hasattr(policy, 'change') or hasattr(policy, 'changePercent')) and desired_capacity): kwargs['desired_capacity'] = desired_capacity if hasattr(policy, 'args') and args != policy.args: kwargs['args'] = args if kwargs: policy.update(**kwargs) changed = True policy.get() module.exit_json(changed=changed, autoscale_policy=rax_to_dict(policy)) else: try: policies = filter(lambda p: name == p.name, sg.list_policies()) if len(policies) > 1: module.fail_json(msg='No unique policy match found by name') elif not policies: policy = {} else: policy.delete() changed = True except Exception as e: module.fail_json(msg='%s' % e.message) module.exit_json(changed=changed, autoscale_policy=rax_to_dict(policy)) def main(): argument_spec = rax_argument_spec() argument_spec.update( dict( at=dict(), change=dict(type='int'), cron=dict(), cooldown=dict(type='int', default=300), desired_capacity=dict(type='int'), is_percent=dict(type='bool', default=False), name=dict(required=True), policy_type=dict(required=True, choices=['webhook', 'schedule']), scaling_group=dict(required=True), state=dict(default='present', choices=['present', 'absent']), ) ) module = AnsibleModule( argument_spec=argument_spec, required_together=rax_required_together(), mutually_exclusive=[ ['cron', 'at'], ['change', 'desired_capacity'], ] ) if not HAS_PYRAX: module.fail_json(msg='pyrax is required for this module') at = module.params.get('at') change = module.params.get('change') cron = module.params.get('cron') cooldown = module.params.get('cooldown') desired_capacity = module.params.get('desired_capacity') is_percent = module.params.get('is_percent') name = module.params.get('name') policy_type = module.params.get('policy_type') scaling_group = module.params.get('scaling_group') state = module.params.get('state') if (at or cron) and policy_type == 'webhook': module.fail_json(msg='policy_type=schedule is required for a time ' 'based policy') setup_rax_module(module, pyrax) rax_asp(module, at=at, change=change, cron=cron, cooldown=cooldown, desired_capacity=desired_capacity, is_percent=is_percent, name=name, policy_type=policy_type, scaling_group=scaling_group, state=state) if __name__ == '__main__': main() PK $�!\��x* * M collections/ansible_collections/community/general/plugins/modules/ipa_host.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_host author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA host description: - Add, modify and delete an IPA host using IPA API. attributes: check_mode: support: full diff_mode: support: none options: fqdn: description: - Full qualified domain name. - Can not be changed as it is the unique identifier. required: true aliases: ["name"] type: str description: description: - A description of this host. type: str force: description: - Force host name even if not in DNS. required: false type: bool ip_address: description: - Add the host to DNS with this IP address. type: str mac_address: description: - List of Hardware MAC address(es) off this host. - If option is omitted MAC addresses will not be checked or changed. - If an empty list is passed all assigned MAC addresses will be removed. - MAC addresses that are already assigned but not passed will be removed. aliases: ["macaddress"] type: list elements: str ns_host_location: description: - Host location (e.g. "Lab 2") aliases: ["nshostlocation"] type: str ns_hardware_platform: description: - Host hardware platform (e.g. "Lenovo T61") aliases: ["nshardwareplatform"] type: str ns_os_version: description: - Host operating system and version (e.g. "Fedora 9") aliases: ["nsosversion"] type: str user_certificate: description: - List of Base-64 encoded server certificates. - If option is omitted certificates will not be checked or changed. - If an empty list is passed all assigned certificates will be removed. - Certificates already assigned but not passed will be removed. aliases: ["usercertificate"] type: list elements: str state: description: State to ensure. default: present choices: ["absent", "disabled", "enabled", "present"] type: str update_dns: description: - If set V(true) with O(state=absent), then removes DNS records of the host managed by FreeIPA DNS. - This option has no effect for states other than "absent". type: bool random_password: description: Generate a random password to be used in bulk enrollment. type: bool extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure host is present community.general.ipa_host: name: host01.example.com description: Example host ip_address: 192.168.0.123 ns_host_location: Lab ns_os_version: CentOS 7 ns_hardware_platform: Lenovo T61 mac_address: - "08:00:27:E3:B1:2D" - "52:54:00:BD:97:1E" state: present ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Generate a random password for bulk enrolment community.general.ipa_host: name: host01.example.com description: Example host ip_address: 192.168.0.123 state: present ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret validate_certs: false random_password: true - name: Ensure host is disabled community.general.ipa_host: name: host01.example.com state: disabled ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure that all user certificates are removed community.general.ipa_host: name: host01.example.com user_certificate: [] ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure host is absent community.general.ipa_host: name: host01.example.com state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure host and its DNS record is absent community.general.ipa_host: name: host01.example.com state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret update_dns: true ''' RETURN = r''' host: description: Host as returned by IPA API. returned: always type: dict host_diff: description: List of options that differ and would be changed returned: if check mode and a difference is found type: list ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class HostIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(HostIPAClient, self).__init__(module, host, port, protocol) def host_show(self, name): return self._post_json(method='host_show', name=name) def host_find(self, name): return self._post_json(method='host_find', name=None, item={'all': True, 'fqdn': name}) def host_add(self, name, host): return self._post_json(method='host_add', name=name, item=host) def host_mod(self, name, host): return self._post_json(method='host_mod', name=name, item=host) def host_del(self, name, update_dns): return self._post_json(method='host_del', name=name, item={'updatedns': update_dns}) def host_disable(self, name): return self._post_json(method='host_disable', name=name) def get_host_dict(description=None, force=None, ip_address=None, ns_host_location=None, ns_hardware_platform=None, ns_os_version=None, user_certificate=None, mac_address=None, random_password=None): data = {} if description is not None: data['description'] = description if force is not None: data['force'] = force if ip_address is not None: data['ip_address'] = ip_address if ns_host_location is not None: data['nshostlocation'] = ns_host_location if ns_hardware_platform is not None: data['nshardwareplatform'] = ns_hardware_platform if ns_os_version is not None: data['nsosversion'] = ns_os_version if user_certificate is not None: data['usercertificate'] = [{"__base64__": item} for item in user_certificate] if mac_address is not None: data['macaddress'] = mac_address if random_password is not None: data['random'] = random_password return data def get_host_diff(client, ipa_host, module_host): non_updateable_keys = ['force', 'ip_address'] if not module_host.get('random'): non_updateable_keys.append('random') for key in non_updateable_keys: if key in module_host: del module_host[key] return client.get_diff(ipa_data=ipa_host, module_data=module_host) def ensure(module, client): name = module.params['fqdn'] state = module.params['state'] ipa_host = client.host_find(name=name) module_host = get_host_dict(description=module.params['description'], force=module.params['force'], ip_address=module.params['ip_address'], ns_host_location=module.params['ns_host_location'], ns_hardware_platform=module.params['ns_hardware_platform'], ns_os_version=module.params['ns_os_version'], user_certificate=module.params['user_certificate'], mac_address=module.params['mac_address'], random_password=module.params.get('random_password'), ) changed = False if state in ['present', 'enabled', 'disabled']: if not ipa_host: changed = True if not module.check_mode: # OTP password generated by FreeIPA is visible only for host_add command # so, return directly from here. return changed, client.host_add(name=name, host=module_host) else: diff = get_host_diff(client, ipa_host, module_host) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_host.get(key) ipa_host_show = client.host_show(name=name) if ipa_host_show.get('has_keytab', False) and module.params.get('random_password'): client.host_disable(name=name) return changed, client.host_mod(name=name, host=data) else: if ipa_host: changed = True update_dns = module.params.get('update_dns', False) if not module.check_mode: client.host_del(name=name, update_dns=update_dns) return changed, client.host_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(description=dict(type='str'), fqdn=dict(type='str', required=True, aliases=['name']), force=dict(type='bool'), ip_address=dict(type='str'), ns_host_location=dict(type='str', aliases=['nshostlocation']), ns_hardware_platform=dict(type='str', aliases=['nshardwareplatform']), ns_os_version=dict(type='str', aliases=['nsosversion']), user_certificate=dict(type='list', aliases=['usercertificate'], elements='str'), mac_address=dict(type='list', aliases=['macaddress'], elements='str'), update_dns=dict(type='bool'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), random_password=dict(type='bool', no_log=False),) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = HostIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, host = ensure(module, client) module.exit_json(changed=changed, host=host) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\�殃�6 �6 O collections/ansible_collections/community/general/plugins/modules/sefcontext.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Dag Wieers (@dagwieers) <dag@wieers.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: sefcontext short_description: Manages SELinux file context mapping definitions description: - Manages SELinux file context mapping definitions. - Similar to the C(semanage fcontext) command. extends_documentation_fragment: - community.general.attributes - community.general.attributes.platform attributes: check_mode: support: full diff_mode: support: full platform: platforms: linux options: target: description: - Target path (expression). type: str required: true aliases: [ path ] ftype: description: - The file type that should have SELinux contexts applied. - "The following file type options are available:" - V(a) for all files, - V(b) for block devices, - V(c) for character devices, - V(d) for directories, - V(f) for regular files, - V(l) for symbolic links, - V(p) for named pipes, - V(s) for socket files. type: str choices: [ a, b, c, d, f, l, p, s ] default: a setype: description: - SELinux type for the specified O(target). type: str substitute: description: - Path to use to substitute file context(s) for the specified O(target). The context labeling for the O(target) subtree is made equivalent to this path. - This is also referred to as SELinux file context equivalence and it implements the C(equal) functionality of the SELinux management tools. version_added: 6.4.0 type: str aliases: [ equal ] seuser: description: - SELinux user for the specified O(target). - Defaults to V(system_u) for new file contexts and to existing value when modifying file contexts. type: str selevel: description: - SELinux range for the specified O(target). - Defaults to V(s0) for new file contexts and to existing value when modifying file contexts. type: str aliases: [ serange ] state: description: - Whether the SELinux file context must be V(absent) or V(present). - Specifying V(absent) without either O(setype) or O(substitute) deletes both SELinux type or path substitution mappings that match O(target). type: str choices: [ absent, present ] default: present reload: description: - Reload SELinux policy after commit. - Note that this does not apply SELinux file contexts to existing files. type: bool default: true ignore_selinux_state: description: - Useful for scenarios (chrooted environment) that you can't get the real SELinux state. type: bool default: false notes: - The changes are persistent across reboots. - O(setype) and O(substitute) are mutually exclusive. - If O(state=present) then one of O(setype) or O(substitute) is mandatory. - The M(community.general.sefcontext) module does not modify existing files to the new SELinux context(s), so it is advisable to first create the SELinux file contexts before creating files, or run C(restorecon) manually for the existing files that require the new SELinux file contexts. - Not applying SELinux fcontexts to existing files is a deliberate decision as it would be unclear what reported changes would entail to, and there's no guarantee that applying SELinux fcontext does not pick up other unrelated prior changes. requirements: - libselinux-python - policycoreutils-python author: - Dag Wieers (@dagwieers) ''' EXAMPLES = r''' - name: Allow apache to modify files in /srv/git_repos community.general.sefcontext: target: '/srv/git_repos(/.*)?' setype: httpd_sys_rw_content_t state: present - name: Substitute file contexts for path /srv/containers with /var/lib/containers community.general.sefcontext: target: /srv/containers substitute: /var/lib/containers state: present - name: Delete file context path substitution for /srv/containers community.general.sefcontext: target: /srv/containers substitute: /var/lib/containers state: absent - name: Delete any file context mappings for path /srv/git community.general.sefcontext: target: /srv/git state: absent - name: Apply new SELinux file context to filesystem ansible.builtin.command: restorecon -irv /srv/git_repos ''' RETURN = r''' # Default return values ''' import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native SELINUX_IMP_ERR = None try: import selinux HAVE_SELINUX = True except ImportError: SELINUX_IMP_ERR = traceback.format_exc() HAVE_SELINUX = False SEOBJECT_IMP_ERR = None try: import seobject HAVE_SEOBJECT = True except ImportError: SEOBJECT_IMP_ERR = traceback.format_exc() HAVE_SEOBJECT = False # Add missing entries (backward compatible) if HAVE_SEOBJECT: seobject.file_types.update( a=seobject.SEMANAGE_FCONTEXT_ALL, b=seobject.SEMANAGE_FCONTEXT_BLOCK, c=seobject.SEMANAGE_FCONTEXT_CHAR, d=seobject.SEMANAGE_FCONTEXT_DIR, f=seobject.SEMANAGE_FCONTEXT_REG, l=seobject.SEMANAGE_FCONTEXT_LINK, p=seobject.SEMANAGE_FCONTEXT_PIPE, s=seobject.SEMANAGE_FCONTEXT_SOCK, ) # Make backward compatible option_to_file_type_str = dict( a='all files', b='block device', c='character device', d='directory', f='regular file', l='symbolic link', p='named pipe', s='socket', ) def get_runtime_status(ignore_selinux_state=False): return True if ignore_selinux_state is True else selinux.is_selinux_enabled() def semanage_fcontext_exists(sefcontext, target, ftype): ''' Get the SELinux file context mapping definition from policy. Return None if it does not exist. ''' # Beware that records comprise of a string representation of the file_type record = (target, option_to_file_type_str[ftype]) records = sefcontext.get_all() try: return records[record] except KeyError: return None def semanage_fcontext_substitute_exists(sefcontext, target): ''' Get the SELinux file context path substitution definition from policy. Return None if it does not exist. ''' return sefcontext.equiv_dist.get(target, sefcontext.equiv.get(target)) def semanage_fcontext_modify(module, result, target, ftype, setype, substitute, do_reload, serange, seuser, sestore=''): ''' Add or modify SELinux file context mapping definition to the policy. ''' changed = False prepared_diff = '' try: sefcontext = seobject.fcontextRecords(sestore) sefcontext.set_reload(do_reload) if substitute is None: exists = semanage_fcontext_exists(sefcontext, target, ftype) if exists: # Modify existing entry orig_seuser, orig_serole, orig_setype, orig_serange = exists if seuser is None: seuser = orig_seuser if serange is None: serange = orig_serange if setype != orig_setype or seuser != orig_seuser or serange != orig_serange: if not module.check_mode: sefcontext.modify(target, setype, ftype, serange, seuser) changed = True if module._diff: prepared_diff += '# Change to semanage file context mappings\n' prepared_diff += '-%s %s %s:%s:%s:%s\n' % (target, ftype, orig_seuser, orig_serole, orig_setype, orig_serange) prepared_diff += '+%s %s %s:%s:%s:%s\n' % (target, ftype, seuser, orig_serole, setype, serange) else: # Add missing entry if seuser is None: seuser = 'system_u' if serange is None: serange = 's0' if not module.check_mode: sefcontext.add(target, setype, ftype, serange, seuser) changed = True if module._diff: prepared_diff += '# Addition to semanage file context mappings\n' prepared_diff += '+%s %s %s:%s:%s:%s\n' % (target, ftype, seuser, 'object_r', setype, serange) else: exists = semanage_fcontext_substitute_exists(sefcontext, target) if exists: # Modify existing path substitution entry orig_substitute = exists if substitute != orig_substitute: if not module.check_mode: sefcontext.modify_equal(target, substitute) changed = True if module._diff: prepared_diff += '# Change to semanage file context path substitutions\n' prepared_diff += '-%s = %s\n' % (target, orig_substitute) prepared_diff += '+%s = %s\n' % (target, substitute) else: # Add missing path substitution entry if not module.check_mode: sefcontext.add_equal(target, substitute) changed = True if module._diff: prepared_diff += '# Addition to semanage file context path substitutions\n' prepared_diff += '+%s = %s\n' % (target, substitute) except Exception as e: module.fail_json(msg="%s: %s\n" % (e.__class__.__name__, to_native(e))) if module._diff and prepared_diff: result['diff'] = dict(prepared=prepared_diff) module.exit_json(changed=changed, seuser=seuser, serange=serange, **result) def semanage_fcontext_delete(module, result, target, ftype, setype, substitute, do_reload, sestore=''): ''' Delete SELinux file context mapping definition from the policy. ''' changed = False prepared_diff = '' try: sefcontext = seobject.fcontextRecords(sestore) sefcontext.set_reload(do_reload) exists = semanage_fcontext_exists(sefcontext, target, ftype) substitute_exists = semanage_fcontext_substitute_exists(sefcontext, target) if exists and substitute is None: # Remove existing entry orig_seuser, orig_serole, orig_setype, orig_serange = exists if not module.check_mode: sefcontext.delete(target, ftype) changed = True if module._diff: prepared_diff += '# Deletion to semanage file context mappings\n' prepared_diff += '-%s %s %s:%s:%s:%s\n' % (target, ftype, exists[0], exists[1], exists[2], exists[3]) if substitute_exists and setype is None and ((substitute is not None and substitute_exists == substitute) or substitute is None): # Remove existing path substitution entry orig_substitute = substitute_exists if not module.check_mode: sefcontext.delete(target, orig_substitute) changed = True if module._diff: prepared_diff += '# Deletion to semanage file context path substitutions\n' prepared_diff += '-%s = %s\n' % (target, orig_substitute) except Exception as e: module.fail_json(msg="%s: %s\n" % (e.__class__.__name__, to_native(e))) if module._diff and prepared_diff: result['diff'] = dict(prepared=prepared_diff) module.exit_json(changed=changed, **result) def main(): module = AnsibleModule( argument_spec=dict( ignore_selinux_state=dict(type='bool', default=False), target=dict(type='str', required=True, aliases=['path']), ftype=dict(type='str', default='a', choices=list(option_to_file_type_str.keys())), setype=dict(type='str'), substitute=dict(type='str', aliases=['equal']), seuser=dict(type='str'), selevel=dict(type='str', aliases=['serange']), state=dict(type='str', default='present', choices=['absent', 'present']), reload=dict(type='bool', default=True), ), mutually_exclusive=[ ('setype', 'substitute'), ('substitute', 'ftype'), ('substitute', 'seuser'), ('substitute', 'selevel'), ], required_if=[ ('state', 'present', ('setype', 'substitute'), True), ], supports_check_mode=True, ) if not HAVE_SELINUX: module.fail_json(msg=missing_required_lib("libselinux-python"), exception=SELINUX_IMP_ERR) if not HAVE_SEOBJECT: module.fail_json(msg=missing_required_lib("policycoreutils-python"), exception=SEOBJECT_IMP_ERR) ignore_selinux_state = module.params['ignore_selinux_state'] if not get_runtime_status(ignore_selinux_state): module.fail_json(msg="SELinux is disabled on this host.") target = module.params['target'] ftype = module.params['ftype'] setype = module.params['setype'] substitute = module.params['substitute'] seuser = module.params['seuser'] serange = module.params['selevel'] state = module.params['state'] do_reload = module.params['reload'] result = dict(target=target, ftype=ftype, setype=setype, substitute=substitute, state=state) if state == 'present': semanage_fcontext_modify(module, result, target, ftype, setype, substitute, do_reload, serange, seuser) elif state == 'absent': semanage_fcontext_delete(module, result, target, ftype, setype, substitute, do_reload) else: module.fail_json(msg='Invalid value of argument "state": {0}'.format(state)) if __name__ == '__main__': main() PK $�!\x��F F J collections/ansible_collections/community/general/plugins/modules/urpmi.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Philippe Makowski # Written by Philippe Makowski <philippem@mageia.org> # Based on apt module written by Matthew Williams <matthew@flowroute.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: urpmi short_description: Urpmi manager description: - Manages packages with C(urpmi) (such as for Mageia or Mandriva) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - A list of package names to install, upgrade or remove. required: true aliases: [ package, pkg ] type: list elements: str state: description: - Indicates the desired package state. choices: [ absent, present, installed, removed ] default: present type: str update_cache: description: - Update the package database first C(urpmi.update -a). type: bool default: false no_recommends: description: - Corresponds to the C(--no-recommends) option for C(urpmi). type: bool default: true force: description: - Assume "yes" is the answer to any question urpmi has to ask. Corresponds to the C(--force) option for C(urpmi). type: bool default: true root: description: - Specifies an alternative install root, relative to which all packages will be installed. Corresponds to the C(--root) option for C(urpmi). aliases: [ installroot ] type: str author: - Philippe Makowski (@pmakowski) ''' EXAMPLES = ''' - name: Install package foo community.general.urpmi: pkg: foo state: present - name: Remove package foo community.general.urpmi: pkg: foo state: absent - name: Remove packages foo and bar community.general.urpmi: pkg: foo,bar state: absent - name: Update the package database (urpmi.update -a -q) and install bar (bar will be the updated if a newer version exists) - community.general.urpmi: name: bar state: present update_cache: true ''' from ansible.module_utils.basic import AnsibleModule def query_package(module, name, root): # rpm -q returns 0 if the package is installed, # 1 if it is not installed rpm_path = module.get_bin_path("rpm", True) cmd = "%s -q %s %s" % (rpm_path, name, root_option(root)) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc == 0: return True else: return False def query_package_provides(module, name, root): # rpm -q returns 0 if the package is installed, # 1 if it is not installed rpm_path = module.get_bin_path("rpm", True) cmd = "%s -q --whatprovides %s %s" % (rpm_path, name, root_option(root)) rc, stdout, stderr = module.run_command(cmd, check_rc=False) return rc == 0 def update_package_db(module): urpmiupdate_path = module.get_bin_path("urpmi.update", True) cmd = "%s -a -q" % (urpmiupdate_path,) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc != 0: module.fail_json(msg="could not update package db") def remove_packages(module, packages, root): remove_c = 0 # Using a for loop in case of error, we can report the package that failed for package in packages: # Query the package first, to see if we even need to remove if not query_package(module, package, root): continue urpme_path = module.get_bin_path("urpme", True) cmd = "%s --auto %s %s" % (urpme_path, root_option(root), package) rc, stdout, stderr = module.run_command(cmd, check_rc=False) if rc != 0: module.fail_json(msg="failed to remove %s" % (package)) remove_c += 1 if remove_c > 0: module.exit_json(changed=True, msg="removed %s package(s)" % remove_c) module.exit_json(changed=False, msg="package(s) already absent") def install_packages(module, pkgspec, root, force=True, no_recommends=True): packages = "" for package in pkgspec: if not query_package_provides(module, package, root): packages += "'%s' " % package if len(packages) != 0: if no_recommends: no_recommends_yes = '--no-recommends' else: no_recommends_yes = '' if force: force_yes = '--force' else: force_yes = '' urpmi_path = module.get_bin_path("urpmi", True) cmd = ("%s --auto %s --quiet %s %s %s" % (urpmi_path, force_yes, no_recommends_yes, root_option(root), packages)) rc, out, err = module.run_command(cmd) for package in pkgspec: if not query_package_provides(module, package, root): module.fail_json(msg="'urpmi %s' failed: %s" % (package, err)) # urpmi always have 0 for exit code if --force is used if rc: module.fail_json(msg="'urpmi %s' failed: %s" % (packages, err)) else: module.exit_json(changed=True, msg="%s present(s)" % packages) else: module.exit_json(changed=False) def root_option(root): if (root): return "--root=%s" % (root) else: return "" def main(): module = AnsibleModule( argument_spec=dict( state=dict(type='str', default='present', choices=['absent', 'installed', 'present', 'removed']), update_cache=dict(type='bool', default=False), force=dict(type='bool', default=True), no_recommends=dict(type='bool', default=True), name=dict(type='list', elements='str', required=True, aliases=['package', 'pkg']), root=dict(type='str', aliases=['installroot']), ), ) p = module.params if p['update_cache']: update_package_db(module) if p['state'] in ['installed', 'present']: install_packages(module, p['name'], p['root'], p['force'], p['no_recommends']) elif p['state'] in ['removed', 'absent']: remove_packages(module, p['name'], p['root']) if __name__ == '__main__': main() PK $�!\�s\�u u S collections/ansible_collections/community/general/plugins/modules/ipinfoio_facts.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Aleksei Kostiuk <unitoff@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ipinfoio_facts short_description: Retrieve IP geolocation facts of a host's IP address description: - "Gather IP geolocation facts of a host's IP address using ipinfo.io API" author: "Aleksei Kostiuk (@akostyuk)" extends_documentation_fragment: - community.general.attributes - community.general.attributes.facts - community.general.attributes.facts_module options: timeout: description: - HTTP connection timeout in seconds required: false default: 10 type: int http_agent: description: - Set http user agent required: false default: "ansible-ipinfoio-module/0.0.1" type: str notes: - "Check http://ipinfo.io/ for more information" ''' EXAMPLES = ''' # Retrieve geolocation data of a host's IP address - name: Get IP geolocation data community.general.ipinfoio_facts: ''' RETURN = ''' ansible_facts: description: "Dictionary of ip geolocation facts for a host's IP address" returned: changed type: complex contains: ip: description: "Public IP address of a host" type: str sample: "8.8.8.8" hostname: description: Domain name type: str sample: "google-public-dns-a.google.com" country: description: ISO 3166-1 alpha-2 country code type: str sample: "US" region: description: State or province name type: str sample: "California" city: description: City name type: str sample: "Mountain View" loc: description: Latitude and Longitude of the location type: str sample: "37.3860,-122.0838" org: description: "organization's name" type: str sample: "AS3356 Level 3 Communications, Inc." postal: description: Postal code type: str sample: "94035" ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url USER_AGENT = 'ansible-ipinfoio-module/0.0.1' class IpinfoioFacts(object): def __init__(self, module): self.url = 'https://ipinfo.io/json' self.timeout = module.params.get('timeout') self.module = module def get_geo_data(self): response, info = fetch_url(self.module, self.url, force=True, # NOQA timeout=self.timeout) try: info['status'] == 200 except AssertionError: self.module.fail_json(msg='Could not get {0} page, ' 'check for connectivity!'.format(self.url)) else: try: content = response.read() result = self.module.from_json(content.decode('utf8')) except ValueError: self.module.fail_json( msg='Failed to parse the ipinfo.io response: ' '{0} {1}'.format(self.url, content)) else: return result def main(): module = AnsibleModule( # NOQA argument_spec=dict( http_agent=dict(default=USER_AGENT), timeout=dict(type='int', default=10), ), supports_check_mode=True, ) ipinfoio = IpinfoioFacts(module) ipinfoio_result = dict( changed=False, ansible_facts=ipinfoio.get_geo_data()) module.exit_json(**ipinfoio_result) if __name__ == '__main__': main() PK $�!\�n�.�* �* M collections/ansible_collections/community/general/plugins/modules/ipa_role.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_role author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA role description: - Add, modify and delete a role within FreeIPA server using FreeIPA API. attributes: check_mode: support: full diff_mode: support: none options: cn: description: - Role name. - Can not be changed as it is the unique identifier. required: true aliases: ['name'] type: str description: description: - A description of this role-group. type: str group: description: - List of group names assign to this role. - If an empty list is passed all assigned groups will be unassigned from the role. - If option is omitted groups will not be checked or changed. - If option is passed all assigned groups that are not passed will be unassigned from the role. type: list elements: str host: description: - List of host names to assign. - If an empty list is passed all assigned hosts will be unassigned from the role. - If option is omitted hosts will not be checked or changed. - If option is passed all assigned hosts that are not passed will be unassigned from the role. type: list elements: str hostgroup: description: - List of host group names to assign. - If an empty list is passed all assigned host groups will be removed from the role. - If option is omitted host groups will not be checked or changed. - If option is passed all assigned hostgroups that are not passed will be unassigned from the role. type: list elements: str privilege: description: - List of privileges granted to the role. - If an empty list is passed all assigned privileges will be removed. - If option is omitted privileges will not be checked or changed. - If option is passed all assigned privileges that are not passed will be removed. type: list elements: str service: description: - List of service names to assign. - If an empty list is passed all assigned services will be removed from the role. - If option is omitted services will not be checked or changed. - If option is passed all assigned services that are not passed will be removed from the role. type: list elements: str state: description: State to ensure. default: "present" choices: ["absent", "present"] type: str user: description: - List of user names to assign. - If an empty list is passed all assigned users will be removed from the role. - If option is omitted users will not be checked or changed. type: list elements: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure role is present community.general.ipa_role: name: dba description: Database Administrators state: present user: - pinky - brain ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure role with certain details community.general.ipa_role: name: another-role description: Just another role group: - editors host: - host01.example.com hostgroup: - hostgroup01 privilege: - Group Administrators - User Administrators service: - service01 - name: Ensure role is absent community.general.ipa_role: name: dba state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' role: description: Role as returned by IPA API. returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class RoleIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(RoleIPAClient, self).__init__(module, host, port, protocol) def role_find(self, name): return self._post_json(method='role_find', name=None, item={'all': True, 'cn': name}) def role_add(self, name, item): return self._post_json(method='role_add', name=name, item=item) def role_mod(self, name, item): return self._post_json(method='role_mod', name=name, item=item) def role_del(self, name): return self._post_json(method='role_del', name=name) def role_add_member(self, name, item): return self._post_json(method='role_add_member', name=name, item=item) def role_add_group(self, name, item): return self.role_add_member(name=name, item={'group': item}) def role_add_host(self, name, item): return self.role_add_member(name=name, item={'host': item}) def role_add_hostgroup(self, name, item): return self.role_add_member(name=name, item={'hostgroup': item}) def role_add_service(self, name, item): return self.role_add_member(name=name, item={'service': item}) def role_add_user(self, name, item): return self.role_add_member(name=name, item={'user': item}) def role_remove_member(self, name, item): return self._post_json(method='role_remove_member', name=name, item=item) def role_remove_group(self, name, item): return self.role_remove_member(name=name, item={'group': item}) def role_remove_host(self, name, item): return self.role_remove_member(name=name, item={'host': item}) def role_remove_hostgroup(self, name, item): return self.role_remove_member(name=name, item={'hostgroup': item}) def role_remove_service(self, name, item): return self.role_remove_member(name=name, item={'service': item}) def role_remove_user(self, name, item): return self.role_remove_member(name=name, item={'user': item}) def role_add_privilege(self, name, item): return self._post_json(method='role_add_privilege', name=name, item={'privilege': item}) def role_remove_privilege(self, name, item): return self._post_json(method='role_remove_privilege', name=name, item={'privilege': item}) def get_role_dict(description=None): data = {} if description is not None: data['description'] = description return data def get_role_diff(client, ipa_role, module_role): return client.get_diff(ipa_data=ipa_role, module_data=module_role) def ensure(module, client): state = module.params['state'] name = module.params['cn'] group = module.params['group'] host = module.params['host'] hostgroup = module.params['hostgroup'] privilege = module.params['privilege'] service = module.params['service'] user = module.params['user'] module_role = get_role_dict(description=module.params['description']) ipa_role = client.role_find(name=name) changed = False if state == 'present': if not ipa_role: changed = True if not module.check_mode: ipa_role = client.role_add(name=name, item=module_role) else: diff = get_role_diff(client, ipa_role, module_role) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_role.get(key) client.role_mod(name=name, item=data) if group is not None: changed = client.modify_if_diff(name, ipa_role.get('member_group', []), group, client.role_add_group, client.role_remove_group) or changed if host is not None: changed = client.modify_if_diff(name, ipa_role.get('member_host', []), host, client.role_add_host, client.role_remove_host) or changed if hostgroup is not None: changed = client.modify_if_diff(name, ipa_role.get('member_hostgroup', []), hostgroup, client.role_add_hostgroup, client.role_remove_hostgroup) or changed if privilege is not None: changed = client.modify_if_diff(name, ipa_role.get('memberof_privilege', []), privilege, client.role_add_privilege, client.role_remove_privilege) or changed if service is not None: changed = client.modify_if_diff(name, ipa_role.get('member_service', []), service, client.role_add_service, client.role_remove_service) or changed if user is not None: changed = client.modify_if_diff(name, ipa_role.get('member_user', []), user, client.role_add_user, client.role_remove_user) or changed else: if ipa_role: changed = True if not module.check_mode: client.role_del(name) return changed, client.role_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), group=dict(type='list', elements='str'), host=dict(type='list', elements='str'), hostgroup=dict(type='list', elements='str'), privilege=dict(type='list', elements='str'), service=dict(type='list', elements='str'), state=dict(type='str', default='present', choices=['present', 'absent']), user=dict(type='list', elements='str')) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = RoleIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, role = ensure(module, client) module.exit_json(changed=changed, role=role) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\K����- �- Q collections/ansible_collections/community/general/plugins/modules/mssql_script.pynu �[��� # Copyright (c) 2021, Kris Budde <kris@budd.ee # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: mssql_script short_description: Execute SQL scripts on a MSSQL database version_added: "4.0.0" description: - Execute SQL scripts on a MSSQL database. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: partial details: - The script will not be executed in check mode. diff_mode: support: none options: name: description: Database to run script against. aliases: [ db ] default: '' type: str login_user: description: The username used to authenticate with. type: str login_password: description: The password used to authenticate with. type: str login_host: description: Host running the database. type: str required: true login_port: description: Port of the MSSQL server. Requires O(login_host) be defined as well. default: 1433 type: int script: description: - The SQL script to be executed. - Script can contain multiple SQL statements. Multiple Batches can be separated by V(GO) command. - Each batch must return at least one result set. required: true type: str output: description: - With V(default) each row will be returned as a list of values. See RV(query_results). - Output format V(dict) will return dictionary with the column names as keys. See RV(query_results_dict). - V(dict) requires named columns to be returned by each query otherwise an error is thrown. choices: [ "dict", "default" ] default: 'default' type: str params: description: | Parameters passed to the script as SQL parameters. (Query V('SELECT %(name\)s"') with V(example: '{"name": "John Doe"}).)' type: dict notes: - Requires the pymssql Python package on the remote host. For Ubuntu, this is as easy as C(pip install pymssql) (See M(ansible.builtin.pip).) requirements: - python >= 2.7 - pymssql author: - Kris Budde (@kbudde) ''' EXAMPLES = r''' - name: Check DB connection community.general.mssql_script: login_user: "{{ mssql_login_user }}" login_password: "{{ mssql_login_password }}" login_host: "{{ mssql_host }}" login_port: "{{ mssql_port }}" db: master script: "SELECT 1" - name: Query with parameter community.general.mssql_script: login_user: "{{ mssql_login_user }}" login_password: "{{ mssql_login_password }}" login_host: "{{ mssql_host }}" login_port: "{{ mssql_port }}" script: | SELECT name, state_desc FROM sys.databases WHERE name = %(dbname)s params: dbname: msdb register: result_params - assert: that: - result_params.query_results[0][0][0][0] == 'msdb' - result_params.query_results[0][0][0][1] == 'ONLINE' - name: two batches with default output community.general.mssql_script: login_user: "{{ mssql_login_user }}" login_password: "{{ mssql_login_password }}" login_host: "{{ mssql_host }}" login_port: "{{ mssql_port }}" script: | SELECT 'Batch 0 - Select 0' SELECT 'Batch 0 - Select 1' GO SELECT 'Batch 1 - Select 0' register: result_batches - assert: that: - result_batches.query_results | length == 2 # two batch results - result_batches.query_results[0] | length == 2 # two selects in first batch - result_batches.query_results[0][0] | length == 1 # one row in first select - result_batches.query_results[0][0][0] | length == 1 # one column in first row - result_batches.query_results[0][0][0][0] == 'Batch 0 - Select 0' # each row contains a list of values. - name: two batches with dict output community.general.mssql_script: login_user: "{{ mssql_login_user }}" login_password: "{{ mssql_login_password }}" login_host: "{{ mssql_host }}" login_port: "{{ mssql_port }}" output: dict script: | SELECT 'Batch 0 - Select 0' as b0s0 SELECT 'Batch 0 - Select 1' as b0s1 GO SELECT 'Batch 1 - Select 0' as b1s0 register: result_batches_dict - assert: that: - result_batches_dict.query_results_dict | length == 2 # two batch results - result_batches_dict.query_results_dict[0] | length == 2 # two selects in first batch - result_batches_dict.query_results_dict[0][0] | length == 1 # one row in first select - result_batches_dict.query_results_dict[0][0][0]['b0s0'] == 'Batch 0 - Select 0' # column 'b0s0' of first row ''' RETURN = r''' query_results: description: List of batches (queries separated by V(GO) keyword). type: list elements: list returned: success and O(output=default) sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]] contains: queries: description: - List of result sets of each query. - If a query returns no results, the results of this and all the following queries will not be included in the output. - Use the V(GO) keyword in O(script) to separate queries. type: list elements: list contains: rows: description: List of rows returned by query. type: list elements: list contains: column_value: description: - List of column values. - Any non-standard JSON type is converted to string. type: list example: ["Batch 0 - Select 0"] returned: success, if output is default query_results_dict: description: List of batches (queries separated by V(GO) keyword). type: list elements: list returned: success and O(output=dict) sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]] contains: queries: description: - List of result sets of each query. - If a query returns no results, the results of this and all the following queries will not be included in the output. Use 'GO' keyword to separate queries. type: list elements: list contains: rows: description: List of rows returned by query. type: list elements: list contains: column_dict: description: - Dictionary of column names and values. - Any non-standard JSON type is converted to string. type: dict example: {"col_name": "Batch 0 - Select 0"} returned: success, if output is dict ''' from ansible.module_utils.basic import AnsibleModule, missing_required_lib import traceback import json PYMSSQL_IMP_ERR = None try: import pymssql except ImportError: PYMSSQL_IMP_ERR = traceback.format_exc() MSSQL_FOUND = False else: MSSQL_FOUND = True def clean_output(o): return str(o) def run_module(): module_args = dict( name=dict(required=False, aliases=['db'], default=''), login_user=dict(), login_password=dict(no_log=True), login_host=dict(required=True), login_port=dict(type='int', default=1433), script=dict(required=True), output=dict(default='default', choices=['dict', 'default']), params=dict(type='dict'), ) result = dict( changed=False, ) module = AnsibleModule( argument_spec=module_args, supports_check_mode=True ) if not MSSQL_FOUND: module.fail_json(msg=missing_required_lib( 'pymssql'), exception=PYMSSQL_IMP_ERR) db = module.params['name'] login_user = module.params['login_user'] login_password = module.params['login_password'] login_host = module.params['login_host'] login_port = module.params['login_port'] script = module.params['script'] output = module.params['output'] sql_params = module.params['params'] login_querystring = login_host if login_port != 1433: login_querystring = "%s:%s" % (login_host, login_port) if login_user is not None and login_password is None: module.fail_json( msg="when supplying login_user argument, login_password must also be provided") try: conn = pymssql.connect( user=login_user, password=login_password, host=login_querystring, database=db) cursor = conn.cursor() except Exception as e: if "Unknown database" in str(e): errno, errstr = e.args module.fail_json(msg="ERROR: %s %s" % (errno, errstr)) else: module.fail_json(msg="unable to connect, check login_user and login_password are correct, or alternatively check your " "@sysconfdir@/freetds.conf / ${HOME}/.freetds.conf") conn.autocommit(True) query_results_key = 'query_results' if output == 'dict': cursor = conn.cursor(as_dict=True) query_results_key = 'query_results_dict' # Process the script into batches queries = [] current_batch = [] for statement in script.splitlines(keepends=True): # Ignore the Byte Order Mark, if found if statement.strip() == '\uFEFF': continue # Assume each 'GO' is on its own line but may have leading/trailing whitespace # and be of mixed-case if statement.strip().upper() != 'GO': current_batch.append(statement) else: queries.append(''.join(current_batch)) current_batch = [] if len(current_batch) > 0: queries.append(''.join(current_batch)) result['changed'] = True if module.check_mode: module.exit_json(**result) query_results = [] for query in queries: # Catch and exit on any bad query errors try: cursor.execute(query, sql_params) qry_result = [] rows = cursor.fetchall() while rows: qry_result.append(rows) rows = cursor.fetchall() query_results.append(qry_result) except Exception as e: # We know we executed the statement so this error just means we have no resultset # which is ok (eg UPDATE/INSERT) if ( type(e).__name__ == 'OperationalError' and str(e) == 'Statement not executed or executed statement has no resultset' ): query_results.append([]) else: error_msg = '%s: %s' % (type(e).__name__, str(e)) module.fail_json(msg="query failed", query=query, error=error_msg, **result) # ensure that the result is json serializable qry_results = json.loads(json.dumps(query_results, default=clean_output)) result[query_results_key] = qry_results module.exit_json(**result) def main(): run_module() if __name__ == '__main__': main() PK $�!\Ls1 1 U collections/ansible_collections/community/general/plugins/modules/scaleway_ip_info.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: scaleway_ip_info short_description: Gather information about the Scaleway ips available description: - Gather information about the Scaleway ips available. author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module options: region: type: str description: - Scaleway region to use (for example C(par1)). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 ''' EXAMPLES = r''' - name: Gather Scaleway ips information community.general.scaleway_ip_info: region: par1 register: result - ansible.builtin.debug: msg: "{{ result.scaleway_ip_info }}" ''' RETURN = r''' --- scaleway_ip_info: description: - Response from Scaleway API. - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." returned: success type: list elements: dict sample: "scaleway_ip_info": [ { "address": "163.172.170.243", "id": "ea081794-a581-8899-8451-386ddaf0a451", "organization": "3f709602-5e6c-4619-b80c-e324324324af", "reverse": null, "server": { "id": "12f19bc7-109c-4517-954c-e6b3d0311363", "name": "scw-e0d158" } } ] ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( Scaleway, ScalewayException, scaleway_argument_spec, SCALEWAY_LOCATION, ) class ScalewayIpInfo(Scaleway): def __init__(self, module): super(ScalewayIpInfo, self).__init__(module) self.name = 'ips' region = module.params["region"] self.module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"] def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())), )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) try: module.exit_json( scaleway_ip_info=ScalewayIpInfo(module).get_resources() ) except ScalewayException as exc: module.fail_json(msg=exc.message) if __name__ == '__main__': main() PK $�!\���\2' 2' R collections/ansible_collections/community/general/plugins/modules/hwc_smn_topic.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (C) 2019 Huawei # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type ############################################################################### # Documentation ############################################################################### DOCUMENTATION = ''' --- module: hwc_smn_topic description: - Represents a SMN notification topic resource. short_description: Creates a resource of SMNTopic in Huaweicloud Cloud author: Huawei Inc. (@huaweicloud) requirements: - requests >= 2.18.4 - keystoneauth1 >= 3.6.0 attributes: check_mode: support: full diff_mode: support: none options: state: description: - Whether the given object should exist in Huaweicloud Cloud. type: str choices: ['present', 'absent'] default: 'present' display_name: description: - Topic display name, which is presented as the name of the email sender in an email message. The topic display name contains a maximum of 192 bytes. type: str required: false name: description: - Name of the topic to be created. The topic name is a string of 1 to 256 characters. It must contain upper- or lower-case letters, digits, hyphens (V(-)), and underscores (V(_)), and must start with a letter or digit. type: str required: true extends_documentation_fragment: - community.general.hwc - community.general.attributes ''' EXAMPLES = ''' - name: Create a smn topic community.general.hwc_smn_topic: identity_endpoint: "{{ identity_endpoint }}" user_name: "{{ user_name }}" password: "{{ password }}" domain_name: "{{ domain_name }}" project_name: "{{ project_name }}" region: "{{ region }}" name: "ansible_smn_topic_test" state: present ''' RETURN = ''' create_time: description: - Time when the topic was created. returned: success type: str display_name: description: - Topic display name, which is presented as the name of the email sender in an email message. The topic display name contains a maximum of 192 bytes. returned: success type: str name: description: - Name of the topic to be created. The topic name is a string of 1 to 256 characters. It must contain upper- or lower-case letters, digits, hyphens (V(-)), and underscores (V(_)), and must start with a letter or digit. returned: success type: str push_policy: description: - Message pushing policy. 0 indicates that the message sending fails and the message is cached in the queue. 1 indicates that the failed message is discarded. returned: success type: int topic_urn: description: - Resource identifier of a topic, which is unique. returned: success type: str update_time: description: - Time when the topic was updated. returned: success type: str ''' ############################################################################### # Imports ############################################################################### from ansible_collections.community.general.plugins.module_utils.hwc_utils import (Config, HwcClientException, HwcModule, navigate_value, are_different_dicts, is_empty_value, build_path, get_region) import re ############################################################################### # Main ############################################################################### def main(): """Main function""" module = HwcModule( argument_spec=dict( state=dict(default='present', choices=['present', 'absent'], type='str'), display_name=dict(type='str'), name=dict(required=True, type='str') ), supports_check_mode=True, ) config = Config(module, "smn") state = module.params['state'] if not module.params.get("id"): module.params['id'] = get_resource_id(config) fetch = None link = self_link(module) # the link will include Nones if required format parameters are missed if not re.search('/None/|/None$', link): client = config.client(get_region(module), "smn", "project") fetch = fetch_resource(module, client, link) changed = False if fetch: if state == 'present': expect = _get_resource_editable_properties(module) current_state = response_to_hash(module, fetch) current = {'display_name': current_state['display_name']} if are_different_dicts(expect, current): if not module.check_mode: fetch = update(config) fetch = response_to_hash(module, fetch) changed = True else: fetch = current_state else: if not module.check_mode: delete(config) fetch = {} changed = True else: if state == 'present': if not module.check_mode: fetch = create(config) fetch = response_to_hash(module, fetch) changed = True else: fetch = {} fetch.update({'changed': changed}) module.exit_json(**fetch) def create(config): module = config.module client = config.client(get_region(module), "smn", "project") link = "notifications/topics" r = None try: r = client.post(link, create_resource_opts(module)) except HwcClientException as ex: msg = ("module(hwc_smn_topic): error creating " "resource, error: %s" % str(ex)) module.fail_json(msg=msg) return get_resource(config, r) def update(config): module = config.module client = config.client(get_region(module), "smn", "project") link = self_link(module) try: client.put(link, update_resource_opts(module)) except HwcClientException as ex: msg = ("module(hwc_smn_topic): error updating " "resource, error: %s" % str(ex)) module.fail_json(msg=msg) return fetch_resource(module, client, link) def delete(config): module = config.module client = config.client(get_region(module), "smn", "project") link = self_link(module) try: client.delete(link) except HwcClientException as ex: msg = ("module(hwc_smn_topic): error deleting " "resource, error: %s" % str(ex)) module.fail_json(msg=msg) def fetch_resource(module, client, link): try: return client.get(link) except HwcClientException as ex: msg = ("module(hwc_smn_topic): error fetching " "resource, error: %s" % str(ex)) module.fail_json(msg=msg) def get_resource(config, result): module = config.module client = config.client(get_region(module), "smn", "project") v = "" try: v = navigate_value(result, ['topic_urn']) except Exception as ex: module.fail_json(msg=str(ex)) d = {'topic_urn': v} url = build_path(module, 'notifications/topics/{topic_urn}', d) return fetch_resource(module, client, url) def get_resource_id(config): module = config.module client = config.client(get_region(module), "smn", "project") link = "notifications/topics" query_link = "?offset={offset}&limit=10" link += query_link p = {'offset': 0} v = module.params.get('name') ids = set() while True: r = None try: r = client.get(link.format(**p)) except Exception: pass if r is None: break r = r.get('topics', []) if r == []: break for i in r: if i.get('name') == v: ids.add(i.get('topic_urn')) if len(ids) >= 2: module.fail_json(msg="Multiple resources are found") p['offset'] += 1 return ids.pop() if ids else None def self_link(module): return build_path(module, "notifications/topics/{id}") def create_resource_opts(module): params = dict() v = module.params.get('display_name') if not is_empty_value(v): params["display_name"] = v v = module.params.get('name') if not is_empty_value(v): params["name"] = v return params def update_resource_opts(module): params = dict() v = module.params.get('display_name') if not is_empty_value(v): params["display_name"] = v return params def _get_resource_editable_properties(module): return { "display_name": module.params.get("display_name"), } def response_to_hash(module, response): """Remove unnecessary properties from the response. This is for doing comparisons with Ansible's current parameters. """ return { u'create_time': response.get(u'create_time'), u'display_name': response.get(u'display_name'), u'name': response.get(u'name'), u'push_policy': _push_policy_convert_from_response( response.get('push_policy')), u'topic_urn': response.get(u'topic_urn'), u'update_time': response.get(u'update_time') } def _push_policy_convert_from_response(value): return { 0: "the message sending fails and is cached in the queue", 1: "the failed message is discarded", }.get(int(value)) if __name__ == '__main__': main() PK $�!\lO� o o J collections/ansible_collections/community/general/plugins/modules/awall.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ted Trask <ttrask01@yahoo.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: awall short_description: Manage awall policies author: Ted Trask (@tdtrask) <ttrask01@yahoo.com> description: - This modules allows for enable/disable/activate of C(awall) policies. - Alpine Wall (C(awall)) generates a firewall configuration from the enabled policy files and activates the configuration on the system. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - One or more policy names. type: list elements: str state: description: - Whether the policies should be enabled or disabled. type: str choices: [ disabled, enabled ] default: enabled activate: description: - Activate the new firewall rules. - Can be run with other steps or on its own. - Idempotency is affected if O(activate=true), as the module will always report a changed state. type: bool default: false notes: - At least one of O(name) and O(activate) is required. ''' EXAMPLES = r''' - name: Enable "foo" and "bar" policy community.general.awall: name: [ foo bar ] state: enabled - name: Disable "foo" and "bar" policy and activate new rules community.general.awall: name: - foo - bar state: disabled activate: false - name: Activate currently enabled firewall rules community.general.awall: activate: true ''' RETURN = ''' # ''' import re from ansible.module_utils.basic import AnsibleModule def activate(module): cmd = "%s activate --force" % (AWALL_PATH) rc, stdout, stderr = module.run_command(cmd) if rc == 0: return True else: module.fail_json(msg="could not activate new rules", stdout=stdout, stderr=stderr) def is_policy_enabled(module, name): cmd = "%s list" % (AWALL_PATH) rc, stdout, stderr = module.run_command(cmd) if re.search(r"^%s\s+enabled" % name, stdout, re.MULTILINE): return True return False def enable_policy(module, names, act): policies = [] for name in names: if not is_policy_enabled(module, name): policies.append(name) if not policies: module.exit_json(changed=False, msg="policy(ies) already enabled") names = " ".join(policies) if module.check_mode: cmd = "%s list" % (AWALL_PATH) else: cmd = "%s enable %s" % (AWALL_PATH, names) rc, stdout, stderr = module.run_command(cmd) if rc != 0: module.fail_json(msg="failed to enable %s" % names, stdout=stdout, stderr=stderr) if act and not module.check_mode: activate(module) module.exit_json(changed=True, msg="enabled awall policy(ies): %s" % names) def disable_policy(module, names, act): policies = [] for name in names: if is_policy_enabled(module, name): policies.append(name) if not policies: module.exit_json(changed=False, msg="policy(ies) already disabled") names = " ".join(policies) if module.check_mode: cmd = "%s list" % (AWALL_PATH) else: cmd = "%s disable %s" % (AWALL_PATH, names) rc, stdout, stderr = module.run_command(cmd) if rc != 0: module.fail_json(msg="failed to disable %s" % names, stdout=stdout, stderr=stderr) if act and not module.check_mode: activate(module) module.exit_json(changed=True, msg="disabled awall policy(ies): %s" % names) def main(): module = AnsibleModule( argument_spec=dict( state=dict(type='str', default='enabled', choices=['disabled', 'enabled']), name=dict(type='list', elements='str'), activate=dict(type='bool', default=False), ), required_one_of=[['name', 'activate']], supports_check_mode=True, ) global AWALL_PATH AWALL_PATH = module.get_bin_path('awall', required=True) p = module.params if p['name']: if p['state'] == 'enabled': enable_policy(module, p['name'], p['activate']) elif p['state'] == 'disabled': disable_policy(module, p['name'], p['activate']) if p['activate']: if not module.check_mode: activate(module) module.exit_json(changed=True, msg="activated awall rules") module.fail_json(msg="no action defined") if __name__ == '__main__': main() PK $�!\��n��/ �/ N collections/ansible_collections/community/general/plugins/modules/rax_files.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Paul Durivage <paul.durivage@rackspace.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: rax_files short_description: Manipulate Rackspace Cloud Files Containers description: - Manipulate Rackspace Cloud Files Containers attributes: check_mode: support: none diff_mode: support: none options: clear_meta: description: - Optionally clear existing metadata when applying metadata to existing containers. Selecting this option is only appropriate when setting type=meta type: bool default: false container: type: str description: - The container to use for container or metadata operations. meta: type: dict default: {} description: - A hash of items to set as metadata values on a container private: description: - Used to set a container as private, removing it from the CDN. B(Warning!) Private containers, if previously made public, can have live objects available until the TTL on cached objects expires type: bool default: false public: description: - Used to set a container as public, available via the Cloud Files CDN type: bool default: false region: type: str description: - Region to create an instance in state: type: str description: - Indicate desired state of the resource choices: ['present', 'absent', 'list'] default: present ttl: type: int description: - In seconds, set a container-wide TTL for all objects cached on CDN edge nodes. Setting a TTL is only appropriate for containers that are public type: type: str description: - Type of object to do work on, i.e. metadata object or a container object choices: - container - meta default: container web_error: type: str description: - Sets an object to be presented as the HTTP error page when accessed by the CDN URL web_index: type: str description: - Sets an object to be presented as the HTTP index page when accessed by the CDN URL author: "Paul Durivage (@angstwad)" extends_documentation_fragment: - community.general.rackspace - community.general.rackspace.openstack - community.general.attributes ''' EXAMPLES = ''' - name: "Test Cloud Files Containers" hosts: local gather_facts: false tasks: - name: "List all containers" community.general.rax_files: state: list - name: "Create container called 'mycontainer'" community.general.rax_files: container: mycontainer - name: "Create container 'mycontainer2' with metadata" community.general.rax_files: container: mycontainer2 meta: key: value file_for: someuser@example.com - name: "Set a container's web index page" community.general.rax_files: container: mycontainer web_index: index.html - name: "Set a container's web error page" community.general.rax_files: container: mycontainer web_error: error.html - name: "Make container public" community.general.rax_files: container: mycontainer public: true - name: "Make container public with a 24 hour TTL" community.general.rax_files: container: mycontainer public: true ttl: 86400 - name: "Make container private" community.general.rax_files: container: mycontainer private: true - name: "Test Cloud Files Containers Metadata Storage" hosts: local gather_facts: false tasks: - name: "Get mycontainer2 metadata" community.general.rax_files: container: mycontainer2 type: meta - name: "Set mycontainer2 metadata" community.general.rax_files: container: mycontainer2 type: meta meta: uploaded_by: someuser@example.com - name: "Remove mycontainer2 metadata" community.general.rax_files: container: "mycontainer2" type: meta state: absent meta: key: "" file_for: "" ''' try: import pyrax HAS_PYRAX = True except ImportError as e: HAS_PYRAX = False from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.rax import rax_argument_spec, rax_required_together, setup_rax_module EXIT_DICT = dict(success=True) META_PREFIX = 'x-container-meta-' def _get_container(module, cf, container): try: return cf.get_container(container) except pyrax.exc.NoSuchContainer as e: module.fail_json(msg=e.message) def _fetch_meta(module, container): EXIT_DICT['meta'] = dict() try: for k, v in container.get_metadata().items(): split_key = k.split(META_PREFIX)[-1] EXIT_DICT['meta'][split_key] = v except Exception as e: module.fail_json(msg=e.message) def meta(cf, module, container_, state, meta_, clear_meta): c = _get_container(module, cf, container_) if meta_ and state == 'present': try: meta_set = c.set_metadata(meta_, clear=clear_meta) except Exception as e: module.fail_json(msg=e.message) elif meta_ and state == 'absent': remove_results = [] for k, v in meta_.items(): c.remove_metadata_key(k) remove_results.append(k) EXIT_DICT['deleted_meta_keys'] = remove_results elif state == 'absent': remove_results = [] for k, v in c.get_metadata().items(): c.remove_metadata_key(k) remove_results.append(k) EXIT_DICT['deleted_meta_keys'] = remove_results _fetch_meta(module, c) _locals = locals().keys() EXIT_DICT['container'] = c.name if 'meta_set' in _locals or 'remove_results' in _locals: EXIT_DICT['changed'] = True module.exit_json(**EXIT_DICT) def container(cf, module, container_, state, meta_, clear_meta, ttl, public, private, web_index, web_error): if public and private: module.fail_json(msg='container cannot be simultaneously ' 'set to public and private') if state == 'absent' and (meta_ or clear_meta or public or private or web_index or web_error): module.fail_json(msg='state cannot be omitted when setting/removing ' 'attributes on a container') if state == 'list': # We don't care if attributes are specified, let's list containers EXIT_DICT['containers'] = cf.list_containers() module.exit_json(**EXIT_DICT) try: c = cf.get_container(container_) except pyrax.exc.NoSuchContainer as e: # Make the container if state=present, otherwise bomb out if state == 'present': try: c = cf.create_container(container_) except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['changed'] = True EXIT_DICT['created'] = True else: module.fail_json(msg=e.message) else: # Successfully grabbed a container object # Delete if state is absent if state == 'absent': try: cont_deleted = c.delete() except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['deleted'] = True if meta_: try: meta_set = c.set_metadata(meta_, clear=clear_meta) except Exception as e: module.fail_json(msg=e.message) finally: _fetch_meta(module, c) if ttl: try: c.cdn_ttl = ttl except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['ttl'] = c.cdn_ttl if public: try: cont_public = c.make_public() except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['container_urls'] = dict(url=c.cdn_uri, ssl_url=c.cdn_ssl_uri, streaming_url=c.cdn_streaming_uri, ios_uri=c.cdn_ios_uri) if private: try: cont_private = c.make_private() except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['set_private'] = True if web_index: try: cont_web_index = c.set_web_index_page(web_index) except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['set_index'] = True finally: _fetch_meta(module, c) if web_error: try: cont_err_index = c.set_web_error_page(web_error) except Exception as e: module.fail_json(msg=e.message) else: EXIT_DICT['set_error'] = True finally: _fetch_meta(module, c) EXIT_DICT['container'] = c.name EXIT_DICT['objs_in_container'] = c.object_count EXIT_DICT['total_bytes'] = c.total_bytes _locals = locals().keys() if ('cont_deleted' in _locals or 'meta_set' in _locals or 'cont_public' in _locals or 'cont_private' in _locals or 'cont_web_index' in _locals or 'cont_err_index' in _locals): EXIT_DICT['changed'] = True module.exit_json(**EXIT_DICT) def cloudfiles(module, container_, state, meta_, clear_meta, typ, ttl, public, private, web_index, web_error): """ Dispatch from here to work with metadata or file objects """ cf = pyrax.cloudfiles if cf is None: module.fail_json(msg='Failed to instantiate client. This ' 'typically indicates an invalid region or an ' 'incorrectly capitalized region name.') if typ == "container": container(cf, module, container_, state, meta_, clear_meta, ttl, public, private, web_index, web_error) else: meta(cf, module, container_, state, meta_, clear_meta) def main(): argument_spec = rax_argument_spec() argument_spec.update( dict( container=dict(), state=dict(choices=['present', 'absent', 'list'], default='present'), meta=dict(type='dict', default=dict()), clear_meta=dict(default=False, type='bool'), type=dict(choices=['container', 'meta'], default='container'), ttl=dict(type='int'), public=dict(default=False, type='bool'), private=dict(default=False, type='bool'), web_index=dict(), web_error=dict() ) ) module = AnsibleModule( argument_spec=argument_spec, required_together=rax_required_together() ) if not HAS_PYRAX: module.fail_json(msg='pyrax is required for this module') container_ = module.params.get('container') state = module.params.get('state') meta_ = module.params.get('meta') clear_meta = module.params.get('clear_meta') typ = module.params.get('type') ttl = module.params.get('ttl') public = module.params.get('public') private = module.params.get('private') web_index = module.params.get('web_index') web_error = module.params.get('web_error') if state in ['present', 'absent'] and not container_: module.fail_json(msg='please specify a container name') if clear_meta and not typ == 'meta': module.fail_json(msg='clear_meta can only be used when setting ' 'metadata') setup_rax_module(module, pyrax) cloudfiles(module, container_, state, meta_, clear_meta, typ, ttl, public, private, web_index, web_error) if __name__ == '__main__': main() PK $�!\3N L collections/ansible_collections/community/general/plugins/modules/hipchat.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: hipchat short_description: Send a message to Hipchat description: - Send a message to a Hipchat room, with options to control the formatting. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: token: type: str description: - API token. required: true room: type: str description: - ID or name of the room. required: true msg_from: type: str description: - Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated. default: Ansible aliases: [from] msg: type: str description: - The message body. required: true color: type: str description: - Background color for the message. default: yellow choices: [ "yellow", "red", "green", "purple", "gray", "random" ] msg_format: type: str description: - Message format. default: text choices: [ "text", "html" ] notify: description: - If true, a notification will be triggered for users in the room. type: bool default: true validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true api: type: str description: - API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with C(/v2) instead of C(/v1). default: 'https://api.hipchat.com/v1' author: - Shirou Wakayama (@shirou) - Paul Bourdel (@pb8226) ''' EXAMPLES = ''' - name: Send a message to a Hipchat room community.general.hipchat: room: notif msg: Ansible task finished - name: Send a message to a Hipchat room using Hipchat API version 2 community.general.hipchat: api: https://api.hipchat.com/v2/ token: OAUTH2_TOKEN room: notify msg: Ansible task finished ''' # =========================================== # HipChat module specific support methods. # import json import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.six.moves.urllib.request import pathname2url from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.urls import fetch_url DEFAULT_URI = "https://api.hipchat.com/v1" MSG_URI_V1 = "/rooms/message" NOTIFY_URI_V2 = "/room/{id_or_name}/notification" def send_msg_v1(module, token, room, msg_from, msg, msg_format='text', color='yellow', notify=False, api=MSG_URI_V1): '''sending message to hipchat v1 server''' params = {} params['room_id'] = room params['from'] = msg_from[:15] # max length is 15 params['message'] = msg params['message_format'] = msg_format params['color'] = color params['api'] = api params['notify'] = int(notify) url = api + MSG_URI_V1 + "?auth_token=%s" % (token) data = urlencode(params) if module.check_mode: # In check mode, exit before actually sending the message module.exit_json(changed=False) response, info = fetch_url(module, url, data=data) if info['status'] == 200: return response.read() else: module.fail_json(msg="failed to send message, return status=%s" % str(info['status'])) def send_msg_v2(module, token, room, msg_from, msg, msg_format='text', color='yellow', notify=False, api=NOTIFY_URI_V2): '''sending message to hipchat v2 server''' headers = {'Authorization': 'Bearer %s' % token, 'Content-Type': 'application/json'} body = dict() body['message'] = msg body['color'] = color body['message_format'] = msg_format body['notify'] = notify POST_URL = api + NOTIFY_URI_V2 url = POST_URL.replace('{id_or_name}', pathname2url(room)) data = json.dumps(body) if module.check_mode: # In check mode, exit before actually sending the message module.exit_json(changed=False) response, info = fetch_url(module, url, data=data, headers=headers, method='POST') # https://www.hipchat.com/docs/apiv2/method/send_room_notification shows # 204 to be the expected result code. if info['status'] in [200, 204]: return response.read() else: module.fail_json(msg="failed to send message, return status=%s" % str(info['status'])) # =========================================== # Module execution. # def main(): module = AnsibleModule( argument_spec=dict( token=dict(required=True, no_log=True), room=dict(required=True), msg=dict(required=True), msg_from=dict(default="Ansible", aliases=['from']), color=dict(default="yellow", choices=["yellow", "red", "green", "purple", "gray", "random"]), msg_format=dict(default="text", choices=["text", "html"]), notify=dict(default=True, type='bool'), validate_certs=dict(default=True, type='bool'), api=dict(default=DEFAULT_URI), ), supports_check_mode=True ) token = module.params["token"] room = str(module.params["room"]) msg = module.params["msg"] msg_from = module.params["msg_from"] color = module.params["color"] msg_format = module.params["msg_format"] notify = module.params["notify"] api = module.params["api"] try: if api.find('/v2') != -1: send_msg_v2(module, token, room, msg_from, msg, msg_format, color, notify, api) else: send_msg_v1(module, token, room, msg_from, msg, msg_format, color, notify, api) except Exception as e: module.fail_json(msg="unable to send msg: %s" % to_native(e), exception=traceback.format_exc()) changed = True module.exit_json(changed=changed, room=room, msg_from=msg_from, msg=msg) if __name__ == '__main__': main() PK $�!\��O�>B >B \ collections/ansible_collections/community/general/plugins/modules/gitlab_project_variable.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Markus Bergholz (markuman@gmail.com) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: gitlab_project_variable short_description: Creates/updates/deletes GitLab Projects Variables description: - When a project variable does not exist, it will be created. - When a project variable does exist, its value will be updated when the values are different. - Variables which are untouched in the playbook, but are not untouched in the GitLab project, they stay untouched (O(purge=false)) or will be deleted (O(purge=true)). author: - "Markus Bergholz (@markuman)" requirements: - python >= 2.7 - python-gitlab python module extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - Create or delete project variable. - Possible values are present and absent. default: present type: str choices: ["present", "absent"] project: description: - The path and name of the project. required: true type: str purge: description: - When set to true, all variables which are not untouched in the task will be deleted. default: false type: bool vars: description: - When the list element is a simple key-value pair, masked, raw and protected will be set to false. - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full control about whether a value should be masked, raw, protected or both. - Support for protected values requires GitLab >= 9.3. - Support for masked values requires GitLab >= 11.10. - Support for raw values requires GitLab >= 15.7. - Support for environment_scope requires GitLab Premium >= 13.11. - Support for variable_type requires GitLab >= 11.11. - A C(value) must be a string or a number. - Field C(variable_type) must be a string with either V(env_var), which is the default, or V(file). - Field C(environment_scope) must be a string defined by scope environment. - When a value is masked, it must be in Base64 and have a length of at least 8 characters. See GitLab documentation on acceptable values for a masked variable (https://docs.gitlab.com/ce/ci/variables/#masked-variables). default: {} type: dict variables: version_added: 4.4.0 description: - A list of dictionaries that represents CI/CD variables. - This module works internal with this structure, even if the older O(vars) parameter is used. default: [] type: list elements: dict suboptions: name: description: - The name of the variable. type: str required: true value: description: - The variable value. - Required when O(state=present). type: str masked: description: - Wether variable value is masked or not. - Support for masked values requires GitLab >= 11.10. type: bool default: false protected: description: - Wether variable value is protected or not. - Support for protected values requires GitLab >= 9.3. type: bool default: false raw: description: - Wether variable value is raw or not. - Support for raw values requires GitLab >= 15.7. type: bool default: false version_added: '7.4.0' variable_type: description: - Wether a variable is an environment variable (V(env_var)) or a file (V(file)). - Support for O(variables[].variable_type) requires GitLab >= 11.11. type: str choices: ["env_var", "file"] default: env_var environment_scope: description: - The scope for the variable. - Support for O(variables[].environment_scope) requires GitLab Premium >= 13.11. type: str default: '*' ''' EXAMPLES = ''' - name: Set or update some CI/CD variables community.general.gitlab_project_variable: api_url: https://gitlab.com api_token: secret_access_token project: markuman/dotfiles purge: false variables: - name: ACCESS_KEY_ID value: abc123 - name: SECRET_ACCESS_KEY value: dassgrfaeui8989 masked: true protected: true environment_scope: production - name: Set or update some CI/CD variables community.general.gitlab_project_variable: api_url: https://gitlab.com api_token: secret_access_token project: markuman/dotfiles purge: false vars: ACCESS_KEY_ID: abc123 SECRET_ACCESS_KEY: value: 3214cbad masked: true protected: true variable_type: env_var environment_scope: '*' - name: Set or update some CI/CD variables with raw value community.general.gitlab_project_variable: api_url: https://gitlab.com api_token: secret_access_token project: markuman/dotfiles purge: false vars: ACCESS_KEY_ID: abc123 SECRET_ACCESS_KEY: value: 3214cbad masked: true protected: true raw: true variable_type: env_var environment_scope: '*' - name: Set or update some CI/CD variables with expandable value community.general.gitlab_project_variable: api_url: https://gitlab.com api_token: secret_access_token project: markuman/dotfiles purge: false vars: ACCESS_KEY_ID: abc123 SECRET_ACCESS_KEY: value: '$MY_OTHER_VARIABLE' masked: true protected: true raw: false variable_type: env_var environment_scope: '*' - name: Delete one variable community.general.gitlab_project_variable: api_url: https://gitlab.com api_token: secret_access_token project: markuman/dotfiles state: absent vars: ACCESS_KEY_ID: abc123 ''' RETURN = ''' project_variable: description: Four lists of the variablenames which were added, updated, removed or exist. returned: always type: dict contains: added: description: A list of variables which were created. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] untouched: description: A list of variables which exist. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] removed: description: A list of variables which were deleted. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] updated: description: A list of variables whose values were changed. returned: always type: list sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'] ''' from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.api import basic_auth_argument_spec from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, gitlab_authentication, ensure_gitlab_package, filter_returned_variables, vars_to_variables, HAS_GITLAB_PACKAGE, GITLAB_IMP_ERR ) class GitlabProjectVariables(object): def __init__(self, module, gitlab_instance): self.repo = gitlab_instance self.project = self.get_project(module.params['project']) self._module = module def get_project(self, project_name): return self.repo.projects.get(project_name) def list_all_project_variables(self): page_nb = 1 variables = [] vars_page = self.project.variables.list(page=page_nb) while len(vars_page) > 0: variables += vars_page page_nb += 1 vars_page = self.project.variables.list(page=page_nb) return variables def create_variable(self, var_obj): if self._module.check_mode: return True var = { "key": var_obj.get('key'), "value": var_obj.get('value'), "masked": var_obj.get('masked'), "protected": var_obj.get('protected'), "raw": var_obj.get('raw'), "variable_type": var_obj.get('variable_type'), } if var_obj.get('environment_scope') is not None: var["environment_scope"] = var_obj.get('environment_scope') self.project.variables.create(var) return True def update_variable(self, var_obj): if self._module.check_mode: return True self.delete_variable(var_obj) self.create_variable(var_obj) return True def delete_variable(self, var_obj): if self._module.check_mode: return True self.project.variables.delete(var_obj.get('key'), filter={'environment_scope': var_obj.get('environment_scope')}) return True def compare(requested_variables, existing_variables, state): # we need to do this, because it was determined in a previous version - more or less buggy # basically it is not necessary and might results in more/other bugs! # but it is required and only relevant for check mode!! # logic represents state 'present' when not purge. all other can be derived from that # untouched => equal in both # updated => name and scope are equal # added => name and scope does not exist untouched = list() updated = list() added = list() if state == 'present': existing_key_scope_vars = list() for item in existing_variables: existing_key_scope_vars.append({'key': item.get('key'), 'environment_scope': item.get('environment_scope')}) for var in requested_variables: if var in existing_variables: untouched.append(var) else: compare_item = {'key': var.get('name'), 'environment_scope': var.get('environment_scope')} if compare_item in existing_key_scope_vars: updated.append(var) else: added.append(var) return untouched, updated, added def native_python_main(this_gitlab, purge, requested_variables, state, module): change = False return_value = dict(added=[], updated=[], removed=[], untouched=[]) gitlab_keys = this_gitlab.list_all_project_variables() before = [x.attributes for x in gitlab_keys] gitlab_keys = this_gitlab.list_all_project_variables() existing_variables = filter_returned_variables(gitlab_keys) # filter out and enrich before compare for item in requested_variables: item['key'] = item.pop('name') item['value'] = str(item.get('value')) if item.get('protected') is None: item['protected'] = False if item.get('raw') is None: item['raw'] = False if item.get('masked') is None: item['masked'] = False if item.get('environment_scope') is None: item['environment_scope'] = '*' if item.get('variable_type') is None: item['variable_type'] = 'env_var' if module.check_mode: untouched, updated, added = compare(requested_variables, existing_variables, state) if state == 'present': add_or_update = [x for x in requested_variables if x not in existing_variables] for item in add_or_update: try: if this_gitlab.create_variable(item): return_value['added'].append(item) except Exception: if this_gitlab.update_variable(item): return_value['updated'].append(item) if purge: # refetch and filter gitlab_keys = this_gitlab.list_all_project_variables() existing_variables = filter_returned_variables(gitlab_keys) remove = [x for x in existing_variables if x not in requested_variables] for item in remove: if this_gitlab.delete_variable(item): return_value['removed'].append(item) elif state == 'absent': # value does not matter on removing variables. # key and environment scope are sufficient for item in existing_variables: item.pop('value') item.pop('variable_type') for item in requested_variables: item.pop('value') item.pop('variable_type') if not purge: remove_requested = [x for x in requested_variables if x in existing_variables] for item in remove_requested: if this_gitlab.delete_variable(item): return_value['removed'].append(item) else: for item in existing_variables: if this_gitlab.delete_variable(item): return_value['removed'].append(item) if module.check_mode: return_value = dict(added=added, updated=updated, removed=return_value['removed'], untouched=untouched) if any(return_value[x] for x in ['added', 'removed', 'updated']): change = True gitlab_keys = this_gitlab.list_all_project_variables() after = [x.attributes for x in gitlab_keys] return change, return_value, before, after def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update( project=dict(type='str', required=True), purge=dict(type='bool', required=False, default=False), vars=dict(type='dict', required=False, default=dict(), no_log=True), # please mind whenever changing the variables dict to also change module_utils/gitlab.py's # KNOWN dict in filter_returned_variables or bad evil will happen variables=dict(type='list', elements='dict', required=False, default=list(), options=dict( name=dict(type='str', required=True), value=dict(type='str', no_log=True), masked=dict(type='bool', default=False), protected=dict(type='bool', default=False), raw=dict(type='bool', default=False), environment_scope=dict(type='str', default='*'), variable_type=dict(type='str', default='env_var', choices=["env_var", "file"]), )), state=dict(type='str', default="present", choices=["absent", "present"]), ) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ['vars', 'variables'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'] ], supports_check_mode=True ) ensure_gitlab_package(module) if not HAS_GITLAB_PACKAGE: module.fail_json(msg=missing_required_lib("python-gitlab"), exception=GITLAB_IMP_ERR) purge = module.params['purge'] var_list = module.params['vars'] state = module.params['state'] if var_list: variables = vars_to_variables(var_list, module) else: variables = module.params['variables'] if state == 'present': if any(x['value'] is None for x in variables): module.fail_json(msg='value parameter is required for all variables in state present') gitlab_instance = gitlab_authentication(module) this_gitlab = GitlabProjectVariables(module=module, gitlab_instance=gitlab_instance) change, raw_return_value, before, after = native_python_main(this_gitlab, purge, variables, state, module) # postprocessing for item in after: item.pop('project_id') item['name'] = item.pop('key') for item in before: item.pop('project_id') item['name'] = item.pop('key') untouched_key_name = 'key' if not module.check_mode: untouched_key_name = 'name' raw_return_value['untouched'] = [x for x in before if x in after] added = [x.get('key') for x in raw_return_value['added']] updated = [x.get('key') for x in raw_return_value['updated']] removed = [x.get('key') for x in raw_return_value['removed']] untouched = [x.get(untouched_key_name) for x in raw_return_value['untouched']] return_value = dict(added=added, updated=updated, removed=removed, untouched=untouched) module.exit_json(changed=change, project_variable=return_value) if __name__ == '__main__': main() PK $�!\r�t�% �% N collections/ansible_collections/community/general/plugins/modules/linode_v4.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017 Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: linode_v4 short_description: Manage instances on the Linode cloud description: Manage instances on the Linode cloud. requirements: - python >= 2.7 - linode_api4 >= 2.0.0 author: - Luke Murphy (@decentral1se) notes: - No Linode resizing is currently implemented. This module will, in time, replace the current Linode module which uses deprecated API bindings on the Linode side. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: region: description: - The region of the instance. This is a required parameter only when creating Linode instances. See U(https://www.linode.com/docs/api/regions/). type: str image: description: - The image of the instance. This is a required parameter only when creating Linode instances. See U(https://www.linode.com/docs/api/images/). type: str type: description: - The type of the instance. This is a required parameter only when creating Linode instances. See U(https://www.linode.com/docs/api/linode-types/). type: str label: description: - The instance label. This label is used as the main determiner for idempotence for the module and is therefore mandatory. type: str required: true group: description: - The group that the instance should be marked under. Please note, that group labelling is deprecated but still supported. The encouraged method for marking instances is to use tags. type: str private_ip: description: - If V(true), the created Linode will have private networking enabled and assigned a private IPv4 address. type: bool default: false version_added: 3.0.0 tags: description: - The tags that the instance should be marked under. See U(https://www.linode.com/docs/api/tags/). type: list elements: str root_pass: description: - The password for the root user. If not specified, one will be generated. This generated password will be available in the task success JSON. type: str authorized_keys: description: - A list of SSH public key parts to deploy for the root user. type: list elements: str state: description: - The desired instance state. type: str choices: - present - absent required: true access_token: description: - The Linode API v4 access token. It may also be specified by exposing the E(LINODE_ACCESS_TOKEN) environment variable. See U(https://www.linode.com/docs/api#access-and-authentication). required: true type: str stackscript_id: description: - The numeric ID of the StackScript to use when creating the instance. See U(https://www.linode.com/docs/api/stackscripts/). type: int version_added: 1.3.0 stackscript_data: description: - An object containing arguments to any User Defined Fields present in the StackScript used when creating the instance. Only valid when a stackscript_id is provided. See U(https://www.linode.com/docs/api/stackscripts/). type: dict version_added: 1.3.0 ''' EXAMPLES = """ - name: Create a new Linode. community.general.linode_v4: label: new-linode type: g6-nanode-1 region: eu-west image: linode/debian9 root_pass: passw0rd authorized_keys: - "ssh-rsa ..." stackscript_id: 1337 stackscript_data: variable: value state: present - name: Delete that new Linode. community.general.linode_v4: label: new-linode state: absent """ RETURN = """ instance: description: The instance description in JSON serialized form. returned: Always. type: dict sample: { "root_pass": "foobar", # if auto-generated "alerts": { "cpu": 90, "io": 10000, "network_in": 10, "network_out": 10, "transfer_quota": 80 }, "backups": { "enabled": false, "schedule": { "day": null, "window": null } }, "created": "2018-09-26T08:12:33", "group": "Foobar Group", "hypervisor": "kvm", "id": 10480444, "image": "linode/centos7", "ipv4": [ "130.132.285.233" ], "ipv6": "2a82:7e00::h03c:46ff:fe04:5cd2/64", "label": "lin-foo", "region": "eu-west", "specs": { "disk": 25600, "memory": 1024, "transfer": 1000, "vcpus": 1 }, "status": "running", "tags": [], "type": "g6-nanode-1", "updated": "2018-09-26T10:10:14", "watchdog_enabled": true } """ import traceback from ansible.module_utils.basic import AnsibleModule, env_fallback, missing_required_lib from ansible_collections.community.general.plugins.module_utils.linode import get_user_agent LINODE_IMP_ERR = None try: from linode_api4 import Instance, LinodeClient HAS_LINODE_DEPENDENCY = True except ImportError: LINODE_IMP_ERR = traceback.format_exc() HAS_LINODE_DEPENDENCY = False def create_linode(module, client, **kwargs): """Creates a Linode instance and handles return format.""" if kwargs['root_pass'] is None: kwargs.pop('root_pass') try: response = client.linode.instance_create(**kwargs) except Exception as exception: module.fail_json(msg='Unable to query the Linode API. Saw: %s' % exception) try: if isinstance(response, tuple): instance, root_pass = response instance_json = instance._raw_json instance_json.update({'root_pass': root_pass}) return instance_json else: return response._raw_json except TypeError: module.fail_json(msg='Unable to parse Linode instance creation response. Please raise a bug against this' ' module on https://github.com/ansible-collections/community.general/issues' ) def maybe_instance_from_label(module, client): """Try to retrieve an instance based on a label.""" try: label = module.params['label'] result = client.linode.instances(Instance.label == label) return result[0] except IndexError: return None except Exception as exception: module.fail_json(msg='Unable to query the Linode API. Saw: %s' % exception) def initialise_module(): """Initialise the module parameter specification.""" return AnsibleModule( argument_spec=dict( label=dict(type='str', required=True), state=dict( type='str', required=True, choices=['present', 'absent'] ), access_token=dict( type='str', required=True, no_log=True, fallback=(env_fallback, ['LINODE_ACCESS_TOKEN']), ), authorized_keys=dict(type='list', elements='str', no_log=False), group=dict(type='str'), image=dict(type='str'), private_ip=dict(type='bool', default=False), region=dict(type='str'), root_pass=dict(type='str', no_log=True), tags=dict(type='list', elements='str'), type=dict(type='str'), stackscript_id=dict(type='int'), stackscript_data=dict(type='dict'), ), supports_check_mode=False, required_one_of=( ['state', 'label'], ), required_together=( ['region', 'image', 'type'], ) ) def build_client(module): """Build a LinodeClient.""" return LinodeClient( module.params['access_token'], user_agent=get_user_agent('linode_v4_module') ) def main(): """Module entrypoint.""" module = initialise_module() if not HAS_LINODE_DEPENDENCY: module.fail_json(msg=missing_required_lib('linode-api4'), exception=LINODE_IMP_ERR) client = build_client(module) instance = maybe_instance_from_label(module, client) if module.params['state'] == 'present' and instance is not None: module.exit_json(changed=False, instance=instance._raw_json) elif module.params['state'] == 'present' and instance is None: instance_json = create_linode( module, client, authorized_keys=module.params['authorized_keys'], group=module.params['group'], image=module.params['image'], label=module.params['label'], private_ip=module.params['private_ip'], region=module.params['region'], root_pass=module.params['root_pass'], tags=module.params['tags'], ltype=module.params['type'], stackscript=module.params['stackscript_id'], stackscript_data=module.params['stackscript_data'], ) module.exit_json(changed=True, instance=instance_json) elif module.params['state'] == 'absent' and instance is not None: instance.delete() module.exit_json(changed=True, instance=instance._raw_json) elif module.params['state'] == 'absent' and instance is None: module.exit_json(changed=False, instance={}) if __name__ == "__main__": main() PK $�!\���6*W *W I collections/ansible_collections/community/general/plugins/modules/lvol.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Jeroen Hoekx <jeroen.hoekx@dsquare.be>, Alexander Bulimov <lazywolf0@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- author: - Jeroen Hoekx (@jhoekx) - Alexander Bulimov (@abulimov) - Raoul Baudach (@unkaputtbar112) - Ziga Kern (@zigaSRC) module: lvol short_description: Configure LVM logical volumes description: - This module creates, removes or resizes logical volumes. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: vg: type: str required: true description: - The volume group this logical volume is part of. lv: type: str description: - The name of the logical volume. size: type: str description: - The size of the logical volume, according to lvcreate(8) --size, by default in megabytes or optionally with one of [bBsSkKmMgGtTpPeE] units; or according to lvcreate(8) --extents as a percentage of [VG|PVS|FREE|ORIGIN]; Float values must begin with a digit. - When resizing, apart from specifying an absolute size you may, according to lvextend(8)|lvreduce(8) C(--size), specify the amount to extend the logical volume with the prefix V(+) or the amount to reduce the logical volume by with prefix V(-). - Resizing using V(+) or V(-) was not supported prior to community.general 3.0.0. - Please note that when using V(+), V(-), or percentage of FREE, the module is B(not idempotent). state: type: str description: - Control if the logical volume exists. If V(present) and the volume does not already exist then the O(size) option is required. choices: [ absent, present ] default: present active: description: - Whether the volume is active and visible to the host. type: bool default: true force: description: - Shrink or remove operations of volumes requires this switch. Ensures that that filesystems get never corrupted/destroyed by mistake. type: bool default: false opts: type: str description: - Free-form options to be passed to the lvcreate command. snapshot: type: str description: - The name of a snapshot volume to be configured. When creating a snapshot volume, the O(lv) parameter specifies the origin volume. pvs: type: str description: - Comma separated list of physical volumes (e.g. /dev/sda,/dev/sdb). thinpool: type: str description: - The thin pool volume name. When you want to create a thin provisioned volume, specify a thin pool volume name. shrink: description: - Shrink if current size is higher than size requested. type: bool default: true resizefs: description: - Resize the underlying filesystem together with the logical volume. - Supported for C(ext2), C(ext3), C(ext4), C(reiserfs) and C(XFS) filesystems. Attempts to resize other filesystem types will fail. type: bool default: false notes: - You must specify lv (when managing the state of logical volumes) or thinpool (when managing a thin provisioned volume). ''' EXAMPLES = ''' - name: Create a logical volume of 512m community.general.lvol: vg: firefly lv: test size: 512 - name: Create a logical volume of 512m with disks /dev/sda and /dev/sdb community.general.lvol: vg: firefly lv: test size: 512 pvs: /dev/sda,/dev/sdb - name: Create cache pool logical volume community.general.lvol: vg: firefly lv: lvcache size: 512m opts: --type cache-pool - name: Create a logical volume of 512g. community.general.lvol: vg: firefly lv: test size: 512g - name: Create a logical volume the size of all remaining space in the volume group community.general.lvol: vg: firefly lv: test size: 100%FREE - name: Create a logical volume with special options community.general.lvol: vg: firefly lv: test size: 512g opts: -r 16 - name: Extend the logical volume to 1024m. community.general.lvol: vg: firefly lv: test size: 1024 - name: Extend the logical volume to consume all remaining space in the volume group community.general.lvol: vg: firefly lv: test size: +100%FREE - name: Extend the logical volume by given space community.general.lvol: vg: firefly lv: test size: +512M - name: Extend the logical volume to take all remaining space of the PVs and resize the underlying filesystem community.general.lvol: vg: firefly lv: test size: 100%PVS resizefs: true - name: Resize the logical volume to % of VG community.general.lvol: vg: firefly lv: test size: 80%VG force: true - name: Reduce the logical volume to 512m community.general.lvol: vg: firefly lv: test size: 512 force: true - name: Reduce the logical volume by given space community.general.lvol: vg: firefly lv: test size: -512M force: true - name: Set the logical volume to 512m and do not try to shrink if size is lower than current one community.general.lvol: vg: firefly lv: test size: 512 shrink: false - name: Remove the logical volume. community.general.lvol: vg: firefly lv: test state: absent force: true - name: Create a snapshot volume of the test logical volume. community.general.lvol: vg: firefly lv: test snapshot: snap1 size: 100m - name: Deactivate a logical volume community.general.lvol: vg: firefly lv: test active: false - name: Create a deactivated logical volume community.general.lvol: vg: firefly lv: test size: 512g active: false - name: Create a thin pool of 512g community.general.lvol: vg: firefly thinpool: testpool size: 512g - name: Create a thin volume of 128g community.general.lvol: vg: firefly lv: test thinpool: testpool size: 128g ''' import re from ansible.module_utils.basic import AnsibleModule LVOL_ENV_VARS = dict( # make sure we use the C locale when running lvol-related commands LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C', ) def mkversion(major, minor, patch): return (1000 * 1000 * int(major)) + (1000 * int(minor)) + int(patch) def parse_lvs(data): lvs = [] for line in data.splitlines(): parts = line.strip().split(';') lvs.append({ 'name': parts[0].replace('[', '').replace(']', ''), 'size': float(parts[1]), 'active': (parts[2][4] == 'a'), 'thinpool': (parts[2][0] == 't'), 'thinvol': (parts[2][0] == 'V'), }) return lvs def parse_vgs(data): vgs = [] for line in data.splitlines(): parts = line.strip().split(';') vgs.append({ 'name': parts[0], 'size': float(parts[1]), 'free': float(parts[2]), 'ext_size': float(parts[3]) }) return vgs def get_lvm_version(module): ver_cmd = module.get_bin_path("lvm", required=True) rc, out, err = module.run_command("%s version" % (ver_cmd)) if rc != 0: return None m = re.search(r"LVM version:\s+(\d+)\.(\d+)\.(\d+).*(\d{4}-\d{2}-\d{2})", out) if not m: return None return mkversion(m.group(1), m.group(2), m.group(3)) def main(): module = AnsibleModule( argument_spec=dict( vg=dict(type='str', required=True), lv=dict(type='str'), size=dict(type='str'), opts=dict(type='str'), state=dict(type='str', default='present', choices=['absent', 'present']), force=dict(type='bool', default=False), shrink=dict(type='bool', default=True), active=dict(type='bool', default=True), snapshot=dict(type='str'), pvs=dict(type='str'), resizefs=dict(type='bool', default=False), thinpool=dict(type='str'), ), supports_check_mode=True, required_one_of=( ['lv', 'thinpool'], ), ) module.run_command_environ_update = LVOL_ENV_VARS # Determine if the "--yes" option should be used version_found = get_lvm_version(module) if version_found is None: module.fail_json(msg="Failed to get LVM version number") version_yesopt = mkversion(2, 2, 99) # First LVM with the "--yes" option if version_found >= version_yesopt: yesopt = "--yes" else: yesopt = "" vg = module.params['vg'] lv = module.params['lv'] size = module.params['size'] opts = module.params['opts'] state = module.params['state'] force = module.boolean(module.params['force']) shrink = module.boolean(module.params['shrink']) active = module.boolean(module.params['active']) resizefs = module.boolean(module.params['resizefs']) thinpool = module.params['thinpool'] size_opt = 'L' size_unit = 'm' size_operator = None snapshot = module.params['snapshot'] pvs = module.params['pvs'] if pvs is None: pvs = "" else: pvs = pvs.replace(",", " ") if opts is None: opts = "" # Add --test option when running in check-mode if module.check_mode: test_opt = ' --test' else: test_opt = '' if size: # LVEXTEND(8)/LVREDUCE(8) -l, -L options: Check for relative value for resizing if size.startswith('+'): size_operator = '+' size = size[1:] elif size.startswith('-'): size_operator = '-' size = size[1:] # LVCREATE(8) does not support [+-] # LVCREATE(8)/LVEXTEND(8)/LVREDUCE(8) -l --extents option with percentage if '%' in size: size_parts = size.split('%', 1) size_percent = int(size_parts[0]) if size_percent > 100: module.fail_json(msg="Size percentage cannot be larger than 100%") size_whole = size_parts[1] if size_whole == 'ORIGIN' and snapshot is None: module.fail_json(msg="Percentage of ORIGIN supported only for snapshot volumes") elif size_whole not in ['VG', 'PVS', 'FREE', 'ORIGIN']: module.fail_json(msg="Specify extents as a percentage of VG|PVS|FREE|ORIGIN") size_opt = 'l' size_unit = '' # LVCREATE(8)/LVEXTEND(8)/LVREDUCE(8) -L --size option unit if '%' not in size: if size[-1].lower() in 'bskmgtpe': size_unit = size[-1] size = size[0:-1] try: float(size) if not size[0].isdigit(): raise ValueError() except ValueError: module.fail_json(msg="Bad size specification of '%s'" % size) # when no unit, megabytes by default if size_opt == 'l': unit = 'm' else: unit = size_unit # Get information on volume group requested vgs_cmd = module.get_bin_path("vgs", required=True) rc, current_vgs, err = module.run_command( "%s --noheadings --nosuffix -o vg_name,size,free,vg_extent_size --units %s --separator ';' %s" % (vgs_cmd, unit.lower(), vg)) if rc != 0: if state == 'absent': module.exit_json(changed=False, stdout="Volume group %s does not exist." % vg) else: module.fail_json(msg="Volume group %s does not exist." % vg, rc=rc, err=err) vgs = parse_vgs(current_vgs) this_vg = vgs[0] # Get information on logical volume requested lvs_cmd = module.get_bin_path("lvs", required=True) rc, current_lvs, err = module.run_command( "%s -a --noheadings --nosuffix -o lv_name,size,lv_attr --units %s --separator ';' %s" % (lvs_cmd, unit.lower(), vg)) if rc != 0: if state == 'absent': module.exit_json(changed=False, stdout="Volume group %s does not exist." % vg) else: module.fail_json(msg="Volume group %s does not exist." % vg, rc=rc, err=err) changed = False lvs = parse_lvs(current_lvs) if snapshot: # Check snapshot pre-conditions for test_lv in lvs: if test_lv['name'] == lv or test_lv['name'] == thinpool: if not test_lv['thinpool'] and not thinpool: break else: module.fail_json(msg="Snapshots of thin pool LVs are not supported.") else: module.fail_json(msg="Snapshot origin LV %s does not exist in volume group %s." % (lv, vg)) check_lv = snapshot elif thinpool: if lv: # Check thin volume pre-conditions for test_lv in lvs: if test_lv['name'] == thinpool: break else: module.fail_json(msg="Thin pool LV %s does not exist in volume group %s." % (thinpool, vg)) check_lv = lv else: check_lv = thinpool else: check_lv = lv for test_lv in lvs: if test_lv['name'] in (check_lv, check_lv.rsplit('/', 1)[-1]): this_lv = test_lv break else: this_lv = None msg = '' if this_lv is None: if state == 'present': if size_operator is not None: if size_operator == "-" or (size_whole not in ["VG", "PVS", "FREE", "ORIGIN", None]): module.fail_json(msg="Bad size specification of '%s%s' for creating LV" % (size_operator, size)) # Require size argument except for snapshot of thin volumes if (lv or thinpool) and not size: for test_lv in lvs: if test_lv['name'] == lv and test_lv['thinvol'] and snapshot: break else: module.fail_json(msg="No size given.") # create LV lvcreate_cmd = module.get_bin_path("lvcreate", required=True) if snapshot is not None: if size: cmd = "%s %s %s -%s %s%s -s -n %s %s %s/%s" % (lvcreate_cmd, test_opt, yesopt, size_opt, size, size_unit, snapshot, opts, vg, lv) else: cmd = "%s %s %s -s -n %s %s %s/%s" % (lvcreate_cmd, test_opt, yesopt, snapshot, opts, vg, lv) elif thinpool and lv: if size_opt == 'l': module.fail_json(changed=False, msg="Thin volume sizing with percentage not supported.") size_opt = 'V' cmd = "%s %s %s -n %s -%s %s%s %s -T %s/%s" % (lvcreate_cmd, test_opt, yesopt, lv, size_opt, size, size_unit, opts, vg, thinpool) elif thinpool and not lv: cmd = "%s %s %s -%s %s%s %s -T %s/%s" % (lvcreate_cmd, test_opt, yesopt, size_opt, size, size_unit, opts, vg, thinpool) else: cmd = "%s %s %s -n %s -%s %s%s %s %s %s" % (lvcreate_cmd, test_opt, yesopt, lv, size_opt, size, size_unit, opts, vg, pvs) rc, dummy, err = module.run_command(cmd) if rc == 0: changed = True else: module.fail_json(msg="Creating logical volume '%s' failed" % lv, rc=rc, err=err) else: if state == 'absent': # remove LV if not force: module.fail_json(msg="Sorry, no removal of logical volume %s without force=true." % (this_lv['name'])) lvremove_cmd = module.get_bin_path("lvremove", required=True) rc, dummy, err = module.run_command("%s %s --force %s/%s" % (lvremove_cmd, test_opt, vg, this_lv['name'])) if rc == 0: module.exit_json(changed=True) else: module.fail_json(msg="Failed to remove logical volume %s" % (lv), rc=rc, err=err) elif not size: pass elif size_opt == 'l': # Resize LV based on % value tool = None size_free = this_vg['free'] if size_whole == 'VG' or size_whole == 'PVS': size_requested = size_percent * this_vg['size'] / 100 else: # size_whole == 'FREE': size_requested = size_percent * this_vg['free'] / 100 if size_operator == '+': size_requested += this_lv['size'] elif size_operator == '-': size_requested = this_lv['size'] - size_requested # According to latest documentation (LVM2-2.03.11) all tools round down size_requested -= (size_requested % this_vg['ext_size']) if this_lv['size'] < size_requested: if (size_free > 0) and (size_free >= (size_requested - this_lv['size'])): tool = module.get_bin_path("lvextend", required=True) else: module.fail_json( msg="Logical Volume %s could not be extended. Not enough free space left (%s%s required / %s%s available)" % (this_lv['name'], (size_requested - this_lv['size']), unit, size_free, unit) ) elif shrink and this_lv['size'] > size_requested + this_vg['ext_size']: # more than an extent too large if size_requested < 1: module.fail_json(msg="Sorry, no shrinking of %s to 0 permitted." % (this_lv['name'])) elif not force: module.fail_json(msg="Sorry, no shrinking of %s without force=true" % (this_lv['name'])) else: tool = module.get_bin_path("lvreduce", required=True) tool = '%s %s' % (tool, '--force') if tool: if resizefs: tool = '%s %s' % (tool, '--resizefs') if size_operator: cmd = "%s %s -%s %s%s%s %s/%s %s" % (tool, test_opt, size_opt, size_operator, size, size_unit, vg, this_lv['name'], pvs) else: cmd = "%s %s -%s %s%s %s/%s %s" % (tool, test_opt, size_opt, size, size_unit, vg, this_lv['name'], pvs) rc, out, err = module.run_command(cmd) if "Reached maximum COW size" in out: module.fail_json(msg="Unable to resize %s to %s%s" % (lv, size, size_unit), rc=rc, err=err, out=out) elif rc == 0: changed = True msg = "Volume %s resized to %s%s" % (this_lv['name'], size_requested, unit) elif "matches existing size" in err: module.exit_json(changed=False, vg=vg, lv=this_lv['name'], size=this_lv['size']) elif "not larger than existing size" in err: module.exit_json(changed=False, vg=vg, lv=this_lv['name'], size=this_lv['size'], msg="Original size is larger than requested size", err=err) else: module.fail_json(msg="Unable to resize %s to %s%s" % (lv, size, size_unit), rc=rc, err=err) else: # resize LV based on absolute values tool = None if float(size) > this_lv['size'] or size_operator == '+': tool = module.get_bin_path("lvextend", required=True) elif shrink and float(size) < this_lv['size'] or size_operator == '-': if float(size) == 0: module.fail_json(msg="Sorry, no shrinking of %s to 0 permitted." % (this_lv['name'])) if not force: module.fail_json(msg="Sorry, no shrinking of %s without force=true." % (this_lv['name'])) else: tool = module.get_bin_path("lvreduce", required=True) tool = '%s %s' % (tool, '--force') if tool: if resizefs: tool = '%s %s' % (tool, '--resizefs') if size_operator: cmd = "%s %s -%s %s%s%s %s/%s %s" % (tool, test_opt, size_opt, size_operator, size, size_unit, vg, this_lv['name'], pvs) else: cmd = "%s %s -%s %s%s %s/%s %s" % (tool, test_opt, size_opt, size, size_unit, vg, this_lv['name'], pvs) rc, out, err = module.run_command(cmd) if "Reached maximum COW size" in out: module.fail_json(msg="Unable to resize %s to %s%s" % (lv, size, size_unit), rc=rc, err=err, out=out) elif rc == 0: changed = True elif "matches existing size" in err: module.exit_json(changed=False, vg=vg, lv=this_lv['name'], size=this_lv['size']) elif "not larger than existing size" in err: module.exit_json(changed=False, vg=vg, lv=this_lv['name'], size=this_lv['size'], msg="Original size is larger than requested size", err=err) else: module.fail_json(msg="Unable to resize %s to %s%s" % (lv, size, size_unit), rc=rc, err=err) if this_lv is not None: if active: lvchange_cmd = module.get_bin_path("lvchange", required=True) rc, dummy, err = module.run_command("%s -ay %s/%s" % (lvchange_cmd, vg, this_lv['name'])) if rc == 0: module.exit_json(changed=((not this_lv['active']) or changed), vg=vg, lv=this_lv['name'], size=this_lv['size']) else: module.fail_json(msg="Failed to activate logical volume %s" % (lv), rc=rc, err=err) else: lvchange_cmd = module.get_bin_path("lvchange", required=True) rc, dummy, err = module.run_command("%s -an %s/%s" % (lvchange_cmd, vg, this_lv['name'])) if rc == 0: module.exit_json(changed=(this_lv['active'] or changed), vg=vg, lv=this_lv['name'], size=this_lv['size']) else: module.fail_json(msg="Failed to deactivate logical volume %s" % (lv), rc=rc, err=err) module.exit_json(changed=changed, msg=msg) if __name__ == '__main__': main() PK $�!\���~�& �& Y collections/ansible_collections/community/general/plugins/modules/elasticsearch_plugin.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Mathew Davies <thepixeldeveloper@googlemail.com> # Copyright (c) 2017, Sam Doran <sdoran@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: elasticsearch_plugin short_description: Manage Elasticsearch plugins description: - Manages Elasticsearch plugins. author: - Mathew Davies (@ThePixelDeveloper) - Sam Doran (@samdoran) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the plugin to install. required: true type: str state: description: - Desired state of a plugin. choices: ["present", "absent"] default: present type: str src: description: - Optionally set the source location to retrieve the plugin from. This can be a file:// URL to install from a local file, or a remote URL. If this is not set, the plugin location is just based on the name. - The name parameter must match the descriptor in the plugin ZIP specified. - Is only used if the state would change, which is solely checked based on the name parameter. If, for example, the plugin is already installed, changing this has no effect. - For ES 1.x use url. required: false type: str url: description: - Set exact URL to download the plugin from (Only works for ES 1.x). - For ES 2.x and higher, use src. required: false type: str timeout: description: - "Timeout setting: 30s, 1m, 1h..." - Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0. default: 1m type: str force: description: - "Force batch mode when installing plugins. This is only necessary if a plugin requires additional permissions and console detection fails." default: false type: bool plugin_bin: description: - Location of the plugin binary. If this file is not found, the default plugin binaries will be used. - The default changed in Ansible 2.4 to None. type: path plugin_dir: description: - Your configured plugin directory specified in Elasticsearch default: /usr/share/elasticsearch/plugins/ type: path proxy_host: description: - Proxy host to use during plugin installation type: str proxy_port: description: - Proxy port to use during plugin installation type: str version: description: - Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated type: str ''' EXAMPLES = ''' - name: Install Elasticsearch Head plugin in Elasticsearch 2.x community.general.elasticsearch_plugin: name: mobz/elasticsearch-head state: present - name: Install a specific version of Elasticsearch Head in Elasticsearch 2.x community.general.elasticsearch_plugin: name: mobz/elasticsearch-head version: 2.0.0 - name: Uninstall Elasticsearch head plugin in Elasticsearch 2.x community.general.elasticsearch_plugin: name: mobz/elasticsearch-head state: absent - name: Install a specific plugin in Elasticsearch >= 5.0 community.general.elasticsearch_plugin: name: analysis-icu state: present - name: Install the ingest-geoip plugin with a forced installation community.general.elasticsearch_plugin: name: ingest-geoip state: present force: true ''' import os from ansible.module_utils.basic import AnsibleModule PACKAGE_STATE_MAP = dict( present="install", absent="remove" ) PLUGIN_BIN_PATHS = tuple([ '/usr/share/elasticsearch/bin/elasticsearch-plugin', '/usr/share/elasticsearch/bin/plugin' ]) def parse_plugin_repo(string): elements = string.split("/") # We first consider the simplest form: pluginname repo = elements[0] # We consider the form: username/pluginname if len(elements) > 1: repo = elements[1] # remove elasticsearch- prefix # remove es- prefix for string in ("elasticsearch-", "es-"): if repo.startswith(string): return repo[len(string):] return repo def is_plugin_present(plugin_name, plugin_dir): return os.path.isdir(os.path.join(plugin_dir, plugin_name)) def parse_error(string): reason = "ERROR: " try: return string[string.index(reason) + len(reason):].strip() except ValueError: return string def install_plugin(module, plugin_bin, plugin_name, version, src, url, proxy_host, proxy_port, timeout, force): cmd_args = [plugin_bin, PACKAGE_STATE_MAP["present"]] is_old_command = (os.path.basename(plugin_bin) == 'plugin') # Timeout and version are only valid for plugin, not elasticsearch-plugin if is_old_command: if timeout: cmd_args.append("--timeout %s" % timeout) if version: plugin_name = plugin_name + '/' + version cmd_args[2] = plugin_name if proxy_host and proxy_port: cmd_args.append("-DproxyHost=%s -DproxyPort=%s" % (proxy_host, proxy_port)) # Legacy ES 1.x if url: cmd_args.append("--url %s" % url) if force: cmd_args.append("--batch") if src: cmd_args.append(src) else: cmd_args.append(plugin_name) cmd = " ".join(cmd_args) if module.check_mode: rc, out, err = 0, "check mode", "" else: rc, out, err = module.run_command(cmd) if rc != 0: reason = parse_error(out) module.fail_json(msg="Installing plugin '%s' failed: %s" % (plugin_name, reason), err=err) return True, cmd, out, err def remove_plugin(module, plugin_bin, plugin_name): cmd_args = [plugin_bin, PACKAGE_STATE_MAP["absent"], parse_plugin_repo(plugin_name)] cmd = " ".join(cmd_args) if module.check_mode: rc, out, err = 0, "check mode", "" else: rc, out, err = module.run_command(cmd) if rc != 0: reason = parse_error(out) module.fail_json(msg="Removing plugin '%s' failed: %s" % (plugin_name, reason), err=err) return True, cmd, out, err def get_plugin_bin(module, plugin_bin=None): # Use the plugin_bin that was supplied first before trying other options valid_plugin_bin = None if plugin_bin and os.path.isfile(plugin_bin): valid_plugin_bin = plugin_bin else: # Add the plugin_bin passed into the module to the top of the list of paths to test, # testing for that binary name first before falling back to the default paths. bin_paths = list(PLUGIN_BIN_PATHS) if plugin_bin and plugin_bin not in bin_paths: bin_paths.insert(0, plugin_bin) # Get separate lists of dirs and binary names from the full paths to the # plugin binaries. plugin_dirs = list(set([os.path.dirname(x) for x in bin_paths])) plugin_bins = list(set([os.path.basename(x) for x in bin_paths])) # Check for the binary names in the default system paths as well as the path # specified in the module arguments. for bin_file in plugin_bins: valid_plugin_bin = module.get_bin_path(bin_file, opt_dirs=plugin_dirs) if valid_plugin_bin: break if not valid_plugin_bin: module.fail_json(msg='%s does not exist and no other valid plugin installers were found. Make sure Elasticsearch is installed.' % plugin_bin) return valid_plugin_bin def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), state=dict(default="present", choices=list(PACKAGE_STATE_MAP.keys())), src=dict(default=None), url=dict(default=None), timeout=dict(default="1m"), force=dict(type='bool', default=False), plugin_bin=dict(type="path"), plugin_dir=dict(default="/usr/share/elasticsearch/plugins/", type="path"), proxy_host=dict(default=None), proxy_port=dict(default=None), version=dict(default=None) ), mutually_exclusive=[("src", "url")], supports_check_mode=True ) name = module.params["name"] state = module.params["state"] url = module.params["url"] src = module.params["src"] timeout = module.params["timeout"] force = module.params["force"] plugin_bin = module.params["plugin_bin"] plugin_dir = module.params["plugin_dir"] proxy_host = module.params["proxy_host"] proxy_port = module.params["proxy_port"] version = module.params["version"] # Search provided path and system paths for valid binary plugin_bin = get_plugin_bin(module, plugin_bin) repo = parse_plugin_repo(name) present = is_plugin_present(repo, plugin_dir) # skip if the state is correct if (present and state == "present") or (state == "absent" and not present): module.exit_json(changed=False, name=name, state=state) if state == "present": changed, cmd, out, err = install_plugin(module, plugin_bin, name, version, src, url, proxy_host, proxy_port, timeout, force) elif state == "absent": changed, cmd, out, err = remove_plugin(module, plugin_bin, name) module.exit_json(changed=changed, cmd=cmd, name=name, state=state, url=url, timeout=timeout, stdout=out, stderr=err) if __name__ == '__main__': main() PK $�!\��-�� � O collections/ansible_collections/community/general/plugins/modules/redis_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Pavlo Bashynskyi (@levonet) <levonet@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: redis_info short_description: Gather information about Redis servers version_added: '0.2.0' description: - Gathers information and statistics about Redis servers. extends_documentation_fragment: - community.general.redis - community.general.attributes - community.general.attributes.info_module options: login_user: version_added: 7.5.0 validate_certs: version_added: 7.5.0 tls: default: false version_added: 7.5.0 ca_certs: version_added: 7.5.0 seealso: - module: community.general.redis author: "Pavlo Bashynskyi (@levonet)" ''' EXAMPLES = r''' - name: Get server information community.general.redis_info: register: result - name: Print server information ansible.builtin.debug: var: result.info ''' RETURN = r''' info: description: The default set of server information sections U(https://redis.io/commands/info). returned: success type: dict sample: { "active_defrag_hits": 0, "active_defrag_key_hits": 0, "active_defrag_key_misses": 0, "active_defrag_misses": 0, "active_defrag_running": 0, "allocator_active": 932409344, "allocator_allocated": 932062792, "allocator_frag_bytes": 346552, "allocator_frag_ratio": 1.0, "allocator_resident": 947253248, "allocator_rss_bytes": 14843904, "allocator_rss_ratio": 1.02, "aof_current_rewrite_time_sec": -1, "aof_enabled": 0, "aof_last_bgrewrite_status": "ok", "aof_last_cow_size": 0, "aof_last_rewrite_time_sec": -1, "aof_last_write_status": "ok", "aof_rewrite_in_progress": 0, "aof_rewrite_scheduled": 0, "arch_bits": 64, "atomicvar_api": "atomic-builtin", "blocked_clients": 0, "client_recent_max_input_buffer": 4, "client_recent_max_output_buffer": 0, "cluster_enabled": 0, "config_file": "", "configured_hz": 10, "connected_clients": 4, "connected_slaves": 0, "db0": { "avg_ttl": 1945628530, "expires": 16, "keys": 3341411 }, "evicted_keys": 0, "executable": "/data/redis-server", "expired_keys": 9, "expired_stale_perc": 1.72, "expired_time_cap_reached_count": 0, "gcc_version": "9.2.0", "hz": 10, "instantaneous_input_kbps": 0.0, "instantaneous_ops_per_sec": 0, "instantaneous_output_kbps": 0.0, "keyspace_hits": 0, "keyspace_misses": 0, "latest_fork_usec": 0, "lazyfree_pending_objects": 0, "loading": 0, "lru_clock": 11603632, "master_repl_offset": 118831417, "master_replid": "0d904704e424e38c3cd896783e9f9d28d4836e5e", "master_replid2": "0000000000000000000000000000000000000000", "maxmemory": 0, "maxmemory_human": "0B", "maxmemory_policy": "noeviction", "mem_allocator": "jemalloc-5.1.0", "mem_aof_buffer": 0, "mem_clients_normal": 49694, "mem_clients_slaves": 0, "mem_fragmentation_bytes": 12355480, "mem_fragmentation_ratio": 1.01, "mem_not_counted_for_evict": 0, "mem_replication_backlog": 1048576, "migrate_cached_sockets": 0, "multiplexing_api": "epoll", "number_of_cached_scripts": 0, "os": "Linux 3.10.0-862.14.4.el7.x86_64 x86_64", "process_id": 1, "pubsub_channels": 0, "pubsub_patterns": 0, "rdb_bgsave_in_progress": 0, "rdb_changes_since_last_save": 671, "rdb_current_bgsave_time_sec": -1, "rdb_last_bgsave_status": "ok", "rdb_last_bgsave_time_sec": -1, "rdb_last_cow_size": 0, "rdb_last_save_time": 1588702236, "redis_build_id": "a31260535f820267", "redis_git_dirty": 0, "redis_git_sha1": 0, "redis_mode": "standalone", "redis_version": "999.999.999", "rejected_connections": 0, "repl_backlog_active": 1, "repl_backlog_first_byte_offset": 118707937, "repl_backlog_histlen": 123481, "repl_backlog_size": 1048576, "role": "master", "rss_overhead_bytes": -3051520, "rss_overhead_ratio": 1.0, "run_id": "8d252f66c3ef89bd60a060cf8dc5cfe3d511c5e4", "second_repl_offset": 118830003, "slave_expires_tracked_keys": 0, "sync_full": 0, "sync_partial_err": 0, "sync_partial_ok": 0, "tcp_port": 6379, "total_commands_processed": 885, "total_connections_received": 10, "total_net_input_bytes": 802709255, "total_net_output_bytes": 31754, "total_system_memory": 135029538816, "total_system_memory_human": "125.76G", "uptime_in_days": 53, "uptime_in_seconds": 4631778, "used_cpu_sys": 4.668282, "used_cpu_sys_children": 0.002191, "used_cpu_user": 4.21088, "used_cpu_user_children": 0.0, "used_memory": 931908760, "used_memory_dataset": 910774306, "used_memory_dataset_perc": "97.82%", "used_memory_human": "888.74M", "used_memory_lua": 37888, "used_memory_lua_human": "37.00K", "used_memory_overhead": 21134454, "used_memory_peak": 932015216, "used_memory_peak_human": "888.84M", "used_memory_peak_perc": "99.99%", "used_memory_rss": 944201728, "used_memory_rss_human": "900.46M", "used_memory_scripts": 0, "used_memory_scripts_human": "0B", "used_memory_startup": 791264 } ''' import traceback REDIS_IMP_ERR = None try: from redis import StrictRedis HAS_REDIS_PACKAGE = True except ImportError: REDIS_IMP_ERR = traceback.format_exc() HAS_REDIS_PACKAGE = False from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.redis import ( fail_imports, redis_auth_argument_spec, redis_auth_params) def redis_client(**client_params): return StrictRedis(**client_params) # Module execution. def main(): module = AnsibleModule( argument_spec=redis_auth_argument_spec(tls_default=False), supports_check_mode=True, ) fail_imports(module, module.params['tls']) redis_params = redis_auth_params(module) # Connect and check client = redis_client(**redis_params) try: client.ping() except Exception as e: module.fail_json(msg="unable to connect to database: %s" % to_native(e), exception=traceback.format_exc()) info = client.info() module.exit_json(changed=False, info=info) if __name__ == '__main__': main() PK $�!\� �B B P collections/ansible_collections/community/general/plugins/modules/ibm_sa_pool.pynu �[��� # -*- coding: utf-8 -*- # Copyright (C) 2018 IBM CORPORATION # Author(s): Tzur Eliyahu <tzure@il.ibm.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ibm_sa_pool short_description: Handles pools on IBM Spectrum Accelerate Family storage systems description: - "This module creates or deletes pools to be used on IBM Spectrum Accelerate Family storage systems" attributes: check_mode: support: none diff_mode: support: none options: pool: description: - Pool name. required: true type: str state: description: - Pool state. default: "present" choices: [ "present", "absent" ] type: str size: description: - Pool size in GB required: false type: str snapshot_size: description: - Pool snapshot size in GB required: false type: str domain: description: - Adds the pool to the specified domain. required: false type: str perf_class: description: - Assigns a perf_class to the pool. required: false type: str extends_documentation_fragment: - community.general.ibm_storage - community.general.attributes author: - Tzur Eliyahu (@tzure) ''' EXAMPLES = ''' - name: Create new pool. community.general.ibm_sa_pool: name: pool_name size: 300 state: present username: admin password: secret endpoints: hostdev-system - name: Delete pool. community.general.ibm_sa_pool: name: pool_name state: absent username: admin password: secret endpoints: hostdev-system ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ibm_sa_utils import execute_pyxcli_command, \ connect_ssl, spectrum_accelerate_spec, is_pyxcli_installed def main(): argument_spec = spectrum_accelerate_spec() argument_spec.update( dict( state=dict(default='present', choices=['present', 'absent']), pool=dict(required=True), size=dict(), snapshot_size=dict(), domain=dict(), perf_class=dict() ) ) module = AnsibleModule(argument_spec) is_pyxcli_installed(module) xcli_client = connect_ssl(module) pool = xcli_client.cmd.pool_list( pool=module.params['pool']).as_single_element state = module.params['state'] state_changed = False if state == 'present' and not pool: state_changed = execute_pyxcli_command( module, 'pool_create', xcli_client) if state == 'absent' and pool: state_changed = execute_pyxcli_command( module, 'pool_delete', xcli_client) module.exit_json(changed=state_changed) if __name__ == '__main__': main() PK $�!\��Xڈ � W collections/ansible_collections/community/general/plugins/modules/selinux_permissive.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Michael Scherer <misc@zarb.org> # inspired by code of github.com/dandiker/ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: selinux_permissive short_description: Change permissive domain in SELinux policy description: - Add and remove a domain from the list of permissive domains. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: domain: description: - The domain that will be added or removed from the list of permissive domains. type: str required: true aliases: [ name ] permissive: description: - Indicate if the domain should or should not be set as permissive. type: bool required: true no_reload: description: - Disable reloading of the SELinux policy after making change to a domain's permissive setting. - The default is V(false), which causes policy to be reloaded when a domain changes state. - Reloading the policy does not work on older versions of the C(policycoreutils-python) library, for example in EL 6." type: bool default: false store: description: - Name of the SELinux policy store to use. type: str default: '' notes: - Requires a recent version of SELinux and C(policycoreutils-python) (EL 6 or newer). requirements: [ policycoreutils-python ] author: - Michael Scherer (@mscherer) <misc@zarb.org> ''' EXAMPLES = r''' - name: Change the httpd_t domain to permissive community.general.selinux_permissive: name: httpd_t permissive: true ''' import traceback HAVE_SEOBJECT = False SEOBJECT_IMP_ERR = None try: import seobject HAVE_SEOBJECT = True except ImportError: SEOBJECT_IMP_ERR = traceback.format_exc() from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native def main(): module = AnsibleModule( argument_spec=dict( domain=dict(type='str', required=True, aliases=['name']), store=dict(type='str', default=''), permissive=dict(type='bool', required=True), no_reload=dict(type='bool', default=False), ), supports_check_mode=True, ) # global vars changed = False store = module.params['store'] permissive = module.params['permissive'] domain = module.params['domain'] no_reload = module.params['no_reload'] if not HAVE_SEOBJECT: module.fail_json(changed=False, msg=missing_required_lib("policycoreutils-python"), exception=SEOBJECT_IMP_ERR) try: permissive_domains = seobject.permissiveRecords(store) except ValueError as e: module.fail_json(domain=domain, msg=to_native(e), exception=traceback.format_exc()) # not supported on EL 6 if 'set_reload' in dir(permissive_domains): permissive_domains.set_reload(not no_reload) try: all_domains = permissive_domains.get_all() except ValueError as e: module.fail_json(domain=domain, msg=to_native(e), exception=traceback.format_exc()) if permissive: if domain not in all_domains: if not module.check_mode: try: permissive_domains.add(domain) except ValueError as e: module.fail_json(domain=domain, msg=to_native(e), exception=traceback.format_exc()) changed = True else: if domain in all_domains: if not module.check_mode: try: permissive_domains.delete(domain) except ValueError as e: module.fail_json(domain=domain, msg=to_native(e), exception=traceback.format_exc()) changed = True module.exit_json(changed=changed, store=store, permissive=permissive, domain=domain) if __name__ == '__main__': main() PK $�!\�N�#Y Y R collections/ansible_collections/community/general/plugins/modules/manageiq_tags.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Daniel Korn <korndaniel1@gmail.com> # Copyright (c) 2017, Yaacov Zamir <yzamir@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: manageiq_tags short_description: Management of resource tags in ManageIQ extends_documentation_fragment: - community.general.manageiq - community.general.attributes author: Daniel Korn (@dkorn) description: - The manageiq_tags module supports adding, updating and deleting tags in ManageIQ. attributes: check_mode: support: none diff_mode: support: none options: state: type: str description: - V(absent) - tags should not exist. - V(present) - tags should exist. - > V(list) - list current tags. This state is deprecated and will be removed 8.0.0. Please use the module M(community.general.manageiq_tags_info) instead. choices: ['absent', 'present', 'list'] default: 'present' tags: type: list elements: dict description: - V(tags) - list of dictionaries, each includes C(name) and C(category) keys. - Required if O(state) is V(present) or V(absent). resource_type: type: str description: - The relevant resource type in manageiq. required: true choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template', 'template', 'tenant', 'user'] resource_name: type: str description: - The name of the resource at which tags will be controlled. - Must be specified if O(resource_id) is not set. Both options are mutually exclusive. resource_id: description: - The ID of the resource at which tags will be controlled. - Must be specified if O(resource_name) is not set. Both options are mutually exclusive. type: int version_added: 2.2.0 ''' EXAMPLES = ''' - name: Create new tags for a provider in ManageIQ. community.general.manageiq_tags: resource_name: 'EngLab' resource_type: 'provider' tags: - category: environment name: prod - category: owner name: prod_ops manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' validate_certs: false - name: Create new tags for a provider in ManageIQ. community.general.manageiq_tags: resource_id: 23000000790497 resource_type: 'provider' tags: - category: environment name: prod - category: owner name: prod_ops manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' validate_certs: false - name: Remove tags for a provider in ManageIQ. community.general.manageiq_tags: state: absent resource_name: 'EngLab' resource_type: 'provider' tags: - category: environment name: prod - category: owner name: prod_ops manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' validate_certs: false ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.manageiq import ( ManageIQ, ManageIQTags, manageiq_argument_spec, manageiq_entities ) def main(): actions = {'present': 'assign', 'absent': 'unassign', 'list': 'list'} argument_spec = dict( tags=dict(type='list', elements='dict'), resource_id=dict(type='int'), resource_name=dict(type='str'), resource_type=dict(required=True, type='str', choices=list(manageiq_entities().keys())), state=dict(required=False, type='str', choices=['present', 'absent', 'list'], default='present'), ) # add the manageiq connection arguments to the arguments argument_spec.update(manageiq_argument_spec()) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[["resource_id", "resource_name"]], required_one_of=[["resource_id", "resource_name"]], required_if=[ ('state', 'present', ['tags']), ('state', 'absent', ['tags']) ], ) tags = module.params['tags'] resource_id = module.params['resource_id'] resource_type_key = module.params['resource_type'] resource_name = module.params['resource_name'] state = module.params['state'] if state == "list": module.deprecate( 'The value "list" for "state" is deprecated. Please use community.general.manageiq_tags_info instead.', version='8.0.0', collection_name='community.general' ) # get the action and resource type action = actions[state] resource_type = manageiq_entities()[resource_type_key] manageiq = ManageIQ(module) # query resource id, fail if resource does not exist if resource_id is None: resource_id = manageiq.query_resource_id(resource_type, resource_name) manageiq_tags = ManageIQTags(manageiq, resource_type, resource_id) if action == 'list': # return a list of current tags for this object current_tags = manageiq_tags.query_resource_tags() res_args = dict(changed=False, tags=current_tags) else: # assign or unassign the tags res_args = manageiq_tags.assign_or_unassign_tags(tags, action) module.exit_json(**res_args) if __name__ == "__main__": main() PK $�!\��18� � ^ collections/ansible_collections/community/general/plugins/modules/utm_ca_host_key_cert_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Stephan Schwarz <stearz@gmx.de> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: utm_ca_host_key_cert_info author: - Stephan Schwarz (@stearz) short_description: Get info for a ca host_key_cert entry in Sophos UTM description: - Get info for a ca host_key_cert entry in SOPHOS UTM. attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name: type: str description: - The name of the object. Will be used to identify the entry required: true extends_documentation_fragment: - community.general.utm - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = """ - name: Get info for a ca host_key_cert entry community.general.utm_ca_host_key_cert_info: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestHostKeyCertEntry """ RETURN = """ result: description: The utm object that was created returned: success type: complex contains: _ref: description: The reference name of the object type: str _locked: description: Whether or not the object is currently locked type: bool _type: description: The type of the object type: str name: description: The name of the object type: str ca: description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object. type: str meta: description: A reference to an existing utm_ca_meta_x509 object. type: str certificate: description: The certificate in PEM format type: str comment: description: Comment string (may be empty string) type: str encrypted: description: If encryption is enabled type: bool key: description: Private key in PEM format (may be empty string) type: str """ from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule from ansible.module_utils.common.text.converters import to_native def main(): endpoint = "ca/host_key_cert" key_to_check_for_changes = [] module = UTMModule( argument_spec=dict( name=dict(type='str', required=True) ), supports_check_mode=True, ) try: # This is needed because the bool value only accepts int values in the backend UTM(module, endpoint, key_to_check_for_changes, info_only=True).execute() except Exception as e: module.fail_json(msg=to_native(e)) if __name__ == '__main__': main() PK $�!\g�`�� � ] collections/ansible_collections/community/general/plugins/modules/oneview_san_manager_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_san_manager_info short_description: Retrieve information about one or more of the OneView SAN Managers description: - Retrieve information about one or more of the SAN Managers from OneView - This module was called C(oneview_san_manager_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.oneview_san_manager_info) module no longer returns C(ansible_facts)! requirements: - hpOneView >= 2.0.1 author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: provider_display_name: description: - Provider Display Name. type: str params: description: - List of params to delimit, filter and sort the list of resources. - "params allowed: - V(start): The first item to return, using 0-based indexing. - V(count): The number of resources to return. - V(query): A general query string to narrow the list of resources returned. - V(sort): The sort order of the returned data set." type: dict extends_documentation_fragment: - community.general.oneview - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: Gather information about all SAN Managers community.general.oneview_san_manager_info: config: /etc/oneview/oneview_config.json delegate_to: localhost register: result - name: Print fetched information about SAN Managers ansible.builtin.debug: msg: "{{ result.san_managers }}" - name: Gather paginated, filtered and sorted information about SAN Managers community.general.oneview_san_manager_info: config: /etc/oneview/oneview_config.json params: start: 0 count: 3 sort: name:ascending query: isInternal eq false delegate_to: localhost register: result - name: Print fetched information about paginated, filtered and sorted list of SAN Managers ansible.builtin.debug: msg: "{{ result.san_managers }}" - name: Gather information about a SAN Manager by provider display name community.general.oneview_san_manager_info: config: /etc/oneview/oneview_config.json provider_display_name: Brocade Network Advisor delegate_to: localhost register: result - name: Print fetched information about SAN Manager found by provider display name ansible.builtin.debug: msg: "{{ result.san_managers }}" ''' RETURN = ''' san_managers: description: Has all the OneView information about the SAN Managers. returned: Always, but can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class SanManagerInfoModule(OneViewModuleBase): argument_spec = dict( provider_display_name=dict(type='str'), params=dict(type='dict') ) def __init__(self): super(SanManagerInfoModule, self).__init__( additional_arg_spec=self.argument_spec, supports_check_mode=True, ) self.resource_client = self.oneview_client.san_managers def execute_module(self): if self.module.params.get('provider_display_name'): provider_display_name = self.module.params['provider_display_name'] san_manager = self.oneview_client.san_managers.get_by_provider_display_name(provider_display_name) if san_manager: resources = [san_manager] else: resources = [] else: resources = self.oneview_client.san_managers.get_all(**self.facts_params) return dict(changed=False, san_managers=resources) def main(): SanManagerInfoModule().run() if __name__ == '__main__': main() PK $�!\��IvQ( Q( Q collections/ansible_collections/community/general/plugins/modules/pritunl_user.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Florian Dambrine <android.florian@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: pritunl_user author: "Florian Dambrine (@Lowess)" version_added: 2.3.0 short_description: Manage Pritunl Users using the Pritunl API description: - A module to manage Pritunl users using the Pritunl API. extends_documentation_fragment: - community.general.pritunl - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: organization: type: str required: true aliases: - org description: - The name of the organization the user is part of. state: type: str default: 'present' choices: - present - absent description: - If V(present), the module adds user O(user_name) to the Pritunl O(organization). If V(absent), removes the user O(user_name) from the Pritunl O(organization). user_name: type: str required: true default: null description: - Name of the user to create or delete from Pritunl. user_email: type: str required: false default: null description: - Email address associated with the user O(user_name). user_type: type: str required: false default: client choices: - client - server description: - Type of the user O(user_name). user_groups: type: list elements: str required: false default: null description: - List of groups associated with the user O(user_name). user_disabled: type: bool required: false default: null description: - Enable/Disable the user O(user_name). user_gravatar: type: bool required: false default: null description: - Enable/Disable Gravatar usage for the user O(user_name). user_mac_addresses: type: list elements: str description: - Allowed MAC addresses for the user O(user_name). version_added: 5.0.0 """ EXAMPLES = """ - name: Create the user Foo with email address foo@bar.com in MyOrg community.general.pritunl_user: state: present organization: MyOrg user_name: Foo user_email: foo@bar.com user_mac_addresses: - "00:00:00:00:00:99" - name: Disable the user Foo but keep it in Pritunl community.general.pritunl_user: state: present organization: MyOrg user_name: Foo user_email: foo@bar.com user_disabled: true - name: Make sure the user Foo is not part of MyOrg anymore community.general.pritunl_user: state: absent organization: MyOrg user_name: Foo """ RETURN = """ response: description: JSON representation of Pritunl Users. returned: success type: dict sample: { "audit": false, "auth_type": "google", "bypass_secondary": false, "client_to_client": false, "disabled": false, "dns_mapping": null, "dns_servers": null, "dns_suffix": null, "email": "foo@bar.com", "gravatar": true, "groups": [ "foo", "bar" ], "id": "5d070dafe63q3b2e6s472c3b", "name": "foo@acme.com", "network_links": [], "organization": "58070daee6sf342e6e4s2c36", "organization_name": "Acme", "otp_auth": true, "otp_secret": "35H5EJA3XB2$4CWG", "pin": false, "port_forwarding": [], "servers": [], } """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.dict_transformations import dict_merge from ansible_collections.community.general.plugins.module_utils.net_tools.pritunl.api import ( PritunlException, delete_pritunl_user, get_pritunl_settings, list_pritunl_organizations, list_pritunl_users, post_pritunl_user, pritunl_argument_spec, ) def add_or_update_pritunl_user(module): result = {} org_name = module.params.get("organization") user_name = module.params.get("user_name") user_params = { "name": user_name, "email": module.params.get("user_email"), "groups": module.params.get("user_groups"), "disabled": module.params.get("user_disabled"), "gravatar": module.params.get("user_gravatar"), "mac_addresses": module.params.get("user_mac_addresses"), "type": module.params.get("user_type"), } org_obj_list = list_pritunl_organizations( **dict_merge( get_pritunl_settings(module), {"filters": {"name": org_name}}, ) ) if len(org_obj_list) == 0: module.fail_json( msg="Can not add user to organization '%s' which does not exist" % org_name ) org_id = org_obj_list[0]["id"] # Grab existing users from this org users = list_pritunl_users( **dict_merge( get_pritunl_settings(module), { "organization_id": org_id, "filters": {"name": user_name}, }, ) ) # Check if the pritunl user already exists if len(users) > 0: # Compare remote user params with local user_params and trigger update if needed user_params_changed = False for key in user_params.keys(): # When a param is not specified grab existing ones to prevent from changing it with the PUT request if user_params[key] is None: user_params[key] = users[0][key] # 'groups' and 'mac_addresses' are list comparison if key == "groups" or key == "mac_addresses": if set(users[0][key]) != set(user_params[key]): user_params_changed = True # otherwise it is either a boolean or a string else: if users[0][key] != user_params[key]: user_params_changed = True # Trigger a PUT on the API to update the current user if settings have changed if user_params_changed: response = post_pritunl_user( **dict_merge( get_pritunl_settings(module), { "organization_id": org_id, "user_id": users[0]["id"], "user_data": user_params, }, ) ) result["changed"] = True result["response"] = response else: result["changed"] = False result["response"] = users else: response = post_pritunl_user( **dict_merge( get_pritunl_settings(module), { "organization_id": org_id, "user_data": user_params, }, ) ) result["changed"] = True result["response"] = response module.exit_json(**result) def remove_pritunl_user(module): result = {} org_name = module.params.get("organization") user_name = module.params.get("user_name") org_obj_list = [] org_obj_list = list_pritunl_organizations( **dict_merge( get_pritunl_settings(module), { "filters": {"name": org_name}, }, ) ) if len(org_obj_list) == 0: module.fail_json( msg="Can not remove user '%s' from a non existing organization '%s'" % (user_name, org_name) ) org_id = org_obj_list[0]["id"] # Grab existing users from this org users = list_pritunl_users( **dict_merge( get_pritunl_settings(module), { "organization_id": org_id, "filters": {"name": user_name}, }, ) ) # Check if the pritunl user exists, if not, do nothing if len(users) == 0: result["changed"] = False result["response"] = {} # Otherwise remove the org from Pritunl else: response = delete_pritunl_user( **dict_merge( get_pritunl_settings(module), { "organization_id": org_id, "user_id": users[0]["id"], }, ) ) result["changed"] = True result["response"] = response module.exit_json(**result) def main(): argument_spec = pritunl_argument_spec() argument_spec.update( dict( organization=dict(required=True, type="str", aliases=["org"]), state=dict( required=False, choices=["present", "absent"], default="present" ), user_name=dict(required=True, type="str"), user_type=dict( required=False, choices=["client", "server"], default="client" ), user_email=dict(required=False, type="str", default=None), user_groups=dict(required=False, type="list", elements="str", default=None), user_disabled=dict(required=False, type="bool", default=None), user_gravatar=dict(required=False, type="bool", default=None), user_mac_addresses=dict(required=False, type="list", elements="str", default=None), ) ) module = AnsibleModule(argument_spec=argument_spec) state = module.params.get("state") try: if state == "present": add_or_update_pritunl_user(module) elif state == "absent": remove_pritunl_user(module) except PritunlException as e: module.fail_json(msg=to_native(e)) if __name__ == "__main__": main() PK $�!\}�U� � P collections/ansible_collections/community/general/plugins/modules/ipa_dnszone.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Fran Fitzpatrick (francis.x.fitzpatrick@gmail.com) # Borrowed heavily from other work by Abhijeet Kasurde (akasurde@redhat.com) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_dnszone author: Fran Fitzpatrick (@fxfitz) short_description: Manage FreeIPA DNS Zones description: - Add and delete an IPA DNS Zones using IPA API attributes: check_mode: support: full diff_mode: support: none options: zone_name: description: - The DNS zone name to which needs to be managed. required: true type: str state: description: State to ensure required: false default: present choices: ["absent", "present"] type: str dynamicupdate: description: Apply dynamic update to zone. default: false type: bool allowsyncptr: description: Allow synchronization of forward and reverse records in the zone. default: false type: bool version_added: 4.3.0 extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure dns zone is present community.general.ipa_dnszone: ipa_host: spider.example.com ipa_pass: Passw0rd! state: present zone_name: example.com - name: Ensure dns zone is present and is dynamic update community.general.ipa_dnszone: ipa_host: spider.example.com ipa_pass: Passw0rd! state: present zone_name: example.com dynamicupdate: true - name: Ensure that dns zone is removed community.general.ipa_dnszone: zone_name: example.com ipa_host: localhost ipa_user: admin ipa_pass: topsecret state: absent - name: Ensure dns zone is present and is allowing sync community.general.ipa_dnszone: ipa_host: spider.example.com ipa_pass: Passw0rd! state: present zone_name: example.com allowsyncptr: true ''' RETURN = r''' zone: description: DNS zone as returned by IPA API. returned: always type: dict ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class DNSZoneIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(DNSZoneIPAClient, self).__init__(module, host, port, protocol) def dnszone_find(self, zone_name, details=None): items = {'all': 'true', 'idnsname': zone_name, } if details is not None: items.update(details) return self._post_json( method='dnszone_find', name=zone_name, item=items ) def dnszone_add(self, zone_name=None, details=None): items = {} if details is not None: items.update(details) return self._post_json( method='dnszone_add', name=zone_name, item=items ) def dnszone_mod(self, zone_name=None, details=None): items = {} if details is not None: items.update(details) return self._post_json( method='dnszone_mod', name=zone_name, item=items ) def dnszone_del(self, zone_name=None, record_name=None, details=None): return self._post_json( method='dnszone_del', name=zone_name, item={}) def ensure(module, client): zone_name = module.params['zone_name'] state = module.params['state'] dynamicupdate = module.params['dynamicupdate'] allowsyncptr = module.params['allowsyncptr'] changed = False # does zone exist ipa_dnszone = client.dnszone_find(zone_name) if state == 'present': if not ipa_dnszone: changed = True if not module.check_mode: client.dnszone_add(zone_name=zone_name, details={'idnsallowdynupdate': dynamicupdate, 'idnsallowsyncptr': allowsyncptr}) elif ipa_dnszone['idnsallowdynupdate'][0] != str(dynamicupdate).upper() or \ ipa_dnszone.get('idnsallowsyncptr') and ipa_dnszone['idnsallowsyncptr'][0] != str(allowsyncptr).upper(): changed = True if not module.check_mode: client.dnszone_mod(zone_name=zone_name, details={'idnsallowdynupdate': dynamicupdate, 'idnsallowsyncptr': allowsyncptr}) else: changed = False # state is absent else: # check for generic zone existence if ipa_dnszone: changed = True if not module.check_mode: client.dnszone_del(zone_name=zone_name) return changed, client.dnszone_find(zone_name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(zone_name=dict(type='str', required=True), state=dict(type='str', default='present', choices=['present', 'absent']), dynamicupdate=dict(type='bool', required=False, default=False), allowsyncptr=dict(type='bool', required=False, default=False), ) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, ) client = DNSZoneIPAClient( module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot'] ) try: client.login( username=module.params['ipa_user'], password=module.params['ipa_pass'] ) changed, zone = ensure(module, client) module.exit_json(changed=changed, zone=zone) except Exception as e: module.fail_json(msg=to_native(e)) if __name__ == '__main__': main() PK $�!\@��: R collections/ansible_collections/community/general/plugins/modules/datadog_event.pynu �[��� # -*- coding: utf-8 -*- # # Author: Artūras 'arturaz' Šlajus <x11@arturaz.net> # Author: Naoya Nakazawa <naoya.n@gmail.com> # # This module is proudly sponsored by iGeolise (www.igeolise.com) and # Tiny Lab Productions (www.tinylabproductions.com). # Copyright (c) Ansible project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: datadog_event short_description: Posts events to Datadog service description: - "Allows to post events to Datadog (www.datadoghq.com) service." - "Uses http://docs.datadoghq.com/api/#events API." author: - "Artūras 'arturaz' Šlajus (@arturaz)" - "Naoya Nakazawa (@n0ts)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: api_key: type: str description: ["Your DataDog API key."] required: true app_key: type: str description: ["Your DataDog app key."] required: true title: type: str description: ["The event title."] required: true text: type: str description: ["The body of the event."] required: true date_happened: type: int description: - POSIX timestamp of the event. - Default value is now. priority: type: str description: ["The priority of the event."] default: normal choices: [normal, low] host: type: str description: - Host name to associate with the event. - If not specified, it defaults to the remote system's hostname. api_host: type: str description: - DataDog API endpoint URL. version_added: '3.3.0' tags: type: list elements: str description: ["Comma separated list of tags to apply to the event."] alert_type: type: str description: ["Type of alert."] default: info choices: ['error', 'warning', 'info', 'success'] aggregation_key: type: str description: ["An arbitrary string to use for aggregation."] validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true ''' EXAMPLES = ''' - name: Post an event with low priority community.general.datadog_event: title: Testing from ansible text: Test priority: low api_key: 9775a026f1ca7d1c6c5af9d94d9595a4 app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN - name: Post an event with several tags community.general.datadog_event: title: Testing from ansible text: Test api_key: 9775a026f1ca7d1c6c5af9d94d9595a4 app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN tags: 'aa,bb,#host:{{ inventory_hostname }}' - name: Post an event with several tags to another endpoint community.general.datadog_event: title: Testing from ansible text: Test api_key: 9775a026f1ca7d1c6c5af9d94d9595a4 app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN api_host: 'https://example.datadoghq.eu' tags: - aa - b - '#host:{{ inventory_hostname }}' ''' import platform import traceback # Import Datadog DATADOG_IMP_ERR = None try: from datadog import initialize, api HAS_DATADOG = True except Exception: DATADOG_IMP_ERR = traceback.format_exc() HAS_DATADOG = False from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native def main(): module = AnsibleModule( argument_spec=dict( api_key=dict(required=True, no_log=True), app_key=dict(required=True, no_log=True), api_host=dict(type='str'), title=dict(required=True), text=dict(required=True), date_happened=dict(type='int'), priority=dict(default='normal', choices=['normal', 'low']), host=dict(), tags=dict(type='list', elements='str'), alert_type=dict(default='info', choices=['error', 'warning', 'info', 'success']), aggregation_key=dict(no_log=False), validate_certs=dict(default=True, type='bool'), ) ) # Prepare Datadog if not HAS_DATADOG: module.fail_json(msg=missing_required_lib('datadogpy'), exception=DATADOG_IMP_ERR) options = { 'api_key': module.params['api_key'], 'app_key': module.params['app_key'], } if module.params['api_host'] is not None: options['api_host'] = module.params['api_host'] initialize(**options) _post_event(module) def _post_event(module): try: if module.params['host'] is None: module.params['host'] = platform.node().split('.')[0] msg = api.Event.create(title=module.params['title'], text=module.params['text'], host=module.params['host'], tags=module.params['tags'], priority=module.params['priority'], alert_type=module.params['alert_type'], aggregation_key=module.params['aggregation_key'], source_type_name='ansible') if msg['status'] != 'ok': module.fail_json(msg=msg) module.exit_json(changed=True, msg=msg) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\�M�� � P collections/ansible_collections/community/general/plugins/modules/portinstall.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, berenddeboer # Written by berenddeboer <berend@pobox.com> # Based on pkgng module written by bleader <bleader at ratonland.org> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: portinstall short_description: Installing packages from FreeBSD's ports system description: - Manage packages for FreeBSD using 'portinstall'. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - name of package to install/remove aliases: [pkg] required: true type: str state: description: - state of the package choices: [ 'present', 'absent' ] required: false default: present type: str use_packages: description: - use packages instead of ports whenever available type: bool required: false default: true author: "berenddeboer (@berenddeboer)" ''' EXAMPLES = ''' - name: Install package foo community.general.portinstall: name: foo state: present - name: Install package security/cyrus-sasl2-saslauthd community.general.portinstall: name: security/cyrus-sasl2-saslauthd state: present - name: Remove packages foo and bar community.general.portinstall: name: foo,bar state: absent ''' import re from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves import shlex_quote def query_package(module, name): pkg_info_path = module.get_bin_path('pkg_info', False) # Assume that if we have pkg_info, we haven't upgraded to pkgng if pkg_info_path: pkgng = False pkg_glob_path = module.get_bin_path('pkg_glob', True) rc, out, err = module.run_command("%s -e `pkg_glob %s`" % (pkg_info_path, shlex_quote(name)), use_unsafe_shell=True) else: pkgng = True pkg_info_path = module.get_bin_path('pkg', True) pkg_info_path = pkg_info_path + " info" rc, out, err = module.run_command("%s %s" % (pkg_info_path, name)) found = rc == 0 if not found: # databases/mysql55-client installs as mysql-client, so try solving # that the ugly way. Pity FreeBSD doesn't have a fool proof way of checking # some package is installed name_without_digits = re.sub('[0-9]', '', name) if name != name_without_digits: if pkgng: rc, out, err = module.run_command("%s %s" % (pkg_info_path, name_without_digits)) else: rc, out, err = module.run_command("%s %s" % (pkg_info_path, name_without_digits)) found = rc == 0 return found def matching_packages(module, name): ports_glob_path = module.get_bin_path('ports_glob', True) rc, out, err = module.run_command("%s %s" % (ports_glob_path, name)) # counts the number of packages found occurrences = out.count('\n') if occurrences == 0: name_without_digits = re.sub('[0-9]', '', name) if name != name_without_digits: rc, out, err = module.run_command("%s %s" % (ports_glob_path, name_without_digits)) occurrences = out.count('\n') return occurrences def remove_packages(module, packages): remove_c = 0 pkg_glob_path = module.get_bin_path('pkg_glob', True) # If pkg_delete not found, we assume pkgng pkg_delete_path = module.get_bin_path('pkg_delete', False) if not pkg_delete_path: pkg_delete_path = module.get_bin_path('pkg', True) pkg_delete_path = pkg_delete_path + " delete -y" # Using a for loop in case of error, we can report the package that failed for package in packages: # Query the package first, to see if we even need to remove if not query_package(module, package): continue rc, out, err = module.run_command("%s `%s %s`" % (pkg_delete_path, pkg_glob_path, shlex_quote(package)), use_unsafe_shell=True) if query_package(module, package): name_without_digits = re.sub('[0-9]', '', package) rc, out, err = module.run_command("%s `%s %s`" % (pkg_delete_path, pkg_glob_path, shlex_quote(name_without_digits)), use_unsafe_shell=True) if query_package(module, package): module.fail_json(msg="failed to remove %s: %s" % (package, out)) remove_c += 1 if remove_c > 0: module.exit_json(changed=True, msg="removed %s package(s)" % remove_c) module.exit_json(changed=False, msg="package(s) already absent") def install_packages(module, packages, use_packages): install_c = 0 # If portinstall not found, automagically install portinstall_path = module.get_bin_path('portinstall', False) if not portinstall_path: pkg_path = module.get_bin_path('pkg', False) if pkg_path: module.run_command("pkg install -y portupgrade") portinstall_path = module.get_bin_path('portinstall', True) if use_packages: portinstall_params = "--use-packages" else: portinstall_params = "" for package in packages: if query_package(module, package): continue # TODO: check how many match matches = matching_packages(module, package) if matches == 1: rc, out, err = module.run_command("%s --batch %s %s" % (portinstall_path, portinstall_params, package)) if not query_package(module, package): module.fail_json(msg="failed to install %s: %s" % (package, out)) elif matches == 0: module.fail_json(msg="no matches for package %s" % (package)) else: module.fail_json(msg="%s matches found for package name %s" % (matches, package)) install_c += 1 if install_c > 0: module.exit_json(changed=True, msg="present %s package(s)" % (install_c)) module.exit_json(changed=False, msg="package(s) already present") def main(): module = AnsibleModule( argument_spec=dict( state=dict(default="present", choices=["present", "absent"]), name=dict(aliases=["pkg"], required=True), use_packages=dict(type='bool', default=True))) p = module.params pkgs = p["name"].split(",") if p["state"] == "present": install_packages(module, pkgs, p["use_packages"]) elif p["state"] == "absent": remove_packages(module, pkgs) if __name__ == '__main__': main() PK $�!\��� � Q collections/ansible_collections/community/general/plugins/modules/easy_install.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2012, Matt Wright <matt@nobien.net> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: easy_install short_description: Installs Python libraries description: - Installs Python libraries, optionally in a C(virtualenv) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - A Python library name. required: true virtualenv: type: str description: - An optional O(virtualenv) directory path to install into. If the O(virtualenv) does not exist, it is created automatically. virtualenv_site_packages: description: - Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created. type: bool default: false virtualenv_command: type: str description: - The command to create the virtual environment with. For example V(pyvenv), V(virtualenv), V(virtualenv2). default: virtualenv executable: type: str description: - The explicit executable or a pathname to the executable to be used to run easy_install for a specific version of Python installed in the system. For example V(easy_install-3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run easy_install for the Python 3.3 installation. default: easy_install state: type: str description: - The desired state of the library. V(latest) ensures that the latest version is installed. choices: [present, latest] default: present notes: - Please note that the C(easy_install) module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the M(ansible.builtin.pip) module which you can first install using M(community.general.easy_install). - Also note that C(virtualenv) must be installed on the remote host if the O(virtualenv) parameter is specified. requirements: [ "virtualenv" ] author: "Matt Wright (@mattupstate)" ''' EXAMPLES = ''' - name: Install or update pip community.general.easy_install: name: pip state: latest - name: Install Bottle into the specified virtualenv community.general.easy_install: name: bottle virtualenv: /webapps/myapp/venv ''' import os import os.path import tempfile from ansible.module_utils.basic import AnsibleModule def install_package(module, name, easy_install, executable_arguments): cmd = '%s %s %s' % (easy_install, ' '.join(executable_arguments), name) rc, out, err = module.run_command(cmd) return rc, out, err def _is_package_installed(module, name, easy_install, executable_arguments): # Copy and add to the arguments executable_arguments = executable_arguments[:] executable_arguments.append('--dry-run') rc, out, err = install_package(module, name, easy_install, executable_arguments) if rc: module.fail_json(msg=err) return 'Downloading' not in out def _get_easy_install(module, env=None, executable=None): candidate_easy_inst_basenames = ['easy_install'] easy_install = None if executable is not None: if os.path.isabs(executable): easy_install = executable else: candidate_easy_inst_basenames.insert(0, executable) if easy_install is None: if env is None: opt_dirs = [] else: # Try easy_install with the virtualenv directory first. opt_dirs = ['%s/bin' % env] for basename in candidate_easy_inst_basenames: easy_install = module.get_bin_path(basename, False, opt_dirs) if easy_install is not None: break # easy_install should have been found by now. The final call to # get_bin_path will trigger fail_json. if easy_install is None: basename = candidate_easy_inst_basenames[0] easy_install = module.get_bin_path(basename, True, opt_dirs) return easy_install def main(): arg_spec = dict( name=dict(required=True), state=dict(required=False, default='present', choices=['present', 'latest'], type='str'), virtualenv=dict(default=None, required=False), virtualenv_site_packages=dict(default=False, type='bool'), virtualenv_command=dict(default='virtualenv', required=False), executable=dict(default='easy_install', required=False), ) module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True) name = module.params['name'] env = module.params['virtualenv'] executable = module.params['executable'] site_packages = module.params['virtualenv_site_packages'] virtualenv_command = module.params['virtualenv_command'] executable_arguments = [] if module.params['state'] == 'latest': executable_arguments.append('--upgrade') rc = 0 err = '' out = '' if env: virtualenv = module.get_bin_path(virtualenv_command, True) if not os.path.exists(os.path.join(env, 'bin', 'activate')): if module.check_mode: module.exit_json(changed=True) command = '%s %s' % (virtualenv, env) if site_packages: command += ' --system-site-packages' cwd = tempfile.gettempdir() rc_venv, out_venv, err_venv = module.run_command(command, cwd=cwd) rc += rc_venv out += out_venv err += err_venv easy_install = _get_easy_install(module, env, executable) cmd = None changed = False installed = _is_package_installed(module, name, easy_install, executable_arguments) if not installed: if module.check_mode: module.exit_json(changed=True) rc_easy_inst, out_easy_inst, err_easy_inst = install_package(module, name, easy_install, executable_arguments) rc += rc_easy_inst out += out_easy_inst err += err_easy_inst changed = True if rc != 0: module.fail_json(msg=err, cmd=cmd) module.exit_json(changed=changed, binary=easy_install, name=name, virtualenv=env) if __name__ == '__main__': main() PK $�!\I��I# I# b collections/ansible_collections/community/general/plugins/modules/bitbucket_pipeline_known_host.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: bitbucket_pipeline_known_host short_description: Manages Bitbucket pipeline known hosts description: - Manages Bitbucket pipeline known hosts under the "SSH Keys" menu. - The host fingerprint will be retrieved automatically, but in case of an error, one can use O(key) field to specify it manually. author: - Evgeniy Krysanov (@catcombo) extends_documentation_fragment: - community.general.bitbucket - community.general.attributes requirements: - paramiko attributes: check_mode: support: full diff_mode: support: none options: repository: description: - The repository name. type: str required: true workspace: description: - The repository owner. - "B(Note:) O(ignore:username) used to be an alias of this option. Since community.general 6.0.0 it is an alias of O(user)." type: str required: true name: description: - The FQDN of the known host. type: str required: true key: description: - The public key. type: str state: description: - Indicates desired state of the record. type: str required: true choices: [ absent, present ] notes: - Check mode is supported. ''' EXAMPLES = r''' - name: Create known hosts from the list community.general.bitbucket_pipeline_known_host: repository: 'bitbucket-repo' workspace: bitbucket_workspace name: '{{ item }}' state: present with_items: - bitbucket.org - example.com - name: Remove known host community.general.bitbucket_pipeline_known_host: repository: bitbucket-repo workspace: bitbucket_workspace name: bitbucket.org state: absent - name: Specify public key file community.general.bitbucket_pipeline_known_host: repository: bitbucket-repo workspace: bitbucket_workspace name: bitbucket.org key: '{{lookup("file", "bitbucket.pub") }}' state: absent ''' RETURN = r''' # ''' import socket try: import paramiko HAS_PARAMIKO = True except ImportError: HAS_PARAMIKO = False from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper error_messages = { 'invalid_params': 'Account or repository was not found', 'unknown_key_type': 'Public key type is unknown', } BITBUCKET_API_ENDPOINTS = { 'known-host-list': '%s/2.0/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/' % BitbucketHelper.BITBUCKET_API_URL, 'known-host-detail': '%s/2.0/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}' % BitbucketHelper.BITBUCKET_API_URL, } def get_existing_known_host(module, bitbucket): """ Search for a host in Bitbucket pipelines known hosts with the name specified in module param `name` :param module: instance of the :class:`AnsibleModule` :param bitbucket: instance of the :class:`BitbucketHelper` :return: existing host or None if not found :rtype: dict or None Return example:: { 'type': 'pipeline_known_host', 'uuid': '{21cc0590-bebe-4fae-8baf-03722704119a7}' 'hostname': 'bitbucket.org', 'public_key': { 'type': 'pipeline_ssh_public_key', 'md5_fingerprint': 'md5:97:8c:1b:f2:6f:14:6b:4b:3b:ec:aa:46:46:74:7c:40', 'sha256_fingerprint': 'SHA256:zzXQOXSFBEiUtuE8AikoYKwbHaxvSc0ojez9YXaGp1A', 'key_type': 'ssh-rsa', 'key': 'AAAAB3NzaC1yc2EAAAABIwAAAQEAubiN81eDcafrgMeLzaFPsw2kN...seeFVBoGqzHM9yXw==' }, } """ content = { 'next': BITBUCKET_API_ENDPOINTS['known-host-list'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], ) } # Look through all response pages in search of hostname we need while 'next' in content: info, content = bitbucket.request( api_url=content['next'], method='GET', ) if info['status'] == 404: module.fail_json(msg='Invalid `repository` or `workspace`.') if info['status'] != 200: module.fail_json(msg='Failed to retrieve list of known hosts: {0}'.format(info)) host = next(filter(lambda v: v['hostname'] == module.params['name'], content['values']), None) if host is not None: return host return None def get_host_key(module, hostname): """ Fetches public key for specified host :param module: instance of the :class:`AnsibleModule` :param hostname: host name :return: key type and key content :rtype: tuple Return example:: ( 'ssh-rsa', 'AAAAB3NzaC1yc2EAAAABIwAAA...SBne8+seeFVBoGqzHM9yXw==', ) """ try: sock = socket.socket() sock.connect((hostname, 22)) except socket.error: module.fail_json(msg='Error opening socket to {0}'.format(hostname)) try: trans = paramiko.transport.Transport(sock) trans.start_client() host_key = trans.get_remote_server_key() except paramiko.SSHException: module.fail_json(msg='SSH error on retrieving {0} server key'.format(hostname)) trans.close() sock.close() key_type = host_key.get_name() key = host_key.get_base64() return key_type, key def create_known_host(module, bitbucket): hostname = module.params['name'] key_param = module.params['key'] if key_param is None: key_type, key = get_host_key(module, hostname) elif ' ' in key_param: key_type, key = key_param.split(' ', 1) else: module.fail_json(msg=error_messages['unknown_key_type']) info, content = bitbucket.request( api_url=BITBUCKET_API_ENDPOINTS['known-host-list'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], ), method='POST', data={ 'hostname': hostname, 'public_key': { 'key_type': key_type, 'key': key, } }, ) if info['status'] == 404: module.fail_json(msg=error_messages['invalid_params']) if info['status'] != 201: module.fail_json(msg='Failed to create known host `{hostname}`: {info}'.format( hostname=module.params['hostname'], info=info, )) def delete_known_host(module, bitbucket, known_host_uuid): info, content = bitbucket.request( api_url=BITBUCKET_API_ENDPOINTS['known-host-detail'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], known_host_uuid=known_host_uuid, ), method='DELETE', ) if info['status'] == 404: module.fail_json(msg=error_messages['invalid_params']) if info['status'] != 204: module.fail_json(msg='Failed to delete known host `{hostname}`: {info}'.format( hostname=module.params['name'], info=info, )) def main(): argument_spec = BitbucketHelper.bitbucket_argument_spec() argument_spec.update( repository=dict(type='str', required=True), workspace=dict(type='str', required=True), name=dict(type='str', required=True), key=dict(type='str', no_log=False), state=dict(type='str', choices=['present', 'absent'], required=True), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_one_of=BitbucketHelper.bitbucket_required_one_of(), required_together=BitbucketHelper.bitbucket_required_together(), ) if (module.params['key'] is None) and (not HAS_PARAMIKO): module.fail_json(msg='`paramiko` package not found, please install it.') bitbucket = BitbucketHelper(module) # Retrieve access token for authorized API requests bitbucket.fetch_access_token() # Retrieve existing known host existing_host = get_existing_known_host(module, bitbucket) state = module.params['state'] changed = False # Create new host in case it doesn't exists if not existing_host and (state == 'present'): if not module.check_mode: create_known_host(module, bitbucket) changed = True # Delete host elif existing_host and (state == 'absent'): if not module.check_mode: delete_known_host(module, bitbucket, existing_host['uuid']) changed = True module.exit_json(changed=changed) if __name__ == '__main__': main() PK $�!\9CLpm m a collections/ansible_collections/community/general/plugins/modules/scaleway_security_group_rule.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway Security Group Rule management module # # Copyright (C) 2018 Antoine Barbare (antoinebarbare@gmail.com). # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_security_group_rule short_description: Scaleway Security Group Rule management module author: Antoine Barbare (@abarbare) description: - "This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com)." extends_documentation_fragment: - community.general.scaleway - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: type: str description: - Indicate desired state of the Security Group Rule. default: present choices: - present - absent region: type: str description: - Scaleway region to use (for example V(par1)). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 protocol: type: str description: - Network protocol to use. choices: - TCP - UDP - ICMP required: true port: description: - Port related to the rule, null value for all the ports. required: true type: int ip_range: type: str description: - IPV4 CIDR notation to apply to the rule. default: 0.0.0.0/0 direction: type: str description: - Rule direction. choices: - inbound - outbound required: true action: type: str description: - Rule action. choices: - accept - drop required: true security_group: type: str description: - Security Group unique identifier. required: true ''' EXAMPLES = ''' - name: Create a Security Group Rule community.general.scaleway_security_group_rule: state: present region: par1 protocol: TCP port: 80 ip_range: 0.0.0.0/0 direction: inbound action: accept security_group: b57210ee-1281-4820-a6db-329f78596ecb register: security_group_rule_creation_task ''' RETURN = ''' data: description: This is only present when O(state=present). returned: when O(state=present) type: dict sample: { "scaleway_security_group_rule": { "direction": "inbound", "protocol": "TCP", "ip_range": "0.0.0.0/0", "dest_port_from": 80, "action": "accept", "position": 2, "dest_port_to": null, "editable": null, "id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9" } } ''' from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway, payload_from_object from ansible.module_utils.basic import AnsibleModule def get_sgr_from_api(security_group_rules, security_group_rule): """ Check if a security_group_rule specs are present in security_group_rules Return None if no rules match the specs Return the rule if found """ for sgr in security_group_rules: if (sgr['ip_range'] == security_group_rule['ip_range'] and sgr['dest_port_from'] == security_group_rule['dest_port_from'] and sgr['direction'] == security_group_rule['direction'] and sgr['action'] == security_group_rule['action'] and sgr['protocol'] == security_group_rule['protocol']): return sgr return None def present_strategy(api, security_group_id, security_group_rule): ret = {'changed': False} response = api.get('security_groups/%s/rules' % security_group_id) if not response.ok: api.module.fail_json( msg='Error getting security group rules "%s": "%s" (%s)' % (response.info['msg'], response.json['message'], response.json)) existing_rule = get_sgr_from_api( response.json['rules'], security_group_rule) if not existing_rule: ret['changed'] = True if api.module.check_mode: return ret # Create Security Group Rule response = api.post('/security_groups/%s/rules' % security_group_id, data=payload_from_object(security_group_rule)) if not response.ok: api.module.fail_json( msg='Error during security group rule creation: "%s": "%s" (%s)' % (response.info['msg'], response.json['message'], response.json)) ret['scaleway_security_group_rule'] = response.json['rule'] else: ret['scaleway_security_group_rule'] = existing_rule return ret def absent_strategy(api, security_group_id, security_group_rule): ret = {'changed': False} response = api.get('security_groups/%s/rules' % security_group_id) if not response.ok: api.module.fail_json( msg='Error getting security group rules "%s": "%s" (%s)' % (response.info['msg'], response.json['message'], response.json)) existing_rule = get_sgr_from_api( response.json['rules'], security_group_rule) if not existing_rule: return ret ret['changed'] = True if api.module.check_mode: return ret response = api.delete( '/security_groups/%s/rules/%s' % (security_group_id, existing_rule['id'])) if not response.ok: api.module.fail_json( msg='Error deleting security group rule "%s": "%s" (%s)' % (response.info['msg'], response.json['message'], response.json)) return ret def core(module): api = Scaleway(module=module) security_group_rule = { 'protocol': module.params['protocol'], 'dest_port_from': module.params['port'], 'ip_range': module.params['ip_range'], 'direction': module.params['direction'], 'action': module.params['action'], } region = module.params['region'] module.params['api_url'] = SCALEWAY_LOCATION[region]['api_endpoint'] if module.params['state'] == 'present': summary = present_strategy( api=api, security_group_id=module.params['security_group'], security_group_rule=security_group_rule) else: summary = absent_strategy( api=api, security_group_id=module.params['security_group'], security_group_rule=security_group_rule) module.exit_json(**summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update( state=dict(type='str', default='present', choices=['absent', 'present']), region=dict(type='str', required=True, choices=list(SCALEWAY_LOCATION.keys())), protocol=dict(type='str', required=True, choices=['TCP', 'UDP', 'ICMP']), port=dict(type='int', required=True), ip_range=dict(type='str', default='0.0.0.0/0'), direction=dict(type='str', required=True, choices=['inbound', 'outbound']), action=dict(type='str', required=True, choices=['accept', 'drop']), security_group=dict(type='str', required=True), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\�3�p p N collections/ansible_collections/community/general/plugins/modules/bearychat.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Jiangge Zhang <tonyseek@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: bearychat short_description: Send BearyChat notifications description: - The M(community.general.bearychat) module sends notifications to U(https://bearychat.com) via the Incoming Robot integration. author: "Jiangge Zhang (@tonyseek)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: url: type: str description: - BearyChat WebHook URL. This authenticates you to the bearychat service. It looks like V(https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60). required: true text: type: str description: - Message to send. markdown: description: - If V(true), text will be parsed as markdown. default: true type: bool channel: type: str description: - Channel to send the message to. If absent, the message goes to the default channel selected by the O(url). attachments: type: list elements: dict description: - Define a list of attachments. For more information, see https://github.com/bearyinnovative/bearychat-tutorial/blob/master/robots/incoming.md#attachments ''' EXAMPLES = """ - name: Send notification message via BearyChat local_action: module: bearychat url: | https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60 text: "{{ inventory_hostname }} completed" - name: Send notification message via BearyChat all options local_action: module: bearychat url: | https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60 text: "{{ inventory_hostname }} completed" markdown: false channel: "#ansible" attachments: - title: "Ansible on {{ inventory_hostname }}" text: "May the Force be with you." color: "#ffffff" images: - http://example.com/index.png """ RETURN = """ msg: description: execution result returned: success type: str sample: "OK" """ try: from ansible.module_utils.six.moves.urllib.parse import urlparse, urlunparse HAS_URLPARSE = True except Exception: HAS_URLPARSE = False from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def build_payload_for_bearychat(module, text, markdown, channel, attachments): payload = {} if text is not None: payload['text'] = text if markdown is not None: payload['markdown'] = markdown if channel is not None: payload['channel'] = channel if attachments is not None: payload.setdefault('attachments', []).extend( build_payload_for_bearychat_attachment( module, item.get('title'), item.get('text'), item.get('color'), item.get('images')) for item in attachments) payload = 'payload=%s' % module.jsonify(payload) return payload def build_payload_for_bearychat_attachment(module, title, text, color, images): attachment = {} if title is not None: attachment['title'] = title if text is not None: attachment['text'] = text if color is not None: attachment['color'] = color if images is not None: target_images = attachment.setdefault('images', []) if not isinstance(images, (list, tuple)): images = [images] for image in images: if isinstance(image, dict) and 'url' in image: image = {'url': image['url']} elif hasattr(image, 'startswith') and image.startswith('http'): image = {'url': image} else: module.fail_json( msg="BearyChat doesn't have support for this kind of " "attachment image") target_images.append(image) return attachment def do_notify_bearychat(module, url, payload): response, info = fetch_url(module, url, data=payload) if info['status'] != 200: url_info = urlparse(url) obscured_incoming_webhook = urlunparse( (url_info.scheme, url_info.netloc, '[obscured]', '', '', '')) module.fail_json( msg=" failed to send %s to %s: %s" % ( payload, obscured_incoming_webhook, info['msg'])) def main(): module = AnsibleModule(argument_spec={ 'url': dict(type='str', required=True, no_log=True), 'text': dict(type='str'), 'markdown': dict(default=True, type='bool'), 'channel': dict(type='str'), 'attachments': dict(type='list', elements='dict'), }) if not HAS_URLPARSE: module.fail_json(msg='urlparse is not installed') url = module.params['url'] text = module.params['text'] markdown = module.params['markdown'] channel = module.params['channel'] attachments = module.params['attachments'] payload = build_payload_for_bearychat( module, text, markdown, channel, attachments) do_notify_bearychat(module, url, payload) module.exit_json(msg="OK") if __name__ == '__main__': main() PK $�!\��+0= = R collections/ansible_collections/community/general/plugins/modules/webfaction_db.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Quentin Stafford-Fraser, with contributions gratefully acknowledged from: # * Andy Baker # * Federico Tarantini # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # Create a webfaction database using Ansible and the Webfaction API from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- deprecated: removed_in: 9.0.0 why: the endpoints this module relies on do not exist any more and do not resolve to IPs in DNS. alternative: no known alternative at this point module: webfaction_db short_description: Add or remove a database on Webfaction description: - Add or remove a database on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction. author: Quentin Stafford-Fraser (@quentinsf) notes: - > You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API. The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as your host, you may want to add C(serial=1) to the plays. - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name of the database required: true type: str state: description: - Whether the database should exist choices: ['present', 'absent'] default: "present" type: str type: description: - The type of database to create. required: true choices: ['mysql', 'postgresql'] type: str password: description: - The password for the new database user. type: str login_name: description: - The webfaction account to use required: true type: str login_password: description: - The webfaction password to use required: true type: str machine: description: - The machine name to use (optional for accounts with only one machine) type: str ''' EXAMPLES = ''' # This will also create a default DB user with the same # name as the database, and the specified password. - name: Create a database community.general.webfaction_db: name: "{{webfaction_user}}_db1" password: mytestsql type: mysql login_name: "{{webfaction_user}}" login_password: "{{webfaction_passwd}}" machine: "{{webfaction_machine}}" # Note that, for symmetry's sake, deleting a database using # 'state: absent' will also delete the matching user. ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves import xmlrpc_client webfaction = xmlrpc_client.ServerProxy('https://api.webfaction.com/') def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), state=dict(choices=['present', 'absent'], default='present'), # You can specify an IP address or hostname. type=dict(required=True, choices=['mysql', 'postgresql']), password=dict(no_log=True), login_name=dict(required=True), login_password=dict(required=True, no_log=True), machine=dict(), ), supports_check_mode=True ) db_name = module.params['name'] db_state = module.params['state'] db_type = module.params['type'] db_passwd = module.params['password'] if module.params['machine']: session_id, account = webfaction.login( module.params['login_name'], module.params['login_password'], module.params['machine'] ) else: session_id, account = webfaction.login( module.params['login_name'], module.params['login_password'] ) db_list = webfaction.list_dbs(session_id) db_map = dict([(i['name'], i) for i in db_list]) existing_db = db_map.get(db_name) user_list = webfaction.list_db_users(session_id) user_map = dict([(i['username'], i) for i in user_list]) existing_user = user_map.get(db_name) result = {} # Here's where the real stuff happens if db_state == 'present': # Does a database with this name already exist? if existing_db: # Yes, but of a different type - fail if existing_db['db_type'] != db_type: module.fail_json(msg="Database already exists but is a different type. Please fix by hand.") # If it exists with the right type, we don't change anything. module.exit_json( changed=False, ) if not module.check_mode: # If this isn't a dry run, create the db # and default user. result.update( webfaction.create_db( session_id, db_name, db_type, db_passwd ) ) elif db_state == 'absent': # If this isn't a dry run... if not module.check_mode: if not (existing_db or existing_user): module.exit_json(changed=False,) if existing_db: # Delete the db if it exists result.update( webfaction.delete_db(session_id, db_name, db_type) ) if existing_user: # Delete the default db user if it exists result.update( webfaction.delete_db_user(session_id, db_name, db_type) ) else: module.fail_json(msg="Unknown state specified: {0}".format(db_state)) module.exit_json( changed=True, result=result ) if __name__ == '__main__': main() PK $�!\`��P P W collections/ansible_collections/community/general/plugins/modules/online_server_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) Ansible project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: online_server_info short_description: Gather information about Online servers description: - Gather information about the servers. - U(https://www.online.net/en/dedicated-server) author: - "Remy Leone (@remyleone)" extends_documentation_fragment: - community.general.online - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = r''' - name: Gather Online server information community.general.online_server_info: api_token: '0d1627e8-bbf0-44c5-a46f-5c4d3aef033f' register: result - ansible.builtin.debug: msg: "{{ result.online_server_info }}" ''' RETURN = r''' online_server_info: description: - Response from Online API. - "For more details please refer to: U(https://console.online.net/en/api/)." returned: success type: list elements: dict sample: "online_server_info": [ { "abuse": "abuse@example.com", "anti_ddos": false, "bmc": { "session_key": null }, "boot_mode": "normal", "contacts": { "owner": "foobar", "tech": "foobar" }, "disks": [ { "$ref": "/api/v1/server/hardware/disk/68452" }, { "$ref": "/api/v1/server/hardware/disk/68453" } ], "drive_arrays": [ { "disks": [ { "$ref": "/api/v1/server/hardware/disk/68452" }, { "$ref": "/api/v1/server/hardware/disk/68453" } ], "raid_controller": { "$ref": "/api/v1/server/hardware/raidController/9910" }, "raid_level": "RAID1" } ], "hardware_watch": true, "hostname": "sd-42", "id": 42, "ip": [ { "address": "195.154.172.149", "mac": "28:92:4a:33:5e:c6", "reverse": "195-154-172-149.rev.poneytelecom.eu.", "switch_port_state": "up", "type": "public" }, { "address": "10.90.53.212", "mac": "28:92:4a:33:5e:c7", "reverse": null, "switch_port_state": "up", "type": "private" } ], "last_reboot": "2018-08-23T08:32:03.000Z", "location": { "block": "A", "datacenter": "DC3", "position": 19, "rack": "A23", "room": "4 4-4" }, "network": { "ip": [ "195.154.172.149" ], "ipfo": [], "private": [ "10.90.53.212" ] }, "offer": "Pro-1-S-SATA", "os": { "name": "FreeBSD", "version": "11.1-RELEASE" }, "power": "ON", "proactive_monitoring": false, "raid_controllers": [ { "$ref": "/api/v1/server/hardware/raidController/9910" } ], "support": "Basic service level" } ] ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.online import ( Online, OnlineException, online_argument_spec ) class OnlineServerInfo(Online): def __init__(self, module): super(OnlineServerInfo, self).__init__(module) self.name = 'api/v1/server' def _get_server_detail(self, server_path): try: return self.get(path=server_path).json except OnlineException as exc: self.module.fail_json(msg="A problem occurred while fetching: %s (%s)" % (server_path, exc)) def all_detailed_servers(self): servers_api_path = self.get_resources() server_data = ( self._get_server_detail(server_api_path) for server_api_path in servers_api_path ) return [s for s in server_data if s is not None] def main(): module = AnsibleModule( argument_spec=online_argument_spec(), supports_check_mode=True, ) try: servers_info = OnlineServerInfo(module).all_detailed_servers() module.exit_json( online_server_info=servers_info ) except OnlineException as exc: module.fail_json(msg=exc.message) if __name__ == '__main__': main() PK $�!\��{OM OM H collections/ansible_collections/community/general/plugins/modules/lvg.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Alexander Bulimov <lazywolf0@gmail.com> # Based on lvol module by Jeroen Hoekx <jeroen.hoekx@dsquare.be> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- author: - Alexander Bulimov (@abulimov) module: lvg short_description: Configure LVM volume groups description: - This module creates, removes or resizes volume groups. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: vg: description: - The name of the volume group. type: str required: true pvs: description: - List of comma-separated devices to use as physical devices in this volume group. - Required when creating or resizing volume group. - The module will take care of running pvcreate if needed. type: list elements: str pesize: description: - "The size of the physical extent. O(pesize) must be a power of 2 of at least 1 sector (where the sector size is the largest sector size of the PVs currently used in the VG), or at least 128KiB." - Since Ansible 2.6, pesize can be optionally suffixed by a UNIT (k/K/m/M/g/G), default unit is megabyte. type: str default: "4" pv_options: description: - Additional options to pass to C(pvcreate) when creating the volume group. type: str default: '' pvresize: description: - If V(true), resize the physical volume to the maximum available size. type: bool default: false version_added: '0.2.0' vg_options: description: - Additional options to pass to C(vgcreate) when creating the volume group. type: str default: '' state: description: - Control if the volume group exists and it's state. - The states V(active) and V(inactive) implies V(present) state. Added in 7.1.0 - "If V(active) or V(inactive), the module manages the VG's logical volumes current state. The module also handles the VG's autoactivation state if supported unless when creating a volume group and the autoactivation option specified in O(vg_options)." type: str choices: [ absent, present, active, inactive ] default: present force: description: - If V(true), allows to remove volume group with logical volumes. type: bool default: false reset_vg_uuid: description: - Whether the volume group's UUID is regenerated. - This is B(not idempotent). Specifying this parameter always results in a change. type: bool default: false version_added: 7.1.0 reset_pv_uuid: description: - Whether the volume group's physical volumes' UUIDs are regenerated. - This is B(not idempotent). Specifying this parameter always results in a change. type: bool default: false version_added: 7.1.0 seealso: - module: community.general.filesystem - module: community.general.lvol - module: community.general.parted notes: - This module does not modify PE size for already present volume group. ''' EXAMPLES = r''' - name: Create a volume group on top of /dev/sda1 with physical extent size = 32MB community.general.lvg: vg: vg.services pvs: /dev/sda1 pesize: 32 - name: Create a volume group on top of /dev/sdb with physical extent size = 128KiB community.general.lvg: vg: vg.services pvs: /dev/sdb pesize: 128K # If, for example, we already have VG vg.services on top of /dev/sdb1, # this VG will be extended by /dev/sdc5. Or if vg.services was created on # top of /dev/sda5, we first extend it with /dev/sdb1 and /dev/sdc5, # and then reduce by /dev/sda5. - name: Create or resize a volume group on top of /dev/sdb1 and /dev/sdc5. community.general.lvg: vg: vg.services pvs: /dev/sdb1,/dev/sdc5 - name: Remove a volume group with name vg.services community.general.lvg: vg: vg.services state: absent - name: Create a volume group on top of /dev/sda3 and resize the volume group /dev/sda3 to the maximum possible community.general.lvg: vg: resizableVG pvs: /dev/sda3 pvresize: true - name: Deactivate a volume group community.general.lvg: state: inactive vg: vg.services - name: Activate a volume group community.general.lvg: state: active vg: vg.services - name: Reset a volume group UUID community.general.lvg: state: inactive vg: vg.services reset_vg_uuid: true - name: Reset both volume group and pv UUID community.general.lvg: state: inactive vg: vg.services pvs: /dev/sdb1,/dev/sdc5 reset_vg_uuid: true reset_pv_uuid: true ''' import itertools import os from ansible.module_utils.basic import AnsibleModule VG_AUTOACTIVATION_OPT = '--setautoactivation' def parse_vgs(data): vgs = [] for line in data.splitlines(): parts = line.strip().split(';') vgs.append({ 'name': parts[0], 'pv_count': int(parts[1]), 'lv_count': int(parts[2]), }) return vgs def find_mapper_device_name(module, dm_device): dmsetup_cmd = module.get_bin_path('dmsetup', True) mapper_prefix = '/dev/mapper/' rc, dm_name, err = module.run_command("%s info -C --noheadings -o name %s" % (dmsetup_cmd, dm_device)) if rc != 0: module.fail_json(msg="Failed executing dmsetup command.", rc=rc, err=err) mapper_device = mapper_prefix + dm_name.rstrip() return mapper_device def parse_pvs(module, data): pvs = [] dm_prefix = '/dev/dm-' for line in data.splitlines(): parts = line.strip().split(';') if parts[0].startswith(dm_prefix): parts[0] = find_mapper_device_name(module, parts[0]) pvs.append({ 'name': parts[0], 'vg_name': parts[1], }) return pvs def find_vg(module, vg): if not vg: return None vgs_cmd = module.get_bin_path('vgs', True) dummy, current_vgs, dummy = module.run_command("%s --noheadings -o vg_name,pv_count,lv_count --separator ';'" % vgs_cmd, check_rc=True) vgs = parse_vgs(current_vgs) for test_vg in vgs: if test_vg['name'] == vg: this_vg = test_vg break else: this_vg = None return this_vg def is_autoactivation_supported(module, vg_cmd): autoactivation_supported = False dummy, vgchange_opts, dummy = module.run_command([vg_cmd, '--help'], check_rc=True) if VG_AUTOACTIVATION_OPT in vgchange_opts: autoactivation_supported = True return autoactivation_supported def activate_vg(module, vg, active): changed = False vgchange_cmd = module.get_bin_path('vgchange', True) vgs_cmd = module.get_bin_path('vgs', True) vgs_fields = ['lv_attr'] autoactivation_enabled = False autoactivation_supported = is_autoactivation_supported(module=module, vg_cmd=vgchange_cmd) if autoactivation_supported: vgs_fields.append('autoactivation') vgs_cmd_with_opts = [vgs_cmd, '--noheadings', '-o', ','.join(vgs_fields), '--separator', ';', vg] dummy, current_vg_lv_states, dummy = module.run_command(vgs_cmd_with_opts, check_rc=True) lv_active_count = 0 lv_inactive_count = 0 for line in current_vg_lv_states.splitlines(): parts = line.strip().split(';') if parts[0][4] == 'a': lv_active_count += 1 else: lv_inactive_count += 1 if autoactivation_supported: autoactivation_enabled = autoactivation_enabled or parts[1] == 'enabled' activate_flag = None if active and lv_inactive_count > 0: activate_flag = 'y' elif not active and lv_active_count > 0: activate_flag = 'n' # Extra logic necessary because vgchange returns error when autoactivation is already set if autoactivation_supported: if active and not autoactivation_enabled: if module.check_mode: changed = True else: module.run_command([vgchange_cmd, VG_AUTOACTIVATION_OPT, 'y', vg], check_rc=True) changed = True elif not active and autoactivation_enabled: if module.check_mode: changed = True else: module.run_command([vgchange_cmd, VG_AUTOACTIVATION_OPT, 'n', vg], check_rc=True) changed = True if activate_flag is not None: if module.check_mode: changed = True else: module.run_command([vgchange_cmd, '--activate', activate_flag, vg], check_rc=True) changed = True return changed def append_vgcreate_options(module, state, vgoptions): vgcreate_cmd = module.get_bin_path('vgcreate', True) autoactivation_supported = is_autoactivation_supported(module=module, vg_cmd=vgcreate_cmd) if autoactivation_supported and state in ['active', 'inactive']: if VG_AUTOACTIVATION_OPT not in vgoptions: if state == 'active': vgoptions += [VG_AUTOACTIVATION_OPT, 'y'] else: vgoptions += [VG_AUTOACTIVATION_OPT, 'n'] def get_pv_values_for_resize(module, device): pvdisplay_cmd = module.get_bin_path('pvdisplay', True) pvdisplay_ops = ["--units", "b", "--columns", "--noheadings", "--nosuffix", "--separator", ";", "-o", "dev_size,pv_size,pe_start,vg_extent_size"] pvdisplay_cmd_device_options = [pvdisplay_cmd, device] + pvdisplay_ops dummy, pv_values, dummy = module.run_command(pvdisplay_cmd_device_options, check_rc=True) values = pv_values.strip().split(';') dev_size = int(values[0]) pv_size = int(values[1]) pe_start = int(values[2]) vg_extent_size = int(values[3]) return (dev_size, pv_size, pe_start, vg_extent_size) def resize_pv(module, device): changed = False pvresize_cmd = module.get_bin_path('pvresize', True) dev_size, pv_size, pe_start, vg_extent_size = get_pv_values_for_resize(module=module, device=device) if (dev_size - (pe_start + pv_size)) > vg_extent_size: if module.check_mode: changed = True else: # If there is a missing pv on the machine, versions of pvresize rc indicates failure. rc, out, err = module.run_command([pvresize_cmd, device]) dummy, new_pv_size, dummy, dummy = get_pv_values_for_resize(module=module, device=device) if pv_size == new_pv_size: module.fail_json(msg="Failed executing pvresize command.", rc=rc, err=err, out=out) else: changed = True return changed def reset_uuid_pv(module, device): changed = False pvs_cmd = module.get_bin_path('pvs', True) pvs_cmd_with_opts = [pvs_cmd, '--noheadings', '-o', 'uuid', device] pvchange_cmd = module.get_bin_path('pvchange', True) pvchange_cmd_with_opts = [pvchange_cmd, '-u', device] dummy, orig_uuid, dummy = module.run_command(pvs_cmd_with_opts, check_rc=True) if module.check_mode: changed = True else: # If there is a missing pv on the machine, pvchange rc indicates failure. pvchange_rc, pvchange_out, pvchange_err = module.run_command(pvchange_cmd_with_opts) dummy, new_uuid, dummy = module.run_command(pvs_cmd_with_opts, check_rc=True) if orig_uuid.strip() == new_uuid.strip(): module.fail_json(msg="PV (%s) UUID change failed" % (device), rc=pvchange_rc, err=pvchange_err, out=pvchange_out) else: changed = True return changed def reset_uuid_vg(module, vg): changed = False vgchange_cmd = module.get_bin_path('vgchange', True) vgchange_cmd_with_opts = [vgchange_cmd, '-u', vg] if module.check_mode: changed = True else: module.run_command(vgchange_cmd_with_opts, check_rc=True) changed = True return changed def main(): module = AnsibleModule( argument_spec=dict( vg=dict(type='str', required=True), pvs=dict(type='list', elements='str'), pesize=dict(type='str', default='4'), pv_options=dict(type='str', default=''), pvresize=dict(type='bool', default=False), vg_options=dict(type='str', default=''), state=dict(type='str', default='present', choices=['absent', 'present', 'active', 'inactive']), force=dict(type='bool', default=False), reset_vg_uuid=dict(type='bool', default=False), reset_pv_uuid=dict(type='bool', default=False), ), required_if=[ ['reset_pv_uuid', True, ['pvs']], ], supports_check_mode=True, ) vg = module.params['vg'] state = module.params['state'] force = module.boolean(module.params['force']) pvresize = module.boolean(module.params['pvresize']) pesize = module.params['pesize'] pvoptions = module.params['pv_options'].split() vgoptions = module.params['vg_options'].split() reset_vg_uuid = module.boolean(module.params['reset_vg_uuid']) reset_pv_uuid = module.boolean(module.params['reset_pv_uuid']) this_vg = find_vg(module=module, vg=vg) present_state = state in ['present', 'active', 'inactive'] pvs_required = present_state and this_vg is None changed = False dev_list = [] if module.params['pvs']: dev_list = list(module.params['pvs']) elif pvs_required: module.fail_json(msg="No physical volumes given.") # LVM always uses real paths not symlinks so replace symlinks with actual path for idx, dev in enumerate(dev_list): dev_list[idx] = os.path.realpath(dev) if present_state: # check given devices for test_dev in dev_list: if not os.path.exists(test_dev): module.fail_json(msg="Device %s not found." % test_dev) # get pv list pvs_cmd = module.get_bin_path('pvs', True) if dev_list: pvs_filter_pv_name = ' || '.join( 'pv_name = {0}'.format(x) for x in itertools.chain(dev_list, module.params['pvs']) ) pvs_filter_vg_name = 'vg_name = {0}'.format(vg) pvs_filter = "--select '{0} || {1}' ".format(pvs_filter_pv_name, pvs_filter_vg_name) else: pvs_filter = '' rc, current_pvs, err = module.run_command("%s --noheadings -o pv_name,vg_name --separator ';' %s" % (pvs_cmd, pvs_filter)) if rc != 0: module.fail_json(msg="Failed executing pvs command.", rc=rc, err=err) # check pv for devices pvs = parse_pvs(module, current_pvs) used_pvs = [pv for pv in pvs if pv['name'] in dev_list and pv['vg_name'] and pv['vg_name'] != vg] if used_pvs: module.fail_json(msg="Device %s is already in %s volume group." % (used_pvs[0]['name'], used_pvs[0]['vg_name'])) if this_vg is None: if present_state: append_vgcreate_options(module=module, state=state, vgoptions=vgoptions) # create VG if module.check_mode: changed = True else: # create PV pvcreate_cmd = module.get_bin_path('pvcreate', True) for current_dev in dev_list: rc, dummy, err = module.run_command([pvcreate_cmd] + pvoptions + ['-f', str(current_dev)]) if rc == 0: changed = True else: module.fail_json(msg="Creating physical volume '%s' failed" % current_dev, rc=rc, err=err) vgcreate_cmd = module.get_bin_path('vgcreate') rc, dummy, err = module.run_command([vgcreate_cmd] + vgoptions + ['-s', pesize, vg] + dev_list) if rc == 0: changed = True else: module.fail_json(msg="Creating volume group '%s' failed" % vg, rc=rc, err=err) else: if state == 'absent': if module.check_mode: module.exit_json(changed=True) else: if this_vg['lv_count'] == 0 or force: # remove VG vgremove_cmd = module.get_bin_path('vgremove', True) rc, dummy, err = module.run_command("%s --force %s" % (vgremove_cmd, vg)) if rc == 0: module.exit_json(changed=True) else: module.fail_json(msg="Failed to remove volume group %s" % (vg), rc=rc, err=err) else: module.fail_json(msg="Refuse to remove non-empty volume group %s without force=true" % (vg)) # activate/inactivate existing VG elif state == 'active': changed = activate_vg(module=module, vg=vg, active=True) elif state == 'inactive': changed = activate_vg(module=module, vg=vg, active=False) # reset VG uuid if reset_vg_uuid: changed = reset_uuid_vg(module=module, vg=vg) or changed # resize VG if dev_list: current_devs = [os.path.realpath(pv['name']) for pv in pvs if pv['vg_name'] == vg] devs_to_remove = list(set(current_devs) - set(dev_list)) devs_to_add = list(set(dev_list) - set(current_devs)) if current_devs: if present_state: for device in current_devs: if pvresize: changed = resize_pv(module=module, device=device) or changed if reset_pv_uuid: changed = reset_uuid_pv(module=module, device=device) or changed if devs_to_add or devs_to_remove: if module.check_mode: changed = True else: if devs_to_add: devs_to_add_string = ' '.join(devs_to_add) # create PV pvcreate_cmd = module.get_bin_path('pvcreate', True) for current_dev in devs_to_add: rc, dummy, err = module.run_command([pvcreate_cmd] + pvoptions + ['-f', str(current_dev)]) if rc == 0: changed = True else: module.fail_json(msg="Creating physical volume '%s' failed" % current_dev, rc=rc, err=err) # add PV to our VG vgextend_cmd = module.get_bin_path('vgextend', True) rc, dummy, err = module.run_command("%s %s %s" % (vgextend_cmd, vg, devs_to_add_string)) if rc == 0: changed = True else: module.fail_json(msg="Unable to extend %s by %s." % (vg, devs_to_add_string), rc=rc, err=err) # remove some PV from our VG if devs_to_remove: devs_to_remove_string = ' '.join(devs_to_remove) vgreduce_cmd = module.get_bin_path('vgreduce', True) rc, dummy, err = module.run_command("%s --force %s %s" % (vgreduce_cmd, vg, devs_to_remove_string)) if rc == 0: changed = True else: module.fail_json(msg="Unable to reduce %s by %s." % (vg, devs_to_remove_string), rc=rc, err=err) module.exit_json(changed=changed) if __name__ == '__main__': main() PK $�!\3�%� P collections/ansible_collections/community/general/plugins/modules/ldap_passwd.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017-2018, Keller Fuchs <kellerfuchs@hashbang.sh> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ldap_passwd short_description: Set passwords in LDAP description: - Set a password for an LDAP entry. This module only asserts that a given password is valid for a given entry. To assert the existence of an entry, see M(community.general.ldap_entry). notes: - The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu install for example, which includes a C(cn=peercred,cn=external,cn=auth) ACL rule allowing root to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in O(bind_dn) and O(bind_pw). author: - Keller Fuchs (@KellerFuchs) requirements: - python-ldap attributes: check_mode: support: full diff_mode: support: none options: passwd: description: - The (plaintext) password to be set for O(dn). type: str extends_documentation_fragment: - community.general.ldap.documentation - community.general.attributes ''' EXAMPLES = """ - name: Set a password for the admin user community.general.ldap_passwd: dn: cn=admin,dc=example,dc=com passwd: "{{ vault_secret }}" - name: Setting passwords in bulk community.general.ldap_passwd: dn: "{{ item.key }}" passwd: "{{ item.value }}" with_dict: alice: alice123123 bob: "|30b!" admin: "{{ vault_secret }}" """ RETURN = """ modlist: description: list of modified parameters returned: success type: list sample: - [2, "olcRootDN", ["cn=root,dc=example,dc=com"]] """ import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible_collections.community.general.plugins.module_utils.ldap import LdapGeneric, gen_specs, ldap_required_together LDAP_IMP_ERR = None try: import ldap HAS_LDAP = True except ImportError: LDAP_IMP_ERR = traceback.format_exc() HAS_LDAP = False class LdapPasswd(LdapGeneric): def __init__(self, module): LdapGeneric.__init__(self, module) # Shortcuts self.passwd = self.module.params['passwd'] def passwd_check(self): try: tmp_con = ldap.initialize(self.server_uri) except ldap.LDAPError as e: self.fail("Cannot initialize LDAP connection", e) if self.start_tls: try: tmp_con.start_tls_s() except ldap.LDAPError as e: self.fail("Cannot start TLS.", e) try: tmp_con.simple_bind_s(self.dn, self.passwd) except ldap.INVALID_CREDENTIALS: return True except ldap.LDAPError as e: self.fail("Cannot bind to the server.", e) else: return False finally: tmp_con.unbind() def passwd_set(self): # Exit early if the password is already valid if not self.passwd_check(): return False # Change the password (or throw an exception) try: self.connection.passwd_s(self.dn, None, self.passwd) except ldap.LDAPError as e: self.fail("Unable to set password", e) # Password successfully changed return True def main(): module = AnsibleModule( argument_spec=gen_specs(passwd=dict(no_log=True)), supports_check_mode=True, required_together=ldap_required_together(), ) if not HAS_LDAP: module.fail_json(msg=missing_required_lib('python-ldap'), exception=LDAP_IMP_ERR) ldap = LdapPasswd(module) if module.check_mode: module.exit_json(changed=ldap.passwd_check()) module.exit_json(changed=ldap.passwd_set()) if __name__ == '__main__': main() PK $�!\&.yӐ# �# N collections/ansible_collections/community/general/plugins/modules/pagerduty.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: pagerduty short_description: Create PagerDuty maintenance windows description: - This module will let you create PagerDuty maintenance windows author: - "Andrew Newdigate (@suprememoocow)" - "Dylan Silva (@thaumos)" - "Justin Johns (!UNKNOWN)" - "Bruce Pennypacker (@bpennypacker)" requirements: - PagerDuty API access extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: state: type: str description: - Create a maintenance window or get a list of ongoing windows. required: true choices: [ "running", "started", "ongoing", "absent" ] name: type: str description: - PagerDuty unique subdomain. Obsolete. It is not used with PagerDuty REST v2 API. user: type: str description: - PagerDuty user ID. Obsolete. Please, use O(token) for authorization. token: type: str description: - A pagerduty token, generated on the pagerduty site. It is used for authorization. required: true requester_id: type: str description: - ID of user making the request. Only needed when creating a maintenance_window. service: type: list elements: str description: - A comma separated list of PagerDuty service IDs. aliases: [ services ] window_id: type: str description: - ID of maintenance window. Only needed when absent a maintenance_window. hours: type: str description: - Length of maintenance window in hours. default: '1' minutes: type: str description: - Maintenance window in minutes (this is added to the hours). default: '0' desc: type: str description: - Short description of maintenance window. default: Created by Ansible validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true ''' EXAMPLES = ''' - name: List ongoing maintenance windows using a token community.general.pagerduty: name: companyabc token: xxxxxxxxxxxxxx state: ongoing - name: Create a 1 hour maintenance window for service FOO123 community.general.pagerduty: name: companyabc user: example@example.com token: yourtoken state: running service: FOO123 - name: Create a 5 minute maintenance window for service FOO123 community.general.pagerduty: name: companyabc token: xxxxxxxxxxxxxx hours: 0 minutes: 5 state: running service: FOO123 - name: Create a 4 hour maintenance window for service FOO123 with the description "deployment" community.general.pagerduty: name: companyabc user: example@example.com state: running service: FOO123 hours: 4 desc: deployment register: pd_window - name: Delete the previous maintenance window community.general.pagerduty: name: companyabc user: example@example.com state: absent window_id: '{{ pd_window.result.maintenance_window.id }}' # Delete a maintenance window from a separate playbook than its creation, # and if it is the only existing maintenance window - name: Check community.general.pagerduty: requester_id: XXXXXXX token: yourtoken state: ongoing register: pd_window - name: Delete community.general.pagerduty: requester_id: XXXXXXX token: yourtoken state: absent window_id: "{{ pd_window.result.maintenance_windows[0].id }}" ''' import datetime import json from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url class PagerDutyRequest(object): def __init__(self, module, name, user, token): self.module = module self.name = name self.user = user self.token = token self.headers = { 'Content-Type': 'application/json', "Authorization": self._auth_header(), 'Accept': 'application/vnd.pagerduty+json;version=2' } def ongoing(self, http_call=fetch_url): url = "https://api.pagerduty.com/maintenance_windows?filter=ongoing" headers = dict(self.headers) response, info = http_call(self.module, url, headers=headers) if info['status'] != 200: self.module.fail_json(msg="failed to lookup the ongoing window: %s" % info['msg']) json_out = self._read_response(response) return False, json_out, False def create(self, requester_id, service, hours, minutes, desc, http_call=fetch_url): if not requester_id: self.module.fail_json(msg="requester_id is required when maintenance window should be created") url = 'https://api.pagerduty.com/maintenance_windows' headers = dict(self.headers) headers.update({'From': requester_id}) start, end = self._compute_start_end_time(hours, minutes) services = self._create_services_payload(service) request_data = {'maintenance_window': {'start_time': start, 'end_time': end, 'description': desc, 'services': services}} data = json.dumps(request_data) response, info = http_call(self.module, url, data=data, headers=headers, method='POST') if info['status'] != 201: self.module.fail_json(msg="failed to create the window: %s" % info['msg']) json_out = self._read_response(response) return False, json_out, True def _create_services_payload(self, service): if (isinstance(service, list)): return [{'id': s, 'type': 'service_reference'} for s in service] else: return [{'id': service, 'type': 'service_reference'}] def _compute_start_end_time(self, hours, minutes): now = datetime.datetime.utcnow() later = now + datetime.timedelta(hours=int(hours), minutes=int(minutes)) start = now.strftime("%Y-%m-%dT%H:%M:%SZ") end = later.strftime("%Y-%m-%dT%H:%M:%SZ") return start, end def absent(self, window_id, http_call=fetch_url): url = "https://api.pagerduty.com/maintenance_windows/" + window_id headers = dict(self.headers) response, info = http_call(self.module, url, headers=headers, method='DELETE') if info['status'] != 204: self.module.fail_json(msg="failed to delete the window: %s" % info['msg']) json_out = self._read_response(response) return False, json_out, True def _auth_header(self): return "Token token=%s" % self.token def _read_response(self, response): try: return json.loads(response.read()) except Exception: return "" def main(): module = AnsibleModule( argument_spec=dict( state=dict(required=True, choices=['running', 'started', 'ongoing', 'absent']), name=dict(required=False), user=dict(required=False), token=dict(required=True, no_log=True), service=dict(required=False, type='list', elements='str', aliases=["services"]), window_id=dict(required=False), requester_id=dict(required=False), hours=dict(default='1', required=False), # @TODO change to int? minutes=dict(default='0', required=False), # @TODO change to int? desc=dict(default='Created by Ansible', required=False), validate_certs=dict(default=True, type='bool'), ) ) state = module.params['state'] name = module.params['name'] user = module.params['user'] service = module.params['service'] window_id = module.params['window_id'] hours = module.params['hours'] minutes = module.params['minutes'] token = module.params['token'] desc = module.params['desc'] requester_id = module.params['requester_id'] pd = PagerDutyRequest(module, name, user, token) if state == "running" or state == "started": if not service: module.fail_json(msg="service not specified") (rc, out, changed) = pd.create(requester_id, service, hours, minutes, desc) if rc == 0: changed = True if state == "ongoing": (rc, out, changed) = pd.ongoing() if state == "absent": (rc, out, changed) = pd.absent(window_id) if rc != 0: module.fail_json(msg="failed", result=out) module.exit_json(msg="success", result=out, changed=changed) if __name__ == '__main__': main() PK $�!\C|�� � O collections/ansible_collections/community/general/plugins/modules/snap_alias.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2021, Alexei Znamensky (russoz) <russoz@gmail.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: snap_alias short_description: Manages snap aliases version_added: 4.0.0 description: - "Manages snaps aliases." extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: state: description: - Desired state of the alias. type: str choices: [ absent, present ] default: present name: description: - Name of the snap. type: str alias: description: - Aliases to be created or removed. type: list elements: str aliases: [aliases] author: - Alexei Znamensky (@russoz) <russoz@gmail.com> seealso: - module: community.general.snap ''' EXAMPLES = ''' # Install "foo" and "bar" snap - name: Create snap alias community.general.snap_alias: name: hello-world alias: hw - name: Create multiple aliases community.general.snap_alias: name: hello-world aliases: - hw - hw2 - hw3 state: present # optional - name: Remove one specific aliases community.general.snap_alias: name: hw state: absent - name: Remove all aliases for snap community.general.snap_alias: name: hello-world state: absent ''' RETURN = ''' snap_aliases: description: The snap aliases after execution. If called in check mode, then the list represents the state before execution. type: list elements: str returned: always ''' import re from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper from ansible_collections.community.general.plugins.module_utils.snap import snap_runner class SnapAlias(StateModuleHelper): _RE_ALIAS_LIST = re.compile(r"^(?P<snap>\S+)\s+(?P<alias>[\w-]+)\s+.*$") module = dict( argument_spec={ 'state': dict(type='str', choices=['absent', 'present'], default='present'), 'name': dict(type='str'), 'alias': dict(type='list', elements='str', aliases=['aliases']), }, required_if=[ ('state', 'present', ['name', 'alias']), ('state', 'absent', ['name', 'alias'], True), ], supports_check_mode=True, ) def _aliases(self): n = self.vars.name return {n: self._get_aliases_for(n)} if n else self._get_aliases() def __init_module__(self): self.runner = snap_runner(self.module) self.vars.set("snap_aliases", self._aliases(), change=True, diff=True) def __quit_module__(self): self.vars.snap_aliases = self._aliases() def _get_aliases(self): def process(rc, out, err): if err: return {} aliases = [self._RE_ALIAS_LIST.match(a.strip()) for a in out.splitlines()[1:]] snap_alias_list = [(entry.group("snap"), entry.group("alias")) for entry in aliases] results = {} for snap, alias in snap_alias_list: results[snap] = results.get(snap, []) + [alias] return results with self.runner("state_alias name", check_rc=True, output_process=process) as ctx: aliases = ctx.run(state_alias="info") if self.verbosity >= 4: self.vars.get_aliases_run_info = ctx.run_info return aliases def _get_aliases_for(self, name): return self._get_aliases().get(name, []) def _has_alias(self, name=None, alias=None): if name: if name not in self.vars.snap_aliases: return False if alias is None: return bool(self.vars.snap_aliases[name]) return alias in self.vars.snap_aliases[name] return any(alias in aliases for aliases in self.vars.snap_aliases.values()) def state_present(self): for _alias in self.vars.alias: if not self._has_alias(self.vars.name, _alias): self.changed = True with self.runner("state_alias name alias", check_mode_skip=True) as ctx: ctx.run(state_alias=self.vars.state, alias=_alias) if self.verbosity >= 4: self.vars.run_info = ctx.run_info def state_absent(self): if not self.vars.alias: if self._has_alias(self.vars.name): self.changed = True with self.runner("state_alias name", check_mode_skip=True) as ctx: ctx.run(state_alias=self.vars.state) if self.verbosity >= 4: self.vars.run_info = ctx.run_info else: for _alias in self.vars.alias: if self._has_alias(self.vars.name, _alias): self.changed = True with self.runner("state_alias alias", check_mode_skip=True) as ctx: ctx.run(state_alias=self.vars.state, alias=_alias) if self.verbosity >= 4: self.vars.run_info = ctx.run_info def main(): SnapAlias.execute() if __name__ == '__main__': main() PK $�!\Sh��� � W collections/ansible_collections/community/general/plugins/modules/opendj_backendprop.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Werner Dijkerman (ikben@werner-dijkerman.nl) # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: opendj_backendprop short_description: Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command description: - This module will update settings for OpenDJ with the command set-backend-prop. - It will check first via de get-backend-prop if configuration needs to be applied. author: - Werner Dijkerman (@dj-wasabi) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: opendj_bindir: description: - The path to the bin directory of OpenDJ. required: false default: /opt/opendj/bin type: path hostname: description: - The hostname of the OpenDJ server. required: true type: str port: description: - The Admin port on which the OpenDJ instance is available. required: true type: str username: description: - The username to connect to. required: false default: cn=Directory Manager type: str password: description: - The password for the cn=Directory Manager user. - Either password or passwordfile is needed. required: false type: str passwordfile: description: - Location to the password file which holds the password for the cn=Directory Manager user. - Either password or passwordfile is needed. required: false type: path backend: description: - The name of the backend on which the property needs to be updated. required: true type: str name: description: - The configuration setting to update. required: true type: str value: description: - The value for the configuration item. required: true type: str state: description: - If configuration needs to be added/updated required: false default: "present" type: str ''' EXAMPLES = ''' - name: Add or update OpenDJ backend properties action: opendj_backendprop hostname=localhost port=4444 username="cn=Directory Manager" password=password backend=userRoot name=index-entry-limit value=5000 ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule class BackendProp(object): def __init__(self, module): self._module = module def get_property(self, opendj_bindir, hostname, port, username, password_method, backend_name): my_command = [ opendj_bindir + '/dsconfig', 'get-backend-prop', '-h', hostname, '--port', str(port), '--bindDN', username, '--backend-name', backend_name, '-n', '-X', '-s' ] + password_method rc, stdout, stderr = self._module.run_command(my_command) if rc == 0: return stdout else: self._module.fail_json(msg="Error message: " + str(stderr)) def set_property(self, opendj_bindir, hostname, port, username, password_method, backend_name, name, value): my_command = [ opendj_bindir + '/dsconfig', 'set-backend-prop', '-h', hostname, '--port', str(port), '--bindDN', username, '--backend-name', backend_name, '--set', name + ":" + value, '-n', '-X' ] + password_method rc, stdout, stderr = self._module.run_command(my_command) if rc == 0: return True else: self._module.fail_json(msg="Error message: " + stderr) def validate_data(self, data=None, name=None, value=None): for config_line in data.split('\n'): if config_line: split_line = config_line.split() if split_line[0] == name: if split_line[1] == value: return True return False def main(): module = AnsibleModule( argument_spec=dict( opendj_bindir=dict(default="/opt/opendj/bin", type="path"), hostname=dict(required=True), port=dict(required=True), username=dict(default="cn=Directory Manager", required=False), password=dict(required=False, no_log=True), passwordfile=dict(required=False, type="path"), backend=dict(required=True), name=dict(required=True), value=dict(required=True), state=dict(default="present"), ), supports_check_mode=True, mutually_exclusive=[['password', 'passwordfile']], required_one_of=[['password', 'passwordfile']] ) opendj_bindir = module.params['opendj_bindir'] hostname = module.params['hostname'] port = module.params['port'] username = module.params['username'] password = module.params['password'] passwordfile = module.params['passwordfile'] backend_name = module.params['backend'] name = module.params['name'] value = module.params['value'] state = module.params['state'] if module.params["password"] is not None: password_method = ['-w', password] elif module.params["passwordfile"] is not None: password_method = ['-j', passwordfile] opendj = BackendProp(module) validate = opendj.get_property(opendj_bindir=opendj_bindir, hostname=hostname, port=port, username=username, password_method=password_method, backend_name=backend_name) if validate: if not opendj.validate_data(data=validate, name=name, value=value): if module.check_mode: module.exit_json(changed=True) if opendj.set_property(opendj_bindir=opendj_bindir, hostname=hostname, port=port, username=username, password_method=password_method, backend_name=backend_name, name=name, value=value): module.exit_json(changed=True) else: module.exit_json(changed=False) else: module.exit_json(changed=False) else: module.exit_json(changed=False) if __name__ == '__main__': main() PK $�!\�m�{^ ^ S collections/ansible_collections/community/general/plugins/modules/logentries_msg.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: logentries_msg short_description: Send a message to logentries description: - Send a message to logentries extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: token: type: str description: - Log token. required: true msg: type: str description: - The message body. required: true api: type: str description: - API endpoint default: data.logentries.com port: type: int description: - API endpoint port default: 80 author: "Jimmy Tang (@jcftang) <jimmy_tang@rapid7.com>" ''' RETURN = '''# ''' EXAMPLES = ''' - name: Send a message to logentries community.general.logentries_msg: token=00000000-0000-0000-0000-000000000000 msg="{{ ansible_hostname }}" ''' import socket from ansible.module_utils.basic import AnsibleModule def send_msg(module, token, msg, api, port): message = "{0} {1}\n".format(token, msg) api_ip = socket.gethostbyname(api) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.connect((api_ip, port)) try: if not module.check_mode: s.send(message) except Exception as e: module.fail_json(msg="failed to send message, msg=%s" % e) s.close() def main(): module = AnsibleModule( argument_spec=dict( token=dict(type='str', required=True, no_log=True), msg=dict(type='str', required=True), api=dict(type='str', default="data.logentries.com"), port=dict(type='int', default=80)), supports_check_mode=True ) token = module.params["token"] msg = module.params["msg"] api = module.params["api"] port = module.params["port"] changed = False try: send_msg(module, token, msg, api, port) changed = True except Exception as e: module.fail_json(msg="unable to send msg: %s" % e) module.exit_json(changed=changed, msg=msg) if __name__ == '__main__': main() PK $�!\��� � ] collections/ansible_collections/community/general/plugins/modules/scaleway_private_network.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway VPC management module # # Copyright (c) Ansible project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_private_network short_description: Scaleway private network management version_added: 4.5.0 author: Pascal MANGIN (@pastral) description: - "This module manages private network on Scaleway account (U(https://developer.scaleway.com))." extends_documentation_fragment: - community.general.scaleway - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: type: str description: - Indicate desired state of the VPC. default: present choices: - present - absent project: type: str description: - Project identifier. required: true region: type: str description: - Scaleway region to use (for example V(par1)). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 name: type: str description: - Name of the VPC. tags: type: list elements: str description: - List of tags to apply to the instance. default: [] ''' EXAMPLES = ''' - name: Create an private network community.general.scaleway_vpc: project: '{{ scw_project }}' name: 'vpc_one' state: present region: par1 register: vpc_creation_task - name: Make sure private network with name 'foo' is deleted in region par1 community.general.scaleway_vpc: name: 'foo' state: absent region: par1 ''' RETURN = ''' scaleway_private_network: description: Information on the VPC. returned: success when O(state=present) type: dict sample: { "created_at": "2022-01-15T11:11:12.676445Z", "id": "12345678-f1e6-40ec-83e5-12345d67ed89", "name": "network", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "tags": [ "tag1", "tag2", "tag3", "tag4", "tag5" ], "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2" } ''' from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule def get_private_network(api, name, page=1): page_size = 10 response = api.get('private-networks', params={'name': name, 'order_by': 'name_asc', 'page': page, 'page_size': page_size}) if not response.ok: msg = "Error during get private network creation: %s: '%s' (%s)" % (response.info['msg'], response.json['message'], response.json) api.module.fail_json(msg=msg) if response.json['total_count'] == 0: return None i = 0 while i < len(response.json['private_networks']): if response.json['private_networks'][i]['name'] == name: return response.json['private_networks'][i] i += 1 # search on next page if needed if (page * page_size) < response.json['total_count']: return get_private_network(api, name, page + 1) return None def present_strategy(api, wished_private_network): changed = False private_network = get_private_network(api, wished_private_network['name']) if private_network is not None: if set(wished_private_network['tags']) == set(private_network['tags']): return changed, private_network else: # private network need to be updated data = {'name': wished_private_network['name'], 'tags': wished_private_network['tags'] } changed = True if api.module.check_mode: return changed, {"status": "private network would be updated"} response = api.patch(path='private-networks/' + private_network['id'], data=data) if not response.ok: api.module.fail_json(msg='Error updating private network [{0}: {1}]'.format(response.status_code, response.json)) return changed, response.json # private network need to be create changed = True if api.module.check_mode: return changed, {"status": "private network would be created"} data = {'name': wished_private_network['name'], 'project_id': wished_private_network['project'], 'tags': wished_private_network['tags'] } response = api.post(path='private-networks/', data=data) if not response.ok: api.module.fail_json(msg='Error creating private network [{0}: {1}]'.format(response.status_code, response.json)) return changed, response.json def absent_strategy(api, wished_private_network): changed = False private_network = get_private_network(api, wished_private_network['name']) if private_network is None: return changed, {} changed = True if api.module.check_mode: return changed, {"status": "private network would be destroyed"} response = api.delete('private-networks/' + private_network['id']) if not response.ok: api.module.fail_json(msg='Error deleting private network [{0}: {1}]'.format( response.status_code, response.json)) return changed, response.json def core(module): wished_private_network = { "project": module.params['project'], "tags": module.params['tags'], "name": module.params['name'] } region = module.params["region"] module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint_vpc"] api = Scaleway(module=module) if module.params["state"] == "absent": changed, summary = absent_strategy(api=api, wished_private_network=wished_private_network) else: changed, summary = present_strategy(api=api, wished_private_network=wished_private_network) module.exit_json(changed=changed, scaleway_private_network=summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( state=dict(default='present', choices=['absent', 'present']), project=dict(required=True), region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())), tags=dict(type="list", elements="str", default=[]), name=dict() )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\934X- - O collections/ansible_collections/community/general/plugins/modules/ibm_sa_vol.pynu �[��� # -*- coding: utf-8 -*- # Copyright (C) 2018 IBM CORPORATION # Author(s): Tzur Eliyahu <tzure@il.ibm.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ibm_sa_vol short_description: Handle volumes on IBM Spectrum Accelerate Family storage systems description: - "This module creates or deletes volumes to be used on IBM Spectrum Accelerate Family storage systems." attributes: check_mode: support: none diff_mode: support: none options: vol: description: - Volume name. required: true type: str pool: description: - Volume pool. required: false type: str state: description: - Volume state. default: "present" choices: [ "present", "absent" ] type: str size: description: - Volume size. required: false type: str extends_documentation_fragment: - community.general.ibm_storage - community.general.attributes author: - Tzur Eliyahu (@tzure) ''' EXAMPLES = ''' - name: Create a new volume. community.general.ibm_sa_vol: vol: volume_name pool: pool_name size: 17 state: present username: admin password: secret endpoints: hostdev-system - name: Delete an existing volume. community.general.ibm_sa_vol: vol: volume_name state: absent username: admin password: secret endpoints: hostdev-system ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ibm_sa_utils import execute_pyxcli_command, \ connect_ssl, spectrum_accelerate_spec, is_pyxcli_installed def main(): argument_spec = spectrum_accelerate_spec() argument_spec.update( dict( state=dict(default='present', choices=['present', 'absent']), vol=dict(required=True), pool=dict(), size=dict() ) ) module = AnsibleModule(argument_spec) is_pyxcli_installed(module) xcli_client = connect_ssl(module) # required args volume = xcli_client.cmd.vol_list( vol=module.params.get('vol')).as_single_element state = module.params['state'] state_changed = False if state == 'present' and not volume: state_changed = execute_pyxcli_command( module, 'vol_create', xcli_client) elif state == 'absent' and volume: state_changed = execute_pyxcli_command( module, 'vol_delete', xcli_client) module.exit_json(changed=state_changed) if __name__ == '__main__': main() PK $�!\�ZB�� � P collections/ansible_collections/community/general/plugins/modules/scaleway_ip.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway IP management module # # Copyright (c) Ansible project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_ip short_description: Scaleway IP management module author: Remy Leone (@remyleone) description: - This module manages IP on Scaleway account U(https://developer.scaleway.com) extends_documentation_fragment: - community.general.scaleway - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: type: str description: - Indicate desired state of the IP. default: present choices: - present - absent organization: type: str description: - Scaleway organization identifier required: true region: type: str description: - Scaleway region to use (for example par1). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 id: type: str description: - id of the Scaleway IP (UUID) server: type: str description: - id of the server you want to attach an IP to. - To unattach an IP don't specify this option reverse: type: str description: - Reverse to assign to the IP ''' EXAMPLES = ''' - name: Create an IP community.general.scaleway_ip: organization: '{{ scw_org }}' state: present region: par1 register: ip_creation_task - name: Make sure IP deleted community.general.scaleway_ip: id: '{{ ip_creation_task.scaleway_ip.id }}' state: absent region: par1 ''' RETURN = ''' data: description: This is only present when O(state=present). returned: when O(state=present) type: dict sample: { "ips": [ { "organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "reverse": null, "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "server": { "id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "name": "ansible_tuto-1" }, "address": "212.47.232.136" } ] } ''' from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible.module_utils.basic import AnsibleModule def ip_attributes_should_be_changed(api, target_ip, wished_ip): patch_payload = {} if target_ip["reverse"] != wished_ip["reverse"]: patch_payload["reverse"] = wished_ip["reverse"] # IP is assigned to a server if target_ip["server"] is None and wished_ip["server"]: patch_payload["server"] = wished_ip["server"] # IP is unassigned to a server try: if target_ip["server"]["id"] and wished_ip["server"] is None: patch_payload["server"] = wished_ip["server"] except (TypeError, KeyError): pass # IP is migrated between 2 different servers try: if target_ip["server"]["id"] != wished_ip["server"]: patch_payload["server"] = wished_ip["server"] except (TypeError, KeyError): pass return patch_payload def payload_from_wished_ip(wished_ip): return dict( (k, v) for k, v in wished_ip.items() if k != 'id' and v is not None ) def present_strategy(api, wished_ip): changed = False response = api.get('ips') if not response.ok: api.module.fail_json(msg='Error getting IPs [{0}: {1}]'.format( response.status_code, response.json['message'])) ips_list = response.json["ips"] ip_lookup = dict((ip["id"], ip) for ip in ips_list) if wished_ip["id"] not in ip_lookup.keys(): changed = True if api.module.check_mode: return changed, {"status": "An IP would be created."} # Create IP creation_response = api.post('/ips', data=payload_from_wished_ip(wished_ip)) if not creation_response.ok: msg = "Error during ip creation: %s: '%s' (%s)" % (creation_response.info['msg'], creation_response.json['message'], creation_response.json) api.module.fail_json(msg=msg) return changed, creation_response.json["ip"] target_ip = ip_lookup[wished_ip["id"]] patch_payload = ip_attributes_should_be_changed(api=api, target_ip=target_ip, wished_ip=wished_ip) if not patch_payload: return changed, target_ip changed = True if api.module.check_mode: return changed, {"status": "IP attributes would be changed."} ip_patch_response = api.patch(path="ips/%s" % target_ip["id"], data=patch_payload) if not ip_patch_response.ok: api.module.fail_json(msg='Error during IP attributes update: [{0}: {1}]'.format( ip_patch_response.status_code, ip_patch_response.json['message'])) return changed, ip_patch_response.json["ip"] def absent_strategy(api, wished_ip): response = api.get('ips') changed = False status_code = response.status_code ips_json = response.json ips_list = ips_json["ips"] if not response.ok: api.module.fail_json(msg='Error getting IPs [{0}: {1}]'.format( status_code, response.json['message'])) ip_lookup = dict((ip["id"], ip) for ip in ips_list) if wished_ip["id"] not in ip_lookup.keys(): return changed, {} changed = True if api.module.check_mode: return changed, {"status": "IP would be destroyed"} response = api.delete('/ips/' + wished_ip["id"]) if not response.ok: api.module.fail_json(msg='Error deleting IP [{0}: {1}]'.format( response.status_code, response.json)) return changed, response.json def core(module): wished_ip = { "organization": module.params['organization'], "reverse": module.params["reverse"], "id": module.params["id"], "server": module.params["server"] } region = module.params["region"] module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"] api = Scaleway(module=module) if module.params["state"] == "absent": changed, summary = absent_strategy(api=api, wished_ip=wished_ip) else: changed, summary = present_strategy(api=api, wished_ip=wished_ip) module.exit_json(changed=changed, scaleway_ip=summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( state=dict(default='present', choices=['absent', 'present']), organization=dict(required=True), server=dict(), reverse=dict(), region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())), id=dict() )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\Z��� � J collections/ansible_collections/community/general/plugins/modules/nexmo.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Matt Martz <matt@sivel.net> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: nexmo short_description: Send a SMS via nexmo description: - Send a SMS message via nexmo author: "Matt Martz (@sivel)" attributes: check_mode: support: none diff_mode: support: none options: api_key: type: str description: - Nexmo API Key required: true api_secret: type: str description: - Nexmo API Secret required: true src: type: int description: - Nexmo Number to send from required: true dest: type: list elements: int description: - Phone number(s) to send SMS message to required: true msg: type: str description: - Message to text to send. Messages longer than 160 characters will be split into multiple messages required: true validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true extends_documentation_fragment: - ansible.builtin.url - community.general.attributes ''' EXAMPLES = """ - name: Send notification message via Nexmo community.general.nexmo: api_key: 640c8a53 api_secret: 0ce239a6 src: 12345678901 dest: - 10987654321 - 16789012345 msg: '{{ inventory_hostname }} completed' delegate_to: localhost """ import json from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url, url_argument_spec NEXMO_API = 'https://rest.nexmo.com/sms/json' def send_msg(module): failed = list() responses = dict() msg = { 'api_key': module.params.get('api_key'), 'api_secret': module.params.get('api_secret'), 'from': module.params.get('src'), 'text': module.params.get('msg') } for number in module.params.get('dest'): msg['to'] = number url = "%s?%s" % (NEXMO_API, urlencode(msg)) headers = dict(Accept='application/json') response, info = fetch_url(module, url, headers=headers) if info['status'] != 200: failed.append(number) responses[number] = dict(failed=True) try: responses[number] = json.load(response) except Exception: failed.append(number) responses[number] = dict(failed=True) else: for message in responses[number]['messages']: if int(message['status']) != 0: failed.append(number) responses[number] = dict(failed=True, **responses[number]) if failed: msg = 'One or messages failed to send' else: msg = '' module.exit_json(failed=bool(failed), msg=msg, changed=False, responses=responses) def main(): argument_spec = url_argument_spec() argument_spec.update( dict( api_key=dict(required=True, no_log=True), api_secret=dict(required=True, no_log=True), src=dict(required=True, type='int'), dest=dict(required=True, type='list', elements='int'), msg=dict(required=True), ), ) module = AnsibleModule( argument_spec=argument_spec ) send_msg(module) if __name__ == '__main__': main() PK $�!\P�i i [ collections/ansible_collections/community/general/plugins/modules/oneview_enclosure_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017, Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_enclosure_info short_description: Retrieve information about one or more Enclosures description: - Retrieve information about one or more of the Enclosures from OneView. - This module was called C(oneview_enclosure_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.oneview_enclosure_info) module no longer returns C(ansible_facts)! requirements: - hpOneView >= 2.0.1 author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name: description: - Enclosure name. type: str options: description: - "List with options to gather additional information about an Enclosure and related resources. Options allowed: V(script), V(environmentalConfiguration), and V(utilization). For the option V(utilization), you can provide specific parameters." type: list elements: raw extends_documentation_fragment: - community.general.oneview - community.general.oneview.factsparams - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: Gather information about all Enclosures community.general.oneview_enclosure_info: hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Enclosures ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather paginated, filtered and sorted information about Enclosures community.general.oneview_enclosure_info: params: start: 0 count: 3 sort: name:descending filter: status=OK hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about paginated, filtered ans sorted list of Enclosures ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather information about an Enclosure by name community.general.oneview_enclosure_info: name: Enclosure-Name hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Enclosure found by name ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Gather information about an Enclosure by name with options community.general.oneview_enclosure_info: name: Test-Enclosure options: - script # optional - environmentalConfiguration # optional - utilization # optional hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Enclosure found by name ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Print fetched information about Enclosure Script ansible.builtin.debug: msg: "{{ result.enclosure_script }}" - name: Print fetched information about Enclosure Environmental Configuration ansible.builtin.debug: msg: "{{ result.enclosure_environmental_configuration }}" - name: Print fetched information about Enclosure Utilization ansible.builtin.debug: msg: "{{ result.enclosure_utilization }}" - name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two specified dates" community.general.oneview_enclosure_info: name: Test-Enclosure options: - utilization: # optional fields: AmbientTemperature filter: - startDate=2016-07-01T14:29:42.000Z - endDate=2017-07-01T03:29:42.000Z view: day refresh: false hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Enclosure found by name ansible.builtin.debug: msg: "{{ result.enclosures }}" - name: Print fetched information about Enclosure Utilization ansible.builtin.debug: msg: "{{ result.enclosure_utilization }}" ''' RETURN = ''' enclosures: description: Has all the OneView information about the Enclosures. returned: Always, but can be null. type: dict enclosure_script: description: Has all the OneView information about the script of an Enclosure. returned: When requested, but can be null. type: str enclosure_environmental_configuration: description: Has all the OneView information about the environmental configuration of an Enclosure. returned: When requested, but can be null. type: dict enclosure_utilization: description: Has all the OneView information about the utilization of an Enclosure. returned: When requested, but can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class EnclosureInfoModule(OneViewModuleBase): argument_spec = dict( name=dict(type='str'), options=dict(type='list', elements='raw'), params=dict(type='dict') ) def __init__(self): super(EnclosureInfoModule, self).__init__( additional_arg_spec=self.argument_spec, supports_check_mode=True, ) def execute_module(self): info = {} if self.module.params['name']: enclosures = self._get_by_name(self.module.params['name']) if self.options and enclosures: info = self._gather_optional_info(self.options, enclosures[0]) else: enclosures = self.oneview_client.enclosures.get_all(**self.facts_params) info['enclosures'] = enclosures return dict(changed=False, **info) def _gather_optional_info(self, options, enclosure): enclosure_client = self.oneview_client.enclosures info = {} if options.get('script'): info['enclosure_script'] = enclosure_client.get_script(enclosure['uri']) if options.get('environmentalConfiguration'): env_config = enclosure_client.get_environmental_configuration(enclosure['uri']) info['enclosure_environmental_configuration'] = env_config if options.get('utilization'): info['enclosure_utilization'] = self._get_utilization(enclosure, options['utilization']) return info def _get_utilization(self, enclosure, params): fields = view = refresh = filter = '' if isinstance(params, dict): fields = params.get('fields') view = params.get('view') refresh = params.get('refresh') filter = params.get('filter') return self.oneview_client.enclosures.get_utilization(enclosure['uri'], fields=fields, filter=filter, refresh=refresh, view=view) def _get_by_name(self, name): return self.oneview_client.enclosures.get_by('name', name) def main(): EnclosureInfoModule().run() if __name__ == '__main__': main() PK $�!\��cI Y collections/ansible_collections/community/general/plugins/modules/scaleway_server_info.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: scaleway_server_info short_description: Gather information about the Scaleway servers available description: - Gather information about the Scaleway servers available. author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module options: region: type: str description: - Scaleway region to use (for example C(par1)). required: true choices: - ams1 - EMEA-NL-EVS - par1 - EMEA-FR-PAR1 - par2 - EMEA-FR-PAR2 - waw1 - EMEA-PL-WAW1 ''' EXAMPLES = r''' - name: Gather Scaleway servers information community.general.scaleway_server_info: region: par1 register: result - ansible.builtin.debug: msg: "{{ result.scaleway_server_info }}" ''' RETURN = r''' --- scaleway_server_info: description: - Response from Scaleway API. - "For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/)." returned: success type: list elements: dict sample: "scaleway_server_info": [ { "arch": "x86_64", "boot_type": "local", "bootscript": { "architecture": "x86_64", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "default": true, "dtb": "", "id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127", "organization": "11111111-1111-4111-8111-111111111111", "public": true, "title": "x86_64 mainline 4.4.127 rev1" }, "commercial_type": "START1-XS", "creation_date": "2018-08-14T21:36:56.271545+00:00", "dynamic_ip_required": false, "enable_ipv6": false, "extra_networks": [], "hostname": "scw-e0d256", "id": "12f19bc7-108c-4517-954c-e6b3d0311363", "image": { "arch": "x86_64", "creation_date": "2018-04-26T12:42:21.619844+00:00", "default_bootscript": { "architecture": "x86_64", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "default": true, "dtb": "", "id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127", "organization": "11111111-1111-4111-8111-111111111111", "public": true, "title": "x86_64 mainline 4.4.127 rev1" }, "extra_volumes": [], "from_server": null, "id": "67375eb1-f14d-4f02-bb42-6119cecbde51", "modification_date": "2018-04-26T12:49:07.573004+00:00", "name": "Ubuntu Xenial", "organization": "51b656e3-4865-41e8-adbc-0c45bdd780db", "public": true, "root_volume": { "id": "020b8d61-3867-4a0e-84a4-445c5393e05d", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42", "size": 25000000000, "volume_type": "l_ssd" }, "state": "available" }, "ipv6": null, "location": { "cluster_id": "5", "hypervisor_id": "412", "node_id": "2", "platform_id": "13", "zone_id": "par1" }, "maintenances": [], "modification_date": "2018-08-14T21:37:28.630882+00:00", "name": "scw-e0d256", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "private_ip": "10.14.222.131", "protected": false, "public_ip": { "address": "163.172.170.197", "dynamic": false, "id": "ea081794-a581-4495-8451-386ddaf0a451" }, "security_group": { "id": "a37379d2-d8b0-4668-9cfb-1233fc436f7e", "name": "Default security group" }, "state": "running", "state_detail": "booted", "tags": [], "volumes": { "0": { "creation_date": "2018-08-14T21:36:56.271545+00:00", "export_uri": "device://dev/vda", "id": "68386fae-4f55-4fbf-aabb-953036a85872", "modification_date": "2018-08-14T21:36:56.271545+00:00", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "server": { "id": "12f19bc7-108c-4517-954c-e6b3d0311363", "name": "scw-e0d256" }, "size": 25000000000, "state": "available", "volume_type": "l_ssd" } } } ] ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.scaleway import ( Scaleway, ScalewayException, scaleway_argument_spec, SCALEWAY_LOCATION, ) class ScalewayServerInfo(Scaleway): def __init__(self, module): super(ScalewayServerInfo, self).__init__(module) self.name = 'servers' region = module.params["region"] self.module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"] def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())), )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) try: module.exit_json( scaleway_server_info=ScalewayServerInfo(module).get_resources() ) except ScalewayException as exc: module.fail_json(msg=exc.message) if __name__ == '__main__': main() PK $�!\�32��8 �8 Q collections/ansible_collections/community/general/plugins/modules/osx_defaults.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, GeekChimp - Franck Nijhof <franck@geekchimp.com> (DO NOT CONTACT!) # Copyright (c) 2019, Ansible project # Copyright (c) 2019, Abhijeet Kasurde <akasurde@redhat.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: osx_defaults author: # DO NOT RE-ADD GITHUB HANDLE! - Franck Nijhof (!UNKNOWN) short_description: Manage macOS user defaults description: - osx_defaults allows users to read, write, and delete macOS user defaults from Ansible scripts. - macOS applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications are not running (such as default font for new documents, or the position of an Info panel). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: domain: description: - The domain is a domain name of the form C(com.companyname.appname). type: str default: NSGlobalDomain host: description: - The host on which the preference should apply. - The special value V(currentHost) corresponds to the C(-currentHost) switch of the defaults commandline tool. type: str key: description: - The key of the user preference. type: str type: description: - The type of value to write. type: str choices: [ array, bool, boolean, date, float, int, integer, string ] default: string array_add: description: - Add new elements to the array for a key which has an array as its value. type: bool default: false value: description: - The value to write. - Only required when O(state=present). type: raw state: description: - The state of the user defaults. - If set to V(list) will query the given parameter specified by O(key). Returns V(null) is nothing found or mis-spelled. - V(list) added in Ansible 2.8. type: str choices: [ absent, list, present ] default: present path: description: - The path in which to search for C(defaults). type: str default: /usr/bin:/usr/local/bin notes: - Apple Mac caches defaults. You may need to logout and login to apply the changes. ''' EXAMPLES = r''' - name: Set boolean valued key for application domain community.general.osx_defaults: domain: com.apple.Safari key: IncludeInternalDebugMenu type: bool value: true state: present - name: Set string valued key for global domain community.general.osx_defaults: domain: NSGlobalDomain key: AppleMeasurementUnits type: string value: Centimeters state: present - name: Set int valued key for arbitrary plist community.general.osx_defaults: domain: /Library/Preferences/com.apple.SoftwareUpdate key: AutomaticCheckEnabled type: int value: 1 become: true - name: Set int valued key only for the current host community.general.osx_defaults: domain: com.apple.screensaver host: currentHost key: showClock type: int value: 1 - name: Defaults to global domain and setting value community.general.osx_defaults: key: AppleMeasurementUnits type: string value: Centimeters - name: Setting an array valued key community.general.osx_defaults: key: AppleLanguages type: array value: - en - nl - name: Removing a key community.general.osx_defaults: domain: com.geekchimp.macable key: ExampleKeyToRemove state: absent ''' from datetime import datetime import re from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import binary_type, text_type # exceptions --------------------------------------------------------------- {{{ class OSXDefaultsException(Exception): def __init__(self, msg): self.message = msg # /exceptions -------------------------------------------------------------- }}} # class MacDefaults -------------------------------------------------------- {{{ class OSXDefaults(object): """ Class to manage Mac OS user defaults """ # init ---------------------------------------------------------------- {{{ def __init__(self, module): """ Initialize this module. Finds 'defaults' executable and preps the parameters """ # Initial var for storing current defaults value self.current_value = None self.module = module self.domain = module.params['domain'] self.host = module.params['host'] self.key = module.params['key'] self.type = module.params['type'] self.array_add = module.params['array_add'] self.value = module.params['value'] self.state = module.params['state'] self.path = module.params['path'] # Try to find the defaults executable self.executable = self.module.get_bin_path( 'defaults', required=False, opt_dirs=self.path.split(':'), ) if not self.executable: raise OSXDefaultsException("Unable to locate defaults executable.") # Ensure the value is the correct type if self.state != 'absent': self.value = self._convert_type(self.type, self.value) # /init --------------------------------------------------------------- }}} # tools --------------------------------------------------------------- {{{ @staticmethod def is_int(value): as_str = str(value) if (as_str.startswith("-")): return as_str[1:].isdigit() else: return as_str.isdigit() @staticmethod def _convert_type(data_type, value): """ Converts value to given type """ if data_type == "string": return str(value) elif data_type in ["bool", "boolean"]: if isinstance(value, (binary_type, text_type)): value = value.lower() if value in [True, 1, "true", "1", "yes"]: return True elif value in [False, 0, "false", "0", "no"]: return False raise OSXDefaultsException("Invalid boolean value: {0}".format(repr(value))) elif data_type == "date": try: return datetime.strptime(value.split("+")[0].strip(), "%Y-%m-%d %H:%M:%S") except ValueError: raise OSXDefaultsException( "Invalid date value: {0}. Required format yyy-mm-dd hh:mm:ss.".format(repr(value)) ) elif data_type in ["int", "integer"]: if not OSXDefaults.is_int(value): raise OSXDefaultsException("Invalid integer value: {0}".format(repr(value))) return int(value) elif data_type == "float": try: value = float(value) except ValueError: raise OSXDefaultsException("Invalid float value: {0}".format(repr(value))) return value elif data_type == "array": if not isinstance(value, list): raise OSXDefaultsException("Invalid value. Expected value to be an array") return value raise OSXDefaultsException('Type is not supported: {0}'.format(data_type)) def _host_args(self): """ Returns a normalized list of commandline arguments based on the "host" attribute """ if self.host is None: return [] elif self.host == 'currentHost': return ['-currentHost'] else: return ['-host', self.host] def _base_command(self): """ Returns a list containing the "defaults" executable and any common base arguments """ return [self.executable] + self._host_args() @staticmethod def _convert_defaults_str_to_list(value): """ Converts array output from defaults to an list """ # Split output of defaults. Every line contains a value value = value.splitlines() # Remove first and last item, those are not actual values value.pop(0) value.pop(-1) # Remove spaces at beginning and comma (,) at the end, unquote and unescape double quotes value = [re.sub('^ *"?|"?,? *$', '', x.replace('\\"', '"')) for x in value] return value # /tools -------------------------------------------------------------- }}} # commands ------------------------------------------------------------ {{{ def read(self): """ Reads value of this domain & key from defaults """ # First try to find out the type rc, out, err = self.module.run_command(self._base_command() + ["read-type", self.domain, self.key]) # If RC is 1, the key does not exist if rc == 1: return None # If the RC is not 0, then terrible happened! Ooooh nooo! if rc != 0: raise OSXDefaultsException("An error occurred while reading key type from defaults: %s" % err) # Ok, lets parse the type from output data_type = out.strip().replace('Type is ', '') # Now get the current value rc, out, err = self.module.run_command(self._base_command() + ["read", self.domain, self.key]) # Strip output out = out.strip() # A non zero RC at this point is kinda strange... if rc != 0: raise OSXDefaultsException("An error occurred while reading key value from defaults: %s" % err) # Convert string to list when type is array if data_type == "array": out = self._convert_defaults_str_to_list(out) # Store the current_value self.current_value = self._convert_type(data_type, out) def write(self): """ Writes value to this domain & key to defaults """ # We need to convert some values so the defaults commandline understands it if isinstance(self.value, bool): if self.value: value = "TRUE" else: value = "FALSE" elif isinstance(self.value, (int, float)): value = str(self.value) elif self.array_add and self.current_value is not None: value = list(set(self.value) - set(self.current_value)) elif isinstance(self.value, datetime): value = self.value.strftime('%Y-%m-%d %H:%M:%S') else: value = self.value # When the type is array and array_add is enabled, morph the type :) if self.type == "array" and self.array_add: self.type = "array-add" # All values should be a list, for easy passing it to the command if not isinstance(value, list): value = [value] rc, out, err = self.module.run_command(self._base_command() + ['write', self.domain, self.key, '-' + self.type] + value, expand_user_and_vars=False) if rc != 0: raise OSXDefaultsException('An error occurred while writing value to defaults: %s' % err) def delete(self): """ Deletes defaults key from domain """ rc, out, err = self.module.run_command(self._base_command() + ['delete', self.domain, self.key]) if rc != 0: raise OSXDefaultsException("An error occurred while deleting key from defaults: %s" % err) # /commands ----------------------------------------------------------- }}} # run ----------------------------------------------------------------- {{{ """ Does the magic! :) """ def run(self): # Get the current value from defaults self.read() if self.state == 'list': self.module.exit_json(key=self.key, value=self.current_value) # Handle absent state if self.state == "absent": if self.current_value is None: return False if self.module.check_mode: return True self.delete() return True # There is a type mismatch! Given type does not match the type in defaults value_type = type(self.value) if self.current_value is not None and not isinstance(self.current_value, value_type): raise OSXDefaultsException("Type mismatch. Type in defaults: %s" % type(self.current_value).__name__) # Current value matches the given value. Nothing need to be done. Arrays need extra care if self.type == "array" and self.current_value is not None and not self.array_add and \ set(self.current_value) == set(self.value): return False elif self.type == "array" and self.current_value is not None and self.array_add and len(list(set(self.value) - set(self.current_value))) == 0: return False elif self.current_value == self.value: return False if self.module.check_mode: return True # Change/Create/Set given key/value for domain in defaults self.write() return True # /run ---------------------------------------------------------------- }}} # /class MacDefaults ------------------------------------------------------ }}} # main -------------------------------------------------------------------- {{{ def main(): module = AnsibleModule( argument_spec=dict( domain=dict(type='str', default='NSGlobalDomain'), host=dict(type='str'), key=dict(type='str', no_log=False), type=dict(type='str', default='string', choices=['array', 'bool', 'boolean', 'date', 'float', 'int', 'integer', 'string']), array_add=dict(type='bool', default=False), value=dict(type='raw'), state=dict(type='str', default='present', choices=['absent', 'list', 'present']), path=dict(type='str', default='/usr/bin:/usr/local/bin'), ), supports_check_mode=True, required_if=( ('state', 'present', ['value']), ), ) try: defaults = OSXDefaults(module=module) module.exit_json(changed=defaults.run()) except OSXDefaultsException as e: module.fail_json(msg=e.message) # /main ------------------------------------------------------------------- }}} if __name__ == '__main__': main() PK $�!\7d�mRZ RZ H collections/ansible_collections/community/general/plugins/modules/ufw.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Ahti Kitsik <ak@ahtik.com> # Copyright (c) 2014, Jarno Keskikangas <jarno.keskikangas@gmail.com> # Copyright (c) 2013, Aleksey Ovcharenko <aleksey.ovcharenko@gmail.com> # Copyright (c) 2013, James Martin <jmartin@basho.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ufw short_description: Manage firewall with UFW description: - Manage firewall with UFW. author: - Aleksey Ovcharenko (@ovcharenko) - Jarno Keskikangas (@pyykkis) - Ahti Kitsik (@ahtik) notes: - See C(man ufw) for more examples. requirements: - C(ufw) package extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - V(enabled) reloads firewall and enables firewall on boot. - V(disabled) unloads firewall and disables firewall on boot. - V(reloaded) reloads firewall. - V(reset) disables and resets firewall to installation defaults. type: str choices: [ disabled, enabled, reloaded, reset ] default: description: - Change the default policy for incoming or outgoing traffic. type: str choices: [ allow, deny, reject ] aliases: [ policy ] direction: description: - Select direction for a rule or default policy command. Mutually exclusive with O(interface_in) and O(interface_out). type: str choices: [ in, incoming, out, outgoing, routed ] logging: description: - Toggles logging. Logged packets use the LOG_KERN syslog facility. type: str choices: [ 'on', 'off', low, medium, high, full ] insert: description: - Insert the corresponding rule as rule number NUM. - Note that ufw numbers rules starting with 1. - If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored. type: int insert_relative_to: description: - Allows to interpret the index in O(insert) relative to a position. - V(zero) interprets the rule number as an absolute index (i.e. 1 is the first rule). - V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position where the first IPv4 rule would be if there is currently none. - V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where the last IPv4 rule would be if there is currently none. - V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position where the first IPv6 rule would be if there is currently none. - V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where the last IPv6 rule would be if there is currently none. type: str choices: [ first-ipv4, first-ipv6, last-ipv4, last-ipv6, zero ] default: zero rule: description: - Add firewall rule type: str choices: [ allow, deny, limit, reject ] log: description: - Log new connections matched to this rule type: bool default: false from_ip: description: - Source IP address. type: str default: any aliases: [ from, src ] from_port: description: - Source port. type: str to_ip: description: - Destination IP address. type: str default: any aliases: [ dest, to] to_port: description: - Destination port. type: str aliases: [ port ] proto: description: - TCP/IP protocol. type: str choices: [ any, tcp, udp, ipv6, esp, ah, gre, igmp ] aliases: [ protocol ] name: description: - Use profile located in C(/etc/ufw/applications.d). type: str aliases: [ app ] delete: description: - Delete rule. - If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored. type: bool default: false interface: description: - Specify interface for the rule. The direction (in or out) used for the interface depends on the value of O(direction). See O(interface_in) and O(interface_out) for routed rules that needs to supply both an input and output interface. Mutually exclusive with O(interface_in) and O(interface_out). type: str aliases: [ if ] interface_in: description: - Specify input interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_out) for routed rules. type: str aliases: [ if_in ] version_added: '0.2.0' interface_out: description: - Specify output interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_in) for routed rules. type: str aliases: [ if_out ] version_added: '0.2.0' route: description: - Apply the rule to routed/forwarded packets. type: bool default: false comment: description: - Add a comment to the rule. Requires UFW version >=0.35. type: str ''' EXAMPLES = r''' - name: Allow everything and enable UFW community.general.ufw: state: enabled policy: allow - name: Set logging community.general.ufw: logging: 'on' # Sometimes it is desirable to let the sender know when traffic is # being denied, rather than simply ignoring it. In these cases, use # reject instead of deny. In addition, log rejected connections: - community.general.ufw: rule: reject port: auth log: true # ufw supports connection rate limiting, which is useful for protecting # against brute-force login attacks. ufw will deny connections if an IP # address has attempted to initiate 6 or more connections in the last # 30 seconds. See http://www.debian-administration.org/articles/187 # for details. Typical usage is: - community.general.ufw: rule: limit port: ssh proto: tcp # Allow OpenSSH. (Note that as ufw manages its own state, simply removing # a rule=allow task can leave those ports exposed. Either use delete=true # or a separate state=reset task) - community.general.ufw: rule: allow name: OpenSSH - name: Delete OpenSSH rule community.general.ufw: rule: allow name: OpenSSH delete: true - name: Deny all access to port 53 community.general.ufw: rule: deny port: '53' - name: Allow port range 60000-61000 community.general.ufw: rule: allow port: 60000:61000 proto: tcp - name: Allow all access to tcp port 80 community.general.ufw: rule: allow port: '80' proto: tcp - name: Allow all access from RFC1918 networks to this host community.general.ufw: rule: allow src: '{{ item }}' loop: - 10.0.0.0/8 - 172.16.0.0/12 - 192.168.0.0/16 - name: Deny access to udp port 514 from host 1.2.3.4 and include a comment community.general.ufw: rule: deny proto: udp src: 1.2.3.4 port: '514' comment: Block syslog - name: Allow incoming access to eth0 from 1.2.3.5 port 5469 to 1.2.3.4 port 5469 community.general.ufw: rule: allow interface: eth0 direction: in proto: udp src: 1.2.3.5 from_port: '5469' dest: 1.2.3.4 to_port: '5469' # Note that IPv6 must be enabled in /etc/default/ufw for IPv6 firewalling to work. - name: Deny all traffic from the IPv6 2001:db8::/32 to tcp port 25 on this host community.general.ufw: rule: deny proto: tcp src: 2001:db8::/32 port: '25' - name: Deny all IPv6 traffic to tcp port 20 on this host # this should be the first IPv6 rule community.general.ufw: rule: deny proto: tcp port: '20' to_ip: "::" insert: 0 insert_relative_to: first-ipv6 - name: Deny all IPv4 traffic to tcp port 20 on this host # This should be the third to last IPv4 rule # (insert: -1 addresses the second to last IPv4 rule; # so the new rule will be inserted before the second # to last IPv4 rule, and will be come the third to last # IPv4 rule.) community.general.ufw: rule: deny proto: tcp port: '20' to_ip: "::" insert: -1 insert_relative_to: last-ipv4 # Can be used to further restrict a global FORWARD policy set to allow - name: Deny forwarded/routed traffic from subnet 1.2.3.0/24 to subnet 4.5.6.0/24 community.general.ufw: rule: deny route: true src: 192.0.2.0/24 dest: 198.51.100.0/24 ''' import re from operator import itemgetter from ansible.module_utils.basic import AnsibleModule def compile_ipv4_regexp(): r = r"((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}" r += r"(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])" return re.compile(r) def compile_ipv6_regexp(): """ validation pattern provided by : https://stackoverflow.com/questions/53497/regular-expression-that-matches- valid-ipv6-addresses#answer-17871737 """ r = r"(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:" r += r"|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}" r += r"(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4})" r += r"{1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]" r += r"{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]" r += r"{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4})" r += r"{0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]" r += r"|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}" r += r"[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}" r += r"[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))" return re.compile(r) def main(): command_keys = ['state', 'default', 'rule', 'logging'] module = AnsibleModule( argument_spec=dict( state=dict(type='str', choices=['enabled', 'disabled', 'reloaded', 'reset']), default=dict(type='str', aliases=['policy'], choices=['allow', 'deny', 'reject']), logging=dict(type='str', choices=['full', 'high', 'low', 'medium', 'off', 'on']), direction=dict(type='str', choices=['in', 'incoming', 'out', 'outgoing', 'routed']), delete=dict(type='bool', default=False), route=dict(type='bool', default=False), insert=dict(type='int'), insert_relative_to=dict(choices=['zero', 'first-ipv4', 'last-ipv4', 'first-ipv6', 'last-ipv6'], default='zero'), rule=dict(type='str', choices=['allow', 'deny', 'limit', 'reject']), interface=dict(type='str', aliases=['if']), interface_in=dict(type='str', aliases=['if_in']), interface_out=dict(type='str', aliases=['if_out']), log=dict(type='bool', default=False), from_ip=dict(type='str', default='any', aliases=['from', 'src']), from_port=dict(type='str'), to_ip=dict(type='str', default='any', aliases=['dest', 'to']), to_port=dict(type='str', aliases=['port']), proto=dict(type='str', aliases=['protocol'], choices=['ah', 'any', 'esp', 'ipv6', 'tcp', 'udp', 'gre', 'igmp']), name=dict(type='str', aliases=['app']), comment=dict(type='str'), ), supports_check_mode=True, mutually_exclusive=[ ['name', 'proto', 'logging'], # Mutual exclusivity with `interface` implied by `required_by`. ['direction', 'interface_in'], ['direction', 'interface_out'], ], required_one_of=([command_keys]), required_by=dict( interface=('direction', ), ), ) cmds = [] ipv4_regexp = compile_ipv4_regexp() ipv6_regexp = compile_ipv6_regexp() def filter_line_that_not_start_with(pattern, content): return ''.join([line for line in content.splitlines(True) if line.startswith(pattern)]) def filter_line_that_contains(pattern, content): return [line for line in content.splitlines(True) if pattern in line] def filter_line_that_not_contains(pattern, content): return ''.join([line for line in content.splitlines(True) if not line.contains(pattern)]) def filter_line_that_match_func(match_func, content): return ''.join([line for line in content.splitlines(True) if match_func(line) is not None]) def filter_line_that_contains_ipv4(content): return filter_line_that_match_func(ipv4_regexp.search, content) def filter_line_that_contains_ipv6(content): return filter_line_that_match_func(ipv6_regexp.search, content) def is_starting_by_ipv4(ip): return ipv4_regexp.match(ip) is not None def is_starting_by_ipv6(ip): return ipv6_regexp.match(ip) is not None def execute(cmd, ignore_error=False): cmd = ' '.join(map(itemgetter(-1), filter(itemgetter(0), cmd))) cmds.append(cmd) (rc, out, err) = module.run_command(cmd, environ_update={"LANG": "C"}) if rc != 0 and not ignore_error: module.fail_json(msg=err or out, commands=cmds) return out def get_current_rules(): user_rules_files = ["/lib/ufw/user.rules", "/lib/ufw/user6.rules", "/etc/ufw/user.rules", "/etc/ufw/user6.rules", "/var/lib/ufw/user.rules", "/var/lib/ufw/user6.rules"] cmd = [[grep_bin], ["-h"], ["'^### tuple'"]] cmd.extend([[f] for f in user_rules_files]) return execute(cmd, ignore_error=True) def ufw_version(): """ Returns the major and minor version of ufw installed on the system. """ out = execute([[ufw_bin], ["--version"]]) lines = [x for x in out.split('\n') if x.strip() != ''] if len(lines) == 0: module.fail_json(msg="Failed to get ufw version.", rc=0, out=out) matches = re.search(r'^ufw.+(\d+)\.(\d+)(?:\.(\d+))?.*$', lines[0]) if matches is None: module.fail_json(msg="Failed to get ufw version.", rc=0, out=out) # Convert version to numbers major = int(matches.group(1)) minor = int(matches.group(2)) rev = 0 if matches.group(3) is not None: rev = int(matches.group(3)) return major, minor, rev params = module.params commands = dict((key, params[key]) for key in command_keys if params[key]) # Ensure ufw is available ufw_bin = module.get_bin_path('ufw', True) grep_bin = module.get_bin_path('grep', True) # Save the pre state and rules in order to recognize changes pre_state = execute([[ufw_bin], ['status verbose']]) pre_rules = get_current_rules() changed = False # Execute filter for (command, value) in commands.items(): cmd = [[ufw_bin], [module.check_mode, '--dry-run']] if command == 'state': states = {'enabled': 'enable', 'disabled': 'disable', 'reloaded': 'reload', 'reset': 'reset'} if value in ['reloaded', 'reset']: changed = True if module.check_mode: # "active" would also match "inactive", hence the space ufw_enabled = pre_state.find(" active") != -1 if (value == 'disabled' and ufw_enabled) or (value == 'enabled' and not ufw_enabled): changed = True else: execute(cmd + [['-f'], [states[value]]]) elif command == 'logging': extract = re.search(r'Logging: (on|off)(?: \(([a-z]+)\))?', pre_state) if extract: current_level = extract.group(2) current_on_off_value = extract.group(1) if value != "off": if current_on_off_value == "off": changed = True elif value != "on" and value != current_level: changed = True elif current_on_off_value != "off": changed = True else: changed = True if not module.check_mode: execute(cmd + [[command], [value]]) elif command == 'default': if params['direction'] not in ['outgoing', 'incoming', 'routed', None]: module.fail_json(msg='For default, direction must be one of "outgoing", "incoming" and "routed", or direction must not be specified.') if module.check_mode: regexp = r'Default: (deny|allow|reject) \(incoming\), (deny|allow|reject) \(outgoing\), (deny|allow|reject|disabled) \(routed\)' extract = re.search(regexp, pre_state) if extract is not None: current_default_values = {} current_default_values["incoming"] = extract.group(1) current_default_values["outgoing"] = extract.group(2) current_default_values["routed"] = extract.group(3) v = current_default_values[params['direction'] or 'incoming'] if v not in (value, 'disabled'): changed = True else: changed = True else: execute(cmd + [[command], [value], [params['direction']]]) elif command == 'rule': if params['direction'] not in ['in', 'out', None]: module.fail_json(msg='For rules, direction must be one of "in" and "out", or direction must not be specified.') if not params['route'] and params['interface_in'] and params['interface_out']: module.fail_json(msg='Only route rules can combine ' 'interface_in and interface_out') # Rules are constructed according to the long format # # ufw [--dry-run] [route] [delete | insert NUM] allow|deny|reject|limit [in|out on INTERFACE] [log|log-all] \ # [from ADDRESS [port PORT]] [to ADDRESS [port PORT]] \ # [proto protocol] [app application] [comment COMMENT] cmd.append([module.boolean(params['route']), 'route']) cmd.append([module.boolean(params['delete']), 'delete']) if params['insert'] is not None and not params['delete']: relative_to_cmd = params['insert_relative_to'] if relative_to_cmd == 'zero': insert_to = params['insert'] else: (dummy, numbered_state, dummy) = module.run_command([ufw_bin, 'status', 'numbered']) numbered_line_re = re.compile(R'^\[ *([0-9]+)\] ') lines = [(numbered_line_re.match(line), '(v6)' in line) for line in numbered_state.splitlines()] lines = [(int(matcher.group(1)), ipv6) for (matcher, ipv6) in lines if matcher] last_number = max([no for (no, ipv6) in lines]) if lines else 0 has_ipv4 = any(not ipv6 for (no, ipv6) in lines) has_ipv6 = any(ipv6 for (no, ipv6) in lines) if relative_to_cmd == 'first-ipv4': relative_to = 1 elif relative_to_cmd == 'last-ipv4': relative_to = max([no for (no, ipv6) in lines if not ipv6]) if has_ipv4 else 1 elif relative_to_cmd == 'first-ipv6': relative_to = max([no for (no, ipv6) in lines if not ipv6]) + 1 if has_ipv4 else 1 elif relative_to_cmd == 'last-ipv6': relative_to = last_number if has_ipv6 else last_number + 1 insert_to = params['insert'] + relative_to if insert_to > last_number: # ufw does not like it when the insert number is larger than the # maximal rule number for IPv4/IPv6. insert_to = None cmd.append([insert_to is not None, "insert %s" % insert_to]) cmd.append([value]) cmd.append([params['direction'], "%s" % params['direction']]) cmd.append([params['interface'], "on %s" % params['interface']]) cmd.append([params['interface_in'], "in on %s" % params['interface_in']]) cmd.append([params['interface_out'], "out on %s" % params['interface_out']]) cmd.append([module.boolean(params['log']), 'log']) for (key, template) in [('from_ip', "from %s"), ('from_port', "port %s"), ('to_ip', "to %s"), ('to_port', "port %s"), ('proto', "proto %s"), ('name', "app '%s'")]: value = params[key] cmd.append([value, template % (value)]) ufw_major, ufw_minor, dummy = ufw_version() # comment is supported only in ufw version after 0.35 if (ufw_major == 0 and ufw_minor >= 35) or ufw_major > 0: cmd.append([params['comment'], "comment '%s'" % params['comment']]) rules_dry = execute(cmd) if module.check_mode: nb_skipping_line = len(filter_line_that_contains("Skipping", rules_dry)) if not (nb_skipping_line > 0 and nb_skipping_line == len(rules_dry.splitlines(True))): rules_dry = filter_line_that_not_start_with("### tuple", rules_dry) # ufw dry-run doesn't send all rules so have to compare ipv4 or ipv6 rules if is_starting_by_ipv4(params['from_ip']) or is_starting_by_ipv4(params['to_ip']): if filter_line_that_contains_ipv4(pre_rules) != filter_line_that_contains_ipv4(rules_dry): changed = True elif is_starting_by_ipv6(params['from_ip']) or is_starting_by_ipv6(params['to_ip']): if filter_line_that_contains_ipv6(pre_rules) != filter_line_that_contains_ipv6(rules_dry): changed = True elif pre_rules != rules_dry: changed = True # Get the new state if module.check_mode: return module.exit_json(changed=changed, commands=cmds) else: post_state = execute([[ufw_bin], ['status'], ['verbose']]) if not changed: post_rules = get_current_rules() changed = (pre_state != post_state) or (pre_rules != post_rules) return module.exit_json(changed=changed, commands=cmds, msg=post_state.rstrip()) if __name__ == '__main__': main() PK $�!\N�K��y �y I collections/ansible_collections/community/general/plugins/modules/pamd.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Kenneth D. Evensen <kdevensen@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' module: pamd author: - Kenneth D. Evensen (@kevensen) short_description: Manage PAM Modules description: - Edit PAM service's type, control, module path and module arguments. - In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d for details. notes: - This module does not handle authselect profiles. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name generally refers to the PAM service file to change, for example system-auth. type: str required: true type: description: - The type of the PAM rule being modified. - The O(type), O(control), and O(module_path) options all must match a rule to be modified. type: str required: true choices: [ account, -account, auth, -auth, password, -password, session, -session ] control: description: - The control of the PAM rule being modified. - This may be a complicated control with brackets. If this is the case, be sure to put "[bracketed controls]" in quotes. - The O(type), O(control), and O(module_path) options all must match a rule to be modified. type: str required: true module_path: description: - The module path of the PAM rule being modified. - The O(type), O(control), and O(module_path) options all must match a rule to be modified. type: str required: true new_type: description: - The new type to assign to the new rule. type: str choices: [ account, -account, auth, -auth, password, -password, session, -session ] new_control: description: - The new control to assign to the new rule. type: str new_module_path: description: - The new module path to be assigned to the new rule. type: str module_arguments: description: - When O(state=updated), the O(module_arguments) will replace existing module_arguments. - When O(state=args_absent) args matching those listed in O(module_arguments) will be removed. - When O(state=args_present) any args listed in O(module_arguments) are added if missing from the existing rule. - Furthermore, if the module argument takes a value denoted by C(=), the value will be changed to that specified in module_arguments. type: list elements: str state: description: - The default of V(updated) will modify an existing rule if type, control and module_path all match an existing rule. - With V(before), the new rule will be inserted before a rule matching type, control and module_path. - Similarly, with V(after), the new rule will be inserted after an existing rulematching type, control and module_path. - With either V(before) or V(after) O(new_type), O(new_control), and O(new_module_path) must all be specified. - If state is V(args_absent) or V(args_present), O(new_type), O(new_control), and O(new_module_path) will be ignored. - State V(absent) will remove the rule. The V(absent) state was added in Ansible 2.4. type: str choices: [ absent, before, after, args_absent, args_present, updated ] default: updated path: description: - This is the path to the PAM service files. type: path default: /etc/pam.d backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool default: false ''' EXAMPLES = r''' - name: Update pamd rule's control in /etc/pam.d/system-auth community.general.pamd: name: system-auth type: auth control: required module_path: pam_faillock.so new_control: sufficient - name: Update pamd rule's complex control in /etc/pam.d/system-auth community.general.pamd: name: system-auth type: session control: '[success=1 default=ignore]' module_path: pam_succeed_if.so new_control: '[success=2 default=ignore]' - name: Insert a new rule before an existing rule community.general.pamd: name: system-auth type: auth control: required module_path: pam_faillock.so new_type: auth new_control: sufficient new_module_path: pam_faillock.so state: before - name: Insert a new rule pam_wheel.so with argument 'use_uid' after an \ existing rule pam_rootok.so community.general.pamd: name: su type: auth control: sufficient module_path: pam_rootok.so new_type: auth new_control: required new_module_path: pam_wheel.so module_arguments: 'use_uid' state: after - name: Remove module arguments from an existing rule community.general.pamd: name: system-auth type: auth control: required module_path: pam_faillock.so module_arguments: '' state: updated - name: Replace all module arguments in an existing rule community.general.pamd: name: system-auth type: auth control: required module_path: pam_faillock.so module_arguments: 'preauth silent deny=3 unlock_time=604800 fail_interval=900' state: updated - name: Remove specific arguments from a rule community.general.pamd: name: system-auth type: session control: '[success=1 default=ignore]' module_path: pam_succeed_if.so module_arguments: crond,quiet state: args_absent - name: Ensure specific arguments are present in a rule community.general.pamd: name: system-auth type: session control: '[success=1 default=ignore]' module_path: pam_succeed_if.so module_arguments: crond,quiet state: args_present - name: Ensure specific arguments are present in a rule (alternative) community.general.pamd: name: system-auth type: session control: '[success=1 default=ignore]' module_path: pam_succeed_if.so module_arguments: - crond - quiet state: args_present - name: Module arguments requiring commas must be listed as a Yaml list community.general.pamd: name: special-module type: account control: required module_path: pam_access.so module_arguments: - listsep=, state: args_present - name: Update specific argument value in a rule community.general.pamd: name: system-auth type: auth control: required module_path: pam_faillock.so module_arguments: 'fail_interval=300' state: args_present - name: Add pam common-auth rule for duo community.general.pamd: name: common-auth new_type: auth new_control: '[success=1 default=ignore]' new_module_path: '/lib64/security/pam_duo.so' state: after type: auth module_path: pam_sss.so control: 'requisite' ''' RETURN = r''' change_count: description: How many rules were changed. type: int sample: 1 returned: success backupdest: description: - "The file name of the backup file, if created." returned: success type: str ... ''' from ansible.module_utils.basic import AnsibleModule import os import re from tempfile import NamedTemporaryFile from datetime import datetime RULE_REGEX = re.compile(r"""(?P<rule_type>-?(?:auth|account|session|password))\s+ (?P<control>\[.*\]|\S*)\s+ (?P<path>\S*)\s* (?P<args>.*)\s*""", re.X) RULE_ARG_REGEX = re.compile(r"(\[.*\]|\S*)") VALID_TYPES = ['account', '-account', 'auth', '-auth', 'password', '-password', 'session', '-session'] class PamdLine(object): def __init__(self, line): self.line = line self.prev = None self.next = None @property def is_valid(self): if self.line.strip() == '': return True return False def validate(self): if not self.is_valid: return False, "Rule is not valid " + self.line return True, "Rule is valid " + self.line # Method to check if a rule matches the type, control and path. def matches(self, rule_type, rule_control, rule_path, rule_args=None): return False def __str__(self): return str(self.line) class PamdEmptyLine(PamdLine): pass class PamdComment(PamdLine): def __init__(self, line): super(PamdComment, self).__init__(line) @property def is_valid(self): if self.line.startswith('#'): return True return False class PamdInclude(PamdLine): def __init__(self, line): super(PamdInclude, self).__init__(line) @property def is_valid(self): if self.line.startswith('@include'): return True return False class PamdRule(PamdLine): valid_simple_controls = ['required', 'requisite', 'sufficient', 'optional', 'include', 'substack', 'definitive'] valid_control_values = ['success', 'open_err', 'symbol_err', 'service_err', 'system_err', 'buf_err', 'perm_denied', 'auth_err', 'cred_insufficient', 'authinfo_unavail', 'user_unknown', 'maxtries', 'new_authtok_reqd', 'acct_expired', 'session_err', 'cred_unavail', 'cred_expired', 'cred_err', 'no_module_data', 'conv_err', 'authtok_err', 'authtok_recover_err', 'authtok_lock_busy', 'authtok_disable_aging', 'try_again', 'ignore', 'abort', 'authtok_expired', 'module_unknown', 'bad_item', 'conv_again', 'incomplete', 'default'] valid_control_actions = ['ignore', 'bad', 'die', 'ok', 'done', 'reset'] def __init__(self, rule_type, rule_control, rule_path, rule_args=None): self.prev = None self.next = None self._control = None self._args = None self.rule_type = rule_type self.rule_control = rule_control self.rule_path = rule_path self.rule_args = rule_args # Method to check if a rule matches the type, control and path. def matches(self, rule_type, rule_control, rule_path, rule_args=None): return (rule_type == self.rule_type and rule_control == self.rule_control and rule_path == self.rule_path) @classmethod def rule_from_string(cls, line): rule_match = RULE_REGEX.search(line) rule_args = parse_module_arguments(rule_match.group('args')) return cls(rule_match.group('rule_type'), rule_match.group('control'), rule_match.group('path'), rule_args) def __str__(self): if self.rule_args: return '{0: <11}{1} {2} {3}'.format(self.rule_type, self.rule_control, self.rule_path, ' '.join(self.rule_args)) return '{0: <11}{1} {2}'.format(self.rule_type, self.rule_control, self.rule_path) @property def rule_control(self): if isinstance(self._control, list): return '[' + ' '.join(self._control) + ']' return self._control @rule_control.setter def rule_control(self, control): if control.startswith('['): control = control.replace(' = ', '=').replace('[', '').replace(']', '') self._control = control.split(' ') else: self._control = control @property def rule_args(self): if not self._args: return [] return self._args @rule_args.setter def rule_args(self, args): self._args = parse_module_arguments(args) @property def line(self): return str(self) @classmethod def is_action_unsigned_int(cls, string_num): number = 0 try: number = int(string_num) except ValueError: return False if number >= 0: return True return False @property def is_valid(self): return self.validate()[0] def validate(self): # Validate the rule type if self.rule_type not in VALID_TYPES: return False, "Rule type, " + self.rule_type + ", is not valid in rule " + self.line # Validate the rule control if isinstance(self._control, str) and self.rule_control not in PamdRule.valid_simple_controls: return False, "Rule control, " + self.rule_control + ", is not valid in rule " + self.line elif isinstance(self._control, list): for control in self._control: value, action = control.split("=") if value not in PamdRule.valid_control_values: return False, "Rule control value, " + value + ", is not valid in rule " + self.line if action not in PamdRule.valid_control_actions and not PamdRule.is_action_unsigned_int(action): return False, "Rule control action, " + action + ", is not valid in rule " + self.line # TODO: Validate path return True, "Rule is valid " + self.line # PamdService encapsulates an entire service and contains one or more rules. It seems the best way is to do this # as a doubly linked list. class PamdService(object): def __init__(self, content): self._head = None self._tail = None for line in content.splitlines(): if line.lstrip().startswith('#'): pamd_line = PamdComment(line) elif line.lstrip().startswith('@include'): pamd_line = PamdInclude(line) elif line.strip() == '': pamd_line = PamdEmptyLine(line) else: pamd_line = PamdRule.rule_from_string(line) self.append(pamd_line) def append(self, pamd_line): if self._head is None: self._head = self._tail = pamd_line else: pamd_line.prev = self._tail pamd_line.next = None self._tail.next = pamd_line self._tail = pamd_line def remove(self, rule_type, rule_control, rule_path): current_line = self._head changed = 0 while current_line is not None: if current_line.matches(rule_type, rule_control, rule_path): if current_line.prev is not None: current_line.prev.next = current_line.next if current_line.next is not None: current_line.next.prev = current_line.prev else: self._head = current_line.next current_line.next.prev = None changed += 1 current_line = current_line.next return changed def get(self, rule_type, rule_control, rule_path): lines = [] current_line = self._head while current_line is not None: if isinstance(current_line, PamdRule) and current_line.matches(rule_type, rule_control, rule_path): lines.append(current_line) current_line = current_line.next return lines def has_rule(self, rule_type, rule_control, rule_path): if self.get(rule_type, rule_control, rule_path): return True return False def update_rule(self, rule_type, rule_control, rule_path, new_type=None, new_control=None, new_path=None, new_args=None): # Get a list of rules we want to change rules_to_find = self.get(rule_type, rule_control, rule_path) new_args = parse_module_arguments(new_args, return_none=True) changes = 0 for current_rule in rules_to_find: rule_changed = False if new_type: if current_rule.rule_type != new_type: rule_changed = True current_rule.rule_type = new_type if new_control: if current_rule.rule_control != new_control: rule_changed = True current_rule.rule_control = new_control if new_path: if current_rule.rule_path != new_path: rule_changed = True current_rule.rule_path = new_path if new_args is not None: if current_rule.rule_args != new_args: rule_changed = True current_rule.rule_args = new_args if rule_changed: changes += 1 return changes def insert_before(self, rule_type, rule_control, rule_path, new_type=None, new_control=None, new_path=None, new_args=None): # Get a list of rules we want to change rules_to_find = self.get(rule_type, rule_control, rule_path) changes = 0 # There are two cases to consider. # 1. The new rule doesn't exist before the existing rule # 2. The new rule exists for current_rule in rules_to_find: # Create a new rule new_rule = PamdRule(new_type, new_control, new_path, new_args) # First we'll get the previous rule. previous_rule = current_rule.prev # Next we may have to loop backwards if the previous line is a comment. If it # is, we'll get the previous "rule's" previous. while previous_rule is not None and isinstance(previous_rule, (PamdComment, PamdEmptyLine)): previous_rule = previous_rule.prev # Next we'll see if the previous rule matches what we are trying to insert. if previous_rule is not None and not previous_rule.matches(new_type, new_control, new_path): # First set the original previous rule's next to the new_rule previous_rule.next = new_rule # Second, set the new_rule's previous to the original previous new_rule.prev = previous_rule # Third, set the new rule's next to the current rule new_rule.next = current_rule # Fourth, set the current rule's previous to the new_rule current_rule.prev = new_rule changes += 1 # Handle the case where it is the first rule in the list. elif previous_rule is None: # This is the case where the current rule is not only the first rule # but the first line as well. So we set the head to the new rule if current_rule.prev is None: self._head = new_rule # This case would occur if the previous line was a comment. else: current_rule.prev.next = new_rule new_rule.prev = current_rule.prev new_rule.next = current_rule current_rule.prev = new_rule changes += 1 return changes def insert_after(self, rule_type, rule_control, rule_path, new_type=None, new_control=None, new_path=None, new_args=None): # Get a list of rules we want to change rules_to_find = self.get(rule_type, rule_control, rule_path) changes = 0 # There are two cases to consider. # 1. The new rule doesn't exist after the existing rule # 2. The new rule exists for current_rule in rules_to_find: # First we'll get the next rule. next_rule = current_rule.next # Next we may have to loop forwards if the next line is a comment. If it # is, we'll get the next "rule's" next. while next_rule is not None and isinstance(next_rule, (PamdComment, PamdEmptyLine)): next_rule = next_rule.next # First we create a new rule new_rule = PamdRule(new_type, new_control, new_path, new_args) if next_rule is not None and not next_rule.matches(new_type, new_control, new_path): # If the previous rule doesn't match we'll insert our new rule. # Second set the original next rule's previous to the new_rule next_rule.prev = new_rule # Third, set the new_rule's next to the original next rule new_rule.next = next_rule # Fourth, set the new rule's previous to the current rule new_rule.prev = current_rule # Fifth, set the current rule's next to the new_rule current_rule.next = new_rule changes += 1 # This is the case where the current_rule is the last in the list elif next_rule is None: new_rule.prev = self._tail new_rule.next = None self._tail.next = new_rule self._tail = new_rule current_rule.next = new_rule changes += 1 return changes def add_module_arguments(self, rule_type, rule_control, rule_path, args_to_add): # Get a list of rules we want to change rules_to_find = self.get(rule_type, rule_control, rule_path) args_to_add = parse_module_arguments(args_to_add) changes = 0 for current_rule in rules_to_find: rule_changed = False # create some structures to evaluate the situation simple_new_args = set() key_value_new_args = dict() for arg in args_to_add: if arg.startswith("["): continue elif "=" in arg: key, value = arg.split("=") key_value_new_args[key] = value else: simple_new_args.add(arg) key_value_new_args_set = set(key_value_new_args) simple_current_args = set() key_value_current_args = dict() for arg in current_rule.rule_args: if arg.startswith("["): continue elif "=" in arg: key, value = arg.split("=") key_value_current_args[key] = value else: simple_current_args.add(arg) key_value_current_args_set = set(key_value_current_args) new_args_to_add = list() # Handle new simple arguments if simple_new_args.difference(simple_current_args): for arg in simple_new_args.difference(simple_current_args): new_args_to_add.append(arg) # Handle new key value arguments if key_value_new_args_set.difference(key_value_current_args_set): for key in key_value_new_args_set.difference(key_value_current_args_set): new_args_to_add.append(key + '=' + key_value_new_args[key]) if new_args_to_add: current_rule.rule_args += new_args_to_add rule_changed = True # Handle existing key value arguments when value is not equal if key_value_new_args_set.intersection(key_value_current_args_set): for key in key_value_new_args_set.intersection(key_value_current_args_set): if key_value_current_args[key] != key_value_new_args[key]: arg_index = current_rule.rule_args.index(key + '=' + key_value_current_args[key]) current_rule.rule_args[arg_index] = str(key + '=' + key_value_new_args[key]) rule_changed = True if rule_changed: changes += 1 return changes def remove_module_arguments(self, rule_type, rule_control, rule_path, args_to_remove): # Get a list of rules we want to change rules_to_find = self.get(rule_type, rule_control, rule_path) args_to_remove = parse_module_arguments(args_to_remove) changes = 0 for current_rule in rules_to_find: if not args_to_remove: args_to_remove = [] # Let's check to see if there are any args to remove by finding the intersection # of the rule's current args and the args_to_remove lists if not list(set(current_rule.rule_args) & set(args_to_remove)): continue # There are args to remove, so we create a list of new_args absent the args # to remove. current_rule.rule_args = [arg for arg in current_rule.rule_args if arg not in args_to_remove] changes += 1 return changes def validate(self): current_line = self._head while current_line is not None: curr_validate = current_line.validate() if not curr_validate[0]: return curr_validate current_line = current_line.next return True, "Module is valid" def __str__(self): lines = [] current_line = self._head mark = "# Updated by Ansible - %s" % datetime.now().isoformat() while current_line is not None: lines.append(str(current_line)) current_line = current_line.next if len(lines) <= 1: lines.insert(0, "") lines.insert(1, mark) else: if lines[1].startswith("# Updated by Ansible"): lines[1] = mark else: lines.insert(1, mark) return '\n'.join(lines) + '\n' def parse_module_arguments(module_arguments, return_none=False): # If args is None, return empty list by default. # But if return_none is True, then return None if module_arguments is None: return None if return_none else [] if isinstance(module_arguments, list) and len(module_arguments) == 1 and not module_arguments[0]: return [] if not isinstance(module_arguments, list): module_arguments = [module_arguments] # From this point on, module_arguments is guaranteed to be a list, empty or not parsed_args = [] re_clear_spaces = re.compile(r"\s*=\s*") for arg in module_arguments: for item in filter(None, RULE_ARG_REGEX.findall(arg)): if not item.startswith("["): re_clear_spaces.sub("=", item) parsed_args.append(item) return parsed_args def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True), type=dict(type='str', required=True, choices=VALID_TYPES), control=dict(type='str', required=True), module_path=dict(type='str', required=True), new_type=dict(type='str', choices=VALID_TYPES), new_control=dict(type='str'), new_module_path=dict(type='str'), module_arguments=dict(type='list', elements='str'), state=dict(type='str', default='updated', choices=['absent', 'after', 'args_absent', 'args_present', 'before', 'updated']), path=dict(type='path', default='/etc/pam.d'), backup=dict(type='bool', default=False), ), supports_check_mode=True, required_if=[ ("state", "args_present", ["module_arguments"]), ("state", "args_absent", ["module_arguments"]), ("state", "before", ["new_control", "new_type", "new_module_path"]), ("state", "after", ["new_control", "new_type", "new_module_path"]), ], ) content = str() fname = os.path.join(module.params["path"], module.params["name"]) # Open the file and read the content or fail try: with open(fname, 'r') as service_file_obj: content = service_file_obj.read() except IOError as e: # If unable to read the file, fail out module.fail_json(msg='Unable to open/read PAM module file %s with error %s.' % (fname, str(e))) # Assuming we didn't fail, create the service service = PamdService(content) # Set the action action = module.params['state'] changes = 0 # Take action if action == 'updated': changes = service.update_rule(module.params['type'], module.params['control'], module.params['module_path'], module.params['new_type'], module.params['new_control'], module.params['new_module_path'], module.params['module_arguments']) elif action == 'before': changes = service.insert_before(module.params['type'], module.params['control'], module.params['module_path'], module.params['new_type'], module.params['new_control'], module.params['new_module_path'], module.params['module_arguments']) elif action == 'after': changes = service.insert_after(module.params['type'], module.params['control'], module.params['module_path'], module.params['new_type'], module.params['new_control'], module.params['new_module_path'], module.params['module_arguments']) elif action == 'args_absent': changes = service.remove_module_arguments(module.params['type'], module.params['control'], module.params['module_path'], module.params['module_arguments']) elif action == 'args_present': if [arg for arg in parse_module_arguments(module.params['module_arguments']) if arg.startswith("[")]: module.fail_json(msg="Unable to process bracketed '[' complex arguments with 'args_present'. Please use 'updated'.") changes = service.add_module_arguments(module.params['type'], module.params['control'], module.params['module_path'], module.params['module_arguments']) elif action == 'absent': changes = service.remove(module.params['type'], module.params['control'], module.params['module_path']) valid, msg = service.validate() # If the module is not valid (meaning one of the rules is invalid), we will fail if not valid: module.fail_json(msg=msg) result = dict( changed=(changes > 0), change_count=changes, backupdest='', ) # If not check mode and something changed, backup the original if necessary then write out the file or fail if not module.check_mode and result['changed']: # First, create a backup if desired. if module.params['backup']: result['backupdest'] = module.backup_local(fname) try: temp_file = NamedTemporaryFile(mode='w', dir=module.tmpdir, delete=False) with open(temp_file.name, 'w') as fd: fd.write(str(service)) except IOError: module.fail_json(msg='Unable to create temporary file %s' % temp_file) module.atomic_move(temp_file.name, os.path.realpath(fname)) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�X��E �E ` collections/ansible_collections/community/general/plugins/modules/hwc_vpc_security_group_rule.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (C) 2019 Huawei # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type ############################################################################### # Documentation ############################################################################### DOCUMENTATION = ''' --- module: hwc_vpc_security_group_rule description: - vpc security group management. short_description: Creates a resource of Vpc/SecurityGroupRule in Huawei Cloud notes: - If O(id) option is provided, it takes precedence over O(security_group_id) for security group rule selection. - O(security_group_id) is used for security group rule selection. If more than one security group rule with this options exists, execution is aborted. - No parameter support updating. If one of option is changed, the module will create a new resource. version_added: '0.2.0' author: Huawei Inc. (@huaweicloud) requirements: - keystoneauth1 >= 3.6.0 attributes: check_mode: support: full diff_mode: support: none options: state: description: - Whether the given object should exist in Huawei Cloud. type: str choices: ['present', 'absent'] default: 'present' direction: description: - Specifies the direction of access control. The value can be egress or ingress. type: str required: true security_group_id: description: - Specifies the security group rule ID, which uniquely identifies the security group rule. type: str required: true description: description: - Provides supplementary information about the security group rule. The value is a string of no more than 255 characters that can contain letters and digits. type: str required: false ethertype: description: - Specifies the IP protocol version. The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by default. type: str required: false port_range_max: description: - Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be smaller than the port_range_min value. An empty value indicates all ports. type: int required: false port_range_min: description: - Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max value. An empty value indicates all ports. type: int required: false protocol: description: - Specifies the protocol type. The value can be icmp, tcp, or udp. If the parameter is left blank, the security group supports all protocols. type: str required: false remote_group_id: description: - Specifies the ID of the peer security group. The value is exclusive with parameter remote_ip_prefix. type: str required: false remote_ip_prefix: description: - Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address. The value can be in the CIDR format or IP addresses. The parameter is exclusive with parameter remote_group_id. type: str required: false extends_documentation_fragment: - community.general.hwc - community.general.attributes ''' EXAMPLES = ''' # create a security group rule - name: Create a security group hwc_vpc_security_group: name: "ansible_network_security_group_test" register: sg - name: Create a security group rule community.general.hwc_vpc_security_group_rule: direction: "ingress" protocol: "tcp" ethertype: "IPv4" port_range_max: 22 security_group_id: "{{ sg.id }}" port_range_min: 22 remote_ip_prefix: "0.0.0.0/0" ''' RETURN = ''' direction: description: - Specifies the direction of access control. The value can be egress or ingress. type: str returned: success security_group_id: description: - Specifies the security group rule ID, which uniquely identifies the security group rule. type: str returned: success description: description: - Provides supplementary information about the security group rule. The value is a string of no more than 255 characters that can contain letters and digits. type: str returned: success ethertype: description: - Specifies the IP protocol version. The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by default. type: str returned: success port_range_max: description: - Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be smaller than the port_range_min value. An empty value indicates all ports. type: int returned: success port_range_min: description: - Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max value. An empty value indicates all ports. type: int returned: success protocol: description: - Specifies the protocol type. The value can be icmp, tcp, or udp. If the parameter is left blank, the security group supports all protocols. type: str returned: success remote_group_id: description: - Specifies the ID of the peer security group. The value is exclusive with parameter remote_ip_prefix. type: str returned: success remote_ip_prefix: description: - Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address. The value can be in the CIDR format or IP addresses. The parameter is exclusive with parameter remote_group_id. type: str returned: success ''' from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( Config, HwcClientException, HwcModule, are_different_dicts, build_path, get_region, is_empty_value, navigate_value) def build_module(): return HwcModule( argument_spec=dict( state=dict(default='present', choices=['present', 'absent'], type='str'), direction=dict(type='str', required=True), security_group_id=dict(type='str', required=True), description=dict(type='str'), ethertype=dict(type='str'), port_range_max=dict(type='int'), port_range_min=dict(type='int'), protocol=dict(type='str'), remote_group_id=dict(type='str'), remote_ip_prefix=dict(type='str') ), supports_check_mode=True, ) def main(): """Main function""" module = build_module() config = Config(module, "vpc") try: resource = None if module.params['id']: resource = True else: v = search_resource(config) if len(v) > 1: raise Exception("Found more than one resource(%s)" % ", ".join([ navigate_value(i, ["id"]) for i in v])) if len(v) == 1: resource = v[0] module.params['id'] = navigate_value(resource, ["id"]) result = {} changed = False if module.params['state'] == 'present': if resource is None: if not module.check_mode: create(config) changed = True current = read_resource(config, exclude_output=True) expect = user_input_parameters(module) if are_different_dicts(expect, current): raise Exception( "Cannot change option from (%s) to (%s) for an" " existing security group(%s)." % (current, expect, module.params.get('id'))) result = read_resource(config) result['id'] = module.params.get('id') else: if resource: if not module.check_mode: delete(config) changed = True except Exception as ex: module.fail_json(msg=str(ex)) else: result['changed'] = changed module.exit_json(**result) def user_input_parameters(module): return { "description": module.params.get("description"), "direction": module.params.get("direction"), "ethertype": module.params.get("ethertype"), "port_range_max": module.params.get("port_range_max"), "port_range_min": module.params.get("port_range_min"), "protocol": module.params.get("protocol"), "remote_group_id": module.params.get("remote_group_id"), "remote_ip_prefix": module.params.get("remote_ip_prefix"), "security_group_id": module.params.get("security_group_id"), } def create(config): module = config.module client = config.client(get_region(module), "vpc", "project") opts = user_input_parameters(module) params = build_create_parameters(opts) r = send_create_request(module, params, client) module.params['id'] = navigate_value(r, ["security_group_rule", "id"]) def delete(config): module = config.module client = config.client(get_region(module), "vpc", "project") send_delete_request(module, None, client) def read_resource(config, exclude_output=False): module = config.module client = config.client(get_region(module), "vpc", "project") res = {} r = send_read_request(module, client) res["read"] = fill_read_resp_body(r) return update_properties(module, res, None, exclude_output) def _build_query_link(opts): query_link = "?marker={marker}&limit=10" v = navigate_value(opts, ["security_group_id"]) if v: query_link += "&security_group_id=" + str(v) return query_link def search_resource(config): module = config.module client = config.client(get_region(module), "vpc", "project") opts = user_input_parameters(module) identity_obj = _build_identity_object(opts) query_link = _build_query_link(opts) link = "security-group-rules" + query_link result = [] p = {'marker': ''} while True: url = link.format(**p) r = send_list_request(module, client, url) if not r: break for item in r: item = fill_list_resp_body(item) if not are_different_dicts(identity_obj, item): result.append(item) if len(result) > 1: break p['marker'] = r[-1].get('id') return result def build_create_parameters(opts): params = dict() v = navigate_value(opts, ["description"], None) if not is_empty_value(v): params["description"] = v v = navigate_value(opts, ["direction"], None) if not is_empty_value(v): params["direction"] = v v = navigate_value(opts, ["ethertype"], None) if not is_empty_value(v): params["ethertype"] = v v = navigate_value(opts, ["port_range_max"], None) if not is_empty_value(v): params["port_range_max"] = v v = navigate_value(opts, ["port_range_min"], None) if not is_empty_value(v): params["port_range_min"] = v v = navigate_value(opts, ["protocol"], None) if not is_empty_value(v): params["protocol"] = v v = navigate_value(opts, ["remote_group_id"], None) if not is_empty_value(v): params["remote_group_id"] = v v = navigate_value(opts, ["remote_ip_prefix"], None) if not is_empty_value(v): params["remote_ip_prefix"] = v v = navigate_value(opts, ["security_group_id"], None) if not is_empty_value(v): params["security_group_id"] = v if not params: return params params = {"security_group_rule": params} return params def send_create_request(module, params, client): url = "security-group-rules" try: r = client.post(url, params) except HwcClientException as ex: msg = ("module(hwc_vpc_security_group_rule): error running " "api(create), error: %s" % str(ex)) module.fail_json(msg=msg) return r def send_delete_request(module, params, client): url = build_path(module, "security-group-rules/{id}") try: r = client.delete(url, params) except HwcClientException as ex: msg = ("module(hwc_vpc_security_group_rule): error running " "api(delete), error: %s" % str(ex)) module.fail_json(msg=msg) return r def send_read_request(module, client): url = build_path(module, "security-group-rules/{id}") r = None try: r = client.get(url) except HwcClientException as ex: msg = ("module(hwc_vpc_security_group_rule): error running " "api(read), error: %s" % str(ex)) module.fail_json(msg=msg) return navigate_value(r, ["security_group_rule"], None) def fill_read_resp_body(body): result = dict() result["description"] = body.get("description") result["direction"] = body.get("direction") result["ethertype"] = body.get("ethertype") result["id"] = body.get("id") result["port_range_max"] = body.get("port_range_max") result["port_range_min"] = body.get("port_range_min") result["protocol"] = body.get("protocol") result["remote_address_group_id"] = body.get("remote_address_group_id") result["remote_group_id"] = body.get("remote_group_id") result["remote_ip_prefix"] = body.get("remote_ip_prefix") result["security_group_id"] = body.get("security_group_id") return result def update_properties(module, response, array_index, exclude_output=False): r = user_input_parameters(module) v = navigate_value(response, ["read", "description"], array_index) r["description"] = v v = navigate_value(response, ["read", "direction"], array_index) r["direction"] = v v = navigate_value(response, ["read", "ethertype"], array_index) r["ethertype"] = v v = navigate_value(response, ["read", "port_range_max"], array_index) r["port_range_max"] = v v = navigate_value(response, ["read", "port_range_min"], array_index) r["port_range_min"] = v v = navigate_value(response, ["read", "protocol"], array_index) r["protocol"] = v v = navigate_value(response, ["read", "remote_group_id"], array_index) r["remote_group_id"] = v v = navigate_value(response, ["read", "remote_ip_prefix"], array_index) r["remote_ip_prefix"] = v v = navigate_value(response, ["read", "security_group_id"], array_index) r["security_group_id"] = v return r def send_list_request(module, client, url): r = None try: r = client.get(url) except HwcClientException as ex: msg = ("module(hwc_vpc_security_group_rule): error running " "api(list), error: %s" % str(ex)) module.fail_json(msg=msg) return navigate_value(r, ["security_group_rules"], None) def _build_identity_object(all_opts): result = dict() v = navigate_value(all_opts, ["description"], None) result["description"] = v v = navigate_value(all_opts, ["direction"], None) result["direction"] = v v = navigate_value(all_opts, ["ethertype"], None) result["ethertype"] = v result["id"] = None v = navigate_value(all_opts, ["port_range_max"], None) result["port_range_max"] = v v = navigate_value(all_opts, ["port_range_min"], None) result["port_range_min"] = v v = navigate_value(all_opts, ["protocol"], None) result["protocol"] = v result["remote_address_group_id"] = None v = navigate_value(all_opts, ["remote_group_id"], None) result["remote_group_id"] = v v = navigate_value(all_opts, ["remote_ip_prefix"], None) result["remote_ip_prefix"] = v v = navigate_value(all_opts, ["security_group_id"], None) result["security_group_id"] = v return result def fill_list_resp_body(body): result = dict() result["description"] = body.get("description") result["direction"] = body.get("direction") result["ethertype"] = body.get("ethertype") result["id"] = body.get("id") result["port_range_max"] = body.get("port_range_max") result["port_range_min"] = body.get("port_range_min") result["protocol"] = body.get("protocol") result["remote_address_group_id"] = body.get("remote_address_group_id") result["remote_group_id"] = body.get("remote_group_id") result["remote_ip_prefix"] = body.get("remote_ip_prefix") result["security_group_id"] = body.get("security_group_id") return result if __name__ == '__main__': main() PK $�!\�# |C |C M collections/ansible_collections/community/general/plugins/modules/filesize.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, quidame <quidame@poivron.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: filesize short_description: Create a file with a given size, or resize it if it exists description: - This module is a simple wrapper around C(dd) to create, extend or truncate a file, given its size. It can be used to manage swap files (that require contiguous blocks) or alternatively, huge sparse files. author: - quidame (@quidame) version_added: "3.0.0" attributes: check_mode: support: full diff_mode: support: full options: path: description: - Path of the regular file to create or resize. type: path required: true size: description: - Requested size of the file. - The value is a number (either C(int) or C(float)) optionally followed by a multiplicative suffix, that can be one of V(B) (bytes), V(KB) or V(kB) (= 1000B), V(MB) or V(mB) (= 1000kB), V(GB) or V(gB) (= 1000MB), and so on for V(T), V(P), V(E), V(Z) and V(Y); or alternatively one of V(K), V(k) or V(KiB) (= 1024B); V(M), V(m) or V(MiB) (= 1024KiB); V(G), V(g) or V(GiB) (= 1024MiB); and so on. - If the multiplicative suffix is not provided, the value is treated as an integer number of blocks of O(blocksize) bytes each (float values are rounded to the closest integer). - When the O(size) value is equal to the current file size, does nothing. - When the O(size) value is bigger than the current file size, bytes from O(source) (if O(sparse) is not V(false)) are appended to the file without truncating it, in other words, without modifying the existing bytes of the file. - When the O(size) value is smaller than the current file size, it is truncated to the requested value without modifying bytes before this value. - That means that a file of any arbitrary size can be grown to any other arbitrary size, and then resized down to its initial size without modifying its initial content. type: raw required: true blocksize: description: - Size of blocks, in bytes if not followed by a multiplicative suffix. - The numeric value (before the unit) B(MUST) be an integer (or a C(float) if it equals an integer). - If not set, the size of blocks is guessed from the OS and commonly results in V(512) or V(4096) bytes, that is used internally by the module or when O(size) has no unit. type: raw source: description: - Device or file that provides input data to provision the file. - This parameter is ignored when O(sparse=true). type: path default: /dev/zero force: description: - Whether or not to overwrite the file if it exists, in other words, to truncate it from 0. When V(true), the module is not idempotent, that means it always reports C(changed=true). - O(force=true) and O(sparse=true) are mutually exclusive. type: bool default: false sparse: description: - Whether or not the file to create should be a sparse file. - This option is effective only on newly created files, or when growing a file, only for the bytes to append. - This option is not supported on OSes or filesystems not supporting sparse files. - O(force=true) and O(sparse=true) are mutually exclusive. type: bool default: false unsafe_writes: description: - This option is silently ignored. This module always modifies file size in-place. requirements: - dd (Data Duplicator) in PATH extends_documentation_fragment: - ansible.builtin.files - community.general.attributes seealso: - name: dd(1) manpage for Linux description: Manual page of the GNU/Linux's dd implementation (from GNU coreutils). link: https://man7.org/linux/man-pages/man1/dd.1.html - name: dd(1) manpage for IBM AIX description: Manual page of the IBM AIX's dd implementation. link: https://www.ibm.com/support/knowledgecenter/ssw_aix_72/d_commands/dd.html - name: dd(1) manpage for Mac OSX description: Manual page of the Mac OSX's dd implementation. link: https://www.unix.com/man-page/osx/1/dd/ - name: dd(1M) manpage for Solaris description: Manual page of the Oracle Solaris's dd implementation. link: https://docs.oracle.com/cd/E36784_01/html/E36871/dd-1m.html - name: dd(1) manpage for FreeBSD description: Manual page of the FreeBSD's dd implementation. link: https://www.freebsd.org/cgi/man.cgi?dd(1) - name: dd(1) manpage for OpenBSD description: Manual page of the OpenBSD's dd implementation. link: https://man.openbsd.org/dd - name: dd(1) manpage for NetBSD description: Manual page of the NetBSD's dd implementation. link: https://man.netbsd.org/dd.1 - name: busybox(1) manpage for Linux description: Manual page of the GNU/Linux's busybox, that provides its own dd implementation. link: https://www.unix.com/man-page/linux/1/busybox ''' EXAMPLES = r''' - name: Create a file of 1G filled with null bytes community.general.filesize: path: /var/bigfile size: 1G - name: Extend the file to 2G (2*1024^3) community.general.filesize: path: /var/bigfile size: 2G - name: Reduce the file to 2GB (2*1000^3) community.general.filesize: path: /var/bigfile size: 2GB - name: Fill a file with random bytes for backing a LUKS device community.general.filesize: path: ~/diskimage.luks size: 512.0 MiB source: /dev/urandom - name: Take a backup of MBR boot code into a file, overwriting it if it exists community.general.filesize: path: /media/sdb1/mbr.bin size: 440B source: /dev/sda force: true - name: Create/resize a sparse file of/to 8TB community.general.filesize: path: /var/local/sparsefile size: 8TB sparse: true - name: Create a file with specific size and attributes, to be used as swap space community.general.filesize: path: /var/swapfile size: 2G blocksize: 512B mode: u=rw,go= owner: root group: root ''' RETURN = r''' cmd: description: Command executed to create or resize the file. type: str returned: when changed or failed sample: /usr/bin/dd if=/dev/zero of=/var/swapfile bs=1048576 seek=3072 count=1024 filesize: description: Dictionary of sizes related to the file. type: dict returned: always contains: blocks: description: Number of blocks in the file. type: int sample: 500 blocksize: description: Size of the blocks in bytes. type: int sample: 1024 bytes: description: Size of the file, in bytes, as the product of RV(filesize.blocks) and RV(filesize.blocksize). type: int sample: 512000 iec: description: Size of the file, in human-readable format, following IEC standard. type: str sample: 500.0 KiB si: description: Size of the file, in human-readable format, following SI standard. type: str sample: 512.0 kB size_diff: description: Difference (positive or negative) between old size and new size, in bytes. type: int sample: -1234567890 returned: always path: description: Realpath of the file if it is a symlink, otherwise the same than module's param. type: str sample: /var/swap0 returned: always ''' import re import os import math from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native # These are the multiplicative suffixes understood (or returned) by dd and # others (ls, df, lvresize, lsblk...). SIZE_UNITS = dict( B=1, kB=1000**1, KB=1000**1, KiB=1024**1, K=1024**1, k=1024**1, MB=1000**2, mB=1000**2, MiB=1024**2, M=1024**2, m=1024**2, GB=1000**3, gB=1000**3, GiB=1024**3, G=1024**3, g=1024**3, TB=1000**4, tB=1000**4, TiB=1024**4, T=1024**4, t=1024**4, PB=1000**5, pB=1000**5, PiB=1024**5, P=1024**5, p=1024**5, EB=1000**6, eB=1000**6, EiB=1024**6, E=1024**6, e=1024**6, ZB=1000**7, zB=1000**7, ZiB=1024**7, Z=1024**7, z=1024**7, YB=1000**8, yB=1000**8, YiB=1024**8, Y=1024**8, y=1024**8, ) def bytes_to_human(size, iec=False): """Return human-readable size (with SI or IEC suffix) from bytes. This is only to populate the returned result of the module, not to handle the file itself (we only rely on bytes for that). """ unit = 'B' for (u, v) in SIZE_UNITS.items(): if size < v: continue if iec: if 'i' not in u or size / v >= 1024: continue else: if v % 5 or size / v >= 1000: continue unit = u hsize = round(size / SIZE_UNITS[unit], 2) if unit == 'B': hsize = int(hsize) unit = re.sub(r'^(.)', lambda m: m.expand(r'\1').upper(), unit) if unit == 'KB': unit = 'kB' return '%s %s' % (str(hsize), unit) def smart_blocksize(size, unit, product, bsize): """Ensure the total size can be written as blocks*blocksize, with blocks and blocksize being integers. """ if not product % bsize: return bsize # Basically, for a file of 8kB (=8000B), system's block size of 4096 bytes # is not usable. The smallest integer number of kB to work with 512B blocks # is 64, the nexts are 128, 192, 256, and so on. unit_size = SIZE_UNITS[unit] if size == int(size): if unit_size > SIZE_UNITS['MiB']: if unit_size % 5: return SIZE_UNITS['MiB'] return SIZE_UNITS['MB'] return unit_size if unit == 'B': raise AssertionError("byte is the smallest unit and requires an integer value") if 0 < product < bsize: return product for bsz in (1024, 1000, 512, 256, 128, 100, 64, 32, 16, 10, 8, 4, 2): if not product % bsz: return bsz return 1 def split_size_unit(string, isint=False): """Split a string between the size value (int or float) and the unit. Support optional space(s) between the numeric value and the unit. """ unit = re.sub(r'(\d|\.)', r'', string).strip() value = float(re.sub(r'%s' % unit, r'', string).strip()) if isint and unit in ('B', ''): if int(value) != value: raise AssertionError("invalid blocksize value: bytes require an integer value") if not unit: unit = None product = int(round(value)) else: if unit not in SIZE_UNITS.keys(): raise AssertionError("invalid size unit (%s): unit must be one of %s, or none." % (unit, ', '.join(sorted(SIZE_UNITS, key=SIZE_UNITS.get)))) product = int(round(value * SIZE_UNITS[unit])) return value, unit, product def size_string(value): """Convert a raw value to a string, but only if it is an integer, a float or a string itself. """ if not isinstance(value, (int, float, str)): raise AssertionError("invalid value type (%s): size must be integer, float or string" % type(value)) return str(value) def size_spec(args): """Return a dictionary with size specifications, especially the size in bytes (after rounding it to an integer number of blocks). """ blocksize_in_bytes = split_size_unit(args['blocksize'], True)[2] if blocksize_in_bytes == 0: raise AssertionError("block size cannot be equal to zero") size_value, size_unit, size_result = split_size_unit(args['size']) if not size_unit: blocks = int(math.ceil(size_value)) else: blocksize_in_bytes = smart_blocksize(size_value, size_unit, size_result, blocksize_in_bytes) blocks = int(math.ceil(size_result / blocksize_in_bytes)) args['size_diff'] = round_bytes = int(blocks * blocksize_in_bytes) args['size_spec'] = dict(blocks=blocks, blocksize=blocksize_in_bytes, bytes=round_bytes, iec=bytes_to_human(round_bytes, True), si=bytes_to_human(round_bytes)) return args['size_spec'] def current_size(args): """Return the size of the file at the given location if it exists, or None.""" path = args['path'] if os.path.exists(path): if not os.path.isfile(path): raise AssertionError("%s exists but is not a regular file" % path) args['file_size'] = os.stat(path).st_size else: args['file_size'] = None return args['file_size'] def complete_dd_cmdline(args, dd_cmd): """Compute dd options to grow or truncate a file.""" if args['file_size'] == args['size_spec']['bytes'] and not args['force']: # Nothing to do. return list() bs = args['size_spec']['blocksize'] # For sparse files (create, truncate, grow): write count=0 block. if args['sparse']: seek = args['size_spec']['blocks'] elif args['force'] or not os.path.exists(args['path']): # Create file seek = 0 elif args['size_diff'] < 0: # Truncate file seek = args['size_spec']['blocks'] elif args['size_diff'] % bs: # Grow file seek = int(args['file_size'] / bs) + 1 else: seek = int(args['file_size'] / bs) count = args['size_spec']['blocks'] - seek dd_cmd += ['bs=%s' % str(bs), 'seek=%s' % str(seek), 'count=%s' % str(count)] return dd_cmd def main(): module = AnsibleModule( argument_spec=dict( path=dict(type='path', required=True), size=dict(type='raw', required=True), blocksize=dict(type='raw'), source=dict(type='path', default='/dev/zero'), sparse=dict(type='bool', default=False), force=dict(type='bool', default=False), ), supports_check_mode=True, add_file_common_args=True, ) args = dict(**module.params) diff = dict(before=dict(), after=dict()) if args['sparse'] and args['force']: module.fail_json(msg='parameters values are mutually exclusive: force=true|sparse=true') if not os.path.exists(os.path.dirname(args['path'])): module.fail_json(msg='parent directory of the file must exist prior to run this module') if not args['blocksize']: args['blocksize'] = str(os.statvfs(os.path.dirname(args['path'])).f_frsize) try: args['size'] = size_string(args['size']) args['blocksize'] = size_string(args['blocksize']) initial_filesize = current_size(args) size_descriptors = size_spec(args) except AssertionError as err: module.fail_json(msg=to_native(err)) expected_filesize = size_descriptors['bytes'] if initial_filesize: args['size_diff'] = expected_filesize - initial_filesize diff['after']['size'] = expected_filesize diff['before']['size'] = initial_filesize result = dict( changed=args['force'], size_diff=args['size_diff'], path=args['path'], filesize=size_descriptors) dd_bin = module.get_bin_path('dd', True) dd_cmd = [dd_bin, 'if=%s' % args['source'], 'of=%s' % args['path']] if expected_filesize != initial_filesize or args['force']: result['cmd'] = ' '.join(complete_dd_cmdline(args, dd_cmd)) if module.check_mode: result['changed'] = True else: result['rc'], dummy, result['stderr'] = module.run_command(dd_cmd) diff['after']['size'] = result_filesize = result['size_diff'] = current_size(args) if initial_filesize: result['size_diff'] = result_filesize - initial_filesize if not args['force']: result['changed'] = result_filesize != initial_filesize if result['rc']: msg = "dd error while creating file %s with size %s from source %s: see stderr for details" % ( args['path'], args['size'], args['source']) module.fail_json(msg=msg, **result) if result_filesize != expected_filesize: msg = "module error while creating file %s with size %s from source %s: file is %s bytes long" % ( args['path'], args['size'], args['source'], result_filesize) module.fail_json(msg=msg, **result) # dd follows symlinks, and so does this module, while file module doesn't. # If we call it, this is to manage file's mode, owner and so on, not the # symlink's ones. file_params = dict(**module.params) if os.path.islink(args['path']): file_params['path'] = result['path'] = os.path.realpath(args['path']) if args['file_size'] is not None: file_args = module.load_file_common_arguments(file_params) result['changed'] = module.set_fs_attributes_if_different(file_args, result['changed'], diff=diff) result['diff'] = diff module.exit_json(**result) if __name__ == '__main__': main() PK $�!\$2�#� � M collections/ansible_collections/community/general/plugins/modules/mssql_db.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Vedit Firat Arig <firatarig@gmail.com> # Outline and parts are reused from Mark Theunissen's mysql_db module # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: mssql_db short_description: Add or remove MSSQL databases from a remote host description: - Add or remove MSSQL databases from a remote host. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - name of the database to add or remove required: true aliases: [ db ] type: str login_user: description: - The username used to authenticate with type: str default: '' login_password: description: - The password used to authenticate with type: str default: '' login_host: description: - Host running the database type: str required: true login_port: description: - Port of the MSSQL server. Requires login_host be defined as other than localhost if login_port is used default: '1433' type: str state: description: - The database state default: present choices: [ "present", "absent", "import" ] type: str target: description: - Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files (C(.sql)) files are supported. type: str autocommit: description: - Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can't be changed within a transaction. type: bool default: false notes: - Requires the pymssql Python package on the remote host. For Ubuntu, this is as easy as pip install pymssql (See M(ansible.builtin.pip).) requirements: - python >= 2.7 - pymssql author: Vedit Firat Arig (@vedit) ''' EXAMPLES = ''' - name: Create a new database with name 'jackdata' community.general.mssql_db: name: jackdata state: present # Copy database dump file to remote host and restore it to database 'my_db' - name: Copy database dump file to remote host ansible.builtin.copy: src: dump.sql dest: /tmp - name: Restore the dump file to database 'my_db' community.general.mssql_db: name: my_db state: import target: /tmp/dump.sql ''' RETURN = ''' # ''' import os import traceback PYMSSQL_IMP_ERR = None try: import pymssql except ImportError: PYMSSQL_IMP_ERR = traceback.format_exc() mssql_found = False else: mssql_found = True from ansible.module_utils.basic import AnsibleModule, missing_required_lib def db_exists(conn, cursor, db): cursor.execute("SELECT name FROM master.sys.databases WHERE name = %s", db) conn.commit() return bool(cursor.rowcount) def db_create(conn, cursor, db): cursor.execute("CREATE DATABASE [%s]" % db) return db_exists(conn, cursor, db) def db_delete(conn, cursor, db): try: cursor.execute("ALTER DATABASE [%s] SET single_user WITH ROLLBACK IMMEDIATE" % db) except Exception: pass cursor.execute("DROP DATABASE [%s]" % db) return not db_exists(conn, cursor, db) def db_import(conn, cursor, module, db, target): if os.path.isfile(target): with open(target, 'r') as backup: sqlQuery = "USE [%s]\n" % db for line in backup: if line is None: break elif line.startswith('GO'): cursor.execute(sqlQuery) sqlQuery = "USE [%s]\n" % db else: sqlQuery += line cursor.execute(sqlQuery) conn.commit() return 0, "import successful", "" else: return 1, "cannot find target file", "cannot find target file" def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True, aliases=['db']), login_user=dict(default=''), login_password=dict(default='', no_log=True), login_host=dict(required=True), login_port=dict(default='1433'), target=dict(default=None), autocommit=dict(type='bool', default=False), state=dict( default='present', choices=['present', 'absent', 'import']) ) ) if not mssql_found: module.fail_json(msg=missing_required_lib('pymssql'), exception=PYMSSQL_IMP_ERR) db = module.params['name'] state = module.params['state'] autocommit = module.params['autocommit'] target = module.params["target"] login_user = module.params['login_user'] login_password = module.params['login_password'] login_host = module.params['login_host'] login_port = module.params['login_port'] login_querystring = login_host if login_port != "1433": login_querystring = "%s:%s" % (login_host, login_port) if login_user != "" and login_password == "": module.fail_json(msg="when supplying login_user arguments login_password must be provided") try: conn = pymssql.connect(user=login_user, password=login_password, host=login_querystring, database='master') cursor = conn.cursor() except Exception as e: if "Unknown database" in str(e): errno, errstr = e.args module.fail_json(msg="ERROR: %s %s" % (errno, errstr)) else: module.fail_json(msg="unable to connect, check login_user and login_password are correct, or alternatively check your " "@sysconfdir@/freetds.conf / ${HOME}/.freetds.conf") conn.autocommit(True) changed = False if db_exists(conn, cursor, db): if state == "absent": try: changed = db_delete(conn, cursor, db) except Exception as e: module.fail_json(msg="error deleting database: " + str(e)) elif state == "import": conn.autocommit(autocommit) rc, stdout, stderr = db_import(conn, cursor, module, db, target) if rc != 0: module.fail_json(msg="%s" % stderr) else: module.exit_json(changed=True, db=db, msg=stdout) else: if state == "present": try: changed = db_create(conn, cursor, db) except Exception as e: module.fail_json(msg="error creating database: " + str(e)) elif state == "import": try: changed = db_create(conn, cursor, db) except Exception as e: module.fail_json(msg="error creating database: " + str(e)) conn.autocommit(autocommit) rc, stdout, stderr = db_import(conn, cursor, module, db, target) if rc != 0: module.fail_json(msg="%s" % stderr) else: module.exit_json(changed=True, db=db, msg=stdout) module.exit_json(changed=changed, db=db) if __name__ == '__main__': main() PK $�!\V�y" y" ` collections/ansible_collections/community/general/plugins/modules/bitbucket_pipeline_variable.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: bitbucket_pipeline_variable short_description: Manages Bitbucket pipeline variables description: - Manages Bitbucket pipeline variables. author: - Evgeniy Krysanov (@catcombo) extends_documentation_fragment: - community.general.bitbucket - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: repository: description: - The repository name. type: str required: true workspace: description: - The repository owner. - "B(Note:) O(ignore:username) used to be an alias of this option. Since community.general 6.0.0 it is an alias of O(user)." type: str required: true name: description: - The pipeline variable name. type: str required: true value: description: - The pipeline variable value. type: str secured: description: - Whether to encrypt the variable value. type: bool default: false state: description: - Indicates desired state of the variable. type: str required: true choices: [ absent, present ] notes: - Check mode is supported. - For secured values return parameter C(changed) is always V(true). ''' EXAMPLES = r''' - name: Create or update pipeline variables from the list community.general.bitbucket_pipeline_variable: repository: 'bitbucket-repo' workspace: bitbucket_workspace name: '{{ item.name }}' value: '{{ item.value }}' secured: '{{ item.secured }}' state: present with_items: - { name: AWS_ACCESS_KEY, value: ABCD1234, secured: false } - { name: AWS_SECRET, value: qwe789poi123vbn0, secured: true } - name: Remove pipeline variable community.general.bitbucket_pipeline_variable: repository: bitbucket-repo workspace: bitbucket_workspace name: AWS_ACCESS_KEY state: absent ''' RETURN = r''' # ''' from ansible.module_utils.basic import AnsibleModule, _load_params from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper error_messages = { 'required_value': '`value` is required when the `state` is `present`', } BITBUCKET_API_ENDPOINTS = { 'pipeline-variable-list': '%s/2.0/repositories/{workspace}/{repo_slug}/pipelines_config/variables/' % BitbucketHelper.BITBUCKET_API_URL, 'pipeline-variable-detail': '%s/2.0/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}' % BitbucketHelper.BITBUCKET_API_URL, } def get_existing_pipeline_variable(module, bitbucket): """ Search for a pipeline variable :param module: instance of the :class:`AnsibleModule` :param bitbucket: instance of the :class:`BitbucketHelper` :return: existing variable or None if not found :rtype: dict or None Return example:: { 'name': 'AWS_ACCESS_OBKEY_ID', 'value': 'x7HU80-a2', 'type': 'pipeline_variable', 'secured': False, 'uuid': '{9ddb0507-439a-495a-99f3-5464f15128127}' } The `value` key in dict is absent in case of secured variable. """ variables_base_url = BITBUCKET_API_ENDPOINTS['pipeline-variable-list'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], ) # Look through the all response pages in search of variable we need page = 1 while True: next_url = "%s?page=%s" % (variables_base_url, page) info, content = bitbucket.request( api_url=next_url, method='GET', ) if info['status'] == 404: module.fail_json(msg='Invalid `repository` or `workspace`.') if info['status'] != 200: module.fail_json(msg='Failed to retrieve the list of pipeline variables: {0}'.format(info)) # We are at the end of list if 'pagelen' in content and content['pagelen'] == 0: return None page += 1 var = next(filter(lambda v: v['key'] == module.params['name'], content['values']), None) if var is not None: var['name'] = var.pop('key') return var def create_pipeline_variable(module, bitbucket): info, content = bitbucket.request( api_url=BITBUCKET_API_ENDPOINTS['pipeline-variable-list'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], ), method='POST', data={ 'key': module.params['name'], 'value': module.params['value'], 'secured': module.params['secured'], }, ) if info['status'] != 201: module.fail_json(msg='Failed to create pipeline variable `{name}`: {info}'.format( name=module.params['name'], info=info, )) def update_pipeline_variable(module, bitbucket, variable_uuid): info, content = bitbucket.request( api_url=BITBUCKET_API_ENDPOINTS['pipeline-variable-detail'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], variable_uuid=variable_uuid, ), method='PUT', data={ 'value': module.params['value'], 'secured': module.params['secured'], }, ) if info['status'] != 200: module.fail_json(msg='Failed to update pipeline variable `{name}`: {info}'.format( name=module.params['name'], info=info, )) def delete_pipeline_variable(module, bitbucket, variable_uuid): info, content = bitbucket.request( api_url=BITBUCKET_API_ENDPOINTS['pipeline-variable-detail'].format( workspace=module.params['workspace'], repo_slug=module.params['repository'], variable_uuid=variable_uuid, ), method='DELETE', ) if info['status'] != 204: module.fail_json(msg='Failed to delete pipeline variable `{name}`: {info}'.format( name=module.params['name'], info=info, )) class BitBucketPipelineVariable(AnsibleModule): def __init__(self, *args, **kwargs): params = _load_params() or {} if params.get('secured'): kwargs['argument_spec']['value'].update({'no_log': True}) super(BitBucketPipelineVariable, self).__init__(*args, **kwargs) def main(): argument_spec = BitbucketHelper.bitbucket_argument_spec() argument_spec.update( repository=dict(type='str', required=True), workspace=dict(type='str', required=True), name=dict(type='str', required=True), value=dict(type='str'), secured=dict(type='bool', default=False), state=dict(type='str', choices=['present', 'absent'], required=True), ) module = BitBucketPipelineVariable( argument_spec=argument_spec, supports_check_mode=True, required_one_of=BitbucketHelper.bitbucket_required_one_of(), required_together=BitbucketHelper.bitbucket_required_together(), ) bitbucket = BitbucketHelper(module) value = module.params['value'] state = module.params['state'] secured = module.params['secured'] # Check parameters if (value is None) and (state == 'present'): module.fail_json(msg=error_messages['required_value']) # Retrieve access token for authorized API requests bitbucket.fetch_access_token() # Retrieve existing pipeline variable (if any) existing_variable = get_existing_pipeline_variable(module, bitbucket) changed = False # Create new variable in case it doesn't exists if not existing_variable and (state == 'present'): if not module.check_mode: create_pipeline_variable(module, bitbucket) changed = True # Update variable if it is secured or the old value does not match the new one elif existing_variable and (state == 'present'): if (existing_variable['secured'] != secured) or (existing_variable.get('value') != value): if not module.check_mode: update_pipeline_variable(module, bitbucket, existing_variable['uuid']) changed = True # Delete variable elif existing_variable and (state == 'absent'): if not module.check_mode: delete_pipeline_variable(module, bitbucket, existing_variable['uuid']) changed = True module.exit_json(changed=changed) if __name__ == '__main__': main() PK $�!\���� � ^ collections/ansible_collections/community/general/plugins/modules/oneview_fcoe_network_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_fcoe_network_info short_description: Retrieve the information about one or more of the OneView FCoE Networks description: - Retrieve the information about one or more of the FCoE Networks from OneView. - This module was called C(oneview_fcoe_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.oneview_fcoe_network_info) module no longer returns C(ansible_facts)! requirements: - hpOneView >= 2.0.1 author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name: description: - FCoE Network name. type: str extends_documentation_fragment: - community.general.oneview - community.general.oneview.factsparams - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: Gather information about all FCoE Networks community.general.oneview_fcoe_network_info: config: /etc/oneview/oneview_config.json delegate_to: localhost register: result - name: Print fetched information about FCoE Networks ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" - name: Gather paginated, filtered and sorted information about FCoE Networks community.general.oneview_fcoe_network_info: config: /etc/oneview/oneview_config.json params: start: 0 count: 3 sort: 'name:descending' filter: 'vlanId=2' delegate_to: localhost register: result - name: Print fetched information about paginated, filtered and sorted list of FCoE Networks ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" - name: Gather information about a FCoE Network by name community.general.oneview_fcoe_network_info: config: /etc/oneview/oneview_config.json name: Test FCoE Network Information delegate_to: localhost register: result - name: Print fetched information about FCoE Network found by name ansible.builtin.debug: msg: "{{ result.fcoe_networks }}" ''' RETURN = ''' fcoe_networks: description: Has all the OneView information about the FCoE Networks. returned: Always, but can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class FcoeNetworkInfoModule(OneViewModuleBase): def __init__(self): argument_spec = dict( name=dict(type='str'), params=dict(type='dict'), ) super(FcoeNetworkInfoModule, self).__init__( additional_arg_spec=argument_spec, supports_check_mode=True, ) def execute_module(self): if self.module.params['name']: fcoe_networks = self.oneview_client.fcoe_networks.get_by('name', self.module.params['name']) else: fcoe_networks = self.oneview_client.fcoe_networks.get_all(**self.facts_params) return dict(changed=False, fcoe_networks=fcoe_networks) def main(): FcoeNetworkInfoModule().run() if __name__ == '__main__': main() PK $�!\��b� � L collections/ansible_collections/community/general/plugins/modules/discord.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Christian Wollinger <cwollinger@web.de> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: discord short_description: Send Discord messages version_added: 3.1.0 description: - Sends a message to a Discord channel using the Discord webhook API. author: Christian Wollinger (@cwollinger) seealso: - name: API documentation description: Documentation for Discord API link: https://discord.com/developers/docs/resources/webhook#execute-webhook extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: webhook_id: description: - The webhook ID. - "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})." required: true type: str webhook_token: description: - The webhook token. - "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})." required: true type: str content: description: - Content of the message to the Discord channel. - At least one of O(content) and O(embeds) must be specified. type: str username: description: - Overrides the default username of the webhook. type: str avatar_url: description: - Overrides the default avatar of the webhook. type: str tts: description: - Set this to V(true) if this is a TTS (Text to Speech) message. type: bool default: false embeds: description: - Send messages as Embeds to the Discord channel. - Embeds can have a colored border, embedded images, text fields and more. - "Allowed parameters are described in the Discord Docs: U(https://discord.com/developers/docs/resources/channel#embed-object)" - At least one of O(content) and O(embeds) must be specified. type: list elements: dict ''' EXAMPLES = """ - name: Send a message to the Discord channel community.general.discord: webhook_id: "00000" webhook_token: "XXXYYY" content: "This is a message from ansible" - name: Send a message to the Discord channel with specific username and avatar community.general.discord: webhook_id: "00000" webhook_token: "XXXYYY" content: "This is a message from ansible" username: Ansible avatar_url: "https://docs.ansible.com/ansible/latest/_static/images/logo_invert.png" - name: Send a embedded message to the Discord channel community.general.discord: webhook_id: "00000" webhook_token: "XXXYYY" embeds: - title: "Embedded message" description: "This is an embedded message" footer: text: "Author: Ansible" image: url: "https://docs.ansible.com/ansible/latest/_static/images/logo_invert.png" - name: Send two embedded messages community.general.discord: webhook_id: "00000" webhook_token: "XXXYYY" embeds: - title: "First message" description: "This is my first embedded message" footer: text: "Author: Ansible" image: url: "https://docs.ansible.com/ansible/latest/_static/images/logo_invert.png" - title: "Second message" description: "This is my first second message" footer: text: "Author: Ansible" icon_url: "https://docs.ansible.com/ansible/latest/_static/images/logo_invert.png" fields: - name: "Field 1" value: "Value of my first field" - name: "Field 2" value: "Value of my second field" timestamp: "{{ ansible_date_time.iso8601 }}" """ RETURN = """ http_code: description: - Response Code returned by Discord API. returned: always type: int sample: 204 """ from ansible.module_utils.urls import fetch_url from ansible.module_utils.basic import AnsibleModule def discord_check_mode(module): webhook_id = module.params['webhook_id'] webhook_token = module.params['webhook_token'] headers = { 'content-type': 'application/json' } url = "https://discord.com/api/webhooks/%s/%s" % ( webhook_id, webhook_token) response, info = fetch_url(module, url, method='GET', headers=headers) return response, info def discord_text_msg(module): webhook_id = module.params['webhook_id'] webhook_token = module.params['webhook_token'] content = module.params['content'] user = module.params['username'] avatar_url = module.params['avatar_url'] tts = module.params['tts'] embeds = module.params['embeds'] headers = { 'content-type': 'application/json' } url = "https://discord.com/api/webhooks/%s/%s" % ( webhook_id, webhook_token) payload = { 'content': content, 'username': user, 'avatar_url': avatar_url, 'tts': tts, 'embeds': embeds, } payload = module.jsonify(payload) response, info = fetch_url(module, url, data=payload, headers=headers, method='POST') return response, info def main(): module = AnsibleModule( argument_spec=dict( webhook_id=dict(type='str', required=True), webhook_token=dict(type='str', required=True, no_log=True), content=dict(type='str'), username=dict(type='str'), avatar_url=dict(type='str'), tts=dict(type='bool', default=False), embeds=dict(type='list', elements='dict'), ), required_one_of=[['content', 'embeds']], supports_check_mode=True ) result = dict( changed=False, http_code='', ) if module.check_mode: response, info = discord_check_mode(module) if info['status'] != 200: try: module.fail_json(http_code=info['status'], msg=info['msg'], response=module.from_json(info['body']), info=info) except Exception: module.fail_json(http_code=info['status'], msg=info['msg'], info=info) else: module.exit_json(msg=info['msg'], changed=False, http_code=info['status'], response=module.from_json(response.read())) else: response, info = discord_text_msg(module) if info['status'] != 204: try: module.fail_json(http_code=info['status'], msg=info['msg'], response=module.from_json(info['body']), info=info) except Exception: module.fail_json(http_code=info['status'], msg=info['msg'], info=info) else: module.exit_json(msg=info['msg'], changed=True, http_code=info['status']) if __name__ == "__main__": main() PK $�!\�}pe T collections/ansible_collections/community/general/plugins/modules/webfaction_site.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Quentin Stafford-Fraser # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # Create Webfaction website using Ansible and the Webfaction API from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- deprecated: removed_in: 9.0.0 why: the endpoints this module relies on do not exist any more and do not resolve to IPs in DNS. alternative: no known alternative at this point module: webfaction_site short_description: Add or remove a website on a Webfaction host description: - Add or remove a website on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction. author: Quentin Stafford-Fraser (@quentinsf) notes: - Sadly, you I(do) need to know your webfaction hostname for the C(host) parameter. But at least, unlike the API, you do not need to know the IP address. You can use a DNS name. - If a site of the same name exists in the account but on a different host, the operation will exit. - > You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API. The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as your host, you may want to add C(serial=1) to the plays. - See L(the webfaction API, https://docs.webfaction.com/xmlrpc-api/) for more info. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name of the website required: true type: str state: description: - Whether the website should exist choices: ['present', 'absent'] default: "present" type: str host: description: - The webfaction host on which the site should be created. required: true type: str https: description: - Whether or not to use HTTPS type: bool default: false site_apps: description: - A mapping of URLs to apps default: [] type: list elements: list subdomains: description: - A list of subdomains associated with this site. default: [] type: list elements: str login_name: description: - The webfaction account to use required: true type: str login_password: description: - The webfaction password to use required: true type: str ''' EXAMPLES = ''' - name: Create website community.general.webfaction_site: name: testsite1 state: present host: myhost.webfaction.com subdomains: - 'testsite1.my_domain.org' site_apps: - ['testapp1', '/'] https: false login_name: "{{webfaction_user}}" login_password: "{{webfaction_passwd}}" ''' import socket from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves import xmlrpc_client webfaction = xmlrpc_client.ServerProxy('https://api.webfaction.com/') def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), state=dict(choices=['present', 'absent'], default='present'), # You can specify an IP address or hostname. host=dict(required=True), https=dict(required=False, type='bool', default=False), subdomains=dict(type='list', elements='str', default=[]), site_apps=dict(type='list', elements='list', default=[]), login_name=dict(required=True), login_password=dict(required=True, no_log=True), ), supports_check_mode=True ) site_name = module.params['name'] site_state = module.params['state'] site_host = module.params['host'] site_ip = socket.gethostbyname(site_host) session_id, account = webfaction.login( module.params['login_name'], module.params['login_password'] ) site_list = webfaction.list_websites(session_id) site_map = dict([(i['name'], i) for i in site_list]) existing_site = site_map.get(site_name) result = {} # Here's where the real stuff happens if site_state == 'present': # Does a site with this name already exist? if existing_site: # If yes, but it's on a different IP address, then fail. # If we wanted to allow relocation, we could add a 'relocate=true' option # which would get the existing IP address, delete the site there, and create it # at the new address. A bit dangerous, perhaps, so for now we'll require manual # deletion if it's on another host. if existing_site['ip'] != site_ip: module.fail_json(msg="Website already exists with a different IP address. Please fix by hand.") # If it's on this host and the key parameters are the same, nothing needs to be done. if (existing_site['https'] == module.boolean(module.params['https'])) and \ (set(existing_site['subdomains']) == set(module.params['subdomains'])) and \ (dict(existing_site['website_apps']) == dict(module.params['site_apps'])): module.exit_json( changed=False ) positional_args = [ session_id, site_name, site_ip, module.boolean(module.params['https']), module.params['subdomains'], ] for a in module.params['site_apps']: positional_args.append((a[0], a[1])) if not module.check_mode: # If this isn't a dry run, create or modify the site result.update( webfaction.create_website( *positional_args ) if not existing_site else webfaction.update_website( *positional_args ) ) elif site_state == 'absent': # If the site's already not there, nothing changed. if not existing_site: module.exit_json( changed=False, ) if not module.check_mode: # If this isn't a dry run, delete the site result.update( webfaction.delete_website(session_id, site_name, site_ip) ) else: module.fail_json(msg="Unknown state specified: {0}".format(site_state)) module.exit_json( changed=True, result=result ) if __name__ == '__main__': main() PK $�!\��� $ $ Z collections/ansible_collections/community/general/plugins/modules/dimensiondata_network.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2016 Dimension Data # Authors: # - Aimon Bustardo <aimon.bustardo@dimensiondata.com> # - Bert Diwa <Lamberto.Diwa@dimensiondata.com> # - Adam Friedman <tintoy@tintoy.io> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: dimensiondata_network short_description: Create, update, and delete MCP 1.0 & 2.0 networks extends_documentation_fragment: - community.general.dimensiondata - community.general.dimensiondata_wait - community.general.attributes description: - Create, update, and delete MCP 1.0 & 2.0 networks author: 'Aimon Bustardo (@aimonb)' attributes: check_mode: support: none diff_mode: support: none options: name: description: - The name of the network domain to create. required: true type: str description: description: - Additional description of the network domain. required: false type: str service_plan: description: - The service plan, either "ESSENTIALS" or "ADVANCED". - MCP 2.0 Only. choices: [ESSENTIALS, ADVANCED] default: ESSENTIALS type: str state: description: - Should the resource be present or absent. choices: [present, absent] default: present type: str ''' EXAMPLES = ''' - name: Create an MCP 1.0 network community.general.dimensiondata_network: region: na location: NA5 name: mynet - name: Create an MCP 2.0 network community.general.dimensiondata_network: region: na mcp_user: my_user mcp_password: my_password location: NA9 name: mynet service_plan: ADVANCED - name: Delete a network community.general.dimensiondata_network: region: na location: NA1 name: mynet state: absent ''' RETURN = ''' network: description: Dictionary describing the network. returned: On success when O(state=present). type: complex contains: id: description: Network ID. type: str sample: "8c787000-a000-4050-a215-280893411a7d" name: description: Network name. type: str sample: "My network" description: description: Network description. type: str sample: "My network description" location: description: Datacenter location. type: str sample: NA3 status: description: Network status. (MCP 2.0 only) type: str sample: NORMAL private_net: description: Private network subnet. (MCP 1.0 only) type: str sample: "10.2.3.0" multicast: description: Multicast enabled? (MCP 1.0 only) type: bool sample: false ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.dimensiondata import HAS_LIBCLOUD, DimensionDataModule from ansible.module_utils.common.text.converters import to_native if HAS_LIBCLOUD: from libcloud.compute.base import NodeLocation from libcloud.common.dimensiondata import DimensionDataAPIException class DimensionDataNetworkModule(DimensionDataModule): """ The dimensiondata_network module for Ansible. """ def __init__(self): """ Create a new Dimension Data network module. """ super(DimensionDataNetworkModule, self).__init__( module=AnsibleModule( argument_spec=DimensionDataModule.argument_spec_with_wait( name=dict(type='str', required=True), description=dict(type='str', required=False), service_plan=dict(default='ESSENTIALS', choices=['ADVANCED', 'ESSENTIALS']), state=dict(default='present', choices=['present', 'absent']) ), required_together=DimensionDataModule.required_together() ) ) self.name = self.module.params['name'] self.description = self.module.params['description'] self.service_plan = self.module.params['service_plan'] self.state = self.module.params['state'] def state_present(self): network = self._get_network() if network: self.module.exit_json( changed=False, msg='Network already exists', network=self._network_to_dict(network) ) network = self._create_network() self.module.exit_json( changed=True, msg='Created network "%s" in datacenter "%s".' % (self.name, self.location), network=self._network_to_dict(network) ) def state_absent(self): network = self._get_network() if not network: self.module.exit_json( changed=False, msg='Network "%s" does not exist' % self.name, network=self._network_to_dict(network) ) self._delete_network(network) def _get_network(self): if self.mcp_version == '1.0': networks = self.driver.list_networks(location=self.location) else: networks = self.driver.ex_list_network_domains(location=self.location) matched_network = [network for network in networks if network.name == self.name] if matched_network: return matched_network[0] return None def _network_to_dict(self, network): network_dict = dict( id=network.id, name=network.name, description=network.description ) if isinstance(network.location, NodeLocation): network_dict['location'] = network.location.id else: network_dict['location'] = network.location if self.mcp_version == '1.0': network_dict['private_net'] = network.private_net network_dict['multicast'] = network.multicast network_dict['status'] = None else: network_dict['private_net'] = None network_dict['multicast'] = None network_dict['status'] = network.status return network_dict def _create_network(self): # Make sure service_plan argument is defined if self.mcp_version == '2.0' and 'service_plan' not in self.module.params: self.module.fail_json( msg='service_plan required when creating network and location is MCP 2.0' ) # Create network try: if self.mcp_version == '1.0': network = self.driver.ex_create_network( self.location, self.name, description=self.description ) else: network = self.driver.ex_create_network_domain( self.location, self.name, self.module.params['service_plan'], description=self.description ) except DimensionDataAPIException as e: self.module.fail_json( msg="Failed to create new network: %s" % to_native(e), exception=traceback.format_exc() ) if self.module.params['wait'] is True: network = self._wait_for_network_state(network.id, 'NORMAL') return network def _delete_network(self, network): try: if self.mcp_version == '1.0': deleted = self.driver.ex_delete_network(network) else: deleted = self.driver.ex_delete_network_domain(network) if deleted: self.module.exit_json( changed=True, msg="Deleted network with id %s" % network.id ) self.module.fail_json( "Unexpected failure deleting network with id %s" % network.id ) except DimensionDataAPIException as e: self.module.fail_json( msg="Failed to delete network: %s" % to_native(e), exception=traceback.format_exc() ) def _wait_for_network_state(self, net_id, state_to_wait_for): try: return self.driver.connection.wait_for_state( state_to_wait_for, self.driver.ex_get_network_domain, self.module.params['wait_poll_interval'], self.module.params['wait_time'], net_id ) except DimensionDataAPIException as e: self.module.fail_json( msg='Network did not reach % state in time: %s' % (state_to_wait_for, to_native(e)), exception=traceback.format_exc() ) def main(): module = DimensionDataNetworkModule() if module.state == 'present': module.state_present() elif module.state == 'absent': module.state_absent() if __name__ == '__main__': main() PK $�!\B{�o. o. J collections/ansible_collections/community/general/plugins/modules/monit.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Darryl Stoflet <stoflet@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: monit short_description: Manage the state of a program monitored via Monit description: - Manage the state of a program monitored via Monit. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name of the C(monit) program/process to manage. required: true type: str state: description: - The state of service. required: true choices: [ "present", "started", "stopped", "restarted", "monitored", "unmonitored", "reloaded" ] type: str timeout: description: - If there are pending actions for the service monitored by monit, then Ansible will check for up to this many seconds to verify the requested action has been performed. Ansible will sleep for five seconds between each check. default: 300 type: int author: - Darryl Stoflet (@dstoflet) - Simon Kelly (@snopoke) ''' EXAMPLES = ''' - name: Manage the state of program httpd to be in started state community.general.monit: name: httpd state: started ''' import time import re from collections import namedtuple from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import python_2_unicode_compatible STATE_COMMAND_MAP = { 'stopped': 'stop', 'started': 'start', 'monitored': 'monitor', 'unmonitored': 'unmonitor', 'restarted': 'restart' } MONIT_SERVICES = ['Process', 'File', 'Fifo', 'Filesystem', 'Directory', 'Remote host', 'System', 'Program', 'Network'] @python_2_unicode_compatible class StatusValue(namedtuple("Status", "value, is_pending")): MISSING = 'missing' OK = 'ok' NOT_MONITORED = 'not_monitored' INITIALIZING = 'initializing' DOES_NOT_EXIST = 'does_not_exist' EXECUTION_FAILED = 'execution_failed' ALL_STATUS = [ MISSING, OK, NOT_MONITORED, INITIALIZING, DOES_NOT_EXIST, EXECUTION_FAILED ] def __new__(cls, value, is_pending=False): return super(StatusValue, cls).__new__(cls, value, is_pending) def pending(self): return StatusValue(self.value, True) def __getattr__(self, item): if item in ('is_%s' % status for status in self.ALL_STATUS): return self.value == getattr(self, item[3:].upper()) raise AttributeError(item) def __str__(self): return "%s%s" % (self.value, " (pending)" if self.is_pending else "") class Status(object): MISSING = StatusValue(StatusValue.MISSING) OK = StatusValue(StatusValue.OK) RUNNING = StatusValue(StatusValue.OK) NOT_MONITORED = StatusValue(StatusValue.NOT_MONITORED) INITIALIZING = StatusValue(StatusValue.INITIALIZING) DOES_NOT_EXIST = StatusValue(StatusValue.DOES_NOT_EXIST) EXECUTION_FAILED = StatusValue(StatusValue.EXECUTION_FAILED) class Monit(object): def __init__(self, module, monit_bin_path, service_name, timeout): self.module = module self.monit_bin_path = monit_bin_path self.process_name = service_name self.timeout = timeout self._monit_version = None self._raw_version = None self._status_change_retry_count = 6 def monit_version(self): if self._monit_version is None: self._raw_version, version = self._get_monit_version() # Use only major and minor even if there are more these should be enough self._monit_version = version[0], version[1] return self._monit_version def _get_monit_version(self): rc, out, err = self.module.run_command([self.monit_bin_path, '-V'], check_rc=True) version_line = out.split('\n')[0] raw_version = re.search(r"([0-9]+\.){1,2}([0-9]+)?", version_line).group() return raw_version, tuple(map(int, raw_version.split('.'))) def exit_fail(self, msg, status=None, **kwargs): kwargs.update({ 'msg': msg, 'monit_version': self._raw_version, 'process_status': str(status) if status else None, }) self.module.fail_json(**kwargs) def exit_success(self, state): self.module.exit_json(changed=True, name=self.process_name, state=state) @property def command_args(self): return ["-B"] if self.monit_version() > (5, 18) else [] def get_status(self, validate=False): """Return the status of the process in monit. :@param validate: Force monit to re-check the status of the process """ monit_command = "validate" if validate else "status" check_rc = False if validate else True # 'validate' always has rc = 1 command = [self.monit_bin_path, monit_command] + self.command_args + [self.process_name] rc, out, err = self.module.run_command(command, check_rc=check_rc) return self._parse_status(out, err) def _parse_status(self, output, err): escaped_monit_services = '|'.join([re.escape(x) for x in MONIT_SERVICES]) pattern = "(%s) '%s'" % (escaped_monit_services, re.escape(self.process_name)) if not re.search(pattern, output, re.IGNORECASE): return Status.MISSING status_val = re.findall(r"^\s*status\s*([\w\- ]+)", output, re.MULTILINE) if not status_val: self.exit_fail("Unable to find process status", stdout=output, stderr=err) status_val = status_val[0].strip().upper() if ' | ' in status_val: status_val = status_val.split(' | ')[0] if ' - ' not in status_val: status_val = status_val.replace(' ', '_') return getattr(Status, status_val) else: status_val, substatus = status_val.split(' - ') action, state = substatus.split() if action in ['START', 'INITIALIZING', 'RESTART', 'MONITOR']: status = Status.OK else: status = Status.NOT_MONITORED if state == 'pending': status = status.pending() return status def is_process_present(self): command = [self.monit_bin_path, 'summary'] + self.command_args rc, out, err = self.module.run_command(command, check_rc=True) return bool(re.findall(r'\b%s\b' % self.process_name, out)) def is_process_running(self): return self.get_status().is_ok def run_command(self, command): """Runs a monit command, and returns the new status.""" return self.module.run_command([self.monit_bin_path, command, self.process_name], check_rc=True) def wait_for_status_change(self, current_status): running_status = self.get_status() if running_status.value != current_status.value or current_status.value == StatusValue.EXECUTION_FAILED: return running_status loop_count = 0 while running_status.value == current_status.value: if loop_count >= self._status_change_retry_count: self.exit_fail('waited too long for monit to change state', running_status) loop_count += 1 time.sleep(0.5) validate = loop_count % 2 == 0 # force recheck of status every second try running_status = self.get_status(validate) return running_status def wait_for_monit_to_stop_pending(self, current_status=None): """Fails this run if there is no status or it's pending/initializing for timeout""" timeout_time = time.time() + self.timeout if not current_status: current_status = self.get_status() waiting_status = [ StatusValue.MISSING, StatusValue.INITIALIZING, StatusValue.DOES_NOT_EXIST, ] while current_status.is_pending or (current_status.value in waiting_status): if time.time() >= timeout_time: self.exit_fail('waited too long for "pending", or "initiating" status to go away', current_status) time.sleep(5) current_status = self.get_status(validate=True) return current_status def reload(self): rc, out, err = self.module.run_command([self.monit_bin_path, 'reload']) if rc != 0: self.exit_fail('monit reload failed', stdout=out, stderr=err) self.exit_success(state='reloaded') def present(self): self.run_command('reload') timeout_time = time.time() + self.timeout while not self.is_process_present(): if time.time() >= timeout_time: self.exit_fail('waited too long for process to become "present"') time.sleep(5) self.exit_success(state='present') def change_state(self, state, expected_status, invert_expected=None): current_status = self.get_status() self.run_command(STATE_COMMAND_MAP[state]) status = self.wait_for_status_change(current_status) status = self.wait_for_monit_to_stop_pending(status) status_match = status.value == expected_status.value if invert_expected: status_match = not status_match if status_match: self.exit_success(state=state) self.exit_fail('%s process not %s' % (self.process_name, state), status) def stop(self): self.change_state('stopped', Status.NOT_MONITORED) def unmonitor(self): self.change_state('unmonitored', Status.NOT_MONITORED) def restart(self): self.change_state('restarted', Status.OK) def start(self): self.change_state('started', Status.OK) def monitor(self): self.change_state('monitored', Status.NOT_MONITORED, invert_expected=True) def main(): arg_spec = dict( name=dict(required=True), timeout=dict(default=300, type='int'), state=dict(required=True, choices=['present', 'started', 'restarted', 'stopped', 'monitored', 'unmonitored', 'reloaded']) ) module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True) name = module.params['name'] state = module.params['state'] timeout = module.params['timeout'] monit = Monit(module, module.get_bin_path('monit', True), name, timeout) def exit_if_check_mode(): if module.check_mode: module.exit_json(changed=True) if state == 'reloaded': exit_if_check_mode() monit.reload() present = monit.is_process_present() if not present and not state == 'present': module.fail_json(msg='%s process not presently configured with monit' % name, name=name) if state == 'present': if present: module.exit_json(changed=False, name=name, state=state) exit_if_check_mode() monit.present() monit.wait_for_monit_to_stop_pending() running = monit.is_process_running() if running and state in ['started', 'monitored']: module.exit_json(changed=False, name=name, state=state) if running and state == 'stopped': exit_if_check_mode() monit.stop() if running and state == 'unmonitored': exit_if_check_mode() monit.unmonitor() elif state == 'restarted': exit_if_check_mode() monit.restart() elif not running and state == 'started': exit_if_check_mode() monit.start() elif not running and state == 'monitored': exit_if_check_mode() monit.monitor() module.exit_json(changed=False, name=name, state=state) if __name__ == '__main__': main() PK $�!\/�d\� � T collections/ansible_collections/community/general/plugins/modules/gconftool2_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2022, Alexei Znamensky <russoz@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: gconftool2_info author: - "Alexei Znamensky (@russoz)" short_description: Retrieve GConf configurations version_added: 5.1.0 description: - This module allows retrieving application preferences from the GConf database, with the help of C(gconftool-2). extends_documentation_fragment: - community.general.attributes - community.general.attributes.info_module options: key: description: - The key name for an element in the GConf database. type: str required: true notes: - See man gconftool-2(1) for more details. seealso: - name: gconf repository (archived) description: Git repository for the project. It is an archived project, so the repository is read-only. link: https://gitlab.gnome.org/Archive/gconf ''' EXAMPLES = """ - name: Get value for a certain key in the database. community.general.gconftool2_info: key: /desktop/gnome/background/picture_filename register: result """ RETURN = ''' value: description: - The value of the property. returned: success type: str sample: Monospace 10 ''' from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper from ansible_collections.community.general.plugins.module_utils.gconftool2 import gconftool2_runner class GConftoolInfo(ModuleHelper): output_params = ['key'] module = dict( argument_spec=dict( key=dict(type='str', required=True, no_log=False), ), supports_check_mode=True, ) def __init_module__(self): self.runner = gconftool2_runner(self.module, check_rc=True) def __run__(self): with self.runner.context(args_order=["state", "key"]) as ctx: rc, out, err = ctx.run(state="get") self.vars.value = None if err and not out else out.rstrip() def main(): GConftoolInfo.execute() if __name__ == '__main__': main() PK $�!\�#� O collections/ansible_collections/community/general/plugins/modules/mattermost.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) Benjamin Jolivot <bjolivot@gmail.com> # Inspired by slack module : # # Copyright (c) 2017, Steve Pletcher <steve@steve-pletcher.com> # # Copyright (c) 2016, René Moser <mail@renemoser.net> # # Copyright (c) 2015, Stefan Berggren <nsg@nsg.cc> # # Copyright (c) 2014, Ramon de la Fuente <ramon@delafuente.nl>) # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: mattermost short_description: Send Mattermost notifications description: - Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration. author: "Benjamin Jolivot (@bjolivot)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: url: type: str description: - Mattermost url (i.e. http://mattermost.yourcompany.com). required: true api_key: type: str description: - Mattermost webhook api key. Log into your mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This will give you full URL. O(api_key) is the last part. http://mattermost.example.com/hooks/C(API_KEY) required: true text: type: str description: - Text to send. Note that the module does not handle escaping characters. - Required when O(attachments) is not set. attachments: type: list elements: dict description: - Define a list of attachments. - For more information, see U(https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/). - Required when O(text) is not set. version_added: 4.3.0 channel: type: str description: - Channel to send the message to. If absent, the message goes to the channel selected for the O(api_key). username: type: str description: - This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc. default: Ansible icon_url: type: str description: - URL for the message sender's icon. default: https://docs.ansible.com/favicon.ico validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. default: true type: bool ''' EXAMPLES = """ - name: Send notification message via Mattermost community.general.mattermost: url: http://mattermost.example.com api_key: my_api_key text: '{{ inventory_hostname }} completed' - name: Send notification message via Mattermost all options community.general.mattermost: url: http://mattermost.example.com api_key: my_api_key text: '{{ inventory_hostname }} completed' channel: notifications username: 'Ansible on {{ inventory_hostname }}' icon_url: http://www.example.com/some-image-file.png - name: Send attachments message via Mattermost community.general.mattermost: url: http://mattermost.example.com api_key: my_api_key attachments: - text: Display my system load on host A and B color: '#ff00dd' title: System load fields: - title: System A value: "load average: 0,74, 0,66, 0,63" short: true - title: System B value: 'load average: 5,16, 4,64, 2,43' short: true """ RETURN = ''' payload: description: Mattermost payload returned: success type: str webhook_url: description: URL the webhook is sent to returned: success type: str ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def main(): module = AnsibleModule( supports_check_mode=True, argument_spec=dict( url=dict(type='str', required=True), api_key=dict(type='str', required=True, no_log=True), text=dict(type='str'), channel=dict(type='str', default=None), username=dict(type='str', default='Ansible'), icon_url=dict(type='str', default='https://docs.ansible.com/favicon.ico'), validate_certs=dict(default=True, type='bool'), attachments=dict(type='list', elements='dict'), ), required_one_of=[ ('text', 'attachments'), ], ) # init return dict result = dict(changed=False, msg="OK") # define webhook webhook_url = "{0}/hooks/{1}".format(module.params['url'], module.params['api_key']) result['webhook_url'] = webhook_url # define payload payload = {} for param in ['text', 'channel', 'username', 'icon_url', 'attachments']: if module.params[param] is not None: payload[param] = module.params[param] payload = module.jsonify(payload) result['payload'] = payload # http headers headers = { 'Content-Type': 'application/json', 'Accept': 'application/json', } # notes: # Nothing is done in check mode # it'll pass even if your server is down or/and if your token is invalid. # If someone find good way to check... # send request if not in test mode if module.check_mode is False: response, info = fetch_url(module=module, url=webhook_url, headers=headers, method='POST', data=payload) # something's wrong if info['status'] != 200: # some problem result['msg'] = "Failed to send mattermost message, the error was: {0}".format(info['msg']) module.fail_json(**result) # Looks good module.exit_json(**result) if __name__ == '__main__': main() PK $�!\��S�� � R collections/ansible_collections/community/general/plugins/modules/ipa_hostgroup.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_hostgroup author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA host-group description: - Add, modify and delete an IPA host-group using IPA API. attributes: check_mode: support: full diff_mode: support: none options: append: description: - If V(true), add the listed O(host) to the O(hostgroup). - If V(false), only the listed O(host) will be in O(hostgroup), removing any other hosts. default: false type: bool version_added: 6.6.0 cn: description: - Name of host-group. - Can not be changed as it is the unique identifier. required: true aliases: ["name"] type: str description: description: - Description. type: str host: description: - List of hosts that belong to the host-group. - If an empty list is passed all hosts will be removed from the group. - If option is omitted hosts will not be checked or changed. - If option is passed all assigned hosts that are not passed will be unassigned from the group. type: list elements: str hostgroup: description: - List of host-groups than belong to that host-group. - If an empty list is passed all host-groups will be removed from the group. - If option is omitted host-groups will not be checked or changed. - If option is passed all assigned hostgroups that are not passed will be unassigned from the group. type: list elements: str state: description: - State to ensure. default: "present" choices: ["absent", "disabled", "enabled", "present"] type: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure host-group databases is present community.general.ipa_hostgroup: name: databases state: present host: - db.example.com hostgroup: - mysql-server - oracle-server ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure host-group databases is absent community.general.ipa_hostgroup: name: databases state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' hostgroup: description: Hostgroup as returned by IPA API. returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class HostGroupIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(HostGroupIPAClient, self).__init__(module, host, port, protocol) def hostgroup_find(self, name): return self._post_json(method='hostgroup_find', name=None, item={'all': True, 'cn': name}) def hostgroup_add(self, name, item): return self._post_json(method='hostgroup_add', name=name, item=item) def hostgroup_mod(self, name, item): return self._post_json(method='hostgroup_mod', name=name, item=item) def hostgroup_del(self, name): return self._post_json(method='hostgroup_del', name=name) def hostgroup_add_member(self, name, item): return self._post_json(method='hostgroup_add_member', name=name, item=item) def hostgroup_add_host(self, name, item): return self.hostgroup_add_member(name=name, item={'host': item}) def hostgroup_add_hostgroup(self, name, item): return self.hostgroup_add_member(name=name, item={'hostgroup': item}) def hostgroup_remove_member(self, name, item): return self._post_json(method='hostgroup_remove_member', name=name, item=item) def hostgroup_remove_host(self, name, item): return self.hostgroup_remove_member(name=name, item={'host': item}) def hostgroup_remove_hostgroup(self, name, item): return self.hostgroup_remove_member(name=name, item={'hostgroup': item}) def get_hostgroup_dict(description=None): data = {} if description is not None: data['description'] = description return data def get_hostgroup_diff(client, ipa_hostgroup, module_hostgroup): return client.get_diff(ipa_data=ipa_hostgroup, module_data=module_hostgroup) def ensure(module, client): name = module.params['cn'] state = module.params['state'] host = module.params['host'] hostgroup = module.params['hostgroup'] append = module.params['append'] ipa_hostgroup = client.hostgroup_find(name=name) module_hostgroup = get_hostgroup_dict(description=module.params['description']) changed = False if state == 'present': if not ipa_hostgroup: changed = True if not module.check_mode: ipa_hostgroup = client.hostgroup_add(name=name, item=module_hostgroup) else: diff = get_hostgroup_diff(client, ipa_hostgroup, module_hostgroup) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_hostgroup.get(key) client.hostgroup_mod(name=name, item=data) if host is not None: changed = client.modify_if_diff(name, ipa_hostgroup.get('member_host', []), [item.lower() for item in host], client.hostgroup_add_host, client.hostgroup_remove_host, append=append) or changed if hostgroup is not None: changed = client.modify_if_diff(name, ipa_hostgroup.get('member_hostgroup', []), [item.lower() for item in hostgroup], client.hostgroup_add_hostgroup, client.hostgroup_remove_hostgroup, append=append) or changed else: if ipa_hostgroup: changed = True if not module.check_mode: client.hostgroup_del(name=name) return changed, client.hostgroup_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), host=dict(type='list', elements='str'), hostgroup=dict(type='list', elements='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), append=dict(type='bool', default=False)) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = HostGroupIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, hostgroup = ensure(module, client) module.exit_json(changed=changed, hostgroup=hostgroup) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\{��_*- *- a collections/ansible_collections/community/general/plugins/modules/ovh_ip_loadbalancing_backend.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ovh_ip_loadbalancing_backend short_description: Manage OVH IP LoadBalancing backends description: - Manage OVH (French European hosting provider) LoadBalancing IP backends author: Pascal Heraud (@pascalheraud) notes: - Uses the python OVH Api U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/) requirements: - ovh > 0.3.5 extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: required: true description: - Name of the LoadBalancing internal name (ip-X.X.X.X) type: str backend: required: true description: - The IP address of the backend to update / modify / delete type: str state: default: present choices: ['present', 'absent'] description: - Determines whether the backend is to be created/modified or deleted type: str probe: default: 'none' choices: ['none', 'http', 'icmp' , 'oco'] description: - Determines the type of probe to use for this backend type: str weight: default: 8 description: - Determines the weight for this backend type: int endpoint: required: true description: - The endpoint to use ( for instance ovh-eu) type: str application_key: required: true description: - The applicationKey to use type: str application_secret: required: true description: - The application secret to use type: str consumer_key: required: true description: - The consumer key to use type: str timeout: default: 120 description: - The timeout in seconds used to wait for a task to be completed. type: int ''' EXAMPLES = ''' - name: Adds or modify the backend '212.1.1.1' to a loadbalancing 'ip-1.1.1.1' ovh_ip_loadbalancing: name: ip-1.1.1.1 backend: 212.1.1.1 state: present probe: none weight: 8 endpoint: ovh-eu application_key: yourkey application_secret: yoursecret consumer_key: yourconsumerkey - name: Removes a backend '212.1.1.1' from a loadbalancing 'ip-1.1.1.1' ovh_ip_loadbalancing: name: ip-1.1.1.1 backend: 212.1.1.1 state: absent endpoint: ovh-eu application_key: yourkey application_secret: yoursecret consumer_key: yourconsumerkey ''' RETURN = ''' ''' import time try: import ovh import ovh.exceptions from ovh.exceptions import APIError HAS_OVH = True except ImportError: HAS_OVH = False from ansible.module_utils.basic import AnsibleModule def getOvhClient(ansibleModule): endpoint = ansibleModule.params.get('endpoint') application_key = ansibleModule.params.get('application_key') application_secret = ansibleModule.params.get('application_secret') consumer_key = ansibleModule.params.get('consumer_key') return ovh.Client( endpoint=endpoint, application_key=application_key, application_secret=application_secret, consumer_key=consumer_key ) def waitForNoTask(client, name, timeout): currentTimeout = timeout while len(client.get('/ip/loadBalancing/{0}/task'.format(name))) > 0: time.sleep(1) # Delay for 1 sec currentTimeout -= 1 if currentTimeout < 0: return False return True def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), backend=dict(required=True), weight=dict(default=8, type='int'), probe=dict(default='none', choices=['none', 'http', 'icmp', 'oco']), state=dict(default='present', choices=['present', 'absent']), endpoint=dict(required=True), application_key=dict(required=True, no_log=True), application_secret=dict(required=True, no_log=True), consumer_key=dict(required=True, no_log=True), timeout=dict(default=120, type='int') ) ) if not HAS_OVH: module.fail_json(msg='ovh-api python module' 'is required to run this module ') # Get parameters name = module.params.get('name') state = module.params.get('state') backend = module.params.get('backend') weight = module.params.get('weight') probe = module.params.get('probe') timeout = module.params.get('timeout') # Connect to OVH API client = getOvhClient(module) # Check that the load balancing exists try: loadBalancings = client.get('/ip/loadBalancing') except APIError as apiError: module.fail_json( msg='Unable to call OVH api for getting the list of loadBalancing, ' 'check application key, secret, consumerkey and parameters. ' 'Error returned by OVH api was : {0}'.format(apiError)) if name not in loadBalancings: module.fail_json(msg='IP LoadBalancing {0} does not exist'.format(name)) # Check that no task is pending before going on try: if not waitForNoTask(client, name, timeout): module.fail_json( msg='Timeout of {0} seconds while waiting for no pending ' 'tasks before executing the module '.format(timeout)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for getting the list of pending tasks ' 'of the loadBalancing, check application key, secret, consumerkey ' 'and parameters. Error returned by OVH api was : {0}' .format(apiError)) try: backends = client.get('/ip/loadBalancing/{0}/backend'.format(name)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for getting the list of backends ' 'of the loadBalancing, check application key, secret, consumerkey ' 'and parameters. Error returned by OVH api was : {0}' .format(apiError)) backendExists = backend in backends moduleChanged = False if state == "absent": if backendExists: # Remove backend try: client.delete( '/ip/loadBalancing/{0}/backend/{1}'.format(name, backend)) if not waitForNoTask(client, name, timeout): module.fail_json( msg='Timeout of {0} seconds while waiting for completion ' 'of removing backend task'.format(timeout)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for deleting the backend, ' 'check application key, secret, consumerkey and ' 'parameters. Error returned by OVH api was : {0}' .format(apiError)) moduleChanged = True else: if backendExists: # Get properties try: backendProperties = client.get( '/ip/loadBalancing/{0}/backend/{1}'.format(name, backend)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for getting the backend properties, ' 'check application key, secret, consumerkey and ' 'parameters. Error returned by OVH api was : {0}' .format(apiError)) if (backendProperties['weight'] != weight): # Change weight try: client.post( '/ip/loadBalancing/{0}/backend/{1}/setWeight' .format(name, backend), weight=weight) if not waitForNoTask(client, name, timeout): module.fail_json( msg='Timeout of {0} seconds while waiting for completion ' 'of setWeight to backend task' .format(timeout)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for updating the weight of the ' 'backend, check application key, secret, consumerkey ' 'and parameters. Error returned by OVH api was : {0}' .format(apiError)) moduleChanged = True if (backendProperties['probe'] != probe): # Change probe backendProperties['probe'] = probe try: client.put( '/ip/loadBalancing/{0}/backend/{1}' .format(name, backend), probe=probe) if not waitForNoTask(client, name, timeout): module.fail_json( msg='Timeout of {0} seconds while waiting for completion of ' 'setProbe to backend task' .format(timeout)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for updating the probe of ' 'the backend, check application key, secret, ' 'consumerkey and parameters. Error returned by OVH api ' 'was : {0}' .format(apiError)) moduleChanged = True else: # Creates backend try: try: client.post('/ip/loadBalancing/{0}/backend'.format(name), ipBackend=backend, probe=probe, weight=weight) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for creating the backend, check ' 'application key, secret, consumerkey and parameters. ' 'Error returned by OVH api was : {0}' .format(apiError)) if not waitForNoTask(client, name, timeout): module.fail_json( msg='Timeout of {0} seconds while waiting for completion of ' 'backend creation task'.format(timeout)) except APIError as apiError: module.fail_json( msg='Unable to call OVH api for creating the backend, check ' 'application key, secret, consumerkey and parameters. ' 'Error returned by OVH api was : {0}'.format(apiError)) moduleChanged = True module.exit_json(changed=moduleChanged) if __name__ == '__main__': main() PK $�!\��b�U �U S collections/ansible_collections/community/general/plugins/modules/iptables_state.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, quidame <quidame@poivron.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: iptables_state short_description: Save iptables state into a file or restore it from a file version_added: '1.1.0' author: quidame (@quidame) extends_documentation_fragment: - community.general.attributes - community.general.attributes.flow description: - C(iptables) is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel. - This module handles the saving and/or loading of rules. This is the same as the behaviour of the C(iptables-save) and C(iptables-restore) (or C(ip6tables-save) and C(ip6tables-restore) for IPv6) commands which this module uses internally. - Modifying the state of the firewall remotely may lead to loose access to the host in case of mistake in new ruleset. This module embeds a rollback feature to avoid this, by telling the host to restore previous rules if a cookie is still there after a given delay, and all this time telling the controller to try to remove this cookie on the host through a new connection. notes: - The rollback feature is not a module option and depends on task's attributes. To enable it, the module must be played asynchronously, i.e. by setting task attributes C(poll) to V(0), and C(async) to a value less or equal to C(ANSIBLE_TIMEOUT). If C(async) is greater, the rollback will still happen if it shall happen, but you will experience a connection timeout instead of more relevant info returned by the module after its failure. attributes: check_mode: support: full diff_mode: support: none action: support: full async: support: full options: counters: description: - Save or restore the values of all packet and byte counters. - When V(true), the module is not idempotent. type: bool default: false ip_version: description: - Which version of the IP protocol this module should apply to. type: str choices: [ ipv4, ipv6 ] default: ipv4 modprobe: description: - Specify the path to the C(modprobe) program internally used by iptables related commands to load kernel modules. - By default, V(/proc/sys/kernel/modprobe) is inspected to determine the executable's path. type: path noflush: description: - For O(state=restored), ignored otherwise. - If V(false), restoring iptables rules from a file flushes (deletes) all previous contents of the respective table(s). If V(true), the previous rules are left untouched (but policies are updated anyway, for all built-in chains). type: bool default: false path: description: - The file the iptables state should be saved to. - The file the iptables state should be restored from. type: path required: true state: description: - Whether the firewall state should be saved (into a file) or restored (from a file). type: str choices: [ saved, restored ] required: true table: description: - When O(state=restored), restore only the named table even if the input file contains other tables. Fail if the named table is not declared in the file. - When O(state=saved), restrict output to the specified table. If not specified, output includes all active tables. type: str choices: [ filter, nat, mangle, raw, security ] wait: description: - Wait N seconds for the xtables lock to prevent instant failure in case multiple instances of the program are running concurrently. type: int requirements: [iptables, ip6tables] ''' EXAMPLES = r''' # This will apply to all loaded/active IPv4 tables. - name: Save current state of the firewall in system file community.general.iptables_state: state: saved path: /etc/sysconfig/iptables # This will apply only to IPv6 filter table. - name: save current state of the firewall in system file community.general.iptables_state: ip_version: ipv6 table: filter state: saved path: /etc/iptables/rules.v6 # This will load a state from a file, with a rollback in case of access loss - name: restore firewall state from a file community.general.iptables_state: state: restored path: /run/iptables.apply async: "{{ ansible_timeout }}" poll: 0 # This will load new rules by appending them to the current ones - name: restore firewall state from a file community.general.iptables_state: state: restored path: /run/iptables.apply noflush: true async: "{{ ansible_timeout }}" poll: 0 # This will only retrieve information - name: get current state of the firewall community.general.iptables_state: state: saved path: /tmp/iptables check_mode: true changed_when: false register: iptables_state - name: show current state of the firewall ansible.builtin.debug: var: iptables_state.initial_state ''' RETURN = r''' applied: description: Whether or not the wanted state has been successfully restored. type: bool returned: always sample: true initial_state: description: The current state of the firewall when module starts. type: list elements: str returned: always sample: [ "# Generated by xtables-save v1.8.2", "*filter", ":INPUT ACCEPT [0:0]", ":FORWARD ACCEPT [0:0]", ":OUTPUT ACCEPT [0:0]", "COMMIT", "# Completed" ] restored: description: The state the module restored, whenever it is finally applied or not. type: list elements: str returned: always sample: [ "# Generated by xtables-save v1.8.2", "*filter", ":INPUT DROP [0:0]", ":FORWARD DROP [0:0]", ":OUTPUT ACCEPT [0:0]", "-A INPUT -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT", "-A INPUT -m conntrack --ctstate INVALID -j DROP", "-A INPUT -i lo -j ACCEPT", "-A INPUT -p icmp -j ACCEPT", "-A INPUT -p tcp -m tcp --dport 22 -j ACCEPT", "COMMIT", "# Completed" ] saved: description: The iptables state the module saved. type: list elements: str returned: always sample: [ "# Generated by xtables-save v1.8.2", "*filter", ":INPUT ACCEPT [0:0]", ":FORWARD DROP [0:0]", ":OUTPUT ACCEPT [0:0]", "COMMIT", "# Completed" ] tables: description: The iptables we have interest for when module starts. type: dict contains: table: description: Policies and rules for all chains of the named table. type: list elements: str sample: |- { "filter": [ ":INPUT ACCEPT", ":FORWARD ACCEPT", ":OUTPUT ACCEPT", "-A INPUT -i lo -j ACCEPT", "-A INPUT -p icmp -j ACCEPT", "-A INPUT -p tcp -m tcp --dport 22 -j ACCEPT", "-A INPUT -j REJECT --reject-with icmp-host-prohibited" ], "nat": [ ":PREROUTING ACCEPT", ":INPUT ACCEPT", ":OUTPUT ACCEPT", ":POSTROUTING ACCEPT" ] } returned: always ''' import re import os import time import tempfile import filecmp import shutil from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_native IPTABLES = dict( ipv4='iptables', ipv6='ip6tables', ) SAVE = dict( ipv4='iptables-save', ipv6='ip6tables-save', ) RESTORE = dict( ipv4='iptables-restore', ipv6='ip6tables-restore', ) TABLES = ['filter', 'mangle', 'nat', 'raw', 'security'] def read_state(b_path): ''' Read a file and store its content in a variable as a list. ''' with open(b_path, 'r') as f: text = f.read() return [t for t in text.splitlines() if t != ''] def write_state(b_path, lines, changed): ''' Write given contents to the given path, and return changed status. ''' # Populate a temporary file tmpfd, tmpfile = tempfile.mkstemp() with os.fdopen(tmpfd, 'w') as f: f.write("{0}\n".format("\n".join(lines))) # Prepare to copy temporary file to the final destination if not os.path.exists(b_path): b_destdir = os.path.dirname(b_path) destdir = to_native(b_destdir, errors='surrogate_or_strict') if b_destdir and not os.path.exists(b_destdir) and not module.check_mode: try: os.makedirs(b_destdir) except Exception as err: module.fail_json( msg='Error creating %s: %s' % (destdir, to_native(err)), initial_state=lines) changed = True elif not filecmp.cmp(tmpfile, b_path): changed = True # Do it if changed and not module.check_mode: try: shutil.copyfile(tmpfile, b_path) except Exception as err: path = to_native(b_path, errors='surrogate_or_strict') module.fail_json( msg='Error saving state into %s: %s' % (path, to_native(err)), initial_state=lines) return changed def initialize_from_null_state(initializer, initcommand, fallbackcmd, table): ''' This ensures iptables-state output is suitable for iptables-restore to roll back to it, i.e. iptables-save output is not empty. This also works for the iptables-nft-save alternative. ''' if table is None: table = 'filter' commandline = list(initializer) commandline += ['-t', table] dummy = module.run_command(commandline, check_rc=True) (rc, out, err) = module.run_command(initcommand, check_rc=True) if '*%s' % table not in out.splitlines(): # The last resort. iptables_input = '*%s\n:OUTPUT ACCEPT\nCOMMIT\n' % table dummy = module.run_command(fallbackcmd, data=iptables_input, check_rc=True) (rc, out, err) = module.run_command(initcommand, check_rc=True) return rc, out, err def filter_and_format_state(string): ''' Remove timestamps to ensure idempotence between runs. Also remove counters by default. And return the result as a list. ''' string = re.sub(r'((^|\n)# (Generated|Completed)[^\n]*) on [^\n]*', r'\1', string) if not module.params['counters']: string = re.sub(r'\[[0-9]+:[0-9]+\]', r'[0:0]', string) lines = [line for line in string.splitlines() if line != ''] return lines def per_table_state(command, state): ''' Convert raw iptables-save output into usable datastructure, for reliable comparisons between initial and final states. ''' tables = dict() for t in TABLES: COMMAND = list(command) if '*%s' % t in state.splitlines(): COMMAND.extend(['--table', t]) dummy, out, dummy = module.run_command(COMMAND, check_rc=True) out = re.sub(r'(^|\n)(# Generated|# Completed|[*]%s|COMMIT)[^\n]*' % t, r'', out) out = re.sub(r' *\[[0-9]+:[0-9]+\] *', r'', out) tables[t] = [tt for tt in out.splitlines() if tt != ''] return tables def main(): global module module = AnsibleModule( argument_spec=dict( path=dict(type='path', required=True), state=dict(type='str', choices=['saved', 'restored'], required=True), table=dict(type='str', choices=['filter', 'nat', 'mangle', 'raw', 'security']), noflush=dict(type='bool', default=False), counters=dict(type='bool', default=False), modprobe=dict(type='path'), ip_version=dict(type='str', choices=['ipv4', 'ipv6'], default='ipv4'), wait=dict(type='int'), _timeout=dict(type='int'), _back=dict(type='path'), ), required_together=[ ['_timeout', '_back'], ], supports_check_mode=True, ) # We'll parse iptables-restore stderr module.run_command_environ_update = dict(LANG='C', LC_MESSAGES='C') path = module.params['path'] state = module.params['state'] table = module.params['table'] noflush = module.params['noflush'] counters = module.params['counters'] modprobe = module.params['modprobe'] ip_version = module.params['ip_version'] wait = module.params['wait'] _timeout = module.params['_timeout'] _back = module.params['_back'] bin_iptables = module.get_bin_path(IPTABLES[ip_version], True) bin_iptables_save = module.get_bin_path(SAVE[ip_version], True) bin_iptables_restore = module.get_bin_path(RESTORE[ip_version], True) os.umask(0o077) changed = False COMMANDARGS = [] INITCOMMAND = [bin_iptables_save] INITIALIZER = [bin_iptables, '-L', '-n'] TESTCOMMAND = [bin_iptables_restore, '--test'] FALLBACKCMD = [bin_iptables_restore] if counters: COMMANDARGS.append('--counters') if table is not None: COMMANDARGS.extend(['--table', table]) if wait is not None: TESTCOMMAND.extend(['--wait', '%s' % wait]) if modprobe is not None: b_modprobe = to_bytes(modprobe, errors='surrogate_or_strict') if not os.path.exists(b_modprobe): module.fail_json(msg="modprobe %s not found" % modprobe) if not os.path.isfile(b_modprobe): module.fail_json(msg="modprobe %s not a file" % modprobe) if not os.access(b_modprobe, os.R_OK): module.fail_json(msg="modprobe %s not readable" % modprobe) if not os.access(b_modprobe, os.X_OK): module.fail_json(msg="modprobe %s not executable" % modprobe) COMMANDARGS.extend(['--modprobe', modprobe]) INITIALIZER.extend(['--modprobe', modprobe]) INITCOMMAND.extend(['--modprobe', modprobe]) TESTCOMMAND.extend(['--modprobe', modprobe]) FALLBACKCMD.extend(['--modprobe', modprobe]) SAVECOMMAND = list(COMMANDARGS) SAVECOMMAND.insert(0, bin_iptables_save) b_path = to_bytes(path, errors='surrogate_or_strict') if state == 'restored': if not os.path.exists(b_path): module.fail_json(msg="Source %s not found" % path) if not os.path.isfile(b_path): module.fail_json(msg="Source %s not a file" % path) if not os.access(b_path, os.R_OK): module.fail_json(msg="Source %s not readable" % path) state_to_restore = read_state(b_path) else: cmd = ' '.join(SAVECOMMAND) (rc, stdout, stderr) = module.run_command(INITCOMMAND, check_rc=True) # The issue comes when wanting to restore state from empty iptable-save's # output... what happens when, say: # - no table is specified, and iptables-save's output is only nat table; # - we give filter's ruleset to iptables-restore, that locks ourselve out # of the host; # then trying to roll iptables state back to the previous (working) setup # doesn't override current filter table because no filter table is stored # in the backup ! So we have to ensure tables to be restored have a backup # in case of rollback. if table is None: if state == 'restored': for t in TABLES: if '*%s' % t in state_to_restore: if len(stdout) == 0 or '*%s' % t not in stdout.splitlines(): (rc, stdout, stderr) = initialize_from_null_state(INITIALIZER, INITCOMMAND, FALLBACKCMD, t) elif len(stdout) == 0: (rc, stdout, stderr) = initialize_from_null_state(INITIALIZER, INITCOMMAND, FALLBACKCMD, 'filter') elif state == 'restored' and '*%s' % table not in state_to_restore: module.fail_json(msg="Table %s to restore not defined in %s" % (table, path)) elif len(stdout) == 0 or '*%s' % table not in stdout.splitlines(): (rc, stdout, stderr) = initialize_from_null_state(INITIALIZER, INITCOMMAND, FALLBACKCMD, table) initial_state = filter_and_format_state(stdout) if initial_state is None: module.fail_json(msg="Unable to initialize firewall from NULL state.") # Depending on the value of 'table', initref_state may differ from # initial_state. (rc, stdout, stderr) = module.run_command(SAVECOMMAND, check_rc=True) tables_before = per_table_state(SAVECOMMAND, stdout) initref_state = filter_and_format_state(stdout) if state == 'saved': changed = write_state(b_path, initref_state, changed) module.exit_json( changed=changed, cmd=cmd, tables=tables_before, initial_state=initial_state, saved=initref_state) # # All remaining code is for state=restored # MAINCOMMAND = list(COMMANDARGS) MAINCOMMAND.insert(0, bin_iptables_restore) if wait is not None: MAINCOMMAND.extend(['--wait', '%s' % wait]) if _back is not None: b_back = to_bytes(_back, errors='surrogate_or_strict') dummy = write_state(b_back, initref_state, changed) BACKCOMMAND = list(MAINCOMMAND) BACKCOMMAND.append(_back) if noflush: MAINCOMMAND.append('--noflush') MAINCOMMAND.append(path) cmd = ' '.join(MAINCOMMAND) TESTCOMMAND = list(MAINCOMMAND) TESTCOMMAND.insert(1, '--test') error_msg = "Source %s is not suitable for input to %s" % (path, os.path.basename(bin_iptables_restore)) # Due to a bug in iptables-nft-restore --test, we have to validate tables # one by one (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=960003). for t in tables_before: testcommand = list(TESTCOMMAND) testcommand.extend(['--table', t]) (rc, stdout, stderr) = module.run_command(testcommand) if 'Another app is currently holding the xtables lock' in stderr: error_msg = stderr if rc != 0: cmd = ' '.join(testcommand) module.fail_json( msg=error_msg, cmd=cmd, rc=rc, stdout=stdout, stderr=stderr, tables=tables_before, initial_state=initial_state, restored=state_to_restore, applied=False) if module.check_mode: tmpfd, tmpfile = tempfile.mkstemp() with os.fdopen(tmpfd, 'w') as f: f.write("{0}\n".format("\n".join(initial_state))) if filecmp.cmp(tmpfile, b_path): restored_state = initial_state else: restored_state = state_to_restore else: # Let time enough to the plugin to retrieve async status of the module # in case of bad option type/value and the like. if _back is not None: b_starter = to_bytes('%s.starter' % _back, errors='surrogate_or_strict') while True: if os.path.exists(b_starter): os.remove(b_starter) break time.sleep(0.01) (rc, stdout, stderr) = module.run_command(MAINCOMMAND) if 'Another app is currently holding the xtables lock' in stderr: module.fail_json( msg=stderr, cmd=cmd, rc=rc, stdout=stdout, stderr=stderr, tables=tables_before, initial_state=initial_state, restored=state_to_restore, applied=False) (rc, stdout, stderr) = module.run_command(SAVECOMMAND, check_rc=True) restored_state = filter_and_format_state(stdout) if restored_state not in (initref_state, initial_state): if module.check_mode: changed = True else: tables_after = per_table_state(SAVECOMMAND, stdout) if tables_after != tables_before: changed = True if _back is None or module.check_mode: module.exit_json( changed=changed, cmd=cmd, tables=tables_before, initial_state=initial_state, restored=restored_state, applied=True) # The rollback implementation currently needs: # Here: # * test existence of the backup file, exit with success if it doesn't exist # * otherwise, restore iptables from this file and return failure # Action plugin: # * try to remove the backup file # * wait async task is finished and retrieve its final status # * modify it and return the result # Task: # * task attribute 'async' set to the same value (or lower) than ansible # timeout # * task attribute 'poll' equals 0 # for dummy in range(_timeout): if os.path.exists(b_back): time.sleep(1) continue module.exit_json( changed=changed, cmd=cmd, tables=tables_before, initial_state=initial_state, restored=restored_state, applied=True) # Here we are: for whatever reason, but probably due to the current ruleset, # the action plugin (i.e. on the controller) was unable to remove the backup # cookie, so we restore initial state from it. (rc, stdout, stderr) = module.run_command(BACKCOMMAND, check_rc=True) os.remove(b_back) (rc, stdout, stderr) = module.run_command(SAVECOMMAND, check_rc=True) tables_rollback = per_table_state(SAVECOMMAND, stdout) msg = ( "Failed to confirm state restored from %s after %ss. " "Firewall has been rolled back to its initial state." % (path, _timeout) ) module.fail_json( changed=(tables_before != tables_rollback), msg=msg, cmd=cmd, tables=tables_before, initial_state=initial_state, restored=restored_state, applied=False) if __name__ == '__main__': main() PK $�!\~LJu u Q collections/ansible_collections/community/general/plugins/modules/utm_dns_host.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: utm_dns_host author: - Johannes Brunswicker (@MatrixCrawler) short_description: Create, update or destroy dns entry in Sophos UTM description: - Create, update or destroy a dns entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. attributes: check_mode: support: none diff_mode: support: none options: name: type: str description: - The name of the object. Will be used to identify the entry required: true address: type: str description: - The IPV4 Address of the entry. Can be left empty for automatic resolving. default: 0.0.0.0 address6: type: str description: - The IPV6 Address of the entry. Can be left empty for automatic resolving. default: "::" comment: type: str description: - An optional comment to add to the dns host object default: '' hostname: type: str description: - The hostname for the dns host object interface: type: str description: - The reference name of the interface to use. If not provided the default interface will be used default: '' resolved: description: - whether the hostname's ipv4 address is already resolved or not default: false type: bool resolved6: description: - whether the hostname's ipv6 address is already resolved or not default: false type: bool timeout: type: int description: - the timeout for the utm to resolve the ip address for the hostname again default: 0 extends_documentation_fragment: - community.general.utm - community.general.attributes ''' EXAMPLES = """ - name: Create UTM dns host entry community.general.utm_dns_host: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestDNSEntry hostname: testentry.some.tld state: present - name: Remove UTM dns host entry community.general.utm_dns_host: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestDNSEntry state: absent """ RETURN = """ result: description: The utm object that was created returned: success type: complex contains: _ref: description: The reference name of the object type: str _locked: description: Whether or not the object is currently locked type: bool name: description: The name of the object type: str address: description: The ipv4 address of the object type: str address6: description: The ipv6 address of the object type: str comment: description: The comment string type: str hostname: description: The hostname of the object type: str interface: description: The reference name of the interface the object is associated with type: str resolved: description: Whether the ipv4 address is resolved or not type: bool resolved6: description: Whether the ipv6 address is resolved or not type: bool timeout: description: The timeout until a new resolving will be attempted type: int """ from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule from ansible.module_utils.common.text.converters import to_native def main(): endpoint = "network/dns_host" key_to_check_for_changes = ["comment", "hostname", "interface"] module = UTMModule( argument_spec=dict( name=dict(type='str', required=True), address=dict(type='str', required=False, default='0.0.0.0'), address6=dict(type='str', required=False, default='::'), comment=dict(type='str', required=False, default=""), hostname=dict(type='str', required=False), interface=dict(type='str', required=False, default=""), resolved=dict(type='bool', required=False, default=False), resolved6=dict(type='bool', required=False, default=False), timeout=dict(type='int', required=False, default=0), ) ) try: UTM(module, endpoint, key_to_check_for_changes).execute() except Exception as e: module.fail_json(msg=to_native(e)) if __name__ == '__main__': main() PK $�!\�X i0K 0K N collections/ansible_collections/community/general/plugins/modules/udm_share.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Adfinis SyGroup AG # Tobias Rueetschi <tobias.ruetschi@adfinis-sygroup.ch> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: udm_share author: - Tobias Rüetschi (@keachi) short_description: Manage samba shares on a univention corporate server description: - "This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: partial options: state: default: "present" choices: [ present, absent ] description: - Whether the share is present or not. type: str name: required: true description: - Name type: str host: required: false description: - Host FQDN (server which provides the share), for example V({{ ansible_fqdn }}). Required if O(state=present). type: str path: required: false description: - Directory on the providing server, for example V(/home). Required if O(state=present). type: path sambaName: required: false description: - Windows name. Required if O(state=present). type: str aliases: [ samba_name ] ou: required: true description: - Organisational unit, inside the LDAP Base DN. type: str owner: default: '0' description: - Directory owner of the share's root directory. type: str group: default: '0' description: - Directory owner group of the share's root directory. type: str directorymode: default: '00755' description: - Permissions for the share's root directory. type: str root_squash: default: true description: - Modify user ID for root user (root squashing). type: bool subtree_checking: default: true description: - Subtree checking. type: bool sync: default: 'sync' description: - NFS synchronisation. type: str writeable: default: true description: - NFS write access. type: bool sambaBlockSize: description: - Blocking size. type: str aliases: [ samba_block_size ] sambaBlockingLocks: default: true description: - Blocking locks. type: bool aliases: [ samba_blocking_locks ] sambaBrowseable: description: - Show in Windows network environment. type: bool default: true aliases: [ samba_browsable ] sambaCreateMode: default: '0744' description: - File mode. type: str aliases: [ samba_create_mode ] sambaCscPolicy: default: 'manual' description: - Client-side caching policy. type: str aliases: [ samba_csc_policy ] sambaCustomSettings: default: [] description: - Option name in smb.conf and its value. type: list elements: dict aliases: [ samba_custom_settings ] sambaDirectoryMode: default: '0755' description: - Directory mode. type: str aliases: [ samba_directory_mode ] sambaDirectorySecurityMode: default: '0777' description: - Directory security mode. type: str aliases: [ samba_directory_security_mode ] sambaDosFilemode: default: false description: - Users with write access may modify permissions. type: bool aliases: [ samba_dos_filemode ] sambaFakeOplocks: default: false description: - Fake oplocks. type: bool aliases: [ samba_fake_oplocks ] sambaForceCreateMode: default: false description: - Force file mode. type: bool aliases: [ samba_force_create_mode ] sambaForceDirectoryMode: default: false description: - Force directory mode. type: bool aliases: [ samba_force_directory_mode ] sambaForceDirectorySecurityMode: default: false description: - Force directory security mode. type: bool aliases: [ samba_force_directory_security_mode ] sambaForceGroup: description: - Force group. type: str aliases: [ samba_force_group ] sambaForceSecurityMode: default: false description: - Force security mode. type: bool aliases: [ samba_force_security_mode ] sambaForceUser: description: - Force user. type: str aliases: [ samba_force_user ] sambaHideFiles: description: - Hide files. type: str aliases: [ samba_hide_files ] sambaHideUnreadable: default: false description: - Hide unreadable files/directories. type: bool aliases: [ samba_hide_unreadable ] sambaHostsAllow: default: [] description: - Allowed host/network. type: list elements: str aliases: [ samba_hosts_allow ] sambaHostsDeny: default: [] description: - Denied host/network. type: list elements: str aliases: [ samba_hosts_deny ] sambaInheritAcls: default: true description: - Inherit ACLs. type: bool aliases: [ samba_inherit_acls ] sambaInheritOwner: default: false description: - Create files/directories with the owner of the parent directory. type: bool aliases: [ samba_inherit_owner ] sambaInheritPermissions: default: false description: - Create files/directories with permissions of the parent directory. type: bool aliases: [ samba_inherit_permissions ] sambaInvalidUsers: description: - Invalid users or groups. type: str aliases: [ samba_invalid_users ] sambaLevel2Oplocks: default: true description: - Level 2 oplocks. type: bool aliases: [ samba_level_2_oplocks ] sambaLocking: default: true description: - Locking. type: bool aliases: [ samba_locking ] sambaMSDFSRoot: default: false description: - MSDFS root. type: bool aliases: [ samba_msdfs_root ] sambaNtAclSupport: default: true description: - NT ACL support. type: bool aliases: [ samba_nt_acl_support ] sambaOplocks: default: true description: - Oplocks. type: bool aliases: [ samba_oplocks ] sambaPostexec: description: - Postexec script. type: str aliases: [ samba_postexec ] sambaPreexec: description: - Preexec script. type: str aliases: [ samba_preexec ] sambaPublic: default: false description: - Allow anonymous read-only access with a guest user. type: bool aliases: [ samba_public ] sambaSecurityMode: default: '0777' description: - Security mode. type: str aliases: [ samba_security_mode ] sambaStrictLocking: default: 'Auto' description: - Strict locking. type: str aliases: [ samba_strict_locking ] sambaVFSObjects: description: - VFS objects. type: str aliases: [ samba_vfs_objects ] sambaValidUsers: description: - Valid users or groups. type: str aliases: [ samba_valid_users ] sambaWriteList: description: - Restrict write access to these users/groups. type: str aliases: [ samba_write_list ] sambaWriteable: default: true description: - Samba write access. type: bool aliases: [ samba_writeable ] nfs_hosts: default: [] description: - Only allow access for this host, IP address or network. type: list elements: str nfsCustomSettings: default: [] description: - Option name in exports file. type: list elements: str aliases: [ nfs_custom_settings ] ''' EXAMPLES = ''' - name: Create a share named home on the server ucs.example.com with the path /home community.general.udm_share: name: home path: /home host: ucs.example.com sambaName: Home ''' RETURN = '''# ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.univention_umc import ( umc_module_for_add, umc_module_for_edit, ldap_search, base_dn, ) def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True, type='str'), ou=dict(required=True, type='str'), owner=dict(type='str', default='0'), group=dict(type='str', default='0'), path=dict(type='path'), directorymode=dict(type='str', default='00755'), host=dict(type='str'), root_squash=dict(type='bool', default=True), subtree_checking=dict(type='bool', default=True), sync=dict(type='str', default='sync'), writeable=dict(type='bool', default=True), sambaBlockSize=dict(type='str', aliases=['samba_block_size']), sambaBlockingLocks=dict(type='bool', aliases=['samba_blocking_locks'], default=True), sambaBrowseable=dict(type='bool', aliases=['samba_browsable'], default=True), sambaCreateMode=dict(type='str', aliases=['samba_create_mode'], default='0744'), sambaCscPolicy=dict(type='str', aliases=['samba_csc_policy'], default='manual'), sambaCustomSettings=dict(type='list', elements='dict', aliases=['samba_custom_settings'], default=[]), sambaDirectoryMode=dict(type='str', aliases=['samba_directory_mode'], default='0755'), sambaDirectorySecurityMode=dict(type='str', aliases=['samba_directory_security_mode'], default='0777'), sambaDosFilemode=dict(type='bool', aliases=['samba_dos_filemode'], default=False), sambaFakeOplocks=dict(type='bool', aliases=['samba_fake_oplocks'], default=False), sambaForceCreateMode=dict(type='bool', aliases=['samba_force_create_mode'], default=False), sambaForceDirectoryMode=dict(type='bool', aliases=['samba_force_directory_mode'], default=False), sambaForceDirectorySecurityMode=dict(type='bool', aliases=['samba_force_directory_security_mode'], default=False), sambaForceGroup=dict(type='str', aliases=['samba_force_group']), sambaForceSecurityMode=dict(type='bool', aliases=['samba_force_security_mode'], default=False), sambaForceUser=dict(type='str', aliases=['samba_force_user']), sambaHideFiles=dict(type='str', aliases=['samba_hide_files']), sambaHideUnreadable=dict(type='bool', aliases=['samba_hide_unreadable'], default=False), sambaHostsAllow=dict(type='list', elements='str', aliases=['samba_hosts_allow'], default=[]), sambaHostsDeny=dict(type='list', elements='str', aliases=['samba_hosts_deny'], default=[]), sambaInheritAcls=dict(type='bool', aliases=['samba_inherit_acls'], default=True), sambaInheritOwner=dict(type='bool', aliases=['samba_inherit_owner'], default=False), sambaInheritPermissions=dict(type='bool', aliases=['samba_inherit_permissions'], default=False), sambaInvalidUsers=dict(type='str', aliases=['samba_invalid_users']), sambaLevel2Oplocks=dict(type='bool', aliases=['samba_level_2_oplocks'], default=True), sambaLocking=dict(type='bool', aliases=['samba_locking'], default=True), sambaMSDFSRoot=dict(type='bool', aliases=['samba_msdfs_root'], default=False), sambaName=dict(type='str', aliases=['samba_name']), sambaNtAclSupport=dict(type='bool', aliases=['samba_nt_acl_support'], default=True), sambaOplocks=dict(type='bool', aliases=['samba_oplocks'], default=True), sambaPostexec=dict(type='str', aliases=['samba_postexec']), sambaPreexec=dict(type='str', aliases=['samba_preexec']), sambaPublic=dict(type='bool', aliases=['samba_public'], default=False), sambaSecurityMode=dict(type='str', aliases=['samba_security_mode'], default='0777'), sambaStrictLocking=dict(type='str', aliases=['samba_strict_locking'], default='Auto'), sambaVFSObjects=dict(type='str', aliases=['samba_vfs_objects']), sambaValidUsers=dict(type='str', aliases=['samba_valid_users']), sambaWriteList=dict(type='str', aliases=['samba_write_list']), sambaWriteable=dict(type='bool', aliases=['samba_writeable'], default=True), nfs_hosts=dict(type='list', elements='str', default=[]), nfsCustomSettings=dict(type='list', elements='str', aliases=['nfs_custom_settings'], default=[]), state=dict(default='present', choices=['present', 'absent'], type='str') ), supports_check_mode=True, required_if=([ ('state', 'present', ['path', 'host', 'sambaName']) ]) ) name = module.params['name'] state = module.params['state'] changed = False diff = None obj = list(ldap_search( '(&(objectClass=univentionShare)(cn={0}))'.format(name), attr=['cn'] )) exists = bool(len(obj)) container = 'cn=shares,ou={0},{1}'.format(module.params['ou'], base_dn()) dn = 'cn={0},{1}'.format(name, container) if state == 'present': try: if not exists: obj = umc_module_for_add('shares/share', container) else: obj = umc_module_for_edit('shares/share', dn) module.params['printablename'] = '{0} ({1})'.format(name, module.params['host']) for k in obj.keys(): if module.params[k] is True: module.params[k] = '1' elif module.params[k] is False: module.params[k] = '0' obj[k] = module.params[k] diff = obj.diff() if exists: for k in obj.keys(): if obj.hasChanged(k): changed = True else: changed = True if not module.check_mode: if not exists: obj.create() elif changed: obj.modify() except Exception as err: module.fail_json( msg='Creating/editing share {0} in {1} failed: {2}'.format( name, container, err, ) ) if state == 'absent' and exists: try: obj = umc_module_for_edit('shares/share', dn) if not module.check_mode: obj.remove() changed = True except Exception as err: module.fail_json( msg='Removing share {0} in {1} failed: {2}'.format( name, container, err, ) ) module.exit_json( changed=changed, name=name, diff=diff, container=container ) if __name__ == '__main__': main() PK $�!\_��� � K collections/ansible_collections/community/general/plugins/modules/matrix.pynu �[��� # coding: utf-8 # Copyright (c) 2018, Jan Christian Grünhage <jan.christian@gruenhage.xyz> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- author: "Jan Christian Grünhage (@jcgruenhage)" module: matrix short_description: Send notifications to matrix description: - This module sends html formatted notifications to matrix rooms. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: msg_plain: type: str description: - Plain text form of the message to send to matrix, usually markdown required: true msg_html: type: str description: - HTML form of the message to send to matrix required: true room_id: type: str description: - ID of the room to send the notification to required: true hs_url: type: str description: - URL of the homeserver, where the CS-API is reachable required: true token: type: str description: - Authentication token for the API call. If provided, user_id and password are not required user_id: type: str description: - The user id of the user password: type: str description: - The password to log in with requirements: - matrix-client (Python library) ''' EXAMPLES = ''' - name: Send matrix notification with token community.general.matrix: msg_plain: "**hello world**" msg_html: "<b>hello world</b>" room_id: "!12345678:server.tld" hs_url: "https://matrix.org" token: "{{ matrix_auth_token }}" - name: Send matrix notification with user_id and password community.general.matrix: msg_plain: "**hello world**" msg_html: "<b>hello world</b>" room_id: "!12345678:server.tld" hs_url: "https://matrix.org" user_id: "ansible_notification_bot" password: "{{ matrix_auth_password }}" ''' RETURN = ''' ''' import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib MATRIX_IMP_ERR = None try: from matrix_client.client import MatrixClient except ImportError: MATRIX_IMP_ERR = traceback.format_exc() matrix_found = False else: matrix_found = True def run_module(): module_args = dict( msg_plain=dict(type='str', required=True), msg_html=dict(type='str', required=True), room_id=dict(type='str', required=True), hs_url=dict(type='str', required=True), token=dict(type='str', required=False, no_log=True), user_id=dict(type='str', required=False), password=dict(type='str', required=False, no_log=True), ) result = dict( changed=False, message='' ) module = AnsibleModule( argument_spec=module_args, mutually_exclusive=[['password', 'token']], required_one_of=[['password', 'token']], required_together=[['user_id', 'password']], supports_check_mode=True ) if not matrix_found: module.fail_json(msg=missing_required_lib('matrix-client'), exception=MATRIX_IMP_ERR) if module.check_mode: return result # create a client object client = MatrixClient(module.params['hs_url']) if module.params['token'] is not None: client.api.token = module.params['token'] else: client.login(module.params['user_id'], module.params['password'], sync=False) # make sure we are in a given room and return a room object for it room = client.join_room(module.params['room_id']) # send an html formatted messages room.send_html(module.params['msg_html'], module.params['msg_plain']) module.exit_json(**result) def main(): run_module() if __name__ == '__main__': main() PK $�!\���1< < R collections/ansible_collections/community/general/plugins/modules/vexata_volume.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Sandeep Kasargod (sandeep@vexata.com) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: vexata_volume short_description: Manage volumes on Vexata VX100 storage arrays description: - Create, deletes or extend volumes on a Vexata VX100 array. author: - Sandeep Kasargod (@vexata) attributes: check_mode: support: full diff_mode: support: none options: name: description: - Volume name. required: true type: str state: description: - Creates/Modifies volume when present or removes when absent. default: present choices: [ present, absent ] type: str size: description: - Volume size in M, G, T units. M=2^20, G=2^30, T=2^40 bytes. type: str extends_documentation_fragment: - community.general.vexata.vx100 - community.general.attributes ''' EXAMPLES = r''' - name: Create new 2 TiB volume named foo community.general.vexata_volume: name: foo size: 2T state: present array: vx100_ultra.test.com user: admin password: secret - name: Expand volume named foo to 4 TiB community.general.vexata_volume: name: foo size: 4T state: present array: vx100_ultra.test.com user: admin password: secret - name: Delete volume named foo community.general.vexata_volume: name: foo state: absent array: vx100_ultra.test.com user: admin password: secret ''' RETURN = r''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.vexata import ( argument_spec, get_array, required_together, size_to_MiB) def get_volume(module, array): """Retrieve a named volume if it exists, None if absent.""" name = module.params['name'] try: vols = array.list_volumes() vol = filter(lambda v: v['name'] == name, vols) if len(vol) == 1: return vol[0] else: return None except Exception: module.fail_json(msg='Error while attempting to retrieve volumes.') def validate_size(module, err_msg): size = module.params.get('size', False) if not size: module.fail_json(msg=err_msg) size = size_to_MiB(size) if size <= 0: module.fail_json(msg='Invalid volume size, must be <integer>[MGT].') return size def create_volume(module, array): """"Create a new volume.""" changed = False size = validate_size(module, err_msg='Size is required to create volume.') if module.check_mode: module.exit_json(changed=changed) try: vol = array.create_volume( module.params['name'], 'Ansible volume', size) if vol: module.log(msg='Created volume {0}'.format(vol['id'])) changed = True else: module.fail_json(msg='Volume create failed.') except Exception: pass module.exit_json(changed=changed) def update_volume(module, array, volume): """Expand the volume size.""" changed = False size = validate_size(module, err_msg='Size is required to update volume') prev_size = volume['volSize'] if size <= prev_size: module.log(msg='Volume expanded size needs to be larger ' 'than current size.') if module.check_mode: module.exit_json(changed=changed) try: vol = array.grow_volume( volume['name'], volume['description'], volume['id'], size) if vol: changed = True except Exception: pass module.exit_json(changed=changed) def delete_volume(module, array, volume): changed = False vol_name = volume['name'] if module.check_mode: module.exit_json(changed=changed) try: ok = array.delete_volume( volume['id']) if ok: module.log(msg='Volume {0} deleted.'.format(vol_name)) changed = True else: raise Exception except Exception: pass module.exit_json(changed=changed) def main(): arg_spec = argument_spec() arg_spec.update( dict( name=dict(type='str', required=True), state=dict(default='present', choices=['present', 'absent']), size=dict(type='str') ) ) module = AnsibleModule(arg_spec, supports_check_mode=True, required_together=required_together()) state = module.params['state'] array = get_array(module) volume = get_volume(module, array) if state == 'present': if not volume: create_volume(module, array) else: update_volume(module, array, volume) elif state == 'absent' and volume: delete_volume(module, array, volume) else: module.exit_json(changed=False) if __name__ == '__main__': main() PK $�!\ϭ�K]l ]l R collections/ansible_collections/community/general/plugins/modules/homebrew_cask.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Daniel Jaouen <dcj24@cornell.edu> # Copyright (c) 2016, Indrajit Raychaudhuri <irc+code@indrajit.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: homebrew_cask author: - "Indrajit Raychaudhuri (@indrajitr)" - "Daniel Jaouen (@danieljaouen)" - "Enric Lluelles (@enriclluelles)" short_description: Install and uninstall homebrew casks description: - Manages Homebrew casks. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of cask to install or remove. aliases: [ 'cask', 'package', 'pkg' ] type: list elements: str path: description: - "':' separated list of paths to search for 'brew' executable." default: '/usr/local/bin:/opt/homebrew/bin' type: path state: description: - State of the cask. choices: [ 'absent', 'installed', 'latest', 'present', 'removed', 'uninstalled', 'upgraded' ] default: present type: str sudo_password: description: - The sudo password to be passed to SUDO_ASKPASS. required: false type: str update_homebrew: description: - Update homebrew itself first. - Note that C(brew cask update) is a synonym for C(brew update). type: bool default: false install_options: description: - Options flags to install a package. aliases: [ 'options' ] type: list elements: str accept_external_apps: description: - Allow external apps. type: bool default: false upgrade_all: description: - Upgrade all casks. - Mutually exclusive with C(upgraded) state. type: bool default: false aliases: [ 'upgrade' ] greedy: description: - Upgrade casks that auto update. - Passes C(--greedy) to C(brew outdated --cask) when checking if an installed cask has a newer version available, or to C(brew upgrade --cask) when upgrading all casks. type: bool default: false ''' EXAMPLES = ''' - name: Install cask community.general.homebrew_cask: name: alfred state: present - name: Remove cask community.general.homebrew_cask: name: alfred state: absent - name: Install cask with install options community.general.homebrew_cask: name: alfred state: present install_options: 'appdir=/Applications' - name: Install cask with install options community.general.homebrew_cask: name: alfred state: present install_options: 'debug,appdir=/Applications' - name: Install cask with force option community.general.homebrew_cask: name: alfred state: present install_options: force - name: Allow external app community.general.homebrew_cask: name: alfred state: present accept_external_apps: true - name: Remove cask with force option community.general.homebrew_cask: name: alfred state: absent install_options: force - name: Upgrade all casks community.general.homebrew_cask: upgrade_all: true - name: Upgrade all casks with greedy option community.general.homebrew_cask: upgrade_all: true greedy: true - name: Upgrade given cask with force option community.general.homebrew_cask: name: alfred state: upgraded install_options: force - name: Upgrade cask with greedy option community.general.homebrew_cask: name: 1password state: upgraded greedy: true - name: Using sudo password for installing cask community.general.homebrew_cask: name: wireshark state: present sudo_password: "{{ ansible_become_pass }}" ''' import os import re import tempfile from ansible_collections.community.general.plugins.module_utils.version import LooseVersion from ansible.module_utils.common.text.converters import to_bytes from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import iteritems, string_types # exceptions -------------------------------------------------------------- {{{ class HomebrewCaskException(Exception): pass # /exceptions ------------------------------------------------------------- }}} # utils ------------------------------------------------------------------- {{{ def _create_regex_group_complement(s): lines = (line.strip() for line in s.split('\n') if line.strip()) chars = filter(None, (line.split('#')[0].strip() for line in lines)) group = r'[^' + r''.join(chars) + r']' return re.compile(group) # /utils ------------------------------------------------------------------ }}} class HomebrewCask(object): '''A class to manage Homebrew casks.''' # class regexes ------------------------------------------------ {{{ VALID_PATH_CHARS = r''' \w # alphanumeric characters (i.e., [a-zA-Z0-9_]) \s # spaces : # colons {sep} # the OS-specific path separator . # dots \- # dashes '''.format(sep=os.path.sep) VALID_BREW_PATH_CHARS = r''' \w # alphanumeric characters (i.e., [a-zA-Z0-9_]) \s # spaces {sep} # the OS-specific path separator . # dots \- # dashes '''.format(sep=os.path.sep) VALID_CASK_CHARS = r''' \w # alphanumeric characters (i.e., [a-zA-Z0-9_]) . # dots / # slash (for taps) \- # dashes @ # at symbol ''' INVALID_PATH_REGEX = _create_regex_group_complement(VALID_PATH_CHARS) INVALID_BREW_PATH_REGEX = _create_regex_group_complement(VALID_BREW_PATH_CHARS) INVALID_CASK_REGEX = _create_regex_group_complement(VALID_CASK_CHARS) # /class regexes ----------------------------------------------- }}} # class validations -------------------------------------------- {{{ @classmethod def valid_path(cls, path): ''' `path` must be one of: - list of paths - a string containing only: - alphanumeric characters - dashes - dots - spaces - colons - os.path.sep ''' if isinstance(path, (string_types)): return not cls.INVALID_PATH_REGEX.search(path) try: iter(path) except TypeError: return False else: paths = path return all(cls.valid_brew_path(path_) for path_ in paths) @classmethod def valid_brew_path(cls, brew_path): ''' `brew_path` must be one of: - None - a string containing only: - alphanumeric characters - dashes - dots - spaces - os.path.sep ''' if brew_path is None: return True return ( isinstance(brew_path, string_types) and not cls.INVALID_BREW_PATH_REGEX.search(brew_path) ) @classmethod def valid_cask(cls, cask): '''A valid cask is either None or alphanumeric + backslashes.''' if cask is None: return True return ( isinstance(cask, string_types) and not cls.INVALID_CASK_REGEX.search(cask) ) @classmethod def valid_state(cls, state): ''' A valid state is one of: - installed - absent ''' if state is None: return True else: return ( isinstance(state, string_types) and state.lower() in ( 'installed', 'absent', ) ) @classmethod def valid_module(cls, module): '''A valid module is an instance of AnsibleModule.''' return isinstance(module, AnsibleModule) # /class validations ------------------------------------------- }}} # class properties --------------------------------------------- {{{ @property def module(self): return self._module @module.setter def module(self, module): if not self.valid_module(module): self._module = None self.failed = True self.message = 'Invalid module: {0}.'.format(module) raise HomebrewCaskException(self.message) else: self._module = module return module @property def path(self): return self._path @path.setter def path(self, path): if not self.valid_path(path): self._path = [] self.failed = True self.message = 'Invalid path: {0}.'.format(path) raise HomebrewCaskException(self.message) else: if isinstance(path, string_types): self._path = path.split(':') else: self._path = path return path @property def brew_path(self): return self._brew_path @brew_path.setter def brew_path(self, brew_path): if not self.valid_brew_path(brew_path): self._brew_path = None self.failed = True self.message = 'Invalid brew_path: {0}.'.format(brew_path) raise HomebrewCaskException(self.message) else: self._brew_path = brew_path return brew_path @property def params(self): return self._params @params.setter def params(self, params): self._params = self.module.params return self._params @property def current_cask(self): return self._current_cask @current_cask.setter def current_cask(self, cask): if not self.valid_cask(cask): self._current_cask = None self.failed = True self.message = 'Invalid cask: {0}.'.format(cask) raise HomebrewCaskException(self.message) else: self._current_cask = cask return cask @property def brew_version(self): try: return self._brew_version except AttributeError: return None @brew_version.setter def brew_version(self, brew_version): self._brew_version = brew_version # /class properties -------------------------------------------- }}} def __init__(self, module, path=path, casks=None, state=None, sudo_password=None, update_homebrew=False, install_options=None, accept_external_apps=False, upgrade_all=False, greedy=False): if not install_options: install_options = list() self._setup_status_vars() self._setup_instance_vars(module=module, path=path, casks=casks, state=state, sudo_password=sudo_password, update_homebrew=update_homebrew, install_options=install_options, accept_external_apps=accept_external_apps, upgrade_all=upgrade_all, greedy=greedy, ) self._prep() # prep --------------------------------------------------------- {{{ def _setup_status_vars(self): self.failed = False self.changed = False self.changed_count = 0 self.unchanged_count = 0 self.message = '' def _setup_instance_vars(self, **kwargs): for key, val in iteritems(kwargs): setattr(self, key, val) def _prep(self): self._prep_brew_path() def _prep_brew_path(self): if not self.module: self.brew_path = None self.failed = True self.message = 'AnsibleModule not set.' raise HomebrewCaskException(self.message) self.brew_path = self.module.get_bin_path( 'brew', required=True, opt_dirs=self.path, ) if not self.brew_path: self.brew_path = None self.failed = True self.message = 'Unable to locate homebrew executable.' raise HomebrewCaskException('Unable to locate homebrew executable.') return self.brew_path def _status(self): return (self.failed, self.changed, self.message) # /prep -------------------------------------------------------- }}} def run(self): try: self._run() except HomebrewCaskException: pass if not self.failed and (self.changed_count + self.unchanged_count > 1): self.message = "Changed: %d, Unchanged: %d" % ( self.changed_count, self.unchanged_count, ) (failed, changed, message) = self._status() return (failed, changed, message) # checks ------------------------------------------------------- {{{ def _current_cask_is_outdated(self): if not self.valid_cask(self.current_cask): return False if self._brew_cask_command_is_deprecated(): base_opts = [self.brew_path, 'outdated', '--cask'] else: base_opts = [self.brew_path, 'cask', 'outdated'] cask_is_outdated_command = base_opts + (['--greedy'] if self.greedy else []) + [self.current_cask] rc, out, err = self.module.run_command(cask_is_outdated_command) return out != "" def _current_cask_is_installed(self): if not self.valid_cask(self.current_cask): self.failed = True self.message = 'Invalid cask: {0}.'.format(self.current_cask) raise HomebrewCaskException(self.message) if self._brew_cask_command_is_deprecated(): base_opts = [self.brew_path, "list", "--cask"] else: base_opts = [self.brew_path, "cask", "list"] cmd = base_opts + [self.current_cask] rc, out, err = self.module.run_command(cmd) if rc == 0: return True else: return False def _get_brew_version(self): if self.brew_version: return self.brew_version cmd = [self.brew_path, '--version'] rc, out, err = self.module.run_command(cmd, check_rc=True) # get version string from first line of "brew --version" output version = out.split('\n')[0].split(' ')[1] self.brew_version = version return self.brew_version def _brew_cask_command_is_deprecated(self): # The `brew cask` replacements were fully available in 2.6.0 (https://brew.sh/2020/12/01/homebrew-2.6.0/) return LooseVersion(self._get_brew_version()) >= LooseVersion('2.6.0') # /checks ------------------------------------------------------ }}} # commands ----------------------------------------------------- {{{ def _run(self): if self.upgrade_all: return self._upgrade_all() if self.casks: if self.state == 'installed': return self._install_casks() elif self.state == 'upgraded': return self._upgrade_casks() elif self.state == 'absent': return self._uninstall_casks() self.failed = True self.message = "You must select a cask to install." raise HomebrewCaskException(self.message) # sudo_password fix ---------------------- {{{ def _run_command_with_sudo_password(self, cmd): rc, out, err = '', '', '' with tempfile.NamedTemporaryFile() as sudo_askpass_file: sudo_askpass_file.write(b"#!/bin/sh\n\necho '%s'\n" % to_bytes(self.sudo_password)) os.chmod(sudo_askpass_file.name, 0o700) sudo_askpass_file.file.close() rc, out, err = self.module.run_command( cmd, environ_update={'SUDO_ASKPASS': sudo_askpass_file.name} ) self.module.add_cleanup_file(sudo_askpass_file.name) return (rc, out, err) # /sudo_password fix --------------------- }}} # updated -------------------------------- {{{ def _update_homebrew(self): rc, out, err = self.module.run_command([ self.brew_path, 'update', ]) if rc == 0: if out and isinstance(out, string_types): already_updated = any( re.search(r'Already up-to-date.', s.strip(), re.IGNORECASE) for s in out.split('\n') if s ) if not already_updated: self.changed = True self.message = 'Homebrew updated successfully.' else: self.message = 'Homebrew already up-to-date.' return True else: self.failed = True self.message = err.strip() raise HomebrewCaskException(self.message) # /updated ------------------------------- }}} # _upgrade_all --------------------------- {{{ def _upgrade_all(self): if self.module.check_mode: self.changed = True self.message = 'Casks would be upgraded.' raise HomebrewCaskException(self.message) if self._brew_cask_command_is_deprecated(): cmd = [self.brew_path, 'upgrade', '--cask'] else: cmd = [self.brew_path, 'cask', 'upgrade'] if self.greedy: cmd = cmd + ['--greedy'] rc, out, err = '', '', '' if self.sudo_password: rc, out, err = self._run_command_with_sudo_password(cmd) else: rc, out, err = self.module.run_command(cmd) if rc == 0: if re.search(r'==> No Casks to upgrade', out.strip(), re.IGNORECASE): self.message = 'Homebrew casks already upgraded.' else: self.changed = True self.message = 'Homebrew casks upgraded.' return True else: self.failed = True self.message = err.strip() raise HomebrewCaskException(self.message) # /_upgrade_all -------------------------- }}} # installed ------------------------------ {{{ def _install_current_cask(self): if not self.valid_cask(self.current_cask): self.failed = True self.message = 'Invalid cask: {0}.'.format(self.current_cask) raise HomebrewCaskException(self.message) if '--force' not in self.install_options and self._current_cask_is_installed(): self.unchanged_count += 1 self.message = 'Cask already installed: {0}'.format( self.current_cask, ) return True if self.module.check_mode: self.changed = True self.message = 'Cask would be installed: {0}'.format( self.current_cask ) raise HomebrewCaskException(self.message) if self._brew_cask_command_is_deprecated(): base_opts = [self.brew_path, 'install', '--cask'] else: base_opts = [self.brew_path, 'cask', 'install'] opts = base_opts + [self.current_cask] + self.install_options cmd = [opt for opt in opts if opt] rc, out, err = '', '', '' if self.sudo_password: rc, out, err = self._run_command_with_sudo_password(cmd) else: rc, out, err = self.module.run_command(cmd) if self._current_cask_is_installed(): self.changed_count += 1 self.changed = True self.message = 'Cask installed: {0}'.format(self.current_cask) return True elif self.accept_external_apps and re.search(r"Error: It seems there is already an App at", err): self.unchanged_count += 1 self.message = 'Cask already installed: {0}'.format( self.current_cask, ) return True else: self.failed = True self.message = err.strip() raise HomebrewCaskException(self.message) def _install_casks(self): for cask in self.casks: self.current_cask = cask self._install_current_cask() return True # /installed ----------------------------- }}} # upgraded ------------------------------- {{{ def _upgrade_current_cask(self): command = 'upgrade' if not self.valid_cask(self.current_cask): self.failed = True self.message = 'Invalid cask: {0}.'.format(self.current_cask) raise HomebrewCaskException(self.message) if not self._current_cask_is_installed(): command = 'install' if self._current_cask_is_installed() and not self._current_cask_is_outdated(): self.message = 'Cask is already upgraded: {0}'.format( self.current_cask, ) self.unchanged_count += 1 return True if self.module.check_mode: self.changed = True self.message = 'Cask would be upgraded: {0}'.format( self.current_cask ) raise HomebrewCaskException(self.message) if self._brew_cask_command_is_deprecated(): base_opts = [self.brew_path, command, '--cask'] else: base_opts = [self.brew_path, 'cask', command] opts = base_opts + self.install_options + [self.current_cask] cmd = [opt for opt in opts if opt] rc, out, err = '', '', '' if self.sudo_password: rc, out, err = self._run_command_with_sudo_password(cmd) else: rc, out, err = self.module.run_command(cmd) if self._current_cask_is_installed() and not self._current_cask_is_outdated(): self.changed_count += 1 self.changed = True self.message = 'Cask upgraded: {0}'.format(self.current_cask) return True else: self.failed = True self.message = err.strip() raise HomebrewCaskException(self.message) def _upgrade_casks(self): for cask in self.casks: self.current_cask = cask self._upgrade_current_cask() return True # /upgraded ------------------------------ }}} # uninstalled ---------------------------- {{{ def _uninstall_current_cask(self): if not self.valid_cask(self.current_cask): self.failed = True self.message = 'Invalid cask: {0}.'.format(self.current_cask) raise HomebrewCaskException(self.message) if not self._current_cask_is_installed(): self.unchanged_count += 1 self.message = 'Cask already uninstalled: {0}'.format( self.current_cask, ) return True if self.module.check_mode: self.changed = True self.message = 'Cask would be uninstalled: {0}'.format( self.current_cask ) raise HomebrewCaskException(self.message) if self._brew_cask_command_is_deprecated(): base_opts = [self.brew_path, 'uninstall', '--cask'] else: base_opts = [self.brew_path, 'cask', 'uninstall'] opts = base_opts + [self.current_cask] + self.install_options cmd = [opt for opt in opts if opt] rc, out, err = '', '', '' if self.sudo_password: rc, out, err = self._run_command_with_sudo_password(cmd) else: rc, out, err = self.module.run_command(cmd) if not self._current_cask_is_installed(): self.changed_count += 1 self.changed = True self.message = 'Cask uninstalled: {0}'.format(self.current_cask) return True else: self.failed = True self.message = err.strip() raise HomebrewCaskException(self.message) def _uninstall_casks(self): for cask in self.casks: self.current_cask = cask self._uninstall_current_cask() return True # /uninstalled --------------------------- }}} # /commands ---------------------------------------------------- }}} def main(): module = AnsibleModule( argument_spec=dict( name=dict( aliases=["pkg", "package", "cask"], required=False, type='list', elements='str', ), path=dict( default="/usr/local/bin:/opt/homebrew/bin", required=False, type='path', ), state=dict( default="present", choices=[ "present", "installed", "latest", "upgraded", "absent", "removed", "uninstalled", ], ), sudo_password=dict( type="str", required=False, no_log=True, ), update_homebrew=dict( default=False, type='bool', ), install_options=dict( default=None, aliases=['options'], type='list', elements='str', ), accept_external_apps=dict( default=False, type='bool', ), upgrade_all=dict( default=False, aliases=["upgrade"], type='bool', ), greedy=dict( default=False, type='bool', ), ), supports_check_mode=True, ) module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C') p = module.params if p['name']: casks = p['name'] else: casks = None path = p['path'] if path: path = path.split(':') state = p['state'] if state in ('present', 'installed'): state = 'installed' if state in ('latest', 'upgraded'): state = 'upgraded' if state in ('absent', 'removed', 'uninstalled'): state = 'absent' sudo_password = p['sudo_password'] update_homebrew = p['update_homebrew'] upgrade_all = p['upgrade_all'] greedy = p['greedy'] p['install_options'] = p['install_options'] or [] install_options = ['--{0}'.format(install_option) for install_option in p['install_options']] accept_external_apps = p['accept_external_apps'] brew_cask = HomebrewCask(module=module, path=path, casks=casks, state=state, sudo_password=sudo_password, update_homebrew=update_homebrew, install_options=install_options, accept_external_apps=accept_external_apps, upgrade_all=upgrade_all, greedy=greedy, ) (failed, changed, message) = brew_cask.run() if failed: module.fail_json(msg=message) else: module.exit_json(changed=changed, msg=message) if __name__ == '__main__': main() PK $�!\q��� � Y collections/ansible_collections/community/general/plugins/modules/rax_mon_notification.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: rax_mon_notification short_description: Create or delete a Rackspace Cloud Monitoring notification description: - Create or delete a Rackspace Cloud Monitoring notification that specifies a channel that can be used to communicate alarms, such as email, webhooks, or PagerDuty. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> *rax_mon_notification* -> rax_mon_notification_plan -> rax_mon_alarm attributes: check_mode: support: none diff_mode: support: none options: state: type: str description: - Ensure that the notification with this O(label) exists or does not exist. choices: ['present', 'absent'] default: present label: type: str description: - Defines a friendly name for this notification. String between 1 and 255 characters long. required: true notification_type: type: str description: - A supported notification type. choices: ["webhook", "email", "pagerduty"] required: true details: type: dict description: - Dictionary of key-value pairs used to initialize the notification. Required keys and meanings vary with notification type. See http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/ service-notification-types-crud.html for details. required: true author: Ash Wilson (@smashwilson) extends_documentation_fragment: - community.general.rackspace.openstack - community.general.attributes ''' EXAMPLES = ''' - name: Monitoring notification example gather_facts: false hosts: local connection: local tasks: - name: Email me when something goes wrong. rax_mon_entity: credentials: ~/.rax_pub label: omg type: email details: address: me@mailhost.com register: the_notification ''' try: import pyrax HAS_PYRAX = True except ImportError: HAS_PYRAX = False from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.rax import rax_argument_spec, rax_required_together, setup_rax_module def notification(module, state, label, notification_type, details): if len(label) < 1 or len(label) > 255: module.fail_json(msg='label must be between 1 and 255 characters long') changed = False notification = None cm = pyrax.cloud_monitoring if not cm: module.fail_json(msg='Failed to instantiate client. This typically ' 'indicates an invalid region or an incorrectly ' 'capitalized region name.') existing = [] for n in cm.list_notifications(): if n.label == label: existing.append(n) if existing: notification = existing[0] if state == 'present': should_update = False should_delete = False should_create = False if len(existing) > 1: module.fail_json(msg='%s existing notifications are labelled %s.' % (len(existing), label)) if notification: should_delete = (notification_type != notification.type) should_update = (details != notification.details) if should_update and not should_delete: notification.update(details=notification.details) changed = True if should_delete: notification.delete() else: should_create = True if should_create: notification = cm.create_notification(notification_type, label=label, details=details) changed = True else: for n in existing: n.delete() changed = True if notification: notification_dict = { "id": notification.id, "type": notification.type, "label": notification.label, "details": notification.details } module.exit_json(changed=changed, notification=notification_dict) else: module.exit_json(changed=changed) def main(): argument_spec = rax_argument_spec() argument_spec.update( dict( state=dict(default='present', choices=['present', 'absent']), label=dict(required=True), notification_type=dict(required=True, choices=['webhook', 'email', 'pagerduty']), details=dict(required=True, type='dict') ) ) module = AnsibleModule( argument_spec=argument_spec, required_together=rax_required_together() ) if not HAS_PYRAX: module.fail_json(msg='pyrax is required for this module') state = module.params.get('state') label = module.params.get('label') notification_type = module.params.get('notification_type') details = module.params.get('details') setup_rax_module(module, pyrax) notification(module, state, label, notification_type, details) if __name__ == '__main__': main() PK $�!\aë�} �} S collections/ansible_collections/community/general/plugins/modules/maven_artifact.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2014, Chris Schmidt <chris.schmidt () contrastsecurity.com> # # Built using https://github.com/hamnis/useful-scripts/blob/master/python/download-maven-artifact # as a reference and starting point. # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: maven_artifact short_description: Downloads an Artifact from a Maven Repository description: - Downloads an artifact from a maven repository given the maven coordinates provided to the module. - Can retrieve snapshots or release versions of the artifact and will resolve the latest available version if one is not available. author: "Chris Schmidt (@chrisisbeef)" requirements: - lxml - boto if using a S3 repository (s3://...) attributes: check_mode: support: none diff_mode: support: none options: group_id: type: str description: - The Maven groupId coordinate required: true artifact_id: type: str description: - The maven artifactId coordinate required: true version: type: str description: - The maven version coordinate - Mutually exclusive with O(version_by_spec). version_by_spec: type: str description: - The maven dependency version ranges. - See supported version ranges on U(https://cwiki.apache.org/confluence/display/MAVENOLD/Dependency+Mediation+and+Conflict+Resolution) - The range type "(,1.0],[1.2,)" and "(,1.1),(1.1,)" is not supported. - Mutually exclusive with O(version). version_added: '0.2.0' classifier: type: str description: - The maven classifier coordinate default: '' extension: type: str description: - The maven type/extension coordinate default: jar repository_url: type: str description: - The URL of the Maven Repository to download from. - Use s3://... if the repository is hosted on Amazon S3, added in version 2.2. - Use file://... if the repository is local, added in version 2.6 default: https://repo1.maven.org/maven2 username: type: str description: - The username to authenticate as to the Maven Repository. Use AWS secret key of the repository is hosted on S3 aliases: [ "aws_secret_key" ] password: type: str description: - The password to authenticate with to the Maven Repository. Use AWS secret access key of the repository is hosted on S3 aliases: [ "aws_secret_access_key" ] headers: description: - Add custom HTTP headers to a request in hash/dict format. type: dict force_basic_auth: description: - httplib2, the library used by the uri module only sends authentication information when a webservice responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request. default: false type: bool version_added: '0.2.0' dest: type: path description: - The path where the artifact should be written to - If file mode or ownerships are specified and destination path already exists, they affect the downloaded file required: true state: type: str description: - The desired state of the artifact default: present choices: [present,absent] timeout: type: int description: - Specifies a timeout in seconds for the connection attempt default: 10 validate_certs: description: - If V(false), SSL certificates will not be validated. This should only be set to V(false) when no other option exists. type: bool default: true client_cert: description: - PEM formatted certificate chain file to be used for SSL client authentication. - This file can also include the key as well, and if the key is included, O(client_key) is not required. type: path version_added: '1.3.0' client_key: description: - PEM formatted file that contains your private key to be used for SSL client authentication. - If O(client_cert) contains both the certificate and key, this option is not required. type: path version_added: '1.3.0' keep_name: description: - If V(true), the downloaded artifact's name is preserved, i.e the version number remains part of it. - This option only has effect when O(dest) is a directory and O(version) is set to V(latest) or O(version_by_spec) is defined. type: bool default: false verify_checksum: type: str description: - If V(never), the MD5/SHA1 checksum will never be downloaded and verified. - If V(download), the MD5/SHA1 checksum will be downloaded and verified only after artifact download. This is the default. - If V(change), the MD5/SHA1 checksum will be downloaded and verified if the destination already exist, to verify if they are identical. This was the behaviour before 2.6. Since it downloads the checksum before (maybe) downloading the artifact, and since some repository software, when acting as a proxy/cache, return a 404 error if the artifact has not been cached yet, it may fail unexpectedly. If you still need it, you should consider using V(always) instead - if you deal with a checksum, it is better to use it to verify integrity after download. - V(always) combines V(download) and V(change). required: false default: 'download' choices: ['never', 'download', 'change', 'always'] checksum_alg: type: str description: - If V(md5), checksums will use the MD5 algorithm. This is the default. - If V(sha1), checksums will use the SHA1 algorithm. This can be used on systems configured to use FIPS-compliant algorithms, since MD5 will be blocked on such systems. default: 'md5' choices: ['md5', 'sha1'] version_added: 3.2.0 unredirected_headers: type: list elements: str version_added: 5.2.0 description: - A list of headers that should not be included in the redirection. This headers are sent to the C(fetch_url) function. - On ansible-core version 2.12 or later, the default of this option is V([Authorization, Cookie]). - Useful if the redirection URL does not need to have sensitive headers in the request. - Requires ansible-core version 2.12 or later. directory_mode: type: str description: - Filesystem permission mode applied recursively to O(dest) when it is a directory. extends_documentation_fragment: - ansible.builtin.files - community.general.attributes ''' EXAMPLES = ''' - name: Download the latest version of the JUnit framework artifact from Maven Central community.general.maven_artifact: group_id: junit artifact_id: junit dest: /tmp/junit-latest.jar - name: Download JUnit 4.11 from Maven Central community.general.maven_artifact: group_id: junit artifact_id: junit version: 4.11 dest: /tmp/junit-4.11.jar - name: Download an artifact from a private repository requiring authentication community.general.maven_artifact: group_id: com.company artifact_id: library-name repository_url: 'https://repo.company.com/maven' username: user password: pass dest: /tmp/library-name-latest.jar - name: Download an artifact from a private repository requiring certificate authentication community.general.maven_artifact: group_id: com.company artifact_id: library-name repository_url: 'https://repo.company.com/maven' client_cert: /path/to/cert.pem client_key: /path/to/key.pem dest: /tmp/library-name-latest.jar - name: Download a WAR File to the Tomcat webapps directory to be deployed community.general.maven_artifact: group_id: com.company artifact_id: web-app extension: war repository_url: 'https://repo.company.com/maven' dest: /var/lib/tomcat7/webapps/web-app.war - name: Keep a downloaded artifact's name, i.e. retain the version community.general.maven_artifact: version: latest artifact_id: spring-core group_id: org.springframework dest: /tmp/ keep_name: true - name: Download the latest version of the JUnit framework artifact from Maven local community.general.maven_artifact: group_id: junit artifact_id: junit dest: /tmp/junit-latest.jar repository_url: "file://{{ lookup('env','HOME') }}/.m2/repository" - name: Download the latest version between 3.8 and 4.0 (exclusive) of the JUnit framework artifact from Maven Central community.general.maven_artifact: group_id: junit artifact_id: junit version_by_spec: "[3.8,4.0)" dest: /tmp/ ''' import hashlib import os import posixpath import shutil import io import tempfile import traceback import re from ansible_collections.community.general.plugins.module_utils.version import LooseVersion from ansible.module_utils.ansible_release import __version__ as ansible_version from re import match LXML_ETREE_IMP_ERR = None try: from lxml import etree HAS_LXML_ETREE = True except ImportError: LXML_ETREE_IMP_ERR = traceback.format_exc() HAS_LXML_ETREE = False BOTO_IMP_ERR = None try: import boto3 HAS_BOTO = True except ImportError: BOTO_IMP_ERR = traceback.format_exc() HAS_BOTO = False SEMANTIC_VERSION_IMP_ERR = None try: from semantic_version import Version, Spec HAS_SEMANTIC_VERSION = True except ImportError: SEMANTIC_VERSION_IMP_ERR = traceback.format_exc() HAS_SEMANTIC_VERSION = False from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.six.moves.urllib.parse import urlparse from ansible.module_utils.urls import fetch_url from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text def split_pre_existing_dir(dirname): ''' Return the first pre-existing directory and a list of the new directories that will be created. ''' head, tail = os.path.split(dirname) b_head = to_bytes(head, errors='surrogate_or_strict') if not os.path.exists(b_head): if head == dirname: return None, [head] else: (pre_existing_dir, new_directory_list) = split_pre_existing_dir(head) else: return head, [tail] new_directory_list.append(tail) return pre_existing_dir, new_directory_list def adjust_recursive_directory_permissions(pre_existing_dir, new_directory_list, module, directory_args, changed): ''' Walk the new directories list and make sure that permissions are as we would expect ''' if new_directory_list: first_sub_dir = new_directory_list.pop(0) if not pre_existing_dir: working_dir = first_sub_dir else: working_dir = os.path.join(pre_existing_dir, first_sub_dir) directory_args['path'] = working_dir changed = module.set_fs_attributes_if_different(directory_args, changed) changed = adjust_recursive_directory_permissions(working_dir, new_directory_list, module, directory_args, changed) return changed class Artifact(object): def __init__(self, group_id, artifact_id, version, version_by_spec, classifier='', extension='jar'): if not group_id: raise ValueError("group_id must be set") if not artifact_id: raise ValueError("artifact_id must be set") self.group_id = group_id self.artifact_id = artifact_id self.version = version self.version_by_spec = version_by_spec self.classifier = classifier if not extension: self.extension = "jar" else: self.extension = extension def is_snapshot(self): return self.version and self.version.endswith("SNAPSHOT") def path(self, with_version=True): base = posixpath.join(self.group_id.replace(".", "/"), self.artifact_id) if with_version and self.version: timestamp_version_match = re.match("^(.*-)?([0-9]{8}\\.[0-9]{6}-[0-9]+)$", self.version) if timestamp_version_match: base = posixpath.join(base, timestamp_version_match.group(1) + "SNAPSHOT") else: base = posixpath.join(base, self.version) return base def _generate_filename(self): filename = self.artifact_id + "-" + self.classifier + "." + self.extension if not self.classifier: filename = self.artifact_id + "." + self.extension return filename def get_filename(self, filename=None): if not filename: filename = self._generate_filename() elif os.path.isdir(filename): filename = os.path.join(filename, self._generate_filename()) return filename def __str__(self): result = "%s:%s:%s" % (self.group_id, self.artifact_id, self.version) if self.classifier: result = "%s:%s:%s:%s:%s" % (self.group_id, self.artifact_id, self.extension, self.classifier, self.version) elif self.extension != "jar": result = "%s:%s:%s:%s" % (self.group_id, self.artifact_id, self.extension, self.version) return result @staticmethod def parse(input): parts = input.split(":") if len(parts) >= 3: g = parts[0] a = parts[1] v = parts[-1] t = None c = None if len(parts) == 4: t = parts[2] if len(parts) == 5: t = parts[2] c = parts[3] return Artifact(g, a, v, c, t) else: return None class MavenDownloader: def __init__(self, module, base, local=False, headers=None): self.module = module if base.endswith("/"): base = base.rstrip("/") self.base = base self.local = local self.headers = headers self.user_agent = "Ansible {0} maven_artifact".format(ansible_version) self.latest_version_found = None self.metadata_file_name = "maven-metadata-local.xml" if local else "maven-metadata.xml" def find_version_by_spec(self, artifact): path = "/%s/%s" % (artifact.path(False), self.metadata_file_name) content = self._getContent(self.base + path, "Failed to retrieve the maven metadata file: " + path) xml = etree.fromstring(content) original_versions = xml.xpath("/metadata/versioning/versions/version/text()") versions = [] for version in original_versions: try: versions.append(Version.coerce(version)) except ValueError: # This means that version string is not a valid semantic versioning pass parse_versions_syntax = { # example -> (,1.0] r"^\(,(?P<upper_bound>[0-9.]*)]$": "<={upper_bound}", # example -> 1.0 r"^(?P<version>[0-9.]*)$": "~={version}", # example -> [1.0] r"^\[(?P<version>[0-9.]*)\]$": "=={version}", # example -> [1.2, 1.3] r"^\[(?P<lower_bound>[0-9.]*),\s*(?P<upper_bound>[0-9.]*)\]$": ">={lower_bound},<={upper_bound}", # example -> [1.2, 1.3) r"^\[(?P<lower_bound>[0-9.]*),\s*(?P<upper_bound>[0-9.]+)\)$": ">={lower_bound},<{upper_bound}", # example -> [1.5,) r"^\[(?P<lower_bound>[0-9.]*),\)$": ">={lower_bound}", } for regex, spec_format in parse_versions_syntax.items(): regex_result = match(regex, artifact.version_by_spec) if regex_result: spec = Spec(spec_format.format(**regex_result.groupdict())) selected_version = spec.select(versions) if not selected_version: raise ValueError("No version found with this spec version: {0}".format(artifact.version_by_spec)) # To deal when repos on maven don't have patch number on first build (e.g. 3.8 instead of 3.8.0) if str(selected_version) not in original_versions: selected_version.patch = None return str(selected_version) raise ValueError("The spec version {0} is not supported! ".format(artifact.version_by_spec)) def find_latest_version_available(self, artifact): if self.latest_version_found: return self.latest_version_found path = "/%s/%s" % (artifact.path(False), self.metadata_file_name) content = self._getContent(self.base + path, "Failed to retrieve the maven metadata file: " + path) xml = etree.fromstring(content) v = xml.xpath("/metadata/versioning/versions/version[last()]/text()") if v: self.latest_version_found = v[0] return v[0] def find_uri_for_artifact(self, artifact): if artifact.version_by_spec: artifact.version = self.find_version_by_spec(artifact) if artifact.version == "latest": artifact.version = self.find_latest_version_available(artifact) if artifact.is_snapshot(): if self.local: return self._uri_for_artifact(artifact, artifact.version) path = "/%s/%s" % (artifact.path(), self.metadata_file_name) content = self._getContent(self.base + path, "Failed to retrieve the maven metadata file: " + path) xml = etree.fromstring(content) for snapshotArtifact in xml.xpath("/metadata/versioning/snapshotVersions/snapshotVersion"): classifier = snapshotArtifact.xpath("classifier/text()") artifact_classifier = classifier[0] if classifier else '' extension = snapshotArtifact.xpath("extension/text()") artifact_extension = extension[0] if extension else '' if artifact_classifier == artifact.classifier and artifact_extension == artifact.extension: return self._uri_for_artifact(artifact, snapshotArtifact.xpath("value/text()")[0]) timestamp_xmlpath = xml.xpath("/metadata/versioning/snapshot/timestamp/text()") if timestamp_xmlpath: timestamp = timestamp_xmlpath[0] build_number = xml.xpath("/metadata/versioning/snapshot/buildNumber/text()")[0] return self._uri_for_artifact(artifact, artifact.version.replace("SNAPSHOT", timestamp + "-" + build_number)) return self._uri_for_artifact(artifact, artifact.version) def _uri_for_artifact(self, artifact, version=None): if artifact.is_snapshot() and not version: raise ValueError("Expected uniqueversion for snapshot artifact " + str(artifact)) elif not artifact.is_snapshot(): version = artifact.version if artifact.classifier: return posixpath.join(self.base, artifact.path(), artifact.artifact_id + "-" + version + "-" + artifact.classifier + "." + artifact.extension) return posixpath.join(self.base, artifact.path(), artifact.artifact_id + "-" + version + "." + artifact.extension) # for small files, directly get the full content def _getContent(self, url, failmsg, force=True): if self.local: parsed_url = urlparse(url) if os.path.isfile(parsed_url.path): with io.open(parsed_url.path, 'rb') as f: return f.read() if force: raise ValueError(failmsg + " because can not find file: " + url) return None response = self._request(url, failmsg, force) if response: return response.read() return None # only for HTTP request def _request(self, url, failmsg, force=True): url_to_use = url parsed_url = urlparse(url) if parsed_url.scheme == 's3': parsed_url = urlparse(url) bucket_name = parsed_url.netloc key_name = parsed_url.path[1:] client = boto3.client('s3', aws_access_key_id=self.module.params.get('username', ''), aws_secret_access_key=self.module.params.get('password', '')) url_to_use = client.generate_presigned_url('get_object', Params={'Bucket': bucket_name, 'Key': key_name}, ExpiresIn=10) req_timeout = self.module.params.get('timeout') # Hack to add parameters in the way that fetch_url expects self.module.params['url_username'] = self.module.params.get('username', '') self.module.params['url_password'] = self.module.params.get('password', '') self.module.params['http_agent'] = self.user_agent kwargs = {} if self.module.params['unredirected_headers']: kwargs['unredirected_headers'] = self.module.params['unredirected_headers'] response, info = fetch_url( self.module, url_to_use, timeout=req_timeout, headers=self.headers, **kwargs ) if info['status'] == 200: return response if force: raise ValueError(failmsg + " because of " + info['msg'] + "for URL " + url_to_use) return None def download(self, tmpdir, artifact, verify_download, filename=None, checksum_alg='md5'): if (not artifact.version and not artifact.version_by_spec) or artifact.version == "latest": artifact = Artifact(artifact.group_id, artifact.artifact_id, self.find_latest_version_available(artifact), None, artifact.classifier, artifact.extension) url = self.find_uri_for_artifact(artifact) tempfd, tempname = tempfile.mkstemp(dir=tmpdir) try: # copy to temp file if self.local: parsed_url = urlparse(url) if os.path.isfile(parsed_url.path): shutil.copy2(parsed_url.path, tempname) else: return "Can not find local file: " + parsed_url.path else: response = self._request(url, "Failed to download artifact " + str(artifact)) with os.fdopen(tempfd, 'wb') as f: shutil.copyfileobj(response, f) if verify_download: invalid_checksum = self.is_invalid_checksum(tempname, url, checksum_alg) if invalid_checksum: # if verify_change was set, the previous file would be deleted os.remove(tempname) return invalid_checksum except Exception as e: os.remove(tempname) raise e # all good, now copy temp file to target shutil.move(tempname, artifact.get_filename(filename)) return None def is_invalid_checksum(self, file, remote_url, checksum_alg='md5'): if os.path.exists(file): local_checksum = self._local_checksum(checksum_alg, file) if self.local: parsed_url = urlparse(remote_url) remote_checksum = self._local_checksum(checksum_alg, parsed_url.path) else: try: remote_checksum = to_text(self._getContent(remote_url + '.' + checksum_alg, "Failed to retrieve checksum", False), errors='strict') except UnicodeError as e: return "Cannot retrieve a valid %s checksum from %s: %s" % (checksum_alg, remote_url, to_native(e)) if not remote_checksum: return "Cannot find %s checksum from %s" % (checksum_alg, remote_url) try: # Check if remote checksum only contains md5/sha1 or md5/sha1 + filename _remote_checksum = remote_checksum.split(None, 1)[0] remote_checksum = _remote_checksum # remote_checksum is empty so we continue and keep original checksum string # This should not happen since we check for remote_checksum before except IndexError: pass if local_checksum.lower() == remote_checksum.lower(): return None else: return "Checksum does not match: we computed " + local_checksum + " but the repository states " + remote_checksum return "Path does not exist: " + file def _local_checksum(self, checksum_alg, file): if checksum_alg.lower() == 'md5': hash = hashlib.md5() elif checksum_alg.lower() == 'sha1': hash = hashlib.sha1() else: raise ValueError("Unknown checksum_alg %s" % checksum_alg) with io.open(file, 'rb') as f: for chunk in iter(lambda: f.read(8192), b''): hash.update(chunk) return hash.hexdigest() def main(): module = AnsibleModule( argument_spec=dict( group_id=dict(required=True), artifact_id=dict(required=True), version=dict(default=None), version_by_spec=dict(default=None), classifier=dict(default=''), extension=dict(default='jar'), repository_url=dict(default='https://repo1.maven.org/maven2'), username=dict(default=None, aliases=['aws_secret_key']), password=dict(default=None, no_log=True, aliases=['aws_secret_access_key']), headers=dict(type='dict'), force_basic_auth=dict(default=False, type='bool'), state=dict(default="present", choices=["present", "absent"]), # TODO - Implement a "latest" state timeout=dict(default=10, type='int'), dest=dict(type="path", required=True), validate_certs=dict(required=False, default=True, type='bool'), client_cert=dict(type="path", required=False), client_key=dict(type="path", required=False), keep_name=dict(required=False, default=False, type='bool'), verify_checksum=dict(required=False, default='download', choices=['never', 'download', 'change', 'always']), checksum_alg=dict(required=False, default='md5', choices=['md5', 'sha1']), unredirected_headers=dict(type='list', elements='str', required=False), directory_mode=dict(type='str'), ), add_file_common_args=True, mutually_exclusive=([('version', 'version_by_spec')]) ) if LooseVersion(ansible_version) < LooseVersion("2.12") and module.params['unredirected_headers']: module.fail_json(msg="Unredirected Headers parameter provided, but your ansible-core version does not support it. Minimum version is 2.12") if LooseVersion(ansible_version) >= LooseVersion("2.12") and module.params['unredirected_headers'] is None: # if the user did not supply unredirected params, we use the default, ONLY on ansible core 2.12 and above module.params['unredirected_headers'] = ['Authorization', 'Cookie'] if not HAS_LXML_ETREE: module.fail_json(msg=missing_required_lib('lxml'), exception=LXML_ETREE_IMP_ERR) if module.params['version_by_spec'] and not HAS_SEMANTIC_VERSION: module.fail_json(msg=missing_required_lib('semantic_version'), exception=SEMANTIC_VERSION_IMP_ERR) repository_url = module.params["repository_url"] if not repository_url: repository_url = "https://repo1.maven.org/maven2" try: parsed_url = urlparse(repository_url) except AttributeError as e: module.fail_json(msg='url parsing went wrong %s' % e) local = parsed_url.scheme == "file" if parsed_url.scheme == 's3' and not HAS_BOTO: module.fail_json(msg=missing_required_lib('boto3', reason='when using s3:// repository URLs'), exception=BOTO_IMP_ERR) group_id = module.params["group_id"] artifact_id = module.params["artifact_id"] version = module.params["version"] version_by_spec = module.params["version_by_spec"] classifier = module.params["classifier"] extension = module.params["extension"] headers = module.params['headers'] state = module.params["state"] dest = module.params["dest"] b_dest = to_bytes(dest, errors='surrogate_or_strict') keep_name = module.params["keep_name"] verify_checksum = module.params["verify_checksum"] verify_download = verify_checksum in ['download', 'always'] verify_change = verify_checksum in ['change', 'always'] checksum_alg = module.params["checksum_alg"] downloader = MavenDownloader(module, repository_url, local, headers) if not version_by_spec and not version: version = "latest" try: artifact = Artifact(group_id, artifact_id, version, version_by_spec, classifier, extension) except ValueError as e: module.fail_json(msg=e.args[0]) changed = False prev_state = "absent" if dest.endswith(os.sep): b_dest = to_bytes(dest, errors='surrogate_or_strict') if not os.path.exists(b_dest): (pre_existing_dir, new_directory_list) = split_pre_existing_dir(dest) os.makedirs(b_dest) directory_args = module.load_file_common_arguments(module.params) directory_mode = module.params["directory_mode"] if directory_mode is not None: directory_args['mode'] = directory_mode else: directory_args['mode'] = None changed = adjust_recursive_directory_permissions(pre_existing_dir, new_directory_list, module, directory_args, changed) if os.path.isdir(b_dest): version_part = version if version == 'latest': version_part = downloader.find_latest_version_available(artifact) elif version_by_spec: version_part = downloader.find_version_by_spec(artifact) filename = "{artifact_id}{version_part}{classifier}.{extension}".format( artifact_id=artifact_id, version_part="-{0}".format(version_part) if keep_name else "", classifier="-{0}".format(classifier) if classifier else "", extension=extension ) dest = posixpath.join(dest, filename) b_dest = to_bytes(dest, errors='surrogate_or_strict') if os.path.lexists(b_dest) and ((not verify_change) or not downloader.is_invalid_checksum(dest, downloader.find_uri_for_artifact(artifact), checksum_alg)): prev_state = "present" if prev_state == "absent": try: download_error = downloader.download(module.tmpdir, artifact, verify_download, b_dest, checksum_alg) if download_error is None: changed = True else: module.fail_json(msg="Cannot retrieve the artifact to destination: " + download_error) except ValueError as e: module.fail_json(msg=e.args[0]) file_args = module.load_file_common_arguments(module.params, path=dest) changed = module.set_fs_attributes_if_different(file_args, changed) if changed: module.exit_json(state=state, dest=dest, group_id=group_id, artifact_id=artifact_id, version=version, classifier=classifier, extension=extension, repository_url=repository_url, changed=changed) else: module.exit_json(state=state, dest=dest, changed=changed) if __name__ == '__main__': main() PK $�!\�sBp8 8 M collections/ansible_collections/community/general/plugins/modules/ipa_user.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_user author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA users description: - Add, modify and delete user within IPA server. attributes: check_mode: support: full diff_mode: support: none options: displayname: description: Display name. type: str update_password: description: - Set password for a user. type: str default: 'always' choices: [ always, on_create ] givenname: description: - First name. - If user does not exist and O(state=present), the usage of O(givenname) is required. type: str krbpasswordexpiration: description: - Date at which the user password will expire. - In the format YYYYMMddHHmmss. - e.g. 20180121182022 will expire on 21 January 2018 at 18:20:22. type: str loginshell: description: Login shell. type: str mail: description: - List of mail addresses assigned to the user. - If an empty list is passed all assigned email addresses will be deleted. - If None is passed email addresses will not be checked or changed. type: list elements: str password: description: - Password for a user. - Will not be set for an existing user unless O(update_password=always), which is the default. type: str sn: description: - Surname. - If user does not exist and O(state=present), the usage of O(sn) is required. type: str sshpubkey: description: - List of public SSH key. - If an empty list is passed all assigned public keys will be deleted. - If None is passed SSH public keys will not be checked or changed. type: list elements: str state: description: State to ensure. default: "present" choices: ["absent", "disabled", "enabled", "present"] type: str telephonenumber: description: - List of telephone numbers assigned to the user. - If an empty list is passed all assigned telephone numbers will be deleted. - If None is passed telephone numbers will not be checked or changed. type: list elements: str title: description: Title. type: str uid: description: uid of the user. required: true aliases: ["name"] type: str uidnumber: description: - Account Settings UID/Posix User ID number. type: str gidnumber: description: - Posix Group ID. type: str homedirectory: description: - Default home directory of the user. type: str version_added: '0.2.0' userauthtype: description: - The authentication type to use for the user. choices: ["password", "radius", "otp", "pkinit", "hardened"] type: list elements: str version_added: '1.2.0' extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes requirements: - base64 - hashlib ''' EXAMPLES = r''' - name: Ensure pinky is present and always reset password community.general.ipa_user: name: pinky state: present krbpasswordexpiration: 20200119235959 givenname: Pinky sn: Acme mail: - pinky@acme.com telephonenumber: - '+555123456' sshpubkey: - ssh-rsa .... - ssh-dsa .... uidnumber: '1001' gidnumber: '100' homedirectory: /home/pinky ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure brain is absent community.general.ipa_user: name: brain state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure pinky is present but don't reset password if already exists community.general.ipa_user: name: pinky state: present givenname: Pinky sn: Acme password: zounds ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret update_password: on_create - name: Ensure pinky is present and using one time password and RADIUS authentication community.general.ipa_user: name: pinky state: present userauthtype: - otp - radius ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' user: description: User as returned by IPA API returned: always type: dict ''' import base64 import hashlib import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class UserIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(UserIPAClient, self).__init__(module, host, port, protocol) def user_find(self, name): return self._post_json(method='user_find', name=None, item={'all': True, 'uid': name}) def user_add(self, name, item): return self._post_json(method='user_add', name=name, item=item) def user_mod(self, name, item): return self._post_json(method='user_mod', name=name, item=item) def user_del(self, name): return self._post_json(method='user_del', name=name) def user_disable(self, name): return self._post_json(method='user_disable', name=name) def user_enable(self, name): return self._post_json(method='user_enable', name=name) def get_user_dict(displayname=None, givenname=None, krbpasswordexpiration=None, loginshell=None, mail=None, nsaccountlock=False, sn=None, sshpubkey=None, telephonenumber=None, title=None, userpassword=None, gidnumber=None, uidnumber=None, homedirectory=None, userauthtype=None): user = {} if displayname is not None: user['displayname'] = displayname if krbpasswordexpiration is not None: user['krbpasswordexpiration'] = krbpasswordexpiration + "Z" if givenname is not None: user['givenname'] = givenname if loginshell is not None: user['loginshell'] = loginshell if mail is not None: user['mail'] = mail user['nsaccountlock'] = nsaccountlock if sn is not None: user['sn'] = sn if sshpubkey is not None: user['ipasshpubkey'] = sshpubkey if telephonenumber is not None: user['telephonenumber'] = telephonenumber if title is not None: user['title'] = title if userpassword is not None: user['userpassword'] = userpassword if gidnumber is not None: user['gidnumber'] = gidnumber if uidnumber is not None: user['uidnumber'] = uidnumber if homedirectory is not None: user['homedirectory'] = homedirectory if userauthtype is not None: user['ipauserauthtype'] = userauthtype return user def get_user_diff(client, ipa_user, module_user): """ Return the keys of each dict whereas values are different. Unfortunately the IPA API returns everything as a list even if only a single value is possible. Therefore some more complexity is needed. The method will check if the value type of module_user.attr is not a list and create a list with that element if the same attribute in ipa_user is list. In this way I hope that the method must not be changed if the returned API dict is changed. :param ipa_user: :param module_user: :return: """ # sshpubkeyfp is the list of ssh key fingerprints. IPA doesn't return the keys itself but instead the fingerprints. # These are used for comparison. sshpubkey = None if 'ipasshpubkey' in module_user: hash_algo = 'md5' if 'sshpubkeyfp' in ipa_user and ipa_user['sshpubkeyfp'][0][:7].upper() == 'SHA256:': hash_algo = 'sha256' module_user['sshpubkeyfp'] = [get_ssh_key_fingerprint(pubkey, hash_algo) for pubkey in module_user['ipasshpubkey']] # Remove the ipasshpubkey element as it is not returned from IPA but save it's value to be used later on sshpubkey = module_user['ipasshpubkey'] del module_user['ipasshpubkey'] result = client.get_diff(ipa_data=ipa_user, module_data=module_user) # If there are public keys, remove the fingerprints and add them back to the dict if sshpubkey is not None: del module_user['sshpubkeyfp'] module_user['ipasshpubkey'] = sshpubkey return result def get_ssh_key_fingerprint(ssh_key, hash_algo='sha256'): """ Return the public key fingerprint of a given public SSH key in format "[fp] [comment] (ssh-rsa)" where fp is of the format: FB:0C:AC:0A:07:94:5B:CE:75:6E:63:32:13:AD:AD:D7 for md5 or SHA256:[base64] for sha256 Comments are assumed to be all characters past the second whitespace character in the sshpubkey string. :param ssh_key: :param hash_algo: :return: """ parts = ssh_key.strip().split(None, 2) if len(parts) == 0: return None key_type = parts[0] key = base64.b64decode(parts[1].encode('ascii')) if hash_algo == 'md5': fp_plain = hashlib.md5(key).hexdigest() key_fp = ':'.join(a + b for a, b in zip(fp_plain[::2], fp_plain[1::2])).upper() elif hash_algo == 'sha256': fp_plain = base64.b64encode(hashlib.sha256(key).digest()).decode('ascii').rstrip('=') key_fp = 'SHA256:{fp}'.format(fp=fp_plain) if len(parts) < 3: return "%s (%s)" % (key_fp, key_type) else: comment = parts[2] return "%s %s (%s)" % (key_fp, comment, key_type) def ensure(module, client): state = module.params['state'] name = module.params['uid'] nsaccountlock = state == 'disabled' module_user = get_user_dict(displayname=module.params.get('displayname'), krbpasswordexpiration=module.params.get('krbpasswordexpiration'), givenname=module.params.get('givenname'), loginshell=module.params['loginshell'], mail=module.params['mail'], sn=module.params['sn'], sshpubkey=module.params['sshpubkey'], nsaccountlock=nsaccountlock, telephonenumber=module.params['telephonenumber'], title=module.params['title'], userpassword=module.params['password'], gidnumber=module.params.get('gidnumber'), uidnumber=module.params.get('uidnumber'), homedirectory=module.params.get('homedirectory'), userauthtype=module.params.get('userauthtype')) update_password = module.params.get('update_password') ipa_user = client.user_find(name=name) changed = False if state in ['present', 'enabled', 'disabled']: if not ipa_user: changed = True if not module.check_mode: ipa_user = client.user_add(name=name, item=module_user) else: if update_password == 'on_create': module_user.pop('userpassword', None) diff = get_user_diff(client, ipa_user, module_user) if len(diff) > 0: changed = True if not module.check_mode: ipa_user = client.user_mod(name=name, item=module_user) else: if ipa_user: changed = True if not module.check_mode: client.user_del(name) return changed, ipa_user def main(): argument_spec = ipa_argument_spec() argument_spec.update(displayname=dict(type='str'), givenname=dict(type='str'), update_password=dict(type='str', default="always", choices=['always', 'on_create'], no_log=False), krbpasswordexpiration=dict(type='str', no_log=False), loginshell=dict(type='str'), mail=dict(type='list', elements='str'), sn=dict(type='str'), uid=dict(type='str', required=True, aliases=['name']), gidnumber=dict(type='str'), uidnumber=dict(type='str'), password=dict(type='str', no_log=True), sshpubkey=dict(type='list', elements='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), telephonenumber=dict(type='list', elements='str'), title=dict(type='str'), homedirectory=dict(type='str'), userauthtype=dict(type='list', elements='str', choices=['password', 'radius', 'otp', 'pkinit', 'hardened'])) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = UserIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) # If sshpubkey is defined as None than module.params['sshpubkey'] is [None]. IPA itself returns None (not a list). # Therefore a small check here to replace list(None) by None. Otherwise get_user_diff() would return sshpubkey # as different which should be avoided. if module.params['sshpubkey'] is not None: if len(module.params['sshpubkey']) == 1 and module.params['sshpubkey'][0] == "": module.params['sshpubkey'] = None try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, user = ensure(module, client) module.exit_json(changed=changed, user=user) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main() PK $�!\<�M^� � Q collections/ansible_collections/community/general/plugins/modules/cobbler_sync.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Dag Wieers (dagwieers) <dag@wieers.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: cobbler_sync short_description: Sync Cobbler description: - Sync Cobbler to commit changes. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: host: description: - The name or IP address of the Cobbler system. default: 127.0.0.1 type: str port: description: - Port number to be used for REST connection. - The default value depends on parameter O(use_ssl). type: int username: description: - The username to log in to Cobbler. default: cobbler type: str password: description: - The password to log in to Cobbler. type: str use_ssl: description: - If V(false), an HTTP connection will be used instead of the default HTTPS connection. type: bool default: true validate_certs: description: - If V(false), SSL certificates will not be validated. - This should only set to V(false) when used on personally controlled sites using self-signed certificates. type: bool default: true author: - Dag Wieers (@dagwieers) todo: notes: - Concurrently syncing Cobbler is bound to fail with weird errors. - On python 2.7.8 and older (i.e. on RHEL7) you may need to tweak the python behaviour to disable certificate validation. More information at L(Certificate verification in Python standard library HTTP clients,https://access.redhat.com/articles/2039753). ''' EXAMPLES = r''' - name: Commit Cobbler changes community.general.cobbler_sync: host: cobbler01 username: cobbler password: MySuperSecureP4sswOrd run_once: true delegate_to: localhost ''' RETURN = r''' # Default return values ''' import datetime import ssl from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves import xmlrpc_client from ansible.module_utils.common.text.converters import to_text def main(): module = AnsibleModule( argument_spec=dict( host=dict(type='str', default='127.0.0.1'), port=dict(type='int'), username=dict(type='str', default='cobbler'), password=dict(type='str', no_log=True), use_ssl=dict(type='bool', default=True), validate_certs=dict(type='bool', default=True), ), supports_check_mode=True, ) username = module.params['username'] password = module.params['password'] port = module.params['port'] use_ssl = module.params['use_ssl'] validate_certs = module.params['validate_certs'] module.params['proto'] = 'https' if use_ssl else 'http' if not port: module.params['port'] = '443' if use_ssl else '80' result = dict( changed=True, ) start = datetime.datetime.utcnow() ssl_context = None if not validate_certs: try: ssl_context = ssl._create_unverified_context() except AttributeError: # Legacy Python that doesn't verify HTTPS certificates by default pass else: # Handle target environment that doesn't support HTTPS verification ssl._create_default_https_context = ssl._create_unverified_context url = '{proto}://{host}:{port}/cobbler_api'.format(**module.params) if ssl_context: conn = xmlrpc_client.ServerProxy(url, context=ssl_context) else: conn = xmlrpc_client.Server(url) try: token = conn.login(username, password) except xmlrpc_client.Fault as e: module.fail_json(msg="Failed to log in to Cobbler '{url}' as '{username}'. {error}".format(url=url, error=to_text(e), **module.params)) except Exception as e: module.fail_json(msg="Connection to '{url}' failed. {error}".format(url=url, error=to_text(e))) if not module.check_mode: try: conn.sync(token) except Exception as e: module.fail_json(msg="Failed to sync Cobbler. {error}".format(error=to_text(e))) elapsed = datetime.datetime.utcnow() - start module.exit_json(elapsed=elapsed.seconds, **result) if __name__ == '__main__': main() PK $�!\�x1&V? V? R collections/ansible_collections/community/general/plugins/modules/django_manage.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2022, Alexei Znamensky <russoz@gmail.com> # Copyright (c) 2013, Scott Anderson <scottanderson42@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: django_manage short_description: Manages a Django application description: - Manages a Django application using the C(manage.py) application frontend to C(django-admin). With the O(virtualenv) parameter, all management commands will be executed by the given C(virtualenv) installation. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: command: description: - The name of the Django management command to run. The commands listed below are built in this module and have some basic parameter validation. - > V(cleanup) - clean up old data from the database (deprecated in Django 1.5). This parameter will be removed in community.general 9.0.0. Use V(clearsessions) instead. - V(collectstatic) - Collects the static files into C(STATIC_ROOT). - V(createcachetable) - Creates the cache tables for use with the database cache backend. - V(flush) - Removes all data from the database. - V(loaddata) - Searches for and loads the contents of the named O(fixtures) into the database. - V(migrate) - Synchronizes the database state with models and migrations. - > V(syncdb) - Synchronizes the database state with models and migrations (deprecated in Django 1.7). This parameter will be removed in community.general 9.0.0. Use V(migrate) instead. - V(test) - Runs tests for all installed apps. - > V(validate) - Validates all installed models (deprecated in Django 1.7). This parameter will be removed in community.general 9.0.0. Use V(check) instead. - Other commands can be entered, but will fail if they are unknown to Django. Other commands that may prompt for user input should be run with the C(--noinput) flag. type: str required: true project_path: description: - The path to the root of the Django application where C(manage.py) lives. type: path required: true aliases: [app_path, chdir] settings: description: - The Python path to the application's settings module, such as V(myapp.settings). type: path required: false pythonpath: description: - A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory. - This would be equivalent to adding O(pythonpath)'s value to the E(PYTHONPATH) environment variable. type: path required: false aliases: [python_path] virtualenv: description: - An optional path to a C(virtualenv) installation to use while running the manage application. type: path aliases: [virtual_env] apps: description: - A list of space-delimited apps to target. Used by the V(test) command. type: str required: false cache_table: description: - The name of the table used for database-backed caching. Used by the V(createcachetable) command. type: str required: false clear: description: - Clear the existing files before trying to copy or link the original file. - Used only with the V(collectstatic) command. The C(--noinput) argument will be added automatically. required: false default: false type: bool database: description: - The database to target. Used by the V(createcachetable), V(flush), V(loaddata), V(syncdb), and V(migrate) commands. type: str required: false failfast: description: - Fail the command immediately if a test fails. Used by the V(test) command. required: false default: false type: bool aliases: [fail_fast] fixtures: description: - A space-delimited list of fixture file names to load in the database. B(Required) by the V(loaddata) command. type: str required: false skip: description: - Will skip over out-of-order missing migrations, you can only use this parameter with V(migrate) command. required: false type: bool merge: description: - Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with V(migrate) command. required: false type: bool link: description: - Will create links to the files instead of copying them, you can only use this parameter with V(collectstatic) command. required: false type: bool testrunner: description: - Controls the test runner class that is used to execute tests. - This parameter is passed as-is to C(manage.py). type: str required: false aliases: [test_runner] ack_venv_creation_deprecation: description: - >- When a O(virtualenv) is set but the virtual environment does not exist, the current behavior is to create a new virtual environment. That behavior is deprecated and if that case happens it will generate a deprecation warning. Set this flag to V(true) to suppress the deprecation warning. - Please note that you will receive no further warning about this being removed until the module will start failing in such cases from community.general 9.0.0 on. type: bool version_added: 5.8.0 notes: - > B(ATTENTION - DEPRECATION): Support for Django releases older than 4.1 will be removed in community.general version 9.0.0 (estimated to be released in May 2024). Please notice that Django 4.1 requires Python 3.8 or greater. - C(virtualenv) (U(http://www.virtualenv.org)) must be installed on the remote host if the O(virtualenv) parameter is specified. This requirement is deprecated and will be removed in community.general version 9.0.0. - This module will create a virtualenv if the O(virtualenv) parameter is specified and a virtual environment does not already exist at the given location. This behavior is deprecated and will be removed in community.general version 9.0.0. - The parameter O(virtualenv) will remain in use, but it will require the specified virtualenv to exist. The recommended way to create one in Ansible is by using M(ansible.builtin.pip). - This module assumes English error messages for the V(createcachetable) command to detect table existence, unfortunately. - To be able to use the V(migrate) command with django versions < 1.7, you must have C(south) installed and added as an app in your settings. - To be able to use the V(collectstatic) command, you must have enabled staticfiles in your settings. - Your C(manage.py) application must be executable (C(rwxr-xr-x)), and must have a valid shebang, for example C(#!/usr/bin/env python), for invoking the appropriate Python interpreter. seealso: - name: django-admin and manage.py Reference description: Reference for C(django-admin) or C(manage.py) commands. link: https://docs.djangoproject.com/en/4.1/ref/django-admin/ - name: Django Download page description: The page showing how to get Django and the timeline of supported releases. link: https://www.djangoproject.com/download/ - name: What Python version can I use with Django? description: From the Django FAQ, the response to Python requirements for the framework. link: https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django requirements: [ "virtualenv", "django" ] author: - Alexei Znamensky (@russoz) - Scott Anderson (@tastychutney) ''' EXAMPLES = """ - name: Run cleanup on the application installed in django_dir community.general.django_manage: command: cleanup project_path: "{{ django_dir }}" - name: Load the initial_data fixture into the application community.general.django_manage: command: loaddata project_path: "{{ django_dir }}" fixtures: "{{ initial_data }}" - name: Run syncdb on the application community.general.django_manage: command: syncdb project_path: "{{ django_dir }}" settings: "{{ settings_app_name }}" pythonpath: "{{ settings_dir }}" virtualenv: "{{ virtualenv_dir }}" - name: Run the SmokeTest test case from the main app. Useful for testing deploys community.general.django_manage: command: test project_path: "{{ django_dir }}" apps: main.SmokeTest - name: Create an initial superuser community.general.django_manage: command: "createsuperuser --noinput --username=admin --email=admin@example.com" project_path: "{{ django_dir }}" """ import os import sys import shlex from ansible.module_utils.basic import AnsibleModule def _fail(module, cmd, out, err, **kwargs): msg = '' if out: msg += "stdout: %s" % (out, ) if err: msg += "\n:stderr: %s" % (err, ) module.fail_json(cmd=cmd, msg=msg, **kwargs) def _ensure_virtualenv(module): venv_param = module.params['virtualenv'] if venv_param is None: return vbin = os.path.join(venv_param, 'bin') activate = os.path.join(vbin, 'activate') if not os.path.exists(activate): # In version 9.0.0, if the venv is not found, it should fail_json() here. if not module.params['ack_venv_creation_deprecation']: module.deprecate( 'The behavior of "creating the virtual environment when missing" is being ' 'deprecated and will be removed in community.general version 9.0.0. ' 'Set the module parameter `ack_venv_creation_deprecation: true` to ' 'prevent this message from showing up when creating a virtualenv.', version='9.0.0', collection_name='community.general', ) virtualenv = module.get_bin_path('virtualenv', True) vcmd = [virtualenv, venv_param] rc, out_venv, err_venv = module.run_command(vcmd) if rc != 0: _fail(module, vcmd, out_venv, err_venv) os.environ["PATH"] = "%s:%s" % (vbin, os.environ["PATH"]) os.environ["VIRTUAL_ENV"] = venv_param def createcachetable_check_changed(output): return "already exists" not in output def flush_filter_output(line): return "Installed" in line and "Installed 0 object" not in line def loaddata_filter_output(line): return "Installed" in line and "Installed 0 object" not in line def syncdb_filter_output(line): return ("Creating table " in line) \ or ("Installed" in line and "Installed 0 object" not in line) def migrate_filter_output(line): return ("Migrating forwards " in line) \ or ("Installed" in line and "Installed 0 object" not in line) \ or ("Applying" in line) def collectstatic_filter_output(line): return line and "0 static files" not in line def main(): command_allowed_param_map = dict( cleanup=(), createcachetable=('cache_table', 'database', ), flush=('database', ), loaddata=('database', 'fixtures', ), syncdb=('database', ), test=('failfast', 'testrunner', 'apps', ), validate=(), migrate=('apps', 'skip', 'merge', 'database',), collectstatic=('clear', 'link', ), ) command_required_param_map = dict( loaddata=('fixtures', ), ) # forces --noinput on every command that needs it noinput_commands = ( 'flush', 'syncdb', 'migrate', 'test', 'collectstatic', ) # These params are allowed for certain commands only specific_params = ('apps', 'clear', 'database', 'failfast', 'fixtures', 'testrunner') # These params are automatically added to the command if present general_params = ('settings', 'pythonpath', 'database',) specific_boolean_params = ('clear', 'failfast', 'skip', 'merge', 'link') end_of_command_params = ('apps', 'cache_table', 'fixtures') module = AnsibleModule( argument_spec=dict( command=dict(required=True, type='str'), project_path=dict(required=True, type='path', aliases=['app_path', 'chdir']), settings=dict(type='path'), pythonpath=dict(type='path', aliases=['python_path']), virtualenv=dict(type='path', aliases=['virtual_env']), apps=dict(), cache_table=dict(type='str'), clear=dict(default=False, type='bool'), database=dict(type='str'), failfast=dict(default=False, type='bool', aliases=['fail_fast']), fixtures=dict(type='str'), testrunner=dict(type='str', aliases=['test_runner']), skip=dict(type='bool'), merge=dict(type='bool'), link=dict(type='bool'), ack_venv_creation_deprecation=dict(type='bool'), ), ) command_split = shlex.split(module.params['command']) command_bin = command_split[0] project_path = module.params['project_path'] virtualenv = module.params['virtualenv'] try: _deprecation = dict( cleanup="clearsessions", syncdb="migrate", validate="check", ) module.deprecate( 'The command {0} has been deprecated as it is no longer supported in recent Django versions.' 'Please use the command {1} instead that provide similar capability.'.format(command_bin, _deprecation[command_bin]), version='9.0.0', collection_name='community.general' ) except KeyError: pass for param in specific_params: value = module.params[param] if value and param not in command_allowed_param_map[command_bin]: module.fail_json(msg='%s param is incompatible with command=%s' % (param, command_bin)) for param in command_required_param_map.get(command_bin, ()): if not module.params[param]: module.fail_json(msg='%s param is required for command=%s' % (param, command_bin)) _ensure_virtualenv(module) run_cmd_args = ["./manage.py"] + command_split if command_bin in noinput_commands and '--noinput' not in command_split: run_cmd_args.append("--noinput") for param in general_params: if module.params[param]: run_cmd_args.append('--%s=%s' % (param, module.params[param])) for param in specific_boolean_params: if module.params[param]: run_cmd_args.append('--%s' % param) # these params always get tacked on the end of the command for param in end_of_command_params: if module.params[param]: if param in ('fixtures', 'apps'): run_cmd_args.extend(shlex.split(module.params[param])) else: run_cmd_args.append(module.params[param]) rc, out, err = module.run_command(run_cmd_args, cwd=project_path) if rc != 0: if command_bin == 'createcachetable' and 'table' in err and 'already exists' in err: out = 'already exists.' else: if "Unknown command:" in err: _fail(module, run_cmd_args, err, "Unknown django command: %s" % command_bin) _fail(module, run_cmd_args, out, err, path=os.environ["PATH"], syspath=sys.path) changed = False lines = out.split('\n') filt = globals().get(command_bin + "_filter_output", None) if filt: filtered_output = list(filter(filt, lines)) if len(filtered_output): changed = True check_changed = globals().get("{0}_check_changed".format(command_bin), None) if check_changed: changed = check_changed(out) module.exit_json(changed=changed, out=out, cmd=run_cmd_args, app_path=project_path, project_path=project_path, virtualenv=virtualenv, settings=module.params['settings'], pythonpath=module.params['pythonpath']) if __name__ == '__main__': main() PK $�!\�� �$ �$ R collections/ansible_collections/community/general/plugins/modules/packet_volume.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Nurfet Becirevic <nurfet.becirevic@gmail.com> # Copyright (c) 2017, Tomas Karasek <tom.to.the.k@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: packet_volume short_description: Create/delete a volume in Packet host description: - Create/delete a volume in Packet host. - API is documented at U(https://www.packet.com/developers/api/#volumes). version_added: '0.2.0' author: - Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com> - Nurfet Becirevic (@nurfet-becirevic) <nurfet.becirevic@gmail.com> extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: description: - Desired state of the volume. default: present choices: ['present', 'absent'] type: str project_id: description: - ID of project of the device. required: true type: str auth_token: description: - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN). type: str name: description: - Selector for API-generated name of the volume type: str description: description: - User-defined description attribute for Packet volume. - "It is used used as idempotent identifier - if volume with given description exists, new one is not created." type: str id: description: - UUID of a volume. type: str plan: description: - storage_1 for standard tier, storage_2 for premium (performance) tier. - Tiers are described at U(https://www.packet.com/cloud/storage/). choices: ['storage_1', 'storage_2'] default: 'storage_1' type: str facility: description: - Location of the volume. - Volumes can only be attached to device in the same location. type: str size: description: - Size of the volume in gigabytes. type: int locked: description: - Create new volume locked. type: bool default: false billing_cycle: description: - Billing cycle for new volume. choices: ['hourly', 'monthly'] default: 'hourly' type: str snapshot_policy: description: - Snapshot policy for new volume. type: dict suboptions: snapshot_count: description: - How many snapshots to keep, a positive integer. required: true type: int snapshot_frequency: description: - Frequency of snapshots. required: true choices: ["15min", "1hour", "1day", "1week", "1month", "1year"] type: str requirements: - "python >= 2.6" - "packet-python >= 1.35" ''' EXAMPLES = ''' # All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN. # You can also pass the api token in module param auth_token. - hosts: localhost vars: volname: testvol123 project_id: 53000fb2-ee46-4673-93a8-de2c2bdba33b tasks: - name: Create volume community.general.packet_volume: description: "{{ volname }}" project_id: "{{ project_id }}" facility: 'ewr1' plan: 'storage_1' state: present size: 10 snapshot_policy: snapshot_count: 10 snapshot_frequency: 1day register: result_create - name: Delete volume community.general.packet_volume: id: "{{ result_create.id }}" project_id: "{{ project_id }}" state: absent ''' RETURN = ''' id: description: UUID of specified volume type: str returned: success sample: 53000fb2-ee46-4673-93a8-de2c2bdba33c name: description: The API-generated name of the volume resource. type: str returned: if volume is attached/detached to/from some device sample: "volume-a91dc506" description: description: The user-defined description of the volume resource. type: str returned: success sample: "Just another volume" ''' import uuid from ansible.module_utils.basic import AnsibleModule, env_fallback from ansible.module_utils.common.text.converters import to_native HAS_PACKET_SDK = True try: import packet except ImportError: HAS_PACKET_SDK = False PACKET_API_TOKEN_ENV_VAR = "PACKET_API_TOKEN" VOLUME_PLANS = ["storage_1", "storage_2"] VOLUME_STATES = ["present", "absent"] BILLING = ["hourly", "monthly"] def is_valid_uuid(myuuid): try: val = uuid.UUID(myuuid, version=4) except ValueError: return False return str(val) == myuuid def get_volume_selector(module): if module.params.get('id'): i = module.params.get('id') if not is_valid_uuid(i): raise Exception("Volume ID '{0}' is not a valid UUID".format(i)) return lambda v: v['id'] == i elif module.params.get('name'): n = module.params.get('name') return lambda v: v['name'] == n elif module.params.get('description'): d = module.params.get('description') return lambda v: v['description'] == d def get_or_fail(params, key): item = params.get(key) if item is None: raise Exception("{0} must be specified for new volume".format(key)) return item def act_on_volume(target_state, module, packet_conn): return_dict = {'changed': False} s = get_volume_selector(module) project_id = module.params.get("project_id") api_method = "projects/{0}/storage".format(project_id) all_volumes = packet_conn.call_api(api_method, "GET")['volumes'] matching_volumes = [v for v in all_volumes if s(v)] if target_state == "present": if len(matching_volumes) == 0: params = { "description": get_or_fail(module.params, "description"), "size": get_or_fail(module.params, "size"), "plan": get_or_fail(module.params, "plan"), "facility": get_or_fail(module.params, "facility"), "locked": get_or_fail(module.params, "locked"), "billing_cycle": get_or_fail(module.params, "billing_cycle"), "snapshot_policies": module.params.get("snapshot_policy"), } new_volume_data = packet_conn.call_api(api_method, "POST", params) return_dict['changed'] = True for k in ['id', 'name', 'description']: return_dict[k] = new_volume_data[k] else: for k in ['id', 'name', 'description']: return_dict[k] = matching_volumes[0][k] else: if len(matching_volumes) > 1: _msg = ("More than one volume matches in module call for absent state: {0}".format( to_native(matching_volumes))) module.fail_json(msg=_msg) if len(matching_volumes) == 1: volume = matching_volumes[0] packet_conn.call_api("storage/{0}".format(volume['id']), "DELETE") return_dict['changed'] = True for k in ['id', 'name', 'description']: return_dict[k] = volume[k] return return_dict def main(): module = AnsibleModule( argument_spec=dict( id=dict(type='str'), description=dict(type="str"), name=dict(type='str'), state=dict(choices=VOLUME_STATES, default="present"), auth_token=dict( type='str', fallback=(env_fallback, [PACKET_API_TOKEN_ENV_VAR]), no_log=True ), project_id=dict(required=True), plan=dict(choices=VOLUME_PLANS, default="storage_1"), facility=dict(type="str"), size=dict(type="int"), locked=dict(type="bool", default=False), snapshot_policy=dict(type='dict'), billing_cycle=dict(type='str', choices=BILLING, default="hourly"), ), supports_check_mode=True, required_one_of=[("name", "id", "description")], mutually_exclusive=[ ('name', 'id'), ('id', 'description'), ('name', 'description'), ] ) if not HAS_PACKET_SDK: module.fail_json(msg='packet required for this module') if not module.params.get('auth_token'): _fail_msg = ("if Packet API token is not in environment variable {0}, " "the auth_token parameter is required".format(PACKET_API_TOKEN_ENV_VAR)) module.fail_json(msg=_fail_msg) auth_token = module.params.get('auth_token') packet_conn = packet.Manager(auth_token=auth_token) state = module.params.get('state') if state in VOLUME_STATES: if module.check_mode: module.exit_json(changed=False) try: module.exit_json(**act_on_volume(state, module, packet_conn)) except Exception as e: module.fail_json( msg="failed to set volume state {0}: {1}".format( state, to_native(e))) else: module.fail_json(msg="{0} is not a valid state for this module".format(state)) if __name__ == '__main__': main() PK $�!\��M��, �, \ collections/ansible_collections/community/general/plugins/modules/manageiq_alert_profiles.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017 Red Hat Inc. # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' module: manageiq_alert_profiles short_description: Configuration of alert profiles for ManageIQ extends_documentation_fragment: - community.general.manageiq - community.general.attributes author: Elad Alfassa (@elad661) <ealfassa@redhat.com> description: - The manageiq_alert_profiles module supports adding, updating and deleting alert profiles in ManageIQ. attributes: check_mode: support: none diff_mode: support: none options: state: type: str description: - absent - alert profile should not exist, - present - alert profile should exist, choices: ['absent', 'present'] default: 'present' name: type: str description: - The unique alert profile name in ManageIQ. - Required when state is "absent" or "present". resource_type: type: str description: - The resource type for the alert profile in ManageIQ. Required when state is "present". choices: ['Vm', 'ContainerNode', 'MiqServer', 'Host', 'Storage', 'EmsCluster', 'ExtManagementSystem', 'MiddlewareServer'] alerts: type: list elements: str description: - List of alert descriptions to assign to this profile. - Required if state is "present" notes: type: str description: - Optional notes for this profile ''' EXAMPLES = ''' - name: Add an alert profile to ManageIQ community.general.manageiq_alert_profiles: state: present name: Test profile resource_type: ContainerNode alerts: - Test Alert 01 - Test Alert 02 manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' validate_certs: false - name: Delete an alert profile from ManageIQ community.general.manageiq_alert_profiles: state: absent name: Test profile manageiq_connection: url: 'http://127.0.0.1:3000' username: 'admin' password: 'smartvm' validate_certs: false ''' RETURN = ''' ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.manageiq import ManageIQ, manageiq_argument_spec class ManageIQAlertProfiles(object): """ Object to execute alert profile management operations in manageiq. """ def __init__(self, manageiq): self.manageiq = manageiq self.module = self.manageiq.module self.api_url = self.manageiq.api_url self.client = self.manageiq.client self.url = '{api_url}/alert_definition_profiles'.format(api_url=self.api_url) def get_profiles(self): """ Get all alert profiles from ManageIQ """ try: response = self.client.get(self.url + '?expand=alert_definitions,resources') except Exception as e: self.module.fail_json(msg="Failed to query alert profiles: {error}".format(error=e)) return response.get('resources') or [] def get_alerts(self, alert_descriptions): """ Get a list of alert hrefs from a list of alert descriptions """ alerts = [] for alert_description in alert_descriptions: alert = self.manageiq.find_collection_resource_or_fail("alert_definitions", description=alert_description) alerts.append(alert['href']) return alerts def add_profile(self, profile): """ Add a new alert profile to ManageIQ """ # find all alerts to add to the profile # we do this first to fail early if one is missing. alerts = self.get_alerts(profile['alerts']) # build the profile dict to send to the server profile_dict = dict(name=profile['name'], description=profile['name'], mode=profile['resource_type']) if profile['notes']: profile_dict['set_data'] = dict(notes=profile['notes']) # send it to the server try: result = self.client.post(self.url, resource=profile_dict, action="create") except Exception as e: self.module.fail_json(msg="Creating profile failed {error}".format(error=e)) # now that it has been created, we can assign the alerts self.assign_or_unassign(result['results'][0], alerts, "assign") msg = "Profile {name} created successfully" msg = msg.format(name=profile['name']) return dict(changed=True, msg=msg) def delete_profile(self, profile): """ Delete an alert profile from ManageIQ """ try: self.client.post(profile['href'], action="delete") except Exception as e: self.module.fail_json(msg="Deleting profile failed: {error}".format(error=e)) msg = "Successfully deleted profile {name}".format(name=profile['name']) return dict(changed=True, msg=msg) def get_alert_href(self, alert): """ Get an absolute href for an alert """ return "{url}/alert_definitions/{id}".format(url=self.api_url, id=alert['id']) def assign_or_unassign(self, profile, resources, action): """ Assign or unassign alerts to profile, and validate the result. """ alerts = [dict(href=href) for href in resources] subcollection_url = profile['href'] + '/alert_definitions' try: result = self.client.post(subcollection_url, resources=alerts, action=action) if len(result['results']) != len(alerts): msg = "Failed to {action} alerts to profile '{name}'," +\ "expected {expected} alerts to be {action}ed," +\ "but only {changed} were {action}ed" msg = msg.format(action=action, name=profile['name'], expected=len(alerts), changed=result['results']) self.module.fail_json(msg=msg) except Exception as e: msg = "Failed to {action} alerts to profile '{name}': {error}" msg = msg.format(action=action, name=profile['name'], error=e) self.module.fail_json(msg=msg) return result['results'] def update_profile(self, old_profile, desired_profile): """ Update alert profile in ManageIQ """ changed = False # we need to use client.get to query the alert definitions old_profile = self.client.get(old_profile['href'] + '?expand=alert_definitions') # figure out which alerts we need to assign / unassign # alerts listed by the user: desired_alerts = set(self.get_alerts(desired_profile['alerts'])) # alert which currently exist in the profile if 'alert_definitions' in old_profile: # we use get_alert_href to have a direct href to the alert existing_alerts = set([self.get_alert_href(alert) for alert in old_profile['alert_definitions']]) else: # no alerts in this profile existing_alerts = set() to_add = list(desired_alerts - existing_alerts) to_remove = list(existing_alerts - desired_alerts) # assign / unassign the alerts, if needed if to_remove: self.assign_or_unassign(old_profile, to_remove, "unassign") changed = True if to_add: self.assign_or_unassign(old_profile, to_add, "assign") changed = True # update other properties profile_dict = dict() if old_profile['mode'] != desired_profile['resource_type']: # mode needs to be updated profile_dict['mode'] = desired_profile['resource_type'] # check if notes need to be updated old_notes = old_profile.get('set_data', {}).get('notes') if desired_profile['notes'] != old_notes: profile_dict['set_data'] = dict(notes=desired_profile['notes']) if profile_dict: # if we have any updated values changed = True try: result = self.client.post(old_profile['href'], resource=profile_dict, action="edit") except Exception as e: msg = "Updating profile '{name}' failed: {error}" msg = msg.format(name=old_profile['name'], error=e) self.module.fail_json(msg=msg) if changed: msg = "Profile {name} updated successfully".format(name=desired_profile['name']) else: msg = "No update needed for profile {name}".format(name=desired_profile['name']) return dict(changed=changed, msg=msg) def main(): argument_spec = dict( name=dict(type='str'), resource_type=dict(type='str', choices=['Vm', 'ContainerNode', 'MiqServer', 'Host', 'Storage', 'EmsCluster', 'ExtManagementSystem', 'MiddlewareServer']), alerts=dict(type='list', elements='str'), notes=dict(type='str'), state=dict(default='present', choices=['present', 'absent']), ) # add the manageiq connection arguments to the arguments argument_spec.update(manageiq_argument_spec()) module = AnsibleModule(argument_spec=argument_spec, required_if=[('state', 'present', ['name', 'resource_type']), ('state', 'absent', ['name'])]) state = module.params['state'] name = module.params['name'] manageiq = ManageIQ(module) manageiq_alert_profiles = ManageIQAlertProfiles(manageiq) existing_profile = manageiq.find_collection_resource_by("alert_definition_profiles", name=name) # we need to add or update the alert profile if state == "present": if not existing_profile: # a profile with this name doesn't exist yet, let's create it res_args = manageiq_alert_profiles.add_profile(module.params) else: # a profile with this name exists, we might need to update it res_args = manageiq_alert_profiles.update_profile(existing_profile, module.params) # this alert profile should not exist if state == "absent": # if we have an alert profile with this name, delete it if existing_profile: res_args = manageiq_alert_profiles.delete_profile(existing_profile) else: # This alert profile does not exist in ManageIQ, and that's okay msg = "Alert profile '{name}' does not exist in ManageIQ" msg = msg.format(name=name) res_args = dict(changed=False, msg=msg) module.exit_json(**res_args) if __name__ == "__main__": main() PK $�!\�%^�/ / R collections/ansible_collections/community/general/plugins/modules/utm_aaa_group.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: utm_aaa_group author: - Johannes Brunswicker (@MatrixCrawler) short_description: Create, update or destroy an aaa group object in Sophos UTM description: - Create, update or destroy an aaa group object in Sophos UTM. - This module needs to have the REST Ability of the UTM to be activated. attributes: check_mode: support: none diff_mode: support: none options: name: description: - The name of the object. Will be used to identify the entry. type: str required: true adirectory_groups: description: - List of adirectory group strings. type: list elements: str default: [] adirectory_groups_sids: description: - Dictionary of group sids. type: dict default: {} backend_match: description: - The backend for the group. type: str choices: - none - adirectory - edirectory - radius - tacacs - ldap default: none comment: description: - Comment that describes the AAA group. type: str default: '' dynamic: description: - Group type. Is static if none is selected. type: str default: none choices: - none - ipsec_dn - directory_groups edirectory_groups: description: - List of edirectory group strings. type: list elements: str default: [] ipsec_dn: description: - The ipsec dn string. type: str default: '' ldap_attribute: description: - The ldap attribute to check against. type: str default: '' ldap_attribute_value: description: - The ldap attribute value to check against. type: str default: '' members: description: - A list of user ref names (aaa/user). type: list elements: str default: [] network: description: - The network reference name. The objects contains the known ip addresses for the authentication object (network/aaa). type: str default: "" radius_groups: description: - A list of radius group strings. type: list elements: str default: [] tacacs_groups: description: - A list of tacacs group strings. type: list elements: str default: [] extends_documentation_fragment: - community.general.utm - community.general.attributes ''' EXAMPLES = """ - name: Create UTM aaa_group community.general.utm_aaa_group: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestAAAGroupEntry backend_match: ldap dynamic: directory_groups ldap_attributes: memberof ldap_attributes_value: "cn=groupname,ou=Groups,dc=mydomain,dc=com" network: REF_OBJECT_STRING state: present - name: Remove UTM aaa_group community.general.utm_aaa_group: utm_host: sophos.host.name utm_token: abcdefghijklmno1234 name: TestAAAGroupEntry state: absent """ RETURN = """ result: description: The utm object that was created. returned: success type: complex contains: _ref: description: The reference name of the object. type: str _locked: description: Whether or not the object is currently locked. type: bool _type: description: The type of the object. type: str name: description: The name of the object. type: str adirectory_groups: description: List of Active Directory Groups. type: str adirectory_groups_sids: description: List of Active Directory Groups SIDS. type: list backend_match: description: The backend to use. type: str comment: description: The comment string. type: str dynamic: description: Whether the group match is ipsec_dn or directory_group. type: str edirectory_groups: description: List of eDirectory Groups. type: str ipsec_dn: description: ipsec_dn identifier to match. type: str ldap_attribute: description: The LDAP Attribute to match against. type: str ldap_attribute_value: description: The LDAP Attribute Value to match against. type: str members: description: List of member identifiers of the group. type: list network: description: The identifier of the network (network/aaa). type: str radius_group: description: The radius group identifier. type: str tacacs_group: description: The tacacs group identifier. type: str """ from ansible_collections.community.general.plugins.module_utils.utm_utils import UTM, UTMModule from ansible.module_utils.common.text.converters import to_native def main(): endpoint = "aaa/group" key_to_check_for_changes = ["comment", "adirectory_groups", "adirectory_groups_sids", "backend_match", "dynamic", "edirectory_groups", "ipsec_dn", "ldap_attribute", "ldap_attribute_value", "members", "network", "radius_groups", "tacacs_groups"] module = UTMModule( argument_spec=dict( name=dict(type='str', required=True), adirectory_groups=dict(type='list', elements='str', required=False, default=[]), adirectory_groups_sids=dict(type='dict', required=False, default={}), backend_match=dict(type='str', required=False, default="none", choices=["none", "adirectory", "edirectory", "radius", "tacacs", "ldap"]), comment=dict(type='str', required=False, default=""), dynamic=dict(type='str', required=False, default="none", choices=["none", "ipsec_dn", "directory_groups"]), edirectory_groups=dict(type='list', elements='str', required=False, default=[]), ipsec_dn=dict(type='str', required=False, default=""), ldap_attribute=dict(type='str', required=False, default=""), ldap_attribute_value=dict(type='str', required=False, default=""), members=dict(type='list', elements='str', required=False, default=[]), network=dict(type='str', required=False, default=""), radius_groups=dict(type='list', elements='str', required=False, default=[]), tacacs_groups=dict(type='list', elements='str', required=False, default=[]), ) ) try: UTM(module, endpoint, key_to_check_for_changes).execute() except Exception as e: module.fail_json(msg=to_native(e)) if __name__ == '__main__': main() PK $�!\���H� � R collections/ansible_collections/community/general/plugins/modules/kibana_plugin.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, Thierno IB. BARRY @barryib # Sponsored by Polyconseil http://polyconseil.fr. # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: kibana_plugin short_description: Manage Kibana plugins description: - This module can be used to manage Kibana plugins. author: Thierno IB. BARRY (@barryib) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the plugin to install. required: true type: str state: description: - Desired state of a plugin. choices: ["present", "absent"] default: present type: str url: description: - Set exact URL to download the plugin from. - For local file, prefix its absolute path with file:// type: str timeout: description: - "Timeout setting: 30s, 1m, 1h etc." default: 1m type: str plugin_bin: description: - Location of the Kibana binary. default: /opt/kibana/bin/kibana type: path plugin_dir: description: - Your configured plugin directory specified in Kibana. default: /opt/kibana/installedPlugins/ type: path version: description: - Version of the plugin to be installed. - If plugin exists with previous version, plugin will B(not) be updated unless O(force) is set to V(true). type: str force: description: - Delete and re-install the plugin. Can be useful for plugins update. type: bool default: false allow_root: description: - Whether to allow C(kibana) and C(kibana-plugin) to be run as root. Passes the C(--allow-root) flag to these commands. type: bool default: false version_added: 2.3.0 ''' EXAMPLES = ''' - name: Install Elasticsearch head plugin community.general.kibana_plugin: state: present name: elasticsearch/marvel - name: Install specific version of a plugin community.general.kibana_plugin: state: present name: elasticsearch/marvel version: '2.3.3' - name: Uninstall Elasticsearch head plugin community.general.kibana_plugin: state: absent name: elasticsearch/marvel ''' RETURN = ''' cmd: description: the launched command during plugin management (install / remove) returned: success type: str name: description: the plugin name to install or remove returned: success type: str url: description: the url from where the plugin is installed from returned: success type: str timeout: description: the timeout for plugin download returned: success type: str stdout: description: the command stdout returned: success type: str stderr: description: the command stderr returned: success type: str state: description: the state for the managed plugin returned: success type: str ''' import os from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.version import LooseVersion PACKAGE_STATE_MAP = dict( present="--install", absent="--remove" ) def parse_plugin_repo(string): elements = string.split("/") # We first consider the simplest form: pluginname repo = elements[0] # We consider the form: username/pluginname if len(elements) > 1: repo = elements[1] # remove elasticsearch- prefix # remove es- prefix for string in ("elasticsearch-", "es-"): if repo.startswith(string): return repo[len(string):] return repo def is_plugin_present(plugin_dir, working_dir): return os.path.isdir(os.path.join(working_dir, plugin_dir)) def parse_error(string): reason = "reason: " try: return string[string.index(reason) + len(reason):].strip() except ValueError: return string def install_plugin(module, plugin_bin, plugin_name, url, timeout, allow_root, kibana_version='4.6'): if LooseVersion(kibana_version) > LooseVersion('4.6'): kibana_plugin_bin = os.path.join(os.path.dirname(plugin_bin), 'kibana-plugin') cmd_args = [kibana_plugin_bin, "install"] if url: cmd_args.append(url) else: cmd_args.append(plugin_name) else: cmd_args = [plugin_bin, "plugin", PACKAGE_STATE_MAP["present"], plugin_name] if url: cmd_args.extend(["--url", url]) if timeout: cmd_args.extend(["--timeout", timeout]) if allow_root: cmd_args.append('--allow-root') if module.check_mode: return True, " ".join(cmd_args), "check mode", "" rc, out, err = module.run_command(cmd_args) if rc != 0: reason = parse_error(out) module.fail_json(msg=reason) return True, " ".join(cmd_args), out, err def remove_plugin(module, plugin_bin, plugin_name, allow_root, kibana_version='4.6'): if LooseVersion(kibana_version) > LooseVersion('4.6'): kibana_plugin_bin = os.path.join(os.path.dirname(plugin_bin), 'kibana-plugin') cmd_args = [kibana_plugin_bin, "remove", plugin_name] else: cmd_args = [plugin_bin, "plugin", PACKAGE_STATE_MAP["absent"], plugin_name] if allow_root: cmd_args.append('--allow-root') if module.check_mode: return True, " ".join(cmd_args), "check mode", "" rc, out, err = module.run_command(cmd_args) if rc != 0: reason = parse_error(out) module.fail_json(msg=reason) return True, " ".join(cmd_args), out, err def get_kibana_version(module, plugin_bin, allow_root): cmd_args = [plugin_bin, '--version'] if allow_root: cmd_args.append('--allow-root') rc, out, err = module.run_command(cmd_args) if rc != 0: module.fail_json(msg="Failed to get Kibana version : %s" % err) return out.strip() def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), state=dict(default="present", choices=list(PACKAGE_STATE_MAP.keys())), url=dict(default=None), timeout=dict(default="1m"), plugin_bin=dict(default="/opt/kibana/bin/kibana", type="path"), plugin_dir=dict(default="/opt/kibana/installedPlugins/", type="path"), version=dict(default=None), force=dict(default=False, type="bool"), allow_root=dict(default=False, type="bool"), ), supports_check_mode=True, ) name = module.params["name"] state = module.params["state"] url = module.params["url"] timeout = module.params["timeout"] plugin_bin = module.params["plugin_bin"] plugin_dir = module.params["plugin_dir"] version = module.params["version"] force = module.params["force"] allow_root = module.params["allow_root"] changed, cmd, out, err = False, '', '', '' kibana_version = get_kibana_version(module, plugin_bin, allow_root) present = is_plugin_present(parse_plugin_repo(name), plugin_dir) # skip if the state is correct if (present and state == "present" and not force) or (state == "absent" and not present and not force): module.exit_json(changed=False, name=name, state=state) if version: name = name + '/' + version if state == "present": if force: remove_plugin(module, plugin_bin, name, allow_root, kibana_version) changed, cmd, out, err = install_plugin(module, plugin_bin, name, url, timeout, allow_root, kibana_version) elif state == "absent": changed, cmd, out, err = remove_plugin(module, plugin_bin, name, allow_root, kibana_version) module.exit_json(changed=changed, cmd=cmd, name=name, state=state, url=url, timeout=timeout, stdout=out, stderr=err) if __name__ == '__main__': main() PK $�!\�6l��^ �^ L collections/ansible_collections/community/general/plugins/modules/sorcery.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015-2023, Vlad Glagolev <scm@vaygr.net> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: sorcery short_description: Package manager for Source Mage GNU/Linux description: - Manages "spells" on Source Mage GNU/Linux using I(sorcery) toolchain author: "Vlad Glagolev (@vaygr)" notes: - When all three components are selected, the update goes by the sequence -- Sorcery -> Grimoire(s) -> Spell(s); you cannot override it. - Grimoire handling is supported since community.general 7.3.0. requirements: - bash extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the spell or grimoire. - Multiple names can be given, separated by commas. - Special value V(*) in conjunction with states V(latest) or V(rebuild) will update or rebuild the whole system respectively - The alias O(grimoire) was added in community.general 7.3.0. aliases: ["spell", "grimoire"] type: list elements: str repository: description: - Repository location. - If specified, O(name) represents grimoire(s) instead of spell(s). - Special value V(*) will pull grimoire from the official location. - Only single item in O(name) in conjunction with V(*) can be used. - O(state=absent) must be used with a special value V(*). type: str version_added: 7.3.0 state: description: - Whether to cast, dispel or rebuild a package. - State V(cast) is an equivalent of V(present), not V(latest). - State V(rebuild) implies cast of all specified spells, not only those existed before. choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] default: "present" type: str depends: description: - Comma-separated list of _optional_ dependencies to build a spell (or make sure it is built) with; use V(+)/V(-) in front of dependency to turn it on/off (V(+) is optional though). - This option is ignored if O(name) parameter is equal to V(*) or contains more than one spell. - Providers must be supplied in the form recognized by Sorcery, for example 'V(openssl(SSL\))'. type: str update: description: - Whether or not to update sorcery scripts at the very first stage. type: bool default: false update_cache: description: - Whether or not to update grimoire collection before casting spells. type: bool default: false aliases: ["update_codex"] cache_valid_time: description: - Time in seconds to invalidate grimoire collection on update. - Especially useful for SCM and rsync grimoires. - Makes sense only in pair with O(update_cache). type: int default: 0 ''' EXAMPLES = ''' - name: Make sure spell foo is installed community.general.sorcery: spell: foo state: present - name: Make sure spells foo, bar and baz are removed community.general.sorcery: spell: foo,bar,baz state: absent - name: Make sure spell foo with dependencies bar and baz is installed community.general.sorcery: spell: foo depends: bar,baz state: present - name: Make sure spell foo with bar and without baz dependencies is installed community.general.sorcery: spell: foo depends: +bar,-baz state: present - name: Make sure spell foo with libressl (providing SSL) dependency is installed community.general.sorcery: spell: foo depends: libressl(SSL) state: present - name: Make sure spells with/without required dependencies (if any) are installed community.general.sorcery: name: "{{ item.spell }}" depends: "{{ item.depends | default(None) }}" state: present loop: - { spell: 'vifm', depends: '+file,-gtk+2' } - { spell: 'fwknop', depends: 'gpgme' } - { spell: 'pv,tnftp,tor' } - name: Install the latest version of spell foo using regular glossary community.general.sorcery: name: foo state: latest - name: Rebuild spell foo community.general.sorcery: spell: foo state: rebuild - name: Rebuild the whole system, but update Sorcery and Codex first community.general.sorcery: spell: '*' state: rebuild update: true update_cache: true - name: Refresh the grimoire collection if it is 1 day old using native sorcerous alias community.general.sorcery: update_codex: true cache_valid_time: 86400 - name: Make sure stable grimoire is present community.general.sorcery: name: stable repository: '*' state: present - name: Make sure binary and stable-rc grimoires are removed community.general.sorcery: grimoire: binary,stable-rc repository: '*' state: absent - name: Make sure games grimoire is pulled from rsync community.general.sorcery: grimoire: games repository: "rsync://download.sourcemage.org::codex/games" state: present - name: Make sure a specific branch of stable grimoire is pulled from git community.general.sorcery: grimoire: stable.git repository: "git://download.sourcemage.org/smgl/grimoire.git:stable.git:stable-0.62" state: present - name: Update only Sorcery itself community.general.sorcery: update: true ''' RETURN = ''' ''' import datetime import fileinput import os import re import shutil import sys from ansible.module_utils.basic import AnsibleModule # auto-filled at module init SORCERY = { 'sorcery': None, 'scribe': None, 'cast': None, 'dispel': None, 'gaze': None } SORCERY_LOG_DIR = "/var/log/sorcery" SORCERY_STATE_DIR = "/var/state/sorcery" NA = "N/A" def get_sorcery_ver(module): """ Get Sorcery version. """ cmd_sorcery = "%s --version" % SORCERY['sorcery'] rc, stdout, stderr = module.run_command(cmd_sorcery) if rc != 0 or not stdout: module.fail_json(msg="unable to get Sorcery version") return stdout.strip() def codex_fresh(codex, module): """ Check if grimoire collection is fresh enough. """ if not module.params['cache_valid_time']: return False timedelta = datetime.timedelta(seconds=module.params['cache_valid_time']) for grimoire in codex: lastupdate_path = os.path.join(SORCERY_STATE_DIR, grimoire + ".lastupdate") try: mtime = os.stat(lastupdate_path).st_mtime except Exception: return False lastupdate_ts = datetime.datetime.fromtimestamp(mtime) # if any grimoire is not fresh, we invalidate the Codex if lastupdate_ts + timedelta < datetime.datetime.now(): return False return True def codex_list(module, skip_new=False): """ List valid grimoire collection. """ params = module.params codex = {} cmd_scribe = "%s index" % SORCERY['scribe'] rc, stdout, stderr = module.run_command(cmd_scribe) if rc != 0: module.fail_json(msg="unable to list grimoire collection, fix your Codex") rex = re.compile(r"^\s*\[\d+\] : (?P<grim>[\w\-+.]+) : [\w\-+./]+(?: : (?P<ver>[\w\-+.]+))?\s*$") # drop 4-line header and empty trailing line for line in stdout.splitlines()[4:-1]: match = rex.match(line) if match: codex[match.group('grim')] = match.group('ver') # return only specified grimoires unless requested to skip new if params['repository'] and not skip_new: codex = dict((x, codex.get(x, NA)) for x in params['name']) if not codex: module.fail_json(msg="no grimoires to operate on; add at least one") return codex def update_sorcery(module): """ Update sorcery scripts. This runs 'sorcery update' ('sorcery -u'). Check mode always returns a positive change value. """ changed = False if module.check_mode: return (True, "would have updated Sorcery") else: sorcery_ver = get_sorcery_ver(module) cmd_sorcery = "%s update" % SORCERY['sorcery'] rc, stdout, stderr = module.run_command(cmd_sorcery) if rc != 0: module.fail_json(msg="unable to update Sorcery: " + stdout) if sorcery_ver != get_sorcery_ver(module): changed = True return (changed, "successfully updated Sorcery") def update_codex(module): """ Update grimoire collections. This runs 'scribe update'. Check mode always returns a positive change value when 'cache_valid_time' is used. """ params = module.params changed = False codex = codex_list(module) fresh = codex_fresh(codex, module) if module.check_mode: if not fresh: changed = True return (changed, "would have updated Codex") else: if not fresh: # SILENT is required as a workaround for query() in libgpg module.run_command_environ_update.update(dict(SILENT='1')) cmd_scribe = "%s update" % SORCERY['scribe'] if params['repository']: cmd_scribe += ' %s' % ' '.join(codex.keys()) rc, stdout, stderr = module.run_command(cmd_scribe) if rc != 0: module.fail_json(msg="unable to update Codex: " + stdout) if codex != codex_list(module): changed = True return (changed, "successfully updated Codex") def match_depends(module): """ Check for matching dependencies. This inspects spell's dependencies with the desired states and returns 'False' if a recast is needed to match them. It also adds required lines to the system-wide depends file for proper recast procedure. """ params = module.params spells = params['name'] depends = {} depends_ok = True if len(spells) > 1 or not params['depends']: return depends_ok spell = spells[0] if module.check_mode: sorcery_depends_orig = os.path.join(SORCERY_STATE_DIR, "depends") sorcery_depends = os.path.join(SORCERY_STATE_DIR, "depends.check") try: shutil.copy2(sorcery_depends_orig, sorcery_depends) except IOError: module.fail_json(msg="failed to copy depends.check file") else: sorcery_depends = os.path.join(SORCERY_STATE_DIR, "depends") rex = re.compile(r"^(?P<status>\+?|\-){1}(?P<depend>[a-z0-9]+[a-z0-9_\-\+\.]*(\([A-Z0-9_\-\+\.]+\))*)$") for d in params['depends'].split(','): match = rex.match(d) if not match: module.fail_json(msg="wrong depends line for spell '%s'" % spell) # normalize status if not match.group('status') or match.group('status') == '+': status = 'on' else: status = 'off' depends[match.group('depend')] = status # drop providers spec depends_list = [s.split('(')[0] for s in depends] cmd_gaze = "%s -q version %s" % (SORCERY['gaze'], ' '.join(depends_list)) rc, stdout, stderr = module.run_command(cmd_gaze) if rc != 0: module.fail_json(msg="wrong dependencies for spell '%s'" % spell) fi = fileinput.input(sorcery_depends, inplace=True) try: try: for line in fi: if line.startswith(spell + ':'): match = None for d in depends: # when local status is 'off' and dependency is provider, # use only provider value d_offset = d.find('(') if d_offset == -1: d_p = '' else: d_p = re.escape(d[d_offset:]) # .escape() is needed mostly for the spells like 'libsigc++' rex = re.compile("%s:(?:%s|%s):(?P<lstatus>on|off):optional:" % (re.escape(spell), re.escape(d), d_p)) match = rex.match(line) # we matched the line "spell:dependency:on|off:optional:" if match: # if we also matched the local status, mark dependency # as empty and put it back into depends file if match.group('lstatus') == depends[d]: depends[d] = None sys.stdout.write(line) # status is not that we need, so keep this dependency # in the list for further reverse switching; # stop and process the next line in both cases break if not match: sys.stdout.write(line) else: sys.stdout.write(line) except IOError: module.fail_json(msg="I/O error on the depends file") finally: fi.close() depends_new = [v for v in depends if depends[v]] if depends_new: try: try: fl = open(sorcery_depends, 'a') for k in depends_new: fl.write("%s:%s:%s:optional::\n" % (spell, k, depends[k])) except IOError: module.fail_json(msg="I/O error on the depends file") finally: fl.close() depends_ok = False if module.check_mode: try: os.remove(sorcery_depends) except IOError: module.fail_json(msg="failed to clean up depends.backup file") return depends_ok def manage_grimoires(module): """ Add or remove grimoires. """ params = module.params grimoires = params['name'] url = params['repository'] codex = codex_list(module, True) if url == '*': if params['state'] in ('present', 'latest', 'absent'): if params['state'] == 'absent': action = "remove" todo = set(grimoires) & set(codex) else: action = "add" todo = set(grimoires) - set(codex) if not todo: return (False, "all grimoire(s) are already %sed" % action[:5]) if module.check_mode: return (True, "would have %sed grimoire(s)" % action[:5]) cmd_scribe = "%s %s %s" % (SORCERY['scribe'], action, ' '.join(todo)) rc, stdout, stderr = module.run_command(cmd_scribe) if rc != 0: module.fail_json(msg="failed to %s one or more grimoire(s): %s" % (action, stdout)) return (True, "successfully %sed one or more grimoire(s)" % action[:5]) else: module.fail_json(msg="unsupported operation on '*' repository value") else: if params['state'] in ('present', 'latest'): if len(grimoires) > 1: module.fail_json(msg="using multiple items with repository is invalid") grimoire = grimoires[0] if grimoire in codex: return (False, "grimoire %s already exists" % grimoire) if module.check_mode: return (True, "would have added grimoire %s from %s" % (grimoire, url)) cmd_scribe = "%s add %s from %s" % (SORCERY['scribe'], grimoire, url) rc, stdout, stderr = module.run_command(cmd_scribe) if rc != 0: module.fail_json(msg="failed to add grimoire %s from %s: %s" % (grimoire, url, stdout)) return (True, "successfully added grimoire %s from %s" % (grimoire, url)) else: module.fail_json(msg="unsupported operation on repository value") def manage_spells(module): """ Cast or dispel spells. This manages the whole system ('*'), list or a single spell. Command 'cast' is used to install or rebuild spells, while 'dispel' takes care of theirs removal from the system. """ params = module.params spells = params['name'] sorcery_queue = os.path.join(SORCERY_LOG_DIR, "queue/install") if spells == '*': if params['state'] == 'latest': # back up original queue try: os.rename(sorcery_queue, sorcery_queue + ".backup") except IOError: module.fail_json(msg="failed to backup the update queue") # see update_codex() module.run_command_environ_update.update(dict(SILENT='1')) cmd_sorcery = "%s queue" % SORCERY['sorcery'] rc, stdout, stderr = module.run_command(cmd_sorcery) if rc != 0: module.fail_json(msg="failed to generate the update queue") try: queue_size = os.stat(sorcery_queue).st_size except Exception: module.fail_json(msg="failed to read the update queue") if queue_size != 0: if module.check_mode: try: os.rename(sorcery_queue + ".backup", sorcery_queue) except IOError: module.fail_json(msg="failed to restore the update queue") return (True, "would have updated the system") cmd_cast = "%s --queue" % SORCERY['cast'] rc, stdout, stderr = module.run_command(cmd_cast) if rc != 0: module.fail_json(msg="failed to update the system") return (True, "successfully updated the system") else: return (False, "the system is already up to date") elif params['state'] == 'rebuild': if module.check_mode: return (True, "would have rebuilt the system") cmd_sorcery = "%s rebuild" % SORCERY['sorcery'] rc, stdout, stderr = module.run_command(cmd_sorcery) if rc != 0: module.fail_json(msg="failed to rebuild the system: " + stdout) return (True, "successfully rebuilt the system") else: module.fail_json(msg="unsupported operation on '*' name value") else: if params['state'] in ('present', 'latest', 'rebuild', 'absent'): # extract versions from the 'gaze' command cmd_gaze = "%s -q version %s" % (SORCERY['gaze'], ' '.join(spells)) rc, stdout, stderr = module.run_command(cmd_gaze) # fail if any of spells cannot be found if rc != 0: module.fail_json(msg="failed to locate spell(s) in the list (%s)" % ', '.join(spells)) cast_queue = [] dispel_queue = [] rex = re.compile(r"[^|]+\|[^|]+\|(?P<spell>[^|]+)\|(?P<grim_ver>[^|]+)\|(?P<inst_ver>[^$]+)") # drop 2-line header and empty trailing line for line in stdout.splitlines()[2:-1]: match = rex.match(line) cast = False if params['state'] == 'present': # spell is not installed.. if match.group('inst_ver') == '-': # ..so set up depends reqs for it match_depends(module) cast = True # spell is installed.. else: # ..but does not conform depends reqs if not match_depends(module): cast = True elif params['state'] == 'latest': # grimoire and installed versions do not match.. if match.group('grim_ver') != match.group('inst_ver'): # ..so check for depends reqs first and set them up match_depends(module) cast = True # grimoire and installed versions match.. else: # ..but the spell does not conform depends reqs if not match_depends(module): cast = True elif params['state'] == 'rebuild': cast = True # 'absent' else: if match.group('inst_ver') != '-': dispel_queue.append(match.group('spell')) if cast: cast_queue.append(match.group('spell')) if cast_queue: if module.check_mode: return (True, "would have cast spell(s)") cmd_cast = "%s -c %s" % (SORCERY['cast'], ' '.join(cast_queue)) rc, stdout, stderr = module.run_command(cmd_cast) if rc != 0: module.fail_json(msg="failed to cast spell(s): " + stdout) return (True, "successfully cast spell(s)") elif params['state'] != 'absent': return (False, "spell(s) are already cast") if dispel_queue: if module.check_mode: return (True, "would have dispelled spell(s)") cmd_dispel = "%s %s" % (SORCERY['dispel'], ' '.join(dispel_queue)) rc, stdout, stderr = module.run_command(cmd_dispel) if rc != 0: module.fail_json(msg="failed to dispel spell(s): " + stdout) return (True, "successfully dispelled spell(s)") else: return (False, "spell(s) are already dispelled") def main(): module = AnsibleModule( argument_spec=dict( name=dict(default=None, aliases=['spell', 'grimoire'], type='list', elements='str'), repository=dict(default=None, type='str'), state=dict(default='present', choices=['present', 'latest', 'absent', 'cast', 'dispelled', 'rebuild']), depends=dict(default=None), update=dict(default=False, type='bool'), update_cache=dict(default=False, aliases=['update_codex'], type='bool'), cache_valid_time=dict(default=0, type='int') ), required_one_of=[['name', 'update', 'update_cache']], supports_check_mode=True ) if os.geteuid() != 0: module.fail_json(msg="root privileges are required for this operation") for c in SORCERY: SORCERY[c] = module.get_bin_path(c, True) # prepare environment: run sorcery commands without asking questions module.run_command_environ_update = dict(PROMPT_DELAY='0', VOYEUR='0') params = module.params # normalize 'state' parameter if params['state'] in ('present', 'cast'): params['state'] = 'present' elif params['state'] in ('absent', 'dispelled'): params['state'] = 'absent' changed = { 'sorcery': (False, NA), 'grimoires': (False, NA), 'codex': (False, NA), 'spells': (False, NA) } if params['update']: changed['sorcery'] = update_sorcery(module) if params['name'] and params['repository']: changed['grimoires'] = manage_grimoires(module) if params['update_cache']: changed['codex'] = update_codex(module) if params['name'] and not params['repository']: changed['spells'] = manage_spells(module) if any(x[0] for x in changed.values()): state_msg = "state changed" state_changed = True else: state_msg = "no change in state" state_changed = False module.exit_json(changed=state_changed, msg=state_msg + ": " + '; '.join(x[1] for x in changed.values())) if __name__ == '__main__': main() PK $�!\&k Lh Lh S collections/ansible_collections/community/general/plugins/modules/gitlab_project.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Guillaume Martinez (lunik@tiwabbit.fr) # Copyright (c) 2015, Werner Dijkerman (ikben@werner-dijkerman.nl) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: gitlab_project short_description: Creates/updates/deletes GitLab Projects description: - When the project does not exist in GitLab, it will be created. - When the project does exists and O(state=absent), the project will be deleted. - When changes are made to the project, the project will be updated. author: - Werner Dijkerman (@dj-wasabi) - Guillaume Martinez (@Lunik) requirements: - python >= 2.7 - python-gitlab python module extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: group: description: - Id or the full path of the group of which this projects belongs to. type: str name: description: - The name of the project. required: true type: str path: description: - The path of the project you want to create, this will be server_url/<group>/path. - If not supplied, name will be used. type: str description: description: - An description for the project. type: str initialize_with_readme: description: - Will initialize the project with a default C(README.md). - Is only used when the project is created, and ignored otherwise. type: bool default: false version_added: "4.0.0" issues_enabled: description: - Whether you want to create issues or not. - Possible values are true and false. type: bool default: true merge_requests_enabled: description: - If merge requests can be made or not. - Possible values are true and false. type: bool default: true wiki_enabled: description: - If an wiki for this project should be available or not. type: bool default: true snippets_enabled: description: - If creating snippets should be available or not. type: bool default: true visibility: description: - V(private) Project access must be granted explicitly for each user. - V(internal) The project can be cloned by any logged in user. - V(public) The project can be cloned without any authentication. default: private type: str choices: ["private", "internal", "public"] aliases: - visibility_level import_url: description: - Git repository which will be imported into gitlab. - GitLab server needs read access to this git repository. required: false type: str state: description: - Create or delete project. - Possible values are present and absent. default: present type: str choices: ["present", "absent"] merge_method: description: - What requirements are placed upon merges. - Possible values are V(merge), V(rebase_merge) merge commit with semi-linear history, V(ff) fast-forward merges only. type: str choices: ["ff", "merge", "rebase_merge"] default: merge version_added: "1.0.0" lfs_enabled: description: - Enable Git large file systems to manages large files such as audio, video, and graphics files. type: bool required: false default: false version_added: "2.0.0" username: description: - Used to create a personal project under a user's name. type: str version_added: "3.3.0" allow_merge_on_skipped_pipeline: description: - Allow merge when skipped pipelines exist. type: bool version_added: "3.4.0" only_allow_merge_if_all_discussions_are_resolved: description: - All discussions on a merge request (MR) have to be resolved. type: bool version_added: "3.4.0" only_allow_merge_if_pipeline_succeeds: description: - Only allow merges if pipeline succeeded. type: bool version_added: "3.4.0" packages_enabled: description: - Enable GitLab package repository. type: bool version_added: "3.4.0" remove_source_branch_after_merge: description: - Remove the source branch after merge. type: bool version_added: "3.4.0" squash_option: description: - Squash commits when merging. type: str choices: ["never", "always", "default_off", "default_on"] version_added: "3.4.0" ci_config_path: description: - Custom path to the CI configuration file for this project. type: str version_added: "3.7.0" shared_runners_enabled: description: - Enable shared runners for this project. type: bool version_added: "3.7.0" avatar_path: description: - Absolute path image to configure avatar. File size should not exceed 200 kb. - This option is only used on creation, not for updates. type: path version_added: "4.2.0" default_branch: description: - Default branch name for a new project. - This option is only used on creation, not for updates. This is also only used if O(initialize_with_readme=true). type: str version_added: "4.2.0" builds_access_level: description: - V(private) means that repository CI/CD is allowed only to project members. - V(disabled) means that repository CI/CD is disabled. - V(enabled) means that repository CI/CD is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.2.0" forking_access_level: description: - V(private) means that repository forks is allowed only to project members. - V(disabled) means that repository forks are disabled. - V(enabled) means that repository forks are enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.2.0" container_registry_access_level: description: - V(private) means that container registry is allowed only to project members. - V(disabled) means that container registry is disabled. - V(enabled) means that container registry is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.2.0" releases_access_level: description: - V(private) means that accessing release is allowed only to project members. - V(disabled) means that accessing release is disabled. - V(enabled) means that accessing release is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" environments_access_level: description: - V(private) means that deployment to environment is allowed only to project members. - V(disabled) means that deployment to environment is disabled. - V(enabled) means that deployment to environment is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" feature_flags_access_level: description: - V(private) means that feature rollout is allowed only to project members. - V(disabled) means that feature rollout is disabled. - V(enabled) means that feature rollout is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" infrastructure_access_level: description: - V(private) means that configuring infrastructure is allowed only to project members. - V(disabled) means that configuring infrastructure is disabled. - V(enabled) means that configuring infrastructure is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" monitor_access_level: description: - V(private) means that monitoring health is allowed only to project members. - V(disabled) means that monitoring health is disabled. - V(enabled) means that monitoring health is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" security_and_compliance_access_level: description: - V(private) means that accessing security and complicance tab is allowed only to project members. - V(disabled) means that accessing security and complicance tab is disabled. - V(enabled) means that accessing security and complicance tab is enabled. type: str choices: ["private", "disabled", "enabled"] version_added: "6.4.0" topics: description: - A topic or list of topics to be assigned to a project. - It is compatible with old GitLab server releases (versions before 14, correspond to C(tag_list)). type: list elements: str version_added: "6.6.0" ''' EXAMPLES = r''' - name: Create GitLab Project community.general.gitlab_project: api_url: https://gitlab.example.com/ api_token: "{{ api_token }}" name: my_first_project group: "10481470" - name: Delete GitLab Project community.general.gitlab_project: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" validate_certs: false name: my_first_project state: absent delegate_to: localhost - name: Create GitLab Project in group Ansible community.general.gitlab_project: api_url: https://gitlab.example.com/ validate_certs: true api_username: dj-wasabi api_password: "MySecretPassword" name: my_first_project group: ansible issues_enabled: false merge_method: rebase_merge wiki_enabled: true snippets_enabled: true import_url: http://git.example.com/example/lab.git initialize_with_readme: true state: present delegate_to: localhost - name: get the initial root password ansible.builtin.shell: | grep 'Password:' /etc/gitlab/initial_root_password | sed -e 's/Password\: \(.*\)/\1/' register: initial_root_password - name: Create a GitLab Project using a username/password via oauth_token community.general.gitlab_project: api_url: https://gitlab.example.com/ api_username: root api_password: "{{ initial_root_password }}" name: my_second_project group: "10481470" ''' RETURN = r''' msg: description: Success or failure message. returned: always type: str sample: "Success" result: description: json parsed response from the server. returned: always type: dict error: description: the error message returned by the GitLab API. returned: failed type: str sample: "400: path is already in use" project: description: API object. returned: always type: dict ''' from ansible.module_utils.api import basic_auth_argument_spec from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, find_group, find_project, gitlab_authentication, gitlab, ensure_gitlab_package ) from ansible_collections.community.general.plugins.module_utils.version import LooseVersion class GitLabProject(object): def __init__(self, module, gitlab_instance): self._module = module self._gitlab = gitlab_instance self.project_object = None ''' @param project_name Name of the project @param namespace Namespace Object (User or Group) @param options Options of the project ''' def create_or_update_project(self, project_name, namespace, options): changed = False project_options = { 'name': project_name, 'description': options['description'], 'issues_enabled': options['issues_enabled'], 'merge_requests_enabled': options['merge_requests_enabled'], 'merge_method': options['merge_method'], 'wiki_enabled': options['wiki_enabled'], 'snippets_enabled': options['snippets_enabled'], 'visibility': options['visibility'], 'lfs_enabled': options['lfs_enabled'], 'allow_merge_on_skipped_pipeline': options['allow_merge_on_skipped_pipeline'], 'only_allow_merge_if_all_discussions_are_resolved': options['only_allow_merge_if_all_discussions_are_resolved'], 'only_allow_merge_if_pipeline_succeeds': options['only_allow_merge_if_pipeline_succeeds'], 'packages_enabled': options['packages_enabled'], 'remove_source_branch_after_merge': options['remove_source_branch_after_merge'], 'squash_option': options['squash_option'], 'ci_config_path': options['ci_config_path'], 'shared_runners_enabled': options['shared_runners_enabled'], 'builds_access_level': options['builds_access_level'], 'forking_access_level': options['forking_access_level'], 'container_registry_access_level': options['container_registry_access_level'], 'releases_access_level': options['releases_access_level'], 'environments_access_level': options['environments_access_level'], 'feature_flags_access_level': options['feature_flags_access_level'], 'infrastructure_access_level': options['infrastructure_access_level'], 'monitor_access_level': options['monitor_access_level'], 'security_and_compliance_access_level': options['security_and_compliance_access_level'], } # topics was introduced on gitlab >=14 and replace tag_list. We get current gitlab version # and check if less than 14. If yes we use tag_list instead topics if LooseVersion(self._gitlab.version()[0]) < LooseVersion("14"): project_options['tag_list'] = options['topics'] else: project_options['topics'] = options['topics'] # Because we have already call userExists in main() if self.project_object is None: project_options.update({ 'path': options['path'], 'import_url': options['import_url'], }) if options['initialize_with_readme']: project_options['initialize_with_readme'] = options['initialize_with_readme'] if options['default_branch']: project_options['default_branch'] = options['default_branch'] project_options = self.get_options_with_value(project_options) project = self.create_project(namespace, project_options) # add avatar to project if options['avatar_path']: try: project.avatar = open(options['avatar_path'], 'rb') except IOError as e: self._module.fail_json(msg='Cannot open {0}: {1}'.format(options['avatar_path'], e)) changed = True else: changed, project = self.update_project(self.project_object, project_options) self.project_object = project if changed: if self._module.check_mode: self._module.exit_json(changed=True, msg="Successfully created or updated the project %s" % project_name) try: project.save() except Exception as e: self._module.fail_json(msg="Failed update project: %s " % e) return True return False ''' @param namespace Namespace Object (User or Group) @param arguments Attributes of the project ''' def create_project(self, namespace, arguments): if self._module.check_mode: return True arguments['namespace_id'] = namespace.id try: project = self._gitlab.projects.create(arguments) except (gitlab.exceptions.GitlabCreateError) as e: self._module.fail_json(msg="Failed to create project: %s " % to_native(e)) return project ''' @param arguments Attributes of the project ''' def get_options_with_value(self, arguments): ret_arguments = dict() for arg_key, arg_value in arguments.items(): if arguments[arg_key] is not None: ret_arguments[arg_key] = arg_value return ret_arguments ''' @param project Project Object @param arguments Attributes of the project ''' def update_project(self, project, arguments): changed = False for arg_key, arg_value in arguments.items(): if arguments[arg_key] is not None: if getattr(project, arg_key) != arguments[arg_key]: setattr(project, arg_key, arguments[arg_key]) changed = True return (changed, project) def delete_project(self): if self._module.check_mode: return True project = self.project_object return project.delete() ''' @param namespace User/Group object @param name Name of the project ''' def exists_project(self, namespace, path): # When project exists, object will be stored in self.project_object. project = find_project(self._gitlab, namespace.full_path + '/' + path) if project: self.project_object = project return True return False def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update(dict( group=dict(type='str'), name=dict(type='str', required=True), path=dict(type='str'), description=dict(type='str'), initialize_with_readme=dict(type='bool', default=False), default_branch=dict(type='str'), issues_enabled=dict(type='bool', default=True), merge_requests_enabled=dict(type='bool', default=True), merge_method=dict(type='str', default='merge', choices=["merge", "rebase_merge", "ff"]), wiki_enabled=dict(type='bool', default=True), snippets_enabled=dict(default=True, type='bool'), visibility=dict(type='str', default="private", choices=["internal", "private", "public"], aliases=["visibility_level"]), import_url=dict(type='str'), state=dict(type='str', default="present", choices=["absent", "present"]), lfs_enabled=dict(default=False, type='bool'), username=dict(type='str'), allow_merge_on_skipped_pipeline=dict(type='bool'), only_allow_merge_if_all_discussions_are_resolved=dict(type='bool'), only_allow_merge_if_pipeline_succeeds=dict(type='bool'), packages_enabled=dict(type='bool'), remove_source_branch_after_merge=dict(type='bool'), squash_option=dict(type='str', choices=['never', 'always', 'default_off', 'default_on']), ci_config_path=dict(type='str'), shared_runners_enabled=dict(type='bool'), avatar_path=dict(type='path'), builds_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), forking_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), container_registry_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), releases_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), environments_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), feature_flags_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), infrastructure_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), monitor_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), security_and_compliance_access_level=dict(type='str', choices=['private', 'disabled', 'enabled']), topics=dict(type='list', elements='str'), )) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ['group', 'username'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'] ], supports_check_mode=True, ) ensure_gitlab_package(module) group_identifier = module.params['group'] project_name = module.params['name'] project_path = module.params['path'] project_description = module.params['description'] initialize_with_readme = module.params['initialize_with_readme'] issues_enabled = module.params['issues_enabled'] merge_requests_enabled = module.params['merge_requests_enabled'] merge_method = module.params['merge_method'] wiki_enabled = module.params['wiki_enabled'] snippets_enabled = module.params['snippets_enabled'] visibility = module.params['visibility'] import_url = module.params['import_url'] state = module.params['state'] lfs_enabled = module.params['lfs_enabled'] username = module.params['username'] allow_merge_on_skipped_pipeline = module.params['allow_merge_on_skipped_pipeline'] only_allow_merge_if_all_discussions_are_resolved = module.params['only_allow_merge_if_all_discussions_are_resolved'] only_allow_merge_if_pipeline_succeeds = module.params['only_allow_merge_if_pipeline_succeeds'] packages_enabled = module.params['packages_enabled'] remove_source_branch_after_merge = module.params['remove_source_branch_after_merge'] squash_option = module.params['squash_option'] ci_config_path = module.params['ci_config_path'] shared_runners_enabled = module.params['shared_runners_enabled'] avatar_path = module.params['avatar_path'] default_branch = module.params['default_branch'] builds_access_level = module.params['builds_access_level'] forking_access_level = module.params['forking_access_level'] container_registry_access_level = module.params['container_registry_access_level'] releases_access_level = module.params['releases_access_level'] environments_access_level = module.params['environments_access_level'] feature_flags_access_level = module.params['feature_flags_access_level'] infrastructure_access_level = module.params['infrastructure_access_level'] monitor_access_level = module.params['monitor_access_level'] security_and_compliance_access_level = module.params['security_and_compliance_access_level'] topics = module.params['topics'] if default_branch and not initialize_with_readme: module.fail_json(msg="Param default_branch need param initialize_with_readme set to true") gitlab_instance = gitlab_authentication(module) # Set project_path to project_name if it is empty. if project_path is None: project_path = project_name.replace(" ", "_") gitlab_project = GitLabProject(module, gitlab_instance) namespace = None namespace_id = None if group_identifier: group = find_group(gitlab_instance, group_identifier) if group is None: module.fail_json(msg="Failed to create project: group %s doesn't exists" % group_identifier) namespace_id = group.id else: if username: namespace = gitlab_instance.namespaces.list(search=username, all=False)[0] else: namespace = gitlab_instance.namespaces.list(search=gitlab_instance.user.username, all=False)[0] namespace_id = namespace.id if not namespace_id: module.fail_json(msg="Failed to find the namespace or group ID which is required to look up the namespace") try: namespace = gitlab_instance.namespaces.get(namespace_id) except gitlab.exceptions.GitlabGetError as e: module.fail_json(msg="Failed to find the namespace for the given user: %s" % to_native(e)) if not namespace: module.fail_json(msg="Failed to find the namespace for the project") project_exists = gitlab_project.exists_project(namespace, project_path) if state == 'absent': if project_exists: gitlab_project.delete_project() module.exit_json(changed=True, msg="Successfully deleted project %s" % project_name) module.exit_json(changed=False, msg="Project deleted or does not exists") if state == 'present': if gitlab_project.create_or_update_project(project_name, namespace, { "path": project_path, "description": project_description, "initialize_with_readme": initialize_with_readme, "default_branch": default_branch, "issues_enabled": issues_enabled, "merge_requests_enabled": merge_requests_enabled, "merge_method": merge_method, "wiki_enabled": wiki_enabled, "snippets_enabled": snippets_enabled, "visibility": visibility, "import_url": import_url, "lfs_enabled": lfs_enabled, "allow_merge_on_skipped_pipeline": allow_merge_on_skipped_pipeline, "only_allow_merge_if_all_discussions_are_resolved": only_allow_merge_if_all_discussions_are_resolved, "only_allow_merge_if_pipeline_succeeds": only_allow_merge_if_pipeline_succeeds, "packages_enabled": packages_enabled, "remove_source_branch_after_merge": remove_source_branch_after_merge, "squash_option": squash_option, "ci_config_path": ci_config_path, "shared_runners_enabled": shared_runners_enabled, "avatar_path": avatar_path, "builds_access_level": builds_access_level, "forking_access_level": forking_access_level, "container_registry_access_level": container_registry_access_level, "releases_access_level": releases_access_level, "environments_access_level": environments_access_level, "feature_flags_access_level": feature_flags_access_level, "infrastructure_access_level": infrastructure_access_level, "monitor_access_level": monitor_access_level, "security_and_compliance_access_level": security_and_compliance_access_level, "topics": topics, }): module.exit_json(changed=True, msg="Successfully created or updated the project %s" % project_name, project=gitlab_project.project_object._attrs) module.exit_json(changed=False, msg="No need to update the project %s" % project_name, project=gitlab_project.project_object._attrs) if __name__ == '__main__': main() PK $�!\<�r� � S collections/ansible_collections/community/general/plugins/modules/one_image_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Milan Ilic <milani@nordeus.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # Make coding more python3-ish from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: one_image_info short_description: Gather information on OpenNebula images description: - Gather information on OpenNebula images. - This module was called C(one_image_facts) before Ansible 2.9. The usage did not change. requirements: - pyone extends_documentation_fragment: - community.general.attributes - community.general.attributes.info_module options: api_url: description: - URL of the OpenNebula RPC server. - It is recommended to use HTTPS so that the username/password are not - transferred over the network unencrypted. - If not set then the value of the E(ONE_URL) environment variable is used. type: str api_username: description: - Name of the user to login into the OpenNebula RPC server. If not set - then the value of the E(ONE_USERNAME) environment variable is used. type: str api_password: description: - Password of the user to login into OpenNebula RPC server. If not set - then the value of the E(ONE_PASSWORD) environment variable is used. type: str ids: description: - A list of images ids whose facts you want to gather. aliases: ['id'] type: list elements: str name: description: - A O(name) of the image whose facts will be gathered. - If the O(name) begins with V(~) the O(name) will be used as regex pattern - which restricts the list of images (whose facts will be returned) whose names match specified regex. - Also, if the O(name) begins with V(~*) case-insensitive matching will be performed. - See examples for more details. type: str author: - "Milan Ilic (@ilicmilan)" - "Jan Meerkamp (@meerkampdvv)" ''' EXAMPLES = ''' - name: Gather facts about all images community.general.one_image_info: register: result - name: Print all images facts ansible.builtin.debug: msg: result - name: Gather facts about an image using ID community.general.one_image_info: ids: - 123 - name: Gather facts about an image using the name community.general.one_image_info: name: 'foo-image' register: foo_image - name: Gather facts about all IMAGEs whose name matches regex 'app-image-.*' community.general.one_image_info: name: '~app-image-.*' register: app_images - name: Gather facts about all IMAGEs whose name matches regex 'foo-image-.*' ignoring cases community.general.one_image_info: name: '~*foo-image-.*' register: foo_images ''' RETURN = ''' images: description: A list of images info type: complex returned: success contains: id: description: image id type: int sample: 153 name: description: image name type: str sample: app1 group_id: description: image's group id type: int sample: 1 group_name: description: image's group name type: str sample: one-users owner_id: description: image's owner id type: int sample: 143 owner_name: description: image's owner name type: str sample: ansible-test state: description: state of image instance type: str sample: READY used: description: is image in use type: bool sample: true running_vms: description: count of running vms that use this image type: int sample: 7 ''' try: import pyone HAS_PYONE = True except ImportError: HAS_PYONE = False from ansible.module_utils.basic import AnsibleModule import os def get_all_images(client): pool = client.imagepool.info(-2, -1, -1, -1) # Filter -2 means fetch all images user can Use return pool IMAGE_STATES = ['INIT', 'READY', 'USED', 'DISABLED', 'LOCKED', 'ERROR', 'CLONE', 'DELETE', 'USED_PERS', 'LOCKED_USED', 'LOCKED_USED_PERS'] def get_image_info(image): info = { 'id': image.ID, 'name': image.NAME, 'state': IMAGE_STATES[image.STATE], 'running_vms': image.RUNNING_VMS, 'used': bool(image.RUNNING_VMS), 'user_name': image.UNAME, 'user_id': image.UID, 'group_name': image.GNAME, 'group_id': image.GID, } return info def get_images_by_ids(module, client, ids): images = [] pool = get_all_images(client) for image in pool.IMAGE: if str(image.ID) in ids: images.append(image) ids.remove(str(image.ID)) if len(ids) == 0: break if len(ids) > 0: module.fail_json(msg='There is no IMAGE(s) with id(s)=' + ', '.join('{id}'.format(id=str(image_id)) for image_id in ids)) return images def get_images_by_name(module, client, name_pattern): images = [] pattern = None pool = get_all_images(client) if name_pattern.startswith('~'): import re if name_pattern[1] == '*': pattern = re.compile(name_pattern[2:], re.IGNORECASE) else: pattern = re.compile(name_pattern[1:]) for image in pool.IMAGE: if pattern is not None: if pattern.match(image.NAME): images.append(image) elif name_pattern == image.NAME: images.append(image) break # if the specific name is indicated if pattern is None and len(images) == 0: module.fail_json(msg="There is no IMAGE with name=" + name_pattern) return images def get_connection_info(module): url = module.params.get('api_url') username = module.params.get('api_username') password = module.params.get('api_password') if not url: url = os.environ.get('ONE_URL') if not username: username = os.environ.get('ONE_USERNAME') if not password: password = os.environ.get('ONE_PASSWORD') if not (url and username and password): module.fail_json(msg="One or more connection parameters (api_url, api_username, api_password) were not specified") from collections import namedtuple auth_params = namedtuple('auth', ('url', 'username', 'password')) return auth_params(url=url, username=username, password=password) def main(): fields = { "api_url": {"required": False, "type": "str"}, "api_username": {"required": False, "type": "str"}, "api_password": {"required": False, "type": "str", "no_log": True}, "ids": {"required": False, "aliases": ['id'], "type": "list", "elements": "str"}, "name": {"required": False, "type": "str"}, } module = AnsibleModule(argument_spec=fields, mutually_exclusive=[['ids', 'name']], supports_check_mode=True) if not HAS_PYONE: module.fail_json(msg='This module requires pyone to work!') auth = get_connection_info(module) params = module.params ids = params.get('ids') name = params.get('name') client = pyone.OneServer(auth.url, session=auth.username + ':' + auth.password) if ids: images = get_images_by_ids(module, client, ids) elif name: images = get_images_by_name(module, client, name) else: images = get_all_images(client).IMAGE result = { 'images': [get_image_info(image) for image in images], } module.exit_json(**result) if __name__ == '__main__': main() PK $�!\0!� l collections/ansible_collections/community/general/plugins/modules/oneview_logical_interconnect_group_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017, Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_logical_interconnect_group_info short_description: Retrieve information about one or more of the OneView Logical Interconnect Groups description: - Retrieve information about one or more of the Logical Interconnect Groups from OneView - This module was called C(oneview_logical_interconnect_group_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.oneview_logical_interconnect_group_info) module no longer returns C(ansible_facts)! requirements: - hpOneView >= 2.0.1 author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name: description: - Logical Interconnect Group name. type: str extends_documentation_fragment: - community.general.oneview - community.general.oneview.factsparams - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: Gather information about all Logical Interconnect Groups community.general.oneview_logical_interconnect_group_info: hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Logical Interconnect Groups ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" - name: Gather paginated, filtered and sorted information about Logical Interconnect Groups community.general.oneview_logical_interconnect_group_info: params: start: 0 count: 3 sort: name:descending filter: name=LIGName hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about paginated, filtered and sorted list of Logical Interconnect Groups ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" - name: Gather information about a Logical Interconnect Group by name community.general.oneview_logical_interconnect_group_info: name: logical interconnect group name hostname: 172.16.101.48 username: administrator password: my_password api_version: 500 no_log: true delegate_to: localhost register: result - name: Print fetched information about Logical Interconnect Group found by name ansible.builtin.debug: msg: "{{ result.logical_interconnect_groups }}" ''' RETURN = ''' logical_interconnect_groups: description: Has all the OneView information about the Logical Interconnect Groups. returned: Always, but can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class LogicalInterconnectGroupInfoModule(OneViewModuleBase): def __init__(self): argument_spec = dict( name=dict(type='str'), params=dict(type='dict'), ) super(LogicalInterconnectGroupInfoModule, self).__init__( additional_arg_spec=argument_spec, supports_check_mode=True, ) def execute_module(self): if self.module.params.get('name'): ligs = self.oneview_client.logical_interconnect_groups.get_by('name', self.module.params['name']) else: ligs = self.oneview_client.logical_interconnect_groups.get_all(**self.facts_params) return dict(changed=False, logical_interconnect_groups=ligs) def main(): LogicalInterconnectGroupInfoModule().run() if __name__ == '__main__': main() PK $�!\y�C;�$ �$ S collections/ansible_collections/community/general/plugins/modules/pagerduty_user.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Zainab Alsaffar <Zainab.Alsaffar@mail.rit.edu> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: pagerduty_user short_description: Manage a user account on PagerDuty description: - This module manages the creation/removal of a user account on PagerDuty. version_added: '1.3.0' author: Zainab Alsaffar (@zanssa) requirements: - pdpyras python module = 4.1.1 - PagerDuty API Access extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: access_token: description: - An API access token to authenticate with the PagerDuty REST API. required: true type: str pd_user: description: - Name of the user in PagerDuty. required: true type: str pd_email: description: - The user's email address. - O(pd_email) is the unique identifier used and cannot be updated using this module. required: true type: str pd_role: description: - The user's role. choices: ['global_admin', 'manager', 'responder', 'observer', 'stakeholder', 'limited_stakeholder', 'restricted_access'] default: 'responder' type: str state: description: - State of the user. - On V(present), it creates a user if the user doesn't exist. - On V(absent), it removes a user if the account exists. choices: ['present', 'absent'] default: 'present' type: str pd_teams: description: - The teams to which the user belongs. - Required if O(state=present). type: list elements: str ''' EXAMPLES = r''' - name: Create a user account on PagerDuty community.general.pagerduty_user: access_token: 'Your_Access_token' pd_user: user_full_name pd_email: user_email pd_role: user_pd_role pd_teams: user_pd_teams state: "present" - name: Remove a user account from PagerDuty community.general.pagerduty_user: access_token: 'Your_Access_token' pd_user: user_full_name pd_email: user_email state: "absent" ''' RETURN = r''' # ''' from os import path from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils import deps with deps.declare("pdpyras", url="https://github.com/PagerDuty/pdpyras"): from pdpyras import APISession, PDClientError class PagerDutyUser(object): def __init__(self, module, session): self._module = module self._apisession = session # check if the user exists def does_user_exist(self, pd_email): for user in self._apisession.iter_all('users'): if user['email'] == pd_email: return user['id'] # create a user account on PD def add_pd_user(self, pd_name, pd_email, pd_role): try: user = self._apisession.persist('users', 'email', { "name": pd_name, "email": pd_email, "type": "user", "role": pd_role, }) return user except PDClientError as e: if e.response.status_code == 400: self._module.fail_json( msg="Failed to add %s due to invalid argument" % (pd_name)) if e.response.status_code == 401: self._module.fail_json(msg="Failed to add %s due to invalid API key" % (pd_name)) if e.response.status_code == 402: self._module.fail_json( msg="Failed to add %s due to inability to perform the action within the API token" % (pd_name)) if e.response.status_code == 403: self._module.fail_json( msg="Failed to add %s due to inability to review the requested resource within the API token" % (pd_name)) if e.response.status_code == 429: self._module.fail_json( msg="Failed to add %s due to reaching the limit of making requests" % (pd_name)) # delete a user account from PD def delete_user(self, pd_user_id, pd_name): try: user_path = path.join('/users/', pd_user_id) self._apisession.rdelete(user_path) except PDClientError as e: if e.response.status_code == 404: self._module.fail_json( msg="Failed to remove %s as user was not found" % (pd_name)) if e.response.status_code == 403: self._module.fail_json( msg="Failed to remove %s due to inability to review the requested resource within the API token" % (pd_name)) if e.response.status_code == 401: # print out the list of incidents pd_incidents = self.get_incidents_assigned_to_user(pd_user_id) self._module.fail_json(msg="Failed to remove %s as user has assigned incidents %s" % (pd_name, pd_incidents)) if e.response.status_code == 429: self._module.fail_json( msg="Failed to remove %s due to reaching the limit of making requests" % (pd_name)) # get incidents assigned to a user def get_incidents_assigned_to_user(self, pd_user_id): incident_info = {} incidents = self._apisession.list_all('incidents', params={'user_ids[]': [pd_user_id]}) for incident in incidents: incident_info = { 'title': incident['title'], 'key': incident['incident_key'], 'status': incident['status'] } return incident_info # add a user to a team/teams def add_user_to_teams(self, pd_user_id, pd_teams, pd_role): updated_team = None for team in pd_teams: team_info = self._apisession.find('teams', team, attribute='name') if team_info is not None: try: updated_team = self._apisession.rput('/teams/' + team_info['id'] + '/users/' + pd_user_id, json={ 'role': pd_role }) except PDClientError: updated_team = None return updated_team def main(): module = AnsibleModule( argument_spec=dict( access_token=dict(type='str', required=True, no_log=True), pd_user=dict(type='str', required=True), pd_email=dict(type='str', required=True), state=dict(type='str', default='present', choices=['present', 'absent']), pd_role=dict(type='str', default='responder', choices=['global_admin', 'manager', 'responder', 'observer', 'stakeholder', 'limited_stakeholder', 'restricted_access']), pd_teams=dict(type='list', elements='str', required=False)), required_if=[['state', 'present', ['pd_teams']], ], supports_check_mode=True, ) deps.validate(module) access_token = module.params['access_token'] pd_user = module.params['pd_user'] pd_email = module.params['pd_email'] state = module.params['state'] pd_role = module.params['pd_role'] pd_teams = module.params['pd_teams'] if pd_role: pd_role_gui_value = { 'global_admin': 'admin', 'manager': 'user', 'responder': 'limited_user', 'observer': 'observer', 'stakeholder': 'read_only_user', 'limited_stakeholder': 'read_only_limited_user', 'restricted_access': 'restricted_access' } pd_role = pd_role_gui_value[pd_role] # authenticate with PD API try: session = APISession(access_token) except PDClientError as e: module.fail_json(msg="Failed to authenticate with PagerDuty: %s" % e) user = PagerDutyUser(module, session) user_exists = user.does_user_exist(pd_email) if user_exists: if state == "absent": # remove user if not module.check_mode: user.delete_user(user_exists, pd_user) module.exit_json(changed=True, result="Successfully deleted user %s" % pd_user) else: module.exit_json(changed=False, result="User %s already exists." % pd_user) # in case that the user does not exist else: if state == "absent": module.exit_json(changed=False, result="User %s was not found." % pd_user) else: # add user, adds user with the default notification rule and contact info (email) if not module.check_mode: user.add_pd_user(pd_user, pd_email, pd_role) # get user's id pd_user_id = user.does_user_exist(pd_email) # add a user to the team/s user.add_user_to_teams(pd_user_id, pd_teams, pd_role) module.exit_json(changed=True, result="Successfully created & added user %s to team %s" % (pd_user, pd_teams)) if __name__ == "__main__": main() PK $�!\H�� *? *? R collections/ansible_collections/community/general/plugins/modules/gitlab_runner.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Raphaël Droz (raphael.droz@gmail.com) # Copyright (c) 2019, Guillaume Martinez (lunik@tiwabbit.fr) # Copyright (c) 2018, Samy Coenen <samy.coenen@nubera.be> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: gitlab_runner short_description: Create, modify and delete GitLab Runners description: - Register, update and delete runners with the GitLab API. - All operations are performed using the GitLab API v4. - For details, consult the full API documentation at U(https://docs.gitlab.com/ee/api/runners.html). - A valid private API token is required for all operations. You can create as many tokens as you like using the GitLab web interface at U(https://$GITLAB_URL/profile/personal_access_tokens). - A valid registration token is required for registering a new runner. To create shared runners, you need to ask your administrator to give you this token. It can be found at U(https://$GITLAB_URL/admin/runners/). notes: - To create a new runner at least the O(api_token), O(description) and O(api_url) options are required. - Runners need to have unique descriptions. author: - Samy Coenen (@SamyCoenen) - Guillaume Martinez (@Lunik) requirements: - python >= 2.7 - python-gitlab >= 1.5.0 extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: group: description: - ID or full path of the group in the form group/subgroup. - Mutually exclusive with O(owned) and O(project). type: str version_added: '6.5.0' project: description: - ID or full path of the project in the form of group/name. - Mutually exclusive with O(owned) since community.general 4.5.0. - Mutually exclusive with O(group). type: str version_added: '3.7.0' description: description: - The unique name of the runner. required: true type: str aliases: - name state: description: - Make sure that the runner with the same name exists with the same configuration or delete the runner with the same name. required: false default: present choices: ["present", "absent"] type: str registration_token: description: - The registration token is used to register new runners. - Required if O(state=present). type: str owned: description: - Searches only runners available to the user when searching for existing, when false admin token required. - Mutually exclusive with O(project) since community.general 4.5.0. - Mutually exclusive with O(group). default: false type: bool version_added: 2.0.0 active: description: - Define if the runners is immediately active after creation. required: false default: true type: bool locked: description: - Determines if the runner is locked or not. required: false default: false type: bool access_level: description: - Determines if a runner can pick up jobs only from protected branches. - If O(access_level_on_creation) is not explicitly set to V(true), this option is ignored on registration and is only applied on updates. - If set to V(not_protected), runner can pick up jobs from both protected and unprotected branches. - If set to V(ref_protected), runner can pick up jobs only from protected branches. - The current default is V(ref_protected). This will change to no default in community.general 8.0.0. From that version on, if this option is not specified explicitly, GitLab will use V(not_protected) on creation, and the value set will not be changed on any updates. required: false choices: ["not_protected", "ref_protected"] type: str access_level_on_creation: description: - Whether the runner should be registered with an access level or not. - If set to V(true), the value of O(access_level) is used for runner registration. - If set to V(false), GitLab registers the runner with the default access level. - The default of this option changed to V(true) in community.general 7.0.0. Before, it was V(false). required: false default: true type: bool version_added: 6.3.0 maximum_timeout: description: - The maximum time that a runner has to complete a specific job. required: false default: 3600 type: int run_untagged: description: - Run untagged jobs or not. required: false default: true type: bool tag_list: description: The tags that apply to the runner. required: false default: [] type: list elements: str ''' EXAMPLES = ''' - name: "Register runner" community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" registration_token: 4gfdsg345 description: Docker Machine t1 state: present active: true tag_list: ['docker'] run_untagged: false locked: false - name: "Delete runner" community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 state: absent - name: Delete an owned runner as a non-admin community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" description: Docker Machine t1 owned: true state: absent - name: Register runner for a specific project community.general.gitlab_runner: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" registration_token: 4gfdsg345 description: MyProject runner state: present project: mygroup/mysubgroup/myproject ''' RETURN = ''' msg: description: Success or failure message returned: always type: str sample: "Success" result: description: json parsed response from the server returned: always type: dict error: description: the error message returned by the GitLab API returned: failed type: str sample: "400: path is already in use" runner: description: API object returned: always type: dict ''' from ansible.module_utils.api import basic_auth_argument_spec from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, gitlab_authentication, gitlab, ensure_gitlab_package ) class GitLabRunner(object): def __init__(self, module, gitlab_instance, group=None, project=None): self._module = module self._gitlab = gitlab_instance self.runner_object = None # Whether to operate on GitLab-instance-wide or project-wide runners # See https://gitlab.com/gitlab-org/gitlab-ce/issues/60774 # for group runner token access if project: self._runners_endpoint = project.runners.list elif group: self._runners_endpoint = group.runners.list elif module.params['owned']: self._runners_endpoint = gitlab_instance.runners.list else: self._runners_endpoint = gitlab_instance.runners.all def create_or_update_runner(self, description, options): changed = False arguments = { 'active': options['active'], 'locked': options['locked'], 'run_untagged': options['run_untagged'], 'maximum_timeout': options['maximum_timeout'], 'tag_list': options['tag_list'], } if options.get('access_level') is not None: arguments['access_level'] = options['access_level'] # Because we have already call userExists in main() if self.runner_object is None: arguments['description'] = description arguments['token'] = options['registration_token'] access_level_on_creation = self._module.params['access_level_on_creation'] if not access_level_on_creation: arguments.pop('access_level', None) runner = self.create_runner(arguments) changed = True else: changed, runner = self.update_runner(self.runner_object, arguments) self.runner_object = runner if changed: if self._module.check_mode: self._module.exit_json(changed=True, msg="Successfully created or updated the runner %s" % description) try: runner.save() except Exception as e: self._module.fail_json(msg="Failed to update runner: %s " % to_native(e)) return True else: return False ''' @param arguments Attributes of the runner ''' def create_runner(self, arguments): if self._module.check_mode: return True try: runner = self._gitlab.runners.create(arguments) except (gitlab.exceptions.GitlabCreateError) as e: self._module.fail_json(msg="Failed to create runner: %s " % to_native(e)) return runner ''' @param runner Runner object @param arguments Attributes of the runner ''' def update_runner(self, runner, arguments): changed = False for arg_key, arg_value in arguments.items(): if arguments[arg_key] is not None: if isinstance(arguments[arg_key], list): list1 = getattr(runner, arg_key) list1.sort() list2 = arguments[arg_key] list2.sort() if list1 != list2: setattr(runner, arg_key, arguments[arg_key]) changed = True else: if getattr(runner, arg_key) != arguments[arg_key]: setattr(runner, arg_key, arguments[arg_key]) changed = True return (changed, runner) ''' @param description Description of the runner ''' def find_runner(self, description): runners = self._runners_endpoint(as_list=False) for runner in runners: # python-gitlab 2.2 through at least 2.5 returns a list of dicts for list() instead of a Runner # object, so we need to handle both if hasattr(runner, "description"): if (runner.description == description): return self._gitlab.runners.get(runner.id) else: if (runner['description'] == description): return self._gitlab.runners.get(runner['id']) ''' @param description Description of the runner ''' def exists_runner(self, description): # When runner exists, object will be stored in self.runner_object. runner = self.find_runner(description) if runner: self.runner_object = runner return True return False def delete_runner(self): if self._module.check_mode: return True runner = self.runner_object return runner.delete() def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update(dict( description=dict(type='str', required=True, aliases=["name"]), active=dict(type='bool', default=True), owned=dict(type='bool', default=False), tag_list=dict(type='list', elements='str', default=[]), run_untagged=dict(type='bool', default=True), locked=dict(type='bool', default=False), access_level=dict(type='str', choices=["not_protected", "ref_protected"]), access_level_on_creation=dict(type='bool', default=True), maximum_timeout=dict(type='int', default=3600), registration_token=dict(type='str', no_log=True), project=dict(type='str'), group=dict(type='str'), state=dict(type='str', default="present", choices=["absent", "present"]), )) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ['project', 'owned'], ['group', 'owned'], ['project', 'group'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'], ], required_if=[ ('state', 'present', ['registration_token']), ], supports_check_mode=True, ) ensure_gitlab_package(module) state = module.params['state'] runner_description = module.params['description'] runner_active = module.params['active'] tag_list = module.params['tag_list'] run_untagged = module.params['run_untagged'] runner_locked = module.params['locked'] access_level = module.params['access_level'] maximum_timeout = module.params['maximum_timeout'] registration_token = module.params['registration_token'] project = module.params['project'] group = module.params['group'] if access_level is None: message = "The option 'access_level' is unspecified, so 'ref_protected' is assumed. "\ "In order to align the module with GitLab's runner API, this option will lose "\ "its default value in community.general 8.0.0. From that version on, you must set "\ "this option to 'ref_protected' explicitly, if you want to have a protected runner, "\ "otherwise GitLab's default access level gets applied, which is 'not_protected'" module.deprecate(message, version='8.0.0', collection_name='community.general') access_level = 'ref_protected' gitlab_instance = gitlab_authentication(module) gitlab_project = None gitlab_group = None if project: try: gitlab_project = gitlab_instance.projects.get(project) except gitlab.exceptions.GitlabGetError as e: module.fail_json(msg='No such a project %s' % project, exception=to_native(e)) elif group: try: gitlab_group = gitlab_instance.groups.get(group) except gitlab.exceptions.GitlabGetError as e: module.fail_json(msg='No such a group %s' % group, exception=to_native(e)) gitlab_runner = GitLabRunner(module, gitlab_instance, gitlab_group, gitlab_project) runner_exists = gitlab_runner.exists_runner(runner_description) if state == 'absent': if runner_exists: gitlab_runner.delete_runner() module.exit_json(changed=True, msg="Successfully deleted runner %s" % runner_description) else: module.exit_json(changed=False, msg="Runner deleted or does not exists") if state == 'present': if gitlab_runner.create_or_update_runner(runner_description, { "active": runner_active, "tag_list": tag_list, "run_untagged": run_untagged, "locked": runner_locked, "access_level": access_level, "maximum_timeout": maximum_timeout, "registration_token": registration_token, }): module.exit_json(changed=True, runner=gitlab_runner.runner_object._attrs, msg="Successfully created or updated the runner %s" % runner_description) else: module.exit_json(changed=False, runner=gitlab_runner.runner_object._attrs, msg="No need to update the runner %s" % runner_description) if __name__ == '__main__': main() PK $�!\i�� & & N collections/ansible_collections/community/general/plugins/modules/ipa_subca.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Abhijeet Kasurde (akasurde@redhat.com) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_subca author: Abhijeet Kasurde (@Akasurde) short_description: Manage FreeIPA Lightweight Sub Certificate Authorities description: - Add, modify, enable, disable and delete an IPA Lightweight Sub Certificate Authorities using IPA API. attributes: check_mode: support: full diff_mode: support: none options: subca_name: description: - The Sub Certificate Authority name which needs to be managed. required: true aliases: ["name"] type: str subca_subject: description: - The Sub Certificate Authority's Subject. e.g., 'CN=SampleSubCA1,O=testrelm.test'. required: true type: str subca_desc: description: - The Sub Certificate Authority's description. type: str state: description: - State to ensure. - State 'disable' and 'enable' is available for FreeIPA 4.4.2 version and onwards. required: false default: present choices: ["absent", "disabled", "enabled", "present"] type: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = ''' - name: Ensure IPA Sub CA is present community.general.ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: present subca_name: AnsibleSubCA1 subca_subject: 'CN=AnsibleSubCA1,O=example.com' subca_desc: Ansible Sub CA - name: Ensure that IPA Sub CA is removed community.general.ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: absent subca_name: AnsibleSubCA1 - name: Ensure that IPA Sub CA is disabled community.general.ipa_subca: ipa_host: spider.example.com ipa_pass: Passw0rd! state: disable subca_name: AnsibleSubCA1 ''' RETURN = r''' subca: description: IPA Sub CA record as returned by IPA API. returned: always type: dict ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.version import LooseVersion class SubCAIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(SubCAIPAClient, self).__init__(module, host, port, protocol) def subca_find(self, subca_name): return self._post_json(method='ca_find', name=subca_name, item=None) def subca_add(self, subca_name=None, subject_dn=None, details=None): item = dict(ipacasubjectdn=subject_dn) subca_desc = details.get('description', None) if subca_desc is not None: item.update(description=subca_desc) return self._post_json(method='ca_add', name=subca_name, item=item) def subca_mod(self, subca_name=None, diff=None, details=None): item = get_subca_dict(details) for change in diff: update_detail = dict() if item[change] is not None: update_detail.update(setattr="{0}={1}".format(change, item[change])) self._post_json(method='ca_mod', name=subca_name, item=update_detail) def subca_del(self, subca_name=None): return self._post_json(method='ca_del', name=subca_name) def subca_disable(self, subca_name=None): return self._post_json(method='ca_disable', name=subca_name) def subca_enable(self, subca_name=None): return self._post_json(method='ca_enable', name=subca_name) def get_subca_dict(details=None): module_subca = dict() if details['description'] is not None: module_subca['description'] = details['description'] if details['subca_subject'] is not None: module_subca['ipacasubjectdn'] = details['subca_subject'] return module_subca def get_subca_diff(client, ipa_subca, module_subca): details = get_subca_dict(module_subca) return client.get_diff(ipa_data=ipa_subca, module_data=details) def ensure(module, client): subca_name = module.params['subca_name'] subca_subject_dn = module.params['subca_subject'] subca_desc = module.params['subca_desc'] state = module.params['state'] ipa_subca = client.subca_find(subca_name) module_subca = dict(description=subca_desc, subca_subject=subca_subject_dn) changed = False if state == 'present': if not ipa_subca: changed = True if not module.check_mode: client.subca_add(subca_name=subca_name, subject_dn=subca_subject_dn, details=module_subca) else: diff = get_subca_diff(client, ipa_subca, module_subca) # IPA does not allow to modify Sub CA's subject DN # So skip it for now. if 'ipacasubjectdn' in diff: diff.remove('ipacasubjectdn') del module_subca['subca_subject'] if len(diff) > 0: changed = True if not module.check_mode: client.subca_mod(subca_name=subca_name, diff=diff, details=module_subca) elif state == 'absent': if ipa_subca: changed = True if not module.check_mode: client.subca_del(subca_name=subca_name) elif state == 'disable': ipa_version = client.get_ipa_version() if LooseVersion(ipa_version) < LooseVersion('4.4.2'): module.fail_json(msg="Current version of IPA server [%s] does not support 'CA disable' option. Please upgrade to " "version greater than 4.4.2") if ipa_subca: changed = True if not module.check_mode: client.subca_disable(subca_name=subca_name) elif state == 'enable': ipa_version = client.get_ipa_version() if LooseVersion(ipa_version) < LooseVersion('4.4.2'): module.fail_json(msg="Current version of IPA server [%s] does not support 'CA enable' option. Please upgrade to " "version greater than 4.4.2") if ipa_subca: changed = True if not module.check_mode: client.subca_enable(subca_name=subca_name) return changed, client.subca_find(subca_name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(subca_name=dict(type='str', required=True, aliases=['name']), subca_subject=dict(type='str', required=True), subca_desc=dict(type='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']),) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True,) client = SubCAIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, record = ensure(module, client) module.exit_json(changed=changed, record=record) except Exception as exc: module.fail_json(msg=to_native(exc)) if __name__ == '__main__': main() PK $�!\� �� � H collections/ansible_collections/community/general/plugins/modules/lbu.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019, Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: lbu short_description: Local Backup Utility for Alpine Linux version_added: '0.2.0' description: - Manage Local Backup Utility of Alpine Linux in run-from-RAM mode extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: commit: description: - Control whether to commit changed files. type: bool exclude: description: - List of paths to exclude. type: list elements: str include: description: - List of paths to include. type: list elements: str author: - Kaarle Ritvanen (@kunkku) ''' EXAMPLES = ''' # Commit changed files (if any) - name: Commit community.general.lbu: commit: true # Exclude path and commit - name: Exclude directory community.general.lbu: commit: true exclude: - /etc/opt # Include paths without committing - name: Include file and directory community.general.lbu: include: - /root/.ssh/authorized_keys - /var/lib/misc ''' RETURN = ''' msg: description: Error message type: str returned: on failure ''' from ansible.module_utils.basic import AnsibleModule import os.path def run_module(): module = AnsibleModule( argument_spec={ 'commit': {'type': 'bool'}, 'exclude': {'type': 'list', 'elements': 'str'}, 'include': {'type': 'list', 'elements': 'str'} }, supports_check_mode=True ) changed = False def run_lbu(*args): code, stdout, stderr = module.run_command( [module.get_bin_path('lbu', required=True)] + list(args) ) if code: module.fail_json(changed=changed, msg=stderr) return stdout update = False commit = False for param in ('include', 'exclude'): if module.params[param]: paths = run_lbu(param, '-l').split('\n') for path in module.params[param]: if os.path.normpath('/' + path)[1:] not in paths: update = True if module.params['commit']: commit = update or run_lbu('status') > '' if module.check_mode: module.exit_json(changed=update or commit) if update: for param in ('include', 'exclude'): if module.params[param]: run_lbu(param, *module.params[param]) changed = True if commit: run_lbu('commit') changed = True module.exit_json(changed=changed) def main(): run_module() if __name__ == '__main__': main() PK $�!\ɋ��p: p: W collections/ansible_collections/community/general/plugins/modules/listen_ports_facts.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2017, Nathan Davison <ndavison85@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: listen_ports_facts author: - Nathan Davison (@ndavison) description: - Gather facts on processes listening on TCP and UDP ports using the C(netstat) or C(ss) commands. - This module currently supports Linux only. requirements: - netstat or ss short_description: Gather facts on processes listening on TCP and UDP ports notes: - | C(ss) returns all processes for each listen address and port. This plugin will return each of them, so multiple entries for the same listen address and port are likely in results. extends_documentation_fragment: - community.general.attributes - community.general.attributes.facts - community.general.attributes.facts_module options: command: description: - Override which command to use for fetching listen ports. - 'By default module will use first found supported command on the system (in alphanumerical order).' type: str choices: - netstat - ss version_added: 4.1.0 include_non_listening: description: - Show both listening and non-listening sockets (for TCP this means established connections). - Adds the return values RV(ansible_facts.tcp_listen[].state), RV(ansible_facts.udp_listen[].state), RV(ansible_facts.tcp_listen[].foreign_address), and RV(ansible_facts.udp_listen[].foreign_address) to the returned facts. type: bool default: false version_added: 5.4.0 ''' EXAMPLES = r''' - name: Gather facts on listening ports community.general.listen_ports_facts: - name: TCP whitelist violation ansible.builtin.debug: msg: TCP port {{ item.port }} by pid {{ item.pid }} violates the whitelist vars: tcp_listen_violations: "{{ ansible_facts.tcp_listen | selectattr('port', 'in', tcp_whitelist) | list }}" tcp_whitelist: - 22 - 25 loop: "{{ tcp_listen_violations }}" - name: List TCP ports ansible.builtin.debug: msg: "{{ ansible_facts.tcp_listen | map(attribute='port') | sort | list }}" - name: List UDP ports ansible.builtin.debug: msg: "{{ ansible_facts.udp_listen | map(attribute='port') | sort | list }}" - name: List all ports ansible.builtin.debug: msg: "{{ (ansible_facts.tcp_listen + ansible_facts.udp_listen) | map(attribute='port') | unique | sort | list }}" - name: Gather facts on all ports and override which command to use community.general.listen_ports_facts: command: 'netstat' include_non_listening: true ''' RETURN = r''' ansible_facts: description: Dictionary containing details of TCP and UDP ports with listening servers returned: always type: complex contains: tcp_listen: description: A list of processes that are listening on a TCP port. returned: if TCP servers were found type: list contains: address: description: The address the server is listening on. returned: always type: str sample: "0.0.0.0" foreign_address: description: The address of the remote end of the socket. returned: if O(include_non_listening=true) type: str sample: "10.80.0.1" version_added: 5.4.0 state: description: The state of the socket. returned: if O(include_non_listening=true) type: str sample: "ESTABLISHED" version_added: 5.4.0 name: description: The name of the listening process. returned: if user permissions allow type: str sample: "mysqld" pid: description: The pid of the listening process. returned: always type: int sample: 1223 port: description: The port the server is listening on. returned: always type: int sample: 3306 protocol: description: The network protocol of the server. returned: always type: str sample: "tcp" stime: description: The start time of the listening process. returned: always type: str sample: "Thu Feb 2 13:29:45 2017" user: description: The user who is running the listening process. returned: always type: str sample: "mysql" udp_listen: description: A list of processes that are listening on a UDP port. returned: if UDP servers were found type: list contains: address: description: The address the server is listening on. returned: always type: str sample: "0.0.0.0" foreign_address: description: The address of the remote end of the socket. returned: if O(include_non_listening=true) type: str sample: "10.80.0.1" version_added: 5.4.0 state: description: The state of the socket. UDP is a connectionless protocol. Shows UCONN or ESTAB. returned: if O(include_non_listening=true) type: str sample: "UCONN" version_added: 5.4.0 name: description: The name of the listening process. returned: if user permissions allow type: str sample: "rsyslogd" pid: description: The pid of the listening process. returned: always type: int sample: 609 port: description: The port the server is listening on. returned: always type: int sample: 514 protocol: description: The network protocol of the server. returned: always type: str sample: "udp" stime: description: The start time of the listening process. returned: always type: str sample: "Thu Feb 2 13:29:45 2017" user: description: The user who is running the listening process. returned: always type: str sample: "root" ''' import re import platform from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.basic import AnsibleModule def split_pid_name(pid_name): """ Split the entry PID/Program name into the PID (int) and the name (str) :param pid_name: PID/Program String seperated with a dash. E.g 51/sshd: returns pid = 51 and name = sshd :return: PID (int) and the program name (str) """ try: pid, name = pid_name.split("/", 1) except ValueError: # likely unprivileged user, so add empty name & pid return 0, "" else: name = name.rstrip(":") return int(pid), name def netStatParse(raw): """ The netstat result can be either split in 6,7 or 8 elements depending on the values of state, process and name. For UDP the state is always empty. For UDP and TCP the process can be empty. So these cases have to be checked. :param raw: Netstat raw output String. First line explains the format, each following line contains a connection. :return: List of dicts, each dict contains protocol, state, local address, foreign address, port, name, pid for one connection. """ results = list() for line in raw.splitlines(): if line.startswith(("tcp", "udp")): # set variables to default state, in case they are not specified state = "" pid_and_name = "" process = "" formatted_line = line.split() protocol, recv_q, send_q, address, foreign_address, rest = \ formatted_line[0], formatted_line[1], formatted_line[2], formatted_line[3], formatted_line[4], formatted_line[5:] address, port = address.rsplit(":", 1) if protocol.startswith("tcp"): # nestat distinguishes between tcp6 and tcp protocol = "tcp" if len(rest) == 3: state, pid_and_name, process = rest if len(rest) == 2: state, pid_and_name = rest if protocol.startswith("udp"): # safety measure, similar to tcp6 protocol = "udp" if len(rest) == 2: pid_and_name, process = rest if len(rest) == 1: pid_and_name = rest[0] pid, name = split_pid_name(pid_name=pid_and_name) result = { 'protocol': protocol, 'state': state, 'address': address, 'foreign_address': foreign_address, 'port': int(port), 'name': name, 'pid': int(pid), } if result not in results: results.append(result) return results def ss_parse(raw): """ The ss_parse result can be either split in 6 or 7 elements depending on the process column, e.g. due to unprivileged user. :param raw: ss raw output String. First line explains the format, each following line contains a connection. :return: List of dicts, each dict contains protocol, state, local address, foreign address, port, name, pid for one connection. """ results = list() regex_conns = re.compile(pattern=r'\[?(.+?)\]?:([0-9]+)$') regex_pid = re.compile(pattern=r'"(.*?)",pid=(\d+)') lines = raw.splitlines() if len(lines) == 0 or not lines[0].startswith('Netid '): # unexpected stdout from ss raise EnvironmentError('Unknown stdout format of `ss`: {0}'.format(raw)) # skip headers (-H arg is not present on e.g. Ubuntu 16) lines = lines[1:] for line in lines: cells = line.split(None, 6) try: if len(cells) == 6: # no process column, e.g. due to unprivileged user process = str() protocol, state, recv_q, send_q, local_addr_port, peer_addr_port = cells else: protocol, state, recv_q, send_q, local_addr_port, peer_addr_port, process = cells except ValueError: # unexpected stdout from ss raise EnvironmentError( 'Expected `ss` table layout "Netid, State, Recv-Q, Send-Q, Local Address:Port, Peer Address:Port" and \ optionally "Process", but got something else: {0}'.format(line) ) conns = regex_conns.search(local_addr_port) pids = regex_pid.findall(process) if conns is None and pids is None: continue if pids is None: # likely unprivileged user, so add empty name & pid # as we do in netstat logic to be consistent with output pids = [(str(), 0)] address = conns.group(1) port = conns.group(2) for name, pid in pids: result = { 'protocol': protocol, 'state': state, 'address': address, 'foreign_address': peer_addr_port, 'port': int(port), 'name': name, 'pid': int(pid), } results.append(result) return results def main(): command_args = ['-p', '-l', '-u', '-n', '-t'] commands_map = { 'netstat': { 'args': [], 'parse_func': netStatParse }, 'ss': { 'args': [], 'parse_func': ss_parse }, } module = AnsibleModule( argument_spec=dict( command=dict(type='str', choices=list(sorted(commands_map))), include_non_listening=dict(default=False, type='bool'), ), supports_check_mode=True, ) if module.params['include_non_listening']: command_args = ['-p', '-u', '-n', '-t', '-a'] commands_map['netstat']['args'] = command_args commands_map['ss']['args'] = command_args if platform.system() != 'Linux': module.fail_json(msg='This module requires Linux.') def getPidSTime(pid): ps_cmd = module.get_bin_path('ps', True) rc, ps_output, stderr = module.run_command([ps_cmd, '-o', 'lstart', '-p', str(pid)]) stime = '' if rc == 0: for line in ps_output.splitlines(): if 'started' not in line: stime = line return stime def getPidUser(pid): ps_cmd = module.get_bin_path('ps', True) rc, ps_output, stderr = module.run_command([ps_cmd, '-o', 'user', '-p', str(pid)]) user = '' if rc == 0: for line in ps_output.splitlines(): if line != 'USER': user = line return user result = { 'changed': False, 'ansible_facts': { 'tcp_listen': [], 'udp_listen': [], }, } try: command = None bin_path = None if module.params['command'] is not None: command = module.params['command'] bin_path = module.get_bin_path(command, required=True) else: for c in sorted(commands_map): bin_path = module.get_bin_path(c, required=False) if bin_path is not None: command = c break if bin_path is None: raise EnvironmentError(msg='Unable to find any of the supported commands in PATH: {0}'.format(", ".join(sorted(commands_map)))) # which ports are listening for connections? args = commands_map[command]['args'] rc, stdout, stderr = module.run_command([bin_path] + args) if rc == 0: parse_func = commands_map[command]['parse_func'] results = parse_func(stdout) for connection in results: # only display state and foreign_address for include_non_listening. if not module.params['include_non_listening']: connection.pop('state', None) connection.pop('foreign_address', None) connection['stime'] = getPidSTime(connection['pid']) connection['user'] = getPidUser(connection['pid']) if connection['protocol'].startswith('tcp'): result['ansible_facts']['tcp_listen'].append(connection) elif connection['protocol'].startswith('udp'): result['ansible_facts']['udp_listen'].append(connection) except (KeyError, EnvironmentError) as e: module.fail_json(msg=to_native(e)) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\��u�6 6 I collections/ansible_collections/community/general/plugins/modules/pnpm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2023 Aritra Sen <aretrosen@proton.me> # Copyright (c) 2017 Chris Hoffman <christopher.hoffman@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ --- module: pnpm short_description: Manage node.js packages with pnpm version_added: 7.4.0 description: - Manage node.js packages with the L(pnpm package manager, https://pnpm.io/). author: - "Aritra Sen (@aretrosen)" - "Chris Hoffman (@chrishoffman), creator of NPM Ansible module" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - The name of a node.js library to install. - All packages in package.json are installed if not provided. type: str required: false alias: description: - Alias of the node.js library. type: str required: false path: description: - The base path to install the node.js libraries. type: path required: false version: description: - The version of the library to be installed, in semver format. type: str required: false global: description: - Install the node.js library globally. required: false default: false type: bool executable: description: - The executable location for pnpm. - The default location it searches for is E(PATH), fails if not set. type: path required: false ignore_scripts: description: - Use the C(--ignore-scripts) flag when installing. required: false type: bool default: false no_optional: description: - Do not install optional packages, equivalent to C(--no-optional). required: false type: bool default: false production: description: - Install dependencies in production mode. - Pnpm will ignore any dependencies under C(devDependencies) in package.json. required: false type: bool default: false dev: description: - Install dependencies in development mode. - Pnpm will ignore any regular dependencies in C(package.json). required: false default: false type: bool optional: description: - Install dependencies in optional mode. required: false default: false type: bool state: description: - Installation state of the named node.js library. - If V(absent) is selected, a name option must be provided. type: str required: false default: present choices: ["present", "absent", "latest"] requirements: - Pnpm executable present in E(PATH). """ EXAMPLES = """ - name: Install "tailwindcss" node.js package. community.general.pnpm: name: tailwindcss path: /app/location - name: Install "tailwindcss" node.js package on version 3.3.2 community.general.pnpm: name: tailwindcss version: 3.3.2 path: /app/location - name: Install "tailwindcss" node.js package globally. community.general.pnpm: name: tailwindcss global: true - name: Install "tailwindcss" node.js package as dev dependency. community.general.pnpm: name: tailwindcss path: /app/location dev: true - name: Install "tailwindcss" node.js package as optional dependency. community.general.pnpm: name: tailwindcss path: /app/location optional: true - name: Install "tailwindcss" node.js package version 0.1.3 as tailwind-1 community.general.pnpm: name: tailwindcss alias: tailwind-1 version: 0.1.3 path: /app/location - name: Remove the globally-installed package "tailwindcss". community.general.pnpm: name: tailwindcss global: true state: absent - name: Install packages based on package.json. community.general.pnpm: path: /app/location - name: Update all packages in package.json to their latest version. community.general.pnpm: path: /app/location state: latest """ import json import os from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native class Pnpm(object): def __init__(self, module, **kwargs): self.module = module self.name = kwargs["name"] self.alias = kwargs["alias"] self.version = kwargs["version"] self.path = kwargs["path"] self.globally = kwargs["globally"] self.executable = kwargs["executable"] self.ignore_scripts = kwargs["ignore_scripts"] self.no_optional = kwargs["no_optional"] self.production = kwargs["production"] self.dev = kwargs["dev"] self.optional = kwargs["optional"] self.alias_name_ver = None if self.alias is not None: self.alias_name_ver = self.alias + "@npm:" if self.name is not None: self.alias_name_ver = (self.alias_name_ver or "") + self.name if self.version is not None: self.alias_name_ver = self.alias_name_ver + "@" + str(self.version) else: self.alias_name_ver = self.alias_name_ver + "@latest" def _exec(self, args, run_in_check_mode=False, check_rc=True): if not self.module.check_mode or (self.module.check_mode and run_in_check_mode): cmd = self.executable + args if self.globally: cmd.append("-g") if self.ignore_scripts: cmd.append("--ignore-scripts") if self.no_optional: cmd.append("--no-optional") if self.production: cmd.append("-P") if self.dev: cmd.append("-D") if self.name and self.optional: cmd.append("-O") # If path is specified, cd into that path and run the command. cwd = None if self.path: if not os.path.exists(self.path): os.makedirs(self.path) if not os.path.isdir(self.path): self.module.fail_json(msg="Path %s is not a directory" % self.path) if not self.alias_name_ver and not os.path.isfile( os.path.join(self.path, "package.json") ): self.module.fail_json( msg="package.json does not exist in provided path" ) cwd = self.path _rc, out, err = self.module.run_command(cmd, check_rc=check_rc, cwd=cwd) return out, err return None, None def missing(self): if not os.path.isfile(os.path.join(self.path, "pnpm-lock.yaml")): return True cmd = ["list", "--json"] if self.name is not None: cmd.append(self.name) try: out, err = self._exec(cmd, True, False) if err is not None and err != "": raise Exception(out) data = json.loads(out) except Exception as e: self.module.fail_json( msg="Failed to parse pnpm output with error %s" % to_native(e) ) if "error" in data: return True data = data[0] for typedep in [ "dependencies", "devDependencies", "optionalDependencies", "unsavedDependencies", ]: if typedep not in data: continue for dep, prop in data[typedep].items(): if self.alias is not None and self.alias != dep: continue name = prop["from"] if self.alias is not None else dep if self.name != name: continue if self.version is None or self.version == prop["version"]: return False break return True def install(self): if self.alias_name_ver is not None: return self._exec(["add", self.alias_name_ver]) return self._exec(["install"]) def update(self): return self._exec(["update", "--latest"]) def uninstall(self): if self.alias is not None: return self._exec(["remove", self.alias]) return self._exec(["remove", self.name]) def list_outdated(self): if not os.path.isfile(os.path.join(self.path, "pnpm-lock.yaml")): return list() cmd = ["outdated", "--format", "json"] try: out, err = self._exec(cmd, True, False) # BUG: It will not show correct error sometimes, like when it has # plain text output intermingled with a {} if err is not None and err != "": raise Exception(out) # HACK: To fix the above bug, the following hack is implemented data_lines = out.splitlines(True) out = None for line in data_lines: if len(line) > 0 and line[0] == "{": out = line continue if len(line) > 0 and line[0] == "}": out += line break if out is not None: out += line data = json.loads(out) except Exception as e: self.module.fail_json( msg="Failed to parse pnpm output with error %s" % to_native(e) ) return data.keys() def main(): arg_spec = dict( name=dict(default=None), alias=dict(default=None), path=dict(default=None, type="path"), version=dict(default=None), executable=dict(default=None, type="path"), ignore_scripts=dict(default=False, type="bool"), no_optional=dict(default=False, type="bool"), production=dict(default=False, type="bool"), dev=dict(default=False, type="bool"), optional=dict(default=False, type="bool"), state=dict(default="present", choices=["present", "absent", "latest"]), ) arg_spec["global"] = dict(default=False, type="bool") module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True) name = module.params["name"] alias = module.params["alias"] path = module.params["path"] version = module.params["version"] globally = module.params["global"] ignore_scripts = module.params["ignore_scripts"] no_optional = module.params["no_optional"] production = module.params["production"] dev = module.params["dev"] optional = module.params["optional"] state = module.params["state"] if module.params["executable"]: executable = module.params["executable"].split(" ") else: executable = [module.get_bin_path("pnpm", True)] if name is None and version is not None: module.fail_json(msg="version is meaningless when name is not provided") if name is None and alias is not None: module.fail_json(msg="alias is meaningless when name is not provided") if path is None and not globally: module.fail_json(msg="path must be specified when not using global") elif path is not None and globally: module.fail_json(msg="Cannot specify path when doing global installation") if globally and (production or dev or optional): module.fail_json( msg="Options production, dev, and optional is meaningless when installing packages globally" ) if name is not None and path is not None and globally: module.fail_json(msg="path should not be mentioned when installing globally") if production and dev and optional: module.fail_json( msg="Options production and dev and optional don't go together" ) if production and dev: module.fail_json(msg="Options production and dev don't go together") if production and optional: module.fail_json(msg="Options production and optional don't go together") if dev and optional: module.fail_json(msg="Options dev and optional don't go together") if name is not None and name[0:4] == "http" and version is not None: module.fail_json(msg="Semver not supported on remote url downloads") if name is None and optional: module.fail_json( msg="Optional not available when package name not provided, use no_optional instead" ) if state == "absent" and name is None: module.fail_json(msg="Package name is required for uninstalling") if globally: _rc, out, _err = module.run_command(executable + ["root", "-g"], check_rc=True) path, _tail = os.path.split(out.strip()) pnpm = Pnpm( module, name=name, alias=alias, path=path, version=version, globally=globally, executable=executable, ignore_scripts=ignore_scripts, no_optional=no_optional, production=production, dev=dev, optional=optional, ) changed = False out = "" err = "" if state == "present": if pnpm.missing(): changed = True out, err = pnpm.install() elif state == "latest": outdated = pnpm.list_outdated() if name is not None: if pnpm.missing() or name in outdated: changed = True out, err = pnpm.install() elif len(outdated): changed = True out, err = pnpm.update() else: # absent if not pnpm.missing(): changed = True out, err = pnpm.uninstall() module.exit_json(changed=changed, out=out, err=err) if __name__ == "__main__": main() PK $�!\�"w�" " ` collections/ansible_collections/community/general/plugins/modules/scaleway_container_registry.pynu �[��� # -*- coding: utf-8 -*- # # Scaleway Container registry management module # # Copyright (c) 2022, Guillaume MARTINEZ <lunik@tiwabbit.fr> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: scaleway_container_registry short_description: Scaleway Container registry management module version_added: 5.8.0 author: Guillaume MARTINEZ (@Lunik) description: - This module manages container registries on Scaleway account. extends_documentation_fragment: - community.general.scaleway - community.general.scaleway_waitable_resource - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: type: str description: - Indicate desired state of the container regitry. default: present choices: - present - absent project_id: type: str description: - Project identifier. required: true region: type: str description: - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par - nl-ams - pl-waw name: type: str description: - Name of the container registry. required: true description: description: - Description of the container registry. type: str default: '' privacy_policy: type: str description: - Default visibility policy. - Everyone will be able to pull images from a V(public) registry. choices: - public - private default: private ''' EXAMPLES = ''' - name: Create a container registry community.general.scaleway_container_registry: project_id: '{{ scw_project }}' state: present region: fr-par name: my-awesome-container-registry register: container_registry_creation_task - name: Make sure container registry is deleted community.general.scaleway_container_registry: project_id: '{{ scw_project }}' state: absent region: fr-par name: my-awesome-container-registry ''' RETURN = ''' container_registry: description: The container registry information. returned: when O(state=present) type: dict sample: created_at: "2022-10-14T09:51:07.949716Z" description: Managed by Ansible endpoint: rg.fr-par.scw.cloud/my-awesome-registry id: 0d7d5270-7864-49c2-920b-9fd6731f3589 image_count: 0 is_public: false name: my-awesome-registry organization_id: 10697b59-5c34-4d24-8d15-9ff2d3b89f58 project_id: 3da4f0b2-06be-4773-8ec4-5dfa435381be region: fr-par size: 0 status: ready status_message: "" updated_at: "2022-10-14T09:51:07.949716Z" ''' from ansible_collections.community.general.plugins.module_utils.scaleway import ( SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway, scaleway_waitable_resource_argument_spec, resource_attributes_should_be_changed ) from ansible.module_utils.basic import AnsibleModule STABLE_STATES = ( "ready", "absent" ) MUTABLE_ATTRIBUTES = ( "description", "is_public" ) def payload_from_wished_cr(wished_cr): payload = { "project_id": wished_cr["project_id"], "name": wished_cr["name"], "description": wished_cr["description"], "is_public": wished_cr["privacy_policy"] == "public" } return payload def absent_strategy(api, wished_cr): changed = False cr_list = api.fetch_all_resources("namespaces") cr_lookup = dict((cr["name"], cr) for cr in cr_list) if wished_cr["name"] not in cr_lookup: return changed, {} target_cr = cr_lookup[wished_cr["name"]] changed = True if api.module.check_mode: return changed, {"status": "Container registry would be destroyed"} api.wait_to_complete_state_transition(resource=target_cr, stable_states=STABLE_STATES, force_wait=True) response = api.delete(path=api.api_path + "/%s" % target_cr["id"]) if not response.ok: api.module.fail_json(msg='Error deleting container registry [{0}: {1}]'.format( response.status_code, response.json)) api.wait_to_complete_state_transition(resource=target_cr, stable_states=STABLE_STATES) return changed, response.json def present_strategy(api, wished_cr): changed = False cr_list = api.fetch_all_resources("namespaces") cr_lookup = dict((cr["name"], cr) for cr in cr_list) payload_cr = payload_from_wished_cr(wished_cr) if wished_cr["name"] not in cr_lookup: changed = True if api.module.check_mode: return changed, {"status": "A container registry would be created."} # Create container registry api.warn(payload_cr) creation_response = api.post(path=api.api_path, data=payload_cr) if not creation_response.ok: msg = "Error during container registry creation: %s: '%s' (%s)" % (creation_response.info['msg'], creation_response.json['message'], creation_response.json) api.module.fail_json(msg=msg) api.wait_to_complete_state_transition(resource=creation_response.json, stable_states=STABLE_STATES) response = api.get(path=api.api_path + "/%s" % creation_response.json["id"]) return changed, response.json target_cr = cr_lookup[wished_cr["name"]] patch_payload = resource_attributes_should_be_changed(target=target_cr, wished=payload_cr, verifiable_mutable_attributes=MUTABLE_ATTRIBUTES, mutable_attributes=MUTABLE_ATTRIBUTES) if not patch_payload: return changed, target_cr changed = True if api.module.check_mode: return changed, {"status": "Container registry attributes would be changed."} cr_patch_response = api.patch(path=api.api_path + "/%s" % target_cr["id"], data=patch_payload) if not cr_patch_response.ok: api.module.fail_json(msg='Error during container registry attributes update: [{0}: {1}]'.format( cr_patch_response.status_code, cr_patch_response.json['message'])) api.wait_to_complete_state_transition(resource=target_cr, stable_states=STABLE_STATES) response = api.get(path=api.api_path + "/%s" % target_cr["id"]) return changed, response.json state_strategy = { "present": present_strategy, "absent": absent_strategy } def core(module): region = module.params["region"] wished_container_registry = { "state": module.params["state"], "project_id": module.params["project_id"], "name": module.params["name"], "description": module.params['description'], "privacy_policy": module.params['privacy_policy'] } api = Scaleway(module=module) api.api_path = "registry/v1/regions/%s/namespaces" % region changed, summary = state_strategy[wished_container_registry["state"]](api=api, wished_cr=wished_container_registry) module.exit_json(changed=changed, container_registry=summary) def main(): argument_spec = scaleway_argument_spec() argument_spec.update(scaleway_waitable_resource_argument_spec()) argument_spec.update(dict( state=dict(type='str', default='present', choices=['absent', 'present']), project_id=dict(type='str', required=True), region=dict(type='str', required=True, choices=SCALEWAY_REGIONS), name=dict(type='str', required=True), description=dict(type='str', default=''), privacy_policy=dict(type='str', default='private', choices=['public', 'private']) )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) core(module) if __name__ == '__main__': main() PK $�!\㚵�� � M collections/ansible_collections/community/general/plugins/modules/gunicorn.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Alejandro Gomez <alexgomez2202@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: gunicorn short_description: Run gunicorn with various settings description: - Starts gunicorn with the parameters specified. Common settings for gunicorn configuration are supported. For additional configuration use a config file See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more options. It's recommended to always use the chdir option to avoid problems with the location of the app. requirements: [gunicorn] author: - "Alejandro Gomez (@agmezr)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: app: type: str required: true aliases: ['name'] description: - The app module. A name refers to a WSGI callable that should be found in the specified module. venv: type: path aliases: ['virtualenv'] description: - 'Path to the virtualenv directory.' config: type: path description: - 'Path to the gunicorn configuration file.' aliases: ['conf'] chdir: type: path description: - 'Chdir to specified directory before apps loading.' pid: type: path description: - 'A filename to use for the PID file. If not set and not found on the configuration file a tmp pid file will be created to check a successful run of gunicorn.' worker: type: str choices: ['sync', 'eventlet', 'gevent', 'tornado ', 'gthread', 'gaiohttp'] description: - 'The type of workers to use. The default class (sync) should handle most "normal" types of workloads.' user: type: str description: - 'Switch worker processes to run as this user.' notes: - If not specified on config file, a temporary error log will be created on /tmp dir. Please make sure you have write access in /tmp dir. Not needed but will help you to identify any problem with configuration. ''' EXAMPLES = ''' - name: Simple gunicorn run example community.general.gunicorn: app: 'wsgi' chdir: '/workspace/example' - name: Run gunicorn on a virtualenv community.general.gunicorn: app: 'wsgi' chdir: '/workspace/example' venv: '/workspace/example/venv' - name: Run gunicorn with a config file community.general.gunicorn: app: 'wsgi' chdir: '/workspace/example' conf: '/workspace/example/gunicorn.cfg' - name: Run gunicorn as ansible user with specified pid and config file community.general.gunicorn: app: 'wsgi' chdir: '/workspace/example' conf: '/workspace/example/gunicorn.cfg' venv: '/workspace/example/venv' pid: '/workspace/example/gunicorn.pid' user: 'ansible' ''' RETURN = ''' gunicorn: description: process id of gunicorn returned: changed type: str sample: "1234" ''' import os import time from ansible.module_utils.basic import AnsibleModule def search_existing_config(config, option): ''' search in config file for specified option ''' if config and os.path.isfile(config): with open(config, 'r') as f: for line in f: if option in line: return line return None def remove_tmp_file(file_path): ''' remove temporary files ''' if os.path.isfile(file_path): os.remove(file_path) def main(): # available gunicorn options on module gunicorn_options = { 'config': '-c', 'chdir': '--chdir', 'worker': '-k', 'user': '-u', } module = AnsibleModule( argument_spec=dict( app=dict(required=True, type='str', aliases=['name']), venv=dict(type='path', aliases=['virtualenv']), config=dict(type='path', aliases=['conf']), chdir=dict(type='path'), pid=dict(type='path'), user=dict(type='str'), worker=dict(type='str', choices=['sync', 'eventlet', 'gevent', 'tornado ', 'gthread', 'gaiohttp']), ) ) # temporary files in case no option provided tmp_error_log = os.path.join(module.tmpdir, 'gunicorn.temp.error.log') tmp_pid_file = os.path.join(module.tmpdir, 'gunicorn.temp.pid') # remove temp file if exists remove_tmp_file(tmp_pid_file) remove_tmp_file(tmp_error_log) # obtain app name and venv params = module.params app = params['app'] venv = params['venv'] pid = params['pid'] # use venv path if exists if venv: gunicorn_command = "/".join((venv, 'bin', 'gunicorn')) else: gunicorn_command = module.get_bin_path('gunicorn') # to daemonize the process options = ["-D"] # fill options for option in gunicorn_options: param = params[option] if param: options.append(gunicorn_options[option]) options.append(param) error_log = search_existing_config(params['config'], 'errorlog') if not error_log: # place error log somewhere in case of fail options.append("--error-logfile") options.append(tmp_error_log) pid_file = search_existing_config(params['config'], 'pid') if not params['pid'] and not pid_file: pid = tmp_pid_file # add option for pid file if not found on config file if not pid_file: options.append('--pid') options.append(pid) # put args together args = [gunicorn_command] + options + [app] rc, out, err = module.run_command(args, use_unsafe_shell=False, encoding=None) if not err: # wait for gunicorn to dump to log time.sleep(0.5) if os.path.isfile(pid): with open(pid, 'r') as f: result = f.readline().strip() if not params['pid']: os.remove(pid) module.exit_json(changed=True, pid=result, debug=" ".join(args)) else: # if user defined own error log, check that if error_log: error = 'Please check your {0}'.format(error_log.strip()) else: if os.path.isfile(tmp_error_log): with open(tmp_error_log, 'r') as f: error = f.read() # delete tmp log os.remove(tmp_error_log) else: error = "Log not found" module.fail_json(msg='Failed to start gunicorn. {0}'.format(error), error=err) else: module.fail_json(msg='Failed to start gunicorn {0}'.format(err), error=err) if __name__ == '__main__': main() PK $�!\�~�s�2 �2 I collections/ansible_collections/community/general/plugins/modules/yarn.pynu �[��� # -*- coding: utf-8 -*- # (c) 2017 David Gunter <david.gunter@tivix.com> # Copyright (c) 2017 Chris Hoffman <christopher.hoffman@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: yarn short_description: Manage node.js packages with Yarn description: - Manage node.js packages with the Yarn package manager (https://yarnpkg.com/) author: - "David Gunter (@verkaufer)" - "Chris Hoffman (@chrishoffman), creator of NPM Ansible module)" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - The name of a node.js library to install - If omitted all packages in package.json are installed. - To globally install from local node.js library. Prepend "file:" to the path of the node.js library. required: false path: type: path description: - The base path where Node.js libraries will be installed. - This is where the node_modules folder lives. required: false version: type: str description: - The version of the library to be installed. - Must be in semver format. If "latest" is desired, use "state" arg instead required: false global: description: - Install the node.js library globally required: false default: false type: bool executable: type: path description: - The executable location for yarn. required: false ignore_scripts: description: - Use the --ignore-scripts flag when installing. required: false type: bool default: false production: description: - Install dependencies in production mode. - Yarn will ignore any dependencies under devDependencies in package.json required: false type: bool default: false registry: type: str description: - The registry to install modules from. required: false state: type: str description: - Installation state of the named node.js library - If absent is selected, a name option must be provided required: false default: present choices: [ "present", "absent", "latest" ] requirements: - Yarn installed in bin path (typically /usr/local/bin) ''' EXAMPLES = ''' - name: Install "imagemin" node.js package. community.general.yarn: name: imagemin path: /app/location - name: Install "imagemin" node.js package on version 5.3.1 community.general.yarn: name: imagemin version: '5.3.1' path: /app/location - name: Install "imagemin" node.js package globally. community.general.yarn: name: imagemin global: true - name: Remove the globally-installed package "imagemin". community.general.yarn: name: imagemin global: true state: absent - name: Install "imagemin" node.js package from custom registry. community.general.yarn: name: imagemin registry: 'http://registry.mysite.com' - name: Install packages based on package.json. community.general.yarn: path: /app/location - name: Update all packages in package.json to their latest version. community.general.yarn: path: /app/location state: latest ''' RETURN = ''' changed: description: Whether Yarn changed any package data returned: always type: bool sample: true msg: description: Provides an error message if Yarn syntax was incorrect returned: failure type: str sample: "Package must be explicitly named when uninstalling." invocation: description: Parameters and values used during execution returned: success type: dict sample: { "module_args": { "executable": null, "globally": false, "ignore_scripts": false, "name": null, "path": "/some/path/folder", "production": false, "registry": null, "state": "present", "version": null } } out: description: Output generated from Yarn. returned: always type: str sample: "yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4] Building fresh packages...success Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s." ''' import os import json from ansible.module_utils.basic import AnsibleModule class Yarn(object): def __init__(self, module, **kwargs): self.module = module self.globally = kwargs['globally'] self.name = kwargs['name'] self.version = kwargs['version'] self.path = kwargs['path'] self.registry = kwargs['registry'] self.production = kwargs['production'] self.ignore_scripts = kwargs['ignore_scripts'] self.executable = kwargs['executable'] # Specify a version of package if version arg passed in self.name_version = None if kwargs['version'] and self.name is not None: self.name_version = self.name + '@' + str(self.version) elif self.name is not None: self.name_version = self.name def _exec(self, args, run_in_check_mode=False, check_rc=True, unsupported_with_global=False): if not self.module.check_mode or (self.module.check_mode and run_in_check_mode): with_global_arg = self.globally and not unsupported_with_global if with_global_arg: # Yarn global arg is inserted before the command (e.g. `yarn global {some-command}`) args.insert(0, 'global') cmd = self.executable + args if self.production: cmd.append('--production') if self.ignore_scripts: cmd.append('--ignore-scripts') if self.registry: cmd.append('--registry') cmd.append(self.registry) # If path is specified, cd into that path and run the command. cwd = None if self.path and not with_global_arg: if not os.path.exists(self.path): # Module will make directory if not exists. os.makedirs(self.path) if not os.path.isdir(self.path): self.module.fail_json(msg="Path provided %s is not a directory" % self.path) cwd = self.path if not os.path.isfile(os.path.join(self.path, 'package.json')): self.module.fail_json(msg="Package.json does not exist in provided path.") rc, out, err = self.module.run_command(cmd, check_rc=check_rc, cwd=cwd) return out, err return None, None def _process_yarn_error(self, err): try: # We need to filter for errors, since Yarn warnings are included in stderr for line in err.splitlines(): if json.loads(line)['type'] == 'error': self.module.fail_json(msg=err) except Exception: self.module.fail_json(msg="Unexpected stderr output from Yarn: %s" % err, stderr=err) def list(self): cmd = ['list', '--depth=0', '--json'] installed = list() missing = list() if not os.path.isfile(os.path.join(self.path, 'yarn.lock')): missing.append(self.name) return installed, missing # `yarn global list` should be treated as "unsupported with global" even though it exists, # because it only only lists binaries, but `yarn global add` can install libraries too. result, error = self._exec(cmd, run_in_check_mode=True, check_rc=False, unsupported_with_global=True) self._process_yarn_error(error) for json_line in result.strip().split('\n'): data = json.loads(json_line) if data['type'] == 'tree': dependencies = data['data']['trees'] for dep in dependencies: name, version = dep['name'].rsplit('@', 1) installed.append(name) if self.name not in installed: missing.append(self.name) return installed, missing def install(self): if self.name_version: # Yarn has a separate command for installing packages by name... return self._exec(['add', self.name_version]) # And one for installing all packages in package.json return self._exec(['install', '--non-interactive']) def update(self): return self._exec(['upgrade', '--latest']) def uninstall(self): return self._exec(['remove', self.name]) def list_outdated(self): outdated = list() if not os.path.isfile(os.path.join(self.path, 'yarn.lock')): return outdated cmd_result, err = self._exec(['outdated', '--json'], True, False, unsupported_with_global=True) # the package.json in the global dir is missing a license field, so warnings are expected on stderr self._process_yarn_error(err) if not cmd_result: return outdated outdated_packages_data = cmd_result.splitlines()[1] data = json.loads(outdated_packages_data) try: outdated_dependencies = data['data']['body'] except KeyError: return outdated for dep in outdated_dependencies: # Outdated dependencies returned as a list of lists, where # item at index 0 is the name of the dependency outdated.append(dep[0]) return outdated def main(): arg_spec = dict( name=dict(default=None), path=dict(default=None, type='path'), version=dict(default=None), production=dict(default=False, type='bool'), executable=dict(default=None, type='path'), registry=dict(default=None), state=dict(default='present', choices=['present', 'absent', 'latest']), ignore_scripts=dict(default=False, type='bool'), ) arg_spec['global'] = dict(default=False, type='bool') module = AnsibleModule( argument_spec=arg_spec, supports_check_mode=True ) name = module.params['name'] path = module.params['path'] version = module.params['version'] globally = module.params['global'] production = module.params['production'] registry = module.params['registry'] state = module.params['state'] ignore_scripts = module.params['ignore_scripts'] # When installing globally, users should not be able to define a path for installation. # Require a path if global is False, though! if path is None and globally is False: module.fail_json(msg='Path must be specified when not using global arg') elif path and globally is True: module.fail_json(msg='Cannot specify path if doing global installation') if state == 'absent' and not name: module.fail_json(msg='Package must be explicitly named when uninstalling.') if state == 'latest': version = 'latest' if module.params['executable']: executable = module.params['executable'].split(' ') else: executable = [module.get_bin_path('yarn', True)] # When installing globally, use the defined path for global node_modules if globally: _rc, out, _err = module.run_command(executable + ['global', 'dir'], check_rc=True) path = out.strip() yarn = Yarn(module, name=name, path=path, version=version, globally=globally, production=production, executable=executable, registry=registry, ignore_scripts=ignore_scripts) changed = False out = '' err = '' if state == 'present': if not name: changed = True out, err = yarn.install() else: installed, missing = yarn.list() if len(missing): changed = True out, err = yarn.install() elif state == 'latest': if not name: changed = True out, err = yarn.install() else: installed, missing = yarn.list() outdated = yarn.list_outdated() if len(missing): changed = True out, err = yarn.install() if len(outdated): changed = True out, err = yarn.update() else: # state == absent installed, missing = yarn.list() if name in installed: changed = True out, err = yarn.uninstall() module.exit_json(changed=changed, out=out, err=err) if __name__ == '__main__': main() PK $�!\L�n�+ �+ Y collections/ansible_collections/community/general/plugins/modules/idrac_redfish_config.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019 Dell EMC Inc. # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: idrac_redfish_config short_description: Manages servers through iDRAC using Dell Redfish APIs description: - For use with Dell iDRAC operations that require Redfish OEM extensions - Builds Redfish URIs locally and sends them to remote iDRAC controllers to set or update a configuration attribute. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: category: required: true type: str description: - Category to execute on iDRAC. command: required: true description: - List of commands to execute on iDRAC. - V(SetManagerAttributes), V(SetLifecycleControllerAttributes) and V(SetSystemAttributes) are mutually exclusive commands when O(category) is V(Manager). type: list elements: str baseuri: required: true description: - Base URI of iDRAC. type: str username: description: - Username for authenticating to iDRAC. type: str password: description: - Password for authenticating to iDRAC. type: str auth_token: description: - Security token for authenticating to iDRAC. type: str version_added: 2.3.0 manager_attributes: required: false description: - Dictionary of iDRAC attribute name and value pairs to update. default: {} type: 'dict' version_added: '0.2.0' timeout: description: - Timeout in seconds for HTTP requests to iDRAC. default: 10 type: int resource_id: required: false description: - ID of the System, Manager or Chassis to modify. type: str version_added: '0.2.0' author: "Jose Delarosa (@jose-delarosa)" ''' EXAMPLES = ''' - name: Enable NTP and set NTP server and Time zone attributes in iDRAC community.general.idrac_redfish_config: category: Manager command: SetManagerAttributes resource_id: iDRAC.Embedded.1 manager_attributes: NTPConfigGroup.1.NTPEnable: "Enabled" NTPConfigGroup.1.NTP1: "{{ ntpserver1 }}" Time.1.Timezone: "{{ timezone }}" baseuri: "{{ baseuri }}" username: "{{ username}}" password: "{{ password }}" - name: Enable Syslog and set Syslog servers in iDRAC community.general.idrac_redfish_config: category: Manager command: SetManagerAttributes resource_id: iDRAC.Embedded.1 manager_attributes: SysLog.1.SysLogEnable: "Enabled" SysLog.1.Server1: "{{ syslog_server1 }}" SysLog.1.Server2: "{{ syslog_server2 }}" baseuri: "{{ baseuri }}" username: "{{ username}}" password: "{{ password }}" - name: Configure SNMP community string, port, protocol and trap format community.general.idrac_redfish_config: category: Manager command: SetManagerAttributes resource_id: iDRAC.Embedded.1 manager_attributes: SNMP.1.AgentEnable: "Enabled" SNMP.1.AgentCommunity: "public_community_string" SNMP.1.TrapFormat: "SNMPv1" SNMP.1.SNMPProtocol: "All" SNMP.1.DiscoveryPort: 161 SNMP.1.AlertPort: 162 baseuri: "{{ baseuri }}" username: "{{ username}}" password: "{{ password }}" - name: Enable CSIOR community.general.idrac_redfish_config: category: Manager command: SetLifecycleControllerAttributes resource_id: iDRAC.Embedded.1 manager_attributes: LCAttributes.1.CollectSystemInventoryOnRestart: "Enabled" baseuri: "{{ baseuri }}" username: "{{ username}}" password: "{{ password }}" - name: Set Power Supply Redundancy Policy to A/B Grid Redundant community.general.idrac_redfish_config: category: Manager command: SetSystemAttributes resource_id: iDRAC.Embedded.1 manager_attributes: ServerPwr.1.PSRedPolicy: "A/B Grid Redundant" baseuri: "{{ baseuri }}" username: "{{ username}}" password: "{{ password }}" ''' RETURN = ''' msg: description: Message with action result or error description returned: always type: str sample: "Action was successful" ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.validation import ( check_mutually_exclusive, check_required_arguments ) from ansible_collections.community.general.plugins.module_utils.redfish_utils import RedfishUtils from ansible.module_utils.common.text.converters import to_native class IdracRedfishUtils(RedfishUtils): def set_manager_attributes(self, command): result = {} required_arg_spec = {'manager_attributes': {'required': True}} try: check_required_arguments(required_arg_spec, self.module.params) except TypeError as e: msg = to_native(e) self.module.fail_json(msg=msg) key = "Attributes" command_manager_attributes_uri_map = { "SetManagerAttributes": self.manager_uri, "SetLifecycleControllerAttributes": "/redfish/v1/Managers/LifecycleController.Embedded.1", "SetSystemAttributes": "/redfish/v1/Managers/System.Embedded.1" } manager_uri = command_manager_attributes_uri_map.get(command, self.manager_uri) attributes = self.module.params['manager_attributes'] attrs_to_patch = {} attrs_skipped = {} attrs_bad = {} # Store attrs which were not found in the system # Search for key entry and extract URI from it response = self.get_request(self.root_uri + manager_uri + "/" + key) if response['ret'] is False: return response result['ret'] = True data = response['data'] if key not in data: return {'ret': False, 'msg': "%s: Key %s not found" % (command, key), 'warning': ""} for attr_name, attr_value in attributes.items(): # Check if attribute exists if attr_name not in data[u'Attributes']: # Skip and proceed to next attribute if this isn't valid attrs_bad.update({attr_name: attr_value}) continue # Find out if value is already set to what we want. If yes, exclude # those attributes if data[u'Attributes'][attr_name] == attr_value: attrs_skipped.update({attr_name: attr_value}) else: attrs_to_patch.update({attr_name: attr_value}) warning = "" if attrs_bad: warning = "Incorrect attributes %s" % (attrs_bad) if not attrs_to_patch: return {'ret': True, 'changed': False, 'msg': "No changes made. Manager attributes already set.", 'warning': warning} payload = {"Attributes": attrs_to_patch} response = self.patch_request(self.root_uri + manager_uri + "/" + key, payload) if response['ret'] is False: return response return {'ret': True, 'changed': True, 'msg': "%s: Modified Manager attributes %s" % (command, attrs_to_patch), 'warning': warning} CATEGORY_COMMANDS_ALL = { "Manager": ["SetManagerAttributes", "SetLifecycleControllerAttributes", "SetSystemAttributes"] } # list of mutually exclusive commands for a category CATEGORY_COMMANDS_MUTUALLY_EXCLUSIVE = { "Manager": [["SetManagerAttributes", "SetLifecycleControllerAttributes", "SetSystemAttributes"]] } def main(): result = {} module = AnsibleModule( argument_spec=dict( category=dict(required=True), command=dict(required=True, type='list', elements='str'), baseuri=dict(required=True), username=dict(), password=dict(no_log=True), auth_token=dict(no_log=True), manager_attributes=dict(type='dict', default={}), timeout=dict(type='int', default=10), resource_id=dict() ), required_together=[ ('username', 'password'), ], required_one_of=[ ('username', 'auth_token'), ], mutually_exclusive=[ ('username', 'auth_token'), ], supports_check_mode=False ) category = module.params['category'] command_list = module.params['command'] # admin credentials used for authentication creds = {'user': module.params['username'], 'pswd': module.params['password'], 'token': module.params['auth_token']} # timeout timeout = module.params['timeout'] # System, Manager or Chassis ID to modify resource_id = module.params['resource_id'] # Build root URI root_uri = "https://" + module.params['baseuri'] rf_utils = IdracRedfishUtils(creds, root_uri, timeout, module, resource_id=resource_id, data_modification=True) # Check that Category is valid if category not in CATEGORY_COMMANDS_ALL: module.fail_json(msg=to_native("Invalid Category '%s'. Valid Categories = %s" % (category, list(CATEGORY_COMMANDS_ALL.keys())))) # Check that all commands are valid for cmd in command_list: # Fail if even one command given is invalid if cmd not in CATEGORY_COMMANDS_ALL[category]: module.fail_json(msg=to_native("Invalid Command '%s'. Valid Commands = %s" % (cmd, CATEGORY_COMMANDS_ALL[category]))) # check for mutually exclusive commands try: # check_mutually_exclusive accepts a single list or list of lists that # are groups of terms that should be mutually exclusive with one another # and checks that against a dictionary check_mutually_exclusive(CATEGORY_COMMANDS_MUTUALLY_EXCLUSIVE[category], dict.fromkeys(command_list, True)) except TypeError as e: module.fail_json(msg=to_native(e)) # Organize by Categories / Commands if category == "Manager": # execute only if we find a Manager resource result = rf_utils._find_managers_resource() if result['ret'] is False: module.fail_json(msg=to_native(result['msg'])) for command in command_list: if command in ["SetManagerAttributes", "SetLifecycleControllerAttributes", "SetSystemAttributes"]: result = rf_utils.set_manager_attributes(command) # Return data back or fail with proper message if result['ret'] is True: if result.get('warning'): module.warn(to_native(result['warning'])) module.exit_json(changed=result['changed'], msg=to_native(result['msg'])) else: module.fail_json(msg=to_native(result['msg'])) if __name__ == '__main__': main() PK $�!\�m�8 L collections/ansible_collections/community/general/plugins/modules/apt_rpm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Evgenii Terechkov # Written by Evgenii Terechkov <evg@altlinux.org> # Based on urpmi module written by Philippe Makowski <philippem@mageia.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: apt_rpm short_description: APT-RPM package manager description: - Manages packages with C(apt-rpm). Both low-level (C(rpm)) and high-level (C(apt-get)) package manager binaries required. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: package: description: - List of packages to install, upgrade, or remove. aliases: [ name, pkg ] type: list elements: str state: description: - Indicates the desired package state. choices: [ absent, present, installed, removed ] default: present type: str update_cache: description: - Run the equivalent of C(apt-get update) before the operation. Can be run as part of the package installation or as a separate step. - Default is not to update the cache. type: bool default: false clean: description: - Run the equivalent of C(apt-get clean) to clear out the local repository of retrieved package files. It removes everything but the lock file from C(/var/cache/apt/archives/) and C(/var/cache/apt/archives/partial/). - Can be run as part of the package installation (clean runs before install) or as a separate step. type: bool default: false version_added: 6.5.0 dist_upgrade: description: - If true performs an C(apt-get dist-upgrade) to upgrade system. type: bool default: false version_added: 6.5.0 update_kernel: description: - If true performs an C(update-kernel) to upgrade kernel packages. type: bool default: false version_added: 6.5.0 author: - Evgenii Terechkov (@evgkrsk) ''' EXAMPLES = ''' - name: Install package foo community.general.apt_rpm: pkg: foo state: present - name: Install packages foo and bar community.general.apt_rpm: pkg: - foo - bar state: present - name: Remove package foo community.general.apt_rpm: pkg: foo state: absent - name: Remove packages foo and bar community.general.apt_rpm: pkg: foo,bar state: absent # bar will be the updated if a newer version exists - name: Update the package database and install bar community.general.apt_rpm: name: bar state: present update_cache: true - name: Run the equivalent of "apt-get clean" as a separate step community.general.apt_rpm: clean: true - name: Perform cache update and complete system upgrade (includes kernel) community.general.apt_rpm: update_cache: true dist_upgrade: true update_kernel: true ''' import os from ansible.module_utils.basic import AnsibleModule APT_PATH = "/usr/bin/apt-get" RPM_PATH = "/usr/bin/rpm" APT_GET_ZERO = "\n0 upgraded, 0 newly installed" UPDATE_KERNEL_ZERO = "\nTry to install new kernel " def query_package(module, name): # rpm -q returns 0 if the package is installed, # 1 if it is not installed rc, out, err = module.run_command("%s -q %s" % (RPM_PATH, name)) if rc == 0: return True else: return False def query_package_provides(module, name): # rpm -q returns 0 if the package is installed, # 1 if it is not installed rc, out, err = module.run_command("%s -q --provides %s" % (RPM_PATH, name)) return rc == 0 def update_package_db(module): rc, update_out, err = module.run_command([APT_PATH, "update"], check_rc=True, environ_update={"LANG": "C"}) return (False, update_out) def dir_size(module, path): total_size = 0 for path, dirs, files in os.walk(path): for f in files: total_size += os.path.getsize(os.path.join(path, f)) return total_size def clean(module): t = dir_size(module, "/var/cache/apt/archives") rc, out, err = module.run_command([APT_PATH, "clean"], check_rc=True) return (t != dir_size(module, "/var/cache/apt/archives"), out) def dist_upgrade(module): rc, out, err = module.run_command([APT_PATH, "-y", "dist-upgrade"], check_rc=True, environ_update={"LANG": "C"}) return (APT_GET_ZERO not in out, out) def update_kernel(module): rc, out, err = module.run_command(["/usr/sbin/update-kernel", "-y"], check_rc=True, environ_update={"LANG": "C"}) return (UPDATE_KERNEL_ZERO not in out, out) def remove_packages(module, packages): if packages is None: return (False, "Empty package list") remove_c = 0 # Using a for loop in case of error, we can report the package that failed for package in packages: # Query the package first, to see if we even need to remove if not query_package(module, package): continue rc, out, err = module.run_command("%s -y remove %s" % (APT_PATH, package), environ_update={"LANG": "C"}) if rc != 0: module.fail_json(msg="failed to remove %s: %s" % (package, err)) remove_c += 1 if remove_c > 0: return (True, "removed %s package(s)" % remove_c) return (False, "package(s) already absent") def install_packages(module, pkgspec): if pkgspec is None: return (False, "Empty package list") packages = "" for package in pkgspec: if not query_package_provides(module, package): packages += "'%s' " % package if len(packages) != 0: rc, out, err = module.run_command("%s -y install %s" % (APT_PATH, packages), environ_update={"LANG": "C"}) installed = True for packages in pkgspec: if not query_package_provides(module, package): installed = False # apt-rpm always have 0 for exit code if --force is used if rc or not installed: module.fail_json(msg="'apt-get -y install %s' failed: %s" % (packages, err)) else: return (True, "%s present(s)" % packages) else: return (False, "Nothing to install") def main(): module = AnsibleModule( argument_spec=dict( state=dict(type='str', default='present', choices=['absent', 'installed', 'present', 'removed']), update_cache=dict(type='bool', default=False), clean=dict(type='bool', default=False), dist_upgrade=dict(type='bool', default=False), update_kernel=dict(type='bool', default=False), package=dict(type='list', elements='str', aliases=['name', 'pkg']), ), ) if not os.path.exists(APT_PATH) or not os.path.exists(RPM_PATH): module.fail_json(msg="cannot find /usr/bin/apt-get and/or /usr/bin/rpm") p = module.params modified = False output = "" if p['update_cache']: update_package_db(module) if p['clean']: (m, out) = clean(module) modified = modified or m if p['dist_upgrade']: (m, out) = dist_upgrade(module) modified = modified or m output += out if p['update_kernel']: (m, out) = update_kernel(module) modified = modified or m output += out packages = p['package'] if p['state'] in ['installed', 'present']: (m, out) = install_packages(module, packages) modified = modified or m output += out if p['state'] in ['absent', 'removed']: (m, out) = remove_packages(module, packages) modified = modified or m output += out # Return total modification status and output of all commands module.exit_json(changed=modified, msg=output) if __name__ == '__main__': main() PK $�!\c/�� V collections/ansible_collections/community/general/plugins/modules/proxmox_user_info.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Tristan Le Guern <tleguern at bouledef.eu> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: proxmox_user_info short_description: Retrieve information about one or more Proxmox VE users version_added: 1.3.0 description: - Retrieve information about one or more Proxmox VE users options: domain: description: - Restrict results to a specific authentication realm. aliases: ['realm'] type: str user: description: - Restrict results to a specific user. aliases: ['name'] type: str userid: description: - Restrict results to a specific user ID, which is a concatenation of a user and domain parts. type: str author: Tristan Le Guern (@tleguern) extends_documentation_fragment: - community.general.proxmox.documentation - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: List existing users community.general.proxmox_user_info: api_host: helldorado api_user: root@pam api_password: "{{ password | default(omit) }}" api_token_id: "{{ token_id | default(omit) }}" api_token_secret: "{{ token_secret | default(omit) }}" register: proxmox_users - name: List existing users in the pve authentication realm community.general.proxmox_user_info: api_host: helldorado api_user: root@pam api_password: "{{ password | default(omit) }}" api_token_id: "{{ token_id | default(omit) }}" api_token_secret: "{{ token_secret | default(omit) }}" domain: pve register: proxmox_users_pve - name: Retrieve information about admin@pve community.general.proxmox_user_info: api_host: helldorado api_user: root@pam api_password: "{{ password | default(omit) }}" api_token_id: "{{ token_id | default(omit) }}" api_token_secret: "{{ token_secret | default(omit) }}" userid: admin@pve register: proxmox_user_admin - name: Alternative way to retrieve information about admin@pve community.general.proxmox_user_info: api_host: helldorado api_user: root@pam api_password: "{{ password | default(omit) }}" api_token_id: "{{ token_id | default(omit) }}" api_token_secret: "{{ token_secret | default(omit) }}" user: admin domain: pve register: proxmox_user_admin ''' RETURN = ''' proxmox_users: description: List of users. returned: always, but can be empty type: list elements: dict contains: comment: description: Short description of the user. returned: on success type: str domain: description: User's authentication realm, also the right part of the user ID. returned: on success type: str email: description: User's email address. returned: on success type: str enabled: description: User's account state. returned: on success type: bool expire: description: Expiration date in seconds since EPOCH. Zero means no expiration. returned: on success type: int firstname: description: User's first name. returned: on success type: str groups: description: List of groups which the user is a member of. returned: on success type: list elements: str keys: description: User's two factor authentication keys. returned: on success type: str lastname: description: User's last name. returned: on success type: str tokens: description: List of API tokens associated to the user. returned: on success type: list elements: dict contains: comment: description: Short description of the token. returned: on success type: str expire: description: Expiration date in seconds since EPOCH. Zero means no expiration. returned: on success type: int privsep: description: Describe if the API token is further restricted with ACLs or is fully privileged. returned: on success type: bool tokenid: description: Token name. returned: on success type: str user: description: User's login name, also the left part of the user ID. returned: on success type: str userid: description: Proxmox user ID, represented as user@realm. returned: on success type: str ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.proxmox import ( proxmox_auth_argument_spec, ProxmoxAnsible, proxmox_to_ansible_bool) class ProxmoxUserInfoAnsible(ProxmoxAnsible): def get_user(self, userid): try: user = self.proxmox_api.access.users.get(userid) except Exception: self.module.fail_json(msg="User '%s' does not exist" % userid) user['userid'] = userid return ProxmoxUser(user) def get_users(self, domain=None): users = self.proxmox_api.access.users.get(full=1) users = [ProxmoxUser(user) for user in users] if domain: return [user for user in users if user.user['domain'] == domain] return users class ProxmoxUser: def __init__(self, user): self.user = dict() # Data representation is not the same depending on API calls for k, v in user.items(): if k == 'enable': self.user['enabled'] = proxmox_to_ansible_bool(user['enable']) elif k == 'userid': self.user['user'] = user['userid'].split('@')[0] self.user['domain'] = user['userid'].split('@')[1] self.user[k] = v elif k in ['groups', 'tokens'] and (v == '' or v is None): self.user[k] = [] elif k == 'groups' and isinstance(v, str): self.user['groups'] = v.split(',') elif k == 'tokens' and isinstance(v, list): for token in v: if 'privsep' in token: token['privsep'] = proxmox_to_ansible_bool(token['privsep']) self.user['tokens'] = v elif k == 'tokens' and isinstance(v, dict): self.user['tokens'] = list() for tokenid, tokenvalues in v.items(): t = tokenvalues t['tokenid'] = tokenid if 'privsep' in tokenvalues: t['privsep'] = proxmox_to_ansible_bool(tokenvalues['privsep']) self.user['tokens'].append(t) else: self.user[k] = v def proxmox_user_info_argument_spec(): return dict( domain=dict(type='str', aliases=['realm']), user=dict(type='str', aliases=['name']), userid=dict(type='str'), ) def main(): module_args = proxmox_auth_argument_spec() user_info_args = proxmox_user_info_argument_spec() module_args.update(user_info_args) module = AnsibleModule( argument_spec=module_args, required_one_of=[('api_password', 'api_token_id')], required_together=[('api_token_id', 'api_token_secret')], mutually_exclusive=[('user', 'userid'), ('domain', 'userid')], supports_check_mode=True ) result = dict( changed=False ) proxmox = ProxmoxUserInfoAnsible(module) domain = module.params['domain'] user = module.params['user'] if user and domain: userid = user + '@' + domain else: userid = module.params['userid'] if userid: users = [proxmox.get_user(userid=userid)] else: users = proxmox.get_users(domain=domain) result['proxmox_users'] = [user.user for user in users] module.exit_json(**result) if __name__ == '__main__': main() PK $�!\�O�.� � N collections/ansible_collections/community/general/plugins/modules/ipmi_boot.pynu �[��� # -*- coding: utf-8 -*- # # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: ipmi_boot short_description: Management of order of boot devices description: - Use this module to manage order of boot devices extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Hostname or ip address of the BMC. required: true type: str port: description: - Remote RMCP port. default: 623 type: int user: description: - Username to use to connect to the BMC. required: true type: str password: description: - Password to connect to the BMC. required: true type: str key: description: - Encryption key to connect to the BMC in hex format. required: false type: str version_added: 4.1.0 bootdev: description: - Set boot device to use on next reboot - "The choices for the device are: - network -- Request network boot - floppy -- Boot from floppy - hd -- Boot from hard drive - safe -- Boot from hard drive, requesting 'safe mode' - optical -- boot from CD/DVD/BD drive - setup -- Boot into setup utility - default -- remove any IPMI directed boot device request" required: true choices: - network - floppy - hd - safe - optical - setup - default type: str state: description: - Whether to ensure that boot devices is desired. - "The choices for the state are: - present -- Request system turn on - absent -- Request system turn on" default: present choices: [ present, absent ] type: str persistent: description: - If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this. type: bool default: false uefiboot: description: - If set, request UEFI boot explicitly. Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option. In practice, this flag not being set does not preclude UEFI boot on any system I've encountered. type: bool default: false requirements: - "python >= 2.6" - pyghmi author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>" ''' RETURN = ''' bootdev: description: The boot device name which will be used beyond next boot. returned: success type: str sample: default persistent: description: If True, system firmware will use this device beyond next boot. returned: success type: bool sample: false uefimode: description: If True, system firmware will use UEFI boot explicitly beyond next boot. returned: success type: bool sample: false ''' EXAMPLES = ''' - name: Ensure bootdevice is HD community.general.ipmi_boot: name: test.testdomain.com user: admin password: password bootdev: hd - name: Ensure bootdevice is not Network community.general.ipmi_boot: name: test.testdomain.com user: admin password: password key: 1234567890AABBCCDEFF000000EEEE12 bootdev: network state: absent ''' import traceback import binascii PYGHMI_IMP_ERR = None try: from pyghmi.ipmi import command except ImportError: PYGHMI_IMP_ERR = traceback.format_exc() command = None from ansible.module_utils.basic import AnsibleModule, missing_required_lib def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True), port=dict(default=623, type='int'), user=dict(required=True, no_log=True), password=dict(required=True, no_log=True), key=dict(type='str', no_log=True), state=dict(default='present', choices=['present', 'absent']), bootdev=dict(required=True, choices=['network', 'hd', 'floppy', 'safe', 'optical', 'setup', 'default']), persistent=dict(default=False, type='bool'), uefiboot=dict(default=False, type='bool') ), supports_check_mode=True, ) if command is None: module.fail_json(msg=missing_required_lib('pyghmi'), exception=PYGHMI_IMP_ERR) name = module.params['name'] port = module.params['port'] user = module.params['user'] password = module.params['password'] state = module.params['state'] bootdev = module.params['bootdev'] persistent = module.params['persistent'] uefiboot = module.params['uefiboot'] request = dict() if state == 'absent' and bootdev == 'default': module.fail_json(msg="The bootdev 'default' cannot be used with state 'absent'.") try: if module.params['key']: key = binascii.unhexlify(module.params['key']) else: key = None except Exception as e: module.fail_json(msg="Unable to convert 'key' from hex string.") # --- run command --- try: ipmi_cmd = command.Command( bmc=name, userid=user, password=password, port=port, kg=key ) module.debug('ipmi instantiated - name: "%s"' % name) current = ipmi_cmd.get_bootdev() # uefimode may not supported by BMC, so use desired value as default current.setdefault('uefimode', uefiboot) if state == 'present' and current != dict(bootdev=bootdev, persistent=persistent, uefimode=uefiboot): request = dict(bootdev=bootdev, uefiboot=uefiboot, persist=persistent) elif state == 'absent' and current['bootdev'] == bootdev: request = dict(bootdev='default') else: module.exit_json(changed=False, **current) if module.check_mode: response = dict(bootdev=request['bootdev']) else: response = ipmi_cmd.set_bootdev(**request) if 'error' in response: module.fail_json(msg=response['error']) if 'persist' in request: response['persistent'] = request['persist'] if 'uefiboot' in request: response['uefimode'] = request['uefiboot'] module.exit_json(changed=True, **response) except Exception as e: module.fail_json(msg=str(e)) if __name__ == '__main__': main() PK $�!\j'� � b collections/ansible_collections/community/general/plugins/modules/oneview_ethernet_network_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' --- module: oneview_ethernet_network_info short_description: Retrieve the information about one or more of the OneView Ethernet Networks description: - Retrieve the information about one or more of the Ethernet Networks from OneView. - This module was called C(oneview_ethernet_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.oneview_ethernet_network_info) module no longer returns C(ansible_facts)! requirements: - hpOneView >= 2.0.1 author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name: description: - Ethernet Network name. type: str options: description: - "List with options to gather additional information about an Ethernet Network and related resources. Options allowed: V(associatedProfiles) and V(associatedUplinkGroups)." type: list elements: str extends_documentation_fragment: - community.general.oneview - community.general.oneview.factsparams - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' - name: Gather information about all Ethernet Networks community.general.oneview_ethernet_network_info: config: /etc/oneview/oneview_config.json delegate_to: localhost register: result - name: Print fetched information about Ethernet Networks ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather paginated and filtered information about Ethernet Networks community.general.oneview_ethernet_network_info: config: /etc/oneview/oneview_config.json params: start: 1 count: 3 sort: 'name:descending' filter: 'purpose=General' delegate_to: localhost register: result - name: Print fetched information about paginated and filtered list of Ethernet Networks ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather information about an Ethernet Network by name community.general.oneview_ethernet_network_info: config: /etc/oneview/oneview_config.json name: Ethernet network name delegate_to: localhost register: result - name: Print fetched information about Ethernet Network found by name ansible.builtin.debug: msg: "{{ result.ethernet_networks }}" - name: Gather information about an Ethernet Network by name with options community.general.oneview_ethernet_network_info: config: /etc/oneview/oneview_config.json name: eth1 options: - associatedProfiles - associatedUplinkGroups delegate_to: localhost register: result - name: Print fetched information about Ethernet Network Associated Profiles ansible.builtin.debug: msg: "{{ result.enet_associated_profiles }}" - name: Print fetched information about Ethernet Network Associated Uplink Groups ansible.builtin.debug: msg: "{{ result.enet_associated_uplink_groups }}" ''' RETURN = ''' ethernet_networks: description: Has all the OneView information about the Ethernet Networks. returned: Always, but can be null. type: dict enet_associated_profiles: description: Has all the OneView information about the profiles which are using the Ethernet network. returned: When requested, but can be null. type: dict enet_associated_uplink_groups: description: Has all the OneView information about the uplink sets which are using the Ethernet network. returned: When requested, but can be null. type: dict ''' from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase class EthernetNetworkInfoModule(OneViewModuleBase): argument_spec = dict( name=dict(type='str'), options=dict(type='list', elements='str'), params=dict(type='dict') ) def __init__(self): super(EthernetNetworkInfoModule, self).__init__( additional_arg_spec=self.argument_spec, supports_check_mode=True, ) self.resource_client = self.oneview_client.ethernet_networks def execute_module(self): info = {} if self.module.params['name']: ethernet_networks = self.resource_client.get_by('name', self.module.params['name']) if self.module.params.get('options') and ethernet_networks: info = self.__gather_optional_info(ethernet_networks[0]) else: ethernet_networks = self.resource_client.get_all(**self.facts_params) info['ethernet_networks'] = ethernet_networks return dict(changed=False, **info) def __gather_optional_info(self, ethernet_network): info = {} if self.options.get('associatedProfiles'): info['enet_associated_profiles'] = self.__get_associated_profiles(ethernet_network) if self.options.get('associatedUplinkGroups'): info['enet_associated_uplink_groups'] = self.__get_associated_uplink_groups(ethernet_network) return info def __get_associated_profiles(self, ethernet_network): associated_profiles = self.resource_client.get_associated_profiles(ethernet_network['uri']) return [self.oneview_client.server_profiles.get(x) for x in associated_profiles] def __get_associated_uplink_groups(self, ethernet_network): uplink_groups = self.resource_client.get_associated_uplink_groups(ethernet_network['uri']) return [self.oneview_client.uplink_sets.get(x) for x in uplink_groups] def main(): EthernetNetworkInfoModule().run() if __name__ == '__main__': main() PK $�!\�Фn�* �* S collections/ansible_collections/community/general/plugins/modules/cobbler_system.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Dag Wieers (dagwieers) <dag@wieers.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: cobbler_system short_description: Manage system objects in Cobbler description: - Add, modify or remove systems in Cobbler extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: host: description: - The name or IP address of the Cobbler system. default: 127.0.0.1 type: str port: description: - Port number to be used for REST connection. - The default value depends on parameter O(use_ssl). type: int username: description: - The username to log in to Cobbler. default: cobbler type: str password: description: - The password to log in to Cobbler. type: str use_ssl: description: - If V(false), an HTTP connection will be used instead of the default HTTPS connection. type: bool default: true validate_certs: description: - If V(false), SSL certificates will not be validated. - This should only set to V(false) when used on personally controlled sites using self-signed certificates. type: bool default: true name: description: - The system name to manage. type: str properties: description: - A dictionary with system properties. type: dict interfaces: description: - A list of dictionaries containing interface options. type: dict sync: description: - Sync on changes. - Concurrently syncing Cobbler is bound to fail. type: bool default: false state: description: - Whether the system should be present, absent or a query is made. choices: [ absent, present, query ] default: present type: str author: - Dag Wieers (@dagwieers) notes: - Concurrently syncing Cobbler is bound to fail with weird errors. - On python 2.7.8 and older (i.e. on RHEL7) you may need to tweak the python behaviour to disable certificate validation. More information at L(Certificate verification in Python standard library HTTP clients,https://access.redhat.com/articles/2039753). ''' EXAMPLES = r''' - name: Ensure the system exists in Cobbler community.general.cobbler_system: host: cobbler01 username: cobbler password: MySuperSecureP4sswOrd name: myhost properties: profile: CentOS6-x86_64 name_servers: [ 2.3.4.5, 3.4.5.6 ] name_servers_search: foo.com, bar.com interfaces: eth0: macaddress: 00:01:02:03:04:05 ipaddress: 1.2.3.4 delegate_to: localhost - name: Enable network boot in Cobbler community.general.cobbler_system: host: bdsol-aci-cobbler-01 username: cobbler password: ins3965! name: bdsol-aci51-apic1.cisco.com properties: netboot_enabled: true state: present delegate_to: localhost - name: Query all systems in Cobbler community.general.cobbler_system: host: cobbler01 username: cobbler password: MySuperSecureP4sswOrd state: query register: cobbler_systems delegate_to: localhost - name: Query a specific system in Cobbler community.general.cobbler_system: host: cobbler01 username: cobbler password: MySuperSecureP4sswOrd name: '{{ inventory_hostname }}' state: query register: cobbler_properties delegate_to: localhost - name: Ensure the system does not exist in Cobbler community.general.cobbler_system: host: cobbler01 username: cobbler password: MySuperSecureP4sswOrd name: myhost state: absent delegate_to: localhost ''' RETURN = r''' systems: description: List of systems returned: O(state=query) and O(name) is not provided type: list system: description: (Resulting) information about the system we are working with returned: when O(name) is provided type: dict ''' import datetime import ssl from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import iteritems from ansible.module_utils.six.moves import xmlrpc_client from ansible.module_utils.common.text.converters import to_text IFPROPS_MAPPING = dict( bondingopts='bonding_opts', bridgeopts='bridge_opts', connected_mode='connected_mode', cnames='cnames', dhcptag='dhcp_tag', dnsname='dns_name', ifgateway='if_gateway', interfacetype='interface_type', interfacemaster='interface_master', ipaddress='ip_address', ipv6address='ipv6_address', ipv6defaultgateway='ipv6_default_gateway', ipv6mtu='ipv6_mtu', ipv6prefix='ipv6_prefix', ipv6secondaries='ipv6_secondariesu', ipv6staticroutes='ipv6_static_routes', macaddress='mac_address', management='management', mtu='mtu', netmask='netmask', static='static', staticroutes='static_routes', virtbridge='virt_bridge', ) def getsystem(conn, name, token): system = dict() if name: # system = conn.get_system(name, token) systems = conn.find_system(dict(name=name), token) if systems: system = systems[0] return system def main(): module = AnsibleModule( argument_spec=dict( host=dict(type='str', default='127.0.0.1'), port=dict(type='int'), username=dict(type='str', default='cobbler'), password=dict(type='str', no_log=True), use_ssl=dict(type='bool', default=True), validate_certs=dict(type='bool', default=True), name=dict(type='str'), interfaces=dict(type='dict'), properties=dict(type='dict'), sync=dict(type='bool', default=False), state=dict(type='str', default='present', choices=['absent', 'present', 'query']), ), supports_check_mode=True, ) username = module.params['username'] password = module.params['password'] port = module.params['port'] use_ssl = module.params['use_ssl'] validate_certs = module.params['validate_certs'] name = module.params['name'] state = module.params['state'] module.params['proto'] = 'https' if use_ssl else 'http' if not port: module.params['port'] = '443' if use_ssl else '80' result = dict( changed=False, ) start = datetime.datetime.utcnow() ssl_context = None if not validate_certs: try: ssl_context = ssl._create_unverified_context() except AttributeError: # Legacy Python that doesn't verify HTTPS certificates by default pass else: # Handle target environment that doesn't support HTTPS verification ssl._create_default_https_context = ssl._create_unverified_context url = '{proto}://{host}:{port}/cobbler_api'.format(**module.params) if ssl_context: conn = xmlrpc_client.ServerProxy(url, context=ssl_context) else: conn = xmlrpc_client.Server(url) try: token = conn.login(username, password) except xmlrpc_client.Fault as e: module.fail_json(msg="Failed to log in to Cobbler '{url}' as '{username}'. {error}".format(url=url, error=to_text(e), **module.params)) except Exception as e: module.fail_json(msg="Connection to '{url}' failed. {error}".format(url=url, error=to_text(e), **module.params)) system = getsystem(conn, name, token) # result['system'] = system if state == 'query': if name: result['system'] = system else: # Turn it into a dictionary of dictionaries # all_systems = conn.get_systems() # result['systems'] = { system['name']: system for system in all_systems } # Return a list of dictionaries result['systems'] = conn.get_systems() elif state == 'present': if system: # Update existing entry system_id = conn.get_system_handle(name, token) for key, value in iteritems(module.params['properties']): if key not in system: module.warn("Property '{0}' is not a valid system property.".format(key)) if system[key] != value: try: conn.modify_system(system_id, key, value, token) result['changed'] = True except Exception as e: module.fail_json(msg="Unable to change '{0}' to '{1}'. {2}".format(key, value, e)) else: # Create a new entry system_id = conn.new_system(token) conn.modify_system(system_id, 'name', name, token) result['changed'] = True if module.params['properties']: for key, value in iteritems(module.params['properties']): try: conn.modify_system(system_id, key, value, token) except Exception as e: module.fail_json(msg="Unable to change '{0}' to '{1}'. {2}".format(key, value, e)) # Add interface properties interface_properties = dict() if module.params['interfaces']: for device, values in iteritems(module.params['interfaces']): for key, value in iteritems(values): if key == 'name': continue if key not in IFPROPS_MAPPING: module.warn("Property '{0}' is not a valid system property.".format(key)) if not system or system['interfaces'][device][IFPROPS_MAPPING[key]] != value: result['changed'] = True interface_properties['{0}-{1}'.format(key, device)] = value if result['changed'] is True: conn.modify_system(system_id, "modify_interface", interface_properties, token) # Only save when the entry was changed if not module.check_mode and result['changed']: conn.save_system(system_id, token) elif state == 'absent': if system: if not module.check_mode: conn.remove_system(name, token) result['changed'] = True if not module.check_mode and module.params['sync'] and result['changed']: try: conn.sync(token) except Exception as e: module.fail_json(msg="Failed to sync Cobbler. {0}".format(to_text(e))) if state in ('absent', 'present'): result['system'] = getsystem(conn, name, token) if module._diff: result['diff'] = dict(before=system, after=result['system']) elapsed = datetime.datetime.utcnow() - start module.exit_json(elapsed=elapsed.seconds, **result) if __name__ == '__main__': main() PK $�!\��-�k, k, P collections/ansible_collections/community/general/plugins/modules/taiga_issue.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Alejandro Guirao <lekumberri@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: taiga_issue short_description: Creates/deletes an issue in a Taiga Project Management Platform description: - Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)). - An issue is identified by the combination of project, issue subject and issue type. - This module implements the creation or deletion of issues (not the update). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: taiga_host: type: str description: - The hostname of the Taiga instance. default: https://api.taiga.io project: type: str description: - Name of the project containing the issue. Must exist previously. required: true subject: type: str description: - The issue subject. required: true issue_type: type: str description: - The issue type. Must exist previously. required: true priority: type: str description: - The issue priority. Must exist previously. default: Normal status: type: str description: - The issue status. Must exist previously. default: New severity: type: str description: - The issue severity. Must exist previously. default: Normal description: type: str description: - The issue description. default: "" attachment: type: path description: - Path to a file to be attached to the issue. attachment_description: type: str description: - A string describing the file to be attached to the issue. default: "" tags: type: list elements: str description: - A lists of tags to be assigned to the issue. default: [] state: type: str description: - Whether the issue should be present or not. choices: ["present", "absent"] default: present author: Alejandro Guirao (@lekum) requirements: [python-taiga] notes: - The authentication is achieved either by the environment variable TAIGA_TOKEN or by the pair of environment variables TAIGA_USERNAME and TAIGA_PASSWORD ''' EXAMPLES = ''' - name: Create an issue in the my hosted Taiga environment and attach an error log community.general.taiga_issue: taiga_host: https://mytaigahost.example.com project: myproject subject: An error has been found issue_type: Bug priority: High status: New severity: Important description: An error has been found. Please check the attached error log for details. attachment: /path/to/error.log attachment_description: Error log file tags: - Error - Needs manual check state: present - name: Deletes the previously created issue community.general.taiga_issue: taiga_host: https://mytaigahost.example.com project: myproject subject: An error has been found issue_type: Bug state: absent ''' RETURN = '''# ''' import traceback from os import getenv from os.path import isfile from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.text.converters import to_native TAIGA_IMP_ERR = None try: from taiga import TaigaAPI from taiga.exceptions import TaigaException TAIGA_MODULE_IMPORTED = True except ImportError: TAIGA_IMP_ERR = traceback.format_exc() TAIGA_MODULE_IMPORTED = False def manage_issue(taiga_host, project_name, issue_subject, issue_priority, issue_status, issue_type, issue_severity, issue_description, issue_attachment, issue_attachment_description, issue_tags, state, check_mode=False): """ Method that creates/deletes issues depending whether they exist and the state desired The credentials should be passed via environment variables: - TAIGA_TOKEN - TAIGA_USERNAME and TAIGA_PASSWORD Returns a tuple with these elements: - A boolean representing the success of the operation - A descriptive message - A dict with the issue attributes, in case of issue creation, otherwise empty dict """ changed = False try: token = getenv('TAIGA_TOKEN') if token: api = TaigaAPI(host=taiga_host, token=token) else: api = TaigaAPI(host=taiga_host) username = getenv('TAIGA_USERNAME') password = getenv('TAIGA_PASSWORD') if not any([username, password]): return False, changed, "Missing credentials", {} api.auth(username=username, password=password) user_id = api.me().id project_list = list(filter(lambda x: x.name == project_name, api.projects.list(member=user_id))) if len(project_list) != 1: return False, changed, "Unable to find project %s" % project_name, {} project = project_list[0] project_id = project.id priority_list = list(filter(lambda x: x.name == issue_priority, api.priorities.list(project=project_id))) if len(priority_list) != 1: return False, changed, "Unable to find issue priority %s for project %s" % (issue_priority, project_name), {} priority_id = priority_list[0].id status_list = list(filter(lambda x: x.name == issue_status, api.issue_statuses.list(project=project_id))) if len(status_list) != 1: return False, changed, "Unable to find issue status %s for project %s" % (issue_status, project_name), {} status_id = status_list[0].id type_list = list(filter(lambda x: x.name == issue_type, project.list_issue_types())) if len(type_list) != 1: return False, changed, "Unable to find issue type %s for project %s" % (issue_type, project_name), {} type_id = type_list[0].id severity_list = list(filter(lambda x: x.name == issue_severity, project.list_severities())) if len(severity_list) != 1: return False, changed, "Unable to find severity %s for project %s" % (issue_severity, project_name), {} severity_id = severity_list[0].id issue = { "project": project_name, "subject": issue_subject, "priority": issue_priority, "status": issue_status, "type": issue_type, "severity": issue_severity, "description": issue_description, "tags": issue_tags, } # An issue is identified by the project_name, the issue_subject and the issue_type matching_issue_list = list(filter(lambda x: x.subject == issue_subject and x.type == type_id, project.list_issues())) matching_issue_list_len = len(matching_issue_list) if matching_issue_list_len == 0: # The issue does not exist in the project if state == "present": # This implies a change changed = True if not check_mode: # Create the issue new_issue = project.add_issue(issue_subject, priority_id, status_id, type_id, severity_id, tags=issue_tags, description=issue_description) if issue_attachment: new_issue.attach(issue_attachment, description=issue_attachment_description) issue["attachment"] = issue_attachment issue["attachment_description"] = issue_attachment_description return True, changed, "Issue created", issue else: # If does not exist, do nothing return True, changed, "Issue does not exist", {} elif matching_issue_list_len == 1: # The issue exists in the project if state == "absent": # This implies a change changed = True if not check_mode: # Delete the issue matching_issue_list[0].delete() return True, changed, "Issue deleted", {} else: # Do nothing return True, changed, "Issue already exists", {} else: # More than 1 matching issue return False, changed, "More than one issue with subject %s in project %s" % (issue_subject, project_name), {} except TaigaException as exc: msg = "An exception happened: %s" % to_native(exc) return False, changed, msg, {} def main(): module = AnsibleModule( argument_spec=dict( taiga_host=dict(type='str', required=False, default="https://api.taiga.io"), project=dict(type='str', required=True), subject=dict(type='str', required=True), issue_type=dict(type='str', required=True), priority=dict(type='str', required=False, default="Normal"), status=dict(type='str', required=False, default="New"), severity=dict(type='str', required=False, default="Normal"), description=dict(type='str', required=False, default=""), attachment=dict(type='path', required=False, default=None), attachment_description=dict(type='str', required=False, default=""), tags=dict(required=False, default=[], type='list', elements='str'), state=dict(type='str', required=False, choices=['present', 'absent'], default='present'), ), supports_check_mode=True ) if not TAIGA_MODULE_IMPORTED: module.fail_json(msg=missing_required_lib("python-taiga"), exception=TAIGA_IMP_ERR) taiga_host = module.params['taiga_host'] project_name = module.params['project'] issue_subject = module.params['subject'] issue_priority = module.params['priority'] issue_status = module.params['status'] issue_type = module.params['issue_type'] issue_severity = module.params['severity'] issue_description = module.params['description'] issue_attachment = module.params['attachment'] issue_attachment_description = module.params['attachment_description'] if issue_attachment: if not isfile(issue_attachment): msg = "%s is not a file" % issue_attachment module.fail_json(msg=msg) issue_tags = module.params['tags'] state = module.params['state'] return_status, changed, msg, issue_attr_dict = manage_issue( taiga_host, project_name, issue_subject, issue_priority, issue_status, issue_type, issue_severity, issue_description, issue_attachment, issue_attachment_description, issue_tags, state, check_mode=module.check_mode ) if return_status: if issue_attr_dict: module.exit_json(changed=changed, msg=msg, issue=issue_attr_dict) else: module.exit_json(changed=changed, msg=msg) else: module.fail_json(msg=msg) if __name__ == '__main__': main() PK $�!\�[F� _ collections/ansible_collections/community/general/plugins/modules/scaleway_organization_info.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2018, Yanis Guenane <yanis+ansible@guenane.org> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: scaleway_organization_info short_description: Gather information about the Scaleway organizations available description: - Gather information about the Scaleway organizations available. author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" options: api_url: description: - Scaleway API URL. default: 'https://account.scaleway.com' aliases: ['base_url'] extends_documentation_fragment: - community.general.scaleway - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = r''' - name: Gather Scaleway organizations information community.general.scaleway_organization_info: register: result - ansible.builtin.debug: msg: "{{ result.scaleway_organization_info }}" ''' RETURN = r''' --- scaleway_organization_info: description: Response from Scaleway API. returned: success type: list elements: dict sample: "scaleway_organization_info": [ { "address_city_name": "Paris", "address_country_code": "FR", "address_line1": "42 Rue de l'univers", "address_line2": null, "address_postal_code": "75042", "address_subdivision_code": "FR-75", "creation_date": "2018-08-06T13:43:28.508575+00:00", "currency": "EUR", "customer_class": "individual", "id": "3f709602-5e6c-4619-b80c-e8432ferewtr", "locale": "fr_FR", "modification_date": "2018-08-06T14:56:41.401685+00:00", "name": "James Bond", "support_id": "694324", "support_level": "basic", "support_pin": "9324", "users": [], "vat_number": null, "warnings": [] } ] ''' from ansible.module_utils.basic import AnsibleModule, env_fallback from ansible_collections.community.general.plugins.module_utils.scaleway import ( Scaleway, ScalewayException, scaleway_argument_spec ) class ScalewayOrganizationInfo(Scaleway): def __init__(self, module): super(ScalewayOrganizationInfo, self).__init__(module) self.name = 'organizations' def main(): argument_spec = scaleway_argument_spec() argument_spec.update(dict( api_url=dict(fallback=(env_fallback, ['SCW_API_URL']), default='https://account.scaleway.com', aliases=['base_url']), )) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) try: module.exit_json( scaleway_organization_info=ScalewayOrganizationInfo(module).get_resources() ) except ScalewayException as exc: module.fail_json(msg=exc.message) if __name__ == '__main__': main() PK $�!\�uס d collections/ansible_collections/community/general/plugins/modules/profitbricks_volume_attachments.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: profitbricks_volume_attachments short_description: Attach or detach a volume description: - Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0 extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: datacenter: description: - The datacenter in which to operate. type: str server: description: - The name of the server you wish to detach or attach the volume. type: str volume: description: - The volume name or ID. type: str subscription_user: description: - The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable. type: str required: false subscription_password: description: - THe ProfitBricks password. Overrides the PB_PASSWORD environment variable. type: str required: false wait: description: - wait for the operation to complete before returning required: false default: true type: bool wait_timeout: description: - how long before wait gives up, in seconds type: int default: 600 state: description: - Indicate desired state of the resource - "The available choices are: V(present), V(absent)." type: str required: false default: 'present' requirements: [ "profitbricks" ] author: Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com> ''' EXAMPLES = ''' - name: Attach a volume community.general.profitbricks_volume_attachments: datacenter: Tardis One server: node002 volume: vol01 wait_timeout: 500 state: present - name: Detach a volume community.general.profitbricks_volume_attachments: datacenter: Tardis One server: node002 volume: vol01 wait_timeout: 500 state: absent ''' import re import time HAS_PB_SDK = True try: from profitbricks.client import ProfitBricksService except ImportError: HAS_PB_SDK = False from ansible.module_utils.basic import AnsibleModule uuid_match = re.compile( r'[\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}', re.I) def _wait_for_completion(profitbricks, promise, wait_timeout, msg): if not promise: return wait_timeout = time.time() + wait_timeout while wait_timeout > time.time(): time.sleep(5) operation_result = profitbricks.get_request( request_id=promise['requestId'], status=True) if operation_result['metadata']['status'] == "DONE": return elif operation_result['metadata']['status'] == "FAILED": raise Exception( 'Request failed to complete ' + msg + ' "' + str( promise['requestId']) + '" to complete.') raise Exception( 'Timed out waiting for async operation ' + msg + ' "' + str( promise['requestId'] ) + '" to complete.') def attach_volume(module, profitbricks): """ Attaches a volume. This will attach a volume to the server. module : AnsibleModule object profitbricks: authenticated profitbricks object. Returns: True if the volume was attached, false otherwise """ datacenter = module.params.get('datacenter') server = module.params.get('server') volume = module.params.get('volume') # Locate UUID for Datacenter if not (uuid_match.match(datacenter)): datacenter_list = profitbricks.list_datacenters() for d in datacenter_list['items']: dc = profitbricks.get_datacenter(d['id']) if datacenter == dc['properties']['name']: datacenter = d['id'] break # Locate UUID for Server if not (uuid_match.match(server)): server_list = profitbricks.list_servers(datacenter) for s in server_list['items']: if server == s['properties']['name']: server = s['id'] break # Locate UUID for Volume if not (uuid_match.match(volume)): volume_list = profitbricks.list_volumes(datacenter) for v in volume_list['items']: if volume == v['properties']['name']: volume = v['id'] break return profitbricks.attach_volume(datacenter, server, volume) def detach_volume(module, profitbricks): """ Detaches a volume. This will remove a volume from the server. module : AnsibleModule object profitbricks: authenticated profitbricks object. Returns: True if the volume was detached, false otherwise """ datacenter = module.params.get('datacenter') server = module.params.get('server') volume = module.params.get('volume') # Locate UUID for Datacenter if not (uuid_match.match(datacenter)): datacenter_list = profitbricks.list_datacenters() for d in datacenter_list['items']: dc = profitbricks.get_datacenter(d['id']) if datacenter == dc['properties']['name']: datacenter = d['id'] break # Locate UUID for Server if not (uuid_match.match(server)): server_list = profitbricks.list_servers(datacenter) for s in server_list['items']: if server == s['properties']['name']: server = s['id'] break # Locate UUID for Volume if not (uuid_match.match(volume)): volume_list = profitbricks.list_volumes(datacenter) for v in volume_list['items']: if volume == v['properties']['name']: volume = v['id'] break return profitbricks.detach_volume(datacenter, server, volume) def main(): module = AnsibleModule( argument_spec=dict( datacenter=dict(), server=dict(), volume=dict(), subscription_user=dict(), subscription_password=dict(no_log=True), wait=dict(type='bool', default=True), wait_timeout=dict(type='int', default=600), state=dict(default='present'), ) ) if not HAS_PB_SDK: module.fail_json(msg='profitbricks required for this module') if not module.params.get('subscription_user'): module.fail_json(msg='subscription_user parameter is required') if not module.params.get('subscription_password'): module.fail_json(msg='subscription_password parameter is required') if not module.params.get('datacenter'): module.fail_json(msg='datacenter parameter is required') if not module.params.get('server'): module.fail_json(msg='server parameter is required') if not module.params.get('volume'): module.fail_json(msg='volume parameter is required') subscription_user = module.params.get('subscription_user') subscription_password = module.params.get('subscription_password') profitbricks = ProfitBricksService( username=subscription_user, password=subscription_password) state = module.params.get('state') if state == 'absent': try: (changed) = detach_volume(module, profitbricks) module.exit_json(changed=changed) except Exception as e: module.fail_json(msg='failed to set volume_attach state: %s' % str(e)) elif state == 'present': try: attach_volume(module, profitbricks) module.exit_json() except Exception as e: module.fail_json(msg='failed to set volume_attach state: %s' % str(e)) if __name__ == '__main__': main() PK $�!\�H�0 0 R collections/ansible_collections/community/general/plugins/modules/gandi_livedns.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2019 Gregory Thiemonge <gregory.thiemonge@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: gandi_livedns author: - Gregory Thiemonge (@gthiemonge) version_added: "2.3.0" short_description: Manage Gandi LiveDNS records description: - "Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/)." extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: api_key: description: - Account API token. type: str required: true record: description: - Record to add. type: str required: true state: description: - Whether the record(s) should exist or not. type: str choices: [ absent, present ] default: present ttl: description: - The TTL to give the new record. - Required when O(state=present). type: int type: description: - The type of DNS record to create. type: str required: true values: description: - The record values. - Required when O(state=present). type: list elements: str domain: description: - The name of the Domain to work with (for example, "example.com"). required: true type: str ''' EXAMPLES = r''' - name: Create a test A record to point to 127.0.0.1 in the my.com domain community.general.gandi_livedns: domain: my.com record: test type: A values: - 127.0.0.1 ttl: 7200 api_key: dummyapitoken register: record - name: Create a mail CNAME record to www.my.com domain community.general.gandi_livedns: domain: my.com type: CNAME record: mail values: - www ttl: 7200 api_key: dummyapitoken state: present - name: Change its TTL community.general.gandi_livedns: domain: my.com type: CNAME record: mail values: - www ttl: 10800 api_key: dummyapitoken state: present - name: Delete the record community.general.gandi_livedns: domain: my.com type: CNAME record: mail api_key: dummyapitoken state: absent ''' RETURN = r''' record: description: A dictionary containing the record data. returned: success, except on record deletion type: dict contains: values: description: The record content (details depend on record type). returned: success type: list elements: str sample: - 192.0.2.91 - 192.0.2.92 record: description: The record name. returned: success type: str sample: www ttl: description: The time-to-live for the record. returned: success type: int sample: 300 type: description: The record type. returned: success type: str sample: A domain: description: The domain associated with the record. returned: success type: str sample: my.com ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.gandi_livedns_api import GandiLiveDNSAPI def main(): module = AnsibleModule( argument_spec=dict( api_key=dict(type='str', required=True, no_log=True), record=dict(type='str', required=True), state=dict(type='str', default='present', choices=['absent', 'present']), ttl=dict(type='int'), type=dict(type='str', required=True), values=dict(type='list', elements='str'), domain=dict(type='str', required=True), ), supports_check_mode=True, required_if=[ ('state', 'present', ['values', 'ttl']), ], ) gandi_api = GandiLiveDNSAPI(module) if module.params['state'] == 'present': ret, changed = gandi_api.ensure_dns_record(module.params['record'], module.params['type'], module.params['ttl'], module.params['values'], module.params['domain']) else: ret, changed = gandi_api.delete_dns_record(module.params['record'], module.params['type'], module.params['values'], module.params['domain']) result = dict( changed=changed, ) if ret: result['record'] = gandi_api.build_result(ret, module.params['domain']) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\���� � S collections/ansible_collections/community/general/plugins/modules/pkg5_publisher.pynu �[��� # -*- coding: utf-8 -*- # Copyright 2014 Peter Oliver <ansible@mavit.org.uk> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: pkg5_publisher author: "Peter Oliver (@mavit)" short_description: Manages Solaris 11 Image Packaging System publishers description: - IPS packages are the native packages in Solaris 11 and higher. - This modules will configure which publishers a client will download IPS packages from. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: name: description: - The publisher's name. required: true aliases: [ publisher ] type: str state: description: - Whether to ensure that a publisher is present or absent. default: present choices: [ present, absent ] type: str sticky: description: - Packages installed from a sticky repository can only receive updates from that repository. type: bool enabled: description: - Is the repository enabled or disabled? type: bool origin: description: - A path or URL to the repository. - Multiple values may be provided. type: list elements: str mirror: description: - A path or URL to the repository mirror. - Multiple values may be provided. type: list elements: str ''' EXAMPLES = ''' - name: Fetch packages for the solaris publisher direct from Oracle community.general.pkg5_publisher: name: solaris sticky: true origin: https://pkg.oracle.com/solaris/support/ - name: Configure a publisher for locally-produced packages community.general.pkg5_publisher: name: site origin: 'https://pkg.example.com/site/' ''' from ansible.module_utils.basic import AnsibleModule def main(): module = AnsibleModule( argument_spec=dict( name=dict(required=True, aliases=['publisher']), state=dict(default='present', choices=['present', 'absent']), sticky=dict(type='bool'), enabled=dict(type='bool'), # search_after=dict(), # search_before=dict(), origin=dict(type='list', elements='str'), mirror=dict(type='list', elements='str'), ) ) for option in ['origin', 'mirror']: if module.params[option] == ['']: module.params[option] = [] if module.params['state'] == 'present': modify_publisher(module, module.params) else: unset_publisher(module, module.params['name']) def modify_publisher(module, params): name = params['name'] existing = get_publishers(module) if name in existing: for option in ['origin', 'mirror', 'sticky', 'enabled']: if params[option] is not None: if params[option] != existing[name][option]: return set_publisher(module, params) else: return set_publisher(module, params) module.exit_json() def set_publisher(module, params): name = params['name'] args = [] if params['origin'] is not None: args.append('--remove-origin=*') args.extend(['--add-origin=' + u for u in params['origin']]) if params['mirror'] is not None: args.append('--remove-mirror=*') args.extend(['--add-mirror=' + u for u in params['mirror']]) if params['sticky'] is not None and params['sticky']: args.append('--sticky') elif params['sticky'] is not None: args.append('--non-sticky') if params['enabled'] is not None and params['enabled']: args.append('--enable') elif params['enabled'] is not None: args.append('--disable') rc, out, err = module.run_command( ["pkg", "set-publisher"] + args + [name], check_rc=True ) response = { 'rc': rc, 'results': [out], 'msg': err, 'changed': True, } if rc != 0: module.fail_json(**response) module.exit_json(**response) def unset_publisher(module, publisher): if publisher not in get_publishers(module): module.exit_json() rc, out, err = module.run_command( ["pkg", "unset-publisher", publisher], check_rc=True ) response = { 'rc': rc, 'results': [out], 'msg': err, 'changed': True, } if rc != 0: module.fail_json(**response) module.exit_json(**response) def get_publishers(module): rc, out, err = module.run_command(["pkg", "publisher", "-Ftsv"], True) lines = out.splitlines() keys = lines.pop(0).lower().split("\t") publishers = {} for line in lines: values = dict(zip(keys, map(unstringify, line.split("\t")))) name = values['publisher'] if name not in publishers: publishers[name] = dict( (k, values[k]) for k in ['sticky', 'enabled'] ) publishers[name]['origin'] = [] publishers[name]['mirror'] = [] if values['type'] is not None: publishers[name][values['type']].append(values['uri']) return publishers def unstringify(val): if val == "-" or val == '': return None elif val == "true": return True elif val == "false": return False else: return val if __name__ == '__main__': main() PK $�!\���$ O collections/ansible_collections/community/general/plugins/modules/locale_gen.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) Ansible project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: locale_gen short_description: Creates or removes locales description: - Manages locales by editing /etc/locale.gen and invoking locale-gen. author: - Augustus Kling (@AugustusKling) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: type: str description: - Name and encoding of the locale, such as "en_GB.UTF-8". required: true state: type: str description: - Whether the locale shall be present. choices: [ absent, present ] default: present notes: - This module does not support RHEL-based systems. ''' EXAMPLES = ''' - name: Ensure a locale exists community.general.locale_gen: name: de_CH.UTF-8 state: present ''' import os import re from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper from ansible_collections.community.general.plugins.module_utils.mh.deco import check_mode_skip from ansible_collections.community.general.plugins.module_utils.locale_gen import locale_runner, locale_gen_runner class LocaleGen(StateModuleHelper): LOCALE_NORMALIZATION = { ".utf8": ".UTF-8", ".eucjp": ".EUC-JP", ".iso885915": ".ISO-8859-15", ".cp1251": ".CP1251", ".koi8r": ".KOI8-R", ".armscii8": ".ARMSCII-8", ".euckr": ".EUC-KR", ".gbk": ".GBK", ".gb18030": ".GB18030", ".euctw": ".EUC-TW", } LOCALE_GEN = "/etc/locale.gen" LOCALE_SUPPORTED = "/var/lib/locales/supported.d/" output_params = ["name"] module = dict( argument_spec=dict( name=dict(type='str', required=True), state=dict(type='str', default='present', choices=['absent', 'present']), ), supports_check_mode=True, ) def __init_module__(self): self.vars.set("ubuntu_mode", False) if os.path.exists(self.LOCALE_SUPPORTED): self.vars.ubuntu_mode = True else: if not os.path.exists(self.LOCALE_GEN): self.do_raise("{0} and {1} are missing. Is the package \"locales\" installed?".format( self.LOCALE_SUPPORTED, self.LOCALE_GEN )) if not self.is_available(): self.do_raise("The locale you've entered is not available on your system.") self.vars.set("is_present", self.is_present(), output=False) self.vars.set("state_tracking", self._state_name(self.vars.is_present), output=False, change=True) def __quit_module__(self): self.vars.state_tracking = self._state_name(self.is_present()) @staticmethod def _state_name(present): return "present" if present else "absent" def is_available(self): """Check if the given locale is available on the system. This is done by checking either : * if the locale is present in /etc/locales.gen * or if the locale is present in /usr/share/i18n/SUPPORTED""" __regexp = r'^#?\s*(?P<locale>\S+[\._\S]+) (?P<charset>\S+)\s*$' if self.vars.ubuntu_mode: __locales_available = '/usr/share/i18n/SUPPORTED' else: __locales_available = '/etc/locale.gen' re_compiled = re.compile(__regexp) with open(__locales_available, 'r') as fd: lines = fd.readlines() res = [re_compiled.match(line) for line in lines] if self.verbosity >= 4: self.vars.available_lines = lines if any(r.group("locale") == self.vars.name for r in res if r): return True # locale may be installed but not listed in the file, for example C.UTF-8 in some systems return self.is_present() def is_present(self): runner = locale_runner(self.module) with runner() as ctx: rc, out, err = ctx.run() if self.verbosity >= 4: self.vars.locale_run_info = ctx.run_info return any(self.fix_case(self.vars.name) == self.fix_case(line) for line in out.splitlines()) def fix_case(self, name): """locale -a might return the encoding in either lower or upper case. Passing through this function makes them uniform for comparisons.""" for s, r in self.LOCALE_NORMALIZATION.items(): name = name.replace(s, r) return name def set_locale(self, name, enabled=True): """ Sets the state of the locale. Defaults to enabled. """ search_string = r'#?\s*%s (?P<charset>.+)' % re.escape(name) if enabled: new_string = r'%s \g<charset>' % (name) else: new_string = r'# %s \g<charset>' % (name) re_search = re.compile(search_string) with open("/etc/locale.gen", "r") as fr: lines = [re_search.sub(new_string, line) for line in fr] with open("/etc/locale.gen", "w") as fw: fw.write("".join(lines)) def apply_change(self, targetState, name): """Create or remove locale. Keyword arguments: targetState -- Desired state, either present or absent. name -- Name including encoding such as de_CH.UTF-8. """ self.set_locale(name, enabled=(targetState == "present")) runner = locale_gen_runner(self.module) with runner() as ctx: ctx.run() def apply_change_ubuntu(self, targetState, name): """Create or remove locale. Keyword arguments: targetState -- Desired state, either present or absent. name -- Name including encoding such as de_CH.UTF-8. """ runner = locale_gen_runner(self.module) if targetState == "present": # Create locale. # Ubuntu's patched locale-gen automatically adds the new locale to /var/lib/locales/supported.d/local with runner() as ctx: ctx.run() else: # Delete locale involves discarding the locale from /var/lib/locales/supported.d/local and regenerating all locales. with open("/var/lib/locales/supported.d/local", "r") as fr: content = fr.readlines() with open("/var/lib/locales/supported.d/local", "w") as fw: for line in content: locale, charset = line.split(' ') if locale != name: fw.write(line) # Purge locales and regenerate. # Please provide a patch if you know how to avoid regenerating the locales to keep! with runner("purge") as ctx: ctx.run() @check_mode_skip def __state_fallback__(self): if self.vars.state_tracking == self.vars.state: return if self.vars.ubuntu_mode: self.apply_change_ubuntu(self.vars.state, self.vars.name) else: self.apply_change(self.vars.state, self.vars.name) def main(): LocaleGen.execute() if __name__ == '__main__': main() PK $�!\;��K.7 .7 V collections/ansible_collections/community/general/plugins/modules/ali_instance_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017-present Alibaba Group Holding Limited. He Guimin <heguimin36@163.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later # # 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 = ''' --- module: ali_instance_info short_description: Gather information on instances of Alibaba Cloud ECS description: - This module fetches data from the Open API in Alicloud. The module must be called from within the ECS instance itself. - This module was called C(ali_instance_facts) before Ansible 2.9. The usage did not change. attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: name_prefix: description: - Use a instance name prefix to filter ecs instances. type: str version_added: '0.2.0' tags: description: - A hash/dictionaries of instance tags. C({"key":"value"}) aliases: ["instance_tags"] type: dict filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. The filter keys can be all of request parameters. See U(https://www.alibabacloud.com/help/doc-detail/25506.htm) for parameter details. Filter keys can be same as request parameter name or be lower case and use underscore (V("_")) or dash (V("-")) to connect different words in one parameter. C(InstanceIds) should be a list. C(Tag.n.Key) and C(Tag.n.Value) should be a dict and using O(tags) instead. type: dict version_added: '0.2.0' author: - "He Guimin (@xiaozhu36)" requirements: - "python >= 3.6" - "footmark >= 1.13.0" extends_documentation_fragment: - community.general.alicloud - community.general.attributes - community.general.attributes.info_module ''' EXAMPLES = ''' # Fetch instances details according to setting different filters - name: Find all instances in the specified region community.general.ali_instance_info: register: all_instances - name: Find all instances based on the specified ids community.general.ali_instance_info: instance_ids: - "i-35b333d9" - "i-ddav43kd" register: instances_by_ids - name: Find all instances based on the specified name_prefix community.general.ali_instance_info: name_prefix: "ecs_instance_" register: instances_by_name_prefix - name: Find instances based on tags community.general.ali_instance_info: tags: Test: "add" ''' RETURN = ''' instances: description: List of ECS instances returned: always type: complex contains: availability_zone: description: The availability zone of the instance is in. returned: always type: str sample: cn-beijing-a block_device_mappings: description: Any block device mapping entries for the instance. returned: always type: complex contains: device_name: description: The device name exposed to the instance (for example, /dev/xvda). returned: always type: str sample: /dev/xvda attach_time: description: The time stamp when the attachment initiated. returned: always type: str sample: "2018-06-25T04:08:26Z" delete_on_termination: description: Indicates whether the volume is deleted on instance termination. returned: always type: bool sample: true status: description: The attachment state. returned: always type: str sample: in_use volume_id: description: The ID of the cloud disk. returned: always type: str sample: d-2zei53pjsi117y6gf9t6 cpu: description: The CPU core count of the instance. returned: always type: int sample: 4 creation_time: description: The time the instance was created. returned: always type: str sample: "2018-06-25T04:08Z" description: description: The instance description. returned: always type: str sample: "my ansible instance" eip: description: The attribution of EIP associated with the instance. returned: always type: complex contains: allocation_id: description: The ID of the EIP. returned: always type: str sample: eip-12345 internet_charge_type: description: The internet charge type of the EIP. returned: always type: str sample: "paybybandwidth" ip_address: description: EIP address. returned: always type: str sample: 42.10.2.2 expired_time: description: The time the instance will expire. returned: always type: str sample: "2099-12-31T15:59Z" gpu: description: The attribution of instance GPU. returned: always type: complex contains: amount: description: The count of the GPU. returned: always type: int sample: 0 spec: description: The specification of the GPU. returned: always type: str sample: "" host_name: description: The host name of the instance. returned: always type: str sample: iZ2zewaoZ id: description: Alias of instance_id. returned: always type: str sample: i-abc12345 instance_id: description: ECS instance resource ID. returned: always type: str sample: i-abc12345 image_id: description: The ID of the image used to launch the instance. returned: always type: str sample: m-0011223344 inner_ip_address: description: The inner IPv4 address of the classic instance. returned: always type: str sample: 10.0.0.2 instance_charge_type: description: The instance charge type. returned: always type: str sample: PostPaid instance_name: description: The name of the instance. returned: always type: str sample: my-ecs instance_type_family: description: The instance type family of the instance belongs. returned: always type: str sample: ecs.sn1ne instance_type: description: The instance type of the running instance. returned: always type: str sample: ecs.sn1ne.xlarge internet_charge_type: description: The billing method of the network bandwidth. returned: always type: str sample: PayByBandwidth internet_max_bandwidth_in: description: Maximum incoming bandwidth from the internet network. returned: always type: int sample: 200 internet_max_bandwidth_out: description: Maximum incoming bandwidth from the internet network. returned: always type: int sample: 20 io_optimized: description: Indicates whether the instance is optimized for EBS I/O. returned: always type: bool sample: false memory: description: Memory size of the instance. returned: always type: int sample: 8192 network_interfaces: description: One or more network interfaces for the instance. returned: always type: complex contains: mac_address: description: The MAC address. returned: always type: str sample: "00:11:22:33:44:55" network_interface_id: description: The ID of the network interface. returned: always type: str sample: eni-01234567 primary_ip_address: description: The primary IPv4 address of the network interface within the vswitch. returned: always type: str sample: 10.0.0.1 osname: description: The operation system name of the instance owned. returned: always type: str sample: CentOS ostype: description: The operation system type of the instance owned. returned: always type: str sample: linux private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always type: str sample: 10.0.0.1 public_ip_address: description: The public IPv4 address assigned to the instance or eip address returned: always type: str sample: 43.0.0.1 resource_group_id: description: The id of the resource group to which the instance belongs. returned: always type: str sample: my-ecs-group security_groups: description: One or more security groups for the instance. returned: always type: list elements: dict contains: group_id: description: The ID of the security group. returned: always type: str sample: sg-0123456 group_name: description: The name of the security group. returned: always type: str sample: my-security-group status: description: The current status of the instance. returned: always type: str sample: running tags: description: Any tags assigned to the instance. returned: always type: dict sample: vswitch_id: description: The ID of the vswitch in which the instance is running. returned: always type: str sample: vsw-dew00abcdef vpc_id: description: The ID of the VPC the instance is in. returned: always type: str sample: vpc-0011223344 ids: description: List of ECS instance IDs returned: always type: list sample: [i-12345er, i-3245fs] ''' from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible_collections.community.general.plugins.module_utils.alicloud_ecs import ( ecs_argument_spec, ecs_connect, FOOTMARK_IMP_ERR, HAS_FOOTMARK ) def main(): argument_spec = ecs_argument_spec() argument_spec.update(dict( name_prefix=dict(type='str'), tags=dict(type='dict', aliases=['instance_tags']), filters=dict(type='dict') ) ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, ) if HAS_FOOTMARK is False: module.fail_json(msg=missing_required_lib('footmark'), exception=FOOTMARK_IMP_ERR) ecs = ecs_connect(module) instances = [] instance_ids = [] ids = [] name_prefix = module.params['name_prefix'] filters = module.params['filters'] if not filters: filters = {} for key, value in list(filters.items()): if key in ["InstanceIds", "instance_ids", "instance-ids"] and isinstance(ids, list): for id in value: if id not in ids: ids.append(value) if ids: filters['instance_ids'] = ids if module.params['tags']: filters['tags'] = module.params['tags'] for inst in ecs.describe_instances(**filters): if name_prefix: if not str(inst.instance_name).startswith(name_prefix): continue volumes = ecs.describe_disks(instance_id=inst.id) setattr(inst, 'block_device_mappings', volumes) setattr(inst, 'user_data', inst.describe_user_data()) instances.append(inst.read()) instance_ids.append(inst.id) module.exit_json(changed=False, ids=instance_ids, instances=instances) if __name__ == '__main__': main() PK $�!\ ��7�& �& g collections/ansible_collections/community/general/plugins/modules/keycloak_authz_authorization_scope.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Eike Frost <ei@kefro.st> # Copyright (c) 2021, Christophe Gilles <christophe.gilles54@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or # https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: keycloak_authz_authorization_scope short_description: Allows administration of Keycloak client authorization scopes via Keycloak API version_added: 6.6.0 description: - This module allows the administration of Keycloak client Authorization Scopes via the Keycloak REST API. Authorization Scopes are only available if a client has Authorization enabled. - This module requires access to the REST API via OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate realm definition with the scope tailored to your needs and a user having the expected roles. - The names of module options are snake_cased versions of the camelCase options used by Keycloak. The Authorization Services paths and payloads have not officially been documented by the Keycloak project. U(https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/) attributes: check_mode: support: full diff_mode: support: full options: state: description: - State of the authorization scope. - On V(present), the authorization scope will be created (or updated if it exists already). - On V(absent), the authorization scope will be removed if it exists. choices: ['present', 'absent'] default: 'present' type: str name: description: - Name of the authorization scope to create. type: str required: true display_name: description: - The display name of the authorization scope. type: str required: false icon_uri: description: - The icon URI for the authorization scope. type: str required: false client_id: description: - The C(clientId) of the Keycloak client that should have the authorization scope. - This is usually a human-readable name of the Keycloak client. type: str required: true realm: description: - The name of the Keycloak realm the Keycloak client is in. type: str required: true extends_documentation_fragment: - community.general.keycloak - community.general.attributes author: - Samuli Seppänen (@mattock) ''' EXAMPLES = ''' - name: Manage Keycloak file:delete authorization scope keycloak_authz_authorization_scope: name: file:delete state: present display_name: File delete client_id: myclient realm: myrealm auth_keycloak_url: http://localhost:8080/auth auth_username: keycloak auth_password: keycloak auth_realm: master ''' RETURN = ''' msg: description: Message as to what action was taken. returned: always type: str end_state: description: Representation of the authorization scope after module execution. returned: on success type: complex contains: id: description: ID of the authorization scope. type: str returned: when O(state=present) sample: a6ab1cf2-1001-40ec-9f39-48f23b6a0a41 name: description: Name of the authorization scope. type: str returned: when O(state=present) sample: file:delete display_name: description: Display name of the authorization scope. type: str returned: when O(state=present) sample: File delete icon_uri: description: Icon URI for the authorization scope. type: str returned: when O(state=present) sample: http://localhost/icon.png ''' from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, \ keycloak_argument_spec, get_token, KeycloakError from ansible.module_utils.basic import AnsibleModule def main(): """ Module execution :return: """ argument_spec = keycloak_argument_spec() meta_args = dict( state=dict(type='str', default='present', choices=['present', 'absent']), name=dict(type='str', required=True), display_name=dict(type='str', required=False), icon_uri=dict(type='str', required=False), client_id=dict(type='str', required=True), realm=dict(type='str', required=True) ) argument_spec.update(meta_args) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, required_one_of=( [['token', 'auth_realm', 'auth_username', 'auth_password']]), required_together=([['auth_realm', 'auth_username', 'auth_password']])) result = dict(changed=False, msg='', end_state={}, diff=dict(before={}, after={})) # Obtain access token, initialize API try: connection_header = get_token(module.params) except KeycloakError as e: module.fail_json(msg=str(e)) kc = KeycloakAPI(module, connection_header) # Convenience variables state = module.params.get('state') name = module.params.get('name') display_name = module.params.get('display_name') icon_uri = module.params.get('icon_uri') client_id = module.params.get('client_id') realm = module.params.get('realm') # Get the "id" of the client based on the usually more human-readable # "clientId" cid = kc.get_client_id(client_id, realm=realm) if not cid: module.fail_json(msg='Invalid client %s for realm %s' % (client_id, realm)) # Get current state of the Authorization Scope using its name as the search # filter. This returns False if it is not found. before_authz_scope = kc.get_authz_authorization_scope_by_name( name=name, client_id=cid, realm=realm) # Generate a JSON payload for Keycloak Admin API. This is needed for # "create" and "update" operations. desired_authz_scope = {} desired_authz_scope['name'] = name desired_authz_scope['displayName'] = display_name desired_authz_scope['iconUri'] = icon_uri # Add "id" to payload for modify operations if before_authz_scope: desired_authz_scope['id'] = before_authz_scope['id'] # Ensure that undefined (null) optional parameters are presented as empty # strings in the desired state. This makes comparisons with current state # much easier. for k, v in desired_authz_scope.items(): if not v: desired_authz_scope[k] = '' # Do the above for the current state if before_authz_scope: for k in ['displayName', 'iconUri']: if k not in before_authz_scope: before_authz_scope[k] = '' if before_authz_scope and state == 'present': changes = False for k, v in desired_authz_scope.items(): if before_authz_scope[k] != v: changes = True # At this point we know we have to update the object anyways, # so there's no need to do more work. break if changes: if module._diff: result['diff'] = dict(before=before_authz_scope, after=desired_authz_scope) if module.check_mode: result['changed'] = True result['msg'] = 'Authorization scope would be updated' module.exit_json(**result) else: kc.update_authz_authorization_scope( payload=desired_authz_scope, id=before_authz_scope['id'], client_id=cid, realm=realm) result['changed'] = True result['msg'] = 'Authorization scope updated' else: result['changed'] = False result['msg'] = 'Authorization scope not updated' result['end_state'] = desired_authz_scope elif not before_authz_scope and state == 'present': if module._diff: result['diff'] = dict(before={}, after=desired_authz_scope) if module.check_mode: result['changed'] = True result['msg'] = 'Authorization scope would be created' module.exit_json(**result) else: kc.create_authz_authorization_scope( payload=desired_authz_scope, client_id=cid, realm=realm) result['changed'] = True result['msg'] = 'Authorization scope created' result['end_state'] = desired_authz_scope elif before_authz_scope and state == 'absent': if module._diff: result['diff'] = dict(before=before_authz_scope, after={}) if module.check_mode: result['changed'] = True result['msg'] = 'Authorization scope would be removed' module.exit_json(**result) else: kc.remove_authz_authorization_scope( id=before_authz_scope['id'], client_id=cid, realm=realm) result['changed'] = True result['msg'] = 'Authorization scope removed' elif not before_authz_scope and state == 'absent': result['changed'] = False else: module.fail_json(msg='Unable to determine what to do with authorization scope %s of client %s in realm %s' % ( name, client_id, realm)) module.exit_json(**result) if __name__ == '__main__': main() PK $�!\!\P q q K collections/ansible_collections/community/general/plugins/modules/twilio.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2015, Matt Makai <matthew.makai@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: twilio short_description: Sends a text message to a mobile phone through Twilio description: - Sends a text message to a phone number through the Twilio messaging API. notes: - This module is non-idempotent because it sends an email through the external API. It is idempotent only in the case that the module fails. - Like the other notification modules, this one requires an external dependency to work. In this case, you'll need a Twilio account with a purchased or verified phone number to send the text message. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: account_sid: type: str description: - User's Twilio account token found on the account page. required: true auth_token: type: str description: - User's Twilio authentication token. required: true msg: type: str description: - The body of the text message. required: true to_numbers: type: list elements: str description: - One or more phone numbers to send the text message to, format C(+15551112222). required: true aliases: [ to_number ] from_number: type: str description: - The Twilio number to send the text message from, format C(+15551112222). required: true media_url: type: str description: - A URL with a picture, video or sound clip to send with an MMS (multimedia message) instead of a plain SMS. required: false author: "Matt Makai (@makaimc)" ''' EXAMPLES = ''' # send an SMS about the build status to (555) 303 5681 # note: replace account_sid and auth_token values with your credentials # and you have to have the 'from_number' on your Twilio account - name: Send a text message to a mobile phone through Twilio community.general.twilio: msg: All servers with webserver role are now configured. account_sid: ACXXXXXXXXXXXXXXXXX auth_token: ACXXXXXXXXXXXXXXXXX from_number: +15552014545 to_number: +15553035681 delegate_to: localhost # send an SMS to multiple phone numbers about the deployment # note: replace account_sid and auth_token values with your credentials # and you have to have the 'from_number' on your Twilio account - name: Send a text message to a mobile phone through Twilio community.general.twilio: msg: This server configuration is now complete. account_sid: ACXXXXXXXXXXXXXXXXX auth_token: ACXXXXXXXXXXXXXXXXX from_number: +15553258899 to_numbers: - +15551113232 - +12025551235 - +19735559010 delegate_to: localhost # send an MMS to a single recipient with an update on the deployment # and an image of the results # note: replace account_sid and auth_token values with your credentials # and you have to have the 'from_number' on your Twilio account - name: Send a text message to a mobile phone through Twilio community.general.twilio: msg: Deployment complete! account_sid: ACXXXXXXXXXXXXXXXXX auth_token: ACXXXXXXXXXXXXXXXXX from_number: +15552014545 to_number: +15553035681 media_url: https://demo.twilio.com/logo.png delegate_to: localhost ''' # ======================================= # twilio module support methods # from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six.moves.urllib.parse import urlencode from ansible.module_utils.urls import fetch_url def post_twilio_api(module, account_sid, auth_token, msg, from_number, to_number, media_url=None): URI = "https://api.twilio.com/2010-04-01/Accounts/%s/Messages.json" \ % (account_sid,) AGENT = "Ansible" data = {'From': from_number, 'To': to_number, 'Body': msg} if media_url: data['MediaUrl'] = media_url encoded_data = urlencode(data) headers = {'User-Agent': AGENT, 'Content-type': 'application/x-www-form-urlencoded', 'Accept': 'application/json', } # Hack module params to have the Basic auth params that fetch_url expects module.params['url_username'] = account_sid.replace('\n', '') module.params['url_password'] = auth_token.replace('\n', '') return fetch_url(module, URI, data=encoded_data, headers=headers) # ======================================= # Main # def main(): module = AnsibleModule( argument_spec=dict( account_sid=dict(required=True), auth_token=dict(required=True, no_log=True), msg=dict(required=True), from_number=dict(required=True), to_numbers=dict(required=True, aliases=['to_number'], type='list', elements='str'), media_url=dict(default=None, required=False), ), supports_check_mode=True ) account_sid = module.params['account_sid'] auth_token = module.params['auth_token'] msg = module.params['msg'] from_number = module.params['from_number'] to_numbers = module.params['to_numbers'] media_url = module.params['media_url'] for number in to_numbers: r, info = post_twilio_api(module, account_sid, auth_token, msg, from_number, number, media_url) if info['status'] not in [200, 201]: body_message = "unknown error" if 'body' in info: body = module.from_json(info['body']) body_message = body['message'] module.fail_json(msg="unable to send message to %s: %s" % (number, body_message)) module.exit_json(msg=msg, changed=False) if __name__ == '__main__': main() PK $�!\S�XSY SY P collections/ansible_collections/community/general/plugins/modules/gitlab_user.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2021, Lennert Mertens (lennert@nubera.be) # Copyright (c) 2019, Guillaume Martinez (lunik@tiwabbit.fr) # Copyright (c) 2015, Werner Dijkerman (ikben@werner-dijkerman.nl) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: gitlab_user short_description: Creates/updates/deletes/blocks/unblocks GitLab Users description: - When the user does not exist in GitLab, it will be created. - When the user exists and state=absent, the user will be deleted. - When the user exists and state=blocked, the user will be blocked. - When changes are made to user, the user will be updated. notes: - From community.general 0.2.0 and onwards, name, email and password are optional while deleting the user. author: - Werner Dijkerman (@dj-wasabi) - Guillaume Martinez (@Lunik) - Lennert Mertens (@LennertMertens) - Stef Graces (@stgrace) requirements: - python >= 2.7 - python-gitlab python module - administrator rights on the GitLab server extends_documentation_fragment: - community.general.auth_basic - community.general.gitlab - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the user you want to create. - Required only if O(state=present). type: str username: description: - The username of the user. required: true type: str password: description: - The password of the user. - GitLab server enforces minimum password length to 8, set this value with 8 or more characters. type: str reset_password: description: - Whether the user can change its password or not. default: false type: bool version_added: 3.3.0 email: description: - The email that belongs to the user. - Required only if O(state=present). type: str sshkey_name: description: - The name of the SSH public key. type: str sshkey_file: description: - The SSH public key itself. type: str sshkey_expires_at: description: - The expiration date of the SSH public key in ISO 8601 format C(YYYY-MM-DDTHH:MM:SSZ). - This is only used when adding new SSH public keys. type: str version_added: 3.1.0 group: description: - Id or Full path of parent group in the form of group/name. - Add user as a member to this group. type: str access_level: description: - The access level to the group. One of the following can be used. - guest - reporter - developer - master (alias for maintainer) - maintainer - owner default: guest type: str choices: ["guest", "reporter", "developer", "master", "maintainer", "owner"] state: description: - Create, delete or block a user. default: present type: str choices: ["present", "absent", "blocked", "unblocked"] confirm: description: - Require confirmation. type: bool default: true isadmin: description: - Grant admin privileges to the user. type: bool default: false external: description: - Define external parameter for this user. type: bool default: false identities: description: - List of identities to be added/updated for this user. - To remove all other identities from this user, set O(overwrite_identities=true). type: list elements: dict suboptions: provider: description: - The name of the external identity provider type: str extern_uid: description: - User ID for external identity. type: str version_added: 3.3.0 overwrite_identities: description: - Overwrite identities with identities added in this module. - This means that all identities that the user has and that are not listed in O(identities) are removed from the user. - This is only done if a list is provided for O(identities). To remove all identities, provide an empty list. type: bool default: false version_added: 3.3.0 ''' EXAMPLES = ''' - name: "Delete GitLab User" community.general.gitlab_user: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" validate_certs: false username: myusername state: absent - name: "Create GitLab User" community.general.gitlab_user: api_url: https://gitlab.example.com/ validate_certs: true api_username: dj-wasabi api_password: "MySecretPassword" name: My Name username: myusername password: mysecretpassword email: me@example.com sshkey_name: MySSH sshkey_file: ssh-rsa AAAAB3NzaC1yc... state: present group: super_group/mon_group access_level: owner - name: "Create GitLab User using external identity provider" community.general.gitlab_user: api_url: https://gitlab.example.com/ validate_certs: true api_token: "{{ access_token }}" name: My Name username: myusername password: mysecretpassword email: me@example.com identities: - provider: Keycloak extern_uid: f278f95c-12c7-4d51-996f-758cc2eb11bc state: present group: super_group/mon_group access_level: owner - name: "Block GitLab User" community.general.gitlab_user: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" validate_certs: false username: myusername state: blocked - name: "Unblock GitLab User" community.general.gitlab_user: api_url: https://gitlab.example.com/ api_token: "{{ access_token }}" validate_certs: false username: myusername state: unblocked ''' RETURN = ''' msg: description: Success or failure message returned: always type: str sample: "Success" result: description: json parsed response from the server returned: always type: dict error: description: the error message returned by the GitLab API returned: failed type: str sample: "400: path is already in use" user: description: API object returned: always type: dict ''' from ansible.module_utils.api import basic_auth_argument_spec from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.gitlab import ( auth_argument_spec, find_group, gitlab_authentication, gitlab, ensure_gitlab_package ) class GitLabUser(object): def __init__(self, module, gitlab_instance): self._module = module self._gitlab = gitlab_instance self.user_object = None self.ACCESS_LEVEL = { 'guest': gitlab.GUEST_ACCESS, 'reporter': gitlab.REPORTER_ACCESS, 'developer': gitlab.DEVELOPER_ACCESS, 'master': gitlab.MAINTAINER_ACCESS, 'maintainer': gitlab.MAINTAINER_ACCESS, 'owner': gitlab.OWNER_ACCESS, } ''' @param username Username of the user @param options User options ''' def create_or_update_user(self, username, options): changed = False potentionally_changed = False # Because we have already call userExists in main() if self.user_object is None: user = self.create_user({ 'name': options['name'], 'username': username, 'password': options['password'], 'reset_password': options['reset_password'], 'email': options['email'], 'skip_confirmation': not options['confirm'], 'admin': options['isadmin'], 'external': options['external'], 'identities': options['identities'], }) changed = True else: changed, user = self.update_user( self.user_object, { # add "normal" parameters here, put uncheckable # params in the dict below 'name': {'value': options['name']}, 'email': {'value': options['email']}, # note: for some attributes like this one the key # from reading back from server is unfortunately # different to the one needed for pushing/writing, # in that case use the optional setter key 'is_admin': { 'value': options['isadmin'], 'setter': 'admin' }, 'external': {'value': options['external']}, 'identities': {'value': options['identities']}, }, { # put "uncheckable" params here, this means params # which the gitlab does accept for setting but does # not return any information about it 'skip_reconfirmation': {'value': not options['confirm']}, 'password': {'value': options['password']}, 'reset_password': {'value': options['reset_password']}, 'overwrite_identities': {'value': options['overwrite_identities']}, } ) # note: as we unfortunately have some uncheckable parameters # where it is not possible to determine if the update # changed something or not, we must assume here that a # changed happened and that an user object update is needed potentionally_changed = True # Assign ssh keys if options['sshkey_name'] and options['sshkey_file']: key_changed = self.add_ssh_key_to_user(user, { 'name': options['sshkey_name'], 'file': options['sshkey_file'], 'expires_at': options['sshkey_expires_at']}) changed = changed or key_changed # Assign group if options['group_path']: group_changed = self.assign_user_to_group(user, options['group_path'], options['access_level']) changed = changed or group_changed self.user_object = user if (changed or potentionally_changed) and not self._module.check_mode: try: user.save() except Exception as e: self._module.fail_json(msg="Failed to update user: %s " % to_native(e)) if changed: if self._module.check_mode: self._module.exit_json(changed=True, msg="Successfully created or updated the user %s" % username) return True else: return False ''' @param group User object ''' def get_user_id(self, user): if user is not None: return user.id return None ''' @param user User object @param sshkey_name Name of the ssh key ''' def ssh_key_exists(self, user, sshkey_name): keyList = map(lambda k: k.title, user.keys.list(all=True)) return sshkey_name in keyList ''' @param user User object @param sshkey Dict containing sshkey infos {"name": "", "file": "", "expires_at": ""} ''' def add_ssh_key_to_user(self, user, sshkey): if not self.ssh_key_exists(user, sshkey['name']): if self._module.check_mode: return True try: parameter = { 'title': sshkey['name'], 'key': sshkey['file'], } if sshkey['expires_at'] is not None: parameter['expires_at'] = sshkey['expires_at'] user.keys.create(parameter) except gitlab.exceptions.GitlabCreateError as e: self._module.fail_json(msg="Failed to assign sshkey to user: %s" % to_native(e)) return True return False ''' @param group Group object @param user_id Id of the user to find ''' def find_member(self, group, user_id): try: member = group.members.get(user_id) except gitlab.exceptions.GitlabGetError: return None return member ''' @param group Group object @param user_id Id of the user to check ''' def member_exists(self, group, user_id): member = self.find_member(group, user_id) return member is not None ''' @param group Group object @param user_id Id of the user to check @param access_level GitLab access_level to check ''' def member_as_good_access_level(self, group, user_id, access_level): member = self.find_member(group, user_id) return member.access_level == access_level ''' @param user User object @param group_path Complete path of the Group including parent group path. <parent_path>/<group_path> @param access_level GitLab access_level to assign ''' def assign_user_to_group(self, user, group_identifier, access_level): group = find_group(self._gitlab, group_identifier) if self._module.check_mode: return True if group is None: return False if self.member_exists(group, self.get_user_id(user)): member = self.find_member(group, self.get_user_id(user)) if not self.member_as_good_access_level(group, member.id, self.ACCESS_LEVEL[access_level]): member.access_level = self.ACCESS_LEVEL[access_level] member.save() return True else: try: group.members.create({ 'user_id': self.get_user_id(user), 'access_level': self.ACCESS_LEVEL[access_level]}) except gitlab.exceptions.GitlabCreateError as e: self._module.fail_json(msg="Failed to assign user to group: %s" % to_native(e)) return True return False ''' @param user User object @param arguments User attributes ''' def update_user(self, user, arguments, uncheckable_args): changed = False for arg_key, arg_value in arguments.items(): av = arg_value['value'] if av is not None: if arg_key == "identities": changed = self.add_identities(user, av, uncheckable_args['overwrite_identities']['value']) elif getattr(user, arg_key) != av: setattr(user, arg_value.get('setter', arg_key), av) changed = True for arg_key, arg_value in uncheckable_args.items(): av = arg_value['value'] if av is not None: setattr(user, arg_value.get('setter', arg_key), av) return (changed, user) ''' @param arguments User attributes ''' def create_user(self, arguments): if self._module.check_mode: return True identities = None if 'identities' in arguments: identities = arguments['identities'] del arguments['identities'] try: user = self._gitlab.users.create(arguments) if identities: self.add_identities(user, identities) except (gitlab.exceptions.GitlabCreateError) as e: self._module.fail_json(msg="Failed to create user: %s " % to_native(e)) return user ''' @param user User object @param identites List of identities to be added/updated @param overwrite_identities Overwrite user identities with identities passed to this module ''' def add_identities(self, user, identities, overwrite_identities=False): changed = False if overwrite_identities: changed = self.delete_identities(user, identities) for identity in identities: if identity not in user.identities: setattr(user, 'provider', identity['provider']) setattr(user, 'extern_uid', identity['extern_uid']) if not self._module.check_mode: user.save() changed = True return changed ''' @param user User object @param identites List of identities to be added/updated ''' def delete_identities(self, user, identities): changed = False for identity in user.identities: if identity not in identities: if not self._module.check_mode: user.identityproviders.delete(identity['provider']) changed = True return changed ''' @param username Username of the user ''' def find_user(self, username): users = self._gitlab.users.list(search=username, all=True) for user in users: if (user.username == username): return user ''' @param username Username of the user ''' def exists_user(self, username): # When user exists, object will be stored in self.user_object. user = self.find_user(username) if user: self.user_object = user return True return False ''' @param username Username of the user ''' def is_active(self, username): user = self.find_user(username) return user.attributes['state'] == 'active' def delete_user(self): if self._module.check_mode: return True user = self.user_object return user.delete() def block_user(self): if self._module.check_mode: return True user = self.user_object return user.block() def unblock_user(self): if self._module.check_mode: return True user = self.user_object return user.unblock() def sanitize_arguments(arguments): for key, value in list(arguments.items()): if value is None: del arguments[key] return arguments def main(): argument_spec = basic_auth_argument_spec() argument_spec.update(auth_argument_spec()) argument_spec.update(dict( name=dict(type='str'), state=dict(type='str', default="present", choices=["absent", "present", "blocked", "unblocked"]), username=dict(type='str', required=True), password=dict(type='str', no_log=True), reset_password=dict(type='bool', default=False, no_log=False), email=dict(type='str'), sshkey_name=dict(type='str'), sshkey_file=dict(type='str', no_log=False), sshkey_expires_at=dict(type='str', no_log=False), group=dict(type='str'), access_level=dict(type='str', default="guest", choices=["developer", "guest", "maintainer", "master", "owner", "reporter"]), confirm=dict(type='bool', default=True), isadmin=dict(type='bool', default=False), external=dict(type='bool', default=False), identities=dict(type='list', elements='dict'), overwrite_identities=dict(type='bool', default=False), )) module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=[ ['api_username', 'api_token'], ['api_username', 'api_oauth_token'], ['api_username', 'api_job_token'], ['api_token', 'api_oauth_token'], ['api_token', 'api_job_token'], ], required_together=[ ['api_username', 'api_password'], ], required_one_of=[ ['api_username', 'api_token', 'api_oauth_token', 'api_job_token'] ], supports_check_mode=True, required_if=( ('state', 'present', ['name', 'email']), ) ) ensure_gitlab_package(module) user_name = module.params['name'] state = module.params['state'] user_username = module.params['username'].lower() user_password = module.params['password'] user_reset_password = module.params['reset_password'] user_email = module.params['email'] user_sshkey_name = module.params['sshkey_name'] user_sshkey_file = module.params['sshkey_file'] user_sshkey_expires_at = module.params['sshkey_expires_at'] group_path = module.params['group'] access_level = module.params['access_level'] confirm = module.params['confirm'] user_isadmin = module.params['isadmin'] user_external = module.params['external'] user_identities = module.params['identities'] overwrite_identities = module.params['overwrite_identities'] gitlab_instance = gitlab_authentication(module) gitlab_user = GitLabUser(module, gitlab_instance) user_exists = gitlab_user.exists_user(user_username) if user_exists: user_is_active = gitlab_user.is_active(user_username) else: user_is_active = False if state == 'absent': if user_exists: gitlab_user.delete_user() module.exit_json(changed=True, msg="Successfully deleted user %s" % user_username) else: module.exit_json(changed=False, msg="User deleted or does not exists") if state == 'blocked': if user_exists and user_is_active: gitlab_user.block_user() module.exit_json(changed=True, msg="Successfully blocked user %s" % user_username) else: module.exit_json(changed=False, msg="User already blocked or does not exists") if state == 'unblocked': if user_exists and not user_is_active: gitlab_user.unblock_user() module.exit_json(changed=True, msg="Successfully unblocked user %s" % user_username) else: module.exit_json(changed=False, msg="User is not blocked or does not exists") if state == 'present': if gitlab_user.create_or_update_user(user_username, { "name": user_name, "password": user_password, "reset_password": user_reset_password, "email": user_email, "sshkey_name": user_sshkey_name, "sshkey_file": user_sshkey_file, "sshkey_expires_at": user_sshkey_expires_at, "group_path": group_path, "access_level": access_level, "confirm": confirm, "isadmin": user_isadmin, "external": user_external, "identities": user_identities, "overwrite_identities": overwrite_identities, }): module.exit_json(changed=True, msg="Successfully created or updated the user %s" % user_username, user=gitlab_user.user_object._attrs) else: module.exit_json(changed=False, msg="No need to update the user %s" % user_username, user=gitlab_user.user_object._attrs) if __name__ == '__main__': main() PK $�!\IݑE�$ �$ H collections/ansible_collections/community/general/plugins/modules/svc.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2015, Brian Coca <bcoca@ansible.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: svc author: - Brian Coca (@bcoca) short_description: Manage daemontools services description: - Controls daemontools services on remote hosts using the svc utility. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the service to manage. type: str required: true state: description: - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the svc (svc -t) and V(killed) will always bounce the svc (svc -k). V(reloaded) will send a sigusr1 (svc -1). V(once) will run a normally downed svc once (svc -o), not really an idempotent operation. type: str choices: [ killed, once, reloaded, restarted, started, stopped ] downed: description: - Should a 'down' file exist or not, if it exists it disables auto startup. Defaults to no. Downed does not imply stopped. type: bool enabled: description: - Whether the service is enabled or not, if disabled it also implies stopped. Take note that a service can be enabled and downed (no auto restart). type: bool service_dir: description: - Directory svscan watches for services type: str default: /service service_src: description: - Directory where services are defined, the source of symlinks to service_dir. type: str default: /etc/service ''' EXAMPLES = ''' - name: Start svc dnscache, if not running community.general.svc: name: dnscache state: started - name: Stop svc dnscache, if running community.general.svc: name: dnscache state: stopped - name: Kill svc dnscache, in all cases community.general.svc: name: dnscache state: killed - name: Restart svc dnscache, in all cases community.general.svc: name: dnscache state: restarted - name: Reload svc dnscache, in all cases community.general.svc: name: dnscache state: reloaded - name: Using alternative svc directory location community.general.svc: name: dnscache state: reloaded service_dir: /var/service ''' import os import re import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native def _load_dist_subclass(cls, *args, **kwargs): ''' Used for derivative implementations ''' subclass = None distro = kwargs['module'].params['distro'] # get the most specific superclass for this platform if distro is not None: for sc in cls.__subclasses__(): if sc.distro is not None and sc.distro == distro: subclass = sc if subclass is None: subclass = cls return super(cls, subclass).__new__(subclass) class Svc(object): """ Main class that handles daemontools, can be subclassed and overridden in case we want to use a 'derivative' like encore, s6, etc """ # def __new__(cls, *args, **kwargs): # return _load_dist_subclass(cls, args, kwargs) def __init__(self, module): self.extra_paths = ['/command', '/usr/local/bin'] self.report_vars = ['state', 'enabled', 'downed', 'svc_full', 'src_full', 'pid', 'duration', 'full_state'] self.module = module self.name = module.params['name'] self.service_dir = module.params['service_dir'] self.service_src = module.params['service_src'] self.enabled = None self.downed = None self.full_state = None self.state = None self.pid = None self.duration = None self.svc_cmd = module.get_bin_path('svc', opt_dirs=self.extra_paths) self.svstat_cmd = module.get_bin_path('svstat', opt_dirs=self.extra_paths) self.svc_full = '/'.join([self.service_dir, self.name]) self.src_full = '/'.join([self.service_src, self.name]) self.enabled = os.path.lexists(self.svc_full) if self.enabled: self.downed = os.path.lexists('%s/down' % self.svc_full) self.get_status() else: self.downed = os.path.lexists('%s/down' % self.src_full) self.state = 'stopped' def enable(self): if os.path.exists(self.src_full): try: os.symlink(self.src_full, self.svc_full) except OSError as e: self.module.fail_json(path=self.src_full, msg='Error while linking: %s' % to_native(e)) else: self.module.fail_json(msg="Could not find source for service to enable (%s)." % self.src_full) def disable(self): try: os.unlink(self.svc_full) except OSError as e: self.module.fail_json(path=self.svc_full, msg='Error while unlinking: %s' % to_native(e)) self.execute_command([self.svc_cmd, '-dx', self.src_full]) src_log = '%s/log' % self.src_full if os.path.exists(src_log): self.execute_command([self.svc_cmd, '-dx', src_log]) def get_status(self): rc, out, err = self.execute_command([self.svstat_cmd, self.svc_full]) if err is not None and err: self.full_state = self.state = err else: self.full_state = out m = re.search(r'\(pid (\d+)\)', out) if m: self.pid = m.group(1) m = re.search(r'(\d+) seconds', out) if m: self.duration = m.group(1) if re.search(' up ', out): self.state = 'start' elif re.search(' down ', out): self.state = 'stopp' else: self.state = 'unknown' return if re.search(' want ', out): self.state += 'ing' else: self.state += 'ed' def start(self): return self.execute_command([self.svc_cmd, '-u', self.svc_full]) def stopp(self): return self.stop() def stop(self): return self.execute_command([self.svc_cmd, '-d', self.svc_full]) def once(self): return self.execute_command([self.svc_cmd, '-o', self.svc_full]) def reload(self): return self.execute_command([self.svc_cmd, '-1', self.svc_full]) def restart(self): return self.execute_command([self.svc_cmd, '-t', self.svc_full]) def kill(self): return self.execute_command([self.svc_cmd, '-k', self.svc_full]) def execute_command(self, cmd): try: rc, out, err = self.module.run_command(cmd) except Exception as e: self.module.fail_json(msg="failed to execute: %s" % to_native(e), exception=traceback.format_exc()) return (rc, out, err) def report(self): self.get_status() states = {} for k in self.report_vars: states[k] = self.__dict__[k] return states # =========================================== # Main control flow def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True), state=dict(type='str', choices=['killed', 'once', 'reloaded', 'restarted', 'started', 'stopped']), enabled=dict(type='bool'), downed=dict(type='bool'), service_dir=dict(type='str', default='/service'), service_src=dict(type='str', default='/etc/service'), ), supports_check_mode=True, ) module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C') state = module.params['state'] enabled = module.params['enabled'] downed = module.params['downed'] svc = Svc(module) changed = False orig_state = svc.report() if enabled is not None and enabled != svc.enabled: changed = True if not module.check_mode: try: if enabled: svc.enable() else: svc.disable() except (OSError, IOError) as e: module.fail_json(msg="Could not change service link: %s" % to_native(e)) if state is not None and state != svc.state: changed = True if not module.check_mode: getattr(svc, state[:-2])() if downed is not None and downed != svc.downed: changed = True if not module.check_mode: d_file = "%s/down" % svc.svc_full try: if downed: open(d_file, "a").close() else: os.unlink(d_file) except (OSError, IOError) as e: module.fail_json(msg="Could not change downed file: %s " % (to_native(e))) module.exit_json(changed=changed, svc=svc.report()) if __name__ == '__main__': main() PK $�!\%W,l} } M collections/ansible_collections/community/general/plugins/modules/read_csv.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Dag Wieers (@dagwieers) <dag@wieers.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: read_csv short_description: Read a CSV file description: - Read a CSV file and return a list or a dictionary, containing one dictionary per row. author: - Dag Wieers (@dagwieers) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: path: description: - The CSV filename to read data from. type: path required: true aliases: [ filename ] key: description: - The column name used as a key for the resulting dictionary. - If O(key) is unset, the module returns a list of dictionaries, where each dictionary is a row in the CSV file. type: str dialect: description: - The CSV dialect to use when parsing the CSV file. - Possible values include V(excel), V(excel-tab) or V(unix). type: str default: excel fieldnames: description: - A list of field names for every column. - This is needed if the CSV does not have a header. type: list elements: str unique: description: - Whether the O(key) used is expected to be unique. type: bool default: true delimiter: description: - A one-character string used to separate fields. - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: str skipinitialspace: description: - Whether to ignore any whitespaces immediately following the delimiter. - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool strict: description: - Whether to raise an exception on bad CSV input. - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool seealso: - plugin: ansible.builtin.csvfile plugin_type: lookup description: Can be used to do selective lookups in CSV files from Jinja. ''' EXAMPLES = r''' # Example CSV file with header # # name,uid,gid # dag,500,500 # jeroen,501,500 # Read a CSV file and access user 'dag' - name: Read users from CSV file and return a dictionary community.general.read_csv: path: users.csv key: name register: users delegate_to: localhost - ansible.builtin.debug: msg: 'User {{ users.dict.dag.name }} has UID {{ users.dict.dag.uid }} and GID {{ users.dict.dag.gid }}' # Read a CSV file and access the first item - name: Read users from CSV file and return a list community.general.read_csv: path: users.csv register: users delegate_to: localhost - ansible.builtin.debug: msg: 'User {{ users.list.1.name }} has UID {{ users.list.1.uid }} and GID {{ users.list.1.gid }}' # Example CSV file without header and semi-colon delimiter # # dag;500;500 # jeroen;501;500 # Read a CSV file without headers - name: Read users from CSV file and return a list community.general.read_csv: path: users.csv fieldnames: name,uid,gid delimiter: ';' register: users delegate_to: localhost ''' RETURN = r''' dict: description: The CSV content as a dictionary. returned: success type: dict sample: dag: name: dag uid: 500 gid: 500 jeroen: name: jeroen uid: 501 gid: 500 list: description: The CSV content as a list. returned: success type: list sample: - name: dag uid: 500 gid: 500 - name: jeroen uid: 501 gid: 500 ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.general.plugins.module_utils.csv import (initialize_dialect, read_csv, CSVError, DialectNotAvailableError, CustomDialectFailureError) def main(): module = AnsibleModule( argument_spec=dict( path=dict(type='path', required=True, aliases=['filename']), dialect=dict(type='str', default='excel'), key=dict(type='str', no_log=False), fieldnames=dict(type='list', elements='str'), unique=dict(type='bool', default=True), delimiter=dict(type='str'), skipinitialspace=dict(type='bool'), strict=dict(type='bool'), ), supports_check_mode=True, ) path = module.params['path'] dialect = module.params['dialect'] key = module.params['key'] fieldnames = module.params['fieldnames'] unique = module.params['unique'] dialect_params = { "delimiter": module.params['delimiter'], "skipinitialspace": module.params['skipinitialspace'], "strict": module.params['strict'], } try: dialect = initialize_dialect(dialect, **dialect_params) except (CustomDialectFailureError, DialectNotAvailableError) as e: module.fail_json(msg=to_native(e)) try: with open(path, 'rb') as f: data = f.read() except (IOError, OSError) as e: module.fail_json(msg="Unable to open file: %s" % to_native(e)) reader = read_csv(data, dialect, fieldnames) if key and key not in reader.fieldnames: module.fail_json(msg="Key '%s' was not found in the CSV header fields: %s" % (key, ', '.join(reader.fieldnames))) data_dict = dict() data_list = list() if key is None: try: for row in reader: data_list.append(row) except CSVError as e: module.fail_json(msg="Unable to process file: %s" % to_native(e)) else: try: for row in reader: if unique and row[key] in data_dict: module.fail_json(msg="Key '%s' is not unique for value '%s'" % (key, row[key])) data_dict[row[key]] = row except CSVError as e: module.fail_json(msg="Unable to process file: %s" % to_native(e)) module.exit_json(dict=data_dict, list=data_list) if __name__ == '__main__': main() PK $�!\j��N N P collections/ansible_collections/community/general/plugins/modules/cisco_webex.pynu �[��� # -*- coding: utf-8 -*- # Copyright Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: cisco_webex short_description: Send a message to a Cisco Webex Teams Room or Individual description: - Send a message to a Cisco Webex Teams Room or Individual with options to control the formatting. author: Drew Rusell (@drew-russell) notes: - The O(recipient_type) must be valid for the supplied O(recipient_id). - Full API documentation can be found at U(https://developer.webex.com/docs/api/basics). extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: recipient_type: description: - The request parameter you would like to send the message to. - Messages can be sent to either a room or individual (by ID or E-Mail). required: true choices: ['roomId', 'toPersonEmail', 'toPersonId'] type: str recipient_id: description: - The unique identifier associated with the supplied O(recipient_type). required: true type: str msg_type: description: - Specifies how you would like the message formatted. default: text choices: ['text', 'markdown'] type: str aliases: ['message_type'] personal_token: description: - Your personal access token required to validate the Webex Teams API. required: true aliases: ['token'] type: str msg: description: - The message you would like to send. required: true type: str ''' EXAMPLES = """ # Note: The following examples assume a variable file has been imported # that contains the appropriate information. - name: Cisco Webex Teams - Markdown Message to a Room community.general.cisco_webex: recipient_type: roomId recipient_id: "{{ room_id }}" msg_type: markdown personal_token: "{{ token }}" msg: "**Cisco Webex Teams Ansible Module - Room Message in Markdown**" - name: Cisco Webex Teams - Text Message to a Room community.general.cisco_webex: recipient_type: roomId recipient_id: "{{ room_id }}" msg_type: text personal_token: "{{ token }}" msg: "Cisco Webex Teams Ansible Module - Room Message in Text" - name: Cisco Webex Teams - Text Message by an Individuals ID community.general.cisco_webex: recipient_type: toPersonId recipient_id: "{{ person_id}}" msg_type: text personal_token: "{{ token }}" msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by ID" - name: Cisco Webex Teams - Text Message by an Individuals E-Mail Address community.general.cisco_webex: recipient_type: toPersonEmail recipient_id: "{{ person_email }}" msg_type: text personal_token: "{{ token }}" msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by E-Mail" """ RETURN = """ status_code: description: - The Response Code returned by the Webex Teams API. - Full Response Code explanations can be found at U(https://developer.webex.com/docs/api/basics). returned: always type: int sample: 200 message: description: - The Response Message returned by the Webex Teams API. - Full Response Code explanations can be found at U(https://developer.webex.com/docs/api/basics). returned: always type: str sample: OK (585 bytes) """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url def webex_msg(module): """When check mode is specified, establish a read only connection, that does not return any user specific data, to validate connectivity. In regular mode, send a message to a Cisco Webex Teams Room or Individual""" # Ansible Specific Variables results = {} ansible = module.params headers = { 'Authorization': 'Bearer {0}'.format(ansible['personal_token']), 'content-type': 'application/json' } if module.check_mode: url = "https://webexapis.com/v1/people/me" payload = None else: url = "https://webexapis.com/v1/messages" payload = { ansible['recipient_type']: ansible['recipient_id'], ansible['msg_type']: ansible['msg'] } payload = module.jsonify(payload) response, info = fetch_url(module, url, data=payload, headers=headers) status_code = info['status'] msg = info['msg'] # Module will fail if the response is not 200 if status_code != 200: results['failed'] = True results['status_code'] = status_code results['message'] = msg else: results['failed'] = False results['status_code'] = status_code if module.check_mode: results['message'] = 'Authentication Successful.' else: results['message'] = msg return results def main(): '''Ansible main. ''' module = AnsibleModule( argument_spec=dict( recipient_type=dict(required=True, choices=['roomId', 'toPersonEmail', 'toPersonId']), recipient_id=dict(required=True, no_log=True), msg_type=dict(required=False, default='text', aliases=['message_type'], choices=['text', 'markdown']), personal_token=dict(required=True, no_log=True, aliases=['token']), msg=dict(required=True), ), supports_check_mode=True ) results = webex_msg(module) module.exit_json(**results) if __name__ == "__main__": main() PK $�!\����P# P# Q collections/ansible_collections/community/general/plugins/modules/ipa_pwpolicy.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2020, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_pwpolicy author: Adralioh (@adralioh) short_description: Manage FreeIPA password policies description: - Add, modify, or delete a password policy using the IPA API. version_added: 2.0.0 attributes: check_mode: support: full diff_mode: support: none options: group: description: - Name of the group that the policy applies to. - If omitted, the global policy is used. aliases: ["name"] type: str state: description: State to ensure. default: "present" choices: ["absent", "present"] type: str maxpwdlife: description: Maximum password lifetime (in days). type: str minpwdlife: description: Minimum password lifetime (in hours). type: str historylength: description: - Number of previous passwords that are remembered. - Users cannot reuse remembered passwords. type: str minclasses: description: Minimum number of character classes. type: str minlength: description: Minimum password length. type: str priority: description: - Priority of the policy. - High number means lower priority. - Required when C(cn) is not the global policy. type: str maxfailcount: description: Maximum number of consecutive failures before lockout. type: str failinterval: description: Period (in seconds) after which the number of failed login attempts is reset. type: str lockouttime: description: Period (in seconds) for which users are locked out. type: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Modify the global password policy community.general.ipa_pwpolicy: maxpwdlife: '90' minpwdlife: '1' historylength: '8' minclasses: '3' minlength: '16' maxfailcount: '6' failinterval: '60' lockouttime: '600' ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure the password policy for the group admins is present community.general.ipa_pwpolicy: group: admins state: present maxpwdlife: '60' minpwdlife: '24' historylength: '16' minclasses: '4' priority: '10' maxfailcount: '4' failinterval: '600' lockouttime: '1200' ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure that the group sysops does not have a unique password policy community.general.ipa_pwpolicy: group: sysops state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' pwpolicy: description: Password policy as returned by IPA API. returned: always type: dict sample: cn: ['admins'] cospriority: ['10'] dn: 'cn=admins,cn=EXAMPLE.COM,cn=kerberos,dc=example,dc=com' krbmaxpwdlife: ['60'] krbminpwdlife: ['24'] krbpwdfailurecountinterval: ['600'] krbpwdhistorylength: ['16'] krbpwdlockoutduration: ['1200'] krbpwdmaxfailure: ['4'] krbpwdmindiffchars: ['4'] objectclass: ['top', 'nscontainer', 'krbpwdpolicy'] ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class PwPolicyIPAClient(IPAClient): '''The global policy will be selected when `name` is `None`''' def __init__(self, module, host, port, protocol): super(PwPolicyIPAClient, self).__init__(module, host, port, protocol) def pwpolicy_find(self, name): if name is None: # Manually set the cn to the global policy because pwpolicy_find will return a random # different policy if cn is `None` name = 'global_policy' return self._post_json(method='pwpolicy_find', name=None, item={'all': True, 'cn': name}) def pwpolicy_add(self, name, item): return self._post_json(method='pwpolicy_add', name=name, item=item) def pwpolicy_mod(self, name, item): return self._post_json(method='pwpolicy_mod', name=name, item=item) def pwpolicy_del(self, name): return self._post_json(method='pwpolicy_del', name=name) def get_pwpolicy_dict(maxpwdlife=None, minpwdlife=None, historylength=None, minclasses=None, minlength=None, priority=None, maxfailcount=None, failinterval=None, lockouttime=None): pwpolicy = {} if maxpwdlife is not None: pwpolicy['krbmaxpwdlife'] = maxpwdlife if minpwdlife is not None: pwpolicy['krbminpwdlife'] = minpwdlife if historylength is not None: pwpolicy['krbpwdhistorylength'] = historylength if minclasses is not None: pwpolicy['krbpwdmindiffchars'] = minclasses if minlength is not None: pwpolicy['krbpwdminlength'] = minlength if priority is not None: pwpolicy['cospriority'] = priority if maxfailcount is not None: pwpolicy['krbpwdmaxfailure'] = maxfailcount if failinterval is not None: pwpolicy['krbpwdfailurecountinterval'] = failinterval if lockouttime is not None: pwpolicy['krbpwdlockoutduration'] = lockouttime return pwpolicy def get_pwpolicy_diff(client, ipa_pwpolicy, module_pwpolicy): return client.get_diff(ipa_data=ipa_pwpolicy, module_data=module_pwpolicy) def ensure(module, client): state = module.params['state'] name = module.params['group'] module_pwpolicy = get_pwpolicy_dict(maxpwdlife=module.params.get('maxpwdlife'), minpwdlife=module.params.get('minpwdlife'), historylength=module.params.get('historylength'), minclasses=module.params.get('minclasses'), minlength=module.params.get('minlength'), priority=module.params.get('priority'), maxfailcount=module.params.get('maxfailcount'), failinterval=module.params.get('failinterval'), lockouttime=module.params.get('lockouttime')) ipa_pwpolicy = client.pwpolicy_find(name=name) changed = False if state == 'present': if not ipa_pwpolicy: changed = True if not module.check_mode: ipa_pwpolicy = client.pwpolicy_add(name=name, item=module_pwpolicy) else: diff = get_pwpolicy_diff(client, ipa_pwpolicy, module_pwpolicy) if len(diff) > 0: changed = True if not module.check_mode: ipa_pwpolicy = client.pwpolicy_mod(name=name, item=module_pwpolicy) else: if ipa_pwpolicy: changed = True if not module.check_mode: client.pwpolicy_del(name=name) return changed, ipa_pwpolicy def main(): argument_spec = ipa_argument_spec() argument_spec.update(group=dict(type='str', aliases=['name']), state=dict(type='str', default='present', choices=['present', 'absent']), maxpwdlife=dict(type='str'), minpwdlife=dict(type='str'), historylength=dict(type='str'), minclasses=dict(type='str'), minlength=dict(type='str'), priority=dict(type='str'), maxfailcount=dict(type='str'), failinterval=dict(type='str'), lockouttime=dict(type='str')) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = PwPolicyIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, pwpolicy = ensure(module, client) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) module.exit_json(changed=changed, pwpolicy=pwpolicy) if __name__ == '__main__': main() PK $�!\w�y��@ �@ L collections/ansible_collections/community/general/plugins/modules/portage.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2016, William L Thomson Jr # Copyright (c) 2013, Yap Sok Ann # Written by Yap Sok Ann <sokann@gmail.com> # Modified by William L. Thomson Jr. <wlt@o-sinc.com> # Based on apt module written by Matthew Williams <matthew@flowroute.com> # # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: portage short_description: Package manager for Gentoo description: - Manages Gentoo packages extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: package: description: - Package atom or set, for example V(sys-apps/foo) or V(>foo-2.13) or V(@world) aliases: [name] type: list elements: str state: description: - State of the package atom default: "present" choices: [ "present", "installed", "emerged", "absent", "removed", "unmerged", "latest" ] type: str update: description: - Update packages to the best version available (--update) type: bool default: false backtrack: description: - Set backtrack value (C(--backtrack)). type: int version_added: 5.8.0 deep: description: - Consider the entire dependency tree of packages (--deep) type: bool default: false newuse: description: - Include installed packages where USE flags have changed (--newuse) type: bool default: false changed_use: description: - Include installed packages where USE flags have changed, except when - flags that the user has not enabled are added or removed - (--changed-use) type: bool default: false oneshot: description: - Do not add the packages to the world file (--oneshot) type: bool default: false noreplace: description: - Do not re-emerge installed packages (--noreplace) type: bool default: true nodeps: description: - Only merge packages but not their dependencies (--nodeps) type: bool default: false onlydeps: description: - Only merge packages' dependencies but not the packages (--onlydeps) type: bool default: false depclean: description: - Remove packages not needed by explicitly merged packages (--depclean) - If no package is specified, clean up the world's dependencies - Otherwise, --depclean serves as a dependency aware version of --unmerge type: bool default: false quiet: description: - Run emerge in quiet mode (--quiet) type: bool default: false verbose: description: - Run emerge in verbose mode (--verbose) type: bool default: false sync: description: - Sync package repositories first - If V(yes), perform "emerge --sync" - If V(web), perform "emerge-webrsync" choices: [ "web", "yes", "no" ] type: str getbinpkgonly: description: - Merge only packages specified at C(PORTAGE_BINHOST) in C(make.conf). type: bool default: false version_added: 1.3.0 getbinpkg: description: - Prefer packages specified at C(PORTAGE_BINHOST) in C(make.conf). type: bool default: false usepkgonly: description: - Merge only binaries (no compiling). type: bool default: false usepkg: description: - Tries to use the binary package(s) in the locally available packages directory. type: bool default: false keepgoing: description: - Continue as much as possible after an error. type: bool default: false jobs: description: - Specifies the number of packages to build simultaneously. - "Since version 2.6: Value of 0 or False resets any previously added" - --jobs setting values type: int loadavg: description: - Specifies that no new builds should be started if there are - other builds running and the load average is at least LOAD - "Since version 2.6: Value of 0 or False resets any previously added" - --load-average setting values type: float withbdeps: description: - Specifies that build time dependencies should be installed. type: bool version_added: 5.8.0 quietbuild: description: - Redirect all build output to logs alone, and do not display it - on stdout (--quiet-build) type: bool default: false quietfail: description: - Suppresses display of the build log on stdout (--quiet-fail) - Only the die message and the path of the build log will be - displayed on stdout. type: bool default: false author: - "William L Thomson Jr (@wltjr)" - "Yap Sok Ann (@sayap)" - "Andrew Udvare (@Tatsh)" ''' EXAMPLES = ''' - name: Make sure package foo is installed community.general.portage: package: foo state: present - name: Make sure package foo is not installed community.general.portage: package: foo state: absent - name: Update package foo to the latest version (os specific alternative to latest) community.general.portage: package: foo update: true - name: Install package foo using PORTAGE_BINHOST setup community.general.portage: package: foo getbinpkg: true - name: Re-install world from binary packages only and do not allow any compiling community.general.portage: package: '@world' usepkgonly: true - name: Sync repositories and update world community.general.portage: package: '@world' update: true deep: true sync: true - name: Remove unneeded packages community.general.portage: depclean: true - name: Remove package foo if it is not explicitly needed community.general.portage: package: foo state: absent depclean: true ''' import os import re import sys import traceback from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.common.respawn import has_respawned, respawn_module from ansible.module_utils.common.text.converters import to_native try: from portage.dbapi import vartree from portage.exception import InvalidAtom HAS_PORTAGE = True PORTAGE_IMPORT_ERROR = None except ImportError: HAS_PORTAGE = False PORTAGE_IMPORT_ERROR = traceback.format_exc() def query_package(module, package, action): if package.startswith('@'): return query_set(module, package, action) return query_atom(module, package, action) def query_atom(module, atom, action): vdb = vartree.vardbapi() try: exists = vdb.match(atom) except InvalidAtom: return False return bool(exists) def query_set(module, set, action): system_sets = [ '@live-rebuild', '@module-rebuild', '@preserved-rebuild', '@security', '@selected', '@system', '@world', '@x11-module-rebuild', ] if set in system_sets: if action == 'unmerge': module.fail_json(msg='set %s cannot be removed' % set) return False world_sets_path = '/var/lib/portage/world_sets' if not os.path.exists(world_sets_path): return False cmd = 'grep %s %s' % (set, world_sets_path) rc, out, err = module.run_command(cmd) return rc == 0 def sync_repositories(module, webrsync=False): if module.check_mode: module.exit_json(msg='check mode not supported by sync') if webrsync: webrsync_path = module.get_bin_path('emerge-webrsync', required=True) cmd = '%s --quiet' % webrsync_path else: cmd = '%s --sync --quiet --ask=n' % module.emerge_path rc, out, err = module.run_command(cmd) if rc != 0: module.fail_json(msg='could not sync package repositories') # Note: In the 3 functions below, package querying is done one-by-one, # but emerge is done in one go. If that is not desirable, split the # packages into multiple tasks instead of joining them together with # comma. def emerge_packages(module, packages): """Run emerge command against given list of atoms.""" p = module.params if p['noreplace'] and not p['changed_use'] and not p['newuse'] and not (p['update'] or p['state'] == 'latest'): for package in packages: if p['noreplace'] and not p['changed_use'] and not p['newuse'] and not query_package(module, package, 'emerge'): break else: module.exit_json(changed=False, msg='Packages already present.') if module.check_mode: module.exit_json(changed=True, msg='Packages would be installed.') args = [] emerge_flags = { 'update': '--update', 'deep': '--deep', 'newuse': '--newuse', 'changed_use': '--changed-use', 'oneshot': '--oneshot', 'noreplace': '--noreplace', 'nodeps': '--nodeps', 'onlydeps': '--onlydeps', 'quiet': '--quiet', 'verbose': '--verbose', 'getbinpkgonly': '--getbinpkgonly', 'getbinpkg': '--getbinpkg', 'usepkgonly': '--usepkgonly', 'usepkg': '--usepkg', 'keepgoing': '--keep-going', 'quietbuild': '--quiet-build', 'quietfail': '--quiet-fail', } for flag, arg in emerge_flags.items(): if p[flag]: args.append(arg) if p['state'] and p['state'] == 'latest': args.append("--update") emerge_flags = { 'jobs': '--jobs', 'loadavg': '--load-average', 'backtrack': '--backtrack', 'withbdeps': '--with-bdeps', } for flag, arg in emerge_flags.items(): flag_val = p[flag] if flag_val is None: """Fallback to default: don't use this argument at all.""" continue """Add the --flag=value pair.""" if isinstance(flag_val, bool): args.extend((arg, to_native('y' if flag_val else 'n'))) elif not flag_val: """If the value is 0 or 0.0: add the flag, but not the value.""" args.append(arg) else: args.extend((arg, to_native(flag_val))) cmd, (rc, out, err) = run_emerge(module, packages, *args) if rc != 0: module.fail_json( cmd=cmd, rc=rc, stdout=out, stderr=err, msg='Packages not installed.', ) # Check for SSH error with PORTAGE_BINHOST, since rc is still 0 despite # this error if (p['usepkgonly'] or p['getbinpkg'] or p['getbinpkgonly']) \ and 'Permission denied (publickey).' in err: module.fail_json( cmd=cmd, rc=rc, stdout=out, stderr=err, msg='Please check your PORTAGE_BINHOST configuration in make.conf ' 'and your SSH authorized_keys file', ) changed = True for line in out.splitlines(): if re.match(r'(?:>+) Emerging (?:binary )?\(1 of', line): msg = 'Packages installed.' break elif module.check_mode and re.match(r'\[(binary|ebuild)', line): msg = 'Packages would be installed.' break else: changed = False msg = 'No packages installed.' module.exit_json( changed=changed, cmd=cmd, rc=rc, stdout=out, stderr=err, msg=msg, ) def unmerge_packages(module, packages): p = module.params for package in packages: if query_package(module, package, 'unmerge'): break else: module.exit_json(changed=False, msg='Packages already absent.') args = ['--unmerge'] for flag in ['quiet', 'verbose']: if p[flag]: args.append('--%s' % flag) cmd, (rc, out, err) = run_emerge(module, packages, *args) if rc != 0: module.fail_json( cmd=cmd, rc=rc, stdout=out, stderr=err, msg='Packages not removed.', ) module.exit_json( changed=True, cmd=cmd, rc=rc, stdout=out, stderr=err, msg='Packages removed.', ) def cleanup_packages(module, packages): p = module.params if packages: for package in packages: if query_package(module, package, 'unmerge'): break else: module.exit_json(changed=False, msg='Packages already absent.') args = ['--depclean'] for flag in ['quiet', 'verbose']: if p[flag]: args.append('--%s' % flag) cmd, (rc, out, err) = run_emerge(module, packages, *args) if rc != 0: module.fail_json(cmd=cmd, rc=rc, stdout=out, stderr=err) removed = 0 for line in out.splitlines(): if not line.startswith('Number removed:'): continue parts = line.split(':') removed = int(parts[1].strip()) changed = removed > 0 module.exit_json( changed=changed, cmd=cmd, rc=rc, stdout=out, stderr=err, msg='Depclean completed.', ) def run_emerge(module, packages, *args): args = list(args) args.append('--ask=n') if module.check_mode: args.append('--pretend') cmd = [module.emerge_path] + args + packages return cmd, module.run_command(cmd) portage_present_states = ['present', 'emerged', 'installed', 'latest'] portage_absent_states = ['absent', 'unmerged', 'removed'] def main(): module = AnsibleModule( argument_spec=dict( package=dict(type='list', elements='str', default=None, aliases=['name']), state=dict( default=portage_present_states[0], choices=portage_present_states + portage_absent_states, ), update=dict(default=False, type='bool'), backtrack=dict(default=None, type='int'), deep=dict(default=False, type='bool'), newuse=dict(default=False, type='bool'), changed_use=dict(default=False, type='bool'), oneshot=dict(default=False, type='bool'), noreplace=dict(default=True, type='bool'), nodeps=dict(default=False, type='bool'), onlydeps=dict(default=False, type='bool'), depclean=dict(default=False, type='bool'), quiet=dict(default=False, type='bool'), verbose=dict(default=False, type='bool'), sync=dict(default=None, choices=['yes', 'web', 'no']), getbinpkgonly=dict(default=False, type='bool'), getbinpkg=dict(default=False, type='bool'), usepkgonly=dict(default=False, type='bool'), usepkg=dict(default=False, type='bool'), keepgoing=dict(default=False, type='bool'), jobs=dict(default=None, type='int'), loadavg=dict(default=None, type='float'), withbdeps=dict(default=None, type='bool'), quietbuild=dict(default=False, type='bool'), quietfail=dict(default=False, type='bool'), ), required_one_of=[['package', 'sync', 'depclean']], mutually_exclusive=[ ['nodeps', 'onlydeps'], ['quiet', 'verbose'], ['quietbuild', 'verbose'], ['quietfail', 'verbose'], ], supports_check_mode=True, ) if not HAS_PORTAGE: if sys.executable != '/usr/bin/python' and not has_respawned(): respawn_module('/usr/bin/python') else: module.fail_json(msg=missing_required_lib('portage'), exception=PORTAGE_IMPORT_ERROR) module.emerge_path = module.get_bin_path('emerge', required=True) p = module.params if p['sync'] and p['sync'].strip() != 'no': sync_repositories(module, webrsync=(p['sync'] == 'web')) if not p['package']: module.exit_json(msg='Sync successfully finished.') packages = [] if p['package']: packages.extend(p['package']) if p['depclean']: if packages and p['state'] not in portage_absent_states: module.fail_json( msg='Depclean can only be used with package when the state is ' 'one of: %s' % portage_absent_states, ) cleanup_packages(module, packages) elif p['state'] in portage_present_states: emerge_packages(module, packages) elif p['state'] in portage_absent_states: unmerge_packages(module, packages) if __name__ == '__main__': main() PK $�!\݂y�� � N collections/ansible_collections/community/general/plugins/modules/nictagadm.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2018, Bruce Smith <Bruce.Smith.IT@gmail.com> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: nictagadm short_description: Manage nic tags on SmartOS systems description: - Create or delete nic tags on SmartOS systems. author: - Bruce Smith (@SmithX10) extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the nic tag. required: true type: str mac: description: - Specifies the O(mac) address to attach the nic tag to when not creating an O(etherstub). - Parameters O(mac) and O(etherstub) are mutually exclusive. type: str etherstub: description: - Specifies that the nic tag will be attached to a created O(etherstub). - Parameter O(etherstub) is mutually exclusive with both O(mtu), and O(mac). type: bool default: false mtu: description: - Specifies the size of the O(mtu) of the desired nic tag. - Parameters O(mtu) and O(etherstub) are mutually exclusive. type: int force: description: - When O(state=absent) this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs. type: bool default: false state: description: - Create or delete a SmartOS nic tag. type: str choices: [ absent, present ] default: present ''' EXAMPLES = r''' - name: Create 'storage0' on '00:1b:21:a3:f5:4d' community.general.nictagadm: name: storage0 mac: 00:1b:21:a3:f5:4d mtu: 9000 state: present - name: Remove 'storage0' nic tag community.general.nictagadm: name: storage0 state: absent ''' RETURN = r''' name: description: nic tag name returned: always type: str sample: storage0 mac: description: MAC Address that the nic tag was attached to. returned: always type: str sample: 00:1b:21:a3:f5:4d etherstub: description: specifies if the nic tag will create and attach to an etherstub. returned: always type: bool sample: false mtu: description: specifies which MTU size was passed during the nictagadm add command. mtu and etherstub are mutually exclusive. returned: always type: int sample: 1500 force: description: Shows if -f was used during the deletion of a nic tag returned: always type: bool sample: false state: description: state of the target returned: always type: str sample: present ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.network import is_mac class NicTag(object): def __init__(self, module): self.module = module self.name = module.params['name'] self.mac = module.params['mac'] self.etherstub = module.params['etherstub'] self.mtu = module.params['mtu'] self.force = module.params['force'] self.state = module.params['state'] self.nictagadm_bin = self.module.get_bin_path('nictagadm', True) def is_valid_mac(self): return is_mac(self.mac.lower()) def nictag_exists(self): cmd = [self.nictagadm_bin, 'exists', self.name] (rc, dummy, dummy) = self.module.run_command(cmd) return rc == 0 def add_nictag(self): cmd = [self.nictagadm_bin, '-v', 'add'] if self.etherstub: cmd.append('-l') if self.mtu: cmd.append('-p') cmd.append('mtu=' + str(self.mtu)) if self.mac: cmd.append('-p') cmd.append('mac=' + str(self.mac)) cmd.append(self.name) return self.module.run_command(cmd) def delete_nictag(self): cmd = [self.nictagadm_bin, '-v', 'delete'] if self.force: cmd.append('-f') cmd.append(self.name) return self.module.run_command(cmd) def main(): module = AnsibleModule( argument_spec=dict( name=dict(type='str', required=True), mac=dict(type='str'), etherstub=dict(type='bool', default=False), mtu=dict(type='int'), force=dict(type='bool', default=False), state=dict(type='str', default='present', choices=['absent', 'present']), ), mutually_exclusive=[ ['etherstub', 'mac'], ['etherstub', 'mtu'], ], required_if=[ ['etherstub', False, ['name', 'mac']], ['state', 'absent', ['name', 'force']], ], supports_check_mode=True ) nictag = NicTag(module) rc = None out = '' err = '' result = dict( changed=False, etherstub=nictag.etherstub, force=nictag.force, name=nictag.name, mac=nictag.mac, mtu=nictag.mtu, state=nictag.state, ) if not nictag.is_valid_mac(): module.fail_json(msg='Invalid MAC Address Value', name=nictag.name, mac=nictag.mac, etherstub=nictag.etherstub) if nictag.state == 'absent': if nictag.nictag_exists(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = nictag.delete_nictag() if rc != 0: module.fail_json(name=nictag.name, msg=err, rc=rc) elif nictag.state == 'present': if not nictag.nictag_exists(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = nictag.add_nictag() if rc is not None and rc != 0: module.fail_json(name=nictag.name, msg=err, rc=rc) if rc is not None: result['changed'] = True if out: result['stdout'] = out if err: result['stderr'] = err module.exit_json(**result) if __name__ == '__main__': main() PK $�!\aT�fR fR Q collections/ansible_collections/community/general/plugins/modules/redfish_info.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017-2018 Dell EMC Inc. # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: redfish_info short_description: Manages Out-Of-Band controllers using Redfish APIs description: - Builds Redfish URIs locally and sends them to remote OOB controllers to get information back. - Information retrieved is placed in a location specified by the user. - This module was called C(redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.redfish_info) module no longer returns C(ansible_facts)! extends_documentation_fragment: - community.general.attributes - community.general.attributes.info_module attributes: check_mode: version_added: 3.3.0 # This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix options: category: required: false description: - List of categories to execute on OOB controller. default: ['Systems'] type: list elements: str command: required: false description: - List of commands to execute on OOB controller. type: list elements: str baseuri: required: true description: - Base URI of OOB controller. type: str username: description: - Username for authenticating to OOB controller. type: str password: description: - Password for authenticating to OOB controller. type: str auth_token: description: - Security token for authenticating to OOB controller. type: str version_added: 2.3.0 timeout: description: - Timeout in seconds for HTTP requests to OOB controller. - The default value for this param is C(10) but that is being deprecated and it will be replaced with C(60) in community.general 9.0.0. type: int update_handle: required: false description: - Handle to check the status of an update in progress. type: str version_added: '6.1.0' author: "Jose Delarosa (@jose-delarosa)" ''' EXAMPLES = ''' - name: Get CPU inventory community.general.redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.cpu.entries | to_nice_json }}" - name: Get CPU model community.general.redfish_info: category: Systems command: GetCpuInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.cpu.entries.0.Model }}" - name: Get memory inventory community.general.redfish_info: category: Systems command: GetMemoryInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Get fan inventory with a timeout of 20 seconds community.general.redfish_info: category: Chassis command: GetFanInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" timeout: 20 register: result - name: Get Virtual Media information community.general.redfish_info: category: Manager command: GetVirtualMedia baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}" - name: Get Virtual Media information from Systems community.general.redfish_info: category: Systems command: GetVirtualMedia baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}" - name: Get Volume Inventory community.general.redfish_info: category: Systems command: GetVolumeInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.volume.entries | to_nice_json }}" - name: Get Session information community.general.redfish_info: category: Sessions command: GetSessions baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts.session.entries | to_nice_json }}" - name: Get default inventory information community.general.redfish_info: baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" register: result - name: Print fetched information ansible.builtin.debug: msg: "{{ result.redfish_facts | to_nice_json }}" - name: Get several inventories community.general.redfish_info: category: Systems command: GetNicInventory,GetBiosAttributes baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get default system inventory and user information community.general.redfish_info: category: Systems,Accounts baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get default system, user and firmware information community.general.redfish_info: category: ["Systems", "Accounts", "Update"] baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get Manager NIC inventory information community.general.redfish_info: category: Manager command: GetManagerNicInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get boot override information community.general.redfish_info: category: Systems command: GetBootOverride baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get chassis inventory community.general.redfish_info: category: Chassis command: GetChassisInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get all information available in the Manager category community.general.redfish_info: category: Manager command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get firmware update capability information community.general.redfish_info: category: Update command: GetFirmwareUpdateCapabilities baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get firmware inventory community.general.redfish_info: category: Update command: GetFirmwareInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get software inventory community.general.redfish_info: category: Update command: GetSoftwareInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get the status of an update operation community.general.redfish_info: category: Update command: GetUpdateStatus baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" update_handle: /redfish/v1/TaskService/TaskMonitors/735 - name: Get Manager Services community.general.redfish_info: category: Manager command: GetNetworkProtocols baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get all information available in all categories community.general.redfish_info: category: all command: all baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get system health report community.general.redfish_info: category: Systems command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get chassis health report community.general.redfish_info: category: Chassis command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get manager health report community.general.redfish_info: category: Manager command: GetHealthReport baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get manager Redfish Host Interface inventory community.general.redfish_info: category: Manager command: GetHostInterfaces baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get Manager Inventory community.general.redfish_info: category: Manager command: GetManagerInventory baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get HPE Thermal Config community.general.redfish_info: category: Chassis command: GetHPEThermalConfig baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get HPE Fan Percent Minimum community.general.redfish_info: category: Chassis command: GetHPEFanPercentMin baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" - name: Get BIOS registry community.general.redfish_info: category: Systems command: GetBiosRegistries baseuri: "{{ baseuri }}" username: "{{ username }}" password: "{{ password }}" ''' RETURN = ''' result: description: different results depending on task returned: always type: dict sample: List of CPUs on system ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.redfish_utils import RedfishUtils CATEGORY_COMMANDS_ALL = { "Systems": ["GetSystemInventory", "GetPsuInventory", "GetCpuInventory", "GetMemoryInventory", "GetNicInventory", "GetHealthReport", "GetStorageControllerInventory", "GetDiskInventory", "GetVolumeInventory", "GetBiosAttributes", "GetBootOrder", "GetBootOverride", "GetVirtualMedia", "GetBiosRegistries"], "Chassis": ["GetFanInventory", "GetPsuInventory", "GetChassisPower", "GetChassisThermals", "GetChassisInventory", "GetHealthReport", "GetHPEThermalConfig", "GetHPEFanPercentMin"], "Accounts": ["ListUsers"], "Sessions": ["GetSessions"], "Update": ["GetFirmwareInventory", "GetFirmwareUpdateCapabilities", "GetSoftwareInventory", "GetUpdateStatus"], "Manager": ["GetManagerNicInventory", "GetVirtualMedia", "GetLogs", "GetNetworkProtocols", "GetHealthReport", "GetHostInterfaces", "GetManagerInventory"], } CATEGORY_COMMANDS_DEFAULT = { "Systems": "GetSystemInventory", "Chassis": "GetFanInventory", "Accounts": "ListUsers", "Update": "GetFirmwareInventory", "Sessions": "GetSessions", "Manager": "GetManagerNicInventory" } def main(): result = {} category_list = [] module = AnsibleModule( argument_spec=dict( category=dict(type='list', elements='str', default=['Systems']), command=dict(type='list', elements='str'), baseuri=dict(required=True), username=dict(), password=dict(no_log=True), auth_token=dict(no_log=True), timeout=dict(type='int'), update_handle=dict(), ), required_together=[ ('username', 'password'), ], required_one_of=[ ('username', 'auth_token'), ], mutually_exclusive=[ ('username', 'auth_token'), ], supports_check_mode=True, ) if module.params['timeout'] is None: timeout = 10 module.deprecate( 'The default value {0} for parameter param1 is being deprecated and it will be replaced by {1}'.format( 10, 60 ), version='9.0.0', collection_name='community.general' ) # admin credentials used for authentication creds = {'user': module.params['username'], 'pswd': module.params['password'], 'token': module.params['auth_token']} # timeout timeout = module.params['timeout'] # update handle update_handle = module.params['update_handle'] # Build root URI root_uri = "https://" + module.params['baseuri'] rf_utils = RedfishUtils(creds, root_uri, timeout, module) # Build Category list if "all" in module.params['category']: for entry in CATEGORY_COMMANDS_ALL: category_list.append(entry) else: # one or more categories specified category_list = module.params['category'] for category in category_list: command_list = [] # Build Command list for each Category if category in CATEGORY_COMMANDS_ALL: if not module.params['command']: # True if we don't specify a command --> use default command_list.append(CATEGORY_COMMANDS_DEFAULT[category]) elif "all" in module.params['command']: for entry in range(len(CATEGORY_COMMANDS_ALL[category])): command_list.append(CATEGORY_COMMANDS_ALL[category][entry]) # one or more commands else: command_list = module.params['command'] # Verify that all commands are valid for cmd in command_list: # Fail if even one command given is invalid if cmd not in CATEGORY_COMMANDS_ALL[category]: module.fail_json(msg="Invalid Command: %s" % cmd) else: # Fail if even one category given is invalid module.fail_json(msg="Invalid Category: %s" % category) # Organize by Categories / Commands if category == "Systems": # execute only if we find a Systems resource resource = rf_utils._find_systems_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "GetSystemInventory": result["system"] = rf_utils.get_multi_system_inventory() elif command == "GetCpuInventory": result["cpu"] = rf_utils.get_multi_cpu_inventory() elif command == "GetMemoryInventory": result["memory"] = rf_utils.get_multi_memory_inventory() elif command == "GetNicInventory": result["nic"] = rf_utils.get_multi_nic_inventory(category) elif command == "GetStorageControllerInventory": result["storage_controller"] = rf_utils.get_multi_storage_controller_inventory() elif command == "GetDiskInventory": result["disk"] = rf_utils.get_multi_disk_inventory() elif command == "GetVolumeInventory": result["volume"] = rf_utils.get_multi_volume_inventory() elif command == "GetBiosAttributes": result["bios_attribute"] = rf_utils.get_multi_bios_attributes() elif command == "GetBootOrder": result["boot_order"] = rf_utils.get_multi_boot_order() elif command == "GetBootOverride": result["boot_override"] = rf_utils.get_multi_boot_override() elif command == "GetHealthReport": result["health_report"] = rf_utils.get_multi_system_health_report() elif command == "GetVirtualMedia": result["virtual_media"] = rf_utils.get_multi_virtualmedia(category) elif command == "GetBiosRegistries": result["bios_registries"] = rf_utils.get_bios_registries() elif category == "Chassis": # execute only if we find Chassis resource resource = rf_utils._find_chassis_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "GetFanInventory": result["fan"] = rf_utils.get_fan_inventory() elif command == "GetPsuInventory": result["psu"] = rf_utils.get_psu_inventory() elif command == "GetChassisThermals": result["thermals"] = rf_utils.get_chassis_thermals() elif command == "GetChassisPower": result["chassis_power"] = rf_utils.get_chassis_power() elif command == "GetChassisInventory": result["chassis"] = rf_utils.get_chassis_inventory() elif command == "GetHealthReport": result["health_report"] = rf_utils.get_multi_chassis_health_report() elif command == "GetHPEThermalConfig": result["hpe_thermal_config"] = rf_utils.get_hpe_thermal_config() elif command == "GetHPEFanPercentMin": result["hpe_fan_percent_min"] = rf_utils.get_hpe_fan_percent_min() elif category == "Accounts": # execute only if we find an Account service resource resource = rf_utils._find_accountservice_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "ListUsers": result["user"] = rf_utils.list_users() elif category == "Update": # execute only if we find UpdateService resources resource = rf_utils._find_updateservice_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "GetFirmwareInventory": result["firmware"] = rf_utils.get_firmware_inventory() elif command == "GetSoftwareInventory": result["software"] = rf_utils.get_software_inventory() elif command == "GetFirmwareUpdateCapabilities": result["firmware_update_capabilities"] = rf_utils.get_firmware_update_capabilities() elif command == "GetUpdateStatus": result["update_status"] = rf_utils.get_update_status(update_handle) elif category == "Sessions": # execute only if we find SessionService resources resource = rf_utils._find_sessionservice_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "GetSessions": result["session"] = rf_utils.get_sessions() elif category == "Manager": # execute only if we find a Manager service resource resource = rf_utils._find_managers_resource() if resource['ret'] is False: module.fail_json(msg=resource['msg']) for command in command_list: if command == "GetManagerNicInventory": result["manager_nics"] = rf_utils.get_multi_nic_inventory(category) elif command == "GetVirtualMedia": result["virtual_media"] = rf_utils.get_multi_virtualmedia(category) elif command == "GetLogs": result["log"] = rf_utils.get_logs() elif command == "GetNetworkProtocols": result["network_protocols"] = rf_utils.get_network_protocols() elif command == "GetHealthReport": result["health_report"] = rf_utils.get_multi_manager_health_report() elif command == "GetHostInterfaces": result["host_interfaces"] = rf_utils.get_hostinterfaces() elif command == "GetManagerInventory": result["manager"] = rf_utils.get_multi_manager_inventory() # Return data back module.exit_json(redfish_facts=result) if __name__ == '__main__': main() PK $�!\q�] ] J collections/ansible_collections/community/general/plugins/modules/jboss.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2013, Jeroen Hoekx <jeroen.hoekx@dsquare.be> # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' module: jboss short_description: Deploy applications to JBoss description: - Deploy applications to JBoss standalone using the filesystem. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: deployment: required: true description: - The name of the deployment. type: str src: description: - The remote path of the application ear or war to deploy. - Required when O(state=present). - Ignored when O(state=absent). type: path deploy_path: default: /var/lib/jbossas/standalone/deployments description: - The location in the filesystem where the deployment scanner listens. type: path state: choices: [ present, absent ] default: "present" description: - Whether the application should be deployed or undeployed. type: str notes: - The JBoss standalone deployment-scanner has to be enabled in standalone.xml - The module can wait until O(deployment) file is deployed/undeployed by deployment-scanner. Duration of waiting time depends on scan-interval parameter from standalone.xml. - Ensure no identically named application is deployed through the JBoss CLI seealso: - name: WildFly reference description: Complete reference of the WildFly documentation. link: https://docs.wildfly.org author: - Jeroen Hoekx (@jhoekx) ''' EXAMPLES = r""" - name: Deploy a hello world application to the default deploy_path community.general.jboss: src: /tmp/hello-1.0-SNAPSHOT.war deployment: hello.war state: present - name: Update the hello world application to the non-default deploy_path community.general.jboss: src: /tmp/hello-1.1-SNAPSHOT.war deploy_path: /opt/wildfly/deployment deployment: hello.war state: present - name: Undeploy the hello world application from the default deploy_path community.general.jboss: deployment: hello.war state: absent """ RETURN = r""" # """ import os import time from ansible.module_utils.basic import AnsibleModule DEFAULT_DEPLOY_PATH = '/var/lib/jbossas/standalone/deployments' def is_deployed(deploy_path, deployment): return os.path.exists(os.path.join(deploy_path, "%s.deployed" % deployment)) def is_undeployed(deploy_path, deployment): return os.path.exists(os.path.join(deploy_path, "%s.undeployed" % deployment)) def is_failed(deploy_path, deployment): return os.path.exists(os.path.join(deploy_path, "%s.failed" % deployment)) def main(): module = AnsibleModule( argument_spec=dict( src=dict(type='path'), deployment=dict(type='str', required=True), deploy_path=dict(type='path', default=DEFAULT_DEPLOY_PATH), state=dict(type='str', choices=['absent', 'present'], default='present'), ), required_if=[('state', 'present', ('src',))], supports_check_mode=True ) result = dict(changed=False) src = module.params['src'] deployment = module.params['deployment'] deploy_path = module.params['deploy_path'] state = module.params['state'] if not os.path.exists(deploy_path): module.fail_json(msg="deploy_path does not exist.") if state == 'absent' and src: module.warn('Parameter src is ignored when state=absent') elif state == 'present' and not os.path.exists(src): module.fail_json(msg='Source file %s does not exist.' % src) deployed = is_deployed(deploy_path, deployment) # === when check_mode === if module.check_mode: if state == 'present': if not deployed: result['changed'] = True elif deployed: if module.sha1(src) != module.sha1(os.path.join(deploy_path, deployment)): result['changed'] = True elif state == 'absent' and deployed: result['changed'] = True module.exit_json(**result) # ======================= if state == 'present' and not deployed: if is_failed(deploy_path, deployment): # Clean up old failed deployment os.remove(os.path.join(deploy_path, "%s.failed" % deployment)) module.preserved_copy(src, os.path.join(deploy_path, deployment)) while not deployed: deployed = is_deployed(deploy_path, deployment) if is_failed(deploy_path, deployment): module.fail_json(msg='Deploying %s failed.' % deployment) time.sleep(1) result['changed'] = True if state == 'present' and deployed: if module.sha1(src) != module.sha1(os.path.join(deploy_path, deployment)): os.remove(os.path.join(deploy_path, "%s.deployed" % deployment)) module.preserved_copy(src, os.path.join(deploy_path, deployment)) deployed = False while not deployed: deployed = is_deployed(deploy_path, deployment) if is_failed(deploy_path, deployment): module.fail_json(msg='Deploying %s failed.' % deployment) time.sleep(1) result['changed'] = True if state == 'absent' and deployed: os.remove(os.path.join(deploy_path, "%s.deployed" % deployment)) while deployed: deployed = not is_undeployed(deploy_path, deployment) if is_failed(deploy_path, deployment): module.fail_json(msg='Undeploying %s failed.' % deployment) time.sleep(1) result['changed'] = True module.exit_json(**result) if __name__ == '__main__': main() PK $�!\Y���� � N collections/ansible_collections/community/general/plugins/modules/kdeconfig.pynu �[��� # Copyright (c) 2023, Salvatore Mesoraca <s.mesoraca16@gmail.com> # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: kdeconfig short_description: Manage KDE configuration files version_added: "6.5.0" description: - Add or change individual settings in KDE configuration files. - It uses B(kwriteconfig) under the hood. options: path: description: - Path to the config file. If the file does not exist it will be created. type: path required: true kwriteconfig_path: description: - Path to the kwriteconfig executable. If not specified, Ansible will try to discover it. type: path values: description: - List of values to set. type: list elements: dict suboptions: group: description: - The option's group. One between this and O(values[].groups) is required. type: str groups: description: - List of the option's groups. One between this and O(values[].group) is required. type: list elements: str key: description: - The option's name. type: str required: true value: description: - The option's value. One between this and O(values[].bool_value) is required. type: str bool_value: description: - Boolean value. - One between this and O(values[].value) is required. type: bool required: true backup: description: - Create a backup file. type: bool default: false extends_documentation_fragment: - files - community.general.attributes attributes: check_mode: support: full diff_mode: support: full requirements: - kwriteconfig author: - Salvatore Mesoraca (@smeso) ''' EXAMPLES = r''' - name: Ensure "Homepage=https://www.ansible.com/" in group "Branding" community.general.kdeconfig: path: /etc/xdg/kickoffrc values: - group: Branding key: Homepage value: https://www.ansible.com/ mode: '0644' - name: Ensure "KEY=true" in groups "Group" and "Subgroup", and "KEY=VALUE" in Group2 community.general.kdeconfig: path: /etc/xdg/someconfigrc values: - groups: [Group, Subgroup] key: KEY bool_value: true - group: Group2 key: KEY value: VALUE backup: true ''' RETURN = r''' # ''' import os import shutil import tempfile import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_text class TemporaryDirectory(object): """Basic backport of tempfile.TemporaryDirectory""" def __init__(self, suffix="", prefix="tmp", dir=None): self.name = None self.name = tempfile.mkdtemp(suffix, prefix, dir) def __enter__(self): return self.name def rm(self): if self.name: shutil.rmtree(self.name, ignore_errors=True) self.name = None def __exit__(self, exc, value, tb): self.rm() def __del__(self): self.rm() def run_kwriteconfig(module, cmd, path, groups, key, value): """Invoke kwriteconfig with arguments""" args = [cmd, '--file', path, '--key', key] for group in groups: args.extend(['--group', group]) if isinstance(value, bool): args.extend(['--type', 'bool']) if value: args.append('true') else: args.append('false') else: args.append(value) module.run_command(args, check_rc=True) def run_module(module, tmpdir, kwriteconfig): result = dict(changed=False, msg='OK', path=module.params['path']) b_path = to_bytes(module.params['path']) tmpfile = os.path.join(tmpdir, 'file') b_tmpfile = to_bytes(tmpfile) diff = dict( before='', after='', before_header=result['path'], after_header=result['path'], ) try: with open(b_tmpfile, 'wb') as dst: try: with open(b_path, 'rb') as src: b_data = src.read() except IOError: result['changed'] = True else: dst.write(b_data) try: diff['before'] = to_text(b_data) except UnicodeError: diff['before'] = repr(b_data) except IOError: module.fail_json(msg='Unable to create temporary file', traceback=traceback.format_exc()) for row in module.params['values']: groups = row['groups'] if groups is None: groups = [row['group']] key = row['key'] value = row['bool_value'] if value is None: value = row['value'] run_kwriteconfig(module, kwriteconfig, tmpfile, groups, key, value) with open(b_tmpfile, 'rb') as tmpf: b_data = tmpf.read() try: diff['after'] = to_text(b_data) except UnicodeError: diff['after'] = repr(b_data) result['changed'] = result['changed'] or diff['after'] != diff['before'] file_args = module.load_file_common_arguments(module.params) if module.check_mode: if not result['changed']: shutil.copystat(b_path, b_tmpfile) uid, gid = module.user_and_group(b_path) os.chown(b_tmpfile, uid, gid) if module._diff: diff = {} else: diff = None result['changed'] = module.set_fs_attributes_if_different(file_args, result['changed'], diff=diff) if module._diff: result['diff'] = diff module.exit_json(**result) if result['changed']: if module.params['backup'] and os.path.exists(b_path): result['backup_file'] = module.backup_local(result['path']) try: module.atomic_move(b_tmpfile, b_path) except IOError: module.ansible.fail_json(msg='Unable to move temporary file %s to %s, IOError' % (tmpfile, result['path']), traceback=traceback.format_exc()) if result['changed']: module.set_fs_attributes_if_different(file_args, result['changed']) else: if module._diff: diff = {} else: diff = None result['changed'] = module.set_fs_attributes_if_different(file_args, result['changed'], diff=diff) if module._diff: result['diff'] = diff module.exit_json(**result) def main(): single_value_arg = dict(group=dict(type='str'), groups=dict(type='list', elements='str'), key=dict(type='str', required=True, no_log=False), value=dict(type='str'), bool_value=dict(type='bool')) required_alternatives = [('group', 'groups'), ('value', 'bool_value')] module_args = dict( values=dict(type='list', elements='dict', options=single_value_arg, mutually_exclusive=required_alternatives, required_one_of=required_alternatives, required=True), path=dict(type='path', required=True), kwriteconfig_path=dict(type='path'), backup=dict(type='bool', default=False), ) module = AnsibleModule( argument_spec=module_args, add_file_common_args=True, supports_check_mode=True, ) kwriteconfig = None if module.params['kwriteconfig_path'] is not None: kwriteconfig = module.get_bin_path(module.params['kwriteconfig_path'], required=True) else: for progname in ('kwriteconfig5', 'kwriteconfig', 'kwriteconfig4'): kwriteconfig = module.get_bin_path(progname) if kwriteconfig is not None: break if kwriteconfig is None: module.fail_json(msg='kwriteconfig is not installed') for v in module.params['values']: if not v['key']: module.fail_json(msg="'key' cannot be empty") with TemporaryDirectory(dir=module.tmpdir) as tmpdir: run_module(module, tmpdir, kwriteconfig) if __name__ == '__main__': main() PK $�!\EHk��8 �8 X collections/ansible_collections/community/general/plugins/modules/clc_server_snapshot.pynu �[��� # -*- coding: utf-8 -*- # # Copyright (c) 2015 CenturyLink # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' module: clc_server_snapshot short_description: Create, Delete and Restore server snapshots in CenturyLink Cloud description: - An Ansible module to Create, Delete and Restore server snapshots in CenturyLink Cloud. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: server_ids: description: - The list of CLC server Ids. type: list required: true elements: str expiration_days: description: - The number of days to keep the server snapshot before it expires. type: int default: 7 required: false state: description: - The state to insure that the provided resources are in. type: str default: 'present' required: false choices: ['present', 'absent', 'restore'] wait: description: - Whether to wait for the provisioning tasks to finish before returning. default: 'True' required: false type: str requirements: - python = 2.7 - requests >= 2.5.0 - clc-sdk author: "CLC Runner (@clc-runner)" notes: - To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud - CLC_V2_API_USERNAME, the account login id for the centurylink cloud - CLC_V2_API_PASSWORD, the account password for the centurylink cloud - Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account login and password via the HTTP api call @ https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, the API token generated from https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, the account alias associated with the centurylink cloud - Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment. ''' EXAMPLES = ''' # Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples - name: Create server snapshot community.general.clc_server_snapshot: server_ids: - UC1TEST-SVR01 - UC1TEST-SVR02 expiration_days: 10 wait: true state: present - name: Restore server snapshot community.general.clc_server_snapshot: server_ids: - UC1TEST-SVR01 - UC1TEST-SVR02 wait: true state: restore - name: Delete server snapshot community.general.clc_server_snapshot: server_ids: - UC1TEST-SVR01 - UC1TEST-SVR02 wait: true state: absent ''' RETURN = ''' server_ids: description: The list of server ids that are changed returned: success type: list sample: [ "UC1TEST-SVR01", "UC1TEST-SVR02" ] ''' __version__ = '${version}' import os import traceback from ansible_collections.community.general.plugins.module_utils.version import LooseVersion REQUESTS_IMP_ERR = None try: import requests except ImportError: REQUESTS_IMP_ERR = traceback.format_exc() REQUESTS_FOUND = False else: REQUESTS_FOUND = True # # Requires the clc-python-sdk. # sudo pip install clc-sdk # CLC_IMP_ERR = None try: import clc as clc_sdk from clc import CLCException except ImportError: CLC_IMP_ERR = traceback.format_exc() CLC_FOUND = False clc_sdk = None else: CLC_FOUND = True from ansible.module_utils.basic import AnsibleModule, missing_required_lib class ClcSnapshot: clc = clc_sdk module = None def __init__(self, module): """ Construct module """ self.module = module if not CLC_FOUND: self.module.fail_json(msg=missing_required_lib('clc-sdk'), exception=CLC_IMP_ERR) if not REQUESTS_FOUND: self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR) if requests.__version__ and LooseVersion(requests.__version__) < LooseVersion('2.5.0'): self.module.fail_json( msg='requests library version should be >= 2.5.0') self._set_user_agent(self.clc) def process_request(self): """ Process the request - Main Code Path :return: Returns with either an exit_json or fail_json """ p = self.module.params server_ids = p['server_ids'] expiration_days = p['expiration_days'] state = p['state'] request_list = [] changed = False changed_servers = [] self._set_clc_credentials_from_env() if state == 'present': changed, request_list, changed_servers = self.ensure_server_snapshot_present( server_ids=server_ids, expiration_days=expiration_days) elif state == 'absent': changed, request_list, changed_servers = self.ensure_server_snapshot_absent( server_ids=server_ids) elif state == 'restore': changed, request_list, changed_servers = self.ensure_server_snapshot_restore( server_ids=server_ids) self._wait_for_requests_to_complete(request_list) return self.module.exit_json( changed=changed, server_ids=changed_servers) def ensure_server_snapshot_present(self, server_ids, expiration_days): """ Ensures the given set of server_ids have the snapshots created :param server_ids: The list of server_ids to create the snapshot :param expiration_days: The number of days to keep the snapshot :return: (changed, request_list, changed_servers) changed: A flag indicating whether any change was made request_list: the list of clc request objects from CLC API call changed_servers: The list of servers ids that are modified """ request_list = [] changed = False servers = self._get_servers_from_clc( server_ids, 'Failed to obtain server list from the CLC API') servers_to_change = [ server for server in servers if len( server.GetSnapshots()) == 0] for server in servers_to_change: changed = True if not self.module.check_mode: request = self._create_server_snapshot(server, expiration_days) request_list.append(request) changed_servers = [ server.id for server in servers_to_change if server.id] return changed, request_list, changed_servers def _create_server_snapshot(self, server, expiration_days): """ Create the snapshot for the CLC server :param server: the CLC server object :param expiration_days: The number of days to keep the snapshot :return: the create request object from CLC API Call """ result = None try: result = server.CreateSnapshot( delete_existing=True, expiration_days=expiration_days) except CLCException as ex: self.module.fail_json(msg='Failed to create snapshot for server : {0}. {1}'.format( server.id, ex.response_text )) return result def ensure_server_snapshot_absent(self, server_ids): """ Ensures the given set of server_ids have the snapshots removed :param server_ids: The list of server_ids to delete the snapshot :return: (changed, request_list, changed_servers) changed: A flag indicating whether any change was made request_list: the list of clc request objects from CLC API call changed_servers: The list of servers ids that are modified """ request_list = [] changed = False servers = self._get_servers_from_clc( server_ids, 'Failed to obtain server list from the CLC API') servers_to_change = [ server for server in servers if len( server.GetSnapshots()) > 0] for server in servers_to_change: changed = True if not self.module.check_mode: request = self._delete_server_snapshot(server) request_list.append(request) changed_servers = [ server.id for server in servers_to_change if server.id] return changed, request_list, changed_servers def _delete_server_snapshot(self, server): """ Delete snapshot for the CLC server :param server: the CLC server object :return: the delete snapshot request object from CLC API """ result = None try: result = server.DeleteSnapshot() except CLCException as ex: self.module.fail_json(msg='Failed to delete snapshot for server : {0}. {1}'.format( server.id, ex.response_text )) return result def ensure_server_snapshot_restore(self, server_ids): """ Ensures the given set of server_ids have the snapshots restored :param server_ids: The list of server_ids to delete the snapshot :return: (changed, request_list, changed_servers) changed: A flag indicating whether any change was made request_list: the list of clc request objects from CLC API call changed_servers: The list of servers ids that are modified """ request_list = [] changed = False servers = self._get_servers_from_clc( server_ids, 'Failed to obtain server list from the CLC API') servers_to_change = [ server for server in servers if len( server.GetSnapshots()) > 0] for server in servers_to_change: changed = True if not self.module.check_mode: request = self._restore_server_snapshot(server) request_list.append(request) changed_servers = [ server.id for server in servers_to_change if server.id] return changed, request_list, changed_servers def _restore_server_snapshot(self, server): """ Restore snapshot for the CLC server :param server: the CLC server object :return: the restore snapshot request object from CLC API """ result = None try: result = server.RestoreSnapshot() except CLCException as ex: self.module.fail_json(msg='Failed to restore snapshot for server : {0}. {1}'.format( server.id, ex.response_text )) return result def _wait_for_requests_to_complete(self, requests_lst): """ Waits until the CLC requests are complete if the wait argument is True :param requests_lst: The list of CLC request objects :return: none """ if not self.module.params['wait']: return for request in requests_lst: request.WaitUntilComplete() for request_details in request.requests: if request_details.Status() != 'succeeded': self.module.fail_json( msg='Unable to process server snapshot request') @staticmethod def define_argument_spec(): """ This function defines the dictionary object required for package module :return: the package dictionary object """ argument_spec = dict( server_ids=dict(type='list', required=True, elements='str'), expiration_days=dict(default=7, type='int'), wait=dict(default=True), state=dict( default='present', choices=[ 'present', 'absent', 'restore']), ) return argument_spec def _get_servers_from_clc(self, server_list, message): """ Internal function to fetch list of CLC server objects from a list of server ids :param server_list: The list of server ids :param message: The error message to throw in case of any error :return the list of CLC server objects """ try: return self.clc.v2.Servers(server_list).servers except CLCException as ex: return self.module.fail_json(msg=message + ': %s' % ex) def _set_clc_credentials_from_env(self): """ Set the CLC Credentials on the sdk by reading environment variables :return: none """ env = os.environ v2_api_token = env.get('CLC_V2_API_TOKEN', False) v2_api_username = env.get('CLC_V2_API_USERNAME', False) v2_api_passwd = env.get('CLC_V2_API_PASSWD', False) clc_alias = env.get('CLC_ACCT_ALIAS', False) api_url = env.get('CLC_V2_API_URL', False) if api_url: self.clc.defaults.ENDPOINT_URL_V2 = api_url if v2_api_token and clc_alias: self.clc._LOGIN_TOKEN_V2 = v2_api_token self.clc._V2_ENABLED = True self.clc.ALIAS = clc_alias elif v2_api_username and v2_api_passwd: self.clc.v2.SetCredentials( api_username=v2_api_username, api_passwd=v2_api_passwd) else: return self.module.fail_json( msg="You must set the CLC_V2_API_USERNAME and CLC_V2_API_PASSWD " "environment variables") @staticmethod def _set_user_agent(clc): if hasattr(clc, 'SetRequestsSession'): agent_string = "ClcAnsibleModule/" + __version__ ses = requests.Session() ses.headers.update({"Api-Client": agent_string}) ses.headers['User-Agent'] += " " + agent_string clc.SetRequestsSession(ses) def main(): """ Main function :return: None """ module = AnsibleModule( argument_spec=ClcSnapshot.define_argument_spec(), supports_check_mode=True ) clc_snapshot = ClcSnapshot(module) clc_snapshot.process_request() if __name__ == '__main__': main() PK $�!\`#{$ $ R collections/ansible_collections/community/general/plugins/modules/sensu_handler.pynu �[��� # -*- coding: utf-8 -*- # Copyright (c) 2017, Red Hat Inc. # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: sensu_handler author: "David Moreau Simard (@dmsimard)" short_description: Manages Sensu handler configuration description: - Manages Sensu handler configuration - 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)' extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: state: type: str description: - Whether the handler should be present or not choices: [ 'present', 'absent' ] default: present name: type: str description: - A unique name for the handler. The name cannot contain special characters or spaces. required: true type: type: str description: - The handler type choices: [ 'pipe', 'tcp', 'udp', 'transport', 'set' ] filter: type: str description: - The Sensu event filter (name) to use when filtering events for the handler. filters: type: list elements: str description: - An array of Sensu event filters (names) to use when filtering events for the handler. - Each array item must be a string. severities: type: list elements: str description: - An array of check result severities the handler will handle. - 'NOTE: event resolution bypasses this filtering.' - "Example: [ 'warning', 'critical', 'unknown' ]." mutator: type: str description: - The Sensu event mutator (name) to use to mutate event data for the handler. timeout: type: int description: - The handler execution duration timeout in seconds (hard stop). - Only used by pipe and tcp handler types. default: 10 handle_silenced: description: - If events matching one or more silence entries should be handled. type: bool default: false handle_flapping: description: - If events in the flapping state should be handled. type: bool default: false command: type: str description: - The handler command to be executed. - The event data is passed to the process via STDIN. - 'NOTE: the command attribute is only required for Pipe handlers (i.e. handlers configured with "type": "pipe").' socket: type: dict description: - The socket definition scope, used to configure the TCP/UDP handler socket. - 'NOTE: the socket attribute is only required for TCP/UDP handlers (i.e. handlers configured with "type": "tcp" or "type": "udp").' pipe: type: dict description: - The pipe definition scope, used to configure the Sensu transport pipe. - 'NOTE: the pipe attribute is only required for Transport handlers (i.e. handlers configured with "type": "transport").' handlers: type: list elements: str description: - An array of Sensu event handlers (names) to use for events using the handler set. - 'NOTE: the handlers attribute is only required for handler sets (i.e. handlers configured with "type": "set").' notes: - Check mode is supported ''' EXAMPLES = ''' # Configure a handler that sends event data as STDIN (pipe) - name: Configure IRC Sensu handler community.general.sensu_handler: name: "irc_handler" type: "pipe" command: "/usr/local/bin/notify-irc.sh" severities: - "ok" - "critical" - "warning" - "unknown" timeout: 15 notify: - Restart sensu-client - Restart sensu-server # Delete a handler - name: Delete IRC Sensu handler community.general.sensu_handler: name: "irc_handler" state: "absent" # Example of a TCP handler - name: Configure TCP Sensu handler community.general.sensu_handler: name: "tcp_handler" type: "tcp" timeout: 30 socket: host: "10.0.1.99" port: 4444 register: handler notify: - Restart sensu-client - Restart sensu-server - name: Secure Sensu handler configuration file ansible.builtin.file: path: "{{ handler['file'] }}" owner: "sensu" group: "sensu" mode: "0600" ''' RETURN = ''' config: description: Effective handler configuration, when state is present returned: success type: dict sample: {'name': 'irc', 'type': 'pipe', 'command': '/usr/local/bin/notify-irc.sh'} file: description: Path to the handler configuration file returned: success type: str sample: "/etc/sensu/conf.d/handlers/irc.json" name: description: Name of the handler returned: success type: str sample: "irc" ''' import json import os from ansible.module_utils.basic import AnsibleModule def main(): module = AnsibleModule( supports_check_mode=True, argument_spec=dict( state=dict(type='str', choices=['present', 'absent'], default='present'), name=dict(type='str', required=True), type=dict(type='str', choices=['pipe', 'tcp', 'udp', 'transport', 'set']), filter=dict(type='str'), filters=dict(type='list', elements='str'), severities=dict(type='list', elements='str'), mutator=dict(type='str'), timeout=dict(type='int', default=10), handle_silenced=dict(type='bool', default=False), handle_flapping=dict(type='bool', default=False), command=dict(type='str'), socket=dict(type='dict'), pipe=dict(type='dict'), handlers=dict(type='list', elements='str'), ), required_if=[ ['state', 'present', ['type']], ['type', 'pipe', ['command']], ['type', 'tcp', ['socket']], ['type', 'udp', ['socket']], ['type', 'transport', ['pipe']], ['type', 'set', ['handlers']] ] ) state = module.params['state'] name = module.params['name'] path = '/etc/sensu/conf.d/handlers/{0}.json'.format(name) if state == 'absent': if os.path.exists(path): if module.check_mode: msg = '{path} would have been deleted'.format(path=path) module.exit_json(msg=msg, changed=True) else: try: os.remove(path) msg = '{path} deleted successfully'.format(path=path) module.exit_json(msg=msg, changed=True) except OSError as e: msg = 'Exception when trying to delete {path}: {exception}' module.fail_json( msg=msg.format(path=path, exception=str(e))) else: # Idempotency: it's okay if the file doesn't ex
| ver. 1.6 |
Github
|
.
| PHP 8.2.30 | ??????????? ?????????: 0.98 |
proxy
|
phpinfo
|
???????????