1BOOM(8)                      MAINTENANCE COMMANDS                      BOOM(8)
2
3
4

NAME

6       Boom — linux boot manager
7

SYNOPSIS

9       boom [entry|profile|host] [create|delete|clone|show|list|edit]
10
11       boom legacy [write|clear|show]
12
13       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
32       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
54       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
78       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

DESCRIPTION

91       Boom  is  a boot manager for Linux systems using boot loaders that sup‐
92       port the BootLoader Specification for boot entry configuration.
93
94       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
99       Boom  also supports writing configuration in legacy boot loader format:
100       currently the syntax used by the Grub1 configuration file is supported.
101
102       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
106

OPTIONS

108       -a|--add-opts opts
109              Specify additional boot options for this entry.
110
111       -d|--del-opts opts
112              Specify boot options to exclude from this entry.
113
114       -b|--boot-id|--bootid boot_id
115              Specify a boot identifier to operate on.
116
117       --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
121       -B|--btrfs-subvolme|--btrfssubvolume [subvol_path|subvol_id]
122              Specify a BTRFS subvolume by its path or identifier.
123
124       --btrfs-opts|--btrfsopts btrfs_options_template
125              An OS profile template string for BTRFS boot options.
126
127       --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
132       -e|--efi efi_image
133              Specify an EFI application image for a boot entry.
134
135       -H|--from-host|--fromhost
136              When  creating  a  new  OS profile, use os-release data from the
137              running host.
138
139       -P|--host-profile
140              Use the specified host profile for search or create operations.
141
142       -i|--initrd image_path
143              A Linux initial ramfs image path.
144
145       -k|--kernel-pattern|--kernelpattern pattern
146              An OS profile template used to generate kernel image paths.
147
148       -l|--linux image_path
149              A Linux kernel image path.
150
151       -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
156       --lvm-opts lvm_opts
157              An OS profile template used to generate LVM2 boot options.
158
159       -m|--machine-id|--machineid machine_id
160
161       -n|--name os_name
162              The name of a boom operating system profile.
163
164       --name-prefixes|--nameprefixes
165              Add a prefix to report field output names.
166
167       --no-headings|--noheadings
168              Suppress output of report headings.
169
170       -o|--options field_list
171              Specify which fields to display.
172
173       --os-version
174              The version string of a boom operating system profile.
175
176       -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
181       -I|--os-version-id|--osversionid os_version_id
182              A boom operating system profile version identifier.
183
184       --os-options|--osoptions options_template
185              An operating system profile template string used to generate the
186              kernel command line options string.
187
188       --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
192       -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
197       -r|--root-device|--rootdevice root_dev
198              The system root device for a new boot entry.
199
200       -R|--initramfs-pattern|--initramfspattern initramfs_pattern
201              An OS profile template used  to  generate  initial  ramfs  image
202              paths.
203
204       --rows
205              Output report columns as rows.
206
207       --separator separator
208              Report field separator
209
210       -s|--short-name|--shortname short_name The short name of a boom operat‐
211              ing system profile.
212
213       -t|--title entry_title
214              The title for a new boot entry.
215
216       -u|--uname-pattern|--unamepattern uname_pattern
217              An uname pattern to match for an operating system profile.
218
219       -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
224       -v|--version version
225              The kernel version of a boom boot entry.
226

OS Profiles and Boot Entries

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
233       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
239       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
243       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
247       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
251
252       Host Profiles
253
254       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
259       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
264
265       Boot Entry Commands
266
267       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
273              The title of the new entry must be set with the --title option.
274
275              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
279              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
285              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
289              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
294              A  BTRFS  subvolume  may  be set by either the subvolume path or
295              subvolume identifier using the --btrfs-subvol option.
296
297              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
303              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
315       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
323              For example, by giving --version, all entries matching the spec‐
324              ified kernel version can be removed at once.
325
326              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
330       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
336              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
340              On  success the new entry and its boot identifier are printed to
341              the terminal.
342
343       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
349              Displays  a  report  with  one  boot  entry per line, containing
350              fields describing the properties of the configured boot entries.
351
352              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
359              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
364       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
371              Boot entries matching the criteria given on the command line are
372              printed to the terminal in boot loader entry format.
373
374       OS Profile Commands
375
376       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
383              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
388              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
392              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
396              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
403              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
408              To create a profile for the  currently  running  host,  use  the
409              --from-host switch.
410
411              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
414       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
421              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
425              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
429       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
436              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
440              On success the new entry and its OS identifier  are  printed  to
441              the terminal.
442
443       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
448              Displays  a  report  with  one  OS  profile per line, containing
449              fields describing the properties of the configured OS profiles.
450
451              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
458              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
463       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
468              OS profiles matching the criteria given on the command line  are
469              printed to the terminal in a compact multi-line format.
470
471       Host Profile Commands
472
473       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
481       boom host delete [host_id] [--host-profile host_id]
482              Delete the specified host profile or profiles.
483
484              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
488              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
492       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
499              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
503              On success the new entry and its host identifier are printed  to
504              the terminal.
505
506       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
513              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
517              On  success  the new profile and its host identifier are printed
518              to the terminal.
519
520       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
527              Displays  a  report  with  one host profile per line, containing
528              fields describing the properties of  the  configured  host  pro‐
529              files.
530
531              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  field  list.  Otherwise  the  given  list of fields
534              replaces the default set of report fields.
535
536              Report output may be sorted by multiple user-defined keys  using
537              the  --sort option. The option expects a comma separated list of
538              keys, with optional '+' and '-'  prefixes  indicating  ascending
539              and descending sort for that field respectively.
540
541       boom host show [profile_id] [--profile os_id] [--version version]
542              [--name osname] [--short-name osshortname] [--os-version ver‐
543              sion]
544              Display  host  profiles  matching selection criteria on standard
545              out.
546
547              Host profiles matching the criteria given on  the  command  line
548              are printed to the terminal in a compact multi-line format.
549
550

