Update local module options (#57553)

* Docs: Point out that local plugins can be loaded based on ansible.cfg settings
pull/57971/head
Ken Celenza 5 years ago committed by Alicia Cozine
parent 9364b4c933
commit 1a63f8642e

@ -72,13 +72,13 @@ Ansible loads plugins automatically too, loading each type of plugin separately
* test_plugins*
* vars_plugins
You can create or add a local plugin in any of these locations:
To load your local plugins automatically, create or add them in any of these locations:
* any directory added to the relevant ``ANSIBLE_plugin_type_PLUGINS`` environment variable (these variables, such as ``$ANSIBLE_INVENTORY_PLUGINS`` and ``$ANSIBLE_VARS_PLUGINS`` take colon-separated lists like ``$PATH``)
* the directory named for the correct ``plugin_type`` within ``~/.ansible/plugins/`` - for example, ``~/.ansible/plugins/callback``
* the directory named for the correct ``plugin_type`` within ``/usr/share/ansible/plugins/`` - for example, ``/usr/share/ansible/plugins/action``
Once your plugin file is in one of these locations, Ansible will load it and you can use it in a any local module, task, playbook, or role.
Once your plugin file is in one of these locations, Ansible will load it and you can use it in a any local module, task, playbook, or role. Alternatively, you can edit your ``ansible.cfg`` file to add directories that contain local plugins - see :ref:`ansible_configuration_settings` for details.
To confirm that ``plugins/plugin_type/my_custom_plugin`` is available:

Loading…
Cancel
Save