Permalink
Browse files

Add some examples to jobs doc

  • Loading branch information...
1 parent 93bacd1 commit 285e82d104114afcac7e695e3e08fd3beee3cb62 @thatch45 thatch45 committed May 30, 2012
Showing with 12 additions and 0 deletions.
  1. +12 −0 doc/topics/jobs/index.rst
View
@@ -61,6 +61,10 @@ The active function will also compare jobs that have returned and jobs that
are still running, making it easier to see what systems have completed a job
and what systems are still being waited on.
+.. code-block:: bash
+
+ # salt-run jobs.active
+
lookup_jid
----------
@@ -70,9 +74,17 @@ By default is is cached for 24 hours, but this can be configured via the
Using the lookup_jid runner will display the same return data that the initial
job invocation with the salt command would display.
+.. code-block:: bash
+
+ # salt-run jobs.lookup_jid <job id number>
+
list_jobs
---------
Before finding a historic job, it may be required to find the job id. list_jobs
will parse the cached execution data and display all of the job data for jobs
that have already, or partially returned.
+
+.. code-block:: bash
+
+ # salt-run jobs.list_jobs

0 comments on commit 285e82d

Please sign in to comment.