Contents
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 single 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.
Kickstart provides a way for users to automate a Fedora or Red Hat Enterprise Linux installation.
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 editing a copy of the sample.ks file found in the RH-DOCS directory of the Fedora or Red Hat Enterprise Linux Documentation CD, using the Kickstart Configurator application, or 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. Old-style kickstart syntax does not specify for any end token after the %packages section or scripts. In this case, the following section order is required. New-style kickstart syntax requires using %end following these sections, which means that ordering is not required. 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, %post, and %traceback sections -- These sections can be in any order and are not required. Refer to Chapter 4 and Chapter 5 for details.
- 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).
- Lines starting with a pound sign (#) are treated as comments and are ignored.
- If deprecated commands, options, or syntax are used while doing 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.
- For kickstart upgrades, the following items are required:
- Language
- Installation method
- Device specification (if device is needed to perform installation)
- Keyboard setup
- The upgrade keyword
- Boot loader configuration
If any other items are specified for an upgrade, those items will be ignored (note that this includes package selection).
Chapter 2. Kickstart Options
The following options 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.
If the option is followed by an equals mark (=), a value must be specified after it. In the example commands, options in brackets ([]) are optional arguments for the command.
auth or authconfig (required)
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.
autopart (optional)
- Automatically create partitions -- 1 GB or more root (/) partition, a swap partition, and an appropriate boot partition for the architecture. One or more of the default partition sizes can be redefined with the part directive.
--encrypted
- Should all devices with support be encrypted by default? This is equivalent to checking the "Encrypt" checkbox on the initial partitioning screen.
--passphrase=
- Provide a default system-wide passphrase for all encrypted devices.
autostep (optional)
- Similar to interactive except it goes to the next screen for you. It is used mostly for debugging.
--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.
bootloader (required)
- Specifies how the boot loader should be installed. This option is required for both installations and upgrades.
--append=
- Specifies kernel parameters. To specify multiple parameters, separate them with spaces. For example:
bootloader --location=mbr --append="hdd=ide-scsi ide=nodma"
--driveorder
- Specify which drive is first in the BIOS boot order. For example:
bootloader --driveorder=sda,hda
--location=
- 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).
--password=
- If using GRUB, sets the GRUB boot loader password the one specified with this option. This should be used to restrict access to the GRUB shell, where arbitrary kernel options can be passed.
--md5pass=
If using GRUB, similar to --password= except the password should already be encrypted.
--lba32
- Force use of lba32 mode instead of auto-detecting.
--upgrade
- Upgrade the existing boot loader configuration, preserving the old entries. This option is only available for upgrades.
--timeout=<secs>
- Specify the number of seconds before the bootloader times out and boots the default option.
- Specifies kernel parameters. To specify multiple parameters, separate them with spaces. For example:
clearpart (optional)
- 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. --all
- Erases all partitions from the system.
--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 --drives hda,hdb
--initlabel
- Initializes the disk label to the default for your architecture (for example msdos for x86 and gpt for Itanium). 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.
--linux
- Erases all Linux partitions.
--none (default)
- Do not remove any partitions.
cmdline (optional)
- Perform the installation in a completely non-interactive command line mode. Any prompts for interaction will halt the install. This mode is useful on S/390 systems with the x3270 console.
device (optional)
- 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 <moduleName> --opts=<options>
<moduleName>
- Replace with the name of the kernel module which should be installed.
--opts=
- Options to pass to the kernel module. Note that multiple options may be passed if they are put in quotes. For example:
--opts="aic152x=0x340 io=11"
dmraid (optional)
dmraid --name= --dev=
driverdisk (optional)
- Driver diskettes can be used during kickstart installations. You need to copy the driver diskettes'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.
driverdisk <partition>|--source=<url> [--type=<fstype>]
<partition>
- Partition containing the driver disk.
--source=<url>
- Specify a URL for the driver disk. NFS locations can be given
with nfs:host:/path/to/img.
--type=
- File system type (for example, vfat or ext2).
firewall (optional)
- This option corresponds to the Firewall Configuration screen in the installation program:
firewall --enabled|--disabled [--trust=] <device> [--port=]
--enabled or --enable
- 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.
--disabled or --disable
- Do not configure any iptables rules.
--trust=
- 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.
<incoming>
- Replace with none or more of the following to allow the specified services through the firewall.
--ssh
--telnet
--smtp
--http
--ftp
--port=
- You can specify that ports be allowed through the firewall using the port:protocol format. For example, to allow IMAP access through your firewall, specify imap:tcp. Numeric ports can also be specified explicitly; for example, to allow UDP packets on port 1234 through, specify 1234:udp. To specify multiple ports, separate them by commas.
firstboot (optional)
- Determine whether the Setup Agent starts the first time the system is booted. If enabled, the firstboot package must be installed. If not specified, this option is disabled by default.
--enable or --enabled
- The Setup Agent is started the first time the system boots.
--disable or --disabled
- The Setup Agent is not started the first time the system boots.
--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.
graphical (optional)
- Perform the kickstart installation in graphical mode. This is the default.
install (optional)
- Tells the system to install a fresh system rather than upgrade an existing system. This 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.
cdrom
- Install from the first CD-ROM drive on the system.
harddrive
- Install from a Red Hat installation tree on a local drive, which must be either vfat or ext2.
--biospart=
- BIOS partition to install from (such as 82).
--partition=
- Partition to install from (such as, sdb2).
--dir=
Directory containing the RedHat directory of the installation tree.
harddrive --partition=hdb2 --dir=/tmp/install-tree
nfs
- Install from the NFS server specified.
--server=
- Server from which to install (hostname or IP).
--dir=
Directory containing the RedHat directory of the installation tree.
--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.
nfs --server=nfsserver.example.com --dir=/tmp/install-tree
url
- Install from an installation tree on a remote server via FTP or HTTP. For example:
url --url http://<server>/<dir> or:
url --url ftp://<username>:<password>@<server>/<dir>
ignoredisk (optional)
- Used to specify disks that anaconda should not touch when partitioning, formatting, and clearing. This command has a single required argument, which takes a comma-separated list of drive names to ignore.
ignoredisk --drives=[disk1,disk2,...]
interactive (optional)
- Uses the information provided in the kickstart file during the installation, but allow for inspection and modification of the values given. You will be presented with each screen of the installation program with the values from the kickstart file. Either accept the values by clicking Next or change the values and click Next to continue. See also autostep.
iscsi (optional)
iscsi --ipaddr= [options]
--target=
--port=
--user=
--password=
iscsiname (optional)
key (optional)
- Specify a registration key, which is needed to aid in package selection and identify your system for support purposes. This command is RHEL-specific; it has no meaning for Fedora and will be ignored.
--skip
- Skip entering a key. Usually if the key command is not given, anaconda will pause at this step to prompt for a key. This option allows automated installation to continue if you do not have a key or do not want to provide one.
keyboard (required)
- Sets system keyboard type. Here is the list of available keyboards on i386, Itanium, and Alpha machines:
be-latin1, bg, br-abnt2, cf, cz-lat2, cz-us-qwertz, de, de-latin1,
de-latin1-nodeadkeys, dk, dk-latin1, dvorak, es, et, fi, fi-latin1,
fr, fr-latin0, fr-latin1, fr-pc, fr_CH, fr_CH-latin1, gr, hu,
hu101, is-latin1, it, it-ibm, it2, jp106, la-latin1, mk-utf, no,
no-latin1, pl, pt-latin1, ro_win, ru, ru-cp1251, ru-ms, ru1, ru2,
ru_win, se-latin1, sg, sg-latin1, sk-qwerty, slovene, speakup,
speakup-lt, sv-latin1, sg, sg-latin1, sk-querty, slovene, trq, ua,
uk, us, us-acentos
- The file /usr/lib/python?.?/site-packages/rhpl/keyboard_models.py also contains this list and is part of the rhpl package.
lang (required)
lang <id> Sets the language to use during installation and the default
language to use on the installed system to <id>. 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.
logvol (optional)
- Create a logical volume for Logical Volume Management (LVM).
logvol <mntpoint> --vgname=<name> --size=<size> --name=<name> <options>
--noformat
- Use an existing logical volume and do not format it.
--useexisting
- Use an existing logical volume and reformat it.
--fstype=
- Sets the file system type for the logical volume. Valid values are ext2, ext3, swap, and vfat.
--fsoptions=
- 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.
--grow
- Tells the logical volume to grow to fill available space (if any), or up to the maximum size setting.
--maxsize=
- The maximum size in megabytes when the logical volume is set to grow. Specify an integer value here, and do not append the number with MB.
--recommended
- Determine the size of the logical volume automatically.
--percent
- Specify the size of the logical volume as a percentage of available space in the volume group.
part pv.01 --size 3000
volgroup myvg pv.01
logvol / --vgname=myvg --size=2000 --name=rootvol
logging (optional)
- This command controls the error logging of anaconda during installation. It has no effect on the installed system.
--host=
- Send logging information to the given remote host, which must be running a syslogd process configured to accept remote logging.
--port=
- If the remote syslogd process uses a port other than the default, it may be specified with this option.
--level=
- One of debug, info, warning, error, or critical. 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.
mediacheck (optional)
- 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.
monitor (optional)
- 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.
--hsync=
- Specifies the horizontal sync frequency of the 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.
--noprobe
- Do not probe the monitor.
--vsync=
- Specifies the vertical sync frequency of the monitor.
multipath (optional)
multipath --name= --device= --rule=
network (optional)
- Configures network information for the system. If the kickstart installation does not require networking (in other words, it is not installed over NFS, HTTP, or FTP), networking is not configured for the system. If the installation does require networking and network information is not provided in the kickstart file, the installation program assumes that the installation should be done over eth0 via a dynamic IP address (BOOTP/DHCP), and configures the final, installed system to determine its IP address dynamically. The network option configures networking information for kickstart installations via a network as well as for the installed system.
--bootproto=[dhcp|bootp|static|query]
- The default setting is dhcp. bootp and dhcp are treated the same. The DHCP method uses a DHCP server system to obtain its networking configuration. As you might guess, the BOOTP method is similar, requiring a BOOTP server to supply the networking configuration. The query method stops the installer during the first stage for you to enter the network settings by hand, and then again during the second stage for the same information. Don't use this method unless you need your kickstart installation stopped for manual intervention. The static method requires that you enter all the required networking information in the kickstart file. As the name implies, this information is static and will be used during and after the installation. The line for static networking is more complex, as you must include all network configuration information on one line. You must specify the IP address, netmask, gateway, and nameserver. For example: (the \ indicates that it is all one line):
network --bootproto=static --ip=10.0.2.15 \
--netmask=255.255.255.0 --gateway=10.0.2.254 \
--nameserver=10.0.2.1
- If you use the static method, be aware of the following two restrictions:
- All static networking configuration information must be specified on one line; you cannot wrap lines using a backslash, for example.
- You can only specify one nameserver here. However, you can use the kickstart file's %post section (described in Chapter 5) to add more name servers, if needed.
--device=
- Used to select a specific Ethernet device for installation.
Note that using --device= will not be effective unless the kickstart file is a local file (such as ks=floppy), since the installation program will configure the network to find the kickstart file. For example:
network --bootproto=dhcp --device=eth0
--ip=
- IP address for the interface.
--ipv6=
- IPv6 address for the interface. This can be the static address, "auto" for address assignment based on automatic neighbor discovery, or "dhcp" to use the DHCPv6 protocol.
--gateway=
- Default gateway as an IP address.
--nameserver=
- Primary nameserver, as an IP address.
--nodns
- Do not configure any DNS server.
--netmask=
- Netmask for the installed system.
--hostname=
- Hostname for the installed system.
--ethtool=
- Specifies additional low-level settings for the network device which will be passed to the ethtool program.
--essid=
- The network ID for wireless networks.
--wepkey=
- The encryption key for wireless networks.
--onboot=
- Whether or not to enable the device a boot time.
--dhcpclass=
- The DHCP class.
--mtu=
- The MTU of the device.
--noipv4
- Disable IPv4 on this device.
--noipv6
- Disable IPv6 on this device.
- Used to select a specific Ethernet device for installation.
part or partition (required for installs, ignored for upgrades)
- Creates a partition on the system. If more than one Red Hat Enterprise Linux installation exists on the system on different partitions, the installation program prompts the user and asks which installation to upgrade.
All partitions created will be formatted as part of the installation process unless --noformat and --onpart are used. part <mntpoint>
The <mntpoint> is where the partition will be mounted and must be of one of the following forms:
/<path>
- For example, /, /usr, /home
swap
- The partition will be used as swap space. To determine the size of the swap partition automatically,
use the --recommended option. The minimum size of the automatically-generated swap partition will be no smaller than the amount of RAM in the system and no bigger than twice the amount of RAM in the system.
- The partition will be used as swap space. To determine the size of the swap partition automatically,
raid.<id>
- The partition will be used for software RAID (refer to raid).
pv.<id>
- The partition will be used for LVM (refer to logvol).
--size=
- The minimum partition size in megabytes. Specify an integer value here such as 500. Do not append the number with MB.
--grow
- Tells the partition to grow to fill available space (if any), or up to the maximum size setting.
--maxsize=
- The maximum partition size in megabytes when the partition is set to grow. Specify an integer value here, and do not append the number with MB.
--noformat
- Tells the installation program not to format the partition, for
use with the --onpart command.
--onpart= or --usepart=
- Put the partition on an already existing device. Do not prefix the partition name with /dev.
--ondisk= or --ondrive=
- Forces the partition to be created on a particular disk. Do not prefix the disk name with /dev.
--asprimary
- Forces automatic allocation of the partition as a primary partition or the partitioning will fail.
--fstype=
- Sets the file system type for the partition. Valid values are ext2, ext3, swap, and vfat.
--fsoptions=
- 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.
--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.
--start=
- Specifies the starting cylinder for the partition. It requires
that a drive be specified with --ondisk= or ondrive=. It also requires that the ending cylinder be specified with --end= or the partition size be specified with --size=.
--end=
- Specifies the ending cylinder for the partition. It requires
that the starting cylinder be specified with --start=.
--recommended
- Determine the size of the partition automatically.
--onbiosdisk=
- Forces the partition to be created on a particular disk as discovered by the BIOS.
--encrypted
- Specify that this partition should be encrypted.
--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.
If partitioning fails for any reason, diagnostic messages will appear on virtual console 3.
raid (optional)
- Assembles a software RAID device. This command is of the form:
raid <mntpoint> --level=<level> --device=<mddevice> <partitions*>
<mntpoint>
- 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. The <partitions*> (which denotes that multiple partitions can be listed) lists the RAID identifiers to add to the RAID array.
--level=
- RAID level to use (0, 1, or 5).
--device=
- Name of the RAID device to use (such as md0 or md1). RAID devices range from md0 to md7, and each may only be used once.
--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.
--fstype=
- Sets the file system type for the RAID array. Valid values are ext2, ext3, swap, and vfat.
--fsoptions=
- 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.
--noformat
- Use an existing RAID device and do not format the RAID array.
--useexisting
- Use an existing RAID device and reformat it.
--encrypted
- Specify that this RAID device should be encrypted.
--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.
- 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
part raid.01 --size=60 --ondisk=sda
part raid.02 --size=60 --ondisk=sdb
part raid.03 --size=60 --ondisk=sdc
part swap --size=128 --ondisk=sda
part swap --size=128 --ondisk=sdb
part swap --size=128 --ondisk=sdc
part raid.11 --size=1 --grow --ondisk=sda
part raid.12 --size=1 --grow --ondisk=sdb
part raid.13 --size=1 --grow --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
reboot (optional)
- Reboot after the installation is complete (no arguments). Normally, kickstart displays a message and waits for the user to press a key before rebooting.
--eject
- Attempt to eject and CD or DVD media before rebooting.
repo (optional)
- Configures additional yum repositories that may be used as sources for package installation. Multiple repo lines may be specified.
repo --name=<name> [--baseurl=<url>|--mirrorlist=<url>] [options]
--name=
- The repo id. This option is required.
--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.
--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.
--priority=
- An integer value to assign a priority level to this repository. If multiple repositories provide the same packages, this number will be used to prioritize which repository will be used before another.
--excludepkgs=
- A comma-separated list of package names and globs that must not be pulled from this repository. This is useful if multiple repositories provide the same package and you want to make sure it comes from a particular repository.
--includepkgs=
- A comma-separated list of package names and globs that must be pulled from this repository. This is useful if multiple repositories provide the same package and you want to make sure it comes from this repository.
rootpw (required)
Sets the system's root password to the <password> argument.
rootpw [--iscrypted] <password>
--iscrypted
- If this is present, the password argument is assumed to already be encrypted.
selinux (optional)
- Sets the state of SELinux on the installed system. SELinux defaults to enforcing in anaconda.
selinux [--disabled|--enforcing|--permissive]
--disabled
- If this is present, SELinux is disabled.
--enforcing
- If this is present, SELinux is set to enforcing mode.
--permissive
- If this is present, SELinux is enabled, but only logs things that would be denied in enforcing mode.
services (optional)
- 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.
services [--disabled=<list>] [--enabled=<list>]
--disabled=
- Disable the services given in the comma separated list.
--enabled=
- Enable the services given in the comma separated list.
skipx (optional)
- If present, X is not configured on the installed system.
text (optional)
- Perform the kickstart installation in text mode. Kickstart installations are performed in graphical mode by default.
timezone (required)
Sets the system time zone to <timezone> which may be any of the time zones listed by timeconfig.
timezone [--utc] <timezone>
--utc
- If present, the system assumes the hardware clock is set to UTC (Greenwich Mean) time.
updates (optional)
- Specify the location of an updates.img for use in installation. See anaconda-release-notes.txt for a description of how to make an updates.img.
updates [url]
url
- If present, the URL for an updates image. If not present, anaconda will attempt to load from a floppy disk.
upgrade (optional)
- Tells the system to upgrade an existing system rather than install a fresh system. You must specify one of cdrom, harddrive, nfs, or url (for ftp and http) as the location of the installation tree. Refer to install for details.
user (optional)
- Creates a new user on the system.
user --name=<username> [--groups=<list>] [--homedir=<homedir>] [--password=<password>] [--iscrypted] [--shell=<shell>] [--uid=<uid>]--name=
- Provides the name of the user. This option is required.
--groups=
- In addition to the default group, a comma separated list of group names the user should belong to.
--homedir=
- The home directory for the user. If not provided, this defaults
to /home/<username>.
--password=
- The new user's password. If not provided, the account will be locked by default.
--iscrypted
Is the password provided by --password already encrypted or not?
--shell=
- The user's login shell. If not provided, this defaults to the system default.
--uid=
- The user's UID. If not provided, this defaults to the next available non-system UID.
vnc (optional)
- 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.
vnc [--host=<hostname>] [--port=<port>] [--password=<password>]
--host=
- Instead of starting a VNC server on the install machine, connect to the VNC viewer process listening on the given hostname.
--port=
- Provide a port that the remote VNC viewer process is listening on. If not provided, anaconda will use the VNC default.
--password=
- Set a password which must be provided to connect to the VNC session. This is optional, but recommended.
volgroup (optional)
- Use to create a Logical Volume Management (LVM) group.
volgroup <name> <partition> <options>
--noformat
- Use an existing volume group and do not format it.
--useexisting
- Use an existing volume group and reformat it.
--pesize=
- Set the size of the physical extents.
part pv.01 --size 3000
volgroup myvg pv.01
logvol / --vgname=myvg --size=2000 --name=rootvol
xconfig (optional)
- Configures the X Window System. If this option is not given, anaconda will use X to attempt to automatically configure. Please try this before manually configuring your system.
--driver=
- Specify the X driver to use for the video hardware.
--videoram=
- Specify the amount of video RAM the video card has.
--defaultdesktop=
- 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).
--startxonboot
- Use a graphical login on the installed system.
--resolution=
- Specify the default resolution for the X Window System on the installed system. Valid values are 640x480, 800x600, 1024x768, 1152x864, 1280x1024, 1400x1050, 1600x1200. Be sure to specify a resolution that is compatible with the video card and monitor.
--depth=
- Specify the default color depth for the X Window System on the installed system. Valid values are 8, 16, 24, and 32. Be sure to specify a color depth that is compatible with the video card and monitor.
zerombr (optional)
- If zerombr is specified, any invalid partition tables found on disks are initialized. This will destroy all of the contents of disks with invalid partition tables.
zfcp (optional)
--devnum=
--fcplun=
--scsiid=
--scsilun=
--wwpn=
%include
Use the %include /path/to/file 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.
%ksappend
Chapter 3. Package Selection
Use the %packages command to begin a kickstart file section that lists the packages you would like to install (this is for installations only, as package selection during upgrades is not supported).
Packages can be specified by group or by individual package name. The installation program defines several groups that contain related packages. Refer to the repodata/comps.xml file on the first CD-ROM for a list of groups. Each group has an id, user visibility value, name, description, and package list. In the package list, the packages marked as mandatory are always installed if the group is selected, the packages marked default are selected by default if the group is selected, and the packages marked optional must be specifically selected even if the group is selected to be installed.
In most cases, it is only necessary to list the desired groups and not individual packages. Note that the Core and Base groups are always selected by default, so it is not necessary to specify them in the %packages section.
The %packages section should be closed with %end, though this is not yet required. It will be required in the future, however. Also, multiple %packages sections may be given. This may be handy if the kickstart file is used as a template and pulls in various other files with the %include mechanism.
Here is an example %packages selection:
%packages
@X Window System
@GNOME Desktop Environment
@Graphical Internet
@Sound and Video
dhcp
%end
As you can see, groups are specified, one to a line, starting with an @ symbol, a space, and then the full group name as given in the comps.xml file. Groups can also be specified using the id for the group, such as gnome-desktop. Specify individual packages with no additional characters (the dhcp line in the example above is an individual package).
Additionally, individual packages may be specified using globs. For instance:
%packages
vim*
kde-i18n-*
%end
This would install all packages whose names start with vim or kde-i18n.
You can also specify which packages not to install from the default package list:
%packages
-autofs
%end
The following options are available for the %packages option:
--default
- Install the default package set. This corresponds to the package set that would be installed if no other selections were made on the package customization screen during an interactive install.
--excludedocs
- Do not install any of the documentation from any packages. For the most part, this means files in /usr/share/doc* will not get installed though it could mean other files as well, depending on how the package was built.
--ignoremissing
- Ignore any packages or groups specified in the packages section that are not found in any configured repository. The default behavior is to halt the installation and ask the user if the installation should be aborted or continued. This option allows fully automated installation even in the error case. It is used as follows:
%packages --ignoremissing
--nobase
- Don't select the Base group by default. This is useful if you are putting together an extremely minimal system. However with this option, it is very easy to end up with a system that does not fully boot to a login prompt as you will need to list all the packages required to get that much functionality.
In addition, group lines in the %packages section can take options as well:
--nodefaults
- Only install the group's mandatory packages, not the default selections.
--optional
- In addition to the mandatory and default packages, also install the optional packages. This means all packages in the group will be installed.
Chapter 4. Pre-installation Script
You can add commands to run on the system immediately after the ks.cfg has been parsed. This section must be at the end of the kickstart file (after the commands) and must start with the %pre command. You can access the network in the %pre section; however, name service has not been configured at this point, so only IP addresses will work.
Preinstallation scripts should be closed with %end, though this is not yet required. It will be required in the future, however.
Note that the pre-install script is not run in the change root environment.
--interpreter /usr/bin/python
- Allows you to specify a different scripting language, such as Python. Replace /usr/bin/python with the scripting language of your choice.
--erroronfail
- If the pre-installation script fails, this option will cause an error dialog to be displayed and will halt installation. The error message will direct you to where the cause of the failure is logged.
--log=
- Log all messages from the script to the given log file.
Example
Here is an example %pre section:
%pre
#!/bin/sh
hds=""
mymedia=""
for file in /proc/ide/h*
do
mymedia=`cat $file/media`
if [ $mymedia == "disk" ] ; then
hds="$hds `basename $file`"
fi
done
set $hds
numhd=`echo $#`
drive1=`echo $hds | cut -d' ' -f1`
drive2=`echo $hds | cut -d' ' -f2`
#Write out partition scheme based on whether there are 1 or 2 hard drives
if [ $numhd == "2" ] ; then
#2 drives
echo "#partitioning scheme generated in %pre for 2 drives" > /tmp/part-include
echo "clearpart --all" >> /tmp/part-include
echo "part /boot --fstype ext3 --size 75 --ondisk hda" >> /tmp/part-include
echo "part / --fstype ext3 --size 1 --grow --ondisk hda" >> /tmp/part-include
echo "part swap --recommended --ondisk $drive1" >> /tmp/part-include
echo "part /home --fstype ext3 --size 1 --grow --ondisk hdb" >> /tmp/part-include
else
#1 drive
echo "#part