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

NAME

6       Boom — linux boot manager
7

SYNOPSIS

9       boom [entry|profile] [create|delete|clone|show|list|edit]
10
11       boom entry create [--profile os_id] [--version version] [--root-device
12              device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
13              trd_path] [--btrfs-subvol subvol]
14       boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
15              [--version version]
16       boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
17              [--version version] [--root-device device] [--root-lv lv]
18              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
19              subvol]
20       boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
21              sion version] [--name osname] [--short-name osshortname] [--os-
22              version version] [--root-device device] [--root-lv lv] [--linux
23              kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
24       boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
25              sion version] [--name osname] [--short-name osshortname] [--os-
26              version version] [--root-device device] [--root-lv lv] [--btrfs-
27              subvol subvol]
28
29       boom profile create [--name osname] [--short-name short_name] [--os-
30              version version] [--os-version-id version_id] [--from-host]
31              [--os-release os_release] [--uname-pattern uname_pattern]
32              [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
33              os_options]
34       boom profile delete [profile_id] [--profile os_id] [--name osname]
35              [--short-name short_name] [--os-version version] [--os-version-
36              id version_id] [--from-host] [--os-release os_release] [--uname-
37              pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
38              btrfs_opts] [--os-options os_options]
39       boom profile clone [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 list [profile_id] [--profile os_id] [--version version]
45              [--name osname] [--short-name osshortname] [--os-version ver‐
46              sion]
47       boom profile show [profile_id] [--profile os_id] [--version version]
48              [--name osname] [--short-name osshortname] [--os-version ver‐
49              sion]
50       boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
51              [--version version] [--name osname] [--short-name osshortname]
52              [--os-version version] [--root-device device] [--root-lv lv]
53              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
54              subvol]
55       boom legacy clear
56       boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
57              [--version version] [--name osname] [--short-name osshortname]
58              [--os-version version] [--root-device device] [--root-lv lv]
59              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
60              subvol]
61

DESCRIPTION

63       Boom  is  a boot manager for Linux systems using boot loaders that sup‐
64       port the BootLoader Specification for boot entry configuration.
65
66       Boom works best with a BLS compatible boot loader: either the  systemd-
67       boot  project,  or  Grub2  with  the `bls` patch. The grub2 boot loader
68       included in Fedora and Red Hat Enterprise Linux include this support.
69
70       Boom also supports writing configuration in legacy boot loader  format:
71       currently the syntax used by the Grub1 configuration file is supported.
72
73       All  long  options  supported  by  boom  may be written with or without
74       dashes separating words. For example, --boot-id and --bootid  are  syn‐
75       onymous.
76
77

OPTIONS

