<chapter id="jumpstartreference-1"><title>Custom JumpStart (Reference)</title><highlights><para>This chapter lists keywords and values that you can use in the <filename>rules</filename> file, profiles, and begin and finish scripts.</para><itemizedlist><listitem><para><olink targetptr="preparecustom-74" remap="internal">Rule Keywords and Values</olink></para>
</listitem><listitem><para><olink targetptr="preparecustom-24696" remap="internal">Profile Keywords and
Values</olink></para>
</listitem><listitem><para><olink targetptr="jumpstartreference-4" remap="internal">Custom JumpStart Environment
Variables</olink></para>
</listitem><listitem><para><olink targetptr="jumpstartreference-6" remap="internal">Probe Keywords and
Values</olink></para>
</listitem>
</itemizedlist>
</highlights><sect1 id="preparecustom-74"><title>Rule Keywords and Values</title><para><olink targetptr="preparecustom-12638" remap="internal">Table 8&ndash;1</olink> describes
the keywords and values that you can use in the <filename>rules</filename> file.
For detailed instructions to create a <filename>rules</filename> file, see <olink targetptr="preparecustom-56059" remap="internal">Creating the rules File</olink>.</para><table frame="topbot" pgwide="1" id="preparecustom-12638"><title>Descriptions
of Rule Keywords and Values</title><tgroup cols="3" colsep="0" rowsep="0"><colspec colname="column1" colwidth="61*"/><colspec colname="column2" colwidth="182*"/><colspec colname="column3" colwidth="153*"/><thead><row rowsep="1"><entry><para>Keyword</para>
</entry><entry><para>Value</para>
</entry><entry><para>Matches</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>any</literal>  </para>
</entry><entry><para>minus sign (<literal>-</literal>)</para>
</entry><entry><para>Anything. The <literal>any</literal> keyword always succeeds.</para>
</entry>
</row><row><entry><para><literal>arch</literal>     </para>
</entry><entry><para><replaceable>processor_type</replaceable></para><para>Valid values for <replaceable>processor_type</replaceable> are the following:</para><itemizedlist><listitem><para>SPARC: <literal>sparc</literal></para>
</listitem><listitem><para>x86: <literal>i386</literal></para>
</listitem>
</itemizedlist>
</entry><entry><para>A system's processor type.</para><para>The <command>uname -p</command> command reports the system's processor
type.</para>
</entry>
</row><row><entry><para><literal>disksize</literal> 
  </para>
</entry><entry><para><replaceable>actual_disk_name</replaceable> <replaceable>size_range</replaceable></para><para><replaceable>actual_disk_name</replaceable> &ndash; A disk name in the
form <literal>c</literal><replaceable>x</replaceable><literal>t</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable>, such as <literal>c0t3d0</literal> or <literal>c0d0</literal>, or the special word <literal>rootdisk</literal>. If <literal>rootdisk</literal> is used, the disk to be matched
is determined in the following order:</para><itemizedlist><listitem><para>SPARC: The disk that contains the preinstalled boot image,
which is a new SPARC based system with factory JumpStart installed</para>
</listitem><listitem><para>The <literal>c0t3d0s0</literal> disk, if the disk exists</para>
</listitem><listitem><para>The first available disk that is searched in kernel probe
order</para>
</listitem>
</itemizedlist><para><replaceable>size_range</replaceable> &ndash; The size of the disk,
which must be specified as a range of Mbytes (<replaceable>x</replaceable>-<replaceable>x</replaceable>).</para><note><para>When calculating <replaceable>size_range</replaceable>, remember
that a Mbyte equals 1,048,576 bytes. A disk might be advertised as a &ldquo;535&ndash;Mbyte&rdquo;
disk, but the disk might contain only 510 million bytes of disk space. The
JumpStart program views the &ldquo;535&ndash;Mbyte&rdquo; disk as a 510&ndash;Mbyte
disk because 535,000,000 / 1,048,576 = 510. A &ldquo;535&ndash;Mbyte&rdquo;
disk does not match a <replaceable>size_range</replaceable> equal to 530&ndash;550.</para>
</note>
</entry><entry><para>The name and size of a system's disk in Mbytes.</para><para>Example: </para><programlisting role="complete">disksize c0t3d0 250-300</programlisting><para>In the example, the JumpStart program attempts to match a system disk
that is named <literal>c0t3d0</literal>. The disk can hold between 250 and
300 Mbytes of information.</para><para>Example: </para><programlisting role="complete">disksize rootdisk 750-1000</programlisting><para>In the example, the JumpStart program attempts to match a disk in the
following order:</para><orderedlist><listitem><para>A system disk that contains a preinstalled boot image</para>
</listitem><listitem><para>The <literal>c0t3d0s0</literal> disk, if the disk exists</para>
</listitem><listitem><para>The first available disk that can hold between 750 Mbytes
and 1 Gbyte of information</para>
</listitem>
</orderedlist>
</entry>
</row><row><entry><para><literal>domainname</literal>   </para>
</entry><entry><para><replaceable>actual_domain_name</replaceable></para>
</entry><entry><para>A system's domain name, which controls how a naming service determines
information. </para><para>If you have a system already installed, the <command>domainname</command> command
reports the system's domain name.</para>
</entry>
</row><row><entry><para><literal>hostaddress</literal>   </para>
</entry><entry><para><replaceable>actual_IP_address</replaceable></para>
</entry><entry><para>A system's IP address.</para>
</entry>
</row><row><entry><para><literal>hostname</literal>   </para>
</entry><entry><para><replaceable>actual_host_name</replaceable></para>
</entry><entry><para>A system's host name. </para><para>If you have a system that is already installed, the <command>uname -n</command> command
reports the system's host name.</para>
</entry>
</row><row><entry><para><literal>installed</literal>      </para>
</entry><entry><para><replaceable>slice</replaceable> <replaceable>version</replaceable></para><para><replaceable>slice</replaceable> &ndash; A disk slice name in the form <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable>,
such as <literal>c0t3d0s5</literal>, or the special words <literal>any</literal> or <literal>rootdisk</literal>. If <literal>any</literal> is used, the JumpStart program
attempts to match all of the system's disks in kernel probe order. If <literal>rootdisk</literal> is used, the disk to be matched is determined in the following
order:</para><itemizedlist><listitem><para>SPARC: The disk that contains the preinstalled boot image,
which is a new SPARC based system with factory JumpStart installed</para>
</listitem><listitem><para>The <literal>c0t3d0s0</literal> disk, if the disk exists</para>
</listitem><listitem><para>The first available disk that is searched in kernel probe
order</para>
</listitem>
</itemizedlist><para><replaceable>version</replaceable> &ndash; A version name or the special
words <literal>any</literal> or <literal>upgrade</literal>. If <literal>any</literal> is
used, any Solaris or SunOS release is matched. If <literal>upgrade</literal> is
used, any Solaris release that is supported and can be upgraded is matched.</para><para>If the JumpStart program finds a Solaris release but is unable to determine
the version, the version that is returned is <literal>SystemV</literal>.</para>
</entry><entry><para>A disk that has a root (<filename>/</filename>) file system that corresponds
to a particular version of Solaris software.</para><para>Example: </para><programlisting role="complete">installed c0t3d0s1 Solaris 11</programlisting><para>In the example, the JumpStart program attempts to match a system that
has a Solaris root (<filename>/</filename>) file system on <literal>c0t3d0s1</literal>.</para>
</entry>
</row><row><entry><para><literal>karch</literal>   </para>
</entry><entry><para><replaceable>actual_platform_group</replaceable></para><para>Valid values are <literal>sun4u</literal>, <literal>i86pc</literal>,
and <literal>prep</literal>. A list of systems and their corresponding platform
group is presented in the <citetitle>Solaris Sun Hardware Platform Guide</citetitle> at <ulink url="http://docs.sun.com" type="url">http://docs.sun.com</ulink>.</para>
</entry><entry><para>A system's platform group.</para><para>If you have a system that is already installed, the <command>arch -k</command> command
or the <command>uname -m</command> command reports the system's platform group.</para>
</entry>
</row><row><entry><para><literal>memsize</literal>    </para>
</entry><entry><para><replaceable>physical_mem</replaceable></para><para>The value must be a range of Mbytes, <replaceable>x</replaceable>-<replaceable>x</replaceable>, or a single Mbyte value.</para>
</entry><entry><para>A system's physical memory size in Mbytes.</para><para>Example: </para><programlisting role="complete">memsize 64-128</programlisting><para>The example tries to match a system with a physical memory size between
64 and 128 Mbytes.</para><para>If you have a system that is already installed, the output of the <command>prtconf</command> command, line 2, reports the system's physical memory size. </para>
</entry>
</row><row><entry><para><literal>model</literal> 
  </para>
</entry><entry><para><replaceable>actual_platform_name</replaceable></para>
</entry><entry><para>A system's platform name. See the <citetitle>Solaris Sun Hardware Platform
Guide</citetitle> at <ulink url="http://docs.sun.com" type="url">http://docs.sun.com</ulink> for a list of valid platform names.</para><para>To find the platform name of an installed system, use the <literal>uname
-i</literal> command or the output of the <command>prtconf</command> command,
line 5.</para><note><para>If the <replaceable>actual_platform_name</replaceable> contains
spaces, you must replace spaces with underscores (_). </para><para>Example: </para><para>SUNW,Sun_4_50</para>
</note>
</entry>
</row><row><entry><para><literal>network</literal>   </para>
</entry><entry><para><replaceable>network_num</replaceable></para>
</entry><entry><para>A system's network number, which the JumpStart program determines by
performing a logical AND between the system's IP address and the subnet mask. </para><para>Example: </para><programlisting role="complete">network 192.168.2.0</programlisting><para>The example tries to match a system with a 192.168.2.8 IP address, if
the subnet mask is 255.255.255.0.</para>
</entry>
</row><row><entry><para><literal>osname</literal>     </para>
</entry><entry><para><literal>Solaris_</literal><replaceable>x</replaceable></para>
</entry><entry><para>A version of Solaris software that is already installed on a system. </para><para>Example: </para><programlisting role="complete">osname Solaris 11</programlisting><para>In the example, the JumpStart program attempts to match a system with
the Solaris Express 5/07 OS already installed.</para>
</entry>
</row><row><entry><para><literal>probe</literal> </para>
</entry><entry><para><replaceable>probe_keyword</replaceable></para>
</entry><entry><para>A valid probe keyword or a valid custom probe keyword.</para><para>Example: </para><programlisting role="complete">probe disks</programlisting><para>The example returns the size of a system's disks in Mbytes and in kernel
probe order, for example, <literal>c0t3d0s1</literal>, <literal>c0t4d0s0</literal>,
on a SPARC based system. The JumpStart program sets the <envar>SI_DISKLIST</envar>, <envar>SI_DISKSIZES</envar>, <envar>SI_NUMDISKS</envar>, and <envar>SI_TOTALDISK</envar> environment
variables.</para><note><para>The <literal>probe</literal> keyword is unique in that the keyword
does not attempt to match an attribute and run a profile. The <literal>probe</literal> keyword
returns a value. Consequently, you cannot specify begin scripts, profiles,
and finish scripts with the <literal>probe</literal> rule keyword.</para>
</note><para>Probe keywords are described in <olink targetptr="customprobes-1" remap="internal">Chapter&nbsp;5,
Creating Custom Rule and Probe Keywords (Tasks)</olink>.</para>
</entry>
</row><row><entry><para><literal>totaldisk</literal>    </para>
</entry><entry><para><replaceable>size_range</replaceable></para><para>The value must be specified as a range of Mbytes (<replaceable>x</replaceable>-<replaceable>x</replaceable>).</para><note><para>When calculating <replaceable>size_range</replaceable>, remember
that one Mbyte equals 1,048,576 bytes. A disk might be advertised as a &ldquo;535&ndash;Mbyte&rdquo;
disk, but the disk might have only 510 million bytes of disk space. The JumpStart
program views the &ldquo;535&ndash;Mbyte&rdquo; disk as a 510&ndash;Mbyte
disk because 535,000,000 / 1,048,576 = 510. A &ldquo;535&ndash;Mbyte&rdquo;
disk does not match a <replaceable>size_range</replaceable> equal to 530&ndash;550.</para>
</note>
</entry><entry><para>The total disk space on a system in Mbytes. The total disk space includes
all the operational disks that are attached to a system.</para><para>Example: </para><programlisting role="complete">totaldisk 300-500</programlisting><para>In the example, the JumpStart program tries to match a system with a
total disk space between 300 and 500 Mbytes.</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1><sect1 id="preparecustom-24696"><title>Profile Keywords and Values</title><para>This section describes the profile keywords and values that you can
use in a profile. For detailed instructions to create a profile, see <olink targetptr="preparecustom-53442" remap="internal">Creating a Profile</olink>.</para><sect2 id="jumpstartreference-8"><title>Profile Keywords Quick Reference</title><para><olink targetptr="preparecustom-tbl-118" remap="internal">Table 8&ndash;2</olink> provides
a quick way to determine which keywords you can use, based on your installation
scenario. Unless otherwise noted in the keyword descriptions, the keyword
can only be used with the initial installation option. </para><table frame="all" pgwide="1" id="preparecustom-tbl-118"><title>Profile Keywords
Overview</title><tgroup cols="6" colsep="1" rowsep="1"><colspec colname="col1" colwidth="110*"/><colspec colname="col2" colwidth="66*"/><colspec colname="colspec0" colwidth="58*"/><colspec colname="colspec1" colwidth="54*"/><colspec colname="colspec2" colwidth="48*"/><colspec colname="col6" colwidth="60*"/><thead><row><entry>
</entry><entry namest="col2" nameend="col6"><para>Installation Scenarios</para>
</entry>
</row><row><entry><para>Profile Keyword</para>
</entry><entry><para>Standalone System (Nonnetworked)</para>
</entry><entry><para>Standalone System (Networked) or Server</para>
</entry><entry><para>OS Server</para>
</entry><entry><para>Upgrade</para>
</entry><entry><para>Upgrade With Disk Space Reallocation</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>archive_location</literal> (installing Solaris Flash archives)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>backup_media</literal></para>
</entry><entry>
</entry><entry>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>boot_device</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>bootenv createbe</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>client_arch</literal></para>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>client_root</literal></para>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>client_swap</literal></para>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>cluster</literal> (adding software groups)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>cluster</literal> (adding or deleting clusters)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>dontuse</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>fdisk</literal> (x86 only)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>filesys</literal> (mounting remote file systems)</para>
</entry><entry>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>filesys</literal> (creating local file systems)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>filesys</literal> (creating mirrored file systems)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>forced_deployment</literal> (installing Solaris Flash differential
archives)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>geo</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>install_type</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>layout_constraint</literal></para>
</entry><entry>
</entry><entry>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>local_customization</literal> (installing Solaris Flash archives)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>locale</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>metadb</literal> (creating state database replicas)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>no_master_check</literal> (installing Solaris Flash differential
archives)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>no_content_check</literal> (installing Solaris Flash differential
archives)</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>num_clients</literal></para>
</entry><entry>
</entry><entry>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row><row><entry><para><literal>package</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>partitioning</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>patch</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>root_device</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry>
</row><row><entry><para><literal>system_type</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para></para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>usedisk</literal></para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry><para>X</para>
</entry><entry>
</entry><entry>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2><sect2 id="jumpstartreference-10"><title>Profile Keyword Descriptions and
Examples</title><sect3 id="preparecustom-2"><title><literal>archive_location</literal> Keyword</title><programlisting role="complete">archive_location <replaceable>retrieval_type</replaceable> <replaceable>location</replaceable></programlisting><variablelist><varlistentry><term><replaceable>retrieval_type</replaceable></term><listitem><para>The values of <replaceable>retrieval_type</replaceable> and <replaceable>location</replaceable> depend on where the Solaris Flash archive is stored.
The following sections contain the values you can use for <replaceable>retrieval_type</replaceable> and <replaceable>location</replaceable> and examples of how
to use the <literal>archive_location</literal> keyword.</para><itemizedlist><listitem><para><olink targetptr="preparecustom-4" remap="internal">Archive Stored on an NFS
Server</olink></para>
</listitem><listitem><para><olink targetptr="preparecustom-300" remap="internal">Archive Stored on an
HTTP or HTTPS Server</olink></para>
</listitem><listitem><para><olink targetptr="jumpstartreference-1a" remap="internal">Archive Stored on
an FTP Server</olink></para>
</listitem><listitem><para><olink targetptr="preparecustom-5" remap="internal">Archive Stored on a Local
Tape</olink></para>
</listitem><listitem><para><olink targetptr="preparecustom-6" remap="internal">Archive Stored on a Local
Device</olink></para>
</listitem><listitem><para><olink targetptr="preparecustom-7" remap="internal">Archive Stored on a Local
File</olink></para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry><varlistentry><term><replaceable>location</replaceable></term><listitem><para>Specifics for locations are noted in the following sections. </para>
</listitem>
</varlistentry>
</variablelist><caution><para>Solaris Flash archive cannot be properly created when
a non-global zone is installed. The Solaris Flash feature is not compatible
 with the Solaris Zones partitioning technology. If you create a Solaris Flash
