mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 08:58:59 +00:00
Document new cmd_sync, cmd_async RunnerClient methods
Also de-emphasize the direct master_call method. Since master_call is inconsistent between RunnerClient and WheelClient we should instead present a single, consistent interface.
This commit is contained in:
parent
35833ab294
commit
6e40307efc
@ -88,7 +88,7 @@ RunnerClient
|
||||
------------
|
||||
|
||||
.. autoclass:: salt.runner.RunnerClient
|
||||
:members:
|
||||
:members: cmd, async, cmd_sync, cmd_async
|
||||
|
||||
WheelClient
|
||||
-----------
|
||||
|
@ -208,18 +208,6 @@ class RunnerClient(object):
|
||||
def master_call(self, **kwargs):
|
||||
'''
|
||||
Execute a runner function through the master network interface (eauth).
|
||||
|
||||
This function requires that :conf_master:`external_auth` is configured
|
||||
and the user is authorized to execute runner functions: (``@runner``).
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
runner.master_call(
|
||||
fun='jobs.list_jobs',
|
||||
username='saltdev',
|
||||
password='saltdev',
|
||||
eauth='pam'
|
||||
)
|
||||
'''
|
||||
load = kwargs
|
||||
load['cmd'] = 'runner'
|
||||
|
Loading…
Reference in New Issue
Block a user