79       -b|--boot-id|--bootid boot_id
80              Specify a boot identifier to operate on.
81
82       --boot-dir|--bootdir path
83              Specify  the location of the /boot file system. Useful for test‐
84              ing or for accessing boom data from a system image.
85
86       -B|--btrfs-subvolme|--btrfssubvolume [subvol_path|subvol_id]
87              Specify a BTRFS subvolume by its path or identifier.
88
89       --btrfs-opts|--btrfsopts btrfs_options_template
90              An OS profile template string for BTRFS boot options.
91
92       --debug debug_flags
93              A comma-separated list of subsystem names  to  enable  debugging
94              output  for,  or  'all'  to  enable all debugging. The available
95              debug classes are: profile, entry, command, report.
96
97       -e|--efi efi_image
98              Specify an EFI application image for a boot entry.
99
100       -H|--from-host|--fromhost
101              When creating a new OS profile, use  os-release  data  from  the
102              running host.
103
104       -i|--initrd image_path
105              A Linux initial ramfs image path.
106
107       -k|--kernel-pattern|--kernelpattern pattern
108              An OS profile template used to generate kernel image paths.
109
110       -l|--linux image_path
111              A Linux kernel image path.
112
113       -L|--root-lv|--rootlv root_lv
114              The  logical  volume  containing the root file system for a boot
115              entry.  If --root-lv is given, but  --root-device  is  not,  the
116              root device is assumed to be the specified logical volume.
117
118       --lvm-opts lvm_opts
119              An OS profile template used to generate LVM2 boot options.
120
121       -m|--machine-id|--machineid machine_id
122
123       -n|--name os_name
124              The name of a boom operating system profile.
125
126       --name-prefixes|--nameprefixes
127              Add a prefix to report field output names.
128
129       --no-headings|--noheadings
130              Suppress output of report headings.
131
132       -o|--options field_list
133              Specify which fields to display.
134
135       --os-version
136              The version string of a boom operating system profile.
137
138       -O|--sort key_list
139              A  comma-separated  list  of  sort  keys  (field names), with an
140              optional per-field prefix of  +  or  -  to  force  ascending  or
141              descending sort order respectively for that field.
142
143       -I|--os-version-id|--osversionid os_version_id
144              A boom operating system profile version identifier.
145
146       --os-options|--osoptions options_template
147              An operating system profile template string used to generate the
148              kernel command line options string.
149
150       --os-release|--osrelease os_release_path
151              A path to a file in os-release(5) from which  to  create  a  new
152              operating system profile.
153
154       -p|--profile os_id
155              The operating system identifier (os_id) of a boom operating sys‐
156              tem profile to use for the current operation. Defaults to the OS
157              profile of the running system if absent.
158
159       -r|--root-device|--rootdevice root_dev
160              The system root device for a new boot entry.
161
162       -R|--initramfs-pattern|--initramfspattern initramfs_pattern
163              An  OS  profile  template  used  to generate initial ramfs image
164              paths.
165
166       --rows
167              Output report columns as rows.
168
169       --separator separator
170              Report field separator
171
172       -s|--short-name|--shortname short_name The short name of a boom operat‐
173              ing system profile.
174
175       -t|--title entry_title
176              The title for a new boot entry.
177
178       -u|--uname-pattern|--unamepattern uname_pattern
179              An uname pattern to match for an operating system profile.
180
181       -V|--verbose
182              Increase  verbosity  level. Specify multiple times, or set addi‐
183              tional debug classed with --debug to enable  more  verbose  mes‐
184              sages.
185
186       -v|--version version
187              The kernel version of a boom boot entry.
188

OS Profiles and Boot Entries