archive, the resulting  archive is not installed properly when the archive
is deployed under these conditions:</para><itemizedlist><listitem><para>The archive is created in a non-global zone</para>
</listitem><listitem><para>The archive is created in a global zone that has non-global
zones installed</para>
</listitem>
</itemizedlist>
</caution><sect4 id="preparecustom-4"><title>Archive Stored on an NFS Server</title><para>If the archive is stored on an NFS server, use the following syntax
for the <literal>archive_location</literal> keyword.</para><screen>archive_location nfs <replaceable>server_name:/path/filename retry n</replaceable></screen><variablelist><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>The name of the server where you stored the archive.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The location of the archive to be retrieved from the specified
server.  If the path contains $HOST, the Solaris Flash installation utilities
replace $HOST with the name of the clone system that you are installing.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>filename</replaceable></term><listitem><para>The name of the Solaris Flash archive file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>retry n</replaceable></term><listitem><para>An optional keyword. <replaceable>n</replaceable> is the maximum
number of times the Solaris Flash utilities attempt to mount the archive.</para>
</listitem>
</varlistentry>
</variablelist><example id="fxjwx"><title>Archive Stored on an NFS Server</title><programlisting>archive_location nfs <filename>golden:/archives/usrarchive</filename>

archive_location <filename>nfs://golden/archives/usrarchive</filename></programlisting>
</example>
</sect4><sect4 id="preparecustom-300"><title>Archive Stored on an HTTP or HTTPS Server</title><para>If the archive is stored on an HTTP server, use the following syntax
for the <literal>archive_location</literal> keyword.</para><screen>archive_location http://<replaceable>server_name:port/path/filename</replaceable> <replaceable>optional_keywords</replaceable></screen><para>If the archive is stored on an HTTPS server, use the following syntax
for the <literal>archive_location</literal> keyword.</para><screen>archive_location https://<replaceable>server_name:port/path/filename</replaceable> <replaceable>optional_keywords</replaceable></screen><variablelist><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>The name of the server where you stored the archive. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>port</replaceable></term><listitem><para>An optional port. <replaceable>port</replaceable> can be a
port number or the name of a TCP service that has a port number that is determined
at runtime.</para><para>If you do not specify a port, the Solaris Flash installation utilities
use the default HTTP port number, 80.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The location of the archive to be retrieved from the specified
server.  If the path contains $HOST, the Solaris Flash installation utilities
replace $HOST with the name of the clone system that you are installing.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>filename</replaceable></term><listitem><para>The name of the Solaris Flash archive file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_keywords</replaceable></term><listitem><para>The optional keywords that you can specify when you retrieve
a Solaris Flash archive from an HTTP server.</para>
</listitem>
</varlistentry>
</variablelist><table frame="topbot" pgwide="1" id="flash-tbl-62"><title>Optional Keywords
to Use With <literal>archive_location</literal> HTTP</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="colspec2" colwidth="29.69*"/><colspec colname="colspec3" colwidth="70.31*"/><thead><row rowsep="1"><entry><para>Keyword</para>
</entry><entry><para>Value Definition</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>auth basic</literal> <replaceable>user_name password</replaceable></para>
</entry><entry><para>If the archive is located on an HTTP server that is password protected,
you must include the user name and password that you need to access the HTTP
server in the profile file. </para><note><para>The use of this authentication method in a profile that is intended
for use with custom JumpStart is risky. Unauthorized users might have access
to the profile file that contains the password.</para>
</note>
</entry>
</row><row><entry><para><literal>timeout</literal> <replaceable>min</replaceable></para>
</entry><entry><para>The <literal>timeout</literal> keyword enables you to specify, in minutes,
the maximum length of time that is allowed to pass without receipt of data
from the HTTP server. If a timeout occurs, the connection is closed, reopened,
and resumed. If you specify a <literal>timeout</literal> value of 0 (zero),
the connection is not reopened.</para><itemizedlist><listitem><para>If a timeout reconnection occurs, the Solaris Flash installation
utilities attempt to resume the installation at the last known position in
the archive. If the Solaris Flash installation utilities cannot resume
the installation at the last known position, the retrieval restarts from the
beginning of the archive and the data that was retrieved prior to the timeout
is discarded.</para>
</listitem><listitem><para>If a timeout reconnection occurs while a package is being
installed, the package is retried from the beginning of the package and the
data that was retrieved prior to the timeout is discarded. </para>
</listitem>
</itemizedlist>
</entry>
</row><row><entry><para><literal>proxy</literal> <replaceable>host:port</replaceable></para>
</entry><entry><para>The <literal>proxy</literal> keyword enables you to specify a proxy
host and proxy port.  You can use a proxy host to retrieve a Solaris Flash archive
from the other side of a firewall.  You must supply a proxy port when you
specify the <literal>proxy</literal> keyword.</para>
</entry>
</row>
</tbody>
</tgroup>
</table><example id="fxjxc"><title>Archive Stored on a HTTP or HTTPS Server</title><programlisting width="100">archive_location http://silver/archives/usrarchive.flar timeout 5 </programlisting><para>Example of the <literal>auth basic</literal> <replaceable>user_name
password</replaceable> keyword:</para><programlisting width="100">archive_location http://silver/archives/usrarchive.flar timeout 5 user1 secret</programlisting>
</example>
</sect4><sect4 id="jumpstartreference-1a"><title>Archive Stored on an FTP Server</title><para>If the archive is stored on an FTP server, use the following syntax
for the <literal>archive_location</literal> keyword.</para><screen width="80100">archive_location ftp://<replaceable>user_name:password</replaceable>@<replaceable>server_name:port/path/filename</replaceable> <replaceable>optional_keywords</replaceable></screen><variablelist><varlistentry><term><replaceable>user_name:password</replaceable></term><listitem><para>The user name and password that you need to access the FTP
server in the profile file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>The name of the server where you stored the archive. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>port</replaceable></term><listitem><para>A is an optional port.  <replaceable>port</replaceable> can
be a port number or the name of a TCP service that has a port number that
is determined at runtime.</para><para>If you do not specify a port, the Solaris Flash installation utilities
use the default FTP port number, 21.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The location of the archive to be retrieved from the specified
server.  If the path contains $HOST, the Solaris Flash installation utilities
replace $HOST with the name of the clone system that you are installing.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>filename</replaceable></term><listitem><para>The name of the Solaris Flash archive file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_keywords</replaceable></term><listitem><para>The optional keywords that you can specify when you retrieve
a Solaris Flash archive from an FTP server.</para>
</listitem>
</varlistentry>
</variablelist><table frame="topbot" pgwide="1" id="jumpstartreference-tbl-2"><title>Optional
Keywords to Use With <literal>archive_location</literal> FTP</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="colspec2" colwidth="29.69*"/><colspec colname="colspec3" colwidth="70.31*"/><thead><row rowsep="1"><entry><para>Keyword</para>
</entry><entry><para>Value Definition</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>timeout</literal> <replaceable>min</replaceable></para>
</entry><entry><para>The <literal>timeout</literal> keyword enables you to specify, in minutes,
the maximum length of time that is allowed to pass without receipt of data
from the HTTP server. If a timeout occurs, the connection is closed, reopened,
and resumed. If you specify a <literal>timeout</literal> value of 0 (zero),
the connection is not reopened.</para><itemizedlist><listitem><para>If a timeout reconnection occurs, the Solaris Flash installation
utilities attempt to resume the installation at the last known position in
the archive. If the Solaris Flash installation utilities cannot resume
the installation at the last known position, the retrieval restarts from the
beginning of the archive and the data that was retrieved prior to the timeout
is discarded.</para>
</listitem><listitem><para>If a timeout reconnection occurs while a package is being
installed, the package is retried from the beginning of the package and the
data that was retrieved prior to the timeout is discarded. </para>
</listitem>
</itemizedlist>
</entry>
</row><row><entry><para><literal>proxy</literal> <replaceable>host:port</replaceable></para>
</entry><entry><para>The <literal>proxy</literal> keyword enables you to specify a proxy
host and proxy port.  You can use a proxy host to retrieve a Solaris Flash archive
from the other side of a firewall.  You must supply a proxy port when you
specify the <literal>proxy</literal> keyword.</para>
</entry>
</row>
</tbody>
</tgroup>
</table><example id="fxjxe"><title>Archive Stored on an FTP Server</title><programlisting width="100">archive_location ftp://user1:secret@silver/archives/usrarchive.flar timeout 5</programlisting>
</example>
</sect4><sect4 id="preparecustom-5"><title>Archive Stored on a Local Tape</title><para>If the archive is stored on a tape, use the following syntax for the <literal>archive_location</literal> keyword.</para><screen>archive_location local_tape <replaceable>device</replaceable> <replaceable>position</replaceable></screen><variablelist><varlistentry><term><replaceable>device</replaceable></term><listitem><para>The name of the tape drive where you stored the Solaris Flash archive.
 If the device name is a canonical path, the Solaris Flash installation
utilities retrieve the archive from the path to the device node.  If you supply
a device name that is not a canonical path, the Solaris Flash installation
utilities add <filename>/dev/rmt/</filename> to the path.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>position</replaceable></term><listitem><para>Designates the place on the tape drive where you saved the
archive. If you do not supply a position, the Solaris Flash installation
utilities retrieve the archive from the current position on the tape drive.
By specifying a <replaceable>position</replaceable>, you can place a begin
script or a <filename>sysidcfg</filename> file on the tape drive before the
archive.</para>
</listitem>
</varlistentry>
</variablelist><example id="fxjxf"><title>Archive Stored on a Local Tape</title><programlisting>archive_location local_tape /dev/rmt/0n 5

archive_location local_tape 0n 5</programlisting>
</example>
</sect4><sect4 id="preparecustom-6"><title>Archive Stored on a Local Device</title><para>You can retrieve a Solaris Flash archive from a local device if
you stored the Solaris Flash archive on a file system-oriented, random-access
device, such as a diskette or a DVD. Use the following syntax for the <literal>archive_location</literal> keyword.</para><note><para>You can retrieve an archive from stream-oriented devices, such
as tape, by using the syntax for local tape. </para>
</note><screen>archive_location local_device <replaceable>device</replaceable> <replaceable>path/filename</replaceable> <replaceable>file_system_type</replaceable></screen><variablelist><varlistentry><term><replaceable>device</replaceable></term><listitem><para>The name of the drive where you stored the Solaris Flash archive.
If the device name is a canonical path, the device is mounted directly.  
If you supply a device name that is not a canonical path, the Solaris Flash installation
utilities add <filename>/dev/dsk/</filename> to the path.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The path to the Solaris Flash archive, relative to the
root of the file system on the device you specified. If the path contains
$HOST, the Solaris Flash installation utilities replace $HOST with the
name of the clone system that you are installing.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>filename</replaceable></term><listitem><para>The name of the Solaris Flash archive file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>file_system_type</replaceable></term><listitem><para>Specifies the type of file system on the device.  If you do
not supply a file system type, the Solaris Flash installation utilities
attempt to mount a UFS file system.  If the UFS mount fails, the Solaris Flash installation
utilities attempt to mount an HSFS file system. </para>
</listitem>
</varlistentry>
</variablelist><example id="fxjxh"><title>Archive Stored on a Local Device</title><para>To retrieve an archive from a local hard drive that is formatted as
a UFS file system, use the following command:</para><programlisting>archive_location local_device c0t0d0s0 <filename>/archives/$HOST</filename></programlisting><para>To retrieve an archive from a local CD-ROM that has an HSFS file system,
use the following command:</para><programlisting>archive_location local_device c0t0d0s0 <filename>/archives/usrarchive</filename></programlisting>
</example>
</sect4><sect4 id="preparecustom-7"><title>Archive Stored on a Local File</title><para>You can retrieve an archive that you stored in the miniroot from which
you booted the clone system as a local file. When you perform a custom JumpStart
installation, you boot the system from a DVD, CD, or an NFS-based miniroot.
 The installation software is loaded and run from this miniroot.  Therefore,
a Solaris Flash archive that you stored in the DVD, CD, or NFS-based
miniroot is accessible as a local file. Use the following syntax for the <literal>archive_location</literal> keyword.</para><screen>archive_location local_file <replaceable>path/filename</replaceable> </screen><variablelist><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The location of the archive. The path must be accessible to
the system as a local file while the system is booted from the Solaris Software - 1 CD
or from the Solaris Operating System DVD. The system cannot access <filename>/net</filename> or
any other automounted directory when it is booted from the Solaris Software - 1 CD
or from the Solaris Operating System DVD.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>filename</replaceable></term><listitem><para>The name of the Solaris Flash archive file.</para>
</listitem>
</varlistentry>
</variablelist><example id="fxjxg"><title>Archive Stored on a Local File</title><programlisting>archive_location local_file <filename>/archives/usrarchive</filename></programlisting>
</example>
</sect4>
</sect3><sect3 id="preparecustom-97"><title><literal>backup_media</literal> Profile
Keyword</title><programlisting role="complete">backup_media <replaceable>type path</replaceable></programlisting><para>You can use <literal>backup_media</literal> only with the upgrade option
when disk space reallocation is required.</para><para><literal>backup_media</literal> defines the media that is to be used
to back up file systems if space needs to be reallocated during an upgrade
because of insufficient space. If multiple tapes or diskettes are required
for the backup, you are prompted to insert tapes or diskettes during the upgrade.</para><informaltable frame="topbot" pgwide="1"><tgroup cols="3" colsep="0" rowsep="0"><colspec colname="column1" colwidth="125*"/><colspec colwidth="100*"/><colspec colname="column2" colwidth="171*"/><thead><row rowsep="1"><entry><para>Valid <replaceable>type</replaceable> Value</para>
</entry><entry><para>Valid <replaceable>path</replaceable> Value</para>
</entry><entry><para>Specification</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>local_tape</literal>	</para>
</entry><entry><para><filename>/dev/rmt/</filename><replaceable>n</replaceable></para>
</entry><entry><para>A local tape drive on the system that is being upgraded. <replaceable>path</replaceable> must
be the character (raw) device path for the tape drive. <replaceable>n</replaceable> is
the number of the tape drive.</para>
</entry>
</row><row><entry><para><literal>local_diskette</literal>	</para>
</entry><entry><para><filename>/dev/rdiskette</filename><replaceable>n</replaceable></para>
</entry><entry><para>A local diskette drive on the system that is being upgraded. <replaceable>path</replaceable> must be the character (raw) device path for the diskette drive. <replaceable>n</replaceable> is the number of the diskette drive.</para><para>Diskettes that you use for the backup must be formatted.</para>
</entry>
</row><row><entry><para><literal>local_filesystem</literal></para>
</entry><entry><para><filename>/dev/dsk/c</filename><replaceable>w</replaceable><filename>t</filename><replaceable>x</replaceable><filename>d</filename><replaceable>y</replaceable><filename>s</filename><replaceable>z</replaceable></para><para><filename>/</filename><replaceable>file_system</replaceable></para>
</entry><entry><para>A local file system on the system that is being upgraded. You cannot
specify a local file system that is being changed by the upgrade. <replaceable>path</replaceable> can be a block device path for a disk slice. For example, the <filename>t</filename><replaceable>x</replaceable> in <filename>/dev/dsk/c</filename><replaceable>w</replaceable><filename>t</filename><replaceable>x</replaceable><filename>d</filename><replaceable>y</replaceable><filename>s</filename><replaceable>z</replaceable> might not
be needed. Or, <replaceable>path</replaceable> can be the absolute path to
a file system that is mounted by the <filename>/etc/vfstab</filename> file.</para>
</entry>
</row><row><entry><para><literal>remote_filesystem</literal>	</para>
</entry><entry><para><replaceable>host</replaceable><filename>:/</filename><replaceable>file_system</replaceable></para>
</entry><entry><para>An NFS file system on a remote system. <replaceable>path</replaceable> must
include the name or IP address of the remote system, <replaceable>host</replaceable>,
and the absolute path to the NFS file system, <replaceable>file_system</replaceable>.
The NFS file system must have read/write access.</para>
</entry>
</row><row><entry><para><literal>remote_system</literal></para>
</entry><entry><para><replaceable>user</replaceable><filename>@</filename><replaceable>host</replaceable><literal>:/</literal><replaceable>directory</replaceable></para>
</entry><entry><para>A directory on a remote system that can be reached by a remote shell, <literal>rsh</literal>. The system that is being upgraded must have access to the remote
system through the remote system's <filename>.rhosts</filename> file. <replaceable>path</replaceable> must include the name of the remote system <replaceable>host</replaceable> and
the absolute path to the directory <replaceable>directory</replaceable>. If
a user login ID <replaceable>user</replaceable> is not specified, <literal>root</literal> is
used by default.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable><example id="fxjxi"><title><literal>backup_media</literal> Profile Keyword</title><programlisting>backup_media local_tape /dev/rmt/0

backup_media local_diskette /dev/rdiskette1

backup_media local_filesystem /dev/dsk/c0t3d0s4

