BKR-LIST-SYSTEMS(1)

🌸 NAME 🌸

okay bestie, welcome to bkr-list-systems(1) — the Beaker manual page for the command you actually type, bkr system-list. Its whole personality? List Beaker systems. That’s the assignment, and it ate. 💅

✨ SYNOPSIS ✨

Here’s the shape of it, no cap:

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>]

🦋 DESCRIPTION 🦋

It prints to stdout a list of all matching systems in Beaker. Like, every system that matches your filters, served straight to stdout. Iconic behavior, honestly. ✨

💖 OPTIONS 💖

• --available — Limit to systems which would be available to be scheduled by the current user. This will exclude any systems whose access policy prevent the current user from running jobs on them. Important vibe check: this does not exclude systems which are currently occupied by other users. Use --free for that.
• --free — Like --available, but only includes systems which can be scheduled right now.
• --removed — Limit to systems which have been marked as Removed.
• --mine — Limit to systems which are owned by the current user.

🚨 Mutually exclusive alert: the --available, --free, and --mine options are mutually exclusive. Pick one, bestie, don’t make it weird. 💀

• --type <type> — Limit to systems of type <type>. Most users will want to filter for the Machine type.
• --status <status> — Limit to systems whose status is <status>, for example Automated, Manual, or Broken.
• --pool <pool> — Limit to systems which are in <pool>.
• --group <group> — Compatibility alias for --pool.
• --arch <arch> — Limit to systems of arch <arch>.
• --dev-vendor-id <vendorid> — Limit to systems which have a device with <vendorid>.
• --dev-device-id <deviceid> — Limit to systems which have a device with <deviceid>.
• --dev-sub-vendor-id <subvendorid> — Limit to systems which have a device with <subvendorid>.
• --dev-sub-device-id <subdeviceid> — Limit to systems which have a device with <subdeviceid>.
• --dev-driver <driver> — Limit to systems which have a device with <driver>.
• --dev-description <description> — Limit to systems which have a device with <description>.
• --xml-filter <xml> — Limit to systems which match the given XML filter criteria. Supports the same criteria as inside the <hostRequires/> element in Beaker job XML.
• --host-filter <name> — Limit to systems which match the given pre-defined host filter. Refer to the description of the --host-filter workflow option in bkr(1).

Common bkr options are described in the Options section of bkr(1). 🫶

🌈 EXIT STATUS 🌈

Non-zero on error, otherwise zero. Shockingly simple, right? But wait — if no systems match the given criteria, this is considered to be an error, and the exit status will be 1. So yeah, empty results are lowkey a whole error situation. 😭

🎀 EXAMPLES 🎀

List automated systems which are in the kernel-hw pool and are not currently in use:

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

👑 SEE ALSO 👑

bkr(1) — go read her too, she’s the main character of the bkr universe. ✨

💜 AUTHOR 💜

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

⭐ COPYRIGHT ⭐

2013-2025 Red Hat, Inc.

---

mwah 💋 that’s the whole page, bestie. This one comes from Beaker 29.2, dated May 26, 2025 — catch you in the group chat 🫶