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