diff --git a/.ansible-lint b/.ansible-lint new file mode 100644 index 0000000..7f470fa --- /dev/null +++ b/.ansible-lint @@ -0,0 +1,10 @@ +--- +# 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 +# SPDX-FileCopyrightText: 2024, Ansible Project + +skip_list: + - meta-runtime[unsupported-version] # Tis rule doesn't make any sense + - fqcn[deep] # This rule produces false positives for files in tests/unit/plugins/action/fixtures/ +exclude_paths: + - changelogs/ diff --git a/.azure-pipelines/azure-pipelines.yml b/.azure-pipelines/azure-pipelines.yml index ad732a0..7c7ec26 100644 --- a/.azure-pipelines/azure-pipelines.yml +++ b/.azure-pipelines/azure-pipelines.yml @@ -37,7 +37,7 @@ variables: resources: containers: - container: default - image: quay.io/ansible/azure-pipelines-test-container:main + image: quay.io/ansible/azure-pipelines-test-container:6.0.0 pool: Standard @@ -57,6 +57,36 @@ stages: test: units - name: Lint test: lint + - stage: Sanity_2_18 + displayName: Ansible 2.18 sanity + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + nameFormat: "{0}" + testFormat: 2.18/{0} + targets: + - name: Sanity + test: sanity + - name: Units + test: units + - name: Lint + test: lint + - stage: Sanity_2_17 + displayName: Ansible 2.17 sanity + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + nameFormat: "{0}" + testFormat: 2.17/{0} + targets: + - name: Sanity + test: sanity + - name: Units + test: units + - name: Lint + test: lint - stage: Sanity_2_16 displayName: Ansible 2.16 sanity dependsOn: [] @@ -70,8 +100,6 @@ stages: test: sanity - name: Units test: units - - name: Lint - test: lint - stage: Sanity_2_15 displayName: Ansible 2.15 sanity dependsOn: [] @@ -85,19 +113,6 @@ stages: test: sanity - name: Units test: units - - stage: Sanity_2_14 - displayName: Ansible 2.14 sanity - dependsOn: [] - jobs: - - template: templates/matrix.yml - parameters: - nameFormat: "{0}" - testFormat: 2.14/{0} - targets: - - name: Sanity - test: sanity - - name: Units - test: units ## Docker - stage: Docker_devel displayName: Docker devel @@ -106,6 +121,34 @@ stages: - template: templates/matrix.yml parameters: testFormat: devel/linux/{0}/1 + targets: + - name: Fedora 40 + test: fedora40 + - name: Ubuntu 22.04 + test: ubuntu2204 + - name: Ubuntu 24.04 + test: ubuntu2404 + - stage: Docker_2_18 + displayName: Docker devel + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + testFormat: 2.18/linux/{0}/1 + targets: + - name: Fedora 40 + test: fedora40 + - name: Ubuntu 22.04 + test: ubuntu2204 + - name: Ubuntu 24.04 + test: ubuntu2404 + - stage: Docker_2_17 + displayName: Docker 2.17 + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + testFormat: 2.17/linux/{0}/1 targets: - name: Fedora 39 test: fedora39 @@ -148,24 +191,6 @@ stages: test: ubuntu2004 - name: Ubuntu 22.04 test: ubuntu2204 - - stage: Docker_2_14 - displayName: Docker 2.14 - dependsOn: [] - jobs: - - template: templates/matrix.yml - parameters: - testFormat: 2.14/linux/{0}/1 - targets: - - name: CentOS 7 - test: centos7 - - name: Fedora 36 - test: fedora36 - - name: openSUSE 15 py3 - test: opensuse15 - - name: Ubuntu 20.04 - test: ubuntu2004 - - name: Ubuntu 22.04 - test: ubuntu2204 ## Remote - stage: Remote_devel @@ -175,6 +200,30 @@ stages: - template: templates/matrix.yml parameters: testFormat: devel/{0}/1 + targets: + - name: RHEL 9.4 + test: rhel/9.4 + - name: FreeBSD 13.3 + test: freebsd/13.3 + - stage: Remote_2_18 + displayName: Remote devel + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + testFormat: 2.18/{0}/1 + targets: + - name: RHEL 9.4 + test: rhel/9.4 + - name: FreeBSD 13.3 + test: freebsd/13.3 + - stage: Remote_2_17 + displayName: Remote 2.17 + dependsOn: [] + jobs: + - template: templates/matrix.yml + parameters: + testFormat: 2.17/{0}/1 targets: - name: RHEL 9.3 test: rhel/9.3 @@ -211,37 +260,26 @@ stages: test: rhel/9.1 - name: FreeBSD 13.2 test: freebsd/13.2 - - stage: Remote_2_14 - displayName: Remote 2.14 - dependsOn: [] - jobs: - - template: templates/matrix.yml - parameters: - testFormat: 2.14/{0}/1 - targets: - - name: RHEL 7.9 - test: rhel/7.9 - - name: RHEL 8.6 - test: rhel/8.6 - - name: FreeBSD 13.2 - test: freebsd/13.2 ## Finally - stage: Summary condition: succeededOrFailed() dependsOn: - - Sanity_2_14 - - Remote_2_14 - - Docker_2_14 - Sanity_2_15 - Remote_2_15 - Docker_2_15 - Sanity_2_16 - Remote_2_16 - Docker_2_16 + - Sanity_2_17 + - Remote_2_17 + - Docker_2_17 + - Sanity_2_18 + - Remote_2_18 + - Docker_2_18 - Sanity_devel - - Remote_devel - - Docker_devel + # - Remote_devel # Wait for test environment release + # - Docker_devel # Wait for test environment release jobs: - template: templates/coverage.yml diff --git a/.github/BOTMETA.yml b/.github/BOTMETA.yml index 60ae92a..ba8b798 100644 --- a/.github/BOTMETA.yml +++ b/.github/BOTMETA.yml @@ -40,7 +40,6 @@ files: labels: debug $plugins/patch.py: labels: patch - $plugins/skippy.py: $plugins/synchronize.py: labels: synchronize $plugins/timer.py: diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ffb9afa..8a844cc 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,48 @@ ansible.posix Release Notes .. contents:: Topics +v1.6.0 +====== + +Release Summary +--------------- + +This is the minor release of the ``ansible.posix`` collection. +This changelog contains all changes to the modules and plugins +in this collection that have been added after the release of +``ansible.posix`` 1.5.4. + +Major Changes +------------- + +- Dropping support for Ansible 2.9, ansible-core 2.15 will be minimum required version for this release + +Minor Changes +------------- + +- Add summary_only parameter to profile_roles and profile_tasks callbacks. +- firewalld - add functionality to set forwarding (https://github.com/ansible-collections/ansible.posix/pull/548). +- firewalld - added offline flag implementation (https://github.com/ansible-collections/ansible.posix/pull/484) +- firewalld - respawn module to use the system python interpreter when the ``firewall`` python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). +- firewalld_info - Only warn about ignored zones, when there are zones ignored. +- firewalld_info - respawn module to use the system python interpreter when the ``firewall`` python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). +- mount - add no_log option for opts parameter (https://github.com/ansible-collections/ansible.posix/pull/563). +- seboolean - respawn module to use the system python interpreter when the ``selinux`` python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). +- selinux - respawn module to use the system python interpreter when the ``selinux`` python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). + +Removed Features (previously deprecated) +---------------------------------------- + +- skippy - Remove skippy pluglin as it is no longer supported(https://github.com/ansible-collections/ansible.posix/issues/350). + +Bugfixes +-------- + +- Bugfix in the documentation regarding the path option for authorised_key(https://github.com/ansible-collections/ansible.posix/issues/483). +- seboolean - make it work with disabled SELinux +- synchronize - maintain proper formatting of the remote paths (https://github.com/ansible-collections/ansible.posix/pull/361). +- sysctl - fix sysctl to work properly on symlinks (https://github.com/ansible-collections/ansible.posix/issues/111). + v1.5.4 ====== diff --git a/README.md b/README.md index 3683489..ddbbb1b 100644 --- a/README.md +++ b/README.md @@ -7,35 +7,26 @@ https://dev.azure.com/ansible/ansible.posix/_apis/build/status/CI?branchName=mai An Ansible Collection of modules and plugins that target POSIX UNIX/Linux and derivative Operating Systems. +## Communication + +* Join the Ansible forum: + * [Get Help](https://forum.ansible.com/c/help/6): get help or help others. + * [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts. + * [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. + +* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes. + +For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). + ## Supported Versions of Ansible ## Ansible version compatibility -This collection has been tested against following Ansible versions: **>=2.14**. +This collection has been tested against following Ansible versions: **>=2.15**. ## Included content - - -### Modules -Name | Description ---- | --- -[ansible.posix.acl](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.acl_module.rst)|Set and retrieve file ACL information. -[ansible.posix.at](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.at_module.rst)|Schedule the execution of a command or script file via the at command -[ansible.posix.authorized_key](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.authorized_key_module.rst)|Adds or removes an SSH authorized key -[ansible.posix.firewalld](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.firewalld_module.rst)|Manage arbitrary ports/services with firewalld -[ansible.posix.firewalld_info](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.firewalld_info_module.rst)|Gather information about firewalld -[ansible.posix.mount](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.mount_module.rst)|Control active and configured mount points -[ansible.posix.patch](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.patch_module.rst)|Apply patch files using the GNU patch tool -[ansible.posix.rhel_facts](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rhel_facts_module.rst)|Facts module to set or override RHEL specific facts. -[ansible.posix.rhel_rpm_ostree](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rhel_rpm_ostree_module.rst)|Ensure packages exist in a RHEL for Edge rpm-ostree based system -[ansible.posix.rpm_ostree_upgrade](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.rpm_ostree_upgrade_module.rst)|Manage rpm-ostree upgrade transactions -[ansible.posix.seboolean](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.seboolean_module.rst)|Toggles SELinux booleans -[ansible.posix.selinux](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.selinux_module.rst)|Change policy and state of SELinux -[ansible.posix.synchronize](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.synchronize_module.rst)|A wrapper around rsync to make common tasks in your playbooks quick and easy -[ansible.posix.sysctl](https://github.com/ansible-collections/ansible.posix/blob/main/docs/ansible.posix.sysctl_module.rst)|Manage entries in sysctl.conf. - - +Check out [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/ansible/posix/content/) or [the Ansible documentation](https://docs.ansible.com/ansible/devel/collections/ansible/posix/) for all modules and plugins included in this collection. ## Installing this collection @@ -83,10 +74,13 @@ None -- ansible-core 2.17 (devel) +- ansible-core 2.19 (devel) +- ansible-core 2.18 (stable) * +- ansible-core 2.17 (stable) - ansible-core 2.16 (stable) - ansible-core 2.15 (stable) -- ansible-core 2.14 (stable) + +*Note: For ansible-core 2.18, CI only covers sanity tests and no integration tests will be run until the test environment is released.* ## Roadmap diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 299f168..70ee8c8 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -347,3 +347,61 @@ releases: - 451_firewall_fix_protocol_parameter.yml - 456_sysctl_fix_nonetype.yml release_date: '2023-05-10' + 1.6.0: + changes: + bugfixes: + - Bugfix in the documentation regarding the path option for authorised_key(https://github.com/ansible-collections/ansible.posix/issues/483). + - seboolean - make it work with disabled SELinux + - synchronize - maintain proper formatting of the remote paths (https://github.com/ansible-collections/ansible.posix/pull/361). + - sysctl - fix sysctl to work properly on symlinks (https://github.com/ansible-collections/ansible.posix/issues/111). + major_changes: + - Dropping support for Ansible 2.9, ansible-core 2.15 will be minimum required + version for this release + minor_changes: + - Add summary_only parameter to profile_roles and profile_tasks callbacks. + - firewalld - add functionality to set forwarding (https://github.com/ansible-collections/ansible.posix/pull/548). + - firewalld - added offline flag implementation (https://github.com/ansible-collections/ansible.posix/pull/484) + - firewalld - respawn module to use the system python interpreter when the ``firewall`` + python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). + - firewalld_info - Only warn about ignored zones, when there are zones ignored. + - firewalld_info - respawn module to use the system python interpreter when + the ``firewall`` python module is not available for ``ansible_python_interpreter`` + (https://github.com/ansible-collections/ansible.posix/pull/460). + - mount - add no_log option for opts parameter (https://github.com/ansible-collections/ansible.posix/pull/563). + - seboolean - respawn module to use the system python interpreter when the ``selinux`` + python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). + - selinux - respawn module to use the system python interpreter when the ``selinux`` + python module is not available for ``ansible_python_interpreter`` (https://github.com/ansible-collections/ansible.posix/pull/460). + release_summary: 'This is the minor release of the ``ansible.posix`` collection. + + This changelog contains all changes to the modules and plugins + + in this collection that have been added after the release of + + ``ansible.posix`` 1.5.4.' + removed_features: + - skippy - Remove skippy pluglin as it is no longer supported(https://github.com/ansible-collections/ansible.posix/issues/350). + fragments: + - 1.6.0.yml + - 206_fix_sysctl_to_work_on_symlinks.yml + - 333_doc_absent_precision.yml + - 361_maintain_proper_formating_remote_paths.yml + - 421-remove-deprecation-warning.yml + - 460-respawn.yaml + - 466-tests.yml + - 477_ci_update.yml + - 484-firewalld-offline.yml + - 487_ci_update.yml + - 490_doc_authorized_key_path.yml + - 496_seboolean-make-it-wrk-with-SELinux-disabled.yaml + - 504-firewalld_info-warning.yaml + - 508_ci_update.yml + - 510_ci_update.yml + - 511_profile-callbacks-add-summary-only-parameter.yml + - 548_add_foward.yml + - 556_remove_skippy_callback.yml + - 562_update_core_version.yml + - 563_add_no_log_option.yml + - dropping-ansible29.yml + - test-reqs.yml + release_date: '2024-09-11' diff --git a/changelogs/fragments/206_fix_sysctl_to_work_on_symlinks.yml b/changelogs/fragments/206_fix_sysctl_to_work_on_symlinks.yml deleted file mode 100644 index 703a6a2..0000000 --- a/changelogs/fragments/206_fix_sysctl_to_work_on_symlinks.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: -- sysctl - fix sysctl to work properly on symlinks (https://github.com/ansible-collections/ansible.posix/issues/111). diff --git a/changelogs/fragments/333_doc_absent_precision.yml b/changelogs/fragments/333_doc_absent_precision.yml deleted file mode 100644 index 42ee162..0000000 --- a/changelogs/fragments/333_doc_absent_precision.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -trivial: -- mount - fix description in the documentation of the state ``absent`` to match its actual behavior - and point out that ``src`` is ignored with state ``absent`` and ``unmounted`` (https://github.com/ansible-collections/ansible.posix/issues/322) diff --git a/changelogs/fragments/365-boot-linux.yml b/changelogs/fragments/365-boot-linux.yml new file mode 100644 index 0000000..ec88776 --- /dev/null +++ b/changelogs/fragments/365-boot-linux.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - mount - Handle ``boot`` option on Linux, NetBSD and OpenBSD correctly (https://github.com/ansible-collections/ansible.posix/issues/364). diff --git a/changelogs/fragments/387_callback_output_header.yml b/changelogs/fragments/387_callback_output_header.yml new file mode 100644 index 0000000..5eb8573 --- /dev/null +++ b/changelogs/fragments/387_callback_output_header.yml @@ -0,0 +1,3 @@ +--- +minor_changes: + - callback plugins - Add recap information to timer, profile_roles and profile_tasks callback outputs (https://github.com/ansible-collections/ansible.posix/pull/387). diff --git a/changelogs/fragments/421-remove-deprecation-warning.yml b/changelogs/fragments/421-remove-deprecation-warning.yml deleted file mode 100644 index 5224f1e..0000000 --- a/changelogs/fragments/421-remove-deprecation-warning.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - synchronize - instantiate the connection plugin without the ``new_stdin`` argument, which is deprecated in ansible-core 2.15 (https://github.com/ansible-collections/ansible.posix/pull/421). diff --git a/changelogs/fragments/460-respawn.yaml b/changelogs/fragments/460-respawn.yaml deleted file mode 100644 index b88763b..0000000 --- a/changelogs/fragments/460-respawn.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- -minor_changes: - - "seboolean - respawn module to use the system python interpreter when the ``selinux`` python module is not available for ``ansible_python_interpreter`` - (https://github.com/ansible-collections/ansible.posix/pull/460)." - - "selinux - respawn module to use the system python interpreter when the ``selinux`` python module is not available for ``ansible_python_interpreter`` - (https://github.com/ansible-collections/ansible.posix/pull/460)." - - "firewalld - respawn module to use the system python interpreter when the ``firewall`` python module is not available for ``ansible_python_interpreter`` - (https://github.com/ansible-collections/ansible.posix/pull/460)." - - "firewalld_info - respawn module to use the system python interpreter when the ``firewall`` python module is not available for ``ansible_python_interpreter`` - (https://github.com/ansible-collections/ansible.posix/pull/460)." diff --git a/changelogs/fragments/466-tests.yml b/changelogs/fragments/466-tests.yml deleted file mode 100644 index 3c08961..0000000 --- a/changelogs/fragments/466-tests.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - "Fix integration tests so they work with ansible-core devel / 2.16 (https://github.com/ansible-collections/ansible.posix/pull/466)." diff --git a/changelogs/fragments/477_ci_update.yml b/changelogs/fragments/477_ci_update.yml deleted file mode 100644 index 9429030..0000000 --- a/changelogs/fragments/477_ci_update.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - "Drop Python3.9 and update versions of RHEL,Fedora and FreeBSD for ansible-core:devel test(https://github.com/ansible-collections/ansible.posix/issues/476)." diff --git a/changelogs/fragments/484-firewalld-offline.yml b/changelogs/fragments/484-firewalld-offline.yml deleted file mode 100644 index c17d4ea..0000000 --- a/changelogs/fragments/484-firewalld-offline.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - firewalld - added offline flag implementation (https://github.com/ansible-collections/ansible.posix/pull/484) diff --git a/changelogs/fragments/487_ci_update.yml b/changelogs/fragments/487_ci_update.yml deleted file mode 100644 index b68da22..0000000 --- a/changelogs/fragments/487_ci_update.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - "Drop FreeBSD12.4 from CI for ansible-core:devel(https://github.com/ansible-collections/ansible.posix/issues/486)." diff --git a/changelogs/fragments/490_doc_authorized_key_path.yml b/changelogs/fragments/490_doc_authorized_key_path.yml deleted file mode 100644 index ba5311f..0000000 --- a/changelogs/fragments/490_doc_authorized_key_path.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - "Bugfix in the documentation regarding the path option for authorised_key(https://github.com/ansible-collections/ansible.posix/issues/483)." diff --git a/changelogs/fragments/496_seboolean-make-it-wrk-with-SELinux-disabled.yaml b/changelogs/fragments/496_seboolean-make-it-wrk-with-SELinux-disabled.yaml deleted file mode 100644 index e14cfa6..0000000 --- a/changelogs/fragments/496_seboolean-make-it-wrk-with-SELinux-disabled.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - seboolean - make it work with disabled SELinux diff --git a/changelogs/fragments/504-firewalld_info-warning.yaml b/changelogs/fragments/504-firewalld_info-warning.yaml deleted file mode 100644 index 73e00aa..0000000 --- a/changelogs/fragments/504-firewalld_info-warning.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - firewalld_info - Only warn about ignored zones, when there are zones ignored. diff --git a/changelogs/fragments/508_ci_update.yml b/changelogs/fragments/508_ci_update.yml deleted file mode 100644 index a4af511..0000000 --- a/changelogs/fragments/508_ci_update.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - "Refactoring remote CI targets." diff --git a/changelogs/fragments/510_ci_update.yml b/changelogs/fragments/510_ci_update.yml deleted file mode 100644 index ada69ef..0000000 --- a/changelogs/fragments/510_ci_update.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - "Replace Fedora 38 with 39 for container test(https://github.com/ansible-collections/ansible.posix/issues/509)." diff --git a/changelogs/fragments/511_profile-callbacks-add-summary-only-parameter.yml b/changelogs/fragments/511_profile-callbacks-add-summary-only-parameter.yml deleted file mode 100644 index 2347dd3..0000000 --- a/changelogs/fragments/511_profile-callbacks-add-summary-only-parameter.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - "Add summary_only parameter to profile_roles and profile_tasks callbacks." diff --git a/changelogs/fragments/566_bump_version_161.yml b/changelogs/fragments/566_bump_version_161.yml new file mode 100644 index 0000000..18bb513 --- /dev/null +++ b/changelogs/fragments/566_bump_version_161.yml @@ -0,0 +1,3 @@ +--- +trivial: + - Bump version to 1.6.1 for next release. diff --git a/changelogs/fragments/567_remove_version_added.yml b/changelogs/fragments/567_remove_version_added.yml new file mode 100644 index 0000000..12d0040 --- /dev/null +++ b/changelogs/fragments/567_remove_version_added.yml @@ -0,0 +1,3 @@ +--- +trivial: + - mount - remove wrong version_added section from ``opts_no_log``. diff --git a/changelogs/fragments/568_update_authorized_key.yml b/changelogs/fragments/568_update_authorized_key.yml new file mode 100644 index 0000000..7efa29c --- /dev/null +++ b/changelogs/fragments/568_update_authorized_key.yml @@ -0,0 +1,3 @@ +--- +minor_changes: + - authorized_keys - allow using absolute path to a file as a SSH key(s) source (https://github.com/ansible-collections/ansible.posix/pull/568) diff --git a/changelogs/fragments/570_nfs4_acl.yml b/changelogs/fragments/570_nfs4_acl.yml new file mode 100644 index 0000000..a6a7f69 --- /dev/null +++ b/changelogs/fragments/570_nfs4_acl.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - acl - Fixed to set ACLs on paths mounted with NFS version 4 correctly (https://github.com/ansible-collections/ansible.posix/issues/240). diff --git a/changelogs/fragments/571_ci_bump_core_version.yml b/changelogs/fragments/571_ci_bump_core_version.yml new file mode 100644 index 0000000..bec2e29 --- /dev/null +++ b/changelogs/fragments/571_ci_bump_core_version.yml @@ -0,0 +1,3 @@ +--- +trivial: + - Bump ansible-core version to 2.19 of devel branch and add 2.18 to CI. diff --git a/changelogs/fragments/576_bump_version_2.yml b/changelogs/fragments/576_bump_version_2.yml new file mode 100644 index 0000000..a93dbf6 --- /dev/null +++ b/changelogs/fragments/576_bump_version_2.yml @@ -0,0 +1,3 @@ +--- +trivial: + - Bump ansible.posix version to 2.0.0. diff --git a/changelogs/fragments/dropping-ansible29.yml b/changelogs/fragments/dropping-ansible29.yml deleted file mode 100644 index 78cd428..0000000 --- a/changelogs/fragments/dropping-ansible29.yml +++ /dev/null @@ -1,2 +0,0 @@ -major_changes: - - "Dropping support for Ansible 2.9, ansible-core 2.14 will be minimum required version for this release" diff --git a/changelogs/fragments/test-reqs.yml b/changelogs/fragments/test-reqs.yml deleted file mode 100644 index 11598f7..0000000 --- a/changelogs/fragments/test-reqs.yml +++ /dev/null @@ -1,2 +0,0 @@ -trivial: - - "Move Galaxy test requirements from old transitional format in tests/requirements.yml to standard Ansible Galaxy requirements files in tests/integration/requirements.yml and tests/unit/requirements.yml." diff --git a/docs/ansible.posix.acl_module.rst b/docs/ansible.posix.acl_module.rst deleted file mode 100644 index 6a13d89..0000000 --- a/docs/ansible.posix.acl_module.rst +++ /dev/null @@ -1,346 +0,0 @@ -.. _ansible.posix.acl_module: - - -***************** -ansible.posix.acl -***************** - -**Set and retrieve file ACL information.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Set and retrieve file ACL information. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- default - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If the target is a directory, setting this to true will make it the default ACL for entities created inside the directory.
-
Setting default to true causes an error if the path is a file.
-
-
- entity - -
- string -
- 		- Default:
""
- 		-
The actual user or group that the ACL applies to when matching entity types user or group are selected.
-
-
- entry - -
- string -
- 		- -
DEPRECATED.
-
The ACL to set or remove.
-
This must always be quoted in the form of <etype>:<qualifier>:<perms>.
-
The qualifier may be empty for some types, but the type and perms are always required.
-
- can be used as placeholder when you do not care about permissions.
-
This is now superseded by entity, type and permissions fields.
-
-
- etype - -
- string -
- 		-
    Choices: -
  • group
    • -
  • mask
    • -
  • other
    • -
  • user
    • -