190       Boom  manages  boot  loader entries for one or more installed operating
191       systems. Each operating system is identified by an OS Profile that pro‐
192       vides  identity  information and a set of templates used to create boot
193       loader entries.
194
195       An OS profile is identified by its os_id, an alphanumeric string  based
196       on  an  SHA  digest  of  the  profile's  identity  fields.  Identifiers
197       reported in boom command output are automatically  abbreviated  to  the
198       minimum length required to ensure uniqueness and this short form may be
199       used in any place where a boom OS identifier is expected.
200
201       A Boot Entry represents one bootable instance of an installed operating
202       system:  a  kernel, optional initial ramfs image, command line options,
203       and other images or settings required for boot.
204
205       Each boot entry is also identified by a SHA  based  unique  identifier:
206       the boot_id. An entry's ID is used to select an entry for display, mod‐
207       ification, deletion or other operations.
208
209       Since the boot entry's identifier is based on the boot parameters  used
210       to  create  the  entry, the boot_id will change if an existing entry is
211       modified (for e.g. with the boom entry edit command).
212
213       Boot Entry Commands
214
215       boom entry create [--profile os_id] [--version version] [--root-device
216              device] [--root-lv lv] [--linux kernel_path] [--initrd ini‐
217              trd_path] [--btrfs-subvol subvol]
218              Create a new boot entry using the specified values.
219
220              The title of the new entry must be set with the --title option.
221
222              The kernel version for the new entry is  given  with  --version.
223              If --version is not present the version is assumed to be that of
224              the currently running kernel.
225
226              If --profile is given, it specifies  the  OS  identifier  of  an
227              existing  OS  profile  to use for the new entry. If --profile is
228              not given, and a profile exists that matches either the supplied
229              or  detected  version  then  that  profile will be automatically
230              used.
231
232              The machine-id of the new entry is automatically set to the cur‐
233              rent machine-id (read from /etc/machine-id) unless this is over‐
234              ridden by the --machine-id switch.
235
236              A root device may be explicitly specified with the --root-device
237              option  or  if an LVM2 logical volume is used this may be speci‐
238              fied with --root-lv: in this case the root device is assumed  to
239              be the normal device path of the specified logical volume.
240
241              A  BTRFS  subvolume  may  be set by either the subvolume path or
242              subvolume identifier using the --btrfs-subvol option.
243
244              The newly created entry and its boot identifier are  printed  to
245              the terminal on success:
246              # boom create --title 'System Snapshot' --root-lv vg00/lvol0
247              Created entry with boot_id 14d6b6e:
248                title System Snapshot
249                machine-id 611f38fd887d41dea7eb3403b2730a76
250                version 4.13.5-200.fc26.x86_64
251                linux /vmlinuz-4.13.5-200.fc26.x86_64
252                initrd /initramfs-4.13.5-200.fc26.x86_64.img
253                options             BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
254              root=/dev/vg00/lvol0 ro rd.lvm.lv=vg00/lvol0 rhgb quiet
255
256       boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id]
257              [--version version]
258              Delete  the  specified  boot  entry.  The entry to delete may be
259              specified either by its boot identifier, in which case  at  most
260              one  entry  will be removed, or by specifying selection criteria
261              which may match (and remove) multiple entries in a single opera‐
262              tion.
263
264              For example, by giving --version, all entries matching the spec‐
265              ified kernel version can be removed at once.
266
267              On success the number of entries removed is printed to the  ter‐
268              minal.   If  the  --verbose option is given then a report of the
269              entries removed will also be displayed.
270
271       boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id]
272              [--version version] [--root-device device] [--root-lv lv]
273              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
274              subvol]
275              Clone an existing boot entry and modify its configuration.
276
277              The  entry  to  clone  must be specified by its boot identifier.
278              Any remaining command line arguments are taken to  be  modifica‐
279              tions to the original entry.
280
281              On  success the new entry and its boot identifier are printed to
282              the terminal.
283
284       boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
285              sion version] [--name osname] [--short-name osshortname] [--os-
286              version version] [--root-device device] [--root-lv lv] [--linux
287              kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
288              Output a tabular report of boot entries.
289
290              Displays  a  report  with  one  boot  entry per line, containing
291              fields describing the properties of the configured boot entries.
292
293              The list of fields to display is given with --options as a comma
294              separated  list  of  field  names. To obtain a list of available
295              fields run 'boom list -o help'. If the  list  of  fields  begins
296              with  the '+' character the specified fields are appended to the
297              default field list. Otherwise the given list of fields  replaces
298              the default set of report fields.
299
300              Report  output may be sorted by multiple user-defined keys using
301              the --sort option. The option expects a comma separated list  of
302              keys,  with  optional  '+' and '-' prefixes indicating ascending
303              and descending sort for that field respectively.
304
305       boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--ver‐
306              sion version] [--name osname] [--short-name osshortname] [--os-
307              version version] [--root-device device] [--root-lv lv] [--btrfs-
308              subvol subvol]
309              Display  boot  entries  matching  selection criteria on standard
310              out.
311
312              Boot entries matching the criteria given on the command line are
313              printed to the terminal in boot loader entry format.
314
315       OS Profile Commands
316
317       boom profile create [--name osname] [--short-name short_name] [--os-
318              version version] [--os-version-id version_id] [--from-host]
319              [--os-release os_release] [--uname-pattern uname_pattern]
320              [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options
321              os_options]
322              Create a new OS profile using the specified values.
323
324              A  new  OS  profile can be created either by specifying required
325              values on the boom command line, or by reading data from  either
326              the  hosts's  os-release  file  (at  /etc/os-release),  or  from
327              another file in os-release format specified on the command line.
328
329              The information read from os-release (or equivalent command line
330              options)  form  the profile's identity and are the basis for the
331              profile OS identifier.
332
333              In addition to the os-release data a new OS profile  requires  a
334              uname  version string pattern to match, and template values used
335              to construct boot entries.
336
337              The uname pattern must be given on the  profile  create  command
338              line and is a regular expression matching the UTS release (uname
339              -r) values reported by that distribution. The  pattern  is  only
340              used to attempt to match unknown boot entries to a valid OS pro‐
341              file: for example entries that have  been  manually  edited,  or
342              that were created by another tool.
343
344              The  boom  command  provides default templates that are suitable
345              for most Linux distributions. Alternately, these values  may  be
346              set on the command line at the time of profile creation, or mod‐
347              ified using the boom program at a later time.
348
349              To create a profile for the  currently  running  host,  use  the
350              --from-host switch.
351
352              To  create  a profile from a saved os-release file use the --os-
353              release optiona and give the path to the file to be used.
354
355       boom profile delete [profile_id] [--profile os_id] [--name osname]
356              [--short-name short_name] [--os-version version] [--os-version-
357              id version_id] [--from-host] [--os-release os_release] [--uname-
358              pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
359              btrfs_opts] [--os-options os_options]
360              Delete the specified Os profile or profiles.
361
362              Delete all OS profiles matching the provided selection criteria.
363              If the --profile option is used to specify an OS identifier then
364              at most one profile will be removed.
365
366              On success the number of profiles removed is printed to the ter‐
367              minal.   If  the  --verbose option is given then a report of the
368              profiles removed will also be displayed.
369
370       boom profile clone [profile_id] [--profile os_id] [--name osname]
371              [--short-name short_name] [--os-version version] [--os-version-
372              id version_id] [--from-host] [--os-release os_release] [--uname-
373              pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts
374              btrfs_opts] [--os-options os_options]
375              Clone an existing OS profile and modify its configuration.
376
377              The entry to clone must be specified by its OS identifier.   Any
378              remaining  command  line arguments are taken to be modifications
379              to the original entry.
380
381              On success the new entry and its OS identifier  are  printed  to
382              the terminal.
383
384       boom profile list [profile_id] [--profile os_id] [--version version]
385              [--name osname] [--short-name osshortname] [--os-version ver‐
386              sion]
387              Output a tabular report of OS profiles.
388
389              Displays  a  report  with  one  OS  profile per line, containing
390              fields describing the properties of the configured OS profiles.
391
392              The list of fields to display is given with --options as a comma
393              separated  list  of  field  names. To obtain a list of available
394              fields run 'boom list -o help'. If the  list  of  fields  begins
395              with  the '+' character the specified fields are appended to the
396              default field list. Otherwise the given list of fields  replaces
397              the default set of report fields.
398
399              Report  output may be sorted by multiple user-defined keys using
400              the --sort option. The option expects a comma separated list  of
401              keys,  with  optional  '+' and '-' prefixes indicating ascending
402              and descending sort for that field respectively.
403
404       boom profile show [profile_id] [--profile os_id] [--version version]
405              [--name osname] [--short-name osshortname] [--os-version ver‐
406              sion]
407              Display OS profiles matching selection criteria on standard out.
408
409              OS profiles matching the criteria given on the command line  are
410              printed to the terminal in a compact multi-line format.
411

