1BKR-SYSTEM-LIST(1)                  Beaker                  BKR-SYSTEM-LIST(1)
2
3
4

NAME

6       bkr-system-list - List Beaker systems
7

SYNOPSIS

9       bkr system-list [options]
10         [--available | --free | --mine]
11         [--type <type>] [--status <status>] [--pool <pool>]
12         [--arch <arch>] [--dev-vendor-id <vendorid>]
13         [--dev-device-id <deviceid>] [--dev-driver <driver>]
14         [--dev-description <description>] [--dev-sub-vendor-id <subvendorid>]
15         [--dev-sub-device-id <subdeviceid>]
16
17

DESCRIPTION

19       Prints to stdout a list of all matching systems in Beaker.
20

OPTIONS

22       --available
23              Limit to systems which would be available to be scheduled by the
24              current user. This will exclude any systems whose access  policy
25              prevent the current user from running jobs on them.
26
27              Note  that this does not exclude systems which are currently oc‐
28              cupied by other users. Use --free for that.
29
30       --free Like --available, but only includes which can be scheduled right
31              now.
32
33       --removed
34              Limit to systems which have been marked as Removed.
35
36       --mine Limit to systems which are owned by the current user.
37
38       The --available, --free, and --mine options are mutually exclusive.
39
40       --type <type>
41              Limit  to systems of type <type>. Most users will want to filter
42              for the Machine type.
43
44       --status <status>
45              Limit to systems whose status is  <status>,  for  example  Auto‐
46              mated, Manual, or Broken.
47
48       --pool <pool>
49              Limit to systems which are in <pool>
50
51       --group <group>
52              Compatibility alias for --pool.
53
54       --arch <arch>
55              Limit to systems of arch <arch>.
56
57       --dev-vendor-id <vendorid>
58              Limit to systems which have a device with <vendorid>.
59
60       --dev-device-id <deviceid>
61              Limit to systems which have a device with <deviceid>.
62
63       --dev-sub-vendor-id <subvendorid>
64              Limit to systems which have a device with <subvendorid>.
65
66       --dev-sub-device-id <subdeviceid>
67              Limit to systems which have a device with <subdeviceid>.
68
69       --dev-driver <driver>
70              Limit to systems which have a device with <driver>.
71
72       --dev-description <description>
73              Limit to systems which have a device with <description>.
74
75       --xml-filter <xml>
76              Limit to systems which match the given XML filter criteria. Sup‐
77              ports the same criteria as inside the <hostRequires/> element in
78              Beaker job XML.
79
80       --host-filter <name>
81              Limit  to systems which match the given pre-defined host filter.
82              Refer to the description of the --host-filter workflow option in
83              bkr(1).
84
85       Common bkr options are described in the Options section of bkr(1).
86

EXIT STATUS

88       Non-zero  on error, otherwise zero.  If no systems match the given cri‐
89       teria this is considered to be an error, and the exit status will be 1.
90

EXAMPLES

92       List automated systems which are in the kernel-hw pool and are not cur‐
93       rently in use:
94
95          bkr system-list --free --type=Machine --status=Automated --pool=kernel-hw
96

SEE ALSO

98       bkr(1)
99

AUTHOR

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

104       2013-2023 Red Hat, Inc.
105
106
107
108
10928.3                             Nov 17, 2023               BKR-SYSTEM-LIST(1)
Impressum