Jobs¶
Support for the core Tapis jobs life cycle is provided by the jobs command set. New, and of note, is support for wildcard include and exclude filters when downloading job outputs, as well as a “sync” mode that only retrieves files from Tapis if they are different from their local copy.
General Commands¶
jobs list¶
List Jobs
tapis jobs list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
Replaces legacy CLI command “jobs-list”
jobs show¶
Show a specific Job
tapis jobs show [-T] JOB_UUID
-
-T
,
--template
¶
Job template from verbose
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-list”
jobs submit¶
Submit a new Job
tapis jobs submit [-F FILEPATH] [--ini FILEPATH]
-
-F
FILEPATH
,
--file
FILEPATH
¶ JSON payload file
-
--ini
FILEPATH
¶ .ini file (project.ini)
Replaces legacy CLI command “jobs-submit”
jobs status¶
how the status of a Job
tapis jobs status JOB_UUID
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-status”
jobs history¶
List history of a given job
tapis jobs history [--sort-ascending | --sort-descending] JOB_UUID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-history”
jobs cancel¶
Cancel a running or queued Job
tapis jobs cancel JOB_UUID
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-stop”
jobs resubmit¶
Resubmit a Job using the same inputs and parameters
tapis jobs resubmit JOB_UUID
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-resubmit”
Output Commands¶
View and download outputs from Tapis jobs.
jobs outputs download¶
Download outputs from a Job
tapis jobs outputs download
[--force | --sync]
[--exclude GLOB]
[--progress]
[--cwd]
JOB_UUID
[FILEPATH]
-
--force
¶
Always overwrite existing files
-
--sync
¶
Overwrite files only when timestamp or size differs
-
--exclude
GLOB
¶ Unix-style fileglob (specify multiple times)
-
--progress
¶
Report progress to STDERR
-
--cwd
¶
Download to ‘.’ instead of a job-specific subdirectory
-
JOB_UUID
¶
Job unique identifer
-
FILEPATH
¶
File path relative to output directory
Replaces legacy CLI command “jobs-output-get”
jobs outputs list¶
Lists output directory for a Jobs
tapis jobs outputs list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
[--all]
[--reverse]
[--sort-size | --sort-time]
JOB_UUID
[FILEPATH]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
--all
¶
Include hidden files
-
--reverse
¶
Reverse sort order.
-
--sort-size
¶
Sort by size before sorting lexicographically.
-
--sort-time
¶
Sort by time modified before sorting lexicographically.
-
JOB_UUID
¶
Job unique identifer
-
FILEPATH
¶
File path relative to output directory
Replaces legacy CLI command “jobs-output-list”
Sharing Commands¶
Manage access by other users to Tapis jobs that you control.
jobs pems drop¶
Drop all granted Permissions from a Job
tapis jobs pems drop
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
JOB_UUID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-pems-update”
jobs pems grant¶
Grant Permissions on a Job to a User
tapis jobs pems grant
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
JOB_UUID
USERNAME
PERMISSION
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
JOB_UUID
¶
Job unique identifer
-
USERNAME
¶
Tapis username
-
PERMISSION
¶
Permission string (ALL| READ| WRITE| READ_WRITE| EXECUTE| READ_EXECUTE| WRITE_EXECUTE| NONE)
Replaces legacy CLI command “jobs-pems-update”
jobs pems list¶
List Permissions for a Job
tapis jobs pems list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
JOB_UUID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
JOB_UUID
¶
Job unique identifer
Replaces legacy CLI command “jobs-pems-list”
jobs pems revoke¶
Revoke Permissions on a Job for a User
tapis jobs pems revoke
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
JOB_UUID
USERNAME
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
JOB_UUID
¶
Job unique identifer
-
USERNAME
¶
Tapis username
Replaces legacy CLI command “jobs-pems-update”
Search Commands¶
Search for Tapis Jobs by any of several criteria. Please consult
tapis jobs search -h
for guidance.
Templated Jobs¶
The jobs init
command can populate a job definition for the designated Tapis app. It can
run automatically, relying on default values provided by the app, or interactively, which allows
the user to specify each value.
jobs init¶
Create a Job document for the specified App
tapis jobs init
[--sort-ascending | --sort-descending]
[--interactive]
[--all]
[--name NAME]
[--queue QUEUE]
[--duration HH:MM:SS]
[--nodes INT]
[--no-archive | --archive-uri AGAVE_URI]
[--no-notify | --notifications-uri URI|EMAIL]
[-O PATH]
APP_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--interactive
¶
Prompt for configuration and parameters
-
--all
¶
Include optional inputs and parameters in template
-
--name
NAME
¶ Job name
-
--queue
QUEUE
¶ Queue
-
--duration
HH:MM:SS
¶ Maximum run time (01:00:00)
-
--nodes
INT
¶ Compute nodes (1)
-
--no-archive
¶
Do not archive results
-
--archive-uri
AGAVE_URI
¶ Path to archive results (agave://)
-
--no-notify
¶
Do not send job status notifications
-
--notifications-uri
URI|EMAIL
¶ POST URL or email address for notifications
-
-O
PATH
,
--output
PATH
¶ Output destination (STDOUT)
-
APP_ID
¶
App identifier
Replaces legacy CLI command “jobs-template”