Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Jun 22, 2016
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions salt/modules/saltutil.py
View file
Open in desktop
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