cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update plugin filter documentation (#46665)

Browse source 
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 6d36849f72)
This commit is contained in:
Abhijeet Kasurde 2018-10-30 00:34:32 +05:30 committed by Toshio Kuratomi
parent 50e6361c3f
commit 709845436e
2 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/46665-plugin_filter_doc_fix.yaml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- Update plugin filter documentation.

9
docs/docsite/rst/user_guide/plugin_filtering_config.rst
View file

@ -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
@ -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.