- 		-
The entity type of the ACL to apply, see setfacl documentation for more info.
-
-
- follow - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Whether to follow symlinks on the path if a symlink is encountered.
-
-
- path - -
- path - / required -
- 		- -
The full path of the file or object.
-

aliases: name
-
-
- permissions - -
- string -
- 		- -
The permissions to apply/remove can be any combination of r, w, x
-
(read, write and execute respectively), and X (execute permission if the file is a directory or already has execute permission for some user)
-
-
- recalculate_mask - -
- string -
- 		-
    Choices: -
  • default ←
    • -
  • mask
    • -
  • no_mask
    • -
- 		-
Select if and when to recalculate the effective right masks of the files.
-
See setfacl documentation for more info.
-
Incompatible with state=query.
-
-
- recursive - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Recursively sets the specified ACL.
-
Incompatible with state=query.
-
Alias recurse added in version 1.3.0.
-

aliases: recurse
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present
    • -
  • query ←
    • -
- 		-
Define whether the ACL should be present or not.
-
The query state gets the current ACL without changing it, for use in register operations.
-
-
- use_nfsv4_acls - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use NFSv4 ACLs instead of POSIX ACLs.
-
-
- - -Notes ------ - -.. note:: - - The ``acl`` module requires that ACLs are enabled on the target filesystem and that the ``setfacl`` and ``getfacl`` binaries are installed. - - As of Ansible 2.0, this module only supports Linux distributions. - - As of Ansible 2.3, the *name* option has been changed to *path* as default, but *name* still works as well. - - - -Examples --------- - -.. code-block:: yaml - - - name: Grant user Joe read access to a file - ansible.posix.acl: - path: /etc/foo.conf - entity: joe - etype: user - permissions: r - state: present - - - name: Removes the ACL for Joe on a specific file - ansible.posix.acl: - path: /etc/foo.conf - entity: joe - etype: user - state: absent - - - name: Sets default ACL for joe on /etc/foo.d/ - ansible.posix.acl: - path: /etc/foo.d/ - entity: joe - etype: user - permissions: rw - default: true - state: present - - - name: Same as previous but using entry shorthand - ansible.posix.acl: - path: /etc/foo.d/ - entry: default:user:joe:rw- - state: present - - - name: Obtain the ACL for a specific file - ansible.posix.acl: - path: /etc/foo.conf - register: acl_info - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- acl - -
- list -
- 		success -
Current ACL on provided path (after changes, if any)
-
-
Sample:
-
['user::rwx', 'group::rwx', 'other::rwx']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Brian Coca (@bcoca) -- Jérémie Astori (@astorije) diff --git a/docs/ansible.posix.at_module.rst b/docs/ansible.posix.at_module.rst deleted file mode 100644 index 3d731a2..0000000 --- a/docs/ansible.posix.at_module.rst +++ /dev/null @@ -1,186 +0,0 @@ -.. _ansible.posix.at_module: - - -**************** -ansible.posix.at -**************** - -**Schedule the execution of a command or script file via the at command** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Use this module to schedule a command or script file to run once in the future. -- All jobs are executed in the 'a' queue. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- at - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- command - -
- string -
- 		- -
A command to be executed in the future.
-
-
- count - -
- integer -
- 		- -
The count of units in the future to execute the command or script file.
-
-
- script_file - -
- string -
- 		- -
An existing script file to be executed in the future.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).
-
-
- unique - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If a matching job is present a new job will not be added.
-
-
- units - -
- string -
- 		-
    Choices: -
  • minutes
    • -
  • hours
    • -
  • days
    • -
  • weeks
    • -
- 		-
The type of units in the future to execute the command or script file.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Schedule a command to execute in 20 minutes as root - ansible.posix.at: - command: ls -d / >/dev/null - count: 20 - units: minutes - - - name: Match a command to an existing job and delete the job - ansible.posix.at: - command: ls -d / >/dev/null - state: absent - - - name: Schedule a command to execute in 20 minutes making sure it is unique in the queue - ansible.posix.at: - command: ls -d / >/dev/null - count: 20 - units: minutes - unique: true - - - - -Status ------- - - -Authors -~~~~~~~ - -- Richard Isaacson (@risaacson) diff --git a/docs/ansible.posix.authorized_key_module.rst b/docs/ansible.posix.authorized_key_module.rst deleted file mode 100644 index 53efe25..0000000 --- a/docs/ansible.posix.authorized_key_module.rst +++ /dev/null @@ -1,480 +0,0 @@ -.. _ansible.posix.authorized_key_module: - - -**************************** -ansible.posix.authorized_key -**************************** - -**Adds or removes an SSH authorized key** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Adds or removes SSH authorized keys for particular user accounts. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- comment - -
- string -
- 		- -
Change the comment on the public key.
-
Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.
-
If no comment is specified, the existing comment will be kept.
-
-
- exclusive - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether to remove all other non-specified keys from the authorized_keys file.
-
Multiple keys can be specified in a single key string value by separating them by newlines.
-
This option is not loop aware, so if you use with_ , it will be exclusive per iteration of the loop.
-
If you want multiple keys in the file you need to pass them all to key in a single batch as mentioned above.
-
-
- follow - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Follow path symlink instead of replacing it.
-
-
- key - -
- string - / required -
- 		- -
The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys).
-
-
- key_options - -
- string -
- 		- -
A string of ssh key options to be prepended to the key in the authorized_keys file.
-
-
- manage_dir - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Whether this module should manage the directory of the authorized key file.
-
If set to true, the module will create the directory, as well as set the owner and permissions of an existing directory.
-
Be sure to set manage_dir=false if you are using an alternate directory for authorized_keys, as set with path, since you could lock yourself out of SSH access.
-
See the example below.
-
-
- path - -
- path -
- 		- -
Alternate path to the authorized_keys file.
-
When unset, this value defaults to ~/.ssh/authorized_keys.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Whether the given key (with the given key_options) should or should not be in the file.
-
-
- user - -
- string - / required -
- 		- -
The username on the remote host whose authorized_keys file will be modified.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
This only applies if using a https url as the source of the keys.
-
If set to false, the SSL certificates will not be validated.
-
This should only set to false used on personally controlled sites using self-signed certificates as it avoids verifying the source site.
-
Prior to 2.1 the code worked as if this was set to true.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Set authorized key taken from file - ansible.posix.authorized_key: - user: charlie - state: present - key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" - - - name: Set authorized keys taken from url - ansible.posix.authorized_key: - user: charlie - state: present - key: https://github.com/charlie.keys - - - name: Set authorized keys taken from url using lookup - ansible.posix.authorized_key: - user: charlie - state: present - key: "{{ lookup('url', 'https://github.com/charlie.keys', split_lines=False) }}" - - - name: Set authorized key in alternate location - ansible.posix.authorized_key: - user: charlie - state: present - key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" - path: /etc/ssh/authorized_keys/charlie - manage_dir: false - - - name: Set up multiple authorized keys - ansible.posix.authorized_key: - user: deploy - state: present - key: '{{ item }}' - with_file: - - public_keys/doe-jane - - public_keys/doe-john - - - name: Set authorized key defining key options - ansible.posix.authorized_key: - user: charlie - state: present - key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" - key_options: 'no-port-forwarding,from="10.0.1.1"' - - - name: Set authorized key without validating the TLS/SSL certificates - ansible.posix.authorized_key: - user: charlie - state: present - key: https://github.com/user.keys - validate_certs: false - - - name: Set authorized key, removing all the authorized keys already set - ansible.posix.authorized_key: - user: root - key: "{{ lookup('file', 'public_keys/doe-jane') }}" - state: present - exclusive: true - - - name: Set authorized key for user ubuntu copying it from current user - ansible.posix.authorized_key: - user: ubuntu - state: present - key: "{{ lookup('file', lookup('env','HOME') + '/.ssh/id_rsa.pub') }}" - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- exclusive - -
- boolean -
- 		success -
If the key has been forced to be exclusive or not.
-
-
-
- key - -
- string -
- 		success -
The key that the module was running against.
-
-
Sample:
-
https://github.com/user.keys
-
-
- key_option - -
- string -
- 		success -
Key options related to the key.
-
-
-
- keyfile - -
- string -
- 		success -
Path for authorized key file.
-
-
Sample:
-
/home/user/.ssh/authorized_keys
-
-
- manage_dir - -
- boolean -
- 		success -
Whether this module managed the directory of the authorized key file.
-
-
Sample:
-
True
-
-
- path - -
- string -
- 		success -
Alternate path to the authorized_keys file
-
-
-
- state - -
- string -
- 		success -
Whether the given key (with the given key_options) should or should not be in the file
-
-
Sample:
-
present
-
-
- unique - -
- boolean -
- 		success -
Whether the key is unique
-
-
-
- user - -
- string -
- 		success -
The username on the remote host whose authorized_keys file will be modified
-
-
Sample:
-
user
-
-
- validate_certs - -
- boolean -
- 		success -
This only applies if using a https url as the source of the keys. If set to false, the SSL certificates will not be validated.
-
-
Sample:
-
True
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Core Team diff --git a/docs/ansible.posix.firewalld_info_module.rst b/docs/ansible.posix.firewalld_info_module.rst deleted file mode 100644 index 911acce..0000000 --- a/docs/ansible.posix.firewalld_info_module.rst +++ /dev/null @@ -1,526 +0,0 @@ -.. _ansible.posix.firewalld_info_module: - - -**************************** -ansible.posix.firewalld_info -**************************** - -**Gather information about firewalld** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module gathers information about firewalld rules. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- firewalld >= 0.2.11 -- python-firewall -- python-dbus - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- active_zones - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Gather information about active zones.
-
-
- zones - -
- list - / elements=string -
- 		- -
Gather information about specific zones.
-
If only works if active_zones is set to false.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather information about active zones - ansible.posix.firewalld_info: - active_zones: true - register: result - - - name: Print default zone for debugging - ansible.builtin.debug: - var: result.firewalld_info.default_zone - - - name: Gather information about specific zones - ansible.posix.firewalld_info: - zones: - - public - - external - - internal - register: result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- active_zones - -
- boolean -
- 		success -
Gather active zones only if turn it true.
-
-
-
- collected_zones - -
- list -
- 		success -
A list of collected zones.
-
-
Sample:
-
['external', 'internal']
-
-
- firewalld_info - -
- complex -
- 		success -
Returns various information about firewalld configuration.
-
-
  -
