Skip to content

Commit

Permalink
Merge pull request #34214 from rallytime/fix-33879
Browse files Browse the repository at this point in the history
Update saltutil.wheel docs to specify remote vs local minion behavior
  • Loading branch information
Mike Place committed Jun 22, 2016
2 parents 4205fd6 + 1be05f6 commit b5ea149
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions salt/modules/saltutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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']),
Expand Down

0 comments on commit b5ea149

Please sign in to comment.