backup_media local_filesystem /export

backup_media remote_filesystem system1:/export/temp

backup_media remote_system user1@system1:/export/temp</programlisting>
</example>
</sect3><sect3 id="preparecustom-113"><title><literal>boot_device</literal> Profile
Keyword</title><programlisting role="complete">boot_device <replaceable>device eeprom</replaceable></programlisting><para><literal>boot_device</literal> designates the device where the JumpStart
program is to install the root (<filename>/</filename>) file system and the
system's boot device. <literal>boot_device</literal> must match any <literal>filesys</literal> keywords that specify the root (<filename>/</filename>) file system
and the <literal>root_device</literal> keyword.</para><para>If you do not specify the <literal>boot_device</literal> keyword
in a profile, the following <literal>boot_device</literal> keyword is specified
by default during the installation:</para><screen>boot_device any update</screen><variablelist><varlistentry><term><replaceable>device</replaceable></term><listitem><para>Use one of the following values.</para><variablelist><varlistentry><term>SPARC: <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable></term><listitem><para>The disk slice where the JumpStart program places the root
(<filename>/</filename>) file system, for example, <literal>c0t0d0s0</literal>.</para>
</listitem>
</varlistentry><varlistentry><term>x86: <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable> or <literal>c</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable></term><listitem><para>The disk where the JumpStart program places the root (<filename>/</filename>) file system, for example, <literal>c0d0</literal>.</para>
</listitem>
</varlistentry><varlistentry><term><literal>existing</literal></term><listitem><para>The JumpStart program places the root (<filename>/</filename>)
file system on the system's existing boot device.</para>
</listitem>
</varlistentry><varlistentry><term><literal>any</literal></term><listitem><para>The JumpStart program chooses where to place the root (<filename>/</filename>) file system. The JumpStart program attempts to use the system's
existing boot device. The JumpStart program might choose a different boot
device if necessary.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><varlistentry><term><replaceable>eeprom</replaceable></term><listitem><para>Choose to update or preserve the system's EEPROM.</para><para>The <emphasis>eeprom</emphasis> value enables you to update the system's
EEPROM if you change the system's current boot device. By updating the system's
EEPROM, the system can automatically boot from the new boot device.</para><note><para>x86: You must specify the <literal>preserve</literal> value.</para>
</note><variablelist><varlistentry><term><literal>update</literal></term><listitem><para>The JumpStart program updates the system's EEPROM to the specified
boot device so that the installed system automatically boots from it.</para>
</listitem>
</varlistentry><varlistentry><term><literal>preserve</literal></term><listitem><para>The boot device value in the system's EEPROM is not changed.
If you specify a new boot device without changing the system's EEPROM, you
need to change the system's EEPROM manually so it can automatically boot from
the new boot device.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist><example id="fxjxk"><title><literal>boot_device</literal> Profile Keyword</title><programlisting>boot_device c0t0d0s2 update</programlisting>
</example>
</sect3><sect3 id="preparecustom-1130"><title><literal>bootenv createbe</literal> Profile
Keyword</title><programlisting role="complete">bootenv createbe bename <replaceable>new_BE_name</replaceable> filesystem <replaceable>mountpoint</replaceable>:<replaceable>device</replaceable>:<replaceable>fs_options</replaceable> 
[filesystem...]</programlisting><para><literal>bootenv createbe</literal> keyword enables you to quickly
create an empty-and-inactive boot environment at the same time you are installing
the Solaris OS. At the least, you must create the root  (<literal>/</literal>)
file system.  The slices are reserved for the file systems specified, but
no file systems are copied.  The boot environment is named, but not actually
created until installed with a Solaris Flash archive.  When the empty
boot environment is installed with an archive, file systems are installed
on the reserved slices. The following lists the values for <replaceable>bename</replaceable> and <replaceable>filesystem</replaceable>.</para><variablelist termlength="wholeline"><varlistentry><term><literal>bename</literal> <replaceable>new_BE_name</replaceable></term><listitem><para><literal>bename</literal> specifies the name of the new boot
environment to be created. <replaceable>new_BE_name</replaceable> can be no
longer than 30 characters, can contain only alphanumeric characters, and can
contain no multibyte characters. The name must be unique on the system.</para>
</listitem>
</varlistentry><varlistentry><term><literal>filesystem</literal> <replaceable>mountpoint</replaceable>:<replaceable>device</replaceable>:<replaceable>fs_options</replaceable></term><listitem><para><literal>filesystem</literal> determines the type and number
of file systems that are to be created in the new boot environment. At least
one slice that contains the root (<filename>/</filename>) file system must
be defined. File systems can be on the same disk or spread across multiple
disks.</para><itemizedlist><listitem><para><replaceable>mountpoint</replaceable> can be any valid mount
point or &ndash; (hyphen), indicating a swap slice. </para>
</listitem><listitem><para><replaceable>device</replaceable>  must be available when
the operating system that is being installed is first booted. The device has
no relation to JumpStart special storage devices such as <emphasis>free</emphasis>.
The device cannot be a Solaris Volume Manager volume or Veritas Volume Manager
volume. <replaceable>device</replaceable> is the name of a disk device, of
the form <filename>/dev/dsk/c<replaceable>w</replaceable>t<replaceable>x</replaceable>d<replaceable>y</replaceable>s<replaceable>z</replaceable></filename>.</para>
</listitem><listitem><para><replaceable>fs_options</replaceable>  can be one of the following:</para><itemizedlist><listitem><para><literal>ufs</literal>, which  indicates a UFS file system.</para>
</listitem><listitem><para><literal>swap</literal>, which  indicates a swap file system.
The swap mount point must be a <literal>&ndash;</literal> (hyphen).</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist><para>For a profile example and background about using this keyword, see the
following references:</para><informaltable frame="topbot"><tgroup cols="2" colsep="0" rowsep="0"><colspec colwidth="50*"/><colspec colwidth="50*"/><tbody><row><entry><para>For an example of a profile</para>
</entry><entry><para><olink targetptr="preparecustom-960" remap="internal">Example 3&ndash;11</olink></para>
</entry>
</row><row><entry><para>For background about using Solaris Live Upgrade that creates, upgrades,
and activates inactive boot environments</para>
</entry><entry><para><olink targetdoc="solinstallupg" targetptr="luoverview-1" remap="external">Chapter 2, <citetitle remap="chapter">Solaris Live Upgrade (Overview),</citetitle> in <citetitle remap="book">Solaris Express Installation Guide:  Solaris Live Upgrade and Upgrade Planning</citetitle></olink></para>
</entry>
</row><row><entry><para>For background about using a Solaris Flash archive</para>
</entry><entry><para><olink targetdoc="solinstallflash" targetptr="flash-24" remap="external">Chapter 1, <citetitle remap="chapter">Solaris Flash (Overview),</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Solaris Flash Archives (Creation and Installation)</citetitle></olink></para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect3><sect3 id="preparecustom-81"><title><literal>client_arch</literal> Profile
Keyword</title><programlisting role="complete">client_arch <replaceable>karch_value</replaceable> ...</programlisting><para><literal>client_arch</literal> specifies that the operating system server
is to support a different platform group than the server uses. If you do not
specify <literal>client_arch</literal> in the profile, any diskless client
 that uses the operating system server must contain the same platform group
