[install-guide/F21-rewrite] Added all Kickstart commands to reference except OSTree
pbokoc
pbokoc at fedoraproject.org
Thu Sep 18 16:06:14 UTC 2014
commit f0af8f85cf728abd0fd15e8f20dd7776055c3ec8
Author: Petr Bokoc <pbokoc at redhat.com>
Date: Thu Sep 18 18:10:56 2014 +0200
Added all Kickstart commands to reference except OSTree
en-US/Kickstart_Syntax_Reference.xml | 2908 +++++++++++++++++++++++++++-------
1 files changed, 2293 insertions(+), 615 deletions(-)
---
diff --git a/en-US/Kickstart_Syntax_Reference.xml b/en-US/Kickstart_Syntax_Reference.xml
index 229ebc7..68580b4 100644
--- a/en-US/Kickstart_Syntax_Reference.xml
+++ b/en-US/Kickstart_Syntax_Reference.xml
@@ -81,7 +81,7 @@
Driver disks can be used during Kickstart installations to provide additional drivers not included by default. You must copy the driver disks's contents to the root directory of a partition on the system's hard drive. Then, you must use the <command>driverdisk</command> command to specify that the installation program should look for a driver disk and its location.
</para>
<programlisting>
-<command>driverdisk [<replaceable>partition</replaceable> | --source= | --biospart=]</command>
+<command>driverdisk <replaceable>partition</replaceable> | --source= | --biospart=</command>
</programlisting>
<variablelist>
<varlistentry>
@@ -126,199 +126,199 @@
<section id="sect-kickstart-commands-install">
<title>install (required) - Configure Installation Method</title>
<para>
- The default installation mode. You must specify the type of installation from <literal>cdrom</literal>, <literal>harddrive</literal>, <literal>nfs</literal>, <literal>liveimg</literal>, or <literal>url</literal>. The <command>install</command> command and the installation method command must be on separate lines. For example:
- </para>
- <programlisting>
+ The default installation mode. You must specify the type of installation from <literal>cdrom</literal>, <literal>harddrive</literal>, <literal>nfs</literal>, <literal>liveimg</literal>, or <literal>url</literal>. The <command>install</command> command and the installation method command must be on separate lines. For example:
+ </para>
+ <programlisting>
<command>install</command>
<command>liveimg --url=file:///images/install/squashfs.img --noverifyssl</command>
- </programlisting>
- <para>
- The installation method commands are:
- </para>
- <variablelist>
- <varlistentry>
- <term><command>cdrom</command></term>
- <listitem>
- <para>
- Install from the first optical (DVD) drive on the system.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>harddrive</command></term>
- <listitem>
- <para>
- Install from a tree or full installation ISO image on a local hard drive. The tree or ISO image must be on a file system which is mountable in the installation environment. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, or <systemitem>xfs</systemitem>.
- </para>
- <programlisting>
+ </programlisting>
+ <para>
+ The installation method commands are:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><command>cdrom</command></term>
+ <listitem>
+ <para>
+ Install from the first optical (DVD) drive on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>harddrive</command></term>
+ <listitem>
+ <para>
+ Install from a tree or full installation ISO image on a local hard drive. The tree or ISO image must be on a file system which is mountable in the installation environment. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, or <systemitem>xfs</systemitem>.
+ </para>
+ <programlisting>
<command>install</command>
<command>harddrive --partition= | --biospart= [--dir=]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--partition=</option></term>
- <listitem>
- <para>
- Partition to install from (such as <literal>sdb2</literal>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--biospart=</option></term>
- <listitem>
- <para>
- BIOS partition to install from (such as <literal>82p2</literal>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dir=</option></term>
- <listitem>
- <para>
- Directory containing the installation tree or ISO image.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>liveimg</command></term>
- <listitem>
- <para>
- Install from a disk image instead of packages. The image can be the <filename>squashfs.img</filename> file from a live ISO image, or any file system that the installation media can mount. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, and <systemitem>xfs</systemitem>.
- </para>
- <programlisting>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--partition=</option></term>
+ <listitem>
+ <para>
+ Partition to install from (such as <literal>sdb2</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--biospart=</option></term>
+ <listitem>
+ <para>
+ BIOS partition to install from (such as <literal>82p2</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--dir=</option></term>
+ <listitem>
+ <para>
+ Directory containing the installation tree or ISO image.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>liveimg</command></term>
+ <listitem>
+ <para>
+ Install from a disk image instead of packages. The image can be the <filename>squashfs.img</filename> file from a live ISO image, or any file system that the installation media can mount. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, and <systemitem>xfs</systemitem>.
+ </para>
+ <programlisting>
<command>install</command>
<command>liveimg --url= [--proxy= | --checksum= | --noverifyssl=]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--url=</option></term>
- <listitem>
- <para>
- The location to install from. Supported protocols are <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, <systemitem class="protocol">FTP</systemitem>, and <systemitem class="protocol">file</systemitem>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--proxy=</option></term>
- <listitem>
- <para>
- Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--checksum=</option></term>
- <listitem>
- <para>
- An optional argument with the <systemitem>SHA256</systemitem> checksum of the image file, used for integrity verification. If you are using a live image provided by Fedora Project, you can find a list of checksums at <ulink url="https://fedoraproject.org/en/verify" />.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noverifyssl</option></term>
- <listitem>
- <para>
- Disable SSL verification when connecting to an <systemitem class="protocol">HTTPS</systemitem> server.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>nfs</command></term>
- <listitem>
- <para>
- Install from an <systemitem class="protocol">NFS</systemitem> server specified. <remark>TODO: link to the PXE chapter's section on preparing install source on nfs</remark>
- </para>
- <programlisting>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--url=</option></term>
+ <listitem>
+ <para>
+ The location to install from. Supported protocols are <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, <systemitem class="protocol">FTP</systemitem>, and <systemitem class="protocol">file</systemitem>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--proxy=</option></term>
+ <listitem>
+ <para>
+ Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--checksum=</option></term>
+ <listitem>
+ <para>
+ An optional argument with the <systemitem>SHA256</systemitem> checksum of the image file, used for integrity verification. If you are using a live image provided by Fedora Project, you can find a list of checksums at <ulink url="https://fedoraproject.org/en/verify" />.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noverifyssl</option></term>
+ <listitem>
+ <para>
+ Disable SSL verification when connecting to an <systemitem class="protocol">HTTPS</systemitem> server.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>nfs</command></term>
+ <listitem>
+ <para>
+ Install from an <systemitem class="protocol">NFS</systemitem> server specified. <remark>TODO: link to the PXE chapter's section on preparing install source on nfs</remark>
+ </para>
+ <programlisting>
<command>install</command>
<command>nfs --server= [--dir=] [--opts= ]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--server=</option></term>
- <listitem>
- <para>
- Host name of the server.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dir=</option></term>
- <listitem>
- <para>
- Directory containing the installation tree or ISO image.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--opts=</option></term>
- <listitem>
- <para>
- Mount options to use for mounting the <systemitem class="protocol">NFS</systemitem> export.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>url</command></term>
- <listitem>
- <para>
- Install from a tree on a remote server via <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, or <systemitem class="protocol">FTP</systemitem>.
- </para>
- <programlisting>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--server=</option></term>
+ <listitem>
+ <para>
+ Host name of the server.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--dir=</option></term>
+ <listitem>
+ <para>
+ Directory containing the installation tree or ISO image.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--opts=</option></term>
+ <listitem>
+ <para>
+ Mount options to use for mounting the <systemitem class="protocol">NFS</systemitem> export.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>url</command></term>
+ <listitem>
+ <para>
+ Install from a tree on a remote server via <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, or <systemitem class="protocol">FTP</systemitem>.
+ </para>
+ <programlisting>
<command>install</command>
<command>url --url= | --mirrorlist= [--proxy= | --noverifyssl]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--url=</option></term>
- <listitem>
- <para>
- The location to install from. Supported protocols are <literal>http</literal>, <literal>https</literal>, <literal>ftp</literal>, and <literal>file</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--mirrorlist=</option></term>
- <listitem>
- <para>
- The mirror URL to install from.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--proxy=</option></term>
- <listitem>
- <para>
- Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noverifyssl</option></term>
- <listitem>
- <para>
- Disable SSL verification when connecting to an <systemitem>HTTPS</systemitem> server.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- </variablelist>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--url=</option></term>
+ <listitem>
+ <para>
+ The location to install from. Supported protocols are <literal>http</literal>, <literal>https</literal>, <literal>ftp</literal>, and <literal>file</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--mirrorlist=</option></term>
+ <listitem>
+ <para>
+ The mirror URL to install from.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--proxy=</option></term>
+ <listitem>
+ <para>
+ Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noverifyssl</option></term>
+ <listitem>
+ <para>
+ Disable SSL verification when connecting to an <systemitem>HTTPS</systemitem> server.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-mediacheck">
- <title>mediacheck - Verify Installation Media Integrity</title>
+ <title>mediacheck (optional) - Verify Installation Media Integrity</title>
<para>
- text
+ This command will force the installation program to perform a media check before starting the installation, similarly to the <option>rd.live.check</option> boot option (see <xref linkend="sect-boot-options-mediacheck" />. This command requires that installations be attended, so it is disabled by default.
</para>
</section>
@@ -330,10 +330,95 @@
</section>
<section id="sect-kickstart-commands-repo">
- <title>repo - Configure Instalaltion Source</title>
+ <title>repo (optional) - Configure Additional Yum Repositories</title>
<para>
- text
+ Configures additional <application>Yum</application> repositories that may be used as sources for package installation. This command can be used multiple times in a single Kickstart file.
</para>
+ <programlisting>
+<command>repo --name=<replaceable>repoid</replaceable> [--baseurl=<replaceable><url></replaceable>|--mirrorlist=<replaceable>url</replaceable>] [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <para>
+ See the <citetitle>Fedora System Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>, for information about the <application>Yum</application> package manager.
+ </para>
+ <important>
+ <para>
+ Repositories used for installation must be stable. The installation may fail if a repository is modified before the installation concludes.
+ </para>
+ </important>
+ <variablelist>
+ <varlistentry>
+ <term><option>--name=</option></term>
+ <listitem>
+ <para>
+ The repository ID. This option is required. If a repository has a name which conflicts with another previously added repository, it will be ignored. Because the installation program uses a list of pre-configured repositories, this means that you cannot add repositories with the same names as the preconfigured ones.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--baseurl=</option></term>
+ <listitem>
+ <para>
+ The repository URL. The variables that may be used in <application>Yum</application> repo configuration files are <emphasis>not</emphasis> supported. You may use one of either this option or <option>--mirrorlist</option>, not both.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--mirrorlist=</option></term>
+ <listitem>
+ <para>
+ The URL pointing at a list of mirrors for the repository. The variables that may normally be used in yum repository configuration files are not supported here. You may use one of either this option or --baseurl, not both.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--cost=</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--excludepkgs=</option></term>
+ <listitem>
+ <para>
+ A comma-separated list of package names that must <emphasis>not</emphasis> 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. Both full package names (such as <literal>publican</literal>) and globs (such as <literal>gnome-*</literal>) are accepted.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--includepkgs=</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--proxy=</option></term>
+ <listitem>
+ <para>
+ Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy server to use when accessing this repository. This setting does not affect any other repositories or installation sources.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ignoregroups=true</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noverifyssl</option></term>
+ <listitem>
+ <para>
+ Disable SSL verification when connecting to an <systemitem class="protocol">HTTPS</systemitem> server.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</section>
@@ -776,7 +861,7 @@
<section id="sect-kickstart-commands-fcoe">
<title>fcoe (optional) - Configure Fibre Channel Over Ethernet Devices</title>
- <para>
+ <para>
Specify which FCoE devices should be activated automatically in addition to those discovered by <firstterm>Enhanced Disk Drive Services</firstterm> (EDD).
</para>
<programlisting>
@@ -811,7 +896,7 @@
</section>
<section id="sect-kickstart-commands-ignoredisk">
- <title>ignoredisk - Ignore Specified Disks</title>
+ <title>ignoredisk (optional) - Ignore Specified Disks</title>
<para>
Causes the installation program to ignore the specified disks. This is useful if you use autopartition and want to be sure that some disks are ignored. For example, without <command>ignoredisk</command>, attempting to deploy on a SAN cluster the Kickstart would fail, as the installation program detects passive paths to the SAN that return no partition table.
</para>
@@ -884,354 +969,1587 @@
<section id="sect-kickstart-commands-iscsi">
<title>iscsi (optional) - Configure iSCSI Devices</title>
<para>
- Specifies additional iSCSI storage to be attached during installation. If you use the <command>iscsi</command> command, you must also assign a name to the iSCSI node, using the <command>iscsiname</command> command (see <xref linkend="sect-kickstart-commands-iscsiname" />. The <command>iscsiname</command> command must appear before the <command>iscsi</command> command in the Kickstart file.
- </para>
- <para>
- You should configure iSCSI storage in the system BIOS or firmware (iBFT for Intel systems) rather than use the <command>iscsi</command> command if possible. If you do so, <application>Anaconda</application> automatically detects and uses disks configured in BIOS or firmware and no special configuration is necessary in the Kickstart file.
- </para>
- <para>
- If you must use the <command>iscsi</command> command, make sure that networking is activated at the beginning of the installation, and that the <command>iscsi</command> command appears in the Kickstart file <emphasis>before</emphasis> you refer to iSCSI disks with commands such as <command>clearpart</command> or <command>ignoredisk</command>.
- </para>
- <programlisting>
-<command>iscsi --ipaddr= --port= [--target= | --iface= | --user= | --password= | --reverse-user= | --reverse-password=]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--ipaddr=</option></term>
- <listitem>
- <para>
- The IP address of the target to connect to.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--port=</option></term>
- <listitem>
- <para>
- The port number (typically <literal>3260</literal>).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--target=</option></term>
- <listitem>
- <para>
- Target <firstterm>IQN</firstterm> (iSCSI Qualified Name).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--iface=</option></term>
- <listitem>
- <para>
- Bind the connection to a specific network interface instead of using the default one determined by the network layer. Once used, it must be specified in all instances of the <command>iscsi</command> command in the entire Kickstart file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--user=</option></term>
- <listitem>
- <para>
- User name required to authenticate with the target.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--password=</option></term>
- <listitem>
- <para>
- Password that corresponds with the user name specified for the target.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reverse-user=</option></term>
- <listitem>
- <para>
- User name required to authenticate with the initiator from a target using reverse CHAP authentication.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reverse-password=</option></term>
- <listitem>
- <para>
- Password that corresponds with the user name specified for the initiator.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section id="sect-kickstart-commands-iscsiname">
- <title>iscsiname (optional) - Assign Name to iSCSI Device</title>
- <para>
- Assigns a name to an iSCSI node specified by the <command>iscsi</command> command (<xref linkend="sect-kickstart-commands-iscsi" />). This command is mandatory if you use the <command>iscsi</command> command, and it must be specified <emphasis>before</emphasis> you use <command>iscsi</command>.
- </para>
- <programlisting>
-<command>iscsiname <replaceable>iqn</replaceable></command>
- </programlisting>
- </section>
-
- <section id="sect-kickstart-commands-logvol">
- <title>logvol - Create LVM Logical Volume</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-part">
- <title>part - Create Physical Partition</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-raid">
- <title>raid - Create Software RAID</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-volgroup">
- <title>volgroup - Create LVM Volume Group</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-zerombr">
- <title>zerombr - Reinitialize Partition Tables</title>
- <para>
- text
+ Specifies additional iSCSI storage to be attached during installation. If you use the <command>iscsi</command> command, you must also assign a name to the iSCSI node, using the <command>iscsiname</command> command (see <xref linkend="sect-kickstart-commands-iscsiname" />. The <command>iscsiname</command> command must appear before the <command>iscsi</command> command in the Kickstart file.
</para>
- </section>
-
- <section id="sect-kickstart-commands-zfcp">
- <title>zfcp - Configure Fibre Channel Device</title>
<para>
- text
+ You should configure iSCSI storage in the system BIOS or firmware (iBFT for Intel systems) rather than use the <command>iscsi</command> command if possible. If you do so, <application>Anaconda</application> automatically detects and uses disks configured in BIOS or firmware and no special configuration is necessary in the Kickstart file.
</para>
- </section>
-
- </section>
-
- <section id="sect-kickstart-commands-network-configuration">
- <title>Network Configuration</title>
- <para>
- Commands in this chapter are used for network configuration.
- </para>
-
- <section id="sect-kickstart-commands-firewall">
- <title>firewall (optional) - Configure Firewall</title>
<para>
- Specify the firewall configuration for the installed system. <remark>TODO: link to the Firewall guide once we have one</remark>
+ If you must use the <command>iscsi</command> command, make sure that networking is activated at the beginning of the installation, and that the <command>iscsi</command> command appears in the Kickstart file <emphasis>before</emphasis> you refer to iSCSI disks with commands such as <command>clearpart</command> or <command>ignoredisk</command>.
</para>
<programlisting>
-<command>firewall --enabled | --disabled <replaceable>device</replaceable> [--trust= | --ssh | --smtp | --http | --ftp | --port= | --service=]</command>
+<command>iscsi --ipaddr= --port= [--target= | --iface= | --user= | --password= | --reverse-user= | --reverse-password=]</command>
</programlisting>
<variablelist>
<varlistentry>
- <term><option>--enabled</option> or <option>--enable</option></term>
+ <term><option>--ipaddr=</option></term>
<listitem>
<para>
- 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.
+ The IP address of the target to connect to.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--disabled</option> or <option>--disable</option></term>
+ <term><option>--port=</option></term>
<listitem>
<para>
- Disable the firewall.
+ The port number (typically <literal>3260</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--trust=</option></term>
+ <term><option>--target=</option></term>
<listitem>
<para>
- Listing a device here, such as <literal>em1</literal>, allows all traffic coming to and from that device to go through the firewall. To list more than one device, use this option again - for example:
+ Target <firstterm>IQN</firstterm> (iSCSI Qualified Name).
</para>
- <programlisting>
-<command>firewall --enable --trust=em1 --trust=em2</command>
- </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--iface=</option></term>
+ <listitem>
<para>
- Do not use a comma-separated format such as <option>--trust em1, em2</option>.
+ Bind the connection to a specific network interface instead of using the default one determined by the network layer. Once used, it must be specified in all instances of the <command>iscsi</command> command in the entire Kickstart file.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><replaceable>incoming</replaceable></term>
+ <term><option>--user=</option></term>
<listitem>
<para>
- Replace with one or more of the following to allow the specified services through the firewall:
+ User name required to authenticate with the target.
</para>
- <itemizedlist>
- <listitem>
- <para>
- <option>--ssh</option>
- </para>
- </listitem>
- <listitem>
- <para>
- <option>--smtp</option>
- </para>
- </listitem>
- <listitem>
- <para>
- <option>--http</option>
- </para>
- </listitem>
- <listitem>
- <para>
- <option>--ftp</option>
- </para>
- </listitem>
- </itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--port=</option></term>
+ <term><option>--password=</option></term>
<listitem>
<para>
- 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 <literal>imap:tcp</literal>. Numeric ports can also be specified explicitly; for example, to allow UDP packets on port 1234 through, specify <literal>1234:udp</literal>. To specify multiple ports, separate them by commas.
+ Password that corresponds with the user name specified for the target.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--service=</option></term>
+ <term><option>--reverse-user=</option></term>
<listitem>
<para>
- This option provides a higher-level way to allow services through the firewall. Some services (like <systemitem>cups</systemitem>, <systemitem>avahi</systemitem>, etc.) require multiple ports to be open or other special configuration in order for the service to work. You can specify each individual port with the <option>--port</option> option, or specify <command>--service=</command> and open them all at once.
+ User name required to authenticate with the initiator from a target using reverse CHAP authentication.
</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--reverse-password=</option></term>
+ <listitem>
<para>
- Valid options are anything recognized by the <application>firewall-offline-cmd</application> program in the <package>firewalld</package> package. If <systemitem>firewalld</systemitem> is running, <command>firewall-cmd --get-services</command> will provide a list of known service names.
+ Password that corresponds with the user name specified for the initiator.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
- <section id="sect-kickstart-commands-network">
- <title>network - Configure Network Interfaces</title>
- <para>
- text
- </para>
- </section>
-
- </section>
-
- <section id="sect-kickstart-commands-environment">
- <title>Console and Environment</title>
- <para>
- The following commands control the environment of the system after the installation finishes - language, keyboard layouts, or the graphical interface.
- </para>
-
- <section id="sect-kickstart-commands-keyboard">
- <title>keyboard (optional) - Configure Keyboard Layouts</title>
- <para>
- Sets one or more available keyboard layouts for the system.
- </para>
- <programlisting>
-<command>keyboard --vckeymap= | --xlayouts= [--switch=]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--vckeymap=</option></term>
- <listitem>
- <para>
- Specify a <systemitem>VConsole</systemitem> keymap which should be used. Valid names correspond to the list of files in the <filename class="directory">/usr/lib/kbd/keymaps/*</filename> directory, without the <literal>.map.gz</literal> extension.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--xlayouts=</option></term>
- <listitem>
- <para>
- Specify a list of <application>X</application> layouts that should be used as a comma-separated list without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>, either in the <literal><replaceable>layout</replaceable></literal> format (such as <literal>cz</literal>), or in the <literal><replaceable>layout</replaceable> (<replaceable>variant</replaceable>)</literal> format (such as <literal>cz (qwerty)</literal>).
- </para>
- <para>
- All available layouts can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Layouts</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--switch=</option></term>
- <listitem>
- <para>
- Specify a list of layout-switching options (shortcuts for switching between multiple keyboard layouts). Multiple options must be separated by commas without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>.
- </para>
- <para>
- Available switching options can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Options</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- The following example sets up two keyboard layouts (<literal>English (US)</literal> and <literal>Czech (qwerty)</literal>) using the <option>--xlayouts=</option> option, and allows to switch between them using <keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo>:
- </para>
- <programlisting>
-<command>keyboard --xlayouts=us,'cz (qwerty)' --switch=grp:alt_shift_toggle</command>
- </programlisting>
- </section>
-
- <section id="sect-kickstart-commands-lang">
- <title>lang (optional) - Configure Language During Installation</title>
- <para>
- Sets the language to use during installation and the default language to use on the installed system.
- </para>
- <programlisting>
-<command>lang <replaceable>language</replaceable> [--addsupport=]</command>
- </programlisting>
- <para>
- The file <filename>/usr/share/system-config-language/locale-list</filename> provides a list of the valid <replaceable>language</replaceable> codes in the first column of each line and is part of the <package>system-config-language</package> package.
- </para>
- <para>
- Certain languages (for example, Chinese, Japanese, Korean, and Indic languages) are not supported during text-mode installation. If you specify one of these languages with the <command>lang</command> command and use text mode, the installation process will continue in English, but the installed system will use your selection as its default language.
- </para>
- <variablelist>
- <varlistentry>
- <term><option>--addsupport=</option></term>
- <listitem>
- <para>
- Add support for additional languages. Takes the form of comma-separated list without spaces. For example:
- </para>
- <programlisting>
-<command>lang en_US --addsupport=cs_CZ,de_DE,en_UK</command>
- </programlisting>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section id="sect-kickstart-commands-services">
- <title>services - Configure Services</title>
+ <section id="sect-kickstart-commands-iscsiname">
+ <title>iscsiname (optional) - Assign Name to iSCSI Device</title>
<para>
- text
+ Assigns a name to an iSCSI node specified by the <command>iscsi</command> command (<xref linkend="sect-kickstart-commands-iscsi" />). This command is mandatory if you use the <command>iscsi</command> command, and it must be specified <emphasis>before</emphasis> you use <command>iscsi</command>.
</para>
+ <programlisting>
+<command>iscsiname <replaceable>iqn</replaceable></command>
+ </programlisting>
</section>
- <section id="sect-kickstart-commands-skipx">
- <title>skipx - Do Not Configure X Window System</title>
+ <section id="sect-kickstart-commands-logvol">
+ <title>logvol (optional) - Create LVM Logical Volume</title>
<para>
- text
+ Create a logical volume for Logical Volume Management (LVM) with the syntax:
</para>
- </section>
-
- <section id="sect-kickstart-commands-timezone">
- <title>timezone - Configure Time Zone</title>
+ <programlisting>
+<command>logvol <replaceable>mntpoint</replaceable> --vgname= --name= [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <note>
+ <para>
+ Do not use the dash (<literal>-</literal>) character in logical volume and volume group names when installing &PRODUCT; using Kickstart. If this character is used, the installation will finish normally, but the <filename class="directory">/dev/mapper/</filename> directory will list these volumes and volume groups with every dash doubled. For example, a volume group named <literal>volgrp-01</literal> containing a logical volume named <literal>logvol-01</literal> will be listed as <filename>/dev/mapper/volgrp--01-logvol--01</filename>.
+ </para>
+ <para>
+ This limitation only applies to newly created logical volume and volume group names. If you are reusing existing ones using the <option>--noformat</option> or <option>--useexisting</option> option, their names will not be changed.
+ </para>
+ </note>
<para>
- text
+ For a detailed example of <command>logvol</command> in action, see <xref linkend="sect-kickstart-example-advanced-partitioning" />.
</para>
- </section>
-
- <section id="sect-kickstart-commands-xconfig">
- <title>xconfig - Configure X Window System</title>
- <para>
- text
+ <variablelist>
+ <varlistentry>
+ <term><replaceable>mntpoint</replaceable></term>
+ <listitem>
+ <para>
+ Replace with the volume's mount point. This name can take the following forms:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><filename>/<replaceable>path</replaceable></filename></term>
+ <listitem>
+ <para>
+ A path to the mount point - for example, <literal>/</literal> or <literal>/home</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>swap</literal></term>
+ <listitem>
+ <para>
+ The partition is used as swap space.
+ </para>
+ <para>
+ To determine the size of the swap partition automatically, use the <option>--recommended</option> option:
+ </para>
+ <programlisting>
+<literal>swap --recommended</literal>
+ </programlisting>
+ <para>
+ The size assigned will be effective but not precisely calibrated for your system.
+ </para>
+ <para>
+ To determine the size of the swap partition automatically but also allow extra space for your system to hibernate, use the <option>--hibernation</option> option:
+ </para>
+ <programlisting>
+<literal>swap--hibernation</literal>
+ </programlisting>
+ <para>
+ The size assigned will be equivalent to the swap space assigned by <option>--recommended</option> plus the amount of RAM on your system.
+ </para>
+ <para>
+ For the swap sizes assigned by these commands, see <remark>todo: xref to a section about swap sizes</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>none</literal></term>
+ <listitem>
+ <para>
+ Used only when creating a thin pool volume.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noformat</option></term>
+ <listitem>
+ <para>
+ Use an existing logical volume and do not format it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--useexisting</option></term>
+ <listitem>
+ <para>
+ Use an existing logical volume and format it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fstype=</option></term>
+ <listitem>
+ <para>
+ Sets the file system type for the logical volume. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, and <literal>vfat</literal>. For information about file system types, see <remark>TODO: xref to info about fs types</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fsoptions=</option></term>
+ <listitem>
+ <para>
+ Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the <filename>/etc/fstab</filename> file of the installed system and should be enclosed in quotes. For example:
+ </para>
+ <programlisting>
+<option>--fsoptions="ro, x-systemd.device-timeout=0"</option>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--label=</option></term>
+ <listitem>
+ <para>
+ Sets a label for the logical volume.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--grow</option></term>
+ <listitem>
+ <para>
+ Grow the volume to fill available space (if any), or up to the limit set by the <option>--maxsize=</option> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--size=</option></term>
+ <listitem>
+ <para>
+ The minimum size of the logical volume in megabytes. This option is mandatory when creating a new logical volume, and optional if you are reusing an existing logical volume using the <option>--useexisting</option> or <option>--noformat</option> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--maxsize=</option></term>
+ <listitem>
+ <para>
+ The maximum size in megabytes when the logical volume is set to grow. Specify an integer value here such as <literal>500</literal> (do not include the unit).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--recommended</option></term>
+ <listitem>
+ <para>
+ Determine the size of the logical volume automatically. For details about the recommended scheme, see <remark>TODO: xref to section with partitioning recommendations</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--resize</option></term>
+ <listitem>
+ <para>
+ Resize an existing logical volume. If you use this option, you must also specify <option>--useexisting</option> and <option>--size</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--percent=</option></term>
+ <listitem>
+ <para>
+ Specify the amount by which to grow the logical volume, as a percentage of the free space in the volume group after any statically-sized logical volumes are taken into account. This option must be used in conjunction with the <option>--size</option> and <option>--grow</option> options.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--encrypted</option></term>
+ <listitem>
+ <para>
+ Specifies that this logical volume should be encrypted, using the passphrase provided in the <option>--passphrase=</option> option. If you do not specify a passphrase, the installation program will use the default, system-wide passphrase set with the <command>autopart --passphrase</command> command, or stop the installation and prompt you to provide a passphrase if no default is set.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--passphrase=</option></term>
+ <listitem>
+ <para>
+ Specifies the passphrase to use when encrypting this logical volume. You must use this option together with the <option>--encrypted</option> option. This option has no effect by itself.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--cipher=</option></term>
+ <listitem>
+ <para>
+ Specifies which type of encryption will be used if the <application>Anaconda</application> default <systemitem>aes-xts-plain64</systemitem> is not satisfactory. You must use this option together with the <option>--encrypted</option> option; by itself it has no effect. Available types of encryption are listed in the <citetitle>Fedora Security Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>. Using either <systemitem>aes-xts-plain64</systemitem> or <systemitem>aes-cbc-essiv:sha256</systemitem> is strongly recommended.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--escrowcert=<replaceable>URL_of_X.509_certificate</replaceable></option></term>
+ <listitem>
+ <para>
+ Store data encryption keys of all encrypted volumes as files in <filename>/root</filename>, encrypted using the X.509 certificate from the URL specified with <replaceable>URL_of_X.509_certificate</replaceable>. The keys are stored as a separate file for each encrypted volume. This option is only meaningful if <option>--encrypted</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--backuppassphrase</option></term>
+ <listitem>
+ <para>
+ Add a randomly-generated passphrase to each encrypted volume. Store these passphrases in separate files in <filename>/root</filename>, encrypted using the X.509 certificate specified with <option>--escrowcert</option>. This option is only meaningful if <option>--escrowcert</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--thinpool</option></term>
+ <listitem>
+ <para>
+ Creates a thin pool logical volume. (Use a mount point of <literal>none</literal>)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--metadatasize=</option></term>
+ <listitem>
+ <para>
+ Metadata area size (in MiB) for a new thin pool device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--chunksize=</option></term>
+ <listitem>
+ <para>
+ Chunk size (in KiB) for a new thin pool device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--thin</option></term>
+ <listitem>
+ <para>
+ Create a thin logical volume. (Requires use of <option>--poolname</option>)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--poolname=</option></term>
+ <listitem>
+ <para>
+ Specify the name of the thin pool in which to create a thin logical volume. Requires the <option>--thin</option> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Create one or more partitions first using <xref linkend="sect-kickstart-commands-part" />, create the logical volume group (<xref linkend="sect-kickstart-commands-volgroup" />), and then create logical volumes. For example:
+ </para>
+ <programlisting>
+<command>part pv.01 --size 3000</command>
+<command>volgroup myvg pv.01</command>
+<command>logvol / --vgname=myvg --size=2000 --name=rootvol</command>
+ </programlisting>
+ </section>
+
+ <section id="sect-kickstart-commands-part">
+ <title>part (required) - Create Physical Partition</title>
+ <para>
+ Creates a partition on the system.
+ </para>
+ <para>
+ For a detailed example of <command>part</command> in action, see <xref linkend="sect-kickstart-example-advanced-partitioning" />.
+ </para>
+ <programlisting>
+<command>part|partition <replaceable>mntpoint</replaceable> --name=<replaceable>name</replaceable> --device=<replaceable>device</replaceable> --rule=<replaceable>rule</replaceable> [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <warning>
+ <para>
+ All partitions created are formatted as part of the installation process unless <option>--noformat</option> and <option>--onpart=</option> are used.
+ </para>
+ </warning>
+ <note>
+ <para>
+ If partitioning fails for any reason, diagnostic messages appear on virtual console 3.
+ </para>
+ </note>
+ <variablelist>
+ <varlistentry>
+ <term><replaceable>mntpoint</replaceable></term>
+ <listitem>
+ <para>
+ Where the partition is mounted. The value must be of one of the following:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><filename>/<replaceable>path</replaceable></filename></term>
+ <listitem>
+ <para>
+ A path to the mount point - for example, <literal>/</literal> or <literal>/home</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>swap</literal></term>
+ <listitem>
+ <para>
+ The partition is used as swap space.
+ </para>
+ <para>
+ To determine the size of the swap partition automatically, use the <option>--recommended</option> option:
+ </para>
+ <programlisting>
+<literal>swap --recommended</literal>
+ </programlisting>
+ <para>
+ The size assigned will be effective but not precisely calibrated for your system.
+ </para>
+ <para>
+ To determine the size of the swap partition automatically but also allow extra space for your system to hibernate, use the <option>--hibernation</option> option:
+ </para>
+ <programlisting>
+<literal>swap--hibernation</literal>
+ </programlisting>
+ <para>
+ The size assigned will be equivalent to the swap space assigned by <option>--recommended</option> plus the amount of RAM on your system.
+ </para>
+ <para>
+ For the swap sizes assigned by these commands, see <remark>todo: xref to a section about swap sizes</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>raid.<replaceable>id</replaceable></literal></term>
+ <listitem>
+ <para>
+ The partition is used for software RAID (see <command>raid</command>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>pv.<replaceable>id</replaceable></literal></term>
+ <listitem>
+ <para>
+ The partition is used for LVM (see <xref linkend="sect-kickstart-commands-part" />).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>biosboot</literal></term>
+ <listitem>
+ <para>
+ The partition will be used for a BIOS Boot partition. A 1 MB BIOS boot partition is necessary on BIOS-based systems using a <firstterm>GUID Partition Table</firstterm> (GPT); the boot loader will be installed into it. It is not necessary on UEFI systems. Also see <xref linkend="sect-kickstart-commands-part" />.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>efi</literal></term>
+ <listitem>
+ <para>
+ An EFI System Partition. An EFI partition at least 50 MB in size is necessary on UEFI-based systems; the recommended size is 200 MB. It is not necessary on BIOS systems. Also see <xref linkend="sect-kickstart-commands-part" />.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--size=</option></term>
+ <listitem>
+ <para>
+ The minimum partition size in megabytes. Specify an integer value here such as <literal>500</literal> (do not include the unit).
+ </para>
+ <important>
+ <para>
+ If the <option>--size</option> value is too small, the installation will fail. Set the <option>--size</option> value as the minimum amount of space you require. For size recommendations, see <remark>TODO: xref to recommended partitioning scheme</remark>.
+ </para>
+ </important>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--maxsize=</option></term>
+ <listitem>
+ <para>
+ The maximum partition size in megabytes when the partition is set to grow. Specify an integer value here such as <literal>500</literal> (do not include the unit).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--resize</option></term>
+ <listitem>
+ <para>
+ Resize an existing partition. When using this option, specify the new size (in megabytes) using the <option>--size=</option> option and the target partition using the <option>--onpart=</option> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--grow</option></term>
+ <listitem>
+ <para>
+ Tells the partition to grow to fill available space (if any), or up to the maximum size setting.
+ </para>
+ <note>
+ <para>
+ If you use <option>--grow=</option> without setting <option>--maxsize=</option> on a swap partition, <application>Anaconda</application> will limit the maximum size of the swap partition. For systems that have less than 2 GB of physical memory, the imposed limit is twice the amount of physical memory. For systems with more than 2 GB, the imposed limit is the size of physical memory plus 2 GB.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noformat</option></term>
+ <listitem>
+ <para>
+ Specifies that the partition should not be formatted, for use with the <option>--onpart</option> command.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--onpart=</option> or <option>--usepart=</option></term>
+ <listitem>
+ <para>
+ Specifies the device on which to place the partition. For example:
+ </para>
+ <programlisting>
+<command>partition /home --onpart=hda1</command>
+ </programlisting>
+ <para>
+ The above puts <filename>/home</filename> on <filename>/dev/hda1</filename>.
+ </para>
+ <para>
+ These options can also add a partition to a logical volume. For example:
+ </para>
+ <programlisting>
+<command>partition pv.1 --onpart=hda2</command>
+ </programlisting>
+ <para>
+ The device must already exist on the system; the <option>--onpart</option> option will not create it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ondisk=</option> or <option>--ondrive=</option></term>
+ <listitem>
+ <para>
+ Forces the partition to be created on a particular disk. For example, <option>--ondisk=sdb</option> puts the partition on the second SCSI disk on the system.
+ </para>
+ <para>
+ To specify a multipath device that does not use <firstterm>logical volume management</firstterm> (LVM), use the format <literal>disk/by-id/dm-uuid-mpath-<replaceable>WWID</replaceable></literal>, where <replaceable>WWID</replaceable> is the <firstterm>world-wide identifier</firstterm> for the device. For example, to specify a disk with WWID <literal>2416CD96995134CA5D787F00A5AA11017</literal>, use:
+ </para>
+ <programlisting>
+<command>part / --fstype=xfs --grow --asprimary --size=8192 --ondisk=disk/by-id/dm-uuid-mpath-2416CD96995134CA5D787F00A5AA11017</command>
+ </programlisting>
+ <para>
+ Multipath devices that use LVM are not assembled until after <application>Anaconda</application> has parsed the Kickstart file. Therefore, you cannot specify these devices in the format <literal>dm-uuid-mpath</literal>. Instead, to specify a multipath device that uses LVM, use the format <literal>disk/by-id/scsi-<replaceable>WWID</replaceable></literal>, where <replaceable>WWID</replaceable> is the <firstterm>world-wide identifier</firstterm> for the device. For example, to specify a disk with WWID <literal>58095BEC5510947BE8C0360F604351918</literal>, use:
+ </para>
+ <programlisting>
+<command>part / --fstype=xfs --grow --asprimary --size=8192 --ondisk=disk/by-id/scsi-58095BEC5510947BE8C0360F604351918</command>
+ </programlisting>
+ <warning>
+ <para>
+ Never specify multipath devices by device names like <literal>mpatha</literal>. Device names such as this are not specific to a particular disk. The disk named <filename>/dev/mpatha</filename> during installation might not be the one that you expect it to be. Therefore, the <command>clearpart</command> command could target the wrong disk.
+ </para>
+ </warning>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--asprimary</option></term>
+ <listitem>
+ <para>
+ Forces the partition to be allocated as a <emphasis>primary</emphasis> partition. If the partition cannot be allocated as primary (usually due to too many primary partitions being already allocated), the partitioning process will fail. For information about primary partitions, see <remark>TODO: xref to an appendix about partitions or something like that</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fsprofile=</option></term>
+ <listitem>
+ <para>
+ Specifies a <firstterm>usage type</firstterm> 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 <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, this configuration file is <filename>/etc/mke2fs.conf</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fstype=</option></term>
+ <listitem>
+ <para>
+ Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <remark>TODO: xref to something about supported fs types</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fsoptions=</option></term>
+ <listitem>
+ <para>
+ Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the <filename>/etc/fstab</filename> file of the installed system and should be enclosed in quotes. For example:
+ </para>
+ <programlisting>
+<option>--fsoptions="ro, x-systemd.device-timeout=0"</option>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--label=</option></term>
+ <listitem>
+ <para>
+ Assign a label to an individual partition.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--recommended</option></term>
+ <listitem>
+ <para>
+ Determine the size of the partition automatically. For details about the recommended scheme, see <remark>TODO: xref to something about recommended partitioning scheme</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--onbiosdisk</option></term>
+ <listitem>
+ <para>
+ Forces the partition to be created on a particular disk as discovered by the BIOS.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--encrypted</option></term>
+ <listitem>
+ <para>
+ Specifies that this partition should be encrypted, using the passphrase provided in the <option>--passphrase</option> option. If you do not specify a passphrase, <application>Anaconda</application> uses the default, system-wide passphrase set with the <command>autopart --passphrase</command> command, or stops the installation and prompts you to provide a passphrase if no default is set.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--passphrase=</option></term>
+ <listitem>
+ <para>
+ Specifies the passphrase to use when encrypting this partition. You must use this option together with the <option>--encrypted</option> option; by itself it has no effect.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--cipher=</option></term>
+ <listitem>
+ <para>
+ Specifies which type of encryption will be used if the <application>Anaconda</application> default <systemitem>aes-xts-plain64</systemitem> is not satisfactory. You must use this option together with the <option>--encrypted</option> option; by itself it has no effect. Available types of encryption are listed in the <citetitle>Fedora Security Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>. Using either <systemitem>aes-xts-plain64</systemitem> or <systemitem>aes-cbc-essiv:sha256</systemitem> is strongly recommended.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--escrowcert=<replaceable>URL_of_X.509_certificate</replaceable></option></term>
+ <listitem>
+ <para>
+ Stores data encryption keys of all encrypted volumes as files in <filename>/root</filename>, encrypted using the X.509 certificate from the URL specified with <replaceable>URL_of_X.509_certificate</replaceable>. The keys are stored as a separate file for each encrypted volume. This option is only meaningful if <option>--encrypted</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--backuppassphrase</option></term>
+ <listitem>
+ <para>
+ Add a randomly-generated passphrase to each encrypted partition. Store these passphrases in separate files in <filename>/root</filename>, encrypted using the X.509 certificate specified with <option>--escrowcert</option>. This option is only meaningful if <option>--escrowcert</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-raid">
+ <title>raid (optional) - Create Software RAID</title>
+ <para>
+ Assembles a software RAID device. This command is of the form:
+ </para>
+ <programlisting>
+<command>raid <replaceable>mntpoint</replaceable> --level=<replaceable>level</replaceable> --device=<replaceable>mddevice</replaceable> <replaceable>partitions*</replaceable></command>
+ </programlisting>
+ <para>
+ For a detailed example of <command>raid</command> in action, see <xref linkend="sect-kickstart-example-advanced-partitioning" />.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><replaceable>mntpoint</replaceable></term>
+ <listitem>
+ <para>
+ Location where the RAID file system is mounted. If it is <filename>/</filename>, the RAID level must be 1 unless a boot partition (<filename>/boot</filename>) is present. If a boot partition is present, the <filename>/boot</filename> partition must be level 1 and the root (<filename>/</filename>) partition can be any of the available types. The <replaceable>partitions*</replaceable> (which denotes that multiple partitions can be listed) lists the RAID identifiers to add to the RAID array.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--level=</option></term>
+ <listitem>
+ <para>
+ RAID level to use (<literal>0</literal>, <literal>1</literal>, <literal>4</literal>, <literal>5</literal>, <literal>6</literal>, or <literal>10</literal>). <remark>TODO: xref to the section that describes raid levels</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--device=</option></term>
+ <listitem>
+ <para>
+ Name of the RAID device to use. As of &PRODUCT; &PRODVER;, RAID devices are no longer referred to by names like <literal>md0</literal>. 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 (for example, <option>--device=rhel7-root --label=rhel7-root</option>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--spares=</option></term>
+ <listitem>
+ <para>
+ Specifies the number of spare drives allocated for the RAID array. Spare drives are used to rebuild the array in case of drive failure.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fsprofile=</option></term>
+ <listitem>
+ <para>
+ Specifies a <firstterm>usage type</firstterm> 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 <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, this configuration file is <filename>/etc/mke2fs.conf</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fstype=</option></term>
+ <listitem>
+ <para>
+ Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <remark>TODO: xref to something about supported fs types</remark>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fsoptions=</option></term>
+ <listitem>
+ <para>
+ Specifies a free form string of options to be used when mounting the filesystem. This string will be copied into the <filename>/etc/fstab</filename> file of the installed system and should be enclosed in quotes. For example:
+ </para>
+ <programlisting>
+<option>--fsoptions="ro, x-systemd.device-timeout=0"</option>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--label=</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noformat</option></term>
+ <listitem>
+ <para>
+ Use an existing RAID device and do not format it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--useexisting</option></term>
+ <listitem>
+ <para>
+ Use an existing RAID device and reformat it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--encrypted</option></term>
+ <listitem>
+ <para>
+ Specifies that this array should be encrypted, using the passphrase provided in the <option>--passphrase</option> option. If you do not specify a passphrase, <application>Anaconda</application> uses the default, system-wide passphrase set with the <command>autopart --passphrase</command> command, or stops the installation and prompts you to provide a passphrase if no default is set.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--passphrase=</option></term>
+ <listitem>
+ <para>
+ Specifies the passphrase to use when encrypting this partition. You must use this option together with the <option>--encrypted</option> option; by itself it has no effect.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--cipher=</option></term>
+ <listitem>
+ <para>
+ Specifies which type of encryption will be used if the <application>Anaconda</application> default <systemitem>aes-xts-plain64</systemitem> is not satisfactory. You must use this option together with the <option>--encrypted</option> option; by itself it has no effect. Available types of encryption are listed in the <citetitle>Fedora Security Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>. Using either <systemitem>aes-xts-plain64</systemitem> or <systemitem>aes-cbc-essiv:sha256</systemitem> is strongly recommended.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--escrowcert=<replaceable>URL_of_X.509_certificate</replaceable></option></term>
+ <listitem>
+ <para>
+ Stores data encryption keys of all encrypted volumes as files in <filename>/root</filename>, encrypted using the X.509 certificate from the URL specified with <replaceable>URL_of_X.509_certificate</replaceable>. The keys are stored as a separate file for each encrypted volume. This option is only meaningful if <option>--encrypted</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--backuppassphrase</option></term>
+ <listitem>
+ <para>
+ Add a randomly-generated passphrase to each encrypted partition. Store these passphrases in separate files in <filename>/root</filename>, encrypted using the X.509 certificate specified with <option>--escrowcert</option>. This option is only meaningful if <option>--escrowcert</option> is specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ The following example shows how to create a RAID level 1 partition for <filename>/</filename>, and a RAID level 5 for <filename>/home</filename>, assuming there are three SCSI disks on the system. It also creates three swap partitions, one on each drive.
+ </para>
+ <example>
+ <title>Creating a RAID array in Kickstart</title>
+ <programlisting>
+<command>part raid.01 --size=6000 --ondisk=sda</command>
+<command>part raid.02 --size=6000 --ondisk=sdb</command>
+<command>part raid.03 --size=6000 --ondisk=sdc</command>
+
+<command>part swap --size=512 --ondisk=sda</command>
+<command>part swap --size=512 --ondisk=sdb</command>
+<command>part swap --size=512 --ondisk=sdc</command>
+
+<command>part raid.11 --size=1 --grow --ondisk=sda</command>
+<command>part raid.12 --size=1 --grow --ondisk=sdb</command>
+<command>part raid.13 --size=1 --grow --ondisk=sdc</command>
+
+<command>raid / --level=1 --device=f&PRODVER;-root --label=f&PRODVER;-root raid.01 raid.02 raid.03</command>
+<command>raid /home --level=5 --device=f&PRODVER;-home --label=f&PRODVER;-home raid.11 raid.12 raid.13</command>
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="sect-kickstart-commands-volgroup">
+ <title>volgroup (optional) - Create LVM Volume Group</title>
+ <para>
+ Creates a Logical Volume Management (LVM) volume group.
+ </para>
+ <programlisting>
+<command>volgroup <replaceable>name</replaceable> <replaceable>partition</replaceable> [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <important>
+ <para>
+ Do not use the dash (<literal>-</literal>) character in logical volume and volume group names when installing &PRODUCT; using Kickstart. If this character is used, the installation will finish normally, but the <filename class="directory">/dev/mapper/</filename> directory will list these volumes and volume groups with every dash doubled. For example, a volume group named <literal>volgrp-01</literal> containing a logical volume named <literal>logvol-01</literal> will be listed as <filename>/dev/mapper/volgrp--01-logvol--01</filename>.
+ </para>
+ <para>
+ This limitation only applies to newly created logical volume and volume group names. If you are reusing existing ones using the <option>--noformat</option> or <option>--noformat</option> option, their names will not be changed.
+ </para>
+ </important>
+ <para>
+ For a detailed partitioning example including <command>volgroup</command>, see <xref linkend="sect-kickstart-example-advanced-partitioning" />.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--noformat</option></term>
+ <listitem>
+ <para>
+ Use an existing volume group and do not format it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--useexisting</option></term>
+ <listitem>
+ <para>
+ Use an existing volume group and reformat it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--pesize=</option></term>
+ <listitem>
+ <para>
+ Set the size of the physical extents. The default size for Kickstart installations is 4 MiB.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--reserved-space=</option></term>
+ <listitem>
+ <para>
+ Specify an amount of space to leave unused in a volume group in megabytes. Applicable only to newly created volume groups.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--reserved-percent=</option></term>
+ <listitem>
+ <para>
+ Specify a percentage of total volume group space to leave unused. Applicable only to newly created volume groups.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Create one or more partitions first using <xref linkend="sect-kickstart-commands-part" />, create the logical volume group (<xref linkend="sect-kickstart-commands-volgroup" />), and then create logical volumes. For example:
+ </para>
+ <programlisting>
+<command>part pv.01 --size 3000</command>
+<command>volgroup myvg pv.01</command>
+<command>logvol / --vgname=myvg --size=2000 --name=rootvol</command>
+ </programlisting>
+ </section>
+
+ <section id="sect-kickstart-commands-zerombr">
+ <title>zerombr (optional) - Reinitialize Partition Tables</title>
+ <para>
+ If <command>zerombr</command> is specified, any invalid partition tables found on disks are initialized. This destroys all of the contents of disks with invalid partition tables. This command is required when performing an unattended installation on a system with previously initialized disks.
+ </para>
+ <warning>
+ <para>
+ On IBM System z, if <command>zerombr</command> is specified, any <firstterm>Direct Access Storage Device</firstterm> (DASD) visible to the installation program which is not already low-level formatted is automatically low-level formatted with <application>dasdfmt</application>. The command also prevents user choice during interactive installations.
+ </para>
+ <para>
+ If <command>zerombr</command> is not specified and there is at least one unformatted DASD visible to the installation program, a non-interactive Kickstart installation will exit unsuccessfully.
+ </para>
+ <para>
+ If <command>zerombr</command> is not specified and there is at least one unformatted DASD visible to the installation program, an interactive installation exits if the user does not agree to format all visible and unformatted DASDs. To circumvent this, only activate those DASDs that you will use during installation. You can always add more DASDs after installation is complete.
+ </para>
+ </warning>
+ </section>
+
+ <section id="sect-kickstart-commands-zfcp">
+ <title>zfcp (optional) - Configure Fibre Channel Device</title>
+ <para>
+ Define a Fibre channel device. This option only applies on IBM System z. All of the options described below must be specified.
+ </para>
+ <programlisting>
+<command>zfcp --devnum=<replaceable>devnum</replaceable> --wwpn=<replaceable>wwpn</replaceable> --fcplun=<replaceable>lun</replaceable></command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--devnum</option></term>
+ <listitem>
+ <para>
+ The device number (zFCP adaptor device bus ID).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--wwpn</option></term>
+ <listitem>
+ <para>
+ The device's World Wide Port Name (WWPN). Takes the form of a 16-digit number, preceded by <literal>0x</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--fcplun</option></term>
+ <listitem>
+ <para>
+ The device's Logical Unit Number (LUN). Takes the form of a 16-digit number, preceded by <literal>0x</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ For example:
+ </para>
+ <programlisting>
+<command>zfcp --devnum=0.0.4000 --wwpn=0x5005076300C213e9 --fcplun=0x5022000000000000</command>
+ </programlisting>
+ </section>
+
+ </section>
+
+ <section id="sect-kickstart-commands-network-configuration">
+ <title>Network Configuration</title>
+ <para>
+ Commands in this chapter are used for network configuration.
+ </para>
+
+ <section id="sect-kickstart-commands-firewall">
+ <title>firewall (optional) - Configure Firewall</title>
+ <para>
+ Specify the firewall configuration for the installed system. <remark>TODO: link to the Firewall guide once we have one</remark>
+ </para>
+ <programlisting>
+<command>firewall --enabled | --disabled <replaceable>device</replaceable> [--trust= | --ssh | --smtp | --http | --ftp | --port= | --service=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--enabled</option> or <option>--enable</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--disabled</option> or <option>--disable</option></term>
+ <listitem>
+ <para>
+ Disable the firewall.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--trust=</option></term>
+ <listitem>
+ <para>
+ Listing a device here, such as <literal>em1</literal>, allows all traffic coming to and from that device to go through the firewall. To list more than one device, use this option again - for example:
+ </para>
+ <programlisting>
+<command>firewall --enable --trust=em1 --trust=em2</command>
+ </programlisting>
+ <para>
+ Do not use a comma-separated format such as <option>--trust em1, em2</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>incoming</replaceable></term>
+ <listitem>
+ <para>
+ Replace with one or more of the following to allow the specified services through the firewall:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <option>--ssh</option>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>--smtp</option>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>--http</option>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <option>--ftp</option>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--port=</option></term>
+ <listitem>
+ <para>
+ 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 <literal>imap:tcp</literal>. Numeric ports can also be specified explicitly; for example, to allow UDP packets on port 1234 through, specify <literal>1234:udp</literal>. To specify multiple ports, separate them by commas.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--service=</option></term>
+ <listitem>
+ <para>
+ This option provides a higher-level way to allow services through the firewall. Some services (like <systemitem>cups</systemitem>, <systemitem>avahi</systemitem>, etc.) require multiple ports to be open or other special configuration in order for the service to work. You can specify each individual port with the <option>--port</option> option, or specify <command>--service=</command> and open them all at once.
+ </para>
+ <para>
+ Valid options are anything recognized by the <application>firewall-offline-cmd</application> program in the <package>firewalld</package> package. If <systemitem>firewalld</systemitem> is running, <command>firewall-cmd --get-services</command> will provide a list of known service names.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-network">
+ <title>network (optional) - Configure Network Interfaces</title>
+ <para>
+ Configures network information for the target system and activates network devices in the installation environment. The device specified in the first <command>network</command> command is activated automatically. Activation of the device can be also explicitly required by the <option>--activate</option> option.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--activate</option></term>
+ <listitem>
+ <para>
+ If you use the <option>--activate</option> option on a device that has already been activated (for example, an interface you configured with boot options so that the system could retrieve the Kickstart file) the device is reactivated to use the details specified in the Kickstart file.
+ </para>
+ <para>
+ Use the <option>--nodefroute</option> option to prevent the device from using the default route.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--bootproto=</option></term>
+ <listitem>
+ <para>
+ One of <literal>dhcp</literal>, <literal>bootp</literal>, <literal>ibft</literal>, or <literal>static</literal>. The default option is <literal>dhcp</literal>; the <literal>dhcp</literal> and <literal>bootp</literal> options are treated the same.
+ </para>
+ <para>
+ The DHCP method uses a DHCP server system to obtain its networking configuration. The BOOTP method is similar, requiring a BOOTP server to supply the networking configuration. To direct a system to use DHCP:
+ </para>
+ <programlisting>
+<command>network --bootproto=dhcp</command>
+ </programlisting>
+ <para>
+ To direct a machine to use BOOTP to obtain its networking configuration, use the following line in the Kickstart file:
+ </para>
+ <programlisting>
+<command>network --bootproto=bootp</command>
+ </programlisting>
+ <para>
+ To direct a machine to use the configuration specified in iBFT, use:
+ </para>
+ <programlisting>
+<command>network --bootproto=ibft</command>
+ </programlisting>
+ <para>
+ The <literal>static</literal> method requires that you specify the IP address, netmask, gateway, and nameserver in the Kickstart file. This information is static and is used during and after the installation.
+ </para>
+ <para>
+ All static networking configuration information must be specified on <emphasis>one</emphasis> line; you cannot wrap lines using a backslash (<literal>\</literal>) as you can on a command line.
+ </para>
+ <programlisting>
+<command>network --bootproto=static --ip=10.0.2.15 --netmask=255.255.255.0 --gateway=10.0.2.254 --nameserver=10.0.2.1</command>
+ </programlisting>
+ <para>
+ You can also configure multiple nameservers at the same time. To do so, specify them as a comma-delimited list in the command line.
+ </para>
+ <programlisting>
+<command>network --bootproto=static --ip=10.0.2.15 --netmask=255.255.255.0 --gateway=10.0.2.254 --nameserver=192.168.2.1,192.168.3.1</command>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--device=</option></term>
+ <listitem>
+ <para>
+ Specifies the device to be configured (and eventually activated in <application>Anaconda</application>) with the <command>network</command> command.
+ </para>
+ <para>
+ If the <option>--device=</option> option is missing on the <emphasis>first</emphasis> use of the <command>network</command> command, the value of the <option>ksdevice=</option> <application>Anaconda</application> boot option is used, if available. Note that this is considered deprecated behavior; in most cases, you should always specify a <option>--device=</option> for every <command>network</command> command.
+ </para>
+ <para>
+ The behavior of any subsequent <command>network</command> command in the same Kickstart file is unspecified if its <option>--device=</option> option is missing. Make sure you specify this option for any <command>network</command> command beyond the first.
+ </para>
+ <para>
+ You can specify a device to be activated in any of the following ways:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ the device name of the interface, for example, <systemitem>em1</systemitem>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the MAC address of the interface, for example, <systemitem>01:23:45:67:89:ab</systemitem>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the keyword <literal>link</literal>, which specifies the first interface with its link in the <literal>up</literal> state
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the keyword <literal>bootif</literal>, which uses the MAC address that <application>pxelinux</application> set in the <parameter>BOOTIF</parameter> variable. Set <literal>IPAPPEND 2</literal> in your <filename>pxelinux.cfg</filename> file to have <application>pxelinux</application> set the <parameter>BOOTIF</parameter> variable.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ For example:
+ </para>
+ <programlisting>
+<command>network --bootproto=dhcp --device=em1</command>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ip=</option></term>
+ <listitem>
+ <para>
+ IP address of the device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ipv6=</option></term>
+ <listitem>
+ <para>
+ IPv6 address of the device, in the form of <replaceable>address</replaceable>[/<replaceable>prefix</replaceable> <replaceable>length</replaceable>] - for example, <literal>3ffe:ffff:0:1::1/128 </literal>. If <replaceable>prefix</replaceable> is omitted, <literal>64</literal> will be used. You can also use <literal>auto</literal> for automatic configuration, or <literal>dhcp</literal> for DHCPv6-only configuration (no router advertisements).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--gateway=</option></term>
+ <listitem>
+ <para>
+ Default gateway as a single IPv4 address.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ipv6gateway=</option></term>
+ <listitem>
+ <para>
+ Default gateway as a single IPv6 address.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--nodefroute</option></term>
+ <listitem>
+ <para>
+ Prevents the interface being set as the default route. Use this option when you activate additional devices with the <option>--activate=</option> option, for example, a NIC on a separate subnet for an iSCSI target.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--nameserver=</option></term>
+ <listitem>
+ <para>
+ Primary nameserver, as an IP address. Multiple nameservers must each be separated by a comma.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--nodns</option></term>
+ <listitem>
+ <para>
+ Do not configure any DNS server.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--netmask=</option></term>
+ <listitem>
+ <para>
+ Network mask for the installed system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--hostname=</option></term>
+ <listitem>
+ <para>
+ Hostname for the installed system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ethtool=</option></term>
+ <listitem>
+ <para>
+ Specifies additional low-level settings for the network device which will be passed to the <application>ethtool</application> program.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--essid=</option></term>
+ <listitem>
+ <para>
+ The network ID for wireless networks.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--wepkey=</option></term>
+ <listitem>
+ <para>
+ The WEP encryption key for wireless networks.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--wpakey=</option></term>
+ <listitem>
+ <para>
+ The WPA encryption key for wireless networks.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--onboot=</option></term>
+ <listitem>
+ <para>
+ Whether or not to enable the device at boot time.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--dhcpclass=</option></term>
+ <listitem>
+ <para>
+ The DHCP class.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--mtu=</option></term>
+ <listitem>
+ <para>
+ The MTU of the device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noipv4</option></term>
+ <listitem>
+ <para>
+ Disable IPv4 on this device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noipv6</option></term>
+ <listitem>
+ <para>
+ Disable IPv6 on this device.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--bondslaves=</option></term>
+ <listitem>
+ <para>
+ When this option is used, the network device specified in the <option>--device=</option> option will be created using slaves defined in the <option>--bondslaves=</option> option. For example:
+ </para>
+ <programlisting>
+<command>network --device=mynetwork --bondslaves=em1,em2</command>
+ </programlisting>
+ <para>
+ The above command will create a bond device named <literal>mynetwork</literal> using the <literal>em1</literal> and <literal>em2</literal> interfaces as its slaves.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>--bondopts=</command></term>
+ <listitem>
+ <para>
+ A list of optional parameters for a bonded interface, which is specified using the <command>--bondslaves=</command> and <command>--device=</command> options. Options in this list must be separated by commas ("<literal>,</literal>") or semicolons ("<literal>;</literal>"). If an option itself contains a comma, use a semicolon to separate the options. For example:
+ </para>
+ <programlisting>
+<command>network --bondopts=mode=active-backup,balance-rr;primary=eth1</command>
+ </programlisting>
+ <para>
+ Available optional parameters are listed in the <citetitle>Working with Kernel Modules</citetitle> chapter of the <citetitle>Fedora System Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>.
+ </para>
+ <important>
+ <para>
+ The <option>--bondopts=mode=</option> parameter only supports full mode names such as <literal>balance-rr</literal> or <literal>broadcast</literal>, not their numerical representations such as <literal>0</literal> or <literal>3</literal>.
+ </para>
+ </important>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--vlanid=</option></term>
+ <listitem>
+ <para>
+ Specifies virtual LAN (VLAN) ID number (802.1q tag) for the device created using the device specified in <option>--device=</option> as a parent. For example, <command>network --device=em1 --vlanid=171</command> will create a virtual LAN device <literal>em1.171</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--interfacename=</option></term>
+ <listitem>
+ <para>
+ Specify a custom interface name for a virtual LAN device. This option should be used when the default name generated by the <option>--vlanid=</option> option is not desirable. This option must be used along with <option>--vlanid=</option>. For example:
+ </para>
+ <programlisting>
+<command>network --device=em1 --vlanid=171 --interfacename=vlan171</command>
+ </programlisting>
+ <para>
+ The above command will create a virtual LAN interface named <literal>vlan171</literal> on the <literal>em1</literal> device with an ID of <literal>171</literal>.
+ </para>
+ <para>
+ The interface name can be arbitrary (for example, <literal>my-vlan</literal>), but in specific cases, the following conventions must be followed:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ If the name contains a dot (<literal>.</literal>), it must take the form of <literal><replaceable>NAME</replaceable>.<replaceable>ID</replaceable></literal>. The <replaceable>NAME</replaceable> is arbitrary, but the <replaceable>ID</replaceable> must be the VLAN ID. For example: <literal>em1.171</literal> or <literal>my-vlan.171</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Names starting with <literal>vlan</literal> must take the form of <literal>vlan<replaceable>ID</replaceable></literal> - for example, <literal>vlan171</literal>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--teamslaves=</option></term>
+ <listitem>
+ <para>
+ Team device specified by the <option>--device=</option> option will be created using slaves specified in this option. Slaves are separated by commas. A slave can be followed by its configuration, which is a single-quoted JSON string with double quotes escaped by the <literal>\</literal> character. For example:
+ </para>
+ <programlisting>
+<command>network --teamslaves="p3p1'{\"prio\": -10, \"sticky\": true}',p3p2'{\"prio\": 100}'"</command>
+ </programlisting>
+ <para>
+ See also the <option>--teamconfig=</option> option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--teamconfig=</option></term>
+ <listitem>
+ <para>
+ Double-quoted team device configuration which is a single-quoted JSON string with double quotes escaped by the <literal>\</literal> character. The device name is specified by <option>--device=</option> option and its slaves and their configuration by <option>--teamslaves=</option> option. For example:
+ </para>
+ <programlisting>
+<command>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\"}}"</command>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ </section>
+
+ <section id="sect-kickstart-commands-environment">
+ <title>Console and Environment</title>
+ <para>
+ The following commands control the environment of the system after the installation finishes - language, keyboard layouts, or the graphical interface.
+ </para>
+
+ <section id="sect-kickstart-commands-keyboard">
+ <title>keyboard (optional) - Configure Keyboard Layouts</title>
+ <para>
+ Sets one or more available keyboard layouts for the system.
+ </para>
+ <programlisting>
+<command>keyboard --vckeymap= | --xlayouts= [--switch=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--vckeymap=</option></term>
+ <listitem>
+ <para>
+ Specify a <systemitem>VConsole</systemitem> keymap which should be used. Valid names correspond to the list of files in the <filename class="directory">/usr/lib/kbd/keymaps/*</filename> directory, without the <literal>.map.gz</literal> extension.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--xlayouts=</option></term>
+ <listitem>
+ <para>
+ Specify a list of <application>X</application> layouts that should be used as a comma-separated list without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>, either in the <literal><replaceable>layout</replaceable></literal> format (such as <literal>cz</literal>), or in the <literal><replaceable>layout</replaceable> (<replaceable>variant</replaceable>)</literal> format (such as <literal>cz (qwerty)</literal>).
+ </para>
+ <para>
+ All available layouts can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Layouts</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--switch=</option></term>
+ <listitem>
+ <para>
+ Specify a list of layout-switching options (shortcuts for switching between multiple keyboard layouts). Multiple options must be separated by commas without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>.
+ </para>
+ <para>
+ Available switching options can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Options</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ The following example sets up two keyboard layouts (<literal>English (US)</literal> and <literal>Czech (qwerty)</literal>) using the <option>--xlayouts=</option> option, and allows to switch between them using <keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo>:
+ </para>
+ <programlisting>
+<command>keyboard --xlayouts=us,'cz (qwerty)' --switch=grp:alt_shift_toggle</command>
+ </programlisting>
+ </section>
+
+ <section id="sect-kickstart-commands-lang">
+ <title>lang (optional) - Configure Language During Installation</title>
+ <para>
+ Sets the language to use during installation and the default language to use on the installed system.
+ </para>
+ <programlisting>
+<command>lang <replaceable>language</replaceable> [--addsupport=]</command>
+ </programlisting>
+ <para>
+ The file <filename>/usr/share/system-config-language/locale-list</filename> provides a list of the valid <replaceable>language</replaceable> codes in the first column of each line and is part of the <package>system-config-language</package> package.
+ </para>
+ <para>
+ Certain languages (for example, Chinese, Japanese, Korean, and Indic languages) are not supported during text-mode installation. If you specify one of these languages with the <command>lang</command> command and use text mode, the installation process will continue in English, but the installed system will use your selection as its default language.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--addsupport=</option></term>
+ <listitem>
+ <para>
+ Add support for additional languages. Takes the form of comma-separated list without spaces. For example:
+ </para>
+ <programlisting>
+<command>lang en_US --addsupport=cs_CZ,de_DE,en_UK</command>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-services">
+ <title>services (optional) - Configure Services</title>
+ <para>
+ Modifies the default set of services that will run under the default <application>systemd</application> target. The list of disabled services is processed before the list of enabled services - therefore, if a service appears on both lists, it will be enabled.
+ </para>
+ <programlisting>
+<command>services [--disabled=<replaceable>list</replaceable>] [--enabled=<replaceable>list</replaceable>]</command>
+ </programlisting>
+ <para>
+ Do not include spaces in the list of services. If you do, Kickstart will enable or disable only the services up to the first space. For example:
+ </para>
+ <programlisting>
+<command>services --disabled=auditd, cups,smartd, nfslock</command>
+ </programlisting>
+ <para>
+ The above will disable only the <systemitem>auditd</systemitem> service. To disable all four services, the entry should include no spaces:
+ </para>
+ <programlisting>
+<command>services --disabled=auditd,cups,smartd,nfslock</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--disabled=</option></term>
+ <listitem>
+ <para>
+ Disable the services given in the comma separated list.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enabled=</option></term>
+ <listitem>
+ <para>
+ Enable the services given in the comma separated list.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-skipx">
+ <title>skipx (optional) - Do Not Configure X Window System</title>
+ <para>
+ If present, <application>X</application> will not be configured on the installed system.
+ </para>
+ <important>
+ <para>
+ If you install a display manager among your package selection options, this package will create an <application>X</application> configuration, and the installed system will default to <systemitem>graphical.target</systemitem>. The effect of the <command>skipx</command> option will be overridden.
+ </para>
+ </important>
+ </section>
+
+ <section id="sect-kickstart-commands-timezone">
+ <title>timezone (optional) - Configure Time Zone</title>
+ <para>
+ Sets the system time zone to <replaceable>timezone</replaceable>. To view a list of available time zones, use the <command>timedatectl list-timezones</command> command.
+ </para>
+ <programlisting>
+<command>timezone <replaceable>timezone</replaceable> [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--utc</option></term>
+ <listitem>
+ <para>
+ If present, the system assumes the hardware clock is set to UTC (Greenwich Mean) time.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--nontp</option></term>
+ <listitem>
+ <para>
+ Disable the NTP service automatic starting.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ntpservers=</option></term>
+ <listitem>
+ <para>
+ Specify a list of NTP servers to be used as a comma-separated list without spaces.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-xconfig">
+ <title>xconfig (optional) - Configure X Window System</title>
+ <para>
+ Configures the <application>X Window System</application>. If you install the <application>X Window System</application> with a Kickstart file that does not include the <command>xconfig</command> command, you must provide the <application>X</application> configuration manually during installation.
+ </para>
+ <para>
+ Do not use this command in a Kickstart file that does not install the <application>X Window System</application>.
</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--defaultdesktop=</option></term>
+ <listitem>
+ <para>
+ Specify either <literal>GNOME</literal> or <literal>KDE</literal> to set the default desktop (assumes that <application>GNOME Desktop Environment</application> and/or <application>KDE Desktop Environment</application> has been installed in the <command>%packages</command> section).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--startxonboot</option></term>
+ <listitem>
+ <para>
+ Use a graphical login on the installed system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</section>
@@ -1279,169 +2597,421 @@
<term><option>--useshadow</option>or <option>--enableshadow</option></term>
<listitem>
<para>
- Use shadow passwords. Active by default.
+ Use shadow passwords. Active by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enableldap</option></term>
+ <listitem>
+ <para>
+ Turns on LDAP support in <filename>/etc/nsswitch.conf</filename>, allowing your system to retrieve information about users (for example, their UIDs, home directories, and shells) from an LDAP directory. To use this option, you must install the <package>nss-pam-ldapd</package> package. You must also specify a server and a base <firstterm>DN</firstterm> (distinguished name) with <option>--ldapserver=</option> and <option>--ldapbasedn=</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enableldapauth</option></term>
+ <listitem>
+ <para>
+ Use LDAP as an authentication method. This enables the <systemitem>pam_ldap</systemitem> module for authentication and changing passwords, using an LDAP directory. To use this option, you must have the <package>nss-pam-ldapd</package> package installed. You must also specify a server and a base DN with <option>--ldapserver=</option> and <option>--ldapbasedn=</option>. If your environment does not use <firstterm>TLS</firstterm> (Transport Layer Security), use the <option>--disableldaptls</option> switch to ensure that the resulting configuration file works.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ldapserver=</option></term>
+ <listitem>
+ <para>
+ If you specified either <option>--enableldap</option> or <option>--enableldapauth</option>, use this option to specify the name of the LDAP server to use. This option is set in the <filename>/etc/ldap.conf</filename> file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ldapbasedn=</option></term>
+ <listitem>
+ <para>
+ If you specified either <option>--enableldap</option> or <option>--enableldapauth</option>, use this option to specify the DN in your LDAP directory tree under which user information is stored. This option is set in the <filename>/etc/ldap.conf</filename> file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enableldaptls</option></term>
+ <listitem>
+ <para>
+ Use TLS (Transport Layer Security) lookups. This option allows LDAP to send encrypted usernames and passwords to an LDAP server before authentication.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--disableldaptls</option></term>
+ <listitem>
+ <para>
+ Do not use TLS (Transport Layer Security) lookups in an environment that uses LDAP for authentication.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enablekrb5</option></term>
+ <listitem>
+ <para>
+ Use Kerberos 5 for authenticating users. Kerberos itself does not know about home directories, UIDs, or shells. If you enable Kerberos, you must make users' accounts known to this workstation by enabling LDAP, NIS, or Hesiod or by using the <command>useradd</command> command. If you use this option, you must have the <package>pam_krb5</package> package installed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--krb5realm=</option></term>
+ <listitem>
+ <para>
+ The Kerberos 5 realm to which your workstation belongs.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--krb5kdc=</option></term>
+ <listitem>
+ <para>
+ The KDC (or KDCs) that serve requests for the realm. If you have multiple KDCs in your realm, use a comma-separated list without spaces.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--krb5adminserver=</option></term>
+ <listitem>
+ <para>
+ The KDC in your realm that is also running kadmind. This server handles password changing and other administrative requests. This server must be run on the master KDC if you have more than one KDC.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enablehesiod</option></term>
+ <listitem>
+ <para>
+ Enables Hesiod support for looking up user home directories, UIDs, and shells. More information on setting up and using Hesiod on your network is in <filename>/usr/share/doc/glibc-2.x.x/README.hesiod</filename>, which is included in the <package>glibc</package> package. Hesiod is an extension of DNS that uses DNS records to store information about users, groups, and various other items.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--hesiodlhs=</option> and <option>--hesiodrhs=</option></term>
+ <listitem>
+ <para>
+ The <systemitem>Hesiod</systemitem> LHS (left-hand side) and RHS (right-hand side) values, set in <filename>/etc/hesiod.conf</filename>. The <systemitem>Hesiod</systemitem> library uses these values to search DNS for a name, similar to the way that <systemitem>LDAP</systemitem> uses a base DN.
+ </para>
+ <para>
+ To look up user information for the username <systemitem>jim</systemitem>, the Hesiod library looks up <literal>jim.passwd<replaceable>LHS</replaceable><replaceable>RHS</replaceable></literal>, which should resolve to a TXT record that contains a string identical to an entry for that user in the <filename>passwd</filename> file: <computeroutput>jim:*:501:501:Jungle Jim:/home/jim:/bin/bash</computeroutput>. To look up groups, the Hesiod library looks up <literal>jim.group<replaceable>LHS</replaceable><replaceable>RHS</replaceable></literal> instead.
+ </para>
+ <para>
+ To look up users and groups by number, make <literal>501.uid</literal> a CNAME for <literal>jim.passwd</literal>, and <literal>501.gid</literal> a CNAME for <literal>jim.group</literal>. Note that the library does not place a period (<literal>.</literal>) in front of the LHS and RHS values when performing a search. Therefore, if the LHS and RHS values need to have a period placed in front of them, you must include the period in the values you set for <option>--hesiodlhs=</option> and <option>--hesiodrhs=</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enablesmbauth</option></term>
+ <listitem>
+ <para>
+ Enables authentication of users against an SMB server (typically a Samba or Windows server). SMB authentication support does not know about home directories, UIDs, or shells. If you enable SMB, you must make users' accounts known to the workstation by enabling LDAP, NIS, or Hesiod or by using the <command>useradd</command> command.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--smbservers=</option></term>
+ <listitem>
+ <para>
+ The name of the servers to use for SMB authentication. To specify more than one server, separate the names with commas (<literal>,</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--smbworkgroup=</option></term>
+ <listitem>
+ <para>
+ The name of the workgroup for the SMB servers.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enablecache</option></term>
+ <listitem>
+ <para>
+ Enables the <systemitem>nscd</systemitem> service. The <systemitem>nscd</systemitem> service caches information about users, groups, and various other types of information. Caching is especially helpful if you choose to distribute information about users and groups over your network using <systemitem>NIS</systemitem>, <systemitem>LDAP</systemitem>, or <systemitem>Hesiod</systemitem>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--passalgo=</option></term>
+ <listitem>
+ <para>
+ Specify <option>sha256</option> to set up the SHA-256 hashing algorithm or <option>sha512</option> to set up the SHA-512 hashing algorithm.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-group">
+ <title>group (optional) - Create User Group</title>
+ <para>
+ 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 <command>user</command> command can be used to create a new group for the newly created user.
+ </para>
+ <programlisting>
+<command>group --name=<replaceable>name</replaceable> [--gid=<replaceable>gid</replaceable>]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--name=</option></term>
+ <listitem>
+ <para>
+ Provides the name of the group.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--gid=</option></term>
+ <listitem>
+ <para>
+ The group ID (GID). If not provided, defaults to the next available non-system GID.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-realm">
+ <title>realm (optional) - Join an Active Directory or IPA Domain</title>
+ <para>
+ Join an Active Directory or IPA domain. For more information about this command, see the <command>join</command> section of the <systemitem>realm(8)</systemitem> man page.
+ </para>
+ <programlisting>
+<command>realm join <replaceable>domain</replaceable> [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--computer-ou=OU=</option></term>
+ <listitem>
+ <para>
+ Provide the <firstterm>distinguished name</firstterm> of an organizational unit in order to create the computer account. The exact format of the distinguished name depends on the client software and membership software. The root DSE portion of the distinguished name can usually be left out.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--no-password</option></term>
+ <listitem>
+ <para>
+ Join automatically without a password.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--one-time-password=</option></term>
+ <listitem>
+ <para>
+ Join using a one-time password. This is not possible with all types of realm.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--client-software=</option></term>
+ <listitem>
+ <para>
+ Only join realms which can run this client software. Valid values include <literal>sssd</literal> and <literal>winbind</literal>. Not all realms support all values. By default, the client software is chosen automatically.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--server-software=</option></term>
+ <listitem>
+ <para>
+ Only join realms which can run this server software. Possible values include <literal>active-directory</literal> or <literal>freeipa</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--enableldap</option></term>
+ <term><option>--membership-software=</option></term>
<listitem>
<para>
- Turns on LDAP support in <filename>/etc/nsswitch.conf</filename>, allowing your system to retrieve information about users (for example, their UIDs, home directories, and shells) from an LDAP directory. To use this option, you must install the <package>nss-pam-ldapd</package> package. You must also specify a server and a base <firstterm>DN</firstterm> (distinguished name) with <option>--ldapserver=</option> and <option>--ldapbasedn=</option>.
+ Use this software when joining the realm. Valid values include <literal>samba</literal> and <literal>adcli</literal>. Not all realms support all values. By default, the membership software is chosen automatically.
</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-rootpw">
+ <title>rootpw (required) - Set Root Password</title>
+ <para>
+ Sets the system's root password to the <replaceable>password</replaceable> argument.
+ </para>
+ <programlisting>
+<command>rootpw [--iscrypted|--plaintext] [--lock] <replaceable>password</replaceable></command>
+ </programlisting>
+ <variablelist>
<varlistentry>
- <term><option>--enableldapauth</option></term>
+ <term><option>--iscrypted</option></term>
<listitem>
<para>
- Use LDAP as an authentication method. This enables the <systemitem>pam_ldap</systemitem> module for authentication and changing passwords, using an LDAP directory. To use this option, you must have the <package>nss-pam-ldapd</package> package installed. You must also specify a server and a base DN with <option>--ldapserver=</option> and <option>--ldapbasedn=</option>. If your environment does not use <firstterm>TLS</firstterm> (Transport Layer Security), use the <option>--disableldaptls</option> switch to ensure that the resulting configuration file works.
+ If this option is present, the password argument is assumed to already be encrypted. This option is mutually exclusive with <option>--plaintext</option>. To create an encrypted password, you can use Python:
+ </para>
+ <screen>
+<prompt>$</prompt> <command>python -c 'import crypt; print(crypt.crypt("My Password", "$6$My Salt"))'</command>
+ </screen>
+ <para>
+ This will generate a SHA512 crypt of your password using your provided salt.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--ldapserver=</option></term>
+ <term><option>--plaintext</option></term>
<listitem>
<para>
- If you specified either <option>--enableldap</option> or <option>--enableldapauth</option>, use this option to specify the name of the LDAP server to use. This option is set in the <filename>/etc/ldap.conf</filename> file.
+ If this option is present, the password argument is assumed to be in plain text. This option is mutually exclusive with <option>--iscrypted</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--ldapbasedn=</option></term>
+ <term><option>--lock</option></term>
<listitem>
<para>
- If you specified either <option>--enableldap</option> or <option>--enableldapauth</option>, use this option to specify the DN in your LDAP directory tree under which user information is stored. This option is set in the <filename>/etc/ldap.conf</filename> file.
+ If this option is present, the root account is locked by default. This means that the root user will not be able to log in from the console.
</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-selinux">
+ <title>selinux (optional) - Configure SELinux</title>
+ <para>
+ Sets the state of SELinux on the installed system. The default policy is <systemitem>enforcing</systemitem>. For more information regarding SELinux in &PRODUCT;, see <remark>TODO: link to wherever we document SELinux now</remark>
+ </para>
+ <programlisting>
+<command>selinux [--disabled|--enforcing|--permissive]</command>
+ </programlisting>
+ <variablelist>
<varlistentry>
- <term><option>--enableldaptls</option></term>
+ <term><option>--enforcing</option></term>
<listitem>
<para>
- Use TLS (Transport Layer Security) lookups. This option allows LDAP to send encrypted usernames and passwords to an LDAP server before authentication.
+ Enables SELinux with the default targeted policy being <systemitem>enforcing</systemitem>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--disableldaptls</option></term>
+ <term><option>--permissive</option></term>
<listitem>
<para>
- Do not use TLS (Transport Layer Security) lookups in an environment that uses LDAP for authentication.
+ Enables SELinux with the default targeted policy being <systemitem>permissive</systemitem>. This policy outputs warnings based on the SELinux policy, but does not actually enforce the policy.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--enablekrb5</option></term>
+ <term><option>--disabled</option></term>
<listitem>
<para>
- Use Kerberos 5 for authenticating users. Kerberos itself does not know about home directories, UIDs, or shells. If you enable Kerberos, you must make users' accounts known to this workstation by enabling LDAP, NIS, or Hesiod or by using the <command>useradd</command> command. If you use this option, you must have the <package>pam_krb5</package> package installed.
+ Disables SELinux completely.
</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="sect-kickstart-commands-user">
+ <title>user (optional) - Create User Account</title>
+ <para>
+ Creates a new user on the system.
+ </para>
+ <programlisting>
+<command>user --name=<replaceable>username</replaceable> [<replaceable>options</replaceable>]</command>
+ </programlisting>
+ <variablelist>
<varlistentry>
- <term><option>--krb5realm=</option></term>
+ <term><option>--name=</option></term>
<listitem>
<para>
- The Kerberos 5 realm to which your workstation belongs.
+ Provides the name of the user. This option is required.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--krb5kdc=</option></term>
+ <term><option>--gecos=</option></term>
<listitem>
<para>
- The KDC (or KDCs) that serve requests for the realm. If you have multiple KDCs in your realm, use a comma-separated list without spaces.
+ 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, etc. See the <systemitem>passwd(5)</systemitem> man page for more details.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--krb5adminserver=</option></term>
+ <term><option>--groups=</option></term>
<listitem>
<para>
- The KDC in your realm that is also running kadmind. This server handles password changing and other administrative requests. This server must be run on the master KDC if you have more than one KDC.
+ In addition to the default group, a comma separated list of group names the user should belong to. The groups must exist before the user account is created. See <xref linkend="sect-kickstart-commands-group" />.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--enablehesiod</option></term>
+ <term><option>--homedir=</option></term>
<listitem>
<para>
- Enables Hesiod support for looking up user home directories, UIDs, and shells. More information on setting up and using Hesiod on your network is in <filename>/usr/share/doc/glibc-2.x.x/README.hesiod</filename>, which is included in the <package>glibc</package> package. Hesiod is an extension of DNS that uses DNS records to store information about users, groups, and various other items.
+ The home directory for the user. If not provided, this defaults to <filename>/home/<replaceable>username</replaceable></filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--hesiodlhs=</option> and <option>--hesiodrhs=</option></term>
+ <term><option>--lock</option></term>
<listitem>
<para>
- The <systemitem>Hesiod</systemitem> LHS (left-hand side) and RHS (right-hand side) values, set in <filename>/etc/hesiod.conf</filename>. The <systemitem>Hesiod</systemitem> library uses these values to search DNS for a name, similar to the way that <systemitem>LDAP</systemitem> uses a base DN.
- </para>
- <para>
- To look up user information for the username <systemitem>jim</systemitem>, the Hesiod library looks up <literal>jim.passwd<replaceable>LHS</replaceable><replaceable>RHS</replaceable></literal>, which should resolve to a TXT record that contains a string identical to an entry for that user in the <filename>passwd</filename> file: <computeroutput>jim:*:501:501:Jungle Jim:/home/jim:/bin/bash</computeroutput>. To look up groups, the Hesiod library looks up <literal>jim.group<replaceable>LHS</replaceable><replaceable>RHS</replaceable></literal> instead.
- </para>
- <para>
- To look up users and groups by number, make <literal>501.uid</literal> a CNAME for <literal>jim.passwd</literal>, and <literal>501.gid</literal> a CNAME for <literal>jim.group</literal>. Note that the library does not place a period (<literal>.</literal>) in front of the LHS and RHS values when performing a search. Therefore, if the LHS and RHS values need to have a period placed in front of them, you must include the period in the values you set for <option>--hesiodlhs=</option> and <option>--hesiodrhs=</option>.
+ If this option is present, this account is locked by default. This means that the user will not be able to log in from the console.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--enablesmbauth</option></term>
+ <term><option>--password=</option></term>
<listitem>
<para>
- Enables authentication of users against an SMB server (typically a Samba or Windows server). SMB authentication support does not know about home directories, UIDs, or shells. If you enable SMB, you must make users' accounts known to the workstation by enabling LDAP, NIS, or Hesiod or by using the <command>useradd</command> command.
+ The new user's password. If no password is provided, the account will be locked.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--smbservers=</option></term>
+ <term><option>--password=</option></term>
<listitem>
<para>
- The name of the servers to use for SMB authentication. To specify more than one server, separate the names with commas (<literal>,</literal>).
+ The new user's password. If not provided, the account will be locked by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--smbworkgroup=</option></term>
+ <term><option>--iscrypted</option></term>
<listitem>
<para>
- The name of the workgroup for the SMB servers.
+ If this option is present, the password argument is assumed to already be encrypted. This option is mutually exclusive with <option>--plaintext</option>. To create an encrypted password, you can use Python:
+ </para>
+ <screen>
+<prompt>$</prompt> <command>python -c 'import crypt; print(crypt.crypt("My Password", "$6$My Salt"))'</command>
+ </screen>
+ <para>
+ This will generate a SHA512 crypt of your password using your provided salt.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--enablecache</option></term>
+ <term><option>--plaintext</option></term>
<listitem>
<para>
- Enables the <systemitem>nscd</systemitem> service. The <systemitem>nscd</systemitem> service caches information about users, groups, and various other types of information. Caching is especially helpful if you choose to distribute information about users and groups over your network using <systemitem>NIS</systemitem>, <systemitem>LDAP</systemitem>, or <systemitem>Hesiod</systemitem>.
+ If this option is present, the password argument is assumed to be in plain text. This option is mutually exclusive with <option>--iscrypted</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--passalgo=</option></term>
+ <term><option>--shell=</option></term>
<listitem>
<para>
- Specify <option>sha256</option> to set up the SHA-256 hashing algorithm or <option>sha512</option> to set up the SHA-512 hashing algorithm.
+ The user's login shell. If not provided, the system default will be used.
</para>
</listitem>
</varlistentry>
- </variablelist>
- </section>
-
- <section id="sect-kickstart-commands-group">
- <title>group - Create User Group</title>
- <para>
- 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 <command>user</command> command can be used to create a new group for the newly created user.
- </para>
- <programlisting>
-<command>group --name=<replaceable>name</replaceable> [--gid=<replaceable>gid</replaceable>]</command>
- </programlisting>
- <variablelist>
<varlistentry>
- <term><option>--name=</option></term>
+ <term><option>--uid=</option></term>
<listitem>
<para>
- Provides the name of the group.
+ The <firstterm>UID</firstterm> (User ID). If not provided, this defaults to the next available non-system UID.
</para>
</listitem>
</varlistentry>
@@ -1449,41 +3019,13 @@
<term><option>--gid=</option></term>
<listitem>
<para>
- The group ID (GID). If not provided, defaults to the next available non-system GID.
+ The <firstterm>GID</firstterm> (Group ID) to be used for the user's default group. If not provided, this defaults to the next available non-system group ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
- <section id="sect-kickstart-commands-realm">
- <title>realm - Join an Active Directory or IPA Domain</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-rootpw">
- <title>rootpw - Set Root Password</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-selinux">
- <title>selinux - Configure SELinux</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-kickstart-commands-user">
- <title>user - Create User Account</title>
- <para>
- text
- </para>
- </section>
-
</section>
<section id="sect-kickstart-commands-installation-environment">
@@ -1527,74 +3069,175 @@
</section>
<section id="sect-kickstart-commands-logging">
- <title>logging - Configure Error Logging During Installation</title>
+ <title>logging (optional) - Configure Error Logging During Installation</title>
<para>
- Controls the error logging of <application>Anaconda</application> during installation. It has no effect on the installed system.
- </para>
- <programlisting>
+ Controls the error logging of <application>Anaconda</application> during installation. It has no effect on the installed system.
+ </para>
+ <programlisting>
<command>logging [--host= | --port= | --level=]</command>
- </programlisting>
- <variablelist>
- <varlistentry>
- <term><option>--host=</option></term>
- <listitem>
- <para>
- Send logging information to the given remote host, which must be running a <systemitem class="service">syslogd</systemitem> process configured to accept remote logging.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--port=</option></term>
- <listitem>
- <para>
- If the remote syslogd process uses a port other than the default, it may be specified with this option.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--level=</option></term>
- <listitem>
- <para>
- Specify the minimum level of messages that appear on virtual console 3 (<systemitem>tty3</systemitem>). This only affects messages printed to the console; log files will contain messages of all levels. Possible values are <literal>debug</literal>, <literal>info</literal>, <literal>warning</literal>, <literal>error</literal>, or <literal>critical</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--host=</option></term>
+ <listitem>
+ <para>
+ Send logging information to the given remote host, which must be running a <systemitem class="service">syslogd</systemitem> process configured to accept remote logging.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--port=</option></term>
+ <listitem>
+ <para>
+ If the remote syslogd process uses a port other than the default, it may be specified with this option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--level=</option></term>
+ <listitem>
+ <para>
+ Specify the minimum level of messages that appear on virtual console 3 (<systemitem>tty3</systemitem>). This only affects messages printed to the console; log files will contain messages of all levels. Possible values are <literal>debug</literal>, <literal>info</literal>, <literal>warning</literal>, <literal>error</literal>, or <literal>critical</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-rescue">
- <title>rescue - Rescue Mode</title>
+ <title>rescue (optional) - Rescue Mode</title>
<para>
- text
+ Automatically enters the installation program's rescue mode. This gives you a chance to repair the system in case of any problems.
</para>
+ <programlisting>
+<command>rescue [--nomount|--romount]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--nomount</option> or <option>--romount</option></term>
+ <listitem>
+ <para>
+ Controls how the installed system is mounted in the rescue environment. By default, the installation program 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 (the <option>--nomount</option> option) or mount in read-only mode (the <option>--romount</option> option). Only one of these two options may be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-sshpw">
- <title>sshpw - Restrict ssh Access During Installation</title>
+ <title>sshpw (optional) - Restrict ssh Access During Installation</title>
<para>
- text
+ During the installation, you can interact with the installation program and monitor its progress over an <systemitem>SSH</systemitem> connection. Use the <command>sshpw</command> command to create temporary accounts through which to log on. Each instance of the command creates a separate account that exists only in the installation environment. These accounts are not transferred to the installed system.
</para>
+ <programlisting>
+<command>sshpw --username=<replaceable>name</replaceable> <replaceable>password</replaceable> [--iscrypted|--plaintext] [--lock]</command>
+ </programlisting>
+ <important>
+ <para>
+ By default, the <systemitem>ssh</systemitem> server is not started during the installation. To make <systemitem>ssh</systemitem> available during the installation, boot the system with the kernel boot option <option>inst.sshd</option>. See <xref linkend="sect-boot-options-display" /> for details.
+ </para>
+ </important>
+ <note>
+ <para>
+ If you want to disable root <systemitem class="protocol">ssh</systemitem> access to your hardware during installation, use the following:
+ </para>
+ <programlisting>
+<command>sshpw --username=root --lock</command>
+ </programlisting>
+ </note>
+ <variablelist>
+ <varlistentry>
+ <term><option>--username</option></term>
+ <listitem>
+ <para>
+ Provides the name of the user. This option is required.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--iscrypted</option></term>
+ <listitem>
+ <para>
+ If this option is present, the password argument is assumed to already be encrypted. This option is mutually exclusive with <option>--plaintext</option>. To create an encrypted password, you can use Python:
+ </para>
+ <screen>
+<prompt>$</prompt> <command>python -c 'import crypt; print(crypt.crypt("My Password", "$6$My Salt"))'</command>
+ </screen>
+ <para>
+ This will generate a SHA512 crypt of your password using your provided salt.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--plaintext</option></term>
+ <listitem>
+ <para>
+ If this option is present, the password argument is assumed to be in plain text. This option is mutually exclusive with <option>--iscrypted</option>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--lock</option></term>
+ <listitem>
+ <para>
+ If this option is present, this account is locked by default. This means that the user will not be able to log in from the console.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-text">
- <title>text - Perform Installation in Text Mode</title>
+ <title>text (optional) - Perform Installation in Text Mode</title>
<para>
- text
+ Perform the Kickstart installation in text mode. Kickstart installations are performed in graphical mode by default.
</para>
</section>
<section id="sect-kickstart-commands-unsupported_hardware">
- <title>unsupported_hardware - Suppress Unsupported Hardware Alerts</title>
+ <title>unsupported_hardware (optional) - Suppress Unsupported Hardware Alerts</title>
<para>
- text
+ Suppress the <guilabel>Unsupported Hardware Detected</guilabel> alert. If this command is not included and unsupported hardware is detected, the installation will stall at this alert.
</para>
</section>
<section id="sect-kickstart-commands-vnc">
- <title>vnc - Configure VNC Access</title>
+ <title>vnc (optional) - Configure VNC Access</title>
<para>
- text
+ 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 installations. With no additional options, this command will start a VNC server on the installation system with no password and will display the details required to connect to it.
+ </para>
+ <programlisting>
+<command>vnc [--host=<replaceable>hostname</replaceable>] [--port=<replaceable>port</replaceable>] [--password=<replaceable>password</replaceable>]</command>
+ </programlisting>
+ <para>
+ For more information about VNC installations, including instructions on how to connect to the installation system, see <xref linkend="chap-vnc-installations" />.
</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--host=</option></term>
+ <listitem>
+ <para>
+ Connect to a VNC viewer listening on the given hostname.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--port=</option></term>
+ <listitem>
+ <para>
+ Provide a port that the remote VNC viewer process is listening on. If not provided, the VNC default (<literal>5900</literal>) will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--password=</option></term>
+ <listitem>
+ <para>
+ Set a password which must be provided to connect to the VNC session. This is optional, but recommended.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</section>
@@ -1664,47 +3307,85 @@
Halt the system after the installation has successfully completed. This is similar to a manual installation, where after the installation finishes, the installer displays a message and waits for the user to press a key before rebooting. During a Kickstart installation, if no completion method is specified, this option is used as the default.
</para>
<para>
- The <command>halt</command> command is equivalent to the <command>shutdown -h</command> command.
- </para>
- <para>
For other completion methods, see the <command>poweroff</command>, <command>reboot</command>, and <command>shutdown</command> commands.
</para>
</section>
<section id="sect-kickstart-commands-poweroff">
- <title>poweroff - Power Off After Installation</title>
+ <title>poweroff (optional) - Power Off After Installation</title>
+ <para>
+ Shut down and power off the system after the installation has successfully completed.
+ </para>
+ <note>
+ <para>
+ The <command>poweroff</command> command is highly dependent on the system hardware in use. Specifically, certain hardware components such as the BIOS, APM (advanced power management), and ACPI (advanced configuration and power interface) must be able to interact with the system kernel. Consult your hardware documentation for more information on you system's APM/ACPI abilities.
+ </para>
+ </note>
<para>
- text
+ For other completion methods, see the <command>halt</command>, <command>reboot</command>, and <command>shutdown</command> Kickstart commands.
</para>
</section>
<section id="sect-kickstart-commands-reboot">
- <title>reboot - Reboot After Installation</title>
+ <title>reboot (optional) - Reboot After Installation</title>
<para>
- text
+ Reboot after the installation is successfully completed. If you are installing &PRODUCT; on IBM System z in command line mode (using <xref linkend="sect-kickstart-commands-cmdline" />), this command is necessary for a fully automated installation.
+ </para>
+ <para>
+ For other completion methods, see the <command>halt</command>, <command>poweroff</command>, and <command>shutdown</command> Kickstart options.
</para>
+ <important>
+ <para>
+ Use of the <command>reboot</command> command <emphasis>may</emphasis> result in an endless installation loop, depending on the installation media and method.
+ </para>
+ </important>
+ <variablelist>
+ <varlistentry>
+ <term><option>--eject</option></term>
+ <listitem>
+ <para>
+ Attempt to eject the installation media (if installing from a DVD) before rebooting.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-shutdown">
- <title>shutdown - Shut Down After Installation</title>
+ <title>shutdown (optional) - Shut Down After Installation</title>
<para>
- text
+ Shut down the system after the installation has successfully completed.
+ </para>
+ <para>
+ For other completion methods, see the <command>halt</command>, <command>poweroff</command>, and <command>reboot</command> Kickstart options.
</para>
</section>
</section>
<section id="sect-kickstart-commands-include">
- <title>%include - Include Contents of Another File</title>
+ <title>%include (optional) - Include Contents of Another File</title>
+ <para>
+ Use the <command>%include <replaceable>/path/to/file</replaceable></command> command to include the contents of another file in the Kickstart file as though the contents were at the location of the <command>%include</command> command in the Kickstart file.
+ </para>
+ </section>
+ <section id="sect-kickstart-commands-ksappend">
+ <title>%ksappend (optional) - Append Contents of Another File</title>
+ <para>
+ The <command>%ksappend <replaceable>url</replaceable></command> directive is very similar to <xref linkend="sect-kickstart-commands-include" /> in that it is used to include the contents of additional files as though they were at the location of the <command>%ksappend</command> command. The difference is in when the two directives are processed.
+ </para>
<para>
- text
+ <command>%ksappend</command> 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 <application>Anaconda</application> where all <command>%pre</command> scripts are handled, and then finally the rest of the Kickstart file is processed in order, which includes <command>%include</command> directives.
+ </para>
+ <para>
+ Therefore, <command>%ksappend</command> provides a way to include a file containing <command>%pre</command> scripts, while <command>%include</command> does not.
</para>
</section>
<section id="sect-kickstart-packages">
- <title>%packages - Package Selection</title>
+ <title>%packages (required) - Package Selection</title>
<para>
- Use the <command>%packages</command> command to begin a Kickstart section which describes the software packages to be installed.
+ Use the <command>%packages</command> command to begin a Kickstart section which describes the software packages to be installed. This section must end with an <command>%end</command> statement.
</para>
<para>
You can specify packages by <firstterm>environment</firstterm>, <firstterm>group</firstterm>, or by their package names. Several environments and groups that contain related packages are defined. See the <filename>repodata/*-comps-<replaceable>variant</replaceable>.<replaceable>architecture</replaceable>.xml</filename> file <remark>TODO: where's comps.xml?</remark>
@@ -1725,9 +3406,6 @@
<application>Initial Setup</application> does not run after a system is installed from a Kickstart file unless a desktop environment and the <application>X Window System</application> were included in the installation and graphical login was enabled. This means that by default, no users except for <systemitem class="username">root</systemitem> will be created. You can either create a user with the <option>user</option> option in the Kickstart file before installing additional systems from it (see <xref linkend="sect-kickstart-commands-user" /> for details) or log into the installed system with a virtual console as <systemitem class="username">root</systemitem> and add users with the <command>useradd</command> command.
</para>
</important>
- <para>
- The <command>%packages</command> section must end with the <command>%end</command> command.
- </para>
<variablelist>
<title>Specifying Environments, Groups and Packages</title>
<varlistentry>
@@ -1899,7 +3577,7 @@ docbook*
</section>
<section id="sect-kickstart-preinstall">
- <title>%pre - Pre-installation Script</title>
+ <title>%pre (optional) - Pre-installation Script</title>
<para>
You can add commands to run on the system immediately after the Kickstart file has been parsed, but before the installation begins. This section must be placed towards the end of the Kickstart file, after the actual Kickstart commands, and must start with <command>%pre</command> and end with <command>%end</command>. If your Kickstart file also includes a <command>%post</command> section, the order in which the <command>%pre</command> and <command>%post</command> sections are included does not matter.
</para>
@@ -1957,7 +3635,7 @@ docbook*
</section>
<section id="sect-kickstart-postinstall">
- <title>%post - Post-installation Script</title>
+ <title>%post (optional) - Post-installation Script</title>
<para>
You have the option of adding commands to run on the system once the installation is complete, but before the system is rebooted for the first time. This section must be placed towards the end of the Kickstart file, after the actual Kickstart commands, and must start with <command>%post</command> and end with <command>%end</command>. If your Kickstart file also includes a <command>%pre</command> section, the order of the <command>%pre</command> and <command>%post</command> sections does not matter.
</para>
More information about the docs-commits
mailing list