LEGACY BOOTLOADER FORMATS

413       Boom is able to write the current set of boot entries into the configu‐
414       ration file of a legacy boot loader installed on the system.  This  may
415       be  used  either on platforms that do not have a native bootloader sup‐
416       porting the Boot Loader Specification, or to allow upgrades and  recov‐
417       ery  from an installation lacking BLS support (if the system is updated
418       to a distribution that does support the BLS boot  loader  configuration
419       it will be used automatically when present).
420
421       Legacy  support is enabled and configured via the boom.conf(5) configu‐
422       ration file.
423
424       boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id]
425              [--version version] [--name osname] [--short-name osshortname]
426              [--os-version version] [--root-device device] [--root-lv lv]
427              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
428              subvol]
429              Write out the current set of Boom boot entries in the configured
430              legacy  configuration  file.  The  normal command line selection
431              options may be used to control the set of entries written to the
432              file.
433
434       boom legacy clear
435              Remove all Boom boot entries from the configured legacy configu‐
436              ration file.
437
438       boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id]
439              [--version version] [--name osname] [--short-name osshortname]
440              [--os-version version] [--root-device device] [--root-lv lv]
441              [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol
442              subvol] Display the selected boot entries as they  would  appear
443              in  the configured legacy boot loader format. The normal command
444              line selection options may be used to control the set of entries
445              written to the terminal.
446