- default_zone - -
- string -
- 		success -
The zone name of default zone.
-
-
Sample:
-
public
-
  -
- version - -
- string -
- 		success -
The version information of firewalld.
-
-
Sample:
-
0.8.2
-
  -
- zones - -
- complex -
- 		success -
A dict of zones to gather information.
-
-
   -
- zone - -
- complex -
- 		success -
The zone name registered in firewalld.
-
-
Sample:
-
external
-
    -
- forward - -
- boolean -
- 		success -
The network interface forwarding.
-
This parameter supports on python-firewall 0.9.0(or later) and is not collected in earlier versions.
-
-
    -
- forward_ports - -
- list -
- 		success -
A list of forwarding port pair with protocol.
-
-
Sample:
-
['icmp', 'ipv6-icmp']
-
    -
- icmp_block_inversion - -
- boolean -
- 		success -
The ICMP block inversion to block all ICMP requests.
-
-
    -
- icmp_blocks - -
- list -
- 		success -
A list of blocking icmp protocol.
-
-
Sample:
-
['echo-request']
-
    -
- interfaces - -
- list -
- 		success -
A list of network interfaces.
-
-
Sample:
-
['eth0', 'eth1']
-
    -
- masquerade - -
- boolean -
- 		success -
The network interface masquerading.
-
-
    -
- ports - -
- list -
- 		success -
A list of network port with protocol.
-
-
Sample:
-
[['22', 'tcp'], ['80', 'tcp']]
-
    -
- protocols - -
- list -
- 		success -
A list of network protocol.
-
-
Sample:
-
['icmp', 'ipv6-icmp']
-
    -
- rich_rules - -
- list -
- 		success -
A list of rich language rule.
-
-
Sample:
-
['rule protocol value="icmp" reject', 'rule priority="32767" reject']
-
    -
- services - -
- list -
- 		success -
A list of network services.
-
-
Sample:
-
['dhcp', 'dns', 'ssh']
-
    -
- source_ports - -
- list -
- 		success -
A list of network source port with protocol.
-
-
Sample:
-
[['30000', 'tcp'], ['30001', 'tcp']]
-
    -
- sources - -
- list -
- 		success -
A list of source network address.
-
-
Sample:
-
['172.16.30.0/24', '172.16.31.0/24']
-
    -
- target - -
- string -
- 		success -
A list of services in the zone.
-
-
Sample:
-
ACCEPT
-
-
- undefined_zones - -
- list -
- 		success -
A list of undefined zones in zones option.
-
undefined_zones will be ignored for gathering process.
-
-
Sample:
-
['foo', 'bar']
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Hideki Saito (@saito-hideki) diff --git a/docs/ansible.posix.firewalld_module.rst b/docs/ansible.posix.firewalld_module.rst deleted file mode 100644 index 0932ac2..0000000 --- a/docs/ansible.posix.firewalld_module.rst +++ /dev/null @@ -1,521 +0,0 @@ -.. _ansible.posix.firewalld_module: - - -*********************** -ansible.posix.firewalld -*********************** - -**Manage arbitrary ports/services with firewalld** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module allows for addition or deletion of services and ports (either TCP or UDP) in either running or permanent firewalld rules. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- firewalld >= 0.2.11 -- python-firewall >= 0.2.11 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- icmp_block - -
- string -
- 		- -
The ICMP block you would like to add/remove to/from a zone in firewalld.
-
-
- icmp_block_inversion - -
- string -
- 		- -
Enable/Disable inversion of ICMP blocks for a zone in firewalld.
-
-
- immediate - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Should this configuration be applied immediately, if set as permanent.
-
-
- interface - -
- string -
- 		- -
The interface you would like to add/remove to/from a zone in firewalld.
-
-
- masquerade - -
- string -
- 		- -
The masquerade setting you would like to enable/disable to/from zones within firewalld.
-
-
- offline - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether to run this module even when firewalld is offline.
-
-
- permanent - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Should this configuration be in the running firewalld configuration or persist across reboots.
-
As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 0.3.9).
-
Note that if this is false, immediate is assumed true.
-
-
- port - -
- string -
- 		- -
Name of a port or port range to add/remove to/from firewalld.
-
Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges.
-
-
- port_forward - -
- list - / elements=dictionary -
- 		- -
Port and protocol to forward using firewalld.
-
-
- port - -
- string - / required -
- 		- -
Source port to forward from
-
-
- proto - -
- string - / required -
- 		-
    Choices: -
  • udp
    • -
  • tcp
    • -
- 		-
protocol to forward
-
-
- toaddr - -
- string -
- 		- -
Optional address to forward to
-
-
- toport - -
- string - / required -
- 		- -
destination port
-
-
- protocol - -
- string -
- 		- -
Name of a protocol to add/remove to/from firewalld.
-
-
- rich_rule - -
- string -
- 		- -
Rich rule to add/remove to/from firewalld.
- -
-
- service - -
- string -
- 		- -
Name of a service to add/remove to/from firewalld.
-
The service must be listed in output of firewall-cmd --get-services.
-
-
- source - -
- string -
- 		- -
The source/network you would like to add/remove to/from firewalld.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • absent
    • -
  • disabled
    • -
  • enabled
    • -
  • present
    • -
- 		-
Enable or disable a setting.
-
For ports: Should this port accept (enabled) or reject (disabled) connections.
-
The states present and absent can only be used in zone level operations (i.e. when no other parameters but zone and state are set).
-
-
- target - -
- string -
-
added in 1.2.0
- 		-
    Choices: -
  • default
    • -
  • ACCEPT
    • -
  • DROP
    • -
  • %%REJECT%%
    • -
- 		-
firewalld Zone target
-
If state is set to absent, this will reset the target to default
-
-
- timeout - -
- integer -
- 		- Default:
0
- 		-
The amount of time in seconds the rule should be in effect for when non-permanent.
-
-
- zone - -
- string -
- 		- -
The firewalld zone to add/remove to/from.
-
Note that the default zone can be configured per system but public is default from upstream.
-
Available choices can be extended based on per-system configs, listed here are "out of the box" defaults.
-
Possible values include block, dmz, drop, external, home, internal, public, trusted, work.
-
-
- - -Notes ------ - -.. note:: - - Not tested on any Debian based system. - - Requires the python2 bindings of firewalld, which may not be installed by default. - - For distributions where the python2 firewalld bindings are unavailable (e.g Fedora 28 and later) you will have to set the ansible_python_interpreter for these hosts to the python3 interpreter path and install the python3 bindings. - - Zone transactions (creating, deleting) can be performed by using only the zone and state parameters "present" or "absent". Note that zone transactions must explicitly be permanent. This is a limitation in firewalld. This also means that you will have to reload firewalld after adding a zone that you wish to perform immediate actions on. The module will not take care of this for you implicitly because that would undo any previously performed immediate actions which were not permanent. Therefore, if you require immediate access to a newly created zone it is recommended you reload firewalld immediately after the zone creation returns with a changed state and before you perform any other immediate, non-permanent actions on that zone. - - This module needs ``python-firewall`` or ``python3-firewall`` on managed nodes. It is usually provided as a subset with ``firewalld`` from the OS distributor for the OS default Python interpreter. - - - -Examples --------- - -.. code-block:: yaml - - - name: permit traffic in default zone for https service - ansible.posix.firewalld: - service: https - permanent: true - state: enabled - - - name: permit ospf traffic - ansible.posix.firewalld: - protocol: ospf - permanent: true - state: enabled - - - name: do not permit traffic in default zone on port 8081/tcp - ansible.posix.firewalld: - port: 8081/tcp - permanent: true - state: disabled - - - ansible.posix.firewalld: - port: 161-162/udp - permanent: true - state: enabled - - - ansible.posix.firewalld: - zone: dmz - service: http - permanent: true - state: enabled - - - ansible.posix.firewalld: - rich_rule: rule service name="ftp" audit limit value="1/m" accept - permanent: true - state: enabled - - - ansible.posix.firewalld: - source: 192.0.2.0/24 - zone: internal - state: enabled - - - ansible.posix.firewalld: - zone: trusted - interface: eth2 - permanent: true - state: enabled - - - ansible.posix.firewalld: - masquerade: true - state: enabled - permanent: true - zone: dmz - - - ansible.posix.firewalld: - zone: custom - state: present - permanent: true - - - ansible.posix.firewalld: - zone: drop - state: enabled - permanent: true - icmp_block_inversion: true - - - ansible.posix.firewalld: - zone: drop - state: enabled - permanent: true - icmp_block: echo-request - - - ansible.posix.firewalld: - zone: internal - state: present - permanent: true - target: ACCEPT - - - name: Redirect port 443 to 8443 with Rich Rule - ansible.posix.firewalld: - rich_rule: rule family=ipv4 forward-port port=443 protocol=tcp to-port=8443 - zone: public - permanent: true - immediate: true - state: enabled - - - - -Status ------- - - -Authors -~~~~~~~ - -- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.mount_module.rst b/docs/ansible.posix.mount_module.rst deleted file mode 100644 index f38621f..0000000 --- a/docs/ansible.posix.mount_module.rst +++ /dev/null @@ -1,336 +0,0 @@ -.. _ansible.posix.mount_module: - - -******************* -ansible.posix.mount -******************* - -**Control active and configured mount points** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module controls active and configured mount points in ``/etc/fstab``. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
-
-
- boot - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Determines if the filesystem should be mounted on boot.
-
Only applies to Solaris and Linux systems.
-
For Solaris systems, true will set yes as the value of mount at boot in /etc/vfstab.
-
For Linux, FreeBSD, NetBSD and OpenBSD systems, false will add noauto to mount options in /etc/fstab.
-
To avoid mount option conflicts, if noauto specified in opts, mount module will ignore boot.
-
This parameter is ignored when state is set to ephemeral.
-
-
- dump - -
- string -
- 		- Default:
"0"
- 		-
Dump (see fstab(5)).
-
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Has no effect on Solaris systems or when used with ephemeral.
-
-
- fstab - -
- string -
- 		- -
File to use instead of /etc/fstab.
-
You should not use this option unless you really know what you are doing.
-
This might be useful if you need to configure mountpoints in a chroot environment.
-
OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.
-
This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.
-
This parameter is ignored when state is set to ephemeral.
-
-
- fstype - -
- string -
- 		- -
Filesystem type.
-
Required when state is present, mounted or ephemeral.
-
-
- opts - -
- string -
- 		- -
Mount options (see fstab(5), or vfstab(4) on Solaris).
-
-
- passno - -
- string -
- 		- Default:
"0"
- 		-
Passno (see fstab(5)).
-
Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
-
Deprecated on Solaris systems. Has no effect when used with ephemeral.
-
-
- path - -
- path - / required -
- 		- -
Path to the mount point (e.g. /mnt/files).
-
Before Ansible 2.3 this option was only usable as dest, destfile and name.
-

aliases: name
-
-
- src - -
- path -
- 		- -
Device (or NFS volume, or something else) to be mounted on path.
-
Required when state set to present, mounted or ephemeral.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • absent
    • -
  • absent_from_fstab
    • -
  • mounted
    • -
  • present
    • -
  • unmounted
    • -
  • remounted
    • -
  • ephemeral
    • -
