saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

noted that __virtual__ can return False and an error string

Browse source
This commit is contained in:
Jacob Hammons 2015-10-07 09:48:46 -06:00
parent b928e1afa8
commit 75cc07cf10
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/ref/modules/index.rst
View file

@ -158,13 +158,13 @@ Virtual module names are set using the ``__virtual__`` function and the
``__virtual__`` Function
========================
The ``__virtual__`` function
returns either a :ref:`string <python2:typesseq>`, :py:data:`True`, or
:py:data:`False`. If a string is returned then the module is loaded using the
name of the string as the virtual name. If ``True`` is returned the module is
loaded using the current module name. If ``False`` is returned the module is not loaded.
``False`` lets the module perform system checks and prevent loading if dependencies
are not met.
The ``__virtual__`` function returns either a :ref:`string <python2:typesseq>`,
:py:data:`True`, :py:data:`False`, or :py:data:`False` with an :ref:`error
string <modules-error-info>`. If a string is returned then the module is loaded
using the name of the string as the virtual name. If ``True`` is returned the
module is loaded using the current module name. If ``False`` is returned the
module is not loaded. ``False`` lets the module perform system checks and
prevent loading if dependencies are not met.
Since ``__virtual__`` is called before the module is loaded, ``__salt__`` will be
unavailable as it will not have been packed into the module at this point in time.
@ -173,6 +173,8 @@ unavailable as it will not have been packed into the module at this point in tim
Modules which return a string from ``__virtual__`` that is already used by a module that
ships with Salt will _override_ the stock module.
.. _modules-error-info:
Returning Error Information from ``__virtual__``
------------------------------------------------