gnt-job(8)

📦
version 3.1.0~rc2 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute

gnt-job(8) — job commands, but make it ✨aesthetic✨

okay so bestie, welcome to gnt-job, which lives in the Ganeti manual (that's version 3.1.0~rc2, if you're keeping score 💅). This is the command you pull up when you wanna examine and manipulate the job queue. Like, the whole queue. Your queue. Our queue. 💖

🌸 SYNOPSIS 🌸

gnt-job {command} [arguments...]

🦋 DESCRIPTION 🦋

So gnt-job is literally the tool for examining and manipulating the job queue. That's it, that's the vibe. Every command you could want over your jobs? It's in here, babe. 🫶

👑 COMMANDS 👑

🎀 ARCHIVE

archive {job-id...}

Use this to archive jobs by their IDs. Big caveat though: it only works on jobs that have finished execution — meaning jobs that are either success, error, or canceled. No archiving the still-alive ones, she's not done yet 💀

🎀 AUTOARCHIVE

autoarchive {age | all}

Archive jobs by their age, bestie. You can archive everything older than age seconds, or — if you're feeling chaotic and want it all gone — pass the string all and every finished job gets archived. Spring cleaning era. 🧹✨

🎀 CANCEL

cancel
{[--force] [--kill] {--pending | --queued | --waiting} |
 *job-id* ...}

Cancels the job(s) you point at with a job id. Important: only jobs that haven't started running yet can be canceled — so, jobs in either the queued or waiting state. Wanna skip the confirmation prompt? Pass --force. 😌

--queued and waiting cancel all the jobs in that respective state, and --pending includes both of them together. One flag, two states, so efficient.

🚨 danger zone alert 🚨 If you give the --kill option, jobs get killed — even ones in the running state, and in that case it uses SIGKILL. This is dangerous, because the job never gets a chance to do any clean up, so it will most likely leave any objects it touched in an inconsistent state. Not a slay. Do not do this casually. 💀

🎀 CHANGE-PRIORITY

change-priority --priority {low | normal | high}
{[--force] {--pending | --queued | --waiting} | job-id...}

Changes the priority of one or multiple pending jobs. For jobs that are currently running, only the priority of the remaining opcodes gets changed — not the whole thing. --priority is mandatory, you must specify it, no vibes-only mode. 🌈

--queued and waiting re-prioritize all the jobs in the respective state, and --pending includes both. And --force skips the confirmation, because sometimes you're just that sure. 💅

🎀 INFO

info {job-id...}

Shows detailed information about the given job id(s). And if you give it no job id at all? It examines all the jobs. Warning though — that is a lot of information. Like, a lot a lot. Buckle up. 😭

🎀 LIST

list [--no-headers] [--separator=*SEPARATOR*]
[-o [+]FIELD,...] [--filter] [job-id...]

Lists the jobs and their status. By default you get the job id, the job status, and a small job description — but bestie, you can select extra parameters if you want more.

  • --no-headers — skips that initial header line.
  • --separator — takes an argument saying what gets used between the output fields.

Both of those are there to help with scripting. 🤖

The -o option takes a comma-separated list of output fields. Here's every available field and what it means:

  • archived — Whether job is archived
  • end_ts — Timestamp of job end (tuple containing seconds and microseconds)
  • id — Job ID
  • opend — List of opcode execution end timestamps
  • opexec — List of opcode execution start timestamps (after acquiring locks)
  • oplog — List of opcode output logs
  • oppriority — List of opcode priorities
  • opresult — List of opcodes results
  • ops — List of all opcodes
  • opstart — List of opcode start timestamps (before acquiring locks)
  • opstatus — List of opcodes status
  • priority — Current job priority (19 to -20)
  • received_ts — Timestamp of when job was received (tuple containing seconds and microseconds)
  • start_ts — Timestamp of job start (tuple containing seconds and microseconds)
  • status — Job status
  • summary — List of per-opcode summaries

Oh and life hack: if the value of the option starts with the character +, the new fields get added to the default list. So you can peep the default list plus a few extras without retyping the entire field list every single time. Obsessed with this actually. 😌✨

Wanna include archived jobs in the list? Use the --archived option. 🫶

Now, to show only specific jobs, you've got these:

  • --pending — Show only jobs pending execution.
  • --running — Show jobs currently running only.
  • --error — Show failed jobs only.
  • --finished — Show finished jobs only.

And if exactly one argument is given and it looks like a query filter (peep ganeti(7) for that), the query result gets filtered accordingly. For the ambiguous cases (like, say, a single field name being used as a filter), the --filter (-F) option forces that argument to be treated as a filter. No ambiguity, periodt. 💅

🎀 LIST-FIELDS

list-fields [field...]

Lists all the available fields for jobs. Simple, iconic, does exactly what it says. ⭐

🎀 WAIT

wait {job-id}

Waits for the job with the given job-id to finish. And produces no output while doing it. Silent. Mysterious. Main character energy. 🤫

🎀 WATCH

watch {job-id}

Follows the output of the job with the given job-id and prints it. It's giving live commentary. 📺✨

😭 REPORTING BUGS

Found a bug? Report it to the project's issue tracker, or hit up the developers using the Ganeti mailing list. They wanna hear it, fr fr. 🫶

🌈 SEE ALSO 🌈

Ganeti overview and specifications: ganeti(7) (general overview), ganeti-os-interface(7) (guest OS definitions), ganeti-extstorage-interface(7) (external storage providers).

Ganeti commands: gnt-cluster(8) (cluster-wide commands), gnt-job(8) (job-related commands), gnt-node(8) (node-related commands), gnt-instance(8) (instance commands), gnt-os(8) (guest OS commands), gnt-storage(8) (storage commands), gnt-group(8) (node group commands), gnt-backup(8) (instance import/export commands), gnt-debug(8) (debug commands).

Ganeti daemons: ganeti-watcher(8) (automatic instance restarter), ganeti-cleaner(8) (job queue cleaner), ganeti-noded(8) (node daemon), ganeti-rapi(8) (remote API daemon).

Ganeti htools: htools(1) (generic binary), hbal(1) (cluster balancer), hspace(1) (capacity calculation), hail(1) (IAllocator plugin), hscan(1) (data gatherer from remote clusters), hinfo(1) (cluster information printer), mon-collector(7) (data collectors interface).

Copyright (C) 2006-2015 Google Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page bestie 💖 This is the gnt-job(8) page from the Ganeti manual, version 3.1.0~rc2 — go manage those jobs, you absolute icon. 🎀✨🦋💅

📦 where this page comes from