flux-queue(1)
SYNOPSIS
DESCRIPTION
The flux queue command operates on Flux job queue(s).
By default, Flux has one anonymous queue. Multiple named queues may be configured - see flux-config-queues(5).
COMMANDS
flux queue has the following subcommands:
list
List queue defaults and limits.
- -n, --no-header
Do not output column headers in
listoutput.
- -o, --format=FORMAT
Specify output format in
listusing Python's string format syntax. See OUTPUT FORMAT below for field names.
status
Report the current queue status.
- -q, --queue=NAME
Select a queue by name.
- -v, --verbose
Display more detail about internal job manager state.
disable
Prevent jobs from being submitted to the queue, with a reason that is shown to submitting users.
- -q, --queue=NAME
Select a queue by name.
- -a, --all
Select all queues.
- -v, --verbose
Display more detail about internal job manager state.
- --quiet
Display only errors.
- --nocheckpoint
Do not preserve the new queue stop state across a Flux instance restart.
enable
Allow jobs to be submitted to the queue.
- -q, --queue=NAME
Select a queue by name.
- -a, --all
Select all queues.
- -v, --verbose
Display more detail about internal job manager state.
- --quiet
Display only errors.
stop
Stop allocating resources to jobs. Pending jobs remain enqueued, and running jobs continue to run, but no new jobs are allocated resources.
- -q, --queue=NAME
Select a queue by name.
- -a, --all
Select all queues.
- -v, --verbose
Display more detail about internal job manager state.
- --quiet
Display only errors.
- --nocheckpoint
Do not preserve the new queue stop state across a Flux instance restart.
start
Start allocating resources to jobs.
- -q, --queue=NAME
Select a queue by name.
- -a, --all
Select all queues.
- -v, --verbose
Display more detail about internal job manager state.
- --quiet
Display only errors.
drain
Block until all queues become empty. It is sometimes useful to run after flux queue disable, to wait until the system is quiescent and can be taken down for maintenance.
- --timeout=FSD
Limit the time that the command` will block.
idle
Block until all queues become idle (no jobs in RUN or CLEANUP state, and no outstanding alloc requests to the scheduler). It may be useful to run after flux queue stop to wait until the scheduler and execution system are quiescent before maintenance involving them.
- --timeout=FSD
Limit the time that the command` will block.
OUTPUT FORMAT
The flux queue list --format option can be used to specify an
output format using Python's string format syntax or a defined format by
name. For a list of built-in and configured formats use -o help.
An alternate default format can be set via the
FLUX_QUEUE_LIST_FORMAT_DEFAULT environment variable.
A configuration snippet for an existing named format may be
generated with --format=get-config=NAME. See flux-jobs(1)
OUTPUT FORMAT section for a detailed description of this syntax.
The following field names can be specified:
- queue
queue name
- queuem
queue name, but default queue is marked up with an asterisk
- defaults.timelimit
default timelimit for jobs submitted to the queue
- limits.timelimit
max timelimit for jobs submitted to the queue
- limits.range.nnodes
range of nodes that can be requested for this queue
- limits.range.ncores
range of cores that can be requested for this queue
- limits.range.ngpus
range of gpus that can be requested for this queue
- limits.min.nnodes
minimum number of nodes that must be requested for this queue
- limits.max.nnodes
maximum number of nodes that can be requested for this queue
- limits.min.ncores
minimum number of cores that must be requested for this queue
- limits.max.ncores
maximum number of cores that can be requested for this queue
- limits.min.ngpus
minimum number of gpus that must be requested for this queue
- limits.max.ngpus
maximum number of gpus that can be requested for this queue
RESOURCES
Flux: http://flux-framework.org
Flux RFC: https://flux-framework.readthedocs.io/projects/flux-rfc