Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update plugin filter documentation #46665

Merged
merged 1 commit into from
Oct 29, 2018
Merged

Update plugin filter documentation #46665

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/docsite/rst/user_guide/plugin_filtering_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ Plugin Filter Configuration

Ansible 2.5 adds the ability for a site administrator to blacklist modules that they do not want to
be available to Ansible. This is configured via a yaml configuration file (by default,
:file:`/etc/ansible/plugin_filters.yml`). The format of the file is:
:file:`/etc/ansible/plugin_filters.yml`). Use ``plugin_filters_cfg`` configuration
in ``defaults`` section to change this configuration file path. The format of the file is:

.. code-block:: YAML

Expand All @@ -20,7 +21,11 @@ be available to Ansible. This is configured via a yaml configuration file (by de
The file contains two fields:

* a version so that it will be possible to update the format while keeping backwards
compatibility in the future The present version should be the string, ``"1.0"``
compatibility in the future. The present version should be the string, ``"1.0"``

* a list of modules to blacklist. Any module listed here will not be found by Ansible when it
searches for a module to invoke for a task.

.. note::

The ``stat`` module is required for Ansible to run. So, please make sure you do not add this module in a blacklist modules list.