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 entry create [--profile os_id] [--version version] [--root-device
14 device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
15 trd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts
16 opts]
17 boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
18 [--version version]
19 boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
20 [--version version] [--root-device device] [--root-lv lv]
21 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
22 subvol] [--add-opts opts] [--del-opts opts]
23 boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
24 sion version] [--name osname] [--short-name osshortname] [--os-
25 version version] [--root-device device] [--root-lv lv] [--linux
26 kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
27 boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
28 sion version] [--name osname] [--short-name osshortname] [--os-
29 version version] [--root-device device] [--root-lv lv] [--btrfs-
30 subvol subvol]
31 boom profile create [--name osname] [--short-name short_name] [--os-
33 version version] [--os-version-id version_id] [--from-host]
34 [--os-release os_release] [--uname-pattern uname_pattern]
35 [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
36 os_options]
37 boom profile delete [profile_id] [--profile os_id] [--name osname]
38 [--short-name short_name] [--os-version version] [--os-version-
39 id version_id] [--from-host] [--os-release os_release] [--uname-
40 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
41 btrfs_opts] [--os-options os_options]
42 boom profile clone [profile_id] [--profile os_id] [--name osname]
43 [--short-name short_name] [--os-version version] [--os-version-
44 id version_id] [--from-host] [--os-release os_release] [--uname-
45 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
46 btrfs_opts] [--os-options os_options]
47 boom profile list [profile_id] [--profile os_id] [--version version]
48 [--name osname] [--short-name osshortname] [--os-version ver‐
49 sion]
50 boom profile show [profile_id] [--profile os_id] [--version version]
51 [--name osname] [--short-name osshortname] [--os-version ver‐
52 sion]
53 boom host create [--name name] [--short-name short_name] [--profile
55 os_id] [--machine-id machine_id] [--kernel-pattern kernel_pat‐
56 tern] [--initramfs-pattern initramfs_pattern] [--lvm-opts
57 lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
58 boom host delete [host_id] [--host-profile host_id]
59 boom host clone [host_id] [--host-profile host_id] [--name name]
60 [--short-name short_name] [--profile os_id] [--machine-id
61 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
62 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
63 btrfs_opts] [--os-options os_options]
64 boom host edit [host_id] [--host-profile host_id] [--name name]
65 [--short-name short_name] [--profile os_id] [--machine-id
66 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
67 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
68 btrfs_opts] [--os-options os_options]
69 boom host list [host_id] [--host-profile host_id] [--name name]
70 [--short-name short_name] [--profile os_id] [--machine-id
71 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
72 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
73 btrfs_opts] [--os-options os_options]
74 boom host show [profile_id] [--profile os_id] [--version version]
75 [--name osname] [--short-name osshortname] [--os-version ver‐
76 sion]
77 boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
79 [--version version] [--name osname] [--short-name osshortname]
80 [--os-version version] [--root-device device] [--root-lv lv]
81 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
82 subvol]
83 boom legacy clear
84 boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
85 [--version version] [--name osname] [--short-name osshortname]
86 [--os-version version] [--root-device device] [--root-lv lv]
87 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
88 subvol]
89
91 Boom is a boot manager for Linux systems using boot loaders that sup‐
92 port the BootLoader Specification for boot entry configuration.
93 Boom works best with a BLS compatible boot loader: either the systemd-
95 boot project, or Grub2 with the `bls` patch. The grub2 boot loader
96 included in CentOS, Fedora and Red Hat Enterprise Linux include this
97 support.
98 Boom also supports writing configuration in legacy boot loader format:
100 currently the syntax used by the Grub1 configuration file is supported.
101 All long options supported by boom may be written with or without
103 dashes separating words. For example, --boot-id and --bootid are syn‐
104 onymous.
105
108 -a|--add-opts opts
109 Specify additional boot options for this entry.
110 -d|--del-opts opts
112 Specify boot options to exclude from this entry.
113 -b|--boot-id|--bootid boot_id
115 Specify a boot identifier to operate on.
116 --boot-dir|--bootdir path
118 Specify the location of the /boot file system. Useful for test‐
119 ing or for accessing boom data from a system image.
120 -B|--btrfs-subvolme|--btrfssubvolume [subvol_path|subvol_id]
122 Specify a BTRFS subvolume by its path or identifier.
123 --btrfs-opts|--btrfsopts btrfs_options_template
125 An OS profile template string for BTRFS boot options.
126 --debug debug_flags
128 A comma-separated list of subsystem names to enable debugging
129 output for, or 'all' to enable all debugging. The available
130 debug classes are: profile, entry, command, report.
131 -e|--efi efi_image
133 Specify an EFI application image for a boot entry.
134 -H|--from-host|--fromhost
136 When creating a new OS profile, use os-release data from the
137 running host.
138 -P|--host-profile
140 Use the specified host profile for search or create operations.
141 -i|--initrd image_path
143 A Linux initial ramfs image path.
144 -k|--kernel-pattern|--kernelpattern pattern
146 An OS profile template used to generate kernel image paths.
147 -l|--linux image_path
149 A Linux kernel image path.
150 -L|--root-lv|--rootlv root_lv
152 The logical volume containing the root file system for a boot
153 entry. If --root-lv is given, but --root-device is not, the
154 root device is assumed to be the specified logical volume.
155 --lvm-opts lvm_opts
157 An OS profile template used to generate LVM2 boot options.
158 -m|--machine-id|--machineid machine_id
160 -n|--name os_name
162 The name of a boom operating system profile.
163 --name-prefixes|--nameprefixes
165 Add a prefix to report field output names.
166 --no-headings|--noheadings
168 Suppress output of report headings.
169 -o|--options field_list
171 Specify which fields to display.
172 --os-version
174 The version string of a boom operating system profile.
175 -O|--sort key_list
177 A comma-separated list of sort keys (field names), with an
178 optional per-field prefix of + or - to force ascending or
179 descending sort order respectively for that field.
180 -I|--os-version-id|--osversionid os_version_id
182 A boom operating system profile version identifier.
183 --os-options|--osoptions options_template
185 An operating system profile template string used to generate the
186 kernel command line options string.
187 --os-release|--osrelease os_release_path
189 A path to a file in os-release(5) from which to create a new
190 operating system profile.
191 -p|--profile os_id
193 The operating system identifier (os_id) of a boom operating sys‐
194 tem profile to use for the current operation. Defaults to the OS
195 profile of the running system if absent.
196 -r|--root-device|--rootdevice root_dev
198 The system root device for a new boot entry.
199 -R|--initramfs-pattern|--initramfspattern initramfs_pattern
201 An OS profile template used to generate initial ramfs image
202 paths.
203 --rows
205 Output report columns as rows.
206 --separator separator
208 Report field separator
209 -s|--short-name|--shortname short_name The short name of a boom operat‐
211 ing system profile.
212 -t|--title entry_title
214 The title for a new boot entry.
215 -u|--uname-pattern|--unamepattern uname_pattern
217 An uname pattern to match for an operating system profile.
218 -V|--verbose
220 Increase verbosity level. Specify multiple times, or set addi‐
221 tional debug classed with --debug to enable more verbose mes‐
222 sages.
223 -v|--version version
225 The kernel version of a boom boot entry.
226
228 Boom manages boot loader entries for one or more installed operating
229 systems. Each operating system is identified by an OS Profile that pro‐
230 vides identity information and a set of templates used to create boot
231 loader entries.
232 An OS profile is identified by its os_id, an alphanumeric string based
234 on an SHA digest of the profile's identity fields. Identifiers
235 reported in boom command output are automatically abbreviated to the
236 minimum length required to ensure uniqueness and this short form may be
237 used in any place where a boom OS identifier is expected.
238 A Boot Entry represents one bootable instance of an installed operating
240 system: a kernel, optional initial ramfs image, command line options,
241 and other images or settings required for boot.
242 Each boot entry is also identified by a SHA based unique identifier:
244 the boot_id. An entry's ID is used to select an entry for display, mod‐
245 ification, deletion or other operations.
246 Since the boot entry's identifier is based on the boot parameters used
248 to create the entry, the boot_id will change if an existing entry is
249 modified (for e.g. with the boom entry edit command).
250 Host Profiles
253 Host profiles provide an additional mechanism to control boot entry
255 templates on a per-host basis. A host profile is bound to a specific
256 machine_id and is used whenever new boot entries are created for the
257 corresponding host.
258 A host profile can add and delete boot options from the set supplied by
260 the active OS Profile, or override specific BOS Profile keys com‐
261 pletely. Any keys not set in a host profile are mapped directly to the
262 original OS profile.
263 Boot Entry Commands
266 boom entry create [--profile os_id] [--version version] [--root-device
268 device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
269 trd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts
270 opts]
271 Create a new boot entry using the specified values.
272 The title of the new entry must be set with the --title option.
274 The kernel version for the new entry is given with --version.
276 If --version is not present the version is assumed to be that of
277 the currently running kernel.
278 If --profile is given, it specifies the OS identifier of an
280 existing OS profile to use for the new entry. If --profile is
281 not given, and a profile exists that matches either the supplied
282 or detected version then that profile will be automatically
283 used.
284 The machine-id of the new entry is automatically set to the cur‐
286 rent machine-id (read from /etc/machine-id) unless this is over‐
287 ridden by the --machine-id switch.
288 A root device may be explicitly specified with the --root-device
290 option or if an LVM2 logical volume is used this may be speci‐
291 fied with --root-lv: in this case the root device is assumed to
292 be the normal device path of the specified logical volume.
293 A BTRFS subvolume may be set by either the subvolume path or
295 subvolume identifier using the --btrfs-subvol option.
296 Additional boot options not defined by the corresponding OsPro‐
298 file templates may be specified with --add-opts. Options may
299 also be removed from the entry using --del-opts (for example to
300 disable graphical boot or the "quiet" flag for a particular
301 entry).
302 The newly created entry and its boot identifier are printed to
304 the terminal on success:
305 # boom create --title 'System Snapshot' --root-lv vg00/lvol0
306 Created entry with boot_id 14d6b6e:
307 title System Snapshot
308 machine-id 611f38fd887d41dea7eb3403b2730a76
309 version 4.13.5-200.fc26.x86_64
310 linux /vmlinuz-4.13.5-200.fc26.x86_64
311 initrd /initramfs-4.13.5-200.fc26.x86_64.img
312 options BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
313 root=/dev/vg00/lvol0 ro rd.lvm.lv=vg00/lvol0 rhgb quiet
314 boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
316 [--version version]
317 Delete the specified boot entry. The entry to delete may be
318 specified either by its boot identifier, in which case at most
319 one entry will be removed, or by specifying selection criteria
320 which may match (and remove) multiple entries in a single opera‐
321 tion.
322 For example, by giving --version, all entries matching the spec‐
324 ified kernel version can be removed at once.
325 On success the number of entries removed is printed to the ter‐
327 minal. If the --verbose option is given then a report of the
328 entries removed will also be displayed.
329 boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
331 [--version version] [--root-device device] [--root-lv lv]
332 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
333 subvol] [--add-opts opts] [--del-opts opts]
334 Clone an existing boot entry and modify its configuration.
335 The entry to clone must be specified by its boot identifier.
337 Any remaining command line arguments are taken to be modifica‐
338 tions to the original entry.
339 On success the new entry and its boot identifier are printed to
341 the terminal.
342 boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
344 sion version] [--name osname] [--short-name osshortname] [--os-
345 version version] [--root-device device] [--root-lv lv] [--linux
346 kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
347 Output a tabular report of boot entries.
348 Displays a report with one boot entry per line, containing
350 fields describing the properties of the configured boot entries.
351 The list of fields to display is given with --options as a comma
353 separated list of field names. To obtain a list of available
354 fields run 'boom list -o help'. If the list of fields begins
355 with the '+' character the specified fields are appended to the
356 default field list. Otherwise the given list of fields replaces
357 the default set of report fields.
358 Report output may be sorted by multiple user-defined keys using
360 the --sort option. The option expects a comma separated list of
361 keys, with optional '+' and '-' prefixes indicating ascending
362 and descending sort for that field respectively.
363 boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
365 sion version] [--name osname] [--short-name osshortname] [--os-
366 version version] [--root-device device] [--root-lv lv] [--btrfs-
367 subvol subvol]
368 Display boot entries matching selection criteria on standard
369 out.
370 Boot entries matching the criteria given on the command line are
372 printed to the terminal in boot loader entry format.
373 OS Profile Commands
375 boom profile create [--name osname] [--short-name short_name] [--os-
377 version version] [--os-version-id version_id] [--from-host]
378 [--os-release os_release] [--uname-pattern uname_pattern]
379 [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
380 os_options]
381 Create a new OS profile using the specified values.
382 A new OS profile can be created either by specifying required
384 values on the boom command line, or by reading data from either
385 the hosts's os-release file (at /etc/os-release), or from
386 another file in os-release format specified on the command line.
387 The information read from os-release (or equivalent command line
389 options) form the profile's identity and are the basis for the
390 profile OS identifier.
391 In addition to the os-release data a new OS profile requires a
393 uname version string pattern to match, and template values used
394 to construct boot entries.
395 The uname pattern must be given on the profile create command
397 line and is a regular expression matching the UTS release (uname
398 -r) values reported by that distribution. The pattern is only
399 used to attempt to match unknown boot entries to a valid OS pro‐
400 file: for example entries that have been manually edited, or
401 that were created by another tool.
402 The boom command provides default templates that are suitable
404 for most Linux distributions. Alternately, these values may be
405 set on the command line at the time of profile creation, or mod‐
406 ified using the boom program at a later time.
407 To create a profile for the currently running host, use the
409 --from-host switch.
410 To create a profile from a saved os-release file use the --os-
412 release optiona and give the path to the file to be used.
413 boom profile delete [profile_id] [--profile os_id] [--name osname]
415 [--short-name short_name] [--os-version version] [--os-version-
416 id version_id] [--from-host] [--os-release os_release] [--uname-
417 pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
418 btrfs_opts] [--os-options os_options]
419 Delete the specified Os profile or profiles.
420 Delete all OS profiles matching the provided selection criteria.
422 If the --profile option is used to specify an OS identifier then
423 at most one profile will be removed.
424 On success the number of profiles removed is printed to the ter‐
426 minal. If the --verbose option is given then a report of the
427 profiles removed will also be displayed.
428 boom profile clone [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 Clone an existing OS profile and modify its configuration.
435 The entry to clone must be specified by its OS identifier. Any
437 remaining command line arguments are taken to be modifications
438 to the original entry.
439 On success the new entry and its OS identifier are printed to
441 the terminal.
442 boom profile list [profile_id] [--profile os_id] [--version version]
444 [--name osname] [--short-name osshortname] [--os-version ver‐
445 sion]
446 Output a tabular report of OS profiles.
447 Displays a report with one OS profile per line, containing
449 fields describing the properties of the configured OS profiles.
450 The list of fields to display is given with --options as a comma
452 separated list of field names. To obtain a list of available
453 fields run 'boom list -o help'. If the list of fields begins
454 with the '+' character the specified fields are appended to the
455 default field list. Otherwise the given list of fields replaces
456 the default set of report fields.
457 Report output may be sorted by multiple user-defined keys using
459 the --sort option. The option expects a comma separated list of
460 keys, with optional '+' and '-' prefixes indicating ascending
461 and descending sort for that field respectively.
462 boom profile show [profile_id] [--profile os_id] [--version version]
464 [--name osname] [--short-name osshortname] [--os-version ver‐
465 sion]
466 Display OS profiles matching selection criteria on standard out.
467 OS profiles matching the criteria given on the command line are
469 printed to the terminal in a compact multi-line format.
470 Host Profile Commands
472 boom host create [--name name] [--short-name short_name] [--profile
474 os_id] [--machine-id machine_id] [--kernel-pattern kernel_pat‐
475 tern] [--initramfs-pattern initramfs_pattern] [--lvm-opts
476 lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
477 Create a new host profile for the specified machine_id and using
478 the given profile option arguments. Any OS Profile keys that are
479 given values will override the values in the underlying profile.
480 boom host delete [host_id] [--host-profile host_id]
482 Delete the specified host profile or profiles.
483 Delete all host profiles matching the provided selection crite‐
485 ria. If the --host-profile option is used to specify an host
486 identifier then at most one profile will be removed.
487 On success the number of profiles removed is printed to the ter‐
489 minal. If the --verbose option is given then a report of the
490 profiles removed will also be displayed.
491 boom host clone [host_id] [--host-profile host_id] [--name name]
493 [--short-name short_name] [--profile os_id] [--machine-id
494 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
495 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
496 btrfs_opts] [--os-options os_options]
497 Clone an existing host profile and modify its configuration.
498 The entry to clone must be specified by its host identifier.
500 Any remaining command line arguments are taken to be modifica‐
501 tions to the original entry.
502 On success the new entry and its host identifier are printed to
504 the terminal.
505 boom host edit [host_id] [--host-profile host_id] [--name name]
507 [--short-name short_name] [--profile os_id] [--machine-id
508 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
509 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
510 btrfs_opts] [--os-options os_options]
511 Edit an existing host profile and modify its configuration.
512 The entry to edit must be specified by its host identifier. Any
514 remaining command line arguments are taken to be modifications
515 to the original profile.
516 On success the new profile and its host identifier are printed
518 to the terminal.
519 boom host list [host_id] [--host-profile host_id] [--name name]
521 [--short-name short_name] [--profile os_id] [--machine-id
522 machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pat‐
523 tern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
524 btrfs_opts] [--os-options os_options] Output a tabular report of
525 host profiles.
526 Displays a report with one host profile per line, containing
528 fields describing the properties of the configured host pro‐
529 files.
530 The list of fields to display is given with --options as a comma
532 separated list of field names. To obtain a list of available
533 fields run 'boom host list -o help'. If the list of fields
534 begins with the '+' character the specified fields are appended
535 to the default field list. Otherwise the given list of fields
536 replaces the default set of report fields.
537 Report output may be sorted by multiple user-defined keys using
539 the --sort option. The option expects a comma separated list of
540 keys, with optional '+' and '-' prefixes indicating ascending
541 and descending sort for that field respectively.
542 boom host show [profile_id] [--profile os_id] [--version version]
544 [--name osname] [--short-name osshortname] [--os-version ver‐
545 sion]
546 Display host profiles matching selection criteria on standard
547 out.
548 Host profiles matching the criteria given on the command line
550 are printed to the terminal in a compact multi-line format.
551
554 Boom is able to write the current set of boot entries into the configu‐
555 ration file of a legacy boot loader installed on the system. This may
556 be used either on platforms that do not have a native bootloader sup‐
557 porting the Boot Loader Specification, or to allow upgrades and recov‐
558 ery from an installation lacking BLS support (if the system is updated
559 to a distribution that does support the BLS boot loader configuration
560 it will be used automatically when present).
561 Legacy support is enabled and configured via the boom.conf(5) configu‐
563 ration file.
564 boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
566 [--version version] [--name osname] [--short-name osshortname]
567 [--os-version version] [--root-device device] [--root-lv lv]
568 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
569 subvol]
570 Write out the current set of Boom boot entries in the configured
571 legacy configuration file. The normal command line selection
572 options may be used to control the set of entries written to the
573 file.
574 boom legacy clear
576 Remove all Boom boot entries from the configured legacy configu‐
577 ration file.
578 boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
580 [--version version] [--name osname] [--short-name osshortname]
581 [--os-version version] [--root-device device] [--root-lv lv]
582 [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
583 subvol] Display the selected boot entries as they would appear
584 in the configured legacy boot loader format. The normal command
585 line selection options may be used to control the set of entries
586 written to the terminal.
587
589 The boom report provides several types of field that may be added to
590 the default field set for either Boot Entry or OS Profile reports, or
591 used to create custom reports.
592 Boot Parameters
594 Boot parameter fields represent the properties that distinguish boot
595 entries: the kernel version and root device configuration.
596 version
598 The kernel version of this Boot Entry.
599 rootdev
601 The root device of this Boot Entry.
602 rootlv The root logical volume of this Boot Entry in 'VG/LV' notation.
604 subvolpath
606 The BTRFS subvolume path for this Boot Entry.
607 subvolid
609 The BTRFS subvolume ID for this BootEntry.
610 Boot Entry fields
612 Boot Entry fields provide information about an entry not specified by
613 its Boot Parameters, including the title, boot identifier, boot image
614 locations, and options required to boot the entry.
615 bootid Boot identifier.
617 title The entry title as displayed in the boot loader.
619 options
621 The kernel command line options used to boot this entry.
622 kernel The path to the bootable kernel image, relative to the boot
624 loader.
625 initramfs
627 The path to the initramfs image, relative to the boot loader.
628 machineid
630 The machine-id associated with this Boot Entry.
631 entrypath
633 The absolute path to this Boot Entry's on-disk configuration
634 file.
635 OS Profile fields
637 OS Profile fields provide access to the details of a profile's configu‐
638 ration including identity fields and the template strings used to gen‐
639 erate entries.
640 Since each Boot Entry has an attached OS Profile all profile fields are
642 also available to add to any Boot Entry report.
643 osid OS profile identifier.
645 osname The name of this OS prorile as read from os-release.
647 osshortname
649 The short name of this OS profile as read from os-release.
650 osversion
652 The OS version of this OS profile as read from os-release.
653 osversion_id
655 The OS version identifier of this OS profile as read from os-
656 release.
657 unamepattern
659 The configured UTS release pattern for this OS profile.
660 kernelpattern
662 The configured kernel image template for this OS profile.
663 initrdpattern
665 The configured initramfs image template for this OS profile.
666 lvm2opts
668 The configured LVM2 root device options template for this OS
669 profile.
670 btrfsopts
672 The configured BTRFS root options template for this OS profile.
673 options
675 The kernel command line options template for this OS profile.
676 profilepath
678 The absolute path to this OS Profile's on-disk configuration
679 file.
680
682 Both the entry list and profile list commands use a common reporting
683 system to display the results of the query. The selection of fields,
684 and the order in which they are displayed, may be controlled to produce
685 custom report formats.
686 Displaying the available boot entry fields
688 # boom list -o help
689 Boot loader entries Fields
690 --------------------------
691 bootid - Boot identifier [sha]
692 title - Entry title [str]
693 options - Kernel options [str]
694 kernel - Kernel image [str]
695 initramfs - Initramfs image [str]
696 machineid - Machine identifier [sha]
697 entrypath - On-disk entry path [str]
698 OS profiles Fields
700 ------------------
701 osid - OS identifier [sha]
702 osname - OS name [str]
703 osshortname - OS short name [str]
704 osversion - OS version [str]
705 osversion_id - Version identifier [str]
706 unamepattern - UTS name pattern [str]
707 kernelpattern - Kernel image pattern [str]
708 initrdpattern - Initrd pattern [str]
709 lvm2opts - LVM2 options [str]
710 btrfsopts - BTRFS options [str]
711 options - Kernel options [str]
712 profilepath - On-disk profile path [str]
713 Boot parameters Fields
715 ----------------------
716 version - Kernel version [str]
717 rootdev - Root device [str]
718 rootlv - Root logical volume [str]
719 subvolpath - BTRFS subvolume path [str]
720 subvolid - BTRFS subvolume ID [num]
721 Displaying the available OS profile fields
723 # boom profile list -o help
724 OS profiles Fields
725 ------------------
726 osid - OS identifier [sha]
727 osname - OS name [str]
728 osshortname - OS short name [str]
729 osversion - OS version [str]
730 osversion_id - Version identifier [str]
731 unamepattern - UTS name pattern [str]
732 kernelpattern - Kernel image pattern [str]
733 initrdpattern - Initrd pattern [str]
734 lvm2opts - LVM2 options [str]
735 btrfsopts - BTRFS options [str]
736 options - Kernel options [str]
737 profilepath - On-disk profile path [str]
738 Selecting custom fields for the entry list and profile list commands
740 # boom list -o bootid,osname
741 BootID Name
742 0d3e547 Fedora
743 bc18de2 Fedora
744 576fe39 Fedora
745 1838f58 Fedora
746 81520ca Fedora
747 327e24a Fedora
748 Adding additional fields to the default set
750 # boom list -o +options
751 BootID Version Name RootDevice
752 Options
753 0d3e547 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
754 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
755 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
756 rd.auto=1
757 bc18de2 4.13.5-200.fc26.x86_64 Fedora
758 /dev/vg_hex/root-snap10 BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
759 root=/dev/vg_hex/root-snap10 ro rd.lvm.lv=vg_hex/root-snap10
760 576fe39 4.13.5-200.fc26.x86_64 Fedora
761 /dev/vg_hex/root BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
762 root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root
763 1838f58 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
764 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
765 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
766 81520ca 4.13.13-200.fc26.x86_64 Fedora /dev/map‐
767 per/vg_hex-root BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
768 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
769 LANG=en_GB.UTF-8
770 327e24a 4.13.5-200.fc26.x86_64 Fedora
771 /dev/vg_hex/root BOOT_IMAGE=%{linux} root=/dev/vg_hex/root ro
772 rd.lvm.lv=vg_hex/root
773 Sort operating system profiles by ascending OS name and descending OS
775 version
776 # boom profile list -O+osname,-osversion
777 OsID Name OsVersion
778 d4439b7 Fedora 26 (Workstation Edition)
779 9736c34 Fedora 25 (Server Edition)
780 9cb53dd Fedora 24 (Workstation Edition)
781 6bf746b Fedora 24 (Server Edition)
782 b99ea5f Red Hat Enterprise Linux Server 8 (Server)
783 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
784 c0b921e Red Hat Enterprise Linux Server 7 (Server)
785 98c3edb Red Hat Enterprise Linux Server 6 (Server)
786 b730331 Red Hat Enterprise Linux Server 5 (Server)
787 efd6d41 Red Hat Enterprise Linux Server 4 (Server)
788 21e37c8 Ubuntu 16.04 LTS (Xenial Xerus)
789
791 List the available operating system profiles
792 # boom profile list
793 OsID Name OsVersion
794 efd6d41 Red Hat Enterprise Linux Server 4 (Server)
795 b730331 Red Hat Enterprise Linux Server 5 (Server)
796 98c3edb Red Hat Enterprise Linux Server 6 (Server)
797 c0b921e Red Hat Enterprise Linux Server 7 (Server)
798 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
799 b99ea5f Red Hat Enterprise Linux Server 8 (Server)
800 List the available boot entries
802 # boom list
803 BootID Version Name RootDevice
804 0d3e547 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
805 per/vg00-lvol0
806 bc18de2 4.13.5-200.fc26.x86_64 Fedora
807 /dev/vg00/lvol0-snap10
808 576fe39 4.13.5-200.fc26.x86_64 Fedora
809 /dev/vg00/lvol0
810 f52ba10 4.11.12-100.fc24.x86_64 Fedora
811 /dev/vg00/lvol0-snap
812 1838f58 4.13.5-200.fc26.x86_64 Fedora /dev/map‐
813 per/vg00-lvol0
814 81520ca 4.13.13-200.fc26.x86_64 Fedora /dev/map‐
815 per/vg00-lvol0
816 327e24a 4.13.5-200.fc26.x86_64 Fedora
817 /dev/vg00/lvol0
818 Create an OS profile for the running system (using Fedora 26 as an
820 example)
821 # boom profile create --from-host --uname-pattern fc26
822 Created profile with os_id d4439b7:
823 OS ID: "d4439b7d2f928c39f1160c0b0291407e5990b9e0",
824 Name: "Fedora", Short name: "fedora",
825 Version: "26 (Workstation Edition)", Version ID: "26",
826 UTS release pattern: "fc26",
827 Kernel pattern: "/kernel-%{version}", Initramfs pattern:
828 "/initramfs-%{version}.img",
829 Root options (LVM2): "rd.lvm.lv=%{lvm_root_lv}",
830 Root options (BTRFS): "rootflags=%{btrfs_subvolume}",
831 Options: "root=%{root_device} ro %{root_opts}"
832 Create a new boot entry for a specific OS profile and version
834 # boom profile list --short-name rhel
835 OsID Name OsVersion
836 3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
837 98c3edb Red Hat Enterprise Linux Server 6 (Server)
838 c0b921e Red Hat Enterprise Linux Server 7 (Server)
839 # boom create --profile 3fc389b --title "RHEL7 snapshot" --version
841 3.10-272.el7 --root-lv vg00/lvol0-snap
842 Created entry with boot_id a5aef11:
843 title RHEL7 snapshot
844 machine-id 611f38fd887d41dea7eb3403b2730a76
845 version 3.10-272.el7
846 linux /boot/vmlinuz-3.10-272.el7
847 initrd /boot/initramfs-3.10-272.el7.img
848 options root=/dev/vg00/lvol0-snap ro rd.lvm.lv=vg00/lvol0-snap rhgb
849 quiet
850 Create a new boot entry for the running system, changing only the root
852 logical volume
853 # boom create --title Snap1 --root-lv vg00/lvol0-snap1
854 Created entry with boot_id e077490:
855 title Snap1
856 machine-id 611f38fd887d41dea7eb3403b2730a76
857 version 4.13.13-200.fc26.x86_64
858 linux /vmlinuz-4.13.13-200.fc26.x86_64
859 initrd /initramfs-4.13.13-200.fc26.x86_64.img
860 options BOOT_IMAGE=/vmlinuz-4.13.13-200.fc26.x86_64
861 root=/dev/vg00/lvol0-snap1 ro rd.lvm.lv=vg00/lvol0-snap1
862 Delete an entry by its boot identifier
864 # boom delete --boot-id e077490
865 Deleted 1 entry
866 Delete all entries for the Fedora 24 OS profile
868 # boom delete --name Fedora --os-version-id 24 Deleted 4 entries
869
871 Bryn M. Reeves <bmr@redhat.com>
872
874 Boom project page: https://github.com/bmr-cymru/boom
875 Boot to snapshot documentation: https://github.com/bmr-cymru/snapshot-
876 boot-docs
877 BootLoader Specification: https://systemd.io/BOOT_LOADER_SPECIFICATION
878 LVM2 resource page: https://www.sourceware.org/lvm2/
879 Device-mapper resource page: http://sources.redhat.com/dm/
880Linux Oct 30 2017 BOOM(8)