Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 6d36849f72
)
This commit is contained in:
parent
50e6361c3f
commit
709845436e
2 changed files with 9 additions and 2 deletions
2
changelogs/fragments/46665-plugin_filter_doc_fix.yaml
Normal file
2
changelogs/fragments/46665-plugin_filter_doc_fix.yaml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
minor_changes:
|
||||||
|
- Update plugin filter documentation.
|
|
@ -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
|
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,
|
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
|
.. 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:
|
The file contains two fields:
|
||||||
|
|
||||||
* a version so that it will be possible to update the format while keeping backwards
|
* 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
|
* 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.
|
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.
|
||||||
|
|
Loading…
Reference in a new issue