boom - Man Page

boom [entry|profile|host] [create|delete|clone|show|list|edit]

boom legacy [write|clear|show]

boom cache [list|show]

boom entry create [--profile os_id] [--version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts opts] [--backup] [--update] [--no-fstab] [--mount mount] [--swap swap]

boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id] [--version version]

boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts opts] [--backup] [--update] [--no-fstab] [--mount mount] [--swap swap]

boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]

boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--btrfs-subvol subvol]

boom profile create [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom profile delete [profile_id] [--profile os_id] [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom profile clone [profile_id] [--profile os_id] [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom profile list [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]

boom profile show [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version]

boom host create [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom host delete [host_id] [--host-profile host_id]

boom host clone [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom host edit [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]

boom host list [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]

boom host show [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version]

boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]

boom legacy clear

boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]

boom cache list [img_id] [--image img_id] [--linux kernel_path] [--initrd initrd_path] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]

boom cache show [img_id] [--image img_id] [--linux kernel_path] [--initrd initrd_path]

boom config create

Boom is a boot manager for Linux systems using boot loaders that support the BootLoader Specification for boot entry configuration.

Boom works best with a BLS compatible boot loader: either the systemd-boot project, or Grub2 with the `bls` patch. The grub2 boot loader included in CentOS, Fedora and Red Hat Enterprise Linux include this support.

Boom also supports writing configuration in legacy boot loader format: currently the syntax used by the Grub1 configuration file is supported.

All long options supported by boom may be written with or without dashes separating words. For example, --boot-id and --bootid are synonymous.

-a|--add-opts opts

Specify additional boot options for this entry.

-d|--del-opts opts

Specify boot options to exclude from this entry.

--backup

Back up boot images used for this entry.

-b|--boot-id|--bootid boot_id

Specify a boot identifier to operate on.

--boot-dir|--bootdir path

Specify the location of the /boot file system. Useful for testing or for accessing boom data from a system image.

-B|--btrfs-subvolme|--btrfssubvolume [subvol_path|subvol_id]

Specify a BTRFS subvolume by its path or identifier.

--btrfs-opts|--btrfsopts btrfs_options_template

An OS profile template string for BTRFS boot options.

--debug debug_flags

A comma-separated list of subsystem names to enable debugging output for, or 'all' to enable all debugging. The available debug classes are: profile, entry, command, report.

-e|--efi efi_image

Specify an EFI application image for a boot entry.

-E|--expand-variables

Expand bootloader variables in command output.

-H|--from-host|--fromhost

When creating a new OS profile, use os-release data from the running host.

-P|--host-profile

Use the specified host profile for search or create operations.

-i|--initrd image_path

A Linux initial ramfs image path.

-k|--kernel-pattern|--kernelpattern pattern

An OS profile template used to generate kernel image paths.

-l|--linux image_path

A Linux kernel image path.

-L|--root-lv|--rootlv root_lv

The logical volume containing the root file system for a boot entry. If --root-lv is given, but --root-device is not, the root device is assumed to be the specified logical volume.

--lvm-opts lvm_opts

An OS profile template used to generate LVM2 boot options.

-m|--machine-id|--machineid machine_id

-M|--mount what:where:fstype:options

Specify a command-line file system mount for the boot entry.

-n|--name os_name

The name of a boom operating system profile.

--name-prefixes|--nameprefixes

Add a prefix to report field output names.

--no-fstab

Disable processing of /etc/fstab for the boot entry.

--no-headings|--noheadings

Suppress output of report headings.

-o|--options field_list

Specify which fields to display.

--os-version

The version string of a boom operating system profile.

-O|--sort key_list

A comma-separated list of sort keys (field names), with an optional per-field prefix of + or - to force ascending or descending sort order respectively for that field.

-I|--os-version-id|--osversionid os_version_id

A boom operating system profile version identifier.

--os-options|--osoptions options_template

An operating system profile template string used to generate the kernel command line options string.

--os-release|--osrelease os_release_path

A path to a file in os-release(5) from which to create a new operating system profile.

-p|--profile os_id

The operating system identifier (os_id) of a boom operating system profile to use for the current operation. Defaults to the OS profile of the running system if absent.

-r|--root-device|--rootdevice root_dev

The system root device for a new boot entry.

-R|--initramfs-pattern|--initramfspattern initramfs_pattern

An OS profile template used to generate initial ramfs image paths.

--rows

Output report columns as rows.

--json

Output reports in JSON notation

--separator separator

Report field separator

-s|--short-name|--shortname short_name

The short name of a boom operating system profile.

--swap what:options

Specify a command-line swap configuration for the boot entry.

-t|--title entry_title

The title for a new boot entry.

-u|--uname-pattern|--unamepattern uname_pattern

An uname pattern to match for an operating system profile.

--update

When used with --backup update the backup image to the current version found in the boot directory.

-V|--verbose

Increase verbosity level. Specify multiple times, or set additional debug classed with --debug to enable more verbose messages.

-v|--version version

The kernel version of a boom boot entry.

Boom manages boot loader entries for one or more installed operating systems. Each operating system is identified by an OS Profile that provides identity information and a set of templates used to create boot loader entries.

An OS profile is identified by its os_id, an alphanumeric string based on an SHA digest of the profile's identity fields. Identifiers reported in boom command output are automatically abbreviated to the minimum length required to ensure uniqueness and this short form may be used in any place where a boom OS identifier is expected.

A Boot Entry represents one bootable instance of an installed operating system: a kernel, optional initial ramfs image, command line options, and other images or settings required for boot.

Each boot entry is also identified by a SHA based unique identifier: the boot_id. An entry's ID is used to select an entry for display, modification, deletion or other operations.

Since the boot entry's identifier is based on the boot parameters used to create the entry, the boot_id will change if an existing entry is modified (for e.g. with the boom entry edit command).

Host Profiles

Host profiles provide an additional mechanism to control boot entry templates on a per-host basis. A host profile is bound to a specific machine_id and is used whenever new boot entries are created for the corresponding host.

A host profile can add and delete boot options from the set supplied by the active OS Profile, or override specific OS Profile keys completely. Any keys not set in a host profile are mapped directly to the original OS profile.

Boot Entry Commands

boom entry create [--profile os_id] [--version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts opts] [--backup] [--update] [--no-fstab] [--mount mount] [--swap swap]
Create a new boot entry using the specified values.

The title of the new entry must be set with the --title option.

The kernel version for the new entry is given with --version. If --version is not present the version is assumed to be that of the currently running kernel.

If --profile is given, it specifies the OS identifier of an existing OS profile to use for the new entry. If --profile is not given, and a profile exists that matches either the supplied or detected version then that profile will be automatically used.

The machine-id of the new entry is automatically set to the current machine-id (read from /etc/machine-id) unless this is overridden by the --machine-id switch.

A root device may be explicitly specified with the --root-device option or if an LVM2 logical volume is used this may be specified with --root-lv: in this case the root device is assumed to be the normal device path of the specified logical volume.

A BTRFS subvolume may be set by either the subvolume path or subvolume identifier using the --btrfs-subvol option.

Additional boot options not defined by the corresponding OsProfile templates may be specified with --add-opts. Options may also be removed from the entry using --del-opts (for example to disable graphical boot or the "quiet" flag for a particular entry).

If --backup is given a backup is made of the boot images (vmlinuz and initramfs) used by the boot entry and the new entry will use the backup paths instead of the original image paths. By default if an existing backup image is present it will be re-used instead of using the latest matching image found in the boot directory. This behaviour can be overridden by using the --update option.

The newly created entry and its boot identifier are printed to the terminal on success:
# boom create --title 'System Snapshot' --root-lv vg00/lvol0
Created entry with boot_id 14d6b6e:
 title System Snapshot
 machine-id 611f38fd887d41dea7eb3403b2730a76
 version 4.13.5-200.fc26.x86_64
 linux /vmlinuz-4.13.5-200.fc26.x86_64
 initrd /initramfs-4.13.5-200.fc26.x86_64.img
 options BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64 root=/dev/vg00/lvol0 ro rd.lvm.lv=vg00/lvol0 rhgb quiet

boom entry delete [boot_id] [--boot-id boot_id] [--profile os_id] [--version version]
Delete the specified boot entry. The entry to delete may be specified either by its boot identifier, in which case at most one entry will be removed, or by specifying selection criteria which may match (and remove) multiple entries in a single operation.

For example, by giving --version, all entries matching the specified kernel version can be removed at once.

On success the number of entries removed is printed to the terminal. If the --verbose option is given then a report of the entries removed will also be displayed.

boom entry clone [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--add-opts opts] [--del-opts opts] [--backup] [--update] [--no-fstab] [--mount mount] [--swap swap]
Clone an existing boot entry and modify its configuration.

The entry to clone must be specified by its boot identifier. Any remaining command line arguments are taken to be modifications to the original entry.

If --backup is given a backup is made of the boot images (vmlinuz and initramfs) used by the boot entry and the new entry will use the backup paths instead of the original image paths. By default if an existing backup image is present it will be re-used instead of using the latest matching image found in the boot directory. This behaviour can be overridden by using the --update option.

On success the new entry and its boot identifier are printed to the terminal.

boom entry list [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]
Output a tabular report of boot entries.

Displays a report with one boot entry per line, containing fields describing the properties of the configured boot entries.

The list of fields to display is given with --options as a comma separated list of field names. To obtain a list of available fields run 'boom list -o help'. If the list of fields begins with the '+' character the specified fields are appended to the default field list. Otherwise the given list of fields replaces the default set of report fields.

Report output may be sorted by multiple user-defined keys using the --sort option. The option expects a comma separated list of keys, with optional '+' and '-' prefixes indicating ascending and descending sort for that field respectively.

boom entry show [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--btrfs-subvol subvol]
Display boot entries matching selection criteria on standard out.

Boot entries matching the criteria given on the command line are printed to the terminal in boot loader entry format.

If --expand-variables is given then any bootloader environment variables in the output will be replaced with their current values, for example the $kernelopts variable that some distributions configure to store the kernel command line.

OS Profile Commands

boom profile create [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Create a new OS profile using the specified values.

A new OS profile can be created either by specifying required values on the boom command line, or by reading data from either the hosts's os-release file (at /etc/os-release), or from another file in os-release format specified on the command line.

The information read from os-release (or equivalent command line options) form the profile's identity and are the basis for the profile OS identifier.

In addition to the os-release data a new OS profile requires a uname version string pattern to match, and template values used to construct boot entries.

The uname pattern must be given on the profile create command line and is a regular expression matching the UTS release (uname -r) values reported by that distribution. The pattern is only used to attempt to match unknown boot entries to a valid OS profile: for example entries that have been manually edited, or that were created by another tool.

The boom command provides default templates that are suitable for most Linux distributions. Alternately, these values may be set on the command line at the time of profile creation, or modified using the boom program at a later time.

To create a profile for the currently running host, use the --from-host switch.

To create a profile from a saved os-release file use the --os-release optiona and give the path to the file to be used.

boom profile delete [profile_id] [--profile os_id] [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Delete the specified Os profile or profiles.

Delete all OS profiles matching the provided selection criteria. If the --profile option is used to specify an OS identifier then at most one profile will be removed.

On success the number of profiles removed is printed to the terminal. If the --verbose option is given then a report of the profiles removed will also be displayed.

boom profile clone [profile_id] [--profile os_id] [--name osname] [--short-name short_name] [--os-version version] [--os-version-id version_id] [--from-host] [--os-release os_release] [--uname-pattern uname_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Clone an existing OS profile and modify its configuration.

The entry to clone must be specified by its OS identifier. Any remaining command line arguments are taken to be modifications to the original entry.

On success the new entry and its OS identifier are printed to the terminal.

boom profile list [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]
Output a tabular report of OS profiles.

Displays a report with one OS profile per line, containing fields describing the properties of the configured OS profiles.

The list of fields to display is given with --options as a comma separated list of field names. To obtain a list of available fields run 'boom list -o help'. If the list of fields begins with the '+' character the specified fields are appended to the default field list. Otherwise the given list of fields replaces the default set of report fields.

Report output may be sorted by multiple user-defined keys using the --sort option. The option expects a comma separated list of keys, with optional '+' and '-' prefixes indicating ascending and descending sort for that field respectively.

boom profile show [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version]
Display OS profiles matching selection criteria on standard out.

OS profiles matching the criteria given on the command line are printed to the terminal in a compact multi-line format.

Host Profile Commands

boom host create [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Create a new host profile for the specified machine_id and using the given profile option arguments. Any OS Profile keys that are given values will override the values in the underlying profile.

boom host delete [host_id] [--host-profile host_id]
Delete the specified host profile or profiles.

Delete all host profiles matching the provided selection criteria. If the --host-profile option is used to specify an host identifier then at most one profile will be removed.

On success the number of profiles removed is printed to the terminal. If the --verbose option is given then a report of the profiles removed will also be displayed.

boom host clone [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Clone an existing host profile and modify its configuration.

The entry to clone must be specified by its host identifier. Any remaining command line arguments are taken to be modifications to the original entry.

On success the new entry and its host identifier are printed to the terminal.

boom host edit [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options]
Edit an existing host profile and modify its configuration.

The entry to edit must be specified by its host identifier. Any remaining command line arguments are taken to be modifications to the original profile.

On success the new profile and its host identifier are printed to the terminal.

boom host list [host_id] [--host-profile host_id] [--name name] [--short-name short_name] [--profile os_id] [--machine-id machine_id] [--kernel-pattern kernel_pattern] [--initramfs-pattern initramfs_pattern] [--lvm-opts lvm_opts] [--btrfs-opts btrfs_opts] [--os-options os_options] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator] Output a tabular report of host profiles.

Displays a report with one host profile per line, containing fields describing the properties of the configured host profiles.

The list of fields to display is given with --options as a comma separated list of field names. To obtain a list of available fields run 'boom host list -o help'. If the list of fields begins with the '+' character the specified fields are appended to the default field list. Otherwise the given list of fields replaces the default set of report fields.

Report output may be sorted by multiple user-defined keys using the --sort option. The option expects a comma separated list of keys, with optional '+' and '-' prefixes indicating ascending and descending sort for that field respectively.

boom host show [profile_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version]
Display host profiles matching selection criteria on standard out.

Host profiles matching the criteria given on the command line are printed to the terminal in a compact multi-line format.

Boom is able to write the current set of boot entries into the configuration file of a legacy boot loader installed on the system. This may be used either on platforms that do not have a native bootloader supporting the Boot Loader Specification, or to allow upgrades and recovery from an installation lacking BLS support (if the system is updated to a distribution that does support the BLS boot loader configuration it will be used automatically when present).

Legacy support is enabled and configured via the boom.conf(5) configuration file.

boom legacy write [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol]
Write out the current set of Boom boot entries in the configured legacy configuration file. The normal command line selection options may be used to control the set of entries written to the file.

boom legacy clear
Remove all Boom boot entries from the configured legacy configuration file.

boom legacy show [boot_id] [--boot-id boot_id] [--profile os_id] [--version version] [--name osname] [--short-name osshortname] [--os-version version] [--root-device device] [--root-lv lv] [--linux kernel_path] [--initrd initrd_path] [--btrfs-subvol subvol] Display the selected boot entries as they would appear in the configured legacy boot loader format. The normal command line selection options may be used to control the set of entries written to the terminal.

Boom can optionally cache or back up the images used by a boom BootEntry. This allows an entry to be booted in the case that a subsequent update has removed the original kernel and initramfs images and can be used to recover an earlier system state from a snapshot following even major operating system updates.

boom cache list [img_id] [--image img_id] [--linux kernel_path] [--initrd initrd_path] [--nameprefixes] [--noheadings] [--options fields] [--sort fields] [--rows|--json] [--separator separator]
Output a tabular report of paths present in the boot image cache.

Displays a report with one cache entry per line, containing fields describing the properties of the cache entry.

The list of fields to display is given with --options as a comma separated list of field names. To obtain a list of available fields run field list. Otherwise the given list of fields replaces the default set of report fields.

Report output may be sorted by multiple user-defined keys using the --sort option. The option expects a comma separated list of keys, with optional '+' and '-' prefixes indicating ascending and descending sort for that field respectively.

boom cache show [img_id] [--image img_id] [--linux kernel_path] [--initrd initrd_path]
Display matching cache entries on standard output.

Entries matching selection criteria are printed in a compact multi-line format.

boom config create
Create a default configuration in /boot.

Set up /boot/boom if configuration files were not provided with the boom package.

The boom report provides several types of field that may be added to the default field set for either Boot Entry or OS Profile reports, or used to create custom reports.

Both the entry list and profile list commands use a common reporting system to display the results of the query. The selection of fields, and the order in which they are displayed, may be controlled to produce custom report formats.

Displaying the available boot entry fields
# boom list -o help
Boot loader entries Fields
--------------------------
 bootid        - Boot identifier [sha]
 title         - Entry title [str]
 options       - Kernel options [str]
 kernel        - Kernel image [str]
 initramfs     - Initramfs image [str]
 machineid     - Machine identifier [sha]
 entrypath     - On-disk entry path [str]

OS profiles Fields
------------------
 osid          - OS identifier [sha]
 osname        - OS name [str]
 osshortname   - OS short name [str]
 osversion     - OS version [str]
 osversion_id  - Version identifier [str]
 unamepattern  - UTS name pattern [str]
 kernelpattern - Kernel image pattern [str]
 initrdpattern - Initrd pattern [str]
 lvm2opts      - LVM2 options [str]
 btrfsopts     - BTRFS options [str]
 options       - Kernel options [str]
 profilepath   - On-disk profile path [str]

Boot parameters Fields
----------------------
 version       - Kernel version [str]
 rootdev       - Root device [str]
 rootlv        - Root logical volume [str]
 subvolpath    - BTRFS subvolume path [str]
 subvolid      - BTRFS subvolume ID [num]

Displaying the available OS profile fields
# boom profile list -o help
OS profiles Fields
------------------
 osid          - OS identifier [sha]
 osname        - OS name [str]
 osshortname   - OS short name [str]
 osversion     - OS version [str]
 osversion_id  - Version identifier [str]
 unamepattern  - UTS name pattern [str]
 kernelpattern - Kernel image pattern [str]
 initrdpattern - Initrd pattern [str]
 lvm2opts      - LVM2 options [str]
 btrfsopts     - BTRFS options [str]
 options       - Kernel options [str]
 profilepath   - On-disk profile path [str]

Selecting custom fields for the entry list and profile list commands
# boom list -o bootid,osname
BootID  Name
0d3e547 Fedora
bc18de2 Fedora
576fe39 Fedora
1838f58 Fedora
81520ca Fedora
327e24a Fedora

Adding additional fields to the default set
# boom list -o +options
BootID  Version                  Name                     RootDevice              Options
0d3e547 4.13.5-200.fc26.x86_64   Fedora                   /dev/mapper/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet rd.auto=1
bc18de2 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg_hex/root-snap10 BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64 root=/dev/vg_hex/root-snap10 ro rd.lvm.lv=vg_hex/root-snap10
576fe39 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg_hex/root        BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64 root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root
1838f58 4.13.5-200.fc26.x86_64   Fedora                   /dev/mapper/vg_hex-root BOOT_IMAGE=/vmlinuz-4.11.12-100.fc24.x86_64 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet
81520ca 4.13.13-200.fc26.x86_64  Fedora                   /dev/mapper/vg_hex-root BOOT_IMAGE=/vmlinuz-4.13.5-200.fc26.x86_64 root=/dev/mapper/vg_hex-root ro rd.lvm.lv=vg_hex/root rhgb quiet LANG=en_GB.UTF-8
327e24a 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg_hex/root        BOOT_IMAGE=%{linux} root=/dev/vg_hex/root ro rd.lvm.lv=vg_hex/root

Sort operating system profiles by ascending OS name and descending OS version
# boom profile list -O+osname,-osversion
OsID    Name                            OsVersion
d4439b7 Fedora                          26 (Workstation Edition)
9736c34 Fedora                          25 (Server Edition)
9cb53dd Fedora                          24 (Workstation Edition)
6bf746b Fedora                          24 (Server Edition)
b99ea5f Red Hat Enterprise Linux Server 8 (Server)
3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
c0b921e Red Hat Enterprise Linux Server 7 (Server)
98c3edb Red Hat Enterprise Linux Server 6 (Server)
b730331 Red Hat Enterprise Linux Server 5 (Server)
efd6d41 Red Hat Enterprise Linux Server 4 (Server)
21e37c8 Ubuntu                          16.04 LTS (Xenial Xerus)

List the available operating system profiles
# boom profile list
OsID    Name                            OsVersion
efd6d41 Red Hat Enterprise Linux Server 4 (Server)
b730331 Red Hat Enterprise Linux Server 5 (Server)
98c3edb Red Hat Enterprise Linux Server 6 (Server)
c0b921e Red Hat Enterprise Linux Server 7 (Server)
3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
b99ea5f Red Hat Enterprise Linux Server 8 (Server)

List the available boot entries
# boom list
BootID  Version                  Name                     RootDevice
0d3e547 4.13.5-200.fc26.x86_64   Fedora                   /dev/mapper/vg00-lvol0
bc18de2 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg00/lvol0-snap10
576fe39 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg00/lvol0
f52ba10 4.11.12-100.fc24.x86_64  Fedora                   /dev/vg00/lvol0-snap
1838f58 4.13.5-200.fc26.x86_64   Fedora                   /dev/mapper/vg00-lvol0
81520ca 4.13.13-200.fc26.x86_64  Fedora                   /dev/mapper/vg00-lvol0
327e24a 4.13.5-200.fc26.x86_64   Fedora                   /dev/vg00/lvol0

Create an OS profile for the running system (using Fedora 26 as an example)
# boom profile create --from-host --uname-pattern fc26
Created profile with os_id d4439b7:
 OS ID: "d4439b7d2f928c39f1160c0b0291407e5990b9e0",
 Name: "Fedora", Short name: "fedora",
 Version: "26 (Workstation Edition)", Version ID: "26",
 UTS release pattern: "fc26",
 Kernel pattern: "/kernel-%{version}", Initramfs pattern: "/initramfs-%{version}.img",
 Root options (LVM2): "rd.lvm.lv=%{lvm_root_lv}",
 Root options (BTRFS): "rootflags=%{btrfs_subvolume}",
 Options: "root=%{root_device} ro %{root_opts}"

Create a new boot entry for a specific OS profile and version
# boom profile list --short-name rhel
OsID    Name                            OsVersion
3fc389b Red Hat Enterprise Linux Server 7.2 (Maipo)
98c3edb Red Hat Enterprise Linux Server 6 (Server)
c0b921e Red Hat Enterprise Linux Server 7 (Server)

# boom create --profile 3fc389b --title "RHEL7 snapshot" --version 3.10-272.el7 --root-lv vg00/lvol0-snap
Created entry with boot_id a5aef11:
title RHEL7 snapshot
machine-id 611f38fd887d41dea7eb3403b2730a76
version 3.10-272.el7
linux /boot/vmlinuz-3.10-272.el7
initrd /boot/initramfs-3.10-272.el7.img
options root=/dev/vg00/lvol0-snap ro rd.lvm.lv=vg00/lvol0-snap rhgb quiet

Create a new boot entry for the running system, changing only the root logical volume
# boom create --title Snap1 --root-lv vg00/lvol0-snap1
Created entry with boot_id e077490:
 title Snap1
 machine-id 611f38fd887d41dea7eb3403b2730a76
 version 4.13.13-200.fc26.x86_64
 linux /vmlinuz-4.13.13-200.fc26.x86_64
 initrd /initramfs-4.13.13-200.fc26.x86_64.img
 options BOOT_IMAGE=/vmlinuz-4.13.13-200.fc26.x86_64 root=/dev/vg00/lvol0-snap1 ro rd.lvm.lv=vg00/lvol0-snap1

Delete an entry by its boot identifier
# boom delete --boot-id e077490
Deleted 1 entry

Delete all entries for the Fedora 24 OS profile
# boom delete --name Fedora --os-version-id 24 Deleted 4 entries

Bryn M. Reeves <bmr@redhat.com>

Boom project page: https://github.com/snapshotmanager/boom
Boot to snapshot documentation: https://github.com/snapshotmanager/snapshot-boot-docs
BootLoader Specification: https://systemd.io/BOOT_LOADER_SPECIFICATION
LVM2 resource page: https://www.sourceware.org/lvm2/
Device-mapper resource page: http://sources.redhat.com/dm/