Dracut/Options

From FedoraProject

< Dracut(Difference between revisions)
Jump to: navigation, search
(iSCSI)
(23 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
<!--{{header|dracut}}-->
 
<!--{{header|dracut}}-->
  
= Options =  
+
{{admon/warning|This wiki can be incomplete. Please use the dracut.cmdline.7 (alias dracut.kernel.7) man page or point your browser at /usr/share/doc/dracut-*/dracut.html}}
 +
 
 +
=Dracut=
 +
 
 +
Creates  an  initial  image used by the kernel for preloading the block device modules (such as IDE, SCSI or RAID) which are needed to access the root filesystem.
 +
 
 
'''SYNOPSIS'''
 
'''SYNOPSIS'''
 
<pre>dracut [OPTION]... <image>  <kernel-version></pre>
 
<pre>dracut [OPTION]... <image>  <kernel-version></pre>
Line 128: Line 133:
  
 
== DHCP ==
 
== DHCP ==
 
+
{{admon/warning| You need to install dracut-network for this module.}}
 
<pre>root=dhcp</pre>
 
<pre>root=dhcp</pre>
 
{{admon/note|Get IP from dhcp server, root-path option from dhcp specifies root location.}}
 
{{admon/note|Get IP from dhcp server, root-path option from dhcp specifies root location.}}
  
 
== NFS ==
 
== NFS ==
 
+
{{admon/warning| You need to install "dracut-network" for this module.}}
 
<pre>root=[<server-ip>:]<root-dir>[:<nfs-options>]</pre>
 
<pre>root=[<server-ip>:]<root-dir>[:<nfs-options>]</pre>
 
<pre>root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>]</pre>
 
<pre>root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>]</pre>
Line 146: Line 151:
 
{{admon/warning| Deprecated! Kernel Documentation/filesystems/nfsroot.txt defines this method. This is supported by dracut but not recommended.}}
 
{{admon/warning| Deprecated! Kernel Documentation/filesystems/nfsroot.txt defines this method. This is supported by dracut but not recommended.}}
  
== iSCSI ==
+
{{admon/note|/etc/idmapd.conf is copied to the initramfs.}}
  
 +
== iSCSI ==
 +
{{admon/warning| You need to install dracut-network for this module.}}
 
<pre>root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>::</pre>
 
<pre>root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>::</pre>
 