LEGACY BOOTLOADER FORMATS

552       Boom is able to write the current set of boot entries into the configu‐
553       ration file of a legacy boot loader installed on the system.  This  may
554       be  used  either on platforms that do not have a native bootloader sup‐
555       porting the Boot Loader Specification, or to allow upgrades and  recov‐
556       ery  from an installation lacking BLS support (if the system is updated
557       to a distribution that does support the BLS boot  loader  configuration
558       it will be used automatically when present).
559
560       Legacy  support is enabled and configured via the boom.conf(5) configu‐
561       ration file.
562
563       boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
564              [--version version] [--name osname] [--short-name osshortname]
565              [--os-version version] [--root-device device] [--root-lv lv]
566              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
567              subvol]
568              Write out the current set of Boom boot entries in the configured
569              legacy  configuration  file.  The  normal command line selection
570              options may be used to control the set of entries written to the
571              file.
572
573       boom legacy clear
574              Remove all Boom boot entries from the configured legacy configu‐
575              ration file.
576
577       boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
578              [--version version] [--name osname] [--short-name osshortname]
579              [--os-version version] [--root-device device] [--root-lv lv]
580              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
581              subvol] Display the selected boot entries as they  would  appear
582              in  the configured legacy boot loader format. The normal command
583              line selection options may be used to control the set of entries
584              written to the terminal.
585

REPORT FIELDS

587       The  boom  report  provides several types of field that may be added to
588       the default field set for either Boot Entry or OS Profile  reports,  or
589       used to create custom reports.
590
591   Boot Parameters
592       Boot  parameter  fields  represent the properties that distinguish boot
593       entries: the kernel version and root device configuration.
594
595       version
596              The kernel version of this Boot Entry.
597
598       rootdev
599              The root device of this Boot Entry.
600
601       rootlv The root logical volume of this Boot Entry in 'VG/LV' notation.
602
603       subvolpath
604              The BTRFS subvolume path for this Boot Entry.
605
606       subvolid
607              The BTRFS subvolume ID for this BootEntry.
608
609   Boot Entry fields
610       Boot Entry fields provide information about an entry not  specified  by
611       its  Boot  Parameters, including the title, boot identifier, boot image
612       locations, and options required to boot the entry.
613
614       bootid Boot identifier.
615
616       title  The entry title as displayed in the boot loader.
617
618       options
619              The kernel command line options used to boot this entry.
620
621       kernel The path to the bootable kernel  image,  relative  to  the  boot
622              loader.
623
624       initramfs
625              The path to the initramfs image, relative to the boot loader.
626
627       machineid
628              The machine-id associated with this Boot Entry.
629
630       entrypath
631              The  absolute  path  to  this Boot Entry's on-disk configuration
632              file.
633
634   OS Profile fields
635       OS Profile fields provide access to the details of a profile's configu‐
636       ration  including identity fields and the template strings used to gen‐
637       erate entries.
638
639       Since each Boot Entry has an attached OS Profile all profile fields are
640       also available to add to any Boot Entry report.
641
642       osid   OS profile identifier.
643
644       osname The name of this OS prorile as read from os-release.
645
646       osshortname
647              The short name of this OS profile as read from os-release.
648
649       osversion
650              The OS version of this OS profile as read from  os-release.
651
652       osversion_id
653              The  OS  version  identifier of this OS profile as read from os-
654              release.
655
656       unamepattern
657              The configured UTS release pattern for this OS profile.
658
659       kernelpattern
660              The configured kernel image template for this OS profile.
661
662       initrdpattern
663              The configured initramfs image template for this OS profile.
664
665       lvm2opts
666              The configured LVM2 root device options  template  for  this  OS
667              profile.
668
669       btrfsopts
670              The configured BTRFS root options template for this OS profile.
671
672       options
673              The kernel command line options template for this OS profile.
674
675       profilepath
676              The  absolute  path  to  this OS Profile's on-disk configuration
677              file.
678