- 		-
If mounted, the device will be actively mounted and appropriately configured in fstab. If the mount point is not present, the mount point will be created.
-
If unmounted, the device will be unmounted without changing fstab.
-
present only specifies that the device is to be configured in fstab and does not trigger or require a mount.
-
ephemeral only specifies that the device is to be mounted, without changing fstab. If it is already mounted, a remount will be triggered. This will always return changed=True. If the mount point path has already a device mounted on, and its source is different than src, the module will fail to avoid unexpected unmount or mount point override. If the mount point is not present, the mount point will be created. The fstab is completely ignored. This option is added in version 1.5.0.
-
absent specifies that the device mount's entry will be removed from fstab and will also unmount the device and remove the mount point.
-
remounted specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. If opts is set, the options will be applied to the remount, but will not change fstab. Additionally, if opts is set, and the remount command fails, the module will error to prevent unexpected mount changes. Try using mounted instead to work around this issue. remounted expects the mount point to be present in the fstab. To remount a mount point not registered in fstab, use ephemeral instead, especially with BSD nodes.
-
absent_from_fstab specifies that the device mount's entry will be removed from fstab. This option does not unmount it or delete the mountpoint.
-
-
- - -Notes ------ - -.. note:: - - As of Ansible 2.3, the *name* option has been changed to *path* as default, but *name* still works as well. - - Using ``remounted`` with *opts* set may create unexpected results based on the existing options already defined on mount, so care should be taken to ensure that conflicting options are not present before hand. - - - -Examples --------- - -.. code-block:: yaml - - # Before 2.3, option 'name' was used instead of 'path' - - name: Mount DVD read-only - ansible.posix.mount: - path: /mnt/dvd - src: /dev/sr0 - fstype: iso9660 - opts: ro,noauto - state: present - - - name: Mount up device by label - ansible.posix.mount: - path: /srv/disk - src: LABEL=SOME_LABEL - fstype: ext4 - state: present - - - name: Mount up device by UUID - ansible.posix.mount: - path: /home - src: UUID=b3e48f45-f933-4c8e-a700-22a159ec9077 - fstype: xfs - opts: noatime - state: present - - - name: Unmount a mounted volume - ansible.posix.mount: - path: /tmp/mnt-pnt - state: unmounted - - - name: Remount a mounted volume - ansible.posix.mount: - path: /tmp/mnt-pnt - state: remounted - - # The following will not save changes to fstab, and only be temporary until - # a reboot, or until calling "state: unmounted" followed by "state: mounted" - # on the same "path" - - name: Remount a mounted volume and append exec to the existing options - ansible.posix.mount: - path: /tmp - state: remounted - opts: exec - - - name: Mount and bind a volume - ansible.posix.mount: - path: /system/new_volume/boot - src: /boot - opts: bind - state: mounted - fstype: none - - - name: Mount an NFS volume - ansible.posix.mount: - src: 192.168.1.100:/nfs/ssd/shared_data - path: /mnt/shared_data - opts: rw,sync,hard - state: mounted - fstype: nfs - - - name: Mount NFS volumes with noauto according to boot option - ansible.posix.mount: - src: 192.168.1.100:/nfs/ssd/shared_data - path: /mnt/shared_data - opts: rw,sync,hard - boot: false - state: mounted - fstype: nfs - - - name: Mount ephemeral SMB volume - ansible.posix.mount: - src: //192.168.1.200/share - path: /mnt/smb_share - opts: "rw,vers=3,file_mode=0600,dir_mode=0700,dom={{ ad_domain }},username={{ ad_username }},password={{ ad_password }}" - fstype: cifs - state: ephemeral - - - - -Status ------- - - -Authors -~~~~~~~ - -- Ansible Core Team -- Seth Vidal (@skvidal) diff --git a/docs/ansible.posix.patch_module.rst b/docs/ansible.posix.patch_module.rst deleted file mode 100644 index 07f672a..0000000 --- a/docs/ansible.posix.patch_module.rst +++ /dev/null @@ -1,245 +0,0 @@ -.. _ansible.posix.patch_module: - - -******************* -ansible.posix.patch -******************* - -**Apply patch files using the GNU patch tool** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Apply patch files using the GNU patch tool. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- backup - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Passes --backup --version-control=numbered to patch, producing numbered backup copies.
-
-
- basedir - -
- path -
- 		- -
Path of a base directory in which the patch file will be applied.
-
May be omitted when dest option is specified, otherwise required.
-
-
- binary - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Setting to true will disable patch's heuristic for transforming CRLF line endings into LF.
-
Line endings of src and dest must match.
-
If set to false, patch will replace CRLF in src files on POSIX.
-
-
- dest - -
- path -
- 		- -
Path of the file on the remote machine to be patched.
-
The names of the files to be patched are usually taken from the patch file, but if there's just one file to be patched it can specified with this option.
-

aliases: originalfile
-
-
- ignore_whitespace - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Setting to true will ignore white space changes between patch and input.
-
-
- remote_src - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If false, it will search for src at originating/controller machine, if true it will go to the remote/target machine for the src.
-
-
- src - -
- path - / required -
- 		- -
Path of the patch file as accepted by the GNU patch tool. If remote_src is false, the patch source file is looked up from the module's files directory.
-

aliases: patchfile
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Whether the patch should be applied or reverted.
-
-
- strip - -
- integer -
- 		- Default:
0
- 		-
Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file.
-
For more information see the strip parameter of the GNU patch tool.
-
-
- - -Notes ------ - -.. note:: - - This module requires GNU *patch* utility to be installed on the remote host. - - - -Examples --------- - -.. code-block:: yaml - - - name: Apply patch to one file - ansible.posix.patch: - src: /tmp/index.html.patch - dest: /var/www/index.html - - - name: Apply patch to multiple files under basedir - ansible.posix.patch: - src: /tmp/customize.patch - basedir: /var/www - strip: 1 - - - name: Revert patch to one file - ansible.posix.patch: - src: /tmp/index.html.patch - dest: /var/www/index.html - state: absent - - - - -Status ------- - - -Authors -~~~~~~~ - -- Jakub Jirutka (@jirutka) -- Luis Alberto Perez Lazaro (@luisperlaz) diff --git a/docs/ansible.posix.rhel_facts_module.rst b/docs/ansible.posix.rhel_facts_module.rst deleted file mode 100644 index d4c8fb6..0000000 --- a/docs/ansible.posix.rhel_facts_module.rst +++ /dev/null @@ -1,103 +0,0 @@ -.. _ansible.posix.rhel_facts_module: - - -************************ -ansible.posix.rhel_facts -************************ - -**Facts module to set or override RHEL specific facts.** - - -Version added: 1.5.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Compatibility layer for using the "package" module for rpm-ostree based systems via setting the "pkg_mgr" fact correctly. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- rpm-ostree - - - - -See Also --------- - -.. seealso:: - - :ref:`ansible.builtin.package_module` - The official documentation on the **ansible.builtin.package** module. - - -Examples --------- - -.. code-block:: yaml - - - name: Playbook to use the package module on all RHEL footprints - vars: - ansible_facts_modules: - - setup # REQUIRED to be run before all custom fact modules - - ansible.posix.rhel_facts - tasks: - - name: Ensure packages are installed - ansible.builtin.package: - name: - - htop - - ansible - state: present - - -Returned Facts --------------- -Facts returned by this module are added/updated in the ``hostvars`` host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them. - -.. raw:: html - - - - - - - - - - - - -
FactReturnedDescription
-
- pkg_mgr - -
- string -
- 		when needed -
System-level package manager override -
-
-
Sample:
-
{'pkg_mgr': 'ansible.posix.rhel_facts'}
-
-

- - - -Status ------- - - -Authors -~~~~~~~ - -- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.rhel_rpm_ostree_module.rst b/docs/ansible.posix.rhel_rpm_ostree_module.rst deleted file mode 100644 index b170b15..0000000 --- a/docs/ansible.posix.rhel_rpm_ostree_module.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. _ansible.posix.rhel_rpm_ostree_module: - - -***************************** -ansible.posix.rhel_rpm_ostree -***************************** - -**Ensure packages exist in a RHEL for Edge rpm-ostree based system** - - -Version added: 1.5.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Compatibility layer for using the "package" module for RHEL for Edge systems utilizing the RHEL System Roles. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- rpm-ostree - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- list - / elements=string -
- 		- Default:
[]
- 		-
A package name or package specifier with version, like name-1.0.
-
Comparison operators for package version are valid here >, <, >=, <=. Example - name>=1.0
-
If a previous version is specified, the task also needs to turn allow_downgrade on. See the allow_downgrade documentation for caveats with downgrading packages.
-
When using state=latest, this can be '*' which means run yum -y update.
-
You can also pass a url or a local path to a rpm file (using state=present). To operate on several packages this can accept a comma separated string of packages or (as of 2.0) a list of packages.
-

aliases: pkg
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • installed
    • -
  • latest
    • -
  • present
    • -
  • removed
    • -
- 		-
Whether to install (present or installed, latest), or remove (absent or removed) a package.
-
present and installed will simply ensure that a desired package is installed.
-
latest will update the specified package if it's not of the latest available version.
-
absent and removed will remove the specified package.
-
Default is None, however in effect the default action is present unless the autoremove option is enabled for this module, then absent is inferred.
-
-
- - -Notes ------ - -.. note:: - - This module does not support installing or removing packages to/from an overlay as this is not supported by RHEL for Edge, packages needed should be defined in the osbuild Blueprint and provided to Image Builder at build time. This module exists only for ``package`` module compatibility. - - - -Examples --------- - -.. code-block:: yaml - - - name: Ensure htop and ansible are installed on rpm-ostree based RHEL - ansible.posix.rhel_rpm_ostree: - name: - - htop - - ansible - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
status of rpm transaction
-
-
Sample:
-
No changes made.
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.rpm_ostree_upgrade_module.rst b/docs/ansible.posix.rpm_ostree_upgrade_module.rst deleted file mode 100644 index d683166..0000000 --- a/docs/ansible.posix.rpm_ostree_upgrade_module.rst +++ /dev/null @@ -1,175 +0,0 @@ -.. _ansible.posix.rpm_ostree_upgrade_module: - - -******************************** -ansible.posix.rpm_ostree_upgrade -******************************** - -**Manage rpm-ostree upgrade transactions** - - -Version added: 1.5.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage an rpm-ostree upgrade transactions. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- rpm-ostree - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allow_downgrade - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Allow for the upgrade to be a chronologically older tree.
-
-
- cache_only - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Perform the transaction using only pre-cached data, do not download.
-
-
- os - -
- string -
- 		- Default:
""
- 		-
The OSNAME upon which to operate.
-
-
- peer - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Force peer-to-peer connection instead of using a system message bus.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Upgrade the rpm-ostree image without options, accept all defaults - ansible.posix.rpm_ostree_upgrade: - - - name: Upgrade the rpm-ostree image allowing downgrades - ansible.posix.rpm_ostree_upgrade: - allow_downgrade: true - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
The command standard output
-
-
Sample:
-
No upgrade available.
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Adam Miller (@maxamillion) diff --git a/docs/ansible.posix.seboolean_module.rst b/docs/ansible.posix.seboolean_module.rst deleted file mode 100644 index 330d091..0000000 --- a/docs/ansible.posix.seboolean_module.rst +++ /dev/null @@ -1,151 +0,0 @@ -.. _ansible.posix.seboolean_module: - - -*********************** -ansible.posix.seboolean -*********************** - -**Toggles SELinux booleans** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Toggles SELinux booleans. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- libselinux-python -- libsemanage-python -- python3-libsemanage - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- ignore_selinux_state - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Useful for scenarios (chrooted environment) that you can't get the real SELinux state.
-
-
- name - -
- string - / required -
- 		- -
Name of the boolean to configure.
-
-
- persistent - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set to true if the boolean setting should survive a reboot.
-
-
- state - -
- boolean - / required -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Desired boolean value
-
-
- - -Notes ------ - -.. note:: - - Not tested on any Debian based system. - - - -Examples --------- - -.. code-block:: yaml - - - name: Set httpd_can_network_connect flag on and keep it persistent across reboots - ansible.posix.seboolean: - name: httpd_can_network_connect - state: true - persistent: true - - - - -Status ------- - - -Authors -~~~~~~~ - -- Stephen Fromm (@sfromm) diff --git a/docs/ansible.posix.selinux_module.rst b/docs/ansible.posix.selinux_module.rst deleted file mode 100644 index 20d9ef8..0000000 --- a/docs/ansible.posix.selinux_module.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. _ansible.posix.selinux_module: - - -********************* -ansible.posix.selinux -********************* - -**Change policy and state of SELinux** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Configures the SELinux mode and policy. -- A reboot may be required after usage. -- Ansible will not issue this reboot but will let you know when it is required. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- libselinux-python - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- configfile - -
- string -
- 		- Default:
"/etc/selinux/config"
- 		-
The path to the SELinux configuration file, if non-standard.
-

aliases: conf, file
-
-
- policy - -
- string -
- 		- -
The name of the SELinux policy to use (e.g. targeted) will be required if state is not disabled.
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • disabled
    • -
  • enforcing
    • -
  • permissive
    • -
- 		-
The SELinux mode.
-
-
- update_kernel_param - -
- boolean -
-
added in 1.4.0
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If set to true, will update also the kernel boot parameters when disabling/enabling SELinux.
-
The grubby tool must be present on the target system for this to work.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable SELinux - ansible.posix.selinux: - policy: targeted - state: enforcing - - - name: Put SELinux in permissive mode, logging actions that would be blocked. - ansible.posix.selinux: - policy: targeted - state: permissive - - - name: Disable SELinux - ansible.posix.selinux: - state: disabled - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- configfile - -
- string -
- 		always -
Path to SELinux configuration file.
-
-
Sample:
-
/etc/selinux/config
-
-
- msg - -
- string -
- 		always -
Messages that describe changes that were made.
-
-
Sample:
-
Config SELinux state changed from 'disabled' to 'permissive'
-
-
- policy - -
- string -
- 		always -
Name of the SELinux policy.
-
-
Sample:
-
targeted
-
-
- reboot_required - -
- boolean -
- 		always -
Whether or not an reboot is required for the changes to take effect.
-
-
Sample:
-
True
-
-
- state - -
- string -
- 		always -
SELinux mode.
-
-
Sample:
-
enforcing
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Derek Carter (@goozbach) diff --git a/docs/ansible.posix.synchronize_module.rst b/docs/ansible.posix.synchronize_module.rst deleted file mode 100644 index 7cb3059..0000000 --- a/docs/ansible.posix.synchronize_module.rst +++ /dev/null @@ -1,744 +0,0 @@ -.. _ansible.posix.synchronize_module: - - -************************* -ansible.posix.synchronize -************************* - -**A wrapper around rsync to make common tasks in your playbooks quick and easy** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- ``synchronize`` is a wrapper around rsync to make common tasks in your playbooks quick and easy. -- It is run and originates on the local host where Ansible is being run. -- Of course, you could just use the ``command`` action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. -- This module is not intended to provide access to the full power of rsync, but does make the most common invocations easier to implement. You `still` may need to call rsync directly via ``command`` or ``shell`` depending on your use case. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- archive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
-
-
- checksum - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Skip based on checksum, rather than mod-time & size; Note that that "archive" option is still enabled by default - the "checksum" option will not disable it.
-
-
- compress - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Compress file data during the transfer.
-
In most cases, leave this enabled unless it causes problems.
-
-
- copy_links - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.
-
-
- delay_updates - -
- boolean -
-
added in 1.3.0
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
This option puts the temporary file from each updated file into a holding directory until the end of the transfer, at which time all the files are renamed into place in rapid succession.
-
-
- delete - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Delete files in dest that do not exist (after transfer, not before) in the src path.
-
This option requires recursive=true.
-
This option ignores excluded files and behaves like the rsync opt --delete-after.
-
-
- dest - -
- string - / required -
- 		- -
Path on the destination host that will be synchronized from the source.
-
The path can be absolute or relative.
-
-
- dest_port - -
- integer -
- 		- -
Port number for ssh on the destination host.
-
Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value.
-
This parameter defaults to the value of ansible_port, the remote_port config setting or the value from ssh client configuration if none of the former have been set.
-
-
- dirs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Transfer directories without recursing.
-
-
- existing_only - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Skip creating new files on receiver.
-
-
- group - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preserve group.
-
This parameter defaults to the value of the archive option.
-
-
- link_dest - -
- list - / elements=string -
- 		- Default:
null
- 		-
Add a destination to hard link against during the rsync.
-
-
- links - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Copy symlinks as symlinks.
-
This parameter defaults to the value of the archive option.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • pull
    • -
  • push ←
    • -
