1BOOTCTL(1)                          bootctl                         BOOTCTL(1)
2
3
4

NAME

6       bootctl - Control the firmware and boot manager settings
7

SYNOPSIS

9       bootctl [OPTIONS...] {COMMAND}
10

DESCRIPTION

12       bootctl can check the EFI boot loader status, list available boot
13       loaders and boot loader entries, and install, update, or remove the
14       systemd-boot(7) boot loader on the current system.
15

COMMANDS

17       status
18           Shows brief information about the system firmware, the boot loader
19           that was used to boot the system, the boot loaders currently
20           available in the ESP, the boot loaders listed in the firmware's
21           list of boot loaders and the current default boot loader entry. If
22           no command is specified, this is the implied default.
23
24       install
25           Installs systemd-boot into the EFI system partition. A copy of
26           systemd-boot will be stored as the EFI default/fallback loader at
27           ESP/EFI/BOOT/BOOT*.EFI. The boot loader is then added to the top of
28           the firmware's boot loader list.
29
30       update
31           Updates all installed versions of systemd-boot(7), if the available
32           version is newer than the version installed in the EFI system
33           partition. This also includes the EFI default/fallback loader at
34           ESP/EFI/BOOT/BOOT*.EFI. The boot loader is then added to end of the
35           firmware's boot loader list if missing.
36
37       remove
38           Removes all installed versions of systemd-boot from the EFI system
39           partition and the firmware's boot loader list.
40
41       is-installed
42           Checks whether systemd-boot is installed in the ESP. Note that a
43           single ESP might host multiple boot loaders; this hence checks
44           whether systemd-boot is one (of possibly many) installed boot
45           loaders — and neither whether it is the default nor whether it is
46           registered in any EFI variables.
47
48       random-seed
49           Generates a random seed and stores it in the EFI System Partition,
50           for use by the systemd-boot boot loader. Also, generates a random
51           'system token' and stores it persistently as an EFI variable, if
52           one has not been set before. If the boot loader finds the random
53           seed in the ESP and the system token in the EFI variable it will
54           derive a random seed to pass to the OS and a new seed to store in
55           the ESP from the combination of both. The random seed passed to the
56           OS is credited to the kernel's entropy pool by the system manager
57           during early boot, and permits userspace to boot up with an entropy
58           pool fully initialized very early on. Also see systemd-boot-system-
59           token.service(8).
60
61           See Random Seeds[1] for further information.
62
63       systemd-efi-options [STRING]
64           When called without the optional argument, prints the current value
65           of the "SystemdOptions" EFI variable. When called with an argument,
66           sets the variable to that value. See systemd(1) for the meaning of
67           that variable.
68
69       reboot-to-firmware [BOOL]
70           Query or set the "Reboot-Into-Firmware-Setup" flag of the EFI
71           firmware. Takes a boolean argument which controls whether to show
72           the firmware setup on next system reboot. If the argument is
73           omitted shows the current status of the flag, or whether the flag
74           is supported. This controls the same flag as systemctl reboot
75           --firmware-setup, but is more low-level and allows setting the flag
76           independently from actually requesting a reboot.
77
78       list
79           Shows all available boot loader entries implementing the Boot
80           Loader Specification[2], as well as any other entries discovered or
81           automatically generated by the boot loader.
82
83       set-default ID, set-oneshot ID
84           Sets the default boot loader entry. Takes a single boot loader
85           entry ID string as argument. The set-oneshot command will set the
86           default entry only for the next boot, the set-default will set it
87           persistently for all future boots.
88

OPTIONS

90       The following options are understood:
91
92       --esp-path=
93           Path to the EFI System Partition (ESP). If not specified, /efi/,
94           /boot/, and /boot/efi/ are checked in turn. It is recommended to
95           mount the ESP to /efi/, if possible.
96
97       --boot-path=
98           Path to the Extended Boot Loader partition, as defined in the Boot
99           Loader Specification[2]. If not specified, /boot/ is checked. It is
100           recommended to mount the Extended Boot Loader partition to /boot/,
101           if possible.
102
103       -p, --print-esp-path
104           This option modifies the behaviour of status. Only prints the path
105           to the EFI System Partition (ESP) to standard output and exits.
106
107       -x, --print-boot-path
108           This option modifies the behaviour of status. Only prints the path
109           to the Extended Boot Loader partition if it exists, and the path to
110           the ESP otherwise to standard output and exit. This command is
111           useful to determine where to place boot loader entries, as they are
112           preferably placed in the Extended Boot Loader partition if it
113           exists and in the ESP otherwise.
114
115           Boot Loader Specification Type #1 entries should generally be
116           placed in the directory "$(bootctl -x)/loader/entries/". Existence
117           of that directory may also be used as indication that boot loader
118           entry support is available on the system. Similarly, Boot Loader
119           Specification Type #2 entries should be placed in the directory
120           "$(bootctl -x)/EFI/Linux/".
121
122           Note that this option (similar to the --print-booth-path option
123           mentioned above), is available independently from the boot loader
124           used, i.e. also without systemd-boot being installed.
125
126       --no-variables
127           Do not touch the firmware's boot loader list stored in EFI
128           variables.
129
130       --graceful
131           Ignore failure when the EFI System Partition cannot be found, or
132           when EFI variables cannot be written. Currently only applies to
133           random seed operations.
134
135       --no-pager
136           Do not pipe output into a pager.
137
138       -h, --help
139           Print a short help text and exit.
140
141       --version
142           Print a short version string and exit.
143

EXIT STATUS

145       On success, 0 is returned, a non-zero failure code otherwise.
146

ENVIRONMENT

148       If $SYSTEMD_RELAX_ESP_CHECKS=1 is set the validation checks for the ESP
149       are relaxed, and the path specified with --esp-path= may refer to any
150       kind of file system on any kind of partition.
151
152       Similarly, $SYSTEMD_RELAX_XBOOTLDR_CHECKS=1 turns off some validation
153       checks for the Extended Boot Loader partition.
154

SEE ALSO

156       systemd-boot(7), Boot Loader Specification[2], Boot Loader
157       Interface[3], systemd-boot-system-token.service(8)
158

NOTES

160        1. Random Seeds
161           https://systemd.io/RANDOM_SEEDS
162
163        2. Boot Loader Specification
164           https://systemd.io/BOOT_LOADER_SPECIFICATION
165
166        3. Boot Loader Interface
167           https://systemd.io/BOOT_LOADER_INTERFACE
168
169
170
171systemd 246                                                         BOOTCTL(1)
Impressum