REPORTING COMMANDS

680       Both the entry list and profile list commands use  a  common  reporting
681       system  to  display  the results of the query. The selection of fields,
682       and the order in which they are displayed, may be controlled to produce
683       custom report formats.
684
685       Displaying the available boot entry fields
686       # boom list -o help
687       Boot loader entries Fields
688       --------------------------
689         bootid        - Boot identifier [sha]
690         title         - Entry title [str]
691         options       - Kernel options [str]
692         kernel        - Kernel image [str]
693         initramfs     - Initramfs image [str]
694         machineid     - Machine identifier [sha]
695         entrypath     - On-disk entry path [str]
696
697       OS profiles Fields
698       ------------------
699         osid          - OS identifier [sha]
700         osname        - OS name [str]
701         osshortname   - OS short name [str]
702         osversion     - OS version [str]
703         osversion_id  - Version identifier [str]
704         unamepattern  - UTS name pattern [str]
705         kernelpattern - Kernel image pattern [str]
706         initrdpattern - Initrd pattern [str]
707         lvm2opts      - LVM2 options [str]
708         btrfsopts     - BTRFS options [str]
709         options       - Kernel options [str]
710         profilepath   - On-disk profile path [str]
711
712       Boot parameters Fields
713       ----------------------
714         version       - Kernel version [str]
715         rootdev       - Root device [str]
716         rootlv        - Root logical volume [str]
717         subvolpath    - BTRFS subvolume path [str]
718         subvolid      - BTRFS subvolume ID [num]
719
720       Displaying the available OS profile fields
721       # boom profile list -o help
722       OS profiles Fields
723       ------------------
724         osid          - OS identifier [sha]
725         osname        - OS name [str]
726         osshortname   - OS short name [str]
727         osversion     - OS version [str]
728         osversion_id  - Version identifier [str]
729         unamepattern  - UTS name pattern [str]
730         kernelpattern - Kernel image pattern [str]
731         initrdpattern - Initrd pattern [str]
732         lvm2opts      - LVM2 options [str]
733         btrfsopts     - BTRFS options [str]
734         options       - Kernel options [str]
735         profilepath   - On-disk profile path [str]
736
737       Selecting custom fields for the entry list and profile list commands
738       # boom list -o bootid,osname
739       BootID  Name
740       0d3e547 Fedora
741       bc18de2 Fedora
742       576fe39 Fedora
743       1838f58 Fedora
744       81520ca Fedora
745       327e24a Fedora
746
747       Adding additional fields to the default set
748       # boom list -o +options
749       BootID   Version                   Name                      RootDevice
750       Options
751       0d3e547  4.13.5-200.fc26.x86_64    Fedora                     /dev/map‐
752       per/vg_hex-root             BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
753       root=/dev/mapper/vg_hex-root  ro   rd.lvm.lv=vg_hex/root   rhgb   quiet
754       rd.auto=1
755       bc18de2                 4.13.5-200.fc26.x86_64                   Fedora
756       /dev/vg_hex/root-snap10      BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
757       root=/dev/vg_hex/root-snap10 ro rd.lvm.lv=vg_hex/root-snap10
758       576fe39                 4.13.5-200.fc26.x86_64                   Fedora
759       /dev/vg_hex/root             BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
760       root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root
761       1838f58   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
762       per/vg_hex-root             BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
763       root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
764       81520ca   4.13.13-200.fc26.x86_64   Fedora                    /dev/map‐
765       per/vg_hex-root              BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
766       root=/dev/mapper/vg_hex-root   ro   rd.lvm.lv=vg_hex/root   rhgb  quiet
767       LANG=en_GB.UTF-8
768       327e24a                 4.13.5-200.fc26.x86_64                   Fedora
769       /dev/vg_hex/root         BOOT_IMAGE=%{linux}  root=/dev/vg_hex/root  ro
770       rd.lvm.lv=vg_hex/root
771
772       Sort operating system profiles by ascending OS name and  descending  OS
773       version
774       # boom profile list -O+osname,-osversion
775       OsID    Name                            OsVersion
776       d4439b7 Fedora                          26 (Workstation Edition)
777       9736c34 Fedora                          25 (Server Edition)
778       9cb53dd Fedora                          24 (Workstation Edition)
779       6bf746b Fedora                          24 (Server Edition)
780       b99ea5f Red Hat Enterprise Linux Server 8 (Server)
781       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
782       c0b921e Red Hat Enterprise Linux Server 7 (Server)
783       98c3edb Red Hat Enterprise Linux Server 6 (Server)
784       b730331 Red Hat Enterprise Linux Server 5 (Server)
785       efd6d41 Red Hat Enterprise Linux Server 4 (Server)
786       21e37c8 Ubuntu                          16.04 LTS (Xenial Xerus)
787