- 		-
Specify the direction of the synchronization.
-
In push mode the localhost or delegate is the source.
-
In pull mode the remote host in context is the source.
-
-
- owner - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preserve owner (super user only).
-
This parameter defaults to the value of the archive option.
-
-
- partial - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Tells rsync to keep the partial file which should make a subsequent transfer of the rest of the file much faster.
-
-
- perms - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preserve permissions.
-
This parameter defaults to the value of the archive option.
-
-
- private_key - -
- path -
- 		- -
Specify the private key to use for SSH-based rsync connections (e.g. ~/.ssh/id_rsa).
-
-
- recursive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Recurse into directories.
-
This parameter defaults to the value of the archive option.
-
-
- rsync_opts - -
- list - / elements=string -
- 		- Default:
null
- 		-
Specify additional rsync options by passing in an array.
-
Note that an empty string in rsync_opts will end up transfer the current working directory.
-
-
- rsync_path - -
- string -
- 		- -
Specify the rsync command to run on the remote host. See --rsync-path on the rsync man page.
-
To specify the rsync command to run on the local host, you need to set this your task var ansible_rsync_path.
-
-
- rsync_timeout - -
- integer -
- 		- Default:
0
- 		-
Specify a --timeout for the rsync command in seconds.
-
-
- set_remote_user - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Put user@ for the remote paths.
-
If you have a custom ssh config to define the remote user for a host that does not match the inventory user, you should set this parameter to false.
-
-
- src - -
- string - / required -
- 		- -
Path on the source host that will be synchronized to the destination.
-
The path can be absolute or relative.
-
-
- ssh_connection_multiplexing - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
SSH connection multiplexing for rsync is disabled by default to prevent misconfigured ControlSockets from resulting in failed SSH connections. This is accomplished by setting the SSH ControlSocket to none.
-
Set this option to true to allow multiplexing and reduce SSH connection overhead.
-
Note that simply setting this option to true is not enough; You must also configure SSH connection multiplexing in your SSH client config by setting values for ControlMaster, ControlPersist and ControlPath.
-
-
- times - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Preserve modification times.
-
This parameter defaults to the value of the archive option.
-
-
- use_ssh_args - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
In Ansible 2.10 and lower, it uses the ssh_args specified in ansible.cfg.
-
In Ansible 2.11 and onwards, when set to true, it uses all SSH connection configurations like ansible_ssh_args, ansible_ssh_common_args, and ansible_ssh_extra_args.
-
-
- verify_host - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Verify destination host key.
-
-
- - -Notes ------ - -.. note:: - - rsync must be installed on both the local and remote host. - - For the ``synchronize`` module, the "local host" is the host `the synchronize task originates on`, and the "destination host" is the host `synchronize is connecting to`. - - The "local host" can be changed to a different host by using `delegate_to`. This enables copying between two remote hosts or entirely on one remote machine. - - The user and permissions for the synchronize `src` are those of the user running the Ansible task on the local host (or the remote_user for a delegate_to host when delegate_to is used). - - - The user and permissions for the synchronize `dest` are those of the `remote_user` on the destination host or the `become_user` if `become=yes` is active. - - In Ansible 2.0 a bug in the synchronize module made become occur on the "local host". This was fixed in Ansible 2.0.1. - - Currently, synchronize is limited to elevating permissions via passwordless sudo. This is because rsync itself is connecting to the remote machine and rsync doesn't give us a way to pass sudo credentials in. - - Currently there are only a few connection types which support synchronize (ssh, paramiko, local, and docker) because a sync strategy has been determined for those connection types. Note that the connection for these must not need a password as rsync itself is making the connection and rsync does not provide us a way to pass a password to the connection. - - Expect that dest=~/x will be ~/x even if using sudo. - - Inspect the verbose output to validate the destination user/host/path are what was expected. - - To exclude files and directories from being synchronized, you may add ``.rsync-filter`` files to the source directory. - - rsync daemon must be up and running with correct permission when using rsync protocol in source or destination path. - - The ``synchronize`` module enables `--delay-updates` by default to avoid leaving a destination in a broken in-between state if the underlying rsync process encounters an error. Those synchronizing large numbers of files that are willing to trade safety for performance should disable this option. - - link_destination is subject to the same limitations as the underlying rsync daemon. Hard links are only preserved if the relative subtrees of the source and destination are the same. Attempts to hardlink into a directory that is a subdirectory of the source will be prevented. - - -See Also --------- - -.. seealso:: - - :ref:`ansible.builtin.copy_module` - The official documentation on the **ansible.builtin.copy** module. - :ref:`community.windows.win_robocopy_module` - The official documentation on the **community.windows.win_robocopy** module. - - -Examples --------- - -.. code-block:: yaml - - - name: Synchronization of src on the control machine to dest on the remote hosts - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - - - name: Synchronization using rsync protocol (push) - ansible.posix.synchronize: - src: some/relative/path/ - dest: rsync://somehost.com/path/ - - - name: Synchronization using rsync protocol (pull) - ansible.posix.synchronize: - mode: pull - src: rsync://somehost.com/path/ - dest: /some/absolute/path/ - - - name: Synchronization using rsync protocol on delegate host (push) - ansible.posix.synchronize: - src: /some/absolute/path/ - dest: rsync://somehost.com/path/ - delegate_to: delegate.host - - - name: Synchronization using rsync protocol on delegate host (pull) - ansible.posix.synchronize: - mode: pull - src: rsync://somehost.com/path/ - dest: /some/absolute/path/ - delegate_to: delegate.host - - - name: Synchronization without any --archive options enabled - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - archive: false - - - name: Synchronization with --archive options enabled except for --recursive - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - recursive: false - - - name: Synchronization with --archive options enabled except for --times, with --checksum option enabled - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - checksum: true - times: false - - - name: Synchronization without --archive options enabled except use --links - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - archive: false - links: true - - - name: Synchronization of two paths both on the control machine - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - delegate_to: localhost - - - name: Synchronization of src on the inventory host to the dest on the localhost in pull mode - ansible.posix.synchronize: - mode: pull - src: some/relative/path - dest: /some/absolute/path - - - name: Synchronization of src on delegate host to dest on the current inventory host. - ansible.posix.synchronize: - src: /first/absolute/path - dest: /second/absolute/path - delegate_to: delegate.host - - - name: Synchronize two directories on one remote host. - ansible.posix.synchronize: - src: /first/absolute/path - dest: /second/absolute/path - delegate_to: "{{ inventory_hostname }}" - - - name: Synchronize and delete files in dest on the remote host that are not found in src of localhost. - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - delete: true - recursive: true - - # This specific command is granted su privileges on the destination - - name: Synchronize using an alternate rsync command - ansible.posix.synchronize: - src: some/relative/path - dest: /some/absolute/path - rsync_path: su -c rsync - - # Example .rsync-filter file in the source directory - # - var # exclude any path whose last part is 'var' - # - /var # exclude any path starting with 'var' starting at the source directory - # + /var/conf # include /var/conf even though it was previously excluded - - - name: Synchronize passing in extra rsync options - ansible.posix.synchronize: - src: /tmp/helloworld - dest: /var/www/helloworld - rsync_opts: - - "--no-motd" - - "--exclude=.git" - - # Hardlink files if they didn't change - - name: Use hardlinks when synchronizing filesystems - ansible.posix.synchronize: - src: /tmp/path_a/foo.txt - dest: /tmp/path_b/foo.txt - link_dest: /tmp/path_a/ - - # Specify the rsync binary to use on remote host and on local host - - hosts: groupofhosts - vars: - ansible_rsync_path: /usr/gnu/bin/rsync - - tasks: - - name: copy /tmp/localpath/ to remote location /tmp/remotepath - ansible.posix.synchronize: - src: /tmp/localpath/ - dest: /tmp/remotepath - rsync_path: /usr/gnu/bin/rsync - - - - -Status ------- - - -Authors -~~~~~~~ - -- Timothy Appnel (@tima) diff --git a/docs/ansible.posix.sysctl_module.rst b/docs/ansible.posix.sysctl_module.rst deleted file mode 100644 index 1a3b111..0000000 --- a/docs/ansible.posix.sysctl_module.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _ansible.posix.sysctl_module: - - -******************** -ansible.posix.sysctl -******************** - -**Manage entries in sysctl.conf.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module manipulates sysctl entries and optionally performs a ``/sbin/sysctl -p`` after changing them. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- ignoreerrors - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use this option to ignore errors about unknown keys.
-
-
- name - -
- string - / required -
- 		- -
The dot-separated path (also known as key) specifying the sysctl variable.
-

aliases: key
-
-
- reload - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
If true, performs a /sbin/sysctl -p if the sysctl_file is updated. If false, does not reload sysctl even if the sysctl_file is updated.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Whether the entry should be present or absent in the sysctl file.
-
-
- sysctl_file - -
- path -
- 		- Default:
"/etc/sysctl.conf"
- 		-
Specifies the absolute path to sysctl.conf, if not /etc/sysctl.conf.
-
-
- sysctl_set - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Verify token value with the sysctl command and set with -w if necessary.
-
-
- value - -
- string -
- 		- -
Desired value of the sysctl key.
-