REPORT FIELDS

448       The  boom  report  provides several types of field that may be added to
449       the default field set for either Boot Entry or OS Profile  reports,  or
450       used to create custom reports.
451
452   Boot Parameters
453       Boot  parameter  fields  represent the properties that distinguish boot
454       entries: the kernel version and root device configuration.
455
456       version
457              The kernel version of this Boot Entry.
458
459       rootdev
460              The root device of this Boot Entry.
461
462       rootlv The root logical volume of this Boot Entry in 'VG/LV' notation.
463
464       subvolpath
465              The BTRFS subvolume path for this Boot Entry.
466
467       subvolid
468              The BTRFS subvolume ID for this BootEntry.
469
470   Boot Entry fields
471       Boot Entry fields provide information about an entry not  specified  by
472       its  Boot  Parameters, including the title, boot identifier, boot image
473       locations, and options required to boot the entry.
474
475       bootid Boot identifier.
476
477       title  The entry title as displayed in the boot loader.
478
479       options
480              The kernel command line options used to boot this entry.
481
482       kernel The path to the bootable kernel  image,  relative  to  the  boot
483              loader.
484
485       initramfs
486              The path to the initramfs image, relative to the boot loader.
487
488       machineid
489              The machine-id associated with this Boot Entry.
490
491       entrypath
492              The  absolute  path  to  this Boot Entry's on-disk configuration
493              file.
494
495   OS Profile fields
496       OS Profile fields provide access to the details of a profile's configu‐
497       ration  including identity fields and the template strings used to gen‐
498       erate entries.
499
500       Since each Boot Entry has an attached OS Profile all profile fields are
501       also available to add to any Boot Entry report.
502
503       osid   OS profile identifier.
504
505       osname The name of this OS prorile as read from os-release.
506
507       osshortname
508              The short name of this OS profile as read from os-release.
509
510       osversion
511              The OS version of this OS profile as read from  os-release.
512
513       osversion_id
514              The  OS  version  identifier of this OS profile as read from os-
515              release.
516
517       unamepattern
518              The configured UTS release pattern for this OS profile.
519
520       kernelpattern
521              The configured kernel image template for this OS profile.
522
523       initrdpattern
524              The configured initramfs image template for this OS profile.
525
526       lvm2opts
527              The configured LVM2 root device options  template  for  this  OS
528              profile.
529
530       btrfsopts
531              The configured BTRFS root options template for this OS profile.
532
533       options
534              The kernel command line options template for this OS profile.
535
536       profilepath
537              The  absolute  path  to  this OS Profile's on-disk configuration
538              file.
539

REPORTING COMMANDS