as the server. You must specify each platform group that you want the operating
system server to support.</para><para>Valid values for <replaceable>karch_value</replaceable> are  <literal>sun4u</literal> and <literal>i86pc</literal>. For a detailed list of platform
names and various systems, see <citetitle>Solaris Sun Hardware Platform Guide</citetitle> at <ulink url="http://docs.sun.com" type="url">http://docs.sun.com</ulink>.  </para><note><para>You can use <literal>client_arch</literal> only when <literal>system_type</literal> is specified as <literal>server</literal>.</para>
</note>
</sect3><sect3 id="preparecustom-98"><title><literal>client_root</literal> Profile
Keyword</title><programlisting role="complete">client_root <replaceable>root_size</replaceable></programlisting><para><literal>client_root</literal> defines
the amount of root space, <replaceable>root_size</replaceable> in Mbytes,
to allocate for each client. If you do not specify <literal>client_root</literal> in
a server's profile, the installation software allocates 15 Mbytes of root
space per client. The size of the client root area is used in combination
with the <literal>num_clients</literal> keyword to determine how much space
to reserve for the <filename>/export/root</filename> file system.    </para><note><para>You can use <literal>client_root</literal> only when <literal>system_type</literal> is specified as <literal>server</literal>.</para>
</note>
</sect3><sect3 id="preparecustom-99"><title><literal>client_swap</literal> Profile
Keyword</title><programlisting role="complete">client_swap <replaceable>swap_size</replaceable></programlisting><para><literal>client_swap</literal> defines the amount of swap space, <replaceable>swap_size</replaceable> in
Mbytes, to allocate for each diskless client. If you do not specify <literal>client_swap</literal> in the profile, 32 Mbytes of swap space is allocated by default.</para><note><para>You can use <literal>client_swap</literal> only when <literal>system_type</literal> is specified as <literal>server</literal>.</para>
</note><example id="fxjxj"><title><literal>client_swap</literal> Profile Keyword</title><para>The following example specifies that each diskless client is to have
a swap space of 64 Mbytes.</para><programlisting>client_swap 64</programlisting>
</example><sect4 id="jumpstartreference-2"><title>How the Size of <filename>swap</filename> Is
Determined</title><para>If a profile does not specify the size
of <filename>swap</filename>, the JumpStart program determines the size of
the swap space, based on the system's physical memory. <olink targetptr="jumpstartreference-tbl-3" remap="internal">Table 8&ndash;5</olink> shows how the
size of <filename>swap</filename> is determined during a custom JumpStart
installation.     </para><table frame="topbot" id="jumpstartreference-tbl-3"><title>Determining <filename>swap</filename> Size</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="column1" colwidth="158*"/><colspec colname="column2" colwidth="238*"/><thead><row rowsep="1"><entry><para>Physical Memory (in Mbytes)</para>
</entry><entry><para>Swap Space (in Mbytes)</para>
</entry>
</row>
</thead><tbody><row><entry><para>16&ndash;64</para>
</entry><entry><para>32</para>
</entry>
</row><row><entry><para>64&ndash;128</para>
</entry><entry><para>64</para>
</entry>
</row><row><entry><para>128&ndash;512</para>
</entry><entry><para>128</para>
</entry>
</row><row><entry><para>Greater than 512</para>
</entry><entry><para>256</para>
</entry>
</row>
</tbody>
</tgroup>
</table><para>The JumpStart program makes the size of <filename>swap</filename> no
more than 20 percent of the disk where <filename>swap</filename> is located.
The allocation is different if the disk contains free space after laying out
the other file systems. If free space exists, the JumpStart program allocates
the free space to <filename>swap</filename>, and if possible, allocates the
amount that is shown in <olink targetptr="jumpstartreference-tbl-3" remap="internal">Table
8&ndash;5</olink>. </para><note><para>Physical memory plus swap space must total a minimum of 32 Mbytes.</para>
</note>
</sect4>
</sect3><sect3 id="preparecustom-100"><title><literal>cluster</literal> Profile Keyword
(Adding Software Groups)</title><programlisting role="complete">cluster <replaceable>group_name</replaceable></programlisting><para><literal>cluster</literal> designates the software group to add to the
system. </para><note><para>A software group is a metacluster that contains a collection of
clusters and packages. The software group is installed by using the <literal>cluster</literal> keyword and <replaceable>group_name</replaceable> variable. This
cluster keyword can only be installed in an initial installation. This <literal>cluster</literal> keyword refers to metaclusters found in the <filename>clustertoc(4)</filename> file.</para><para>A cluster is a collection of packages that is named SUNW<replaceable>name</replaceable>. A cluster is installed by using the <literal>cluster</literal> keyword
and <replaceable>cluster_name</replaceable> variable. A cluster can be added
or removed from a software group (metacluster) in an initial install or an
upgrade.</para>
</note><para>The <replaceable>group_name</replaceable> for each software group is
listed in the following table.</para><informaltable frame="topbot"><tgroup cols="2" colsep="0" rowsep="0"><colspec colwidth="162*"/><colspec colname="column2" colwidth="234*"/><thead><row rowsep="1"><entry><para>Software Group</para>
</entry><entry><para><emphasis>group_name</emphasis></para>
</entry>
</row>
</thead><tbody><row><entry><para>Reduced Network Support Software Group</para>
</entry><entry><para><literal>SUNWCrnet</literal></para>
</entry>
</row><row><entry><para>Core System Support Software Group</para>
</entry><entry><para><literal>SUNWCreq</literal></para>
</entry>
</row><row><entry><para>End User Solaris Software Group</para>
</entry><entry><para><literal>SUNWCuser</literal></para>
</entry>
</row><row><entry><para>Developer Solaris Software Group</para>
</entry><entry><para><literal>SUNWCprog</literal></para>
</entry>
</row><row><entry><para>Entire Solaris Software Group</para>
</entry><entry><para><literal>SUNWCall</literal></para>
</entry>
</row><row><entry><para>Entire Solaris Software Group Plus OEM Support</para>
</entry><entry><para><literal>SUNWCXall</literal></para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable><itemizedlist><para>The following limitations apply:</para><listitem><para>You can specify
only one software group in a profile.</para>
</listitem><listitem><para>The software group must be specified before other <literal>cluster</literal> and <literal>package</literal> entries. </para>
</listitem><listitem><para>If you do not specify a software group with <literal>cluster</literal> in
the profile, the end&ndash;user software group, <literal>SUNWCuser</literal>,
is installed on the system.</para>
</listitem>
</itemizedlist><para>For more information about software groups, see <olink targetdoc="solinstallpbiu" targetptr="esimo" remap="external"><citetitle remap="section">Disk Space Recommendations for Software Groups</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Planning for Installation and Upgrade</citetitle></olink>.</para>
</sect3><sect3 id="preparecustom-85"><title><literal>cluster</literal> Profile Keyword
(Adding or Deleting Clusters)</title><programlisting role="complete">cluster <replaceable>cluster_name</replaceable> <replaceable>add_delete_switch</replaceable></programlisting><para><literal>cluster</literal> designates whether a cluster is to
be added or deleted from the software group that is to be installed on the
system. </para><variablelist><varlistentry><term><replaceable>cluster_name</replaceable></term><listitem><para>The name of the cluster that must be in the form <literal>SUNWC</literal><replaceable>name</replaceable>.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>add_delete_switch</replaceable></term><listitem><para>An optional keyword that  indicates whether to add or delete
the cluster that is specified. Use the value <literal>add</literal> or <literal>delete</literal>. If you do not specify <literal>add</literal> or <literal>delete</literal>, <literal>add</literal> is used by default.</para>
</listitem>
</varlistentry>
</variablelist><para>When you use <literal>cluster</literal> during
an upgrade, the following conditions apply:    </para><itemizedlist><listitem><para>All clusters that are already on the system are automatically
upgraded.</para>
</listitem><listitem><para>If you specify <replaceable>cluster_name</replaceable> <literal>add</literal>, and <replaceable>cluster_name</replaceable> is not installed on
the system, the cluster is installed.</para>
</listitem><listitem><para>If you specify <replaceable>cluster_name</replaceable> <literal>delete</literal>, and <replaceable>cluster_name</replaceable> is installed on the
system, the package is deleted <emphasis>before</emphasis> the upgrade begins.</para>
</listitem>
</itemizedlist><note><para>A software group is a metacluster that contains a collection of
clusters and packages. The software group is installed by using the <literal>cluster</literal> keyword and <replaceable>group_name</replaceable> variable. This
cluster keyword can only be installed in an initial installation. This <literal>cluster</literal> keyword refers to metaclusters found in the <filename>clustertoc(4)</filename> file. </para><para>A cluster is collection of packages. Clusters can be grouped
together to form a software group (metacluster). A cluster name is always
in the form of SUNW&lt;name>. A cluster is installed by using the <literal>cluster</literal> keyword and <replaceable>cluster_name</replaceable> variable. A
cluster can be added or removed from a software group (metacluster) in an
initial install or an upgrade.</para>
</note>
</sect3><sect3 id="preparecustom-86"><title><literal>dontuse</literal> Profile
Keyword</title><programlisting role="complete">dontuse <replaceable>disk_name</replaceable> ...</programlisting><para>By default, the JumpStart program uses all of the operational disks
on the system when <literal>partitioning default</literal> is specified. <literal>dontuse</literal> designates one or more disks that you do not want the JumpStart
program to use. <replaceable>disk_name</replaceable> must be specified in
the form <literal>c</literal><replaceable>x</replaceable><literal>t</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable>or <literal>c</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable>, for example, <literal>c0t0d0</literal>.   </para><note><para>You cannot specify the <literal>dontuse</literal> keyword and
the <literal>usedisk</literal> keyword in the same profile.</para>
</note>
</sect3><sect3 id="preparecustom-87" arch="x86"><title><literal>fdisk</literal> Profile
Keyword</title><programlisting role="complete">fdisk <replaceable>disk_name type size</replaceable></programlisting><para><literal>fdisk</literal> defines how the <literal>fdisk</literal> partitions
are set up on an x86 based system. You can specify <literal>fdisk</literal> more
than once. When <literal>fdisk</literal> partitions an x86 based system, the
following occurs:</para><itemizedlist><listitem><para>All <literal>fdisk</literal> partitions on the disk are preserved
unless you delete the partitions with the <literal>fdisk</literal> keyword
by assigning <replaceable>size</replaceable> the value of <literal>delete</literal> or <literal>0</literal>. Also, all existing <literal>fdisk</literal> partitions are deleted
when <replaceable>size</replaceable> is set to <literal>all</literal>.</para>
</listitem><listitem><para>A Solaris <literal>fdisk</literal> partition that contains
a root (<filename>/</filename>) file system is always designated as the active
partition on the disk. </para><note><para>The system boots from the active partition by default.</para>
</note>
</listitem><listitem><para>If the <literal>fdisk</literal> keyword is not specified in
a profile, the following <literal>fdisk</literal> keyword is used by default
during the installation.</para><programlisting>fdisk all solaris maxfree</programlisting>
</listitem><listitem><para><literal>fdisk</literal> entries are processed in the order
in which the entries are listed in the profile.</para>
</listitem>
</itemizedlist><variablelist><varlistentry><term><replaceable>disk_name</replaceable></term><listitem><para>Use the following values to specify where the <literal>fdisk</literal> partition
is to be created or deleted:</para><itemizedlist><listitem><para><literal>c</literal><replaceable>x</replaceable><literal>t</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable> &ndash; A
specific disk, for example, <literal>c0t3d0</literal>.</para>
</listitem><listitem><para><literal>rootdisk</literal> &ndash; The variable that contains
the value of the system's root disk, which is where the installation takes
place. The root disk is determined by the JumpStart program as described in <olink targetptr="preparecustom-25766" remap="internal">How the System's Root Disk Is Determined</olink>.</para>
</listitem><listitem><para><literal>all</literal> &ndash; All the selected disks.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry><varlistentry><term><replaceable>type</replaceable></term><listitem><para>Use the following values to specify the type of <literal>fdisk</literal> partition
that is to be created or deleted on the specified disk:</para><itemizedlist><listitem><para><literal>solaris</literal> &ndash; A Solaris <literal>fdisk</literal> partition
(<literal>SUNIXOS fdisk</literal> type).</para>
</listitem><listitem><para><literal>dosprimary</literal> &ndash; An alias for primary
DOS <literal>fdisk</literal> partitions, not for <literal>fdisk</literal> partitions
that are extended or reserved for data DOS. When you delete <literal>fdisk</literal> partitions
by assigning <replaceable>size</replaceable> the value <literal>delete</literal>, <literal>dosprimary</literal> is an alias for the DOSHUGE, DOSOS12, and DOSOS16 <literal>fdisk</literal> types. When you create an <literal>fdisk</literal> partition, <literal>dosprimary</literal> is an alias for the DOSHUGE <literal>fdisk</literal> partition. </para>
</listitem><listitem><para><replaceable>DDD</replaceable> &ndash; An integer <literal>fdisk</literal> partition. <replaceable>DDD</replaceable> is an integer between 1 and 255 inclusive.</para><note><para>You can specify this value only if <replaceable>size</replaceable> is <literal>delete</literal>.</para>
</note>
</listitem><listitem><para>0x<replaceable>HH</replaceable> &ndash; A hexadecimal <literal>fdisk</literal> partition. <replaceable>HH</replaceable> is a hexadecimal number
between 01 and FF.</para><note><para>You can specify this value only if <replaceable>size</replaceable> is <literal>delete</literal>.</para>
</note>
</listitem>
</itemizedlist><para>The following table shows the integer and hexadecimal numbers for some
of the <literal>fdisk</literal> types.</para><informaltable frame="topbot"><tgroup cols="3" colsep="0" rowsep="0"><colspec colname="column1" colwidth="65*"/><colspec colname="column2" colwidth="65*"/><colspec colname="column3" colwidth="65*"/><thead><row rowsep="1"><entry><para><literal>fdisk</literal> Type</para>
</entry><entry><para><replaceable>DDD</replaceable></para>
</entry><entry><para><replaceable>HH</replaceable></para>
</entry>
</row>
</thead><tbody><row><entry><para>DOSOS12</para>
</entry><entry><para><literal>1</literal></para>
</entry><entry><para><literal>01</literal></para>
</entry>
</row><row><entry><para>PCIXOS</para>
</entry><entry><para><literal>2</literal></para>
</entry><entry><para><literal>02</literal></para>
</entry>
</row><row><entry><para>DOSOS16</para>
</entry><entry><para><literal>4</literal></para>
</entry><entry><para><literal>04</literal></para>
</entry>
</row><row><entry><para>EXTDOS</para>
</entry><entry><para><literal>5</literal></para>
</entry><entry><para><literal>05</literal></para>
</entry>
</row><row><entry><para>DOSHUGE</para>
</entry><entry><para><literal>6</literal></para>
</entry><entry><para><literal>06</literal></para>
</entry>
</row><row><entry><para>DOSDATA</para>
</entry><entry><para><literal>86</literal></para>
</entry><entry><para><literal>56</literal></para>
</entry>
</row><row><entry><para>OTHEROS</para>
</entry><entry><para><literal>98</literal></para>
</entry><entry><para><literal>62</literal></para>
</entry>
</row><row><entry><para>UNIXOS</para>
</entry><entry><para><literal>99</literal></para>
</entry><entry><para><literal>63</literal></para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry><varlistentry><term><replaceable>size</replaceable></term><listitem><para>Use one of the following values:</para><itemizedlist><listitem><para><replaceable>DDD</replaceable> &ndash; An <literal>fdisk</literal> partition
of size <replaceable>DDD</replaceable> in Mbytes is created on the specified
disk. <replaceable>DDD</replaceable> must be an integer, and the JumpStart
program automatically rounds the number up to the nearest cylinder boundary.
Specifying a value of <literal>0</literal> is the same as specifying <literal>delete</literal>.</para>
</listitem><listitem><para><literal>all</literal> &ndash; An <literal>fdisk</literal> partition
is created on the entire disk. All existing <literal>fdisk</literal> partitions
are deleted.</para><note arch="x86"><para>The <literal>all</literal> value can be specified only
if <replaceable>type</replaceable> is <literal>solaris</literal>.</para>
</note>
</listitem><listitem><para><literal>maxfree</literal> &ndash; An <literal>fdisk</literal> partition
is created in the largest contiguous free space on the specified disk. If
an <literal>fdisk</literal> partition of the specified <replaceable>type</replaceable> already
exists on the disk, the existing <literal>fdisk</literal> partition is used.
A new <literal>fdisk</literal> partition is <emphasis>not</emphasis> created
on the disk.</para><note arch="x86"><para>The disk must contain at least one unused <literal>fdisk</literal> partition.
Also, the disk must have free space or the installation fails. The <literal>maxfree</literal> value can be specified only if <replaceable>type</replaceable> is <literal>solaris</literal> or <literal>dosprimary</literal>.</para>
</note>
</listitem><listitem><para><literal>delete</literal> &ndash; All <literal>fdisk</literal> partitions
of the specified <replaceable>type</replaceable> are deleted on the specified
disk.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</sect3><sect3 id="preparecustom-88"><title><literal>filesys</literal> Profile Keyword
(Mounting Remote File Systems)</title><programlisting role="complete">filesys <replaceable>server</replaceable>:<replaceable>path server_address mount_pt_name</replaceable> <replaceable>mount_options</replaceable></programlisting><para>By using <literal>filesys</literal> with the listed values, the JumpStart
program sets up the installed system to automatically mount remote file systems
when the system boots. You can specify <literal>filesys</literal> more than
once.</para><variablelist><varlistentry><term><replaceable>server</replaceable></term><listitem><para>The name of the server where the remote file system is located,
followed by a colon.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>The remote file system's mount-point name. For example, <filename>/usr</filename> or <filename>/export/home</filename></para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_address</replaceable></term><listitem><para>The IP address of the server that is specified in <replaceable>server</replaceable>:<replaceable>path</replaceable>. If a naming service is not
running on the network, the <replaceable>server_address</replaceable> value
can be used to populate the <filename>/etc/hosts</filename> file with the
server's host name and IP address. If you are not specifying the server's
IP address, you must specify a minus sign (<literal>-</literal>).  For example,
if you have a naming service that is running on the network, you do not need
to specify the server's IP address.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>mount_pt_name</replaceable></term><listitem><para>The name of the mount point on which the remote file system
is to be mounted.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>mount_options</replaceable></term><listitem><para>One or more mount options, which is the same as the <option>o</option> option
of the <olink targetdoc="refman1m" targetptr="mount-1m" remap="external"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink> command.
The mount options are added to the <filename>/etc/vfstab</filename> entry
for the specified <replaceable>mount_pt_name</replaceable>. </para><note><para>If you need to specify more than one mount option, the mount options
must be separated by commas and no spaces (<literal>ro,quota</literal> for
example).</para>
</note>
</listitem>
</varlistentry>
</variablelist><example id="fxjxl"><title><literal>filsys</literal> Profile Keyword</title><programlisting>filesys sherlock:/export/home/user2 - /home</programlisting>
</example>
</sect3><sect3 id="preparecustom-89"><title><literal>filesys</literal> Profile Keyword
(Creating Local File Systems)</title><programlisting role="complete">filesys <replaceable>slice size</replaceable> <replaceable>file_system</replaceable> <replaceable>optional_parameters</replaceable></programlisting><para>By using <literal>filesys</literal> with the values that are listed,
the JumpStart program creates local file systems during the installation.
You can specify <literal>filesys</literal> more than once.</para><variablelist><varlistentry><term><replaceable>slice</replaceable></term><listitem><para>Use one of the following values: </para><variablelist><varlistentry><term><literal>any</literal></term><listitem><para>The JumpStart program places the file system on any disk.</para><note><para>You cannot specify <literal>any</literal> when <literal>size</literal> is <literal>existing</literal>, <literal>all</literal>, <literal>free</literal>, <replaceable>start</replaceable>:<replaceable>size</replaceable>, or <literal>ignore</literal>.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable></term><listitem><para>The disk slice where the JumpStart program places the file
system, for example, <literal>c0t0d0s0</literal> or <literal>c0d0s0</literal>.</para>
</listitem>
</varlistentry><varlistentry><term><literal>rootdisk.s</literal><replaceable>n</replaceable></term><listitem><para>The variable that contains the value
for the system's root disk, which is determined by the JumpStart program as
described in <olink targetptr="preparecustom-25766" remap="internal">How the System's Root
Disk Is Determined</olink>. The <literal>s</literal><replaceable>n</replaceable> suffix
indicates a specific slice on the disk. </para><note><para>The root disk is determined by the JumpStart program and determines
where the OS is to be installed. The rules file uses a probe keyword "<literal>rootdisk</literal>,&rdquo; but this keyword is used differently than the "rootdisk"
keyword used in the JumpStart profile. You cannot set the place of installation
by using the probe keyword &ldquo;<literal>rootdisk</literal>&rdquo; in the
rules file. The probe keyword, <literal>rootdisk</literal>, determines where
to boot from during the installation. See <olink targetptr="jumpstartreference-tbl-7" remap="internal">Table 8&ndash;10</olink>.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><varlistentry><term><replaceable>size</replaceable></term><listitem><para>Use one of the following values:</para><variablelist><varlistentry><term><replaceable>num</replaceable></term><listitem><para>The size of the file system is set to <replaceable>num</replaceable> in
Mbytes.</para>
</listitem>
</varlistentry><varlistentry><term><literal>existing</literal></term><listitem><para>The current size of the existing file system is used.</para><note><para>When you use the <literal>existing</literal> value, you can change
the name of an existing slice by specifying <replaceable>file_system</replaceable> as
a different <replaceable>mount_pt_name</replaceable>.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><literal>auto</literal></term><listitem><para>The size of the file system is automatically determined, depending
on the software that is selected.</para>
</listitem>
</varlistentry><varlistentry><term><literal>all</literal></term><listitem><para>The specified <replaceable>slice</replaceable> uses the entire
disk for the file system. When you specify the <literal>all</literal> value,
no other file systems can be placed on the specified disk.</para>
</listitem>
</varlistentry><varlistentry><term><literal>free</literal></term><listitem><para>The remaining unused space on the disk is used for the file
system.</para><note><para>If <literal>free</literal> is used as the value to <literal>filesys</literal>,
the <literal>filesys</literal> entry must be the last entry in a profile.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><replaceable>start</replaceable>:<replaceable>size</replaceable></term><listitem><para>The file system is explicitly partitioned. <replaceable>start</replaceable> is
the cylinder where the slice begins.  <replaceable>size</replaceable> is the
number of cylinders for the slice.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><varlistentry><term><replaceable>file_system</replaceable></term><listitem><para>The <replaceable>file_system</replaceable> value is optional
and used when <replaceable>slice</replaceable> is specified as <literal>any</literal> or <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable>.
If <replaceable>file_system</replaceable> is not specified, <literal>unnamed</literal> is
set by default. If <literal>unnamed</literal> is set, you cannot specify the <replaceable>optional_parameters</replaceable> value. Use one of the following values:</para><variablelist><varlistentry><term><replaceable>mount_pt_name</replaceable></term><listitem><para>The file system's mount-point name, for example, <filename>/var</filename>.</para>
</listitem>
</varlistentry><varlistentry><term><literal>swap</literal></term><listitem><para>The specified <replaceable>slice</replaceable> is used as <literal>swap</literal>.</para>
</listitem>
</varlistentry><varlistentry><term><literal>overlap</literal></term><listitem><para>The specified <replaceable>slice</replaceable> is defined
as a representation of a disk region. The VTOC value is V_BACKUP. By default,
slice 2 is an overlap slice that is a representation of the whole disk.</para><note><para>You can specify <literal>overlap</literal> only when <replaceable>size</replaceable> is <literal>existing</literal>, <literal>all</literal>, or <replaceable>start</replaceable>:<replaceable>size</replaceable>.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><literal>unnamed</literal></term><listitem><para>The specified <replaceable>slice</replaceable> is defined
as a raw slice, so <replaceable>slice</replaceable> does not have a mount-point
name. If you do not specify <replaceable>file_system</replaceable>, <literal>unnamed</literal> is used by default.</para>
</listitem>
</varlistentry><varlistentry><term><literal>ignore</literal></term><listitem><para>The specified <replaceable>slice</replaceable> is not used
or recognized by the JumpStart program. You can use this option to specify
that you want a file system to be ignored on a disk during installation. The
JumpStart program creates a new file system on the same disk with the same
name. You can use <literal>ignore</literal> only when <literal>partitioning
existing</literal> is specified.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_parameters</replaceable></term><listitem><para>Use one of the following values:</para><variablelist><varlistentry><term><literal>preserve</literal></term><listitem><para>The file system on the specified <replaceable>slice</replaceable> is
preserved.</para><note><para><literal>preserve</literal> can be specified only when <replaceable>size</replaceable> is <literal>existing</literal> and <replaceable>slice</replaceable> is <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable>.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><replaceable>mount_options</replaceable></term><listitem><para>One or more mount options, which is the same as the <option>o</option> option
of the <olink targetdoc="refman1m" targetptr="mount-1m" remap="external"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink> command.
The mount options are added to the <filename>/etc/vfstab</filename> entry
for the specified <replaceable>mount_pt_name</replaceable>.</para><note><para>If you need to specify more than one mount option, the mount options
must be separated by commas and no space (<literal>ro,quota</literal>, for
example).</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect3><sect3 id="jumpstartreference-mirror"><title><literal>filesys</literal> Profile
Keyword (Creating RAID-1 Volumes)</title><programlisting role="complete">filesys mirror[:<replaceable>name</replaceable>]<replaceable>slice</replaceable> [<replaceable>slice</replaceable>] <replaceable>size</replaceable> <replaceable>file_system</replaceable> <replaceable>optional_parameters</replaceable></programlisting><para>By using the <literal>filesys mirror</literal> keywords with the values
that are listed, the JumpStart program creates the RAID-1 and RAID-0 volumes
that are necessary to create a mirrored file system. You can specify <literal>filesys
mirror</literal> more than once to create RAID-1 volumes (mirrors) for different
file systems.</para><note><para>The <literal>filesys mirror</literal> keyword is only supported
for initial installations.</para>
</note><variablelist><varlistentry><term><replaceable>name</replaceable></term><listitem><para>This optional keyword enables you to name the RAID-1 volume
(mirror). Mirror names must start with the letter &ldquo;d&rdquo;, followed
by a number between 0 and 127, for example, <literal>d100</literal>. If you
do not specify a mirror name, the custom JumpStart program assigns a mirror
name for you. For guidelines about how to name mirrors, see <olink targetdoc="solinstallpbiu" targetptr="epudh" remap="external"><citetitle remap="section">RAID Volume Name Requirements and Guidelines for Custom JumpStart and Solaris Live Upgrade</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Planning for Installation and Upgrade</citetitle></olink>.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>slice</replaceable></term><listitem><para>This value specifies the disk slice where the custom JumpStart
program places the file system you want to duplicate. The slice value must
follow the format c<replaceable>w</replaceable>t<replaceable>x</replaceable>d<replaceable>y</replaceable>s<replaceable>z</replaceable>, for example <literal>c0t0d0s0</literal> or <literal>c0t0d0s5</literal>. The custom JumpStart program creates a RAID-0 volume (single-slice
concatenation) on the slice, and creates a RAID-1 volume to mirror the concatenation.
You can specify up to two slices for two RAID-0 volumes.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>size</replaceable></term><listitem><para>This value specifies the size, in Mbytes, of the file system.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>file_system</replaceable></term><listitem><para>This value specifies the file system that you are duplicating.
The custom JumpStart program creates the RAID-1 volume from the slices that
are specified and mounts the RAID-1 volume on the specified file system. In
addition to critical file systems, such as root (<filename>/</filename>), <filename>/usr</filename>, and <filename>/var</filename>, you can also specify <filename>swap</filename> as the file system.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_parameters</replaceable></term><listitem><para>One or more mount options, which is the same as the <option>o</option> option
of the <olink targetdoc="refman1m" targetptr="mount-1m" remap="external"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink> command.
The mount options are added to the <filename>/etc/vfstab</filename> entry
for the specified <replaceable>file_system</replaceable>. If you need to specify
more than one mount option, the mount options must be separated by commas
and no spaces, for example, <literal>ro,quota</literal>.</para>
</listitem>
</varlistentry>
</variablelist><para>For more information about creating mirrored file systems during your
installation, see <olink targetdoc="solinstallpbiu" targetptr="mirroroverview-1" remap="external">Chapter 8, <citetitle remap="chapter">Creating RAID-1 Volumes (Mirrors) During Installation (Overview),</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Planning for Installation and Upgrade</citetitle></olink>.</para>
</sect3><sect3 id="jumpstartreference-702"><title><literal>forced_deployment</literal> Profile
Keyword (Installing Solaris Flash Differential Archives)</title><programlisting role="complete">forced_deployment </programlisting><para><literal>forced_deployment</literal> forces
the installation of a Solaris Flash differential archive onto a clone
system that is different than the software expects. </para><caution><para>If you use <literal>forced_deployment</literal>, all new files
are deleted to bring the clone system to the expected state. If you are not
certain that you want files deleted, use the default, which protects new files
by stopping the installation. </para>
</caution>
</sect3><sect3 id="preparecustom-1"><title><literal>geo</literal> Profile Keyword</title><programlisting role="complete">geo <replaceable>region</replaceable></programlisting><para><literal>geo</literal> designates the regional locale or locales
that  you want to install on a system or to add when upgrading a system. <replaceable>region</replaceable> designates a geographical area that contains the locales
that you want to install. Values you can specify for <replaceable>region</replaceable> are
listed in the following table. </para><informaltable frame="topbot"><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="column1" colwidth="100*"/><colspec colname="column2" colwidth="296*"/><thead><row><entry><para>Value</para>
</entry><entry><para>Description</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>N_Africa</literal></para>
</entry><entry><para>Northern Africa, including Egypt</para>
</entry>
</row><row><entry><para><literal>C_America</literal></para>
</entry><entry><para>Central America, including Costa Rica, El Salvador, Guatemala, Mexico,
Nicaragua, Panama</para>
</entry>
</row><row><entry><para><literal>N_America</literal></para>
</entry><entry><para>North America, including Canada, United States</para>
</entry>
</row><row><entry><para><literal>S_America</literal></para>
</entry><entry><para>South America, including Argentina, Bolivia, Brazil, Chile, Colombia,
Ecuador, Paraguay, Peru, Uruguay, Venezuela</para>
</entry>
</row><row><entry><para><literal>Asia</literal></para>
</entry><entry><para>Asia, including Japan, Republic of Korea, People's Republic of China,
Taiwan, Thailand</para>
</entry>
</row><row><entry><para><literal>Ausi</literal></para>
</entry><entry><para>Australasia, including Australia, New Zealand</para>
</entry>
</row><row><entry><para><literal>C_Europe</literal></para>
</entry><entry><para>Central Europe, including Austria, Czech Republic, Germany, Hungary,
Poland, Slovakia, Switzerland</para>
</entry>
</row><row><entry><para><literal>E_Europe</literal></para>
</entry><entry><para>Eastern Europe, including Albania, Bosnia, Bulgaria, Croatia, Estonia,
Latvia, Lithuania, Macedonia, Romania, Russia, Serbia, Slovenia, Turkey</para>
</entry>
</row><row><entry><para><literal>N_Europe</literal></para>
</entry><entry><para>Northern Europe, including Denmark, Finland, Iceland, Norway, Sweden</para>
</entry>
</row><row><entry><para><literal>S_Europe</literal></para>
</entry><entry><para>Southern Europe, including Greece, Italy, Portugal, Spain</para>
</entry>
</row><row><entry><para><literal>W_Europe</literal></para>
</entry><entry><para>Western Europe, including Belgium, France, Great Britain, Ireland, Netherlands</para>
</entry>
</row><row><entry><para><literal>M_East</literal></para>
</entry><entry><para>Middle East, including Israel</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable><para>A complete list of the component locale values that compose each regional
locale that is listed previously is presented in <olink targetdoc="i18ndg" remap="external"><citetitle remap="book">International Language Environments Guide</citetitle></olink>.</para><note><para>You can specify a <literal>geo</literal> keyword for each locale
you need to add to a system.</para>
</note>
</sect3><sect3 id="preparecustom-90"><title><literal>install_type</literal> Profile
Keyword</title><programlisting role="complete">install_type <replaceable>initial_upgrade_flash_switch</replaceable></programlisting><para><literal>install_type</literal> defines whether to erase and install
a new Solaris OS on a system, upgrade the existing Solaris OS on a system,
or install a Solaris Flash archive on the system.</para><note><para>You must specify <literal>install_type</literal> in a profile,
and <literal>install_type</literal> must be the first profile keyword in every
profile.</para>
</note><para>You must use one of the
following options for the <replaceable>initial_upgrade_flash_switch</replaceable>:
 </para><variablelist><varlistentry><term><literal>initial_install</literal></term><listitem><para>Specifies to perform an initial installation of the Solaris