aliases: val
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - # Set vm.swappiness to 5 in /etc/sysctl.conf - - ansible.posix.sysctl: - name: vm.swappiness - value: '5' - state: present - - # Remove kernel.panic entry from /etc/sysctl.conf - - ansible.posix.sysctl: - name: kernel.panic - state: absent - sysctl_file: /etc/sysctl.conf - - # Set kernel.panic to 3 in /tmp/test_sysctl.conf - - ansible.posix.sysctl: - name: kernel.panic - value: '3' - sysctl_file: /tmp/test_sysctl.conf - reload: false - - # Set ip forwarding on in /proc and verify token value with the sysctl command - - ansible.posix.sysctl: - name: net.ipv4.ip_forward - value: '1' - sysctl_set: true - - # Set ip forwarding on in /proc and in the sysctl file and reload if necessary - - ansible.posix.sysctl: - name: net.ipv4.ip_forward - value: '1' - sysctl_set: true - state: present - reload: true - - - - -Status ------- - - -Authors -~~~~~~~ - -- David CHANIAL (@davixx) diff --git a/galaxy.yml b/galaxy.yml index 6b7009b..01e619c 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,7 +1,7 @@ --- namespace: ansible name: posix -version: 1.5.4 +version: 2.0.0 readme: README.md authors: - Ansible (github.com/ansible) @@ -10,6 +10,6 @@ license_file: COPYING tags: [posix, networking, shell, unix] dependencies: {} repository: https://github.com/ansible-collections/ansible.posix -documentation: https://github.com/ansible-collections/ansible.posix/tree/main/docs +documentation: https://docs.ansible.com/ansible/latest/collections/ansible/posix/ homepage: https://github.com/ansible-collections/ansible.posix issues: https://github.com/ansible-collections/ansible.posix diff --git a/meta/runtime.yml b/meta/runtime.yml index a96714c..1e85b01 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,8 +1,2 @@ --- -requires_ansible: ">=2.14.0" -plugin_routing: - callback: - skippy: - deprecation: - removal_date: "2022-06-01" - warning_text: See the plugin documentation for more details +requires_ansible: ">=2.15.0" diff --git a/plugins/action/synchronize.py b/plugins/action/synchronize.py index 34c9015..a171a2b 100644 --- a/plugins/action/synchronize.py +++ b/plugins/action/synchronize.py @@ -77,7 +77,14 @@ class ActionModule(ActionBase): if self._host_is_ipv6_address(host): return '[%s%s]:%s' % (user_prefix, host, path) - return '%s%s:%s' % (user_prefix, host, path) + + # preserve formatting of remote paths if host or user@host is explicitly defined in the path + if ':' not in path: + return '%s%s:%s' % (user_prefix, host, path) + elif '@' not in path: + return '%s%s' % (user_prefix, path) + else: + return path def _process_origin(self, host, path, user): diff --git a/plugins/callback/profile_roles.py b/plugins/callback/profile_roles.py index 59a437f..270a74f 100644 --- a/plugins/callback/profile_roles.py +++ b/plugins/callback/profile_roles.py @@ -128,7 +128,10 @@ class CallbackModule(CallbackBase): self._display_tasktime() def playbook_on_stats(self, stats): - self._display_tasktime() + # Align summary report header with other callback plugin summary + self._display.banner("ROLES RECAP") + + self._display.display(tasktime()) self._display.display(filled("", fchar="=")) timestamp(self) diff --git a/plugins/callback/profile_tasks.py b/plugins/callback/profile_tasks.py index 5fb7972..c5cc5fe 100644 --- a/plugins/callback/profile_tasks.py +++ b/plugins/callback/profile_tasks.py @@ -193,7 +193,10 @@ class CallbackModule(CallbackBase): self._display_tasktime() def playbook_on_stats(self, stats): - self._display_tasktime() + # Align summary report header with other callback plugin summary + self._display.banner("TASKS RECAP") + + self._display.display(tasktime()) self._display.display(filled("", fchar="=")) timestamp(self) diff --git a/plugins/callback/skippy.py b/plugins/callback/skippy.py deleted file mode 100644 index ced28af..0000000 --- a/plugins/callback/skippy.py +++ /dev/null @@ -1,43 +0,0 @@ -# (c) 2012-2014, Michael DeHaan -# (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - -# Make coding more python3-ish -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -DOCUMENTATION = ''' - name: skippy - type: stdout - requirements: - - set as main display callback - short_description: Ansible screen output that ignores skipped status - deprecated: - why: The 'default' callback plugin now supports this functionality - removed_at_date: '2022-06-01' - alternative: "'default' callback plugin with 'display_skipped_hosts = no' option" - extends_documentation_fragment: - - default_callback - description: - - This callback does the same as the default except it does not output skipped host/task/item status -''' - -from ansible.plugins.callback.default import CallbackModule as CallbackModule_default - - -class CallbackModule(CallbackModule_default): - - ''' - This is the default callback interface, which simply prints messages - to stdout when new callback events are received. - ''' - - CALLBACK_VERSION = 2.0 - CALLBACK_TYPE = 'stdout' - CALLBACK_NAME = 'ansible.posix.skippy' - - def v2_runner_on_skipped(self, result): - pass - - def v2_runner_item_on_skipped(self, result): - pass diff --git a/plugins/callback/timer.py b/plugins/callback/timer.py index 3ef9255..e2eca05 100644 --- a/plugins/callback/timer.py +++ b/plugins/callback/timer.py @@ -46,4 +46,6 @@ class CallbackModule(CallbackBase): def v2_playbook_on_stats(self, stats): end_time = datetime.utcnow() runtime = end_time - self.start_time - self._display.display("Playbook run took %s days, %s hours, %s minutes, %s seconds" % (self.days_hours_minutes_seconds(runtime))) + # Align summary report header with other callback plugin summary + self._display.banner("PLAYBOOK RECAP") + self._display.display("Playbook run took %s days, %s hours, %s minutes, %s seconds\n\r" % (self.days_hours_minutes_seconds(runtime))) diff --git a/plugins/modules/acl.py b/plugins/modules/acl.py index 1fde8eb..4cc94e7 100644 --- a/plugins/modules/acl.py +++ b/plugins/modules/acl.py @@ -25,7 +25,7 @@ options: state: description: - Define whether the ACL should be present or not. - - The C(query) state gets the current ACL without changing it, for use in C(register) operations. + - The V(query) state gets the current ACL without changing it, for use in C(register) operations. choices: [ absent, present, query ] default: query type: str @@ -36,8 +36,8 @@ options: default: true default: description: - - If the target is a directory, setting this to C(true) will make it the default ACL for entities created inside the directory. - - Setting C(default) to C(true) causes an error if the path is a file. + - If O(path) is a directory, setting this to V(true) will make it the default ACL for entities created inside the directory. + - Setting O(default=true) causes an error if O(path) is a file. type: bool default: false entity: @@ -53,7 +53,7 @@ options: permissions: description: - The permissions to apply/remove can be any combination of C(r), C(w), C(x) - - (read, write and execute respectively), and C(X) (execute permission if the file is a directory or already has execute permission for some user) + (read, write and execute respectively), and C(X) (execute permission if the file is a directory or already has execute permission for some user) type: str entry: description: @@ -67,21 +67,25 @@ options: recursive: description: - Recursively sets the specified ACL. - - Incompatible with C(state=query). - - Alias C(recurse) added in version 1.3.0. + - Incompatible with O(state=query). + - Alias O(recurse) added in version 1.3.0. type: bool default: false aliases: [ recurse ] use_nfsv4_acls: description: - Use NFSv4 ACLs instead of POSIX ACLs. + - This feature uses C(nfs4_setfacl) and C(nfs4_getfacl). The behavior depends on those implementation. + And currently it only supports C(A) in ACE, so C(D) must be replaced with the appropriate C(A). + - Permission is set as optimised ACLs by the system. You can check the actual ACLs that has been set using the return value. + - More info C(man nfs4_setfacl) type: bool default: false recalculate_mask: description: - Select if and when to recalculate the effective right masks of the files. - See C(setfacl) documentation for more info. - - Incompatible with C(state=query). + - Incompatible with O(state=query). choices: [ default, mask, no_mask ] default: default type: str @@ -89,9 +93,9 @@ author: - Brian Coca (@bcoca) - Jérémie Astori (@astorije) notes: -- The C(acl) module requires that ACLs are enabled on the target filesystem and that the C(setfacl) and C(getfacl) binaries are installed. +- The M(ansible.posix.acl) module requires that ACLs are enabled on the target filesystem and that the C(setfacl) and C(getfacl) binaries are installed. - As of Ansible 2.0, this module only supports Linux distributions. -- As of Ansible 2.3, the I(name) option has been changed to I(path) as default, but I(name) still works as well. +- As of Ansible 2.3, the O(name) option has been changed to O(path) as default, but O(name) still works as well. ''' EXAMPLES = r''' @@ -179,7 +183,7 @@ def split_entry(entry): def build_entry(etype, entity, permissions=None, use_nfsv4_acls=False): '''Builds and returns an entry string. Does not include the permissions bit if they are not provided.''' if use_nfsv4_acls: - return ':'.join([etype, entity, permissions, 'allow']) + return ':'.join(['A', 'g' if etype == 'group' else '', entity, permissions + 'tcy']) if permissions: return etype + ':' + entity + ':' + permissions @@ -187,22 +191,27 @@ def build_entry(etype, entity, permissions=None, use_nfsv4_acls=False): return etype + ':' + entity -def build_command(module, mode, path, follow, default, recursive, recalculate_mask, entry=''): +def build_command(module, mode, path, follow, default, recursive, recalculate_mask, use_nfsv4_acls, entry=''): '''Builds and returns a getfacl/setfacl command.''' if mode == 'set': - cmd = [module.get_bin_path('setfacl', True)] - cmd.extend(['-m', entry]) + cmd = [module.get_bin_path('nfs4_setfacl' if use_nfsv4_acls else 'setfacl', True)] + cmd.extend(['-a' if use_nfsv4_acls else '-m', entry]) elif mode == 'rm': - cmd = [module.get_bin_path('setfacl', True)] + cmd = [module.get_bin_path('nfs4_setfacl' if use_nfsv4_acls else 'setfacl', True)] cmd.extend(['-x', entry]) else: # mode == 'get' cmd = [module.get_bin_path('getfacl', True)] # prevents absolute path warnings and removes headers if platform.system().lower() == 'linux': + if use_nfsv4_acls: + # use nfs4_getfacl instead of getfacl if use_nfsv4_acls is True + cmd = [module.get_bin_path('nfs4_getfacl', True)] + else: + cmd = [module.get_bin_path('getfacl', True)] + cmd.append('--absolute-names') cmd.append('--omit-header') - cmd.append('--absolute-names') - if recursive: + if recursive and not use_nfsv4_acls: cmd.append('--recursive') if recalculate_mask == 'mask' and mode in ['set', 'rm']: @@ -210,7 +219,7 @@ def build_command(module, mode, path, follow, default, recursive, recalculate_ma elif recalculate_mask == 'no_mask' and mode in ['set', 'rm']: cmd.append('--no-mask') - if not follow: + if not follow and not use_nfsv4_acls: if platform.system().lower() == 'linux': cmd.append('--physical') elif platform.system().lower() == 'freebsd': @@ -223,24 +232,34 @@ def build_command(module, mode, path, follow, default, recursive, recalculate_ma return cmd -def acl_changed(module, cmd): +def acl_changed(module, cmd, entry, use_nfsv4_acls=False): '''Returns true if the provided command affects the existing ACLs, false otherwise.''' - # FreeBSD do not have a --test flag, so by default, it is safer to always say "true" + # To check the ACL changes, use the output of setfacl or nfs4_setfacl with '--test'. + # FreeBSD do not have a --test flag, so by default, it is safer to always say "true". if platform.system().lower() == 'freebsd': return True cmd = cmd[:] # lists are mutables so cmd would be overwritten without this cmd.insert(1, '--test') lines = run_acl(module, cmd) - + counter = 0 for line in lines: - if not line.endswith('*,*'): - return True - return False + if line.endswith('*,*') and not use_nfsv4_acls: + return False + # if use_nfsv4_acls and entry is listed + if use_nfsv4_acls and entry == line: + counter += 1 + + # The current 'nfs4_setfacl --test' lists a new entry, + # which will be added at the top of list, followed by the existing entries. + # So if the entry has already been registered, the entry should be find twice. + if counter == 2: + return False + return True def run_acl(module, cmd, check_rc=True): - + '''Runs the provided command and returns the output as a list of lines.''' try: (rc, out, err) = module.run_command(cmd, check_rc=check_rc) except Exception as e: @@ -313,7 +332,7 @@ def main(): module.fail_json(msg="'recalculate_mask' MUST NOT be set to 'mask' or 'no_mask' when 'state=query'.") if not entry: - if state == 'absent' and permissions: + if state == 'absent' and permissions and not use_nfsv4_acls: module.fail_json(msg="'permissions' MUST NOT be set when 'state=absent'.") if state == 'absent' and not entity: @@ -350,21 +369,24 @@ def main(): entry = build_entry(etype, entity, permissions, use_nfsv4_acls) command = build_command( module, 'set', path, follow, - default, recursive, recalculate_mask, entry + default, recursive, recalculate_mask, use_nfsv4_acls, entry ) - changed = acl_changed(module, command) + changed = acl_changed(module, command, entry, use_nfsv4_acls) if changed and not module.check_mode: run_acl(module, command) msg = "%s is present" % entry elif state == 'absent': - entry = build_entry(etype, entity, use_nfsv4_acls) + if use_nfsv4_acls: + entry = build_entry(etype, entity, permissions, use_nfsv4_acls) + else: + entry = build_entry(etype, entity, use_nfsv4_acls) command = build_command( module, 'rm', path, follow, - default, recursive, recalculate_mask, entry + default, recursive, recalculate_mask, use_nfsv4_acls, entry ) - changed = acl_changed(module, command) + changed = acl_changed(module, command, entry, use_nfsv4_acls) if changed and not module.check_mode: run_acl(module, command, False) @@ -375,7 +397,10 @@ def main(): acl = run_acl( module, - build_command(module, 'get', path, follow, default, recursive, recalculate_mask) + build_command( + module, 'get', path, follow, default, recursive, + recalculate_mask, use_nfsv4_acls + ) ) module.exit_json(changed=changed, msg=msg, acl=acl) diff --git a/plugins/modules/at.py b/plugins/modules/at.py index 3db953e..9367ac2 100644 --- a/plugins/modules/at.py +++ b/plugins/modules/at.py @@ -36,7 +36,7 @@ options: choices: [ minutes, hours, days, weeks ] state: description: - - The state dictates if the command or script file should be evaluated as present(added) or absent(deleted). + - The state dictates if the command or script file should be evaluated as V(present) (added) or V(absent) (deleted). type: str choices: [ absent, present ] default: present diff --git a/plugins/modules/authorized_key.py b/plugins/modules/authorized_key.py index 26b5b0a..1d68b4e 100644 --- a/plugins/modules/authorized_key.py +++ b/plugins/modules/authorized_key.py @@ -24,22 +24,23 @@ options: key: description: - The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys). + - You can also use V(file://) prefix to search remote for a file with SSH key(s). type: str required: true path: description: - Alternative path to the authorized_keys file. - - The default value is the C(.ssh/authorized_keys) of the home of the user specified in the O(user) parameter. - - Most of the time, it's not necessary to set this key. + - The default value is the V(.ssh/authorized_keys) of the home of the user specified in the O(user) parameter. + - Most of the time, it is not necessary to set this key. - Use the path to your target authorized_keys if you need to explicitly point on it. type: path manage_dir: description: - Whether this module should manage the directory of the authorized key file. - - If set to C(true), the module will create the directory, as well as set the owner and permissions + - If set to V(true), the module will create the directory, as well as set the owner and permissions of an existing directory. - - Be sure to set C(manage_dir=false) if you are using an alternate directory for authorized_keys, - as set with C(path), since you could lock yourself out of SSH access. + - Be sure to set O(manage_dir=false) if you are using an alternate directory for authorized_keys, + as set with O(path), since you could lock yourself out of SSH access. - See the example below. type: bool default: true @@ -56,17 +57,17 @@ options: exclusive: description: - Whether to remove all other non-specified keys from the authorized_keys file. - - Multiple keys can be specified in a single C(key) string value by separating them by newlines. + - Multiple keys can be specified in a single O(key) string value by separating them by newlines. - This option is not loop aware, so if you use C(with_) , it will be exclusive per iteration of the loop. - - If you want multiple keys in the file you need to pass them all to C(key) in a single batch as mentioned above. + - If you want multiple keys in the file you need to pass them all to O(key) in a single batch as mentioned above. type: bool default: false validate_certs: description: - This only applies if using a https url as the source of the keys. - - If set to C(false), the SSL certificates will not be validated. - - This should only set to C(false) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. - - Prior to 2.1 the code worked as if this was set to C(true). + - 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. + - Prior to 2.1 the code worked as if this was set to V(true). type: bool default: true comment: @@ -96,6 +97,12 @@ EXAMPLES = r''' state: present key: https://github.com/charlie.keys +- name: Set authorized keys taken from path on controller node + ansible.posix.authorized_key: + user: charlie + state: present + key: file:///home/charlie/.ssh/id_rsa.pub + - name: Set authorized keys taken from url using lookup ansible.posix.authorized_key: user: charlie @@ -223,6 +230,7 @@ from operator import itemgetter from ansible.module_utils._text import to_native from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.urls import fetch_url +from ansible.module_utils.six.moves.urllib.parse import urlparse class keydict(dict): @@ -556,7 +564,7 @@ def enforce_state(module, params): follow = params.get('follow', False) error_msg = "Error getting key from: %s" - # if the key is a url, request it and use it as key source + # if the key is a url or file, request it and use it as key source if key.startswith("http"): try: resp, info = fetch_url(module, key) @@ -570,6 +578,19 @@ def enforce_state(module, params): # resp.read gives bytes on python3, convert to native string type key = to_native(key, errors='surrogate_or_strict') + if key.startswith("file"): + # if the key is an absolute path, check for existense and use it as a key source + key_path = urlparse(key).path + if not os.path.exists(key_path): + module.fail_json(msg="Path to a key file not found: %s" % key_path) + if not os.path.isfile(key_path): + module.fail_json(msg="Path to a key is a directory and must be a file: %s" % key_path) + try: + with open(key_path, 'r') as source_fh: + key = source_fh.read() + except OSError as e: + module.fail_json(msg="Failed to read key file %s : %s" % (key_path, to_native(e))) + # extract individual keys into an array, skipping blank lines and comments new_keys = [s for s in key.splitlines() if s and not s.startswith('#')] diff --git a/plugins/modules/firewalld.py b/plugins/modules/firewalld.py index 146990f..167c449 100644 --- a/plugins/modules/firewalld.py +++ b/plugins/modules/firewalld.py @@ -17,7 +17,7 @@ options: service: description: - Name of a service to add/remove to/from firewalld. - - The service must be listed in output of firewall-cmd --get-services. + - The service must be listed in output of C(firewall-cmd --get-services). type: str protocol: description: @@ -38,22 +38,22 @@ options: type: str required: true description: - - Source port to forward from + - Source port to forward from. proto: type: str required: true description: - - protocol to forward + - protocol to forward. choices: [udp, tcp] toport: type: str required: true description: - - destination port + - destination port. toaddr: type: str description: - - Optional address to forward to + - Optional address to forward to. rich_rule: description: - Rich rule to add/remove to/from firewalld. @@ -78,28 +78,28 @@ options: zone: description: - The firewalld zone to add/remove to/from. - - Note that the default zone can be configured per system but C(public) is default from upstream. + - Note that the default zone can be configured per system but V(public) is default from upstream. - Available choices can be extended based on per-system configs, listed here are "out of the box" defaults. - - Possible values include C(block), C(dmz), C(drop), C(external), C(home), C(internal), C(public), C(trusted), C(work). + - Possible values include V(block), V(dmz), V(drop), V(external), V(home), V(internal), V(public), V(trusted), V(work). type: str permanent: description: - Whether to apply this change to the permanent firewalld configuration. - As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 0.3.9). - - Note that if this is C(false), I(immediate) defaults to C(true). + - Note that if this is V(false), O(immediate=true) by default. type: bool default: false immediate: description: - Whether to apply this change to the runtime firewalld configuration. - - Defaults to C(true) if I(permanent=false). + - Defaults to V(true) if O(permanent=false). type: bool default: false state: description: - Enable or disable a setting. - - 'For ports: Should this port accept (enabled) or reject (disabled) connections.' - - The states C(present) and C(absent) can only be used in zone level operations (i.e. when no other parameters but zone and state are set). + - 'For ports: Should this port accept (V(enabled)) or reject (V(disabled)) connections.' + - The states V(present) and V(absent) can only be used in zone level operations (i.e. when no other parameters but zone and state are set). type: str required: true choices: [ absent, disabled, enabled, present ] @@ -108,19 +108,24 @@ options: - The amount of time in seconds the rule should be in effect for when non-permanent. type: int default: 0 + forward: + description: + - The forward setting you would like to enable/disable to/from zones within firewalld. + - This option only is supported by firewalld v0.9.0 or later. + type: str masquerade: description: - The masquerade setting you would like to enable/disable to/from zones within firewalld. type: str offline: description: - - Ignores I(immediate) if I(permanent=true) and firewalld is not running. + - Ignores O(immediate) if O(permanent=true) and firewalld is not running. type: bool default: false target: description: - - firewalld Zone target - - If state is set to C(absent), this will reset the target to default + - firewalld Zone target. + - If O(state=absent), this will reset the target to default. choices: [ default, ACCEPT, DROP, "%%REJECT%%" ] type: str version_added: 1.2.0 @@ -138,8 +143,8 @@ notes: - This module needs C(python-firewall) or C(python3-firewall) on managed nodes. It is usually provided as a subset with C(firewalld) from the OS distributor for the OS default Python interpreter. requirements: -- firewalld >= 0.2.11 -- python-firewall >= 0.2.11 +- firewalld >= 0.9.0 +- python-firewall >= 0.9.0 author: - Adam Miller (@maxamillion) ''' @@ -198,6 +203,12 @@ EXAMPLES = r''' permanent: true state: enabled +- ansible.posix.firewalld: + forward: true + state: enabled + permanent: true + zone: internal + - ansible.posix.firewalld: masquerade: true state: enabled @@ -405,6 +416,49 @@ class ProtocolTransaction(FirewallTransaction): self.update_fw_settings(fw_zone, fw_settings) +class ForwardTransaction(FirewallTransaction): + """ + ForwardTransaction + """ + + def __init__(self, module, action_args=None, zone=None, desired_state=None, permanent=False, immediate=False): + super(ForwardTransaction, self).__init__( + module, action_args=action_args, desired_state=desired_state, zone=zone, permanent=permanent, immediate=immediate + ) + + self.enabled_msg = "Added forward to zone %s" % self.zone + self.disabled_msg = "Removed forward from zone %s" % self.zone + + def get_enabled_immediate(self): + if self.fw.queryForward(self.zone) is True: + return True + else: + return False + + def get_enabled_permanent(self): + fw_zone, fw_settings = self.get_fw_zone_settings() + if fw_settings.queryForward() is True: + return True + else: + return False + + def set_enabled_immediate(self): + self.fw.addForward(self.zone) + + def set_enabled_permanent(self): + fw_zone, fw_settings = self.get_fw_zone_settings() + fw_settings.setForward(True) + self.update_fw_settings(fw_zone, fw_settings) + + def set_disabled_immediate(self): + self.fw.removeForward(self.zone) + + def set_disabled_permanent(self): + fw_zone, fw_settings = self.get_fw_zone_settings() + fw_settings.setForward(False) + self.update_fw_settings(fw_zone, fw_settings) + + class MasqueradeTransaction(FirewallTransaction): """ MasqueradeTransaction @@ -821,6 +875,7 @@ def main(): state=dict(type='str', required=True, choices=['absent', 'disabled', 'enabled', 'present']), timeout=dict(type='int', default=0), interface=dict(type='str'), + forward=dict(type='str'), masquerade=dict(type='str'), offline=dict(type='bool', default=False), target=dict(type='str', choices=['default', 'ACCEPT', 'DROP', '%%REJECT%%']), @@ -833,7 +888,7 @@ def main(): ), mutually_exclusive=[ ['icmp_block', 'icmp_block_inversion', 'service', 'protocol', 'port', 'port_forward', 'rich_rule', - 'interface', 'masquerade', 'source', 'target'] + 'interface', 'forward', 'masquerade', 'source', 'target'] ], ) @@ -842,6 +897,7 @@ def main(): immediate = module.params['immediate'] timeout = module.params['timeout'] interface = module.params['interface'] + forward = module.params['forward'] masquerade = module.params['masquerade'] offline = module.params['offline'] @@ -905,7 +961,7 @@ def main(): modification = False if any([icmp_block, icmp_block_inversion, service, protocol, port, port_forward, rich_rule, - interface, masquerade, source, target]): + interface, forward, masquerade, source, target]): modification = True if modification and desired_state in ['absent', 'present'] and target is None: module.fail_json( @@ -1072,6 +1128,29 @@ def main(): changed, transaction_msgs = transaction.run() msgs = msgs + transaction_msgs + if forward is not None: + # Type of forward will be changed to boolean in a future release. + forward_status = False + try: + forward_status = boolean(forward, False) + except TypeError: + module.warn('The value of the forward option is "%s". ' + 'The type of the option will be changed from string to boolean in a future release. ' + 'To avoid unexpected behavior, please change the value to boolean.' % forward) + + expected_state = 'enabled' if (desired_state == 'enabled') == forward_status else 'disabled' + transaction = ForwardTransaction( + module, + action_args=(), + zone=zone, + desired_state=expected_state, + permanent=permanent, + immediate=immediate, + ) + + changed, transaction_msgs = transaction.run() + msgs = msgs + transaction_msgs + if masquerade is not None: # Type of masquerade will be changed to boolean in a future release. masquerade_status = True diff --git a/plugins/modules/firewalld_info.py b/plugins/modules/firewalld_info.py index c83437d..c34a362 100644 --- a/plugins/modules/firewalld_info.py +++ b/plugins/modules/firewalld_info.py @@ -21,7 +21,7 @@ options: zones: description: - Gather information about specific zones. - - If only works if C(active_zones) is set to C(false). + - If only works if O(active_zones=false). required: false type: list elements: str diff --git a/plugins/modules/mount.py b/plugins/modules/mount.py index 318844b..dadbd46 100644 --- a/plugins/modules/mount.py +++ b/plugins/modules/mount.py @@ -24,75 +24,80 @@ options: path: description: - Path to the mount point (e.g. C(/mnt/files)). - - Before Ansible 2.3 this option was only usable as I(dest), I(destfile) and I(name). + - Before Ansible 2.3 this option was only usable as O(ignore:dest), O(ignore:destfile), and O(name). type: path required: true aliases: [ name ] src: description: - Device (or NFS volume, or something else) to be mounted on I(path). - - Required when I(state) set to C(present), C(mounted) or C(ephemeral). - - Ignored when I(state) set to C(absent) or C(unmounted). + - Required when O(state) set to V(present), V(mounted), or V(ephemeral). + - Ignored when O(state) set to V(absent) or V(unmounted). type: path fstype: description: - Filesystem type. - - Required when I(state) is C(present), C(mounted) or C(ephemeral). + - Required when O(state) is V(present), V(mounted), or V(ephemeral). type: str opts: description: - Mount options (see fstab(5), or vfstab(4) on Solaris). type: str + opts_no_log: + description: + - Do not log opts. + type: bool + default: false dump: description: - Dump (see fstab(5)). - - Note that if set to C(null) and I(state) set to C(present), + - Note that if set to C(null) and O(state=present), it will cease to work and duplicate entries will be made with subsequent runs. - - Has no effect on Solaris systems or when used with C(ephemeral). + - Has no effect on Solaris systems or when used with O(state=ephemeral). type: str default: '0' passno: description: - Passno (see fstab(5)). - - Note that if set to C(null) and I(state) set to C(present), + - Note that if set to C(null) and O(state=present), it will cease to work and duplicate entries will be made with subsequent runs. - - Deprecated on Solaris systems. Has no effect when used with C(ephemeral). + - Deprecated on Solaris systems. Has no effect when used with O(state=ephemeral). type: str default: '0' state: description: - - If C(mounted), the device will be actively mounted and appropriately + - If V(mounted), the device will be actively mounted and appropriately configured in I(fstab). If the mount point is not present, the mount point will be created. - - If C(unmounted), the device will be unmounted without changing I(fstab). - - C(present) only specifies that the device is to be configured in + - If V(unmounted), the device will be unmounted without changing I(fstab). + - V(present) only specifies that the device is to be configured in I(fstab) and does not trigger or require a mount. - - C(ephemeral) only specifies that the device is to be mounted, without changing + - V(ephemeral) only specifies that the device is to be mounted, without changing I(fstab). If it is already mounted, a remount will be triggered. - This will always return changed=True. If the mount point I(path) - has already a device mounted on, and its source is different than I(src), + This will always return RV(ignore:changed=true). If the mount point O(path) + has already a device mounted on, and its source is different than O(src), the module will fail to avoid unexpected unmount or mount point override. If the mount point is not present, the mount point will be created. The I(fstab) is completely ignored. This option is added in version 1.5.0. - - C(absent) specifies that the mount point entry I(path) will be removed + - V(absent) specifies that the mount point entry O(path) will be removed from I(fstab) and will also unmount the mounted device and remove the - mount point. A mounted device will be unmounted regardless of I(src) or its - real source. C(absent) does not unmount recursively, and the module will + mount point. A mounted device will be unmounted regardless of O(src) or its + real source. V(absent) does not unmount recursively, and the module will fail if multiple devices are mounted on the same mount point. Using - C(absent) with a mount point that is not registered in the I(fstab) has - no effect. Use C(unmounted) instead.. - - C(remounted) specifies that the device will be remounted for when you + V(absent) with a mount point that is not registered in the I(fstab) has + no effect, use V(unmounted) instead. + - V(remounted) specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will - always return changed=true. If I(opts) is set, the options will be + always return RV(ignore:changed=true). If O(opts) is set, the options will be applied to the remount, but will not change I(fstab). Additionally, - if I(opts) is set, and the remount command fails, the module will - error to prevent unexpected mount changes. Try using C(mounted) - instead to work around this issue. C(remounted) expects the mount point + if O(opts) is set, and the remount command fails, the module will + error to prevent unexpected mount changes. Try using V(mounted) + instead to work around this issue. V(remounted) expects the mount point to be present in the I(fstab). To remount a mount point not registered - in I(fstab), use C(ephemeral) instead, especially with BSD nodes. - - C(absent_from_fstab) specifies that the device mount's entry will be + in I(fstab), use V(ephemeral) instead, especially with BSD nodes. + - V(absent_from_fstab) specifies that the device mount's entry will be removed from I(fstab). This option does not unmount it or delete the mountpoint. type: str @@ -105,20 +110,20 @@ options: - This might be useful if you need to configure mountpoints in a chroot environment. - OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem. - - This parameter defaults to /etc/fstab or /etc/vfstab on Solaris. - - This parameter is ignored when I(state) is set to C(ephemeral). + - This parameter defaults to C(/etc/fstab) or C(/etc/vfstab) on Solaris. + - This parameter is ignored when O(state=ephemeral). type: str boot: description: - Determines if the filesystem should be mounted on boot. - Only applies to Solaris and Linux systems. - For Solaris systems, C(true) will set C(yes) as the value of mount at boot - in I(/etc/vfstab). + in C(/etc/vfstab). - For Linux, FreeBSD, NetBSD and OpenBSD systems, C(false) will add C(noauto) - to mount options in I(/etc/fstab). - - To avoid mount option conflicts, if C(noauto) specified in C(opts), - mount module will ignore C(boot). - - This parameter is ignored when I(state) is set to C(ephemeral). + to mount options in C(/etc/fstab). + - To avoid mount option conflicts, if C(noauto) specified in O(opts), + mount module will ignore O(boot). + - This parameter is ignored when O(state=ephemeral). type: bool default: true backup: @@ -128,9 +133,9 @@ options: type: bool default: false notes: - - As of Ansible 2.3, the I(name) option has been changed to I(path) as - default, but I(name) still works as well. - - Using C(remounted) with I(opts) set may create unexpected results based on + - As of Ansible 2.3, the O(name) option has been changed to O(path) as + default, but O(name) still works as well. + - Using O(state=remounted) with O(opts) set may create unexpected results based on the existing options already defined on mount, so care should be taken to ensure that conflicting options are not present before hand. ''' @@ -209,6 +214,7 @@ EXAMPLES = r''' src: //192.168.1.200/share path: /mnt/smb_share opts: "rw,vers=3,file_mode=0600,dir_mode=0700,dom={{ ad_domain }},username={{ ad_username }},password={{ ad_password }}" + opts_no_log: true fstype: cifs state: ephemeral ''' @@ -768,6 +774,7 @@ def main(): fstype=dict(type='str'), path=dict(type='path', required=True, aliases=['name']), opts=dict(type='str'), + opts_no_log=dict(type='bool', default=False), passno=dict(type='str', no_log=False, default='0'), src=dict(type='path'), backup=dict(type='bool', default=False), @@ -781,6 +788,9 @@ def main(): ), ) + if module.params['opts_no_log']: + module.no_log_values.add(module.params['opts']) + # solaris args: # name, src, fstype, opts, boot, passno, state, fstab=/etc/vfstab # linux args: @@ -840,11 +850,8 @@ def main(): args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'noauto'.") elif not module.params['boot']: args['boot'] = 'no' - if 'defaults' in opts: - args['warnings'].append("Ignore the 'boot' due to 'opts' contains 'defaults'.") - else: - opts.append('noauto') - args['opts'] = ','.join(opts) + opts.append('noauto') + args['opts'] = ','.join(opts) # If fstab file does not exist, we first need to create it. This mainly # happens when fstab option is passed to the module. diff --git a/plugins/modules/patch.py b/plugins/modules/patch.py index ecedbf6..39744a7 100644 --- a/plugins/modules/patch.py +++ b/plugins/modules/patch.py @@ -24,7 +24,7 @@ options: basedir: description: - Path of a base directory in which the patch file will be applied. - - May be omitted when C(dest) option is specified, otherwise required. + - May be omitted when O(dest) option is specified, otherwise required. type: path dest: description: @@ -37,7 +37,7 @@ options: src: description: - Path of the patch file as accepted by the GNU patch tool. If - C(remote_src) is C(false), the patch source file is looked up from the + O(remote_src=false), the patch source file is looked up from the module's I(files) directory. type: path required: true @@ -50,8 +50,8 @@ options: default: present remote_src: description: - - If C(false), it will search for src at originating/controller machine, if C(true) it will - go to the remote/target machine for the C(src). + - If V(false), it will search for src at originating/controller machine, + - If C(true), it will go to the remote/target machine for the O(src). type: bool default: false strip: @@ -68,15 +68,15 @@ options: default: false binary: description: - - Setting to C(true) will disable patch's heuristic for transforming CRLF + - Setting to V(true) will disable patch's heuristic for transforming CRLF line endings into LF. - - Line endings of src and dest must match. - - If set to C(false), C(patch) will replace CRLF in C(src) files on POSIX. + - Line endings of O(src) and O(dest) must match. + - If set to V(false), C(patch) will replace CRLF in O(src) files on POSIX. type: bool default: false ignore_whitespace: description: - - Setting to C(true) will ignore white space changes between patch and input. + - Setting to V(true) will ignore white space changes between patch and input. type: bool default: false notes: diff --git a/plugins/modules/rhel_facts.py b/plugins/modules/rhel_facts.py index a30622a..d0c5927 100644 --- a/plugins/modules/rhel_facts.py +++ b/plugins/modules/rhel_facts.py @@ -13,7 +13,7 @@ module: rhel_facts version_added: 1.5.0 short_description: Facts module to set or override RHEL specific facts. description: - - Compatibility layer for using the "package" module for rpm-ostree based systems via setting the "pkg_mgr" fact correctly. + - Compatibility layer for using the M(ansible.builtin.package) module for rpm-ostree based systems via setting the C(pkg_mgr) fact correctly. author: - Adam Miller (@maxamillion) requirements: diff --git a/plugins/modules/rhel_rpm_ostree.py b/plugins/modules/rhel_rpm_ostree.py index 0976e02..0aafb54 100644 --- a/plugins/modules/rhel_rpm_ostree.py +++ b/plugins/modules/rhel_rpm_ostree.py @@ -25,12 +25,12 @@ requirements: options: name: description: - - A package name or package specifier with version, like C(name-1.0). - - Comparison operators for package version are valid here C(>), C(<), C(>=), C(<=). Example - C(name>=1.0) + - A package name or package specifier with version, like V(name-1.0). + - Comparison operators for package version are valid here C(>), C(<), C(>=), C(<=). Example - C(name>=1.0). - If a previous version is specified, the task also needs to turn C(allow_downgrade) on. See the C(allow_downgrade) documentation for caveats with downgrading packages. - - When using state=latest, this can be C('*') which means run C(yum -y update). - - You can also pass a url or a local path to a rpm file (using state=present). + - When using O(state=latest), this can be V('*') which means run C(yum -y update). + - You can also pass a url or a local path to a rpm file (using O(state=present)). To operate on several packages this can accept a comma separated string of packages or (as of 2.0) a list of packages. aliases: [ pkg ] type: list @@ -38,12 +38,12 @@ options: default: [] state: description: - - Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package. - - C(present) and C(installed) will simply ensure that a desired package is installed. - - C(latest) will update the specified package if it's not of the latest available version. - - C(absent) and C(removed) will remove the specified package. - - Default is C(None), however in effect the default action is C(present) unless the C(autoremove) option is - enabled for this module, then C(absent) is inferred. + - 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's not of the latest available version. + - V(absent) and V(removed) will remove the specified package. + - Default is C(null), however in effect the default action is V(present) unless the C(autoremove) option is + enabled for this module, then V(absent) is inferred. type: str choices: [ absent, installed, latest, present, removed ] notes: diff --git a/plugins/modules/seboolean.py b/plugins/modules/seboolean.py index 1e73aef..8580c62 100644 --- a/plugins/modules/seboolean.py +++ b/plugins/modules/seboolean.py @@ -22,12 +22,12 @@ options: type: str persistent: description: - - Set to C(true) if the boolean setting should survive a reboot. + - Set to V(true) if the boolean setting should survive a reboot. type: bool default: false state: description: - - Desired boolean value + - Desired boolean value. type: bool required: true ignore_selinux_state: diff --git a/plugins/modules/selinux.py b/plugins/modules/selinux.py index 0609462..41c51d0 100644 --- a/plugins/modules/selinux.py +++ b/plugins/modules/selinux.py @@ -20,7 +20,7 @@ version_added: "1.0.0" options: policy: description: - - The name of the SELinux policy to use (e.g. C(targeted)) will be required if I(state) is not C(disabled). + - The name of the SELinux policy to use (e.g. C(targeted)) will be required unless O(state=disabled). type: str state: description: @@ -30,7 +30,7 @@ options: type: str update_kernel_param: description: - - If set to I(true), will update also the kernel boot parameters when disabling/enabling SELinux. + - If set to V(true), will update also the kernel boot parameters when disabling/enabling SELinux. - The C(grubby) tool must be present on the target system for this to work. default: false type: bool diff --git a/plugins/modules/synchronize.py b/plugins/modules/synchronize.py index 3d8d0fe..d65e08f 100644 --- a/plugins/modules/synchronize.py +++ b/plugins/modules/synchronize.py @@ -14,12 +14,13 @@ DOCUMENTATION = r''' module: synchronize short_description: A wrapper around rsync to make common tasks in your playbooks quick and easy description: - - C(synchronize) is a wrapper around rsync to make common tasks in your playbooks quick and easy. + - M(ansible.posix.synchronize) is a wrapper around C(rsync) to make common tasks in your playbooks quick and easy. - It is run and originates on the local host where Ansible is being run. - - Of course, you could just use the C(command) action to call rsync yourself, but you also have to add a fair number of + - Of course, you could just use the M(ansible.builtin.command) action to call C(rsync) yourself, but you also have to add a fair number of boilerplate options and host facts. - - This module is not intended to provide access to the full power of rsync, but does make the most common - invocations easier to implement. You `still` may need to call rsync directly via C(command) or C(shell) depending on your use case. + - This module is not intended to provide access to the full power of C(rsync), but does make the most common + invocations easier to implement. + You I(still) may need to call C(rsync) directly via M(ansible.builtin.command) or M(ansible.builtin.shell) depending on your use case. version_added: "1.0.0" options: src: @@ -37,27 +38,27 @@ options: dest_port: description: - Port number for ssh on the destination host. - - Prior to Ansible 2.0, the ansible_ssh_port inventory var took precedence over this value. + - Prior to Ansible 2.0, the C(ansible_ssh_port) inventory var took precedence over this value. - This parameter defaults to the value of C(ansible_port), the C(remote_port) config setting or the value from ssh client configuration if none of the former have been set. type: int mode: description: - Specify the direction of the synchronization. - - In push mode the localhost or delegate is the source. - - In pull mode the remote host in context is the source. + - In V(push) mode the localhost or delegate is the source. + - In V(pull) mode the remote host in context is the source. type: str choices: [ pull, push ] default: push archive: description: - - Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D. + - Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags, and C(-D). type: bool default: true checksum: description: - - Skip based on checksum, rather than mod-time & size; Note that that "archive" option is still enabled by default - the "checksum" option will - not disable it. + - Skip based on checksum, rather than mod-time & size; Note that that O(archive) option is still enabled by default - + the O(checksum) option will not disable it. type: bool default: false compress: @@ -73,8 +74,8 @@ options: default: false delete: description: - - Delete files in I(dest) that do not exist (after transfer, not before) in the I(src) path. - - This option requires I(recursive=true). + - Delete files in O(dest) that do not exist (after transfer, not before) in the O(src) path. + - This option requires O(recursive=true). - This option ignores excluded files and behaves like the rsync opt C(--delete-after). type: bool default: false @@ -130,17 +131,17 @@ options: default: 0 set_remote_user: description: - - Put user@ for the remote paths. + - Put C(user@) for the remote paths. - If you have a custom ssh config to define the remote user for a host - that does not match the inventory user, you should set this parameter to C(false). + that does not match the inventory user, you should set this parameter to V(false). type: bool default: true ssh_connection_multiplexing: description: - SSH connection multiplexing for rsync is disabled by default to prevent misconfigured ControlSockets from resulting in failed SSH connections. This is accomplished by setting the SSH C(ControlSocket) to C(none). - - Set this option to C(true) to allow multiplexing and reduce SSH connection overhead. - - Note that simply setting this option to C(true) is not enough; + - Set this option to V(true) to allow multiplexing and reduce SSH connection overhead. + - Note that simply setting this option to V(true) is not enough; You must also configure SSH connection multiplexing in your SSH client config by setting values for C(ControlMaster), C(ControlPersist) and C(ControlPath). type: bool @@ -182,7 +183,7 @@ options: use_ssh_args: description: - In Ansible 2.10 and lower, it uses the ssh_args specified in C(ansible.cfg). - - In Ansible 2.11 and onwards, when set to C(true), it uses all SSH connection configurations like + - In Ansible 2.11 and onwards, when set to V(true), it uses all SSH connection configurations like C(ansible_ssh_args), C(ansible_ssh_common_args), and C(ansible_ssh_extra_args). type: bool default: false @@ -200,31 +201,31 @@ options: type: bool default: false _ssh_args: - description: Internal use only. See C(use_ssh_args) for ssh arg settings. + description: Internal use only. See O(use_ssh_args) for ssh arg settings. type: str required: false notes: - - rsync must be installed on both the local and remote host. - - For the C(synchronize) module, the "local host" is the host `the synchronize task originates on`, and the "destination host" is the host - `synchronize is connecting to`. - - The "local host" can be changed to a different host by using `delegate_to`. This enables copying between two remote hosts or entirely on one - remote machine. + - C(rsync) must be installed on both the local and remote host. + - For the M(ansible.posix.synchronize) module, the "local host" is the host I(the synchronize task originates on), + and the "destination host" is the host I(synchronize is connecting to). + - The "local host" can be changed to a different host by using C(delegate_to). + This enables copying between two remote hosts or entirely on one remote machine. - > - The user and permissions for the synchronize `src` are those of the user running the Ansible task on the local host (or the remote_user for a - delegate_to host when delegate_to is used). + The user and permissions for the synchronize O(src) are those of the user running the Ansible task on the local host (or the remote_user for a + C(delegate_to) host when C(delegate_to) is used). - The user and permissions for the synchronize `dest` are those of the `remote_user` on the destination host or the `become_user` if `become=yes` is active. - In Ansible 2.0 a bug in the synchronize module made become occur on the "local host". This was fixed in Ansible 2.0.1. - - Currently, synchronize is limited to elevating permissions via passwordless sudo. This is because rsync itself is connecting to the remote machine - and rsync doesn't give us a way to pass sudo credentials in. + - Currently, M(ansible.posix.synchronize) is limited to elevating permissions via passwordless sudo. + This is because rsync itself is connecting to the remote machine and rsync doesn't give us a way to pass sudo credentials in. - Currently there are only a few connection types which support synchronize (ssh, paramiko, local, and docker) because a sync strategy has been determined for those connection types. Note that the connection for these must not need a password as rsync itself is making the connection and rsync does not provide us a way to pass a password to the connection. - - Expect that dest=~/x will be ~/x even if using sudo. + - Expect that O(dest=~/x) will be V(~/x) even if using sudo. - Inspect the verbose output to validate the destination user/host/path are what was expected. - To exclude files and directories from being synchronized, you may add C(.rsync-filter) files to the source directory. - rsync daemon must be up and running with correct permission when using rsync protocol in source or destination path. - - The C(synchronize) module enables `--delay-updates` by default to avoid leaving a destination in a broken in-between state if the underlying rsync process + - The C(synchronize) module enables C(--delay-updates) by default to avoid leaving a destination in a broken in-between state if the underlying rsync process encounters an error. Those synchronizing large numbers of files that are willing to trade safety for performance should disable this option. - link_destination is subject to the same limitations as the underlying rsync daemon. Hard links are only preserved if the relative subtrees of the source and destination are the same. Attempts to hardlink into a directory that is a subdirectory of the source will be prevented. diff --git a/plugins/modules/sysctl.py b/plugins/modules/sysctl.py index c016d09..77fc392 100644 --- a/plugins/modules/sysctl.py +++ b/plugins/modules/sysctl.py @@ -19,7 +19,7 @@ version_added: "1.0.0" options: name: description: - - The dot-separated path (also known as I(key)) specifying the sysctl variable. + - The dot-separated path (also known as O(key)) specifying the sysctl variable. required: true aliases: [ 'key' ] type: str @@ -41,9 +41,9 @@ options: default: false reload: description: - - If C(true), performs a I(/sbin/sysctl -p) if the C(sysctl_file) is - updated. If C(false), does not reload I(sysctl) even if the - C(sysctl_file) is updated. + - If V(true), performs a C(/sbin/sysctl -p) if the O(sysctl_file) is + updated. If V(false), does not reload C(sysctl) even if the + O(sysctl_file) is updated. type: bool default: true sysctl_file: @@ -53,7 +53,7 @@ options: type: path sysctl_set: description: - - Verify token value with the sysctl command and set with -w if necessary. + - Verify token value with the sysctl command and set with C(-w) if necessary. type: bool default: false author: diff --git a/tests/integration/targets/authorized_key/defaults/main.yml b/tests/integration/targets/authorized_key/defaults/main.yml index 1b60f8c..7ec99ca 100644 --- a/tests/integration/targets/authorized_key/defaults/main.yml +++ b/tests/integration/targets/authorized_key/defaults/main.yml @@ -35,3 +35,5 @@ multiple_keys_comments: | ssh-rsa DATA_BASIC 1@testing # I like adding comments yo-dude-this-is-not-a-key INVALID_DATA 2@testing ecdsa-sha2-nistp521 ECDSA_DATA 4@testing + +key_path: /tmp/id_rsa.pub diff --git a/tests/integration/targets/authorized_key/tasks/check_path.yml b/tests/integration/targets/authorized_key/tasks/check_path.yml new file mode 100644 index 0000000..df5d46e --- /dev/null +++ b/tests/integration/targets/authorized_key/tasks/check_path.yml @@ -0,0 +1,32 @@ +--- +- name: Create key file for test + ansible.builtin.copy: + dest: "{{ key_path }}" + content: "{{ rsa_key_basic }}" + mode: "0600" + +- name: Add key using path + ansible.posix.authorized_key: + user: root + key: file://{{ key_path }} + state: present + path: "{{ output_dir | expanduser }}/authorized_keys" + register: result + +- name: Assert that the key was added + ansible.builtin.assert: + that: + - result.changed == true + +- name: Add key using path again + ansible.posix.authorized_key: + user: root + key: file://{{ key_path }} + state: present + path: "{{ output_dir | expanduser }}/authorized_keys" + register: result + +- name: Assert that no changes were applied + ansible.builtin.assert: + that: + - result.changed == false diff --git a/tests/integration/targets/authorized_key/tasks/main.yml b/tests/integration/targets/authorized_key/tasks/main.yml index 6a22838..d687f17 100644 --- a/tests/integration/targets/authorized_key/tasks/main.yml +++ b/tests/integration/targets/authorized_key/tasks/main.yml @@ -31,3 +31,6 @@ - name: Test for the management of comments with key ansible.builtin.import_tasks: comments.yml + +- name: Test for specifying key as a path + ansible.builtin.import_tasks: check_path.yml diff --git a/tests/integration/targets/firewalld/tasks/source_test_cases.yml b/tests/integration/targets/firewalld/tasks/source_test_cases.yml index a2552d5..8b76521 100644 --- a/tests/integration/targets/firewalld/tasks/source_test_cases.yml +++ b/tests/integration/targets/firewalld/tasks/source_test_cases.yml @@ -83,5 +83,6 @@ ansible.builtin.assert: that: - result is not changed - - "result.msg == - 'parameters are mutually exclusive: icmp_block|icmp_block_inversion|service|protocol|port|port_forward|rich_rule|interface|masquerade|source|target'" + - > + result.msg == 'parameters are mutually exclusive: + icmp_block|icmp_block_inversion|service|protocol|port|port_forward|rich_rule|interface|forward|masquerade|source|target' diff --git a/tests/integration/targets/firewalld/tasks/zone_test_cases.yml b/tests/integration/targets/firewalld/tasks/zone_test_cases.yml index 753dd18..abb7b0f 100644 --- a/tests/integration/targets/firewalld/tasks/zone_test_cases.yml +++ b/tests/integration/targets/firewalld/tasks/zone_test_cases.yml @@ -23,6 +23,55 @@ that: - result is not changed +- name: Zone forwarding test + when: (ansible_distribution == 'RedHat' and ansible_distribution_major_version is version('8', '>=')) + block: + - name: Enable zone forwarding + ansible.posix.firewalld: + zone: custom + forward: true + permanent: true + state: enabled + register: result + + - name: Assert zone forwarding is enabled + ansible.builtin.debug: + var: result is changed + + - name: Enable zone forwarding (verify not changed) + ansible.posix.firewalld: + zone: custom + forward: true + permanent: true + state: enabled + register: result + + - name: Assert zone forwarding is enabled (verify not changed) + ansible.builtin.debug: + var: result is not changed + + - name: Disable zone forwarding + ansible.posix.firewalld: + zone: custom + forward: false + permanent: true + state: enabled + + - name: Assert zone forwarding is disabled + ansible.builtin.debug: + var: result is changed + + - name: Disable zone forwarding (verify not changed) + ansible.posix.firewalld: + zone: custom + forward: false + permanent: true + state: enabled + + - name: Assert zone forwarding is disabled (verify not changed) + ansible.builtin.debug: + var: result is not changed + - name: Firewalld remove zone custom ansible.posix.firewalld: zone: custom diff --git a/tests/integration/targets/mount/tasks/main.yml b/tests/integration/targets/mount/tasks/main.yml index 58eace8..bb91648 100644 --- a/tests/integration/targets/mount/tasks/main.yml +++ b/tests/integration/targets/mount/tasks/main.yml @@ -472,6 +472,25 @@ path: /tmp/myfs state: absent + - name: Mount the FS with noauto option and defaults + ansible.posix.mount: + path: /tmp/myfs + src: /tmp/myfs.img + fstype: ext3 + state: mounted + boot: false + register: mount_info + + - name: Assert the mount without noauto was successful + ansible.builtin.assert: + that: + - "'noauto' in mount_info['opts'].split(',')" + + - name: Unmount FS + ansible.posix.mount: + path: /tmp/myfs + state: absent + - name: Remove the test FS ansible.builtin.file: path: '{{ item }}' @@ -739,3 +758,53 @@ - /tmp/myfs_A.img - /tmp/myfs_B.img - /tmp/myfs + +- name: Block to test opts_no_log option + when: ansible_system == 'Linux' + block: + - name: Create an empty file + community.general.filesize: + path: /tmp/myfs.img + size: 1M + - name: Format FS + community.general.filesystem: + fstype: ext4 + dev: /tmp/myfs.img + - name: Mount the FS with opts_no_log option true + ansible.posix.mount: + path: /tmp/myfs + src: /tmp/myfs.img + fstype: ext4 + state: mounted + opts: rw + opts_no_log: true + register: mount_info + - name: Assert opts_no_log option true + ansible.builtin.assert: + that: + - mount_info.opts == 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER' + - name: Remount the FS with opts_no_log option false + ansible.posix.mount: + path: /tmp/myfs + src: /tmp/myfs.img + fstype: ext4 + state: remounted + opts: rw,user + opts_no_log: false + register: mount_info + - name: Assert opts_no_log option false + ansible.builtin.assert: + that: + - mount_info.opts == 'rw,user' + always: + - name: Unmount FS + ansible.posix.mount: + path: /tmp/myfs + state: absent + - name: Remove the test FS + ansible.builtin.file: + path: '{{ item }}' + state: absent + loop: + - /tmp/myfs.img + - /tmp/myfs diff --git a/tests/sanity/ignore-2.18.txt b/tests/sanity/ignore-2.18.txt new file mode 100644 index 0000000..3cf68c0 --- /dev/null +++ b/tests/sanity/ignore-2.18.txt @@ -0,0 +1 @@ +tests/utils/shippable/timing.py shebang diff --git a/tests/sanity/ignore-2.19.txt b/tests/sanity/ignore-2.19.txt new file mode 100644 index 0000000..3cf68c0 --- /dev/null +++ b/tests/sanity/ignore-2.19.txt @@ -0,0 +1 @@ +tests/utils/shippable/timing.py shebang