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

Update saltutil.wheel docs to specify remote vs local minion behavior

Browse source 
Fixes #33879
This commit is contained in:
rallytime 2016-06-22 11:44:46 -06:00
parent 3413c494bd
commit 1be05f6a87
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
salt/modules/saltutil.py
View file

@ -1107,7 +1107,8 @@ def runner(_fun, **kwargs):
def wheel(_fun, *args, **kwargs):
'''
Execute a wheel module (this function must be run on the master)
Execute a wheel module and function. This function must be run against a
minion that is local to the master.
.. versionadded:: 2014.7.0
@ -1127,7 +1128,17 @@ def wheel(_fun, *args, **kwargs):
.. code-block:: bash
salt '*' saltutil.wheel key.accept jerry
salt my-local-minion saltutil.wheel key.accept jerry
salt my-local-minion saltutil.wheel minions.connected
.. note::
Since this function must be run against a minion that is running locally
on the master in order to get accurate returns, if this function is run
against minions that are not local to the master, "empty" returns are
expected. The remote minion does not have access to wheel functions and
their return data.
'''
if __opts__['__role'] == 'minion':
master_config = os.path.join(os.path.dirname(__opts__['conf_file']),