Authors:
Chris Lumens clumens@redhat.com and other members of the Anaconda installer team
Contents
Kickstart Documentation
Chapter 1. Introduction
What are Kickstart Installations?
How Do You Perform a Kickstart Installation?
Creating the Kickstart File
Special Notes for Referring to Disks
Chapter 2. Kickstart Commands in Fedora
auth or authconfig
authselect
autopart
autostep
bootc
bootloader
btrfs
cdrom
clearpart
graphical or text or cmdline
device
deviceprobe
dmraid
driverdisk
eula
fcoe
firewall
firstboot
group
reboot or poweroff or shutdown or halt
harddrive
hmc
ignoredisk
install
interactive
iscsi
iscsiname
keyboard
lang
langsupport
lilo
lilocheck
liveimg
logging
logvol
mediacheck
method
module
monitor
mount
mouse
multipath
network
nfs
nvdimm
ostreecontainer
ostreesetup
part or partition
raid
rdp
realm join
repo
reqpart
rescue
rootpw
selinux
services
skipx
snapshot
sshkey
sshpw
timesource
timezone
updates
install or upgrade
url
user
vnc
volgroup
xconfig
zerombr
zfcp
zipl
%include
%ksappend
Chapter 3. Kickstart Commands in Red Hat Enterprise Linux
auth or authconfig
authselect
autopart
autostep
bootloader
btrfs
cdrom
clearpart
graphical or text or cmdline
device
deviceprobe
dmraid
driverdisk
eula
fcoe
firewall
firstboot
group
reboot or poweroff or shutdown or halt
harddrive
hmc
ignoredisk
install
interactive
iscsi
iscsiname
key
keyboard
lang
langsupport
lilo
lilocheck
liveimg
logging
logvol
mediacheck
method
module
monitor
mount
mouse
multipath
network
nfs
nvdimm
ostreecontainer
ostreesetup
part or partition
raid
realm join
repo
reqpart
rescue
rhsm
rootpw
selinux
services
skipx
snapshot
sshkey
sshpw
syspurpose
timesource
timezone
unsupported_hardware
updates
install or upgrade
url
user
vnc
volgroup
xconfig
zerombr
zfcp
zipl
%include
%ksappend
Chapter 4. Pre-installation script
Example
Chapter 5. Pre-install Script
Chapter 6. Post-installation Script
Examples
Chapter 7. Handling Errors
Chapter 8. Handling Tracebacks
Chapter 9. Package Selection
Group-level options
Chapter 10. Certificate
Chapter 11. Making the Kickstart File Available
Creating a Kickstart Boot Diskette
Creating a Kickstart Boot CD-ROM
Making the Kickstart File Available on the Network
Chapter 12. Making the Installation Tree Available
Chapter 13. Starting a Kickstart Installation
Boot Diskette
CD-ROM #1 and Diskette
With Driver Disk
Boot CD-ROM
Other kickstart options
Example Kickstart Script
More Kickstart usage examples
Chapter 1. Introduction
What are Kickstart Installations?
Many system administrators would prefer to use an automated installation method to install Fedora or Red Hat Enterprise Linux on their machines. To answer this need, Red Hat created the kickstart installation method. Using kickstart, a system administrator can create a single file containing the answers to all the questions that would normally be asked during a typical installation.
Kickstart files can be kept on a server system and read by individual computers during the installation. This installation method can support the use of a single kickstart file to install Fedora or Red Hat Enterprise Linux on multiple machines, making it ideal for network and system administrators.
The Fedora installation guide at http://docs.fedoraproject.org/en-US/index.html has a detailed section on kickstart.
How Do You Perform a Kickstart Installation?
Kickstart installations can be performed using a local CD-ROM, a local hard drive, or via NFS, FTP, or HTTP.
To use kickstart, you must:
Create a kickstart file.
Create a boot diskette with the kickstart file or make the kickstart file available on the network.
Make the installation tree available.
Start the kickstart installation.
This chapter explains these steps in detail.
Creating the Kickstart File
The kickstart file is a simple text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application or by writing it from scratch. The Fedora or Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file /root/anaconda-ks.cfg. You should be able to edit it with any text editor or word processor that can save files as ASCII text.
First, be aware of the following issues when you are creating your kickstart file:
While not strictly required, there is a natural order for sections that should be followed. Items within the sections do not have to be in a specific order unless otherwise noted. The section order is:
Command section – Refer to Chapter 2 for a list of kickstart options. You must include the required options.
The %packages section – Refer to Chapter 3 for details.
The %pre, %pre-install, %post, %onerror, and %traceback sections – These sections can be in any order and are not required. Refer to Chapter 4, Chapter 5, and Chapter 6 for details.
The %certificate, %packages, %pre, %pre-install, %post, %onerror, and %traceback sections are all required to be closed with %end
Items that are not required can be omitted.
Omitting any required item will result in the installation program prompting the user for an answer to the related item, just as the user would be prompted during a typical installation. Once the answer is given, the installation will continue unattended unless it finds another missing item.
One installation source command from the list of commands in the method proxy command must be specified for the fully automated kickstart installation. This is required even for Fedora – the closest mirror can’t be chosen by the kickstart file.
Lines starting with a pound sign (#) are treated as comments and are ignored.
If deprecated commands, options, or syntax are used during a kickstart installation, a warning message will be logged to the anaconda log. Since deprecated items are usually removed within a release or two, it makes sense to check the installation log to make sure you haven’t used any of them. When using ksvalidator, deprecated items will cause an error.
Special Notes for Referring to Disks
Traditionally, disks have been referred to throughout Kickstart by a device node name (such as sda). The Linux kernel has moved to a more dynamic method where device names are not guaranteed to be consistent across reboots, so this can complicate usage in Kickstart scripts. To accommodate stable device naming, you can use any item from /dev/disk/by-id in place of a device node name. For example, instead of:
part / –fstype=ext4 –onpart=sda1
You could use an entry similar to one of the following:
part / –fstype=ext4 –onpart=/dev/disk/by-id/wwn-0x60022480de06a1c36a0f1e345393b224-part1
part / –fstype=ext4 –onpart=/dev/disk/by-id/scsi-360022480de06a1c36a0f1e345393b224-part1
This provides a consistent way to refer to disks that is more meaningful than just sda. This is especially useful in large storage environments.
You can also use shell-like entries to refer to disks. This is primarily intended to make it easier to use the clearpart and ignoredisk commands in large storage environments. For example, instead of:
However, the installation will fail if the * pattern does not match a device. For clearpart and ignoredisk commands specifically you can also use
to solve this issue. For example to match vda and/or hda you can use vda
hda which would match vda or hda or both. But if neither vda or hda are available the installation will fail. If you want to match any vd or hd disks you could combine * and
to match any drive of either: vd*
hd*.
Please note that /dev/disk/by-path identifiers are not 100% reliable as they can vary if the host bus adapter is physically moved, a new host bus adapter is added, or if the drivers are loaded or probed in a different order.
Finally, anywhere you want to refer to an existing partition or filesystem (say, in the part –ondisk=) option, you may also refer to the device by its filesystem label, UUID, or UUID path. This is done as follows:
part /data –ondisk=LABEL=data
part /misc –ondisk=UUID=819ff6de-0bd6-4bf4-8b72-dbe41033a85b
part /db –ondisk=/dev/disk/by-uuid/03596c0c-47e2-45e1-a4fd-212ba320f64e
When automating disk selection in kickstart for physical machines or virtual machines where the disk configuration is consistent, consider the following:
If only one disk exists, you can simply use the device node name.
If the configuration has multiple disks, each of which are the same size, you can use the device node names as it doesn’t matter which disk is which.
If you have different size disks, it may be helpful to select the disk based on size, see: Kickstart Examples.
Chapter 2. Kickstart Commands in Fedora
The following commands can be placed in a kickstart file. If you prefer to use a graphical interface for creating your kickstart file, you can use the Kickstart Configurator application.
Most commands take arguments. If an argument is followed equals mark (=), a value must be specified after it.
In the example commands, options in ‘’’[square brackets]’’’ are optional arguments for the command.
pykickstart processes arguments to commands just like the shell does:
If a list of arguments can be passed in, the arguments must be separated by
commas and not include any extra spaces. If extra spaces are required in the
list of arguments, the entire argument must be surrounded by double quotes.
If quotes, spaces, or other special characters need to be added to the
arguments list, they must be escaped.
auth or authconfig
auth|authconfig [options]
Added in version Fedora3.
This required command sets up the authentication options for the system. This is just a wrapper around the authconfig program, so all options recognised by that program are valid for this command. See the manual page for authconfig for a complete list.
By default, passwords are normally encrypted and are not shadowed.
Changed in version Fedora28.
The authconfig program is deprecated. This command will use the authconfig compatibility tool, but you should use the authselect command instead.
Removed in version Fedora35.
positional arguments:
[options]
See man authconfig.
Added in version Fedora3.
authselect
authselect [options]
Added in version Fedora28.
This command sets up the authentication options for the system. This is just a wrapper around the authselect program, so all options recognised by that program are valid for this command. See the manual page for authselect for a complete list.
Automatically create partitions – a root (/) partition, a swap partition, and an appropriate boot partition for the architecture. On large enough drives, this will also create a /home partition.
Note autopart cannot be used with the following commands: partition, raid, volgroup, logvol, reqpart
options:
–encrypted
Should all devices with support be encrypted by default? This is equivalent to checking the “Encrypt” checkbox on the initial partitioning screen.
Added in version Fedora9.
–passphrase PASSPHRASE
Only relevant if –encrypted is specified. Provide a default system-wide passphrase for all encrypted devices.
Added in version Fedora9.
–escrowcert
Only relevant if –encrypted is specified. Load an X.509 certificate from . Store the data encryption keys of all encrypted volumes created during installation, encrypted using the certificate, as files in /root.
Added in version Fedora12.
–backuppassphrase
Only relevant if –escrowcert is specified. In addition to storing the data encryption keys, generate a random passphrase and add it to all encrypted volumes created during installation. Then store the passphrase, encrypted using the certificate specified by –escrowcert, as files in /root (one file for each encrypted volume).
Added in version Fedora12.
–nolvm
Don’t use LVM when partitioning.
Added in version Fedora16.
Changed in version Fedora17.
The same as –type=plain
–type TYPE
Select automatic partitioning scheme. Must be one of the following: [‘lvm’, ‘btrfs’, ‘plain’, ‘partition’, ‘thinp’]. Plain means regular partitions with no btrfs or lvm.
Added in version Fedora17.
Changed in version Fedora20.
Partitioning scheme ‘thinp’ was added.
–cipher CIPHER
Only relevant if –encrypted is specified. Specifies which encryption algorithm should be used to encrypt the filesystem.
Added in version Fedora18.
–fstype FSTYPE
Use the specified filesystem type on the partitions. Note that it cannot be used with –type=btrfs since btrfs is both a partition scheme and a filesystem. eg. –fstype=ext4.
Added in version Fedora21.
–nohome
Do not create a /home partition.
Added in version Fedora26.
–noboot
Do not create a /boot partition.
Added in version Fedora26.
–noswap
Do not create a swap partition. Only one of –noswap and –hibernation can be specified.
Added in version Fedora26.
–luks-version LUKS_VERSION
Only relevant if –encrypted is specified. Specifies which version of LUKS format should be used to encrypt the filesystem.
Added in version Fedora29.
–pbkdf PBKDF
Only relevant if –encrypted is specified. Sets Password-Based Key Derivation Function (PBKDF) algorithm for LUKS keyslot. See man cryptsetup.
Added in version Fedora29.
–pbkdf-memory PBKDF_MEMORY
Only relevant if –encrypted is specified. Sets the memory cost for PBKDF. See man cryptsetup.
Added in version Fedora29.
–pbkdf-time PBKDF_TIME
Only relevant if –encrypted is specified. Sets the number of milliseconds to spend with PBKDF passphrase processing. See –iter-time in man cryptsetup.
Only one of –pbkdf-time and –pbkdf-iterations can be specified.
Added in version Fedora29.
–pbkdf-iterations PBKDF_ITERATIONS
Only relevant if –encrypted is specified. Sets the number of iterations directly and avoids PBKDF benchmark. See –pbkdf-force-iterations in man cryptsetup.
Only one of –pbkdf-time and –pbkdf-iterations can be specified.
Added in version Fedora29.
–hibernation
Create a swap partition with an automatically determined size that’s big enough for hibernation. Only one of –noswap and –hibernation can be specified.
Added in version Fedora38.
–hw-passphrase HW_PASSPHRASE
Only relevant if –encrypted is specified and –luks-version is set to either luks2-hw-opal or luks2-hw-opal-only.
OPAL administrator passphrase needed to create a new OPAL locking range.
Added in version Fedora41.
autostep
autostep [–autoscreenshot]
Added in version Fedora3.
Kickstart installs normally skip unnecessary screens. This makes the installer step through every screen, displaying each briefly.
This is mostly used for debugging.
Deprecated since version Fedora34.
Removed in version Fedora40.
options:
–autoscreenshot
Take a screenshot at every step during installation and copy the images over to /root/anaconda-screenshots after installation is complete. This is most useful for documentation.
Added in version Fedora3.
bootc
bootc [–stateroot STATEROOT] –source-imgref SOURCEIMGREF
[–target-imgref TARGETIMGREF]
Added in version Fedora43.
Used for Bootc installations from native container. See https://bootc-dev.github.io/bootc//man/bootc-install-to-filesystem.html for more information about Bootc install to filesystem.
Note bootc cannot be used with the following commands: ostreesetup, ostreecontainer
options:
–stateroot STATEROOT
Name for the state directory, also known as “osname”.
Added in version Fedora43.
–source-imgref SOURCEIMGREF
Install the system from an explicitly given source.
Added in version Fedora43.
–target-imgref TARGETIMGREF
Specify the image to fetch for subsequent updates. If not presented defaults to ‘–source-imgref’ value.
This required command specifies how the boot loader should be installed.
There must be a biosboot partition for the bootloader to be installed successfully onto a disk that contains a GPT/GUID partition table, which includes disks initialised by anaconda. This partition may be created with the kickstart command part biosboot –fstype=biosboot –size=1. However, in the case that a disk has an existing biosboot partition, adding a part biosboot option is unnecessary.
options:
–append APPENDLINE
Specifies additional kernel parameters. For example:
Note The installer will add the bootloader arguments rhgb quiet if plymouth is installed on the target system. You can disable these options with -plymouth in the %packages section.
Added in version Fedora3.
–linear
use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
Removed in version Fedora4.
–nolinear
do not use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
Removed in version Fedora4.
–location {mbr,partition,none,boot}
Specifies where the boot record is written. Valid values are the following: mbr (the default), partition (installs the boot loader on the first sector of the partition containing the kernel), or none (do not install the boot loader).
Note bootloader –location=none is different from bootloader –location=none –disabled. –location=none prevents extra installation steps that makes the target machine bootable, e.g. write to MBR on x86 BIOS systems. However, the corresponding RPM packages are still installed, and –disabled can be appended to prevent it. bootloader –disabled only does not prevent the installation of the bootloader and Anaconda will complain if no other options are provided.
Added in version Fedora3.
–password PASSWORD
If using GRUB, sets the GRUB boot loader password. This should be used to restrict access to the GRUB shell, where arbitrary kernel options can be passed.
Added in version Fedora3.
–useLilo
force the use of LILO
Added in version Fedora3.
Removed in version Fedora4.
–driveorder DRIVEORDER
define the explicit hard disk order the boot loader should use
Added in version Fedora3.
–timeout TIMEOUT
Specify the number of seconds before the bootloader times out and boots the default option.
Added in version Fedora8.
–default DEFAULT
Sets the default boot image in the bootloader configuration.
Added in version Fedora8.
–lba32
force the use of LBA32 mode for hard disk access (LILO only)
Added in version Fedora3.
Deprecated since version Fedora12.
Removed in version Fedora14.
–iscrypted
If given, the password specified by –password= is already encrypted and should be passed to the bootloader configuration without additional modification.
Added in version Fedora15.
–md5pass MD5PASS
If using GRUB, similar to –password= except the password should already be encrypted.
Added in version Fedora3.
Changed in version Fedora15.
Alias for –password=MD5PASS –iscrypted.
–boot-drive BOOTDRIVE
Specifies which drive the bootloader should be written to and thus, which drive the computer will boot from.
Added in version Fedora17.
–leavebootorder
On EFI or ISeries/PSeries machines, this option prevents the installer from making changes to the existing list of bootable images.
Added in version Fedora18.
–extlinux
Use the extlinux bootloader instead of GRUB. This option only works on machines that are supported by extlinux.
Added in version Fedora19.
–disabled
Do not install the boot loader.
Note bootloader –location=none is different from bootloader –location=none –disabled. –location=none prevents extra installation steps that makes the target machine bootable, e.g. write to MBR on x86 BIOS systems. However, the corresponding RPM packages are still installed, and –disabled can be appended to prevent it. bootloader –disabled only does not prevent the installation of the bootloader and Anaconda will complain if no other options are provided.
Added in version Fedora21.
–nombr
do not install the boot loader to the MBR
Added in version Fedora21.
–upgrade
upgrade the boot loader installed on disk
Added in version Fedora3.
Deprecated since version Fedora29.
Removed in version Fedora34.
–sdboot
Use systemd-boot as the bootloader instead of grub2. This option only works on EFI machines.
Defines a BTRFS volume or subvolume. This command is of the form:
btrfs --data= --metadata= --label=
for volumes and of the form:
btrfs --subvol --name=
for subvolumes.
The <partitions*> (which denotes that multiple partitions can be listed) lists the BTRFS identifiers to add to the BTRFS volume. For subvolumes, should be the identifier of the subvolume’s parent volume.
Location where the file system is mounted.
options:
--noformat
Use an existing BTRFS volume (or subvolume) and do not reformat the filesystem.
Added in version Fedora17.
--useexisting
Same as --noformat.
Added in version Fedora17.
--label LABEL
Specify the label to give to the filesystem to be made. If the given label is already in use by another filesystem, a new label will be created. This option has no meaning for subvolumes.
Added in version Fedora17.
--data DATALEVEL
RAID level to use (0, 1, 10) for filesystem data. Optional. This option has no meaning for subvolumes.
Added in version Fedora17.
--metadata METADATALEVEL
RAID level to use (0, 1, 10) for filesystem/volume metadata. Optional. This option has no meaning for subvolumes.
Added in version Fedora17.
--subvol
Create BTRFS subvolume.
Added in version Fedora17.
--parent PARENT
BTRFS parent device
Added in version Fedora17.
--name NAME
Subvolume name.
Added in version Fedora17.
--mkfsoptions MKFSOPTS
Specifies additional parameters to be passed to the program that makes a filesystem on this partition. No processing is done on the list of arguments, so they must be supplied in a format that can be passed directly to the mkfs program. This means multiple options should be comma-separated or surrounded by double quotes, depending on the filesystem.
Added in version Fedora23.
The following example shows how to create a BTRFS volume from member partitions on three disks with subvolumes for root and home. The main volume is not mounted or used directly in this example – only the root and home subvolumes:
part btrfs.01 --size=6000 --ondisk=sda
part btrfs.02 --size=6000 --ondisk=sdb
part btrfs.03 --size=6000 --ondisk=sdc
btrfs none --data=0 --metadata=1 --label=f17 btrfs.01 btrfs.02 btrfs.03
btrfs / --subvol --name=root LABEL=f17
btrfs /home --subvol --name=home f17
cdrom
cdrom
Added in version Fedora3.
Install from the first CD-ROM/DVD drive on the system.
clearpart
clearpart [--all] [--initlabel] [--linux] [--none] [--disklabel DISKLABEL]
[--drives DRIVES] [--list DEVICES] [--cdl]
Added in version Fedora3.
Removes partitions from the system, prior to creation of new partitions. By default, no partitions are removed.
If the clearpart command is used, then the --onpart command cannot be used on a logical partition.
options:
--all
Erases all partitions from the system.
Added in version Fedora3.
--initlabel
Initializes the disk label to the default for your architecture (for example gpt for x86). This is only meaningful in combination with the ‘–all’ option.
Added in version Fedora3.
--linux
Erases all Linux partitions.
Added in version Fedora3.
--none
Do not remove any partitions. This is the default
Added in version Fedora3.
--disklabel DISKLABEL
Set the default disklabel to use. Only disklabels supported for the platform will be accepted. eg. msdos and gpt for x86_64 but not dasd.
Added in version Fedora21.
--drives DRIVES
Specifies which drives to clear partitions from. For example, the following clears the partitions on the first two drives on the primary IDE controller:
``clearpart --all --drives=sda,sdb``
Added in version Fedora3.
Changed in version Fedora25.
The following clears the partitions on the first two drives on the system:
clearpart --drives=sda,sdb
or clear as many drives as it could and skip the missing (at least one must be matched):
clearpart --drives=sda|sdb1
or clear all virtio drives and only first scsi device if exists
clearpart --drives=sda|vd*
--list DEVICES
Specifies which partitions to clear. If given, this supersedes any of the --all and --linux options. This can be across different drives:
``clearpart --list=sda2,sda3,sdb1``
Added in version Fedora17.
Changed in version Fedora25.
The following clears the partitions on the first two drives on the system:
clearpart --list=sda,sdb
or clear as many drives as it could and skip the missing (at least one must be matched):
clearpart --list=sda|sdb1
or clear all virtio drives and only first scsi device if exists
clearpart --list=sda|vd*
--cdl
Reformat any LDL DASDs to CDL format.
Added in version Fedora28.
graphical or text or cmdline
graphical|text|cmdline [--non-interactive]
Added in version Fedora3.
Controls which display mode will be used for the installation and for the installed system. If text or cmdline is chosen the system will boot in text mode. And when cmdline is used all required installation options must be configured via kickstart, otherwise the installation will fail.
options:
--non-interactive
Perform the installation in a completely non-interactive mode. This mode will kill the installation when user interaction will be required. Can’t be used with cmdline mode. This option is especially useful for automated testing purpose.
Added in version Fedora26.
device
device [--opts MODULEOPTS]
Added in version Fedora3.
On most PCI systems, the installation program will autoprobe for Ethernet and SCSI cards properly. On older systems and some PCI systems, however, kickstart needs a hint to find the proper devices. The device command, which tells the installation program to install extra modules, is in this format:
device --opts=
Replace with the name of the kernel module which should be installed.
Deprecated since version Fedora24.
Removed in version Fedora34.
options:
--opts MODULEOPTS
Options to pass to the kernel module. For example:
--opts="aic152x=0x340 io=11"
Added in version Fedora3.
deviceprobe
deviceprobe
Added in version Fedora3.
probe for devices
Deprecated since version Fedora29.
Removed in version Fedora34.
dmraid
dmraid --name NAME --dev DEVICES
Added in version Fedora6.
define a software RAID device
Deprecated since version Fedora24.
Removed in version Fedora34.
options:
--name NAME
Name of dmraid
Added in version Fedora6.
--dev DEVICES
device to add to the dmraid
Added in version Fedora6.
driverdisk
driverdisk [--source SOURCE] [--biospart BIOSPART] [partition ...]
Added in version Fedora3.
Driver diskettes can be used during kickstart installations. You need to copy the driver disk’s contents to the root directory of a partition on the system’s hard drive. Then you need to use the driverdisk command to tell the installation program where to look for the driver disk.
positional arguments:
partition
Partition containing the driver disk. This can be specified by device name, UUID=, or LABEL= just like the harddrive command may be.
Added in version Fedora3.
options:
--source SOURCE
Specify a URL for the driver disk. NFS locations can be given with nfs:host:/path/to/img.
Added in version Fedora3.
--biospart BIOSPART
BIOS partition containing the driver disk (such as 82p2).
Added in version Fedora4.
--type TYPE
REMOVED
Added in version Fedora3.
Deprecated since version Fedora12.
Removed in version Fedora14.
eula
eula [--agreed]
Added in version Fedora20.
Automatically accept Red Hat’s EULA
options:
--agreed, --agree, --accepted, --accept
Accept the EULA. This is mandatory option!
Added in version Fedora20.
fcoe
fcoe --nic NIC [--dcb] [--autovlan]
Added in version Fedora12.
Discover and attach FCoE storage devices accessible via specified network interface
options:
--nic NIC
Name of the network device connected to the FCoE switch
Added in version Fedora12.
--dcb
Enable Data Center Bridging awareness in installer. This option should only be enabled for network interfaces that require a host-based DCBX client. Configurations on interfaces that implement a hardware DCBX client should not use it.
Added in version Fedora13.
--autovlan
Perform automatic VLAN discovery and setup. This option is enabled by default.
Added in version Fedora28.
firewall
firewall [--disable] [--enable] [--port PORTS] [--trust TRUSTS]
[--service SERVICES] [--ftp] [--http] [--smtp] [--ssh]
[--remove-service REMOVE_SERVICES] [--use-system-defaults]
Added in version Fedora3.
This option corresponds to the Firewall Configuration screen in the installation program
options:
--disable, --disabled
Do not configure any iptables rules.
Added in version Fedora3.
--enable, --enabled
Reject incoming connections that are not in response to outbound requests, such as DNS replies or DHCP requests. If access to services running on this machine is needed, you can choose to allow specific services through the firewall.
Added in version Fedora3.
--high HIGH
Added in version Fedora3.
Deprecated since version Fedora3.
Removed in version Fedora9.
--medium MEDIUM
Added in version Fedora3.
Deprecated since version Fedora3.
Removed in version Fedora9.
--port PORTS
You can specify that ports be allowed through the firewall using the port:protocol format. You can also specify ports numerically. Multiple ports can be combined into one option as long as they are separated by commas. For example:
``firewall --port=imap:tcp,1234:ucp,47``
Added in version Fedora3.
--trust TRUSTS
Listing a device here, such as eth0, allows all traffic coming from that device to go through the firewall. To list more than one device, use –trust eth0 –trust eth1. Do NOT use a comma-separated format such as –trust eth0, eth1.
Added in version Fedora3.
--service SERVICES
This option provides a higher-level way to allow services through the firewall. Some services (like cups, avahi, etc.) require multiple ports to be open or other special configuration in order for the service to work. You could specify each individual service with the --port option, or specify --service= and open them all at once.
Valid options are anything recognized by the firewall-cmd program in the firewalld package. If firewalld is running:
``firewall-cmd --get-services``
will provide a list of known service names.
Added in version Fedora10.
--ftp
Open port 21:tcp
Added in version Fedora3.
Changed in version Fedora10.
Open the ftp service port
--http
Open ports 80:tcp and 443:tcp
Added in version Fedora3.
Changed in version Fedora10.
Open the http service port
--smtp
Open port 25:tcp
Added in version Fedora3.
Changed in version Fedora10.
Open the smtp service port
--ssh
Open port 22:tcp
Added in version Fedora3.
Changed in version Fedora10.
Open the ssh service port
--telnet TELNET
Open port 23:tcp
Added in version Fedora3.
Deprecated since version Fedora10.
Removed in version Fedora14.
--remove-service REMOVE_SERVICES
Close ports for the comma-separated list of services
Added in version Fedora20.
--use-system-defaults
Don’t configure the firewall at all. This instructs anaconda to do nothing and allows the system to rely on the defaults that were provided with the package or ostree. If this option is used with other options then all other options will be ignored.
Added in version Fedora28.
firstboot
firstboot [--disable] [--enable] [--reconfig]
Added in version Fedora3.
Determine whether the Setup Agent starts the first time the system is booted. If enabled, the initial-setup package must be installed. If not specified, the setup agent (initial-setup) is disabled by default.
options:
--disable, --disabled
The Setup Agent is not started the first time the system boots.
Added in version Fedora3.
--enable, --enabled
The Setup Agent is started the first time the system boots.
Added in version Fedora3.
--reconfig
Enable the Setup Agent to start at boot time in reconfiguration mode. This mode enables the language, mouse, keyboard, root password, security level, time zone, and networking configuration options in addition to the default ones.
Added in version Fedora3.
group
group --name NAME [--gid GID]
Added in version Fedora12.
Creates a new user group on the system. If a group with the given name or GID already exists, this command will fail. In addition, the user command can be used to create a new group for the newly created user.
options:
--name NAME
Provides the name of the new group.
Added in version Fedora12.
--gid GID
The group’s GID. If not provided, this defaults to the next available non-system GID.
Added in version Fedora12.
reboot or poweroff or shutdown or halt
reboot|poweroff|shutdown|halt [--eject] [--kexec]
Added in version Fedora3.
reboot
Reboot after the installation is complete. Normally, kickstart displays a message and waits for the user to press a key before rebooting.
poweroff
Turn off the machine after the installation is complete. Normally, kickstart displays a message and waits for the user to press a key before rebooting.
shutdown
At the end of installation, shut down the machine. This is the same as the poweroff command. Normally, kickstart displays a message and waits for the user to press a key before rebooting.
halt
At the end of installation, display a message and wait for the user to press a key before rebooting. This is the default action.
Changed in version Fedora18.
The ‘halt’ command was added!
options:
--eject
Attempt to eject CD or DVD media before rebooting.
Added in version Fedora6.
--kexec
Use kexec to reboot into the new system, bypassing BIOS/Firmware and bootloader.
Added in version Fedora23.
harddrive
harddrive --dir DIR --partition PARTITION
Added in version Fedora3.
Install from a directory of ISO images on a local drive, which must be either vfat or ext2. In addition to this directory, you must also provide the install.img in some way. You can either do this by booting off the boot.iso or by creating an images/ directory in the same directory as the ISO images and placing install.img in there.
options:
--biospart BIOSPART
BIOS partition to install from (such as 82p2).
Added in version Fedora3.
Removed in version Fedora33.
--dir DIR
Directory containing both the ISO images and the images/install.img. For example:
``harddrive --partition=hdb2 --dir=/tmp/install-tree``
Added in version Fedora3.
--partition PARTITION
Partition to install from (such as, sdb2).
Added in version Fedora3.
Changed in version Fedora33.
Partition to install from (such as, sdb2).
hmc
hmc
Added in version RedHatEnterpriseLinux7.
Install from an installation medium via SE/HMC on z Systems.
ignoredisk
ignoredisk [--drives IGNOREDISK] [--only-use ONLYUSE]
Added in version Fedora3.
Controls anaconda’s access to disks attached to the system. By default, all disks will be available for partitioning. Only one of the following three options may be used.
options:
--drives IGNOREDISK
Specifies those disks that anaconda should not touch when partitioning, formatting, and clearing.
Added in version Fedora3.
Changed in version Fedora8.
This argument is no longer required!
Changed in version Fedora25.
The following ignores the partitions on the first two drives on the system:
ignoredisk --drives=sda,sdb
or ignores as many drives as it could and skip the missing (at least one must be matched):
ignoredisk --drives=sda|sdb1
or ignores all virtio drives and only first scsi device if exists
ignoredisk --drives=sda|vd*
--only-use ONLYUSE
Specifies the opposite - only disks listed here will be used during installation.
Added in version Fedora8.
Changed in version Fedora25.
The following ignores the partitions on the first two drives on the system:
ignoredisk --only-use=sda,sdb
or ignores as many drives as it could and skip the missing (at least one must be matched):
ignoredisk --only-use=sda|sdb1
or ignores all virtio drives and only first scsi device if exists
ignoredisk --only-use=sda|vd*
--interactive
Allow the user manually navigate the advanced storage screen.
Added in version RedHatEnterpriseLinux6.
Deprecated since version Fedora29.
Removed in version Fedora34.
install
install [--root-device ROOT_DEVICE]
Install a fresh system. You must specify the type of
installation from one of cdrom, harddrive, nfs, or url
(for ftp or http installations).
The install command and the installation method command
must be on separate lines.
Important: before Fedora 20 this command was known as
install or upgrade but the upgrade part was deprecated!
Deprecated since version Fedora29.
Removed in version Fedora34.
options:
--root-device ROOT_DEVICE
On a system with multiple installs, this option specifies which filesystem holds the installation to be upgraded. This can be specified by device name, UUID=, or LABEL= just like the harddrive command may be.
Added in version Fedora11.
interactive
interactive
Added in version Fedora3.
Use interactive kickstart installation method.
Deprecated since version Fedora14.
Removed in version Fedora15.
iscsi
iscsi [--target TARGET] --ipaddr IPADDR [--port PORT] [--user USER]
[--password PASSWORD] [--reverse-user USER_IN]
[--reverse-password PASSWORD_IN] [--iface IFACE]
Added in version Fedora6.
Specifies additional iSCSI storage to be attached during installation. If you use the iscsi parameter, you must also assign a name to the iSCSI node, using the iscsiname parameter. The iscsiname parameter must appear before the iscsi parameter in the kickstart file.
We recommend that wherever possible you configure iSCSI storage in the system BIOS or firmware (iBFT for Intel systems) rather than use the iscsi parameter. Anaconda automatically detects and uses disks configured in BIOS or firmware and no special configuration is necessary in the kickstart file.
If you must use the iscsi parameter, ensure that networking is activated at the beginning of the installation, and that the iscsi parameter appears in the kickstart file before you refer to iSCSI disks with parameters such as clearpart or ignoredisk.
options:
--target TARGET
The target iqn.
Added in version Fedora6.
--ipaddr IPADDR
The IP address of the target to connect to.
Added in version Fedora6.
--port PORT
The port number to connect to (default, –port=3260).
Added in version Fedora6.
--user USER
The username required to authenticate with the target.
Added in version Fedora6.
--password PASSWORD
The password that corresponds with the username specified for the target.
Added in version Fedora6.
--reverse-user USER_IN
The username required to authenticate with the initiator from a target that uses reverse CHAP authentication.
Added in version Fedora10.
--reverse-password PASSWORD_IN
The password that corresponds with the username specified for the initiator.
Added in version Fedora10.
--iface IFACE
Bind connection to specific network interface instead of using the default one determined by network layer. Once used, it must be specified for all iscsi commands.
Added in version Fedora17.
iscsiname
iscsiname
Added in version Fedora6.
Assigns an initiator name to the computer. If you use the iscsi parameter in your kickstart file, this parameter is mandatory, and you must specify iscsiname in the kickstart file before you specify iscsi.
positional arguments:
IQN name
Added in version Fedora6.
keyboard
keyboard [--vckeymap VC_KEYMAP] [--xlayouts X_LAYOUTS]
[--switch SWITCH_OPTIONS]
[kbd ...]
Added in version Fedora3.
This required command sets system keyboard type.
Changed in version Fedora18.
See the documentation of --vckeymap option and the tip at the end of this section for a guide how to get values accepted by this command.
Either --vckeymap or --xlayouts must be used.
Alternatively, use the older format, arg, which is still supported. arg can be an X layout or VConsole keymap name.
Missing values will be automatically converted from the given one(s).
positional arguments:
kbd
Keyboard type
Added in version Fedora3.
options:
--vckeymap VC_KEYMAP
Specify VConsole keymap that should be used. is a keymap name which is the same as the filename under /usr/lib/kbd/keymaps/ without the .map.gz extension.
Added in version Fedora18.
--xlayouts X_LAYOUTS
Specify a list of X layouts that should be used (comma-separated list without spaces). Accepts the same values as setxkbmap(1), but uses either the layout format (such as cz) or the ‘layout (variant)’ format (such as ‘cz (qwerty)’). For example:
``keyboard --xlayouts=cz,'cz (qwerty)'`
Added in version Fedora18.
--switch SWITCH_OPTIONS
Specify a list of layout switching options that should be used (comma-separated list without spaces). Accepts the same values as setxkbmap(1) for layout switching. For example:
``keyboard --xlayouts=cz,'cz (qwerty)' --switch=grp:alt_shift_toggle``
Added in version Fedora18.
If you know only the description of the layout (e.g. Czech (qwerty)), you can use http://vpodzime.fedorapeople.org/layouts_list.py to list all available layouts and find the one you want to use. The string in square brackets is the valid layout specification as Anaconda accepts it. The same goes for switching options and http://vpodzime.fedorapeople.org/switching_list.py
lang
lang [--addsupport LOCALE]
Added in version Fedora3.
This required command sets the language to use during installation and the default language to use on the installed system to . This can be the same as any recognized setting for the $LANG environment variable, though not all languages are supported during installation.
Certain languages (mainly Chinese, Japanese, Korean, and Indic languages) are not supported during text mode installation. If one of these languages is specified using the lang command, installation will continue in English though the running system will have the specified langauge by default.
The file /usr/share/system-config-language/locale-list provides a list the valid language codes in the first column of each line and is part of the system-config-languages package.
positional arguments:
Language ID.
Added in version Fedora3.
options:
--addsupport LOCALE
Install the support packages for the given locales, specified as a comma-separated list. Each locale may be specified in the same ways as the primary language may be, as described above.
Added in version Fedora19.
langsupport
langsupport [--default DEFLANG]
Added in version Fedora3.
Install the support packages for the given locales.
Deprecated since version Fedora5.
Removed in version Fedora7.
options:
--default DEFLANG
Default locale
Added in version Fedora3.
lilo
lilo [--append APPENDLINE] [--linear] [--nolinear]
[--location {mbr,partition,none,boot}] [--lba32] [--password PASSWORD]
[--md5pass MD5PASS] [--upgrade] [--useLilo] [--driveorder DRIVEORDER]
Added in version Fedora3.
This required command specifies how the boot loader should be installed.
There must be a biosboot partition for the bootloader to be installed successfully onto a disk that contains a GPT/GUID partition table, which includes disks initialized by anaconda. This partition may be created with the kickstart command part biosboot --fstype=biosboot --size=1. However, in the case that a disk has an existing biosboot partition, adding a part biosboot option is unnecessary.
Removed in version Fedora4.
options:
--append APPENDLINE
Specifies additional kernel parameters. For example:
bootloader --location=mbr --append="hdd=ide-scsi ide=nodma"
Note The installer will add the bootloader arguments rhgb quiet if plymouth is installed on the target system. You can disable these options with -plymouth in the %packages section.
Added in version Fedora3.
--linear
use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
--nolinear
do not use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
--location {mbr,partition,none,boot}
Specifies where the boot record is written. Valid values are the following: mbr (the default), partition (installs the boot loader on the first sector of the partition containing the kernel), or none (do not install the boot loader).
Note bootloader –location=none is different from bootloader –location=none –disabled. –location=none prevents extra installation steps that makes the target machine bootable, e.g. write to MBR on x86 BIOS systems. However, the corresponding RPM packages are still installed, and –disabled can be appended to prevent it. bootloader –disabled only does not prevent the installation of the bootloader and Anaconda will complain if no other options are provided.
Added in version Fedora3.
--lba32
force the use of LBA32 mode for hard disk access (LILO only)
Added in version Fedora3.
--password PASSWORD
If using GRUB, sets the GRUB boot loader password. This should be used to restrict access to the GRUB shell, where arbitrary kernel options can be passed.
Added in version Fedora3.
--md5pass MD5PASS
If using GRUB, similar to --password= except the password should already be encrypted.
Added in version Fedora3.
--upgrade
upgrade the boot loader installed on disk
Added in version Fedora3.
--useLilo
force the use of LILO
Added in version Fedora3.
--driveorder DRIVEORDER
define the explicit hard disk order the boot loader should use
Added in version Fedora3.
lilocheck
lilocheck
Added in version Fedora3.
check LILO boot loader
Removed in version Fedora4.
liveimg
liveimg --url [--proxy ] [--noverifyssl] [--checksum ]
Added in version Fedora19.
Install a disk image instead of packages. The image can be the squashfs.img from a Live iso, or any filesystem mountable by the install media (eg. ext4). Anaconda expects the image to contain utilities it needs to complete the system install so the best way to create one is to use livemedia-creator to make the disk image. If the image contains /LiveOS/*.img (this is how squashfs.img is structured) the first *.img file inside LiveOS will be mounted and used to install the target system. The URL may also point to a tarfile of the root filesystem. The file must end in .tar, .tbz, .tgz, .txz, .tar.bz2, tar.gz, tar.xz
options:
--url
The URL to install from. http, https, ftp and file are supported.
Added in version Fedora19.
--proxy
Specify an HTTP/HTTPS/FTP proxy to use while performing the install. The various parts of the argument act like you would expect. Syntax is:
``--proxy=[protocol://][username[:password]@]host[:port]``
Added in version Fedora19.
--noverifyssl
For a tree on a HTTPS server do not check the server’s certificate with what well-known CA validate and do not check the server’s hostname matches the certificate’s domain name.
Added in version Fedora19.
--checksum
Optional sha256 checksum of the image file
Added in version Fedora19.
logging
logging [--host HOST] [--port PORT]
Added in version Fedora6.
This command controls the error logging of anaconda during installation. It has no effect on the installed system.
options:
--host HOST
Send logging information to the given remote host, which must be running a syslogd process configured to accept remote logging.
Added in version Fedora6.
--port PORT
If the remote syslogd process uses a port other than the default, it may be specified with this option.
Added in version Fedora6.
--level LEVEL
Specify the minimum level of messages that appear on tty3. All messages will still be sent to the log file regardless of this level, however.
Added in version Fedora6.
Deprecated since version Fedora34.
Removed in version Fedora40.
logvol
logvol [--fstype FSTYPE] [--grow] [--maxsize MAXSIZEMB] --name NAME
[--noformat] [--percent PERCENT] [--recommended] [--size SIZE]
[--useexisting] --vgname VGNAME [--fsoptions FSOPTS]
[--fsprofile FSPROFILE] [--encrypted] [--passphrase PASSPHRASE]
[--escrowcert ] [--backuppassphrase] [--label LABEL] [--resize]
[--hibernation] [--cipher CIPHER] [--thinpool] [--thin]
[--poolname POOL_NAME] [--chunksize CHUNK_SIZE]
[--metadatasize METADATA_SIZE] [--profile PROFILE]
[--cachesize CACHE_SIZE] [--cachemode CACHE_MODE]
[--cachepvs CACHE_PVS] [--mkfsoptions MKFSOPTS]
[--luks-version LUKS_VERSION] [--pbkdf PBKDF]
[--pbkdf-memory PBKDF_MEMORY] [--pbkdf-time PBKDF_TIME]
[--pbkdf-iterations PBKDF_ITERATIONS]
Added in version Fedora3.
Create a logical volume for Logical Volume Management (LVM).
Note logvol cannot be used with the following commands: autopart, mount
positional arguments:
Mountpoint for this logical volume or ‘none’.
Added in version Fedora3.
options:
--fstype FSTYPE
Sets the file system type for the logical volume. Valid values include ext4, ext3, ext2, btrfs, swap, and vfat. Other filesystems may be valid depending on command line arguments passed to Anaconda to enable other filesystems.
Added in version Fedora3.
--grow
Tells the logical volume to grow to fill available space (if any), or up to the maximum size setting. Note that --grow is not supported for logical volumes containing a RAID volume on top of them.
Added in version Fedora3.
--maxsize MAXSIZEMB
The maximum size in MiB the logical volume may grow to. Specify an integer value here, and do not append any units. This option is only relevant if --grow is specified as well.
Added in version Fedora3.
--name NAME
The name of this logical volume.
Added in version Fedora3.
--noformat
Use an existing logical volume and do not format it.
Added in version Fedora3.
--percent PERCENT
Specify the size of the logical volume as a percentage of available space in the volume group. Without the above --grow option, this may not work.
Added in version Fedora3.
--recommended
Determine the size of the logical volume automatically.
Added in version Fedora3.
--size SIZE
Size of this logical volume.
Added in version Fedora3.
--useexisting
Use an existing logical volume and reformat it.
Added in version Fedora3.
--vgname VGNAME
Name of the Volume Group this logical volume belongs to.
Added in version Fedora3.
--fsoptions FSOPTS
Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the /etc/fstab file of the installed system and should be enclosed in quotes.
Added in version Fedora4.
--bytes-per-inode BYTES_PER_INODE
Specify the bytes/inode ratio.
Added in version Fedora4.
Deprecated since version Fedora9.
Removed in version Fedora14.
--fsprofile FSPROFILE
Specifies a usage type to be passed to the program that makes a filesystem on this partition. A usage type defines a variety of tuning parameters to be used when making a filesystem. For this option to work, the filesystem must support the concept of usage types and there must be a configuration file that lists valid types. For ext2/3/4, this configuration file is /etc/mke2fs.conf.
Added in version Fedora9.
--encrypted
Specify that this logical volume should be encrypted.
Added in version Fedora9.
--passphrase PASSPHRASE
Specify the passphrase to use when encrypting this logical volume. Without the above --encrypted option, this option does nothing. If no passphrase is specified, the default system-wide one is used, or the installer will stop and prompt if there is no default.
Added in version Fedora9.
--escrowcert
Load an X.509 certificate from . Store the data encryption key of this logical volume, encrypted using the certificate, as a file in /root. Only relevant if --encrypted is specified as well.
Added in version Fedora12.
--backuppassphrase
Only relevant if --escrowcert is specified as well. In addition to storing the data encryption key, generate a random passphrase and add it to this logical volume. Then store the passphrase, encrypted using the certificate specified by --escrowcert, as a file in /root. If more than one LUKS volume uses --backuppassphrase, the same passphrase will be used for all such volumes.
Added in version Fedora12.
--label LABEL
Specify the label to give to the filesystem to be made. If the given label is already in use by another filesystem, a new label will be created.
Added in version Fedora15.
--resize
Attempt to resize this logical volume to the size given by --size=. This option must be used with --useexisting --size=, or an error will be raised.
Added in version Fedora17.
--hibernation
This option can be used to automatically determine the size of the swap partition big enough for hibernation.
Added in version Fedora18.
--cipher CIPHER
Only relevant if --encrypted is specified. Specifies which encryption algorithm should be used to encrypt the filesystem.
Added in version Fedora18.
--thinpool
Create a thin pool logical volume. Use a mountpoint of ‘none’.
Added in version Fedora20.
--thin
Create a thin logical volume. Requires --poolname.
Added in version Fedora20.
--poolname POOL_NAME
Specify the name of the thin pool in which to create a thin logical volume. Requires --thin.
Added in version Fedora20.
--chunksize CHUNK_SIZE
Specify the chunk size (in KiB) for a new thin pool device.
Added in version Fedora20.
--metadatasize METADATA_SIZE
Specify the metadata area size (in MiB) for a new thin pool device.
Added in version Fedora20.
--profile PROFILE
Specify an LVM profile for the thin pool (see lvm(8), standard profiles are default and thin-performance defined in the /etc/lvm/profile/ directory).
Added in version Fedora21.
--cachesize CACHE_SIZE
Requested size (in MiB) of cache attached to the logical volume. Requires --cachepvs.
Added in version Fedora23.
--cachemode CACHE_MODE
Mode that should be used for the cache. Either writeback or writethrough.
Added in version Fedora23.
--cachepvs CACHE_PVS
Comma-separated list of (fast) physical volumes that should be used for the cache.
Added in version Fedora23.
--mkfsoptions MKFSOPTS
Specifies additional parameters to be passed to the program that makes a filesystem on this partition. No processing is done on the list of arguments, so they must be supplied in a format that can be passed directly to the mkfs program. This means multiple options should be comma-separated or surrounded by double quotes, depending on the filesystem.
Added in version Fedora23.
--luks-version LUKS_VERSION
Only relevant if --encrypted is specified. Specifies which version of LUKS format should be used to encrypt the filesystem.
Added in version Fedora29.
--pbkdf PBKDF
Only relevant if --encrypted is specified. Sets Password-Based Key Derivation Function (PBKDF) algorithm for LUKS keyslot. See man cryptsetup.
Added in version Fedora29.
--pbkdf-memory PBKDF_MEMORY
Only relevant if --encrypted is specified. Sets the memory cost for PBKDF. See man cryptsetup.
Added in version Fedora29.
--pbkdf-time PBKDF_TIME
Only relevant if --encrypted is specified. Sets the number of milliseconds to spend with PBKDF passphrase processing. See --iter-time in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
--pbkdf-iterations PBKDF_ITERATIONS
Only relevant if --encrypted is specified. Sets the number of iterations directly and avoids PBKDF benchmark. See --pbkdf-force-iterations in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
Create the partition first, create the logical volume group, and then create the logical volume. For example:
part pv.01 --size 3000
volgroup myvg pv.01
logvol / --vgname=myvg --size=2000 --name=rootvol
mediacheck
mediacheck
Added in version Fedora4.
If given, this will force anaconda to run mediacheck on the installation media. This command requires that installs be attended, so it is disabled by default.
method
method
Added in version Fedora3.
Proxy to the actual installation method. Valid installation methods are:
cdrom
harddrive
nfs
url
liveimg
Deprecated since version Fedora34.
Removed in version Fedora40.
module
module --name [--stream ] [--disable]
Added in version Fedora29.
The module command makes it possible to manipulate modules.
(In this case we mean modules as introduced by the Fedora modularity initiative.)
A module is defined by a unique name and a stream id, where single module can (and usually has) multiple available streams.
Streams will in most cases corresponds to stable releases of the given software components (such as Node.js, Django, etc.) but there could be also other use cases, such as a raw upstream master branch stream or streams corresponding to an upcoming stable release.
For more information see the Fedora modularity initiative documentation: https://docs.pagure.org/modularity/
Deprecated since version Fedora41.
The module command is deprecated and might be removed in the future.
options:
--name
Name of the module to enable.
Added in version Fedora29.
--stream
Name of the module stream to enable.
Added in version Fedora29.
--disable
Disable module.
Added in version RedHatEnterpriseLinux8.
monitor
monitor [--hsync HSYNC] [--monitor MONITOR] [--vsync VSYNC] [--noprobe]
Added in version Fedora3.
If the monitor command is not given, anaconda will use X to automatically detect your monitor settings. Please try this before manually configuring your monitor.
Deprecated since version Fedora10.
Removed in version Fedora18.
options:
--hsync HSYNC
Specifies the horizontal sync frequency of the monitor.
Added in version Fedora3.
--monitor MONITOR
Use specified monitor; monitor name should be from the list of monitors in /usr/share/hwdata/MonitorsDB from the hwdata package. The list of monitors can also be found on the X Configuration screen of the Kickstart Configurator. This is ignored if --hsync or --vsync is provided. If no monitor information is provided, the installation program tries to probe for it automatically.
Added in version Fedora3.
--vsync VSYNC
Specifies the vertical sync frequency of the monitor.
Added in version Fedora3.
--noprobe
Do not probe the monitor.
Added in version Fedora6.
mount
mount [--reformat [REFORMAT]] [--mkfsoptions MKFS_OPTS]
[--mountoptions MOUNT_OPTS]
Added in version Fedora27.
Assigns a mount point to a block device and optionally reformats it to a given format. It at least requires a device and a mount point where the mount point can be none in case the format on the device is not mountable or in case the device should just be reformatted.
The difference between this command and the other commands for storage configuration (part, logvol,…) is that it doesn’t require the whole storage stack to be described in the kickstart file. The user just needs to make sure that the specified block device exists in the system. The installer doesn’t necessarily have to know all the details about of the given device. If, on the other hand, the installer is supposed to create the storage stack with all the devices mounted at various places, the part, logvol, raid, etc. commands have to be used.
Note mount cannot be used with the following commands: autopart, partition, raid, volgroup, logvol, reqpart
positional arguments:
The block device to mount
Added in version Fedora27.
The is where the will be mounted. Must be a valid mount point, for example /, /usr, /home, or none if the device cannot (e.g. swap) or should not be mounted.
Added in version Fedora27.
options:
--reformat [REFORMAT]
Specifies the new format (e.g. a file system) for the device.
Added in version Fedora27.
--mkfsoptions MKFS_OPTS
Specifies additional parameters to be passed to the program that makes a filesystem on this partition. No processing is done on the list of arguments, so they must be supplied in a format that can be passed directly to the mkfs program. This means multiple options should be comma-separated or surrounded by double quotes, depending on the filesystem.
Added in version Fedora27.
--mountoptions MOUNT_OPTS
Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the /etc/fstab file of the installed system and should be enclosed in quotes.
Added in version Fedora27.
mouse
mouse [--device DEVICE] [--emulthree]
Added in version RedHatEnterpriseLinux3.
Configure the system mouse
Deprecated since version Fedora3.
Removed in version Fedora7.
options:
--device DEVICE
Which device node to use for mouse
Added in version RedHatEnterpriseLinux3.
--emulthree
If set emulate 3 mouse buttons
Added in version RedHatEnterpriseLinux3.
multipath
multipath --name NAME --device DEVICE --rule RULE
Added in version Fedora6.
define a multipath storage device
Deprecated since version Fedora24.
Removed in version Fedora34.
options:
--name NAME
multipath device name
Added in version Fedora6.
--device DEVICE
multipath device node
Added in version Fedora6.
--rule RULE
multipath device rule
Added in version Fedora6.
network
network [--bootproto {dhcp,bootp,static,query,ibft}] [--dhcpclass DHCPCLASS]
[--device DEVICE] [--essid ESSID] [--ethtool ETHTOOL]
[--gateway GATEWAY] [--hostname HOSTNAME] [--ip IP] [--mtu MTU]
[--nameserver NAMESERVER] [--netmask NETMASK] [--nodns]
[--onboot ONBOOT] [--wepkey WEPKEY] [--notksdevice] [--noipv4]
[--noipv6] [--ipv6 IPV6] [--activate] [--nodefroute] [--wpakey WPAKEY]
[--bondslaves BONDSLAVES] [--bondopts BONDOPTS] [--vlanid VLANID]
[--ipv6gateway IPV6GATEWAY] [--teamslaves TEAMSLAVES]
[--teamconfig TEAMCONFIG] [--interfacename INTERFACENAME]
[--bridgeslaves BRIDGESLAVES] [--bridgeopts BRIDGEOPTS]
[--no-activate] [--bindto {mac}] [--ipv4-dns-search IPV4_DNS_SEARCH]
[--ipv6-dns-search IPV6_DNS_SEARCH] [--ipv4-ignore-auto-dns]
[--ipv6-ignore-auto-dns]
Added in version Fedora3.
Configures network information for target system and activates network devices in installer environment. The device specified in the first network command is activated automatically. Activation of the device can be also explicitly required by --activate option
options:
--bootproto {dhcp,bootp,static,query,ibft}
The method of IPv4 configuration. For IPv6 configuration use --ipv6 option.
The default setting is dhcp. To turn IPv4 configuration off use --noipv4 option.
The dhcp method uses a DHCP server system to obtain its networking configuration.
The static method requires that you specify at least IP address and netmask with --ip and --netmask options.
For example:
``network --device=link --bootproto=static --ip=10.0.2.15 --netmask=255.255.255.0 --gateway=10.0.2.254 --nameserver=10.0.2.1``
ibft setting is for reading the configuration from iBFT table.
Added in version Fedora3.
Changed in version Fedora9.
The ‘query’ value was added.
Changed in version Fedora16.
The ‘ibft’ value was added.
--dhcpclass DHCPCLASS
Specifies the DHCP vendor class identifier. The dhcpd service will see this value as vendor-class-identifier.
Added in version Fedora3.
--device DEVICE
Specifies the device to be configured (and eventually activated in Anaconda) with the network command.
You can specify a device to be activated in any of the following ways:
the device name of the interface, for example, em1
the MAC address of the interface, for example, 01:23:45:67:89:ab
the keyword link, which specifies the first interface with its link in the up state
the keyword bootif, which uses the MAC address that pxelinux set in the BOOTIF variable. Set IPAPPEND 2 in your pxelinux.cfg file to have pxelinux set the BOOTIF variable.
For example:
``network --bootproto=dhcp --device=ens3``
If the --device= option is missing on the first use of the network command, the value of the ksdevice= Anaconda boot option is used, if available. If ksdevice= is not set, link value is used. Note that this is considered deprecated behavior; in most cases, you should always specify a --device= for every network command. The behavior of any subsequent network command in the same Kickstart file is unspecified if its --device= option is missing. Make sure you specify this option for any network command beyond the first.
Added in version Fedora3.
--essid ESSID
The network ID for wireless networks.
Added in version Fedora3.
--ethtool ETHTOOL
Specifies additional low-level settings for the network device which will be passed to the ethtool program.
Added in version Fedora3.
--gateway GATEWAY
Default gateway, as a single IPv4 address.
Added in version Fedora3.
--hostname HOSTNAME
The host name for the installed system.
The host name can either be a fully-qualified domain name (FQDN) in the format hostname.domainname, or a short host name with no domain. Many networks have a DHCP service which automatically supplies connected systems with a domain name; to allow DHCP to assign the domain name, only specify a short host name.
Added in version Fedora3.
--ip IP
IPv4 address for the interface.
Added in version Fedora3.
--mtu MTU
The MTU of the device.
Added in version Fedora3.
--nameserver NAMESERVER
Primary nameserver, as an IP address. Multiple nameservers must be comma separated.
Added in version Fedora3.
--netmask NETMASK
IPv4 network mask of the device.
Added in version Fedora3.
--nodns
Do not configure any DNS server.
Added in version Fedora3.
--onboot ONBOOT
Whether or not to enable the device a boot time.
Added in version Fedora3.
--wepkey WEPKEY
The WEP encryption key for wireless networks.
Added in version Fedora3.
--notksdevice
This network device is not used for kickstart.
Added in version Fedora4.
--noipv4
Disable IPv4 configuration of this device.
Added in version Fedora6.
--noipv6
Disable IPv6 configuration of this device.
Added in version Fedora6.
--ipv6 IPV6
IPv6 address for the interface. This can be: - the static address in form [/], e.g. 3ffe:ffff:0:1::1/128 (if prefix is omitted 64 is assumed), - auto for stateless automatic address autoconfiguration, or - dhcp for DHCPv6-only configuration (no router advertisements).
Added in version Fedora8.
--activate
As noted above, using this option ensures any matching devices beyond the first will also be activated.
Added in version Fedora16.
--nodefroute
Prevents grabbing of the default route by the device. It can be useful when activating additional devices in installer using --activate option.
Added in version Fedora16.
--wpakey WPAKEY
The WPA encryption key for wireless networks.
Added in version Fedora16.
--bondslaves BONDSLAVES
Bonded device with name specified by --device option will be created using slaves specified in this option. Example:
``network --device bond0 --bootproto static --ip=10.34.102.222 --netmask=255.255.255.0 --gateway=10.34.102.254 --nameserver=10.34.39.2 --bondslaves=ens7,ens8 --bondopts=mode=active-backup,primary=ens7 --activate``
Added in version Fedora19.
--bondopts BONDOPTS
A comma-separated list of optional parameters for bonded interface specified by --bondslaves and --device options. Example:
``--bondopts=mode=active-backup,primary=eth1``
If an option itself contains comma as separator use semicolon to separate the options. Example:
``--bondopts=mode=active-backup,balance-rr;primary=eth1``
Added in version Fedora19.
--vlanid VLANID
Id (802.1q tag) of vlan device to be created using parent device specified by --device option. For example:
``network --device=eth0 --vlanid=171``
will create vlan device eth0.171.
Added in version Fedora19.
--ipv6gateway IPV6GATEWAY
Default gateway, as a single IPv6 address.
Added in version Fedora19.
--teamslaves TEAMSLAVES
Team device with name specified by --device option will be created using slaves specified in this option. Slaves are separated by comma. A slave can be followed by its configuration which is a single-quoted json format string with double qoutes escaped by '' character. Example:
``--teamslaves="p3p1'{"prio": -10, "sticky": true}',p3p2'{"prio": 100}'"``.
See also --teamconfig option.
Added in version Fedora20.
--teamconfig TEAMCONFIG
Double-quoted team device configuration which is a json format string with double quotes escaped with '' character. The device name is specified by --device option and its slaves and their configuration by --teamslaves option. Example:
``network --device team0 --activate --bootproto static --ip=10.34.102.222 --netmask=255.255.255.0 --gateway=10.34.102.254 --nameserver=10.34.39.2 --teamslaves="p3p1'{"prio": -10, "sticky": true}',p3p2'{"prio": 100}'" --teamconfig="{"runner": {"name": "activebackup"}}"``
Added in version Fedora20.
--interfacename INTERFACENAME
Specify a custom interface name for a virtual LAN device. This option should be used when the default name generated by the --vlanid= option is not desirable. This option must be used along with --vlanid=. For example:
``network --device=em1 --vlanid=171 --interfacename=vlan171``
The above command creates a virtual LAN interface named vlan171 on the em1 device with an ID of 171. The interface name can be arbitrary (for example, my-vlan), but in specific cases, the following conventions must be followed:
If the name contains a dot (.), it must take the form of NAME.ID. The NAME is arbitrary, but the ID must be the VLAN ID. For example: em1.171 or my-vlan.171. Names starting with vlan must take the form of vlanID - for example: vlan171.
Added in version Fedora21.
--bridgeslaves BRIDGESLAVES
When this option is used, the network bridge with device name specified using the --device= option will be created and devices defined in the --bridgeslaves= option will be added to the bridge. For example:
``network --device=bridge0 --bridgeslaves=em1``
Added in version Fedora22.
--bridgeopts BRIDGEOPTS
An optional comma-separated list of parameters for the bridged interface. Available values are stp, priority, forward-delay, hello-time, max-age, and ageing-time. For information about these parameters, see the bridge setting table in the nm-settings(5) man page or at https://developer.gnome.org/NetworkManager/0.9/ref-settings.html.
Added in version Fedora22.
--no-activate
Use this option with first network command to prevent activation of the device in istaller environment
Added in version Fedora25.
--bindto {mac}
Optionally allows to specify how the connection configuration created for the device should be bound. If the option is not used, the connection binds to interface name (DEVICE value in ifcfg file). For virtual devices (bond, team, bridge) it configures binding of slaves. Not applicable to vlan devices.
Note that this option is independent of how the --device is specified.
Currently only the value mac is suported. --bindto=mac will bind the connection to MAC address of the device (HWADDR value in ifcfg file).
For example:
``network --device=01:23:45:67:89:ab --bootproto=dhcp --bindto=mac``
will bind the configuration of the device specified by MAC address 01:23:45:67:89:ab to its MAC address.
network --device=01:23:45:67:89:ab --bootproto=dhcp
will bind the configuration of the device specified by MAC address 01:23:45:67:89:ab to its interface name (eg ens3).
network --device=ens3 --bootproto=dhcp --bindto=mac
will bind the configuration of the device specified by interface name ens3 to its MAC address.
Added in version Fedora27.
--ipv4-dns-search IPV4_DNS_SEARCH
Use this option to set IPv4 search domains. For example: --ipv4-dns-search domain1.example.com,domain2.example.com
Requires --device to be specified.
Added in version Fedora39.
--ipv6-dns-search IPV6_DNS_SEARCH
Use this option to set IPv6 search domains. For example: --ipv6-dns-search domain1.example.com,domain2.example.com
Requires --device to be specified.
Added in version Fedora39.
--ipv4-ignore-auto-dns
Use this option to ignore IPv4 automatic DNS.
Requires --device to be specified.
Added in version Fedora39.
--ipv6-ignore-auto-dns
Use this option to ignore IPv6 automatic DNS.
Requires --device to be specified.
Added in version Fedora39.
nfs
nfs --server --dir [--opts ]
Added in version Fedora3.
Install from the NFS server specified. This can either be an exploded installation tree or a directory of ISO images. In the latter case, the install.img must also be provided subject to the same rules as with the harddrive installation method described above.
options:
--server
Server from which to install (hostname or IP).
Added in version Fedora3.
--dir
Directory containing the Packages/ directory of the installation tree. If doing an ISO install, this directory must also contain images/install.img.
Added in version Fedora3.
--opts
Mount options to use for mounting the NFS export. Any options that can be specified in /etc/fstab for an NFS mount are allowed. The options are listed in the nfs(5) man page. Multiple options are separated with a comma.
Added in version Fedora6.
nvdimm
nvdimm [--namespace ]
[--blockdevs ,,...,] [--mode {sector}]
[--sectorsize SECTORSIZE]
{reconfigure,use}
Added in version Fedora28.
Perform an action on an nvdimm device.
Deprecated since version Fedora40.
positional arguments:
{reconfigure,use}
The action to be performed on the device specified by further options. The device can be specified by --namespace or --blockdevs options, depending on the action.
Valid actions: - reconfigure: Reconfigures the device specified by --namespace into the mode specified by --mode and (depending on the mode) --sectorsize options. The device reconfigured into sector mode will be allowed to be used for storage configuration. - use: Allow the device to be used for storage configuration. By default nvdimm devices are ignored. Only devices in sector mode can be used.
Added in version Fedora28.
options:
--namespace
The device specification by namespace.
Added in version Fedora28.
--blockdevs ,,...,
Specification of devices by comma separated list of block device names.
Added in version Fedora28.
--mode {sector}
The mode specification.
Added in version Fedora28.
--sectorsize SECTORSIZE
Size of a sector for sector mode.
Added in version Fedora28.
ostreecontainer
ostreecontainer [--stateroot STATEROOT] --url URL [--transport TRANSPORT]
[--remote REMOTE] [--no-signature-verification]
Added in version Fedora38.
Used for OSTree installations from native container. See https://coreos.github.io/rpm-ostree/container/ for more information about OSTree.
Experimental. Use on your own risk.
Note ostreecontainer cannot be used with the following commands: ostreesetup, bootc
options:
--stateroot STATEROOT
Name for the state directory, also known as “osname”. Default value will be default.
Added in version Fedora38.
--url URL
Name of the container image; for the registry transport. This would be e.g. quay.io/exampleos/foo:latest.
Added in version Fedora38.
--transport TRANSPORT
The transport; e.g. registry, oci, oci-archive. The default is registry.
Added in version Fedora38.
--remote REMOTE
Name of the OSTree remote.
Added in version Fedora38.
--no-signature-verification
Disable verification via an ostree remote.
Added in version Fedora38.
ostreesetup
ostreesetup --osname OSNAME [--remote REMOTE] --url URL --ref REF [--nogpg]
Added in version Fedora21.
Used for OSTree installations. See https://wiki.gnome.org/action/show/Projects/OSTree for more information about OSTree.
Note ostreesetup cannot be used with the following commands: ostreecontainer, bootc
options:
--osname OSNAME
Management root for OS installation.
Added in version Fedora21.
--remote REMOTE
Management root for OS installation.
Added in version Fedora21.
--url URL
Repository URL.
Added in version Fedora21.
--ref REF
Name of branch inside the repository.
Added in version Fedora21.
--nogpg
Disable GPG key verification.
Added in version Fedora21.
part or partition
part|partition [--asprimary] [--fstype FSTYPE] [--grow] [--maxsize MAXSIZEMB]
[--noformat] [--onbiosdisk ONBIOSDISK] [--ondisk DISK]
[--onpart ONPART] [--recommended] [--size SIZE]
[--fsoptions FSOPTS] [--label LABEL] [--fsprofile FSPROFILE]
[--encrypted] [--passphrase PASSPHRASE] [--escrowcert ]
[--backuppassphrase] [--resize] [--hibernation]
[--cipher CIPHER] [--mkfsoptions MKFSOPTS]
[--luks-version LUKS_VERSION] [--pbkdf PBKDF]
[--pbkdf-memory PBKDF_MEMORY] [--pbkdf-time PBKDF_TIME]
[--pbkdf-iterations PBKDF_ITERATIONS]
[--hw-passphrase HW_PASSPHRASE]
Added in version Fedora3.
Creates a partition on the system. This command is required. All partitions created will be formatted as part of the installation process unless --noformat and --onpart are used.
Note part|partition cannot be used with the following commands: autopart, mount
positional arguments:
The is where the partition will be mounted and must be of one of the following forms:
/
For example, /, /usr, /home
swap
The partition will be used as swap space.
raid.
The partition will be used for software RAID. Refer to the raid command.
pv.
The partition will be used for LVM. Refer to the logvol command.
btrfs.
The partition will be used for BTRFS volume. Rerefer to the btrfs command.
biosboot
The partition will be used for a BIOS Boot Partition. As of Fedora 16 there must be a biosboot partition for the bootloader to be successfully installed onto a disk that contains a GPT/GUID partition table. Rerefer to the bootloader command.
Added in version Fedora3.
options:
--asprimary
Forces automatic allocation of the partition as a primary partition or the partitioning will fail.
TIP: The --asprimary option only makes sense with the MBR partitioning scheme and is ignored when the GPT partitioning scheme is used.
Added in version Fedora3.
--fstype FSTYPE, --type FSTYPE
Sets the file system type for the partition. Valid values include ext4, ext3, ext2, xfs, btrfs, swap, and vfat. Other filesystems may be valid depending on command line arguments passed to anaconda to enable other filesystems.
Added in version Fedora3.
--grow
Tells the partition to grow to fill available space (if any), or up to the maximum size setting. Note that --grow is not supported for partitions containing a RAID volume on top of them.
Added in version Fedora3.
--maxsize MAXSIZEMB
The maximum size in MiB the partition may grow to. Specify an integer value here, and do not append any units. This option is only relevant if --grow is specified as well.
Added in version Fedora3.
--noformat
Tells the installation program not to format the partition, for use with the --onpart command.
Added in version Fedora3.
--onbiosdisk ONBIOSDISK
Forces the partition to be created on a particular disk as discovered by the BIOS.
Added in version Fedora3.
--ondisk DISK, --ondrive DISK
Forces the partition to be created on a particular disk.
Added in version Fedora3.
--onpart ONPART, --usepart ONPART
Put the partition on an already existing device. Use --onpart=LABEL=name or --onpart=UUID=name to specify a partition by label or uuid respectively.
Anaconda may create partitions in any particular order, so it is safer to use labels than absolute partition names.
Added in version Fedora3.
--recommended
Determine the size of the partition automatically.
Added in version Fedora3.
--size SIZE
The minimum partition size in MiB. Specify an integer value here and do not append any units.
Added in version Fedora3.
--fsoptions FSOPTS
Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the /etc/fstab file of the installed system and should be enclosed in quotes.
Added in version Fedora4.
--label LABEL
Specify the label to give to the filesystem to be made on the partition. If the given label is already in use by another filesystem, a new label will be created for this partition.
Added in version Fedora4.
--bytes-per-inode BYTES_PER_INODE
Specify the bytes/inode ratio.
Added in version Fedora4.
Deprecated since version Fedora9.
Removed in version Fedora14.
--fsprofile FSPROFILE
Specifies a usage type to be passed to the program that makes a filesystem on this partition. A usage type defines a variety of tuning parameters to be used when making a filesystem. For this option to work, the filesystem must support the concept of usage types and there must be a configuration file that lists valid types. For ext2/3/4, this configuration file is /etc/mke2fs.conf.
Added in version Fedora9.
--encrypted
Specify that this partition should be encrypted.
Added in version Fedora9.
--passphrase PASSPHRASE
Specify the passphrase to use when encrypting this partition. Without the above –encrypted option, this option does nothing. If no passphrase is specified, the default system-wide one is used, or the installer will stop and prompt if there is no default.
Added in version Fedora9.
--start START
REMOVED
Added in version Fedora3.
Deprecated since version Fedora11.
Removed in version Fedora14.
--end END
REMOVED
Added in version Fedora3.
Deprecated since version Fedora11.
Removed in version Fedora14.
--escrowcert
Load an X.509 certificate from . Store the data encryption key of this partition, encrypted using the certificate, as a file in /root. Only relevant if --encrypted is specified as well.
Added in version Fedora12.
--backuppassphrase
Only relevant if --escrowcert is specified as well. In addition to storing the data encryption key, generate a random passphrase and add it to this partition. Then store the passphrase, encrypted using the certificate specified by --escrowcert, as a file in /root. If more than one LUKS volume uses --backuppassphrase, the same passphrase will be used for all such volumes.
Added in version Fedora12.
--resize
Attempt to resize this partition to the size given by --size=. This option must be used with --onpart --size=, or an error will be raised.
Added in version Fedora17.
--hibernation
This option can be used to automatically determine the size of the swap partition big enough for hibernation.
Added in version Fedora18.
--cipher CIPHER
Only relevant if --encrypted is specified. Specifies which encryption algorithm should be used to encrypt the filesystem.
Added in version Fedora18.
--mkfsoptions MKFSOPTS
Specifies additional parameters to be passed to the program that makes a filesystem on this partition. This is similar to --fsprofile but works for all filesystems, not just the ones that support the profile concept. No processing is done on the list of arguments, so they must be supplied in a format that can be passed directly to the mkfs program. This means multiple options should be comma-separated or surrounded by double quotes, depending on the filesystem.
Added in version Fedora23.
--active
Set partition as active
Added in version Fedora3.
Deprecated since version Fedora29.
Removed in version Fedora34.
--luks-version LUKS_VERSION
Only relevant if --encrypted is specified. Specifies which version of LUKS format should be used to encrypt the filesystem.
Added in version Fedora29.
--pbkdf PBKDF
Only relevant if --encrypted is specified. Sets Password-Based Key Derivation Function (PBKDF) algorithm for LUKS keyslot. See man cryptsetup.
Added in version Fedora29.
--pbkdf-memory PBKDF_MEMORY
Only relevant if --encrypted is specified. Sets the memory cost for PBKDF. See man cryptsetup.
Added in version Fedora29.
--pbkdf-time PBKDF_TIME
Only relevant if --encrypted is specified. Sets the number of milliseconds to spend with PBKDF passphrase processing. See --iter-time in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
--pbkdf-iterations PBKDF_ITERATIONS
Only relevant if --encrypted is specified. Sets the number of iterations directly and avoids PBKDF benchmark. See --pbkdf-force-iterations in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
--hw-passphrase HW_PASSPHRASE
Only relevant if --encrypted is specified and --luks-version is set to either luks2-hw-opal or luks2-hw-opal-only.
OPAL administrator passphrase needed to create a new OPAL locking range.
Added in version Fedora41.
If partitioning fails for any reason, diagnostic messages will appear on virtual console 3.
raid
raid --device DEVICE [--fstype FSTYPE] [--level LEVEL] [--noformat]
[--spares SPARES] [--useexisting] [--fsoptions FSOPTS]
[--fsprofile FSPROFILE] [--encrypted] [--passphrase PASSPHRASE]
[--escrowcert ] [--backuppassphrase] [--label LABEL]
[--cipher CIPHER] [--mkfsoptions MKFSOPTS] [--chunksize CHUNK_SIZE]
[--luks-version LUKS_VERSION] [--pbkdf PBKDF]
[--pbkdf-memory PBKDF_MEMORY] [--pbkdf-time PBKDF_TIME]
[--pbkdf-iterations PBKDF_ITERATIONS]
[<partitions*> ...]
Added in version Fedora3.
Assembles a software RAID device.
Note raid cannot be used with the following commands: autopart, mount
positional arguments:
Location where the RAID file system is mounted. If it is /, the RAID level must be 1 unless a boot partition (/boot) is present. If a boot partition is present, the /boot partition must be level 1 and the root (/) partition can be any of the available types.
Added in version Fedora3.
<partitions*>
The software raid partitions lists the RAID identifiers to add to the RAID array.
Added in version Fedora3.
options:
--device DEVICE
Name of the RAID device to use (such as ‘fedora-root’ or ‘home’). As of Fedora 19, RAID devices are no longer referred to by names like ‘md0’. If you have an old (v0.90 metadata) array that you cannot assign a name to, you can specify the array by a filesystem label or UUID (eg: –device=LABEL=fedora-root).
Added in version Fedora3.
--fstype FSTYPE
Sets the file system type for the RAID array. Valid values include ext4, ext3, ext2, btrfs, swap, and vfat. Other filesystems may be valid depending on command line arguments passed to anaconda to enable other filesystems.
Added in version Fedora3.
--level LEVEL
RAID level to use {‘RAID5’, ‘RAID10’, ‘RAID6’, ‘RAID0’, ‘RAID4’, ‘RAID1’}.
Added in version Fedora3.
Changed in version Fedora7.
The “RAID10” level was added.
Changed in version Fedora13.
The “RAID4” level was added.
--noformat
Use an existing RAID device and do not format the RAID array.
Added in version Fedora3.
--spares SPARES
Specifies the number of spare drives allocated for the RAID array. Spare drives are used to rebuild the array in case of drive failure.
Added in version Fedora3.
--useexisting
Use an existing RAID device and reformat it.
Added in version Fedora3.
--fsoptions FSOPTS
Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the /etc/fstab file of the installed system and should be enclosed in quotes.
Added in version Fedora4.
--bytes-per-inode BYTES_PER_INODE
Specify the bytes/inode ratio.
Added in version Fedora5.
Deprecated since version Fedora9.
Removed in version Fedora14.
--fsprofile FSPROFILE
Specifies a usage type to be passed to the program that makes a filesystem on this partition. A usage type defines a variety of tuning parameters to be used when making a filesystem. For this option to work, the filesystem must support the concept of usage types and there must be a configuration file that lists valid types. For ext2/3/4, this configuration file is /etc/mke2fs.conf.
Added in version Fedora9.
--encrypted
Specify that this RAID device should be encrypted.
Added in version Fedora9.
--passphrase PASSPHRASE
Specify the passphrase to use when encrypting this RAID device. Without the above –encrypted option, this option does nothing. If no passphrase is specified, the default system-wide one is used, or the installer will stop and prompt if there is no default.
Added in version Fedora9.
--escrowcert
Load an X.509 certificate from . Store the data encryption key of this partition, encrypted using the certificate, as a file in /root. Only relevant if --encrypted is specified as well.
Added in version Fedora12.
--backuppassphrase
Only relevant if --escrowcert is specified as well. In addition to storing the data encryption key, generate a random passphrase and add it to this partition. Then store the passphrase, encrypted using the certificate specified by --escrowcert, as a file in /root. If more than one LUKS volume uses --backuppassphrase, the same passphrase will be used for all such volumes.
Added in version Fedora12.
--label LABEL
Specify the label to give to the filesystem to be made. If the given label is already in use by another filesystem, a new label will be created.
Added in version Fedora15.
--cipher CIPHER
Only relevant if --encrypted is specified. Specifies which encryption algorithm should be used to encrypt the filesystem.
Added in version Fedora18.
--mkfsoptions MKFSOPTS
Specifies additional parameters to be passed to the program that makes a filesystem on this partition. No processing is done on the list of arguments, so they must be supplied in a format that can be passed directly to the mkfs program. This means multiple options should be comma-separated or surrounded by double quotes, depending on the filesystem.
Added in version Fedora23.
--chunksize CHUNK_SIZE
Specify the chunk size (in KiB) for this RAID array.
Added in version Fedora25.
--luks-version LUKS_VERSION
Only relevant if --encrypted is specified. Specifies which version of LUKS format should be used to encrypt the filesystem.
Added in version Fedora29.
--pbkdf PBKDF
Only relevant if --encrypted is specified. Sets Password-Based Key Derivation Function (PBKDF) algorithm for LUKS keyslot. See man cryptsetup.
Added in version Fedora29.
--pbkdf-memory PBKDF_MEMORY
Only relevant if --encrypted is specified. Sets the memory cost for PBKDF. See man cryptsetup.
Added in version Fedora29.
--pbkdf-time PBKDF_TIME
Only relevant if --encrypted is specified. Sets the number of milliseconds to spend with PBKDF passphrase processing. See --iter-time in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
--pbkdf-iterations PBKDF_ITERATIONS
Only relevant if --encrypted is specified. Sets the number of iterations directly and avoids PBKDF benchmark. See --pbkdf-force-iterations in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
The following example shows how to create a RAID level 1 partition for /, and a RAID level 5 for /usr, assuming there are three disks on the system. It also creates three swap partitions, one on each drive:
part raid.01 --size=6000 --ondisk=sda
part raid.02 --size=6000 --ondisk=sdb
part raid.03 --size=6000 --ondisk=sdc
part swap1 --size=512 --ondisk=sda
part swap2 --size=512 --ondisk=sdb
part swap3 --size=512 --ondisk=sdc
part raid.11 --size=6000 --ondisk=sda
part raid.12 --size=6000 --ondisk=sdb
part raid.13 --size=6000 --ondisk=sdc
raid / --level=1 --device=md0 raid.01 raid.02 raid.03
raid /usr --level=5 --device=md1 raid.11 raid.12 raid.13
rdp
rdp [--username USERNAME] [--password PASSWORD]
Added in version Fedora43.
Allows the graphical installation to be viewed remotely via RDP (Remote Desktop Protocol). This method is usually preferred over text mode, as there are some size and language limitations in text installs. With no options, this command will enable RDP mode in Anaconda and wait for user to locally set username and password.
options:
--username USERNAME
Set a username which must be provided to connect by the RDP client.
Added in version Fedora43.
--password PASSWORD
Set a password which must be provided to connect by the RDP client.
Added in version Fedora43.
realm join
realm join [options]
Added in version Fedora19.
Define an Active Directory realm to join
positional arguments:
[options]
See man realm join section.
Added in version Fedora19.
repo
repo --name NAME [--baseurl BASEURL] [--mirrorlist MIRRORLIST] [--cost COST]
[--excludepkgs EXCLUDEPKGS] [--includepkgs INCLUDEPKGS] [--proxy PROXY]
[--noverifyssl] [--install] [--metalink METALINK] [--sslcacert SSLCACERT]
[--sslclientcert SSLCLIENTCERT] [--sslclientkey SSLCLIENTKEY]
Added in version Fedora6.
Configures additional yum repositories that may be used as sources for package installation. Multiple repo lines may be specified. By default, anaconda has a configured set of repos taken from /etc/anaconda.repos.d plus a special Installation Repo in the case of a media install. The exact set of repos in this directory changes from release to release and cannot be listed here. There will likely always be a repo named “updates”.
Note: If you want to enable one of the repos in /etc/anaconda.repos.d that is disabled by default (like “updates”), you should use –name= but none of the other options. anaconda will look for a repo by this name automatically. Providing a baseurl or mirrorlist URL will result in anaconda attempting to add another repo by the same name, which will cause a conflicting repo error.
options:
--name NAME
The repo id. This option is required. The RepoId must not contain spaces (do not confuse with the optional name used by yum). If a repo has a name that conflicts with a previously added one, the new repo will be ignored. Because anaconda has a populated list of repos when it starts, this means that users cannot create new repos that override these names. Please check /etc/anaconda.repos.d from the operating system you wish to install to see what names are not available.
Added in version Fedora6.
--baseurl BASEURL
The URL for the repository. The variables that may be used in yum repo config files are not supported here. You may use one of either this option or --mirrorlist, not both. If an NFS repository is specified, it should be of the form nfs://host:/path/to/repo. Note that there is a colon after the host. Anaconda passes everything after “nfs:// “ directly to the mount command instead of parsing URLs according to RFC 2224. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora6.
Changed in version Fedora15.
--mirrorlist and --baseurl are not required anymore!
Changed in version Fedora27.
Another mutually exclusive option --metalink was added.
--mirrorlist MIRRORLIST
The URL pointing at a list of mirrors for the repository. The variables that may be used in yum repo config files are not supported here. You may use one of either this option or --baseurl, not both. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora6.
Changed in version Fedora15.
--mirrorlist and --baseurl are not required anymore!
Changed in version Fedora27.
Another mutually exclusive option --metalink was added.
--cost COST
An integer value to assign a cost to this repository. If multiple repositories provide the same packages, this number will be used to prioritize which repository will be used before another. Repositories with a lower cost take priority over repositories with higher cost.
Added in version Fedora8.
--excludepkgs EXCLUDEPKGS
A comma-separated list of package names and globs that must not be fetched from this repository. This is useful if multiple repositories provide the same package and you want to make sure it is not fetched from a particular repository during installation.
Added in version Fedora8.
--includepkgs INCLUDEPKGS
A comma-separated list of package names and globs that can be pulled from this repository. Any other packages provided by the repository not on this list will be ignored. This is useful if you want to install just a single package or set of packages from a repository while including all other packages the repository provides.
Added in version Fedora8.
--proxy PROXY
Specify an HTTP/HTTPS/FTP proxy to use just for this repository. This setting does not affect any other repositories, nor how the install.img is fetched on HTTP installs. The various parts of the argument act like you would expect. The syntax is:
``--proxy=[protocol://][username[:password]@]host[:port]``
Added in version Fedora13.
--noverifyssl
For a https repo do not check the server’s certificate with what well-known CA validate and do not check the server’s hostname matches the certificate’s domain name.
Added in version Fedora14.
--install
Install this repository to the target system so that it can be used after reboot.
Added in version Fedora21.
--metalink METALINK
The URL pointing at a metalink for the repository. The variables that may be used in yum repo config files are not supported here. You may use only one of the --baseurl, --mirrorlist, or --metalink options. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora27.
--sslcacert SSLCACERT
Path to the file holding one or more SSL certificates to verify the repository host with.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
--sslclientcert SSLCLIENTCERT
Path to the SSL client certificate (PEM file) which should be used to connect to the repository.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
--sslclientkey SSLCLIENTKEY
Path to the private key file associated with the client certificate given with –sslclientcert.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
--ignoregroups IGNOREGROUPS
This option is used when composing installation trees and has no effect on the installation process itself. It tells the compose tools to not look at the package group information when mirroring trees so as to avoid mirroring large amounts of unnecessary data.
Added in version Fedora11.
Deprecated since version Fedora33.
Removed in version Fedora40.
reqpart
reqpart [--add-boot]
Added in version Fedora23.
Automatically create partitions required by your hardware platform. These include a /boot/efi for x86_64 and Aarch64 systems with UEFI firmware, biosboot for x86_64 systems with BIOS firmware and GPT, and PRePBoot for IBM Power Systems.
Note: This command can not be used together with autopart, because autopart does the same and creates other partitions or logical volumes such as / and swap on top. In contrast with autopart, this command only creates platform-specific partitions and leaves the rest of the drive empty, allowing you to create a custom layout.
Note reqpart cannot be used with the following commands: autopart, mount
options:
--add-boot
Create a separate /boot partition in addition to the platform-specific partition created by the base command.
Added in version Fedora23.
rescue
rescue [--nomount] [--romount]
Added in version Fedora10.
Automatically enter the installer’s rescue mode. This gives you a chance to repair the system should something catastrophic happen.
options:
--nomount
Don’t mount the installed system.
Added in version Fedora10.
--romount
Mount the installed system in read-only mode.
Added in version Fedora10.
By default, the installer will find your system and mount it in read-write mode, telling you where it has performed this mount. You may optionally choose to not mount anything or mount in read-only mode. Only one of these two options may be given at any one time.
rootpw
rootpw [--iscrypted] [--lock] [--plaintext] [--allow-ssh] []
Added in version Fedora3.
This required command sets the system’s root password.
positional arguments:
The desired root password.
Added in version Fedora3.
options:
--iscrypted
If this is present, the password argument is assumed to already be encrypted. To create an encrypted password you can use python:
``python -c 'import crypt; print(crypt.crypt("My Password", "$6$My Salt"))'``
This will generate sha512 crypt of your password using your provided salt.
Added in version Fedora3.
--lock
If this is present, the root account is locked by default. That is, the root user will not be able to login from the console. When this option is present the argument is not required.
Added in version Fedora8.
--plaintext
The password argument is assumed to not be encrypted. This is the default!
Added in version Fedora8.
--allow-ssh
This will allow remote root logins via ssh using only the password. Only use as a last resort.
Added in version Fedora37.
selinux
selinux [--disabled] [--enforcing] [--permissive]
Added in version Fedora3.
Sets the state of SELinux on the installed system. SELinux defaults to enforcing in anaconda.
options:
--disabled
If this is present, SELinux is disabled.
Added in version Fedora3.
--enforcing
If this is present, SELinux is set to enforcing mode.
Added in version Fedora3.
--permissive
If this is present, SELinux is enabled, but only logs things that would be denied in enforcing mode.
Added in version Fedora3.
Only one of --disabled, --enabled or --permissive must be specified!
services
services [--disabled ] [--enabled ]
Added in version Fedora6.
Modifies the default set of services that will run under the default runlevel. The services listed in the disabled list will be disabled before the services listed in the enabled list are enabled.
options:
--disabled
Disable the services given in the comma separated list.
Added in version Fedora6.
--enabled
Enable the services given in the comma separated list.
Added in version Fedora6.
One of --disabled or --enabled must be provided.
skipx
skipx
Added in version Fedora3.
If present, X is not configured on the installed system.
snapshot
snapshot --name --when <post-install|pre-install>
<originVG/originLV>
Added in version Fedora26.
Create an LVM snapshot for devices on an LVM thin pool.
positional arguments:
<originVG/originLV>
Origin of the snapshot. The origin is specified as /.
Added in version Fedora26.
options:
--name
Name of the newly created snapshot.
Added in version Fedora26.
--when <post-install|pre-install>
You can specify two possible values: pre-install and post-install. When the pre-install value is used the snapshot is created before the installation but after the %pre section is run. When the post-install value is used the snapshot is created after the installation is done and after the %post section is run.
Added in version Fedora26.
sshkey
sshkey --username "ssh key"
Added in version Fedora22.
This installs a ssh key to the authorized_keys file of the specified user on the installed system.
positional arguments:
"ssh key"
The content of the ssh key to install.
Added in version Fedora22.
options:
--username
User for which to install the specified key. This option is required.
Added in version Fedora22.
Note that the key should be quoted, if it contains spaces and the user should exist (or be root) either via creation by a package install or the kickstart user command.
sshpw
sshpw --username [--iscrypted] [--plaintext] [--lock] [--sshkey]
[ ...]
Added in version Fedora13.
The installer can start up ssh to provide for interactivity and inspection, just like it can with telnet. The “inst.sshd” option must be specified on the kernel command-line for Anaconda to start an ssh daemon. The sshpw command is used to control the accounts created in the installation environment that may be remotely logged into. For each instance of this command given, a user will be created. These users will not be created on the final system - they only exist for use while the installer is running.
Note that by default, root has a blank password. If you don’t want any user to be able to ssh in and have full access to your hardware, you must specify sshpw for username root. Also note that if Anaconda fails to parse the kickstart file, it will allow anyone to login as root and have full access to your hardware.
positional arguments:
The password string to use.
Added in version Fedora13.
options:
--username
Provides the name of the user. This option is required.
Added in version Fedora13.
--iscrypted
If this is present, the password argument is assumed to already be encrypted.
Added in version Fedora13.
--plaintext
If this is present, the password argument is assumed to not be encrypted. This is the default.
Added in version Fedora13.
--lock
If this is present, the new user account is locked by default. That is, the user will not be able to login from the console.
Added in version Fedora13.
--sshkey
If this is used then the string is interpreted as an ssh key value.
Added in version Fedora24.
timesource
timesource [--ntp-server NTP_SERVER] [--ntp-pool NTP_POOL] [--ntp-disable]
[--nts]
Added in version Fedora33.
Configures a timesource.
options:
--ntp-server NTP_SERVER
A single NTP server.
--ntp-server, --ntp-pool and --ntp-disable are mutually exclusive.
Added in version Fedora33.
--ntp-pool NTP_POOL
A single NTP pool.
--ntp-pool, --ntp-server and --ntp-disable are mutually exclusive.
Added in version Fedora33.
--ntp-disable
If specified, disable any NTP based time sync, both on target system as well as in installation environment.
Added in version Fedora33.
--nts
If specified, consider the provided hostname to be a NTS compatible time source. Without the --nts option it will be considered to be a plain NTP time source without NTS support.
Added in version Fedora33.
timezone
timezone [--utc] [--isUtc] [--nontp]
[--ntpservers ,,...,]
[ ...]
Added in version Fedora3.
This required command sets the system time zone to which may be any of the time zones listed by timeconfig.
positional arguments:
Timezone name, e.g. Europe/Sofia. This is optional but at least one of the options needs to be used if no timezone is specified.
Added in version Fedora3.
options:
--utc
If present, the system assumes the hardware clock is set to UTC (Greenwich Mean) time.
To get the list of supported timezones, you can either run this script: http://vpodzime.fedorapeople.org/timezones_list.py or look at this list: http://vpodzime.fedorapeople.org/timezones_list.txt
Added in version Fedora6.
--isUtc
This is an alias for the --utc option.
Added in version Fedora6.
Deprecated since version Fedora40.
--nontp
Disable automatic starting of NTP service.
--nontp and --ntpservers are mutually exclusive.
Added in version Fedora18.
Deprecated since version Fedora40.
--ntpservers ,,...,
Specify a list of NTP servers to be used (comma-separated list with no spaces). The chrony package is automatically installed when this option is used. If you don’t want the package to be automatically installed then use -chrony in package selection. For example:
timezone –ntpservers=ntp.cesnet.cz,tik.nic.cz Europe/Prague
Added in version Fedora18.
Deprecated since version Fedora40.
updates
updates [URL]
Added in version Fedora7.
Specify the location of an updates.img for use in installation.
positional arguments:
[URL]
If present, the URL for an updates image.
If not present, anaconda will attempt to load from a floppy disk.
Added in version Fedora7.
Changed in version Fedora34.
The URL for an updates image is required. Anaconda no longer supports updates on a floppy disk.
install or upgrade
install|upgrade [--root-device ROOT_DEVICE]
Added in version Fedora3.
Install a fresh system or upgrade an existing system. Install is the default mode. For installation, you must specify the type of installation from one of cdrom, harddrive, nfs, or url (for ftp or http installations). The install command and the installation method command must be on separate lines.
Deprecated since version Fedora20.
Starting with F18, upgrades are no longer supported in anaconda and should be done with FedUp, the Fedora update tool. Starting with F21, the DNF system-upgrade plugin is recommended instead. Therefore, the upgrade command essentially does nothing.
Removed in version Fedora29.
options:
--root-device ROOT_DEVICE
On a system with multiple installs, this option specifies which filesystem holds the installation to be upgraded. This can be specified by device name, UUID=, or LABEL= just like the harddrive command may be.
Added in version Fedora11.
url
url [--proxy URL] [--noverifyssl] [--mirrorlist URL] [--url URL]
[--metalink URL] [--sslcacert SSLCACERT] [--sslclientcert SSLCLIENTCERT]
[--sslclientkey SSLCLIENTKEY]
Added in version Fedora3.
Install from an installation tree on a remote server via FTP or HTTP.
options:
--proxy URL
Specify an HTTP/HTTPS/FTP proxy to use while performing the install. The various parts of the argument act like you would expect. The syntax is:
[protocol://][username[:password]@]host[:port]
Added in version Fedora13.
--noverifyssl
For a tree on a HTTPS server do not check the server’s certificate with what well-known CA validate and do not check the server’s hostname matches the certificate’s domain name.
Added in version Fedora14.
--mirrorlist URL
The mirrorlist URL to install from. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora18.
--url URL
The URL to install from. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora3.
Changed in version Fedora18.
Only one of the –url or –mirrorlist can be specified.
Changed in version Fedora27.
Only one of the –url, –mirrorlist or –metalink can be specified.
--metalink URL
The metalink URL to install from. Variable substitution is done for $releasever and $basearch in the url.
Added in version Fedora27.
--sslcacert SSLCACERT
Path to the file holding one or more SSL certificates to verify the repository host with.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
--sslclientcert SSLCLIENTCERT
Path to the SSL client certificate (PEM file) which should be used to connect to the repository.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
--sslclientkey SSLCLIENTKEY
Path to the private key file associated with the client certificate given with –sslclientcert.
Note Usage of this parameter is discouraged. It is designed for a specific image building tool use and there are plans for a replacement.
Added in version Fedora30.
user
user [--homedir HOMEDIR] [--iscrypted] --name NAME [--password PASSWORD]
[--shell SHELL] [--uid INT] [--lock] [--plaintext] [--gecos GECOS]
[--gid INT] [--groups GROUPS]
Added in version Fedora6.
Creates a new user on the system.
options:
--homedir HOMEDIR
The home directory for the user. If not provided, this defaults to /home/.
Added in version Fedora6.
--iscrypted
If specified, consider the password provided by --password already encrypted. This is the default.
Added in version Fedora6.
--name NAME
Provides the name of the user. This option is required.
Added in version Fedora6.
--password PASSWORD
The new user’s password. If not provided, the account will be locked by default. If this is present, the password argument is assumed to already be encrypted. --plaintext has the opposite effect - the password argument is assumed to not be encrypted. To create an encrypted password you can use:
mkpasswd -m yescrypt
This will generate a yescrypt hash of your password using a random salt. As a fallback for older distributions or in case mkpasswd is not available you can use:
python -c ‘import crypt; print(crypt.crypt(“My Password”, “$6$MySalt”))’
This will generate a SHA-512 hash of your password using your provided salt.
Added in version Fedora6.
--shell SHELL
The user’s login shell. If not provided, this defaults to the system default.
Added in version Fedora6.
--uid INT
The user’s UID. If not provided, this defaults to the next available non-system UID.
Added in version Fedora6.
--lock
If this is present, the new user account is locked by default. That is, the user will not be able to login from the console.
Added in version Fedora8.
--plaintext
If specified, consider the password provided by --password to be plain text.
Added in version Fedora8.
--gecos GECOS
Provides the GECOS information for the user. This is a string of various system-specific fields separated by a comma. It is frequently used to specify the user’s full name, office number, and the like. See man 5 passwd for more details.
Added in version Fedora12.
--gid INT
The GID of the user’s primary group. If not provided, this defaults to the next available non-system GID.
Added in version Fedora19.
--groups GROUPS
In addition to the default group, a comma separated list of group names the user should belong to. Any groups that do not already exist will be created. If the group already exists with a different GID, an error will be raised.
Added in version Fedora6.
Changed in version Fedora24.
The group name can optionally be followed by a GID in parenthesis, for example, newgroup(5002).
vnc
vnc [--password PASSWORD] [--host HOST] [--port PORT]
Added in version Fedora3.
Allows the graphical installation to be viewed remotely via VNC. This method is usually preferred over text mode, as there are some size and language limitations in text installs. With no options, this command will start a VNC server on the machine with no password and will print out the command that needs to be run to connect a remote machine. Please use the inst.rdp boot option instead.
Deprecated since version Fedora43.
options:
--password PASSWORD
Set a password which must be provided to connect to the VNC session. This is optional, but recommended.
Added in version Fedora3.
--connect host[:port]
Connect to a remote host instead of starting VNC server locally.
Added in version Fedora3.
Changed in version Fedora6.
Added support for host[:port] syntax.
Removed in version Fedora9.
--host HOST
Instead of starting a VNC server on the install machine, connect to the VNC viewer process listening on the given hostname.
Added in version Fedora6.
--port PORT
Provide a port that the remote VNC viewer process is listening on. If not provided, anaconda will use the VNC default.
Added in version Fedora6.
volgroup
volgroup [--noformat] [--useexisting] [--reserved-space RESERVED_SPACE]
[--reserved-percent RESERVED_PERCENT] [--pesize PESIZE]
[ ...] [<partitions*> ...]
Added in version Fedora3.
Creates a Logical Volume Management (LVM) group.
Note volgroup cannot be used with the following commands: autopart, mount
positional arguments:
Name given to the volume group. The (which denotes that multiple partitions can be listed) lists the identifiers to add to the volume group.
Added in version Fedora3.
<partitions*>
Physical Volume partitions to be included in this Volume Group
Added in version Fedora3.
options:
--noformat
Use an existing volume group. Do not specify partitions when using this option.
Added in version Fedora3.
--useexisting
Use an existing volume group. Do not specify partitions when using this option.
Added in version Fedora3.
--reserved-space RESERVED_SPACE
Specify an amount of space to leave unused in a volume group, in MiB. Do not append any units. This option is only used for new volume groups.
Added in version Fedora16.
--reserved-percent RESERVED_PERCENT
Specify a percentage of total volume group space to leave unused (new volume groups only).
Added in version Fedora16.
--pesize PESIZE
Set the size of the physical extents in KiB.
Added in version Fedora3.
Changed in version Fedora21.
Set the size of the physical extents in KiB.
Create the partition first, create the logical volume group, and then create the logical volume. For example:
part pv.01 --size 3000
volgroup myvg pv.01
logvol / --vgname=myvg --size=2000 --name=rootvol
xconfig
xconfig [--defaultdesktop GNOME|KDE] [--startxonboot]
Added in version Fedora3.
Configures the X Window System. If this option is not given, Anaconda will use X and attempt to automatically configure. Please try this before manually configuring your system.
options:
--defaultdesktop GNOME|KDE
Specify either GNOME or KDE to set the default desktop (assumes that GNOME Desktop Environment and/or KDE Desktop Environment has been installed through %packages).
Added in version Fedora3.
--server SERVER
REMOVED
Added in version Fedora3.
Removed in version Fedora6.
--startxonboot
Use a graphical login on the installed system.
Added in version Fedora3.
--card CARD
REMOVED
Added in version Fedora3.
Deprecated since version Fedora6.
Removed in version Fedora9.
--hsync HSYNC
REMOVED
Added in version Fedora3.
Deprecated since version Fedora6.
Removed in version Fedora9.
--monitor MONITOR
REMOVED
Added in version Fedora3.
Deprecated since version Fedora6.
Removed in version Fedora9.
--noprobe NOPROBE
REMOVED
Added in version Fedora3.
Deprecated since version Fedora6.
Removed in version Fedora9.
--vsync VSYNC
REMOVED
Added in version Fedora3.
Deprecated since version Fedora6.
Removed in version Fedora9.
--driver DRIVER
REMOVED
Added in version Fedora6.
Deprecated since version Fedora10.
Removed in version Fedora14.
--depth DEPTH
REMOVED
Added in version Fedora3.
Deprecated since version Fedora10.
Removed in version Fedora14.
--resolution RESOLUTION
REMOVED
Added in version Fedora3.
Deprecated since version Fedora10.
Removed in version Fedora14.
--videoram VIDEORAM
REMOVED
Added in version Fedora3.
Deprecated since version Fedora10.
Removed in version Fedora14.
zerombr
zerombr
Added in version Fedora3.
If zerombr is specified, any disks whose formatting is unrecognized are initialized. This will destroy all of the contents of disks with invalid partition tables or other formatting unrecognizable to the installer. It is useful so that the installation program does not ask if it should initialize the disk label if installing to a brand new hard drive.
zfcp
zfcp --devnum DEVNUM [--wwpn WWPN] [--fcplun FCPLUN]
Added in version Fedora3.
Define a Fibre channel device. This option only applies on IBM System z.
Changed in version Fedora37.
It is sufficient to specify an FCP device bus ID if automatic LUN scanning is available. Otherwise all three parameters are required.
zfcp --devnum= [--wwpn= --fcplun=]
Automatic LUN scanning is available for FCP devices operating in NPIV mode if it is not disabled through the zfcp.allow_lun_scan module parameter (enabled by default). It provides access to all SCSI devices, that is, WWPNs and FCP LUNs, found in the storage area network attached to the FCP device with the specified bus ID.
options:
--devnum DEVNUM
The device number (zFCP adaptor device bus ID).
Added in version Fedora3.
--scsiid SCSIID
SCSI ID
Added in version Fedora3.
Deprecated since version Fedora12.
Removed in version Fedora14.
--scsilun SCSILUN
SCSI LUN
Added in version Fedora3.
Deprecated since version Fedora12.
Removed in version Fedora14.
--wwpn WWPN
The device’s World Wide Port Name (WWPN). Takes the form of a 16-digit number, preceded by 0x.
Added in version Fedora3.
Changed in version Fedora37.
The argument is optional.
--fcplun FCPLUN
The device’s Logical Unit Number (LUN). Takes the form of a 16-digit number, preceded by 0x.
Added in version Fedora3.
Changed in version Fedora37.
The argument is optional.
For example:
zfcp --devnum=0.0.6000
zfcp --devnum=0.0.4000 --wwpn=0x5005076300C213e9 --fcplun=0x5022000000000000
zipl
zipl [--secure-boot] [--force-secure-boot] [--no-secure-boot]
Added in version Fedora32.
This command specifies the ZIPL configuration for s390x.
options:
--secure-boot
Enable Secure Boot if supported by the installing machine.
Note When installed on a model newer than IBM z14, the installed system cannot be booted from an IBM z14 and earlier models.
Added in version Fedora32.
--force-secure-boot
Enable Secure Boot unconditionally.
Note Installation will fail on IBM z14 and earlier models.
Added in version Fedora32.
--no-secure-boot
Disable Secure Boot.
Note Secure Boot is not supported on IBM z14 and earlier models, therefore choose ‘–no-secure-boot’ if you intend to boot the installed system on such models.
Added in version Fedora32.
%include
Use the %include /path/to/file or %include command to include the contents of another file in the kickstart file as though the contents were at the location of the %include command in the kickstart file.
Note the semantics of most kickstart commands default to “last keyword wins”, which means that for example if you have a services --enable=foo,bar in one file, and %include that file and use services --enable=baz, only the baz service will be enabled.
The Kickstart documentation usually notes which commands support multiple instances - this is mostly multi-line commands such as %packages and %post. Other exceptions include the user and group commands. Consult individual command documentation for semantics.
%ksappend
The %ksappend url directive is very similar to %include in that it is used to include the contents of additional files as though they were at the location of the %ksappend directive. The difference is in when the two directives are processed. %ksappend is processed in an initial pass, before any other part of the kickstart file. Then, this expanded kickstart file is passed to the rest of anaconda where all %pre scripts are handled, and then finally the rest of the kickstart file is processed in order, which includes %include directives.
Thus, %ksappend provides a way to include a file containing %pre scripts, while %include does not.
Chapter 3. Kickstart Commands in Red Hat Enterprise Linux
The following commands can be placed in a kickstart file. If you prefer to use a graphical interface for creating your kickstart file, you can use the Kickstart Configurator application.
Most commands take arguments. If an argument is followed equals mark (=), a value must be specified after it.
In the example commands, options in ‘’’[square brackets]’’’ are optional arguments for the command.
pykickstart processes arguments to commands just like the shell does:
If a list of arguments can be passed in, the arguments must be separated by
commas and not include any extra spaces. If extra spaces are required in the
list of arguments, the entire argument must be surrounded by double quotes.
If quotes, spaces, or other special characters need to be added to the
arguments list, they must be escaped.
Note Documentation for RHEL 8 commands can be found here
Commands for RHEL 9:
auth or authconfig
auth|authconfig [options]
Added in version Fedora3.
This required command sets up the authentication options for the system. This is just a wrapper around the authconfig program, so all options recognized by that program are valid for this command. See the manual page for authconfig for a complete list.
By default, passwords are normally encrypted and are not shadowed.
Changed in version Fedora28.
The authconfig program is deprecated. This command will use the authconfig compatibility tool, but you should use the authselect command instead.
positional arguments:
[options]
See man authconfig.
Added in version Fedora3.
authselect
authselect [options]
Added in version Fedora28.
This command sets up the authentication options for the system. This is just a wrapper around the authselect program, so all options recognized by that program are valid for this command. See the manual page for authselect for a complete list.
positional arguments:
[options]
See man authselect.
Added in version Fedora28.
autopart
autopart [--encrypted] [--passphrase PASSPHRASE] [--escrowcert ]
[--backuppassphrase] [--nolvm] [--type TYPE] [--cipher CIPHER]
[--fstype FSTYPE] [--nohome] [--noboot] [--noswap]
[--luks-version LUKS_VERSION] [--pbkdf PBKDF]
[--pbkdf-memory PBKDF_MEMORY] [--pbkdf-time PBKDF_TIME]
[--pbkdf-iterations PBKDF_ITERATIONS]
Added in version Fedora3.
Automatically create partitions – a root (/) partition, a swap partition, and an appropriate boot partition for the architecture. On large enough drives, this will also create a /home partition.
Note autopart cannot be used with the following commands: partition, raid, volgroup, logvol, reqpart
options:
--encrypted
Should all devices with support be encrypted by default? This is equivalent to checking the “Encrypt” checkbox on the initial partitioning screen.
Added in version Fedora9.
--passphrase PASSPHRASE
Only relevant if --encrypted is specified. Provide a default system-wide passphrase for all encrypted devices.
Added in version Fedora9.
--escrowcert
Only relevant if --encrypted is specified. Load an X.509 certificate from . Store the data encryption keys of all encrypted volumes created during installation, encrypted using the certificate, as files in /root.
Added in version Fedora12.
--backuppassphrase
Only relevant if --escrowcert is specified. In addition to storing the data encryption keys, generate a random passphrase and add it to all encrypted volumes created during installation. Then store the passphrase, encrypted using the certificate specified by --escrowcert, as files in /root (one file for each encrypted volume).
Added in version Fedora12.
--nolvm
Don’t use LVM when partitioning.
Added in version Fedora16.
Changed in version Fedora17.
The same as --type=plain
--type TYPE
Select automatic partitioning scheme. Must be one of the following: [‘lvm’, ‘btrfs’, ‘plain’, ‘partition’, ‘thinp’]. Plain means regular partitions with no btrfs or lvm.
Added in version Fedora17.
Changed in version Fedora20.
Partitioning scheme ‘thinp’ was added.
Changed in version RedHatEnterpriseLinux8.
Partitioning scheme ‘btrfs’ was removed.
--cipher CIPHER
Only relevant if --encrypted is specified. Specifies which encryption algorithm should be used to encrypt the filesystem.
Added in version Fedora18.
--fstype FSTYPE
Use the specified filesystem type on the partitions. Note that it cannot be used with --type=btrfs since btrfs is both a partition scheme and a filesystem. eg. --fstype=ext4.
Added in version Fedora21.
Changed in version RedHatEnterpriseLinux8.
Partitioning scheme ‘btrfs’ was removed.
--nohome
Do not create a /home partition.
Added in version Fedora26.
--noboot
Do not create a /boot partition.
Added in version Fedora26.
--noswap
Do not create a swap partition. Only one of --noswap and --hibernation can be specified.
Added in version Fedora26.
--luks-version LUKS_VERSION
Only relevant if --encrypted is specified. Specifies which version of LUKS format should be used to encrypt the filesystem.
Added in version Fedora29.
--pbkdf PBKDF
Only relevant if --encrypted is specified. Sets Password-Based Key Derivation Function (PBKDF) algorithm for LUKS keyslot. See man cryptsetup.
Added in version Fedora29.
--pbkdf-memory PBKDF_MEMORY
Only relevant if --encrypted is specified. Sets the memory cost for PBKDF. See man cryptsetup.
Added in version Fedora29.
--pbkdf-time PBKDF_TIME
Only relevant if --encrypted is specified. Sets the number of milliseconds to spend with PBKDF passphrase processing. See --iter-time in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
--pbkdf-iterations PBKDF_ITERATIONS
Only relevant if --encrypted is specified. Sets the number of iterations directly and avoids PBKDF benchmark. See --pbkdf-force-iterations in man cryptsetup.
Only one of --pbkdf-time and --pbkdf-iterations can be specified.
Added in version Fedora29.
autostep
autostep [--autoscreenshot]
Added in version Fedora3.
Kickstart installs normally skip unnecessary screens. This makes the installer step through every screen, displaying each briefly.
This is mostly used for debugging.
Deprecated since version Fedora34.
options:
--autoscreenshot
Take a screenshot at every step during installation and copy the images over to /root/anaconda-screenshots after installation is complete. This is most useful for documentation.
Added in version Fedora3.
bootloader
bootloader [--append APPENDLINE] [--location {mbr,partition,none,boot}]
[--password PASSWORD] [--driveorder DRIVEORDER] [--timeout TIMEOUT]
[--default DEFAULT] [--iscrypted] [--md5pass MD5PASS]
[--boot-drive BOOTDRIVE] [--leavebootorder] [--extlinux]
[--disabled] [--nombr]
Added in version Fedora3.
This required command specifies how the boot loader should be installed.
There must be a biosboot partition for the bootloader to be installed successfully onto a disk that contains a GPT/GUID partition table, which includes disks initialized by anaconda. This partition may be created with the kickstart command part biosboot --fstype=biosboot --size=1. However, in the case that a disk has an existing biosboot partition, adding a part biosboot option is unnecessary.
options:
--append APPENDLINE
Specifies additional kernel parameters. For example:
bootloader --location=mbr --append="hdd=ide-scsi ide=nodma"
Note The installer will add the bootloader arguments rhgb quiet if plymouth is installed on the target system. You can disable these options with -plymouth in the %packages section.
Added in version Fedora3.
--linear
use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
Removed in version Fedora4.
--nolinear
do not use linear mode to access hard disks (for LILO only)
Added in version Fedora3.
Removed in version Fedora4.
--location {mbr,partition,none,boot}
Specifies where the boot record is written. Valid values are the following: mbr (the default), partition (installs the boot loader on the first sector of the partition containing the kernel), or none (do not install the boot loader).
Note bootloader –location=none is different from bootloader –location=none –disabled. –location=none prevents extra installation steps that makes the target machine bootable, e.g. write to MBR on x86 BIOS systems. However, the corresponding RPM packages are still installed, and –disabled can be appended to prevent it. bootloader –disabled only does not prevent the installation of the bootloader and Anaconda will complain if no other options are provided.
Added in version Fedora3.
--password PASSWORD
If using GRUB, sets the GRUB boot loader password. This should be used to restrict access to the GRUB shell, where arbitrary kernel options can be passed.
Added in version Fedora3.
--useLilo
force the use of LILO
Added in version Fedora3.
Removed in version Fedora4.
--driveorder DRIVEORDER
define the explicit hard disk order the boot loader should use
Added in version Fedora3.
--timeout TIMEOUT
Specify the number of seconds before the bootloader times out and boots the default option.
Added in version Fedora8.
--default DEFAULT
Sets the default boot image in the bootloader configuration.
Added in version Fedora8.
--lba32
force the use of LBA32 mode for hard disk access (LILO only)
Added in version Fedora3.
Deprecated since version Fedora12.
Removed in version Fedora14.
--iscrypted
If given, the password specified by --password= is already encrypted and should be passed to the bootloader configuration without additional modification.
Added in version Fedora15.
--md5pass MD5PASS
If using GRUB, similar to --password= except the password should already be encrypted.
Added in version Fedora3.
Changed in version Fedora15.
Alias for --password=MD5PASS --iscrypted.
--boot-drive BOOTDRIVE
Specifies which drive the bootloader should be written to and thus, which drive the computer will boot from.
Added in version Fedora17.
--leavebootorder
On EFI or ISeries/PSeries machines, this option prevents the installer from making changes to the existing list of bootable images.
Added in version Fedora18.
--extlinux
Use the extlinux bootloader instead of GRUB. This option only works on machines that are supported by extlinux.
Added in version Fedora19.
--disabled
Do not install the boot loader.
Note bootloader –location=none is different from bootloader –location=none –disabled. –location=none prevents extra installation steps that makes the target machine bootable, e.g. write to MBR on x86 BIOS systems. However, the corresponding RPM packages are still installed, and –disabled can be appended to prevent it. bootloader –disabled only does not prevent the installation of the bootloader and Anaconda will complain if no other options are provided.
Added in version Fedora21.
--nombr
do not install the boot loader to the MBR
Added in version Fedora21.
--upgrade
upgrade the boot loader installed on disk
Added in version Fedora3.
Deprecated since version Fedora29.
Removed in version Fedora34.
btrfs
btrfs [--noformat] [--useexisting] [--label LABEL] [--data DATALEVEL]
[--metadata METADATALEVEL] [--subvol] [--parent PARENT] [--name NAME]
[--mkfsoptions MKFSOPTS]
Added in version Fedora17.
Defines a BTRFS volume or subvolume. This command is of the form:
btrfs --data= --metadata= --label=