salt.runners.jobs

A convenience system to manage jobs, both active and already run

salt.runners.jobs.active(outputter=None, display_progress=False)

Return a report on all actively running jobs from a job id centric perspective

CLI Example:

salt-run jobs.active
salt.runners.jobs.list_job(jid, ext_source=None, outputter=None)

List a specific job given by its jid

CLI Example:

salt-run jobs.list_job 20130916125524463507
salt.runners.jobs.list_jobs(ext_source=None, outputter=None, search_metadata=None, search_function=None, search_target=None, display_progress=False)

List all detectable jobs and associated functions

CLI Example:

salt-run jobs.list_jobs
salt.runners.jobs.lookup_jid(jid, ext_source=None, missing=False, outputter=None, display_progress=False)

Return the printout from a previously executed job

jid
The jid to look up.
ext_source
The external job cache to use. Default: None.
missing
When set to True, adds the minions that did not return from the command. Default: False.
display_progress

Displays progress events when set to True. Default: False.

New in version 2015.5.0.

CLI Example:

salt-run jobs.lookup_jid 20130916125524463507
salt-run jobs.lookup_jid 20130916125524463507 outputter=highstate
salt.runners.jobs.print_job(jid, ext_source=None, outputter=None)

Print a specific job's detail given by it's jid, including the return data.

CLI Example:

salt-run jobs.print_job 20130916125524463507