]> git.ipfire.org Git - thirdparty/dracut.git/blob - dracut.cmdline.7.asc
add iscsi interface binding
[thirdparty/dracut.git] / dracut.cmdline.7.asc
1 DRACUT.CMDLINE(7)
2 =================
3 :doctype: manpage
4 :man source: dracut
5 :man manual: dracut
6
7 NAME
8 ----
9 dracut.cmdline - dracut kernel command line options
10
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.
15
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.
22
23 In the following all kernel command line parameters, which are processed by
24 dracut, are described.
25
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.
31
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
37
38 **root=**_<path to blockdevice>_::
39 specify the block device to use as the root filesystem.
40 +
41 E.g.:
42 +
43 ----
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 ----
51
52 **rootfstype=**_<filesystem type>_:: "auto" if not specified, e.g.:
53 +
54 ----
55 rootfstype=ext3
56 ----
57
58 **rootflags=**_<mount options>_::
59 specify additional mount options for the root filesystem. If not set,
60 _/etc/fstab_ of the real root will be parsed for special mount options and
61 mounted accordingly.
62
63 **rd.fstab=0**::
64 do not honor special mount options for the root filesystem found in
65 _/etc/fstab_ of the real root.
66
67 Misc
68 ~~~~
69 **rd.driver.blacklist=**_<drivername>[,<drivername>,...]_::
70 do not load kernel module <drivername>. This parameter can be specified
71 multiple times.
72
73 **rd.driver.pre=**_<drivername>[,<drivername>,...]_::
74 force loading kernel module <drivername>. This parameter can be specified
75 multiple times.
76
77 **rd.driver.post=**_<drivername>[,<drivername>,...]_::
78 force loading kernel module <drivername> after all automatic loading modules
79 have been loaded. This parameter can be specified multiple times.
80
81 [[dracutkerneldebug]]
82 Debug
83 ~~~~~
84 **rd.info**::
85 print informational output though "quiet" is set
86
87 **rd.shell**::
88 allow dropping to a shell, if root mounting fails
89
90 **rd.debug**::
91 set -x for the dracut shell and logs to dmesg, console and
92 _/run/initramfs/init.log_
93
94 **rd.break**::
95 drop to a shell at the end
96
97 **rd.break=**_{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot}_::
98 drop to a shell on defined breakpoint
99
100 **rd.udev.info**::
101 set udev to loglevel info
102
103 **rd.udev.debug**::
104 set udev to loglevel debug
105
106 I18N
107 ~~~~
108 **vconsole.keymap=**_<keymap base file name>_::
109 keyboard translation table loaded by loadkeys; taken from keymaps directory;
110 will be written as KEYMAP to _/etc/vconsole.conf_ in the initramfs, e.g.:
111 +
112 ----
113 vconsole.keymap=de-latin1-nodeadkeys
114 ----
115
116 **vconsole.keymap.ext=**_<list of keymap base file names>_::
117 list of extra keymaps to bo loaded (sep. by space); will be written as
118 EXT_KEYMAP to _/etc/vconsole.conf_ in the initramfs
119
120 **vconsole.unicode**[=_{0|1}_]::
121 boolean, indicating UTF-8 mode; will be written as UNICODE to
122 _/etc/vconsole.conf_ in the initramfs
123
124 **vconsole.font=**_<font base file name>_::
125 console font; taken from consolefonts directory; will be written as FONT to
126 _/etc/vconsole.conf_ in the initramfs; e.g.:
127 +
128 ----
129 vconsole.font=LatArCyrHeb-16
130 ----
131
132 **vconsole.font.map=**_<console map base file name>_::
133 see description of '-m' parameter in setfont manual; taken from consoletrans
134 directory; will be written as FONT_MAP to _/etc/vconsole.conf_ in the
135 initramfs
136
137 **vconsole.font.unimap=**_<unicode table base file name>_::
138 see description of '-u' parameter in setfont manual; taken from unimaps
139 directory; will be written as FONT_UNIMAP to _/etc/vconsole.conf_ in the
140 initramfs
141
142 **locale.LANG=**_<locale>_::
143 taken from the environment; if no UNICODE is defined we set its value in
144 basis of LANG value (whether it ends with ".utf8" (or similar) or not); will
145 be written as LANG to _/etc/locale.conf_ in the initramfs; e.g.:
146 +
147 ----
148 locale.LANG=pl_PL.utf8
149 ----
150
151 **locale.LC_ALL=**_<locale>_::
152 taken from the environment; will be written as LC_ALL to _/etc/locale.conf_
153 in the initramfs
154
155 LVM
156 ~~~
157 **rd.lvm=0**::
158 disable LVM detection
159
160 **rd.lvm.vg=**_<volume group name>_::
161 only activate the volume groups with the given name. rd.lvm.vg can be
162 specified multiple times on the kernel command line.
163
164 **rd.lvm.lv=**_<logical volume name>_::
165 only activate the logical volumes with the given name. rd.lvm.lv can be
166 specified multiple times on the kernel command line.
167
168 **rd.lvm.conf=0**::
169 remove any _/etc/lvm/lvm.conf_, which may exist in the initramfs
170
171 crypto LUKS
172 ~~~~~~~~~~~
173 **rd.luks=0**::
174 disable crypto LUKS detection
175
176 **rd.luks.uuid=**_<luks uuid>_::
177 only activate the LUKS partitions with the given UUID. Any "luks-" of the
178 LUKS UUID is removed before comparing to _<luks uuid>_.
179 The comparisons also matches, if _<luks uuid>_ is only the beginning of the
180 LUKS UUID, so you don't have to specify the full UUID.
181 This parameter can be specified multiple times.
182
183 **rd.luks.crypttab=0**::
184 do not check, if LUKS partition is in _/etc/crypttab_
185
186 crypto LUKS - key on removable device support
187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188 **rd.luks.key=**_<keypath>:<keydev>:<luksdev>_::
189 _keypath_ is a path to key file to look for. It's REQUIRED. When _keypath_ ends with '.gpg' it's considered to be key encrypted symmetrically with GPG. You will be prompted for password on boot. GPG support comes with 'crypt-gpg' module which needs to be added explicitly.
190 +
191 _keydev_ is a device on which key file resides. It might be kernel name of devices (should start with "/dev/"), UUID (prefixed with "UUID=") or label (prefix with "LABEL="). You don't have to specify full UUID. Just its beginning will suffice, even if its ambiguous. All matching devices will be probed. This parameter is recommended, but not required. If not present, all block devices will be probed, which may significantly increase boot time.
192 +
193 If _luksdev_ is given, the specified key will only be applied for that LUKS device. Possible values are the same as for _keydev_. Unless you have several LUKS devices, you don't have to specify this parameter. The simplest usage is:
194 +
195 ----
196 rd.luks.key=/foo/bar.key
197 ----
198 +
199 As you see, you can skip colons in such a case.
200
201 MD RAID
202 ~~~~~~~
203 **rd.md=0**::
204 disable MD RAID detection
205
206 **rd.md.imsm=0**::
207 disable MD RAID for imsm/isw raids, use DM RAID instead
208
209 **rd.md.ddf=0**::
210 disable MD RAID for SNIA ddf raids, use DM RAID instead
211
212 **rd.md.conf=0**::
213 ignore mdadm.conf included in initramfs
214
215 **rd.md.waitclean=1**::
216 wait for any resync, recovery, or reshape activity to finish before continuing
217
218 **rd.md.uuid=**_<md raid uuid>_::
219 only activate the raid sets with the given UUID. This parameter can be
220 specified multiple times.
221
222 DM RAID
223 ~~~~~~~
224 **rd.dm=0**::
225 disable DM RAID detection
226
227 **rd.dm.uuid=**_<dm raid uuid>_::
228 only activate the raid sets with the given UUID. This parameter can be
229 specified multiple times.
230
231 FIPS
232 ~~~~
233 **rd.fips**::
234 enable FIPS
235
236 **boot=**_<boot device>_::
237 specify the device, where /boot is located. e.g.
238 +
239 ----
240 boot=/dev/sda1
241 boot=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
242 boot=UUID=<uuid>
243 boot=LABEL=<label>
244 ----
245
246 **rd.fips.skipkernel**::
247 skip checksum check of the kernel image. Useful, if the kernel image is not
248 in a separate boot partition.
249
250 Network
251 ~~~~~~~
252 **ip=**_{dhcp|on|any|dhcp6|auto6|ibft}_::
253 dhcp|on|any::: get ip from dhcp server from all interfaces. If root=dhcp, loop
254 sequentially through all interfaces (eth0, eth1, ...) and use the first with
255 a valid DHCP root-path.
256
257 auto6::: IPv6 autoconfiguration
258
259 dhcp6::: IPv6 DHCP
260
261 ibft::: iBFT autoconfiguration
262
263 **ip=**_<interface>_:_{dhcp|on|any|dhcp6|auto6}_::
264 This parameter can be specified multiple times.
265 +
266 dhcp|on|any|dhcp6::: get ip from dhcp server on a specific interface
267 auto6::: do IPv6 autoconfiguration
268
269 **ip=**_<client-IP>_:_<server-IP>_:_<gateway-IP>_:_<netmask>_:_<client_hostname>_:_<interface>_:_{none|off}_::
270 explicit network configuration. If you want do define a IPv6 address, put it
271 in brackets (e.g. [2001:DB8::1]). This parameter can be specified multiple
272 times.
273
274 **ifname=**_<interface>_:_<MAC>_::
275 Assign network device name <interface> (ie eth0) to the NIC with MAC <MAC>.
276 Note: If you use this option you _must_ specify an ifname= argument for all
277 interfaces used in ip= or fcoe= arguments. This parameter can be specified
278 multiple times.
279
280 **bootdev=**_<interface>_::
281 specify network interface to use routing and netroot information from.
282 Required if multiple ip= lines are used.
283
284 **nameserver=**__<IP>__ [**nameserver=**__<IP>__ ...]::
285 specify nameserver(s) to use
286
287 **biosdevname=0**::
288 boolean, turn off biosdevname network interface renaming
289
290 **rd.neednet=1**::
291 boolean, bring up network even without netroot set
292
293 NFS
294 ~~~
295 **root=**[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_]::
296 mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given, use
297 dhcp next_server. if server-ip is an IPv6 address it has to be put in
298 brackets, e.g. [2001:DB8::1]. NFS options can be appended with the prefix
299 ":" or "," and are seperated by ",".
300
301 **root=**nfs:[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_], **root=**nfs4:[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_], **root=**_{dhcp|dhcp6}_::
302 root=dhcp alone directs initrd to look at the DHCP root-path where NFS
303 options can be specified.
304 +
305 ----
306 root-path=<server-ip>:<root-dir>[,<nfs-options>]
307 root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
308 root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>]
309 ----
310
311 **root=**_/dev/nfs_ nfsroot=[_<server-ip>_:]_<root-dir>_[:_<nfs-options>_]::
312 _Deprecated!_ kernel Documentation_/filesystems/nfsroot.txt_ defines this
313 method. This is supported by dracut, but not recommended.
314
315 **rd.nfs.domain=**_<NFSv4 domain name>_::
316 Set the NFSv4 domain name. Will overwrite the settings in _/etc/idmap.conf_.
317
318 iSCSI
319 ~~~~~
320 **root=**iscsi:[_<username>_:_<password>_[:_<reverse>_:_<password>_]@][_<servername>_]:[_<protocol>_]:[_<port>_][:[_<iscsi_iface_name>_]:[_<netdev_name>_]]:[_<LUN>_]:_<targetname>_::
321 protocol defaults to "6", LUN defaults to "0". If the "servername" field is
322 provided by BOOTP or DHCP, then that field is used in conjunction with other
323 associated fields to contact the boot server in the Boot stage. However, if
324 the "servername" field is not provided, then the "targetname" field is then
325 used in the Discovery Service stage in conjunction with other associated
326 fields. See
327 link:$$http://tools.ietf.org/html/rfc4173#section-5$$[rfc4173].
328 e.g.:
329 +
330 ----
331 root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
332 ----
333 +
334 If servername is an IPv6 address, it has to be put in brackets. e.g.:
335 +
336 ----
337 root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
338 ----
339
340 **root=**_???_ **netroot=**iscsi:[_<username>_:_<password>_[:_<reverse>_:_<password>_]@][_<servername>_]:[_<protocol>_]:[_<port>_][:[_<iscsi_iface_name>_]:[_<netdev_name>_]]:[_<LUN>_]:_<targetname>_ ...::
341 multiple netroot options allow setting up multiple iscsi disks. e.g.:
342 +
343 ----
344 root=UUID=12424547
345 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
346 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1
347 ----
348 +
349 If servername is an IPv6 address, it has to be put in brackets. e.g.:
350 +
351 ----
352 netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0
353 ----
354
355 **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>_::
356 manually specify all iscsistart parameter (see **+iscsistartĀ --help+**)
357
358 **root=**_???_ **netroot=**iscsi **rd.iscsi.firmware=1**::
359 will read the iscsi parameter from the BIOS firmware
360
361 FCoE
362 ~~~~
363 **fcoe=**_<edd|interface|MAC>_:_{dcb|nodcb}_::
364 Try to connect to a FCoE SAN through the NIC specified by _<interface>_ or
365 _<MAC>_ or EDD settings. For the second argument, currently only nodcb is
366 supported. This parameter can be specified multiple times. Note: letters in
367 the MAC-address must be lowercase!
368
369 NBD
370 ~~~
371 **root=**??? **netroot=**nbd:_<server>_:_<port>_[:_<fstype>_[:_<mountopts>_[:_<nbdopts>_]]]::
372 mount nbd share from <server>
373
374 **root=dhcp** with **dhcp** **root-path=**nbd:_<server>_:_<port>_[:_<fstype>_[:_<mountopts>_[:_<nbdopts>_]]]::
375 root=dhcp alone directs initrd to look at the DHCP root-path where NBD
376 options can be specified. This syntax is only usable in cases where you are
377 directly mounting the volume as the rootfs.
378
379 DASD
380 ~~~~
381 **rd.dasd_mod.dasd=**....::
382 same syntax as the kernel module parameter (s390 only)
383
384 **rd.dasd=**_<dasd_adaptor device bus ID>_[,readonly=_X_][,use_diag=_X_][,erplog=_X_]::
385 activate DASD device with the given adaptor device bus ID and setting the
386 sysfs attributes to the specified values. This parameter can be specified
387 multiple times.
388
389 ZFCP
390 ~~~~
391 **rd.zfcp=**_<zfcp adaptor device bus ID>_,_<WWPN>_,_<FCPLUN>_::
392 rd.zfcp can be specified multiple times on the kernel command line. e.g.:
393 +
394 ----
395 rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
396 ----
397
398 **rd.zfcp.conf=0**::
399 ignore zfcp.conf included in the initramfs
400
401 ZNET
402 ~~~~
403 **rd.znet=**_<nettype>_,_<subchannels>_,_<options>_::
404 rd.znet can be specified multiple times on the kernel command line. e.g.:
405 +
406 ----
407 rd.znet=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo
408 rd.znet=ctc,0.0.0600,0.0.0601,0.0.0602,protocol=bar
409 ----
410
411 Plymouth Boot Splash
412 ~~~~~~~~~~~~~~~~~~~~
413 **plymouth.enable=0**::
414 disable the plymouth bootsplash completly.
415
416 **rd.plymouth=0**::
417 disable the plymouth bootsplash only for the initramfs.
418
419 Kernel keys
420 ~~~~~~~~~~~
421 **masterkey=**_<kernel master key path name>_::
422 Set the path name of the kernel master key. e.g.:
423 +
424 ----
425 masterkey=/etc/keys/kmk-trusted.blob
426 ----
427
428 **masterkeytype=**_<kernel master key type>_::
429 Set the type of the kernel master key. e.g.:
430 +
431 ----
432 masterkeytype=trusted
433 ----
434
435 **evmkey=**_<EVM key path name>_::
436 Set the path name of the EVM key. e.g.:
437 +
438 ----
439 evmkey=/etc/keys/evm-trusted.blob
440 ----
441
442 **ecryptfskey=**_<eCryptfs key path name>_::
443 Set the path name of the eCryptfs key. e.g.:
444 +
445 ----
446 ecryptfskey=/etc/keys/ecryptfs-trusted.blob
447 ----
448
449 Deprecated, renamed Options
450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
451 Here is a list of options, which were used in dracut prior to version 008, and their new replacement.
452
453 rdbreak:: rd.break
454
455 rd_CCW:: rd.ccw
456
457 rd_DASD_MOD:: rd.dasd_mod.dasd
458
459 rd_DASD:: rd.dasd
460
461 rdinitdebug rdnetdebug:: rd.debug
462
463 rd_NO_DM:: rd.dm=0
464
465 rd_DM_UUID:: rd.dm.uuid
466
467 rdblacklist:: rd.driver.blacklist
468
469 rdinsmodpost:: rd.driver.post
470
471 rdloaddriver:: rd.driver.pre
472
473 rd_NO_FSTAB:: rd.fstab=0
474
475 rdinfo:: rd.info
476
477 check:: rd.live.check
478
479 rdlivedebug:: rd.live.debug
480
481 live_dir:: rd.live.dir
482
483 liveimg:: rd.live.image
484
485 overlay:: rd.live.overlay
486
487 readonly_overlay:: rd.live.overlay.readonly
488
489 reset_overlay:: rd.live.overlay.reset
490
491 live_ram:: rd.live.ram
492
493 rd_NO_CRYPTTAB:: rd.luks.crypttab=0
494
495 rd_LUKS_KEYDEV_UUID:: rd.luks.keydev.uuid
496
497 rd_LUKS_KEYPATH:: rd.luks.keypath
498
499 rd_NO_LUKS:: rd.luks=0
500
501 rd_LUKS_UUID:: rd.luks.uuid
502
503 rd_NO_LVMCONF:: rd.lvm.conf
504
505 rd_LVM_LV:: rd.lvm.lv
506
507 rd_NO_LVM:: rd.lvm=0
508
509 rd_LVM_SNAPSHOT:: rd.lvm.snapshot
510
511 rd_LVM_SNAPSIZE:: rd.lvm.snapsize
512
513 rd_LVM_VG:: rd.lvm.vg
514
515 rd_NO_MDADMCONF:: rd.md.conf=0
516
517 rd_NO_MDIMSM:: rd.md.imsm=0
518
519 rd_NO_MD:: rd.md=0
520
521 rd_MD_UUID:: rd.md.uuid
522
523 rd_NFS_DOMAIN:: rd.nfs.domain
524
525 iscsi_initiator:: rd.iscsi.initiator
526
527 iscsi_target_name:: rd.iscsi.target.name
528
529 iscsi_target_ip:: rd.iscsi.target.ip
530
531 iscsi_target_port:: rd.iscsi.target.port
532
533 iscsi_target_group:: rd.iscsi.target.group
534
535 iscsi_username:: rd.iscsi.username
536
537 iscsi_password:: rd.iscsi.password
538
539 iscsi_in_username:: rd.iscsi.in.username
540
541 iscsi_in_password:: rd.iscsi.in.password
542
543 iscsi_firmware:: rd.iscsi.firmware=0
544
545 rd_NO_PLYMOUTH:: rd.plymouth=0
546
547 rd_retry:: rd.retry
548
549 rdshell:: rd.shell
550
551 rd_NO_SPLASH:: rd.splash
552
553 rdudevdebug:: rd.udev.debug
554
555 rdudevinfo:: rd.udev.info
556
557 rd_NO_ZFCPCONF:: rd.zfcp.conf=0
558
559 rd_ZFCP:: rd.zfcp
560
561 rd_ZNET:: rd.znet
562
563 KEYMAP:: vconsole.keymap
564
565 KEYTABLE:: vconsole.keymap
566
567 SYSFONT:: vconsole.font
568
569 CONTRANS:: vconsole.font.map
570
571 UNIMAP:: vconsole.font.unimap
572
573 UNICODE:: vconsole.unicode
574
575 EXT_KEYMAP:: vconsole.keymap.ext
576
577 Configuration in the Initramfs
578 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
579 _/etc/conf.d/_::
580 Any files found in _/etc/conf.d/_ will be sourced in the initramfs to
581 set initial values. Command line options will override these values
582 set in the configuration files.
583
584 _/etc/cmdline_::
585 Can contain additional command line options.
586
587 _/etc/cmdline.d/*.conf_::
588 Can contain additional command line options.
589
590 AUTHOR
591 ------
592 *Harald Hoyer*::
593 Project Leader and Developer
594
595 SEE ALSO
596 --------
597 *dracut*(8) *dracut.conf*(5)