pstat

Summary:

pstat gives command line access to the jobs database. It can be used to:

  • List job info by:
    • Job id
    • Modification time
    • If still active
    • Database column and regex
      • Possible columns can be determined from the -f output
    • Grouped series of continuation jobs, or ungrouped
  • Continue (re-submit) ‘Auto’ jobs
  • Mark jobs as ‘Complete’ or ‘Incomplete’
  • Abort running jobs
  • Add/modify an error message
  • Delete jobs from the database (and abort if currently running)

--help documentation:

Print or modify prisms-jobs job and task status.

By default, ‘pstat’ prints status for select jobs. Jobs are selected by listing jobids or using –all, –range, or –recent, optionally combined with –active. Running ‘pstat’ with no selection is equivalent to selecting ‘–all –active’. The default display style is a summary list. Other options are –full or –series.

Using one of –complete, –continue, –error, –abort, or –delete modifies status instead of printing. User confirmation is required before a modification is applied, unless the –force option is given.

Job status is as given by prisms-jobs for a single job (‘C’, ‘R’, ‘Q’, etc.).

Task status is user-defined and defines the status of a single job within a possible series of jobs comprising some task. ‘Auto’ jobs may be re-submitted with the –continue option.

Jobs are marked ‘auto’ either by submitting through the python class prisms_jobs.Job with the attribute auto=True, or by submitting a script which contains the line #auto=True via psub.

Possible values for task status are:

”Complete” Job and task are complete.
”Incomplete” Job or task are incomplete.
”Continued” Job is complete, but task was not complete.
”Check” Non-auto job is complete and requires user input for status.
”Error:.*” Some kind of error was noted.
”Aborted” The job and task have been aborted.

usage: pstat [-h] [-f | -s]
             [-a | --range MINID MAXID | --recent DD:HH:MM:SS | --regex KEY REGEX]
             [--active]
             [--complete | --continue | --reset | --abort | --error ERRMSG | --delete | --key KEY]
             [--force]
             [JOBID [JOBID ...]]

Positional Arguments

JOBID Job IDs to query or operate on

Named Arguments

-f, --full

List all fields instead of summary

Default: False

-s, --series

List all fields grouped by continuation jobs

Default: False

-a, --all

Select all jobs in database

Default: False

--range A range of Job IDs (inclusive) to query or operate on
--recent Select jobs created or modified within given amout of time
--regex Select jobs where the value of column ‘KEY’ matches the regular expression ‘REGEX’.
--active

Select active jobs only. May be combined with –range and –recent

Default: False

--complete

Mark jobs as ‘Complete’

Default: False

--continue

Re-submit auto jobs

Default: False

--reset

Mark job as ‘Incomplete’

Default: False

--abort

Call qdel on job and mark as ‘Aborted’

Default: False

--error Add error message.
--delete

Delete jobs from database. Aborts jobs that are still running.

Default: False

--key Output data corresponding to ‘key’ for selected jobs.
--force

Modify jobs without user confirmation

Default: False