BKR-SYSTEM-LIST(1)

💅 bkr-system-list — the bkr manual, bestie edition 🎀

okay so you opened the manual page for bkr-system-list from Beaker and honestly? iconic of you. let's get into it 🫶

✨ NAME ✨

bkr-system-list — like, it lists Beaker systems. that's the whole vibe. 🌸

✨ SYNOPSIS ✨

bkr system-list [options]
  [--available | --free | --mine]
  [--type <type>] [--status <status>] [--pool <pool>]
  [--arch <arch>] [--dev-vendor-id <vendorid>]
  [--dev-device-id <deviceid>] [--dev-driver <driver>]
  [--dev-description <description>] [--dev-sub-vendor-id <subvendorid>]
  [--dev-sub-device-id <subdeviceid>]

yes bestie, that's a lot of brackets. it's giving "choose your own adventure" 💅

✨ DESCRIPTION ✨

it prints to stdout a list of all the matching systems in Beaker. that's it. that's the whole thing. no cap. ✨

✨ OPTIONS ✨

okay this is the part where we go through every single flag because we do not skip, we do not summarize, we are thorough queens 👑

• --available — limits the list to systems that would actually be available to be scheduled by the current user. so basically it kicks out any system whose access policy would stop you from running jobs on it.

heads up bestie 💀 this does not exclude systems currently occupied by other users. for that you want --free. don't mix these up, i'm begging.

• --free — same energy as --available, but it only includes systems that can be scheduled right now. like, right this second. no waiting. 🏃‍♀️
• --removed — limits the list to systems that have been marked as Removed. rip to those systems 😭
• --mine — limits the list to systems owned by the current user. main character energy only 👑

the tea: --available, --free, and --mine are mutually exclusive. pick one. you cannot have all three. the audacity, i know. 💅

• --type <type> — limits to systems of type <type>. most users are gonna want to filter for the Machine type. like, that's the one. fr fr.
• --status <status> — limits to systems whose status is <status>. for example Automated, Manual, or Broken. yes, Broken is a real status. we don't judge. 🫶
• --pool <pool> — limits to systems that are in <pool>.
• --group <group> — compatibility alias for --pool. same thing, different name. it's giving "i go by both" 💖
• --arch <arch> — limits to systems of arch <arch>.
• --dev-vendor-id <vendorid> — limits to systems that have a device with <vendorid>.
• --dev-device-id <deviceid> — limits to systems that have a device with <deviceid>.
• --dev-sub-vendor-id <subvendorid> — limits to systems that have a device with <subvendorid>.
• --dev-sub-device-id <subdeviceid> — limits to systems that have a device with <subdeviceid>.
• --dev-driver <driver> — limits to systems that have a device with <driver>.
• --dev-description <description> — limits to systems that have a device with <description>.
• --xml-filter <xml> — limits to systems that match the given XML filter criteria. it supports the same criteria as inside the <hostRequires/> element in Beaker job XML. fancy, i know 🎀
• --host-filter <name> — limits to systems that match the given pre-defined host filter. go read the description of the --host-filter workflow option in bkr(1) for the details, i'm not doing all the work for you (affectionate) 💜

and btw, the common bkr options are described in the Options section of bkr(1). you know where to find them 🦋

✨ EXIT STATUS ✨

non-zero on error, otherwise zero.

⚠️ okay important one: if no systems match the given criteria, that's considered an error, and the exit status will be 1. so if you get a 1, it doesn't necessarily mean something exploded — it might just mean nothing matched. no cap. 🔥

✨ EXAMPLES ✨

ok so say you wanna list automated systems that are in the kernel-hw pool and are not currently in use. look at her go:

bkr system-list --free --type=Machine --status=Automated --pool=kernel-hw

slay. ate. periodt. 🍓

✨ SEE ALSO ✨

• bkr(1) — go read it, bestie 💖

✨ AUTHOR ✨

The Beaker team <beaker-devel@lists.fedorahosted.org> 🧚

✨ COPYRIGHT ✨

2013-2025 Red Hat, Inc. — like, they've been at this a while and we respect it 👑

---

🌸 that's the whole page! this was bkr-system-list(1) from the Beaker 29.2 manual, dated May 26, 2025 — ty for reading bestie, now go list some systems 💅✨🫶