EXAMPLES

789       List the available operating system profiles
790       # boom profile list
791       OsID    Name                            OsVersion
792       efd6d41 Red Hat Enterprise Linux Server 4 (Server)
793       b730331 Red Hat Enterprise Linux Server 5 (Server)
794       98c3edb Red Hat Enterprise Linux Server 6 (Server)
795       c0b921e Red Hat Enterprise Linux Server 7 (Server)
796       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
797       b99ea5f Red Hat Enterprise Linux Server 8 (Server)
798
799       List the available boot entries
800       # boom list
801       BootID  Version                  Name                     RootDevice
802       0d3e547   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
803       per/vg00-lvol0
804       bc18de2                 4.13.5-200.fc26.x86_64                   Fedora
805       /dev/vg00/lvol0-snap10
806       576fe39                 4.13.5-200.fc26.x86_64                   Fedora
807       /dev/vg00/lvol0
808       f52ba10                 4.11.12-100.fc24.x86_64                  Fedora
809       /dev/vg00/lvol0-snap
810       1838f58   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
811       per/vg00-lvol0
812       81520ca  4.13.13-200.fc26.x86_64   Fedora                     /dev/map‐
813       per/vg00-lvol0
814       327e24a                 4.13.5-200.fc26.x86_64                   Fedora
815       /dev/vg00/lvol0
816
817       Create an OS profile for the running system  (using  Fedora  26  as  an
818       example)
819       # boom profile create --from-host --uname-pattern fc26
820       Created profile with os_id d4439b7:
821         OS ID: "d4439b7d2f928c39f1160c0b0291407e5990b9e0",
822         Name: "Fedora", Short name: "fedora",
823         Version: "26 (Workstation Edition)", Version ID: "26",
824         UTS release pattern: "fc26",
825         Kernel     pattern:    "/kernel-%{version}",    Initramfs    pattern:
826       "/initramfs-%{version}.img",
827         Root options (LVM2): "rd.lvm.lv=%{lvm_root_lv}",
828         Root options (BTRFS): "rootflags=%{btrfs_subvolume}",
829         Options: "root=%{root_device} ro %{root_opts}"
830
831       Create a new boot entry for a specific OS profile and version
832       # boom profile list --short-name rhel
833       OsID    Name                            OsVersion
834       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
835       98c3edb Red Hat Enterprise Linux Server 6 (Server)
836       c0b921e Red Hat Enterprise Linux Server 7 (Server)
837
838       # boom create --profile  3fc389b  --title  "RHEL7  snapshot"  --version
839       3.10-272.el7 --root-lv vg00/lvol0-snap
840       Created entry with boot_id a5aef11:
841       title RHEL7 snapshot
842       machine-id 611f38fd887d41dea7eb3403b2730a76
843       version 3.10-272.el7
844       linux /boot/vmlinuz-3.10-272.el7
845       initrd /boot/initramfs-3.10-272.el7.img
846       options  root=/dev/vg00/lvol0-snap  ro  rd.lvm.lv=vg00/lvol0-snap  rhgb
847       quiet
848
849       Create a new boot entry for the running system, changing only the  root
850       logical volume
851       # boom create --title Snap1 --root-lv vg00/lvol0-snap1
852       Created entry with boot_id e077490:
853         title Snap1
854         machine-id 611f38fd887d41dea7eb3403b2730a76
855         version 4.13.13-200.fc26.x86_64
856         linux /vmlinuz-4.13.13-200.fc26.x86_64
857         initrd /initramfs-4.13.13-200.fc26.x86_64.img
858         options                   BOOT_IMAGE=/vmlinuz-4.13.13-200.fc26.x86_64
859       root=/dev/vg00/lvol0-snap1 ro rd.lvm.lv=vg00/lvol0-snap1
860
861       Delete an entry by its boot identifier
862       # boom delete --boot-id e077490
863       Deleted 1 entry
864
865       Delete all entries for the Fedora 24 OS profile
866       # boom delete --name Fedora --os-version-id 24 Deleted 4 entries
867

AUTHORS

869       Bryn M. Reeves <bmr@redhat.com>
870

SEE ALSO

872       Boom project page: https://github.com/bmr-cymru/boom
873       Boot to snapshot documentation:  https://github.com/bmr-cymru/snapshot-
874       boot-docs
875       BootLoader Specification: https://systemd.io/BOOT_LOADER_SPECIFICATION
876       LVM2 resource page: https://www.sourceware.org/lvm2/
877       Device-mapper resource page: http://sources.redhat.com/dm/
878
879
880
881Linux                             Oct 30 2017                          BOOM(8)
Impressum