OS</para>
</listitem>
</varlistentry><varlistentry><term><literal>upgrade</literal></term><listitem><para>Specifies to perform an upgrade of the Solaris OS</para>
</listitem>
</varlistentry><varlistentry><term><literal>flash_install</literal></term><listitem><para>Specifies to install a Solaris Flash archive that overwrites
all files</para>
</listitem>
</varlistentry><varlistentry><term><literal>flash_update</literal></term><listitem><para>Specifies to install a Solaris Flash differential archive
that overwrites only the files that are specified</para>
</listitem>
</varlistentry>
</variablelist><note><para>Some profile keywords can only be used with the <literal>initial_install</literal> option. Some profile keywords can only be used with the <literal>upgrade</literal> option. Some profile keywords can only be used with the <literal>flash_install</literal> option.</para>
</note>
</sect3><sect3 id="preparecustom-91"><title><literal>layout_constraint</literal> Profile
Keyword</title><programlisting role="complete">layout_constraint <replaceable>slice</replaceable> <replaceable>constraint</replaceable> <replaceable>minimum_size</replaceable></programlisting><para><literal>layout_constraint</literal> designates the constraint auto-layout
has on a file system if auto-layout needs to reallocate space during an upgrade
because of space problems. </para><informaltable frame="topbot"><tgroup cols="2" colsep="0" rowsep="0"><colspec colwidth="33.49*"/><colspec colwidth="66.51*"/><thead><row><entry rowsep="1" valign="top"><para>Limitation</para>
</entry><entry rowsep="1" valign="top"><para>Description</para>
</entry>
</row>
</thead><tbody><row><entry><para>This keyword is used only with upgrade option.</para>
</entry><entry><para>You can use <literal>layout_constraint</literal> only for the upgrade
option when you need to reallocate disk space.</para>
</entry>
</row><row><entry><para>If you do not specify the <literal>layout_constraint</literal> keyword </para>
</entry><entry><para>The JumpStart program lays out the disk as follows:</para><itemizedlist><listitem><para>File systems that require more space for the upgrade are marked
changeable.</para>
</listitem><listitem><para>File systems that are on the same disk as the file system
that requires more space and that are mounted by the <filename>/etc/vfstab</filename> file
are marked changeable.</para>
</listitem><listitem><para>Remaining file systems are marked fixed because auto-layout
cannot change the file systems.</para>
</listitem>
</itemizedlist>
</entry>
</row><row><entry><para>If you specify one or more <literal>layout_constraint</literal> keywords</para>
</entry><entry><para>The JumpStart program lays out the disk as follows:</para><itemizedlist><listitem><para>File systems that require more space for the upgrade are marked
changeable.</para>
</listitem><listitem><para>File systems for which you specified a <literal>layout_constraint</literal> keyword are marked with the specified constraint.</para>
</listitem><listitem><para>The remaining file systems are marked fixed.</para>
</listitem>
</itemizedlist>
</entry>
</row><row><entry><para>If the file system is not marked changeable</para>
</entry><entry><para>You cannot change the constraint on file systems that require more space
for the upgrade because the file systems must be marked changeable. You can
use the <literal>layout_constraint</literal> keyword to change the <replaceable>minimum_size</replaceable> values on file systems that require more space for the upgrade.</para>
</entry>
</row><row><entry><para>If file systems require more space for upgrade</para>
</entry><entry><para>To help auto-layout reallocate space, select more file systems to be
changeable or movable, especially those file systems that are located on the
same disks as the file systems that require more space for the upgrade.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable><variablelist><varlistentry><term><replaceable>slice</replaceable></term><listitem><para>Specifies the file system's disk slice on which to specify
the constraint. You must specify the system's disk slice in the form <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable>.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>constraint</replaceable></term><listitem><para>Use one of the following constraints for the specified file
system:</para><variablelist><varlistentry><term><literal>changeable</literal></term><listitem><para>Auto-layout can move the file system to another location and
it can change the file system size. The <literal>changeable</literal> constraint
can only be specified on file systems that are mounted by the <filename>/etc/vfstab</filename> file. You can change the file system's size by specifying the <replaceable>minimum_size</replaceable> value.</para><para>When you mark a file system as changeable and <replaceable>minimum_size</replaceable> is
not specified, the file system's minimum size is set to 10 percent more than
the minimum size that is required. For example, if the minimum size for a
file system is 100 Mbytes, the changed size is 110 Mbytes. If <replaceable>minimum_size</replaceable> is specified, any free space that remains, original size minus
minimum size, is used for other file systems.</para>
</listitem>
</varlistentry><varlistentry><term><literal>movable</literal></term><listitem><para>Auto-layout can move the file system to another slice on the
same disk or different disk. The file system size remains the same.</para>
</listitem>
</varlistentry><varlistentry><term><literal>available</literal></term><listitem><para>Auto-layout can use all of the space on the file system to
reallocate space. All of the data in the file system is lost. The <literal>available</literal> constraint can only be specified on file systems that are not mounted
by the <filename>/etc/vfstab</filename> file.</para>
</listitem>
</varlistentry><varlistentry><term><literal>collapse</literal></term><listitem><para>Auto-layout moves and collapses the specified file system
into the parent file system.  You can use the <literal>collapse</literal> option
to reduce the number of file systems on a system as part of the upgrade. For
example, if a system has the <literal>/usr</literal> and <literal>/usr/share</literal> file
systems, collapsing the <literal>/usr/share</literal> file system moves the
file system into <literal>/usr</literal>, the parent file system. You can
specify the <literal>collapse</literal> constraint only on file systems that
are mounted by the <filename>/etc/vfstab</filename> file.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry><varlistentry><term><replaceable>minimum_size</replaceable></term><listitem><para>Specifies the size of the file system after auto-layout reallocates
space. The <replaceable>minimum_size</replaceable> option enables you to change
the size of a file system. The size of the file system might be larger if
unallocated space is added to the file system. But, the size is never less
than the value you specify. The <replaceable>minimum_size</replaceable> value
is optional. Use this value only if you have marked a file system as changeable
and the minimum size cannot be less than what the file system needs for the
existing file system contents.</para>
</listitem>
</varlistentry>
</variablelist><example id="fxjxm"><title><literal>layout_constraint</literal> Profile Keyword</title><programlisting>layout_constraint c0t3d0s1 changeable 200

layout_constraint c0t3d0s4 movable

layout_constraint c0t3d1s3 available