541       Both the entry list and profile list commands use  a  common  reporting
542       system  to  display  the results of the query. The selection of fields,
543       and the order in which they are displayed, may be controlled to produce
544       custom report formats.
545
546       Displaying the available boot entry fields
547       # boom list -o help
548       Boot loader entries Fields
549       --------------------------
550         bootid        - Boot identifier [sha]
551         title         - Entry title [str]
552         options       - Kernel options [str]
553         kernel        - Kernel image [str]
554         initramfs     - Initramfs image [str]
555         machineid     - Machine identifier [sha]
556         entrypath     - On-disk entry path [str]
557
558       OS profiles Fields
559       ------------------
560         osid          - OS identifier [sha]
561         osname        - OS name [str]
562         osshortname   - OS short name [str]
563         osversion     - OS version [str]
564         osversion_id  - Version identifier [str]
565         unamepattern  - UTS name pattern [str]
566         kernelpattern - Kernel image pattern [str]
567         initrdpattern - Initrd pattern [str]
568         lvm2opts      - LVM2 options [str]
569         btrfsopts     - BTRFS options [str]
570         options       - Kernel options [str]
571         profilepath   - On-disk profile path [str]
572
573       Boot parameters Fields
574       ----------------------
575         version       - Kernel version [str]
576         rootdev       - Root device [str]
577         rootlv        - Root logical volume [str]
578         subvolpath    - BTRFS subvolume path [str]
579         subvolid      - BTRFS subvolume ID [num]
580
581       Displaying the available OS profile fields
582       # boom profile list -o help
583       OS profiles Fields
584       ------------------
585         osid          - OS identifier [sha]
586         osname        - OS name [str]
587         osshortname   - OS short name [str]
588         osversion     - OS version [str]
589         osversion_id  - Version identifier [str]
590         unamepattern  - UTS name pattern [str]
591         kernelpattern - Kernel image pattern [str]
592         initrdpattern - Initrd pattern [str]
593         lvm2opts      - LVM2 options [str]
594         btrfsopts     - BTRFS options [str]
595         options       - Kernel options [str]
596         profilepath   - On-disk profile path [str]
597
598       Selecting custom fields for the entry list and profile list commands
599       # boom list -o bootid,osname
600       BootID  Name
601       0d3e547 Fedora
602       bc18de2 Fedora
603       576fe39 Fedora
604       1838f58 Fedora
605       81520ca Fedora
606       327e24a Fedora
607
608       Adding additional fields to the default set
609       # boom list -o +options
610       BootID   Version                   Name                      RootDevice
611       Options
612       0d3e547  4.13.5-200.fc26.x86_64    Fedora                     /dev/map‐
613       per/vg_hex-root             BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
614       root=/dev/mapper/vg_hex-root  ro   rd.lvm.lv=vg_hex/root   rhgb   quiet
615       rd.auto=1
616       bc18de2                 4.13.5-200.fc26.x86_64                   Fedora
617       /dev/vg_hex/root-snap10      BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
618       root=/dev/vg_hex/root-snap10 ro rd.lvm.lv=vg_hex/root-snap10
619       576fe39                 4.13.5-200.fc26.x86_64                   Fedora
620       /dev/vg_hex/root             BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
621       root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root
622       1838f58   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
623       per/vg_hex-root             BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64
624       root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
625       81520ca   4.13.13-200.fc26.x86_64   Fedora                    /dev/map‐
626       per/vg_hex-root              BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64
627       root=/dev/mapper/vg_hex-root   ro   rd.lvm.lv=vg_hex/root   rhgb  quiet
628       LANG=en_GB.UTF-8
629       327e24a                 4.13.5-200.fc26.x86_64                   Fedora
630       /dev/vg_hex/root         BOOT_IMAGE=%{linux}  root=/dev/vg_hex/root  ro
631       rd.lvm.lv=vg_hex/root
632
633       Sort operating system profiles by ascending OS name and  descending  OS
634       version
635       # boom profile list -O+osname,-osversion
636       OsID    Name                            OsVersion
637       d4439b7 Fedora                          26 (Workstation Edition)
638       9736c34 Fedora                          25 (Server Edition)
639       9cb53dd Fedora                          24 (Workstation Edition)
640       6bf746b Fedora                          24 (Server Edition)
641       b99ea5f Red Hat Enterprise Linux Server 8 (Server)
642       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
643       c0b921e Red Hat Enterprise Linux Server 7 (Server)
644       98c3edb Red Hat Enterprise Linux Server 6 (Server)
645       b730331 Red Hat Enterprise Linux Server 5 (Server)
646       efd6d41 Red Hat Enterprise Linux Server 4 (Server)
647       21e37c8 Ubuntu                          16.04 LTS (Xenial Xerus)
648

EXAMPLES

