]> git.ipfire.org Git - thirdparty/dracut.git/blame - dracut.cmdline.7.asc
kernel-modules: added hid-lcpower
[thirdparty/dracut.git] / dracut.cmdline.7.asc
CommitLineData
888d53f2
HH
1DRACUT.CMDLINE(7)
2=================
3:doctype: manpage
4:man source: dracut
5:man manual: dracut
6
7NAME
8----
9dracut.cmdline - dracut kernel command line options
10
11DESCRIPTION
12-----------
13The root device used by the kernel is specified in the boot configuration
14file on the kernel command line, as always.
15
16The traditional _root=/dev/sda1_ style device specification is allowed, but not
17encouraged. The root device should better be identified by LABEL or UUID. If a
18label is used, as in _root=LABEL=<label_of_root>_ the initramfs will search all
19available devices for a filesystem with the appropriate label, and mount that
20device as the root filesystem. _root=UUID=<uuidnumber>_ will mount the partition
21with that UUID as the root filesystem.
22
23In the following all kernel command line parameters, which are processed by
24dracut, are described.
25
26"rd.*" parameters mentioned without "=" are boolean parameters. They can be
27turned on/off by setting them to {0|1}. If the assignment with "=" is missing
28"=1" is implied. For example _rd.info_ can be turned off with _rd.info=0_ or
29turned on with _rd.info=1_ or _rd.info_. The last value in the kernel command
30line is the value, which is honored.
31
32Standard
33~~~~~~~~
b6c89768 34**init=**__<path to real init>__::
888d53f2
HH
35 specify the path to the init programm to be started after the initramfs has
36 finished
37
b6c89768 38**root=**__<path to blockdevice>__::
888d53f2
HH
39 specify the block device to use as the root filesystem.
40+
b6c89768
HH
41[listing]
42.Example
43--
888d53f2
HH
44root=/dev/sda1
45root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
46root=/dev/disk/by-label/Root
47root=LABEL=Root
48root=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
49root=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
b23a2837 50root=PARTUUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
b6c89768 51--
888d53f2 52
b6c89768 53**rootfstype=**__<filesystem type>__:: "auto" if not specified.
888d53f2 54+
b6c89768
HH
55[listing]
56.Example
57--
888d53f2 58rootfstype=ext3
b6c89768 59--
888d53f2 60
b6c89768 61**rootflags=**__<mount options>__::
888d53f2
HH
62 specify additional mount options for the root filesystem. If not set,
63 _/etc/fstab_ of the real root will be parsed for special mount options and
64 mounted accordingly.
65
5afa9579
66**ro**::
67 force mounting _/_ and _/usr_ (if it is a separate device) read-only. If
68 none of ro and rw is present, both are mounted according to _/etc/fstab_.
69
70**rw**::
71 force mounting _/_ and _/usr_ (if it is a separate device) read-write.
72 See also ro option.
73
b6c89768 74**rootfallback=**__<path to blockdevice>__::
ef9ddb91
HH
75 specify the block device to use as the root filesystem, if the normal root
76 cannot be found. This can only be a simple block device with a simple file
77 system, for which the filesystem driver is either compiled in, or added
78 manually to the initramfs. This parameter can be specified multiple times.
c4c1c4f4 79
a6332e69 80**rd.auto** **rd.auto=1**::
ef9ddb91
HH
81 enable autoassembly of special devices like cryptoLUKS, dmraid, mdraid or
82 lvm. Default is off as of dracut version >= 024.
e0641277 83
5a575820
HH
84**rd.hostonly=0**::
85 removes all compiled in configuration of the host system the initramfs image
86 was built on. This helps booting, if any disk layout changed, especially in
87 combination with rd.auto or other parameters specifying the layout.
88
f232f662
HH
89**rd.cmdline=ask**::
90 prompts the user for additional kernel command line parameters
91
888d53f2
HH
92**rd.fstab=0**::
93 do not honor special mount options for the root filesystem found in
94 _/etc/fstab_ of the real root.
95
b6c89768 96**resume=**__<path to resume partition>__::
5d0404e3 97 resume from a swap partition
97903dfc 98+
b6c89768
HH
99[listing]
100.Example
101--
97903dfc
HH
102resume=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
103resume=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
104resume=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
b6c89768 105--
97903dfc 106
9fb01d49
107**rd.skipfsck**::
108 skip fsck for rootfs and _/usr_. If you're mounting _/usr_ read-only and
109 the init system performs fsck before remount, you might want to use this
110 option to avoid duplication.
97903dfc 111
2ee48b4b 112
888d53f2
HH
113Misc
114~~~~
b6c89768 115**rd.driver.blacklist=**__<drivername>__[,__<drivername>__,...]::
888d53f2
HH
116 do not load kernel module <drivername>. This parameter can be specified
117 multiple times.
118
b6c89768 119**rd.driver.pre=**__<drivername>__[,__<drivername>__,...]::
888d53f2
HH
120 force loading kernel module <drivername>. This parameter can be specified
121 multiple times.
122
b6c89768 123**rd.driver.post=**__<drivername>__[,__<drivername>__,...]::
888d53f2
HH
124 force loading kernel module <drivername> after all automatic loading modules
125 have been loaded. This parameter can be specified multiple times.
126
b6c89768 127**rd.retry=**__<seconds>__::
5cd7c104
HH
128 specify how long dracut should wait for devices to appear.
129 The default is 30 seconds. After 2/3 of the time, degraded raids are force
52da8a51
HH
130 started. If you have hardware, which takes a very long time to announce its
131 drives, you might want to extend this value.
5cd7c104 132
13cb578a
BL
133**rd.noverifyssl**::
134 accept self-signed certificates for ssl downloads.
135
b6c89768 136**rd.ctty=**__<terminal device>__::
14986b9d
HH
137 specify the controlling terminal for the console.
138 This is useful, if you have multiple "console=" arguments.
139
888d53f2
HH
140[[dracutkerneldebug]]
141Debug
142~~~~~
ef9ddb91
HH
143If you are dropped to an emergency shell, the file
144_/run/initramfs/rdsosreport.txt_ is created, which can be safed to a (to be
145mounted by hand) partition (usually /boot) or a USB stick. Additional debugging
146info can be produced by adding **rd.debug** to the kernel command line.
c33488fe 147_/run/initramfs/rdsosreport.txt_ contains all logs and the output of some tools.
64d144ae
HH
148It should be attached to any report about dracut problems.
149
888d53f2
HH
150**rd.info**::
151 print informational output though "quiet" is set
152
153**rd.shell**::
154 allow dropping to a shell, if root mounting fails
155
156**rd.debug**::
64d144ae 157 set -x for the dracut shell.
ef9ddb91
HH
158 If systemd is active in the initramfs, all output is logged to the systemd
159 journal, which you can inspect with "journalctl -ab".
160 If systemd is not active, the logs are written to dmesg and
161 _/run/initramfs/init.log_.
64d144ae 162 If "quiet" is set, it also logs to the console.
888d53f2 163
7bd8f233 164**rd.memdebug=[0-3]**::
ef9ddb91
HH
165 Print memory usage info at various points, set the verbose level from 0 to 3.
166+
9c322b2f 167 Higher level means more debugging output:
b6c89768
HH
168+
169----
9c322b2f
DY
170 0 - no output
171 1 - partial /proc/meminfo
172 2 - /proc/meminfo
173 3 - /proc/meminfo + /proc/slabinfo
b6c89768 174----
7bd8f233 175
888d53f2
HH
176**rd.break**::
177 drop to a shell at the end
178
b6c89768 179**rd.break=**__{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot|cleanup}__::
888d53f2
HH
180 drop to a shell on defined breakpoint
181
182**rd.udev.info**::
183 set udev to loglevel info
184
185**rd.udev.debug**::
186 set udev to loglevel debug
187
188I18N
189~~~~
b6c89768 190**rd.vconsole.keymap=**__<keymap base file name>__::
888d53f2 191 keyboard translation table loaded by loadkeys; taken from keymaps directory;
b6c89768 192 will be written as KEYMAP to _/etc/vconsole.conf_ in the initramfs.
888d53f2 193+
b6c89768
HH
194[listing]
195.Example
196--
197rd.vconsole.keymap=de-latin1-nodeadkeys
198--
888d53f2 199
b6c89768 200**rd.vconsole.keymap.ext=**__<list of keymap base file names>__::
888d53f2
HH
201 list of extra keymaps to bo loaded (sep. by space); will be written as
202 EXT_KEYMAP to _/etc/vconsole.conf_ in the initramfs
203
b6c89768 204**rd.vconsole.unicode**::
888d53f2
HH
205 boolean, indicating UTF-8 mode; will be written as UNICODE to
206 _/etc/vconsole.conf_ in the initramfs
207
b6c89768 208**rd.vconsole.font=**__<font base file name>__::
888d53f2 209 console font; taken from consolefonts directory; will be written as FONT to
b6c89768 210 _/etc/vconsole.conf_ in the initramfs.
888d53f2 211+
b6c89768
HH
212[listing]
213.Example
214--
215rd.vconsole.font=LatArCyrHeb-16
216--
888d53f2 217
b6c89768 218**rd.vconsole.font.map=**__<console map base file name>__::
888d53f2
HH
219 see description of '-m' parameter in setfont manual; taken from consoletrans
220 directory; will be written as FONT_MAP to _/etc/vconsole.conf_ in the
221 initramfs
222
b6c89768 223**rd.vconsole.font.unimap=**__<unicode table base file name>__::
888d53f2
HH
224 see description of '-u' parameter in setfont manual; taken from unimaps
225 directory; will be written as FONT_UNIMAP to _/etc/vconsole.conf_ in the
226 initramfs
227
b6c89768 228**rd.locale.LANG=**__<locale>__::
888d53f2
HH
229 taken from the environment; if no UNICODE is defined we set its value in
230 basis of LANG value (whether it ends with ".utf8" (or similar) or not); will
b6c89768 231 be written as LANG to _/etc/locale.conf_ in the initramfs.
888d53f2 232+
b6c89768
HH
233[listing]
234.Example
235--
236rd.locale.LANG=pl_PL.utf8
237--
888d53f2 238
b6c89768 239**rd.locale.LC_ALL=**__<locale>__::
888d53f2
HH
240 taken from the environment; will be written as LC_ALL to _/etc/locale.conf_
241 in the initramfs
242
243LVM
244~~~
245**rd.lvm=0**::
246 disable LVM detection
247
b6c89768 248**rd.lvm.vg=**__<volume group name>__::
888d53f2
HH
249 only activate the volume groups with the given name. rd.lvm.vg can be
250 specified multiple times on the kernel command line.
251
b6c89768 252**rd.lvm.lv=**__<logical volume name>__::
888d53f2
HH
253 only activate the logical volumes with the given name. rd.lvm.lv can be
254 specified multiple times on the kernel command line.
255
256**rd.lvm.conf=0**::
257 remove any _/etc/lvm/lvm.conf_, which may exist in the initramfs
258
259crypto LUKS
260~~~~~~~~~~~
261**rd.luks=0**::
262 disable crypto LUKS detection
263
b6c89768 264**rd.luks.uuid=**__<luks uuid>__::
888d53f2
HH
265 only activate the LUKS partitions with the given UUID. Any "luks-" of the
266 LUKS UUID is removed before comparing to _<luks uuid>_.
267 The comparisons also matches, if _<luks uuid>_ is only the beginning of the
268 LUKS UUID, so you don't have to specify the full UUID.
269 This parameter can be specified multiple times.
270
b6c89768 271**rd.luks.allow-discards=**__<luks uuid>__::
ef9ddb91
HH
272 Allow using of discards (TRIM) requests for LUKS partitions with the given
273 UUID. Any "luks-" of the LUKS UUID is removed before comparing to
274 _<luks uuid>_. The comparisons also matches, if _<luks uuid>_ is only the
275 beginning of the LUKS UUID, so you don't have to specify the full UUID.
5ad3803d
HH
276 This parameter can be specified multiple times.
277
f7235c22 278**rd.luks.allow-discards**::
5ad3803d
HH
279 Allow using of discards (TRIM) requests on all LUKS partitions.
280
888d53f2
HH
281**rd.luks.crypttab=0**::
282 do not check, if LUKS partition is in _/etc/crypttab_
283
284crypto LUKS - key on removable device support
285~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
b6c89768 286**rd.luks.key=**__<keypath>__:__<keydev>__:__<luksdev>__::
ef9ddb91
HH
287 _keypath_ is a path to key file to look for. It's REQUIRED. When _keypath_
288 ends with '.gpg' it's considered to be key encrypted symmetrically with GPG.
289 You will be prompted for password on boot. GPG support comes with
290 'crypt-gpg' module which needs to be added explicitly.
291+
292_keydev_ is a device on which key file resides. It might be kernel name of
293devices (should start with "/dev/"), UUID (prefixed with "UUID=") or label
294(prefix with "LABEL="). You don't have to specify full UUID. Just its beginning
295will suffice, even if its ambiguous. All matching devices will be probed.
296This parameter is recommended, but not required. If not present, all block
297devices will be probed, which may significantly increase boot time.
298+
299If _luksdev_ is given, the specified key will only be applied for that LUKS
300device. Possible values are the same as for _keydev_. Unless you have several
301LUKS devices, you don't have to specify this parameter. The simplest usage is:
888d53f2 302+
b6c89768
HH
303[listing]
304.Example
305--
888d53f2 306rd.luks.key=/foo/bar.key
b6c89768 307--
888d53f2
HH
308+
309As you see, you can skip colons in such a case.
173edca0
310+
311[NOTE]
312===============================
600c8769 313dracut pipes key to cryptsetup with _-d -_ argument, therefore you need to pipe
173edca0
314to crypsetup luksFormat with _-d -_, too!
315
316Here follows example for key encrypted with GPG:
317
b6c89768
HH
318[listing]
319--
320gpg --quiet --decrypt rootkey.gpg | \
321cryptsetup -d - -v --cipher serpent-cbc-essiv:sha256 \
173edca0 322--key-size 256 luksFormat /dev/sda3
b6c89768 323--
173edca0
324
325If you use plain keys, just add path to _-d_ option:
326
b6c89768
HH
327[listing]
328--
329cryptsetup -d rootkey.key -v --cipher serpent-cbc-essiv:sha256 \
330 --key-size 256 luksFormat /dev/sda3
331--
173edca0 332===============================
888d53f2
HH
333
334MD RAID
335~~~~~~~
336**rd.md=0**::
337 disable MD RAID detection
338
339**rd.md.imsm=0**::
340 disable MD RAID for imsm/isw raids, use DM RAID instead
341
342**rd.md.ddf=0**::
343 disable MD RAID for SNIA ddf raids, use DM RAID instead
344
345**rd.md.conf=0**::
346 ignore mdadm.conf included in initramfs
347
348**rd.md.waitclean=1**::
ef9ddb91
HH
349 wait for any resync, recovery, or reshape activity to finish before
350 continuing
888d53f2 351
b6c89768 352**rd.md.uuid=**__<md raid uuid>__::
888d53f2
HH
353 only activate the raid sets with the given UUID. This parameter can be
354 specified multiple times.
355
356DM RAID
357~~~~~~~
358**rd.dm=0**::
359 disable DM RAID detection
360
b6c89768 361**rd.dm.uuid=**__<dm raid uuid>__::
888d53f2
HH
362 only activate the raid sets with the given UUID. This parameter can be
363 specified multiple times.
364
365FIPS
366~~~~
367**rd.fips**::
368 enable FIPS
369
b6c89768
HH
370**boot=**__<boot device>__::
371 specify the device, where /boot is located.
888d53f2 372+
b6c89768
HH
373[listing]
374.Example
375--
888d53f2
HH
376boot=/dev/sda1
377boot=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
378boot=UUID=<uuid>
379boot=LABEL=<label>
b6c89768 380--
888d53f2
HH
381
382**rd.fips.skipkernel**::
383 skip checksum check of the kernel image. Useful, if the kernel image is not
384 in a separate boot partition.
385
386Network
387~~~~~~~
b6c89768
HH
388
389[IMPORTANT]
390=====================
ef9ddb91
HH
391It is recommended to either bind an interface to a MAC with the **ifname**
392argument, or to use the systemd-udevd predictable network interface names.
b6c89768
HH
393
394Predictable network interface device names based on:
395
396- firmware/bios-provided index numbers for on-board devices
397- firmware-provided pci-express hotplug slot index number
398- physical/geographical location of the hardware
399- the interface's MAC address
400
ef9ddb91
HH
401See:
402http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
b6c89768
HH
403
404Two character prefixes based on the type of interface:
405
406en:: ethernet
407wl:: wlan
408ww:: wwan
409
410Type of names:
411
412o<index>:: on-board device index number
413s<slot>[f<function>][d<dev_id>]:: hotplug slot index number
414x<MAC>:: MAC address
415[P<domain>]p<bus>s<slot>[f<function>][d<dev_id>]:: PCI geographical location
416[P<domain>]p<bus>s<slot>[f<function>][u<port>][..][c<config>][i<interface>]:: USB port number chain
417
418All multi-function PCI devices will carry the [f<function>] number in the
419device name, including the function 0 device.
420
421When using PCI geography, The PCI domain is only prepended when it is not 0.
422
423For USB devices the full chain of port numbers of hubs is composed. If the
424name gets longer than the maximum number of 15 characters, the name is not
425exported.
426The usual USB configuration == 1 and interface == 0 values are suppressed.
427
428PCI ethernet card with firmware index "1"::
429* eno1
430
431PCI ethernet card in hotplug slot with firmware index number::
432* ens1
433
434PCI ethernet multi-function card with 2 ports::
435* enp2s0f0
436* enp2s0f1
437
438PCI wlan card::
439* wlp3s0
440
441USB built-in 3G modem::
442* wwp0s29u1u4i6
443
444USB Android phone::
445* enp0s29u1u2
446=====================
447
5580e4c1 448**ip=**__{dhcp|on|any|dhcp6|auto6}__::
ef9ddb91
HH
449 dhcp|on|any::: get ip from dhcp server from all interfaces. If root=dhcp,
450 loop sequentially through all interfaces (eth0, eth1, ...) and use the first
451 with a valid DHCP root-path.
888d53f2
HH
452
453 auto6::: IPv6 autoconfiguration
454
455 dhcp6::: IPv6 DHCP
456
b6c89768 457**ip=**__<interface>__:__{dhcp|on|any|dhcp6|auto6}__[:[__<mtu>__][:__<macaddr>__]]::
888d53f2
HH
458 This parameter can be specified multiple times.
459+
1760dfc0 460=====================
888d53f2
HH
461dhcp|on|any|dhcp6::: get ip from dhcp server on a specific interface
462auto6::: do IPv6 autoconfiguration
1760dfc0
HH
463<macaddr>::: optionally **set** <macaddr> on the <interface>. This
464cannot be used in conjunction with the **ifname** argument for the
465same <interface>.
466=====================
467
e38e73d5 468**ip=**__<client-IP>__:[__<peer>__]:__<gateway-IP>__:__<netmask>__:__<client_hostname>__:__<interface>__:__{none|off|dhcp|on|any|dhcp6|auto6|ibft}__:[:[__<mtu>__][:__<macaddr>__]]::
888d53f2
HH
469 explicit network configuration. If you want do define a IPv6 address, put it
470 in brackets (e.g. [2001:DB8::1]). This parameter can be specified multiple
e38e73d5 471 times. __<peer>__ is optional and is the address of the remote endpoint
ef9ddb91
HH
472 for pointopoint interfaces and it may be followed by a slash and a decimal
473 number, encoding the network prefix length.
990e945f 474+
1760dfc0
HH
475=====================
476<macaddr>::: optionally **set** <macaddr> on the <interface>. This
477cannot be used in conjunction with the **ifname** argument for the
478same <interface>.
479=====================
480
1982098e
HH
481**ip=**__<client-IP>__:[__<peer>__]:__<gateway-IP>__:__<netmask>__:__<client_hostname>__:__<interface>__:__{none|off|dhcp|on|any|dhcp6|auto6|ibft}__[:[__<dns1>__][:__<dns2>__]]::
482 explicit network configuration. If you want do define a IPv6 address, put it
483 in brackets (e.g. [2001:DB8::1]). This parameter can be specified multiple
484 times. __<peer>__ is optional and is the address of the remote endpoint
485 for pointopoint interfaces and it may be followed by a slash and a decimal
486 number, encoding the network prefix length.
487
b6c89768 488**ifname=**__<interface>__:__<MAC>__::
ef9ddb91
HH
489 Assign network device name <interface> (ie "bootnet") to the NIC with
490 MAC <MAC>.
1760dfc0 491+
b6c89768 492WARNING: Do **not** use the default kernel naming scheme for the interface name,
1760dfc0
HH
493as it can conflict with the kernel names. So, don't use "eth[0-9]+" for the
494interface name. Better name it "bootnet" or "bluesocket".
888d53f2 495
7b46244b
HH
496**rd.route=**__<net>__/__<netmask>__:__<gateway>__[:__<interface>__]::
497 Add a static route with route options, which are separated by a colon.
498 IPv6 addresses have to be put in brackets.
499+
500[listing]
501.Example
502--
503 rd.route=192.168.200.0/24:192.168.100.222:ens10
504 rd.route=192.168.200.0/24:192.168.100.222
505 rd.route=192.168.200.0/24::ens10
506 rd.route=[2001:DB8:3::/8]:[2001:DB8:2::1]:ens10
507--
508
b6c89768 509**bootdev=**__<interface>__::
888d53f2
HH
510 specify network interface to use routing and netroot information from.
511 Required if multiple ip= lines are used.
512
ee993857
HH
513**BOOTIF=**__<MAC>__::
514 specify network interface to use routing and netroot information from.
515
516**rd.bootif=0**::
517 Disable BOOTIF parsing, which is provided by PXE
518
888d53f2
HH
519**nameserver=**__<IP>__ [**nameserver=**__<IP>__ ...]::
520 specify nameserver(s) to use
521
522**biosdevname=0**::
523 boolean, turn off biosdevname network interface renaming
524
48dba7f9
HH
525**rd.neednet=1**::
526 boolean, bring up network even without netroot set
527
b6c89768 528**vlan=**__<vlanname>__:__<phydevice>__::
144787fe 529 Setup vlan device named <vlanname> on <phydeivce>.
ef9ddb91
HH
530 We support the four styles of vlan names: VLAN_PLUS_VID (vlan0005),
531 VLAN_PLUS_VID_NO_PAD (vlan5), DEV_PLUS_VID (eth0.0005),
532 DEV_PLUS_VID_NO_PAD (eth0.5)
144787fe 533
b6c89768 534**bond=**__<bondname>__[:__<bondslaves>__:[:__<options>__]]::
c438bdb0
AW
535 Setup bonding device <bondname> on top of <bondslaves>.
536 <bondslaves> is a comma-separated list of physical (ethernet) interfaces.
ef9ddb91
HH
537 <options> is a comma-separated list on bonding options (modinfo bonding for
538 details) in format compatible with initscripts. If <options> includes
539 multi-valued arp_ip_target option, then its values should be separated by
540 semicolon. Bond without parameters assumes
541 bond=bond0:eth0,eth1:mode=balance-rr
c438bdb0 542
b6c89768 543**team=**__<teammaster>__:__<teamslaves>__::
3baa150b
CW
544 Setup team device <teammaster> on top of <teamslaves>.
545 <teamslaves> is a comma-separated list of physical (ethernet) interfaces.
546
b6c89768 547**bridge=**__<bridgename>__:__<ethnames>__::
21928b97 548 Setup bridge <bridgename> with <ethnames>. <ethnames> is a comma-separated
ef9ddb91
HH
549 list of physical (ethernet) interfaces. Bridge without parameters assumes
550 bridge=br0:eth0
9337c692 551
888d53f2
HH
552NFS
553~~~
b6c89768 554**root=**\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
888d53f2 555 mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given, use
7b46244b 556 dhcp next_server. If server-ip is an IPv6 address it has to be put in
888d53f2
HH
557 brackets, e.g. [2001:DB8::1]. NFS options can be appended with the prefix
558 ":" or "," and are seperated by ",".
559
b6c89768 560**root=**nfs:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**nfs4:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**__{dhcp|dhcp6}__::
888d53f2
HH
561 root=dhcp alone directs initrd to look at the DHCP root-path where NFS
562 options can be specified.
563+
b6c89768
HH
564[listing]
565.Example
566--
888d53f2
HH
567 root-path=<server-ip>:<root-dir>[,<nfs-options>]
568 root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
569 root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>]
b6c89768 570--
888d53f2 571
b6c89768 572**root=**_/dev/nfs_ nfsroot=\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
888d53f2
HH
573 _Deprecated!_ kernel Documentation_/filesystems/nfsroot.txt_ defines this
574 method. This is supported by dracut, but not recommended.
575
b6c89768 576**rd.nfs.domain=**__<NFSv4 domain name>__::
888d53f2
HH
577 Set the NFSv4 domain name. Will overwrite the settings in _/etc/idmap.conf_.
578
d580636e
MG
579CIFS
580~~~
b6c89768 581**root=**cifs://[__<username>__[:__<password>__]@]__<server-ip>__:__<root-dir>__::
d580636e
MG
582 mount cifs share from <server-ip>:/<root-dir>, if no server-ip is given, use
583 dhcp next_server. if server-ip is an IPv6 address it has to be put in
584 brackets, e.g. [2001:DB8::1]. If a username or password are not specified
585as part of the root, then they must be passed on the command line through
586cifsuser/cifspass.
833685de 587+
ef9ddb91
HH
588WARNING: Passwords specified on the kernel command line are visible for all
589users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
590network, when using DHCP with DHCP root-path.
d580636e 591
b6c89768 592**cifsuser**=__<username>__::
d580636e
MG
593 Set the cifs username, if not specified as part of the root.
594
b6c89768 595**cifspass**=__<password>__::
d580636e 596 Set the cifs password, if not specified as part of the root.
833685de 597+
ef9ddb91
HH
598WARNING: Passwords specified on the kernel command line are visible for all
599users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
600network, when using DHCP with DHCP root-path.
d580636e 601
888d53f2
HH
602iSCSI
603~~~~~
b6c89768 604**root=**iscsi:[__<username>__:__<password>__[:__<reverse>__:__<password>__]@][__<servername>__]:[__<protocol>__]:[__<port>__][:[__<iscsi_iface_name>__]:[__<netdev_name>__]]:[__<LUN>__]:__<targetname>__::
888d53f2
HH
605 protocol defaults to "6", LUN defaults to "0". If the "servername" field is
606 provided by BOOTP or DHCP, then that field is used in conjunction with other
607 associated fields to contact the boot server in the Boot stage. However, if
608 the "servername" field is not provided, then the "targetname" field is then
609 used in the Discovery Service stage in conjunction with other associated
610 fields. See
611 link:$$http://tools.ietf.org/html/rfc4173#section-5$$[rfc4173].
888d53f2 612+
ef9ddb91
HH
613WARNING: Passwords specified on the kernel command line are visible for all
614users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
615network, when using DHCP with DHCP root-path.
b6c89768
HH
616+
617[listing]
618.Example
619--
888d53f2 620root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
b6c89768 621--
888d53f2 622+
b6c89768 623If servername is an IPv6 address, it has to be put in brackets:
888d53f2 624+
b6c89768
HH
625[listing]
626.Example
627--
888d53f2 628root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
b6c89768 629--
888d53f2 630
b6c89768
HH
631**root=**__???__ **netroot=**iscsi:[__<username>__:__<password>__[:__<reverse>__:__<password>__]@][__<servername>__]:[__<protocol>__]:[__<port>__][:[__<iscsi_iface_name>__]:[__<netdev_name>__]]:[__<LUN>__]:__<targetname>__ ...::
632 multiple netroot options allow setting up multiple iscsi disks:
888d53f2 633+
b6c89768
HH
634[listing]
635.Example
636--
888d53f2
HH
637root=UUID=12424547
638netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
639netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1
b6c89768 640--
888d53f2 641+
b6c89768 642If servername is an IPv6 address, it has to be put in brackets:
888d53f2 643+
b6c89768
HH
644[listing]
645.Example
646--
888d53f2 647netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
b6c89768 648--
833685de 649+
ef9ddb91
HH
650WARNING: Passwords specified on the kernel command line are visible for all
651users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
652network, when using DHCP with DHCP root-path.
653You may want to use rd.iscsi.firmware.
888d53f2 654
b6c89768 655**root=**__???__ **rd.iscsi.initiator=**__<initiator>__ **rd.iscsi.target.name=**__<target name>__ **rd.iscsi.target.ip=**__<target ip>__ **rd.iscsi.target.port=**__<target port>__ **rd.iscsi.target.group=**__<target group>__ **rd.iscsi.username=**__<username>__ **rd.iscsi.password=**__<password>__ **rd.iscsi.in.username=**__<in username>__ **rd.iscsi.in.password=**__<in password>__::
888d53f2 656 manually specify all iscsistart parameter (see **+iscsistart --help+**)
833685de 657+
ef9ddb91
HH
658WARNING: Passwords specified on the kernel command line are visible for all
659users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
660network, when using DHCP with DHCP root-path.
661You may want to use rd.iscsi.firmware.
888d53f2
HH
662
663**root=**_???_ **netroot=**iscsi **rd.iscsi.firmware=1**::
664 will read the iscsi parameter from the BIOS firmware
665
b6c89768 666**rd.iscsi.param=**__<param>__::
8d51acbb
HH
667 <param> will be passed as "--param <param>" to iscsistart.
668 This parameter can be specified multiple times.
8d51acbb 669+
b6c89768
HH
670[listing]
671.Example
672--
833685de 673"netroot=iscsi rd.iscsi.firmware=1 rd.iscsi.param=node.session.timeo.replacement_timeout=30"
b6c89768 674--
8d51acbb
HH
675+
676will result in
677+
b6c89768
HH
678[listing]
679--
8d51acbb 680iscsistart -b --param node.session.timeo.replacement_timeout=30
b6c89768 681--
8d51acbb 682
5580e4c1
HH
683**rd.iscsi.ibft** **rd.iscsi.ibft=1**:
684 Turn on iBFT autoconfiguration for the interfaces
685
888d53f2
HH
686FCoE
687~~~~
b6c89768 688**fcoe=**__<edd|interface|MAC>__:__{dcb|nodcb}__::
888d53f2
HH
689 Try to connect to a FCoE SAN through the NIC specified by _<interface>_ or
690 _<MAC>_ or EDD settings. For the second argument, currently only nodcb is
1760dfc0
HH
691 supported. This parameter can be specified multiple times.
692+
b6c89768 693NOTE: letters in the MAC-address must be lowercase!
888d53f2
HH
694
695NBD
696~~~
b6c89768 697**root=**??? **netroot=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
888d53f2
HH
698 mount nbd share from <server>
699
b6c89768 700**root=dhcp** with **dhcp** **root-path=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
888d53f2
HH
701 root=dhcp alone directs initrd to look at the DHCP root-path where NBD
702 options can be specified. This syntax is only usable in cases where you are
703 directly mounting the volume as the rootfs.
704
705DASD
706~~~~
4d76a85d 707**rd.dasd=**....::
888d53f2
HH
708 same syntax as the kernel module parameter (s390 only)
709
888d53f2
HH
710ZFCP
711~~~~
b6c89768
HH
712**rd.zfcp=**__<zfcp adaptor device bus ID>__,__<WWPN>__,__<FCPLUN>__::
713 rd.zfcp can be specified multiple times on the kernel command line.
888d53f2 714+
b6c89768
HH
715[listing]
716.Example
717--
888d53f2 718rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
b6c89768 719--
888d53f2
HH
720
721**rd.zfcp.conf=0**::
722 ignore zfcp.conf included in the initramfs
723
724ZNET
725~~~~
b6c89768
HH
726**rd.znet=**__<nettype>__,__<subchannels>__,__<options>__::
727 rd.znet can be specified multiple times on the kernel command line.
888d53f2 728+
b6c89768
HH
729[listing]
730.Example
731--
888d53f2 732rd.znet=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo
62fd2b36 733rd.znet=ctc,0.0.0600,0.0.0601,protocol=bar
b6c89768 734--
888d53f2 735
504c0a8f
MH
736Booting live images
737~~~~~~~~~~~~~~~~~~~
738Dracut offers multiple options for live booted images:
739
740=====================
741squashfs with read-only filesystem image::: The system will boot with a read
742only filesystem from the squashfs and apply a writable device mapper snapshot
743over the read only filesystem. Using this method ensures a relatively fast
744boot and lower RAM usage. Users **must be careful** to avoid writing too many
745blocks to the snapshot volume. Once the blocks of the snapshot are exhaused,
746the live filesystem becomes unusable and requires a reboot.
747+
748The filesystem structure is expected to be:
749+
750[listing]
751--
752squashfs.img | Squashfs downloaded via network
753 !(mount)
754 /LiveOS
755 |- ext3fs.img | Filesystem image to mount read-only
756 !(mount)
757 /bin | Live filesystem
758 /boot |
759 /dev |
760 ... |
761--
762+
763Dracut uses this method of live booting by default. No additional command line
764options are required other than **root=live:<URL>** to specify the location
765of your squashed filesystem.
766+
767writable filesystem image::: The system will retrieve a compressed filesystem
768image, connect it to a loopback device, and mount it as a writable volume. More
769RAM is required during boot but the live filesystem is easier to manage if it
770becomes full. Users can make a filesystem image of any size and that size will
771be maintained when the system boots.
772+
773The filesystem structure is expected to be:
774+
775[listing]
776--
777rootfs.tgz | Compressed tarball containing fileystem image
778 !(unpack)
779 /rootfs.img | Filesystem image
780 !(mount)
781 /bin | Live filesystem
782 /boot |
783 /dev |
784 ... |
785--
786+
787To use this boot option, ensure that **rd.writable_fsimg=1** is in your kernel
788command line and add the **root=live:<URL>** to specify the location
789of your compressed filesystem image tarball.
790=====================
791
792**root=**live:__<url>__::
338bad63 793Boots a live image retrieved from __<url>__. Valid handlers: __http, https, ftp, torrent, tftp__.
504c0a8f
MH
794+
795[listing]
796.Example
797--
798root=live:http://example.com/liveboot.img
799root=live:ftp://ftp.example.com/liveboot.img
338bad63 800root=live:torrent://example.com/liveboot.img.torrent
504c0a8f
MH
801--
802
803**rd.live.debug=**1::
804Enables debug output from the live boot process.
805
806**rd.live.dir=**__<path>__::
807Specifies the directory within the squashfs where the ext3fs.img or rootfs.img
808can be found. By default, this is __LiveOS__.
809
810**rd.writable.fsimg=**1::
811Enables writable filesystem support. The system will boot with a fully
812writable filesystem without snapshots __(see notes above about available live boot options)__.
813You can use the **rootflags** option to set mount options for the live
814filesystem as well __(see documentation about rootflags in the **Standard** section above)__.
815
816
888d53f2
HH
817Plymouth Boot Splash
818~~~~~~~~~~~~~~~~~~~~
819**plymouth.enable=0**::
504c0a8f 820 disable the plymouth bootsplash completely.
888d53f2
HH
821
822**rd.plymouth=0**::
823 disable the plymouth bootsplash only for the initramfs.
824
825Kernel keys
826~~~~~~~~~~~
b6c89768
HH
827**masterkey=**__<kernel master key path name>__::
828 Set the path name of the kernel master key.
888d53f2 829+
b6c89768
HH
830[listing]
831.Example
832--
888d53f2 833masterkey=/etc/keys/kmk-trusted.blob
b6c89768 834--
888d53f2 835
b6c89768
HH
836**masterkeytype=**__<kernel master key type>__::
837 Set the type of the kernel master key.
888d53f2 838+
b6c89768
HH
839[listing]
840.Example
841--
888d53f2 842masterkeytype=trusted
b6c89768 843--
888d53f2 844
b6c89768
HH
845**evmkey=**__<EVM key path name>__::
846 Set the path name of the EVM key.
888d53f2 847+
b6c89768
HH
848[listing]
849.Example
850--
888d53f2 851evmkey=/etc/keys/evm-trusted.blob
b6c89768 852--
888d53f2 853
b6c89768
HH
854**ecryptfskey=**__<eCryptfs key path name>__::
855 Set the path name of the eCryptfs key.
888d53f2 856+
b6c89768
HH
857[listing]
858.Example
859--
888d53f2 860ecryptfskey=/etc/keys/ecryptfs-trusted.blob
b6c89768 861--
888d53f2
HH
862
863Deprecated, renamed Options
864~~~~~~~~~~~~~~~~~~~~~~~~~~~
ef9ddb91
HH
865Here is a list of options, which were used in dracut prior to version 008, and
866their new replacement.
888d53f2
HH
867
868rdbreak:: rd.break
869
870rd_CCW:: rd.ccw
871
4d76a85d 872rd_DASD_MOD:: rd.dasd
888d53f2
HH
873
874rd_DASD:: rd.dasd
875
876rdinitdebug rdnetdebug:: rd.debug
877
878rd_NO_DM:: rd.dm=0
879
880rd_DM_UUID:: rd.dm.uuid
881
882rdblacklist:: rd.driver.blacklist
883
884rdinsmodpost:: rd.driver.post
885
886rdloaddriver:: rd.driver.pre
887
888rd_NO_FSTAB:: rd.fstab=0
889
890rdinfo:: rd.info
891
892check:: rd.live.check
893
894rdlivedebug:: rd.live.debug
895
896live_dir:: rd.live.dir
897
898liveimg:: rd.live.image
899
900overlay:: rd.live.overlay
901
902readonly_overlay:: rd.live.overlay.readonly
903
904reset_overlay:: rd.live.overlay.reset
905
906live_ram:: rd.live.ram
907
908rd_NO_CRYPTTAB:: rd.luks.crypttab=0
909
910rd_LUKS_KEYDEV_UUID:: rd.luks.keydev.uuid
911
912rd_LUKS_KEYPATH:: rd.luks.keypath
913
914rd_NO_LUKS:: rd.luks=0
915
916rd_LUKS_UUID:: rd.luks.uuid
917
918rd_NO_LVMCONF:: rd.lvm.conf
919
920rd_LVM_LV:: rd.lvm.lv
921
922rd_NO_LVM:: rd.lvm=0
923
924rd_LVM_SNAPSHOT:: rd.lvm.snapshot
925
926rd_LVM_SNAPSIZE:: rd.lvm.snapsize
927
928rd_LVM_VG:: rd.lvm.vg
929
930rd_NO_MDADMCONF:: rd.md.conf=0
931
932rd_NO_MDIMSM:: rd.md.imsm=0
933
934rd_NO_MD:: rd.md=0
935
936rd_MD_UUID:: rd.md.uuid
937
938rd_NFS_DOMAIN:: rd.nfs.domain
939
940iscsi_initiator:: rd.iscsi.initiator
941
942iscsi_target_name:: rd.iscsi.target.name
943
944iscsi_target_ip:: rd.iscsi.target.ip
945
946iscsi_target_port:: rd.iscsi.target.port
947
948iscsi_target_group:: rd.iscsi.target.group
949
950iscsi_username:: rd.iscsi.username
951
952iscsi_password:: rd.iscsi.password
953
954iscsi_in_username:: rd.iscsi.in.username
955
956iscsi_in_password:: rd.iscsi.in.password
957
958iscsi_firmware:: rd.iscsi.firmware=0
959
960rd_NO_PLYMOUTH:: rd.plymouth=0
961
962rd_retry:: rd.retry
963
964rdshell:: rd.shell
965
966rd_NO_SPLASH:: rd.splash
967
968rdudevdebug:: rd.udev.debug
969
970rdudevinfo:: rd.udev.info
971
972rd_NO_ZFCPCONF:: rd.zfcp.conf=0
973
974rd_ZFCP:: rd.zfcp
975
976rd_ZNET:: rd.znet
977
978KEYMAP:: vconsole.keymap
979
980KEYTABLE:: vconsole.keymap
981
982SYSFONT:: vconsole.font
983
984CONTRANS:: vconsole.font.map
985
986UNIMAP:: vconsole.font.unimap
987
988UNICODE:: vconsole.unicode
989
990EXT_KEYMAP:: vconsole.keymap.ext
991
992Configuration in the Initramfs
993~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
994_/etc/conf.d/_::
995 Any files found in _/etc/conf.d/_ will be sourced in the initramfs to
996 set initial values. Command line options will override these values
997 set in the configuration files.
998
999_/etc/cmdline_::
ef9ddb91
HH
1000 Can contain additional command line options. Deprecated, better use
1001 /etc/cmdline.d/*.conf.
888d53f2
HH
1002
1003_/etc/cmdline.d/*.conf_::
1004 Can contain additional command line options.
1005
1006AUTHOR
1007------
9f355169 1008Harald Hoyer
888d53f2
HH
1009
1010SEE ALSO
1011--------
1012*dracut*(8) *dracut.conf*(5)