shutdown.sh: correct return code of _check_shutdown()
[dracut.git] / dracut.cmdline.7.asc
blob48356c7530e88acb90a31f4013fec4b309059a6a
1 DRACUT.CMDLINE(7)
2 =================
3 :doctype: manpage
4 :man source:   dracut
5 :man manual:   dracut
7 NAME
8 ----
9 dracut.cmdline - dracut kernel command line options
11 DESCRIPTION
12 -----------
13 The root device used by the kernel is specified in the boot configuration
14 file on the kernel command line, as always.
16 The traditional _root=/dev/sda1_ style device specification is allowed, but not
17 encouraged. The root device should better be identified by LABEL or UUID. If a
18 label is used, as in _root=LABEL=<label_of_root>_ the initramfs will search all
19 available devices for a filesystem with the appropriate label, and mount that
20 device as the root filesystem. _root=UUID=<uuidnumber>_ will mount the partition
21 with that UUID as the root filesystem.
23 In the following all kernel command line parameters, which are processed by
24 dracut, are described.
26 "rd.*" parameters mentioned without "=" are boolean parameters. They can be
27 turned 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
29 turned on with _rd.info=1_ or _rd.info_. The last value in the kernel command
30 line is the value, which is honored.
32 Standard
33 ~~~~~~~~
34 **init=**__<path to real init>__::
35     specify the path to the init programm to be started after the initramfs has
36     finished
38 **root=**__<path to blockdevice>__::
39     specify the block device to use as the root filesystem.
41 [listing]
42 .Example
44 root=/dev/sda1
45 root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
46 root=/dev/disk/by-label/Root
47 root=LABEL=Root
48 root=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
49 root=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
50 root=PARTUUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
53 **rootfstype=**__<filesystem type>__:: "auto" if not specified.
55 [listing]
56 .Example
58 rootfstype=ext3
61 **rootflags=**__<mount options>__::
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.
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_.
70 **rw**::
71     force mounting _/_ and _/usr_ (if it is a separate device) read-write.
72     See also ro option.
74 **rootfallback=**__<path to blockdevice>__::
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.
80 **rd.auto** **rd.auto=1**::
81     enable autoassembly of special devices like cryptoLUKS, dmraid, mdraid or
82     lvm. Default is off as of dracut version >= 024.
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.
89 **rd.cmdline=ask**::
90     prompts the user for additional kernel command line parameters
92 **rd.fstab=0**::
93     do not honor special mount options for the root filesystem found in
94     _/etc/fstab_ of the real root.
96 **resume=**__<path to resume partition>__::
97     resume from a swap partition
99 [listing]
100 .Example
102 resume=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
103 resume=/dev/disk/by-uuid/3f5ad593-4546-4a94-a374-bcfb68aa11f7
104 resume=UUID=3f5ad593-4546-4a94-a374-bcfb68aa11f7
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.
112 iso-scan/filename
113 ~~~~~~~~~~~~~~~~~
115 Using iso-scan/filename with a Fedora/Red Hat/CentOS Live iso should just work
116 by copying the original kernel cmdline parameters.
118 [listing]
119 .Example
121 menuentry '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
130 Misc
131 ~~~~
132 **rd.driver.blacklist=**__<drivername>__[,__<drivername>__,...]::
133     do not load kernel module <drivername>. This parameter can be specified
134     multiple times.
136 **rd.driver.pre=**__<drivername>__[,__<drivername>__,...]::
137     force loading kernel module <drivername>. This parameter can be specified
138     multiple times.
140 **rd.driver.post=**__<drivername>__[,__<drivername>__,...]::
141     force loading kernel module <drivername> after all automatic loading modules
142     have been loaded. This parameter can be specified multiple times.
144 **rd.retry=**__<seconds>__::
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
147     started. If you have hardware, which takes a very long time to announce its
148     drives, you might want to extend this value.
150 **rd.noverifyssl**::
151     accept self-signed certificates for ssl downloads.
153 **rd.ctty=**__<terminal device>__::
154    specify the controlling terminal for the console.
155    This is useful, if you have multiple "console=" arguments.
157 [[dracutkerneldebug]]
158 Debug
159 ~~~~~
160 If you are dropped to an emergency shell, the file 
161 _/run/initramfs/rdsosreport.txt_ is created, which can be safed to a (to be
162 mounted by hand) partition (usually /boot) or a USB stick. Additional debugging
163 info can be produced by adding **rd.debug** to the kernel command line.
164 _/run/initramfs/rdsosreport.txt_ contains all logs and the output of some tools.
165 It should be attached to any report about dracut problems.
167 **rd.info**::
168     print informational output though "quiet" is set
170 **rd.shell**::
171     allow dropping to a shell, if root mounting fails
173 **rd.debug**::
174     set -x for the dracut shell.
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_.
179     If "quiet" is set, it also logs to the console.
181 **rd.memdebug=[0-3]**::
182     Print memory usage info at various points, set the verbose level from 0 to 3.
183 +    
184     Higher level means more debugging output:
186 ----
187     0 - no output
188     1 - partial /proc/meminfo
189     2 - /proc/meminfo
190     3 - /proc/meminfo + /proc/slabinfo
191 ----
193 **rd.break**::
194     drop to a shell at the end
196 **rd.break=**__{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot|cleanup}__::
197     drop to a shell on defined breakpoint
199 **rd.udev.info**::
200     set udev to loglevel info
202 **rd.udev.debug**::
203     set udev to loglevel debug
205 I18N
206 ~~~~
207 **rd.vconsole.keymap=**__<keymap base file name>__::
208     keyboard translation table loaded by loadkeys; taken from keymaps directory;
209     will be written as KEYMAP to _/etc/vconsole.conf_ in the initramfs.
211 [listing]
212 .Example
214 rd.vconsole.keymap=de-latin1-nodeadkeys
217 **rd.vconsole.keymap.ext=**__<list of keymap base file names>__::
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
221 **rd.vconsole.unicode**::
222     boolean, indicating UTF-8 mode; will be written as UNICODE to
223     _/etc/vconsole.conf_ in the initramfs
225 **rd.vconsole.font=**__<font base file name>__::
226     console font; taken from consolefonts directory; will be written as FONT to
227     _/etc/vconsole.conf_ in the initramfs.
229 [listing]
230 .Example
232 rd.vconsole.font=LatArCyrHeb-16
235 **rd.vconsole.font.map=**__<console map base file name>__::
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
240 **rd.vconsole.font.unimap=**__<unicode table base file name>__::
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
245 **rd.locale.LANG=**__<locale>__::
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
248     be written as LANG to _/etc/locale.conf_ in the initramfs.
250 [listing]
251 .Example
253 rd.locale.LANG=pl_PL.utf8
256 **rd.locale.LC_ALL=**__<locale>__::
257     taken from the environment; will be written as LC_ALL to _/etc/locale.conf_
258     in the initramfs
262 **rd.lvm=0**::
263     disable LVM detection
265 **rd.lvm.vg=**__<volume group name>__::
266     only activate the volume groups with the given name. rd.lvm.vg can be
267     specified multiple times on the kernel command line.
269 **rd.lvm.lv=**__<logical volume name>__::
270     only activate the logical volumes with the given name. rd.lvm.lv can be
271     specified multiple times on the kernel command line.
273 **rd.lvm.conf=0**::
274     remove any _/etc/lvm/lvm.conf_, which may exist in the initramfs
276 crypto LUKS
277 ~~~~~~~~~~~
278 **rd.luks=0**::
279     disable crypto LUKS detection
281 **rd.luks.uuid=**__<luks uuid>__::
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.
288 **rd.luks.allow-discards=**__<luks uuid>__::
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.
293     This parameter can be specified multiple times.
295 **rd.luks.allow-discards**::
296     Allow  using  of discards (TRIM) requests on all LUKS partitions.
298 **rd.luks.crypttab=0**::
299     do not check, if LUKS partition is in _/etc/crypttab_
301 crypto LUKS - key on removable device support
302 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
303 **rd.luks.key=**__<keypath>__:__<keydev>__:__<luksdev>__::
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.
309 _keydev_ is a device on which key file resides. It might be kernel name of
310 devices (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
312 will suffice, even if its ambiguous. All matching devices will be probed.
313 This parameter is recommended, but not required. If not present, all block
314 devices will be probed, which may significantly increase boot time.
316 If _luksdev_ is given, the specified key will only be applied for that LUKS
317 device. Possible values are the same as for _keydev_. Unless you have several
318 LUKS devices, you don't have to specify this parameter. The simplest usage is:
320 [listing]
321 .Example
323 rd.luks.key=/foo/bar.key
326 As you see, you can skip colons in such a case.
328 [NOTE]
329 ===============================
330 dracut pipes key to cryptsetup with _-d -_ argument, therefore you need to pipe
331 to crypsetup luksFormat with _-d -_, too!
333 Here follows example for key encrypted with GPG:
335 [listing]
337 gpg --quiet --decrypt rootkey.gpg | \
338 cryptsetup -d - -v --cipher serpent-cbc-essiv:sha256 \
339 --key-size 256 luksFormat /dev/sda3
342 If you use plain keys, just add path to _-d_ option:
344 [listing]
346 cryptsetup -d rootkey.key -v --cipher serpent-cbc-essiv:sha256 \
347  --key-size 256 luksFormat /dev/sda3
349 ===============================
351 MD RAID
352 ~~~~~~~
353 **rd.md=0**::
354     disable MD RAID detection
356 **rd.md.imsm=0**::
357     disable MD RAID for imsm/isw raids, use DM RAID instead
359 **rd.md.ddf=0**::
360     disable MD RAID for SNIA ddf raids, use DM RAID instead
362 **rd.md.conf=0**::
363     ignore mdadm.conf included in initramfs
365 **rd.md.waitclean=1**::
366     wait for any resync, recovery, or reshape activity to finish before
367     continuing
369 **rd.md.uuid=**__<md raid uuid>__::
370     only activate the raid sets with the given UUID. This parameter can be
371     specified multiple times.
373 DM RAID
374 ~~~~~~~
375 **rd.dm=0**::
376     disable DM RAID detection
378 **rd.dm.uuid=**__<dm raid uuid>__::
379    only activate the raid sets with the given UUID. This parameter can be
380    specified multiple times.
382 FIPS
383 ~~~~
384 **rd.fips**::
385     enable FIPS
387 **boot=**__<boot device>__::
388     specify the device, where /boot is located.
390 [listing]
391 .Example
393 boot=/dev/sda1
394 boot=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
395 boot=UUID=<uuid>
396 boot=LABEL=<label>
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.
403 Network
404 ~~~~~~~
406 [IMPORTANT]
407 =====================
408 It is recommended to either bind an interface to a MAC with the **ifname**
409 argument, or to use the systemd-udevd predictable network interface names.
411 Predictable network interface device names based on:
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
418 See:
419 http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames
421 Two character prefixes based on the type of interface:
423 en:: ethernet
424 wl:: wlan
425 ww:: wwan
427 Type of names:
429 o<index>:: on-board device index number
430 s<slot>[f<function>][d<dev_id>]:: hotplug slot index number
431 x<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
435 All multi-function PCI devices will carry the [f<function>] number in the
436 device name, including the function 0 device.
438 When using PCI geography, The PCI domain is only prepended when it is not 0.
440 For USB devices the full chain of port numbers of hubs is composed. If the
441 name gets longer than the maximum number of 15 characters, the name is not
442 exported.
443 The usual USB configuration == 1 and interface == 0 values are suppressed.
445 PCI ethernet card with firmware index "1"::
446 * eno1
448 PCI ethernet card in hotplug slot with firmware index number::
449 * ens1
451 PCI ethernet multi-function card with 2 ports::
452 * enp2s0f0
453 * enp2s0f1
455 PCI wlan card::
456 * wlp3s0
458 USB built-in 3G modem::
459 * wwp0s29u1u4i6
461 USB Android phone::
462 * enp0s29u1u2
463 =====================
465 **ip=**__{dhcp|on|any|dhcp6|auto6}__::
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.
470     auto6::: IPv6 autoconfiguration
472     dhcp6::: IPv6 DHCP
474 **ip=**__<interface>__:__{dhcp|on|any|dhcp6|auto6}__[:[__<mtu>__][:__<macaddr>__]]::
475     This parameter can be specified multiple times.
477 =====================
478 dhcp|on|any|dhcp6::: get ip from dhcp server on a specific interface
479 auto6::: do IPv6 autoconfiguration
480 <macaddr>::: optionally **set** <macaddr> on the <interface>. This
481 cannot be used in conjunction with the **ifname** argument for the
482 same <interface>.
483 =====================
485 **ip=**__<client-IP>__:[__<peer>__]:__<gateway-IP>__:__<netmask>__:__<client_hostname>__:__<interface>__:__{none|off|dhcp|on|any|dhcp6|auto6|ibft}__:[:[__<mtu>__][:__<macaddr>__]]::
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
488     times. __<peer>__ is optional and is the address of the remote endpoint
489     for pointopoint interfaces and it may be followed by a slash and a decimal
490     number, encoding the network prefix length.
492 =====================
493 <macaddr>::: optionally **set** <macaddr> on the <interface>. This
494 cannot be used in conjunction with the **ifname** argument for the
495 same <interface>.
496 =====================
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.
505 **ifname=**__<interface>__:__<MAC>__::
506     Assign network device name <interface> (ie "bootnet") to the NIC with
507     MAC <MAC>.
509 WARNING: Do **not** use the default kernel naming scheme for the interface name,
510 as it can conflict with the kernel names. So, don't use "eth[0-9]+" for the
511 interface name. Better name it "bootnet" or "bluesocket".
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.
517 [listing]
518 .Example
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
526 **bootdev=**__<interface>__::
527     specify network interface to use routing and netroot information from.
528     Required if multiple ip= lines are used.
530 **BOOTIF=**__<MAC>__::
531     specify network interface to use routing and netroot information from.
533 **rd.bootif=0**::
534     Disable BOOTIF parsing, which is provided by PXE
536 **nameserver=**__<IP>__ [**nameserver=**__<IP>__ ...]::
537     specify nameserver(s) to use
539 **biosdevname=0**::
540     boolean, turn off biosdevname network interface renaming
542 **rd.neednet=1**::
543     boolean, bring up network even without netroot set
545 **vlan=**__<vlanname>__:__<phydevice>__::
546     Setup vlan device named <vlanname> on <phydeivce>.
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)
551 **bond=**__<bondname>__[:__<bondslaves>__:[:__<options>__]]::
552     Setup bonding device <bondname> on top of <bondslaves>.
553     <bondslaves> is a comma-separated list of physical (ethernet) interfaces.
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
560 **team=**__<teammaster>__:__<teamslaves>__::
561     Setup team device <teammaster> on top of <teamslaves>.
562     <teamslaves> is a comma-separated list of physical (ethernet) interfaces.
564 **bridge=**__<bridgename>__:__<ethnames>__::
565     Setup bridge <bridgename> with <ethnames>. <ethnames> is a comma-separated
566     list of physical (ethernet) interfaces. Bridge without parameters assumes
567     bridge=br0:eth0
571 **root=**\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
572     mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given, use
573     dhcp next_server. If server-ip is an IPv6 address it has to be put in
574     brackets, e.g. [2001:DB8::1]. NFS options can be appended with the prefix
575     ":" or "," and are seperated by ",".
577 **root=**nfs:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**nfs4:\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__], **root=**__{dhcp|dhcp6}__::
578     root=dhcp alone directs initrd to look at the DHCP root-path where NFS
579     options can be specified.
581 [listing]
582 .Example
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>]
589 **root=**_/dev/nfs_ nfsroot=\[_<server-ip>_:]__<root-dir>__[:__<nfs-options>__]::
590     _Deprecated!_ kernel Documentation_/filesystems/nfsroot.txt_ defines this
591     method. This is supported by dracut, but not recommended.
593 **rd.nfs.domain=**__<NFSv4 domain name>__::
594     Set the NFSv4 domain name. Will overwrite the settings in _/etc/idmap.conf_.
596 CIFS
598 **root=**cifs://[__<username>__[:__<password>__]@]__<server-ip>__:__<root-dir>__::
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
602 as part of the root, then they must be passed on the command line through
603 cifsuser/cifspass.
605 WARNING: Passwords specified on the kernel command line are visible for all
606 users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
607 network, when using DHCP with DHCP root-path.
609 **cifsuser**=__<username>__::
610     Set the cifs username, if not specified as part of the root.
612 **cifspass**=__<password>__::
613     Set the cifs password, if not specified as part of the root.
615 WARNING: Passwords specified on the kernel command line are visible for all
616 users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
617 network, when using DHCP with DHCP root-path.
619 iSCSI
620 ~~~~~
621 **root=**iscsi:[__<username>__:__<password>__[:__<reverse>__:__<password>__]@][__<servername>__]:[__<protocol>__]:[__<port>__][:[__<iscsi_iface_name>__]:[__<netdev_name>__]]:[__<LUN>__]:__<targetname>__::
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].
630 WARNING: Passwords specified on the kernel command line are visible for all
631 users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
632 network, when using DHCP with DHCP root-path.
634 [listing]
635 .Example
637 root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
640 If servername is an IPv6 address, it has to be put in brackets:
642 [listing]
643 .Example
645 root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
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:
651 [listing]
652 .Example
654 root=UUID=12424547
655 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
656 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1
659 If servername is an IPv6 address, it has to be put in brackets:
661 [listing]
662 .Example
664 netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
667 WARNING: Passwords specified on the kernel command line are visible for all
668 users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
669 network, when using DHCP with DHCP root-path.
670 You may want to use rd.iscsi.firmware.
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>__::
673     manually specify all iscsistart parameter (see **+iscsistart --help+**)
675 WARNING: Passwords specified on the kernel command line are visible for all
676 users via the file _/proc/cmdline_ and via dmesg or can be sniffed on the
677 network, when using DHCP with DHCP root-path.
678 You may want to use rd.iscsi.firmware.
680 **root=**_???_ **netroot=**iscsi **rd.iscsi.firmware=1**::
681  will read the iscsi parameter from the BIOS firmware
683 **rd.iscsi.param=**__<param>__::
684     <param> will be passed as "--param <param>" to iscsistart.
685     This parameter can be specified multiple times.
687 [listing]
688 .Example
690 "netroot=iscsi rd.iscsi.firmware=1 rd.iscsi.param=node.session.timeo.replacement_timeout=30"
693 will result in
695 [listing]
697 iscsistart -b --param node.session.timeo.replacement_timeout=30
700 **rd.iscsi.ibft** **rd.iscsi.ibft=1**:
701     Turn on iBFT autoconfiguration for the interfaces
703 FCoE
704 ~~~~
705 **fcoe=**__<edd|interface|MAC>__:__{dcb|nodcb}__::
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
708     supported. This parameter can be specified multiple times.
710 NOTE: letters in the MAC-address must be lowercase!
714 **root=**??? **netroot=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
715     mount nbd share from <server>
717 **root=dhcp** with **dhcp** **root-path=**nbd:__<server>__:__<port>__[:__<fstype>__[:__<mountopts>__[:__<nbdopts>__]]]::
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.
722 DASD
723 ~~~~
724 **rd.dasd=**....::
725     same syntax as the kernel module parameter (s390 only)
727 ZFCP
728 ~~~~
729 **rd.zfcp=**__<zfcp adaptor device bus ID>__,__<WWPN>__,__<FCPLUN>__::
730     rd.zfcp can be specified multiple times on the kernel command line.
732 [listing]
733 .Example
735 rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
738 **rd.zfcp.conf=0**::
739     ignore zfcp.conf included in the initramfs
741 ZNET
742 ~~~~
743 **rd.znet=**__<nettype>__,__<subchannels>__,__<options>__::
744     rd.znet can be specified multiple times on the kernel command line.
746 [listing]
747 .Example
749 rd.znet=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo
750 rd.znet=ctc,0.0.0600,0.0.0601,protocol=bar
753 Booting live images
754 ~~~~~~~~~~~~~~~~~~~
755 Dracut offers multiple options for live booted images:
757 =====================
758 squashfs with read-only filesystem image::: The system will boot with a read
759 only filesystem from the squashfs and apply a writable device mapper snapshot
760 over the read only filesystem.  Using this method ensures a relatively fast
761 boot and lower RAM usage. Users **must be careful** to avoid writing too many
762 blocks to the snapshot volume.  Once the blocks of the snapshot are exhaused,
763 the live filesystem becomes unusable and requires a reboot.
765 The filesystem structure is expected to be:
767 [listing]
769 squashfs.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             ...       |
780 Dracut uses this method of live booting by default.  No additional command line
781 options are required other than **root=live:<URL>** to specify the location
782 of your squashed filesystem.
784 writable filesystem image::: The system will retrieve a compressed filesystem
785 image, connect it to a loopback device, and mount it as a writable volume.  More
786 RAM is required during boot but the live filesystem is easier to manage if it
787 becomes full.  Users can make a filesystem image of any size and that size will
788 be maintained when the system boots.
790 The filesystem structure is expected to be:
792 [listing]
794 rootfs.tgz            |  Compressed tarball containing fileystem image
795    !(unpack)
796    /rootfs.img        |  Filesystem image
797       !(mount)
798       /bin            |  Live filesystem
799       /boot           |
800       /dev            |
801       ...             |
804 To use this boot option, ensure that **rd.writable_fsimg=1** is in your kernel
805 command line and add the **root=live:<URL>** to specify the location
806 of your compressed filesystem image tarball.
807 =====================
809 **root=**live:__<url>__::
810 Boots a live image retrieved from __<url>__.  Valid handlers: __http, https, ftp, torrent, tftp__.
812 [listing]
813 .Example
815 root=live:http://example.com/liveboot.img
816 root=live:ftp://ftp.example.com/liveboot.img
817 root=live:torrent://example.com/liveboot.img.torrent
820 **rd.live.debug=**1::
821 Enables debug output from the live boot process.
823 **rd.live.dir=**__<path>__::
824 Specifies the directory within the squashfs where the ext3fs.img or rootfs.img
825 can be found.  By default, this is __LiveOS__.
827 **rd.writable.fsimg=**1::
828 Enables writable filesystem support.  The system will boot with a fully 
829 writable filesystem without snapshots __(see notes above about available live boot options)__.
830 You can use the **rootflags** option to set mount options for the live
831 filesystem as well __(see documentation about rootflags in the **Standard** section above)__.
834 Plymouth Boot Splash
835 ~~~~~~~~~~~~~~~~~~~~
836 **plymouth.enable=0**::
837     disable the plymouth bootsplash completely.
839 **rd.plymouth=0**::
840     disable the plymouth bootsplash only for the initramfs.
842 Kernel keys
843 ~~~~~~~~~~~
844 **masterkey=**__<kernel master key path name>__::
845     Set the path name of the kernel master key.
847 [listing]
848 .Example
850 masterkey=/etc/keys/kmk-trusted.blob
853 **masterkeytype=**__<kernel master key type>__::
854     Set the type of the kernel master key.
856 [listing]
857 .Example
859 masterkeytype=trusted
862 **evmkey=**__<EVM key path name>__::
863     Set the path name of the EVM key.
865 [listing]
866 .Example
868 evmkey=/etc/keys/evm-trusted.blob
871 **ecryptfskey=**__<eCryptfs key path name>__::
872     Set the path name of the eCryptfs key.
874 [listing]
875 .Example
877 ecryptfskey=/etc/keys/ecryptfs-trusted.blob
880 Deprecated, renamed Options
881 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
882 Here is a list of options, which were used in dracut prior to version 008, and
883 their new replacement.
885 rdbreak:: rd.break
887 rd_CCW:: rd.ccw
889 rd_DASD_MOD:: rd.dasd
891 rd_DASD:: rd.dasd
893 rdinitdebug rdnetdebug:: rd.debug
895 rd_NO_DM:: rd.dm=0
897 rd_DM_UUID:: rd.dm.uuid
899 rdblacklist:: rd.driver.blacklist
901 rdinsmodpost:: rd.driver.post
903 rdloaddriver:: rd.driver.pre
905 rd_NO_FSTAB:: rd.fstab=0
907 rdinfo:: rd.info
909 check:: rd.live.check
911 rdlivedebug:: rd.live.debug
913 live_dir:: rd.live.dir
915 liveimg:: rd.live.image
917 overlay:: rd.live.overlay
919 readonly_overlay:: rd.live.overlay.readonly
921 reset_overlay:: rd.live.overlay.reset
923 live_ram:: rd.live.ram
925 rd_NO_CRYPTTAB:: rd.luks.crypttab=0
927 rd_LUKS_KEYDEV_UUID:: rd.luks.keydev.uuid
929 rd_LUKS_KEYPATH:: rd.luks.keypath
931 rd_NO_LUKS:: rd.luks=0
933 rd_LUKS_UUID:: rd.luks.uuid
935 rd_NO_LVMCONF:: rd.lvm.conf
937 rd_LVM_LV:: rd.lvm.lv
939 rd_NO_LVM:: rd.lvm=0
941 rd_LVM_SNAPSHOT:: rd.lvm.snapshot
943 rd_LVM_SNAPSIZE:: rd.lvm.snapsize
945 rd_LVM_VG:: rd.lvm.vg
947 rd_NO_MDADMCONF:: rd.md.conf=0
949 rd_NO_MDIMSM:: rd.md.imsm=0
951 rd_NO_MD:: rd.md=0
953 rd_MD_UUID:: rd.md.uuid
955 rd_NFS_DOMAIN:: rd.nfs.domain
957 iscsi_initiator:: rd.iscsi.initiator
959 iscsi_target_name:: rd.iscsi.target.name
961 iscsi_target_ip:: rd.iscsi.target.ip
963 iscsi_target_port:: rd.iscsi.target.port
965 iscsi_target_group:: rd.iscsi.target.group
967 iscsi_username:: rd.iscsi.username
969 iscsi_password:: rd.iscsi.password
971 iscsi_in_username:: rd.iscsi.in.username
973 iscsi_in_password:: rd.iscsi.in.password
975 iscsi_firmware:: rd.iscsi.firmware=0
977 rd_NO_PLYMOUTH:: rd.plymouth=0
979 rd_retry:: rd.retry
981 rdshell:: rd.shell
983 rd_NO_SPLASH:: rd.splash
985 rdudevdebug:: rd.udev.debug
987 rdudevinfo:: rd.udev.info
989 rd_NO_ZFCPCONF:: rd.zfcp.conf=0
991 rd_ZFCP:: rd.zfcp
993 rd_ZNET:: rd.znet
995 KEYMAP:: vconsole.keymap
997 KEYTABLE:: vconsole.keymap
999 SYSFONT:: vconsole.font
1001 CONTRANS:: vconsole.font.map
1003 UNIMAP:: vconsole.font.unimap
1005 UNICODE:: vconsole.unicode
1007 EXT_KEYMAP:: vconsole.keymap.ext
1009 Configuration 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.
1016 _/etc/cmdline_::
1017     Can contain additional command line options. Deprecated, better use
1018     /etc/cmdline.d/*.conf.
1020 _/etc/cmdline.d/*.conf_::
1021     Can contain additional command line options.
1023 AUTHOR
1024 ------
1025 Harald Hoyer
1027 SEE ALSO
1028 --------
1029 *dracut*(8) *dracut.conf*(5)