{{admon/note|Protocol defaults to "6", LUN defaults to "0". If the "servername" field is provided by BOOTP or DHCP, then that field is used in conjunction with other associated fields to contact the boot server in the Boot stage (Section 7).  However, if the "servername" field is not provided, then the "targetname" field is then used in the Discovery Service stage in conjunction with other associated fields.[http://tools.ietf.org/html/rfc4173 RFC4173]}}
 
{{admon/note|Protocol defaults to "6", LUN defaults to "0". If the "servername" field is provided by BOOTP or DHCP, then that field is used in conjunction with other associated fields to contact the boot server in the Boot stage (Section 7).  However, if the "servername" field is not provided, then the "targetname" field is then used in the Discovery Service stage in conjunction with other associated fields.[http://tools.ietf.org/html/rfc4173 RFC4173]}}
 
<pre>root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname></pre>
 
<pre>root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname></pre>
{{admon/note|E.g. '''root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0'''}}
+
{{admon/note|'''E.g. root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0'''}}
 
<pre>root=??? netroot=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ...</pre>
 
<pre>root=??? netroot=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ...</pre>
{{admon/note|Multiple netroot options allow setting up multiple iscsi disks e.g. '''root=UUID=12424547 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0  netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1''' not yet implemented.}}
+
{{admon/note|Multiple netroot options allow setting up multiple iscsi disks e.g. '''root=UUID=12424547 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0  netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1 not yet implemented.'''}}
 
<pre>root=??? iscsi_initiator= iscsi_target_name= iscsi_target_ip= iscsi_target_port= iscsi_target_group= iscsi_username= iscsi_password= iscsi_in_username= iscsi_in_password=::</pre>
 
<pre>root=??? iscsi_initiator= iscsi_target_name= iscsi_target_ip= iscsi_target_port= iscsi_target_group= iscsi_username= iscsi_password= iscsi_in_username= iscsi_in_password=::</pre>
 
<pre>root=??? iscsi_firmware::</pre>
 
<pre>root=??? iscsi_firmware::</pre>
  
 
== NBD ==
 
== NBD ==
 
+
{{admon/warning| You need to install dracut-network for this module.}}
 
<pre>root=nbd:<server>:<port>[:<fstype>][:<mountopts>]</pre>
 
<pre>root=nbd:<server>:<port>[:<fstype>][:<mountopts>]</pre>
 
{{admon/note|Mount nbd share from <server>.}}
 
{{admon/note|Mount nbd share from <server>.}}
Line 166: Line 173:
  
 
== Network ==
 
== Network ==
 +
{{admon/warning| You need to install dracut-network for this module.}}
  
 
<pre>ip=[dhcp|on|any]</pre>
 
<pre>ip=[dhcp|on|any]</pre>
 
{{admon/note|2='''Get ip from dhcp server from all interfaces.If root=dhcp, loop sequentially through all interfaces '(eth0, eth1, ...)' and use the first with a valid DHCP root-path.'''}}  
 
{{admon/note|2='''Get ip from dhcp server from all interfaces.If root=dhcp, loop sequentially through all interfaces '(eth0, eth1, ...)' and use the first with a valid DHCP root-path.'''}}  
<pre>ip=<interface>:[dhcp|on|any]</pre>
+
 
 +
<pre>ip=<interface>:[dhcp|on|any|none|off]</pre>
 
{{admon/note|Get ip from dhcp server on a specific interface.}}
 
{{admon/note|Get ip from dhcp server on a specific interface.}}
<pre>ip=<client-IP-number>:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:[dhcp|on|any|]</pre>
+
 
{{admon/note|Explicit network configuration }}
+
<pre>ip=<client-IP-number>:[<server-id>]:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:{dhcp|dhcp6|auto6|on|any|none|off}</pre>
 +
{{admon/note|Explicit network configuration.}}
 +
* none,off mean static network configuration
 +
* dhcp,on,any mean DHCP IPv4 configuration
 +
* dchp6 - DHCP IPv6 configuration
 +
* auto6 - automatic IPv6 configuration
 +
 
 +
<pre>nameserver=srv1 [nameserver=srv2 [nameserver=srv3 [...]]]</pre>
 +
{{admon/note|2='''Explicit nameserver configuration'''}}
  
 
== Misc ==
 
== Misc ==
Line 181: Line 198:
 
== Debug ==
 
== Debug ==
  
<pre>rdinitdebug</pre>
+
<pre>rdshell</pre>
{{admon/note|Drop to a shell, if the imitramfs fails.}}
+
{{admon/note|Drop to a shell, if the initramfs fails.}}
 
<pre>rdinitdebug</pre>
 
<pre>rdinitdebug</pre>
 
{{admon/note|set -x for the dracut shell.}}
 
{{admon/note|set -x for the dracut shell.}}
Line 196: Line 213:
 
== Configuration in initrd ==
 
== Configuration in initrd ==
  
<pre>/conf/conf.d/* </pre>
+
<pre>/etc/conf.d/* </pre>
 
{{admon/note|Command line options can override values set here}}
 
{{admon/note|Command line options can override values set here}}
 +
 +
=Dracut-catimages=
 +
 +
Creates initial ramdisk image by concatenating several images from the command line and /boot/dracut/
 +
 +
'''SYNOPSIS'''
 +
<pre>dracut-catimages [OPTION]... <initramfs> <base image> [<image>...]</pre>
 +
 +
==-f, --force==
 +
<pre>-f, --force</pre>
 +
{{admon/note|Overwrite existing initramfs file.}}
 +
==-i, --imagedir==
 +
<pre>-i, --imagedir</pre>
 +
{{admon/note|Directory with additional images to add (default: /boot/dracut/).}}
 +
==-o, --overlaydir==
 +
<pre>-o, --overlaydir</pre>
 +
{{admon/note|Overlay directory, which contains files that will be used to create an additional image.}}
 +
==--nooverlay==
 +
<pre>--nooverlay</pre>
 +
{{admon/note|Do not use the overlay directory.}}
 +
 +
==--noimagedir==
 +
<pre>--noimagedir</pre>
 +
{{admon/note|Do not use the additional image directory.}}
 +
==-h, --help==
 +
<pre>-h, --help</pre>
 +
{{admon/note|Print help text and exit.}}
 +
 +
==--debug==
 +
<pre>--debug</pre>
 +
{{admon/note|Output debug information of the build process.}}
 +
==-v, --verbose==
 +
<pre>-v, --verbose</pre>
 +
{{admon/note|Verbose output during the build process.}}
 +
 +
=Dracut-gencmdline=
 +
 +
Generate the kernel command line for the local host.
 +
 +
'''SYNOPSIS'''
 +
<pre>dracut-gencmdline</pre>

Revision as of 09:37, 24 July 2012


Warning (medium size).png
This wiki can be incomplete. Please use the dracut.cmdline.7 (alias dracut.kernel.7) man page or point your browser at /usr/share/doc/dracut-*/dracut.html

Contents

Dracut

Creates an initial image used by the kernel for preloading the block device modules (such as IDE, SCSI or RAID) which are needed to access the root filesystem.

SYNOPSIS

dracut [OPTION]... <image>  <kernel-version>

-f, --force

-f, --force
Note.png
Overwrite existing initramfs file.

-m, --modules

-m, --modules LIST
Note.png
Specify a space-separated list of dracut modules to call when building the initramfs. Modules are located in /usr/share/dracut/modules.d.

-o, --omit

-o, --omit LIST
Note.png
Omit a space-separated list of dracut modules.

-a, --add

-a, --add LIST
Note.png
Add a space-separated list of dracut modules.

-d, --drivers

-d, --drivers LIST
Note.png
Specify a space-separated list of kernel modules to include in the initramfs.

-k, --kmoddir

-k, --kmoddir {DIR}
Note.png
Specify the directory, where to look for kernel modules.

--fwdir

--fwdir {DIR}
Note.png
Specify additional directory, where to look for firmwares.

--kernel-only

--kernel-only
Note.png
Only install kernel drivers and firmware files.

--no-kernel

--no-kernel
Note.png
Do not install kernel drivers and firmware files.

--strip

--strip
Note.png
Strip binaries in the initramfs (default).

--nostrip

--nostrip
Note.png
No not strip binaries in the initramfs.

-h, --help

-h, --help
Note.png
Display help text and exit.

--debug

--debug
Note.png
Output debug information of the build process

-v, --verbose

v, --verbose
Note.png
Verbose output during the build process

-c, --conf

-c, --conf FILE
Note.png
Specify configuration file to use. Default: /etc/dracut.conf

-l, --local

-l, --local
Note.png
Local mode. Use modules from the current working directory instead of the system-wide installed in /usr/share/dracut/modules.d. Useful when running dracut from a git checkout.

-H, --hostonly

-H, --hostonly
Note.png
Host-Only mode: Install only what is needed for booting the local host instead of a generic host.

-i, --include

-i, --include SOURCE TARGET
Note.png
Include the files in the SOURCE directory into the target directory in the final initramfs.

-I, --install

-I, --install LIST
Note.png
Install the space separated list of files into the initramfs.

Dracut kernel command line parameters

The root filesystem used by the kernel is specified in the boot configuration file, as always. The traditional root=/dev/hda1 style device specification is allowed. If a label is used, as in root=LABEL=rootPart the initrd will search all available devices for an ext2 or ext3 filesystem with the appropriate label, and mount that device as the root filesystem. root=UUID=uuidnumber will mount the partition with that UUID as the root filesystem.

Limitations

  • Command line length: 2048
  • dhcp root-path: 255

Standard

init=<path to real init>
root=<path to blockdevice>
Note.png
Specify e.g. /dev/sda1 or /dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1

I18N

KEYBOARDTYPE=sun|pc
Note.png
Will be written to /etc/sysconfig/keyboard in the initramfs
KEYTABLE=<keytable filename>
Note.png
Will be written to /etc/sysconfig/keyboard in the initramfs
SYSFONT= Console font
Note.png
Will be written to /etc/sysconfig/i18n in the initramfs
SYSFONTACM= Unicode font map
Note.png
Will be written to /etc/sysconfig/i18n in the initramfs
UNIMAP= Unicode font map
Note.png
Will be written to /etc/sysconfig/i18n in the initramfs
LANG=<locale>
Note.png
Will be written to /etc/sysconfig/i18n in the initramfs

Bootsplash - plymouth

rd_plytheme=<theme name>
Note.png
Specify the plymouth bootsplash theme (fallback is text)

LVM

rd_NO_LVM
Note.png
Disable LVM detection
rd_LVM_VG=<volume group name>
Note.png
Only activate the volume groups with the given name

crypto LUKS

rd_NO_LUKS
Note.png
Disable crypto LUKS detection
rd_LUKS_UUID=<luks uuid>
Note.png
Only activate the LUKS partitions with the given UUID

MD

rd_NO_MD
Note.png
Disable MD RAID detection
rd_NO_MDIMSM
Note.png
No MD RAID for imsm/isw raids, use dmraid instead.
rd_MD_UUID=<md uuid>
Note.png
Only activate the raid sets with the given UUID

DMRAID

rd_NO_DM
Note.png
Disable DM RAID detection
rd_DM_UUID=<dmraid uuid>
Note.png
Only activate the raid sets with the given UUID

DASD

dasd=....
Note.png
Same syntax as the kernel module parameter (s390 only).

DHCP

Warning (medium size).png
You need to install dracut-network for this module.
root=dhcp
Note.png
Get IP from dhcp server, root-path option from dhcp specifies root location.

NFS

Warning (medium size).png
You need to install "dracut-network" for this module.
root=[<server-ip>:]<root-dir>[:<nfs-options>]
root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>]
root=nfs4:[<server-ip>:]<root-dir>[:<nfs-options>]
Note.png
Mount nfs share from <server-ip>:/<root-dir> If no server-ip is given use dhcp next_server. nfs-options can be appended with the prefix ":" or ","
root=dhcp root-path=<server-ip>:<root-dir>[,<nfs-options>]
root=dhcp root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
root=dhcp root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>]
Note.png
root=dhcp alone directs initrd to look at the DHCP root-path where NFS options can be specified.
root=/dev/nfs nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
Warning (medium size).png
Deprecated! Kernel Documentation/filesystems/nfsroot.txt defines this method. This is supported by dracut but not recommended.
Note.png
/etc/idmapd.conf is copied to the initramfs.

iSCSI

Warning (medium size).png
You need to install dracut-network for this module.
root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>::
Note.png
Protocol defaults to "6", LUN defaults to "0". If the "servername" field is provided by BOOTP or DHCP, then that field is used in conjunction with other associated fields to contact the boot server in the Boot stage (Section 7). However, if the "servername" field is not provided, then the "targetname" field is then used in the Discovery Service stage in conjunction with other associated fields.RFC4173
root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
Note.png
root=??? netroot=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ...
Note.png
root=??? iscsi_initiator= iscsi_target_name= iscsi_target_ip= iscsi_target_port= iscsi_target_group= iscsi_username= iscsi_password= iscsi_in_username= iscsi_in_password=::
root=??? iscsi_firmware::

NBD

Warning (medium size).png
You need to install dracut-network for this module.
root=nbd:<server>:<port>[:<fstype>][:<mountopts>]
Note.png
Mount nbd share from <server>.
root=dhcp
Note.png
root-path=nbd:<server>:<port>[:<fstype>][:<mountopts>]. root=dhcp alone directs initrd to look at the DHCP root-path where NBD options can be specified. This syntax is only usable in cases where you are directly mounting the volume as the rootfs.

Network

Warning (medium size).png
You need to install dracut-network for this module.
ip=[dhcp|on|any]
Note.png
Get ip from dhcp server from all interfaces.If root=dhcp, loop sequentially through all interfaces '(eth0, eth1, ...)' and use the first with a valid DHCP root-path.
ip=<interface>:[dhcp|on|any|none|off]
Note.png
Get ip from dhcp server on a specific interface.
ip=<client-IP-number>:[<server-id>]:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:{dhcp|dhcp6|auto6|on|any|none|off}
Note.png
Explicit network configuration.
  • none,off mean static network configuration
  • dhcp,on,any mean DHCP IPv4 configuration
  • dchp6 - DHCP IPv6 configuration
  • auto6 - automatic IPv6 configuration
nameserver=srv1 [nameserver=srv2 [nameserver=srv3 [...]]]
Note.png
Explicit nameserver configuration

Misc

rdblacklist=<modulename>
Note.png
TBD: do not load modulename.

Debug

rdshell
Note.png
Drop to a shell, if the initramfs fails.
rdinitdebug
Note.png
set -x for the dracut shell.
rdbreak=[pre-udev|pre-mount|mount|pre-pivot|]
Note.png
Drop the shell on defined breakpoint.
rdudevinfo
Note.png
Set udev to loglevel info.
rdudevdebug
Note.png
Set udev to loglevel debug.
rdnetdebug
Note.png
Debug network scripts in dracut.

Configuration in initrd

/etc/conf.d/* 
Note.png
Command line options can override values set here

Dracut-catimages

Creates initial ramdisk image by concatenating several images from the command line and /boot/dracut/

SYNOPSIS

dracut-catimages [OPTION]... <initramfs> <base image> [<image>...]

-f, --force

-f, --force
Note.png
Overwrite existing initramfs file.

-i, --imagedir

-i, --imagedir
Note.png
Directory with additional images to add (default: /boot/dracut/).

-o, --overlaydir

-o, --overlaydir
Note.png
Overlay directory, which contains files that will be used to create an additional image.

--nooverlay

--nooverlay
Note.png
Do not use the overlay directory.

--noimagedir

--noimagedir
Note.png
Do not use the additional image directory.

-h, --help

-h, --help
Note.png
Print help text and exit.

--debug

--debug
Note.png
Output debug information of the build process.

-v, --verbose

-v, --verbose
Note.png
Verbose output during the build process.

Dracut-gencmdline

Generate the kernel command line for the local host.

SYNOPSIS

dracut-gencmdline