phenix job¶
Every command on this page also accepts the global flags.
phenix job¶
Background job management
Synopsis¶
Background job management
Lists, follows and cancels the background jobs of the running phenix ui
server (bulk VM actions, experiment file archives, disk clones), over its
unix socket (--unix-socket), which acts as Global Admin and sees every
user's jobs. Jobs live in that server's memory only, and are started from
the web UI or the REST API: the CLI's own VM and disk commands run in the
CLI process and are not jobs.
Options¶
SEE ALSO¶
- phenix - A cli application for phēnix
- phenix job cancel - Cancel a background job
- phenix job get - Show a background job and the outcome of each item
- phenix job list - List background jobs, newest first
- phenix job wait - Wait for a background job to finish
phenix job cancel¶
Cancel a background job
Synopsis¶
Cancel a background job
A queued job is canceled at once. A running VM action job stops after the
VMs in progress; archive and clone jobs stop at once and leave no file. Use
phenix job wait to see it end. With --dry-run, phenix gets the job, shows
the cancel that it would request, and requests nothing.
Options¶
SEE ALSO¶
- phenix job - Background job management
phenix job get¶
Show a background job and the outcome of each item
Options¶
SEE ALSO¶
- phenix job - Background job management
phenix job list¶
List background jobs, newest first
Examples¶
# Every job the server holds
phenix job list
# Running and queued jobs of one experiment, as JSON
phenix job list --experiment exp1 --active -o json
Options¶
--active only jobs queued or running
--experiment string only the jobs of this experiment
-h, --help help for list
--kind string only jobs of this kind (vms.action, files.archive, disk.clone, experiments.start, experiments.trigger, experiments.periodic)
-o, --output string Output format (table, json, yaml) (default "table")
SEE ALSO¶
- phenix job - Background job management
phenix job wait¶
Wait for a background job to finish
Synopsis¶
Wait for a background job to finish
Asks the server for the job every second until it finishes, then prints it.
Exits 0 when it succeeded, 2 when it ended partial (some items succeeded and
others did not), and 1 when it failed or was canceled, or when waiting
failed or timed out.
Examples¶
Options¶
-h, --help help for wait
-o, --output string Output format (table, json, yaml) (default "table")
--timeout duration give up after this long (0 waits until the job finishes)
SEE ALSO¶
- phenix job - Background job management