1BOOM(8) MAINTENANCE COMMANDS BOOM(8)
2
6 Boom — linux boot manager
7
9 boom [entry|profile|host] [create|delete|clone|show|list|edit]
10 boom legacy [write|clear|show]
12 boom cache [list|show]
14 boom entry create [--profile os_id] [--version version] [--root-device
16 device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
17 trd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts
18 opts]
19 boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
20 [--version version]
21 boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
22 [--version version] [--root-device device] [--root-lv lv]
23 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
24 subvol] [--add-opts opts] [--del-opts opts]
25 boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
26 sion version] [--name osname] [--short-name osshortname] [--os-
27 version version] [--root-device device] [--root-lv lv] [--linux
28 kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
29 boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
30 sion version] [--name osname] [--short-name osshortname] [--os-
31 version version] [--root-device device] [--root-lv lv] [--btrfs-
32 subvol subvol]
33 boom profile create [--name osname] [--short-name short_name] [--os-
35 version version] [--os-version-id version_id] [--from-host]
36 [--os-release os_release] [--uname-pattern uname_pattern]
37 [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
38 os_options]
39 boom profile delete [profile_id] [--profile os_id] [--name osname]
40 [--short-name short_name] [--os-version version] [--os-version-
41 id version_id] [--from-host] [--os-release os_release] [--uname-
42 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
43 btrfs_opts] [--os-options os_options]
44 boom profile clone [profile_id] [--profile os_id] [--name osname]
45 [--short-name short_name] [--os-version version] [--os-version-
46 id version_id] [--from-host] [--os-release os_release] [--uname-
47 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
48 btrfs_opts] [--os-options os_options]
49 boom profile list [profile_id] [--profile os_id] [--version version]
50 [--name osname] [--short-name osshortname] [--os-version ver‐
51 sion]
52 boom profile show [profile_id] [--profile os_id] [--version version]
53 [--name osname] [--short-name osshortname] [--os-version ver‐
54 sion]
55 boom host create [--name name] [--short-name short_name] [--profile
57 os_id] [--machine-id machine_id] [--kernel-pattern kernel_pat‐
58 tern] [--initramfs-pattern initramfs_pattern] [--lvm-opts
59 lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
60 boom host delete [host_id] [--host-profile host_id]
61 boom host clone [host_id] [--host-profile host_id] [--name name]
62 [--short-name short_name] [--profile os_id] [--machine-id ma‐
63 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
64 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
65 btrfs_opts] [--os-options os_options]
66 boom host edit [host_id] [--host-profile host_id] [--name name]
67 [--short-name short_name] [--profile os_id] [--machine-id ma‐
68 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
69 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
70 btrfs_opts] [--os-options os_options]
71 boom host list [host_id] [--host-profile host_id] [--name name]
72 [--short-name short_name] [--profile os_id] [--machine-id ma‐
73 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
74 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
75 btrfs_opts] [--os-options os_options]
76 boom host show [profile_id] [--profile os_id] [--version version]
77 [--name osname] [--short-name osshortname] [--os-version ver‐
78 sion]
79 boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
81 [--version version] [--name osname] [--short-name osshortname]
82 [--os-version version] [--root-device device] [--root-lv lv]
83 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
84 subvol]
85 boom legacy clear
86 boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
87 [--version version] [--name osname] [--short-name osshortname]
88 [--os-version version] [--root-device device] [--root-lv lv]
89 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
90 subvol]
91 boom cache list [img_id] [--image img_id] [--linux kernel_path] [--ini‐
93 trd initrd_path]
94 boom cache show [img_id] [--image img_id] [--linux kernel_path] [--ini‐
95 trd initrd_path]
96
99 Boom is a boot manager for Linux systems using boot loaders that sup‐
100 port the BootLoader Specification for boot entry configuration.
101 Boom works best with a BLS compatible boot loader: either the systemd-
103 boot project, or Grub2 with the `bls` patch. The grub2 boot loader in‐
104 cluded in CentOS, Fedora and Red Hat Enterprise Linux include this sup‐
105 port.
106 Boom also supports writing configuration in legacy boot loader format:
108 currently the syntax used by the Grub1 configuration file is supported.
109 All long options supported by boom may be written with or without
111 dashes separating words. For example, --boot-id and --bootid are syn‐
112 onymous.
113
116 -a|--add-opts opts
117 Specify additional boot options for this entry.
118 -d|--del-opts opts
120 Specify boot options to exclude from this entry.
121 -b|--boot-id|--bootid boot_id
123 Specify a boot identifier to operate on.
124 --boot-dir|--bootdir path
126 Specify the location of the /boot file system. Useful for test‐
127 ing or for accessing boom data from a system image.
128 -B|--btrfs-subvolme|--btrfssubvolume [subvol_path|subvol_id]
130 Specify a BTRFS subvolume by its path or identifier.
131 --btrfs-opts|--btrfsopts btrfs_options_template
133 An OS profile template string for BTRFS boot options.
134 --debug debug_flags
136 A comma-separated list of subsystem names to enable debugging
137 output for, or 'all' to enable all debugging. The available de‐
138 bug classes are: profile, entry, command, report.
139 -e|--efi efi_image
141 Specify an EFI application image for a boot entry.
142 -E|--expand-variables
144 Expand bootloader variables in command output.
145 -H|--from-host|--fromhost
147 When creating a new OS profile, use os-release data from the
148 running host.
149 -P|--host-profile
151 Use the specified host profile for search or create operations.
152 -i|--initrd image_path
154 A Linux initial ramfs image path.
155 -k|--kernel-pattern|--kernelpattern pattern
157 An OS profile template used to generate kernel image paths.
158 -l|--linux image_path
160 A Linux kernel image path.
161 -L|--root-lv|--rootlv root_lv
163 The logical volume containing the root file system for a boot
164 entry. If --root-lv is given, but --root-device is not, the
165 root device is assumed to be the specified logical volume.
166 --lvm-opts lvm_opts
168 An OS profile template used to generate LVM2 boot options.
169 -m|--machine-id|--machineid machine_id
171 -n|--name os_name
173 The name of a boom operating system profile.
174 --name-prefixes|--nameprefixes
176 Add a prefix to report field output names.
177 --no-headings|--noheadings
179 Suppress output of report headings.
180 -o|--options field_list
182 Specify which fields to display.
183 --os-version
185 The version string of a boom operating system profile.
186 -O|--sort key_list
188 A comma-separated list of sort keys (field names), with an op‐
189 tional per-field prefix of + or - to force ascending or descend‐
190 ing sort order respectively for that field.
191 -I|--os-version-id|--osversionid os_version_id
193 A boom operating system profile version identifier.
194 --os-options|--osoptions options_template
196 An operating system profile template string used to generate the
197 kernel command line options string.
198 --os-release|--osrelease os_release_path
200 A path to a file in os-release(5) from which to create a new op‐
201 erating system profile.
202 -p|--profile os_id
204 The operating system identifier (os_id) of a boom operating sys‐
205 tem profile to use for the current operation. Defaults to the OS
206 profile of the running system if absent.
207 -r|--root-device|--rootdevice root_dev
209 The system root device for a new boot entry.
210 -R|--initramfs-pattern|--initramfspattern initramfs_pattern
212 An OS profile template used to generate initial ramfs image
213 paths.
214 --rows
216 Output report columns as rows.
217 --separator separator
219 Report field separator
220 -s|--short-name|--shortname short_name The short name of a boom operat‐
222 ing system profile.
223 -t|--title entry_title
225 The title for a new boot entry.
226 -u|--uname-pattern|--unamepattern uname_pattern
228 An uname pattern to match for an operating system profile.
229 -V|--verbose
231 Increase verbosity level. Specify multiple times, or set addi‐
232 tional debug classed with --debug to enable more verbose mes‐
233 sages.
234 -v|--version version
236 The kernel version of a boom boot entry.
237
239 Boom manages boot loader entries for one or more installed operating
240 systems. Each operating system is identified by an OS Profile that pro‐
241 vides identity information and a set of templates used to create boot
242 loader entries.
243 An OS profile is identified by its os_id, an alphanumeric string based
245 on an SHA digest of the profile's identity fields. Identifiers re‐
246 ported in boom command output are automatically abbreviated to the min‐
247 imum length required to ensure uniqueness and this short form may be
248 used in any place where a boom OS identifier is expected.
249 A Boot Entry represents one bootable instance of an installed operating
251 system: a kernel, optional initial ramfs image, command line options,
252 and other images or settings required for boot.
253 Each boot entry is also identified by a SHA based unique identifier:
255 the boot_id. An entry's ID is used to select an entry for display, mod‐
256 ification, deletion or other operations.
257 Since the boot entry's identifier is based on the boot parameters used
259 to create the entry, the boot_id will change if an existing entry is
260 modified (for e.g. with the boom entry edit command).
261 Host Profiles
264 Host profiles provide an additional mechanism to control boot entry
266 templates on a per-host basis. A host profile is bound to a specific
267 machine_id and is used whenever new boot entries are created for the
268 corresponding host.
269 A host profile can add and delete boot options from the set supplied by
271 the active OS Profile, or override specific OS Profile keys completely.
272 Any keys not set in a host profile are mapped directly to the original
273 OS profile.
274 Boot Entry Commands
277 boom entry create [--profile os_id] [--version version] [--root-device
279 device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
280 trd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts
281 opts]
282 Create a new boot entry using the specified values.
283 The title of the new entry must be set with the --title option.
285 The kernel version for the new entry is given with --version.
287 If --version is not present the version is assumed to be that of
288 the currently running kernel.
289 If --profile is given, it specifies the OS identifier of an ex‐
291 isting OS profile to use for the new entry. If --profile is not
292 given, and a profile exists that matches either the supplied or
293 detected version then that profile will be automatically used.
294 The machine-id of the new entry is automatically set to the cur‐
296 rent machine-id (read from /etc/machine-id) unless this is over‐
297 ridden by the --machine-id switch.
298 A root device may be explicitly specified with the --root-device
300 option or if an LVM2 logical volume is used this may be speci‐
301 fied with --root-lv: in this case the root device is assumed to
302 be the normal device path of the specified logical volume.
303 A BTRFS subvolume may be set by either the subvolume path or
305 subvolume identifier using the --btrfs-subvol option.
306 Additional boot options not defined by the corresponding OsPro‐
308 file templates may be specified with --add-opts. Options may
309 also be removed from the entry using --del-opts (for example to
310 disable graphical boot or the "quiet" flag for a particular en‐
311 try).
312 The newly created entry and its boot identifier are printed to
314 the terminal on success:
315 # boom create --title 'System Snapshot' --root-lv vg00/lvol0
316 Created entry with boot_id 14d6b6e:
317 title System Snapshot
318 machine-id 611f38fd887d41dea7eb3403b2730a76
319 version 4.13.5-200.fc26.x86_64
320 linux /vmlinuz-4.13.5-200.fc26.x86_64
321 initrd /initramfs-4.13.5-200.fc26.x86_64.img
322 options BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
323 root=/dev/vg00/lvol0 ro rd.lvm.lv=vg00/lvol0 rhgb quiet
324 boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
326 [--version version]
327 Delete the specified boot entry. The entry to delete may be
328 specified either by its boot identifier, in which case at most
329 one entry will be removed, or by specifying selection criteria
330 which may match (and remove) multiple entries in a single opera‐
331 tion.
332 For example, by giving --version, all entries matching the spec‐
334 ified kernel version can be removed at once.
335 On success the number of entries removed is printed to the ter‐
337 minal. If the --verbose option is given then a report of the
338 entries removed will also be displayed.
339 boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
341 [--version version] [--root-device device] [--root-lv lv]
342 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
343 subvol] [--add-opts opts] [--del-opts opts]
344 Clone an existing boot entry and modify its configuration.
345 The entry to clone must be specified by its boot identifier.
347 Any remaining command line arguments are taken to be modifica‐
348 tions to the original entry.
349 On success the new entry and its boot identifier are printed to
351 the terminal.
352 boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
354 sion version] [--name osname] [--short-name osshortname] [--os-
355 version version] [--root-device device] [--root-lv lv] [--linux
356 kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
357 Output a tabular report of boot entries.
358 Displays a report with one boot entry per line, containing
360 fields describing the properties of the configured boot entries.
361 The list of fields to display is given with --options as a comma
363 separated list of field names. To obtain a list of available
364 fields run 'boom list -o help'. If the list of fields begins
365 with the '+' character the specified fields are appended to the
366 default field list. Otherwise the given list of fields replaces
367 the default set of report fields.
368 Report output may be sorted by multiple user-defined keys using
370 the --sort option. The option expects a comma separated list of
371 keys, with optional '+' and '-' prefixes indicating ascending
372 and descending sort for that field respectively.
373 boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
375 sion version] [--name osname] [--short-name osshortname] [--os-
376 version version] [--root-device device] [--root-lv lv] [--btrfs-
377 subvol subvol]
378 Display boot entries matching selection criteria on standard
379 out.
380 Boot entries matching the criteria given on the command line are
382 printed to the terminal in boot loader entry format.
383 If --expand-variables is given then any bootloader environment
385 variables in the output will be replaced with their current val‐
386 ues, for example the $kernelopts variable that some distribu‐
387 tions configure to store the kernel command line.
388 OS Profile Commands
390 boom profile create [--name osname] [--short-name short_name] [--os-
392 version version] [--os-version-id version_id] [--from-host]
393 [--os-release os_release] [--uname-pattern uname_pattern]
394 [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
395 os_options]
396 Create a new OS profile using the specified values.
397 A new OS profile can be created either by specifying required
399 values on the boom command line, or by reading data from either
400 the hosts's os-release file (at /etc/os-release), or from an‐
401 other file in os-release format specified on the command line.
402 The information read from os-release (or equivalent command line
404 options) form the profile's identity and are the basis for the
405 profile OS identifier.
406 In addition to the os-release data a new OS profile requires a
408 uname version string pattern to match, and template values used
409 to construct boot entries.
410 The uname pattern must be given on the profile create command
412 line and is a regular expression matching the UTS release (uname
413 -r) values reported by that distribution. The pattern is only
414 used to attempt to match unknown boot entries to a valid OS pro‐
415 file: for example entries that have been manually edited, or
416 that were created by another tool.
417 The boom command provides default templates that are suitable
419 for most Linux distributions. Alternately, these values may be
420 set on the command line at the time of profile creation, or mod‐
421 ified using the boom program at a later time.
422 To create a profile for the currently running host, use the
424 --from-host switch.
425 To create a profile from a saved os-release file use the --os-
427 release optiona and give the path to the file to be used.
428 boom profile delete [profile_id] [--profile os_id] [--name osname]
430 [--short-name short_name] [--os-version version] [--os-version-
431 id version_id] [--from-host] [--os-release os_release] [--uname-
432 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
433 btrfs_opts] [--os-options os_options]
434 Delete the specified Os profile or profiles.
435 Delete all OS profiles matching the provided selection criteria.
437 If the --profile option is used to specify an OS identifier then
438 at most one profile will be removed.
439 On success the number of profiles removed is printed to the ter‐
441 minal. If the --verbose option is given then a report of the
442 profiles removed will also be displayed.
443 boom profile clone [profile_id] [--profile os_id] [--name osname]
445 [--short-name short_name] [--os-version version] [--os-version-
446 id version_id] [--from-host] [--os-release os_release] [--uname-
447 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
448 btrfs_opts] [--os-options os_options]
449 Clone an existing OS profile and modify its configuration.
450 The entry to clone must be specified by its OS identifier. Any
452 remaining command line arguments are taken to be modifications
453 to the original entry.
454 On success the new entry and its OS identifier are printed to
456 the terminal.
457 boom profile list [profile_id] [--profile os_id] [--version version]
459 [--name osname] [--short-name osshortname] [--os-version ver‐
460 sion]
461 Output a tabular report of OS profiles.
462 Displays a report with one OS profile per line, containing
464 fields describing the properties of the configured OS profiles.
465 The list of fields to display is given with --options as a comma
467 separated list of field names. To obtain a list of available
468 fields run 'boom list -o help'. If the list of fields begins
469 with the '+' character the specified fields are appended to the
470 default field list. Otherwise the given list of fields replaces
471 the default set of report fields.
472 Report output may be sorted by multiple user-defined keys using
474 the --sort option. The option expects a comma separated list of
475 keys, with optional '+' and '-' prefixes indicating ascending
476 and descending sort for that field respectively.
477 boom profile show [profile_id] [--profile os_id] [--version version]
479 [--name osname] [--short-name osshortname] [--os-version ver‐
480 sion]
481 Display OS profiles matching selection criteria on standard out.
482 OS profiles matching the criteria given on the command line are
484 printed to the terminal in a compact multi-line format.
485 Host Profile Commands
487 boom host create [--name name] [--short-name short_name] [--profile
489 os_id] [--machine-id machine_id] [--kernel-pattern kernel_pat‐
490 tern] [--initramfs-pattern initramfs_pattern] [--lvm-opts
491 lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
492 Create a new host profile for the specified machine_id and using
493 the given profile option arguments. Any OS Profile keys that are
494 given values will override the values in the underlying profile.
495 boom host delete [host_id] [--host-profile host_id]
497 Delete the specified host profile or profiles.
498 Delete all host profiles matching the provided selection crite‐
500 ria. If the --host-profile option is used to specify an host
501 identifier then at most one profile will be removed.
502 On success the number of profiles removed is printed to the ter‐
504 minal. If the --verbose option is given then a report of the
505 profiles removed will also be displayed.
506 boom host clone [host_id] [--host-profile host_id] [--name name]
508 [--short-name short_name] [--profile os_id] [--machine-id ma‐
509 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
510 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
511 btrfs_opts] [--os-options os_options]
512 Clone an existing host profile and modify its configuration.
513 The entry to clone must be specified by its host identifier.
515 Any remaining command line arguments are taken to be modifica‐
516 tions to the original entry.
517 On success the new entry and its host identifier are printed to
519 the terminal.
520 boom host edit [host_id] [--host-profile host_id] [--name name]
522 [--short-name short_name] [--profile os_id] [--machine-id ma‐
523 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
524 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
525 btrfs_opts] [--os-options os_options]
526 Edit an existing host profile and modify its configuration.
527 The entry to edit must be specified by its host identifier. Any
529 remaining command line arguments are taken to be modifications
530 to the original profile.
531 On success the new profile and its host identifier are printed
533 to the terminal.
534 boom host list [host_id] [--host-profile host_id] [--name name]
536 [--short-name short_name] [--profile os_id] [--machine-id ma‐
537 chine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern
538 initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
539 btrfs_opts] [--os-options os_options] Output a tabular report of
540 host profiles.
541 Displays a report with one host profile per line, containing
543 fields describing the properties of the configured host pro‐
544 files.
545 The list of fields to display is given with --options as a comma
547 separated list of field names. To obtain a list of available
548 fields run 'boom host list -o help'. If the list of fields be‐
549 gins with the '+' character the specified fields are appended to
550 the default field list. Otherwise the given list of fields re‐
551 places the default set of report fields.
552 Report output may be sorted by multiple user-defined keys using
554 the --sort option. The option expects a comma separated list of
555 keys, with optional '+' and '-' prefixes indicating ascending
556 and descending sort for that field respectively.
557 boom host show [profile_id] [--profile os_id] [--version version]
559 [--name osname] [--short-name osshortname] [--os-version ver‐
560 sion]
561 Display host profiles matching selection criteria on standard
562 out.
563 Host profiles matching the criteria given on the command line
565 are printed to the terminal in a compact multi-line format.
566
569 Boom is able to write the current set of boot entries into the configu‐
570 ration file of a legacy boot loader installed on the system. This may
571 be used either on platforms that do not have a native bootloader sup‐
572 porting the Boot Loader Specification, or to allow upgrades and recov‐
573 ery from an installation lacking BLS support (if the system is updated
574 to a distribution that does support the BLS boot loader configuration
575 it will be used automatically when present).
576 Legacy support is enabled and configured via the boom.conf(5) configu‐
578 ration file.
579 boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
581 [--version version] [--name osname] [--short-name osshortname]
582 [--os-version version] [--root-device device] [--root-lv lv]
583 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
584 subvol]
585 Write out the current set of Boom boot entries in the configured
586 legacy configuration file. The normal command line selection op‐
587 tions may be used to control the set of entries written to the
588 file.
589 boom legacy clear
591 Remove all Boom boot entries from the configured legacy configu‐
592 ration file.
593 boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
595 [--version version] [--name osname] [--short-name osshortname]
596 [--os-version version] [--root-device device] [--root-lv lv]
597 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
598 subvol] Display the selected boot entries as they would appear
599 in the configured legacy boot loader format. The normal command
600 line selection options may be used to control the set of entries
601 written to the terminal.
602
605 Boom can optionally cache or back up the images used by a boom BootEn‐
606 try. This allows an entry to be booted in the case that a subsequent
607 update has removed the original kernel and initramfs images and can be
608 used to recover an earlier system state from a snapshot following even
609 major operating system updates.
610 boom cache list [img_id] [--image img_id] [--linux kernel_path] [--ini‐
612 trd initrd_path]
613 Output a tabular report of paths present in the boot image
614 cache.
615 Displays a report with one cache entry per line, containing
617 fields describing the properties of the cache entry.
618 The list of fields to display is given with --options as a comma
620 separated list of field names. To obtain a list of available
621 fields run 'boom host list -o help'. If the list of fields be‐
622 gins with the '+' character the specified fields are appended to
623 the default field list. Otherwise the given list of fields re‐
624 places the default set of report fields.
625 Report output may be sorted by multiple user-defined keys using
627 the --sort option. The option expects a comma separated list of
628 keys, with optional '+' and '-' prefixes indicating ascending
629 and descending sort for that field respectively.
630 boom cache show [img_id] [--image img_id] [--linux kernel_path] [--ini‐
632 trd initrd_path]
633 Display matching cache entries on standard output.
634 Entries matching selection criteria are printed in a compact
636 multi-line format.
637
639 The boom report provides several types of field that may be added to
640 the default field set for either Boot Entry or OS Profile reports, or
641 used to create custom reports.
642 Boot Parameters
644 Boot parameter fields represent the properties that distinguish boot
645 entries: the kernel version and root device configuration.
646 version
648 The kernel version of this Boot Entry.
649 rootdev
651 The root device of this Boot Entry.
652 rootlv The root logical volume of this Boot Entry in 'VG/LV' notation.
654 subvolpath
656 The BTRFS subvolume path for this Boot Entry.
657 subvolid
659 The BTRFS subvolume ID for this BootEntry.
660 Boot Entry fields
662 Boot Entry fields provide information about an entry not specified by
663 its Boot Parameters, including the title, boot identifier, boot image
664 locations, and options required to boot the entry.
665 bootid Boot identifier.
667 title The entry title as displayed in the boot loader.
669 options
671 The kernel command line options used to boot this entry.
672 kernel The path to the bootable kernel image, relative to the boot
674 loader.
675 initramfs
677 The path to the initramfs image, relative to the boot loader.
678 machineid
680 The machine-id associated with this Boot Entry.
681 entrypath
683 The absolute path to this Boot Entry's on-disk configuration
684 file.
685 OS Profile fields
687 OS Profile fields provide access to the details of a profile's configu‐
688 ration including identity fields and the template strings used to gen‐
689 erate entries.
690 Since each Boot Entry has an attached OS Profile all profile fields are
692 also available to add to any Boot Entry report.
693 osid OS profile identifier.
695 osname The name of this OS prorile as read from os-release.
697 osshortname
699 The short name of this OS profile as read from os-release.
700 osversion
702 The OS version of this OS profile as read from os-release.
703 osversion_id
705 The OS version identifier of this OS profile as read from os-re‐
706 lease.
707 unamepattern
709 The configured UTS release pattern for this OS profile.
710 kernelpattern
712 The configured kernel image template for this OS profile.
713 initrdpattern
715 The configured initramfs image template for this OS profile.
716 lvm2opts
718 The configured LVM2 root device options template for this OS
719 profile.
720 btrfsopts
722 The configured BTRFS root options template for this OS profile.
723 options
725 The kernel command line options template for this OS profile.
726 profilepath
728 The absolute path to this OS Profile's on-disk configuration
729 file.
730 Host Profile fields
732 Host Profile fields provide access to the details of a profile's con‐
733 figuration including identity fields and the template strings used to
734 generate entries. This includes all fields available in the OS Profile
735 report as well as additional Host Profile identity fields.
736 hostid Host profile identifier.
738 hostname
740 The hostname of this host profile.
741 label The label of this host profile.
743 Cache Entry fields
745 Cache entry fields provide information on the paths and images stored
746 in the boom boot image cache.
747 imgid Image identifier.
749 path Path to the cached image, relative to the boot file system.
751 mode Path file system mode in human-readable format.
753 uid Image owner user identifier.
755 gid Image owner group identifier.
757 ts Image timestamp. The mtime of the image file at the time it was
759 added to the cache.
760 state A string description of the cache entry state: CACHED, MISSING,
762 RESTORED, or BROKEN.
763 count The number of boot entries that reference this boot image.
765
767 Both the entry list and profile list commands use a common reporting
768 system to display the results of the query. The selection of fields,
769 and the order in which they are displayed, may be controlled to produce
770 custom report formats.
771 Displaying the available boot entry fields
773 # boom list -o help
774 Boot loader entries Fields
775 --------------------------
776 bootid - Boot identifier [sha]
777 title - Entry title [str]
778 options - Kernel options [str]
779 kernel - Kernel image [str]
780 initramfs - Initramfs image [str]
781 machineid - Machine identifier [sha]
782 entrypath - On-disk entry path [str]
783 OS profiles Fields
785 ------------------
786 osid - OS identifier [sha]
787 osname - OS name [str]
788 osshortname - OS short name [str]
789 osversion - OS version [str]
790 osversion_id - Version identifier [str]
791 unamepattern - UTS name pattern [str]
792 kernelpattern - Kernel image pattern [str]
793 initrdpattern - Initrd pattern [str]
794 lvm2opts - LVM2 options [str]
795 btrfsopts - BTRFS options [str]
796 options - Kernel options [str]
797 profilepath - On-disk profile path [str]
798 Boot parameters Fields
800 ----------------------
801 version - Kernel version [str]
802 rootdev - Root device [str]
803 rootlv - Root logical volume [str]
804 subvolpath - BTRFS subvolume path [str]
805 subvolid - BTRFS subvolume ID [num]
806 Displaying the available OS profile fields
808 # boom profile list -o help
809 OS profiles Fields
810 ------------------
811 osid - OS identifier [sha]
812 osname - OS name [str]
813 osshortname - OS short name [str]
814 osversion - OS version [str]
815 osversion_id - Version identifier [str]
816 unamepattern - UTS name pattern [str]
817 kernelpattern - Kernel image pattern [str]
818 initrdpattern - Initrd pattern [str]
819 lvm2opts - LVM2 options [str]
820 btrfsopts - BTRFS options [str]
821 options - Kernel options [str]
822 profilepath - On-disk profile path [str]
823 Selecting custom fields for the entry list and profile list commands
825 # boom list -o bootid,osname
826 BootID Name
827 0d3e547 Fedora
828 bc18de2 Fedora
829 576fe39 Fedora
830 1838f58 Fedora
831 81520ca Fedora
832 327e24a Fedora
833 Adding additional fields to the default set
835 # boom list -o +options
836 BootID Version Name RootDevice
837 Options
838 0d3e547 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
839 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
840 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
841 rd.auto=1
842 bc18de2 4.13.5-200.fc26.x86_64 Fedora
843 /dev/vg_hex/root-snap10 BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
844 root=/dev/vg_hex/root-snap10 ro rd.lvm.lv=vg_hex/root-snap10
845 576fe39 4.13.5-200.fc26.x86_64 Fedora
846 /dev/vg_hex/root BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
847 root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root
848 1838f58 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
849 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
850 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
851 81520ca 4.13.13-200.fc26.x86_64 Fedora /dev/map‐
852 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
853 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
854 LANG=en_GB.UTF-8
855 327e24a 4.13.5-200.fc26.x86_64 Fedora
856 /dev/vg_hex/root BOOT_IMAGE=%{linux} root=/dev/vg_hex/root ro
857 rd.lvm.lv=vg_hex/root
858 Sort operating system profiles by ascending OS name and descending OS
860 version
861 # boom profile list -O+osname,-osversion
862 OsID Name OsVersion
863 d4439b7 Fedora 26 (Workstation Edition)
864 9736c34 Fedora 25 (Server Edition)
865 9cb53dd Fedora 24 (Workstation Edition)
866 6bf746b Fedora 24 (Server Edition)
867 b99ea5f Red Hat Enterprise Linux Server 8 (Server)
868 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
869 c0b921e Red Hat Enterprise Linux Server 7 (Server)
870 98c3edb Red Hat Enterprise Linux Server 6 (Server)
871 b730331 Red Hat Enterprise Linux Server 5 (Server)
872 efd6d41 Red Hat Enterprise Linux Server 4 (Server)
873 21e37c8 Ubuntu 16.04 LTS (Xenial Xerus)
874
876 List the available operating system profiles
877 # boom profile list
878 OsID Name OsVersion
879 efd6d41 Red Hat Enterprise Linux Server 4 (Server)
880 b730331 Red Hat Enterprise Linux Server 5 (Server)
881 98c3edb Red Hat Enterprise Linux Server 6 (Server)
882 c0b921e Red Hat Enterprise Linux Server 7 (Server)
883 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
884 b99ea5f Red Hat Enterprise Linux Server 8 (Server)
885 List the available boot entries
887 # boom list
888 BootID Version Name RootDevice
889 0d3e547 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
890 per/vg00-lvol0
891 bc18de2 4.13.5-200.fc26.x86_64 Fedora
892 /dev/vg00/lvol0-snap10
893 576fe39 4.13.5-200.fc26.x86_64 Fedora
894 /dev/vg00/lvol0
895 f52ba10 4.11.12-100.fc24.x86_64 Fedora
896 /dev/vg00/lvol0-snap
897 1838f58 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
898 per/vg00-lvol0
899 81520ca 4.13.13-200.fc26.x86_64 Fedora /dev/map‐
900 per/vg00-lvol0
901 327e24a 4.13.5-200.fc26.x86_64 Fedora
902 /dev/vg00/lvol0
903 Create an OS profile for the running system (using Fedora 26 as an ex‐
905 ample)
906 # boom profile create --from-host --uname-pattern fc26
907 Created profile with os_id d4439b7:
908 OS ID: "d4439b7d2f928c39f1160c0b0291407e5990b9e0",
909 Name: "Fedora", Short name: "fedora",
910 Version: "26 (Workstation Edition)", Version ID: "26",
911 UTS release pattern: "fc26",
912 Kernel pattern: "/kernel-%{version}", Initramfs pattern:
913 "/initramfs-%{version}.img",
914 Root options (LVM2): "rd.lvm.lv=%{lvm_root_lv}",
915 Root options (BTRFS): "rootflags=%{btrfs_subvolume}",
916 Options: "root=%{root_device} ro %{root_opts}"
917 Create a new boot entry for a specific OS profile and version
919 # boom profile list --short-name rhel
920 OsID Name OsVersion
921 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
922 98c3edb Red Hat Enterprise Linux Server 6 (Server)
923 c0b921e Red Hat Enterprise Linux Server 7 (Server)
924 # boom create --profile 3fc389b --title "RHEL7 snapshot" --version
926 3.10-272.el7 --root-lv vg00/lvol0-snap
927 Created entry with boot_id a5aef11:
928 title RHEL7 snapshot
929 machine-id 611f38fd887d41dea7eb3403b2730a76
930 version 3.10-272.el7
931 linux /boot/vmlinuz-3.10-272.el7
932 initrd /boot/initramfs-3.10-272.el7.img
933 options root=/dev/vg00/lvol0-snap ro rd.lvm.lv=vg00/lvol0-snap rhgb
934 quiet
935 Create a new boot entry for the running system, changing only the root
937 logical volume
938 # boom create --title Snap1 --root-lv vg00/lvol0-snap1
939 Created entry with boot_id e077490:
940 title Snap1
941 machine-id 611f38fd887d41dea7eb3403b2730a76
942 version 4.13.13-200.fc26.x86_64
943 linux /vmlinuz-4.13.13-200.fc26.x86_64
944 initrd /initramfs-4.13.13-200.fc26.x86_64.img
945 options BOOT_IMAGE=/vmlinuz-4.13.13-200.fc26.x86_64
946 root=/dev/vg00/lvol0-snap1 ro rd.lvm.lv=vg00/lvol0-snap1
947 Delete an entry by its boot identifier
949 # boom delete --boot-id e077490
950 Deleted 1 entry
951 Delete all entries for the Fedora 24 OS profile
953 # boom delete --name Fedora --os-version-id 24 Deleted 4 entries
954
956 Bryn M. Reeves <bmr@redhat.com>
957
959 Boom project page: https://github.com/snapshotmanager/boom
960 Boot to snapshot documentation: https://github.com/snapshotman‐
961 ager/snapshot-boot-docs
962 BootLoader Specification: https://systemd.io/BOOT_LOADER_SPECIFICATION
963 LVM2 resource page: https://www.sourceware.org/lvm2/
964 Device-mapper resource page: http://sources.redhat.com/dm/
965Linux Oct 30 2017 BOOM(8)