layout_constraint c0t2d0s1 collapse</programlisting>
</example>
</sect3><sect3 id="jumpstartreference-701"><title><literal>local_customization</literal> Profile
Keyword (Installing Solaris Flash Archives)</title><programlisting role="complete">local_customization <replaceable>local_directory</replaceable></programlisting><para>Before you install a Solaris Flash archive
on a clone system, you can create custom scripts to preserve local configurations
on the clone system. The <literal>local_customization</literal> keyword designates
the directory where you have stored these scripts. <replaceable>local_directory</replaceable> is
the path to the script on the clone system.</para><para>For information about predeployment and postdeployment scripts, see <olink targetdoc="solinstallflash" targetptr="flashcreate-65" remap="external"><citetitle remap="section">Creating Customization Scripts</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Solaris Flash Archives (Creation and Installation)</citetitle></olink>.</para>
</sect3><sect3 id="preparecustom-92"><title><literal>locale</literal> Profile Keyword</title><programlisting role="complete">locale <replaceable>locale_name</replaceable></programlisting><note><para>You can use <literal>locale</literal> with both the initial installation
and upgrade options.</para>
</note><para><literal>locale</literal> designates the locale packages you want
to install or add when upgrading for the specified <replaceable>locale_name</replaceable>.
The <replaceable>locale_name</replaceable> values are the same as those values
that are used for the <envar>$LANG</envar> environment variable. <olink targetdoc="i18ndg" remap="external"><citetitle remap="book">International Language Environments Guide</citetitle></olink> contains a list of valid locale values.  </para><para>When you use the <literal>locale</literal> keyword, consider the following:</para><itemizedlist><listitem><para>If you have preconfigured a default locale, the locale is
automatically installed. The English language packages are installed by default.</para>
</listitem><listitem><para>You can specify a <literal>locale</literal> keyword for each
locale you need to add to a system.</para>
</listitem>
</itemizedlist>
</sect3><sect3 id="jumpstartreference-metadb"><title><literal>metadb</literal> Profile
Keyword (Creating State Database Replicas)</title><programlisting>metadb <replaceable>slice</replaceable> [size <replaceable>size-in-blocks</replaceable>] [count <replaceable>number-of-replicas</replaceable>]</programlisting><para>The <literal>metadb</literal> keyword enables you to create Solaris
Volume Manager state database replicas (mediates) during your custom JumpStart
installation. You can use the <literal>metadb</literal> keyword multiple times
in your profile file to create state database replicas on different disk slices.</para><variablelist><varlistentry><term><replaceable>slice</replaceable></term><listitem><para>You must specify the disk slice on which you want the custom
JumpStart program to place the state database replica. The <replaceable>slice</replaceable> value
must follow the format c<replaceable>w</replaceable>t<replaceable>x</replaceable>d<replaceable>y</replaceable>s<replaceable>z</replaceable>.</para>
</listitem>
</varlistentry><varlistentry><term><literal>size</literal> <replaceable>size-in-blocks</replaceable></term><listitem><para>The <literal>size</literal> optional keyword enables you to
specify the size, in blocks, of the state database replica to be created.
If you do not specify a <literal>size</literal> value, the custom JumpStart
program uses a default size of 8192 blocks for the state database replica.</para>
</listitem>
</varlistentry><varlistentry><term><literal>count</literal> <replaceable>number-of-replicas</replaceable></term><listitem><para>You can specify the number of state database replicas you
are creating by setting the optional <literal>count</literal> keyword value
in your profile. If you do not specify a <literal>count</literal> value, the
custom JumpStart program creates three state database replicas by default.</para>
</listitem>
</varlistentry>
</variablelist><para>For more information about creating Solaris Volume Manager state database
replicas during your installation, see <olink targetdoc="solinstallpbiu" targetptr="volumes-10" remap="external"><citetitle remap="section">State Database Replicas Guidelines and Requirements</citetitle> in <citetitle remap="book">Solaris Express Installation Guide: Planning for Installation and Upgrade</citetitle></olink>.</para>
</sect3><sect3 id="jumpstartreference-703"><title><literal>no_content_check</literal> Profile
Keyword (Installing Solaris Flash Archives)</title><programlisting role="complete">no_content_check</programlisting><para>When installing a clone system with a Solaris Flash differential
archive, you can use the <literal>no_content_check</literal> keyword to ignore
file-by-file validation. File-by-file validation ensures that the clone system
is a duplicate of the master system. Avoid using this keyword unless you are
sure the clone system is a duplicate of the original master system.</para><caution><para>If you use <literal>no_content_check</literal>, all new files
are deleted to bring the clone system to the expected state. If you are not
certain that you want files deleted, use the default, which protects new files
by stopping the installation. </para>
</caution><para>For information about installing Solaris Flash differential archives,
see <olink targetptr="flash-46" remap="internal">To Prepare to Install a Solaris Flash Archive
With a Custom JumpStart Installation</olink>.  </para>
</sect3><sect3 id="jumpstartreference-704"><title><literal>no_master_check</literal> Profile
Keyword (Installing Solaris Flash Archives)</title><programlisting role="complete">no_master_check</programlisting><para>When installing a clone system with a Solaris Flash differential
archive, you can use the <literal>no_master_check</literal> keyword to ignore
checking the clone system to make sure it was built from the original master
system. Avoid using this keyword unless you are sure the clone system is a
duplicate of the original master system. </para><para>For information about installing Solaris Flash differential archives,
see <olink targetptr="flash-46" remap="internal">To Prepare to Install a Solaris Flash Archive
With a Custom JumpStart Installation</olink>.  </para>
</sect3><sect3 id="preparecustom-93"><title><literal>num_clients</literal> Profile
Keyword</title><programlisting role="complete">num_clients <replaceable>client_num</replaceable></programlisting><para>When a server is installed, space is allocated for each diskless
client's root (<filename>/</filename>) and <filename>swap</filename> file
systems. <literal>num_clients</literal> defines the number of diskless clients, <replaceable>client_num</replaceable>, that a server supports. If you do not specify <literal>num_clients</literal> in the profile, five diskless clients are allocated
by default. </para><note><para>You can use <literal>num_clients</literal> only when <literal>system_type</literal> is specified as <literal>server</literal>.</para>
</note>
</sect3><sect3 id="preparecustom-94"><title><literal>package</literal> Profile Keyword</title><programlisting role="complete">package <replaceable>package_name</replaceable> [add [<replaceable>retrieval_type location</replaceable>]| delete]</programlisting><para>You can use <literal>package</literal> with both the initial installation
and upgrade options. The <literal>package</literal> keyword enables you to
do the following:</para><itemizedlist><listitem><para>Add a package to the software group from the Solaris distribution
that is to be installed. </para>
</listitem><listitem><para>Add a package to the software group from outside the distribution
that is being installed.</para>
</listitem><listitem><para>Exclude or remove a package from the software group that is
to be installed or upgraded.</para>
</listitem><listitem><para>Add a package from outside the distribution that is being
installed when installing a Solaris Flash archive.</para>
</listitem>
</itemizedlist><variablelist><varlistentry><term><replaceable>package_name</replaceable></term><listitem><para>Specifies the package name in the form <literal>SUNW</literal><replaceable>name</replaceable>. To view detailed information about packages and their
names, on an installed system, use the <command>pkginfo -l</command> command.</para>
</listitem>
</varlistentry><varlistentry><term>add | delete</term><listitem><para>Specifies to add or remove the specified package. If you do
not specify <literal>add</literal> or <literal>delete</literal>, <literal>add</literal> is
used by default.</para><note><para>You can add more than one package by adding another package entry
to the profile and omitting the location. The location of the previous package
is used for all subsequent packages if the location is left blank.</para>
</note>
</listitem>
</varlistentry><varlistentry><term>[<replaceable>retrieval_type location</replaceable>]</term><listitem><para>Specifies the addition of a package or packages that are located
outside the Solaris distribution that is being installed. The values of <replaceable>retrieval_type</replaceable> and <replaceable>location</replaceable> depend
on where the package is stored. The following sections contain the values
you can use for <replaceable>retrieval_type</replaceable> and <replaceable>location</replaceable> and examples of how to use the <literal>package_name</literal> keyword.</para>
</listitem>
</varlistentry>
</variablelist><sect4 id="preparecustom-400"><title>Packages Stored on an NFS Server</title><para>If the package is stored on an NFS server, use one of the following
syntaxes for the <literal>package</literal> keyword. </para><screen>package <replaceable>package_name</replaceable> add nfs <replaceable>server_name:/path</replaceable> [retry <replaceable>n</replaceable>]
package <replaceable>package_name</replaceable> add nfs://<replaceable>server_name:/path</replaceable> [retry <replaceable>n</replaceable>]</screen><variablelist><varlistentry><term><replaceable>package_name</replaceable></term><listitem><para>Specifies the package name in the form <literal>SUNW</literal><replaceable>name</replaceable>. To view detailed information about packages and their
names, on an installed system, use the <command>pkginfo -l</command> command.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>Specifies the name of the server where you stored the package.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>Specifies the location of the package directory on the specified
server.  If the path contains $HOST, $HOST is replaced with the name of the
host system that you are installing.</para>
</listitem>
</varlistentry><varlistentry><term>retry <replaceable>n</replaceable></term><listitem><para>Is an optional keyword. <replaceable>n</replaceable> is the
maximum number of times the installation process attempts to mount the directory.</para>
</listitem>
</varlistentry>
</variablelist><example id="jumpstartreference-ex-29"><title>Adding a Package by Using NFS</title><para>In this example, the <literal>package</literal> profile keyword adds
the SUNWnew package from the NFS location <filename>nfs://golden/packages/Solaris_11/</filename>. If a mount fails, the NFS mount is tried five times.</para><programlisting>package SUNWnew add nfs <filename>golden:/packages/Solaris_11 retry 5</filename></programlisting>
</example>
</sect4><sect4 id="preparecustom-3001"><title>Packages Stored on an HTTP Server</title><para>If the package is stored on an HTTP server, use one of the following
syntaxes for the <literal>package</literal> keyword.</para><screen>package <replaceable>package_name</replaceable> add http://<replaceable>server_name[:port] path</replaceable> <replaceable>optional_keywords</replaceable>
package <replaceable>package_name</replaceable> add http <replaceable>server_name[:port] path</replaceable> <replaceable>optional_keywords</replaceable></screen><variablelist><varlistentry><term><replaceable>package_name</replaceable></term><listitem><para>Specifies the package name in the form <literal>SUNW</literal><replaceable>name</replaceable>. To view detailed information about packages and their
names, on an installed system, use the <command>pkginfo -l</command> command.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>Specifies the name of the server where you stored the package. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>port</replaceable></term><listitem><para>Specifies an optional port.  <replaceable>port</replaceable> can
be a port number or the name of a TCP service that has a port number that
is determined at runtime.</para><para>If you do not specify a port, the default HTTP port number 80 is used.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>Specifies the location of the package to be retrieved from
the specified server. When using an HTTP server, the package must be in package
datastream format. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_keywords</replaceable></term><listitem><para>Specifies the optional keywords to use when you retrieve a
package from an HTTP server.</para>
</listitem>
</varlistentry>
</variablelist><table frame="topbot" pgwide="1" id="flash-tbl-6201"><title>Optional <literal>package</literal> Keywords to Use With HTTP</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="colspec2" colwidth="29.69*"/><colspec colname="colspec3" colwidth="70.31*"/><thead><row rowsep="1"><entry><para>Keyword</para>
</entry><entry><para>Value Definition</para>
</entry>
</row>
</thead><tbody><row><entry colname="colspec2"><para><literal>timeout</literal> <replaceable>min</replaceable></para>
</entry><entry colname="colspec3"><para>The <literal>timeout</literal> keyword enables you to specify, in minutes,
the maximum length of time that is allowed to pass without receipt of data
from the HTTP server. If a timeout occurs, the connection is closed, reopened,
and resumed. If you specify a <literal>timeout</literal> value of 0 (zero),
the connection is not reopened.</para><para>If a timeout reconnection occurs, the package is retried from the beginning
of the package and the data that was retrieved prior to the timeout is discarded.</para>
</entry>
</row><row><entry colname="colspec2"><para><literal>proxy</literal> <replaceable>host:port</replaceable></para>
</entry><entry colname="colspec3"><para>The <literal>proxy</literal> keyword enables you to specify a proxy
host and proxy port.  You can use a proxy host to retrieve a Solaris package
from the other side of a firewall.  You must supply a proxy port when you
specify the <literal>proxy</literal> keyword.</para>
</entry>
</row>
</tbody>
</tgroup>
</table><example id="jumpstartreference-ex-16"><title>Adding a Package by Using HTTP</title><para>In this example, the <literal>package</literal> profile keyword adds
all the packages listed in the <filename>Solaris 11</filename> directory
from the HTTP location <filename>http://package.central/Solaris_11</filename>.
If five minutes pass and no data is received, the package data is retrieved
again. Previous package data is discarded. Either of the following formats
can be used.</para><programlisting width="100">package SUNWnew add http package.central/Solaris_11 timeout 5 </programlisting><programlisting width="100">package SUNWnew add http://package.central/Solaris_11 timeout 5 </programlisting>
</example><example id="jumpstartreference-ex-26"><title>Adding a Package by Using HTTP
with a Proxy Port</title><para>In this example, the <literal>package</literal> profile keyword adds
all the packages listed in the <filename>Solaris_11</filename> directory
from the HTTP location <filename>http://package.central/Solaris_11</filename>.
The package is retrieved across a firewall by using the <literal>proxy</literal> keyword. </para><programlisting width="100">package SUNWnew add http://package.central/Solaris_11 proxy webcache.east:8080</programlisting>
</example>
</sect4><sect4 id="preparecustom-611"><title>Packages Stored on a Local Device</title><para>You can retrieve a Solaris package from a local device if you stored
the package on a file system-oriented, random-access device, such as a diskette
or a DVD-ROM. Use the following syntax for the <literal>package</literal> keyword.</para><programlisting>package <replaceable>package_name</replaceable> add local_device <replaceable>device</replaceable> <replaceable>path</replaceable> <replaceable>file_system_type</replaceable></programlisting><variablelist><varlistentry><term><replaceable>package_name</replaceable></term><listitem><para>Specifies the package name in the form <literal>SUNW</literal><replaceable>name</replaceable>. To view detailed information about packages and their
names, on an installed system, use the <command>pkginfo -l</command> command.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>device</replaceable></term><listitem><para>Specifies the name of the drive where the Solaris package
resides. If the device name is a canonical path, the device is mounted directly.
  If you supply a device name that is not a canonical path, the installation
utility adds <filename>/dev/dsk/</filename> to the path. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>Specifies the path to the Solaris package, relative to the
root (<filename>/</filename>) file system on the device you specified. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>file_system_type</replaceable></term><listitem><para>Specifies the type of file system on the device.  If you do
not supply a file system type, the installation utility attempts to mount
a UFS file system.  If the UFS mount fails, the installation utility attempts
to mount an HSFS file system. </para>
</listitem>
</varlistentry>
</variablelist><example id="jumpstartreference-ex-20"><title>Adding a Package by Using a
Local Device With a UFS File System</title><para>In this example, the <literal>package</literal> profile keyword adds
the <literal>SUNWnew</literal> package from the directory <filename>/Solaris_11/Product</filename> from the local device c0t6d0s0. This is a UFS file system.</para><programlisting>package SUNWnew add local_device c0t6d0s0 <filename>/Solaris_11/Product</filename> ufs</programlisting>
</example><example id="jumpstartreference-ex-21"><title>Adding a Package by Using a
Local Device From an HSFS File System</title><para>In this example, the <literal>package</literal> profile keyword adds
the <literal>SUNWnew</literal> package from the directory <filename>/Solaris_11/Product</filename> from the local device c0t6d0s0. This is an HSFS file system.</para><programlisting>package SUNWnew add local_device c0t6d0s0 <filename>/Solaris_11/Product</filename>  hsfs</programlisting>
</example>
</sect4><sect4 id="preparecustom-711"><title>Packages Stored on a Local File</title><para>A package can be installed from the miniroot from which you booted the
system. When you perform a custom JumpStart installation, you boot the system
from a DVD, CD, or an NFS-based miniroot.  The installation software is loaded
and run from this miniroot.  Therefore, a package that you stored in the DVD,
CD, or NFS-based miniroot is accessible as a local file. Use the following
syntax for the <literal>package</literal> keyword.</para><screen>package <replaceable>package_name</replaceable> add local_file <replaceable>path</replaceable> </screen><variablelist><varlistentry><term><replaceable>package_name</replaceable></term><listitem><para>Specifies the package name in the form <literal>SUNW</literal><replaceable>name</replaceable>. To view detailed information about packages and their
names, on an installed system, use the <command>pkginfo -l</command> command.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>Specifies the location of the package. The path must be accessible
to the system as a local file while the system is booted from the Solaris Software - 1 CD
or from the Solaris Operating System DVD. The system cannot access <filename>/net</filename> when
it is booted from the Solaris Software - 1 CD or from the Solaris Operating System DVD.</para>
</listitem>
</varlistentry>
</variablelist><example id="jumpstartreference-ex-12"><title>Adding a Package by Using a
Local File</title><para>In this example, the <literal>package</literal> profile keyword adds
the <literal>SUNWnew</literal> package from the <filename>/Solaris_11/Product</filename> directory. </para><programlisting>package SUNWnew add local_file <filename>/Solaris_11/Product</filename></programlisting>
</example>
</sect4><sect4 id="jumpstartreference-3"><title>Limitations When Using the <literal>package</literal> Keyword</title><para>Note these limitations when using the <literal>package</literal> keyword:</para><itemizedlist><listitem><para>Some packages are required and cannot be deleted.</para>
</listitem><listitem><para>You cannot individually add or delete localization packages
by using the <literal>package</literal> profile keyword. To add localization
packages, use the <literal>locale</literal> profile keyword.</para>
</listitem><listitem><para>Packages cannot be retrieved from an FTP server location or
local backup, such as tape.</para>
</listitem><listitem><para>Packages within the Solaris distribution being installed cannot
be added from alternate locations. If a package from the Solaris distribution
is specified, the package cannot be followed by an alternative location in
order to maintain consistency with the resulting installed system.</para>
</listitem><listitem><para>In order to install without manual intervention, the package
must be installable by using the <command>pkgadd</command> command. The same <literal>admin</literal> file must be used to install the software group packages and
the package that resides in another location. </para><itemizedlist><listitem><para>If the retrieval_type is HTTP, then the package must be in
stream format.</para>
</listitem><listitem><para>If the retrieval_type is NFS server, local device, or local
file, then the package should follow standard packaging format with the directory
name being the same as the package being installed. </para>
</listitem><listitem><para>If a package is being added from a separate location and a
package depends on another package that is not currently installed, the package
is not installed. An error message is logged into the install or upgrade log
file.</para>
</listitem>
</itemizedlist>
</listitem><listitem><para>If the package is being installed with a Solaris Flash archive,
follow these guidelines.</para><itemizedlist><listitem><para>Any package installed must be compatible with the archive.</para>
</listitem><listitem><para>If a package is present in the archive, the JumpStart overwrites
the existing package.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect4><sect4 id="jumpstartreference-41"><title>Upgrade Behavior When Using
the <literal>package</literal> Keyword</title><para>When you use <literal>package</literal> for an upgrade, the JumpStart
program performs the following actions: </para><itemizedlist><listitem><para>All packages already on the system are automatically upgraded.</para>
</listitem><listitem><para>If you specify <replaceable>package_name</replaceable> <literal>add</literal> and <replaceable>package_name</replaceable> is not installed on
the system, the package is installed.</para>
</listitem><listitem><para>If you specify <replaceable>package_name</replaceable> <literal>delete</literal> and <replaceable>package_name</replaceable> is installed on the
system, the package is deleted <emphasis>before</emphasis> the upgrade begins.</para>
</listitem><listitem><para>If you specify <replaceable>package_name</replaceable> <literal>delete</literal> and <replaceable>package_name</replaceable> is not installed on
the system, the package is not installed if the package is part of a cluster
that is designated to be installed.</para>
</listitem>
</itemizedlist>
</sect4>
</sect3><sect3 id="preparecustom-95"><title><literal>partitioning</literal> Profile
Keyword</title><programlisting role="complete">partitioning <replaceable>type</replaceable></programlisting><para><literal>partitioning</literal> defines how
the disks are divided into slices for file systems during the installation.
 </para><para>If you do not specify <literal>partitioning</literal> in the profile,
