From e51ddfa2a3eb377cd2d6b41b64776e9fc36c2024 Mon Sep 17 00:00:00 2001 From: Mike Place Date: Fri, 18 Mar 2016 12:14:56 -0600 Subject: [PATCH] Adjust docs for saltutil.runner Closes #31850 --- salt/modules/saltutil.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/salt/modules/saltutil.py b/salt/modules/saltutil.py index 3a668d2fa8..0400538d27 100644 --- a/salt/modules/saltutil.py +++ b/salt/modules/saltutil.py @@ -952,7 +952,9 @@ def cmd_iter(tgt, def runner(_fun, **kwargs): ''' - Execute a runner module (this function must be run on the master) + Execute a runner function. This function must be run on the master, + either by targeting a minion running on a master or by using + salt-call on a master. .. versionadded:: 2014.7.0 @@ -963,9 +965,12 @@ def runner(_fun, **kwargs): CLI Example: + In this example, assume that `master_minion` is a minion running + on a master. + .. code-block:: bash - salt '*' saltutil.runner jobs.list_jobs + salt master_minion saltutil.runner jobs.list_jobs ''' kwargs = salt.utils.clean_kwargs(**kwargs)