diff --git a/README.md b/README.md index a9d30cd..a0f2041 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,36 @@ []() +An Ansible Collection of modules and plugins that target POSIX UNIX/Linux and derivative Operating Systems. + +## Supported Versions of Ansible + +## Ansible version compatibility -## Tested with Ansible +This collection has been tested against following Ansible versions: **>=2.9,<2.11**. - - -* ansible-base 2.10 (devel) - -## External requirements - -None +Plugins and modules within a collection may be tested with only specific Ansible versions. +A collection may contain metadata that identifies these versions. +PEP440 is the schema used to describe the versions of Ansible. + ## Included content - + +### Modules +Name | Description +--- | --- +[ansible.posix.acl](https://github.com/ansible-collections/ansible.posix/blob/master/docs/ansible.posix.acl_module.rst)|Set and retrieve file ACL information. +[ansible.posix.at](https://github.com/ansible-collections/ansible.posix/blob/master/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/master/docs/ansible.posix.authorized_key_module.rst)|Adds or removes an SSH authorized key +[ansible.posix.mount](https://github.com/ansible-collections/ansible.posix/blob/master/docs/ansible.posix.mount_module.rst)|Control active and configured mount points +[ansible.posix.patch](https://github.com/ansible-collections/ansible.posix/blob/master/docs/ansible.posix.patch_module.rst)|Apply patch files using the GNU patch tool +[ansible.posix.seboolean](https://github.com/ansible-collections/ansible.posix/blob/master/docs/ansible.posix.seboolean_module.rst)|Toggles SELinux booleans +[ansible.posix.selinux](https://github.com/ansible-collections/ansible.posix/blob/master/docs/ansible.posix.selinux_module.rst)|Change policy and state of SELinux +[ansible.posix.synchronize](https://github.com/ansible-collections/ansible.posix/blob/master/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/master/docs/ansible.posix.sysctl_module.rst)|Manage entries in sysctl.conf. + + ## Installing this collection @@ -60,6 +76,18 @@ Please read and familiarize yourself with this document. * 0.1.1 Initial stable build * 0.1.0 Internal only build +## External requirements + +None + +## Tested with Ansible + + + +* ansible-base 2.11 (devel) +* ansible-base 2.10 (Beta) +* ansible-base 2.9 (stable) + ## Roadmap @@ -77,4 +105,4 @@ Please read and familiarize yourself with this document. GNU General Public License v3.0 or later. -See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. +See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. \ No newline at end of file diff --git a/docs/ansible.posix.acl_module.rst b/docs/ansible.posix.acl_module.rst new file mode 100644 index 0000000..b5b0fe7 --- /dev/null +++ b/docs/ansible.posix.acl_module.rst @@ -0,0 +1,345 @@ +.. _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 + +
| Key | +Returned | +Description | +
|---|---|---|
|
+
+ acl
+
+
+ list
+
+ |
+ success | +
+ Current ACL on provided path (after changes, if any)
+ + Sample:
+ ['user::rwx', 'group::rwx', 'other::rwx']
+ |
+