- --cwd=DIRECTORY
Set job working directory.
- --urgency=N
Specify job urgency. N has a range of 0 to 16 for guest users, 0 to 31 for instance owners, and a default value of 16. In addition to numerical values, the following special names are accepted:
- hold (0)
Hold the job until the urgency is raised with
flux job urgency
.- default (16)
The default urgency for all users.
- expedite (31)
Assign the highest possible priority to the job (restricted to instance owner).
Urgency is one factor used to calculate job priority, which affects the order in which the scheduler considers jobs. By default, priority is calculated from the urgency and the time elapsed since job submission. This calculation may be overridden by configuration. For example, in a multi-user Flux instance with the Flux accounting priority plugin loaded, the calculation includes other factors such as past usage and bank allocations.
A job with an urgency value of 0 is treated specially: it is never considered by the scheduler and is effectively held. Similarly, a job with an urgency of 31 is always assigned the maximum priority, regardless of other factors and is considered expedited.
flux jobs -o deps
lists jobs with urgency and priority fields.
- -v, --verbose
Increase verbosity on stderr. For example, currently
flux run -v
displays jobid,-vv
displays job events, and-vvv
displays exec events.flux alloc -v
forces the command to print the submitted jobid on stderr. The specific output may change in the future.
- -o, --setopt=KEY[=VAL]
Set shell option. Keys may include periods to denote hierarchy. VAL is optional and may be valid JSON (bare values, objects, or arrays), otherwise VAL is interpreted as a string. If VAL is not set, then the default value is 1. See `SHELL OPTIONS`_ below.
- --setattr=KEY[=VAL]
Set jobspec attribute. Keys may include periods to denote hierarchy. If KEY does not begin with
system.
,user.
, or.
, thensystem.
is assumed. VAL is optional and may be valid JSON (bare values, objects, or arrays), otherwise VAL is interpreted as a string. If VAL is not set, then the default value is 1. If KEY starts with a^
character, then VAL is interpreted as a file, which must be valid JSON, to use as the attribute value.
- --add-file=[NAME=]ARG
Add a file to the RFC 37 file archive in jobspec before submission. Both the file metadata and content are stored in the archive, so modification or deletion of a file after being processed by this option will have no effect on the job. If no
NAME
is provided, thenARG
is assumed to be the path to a local file and the basename of the file will be used asNAME
. Otherwise, ifARG
contains a newline, then it is assumed to be the raw file data to encode. The file will be extracted by the job shell into the job temporary directory and may be referenced as{{tmpdir}}/NAME
on the command line, or$FLUX_JOB_TMPDIR/NAME
in a batch script. This option may be specified multiple times to encode multiple files. Note: As documented in RFC 14, the file namesscript
andconf.json
are both reserved.Note
This option should only be used for small files such as program input parameters, configuration, scripts, and so on. For broadcast of large files, binaries, and directories, the flux-shell(1)
stage-in
plugin will be more appropriate.
- --begin-time=+FSD|DATETIME
Convenience option for setting a
begin-time
dependency for a job. The job is guaranteed to start after the specified date and time. If argument begins with a+
character, then the remainder is considered to be an offset in Flux standard duration (RFC 23), otherwise, any datetime expression accepted by the Python parsedatetime module is accepted, e.g.2021-06-21 8am
,in an hour
,tomorrow morning
, etc.
- --signal=SIG@TIME
Send signal
SIG
to jobTIME
before the job time limit.SIG
can specify either an integer signal number or a full or abbreviated signal name, e.g.SIGUSR1
orUSR1
or10
.TIME
is specified in Flux Standard Duration, e.g.30
for 30s or1h
for 1 hour. Either parameter may be omitted, with defaults ofSIGUSR1
and 60s. For example,--signal=USR2
will sendSIGUSR2
to the job 60 seconds before expiration, and--signal=@3m
will sendSIGUSR1
3 minutes before expiration. Note that ifTIME
is greater than the remaining time of a job as it starts, the job will be signaled immediately.The default behavior is to not send any warning signal to jobs.
- --dry-run
Don't actually submit job. Just emit jobspec on stdout and exit for
run
,submit
,alloc
, andbatch
. Forbulksubmit
, emit a line of output including relevant options for each job which would have been submitted,
- --debug
Enable job debug events, primarily for debugging Flux itself. The specific effects of this option may change in the future.