Skip to content

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.
phenix job [flags]

Options

  -h, --help   help for job

SEE ALSO

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.
phenix job cancel <ID> [flags]

Options

      --dry-run   Show what the command would change, and change nothing
  -h, --help      help for cancel

SEE ALSO

phenix job get

Show a background job and the outcome of each item

phenix job get <ID> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format (table, json, yaml) (default "table")

SEE ALSO

phenix job list

List background jobs, newest first

phenix job list [flags]

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 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.
phenix job wait <ID> [flags]

Examples

# Wait at most 10 minutes
phenix job wait j0f3a9c2e81b4d7a6 --timeout 10m

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