Skip to content

Latest commit

 

History

History
114 lines (73 loc) · 4.57 KB

README.md

File metadata and controls

114 lines (73 loc) · 4.57 KB
Raw

ansible.posix

Build Status Run Status

Communication

Description

An Ansible Collection of modules and plugins that target POSIX UNIX/Linux and derivative Operating Systems.

Requirements

  • Python:
    • The Python interpreter version must meet Ansible Core's requirements.
  • Ansible Core:
    • ansible-core 2.15 or later

Installation

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install ansible.posix

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

collections:
  - name: ansible.posix

Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install ansible.posix --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.0.0:

ansible-galaxy collection install ansible.posix:==1.0.0

See using Ansible collections for more details.

For more information about communication, see the Ansible communication guide.

Use Cases

You can see the general use-cases as an example by ansible-doc command like below.

For example, ansible.posix.firewalld module:

ansible-doc ansible.posix.firewalld

Also, if you want to confirm the plugins descriptions, you can follow the following option with ansible-doc command:

For example, ansible.posix.profile_tasks callback plugin:

ansible-doc -t callback ansible.posix.profile_tasks

Testing

The following ansible-core versions have been tested with this collection:

  • 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)

Contributing

We welcome community contributions to this collection. For more details, see Contributing to Ansible-maintained collections for complete details.

Support

See Communication section.

Release Notes and Roadmap

See changelog for more details.

Related Information

This document was written using the following template.

The README has been carefully prepared to cover the community template, but if you find any problems, please file a documentation issue.

License Information

GNU General Public License v3.0 or later.

See COPYING to see the full text.