the <literal>default</literal> type of partitioning is used by default.</para><variablelist><varlistentry><term><replaceable>type</replaceable></term><listitem><para>Use one of the following values:</para><variablelist><varlistentry><term><literal>default</literal></term><listitem><para>The JumpStart program selects the disks and creates the file
systems on which to install the specified software,  except for any file systems
that are specified by the <literal>filesys</literal> keywords. <literal>rootdisk</literal> is
selected first. The JumpStart program uses additional disks if the specified
software does not fit on <literal>rootdisk</literal>. </para>
</listitem>
</varlistentry><varlistentry><term><literal>existing</literal></term><listitem><para>The JumpStart program uses the existing file systems on the
system's disks. All file systems except <filename>/</filename>, <filename>/usr</filename>, <filename>/usr/openwin</filename>, <filename>/opt</filename>, and <filename>/var</filename> are
preserved. The JumpStart program uses the last mount-point field from the
file system superblock to determine which file-system mount point the slice
represents. </para><note><para>When you use both the <literal>filesys</literal> and <literal>partitioning
existing</literal> profile keywords, you must set size <replaceable>size</replaceable> to <literal>existing</literal>.</para>
</note>
</listitem>
</varlistentry><varlistentry><term><literal>explicit</literal></term><listitem><para>The JumpStart program uses the disks and creates the file
systems that are specified by the <literal>filesys</literal> keywords. If
you specify only the root (<filename>/</filename>) file system with the <literal>filesys</literal> keyword, all of the Solaris software is installed in the
root (<filename>/</filename>) file system.</para><note><para>If you use the <literal>explicit</literal> profile value, you
must use the <literal>filesys</literal> keyword to specify the disks to use
and file systems to create.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect3><sect3 id="egkca"><title><literal>patch</literal> Profile Keyword</title><programlisting role="complete">patch <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> <replaceable>patch_location</replaceable> <replaceable>optional_keywords</replaceable>]</programlisting><variablelist><varlistentry><term><replaceable>patch_id_list</replaceable></term><listitem><para>Specifies the patch ID numbers that are to be installed. The
list should be a list of comma-separated Solaris patch IDs. The patches are
installed in the order specified in the list. Do not add a space after the
comma, for example: 112467-01,112765-02.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_file</replaceable></term><listitem><para>A file with a list of patches that is found in the <replaceable>patch_location</replaceable>. The patches are installed in the order specified in the file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_location</replaceable></term><listitem><para>Specifies the location where the patches reside. The locations
allowed are the following:</para><itemizedlist><listitem><para>NFS server</para>
</listitem><listitem><para>HTTP server</para>
</listitem><listitem><para>Local device</para>
</listitem><listitem><para>Local file</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_keywords</replaceable></term><listitem><para>Optional keywords depend on where patches are stored. The
following sections describe the possible locations and optional keywords.</para>
</listitem>
</varlistentry>
</variablelist><sect4 id="egkbu"><title>Patches Stored on an NFS Server</title><para>If the patch is stored on an NFS server, use one of the following syntaxes
for the <literal>patch</literal> keyword.</para><screen width="100">patch <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> nfs <replaceable>server_name:/patch_directory</replaceable> [retry <replaceable>n</replaceable>]
patch <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> nfs://<replaceable>server_name/patch_director</replaceable>  [retry <replaceable>n</replaceable>]</screen><variablelist><varlistentry><term><replaceable>patch_id_list</replaceable></term><listitem><para>Specifies the patch ID numbers that are to be installed. The
list should be a list of comma-separated Solaris patch IDs. The patches are
installed in the order specified in the list. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_file</replaceable></term><listitem><para>A file with a list of patches that is found in the <replaceable>patch_location</replaceable>. The patches are installed in the order specified in the file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>Specifies the name of the server where you stored the patches.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_directory</replaceable></term><listitem><para>Specifies the location of the patch directory on the specified
server. The patches must be in standard patch format. </para>
</listitem>
</varlistentry><varlistentry><term>retry <replaceable>n</replaceable></term><listitem><para>Is an optional keyword. <replaceable>n</replaceable> is the
maximum number of times the install utility attempts to mount the directory.</para>
</listitem>
</varlistentry>
</variablelist><example id="egkcb"><title>Adding a Patch With an Ordered List by Using NFS</title><para>In this example, the <literal>patch</literal> profile keyword adds all
the patches listed in the <filename>patch</filename> file from the NFS patch
directory <filename>nfs://patch_master/Solaris/v11/patches</filename>.
Patches are installed in the order listed in the <filename>patch</filename>.
If a mount fails, the NFS mount is tried five times.</para><programlisting>patch patch_file <filename>nfs://patch_master/Solaris/v11/patches retry 5</filename></programlisting>
</example><example id="egkav"><title>Adding a Patch by Using NFS</title><para>In this example, the <literal>patch</literal> profile keyword adds the
patches 112467&ndash;01 and 112765&ndash;02 from the patch directory <filename>/Solaris/v11/patches</filename> on the server <literal>patch_master</literal>.</para><programlisting>patch 112467-01,112765-02 nfs patch_master:<filename>/Solaris/v11/patches</filename></programlisting>
</example>
</sect4><sect4 id="egkbs"><title>Patches Stored on an HTTP Server</title><para>If the patch is stored on an HTTP server, use one of the following syntaxes
for the <literal>patch</literal> keyword.</para><screen width="100">patch  <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> http://<replaceable>server_name [:port]</replaceable> <replaceable>patch_directory</replaceable> <replaceable>optional_http_keywords</replaceable></screen><screen width="100">patch  <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> http <replaceable>server_name [:port]</replaceable> <replaceable>patch_directory</replaceable> <replaceable>optional_http_keywords</replaceable></screen><variablelist><varlistentry><term><replaceable>patch_id_list</replaceable></term><listitem><para>Specifies the patch ID numbers that are to be installed. The
list should be a list of comma-separated Solaris patch IDs. The patches are
installed in the order specified in the list. Do not add a space after the
comma, for example: 112467-01,112765-02.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_file</replaceable></term><listitem><para>A file with a list of patches that is found in the <replaceable>patch_location</replaceable>. The patches are installed in the order specified in the file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>server_name</replaceable></term><listitem><para>Specifies the name of the server where you stored the patch. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>port</replaceable></term><listitem><para>Specifies an optional port.  <replaceable>port</replaceable> can
be a port number or the name of a TCP service that has a port number that
is determined at runtime.</para><para>If you do not specify a port, the default HTTP port number 80 is used.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_directory</replaceable></term><listitem><para>Specifies the location of the patch directory to be retrieved
from the specified server. When using an HTTP server, the patch must be in
JAR format. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>optional_keywords</replaceable></term><listitem><para>Specifies the optional keywords to use when you retrieve a
patch from an HTTP server.</para>
</listitem>
</varlistentry>
</variablelist><table frame="topbot" pgwide="1" id="egkbz"><title>Optional <literal>patch</literal> Keywords
to Use With HTTP</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="colspec2" colwidth="29.69*"/><colspec colname="colspec3" colwidth="70.31*"/><thead><row rowsep="1"><entry><para>Keyword</para>
</entry><entry><para>Value Definition</para>
</entry>
</row>
</thead><tbody><row><entry colname="colspec2"><para><literal>timeout</literal> <replaceable>min</replaceable></para>
</entry><entry colname="colspec3"><para>The <literal>timeout</literal> keyword enables you to specify, in minutes,
the maximum length of time that is allowed to pass without receipt of data
from the HTTP server. If a timeout occurs, the connection is closed, reopened,
and resumed. If you specify a <literal>timeout</literal> value of 0 (zero),
the connection is not reopened.</para><para>If a timeout reconnection occurs, the package is retried from the beginning
of the package and the data that was retrieved prior to the timeout is discarded.</para>
</entry>
</row><row><entry colname="colspec2"><para><literal>proxy</literal> <replaceable>host:port</replaceable></para>
</entry><entry colname="colspec3"><para>The <literal>proxy</literal> keyword enables you to specify a proxy
host and proxy port.  You can use a proxy host to retrieve a Solaris package
from the other side of a firewall.  You must supply a proxy port when you
specify the <literal>proxy</literal> keyword.</para>
</entry>
</row>
</tbody>
</tgroup>
</table><example id="egkcz"><title>Adding a Patch With an Ordered List by Using HTTP</title><para>In this example, the <literal>patch</literal> profile keyword adds all
the patches listed in the <filename>patch_file</filename> file from the HTTP
location <filename>http://patch.central/Solaris/v11/patches</filename>. The patches are installed in the order specified in the file
the <filename>patch</filename> file. If five minutes pass and no data is received,
the patch data is retrieved again. Previous patch data is discarded.</para><programlisting>patch patch_file http://patch.central<filename>/Solaris/v11/patches timeout 5</filename></programlisting>
</example><example id="egkcv"><title>Adding a Patch by Using HTTP</title><para>In this example, the <literal>patch</literal> profile keyword entry
adds the patches 112467&ndash;01 and 112765&ndash;02 from the patch location <filename>http://patch_master/Solaris/v11/patches</filename>.</para><programlisting>patch 112467-01,112765-02 http://patch.central<filename>/Solaris/v11/patches</filename></programlisting>
</example>
</sect4><sect4 id="egkaz"><title>Patches Stored on a Local Device</title><para>You can retrieve a Solaris package from a local device if you stored
the package on a file system-oriented, random-access device, such as a diskette
or a DVD-ROM. Use the following syntax for the <literal>patch</literal> keyword.</para><screen>patch <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> local_device \
<replaceable>device</replaceable> <replaceable>path</replaceable> <replaceable>file_system_type</replaceable></screen><variablelist><varlistentry><term><replaceable>patch_id_list</replaceable></term><listitem><para>Specifies the patch ID numbers that are to be installed. The
list should be a list of comma-separated Solaris patch IDs. The patches are
installed in the order specified in the list. Do not add a space after the
comma, for example: 112467-01,112765-02.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_file</replaceable></term><listitem><para>A file with a list of patches that is found in the <replaceable>patch_location</replaceable>. The patches are installed in the order specified in the file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>device</replaceable></term><listitem><para>Specifies the name of the drive where the Solaris package
resides. If the device name is a canonical path, the device is mounted directly.
  If you supply a device name that is not a canonical path, the installation
utility adds <filename>/dev/dsk/</filename> to the path.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>path</replaceable></term><listitem><para>Specifies the path to the Solaris patch, relative to the root
(<filename>/</filename>) file system on the device you specified. </para>
</listitem>
</varlistentry><varlistentry><term><replaceable>file_system_type</replaceable></term><listitem><para>Specifies the type of file system on the device.  If you do
not supply a file system type, the installation utility attempts to mount
a UFS file system.  If the UFS mount fails, the installation utility attempts
to mount an HSFS file system. </para>
</listitem>
</varlistentry>
</variablelist><example id="egkcg"><title>Adding a Patch With an Ordered List by Using a
Local Device</title><para>In this example, the <literal>patch</literal> profile keyword adds all
the patches listed in the <filename>patch_file</filename> file from the directory <filename>/Solaris_11/patches</filename> from the local device
c0t6d0s0. The <filename>patch</filename> file determines the order of patches
to be installed. </para><programlisting>patch patch_file c0t6d0s0 <filename>/Solaris_11/patches</filename></programlisting>
</example><example id="egkdl"><title>Adding a Patch by Using a Local Device</title><para>In this example, the <literal>patch</literal> profile keyword adds the
patches 112467&ndash;01 and 112765&ndash;02 from the patch directory <filename>/Solaris_11/patches</filename> from local device c0t6d0s0. </para><programlisting>patch 112467-01,112765-02 local_device c0t6d0s0 <filename>/Solaris_11/patches</filename></programlisting>
</example>
</sect4><sect4 id="egkdb"><title>Patches Stored on a Local File</title><para>A patch can be installed from the miniroot from which you booted the
system. When you perform a custom JumpStart installation, you boot the system
from a DVD, CD, or an NFS-based miniroot.  The installation software is loaded
and run from this miniroot.  Therefore, a patch that you stored in the DVD,
CD, or NFS-based miniroot is accessible as a local file. Use the following
syntax for the <literal>patch</literal> keyword.</para><programlisting>patch <replaceable>patch_id_list</replaceable> | <replaceable>patch_file</replaceable> local_file <replaceable>patch _directory</replaceable> </programlisting><variablelist><varlistentry><term><replaceable>patch_id_list</replaceable></term><listitem><para>Specifies the patch ID numbers that are to be installed. The
list should be a list of comma-separated Solaris patch IDs. The patches are
installed in the order specified in the list. Do not add a space after the
comma, for example: 112467-01,112765-02.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_file</replaceable></term><listitem><para>A file with a list of patches that is found in the <replaceable>patch_location</replaceable>. The patches are installed in the order specified in the file.</para>
</listitem>
</varlistentry><varlistentry><term><replaceable>patch_directory</replaceable></term><listitem><para>Specifies the location of the patch directory. The patch directory
must be accessible to the system as a local file while the system is booted
from the Solaris Software - 1 CD or from the Solaris Operating System DVD. The system cannot
access <filename>/net</filename> when it is booted from the Solaris Software - 1 CD
or from the Solaris Operating System DVD.</para>
</listitem>
</varlistentry>
</variablelist><example id="egkcy"><title>Adding a Patch With an Ordered List by Using a
Local File</title><para>In this example, the <literal>patch</literal> profile keyword adds all
the patches that are listed in the <filename>patch_file</filename> file from
the <filename>/Solaris_11/patches</filename> directory.
The <filename>patch</filename> file determines the order of patches to be
installed. </para><programlisting>patch patch_cal_file <filename>/Solaris_11/patches</filename></programlisting>
</example><example id="egkbt"><title>Adding a Patch by Using a Local File</title><para>In this example, the <literal>patch</literal> profile keyword adds the
patches 112467&ndash;01 and 112765&ndash;02 from the patch directory <filename>/Solaris_11/patches</filename>. </para><programlisting>patch 112467-01,112765-02 local_file <filename>/Solaris_11/patches</filename></programlisting>
</example>
</sect4><sect4 id="egkbv"><title>Limitations When Using the <literal>patch</literal> Keyword</title><para>Note the following limitations when using the <literal>patch</literal> keyword:</para><itemizedlist><listitem><para>Patches cannot be retrieved from FTP locations or local backup,
such as tape.</para>
</listitem><listitem><para>Signed patches cannot be added.</para>
</listitem><listitem><para>Patches must be installable with the <command>patchadd</command> command.</para>
</listitem><listitem><para>If a patch depends on a patch that is not currently installed,
the patch is not installed. An error message is logged into the installation
or upgrade log file.</para>
</listitem><listitem><para>You must determine the correct order of the patches for a
correct installation of the patches.</para>
</listitem>
</itemizedlist>
</sect4>
</sect3><sect3 id="preparecustom-101"><title><literal>root_device</literal> Profile
Keyword</title><programlisting role="complete">root_device <replaceable>slice</replaceable></programlisting><para><literal>root_device</literal> designates the system's root disk. <olink targetptr="preparecustom-25766" remap="internal">How the System's Root Disk Is Determined</olink> contains
additional information.</para><note><para>The root disk is determined by the JumpStart program and determines
where the OS is to be installed. The rules file uses a probe keyword "<literal>rootdisk</literal>," but this keyword is used differently than the "rootdisk" keyword
used in the JumpStart profile. You cannot set the place of installation by
using the probe keyword &ldquo;<literal>rootdisk</literal>&rdquo; in the rules
file. The probe keyword, <literal>rootdisk</literal>, determines where to
boot from during the installation. See <olink targetptr="jumpstartreference-tbl-7" remap="internal">Table 8&ndash;10</olink>.</para>
</note><para>When you are upgrading a system, <literal>root_device</literal> designates
the root (<filename>/</filename>) file system and the file systems that are
mounted by its <filename>/etc/vfstab</filename> file to be upgraded. You must
specify <literal>root_device</literal> if more than one root (<filename>/</filename>)
file system can be upgraded on a system. You must specify <replaceable>slice</replaceable> in
the form <literal>c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable>.</para><para>When you use the <literal>root_device</literal> keyword, consider the
following:</para><itemizedlist><listitem><para>If you specify <literal>root_device</literal> on a system
with only one disk, the <literal>root_device</literal> and the disk must match.
Also, any <literal>filesys</literal> keywords that specify the root (<filename>/</filename>)
file system must match <literal>root_device</literal>.</para>
</listitem><listitem><para>If you are upgrading a RAID-1 volume (mirror), the value that
is specified for <literal>root_device</literal> should be one side of the
mirror. The other side of the mirror is automatically upgraded. </para>
</listitem>
</itemizedlist><example id="fxjxn"><title><literal>root_device</literal> Profile Keyword</title><programlisting>root_device c0t0d0s2</programlisting>
</example><sect4 id="preparecustom-25766"><title>How the System's Root Disk Is Determined</title><para>A system's
root disk is the disk on the system that contains the root (<filename>/</filename>)
file system. In a profile, you can use the <literal>rootdisk</literal> variable
in place of a disk name, which the JumpStart program sets to the system's
root disk. <olink targetptr="preparecustom-28241" remap="internal">Table 8&ndash;8</olink> describes
how the JumpStart program determines the system's root disk for the installation.
         </para><note><para>The JumpStart program only determines a system's root disk size
