valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix job_return -> return_job example typo

Browse Source
This commit is contained in:
Seth House 2015-02-11 09:24:28 -07:00
parent 03b44c3650
commit d7cf05d7a8
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
salt/utils/schedule.py
View File

@ -163,15 +163,16 @@ code-block:: yaml
By default, data about jobs runs from the Salt scheduler is not returned to the
master. Because of this information for these jobs will not be listed in the
jobs.list_jobs runner. The return_job parameter will return the data back to
the Salt master, making the job available in this list.
:py:func:`jobs.list_jobs <salt.runners.jobs.list_jobs>` runner. The
``return_job`` parameter will return the data back to the Salt master, making
the job available in this list.
... versionadded:: Lithium
schedule:
job1:
function: scheduled_job_function
job_return: True
return_job: True
It can be useful to include specific data to differentiate a job from other
jobs. Using the metadata parameter special values can be associated with