650       List the available operating system profiles
651       # boom profile list
652       OsID    Name                            OsVersion
653       efd6d41 Red Hat Enterprise Linux Server 4 (Server)
654       b730331 Red Hat Enterprise Linux Server 5 (Server)
655       98c3edb Red Hat Enterprise Linux Server 6 (Server)
656       c0b921e Red Hat Enterprise Linux Server 7 (Server)
657       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
658       b99ea5f Red Hat Enterprise Linux Server 8 (Server)
659
660       List the available boot entries
661       # boom list
662       BootID  Version                  Name                     RootDevice
663       0d3e547   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
664       per/vg00-lvol0
665       bc18de2                 4.13.5-200.fc26.x86_64                   Fedora
666       /dev/vg00/lvol0-snap10
667       576fe39                 4.13.5-200.fc26.x86_64                   Fedora
668       /dev/vg00/lvol0
669       f52ba10                 4.11.12-100.fc24.x86_64                  Fedora
670       /dev/vg00/lvol0-snap
671       1838f58   4.13.5-200.fc26.x86_64    Fedora                    /dev/map‐
672       per/vg00-lvol0
673       81520ca  4.13.13-200.fc26.x86_64   Fedora                     /dev/map‐
674       per/vg00-lvol0
675       327e24a                 4.13.5-200.fc26.x86_64                   Fedora
676       /dev/vg00/lvol0
677
678       Create an OS profile for the running system  (using  Fedora  26  as  an
679       example)
680       # boom profile create --from-host --uname-pattern fc26
681       Created profile with os_id d4439b7:
682         OS ID: "d4439b7d2f928c39f1160c0b0291407e5990b9e0",
683         Name: "Fedora", Short name: "fedora",
684         Version: "26 (Workstation Edition)", Version ID: "26",
685         UTS release pattern: "fc26",
686         Kernel     pattern:    "/kernel-%{version}",    Initramfs    pattern:
687       "/initramfs-%{version}.img",
688         Root options (LVM2): "rd.lvm.lv=%{lvm_root_lv}",
689         Root options (BTRFS): "rootflags=%{btrfs_subvolume}",
690         Options: "root=%{root_device} ro %{root_opts}"
691
692       Create a new boot entry for a specific OS profile and version
693       # boom profile list --short-name rhel
694       OsID    Name                            OsVersion
695       3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
696       98c3edb Red Hat Enterprise Linux Server 6 (Server)
697       c0b921e Red Hat Enterprise Linux Server 7 (Server)
698
699       # boom create --profile  3fc389b  --title  "RHEL7  snapshot"  --version
700       3.10-272.el7 --root-lv vg00/lvol0-snap
701       Created entry with boot_id a5aef11:
702       title RHEL7 snapshot
703       machine-id 611f38fd887d41dea7eb3403b2730a76
704       version 3.10-272.el7
705       linux /boot/vmlinuz-3.10-272.el7
706       initrd /boot/initramfs-3.10-272.el7.img
707       options  root=/dev/vg00/lvol0-snap  ro  rd.lvm.lv=vg00/lvol0-snap  rhgb
708       quiet
709
710       Create a new boot entry for the running system, changing only the  root
711       logical volume
712       # boom create --title Snap1 --root-lv vg00/lvol0-snap1
713       Created entry with boot_id e077490:
714         title Snap1
715         machine-id 611f38fd887d41dea7eb3403b2730a76
716         version 4.13.13-200.fc26.x86_64
717         linux /vmlinuz-4.13.13-200.fc26.x86_64
718         initrd /initramfs-4.13.13-200.fc26.x86_64.img
719         options                   BOOT_IMAGE=/vmlinuz-4.13.13-200.fc26.x86_64
720       root=/dev/vg00/lvol0-snap1 ro rd.lvm.lv=vg00/lvol0-snap1
721
722       Delete an entry by its boot identifier
723       # boom delete --boot-id e077490
724       Deleted 1 entry
725
726       Delete all entries for the Fedora 24 OS profile
727       # boom delete --name Fedora --os-version-id 24 Deleted 4 entries
728

AUTHORS

730       Bryn M. Reeves <bmr@redhat.com>
731

SEE ALSO

733       Boom project page: https://github.com/bmr-cymru/boom
734       Boot to snapshot documentation:  https://github.com/bmr-cymru/snapshot-
735       boot-docs
736       LVM2 resource page: https://www.sourceware.org/lvm2/
737       Device-mapper resource page: http://sources.redhat.com/dm/
738
739
740
741Linux                             Oct 30 2017                          BOOM(8)
Impressum