summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbhijeet Kasurde <akasurde@redhat.com>2018-10-30 00:34:32 +0530
committerToshio Kuratomi <a.badger@gmail.com>2018-11-12 19:25:01 -0800
commit709845436e5a1d7ea36a7dfb397aa7b66081d1f2 (patch)
treea0a44efc612c1f65d863a249d05219fafd2fa9d3
parent50e6361c3f9143d0a85c05e91c4d16eb858ac2b7 (diff)
downloadansible-709845436e5a1d7ea36a7dfb397aa7b66081d1f2.tar.gz
Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 6d36849f72efe868af05361576f55d66627ec653)
-rw-r--r--changelogs/fragments/46665-plugin_filter_doc_fix.yaml2
-rw-r--r--docs/docsite/rst/user_guide/plugin_filtering_config.rst9
2 files changed, 9 insertions, 2 deletions
diff --git a/changelogs/fragments/46665-plugin_filter_doc_fix.yaml b/changelogs/fragments/46665-plugin_filter_doc_fix.yaml
new file mode 100644
index 0000000000..af18205cde
--- /dev/null
+++ b/changelogs/fragments/46665-plugin_filter_doc_fix.yaml
@@ -0,0 +1,2 @@
+minor_changes:
+- Update plugin filter documentation.
diff --git a/docs/docsite/rst/user_guide/plugin_filtering_config.rst b/docs/docsite/rst/user_guide/plugin_filtering_config.rst
index 04fb0d368d..fd5a3e9349 100644
--- a/docs/docsite/rst/user_guide/plugin_filtering_config.rst
+++ b/docs/docsite/rst/user_guide/plugin_filtering_config.rst
@@ -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.