during an initial installation. You cannot change a system's root disk during
an upgrade.</para>
</note><table frame="topbot" id="preparecustom-28241"><title>How JumpStart Determines
a System's Root Disk (Initial Installation)</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="column1" colwidth="38*"/><colspec colname="column3" colwidth="358*"/><thead><row rowsep="1"><entry><para>Stage</para>
</entry><entry><para>Action</para>
</entry>
</row>
</thead><tbody><row><entry><para>1</para>
</entry><entry><para>If the <literal>root_device</literal> keyword is specified in the profile,
the JumpStart program sets <literal>rootdisk</literal> to the root device. </para>
</entry>
</row><row><entry><para>2</para>
</entry><entry><para>If <literal>rootdisk</literal> is not set and the <literal>boot_device</literal> keyword
is specified in the profile, the JumpStart program sets <literal>rootdisk</literal> to
the boot device.</para>
</entry>
</row><row><entry><para>3</para>
</entry><entry><para>If <literal>rootdisk</literal> is not set and a <literal>filesys c</literal><replaceable>w</replaceable><literal>t</literal><replaceable>x</replaceable><literal>d</literal><replaceable>y</replaceable><literal>s</literal><replaceable>z</replaceable><literal></literal> <replaceable>size</replaceable> <literal>/</literal> entry is specified in the profile,
the JumpStart program sets <literal>rootdisk</literal> to the disk that is
specified in the entry.</para>
</entry>
</row><row><entry><para>4</para>
</entry><entry><para>If <literal>rootdisk</literal> is not set and a <literal>rootdisk.s</literal><replaceable>n</replaceable><literal></literal> entry is specified in the profile, the
JumpStart program searches the system's disks in kernel probe order for an
existing root file system on the specified slice. If a disk is found, the
JumpStart program sets <literal>rootdisk</literal> to the found disk.</para>
</entry>
</row><row><entry><para>5</para>
</entry><entry><para>If <literal>rootdisk</literal> is not set and <literal>partitioning
existing</literal> is specified in the profile, the JumpStart program searches
the system's disks in kernel probe order for an existing root file system.
If a root file system is not found or more than one is found, an error occurs.
If a root file system is found, the JumpStart program sets <literal>rootdisk</literal> to
the found disk.</para>
</entry>
</row><row><entry><para>6</para>
</entry><entry><para>If <literal>rootdisk</literal> is not set, the JumpStart program sets <literal>rootdisk</literal> to the disk where the root (<filename>/</filename>) file
system is installed.</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect4>
</sect3><sect3 id="preparecustom-102"><title><literal>system_type</literal> Profile
Keyword</title><programlisting role="complete">system_type <replaceable>type_switch</replaceable></programlisting><para><literal>system_type</literal> defines the type of system on which
the Solaris OS is to be installed. </para><para><replaceable>type_switch</replaceable> represents the option <literal>standalone</literal> or <literal>server</literal>, which you use to indicate the type
of system on which the Solaris software is to be installed. If you do not
specify <literal>system_type</literal> in a profile, <literal>standalone</literal> is
used by default.</para>
</sect3><sect3 id="preparecustom-103"><title><literal>usedisk</literal> Profile Keyword</title><programlisting role="complete">usedisk <replaceable>disk_name</replaceable> ...</programlisting><para>By default, the JumpStart program uses all of the operational disks
on the system when you specify <literal>partitioning default</literal>. The <literal>usedisk</literal> profile keyword designates one or more disks that you want
the JumpStart program to use. You must specify <replaceable>disk_name</replaceable> in
the form <literal>c</literal><replaceable>x</replaceable><literal>t</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable> or <literal>c</literal><replaceable>y</replaceable><literal>d</literal><replaceable>z</replaceable>, for example, <literal>c0t0d0</literal> or <literal>c0d0s0</literal>. </para><para>If you specify <literal>usedisk</literal> in a profile, the JumpStart
program uses only the disks that you specify after the <literal>usedisk</literal> keyword.
        </para><note><para>You cannot specify the <literal>usedisk</literal> keyword and
the <literal>dontuse</literal> keyword in the same profile.</para>
</note>
</sect3>
</sect2>
</sect1><sect1 id="jumpstartreference-4"><title>Custom JumpStart Environment Variables</title><para>You can use environment variables in your begin and finish scripts.
For example, a begin script might extract the disk size, <envar>SI_DISKSIZES</envar>,
and install or not install particular packages on a system, based on the actual
disk size the script extracts.</para><para>Information that is gathered about a system is stored in these environment
variables, which are generally set or not, depending on the rule keywords
and values you use in the <filename>rules</filename> file.</para><para>For example, information about which operating system is already installed
on a system is only available in <envar>SI_INSTALLED</envar> after the <literal>installed</literal> keyword is used.</para><para><olink targetptr="jumpstartreference-tbl-5" remap="internal">Table 8&ndash;9</olink> describes
these variables and their values.</para><table frame="topbot" pgwide="1" id="jumpstartreference-tbl-5"><title>Installation
Environment Variables</title><tgroup cols="2" colsep="0" rowsep="0"><colspec colname="column1" colwidth="116.00*"/><colspec colname="column2" colwidth="280.00*"/><thead><row rowsep="1"><entry><para>Environment Variable</para>
</entry><entry><para>Value</para>
</entry>
</row>
</thead><tbody><row><entry><para><envar>SI_ARCH</envar></para>
</entry><entry><para>The hardware architecture of the install client. The <envar>SI_ARCH</envar> variable
is set when the <literal>arch</literal> keyword is used in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_BEGIN</envar></para>
</entry><entry><para>The name of the begin script, if one is used.</para>
</entry>
</row><row><entry><para><envar>SI_CLASS</envar></para>
</entry><entry><para>The name of the profile that is used to install the install client.</para>
</entry>
</row><row><entry><para><envar>SI_DISKLIST</envar></para>
</entry><entry><para>A comma-separated list of disk names on the install client. The <envar>SI_DISKLIST</envar> variable is set when the <filename>disksize</filename> keyword is
used and matched in the <filename>rules</filename> file. The <envar>SI_DISKLIST</envar> and <envar>SI_NUMDISKS</envar> variables are used to determine the physical disk to use
for the <literal>rootdisk</literal>. <literal>rootdisk</literal> is described
in <olink targetptr="preparecustom-25766" remap="internal">How the System's Root Disk Is Determined</olink>.</para>
</entry>
</row><row><entry><para><envar>SI_DISKSIZES</envar></para>
</entry><entry><para>A comma-separated list of disk sizes on the install client. The <envar>SI_DISKSIZES</envar> variable is set when the <literal>disksize</literal> keyword is used
and matched in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_DOMAINNAME</envar></para>
</entry><entry><para>The domain name. The <envar>SI_DOMAINNAME</envar> variable is set when
the <literal>dommainname</literal> keyword is used and matched in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_FINISH</envar></para>
</entry><entry><para>The name of the finish script, if one is used.</para>
</entry>
</row><row><entry><para><envar>SI_HOSTADDRESS</envar></para>
</entry><entry><para>The install client's IP address.</para>
</entry>
</row><row><entry><para><envar>SI_HOSTNAME</envar></para>
</entry><entry><para>The install client's host name. The <envar>SI_HOSTNAME</envar> variable
is set when the <literal>hostname</literal> keyword is used and matched in
the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_INSTALLED</envar></para>
</entry><entry><para>The device name of a disk with a specific operating system on the disk,
for example, Solaris, SunOS, or System V. The <envar>SI_INSTALLED</envar> variable
is set when the <literal>installed</literal> keyword is used and matched in
the <filename>rules</filename> file. <envar>SI_INST_OS</envar> and <envar>SI_INST_VER</envar> are used to determine the value of <envar>SI_INSTALLED</envar>.</para>
</entry>
</row><row><entry><para><envar>SI_INST_OS</envar></para>
</entry><entry><para>The name of the operating system. <envar>SI_INST_OS</envar> and <envar>SI_INST_VER</envar> are used to determine the value of <envar>SI_INSTALLED</envar>.</para>
</entry>
</row><row><entry><para><envar>SI_INST_VER</envar></para>
</entry><entry><para>The version of the operating system. <envar>SI_INST_OS</envar> and <envar>SI_INST_VER</envar> are used to determine the value of <envar>SI_INSTALLED</envar>.</para>
</entry>
</row><row><entry><para><envar>SI_KARCH</envar></para>
</entry><entry><para>The install client's kernel architecture. The <envar>SI_KARCH</envar> variable
is set when the <literal>karch</literal> keyword is used and matched in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_MEMSIZE</envar></para>
</entry><entry><para>The amount of physical memory on the install client. The <envar>SI_MEMSIZE</envar> variable
is set when the <literal>memsize</literal> keyword is used and matched in
the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_MODEL</envar></para>
</entry><entry><para>The install client's model name. The <envar>SI_MODEL</envar> variable
is set when the <literal>model</literal> keyword is used and matched in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_NETWORK</envar></para>
</entry><entry><para>The install client's network number. The <envar>SI_NETWORK</envar> variable
is set when the <literal>network</literal> keyword is used and matched in
the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_NUMDISKS</envar></para>
</entry><entry><para>The number of disks on an install client. The <envar>SI_NUMDISKS</envar> variable
is set when the <literal>disksize</literal> keyword is used and matched in
the <filename>rules</filename> file. The <envar>SI_NUMDISKS</envar> and <envar>SI_DISKLIST</envar> variables are used to determine the physical disk to use for the <literal>rootdisk</literal>. <literal>rootdisk</literal> is described in <olink targetptr="preparecustom-25766" remap="internal">How the System's Root Disk Is Determined</olink>.</para>
</entry>
</row><row><entry><para><envar>SI_OSNAME</envar></para>
</entry><entry><para>The operating system release on the Solaris software image. For example,
you can use the <envar>SI_OSNAME</envar> variable in a script if you are installing
the Solaris software on systems that are based on the version of the operating
system on the Solaris Operating System DVD or the Solaris Software - 1 CD image.</para>
</entry>
</row><row><entry><para><envar>SI_ROOTDISK</envar></para>
</entry><entry><para>The device name of the disk that is represented by the logical name <literal>rootdisk</literal>. The <envar>SI_ROOTDISK</envar> variable is set when the <literal>disksize</literal> or the <literal>installed</literal> keyword is set to <literal>rootdisk</literal> in the <filename>rules</filename> file.  The <literal>SI_ROOTDISK</literal> variable sets  the device to boot from during the installation. </para><note><para>You cannot set the place of installation by using the probe keyword &ldquo;<literal>rootdisk</literal>&rdquo; in the rules file. For information on the "<literal>rootdisk</literal>" variable that is set in a JumpStart profile, see <olink targetptr="preparecustom-25766" remap="internal">How the System's Root Disk Is Determined</olink>.</para>
</note>
</entry>
</row><row><entry><para><envar>SI_ROOTDISKSIZE</envar></para>
</entry><entry><para>The size of the disk that is represented by the logical name <literal>rootdisk</literal>. The <envar>SI_ROOTDISKSIZE</envar> variable is set when the <literal>disksize</literal> or the <literal>installed</literal> keyword is set to <literal>rootdisk</literal> in the <filename>rules</filename> file.</para>
</entry>
</row><row><entry><para><envar>SI_TOTALDISK</envar></para>
</entry><entry><para>The total amount of disk space on the install client. The <envar>SI_TOTALDISK</envar> variable is set when the <literal>totaldisk</literal> keyword is
used and matched in the <filename>rules</filename> file.</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1><sect1 id="jumpstartreference-6"><title>Probe Keywords and Values</title><para><olink targetptr="jumpstartreference-tbl-7" remap="internal">Table 8&ndash;10</olink> describes
each rule keyword and its equivalent probe keyword.</para><note><para>Always place probe keywords at or near the beginning of the <filename>rules</filename> file.</para>
</note><table frame="topbot" pgwide="1" id="jumpstartreference-tbl-7"><title>Descriptions
of Probe Keywords</title><tgroup cols="3" colsep="0" rowsep="0"><colspec colname="column1" colwidth="61*"/><colspec colname="column2" colwidth="61*"/><colspec colname="column3" colwidth="274*"/><thead><row rowsep="1"><entry><para>Rule Keyword</para>
</entry><entry><para>Equivalent Probe Keyword</para>
</entry><entry><para>Description of Probe Keyword</para>
</entry>
</row>
</thead><tbody><row><entry><para><literal>any</literal> </para>
</entry><entry><para>None </para>
</entry><entry><para></para>
</entry>
</row><row><entry><para><literal>arch</literal>     </para>
</entry><entry><para><literal>arch</literal> 
   </para>
</entry><entry><para>Determines the kernel architecture, i386 or SPARC, and sets <envar>SI_ARCH</envar>.</para>
</entry>
</row><row><entry><para><literal>disksize</literal>    </para>
</entry><entry><para><literal>disks</literal>    </para>
</entry><entry><para>Returns the size of a system's disks in Mbytes in kernel probe order,
c0t3d0s0, c0t3d0s1, c0t4d0s0. <literal>disksize</literal> sets <envar>SI_DISKLIST</envar>, <envar>SI_DISKSIZES</envar>, <envar>SI_NUMDISKS</envar>, and <envar>SI_TOTALDISK</envar>.</para>
</entry>
</row><row><entry><para><literal>domainname</literal>   </para>
</entry><entry><para><literal>domainname</literal>   </para>
</entry><entry><para>Returns a system's NIS or NIS+ domain name or blank and sets <envar>SI_DOMAINNAME</envar>. The <literal>domainname</literal> keyword returns the output of <olink targetdoc="refman1m" targetptr="domainname-1m" remap="external"><citerefentry><refentrytitle>domainname</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>.</para>
</entry>
</row><row><entry><para><literal>hostaddress</literal>   </para>
</entry><entry><para><literal>hostaddress</literal>   </para>
</entry><entry><para>Returns a system's IP address, the first address that is listed in the
output of <olink targetdoc="refman1m" targetptr="ifconfig-1m" remap="external"><citerefentry><refentrytitle>ifconfig</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink> <command>-a</command> that is not lo0, and sets <envar>SI_HOSTADDRESS</envar>.</para>
</entry>
</row><row><entry><para><literal>hostname</literal>   </para>
</entry><entry><para><literal>hostname</literal>   </para>
</entry><entry><para>Returns a system's host name that is the output from <olink targetdoc="refman1" targetptr="uname-1" remap="external"><citerefentry><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry></olink> <command>-n</command> and
sets <envar>SI_HOSTNAME</envar>.</para>
</entry>
</row><row><entry><para><literal>installed</literal>      </para>
</entry><entry><para><literal>installed</literal>      </para>
</entry><entry><para>Returns the version name of the Solaris OS that is installed on a system
and sets <envar>SI_ROOTDISK</envar> and <envar>SI_INSTALLED</envar>.</para><para>If the JumpStart program finds a Solaris release but is unable to determine
the version, the version that is  returned is <literal>SystemV</literal>.</para>
</entry>
</row><row><entry><para><literal>karch</literal>   </para>
</entry><entry><para><literal>karch</literal>   </para>
</entry><entry><para>Returns a system's platform group, for example i86pc or sun4u, and sets <envar>SI_KARCH</envar>. For a list of platform names, see <citetitle>Solaris Sun
Hardware Platform Guide</citetitle> at <ulink url="http://docs.sun.com" type="url">http://docs.sun.com</ulink>.</para>
</entry>
</row><row><entry><para><literal>memsize</literal>    </para>
</entry><entry><para><literal>memsize</literal>    </para>
</entry><entry><para>Returns the size of physical memory on a system in Mbytes and sets <envar>SI_MEMSIZE</envar>.</para>
</entry>
</row><row><entry><para><literal>model</literal>    </para>
</entry><entry><para><literal>model</literal>    </para>
</entry><entry><para>Returns a system's platform name and sets <envar>SI_MODEL</envar>. 
For a list of platform names, see the <citetitle>Solaris Sun Hardware Platform
Guide</citetitle> at <ulink url="http://docs.sun.com" type="url">http://docs.sun.com</ulink>.</para>
</entry>
</row><row><entry><para><literal>network</literal>   </para>
</entry><entry><para><literal>network</literal>   </para>
</entry><entry><para>Returns a system's network number, which the JumpStart program determines
by performing a logical AND between the system's IP address and the subnet
mask. The system's IP address and the subnet mask are extracted from the first
address that is listed in the output of <olink targetdoc="refman1m" targetptr="ifconfig-1m" remap="external"><citerefentry><refentrytitle>ifconfig</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink> <command>-a</command> that
is not lo0. The <literal>network</literal> keyword sets <envar>SI_NETWORK</envar>.</para>
</entry>
</row><row><entry><para><literal>osname</literal>     </para>
</entry><entry><para><literal>osname</literal>     </para>
</entry><entry><para>Returns the version and operating system name of the Solaris OS that
is found on a CD and sets <envar>SI_OSNAME</envar>.</para><para>If the JumpStart program finds a Solaris release but is unable to determine
the version, the version that is returned is <literal>SystemV</literal>.</para>
</entry>
</row><row><entry><para>&nbsp;</para>
</entry><entry><para><literal>rootdisk</literal> </para>
</entry><entry><para>Returns the name and size  in Mbytes of a system's root disk and sets <envar>SI_ROOTDISK</envar>.</para>
</entry>
</row><row><entry><para><literal>totaldisk</literal> 
  </para>
</entry><entry><para><literal>totaldisk</literal> 
  </para>
</entry><entry><para>Returns the total disk space on a system (in Mbytes) and sets <envar>SI_TOTALDISK</envar>. The total disk space includes all of the operational disks that
are attached to a system.</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
</chapter>