This chapter lists keywords and values that you can use in the rules file, profiles, and begin and finish scripts.
Table 28–1 describes the keywords and values that you can use in the rules file. For detailed instructions to create a rules file, see Creating the rules File.
Table 28–1 Descriptions of Rule Keywords and Values
Keyword |
Value |
Matches |
||
---|---|---|---|---|
minus sign (-) |
Anything. The any keyword always succeeds. |
|||
processor_type Valid values for processor_type are the following:
|
A system's processor type. The uname -p command reports the system's processor type. |
|||
actual_disk_name size_range actual_disk_name – A disk name in the form cxtydz, such as c0t3d0or c0d0, or the special word rootdisk. If rootdisk is used, the disk to be matched is determined in the following order:
size_range – The size of the disk, which must be specified as a range of Mbytes (x-x). |
The name and size of a system's disk in Mbytes.
In the example, the JumpStart program attempts to match a system disk that is named c0t3d0. The disk can hold between 250 and 300 Mbytes of information.
In the example, the JumpStart program first attempts to match a system disk that contains a preinstalled boot image. Next, the JumpStart program attempts to match the c0t3d0s0 disk, if the disk exists. Finally, the JumpStart program attempts to match the first available disk that can hold between 750 Mbytes and 1 Gbyte of information. Note – When calculating size_range, remember that a Mbyte equals 1,048,576 bytes. A disk might be advertised as a “535–Mbyte” disk, but the disk might contain only 510 million bytes of disk space. The JumpStart program views the “535–Mbyte” disk as a 510–Mbyte disk because 535,000,000 / 1,048,576 = 510. A “535–Mbyte” disk does not match a size_range equal to 530–550. |
|||
actual_domain_name |
A system's domain name, which controls how a name service determines information. If you have a system already installed, the domainname command reports the system's domain name. |
|||
actual_IP_address |
A system's IP address. |
|||
actual_host_name |
A system's host name. If you have a system that is already installed, the uname -n command reports the system's host name. |
|||
slice version slice — A disk slice name in the form cwtxdysz, such as c0t3d0s5, or the special words any or rootdisk. If any is used, the JumpStart program attempts to match all of the system's disks in kernel probe order. If rootdisk is used, the disk to be matched is determined in the following order:
version — A version name or the special words any or upgrade. If any is used, any Solaris or SunOS release is matched. If upgrade is used, any Solaris 2.1 or compatible release that can be upgraded is matched. If the JumpStart program finds a Solaris release but is unable to determine the version, the version that is returned is SystemV. |
A disk that has a root (/) file system that corresponds to a particular version of Solaris software.
In the example, the JumpStart program attempts to match a system that has a Solaris 9 root (/) file system on c0t3d0s1. |
|||
actual_platform_group Valid values are sun4m, sun4u, i86pc, prep. A list of systems and their corresponding platform group is presented in the Solaris 9 Sun Hardware Platform Guide. |
A system's platform group. If you have a system that is already installed, the arch -k command or the uname -m command reports the system's platform group. |
|||
physical_mem The value must be a range of Mbytes, x-x, or a single Mbyte value. |
A system's physical memory size in Mbytes.
The example tries to match a system with a physical memory size between 64 and 128 Mbytes. If you have a system that is already installed, the output of the prtconf command, line 2, reports the system's physical memory size. |
|||
actual_platform_name |
A system's platform name. See the Solaris 9 Sun Hardware Platform Guide for a list of valid platform names. To find the platform name of an installed system, use the uname -i command or the output of the prtconf command, line 5. Note – If the actual_platform_name contains spaces, you must replace spaces with underscores (_). Example: SUNW,Sun_4_50 |
|||
network_num |
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 example tries to match a system with a 193.144.2.8 IP address, if the subnet mask is 255.255.255.0. |
|||
Solaris_x |
A version of Solaris software that is already installed on a system.
In the example, the JumpStart program attempts to match a system with the Solaris 9 operating environment already installed. |
|||
probe_keyword |
A valid probe keyword or a valid custom probe keyword.
The example returns the size of a system's disks in Mbytes and in kernel probe order, for example, c0t3d0s1, c0t4d0s0, on a SPARC system. The JumpStart program sets the SI_DISKLIST, SI_DISKSIZES, SI_NUMDISKS, and SI_TOTALDISK environment variables. Note – The probe keyword is unique in that the keyword does not attempt to match an attribute and run a profile. The probe keyword returns a value. Consequently, you cannot specify begin scripts, profiles, and finish scripts with the probe rule keyword. Probe keywords are described in Chapter 25, Creating Custom Rule and Probe Keywords (Tasks). |
|||
size_range The value must be specified as a range of Mbytes (x-x). |
The total disk space on a system in Mbytes. The total disk space includes all the operational disks that are attached to a system.
In the example, the JumpStart program tries to match a system with a total disk space between 300 and 500 Mbytes. Note – When calculating size_range, remember that one Mbyte equals 1,048,576 bytes. A disk might be advertised as a “535–Mbyte” disk, but the disk might have only 510 million bytes of disk space. The JumpStart program views the “535–Mbyte” disk as a 510–Mbyte disk because 535,000,000 / 1,048,576 = 510. A “535–Mbyte” disk does not match a size_range equal to 530–550. |
This section describes the profile keywords and values that you can use in a profile. For detailed instructions to create a profile, see Creating a Profile.
Table 28–2 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.
Table 28–2 Overview of Profile Keywords
Installation Scenarios |
|||||
---|---|---|---|---|---|
Profile Keywords |
Standalone System (Nonnetworked) |
Standalone System (Networked) or Server |
OS Server |
Upgrade |
Upgrade With Disk Space Reallocation |
archive_location (installing Solaris Flash archives) |
√ |
√ | |||
backup_media |
√ |
||||
boot_device |
√ |
√ |
√ | ||
bootenv createbe |
√ |
√ |
√ | ||
client_arch |
√ | ||||
client_root |
√ | ||||
client_swap |
√ | ||||
cluster (adding software groups) |
√ |
√ |
√ | ||
cluster (adding or deleting clusters) |
√ |
√ |
√ |
√ |
√ |
dontuse |
√ |
√ |
√ | ||
fdisk (x86 only) |
√ |
√ |
√ | ||
filesys (mounting remote file systems) |
√ |
√ | |||
filesys (creating local file systems) |
√ |
√ |
√ | ||
forced_deployment (installing Solaris Flash differential archives) |
√ |
√ |
|
|
|
geo |
√ |
√ |
√ |
√ |
√ |
install_type |
√ |
√ |
√ |
√ |
√ |
isa_bits |
√ |
√ |
√ |
√ |
√ |
layout_constraint |
√ |
||||
local_customization (installing Solaris Flash archives) |
√ |
√ |
|
|
|
locale |
√ |
√ |
√ |
√ |
√ |
no_master_check (installing Solaris Flash differential archives) |
√ |
√ |
|
|
|
no_content_check (installing Solaris Flash differential archives) |
√ |
√ |
|
|
|
num_clients |
√ | ||||
package |
√ |
√ |
√ |
√ |
√ |
partitioning |
√ |
√ |
√ |
|
|
root_device |
√ |
√ |
√ |
√ |
√ |
system_type |
√ |
√ |
√ |
|
|
usedisk |
√ |
√ |
√ |
archive_location retrieval_type location |
The values of retrieval_type and location depend on where the Solaris Flash archive is stored. The following sections contain the values you can use for retrieval_type and location and examples of how to use the archive_location keyword.
If the archive is stored on an NFS server, use the following syntax for the archive_location keyword.
archive_location nfs server_name:/path/filename retry n |
The name of the server where you stored the archive.
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.
The name of the Solaris Flash archive file.
An optional keyword. n is the maximum number of times the Solaris Flash utilities attempt to mount the archive.
Examples:
archive_location nfs golden:/archives/usrarchive archive_location nfs://golden/archives/usrarchive
If the archive is stored on an HTTP server, use the following syntax for the archive_location keyword.
archive_location http://server_name:port path/filename optional_keywords |
The name of the server where you stored the archive. server_name can be a port number or the name of a TCP service that has a port number that is determined at runtime.
An optional port. If you do not specify a port, the Solaris Flash installation utilities use the default HTTP port number, 80.
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.
The name of the Solaris Flash archive file.
The optional keywords that you can specify when you retrieve a Solaris Flash archive from an HTTP server.
Keywords |
Value Definitions |
---|---|
auth basic user_name password |
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. Note – 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. |
timeout min |
The timeout 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 before the connection is closed, reopened, and resumed from the point where the timeout occurred. If you specify a timeout value of 0 (zero), the connection is not reopened because of inactivity. If a time-out 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. |
proxy host:port |
The proxy keyword allows 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 proxy keyword. |
Example:
archive_location http://silver/archives/usrarchive.flar timeout 5
Example of the auth basic user_name password keyword:
archive_location http://silver/archives/usrarchive.flar timeout 5 user1 secret
If the archive is stored on an FTP server, use the following syntax for the archive_location keyword.
archive_location ftp://user_name:password@server_name:port path/filename optional_keywords |
The user name and password that you need to access the FTP server in the profile file.
The name of the server where you stored the archive. server_name can be a port number or the name of a TCP service that has a port number that is determined at runtime.
A is an optional port. If you do not specify a port, the Solaris Flash installation utilities use the default FTP port number, 21.
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.
The name of the Solaris Flash archive file.
The optional keywords that you can specify when you retrieve a Solaris Flash archive from an FTP server.
Keywords |
Value Definitions |
---|---|
timeout min |
The timeout keyword enables you to specify, in minutes, the maximum length of time that is allowed to pass without receipt of data from the FTP server before the connection is closed, reopened, and resumed from the point where the timeout occurred. If you specify a timeout value of 0 (zero), the connection is not reopened because of inactivity. If a time-out 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. |
proxy host:port |
The proxy keyword allows 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 proxy keyword. |
Example:
archive_location ftp://user1:secret@silver/archives/usrarchive.flar timeout 5
If the archive is stored on a tape, use the following syntax for the archive_location keyword.
archive_location local_tape device position |
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 /dev/rmt/ to the path.
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 position, you can place a begin script or a sysidcfg file on the tape drive before the archive.
Examples:
archive_location local_tape /dev/rmt/0n 5 archive_location local_tape 0n 5
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 CD-ROM. Use the following syntax for the archive_location keyword.
You can retrieve an archive from stream-oriented devices, such as tape, by using the syntax for local tape.
archive_location local_device device path/filename file_system_type |
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 /dev/dsk/ to the path.
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.
The name of the Solaris Flash archive file.
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.
Examples:
To retrieve an archive from a local hard drive that is formatted as a UFS file system, use the following command:
archive_location local_device c0t0d0s0 /archives/$HOST
To retrieve an archive from a local CD-ROM that has an HSFS file system, use the following command:
archive_location local_device c0t0d0s0 /archives/usrarchive
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 CD-ROM 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 CD-ROM or NFS-based miniroot is accessible as a local file. Use the following syntax for the archive_location keyword.
archive_location local_file path/filename |
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 9 Installation CD or from the Solaris 9 DVD. The system cannot access /net when it is booted from the Solaris 9 Installation CD or from the Solaris 9 DVD.
The name of the Solaris Flash archive file.
Examples:
archive_location local_file /archives/usrarchive archive_location local_file /archives/usrarchive
backup_media type path |
You can use backup_media only with the upgrade option when disk space reallocation is required.
backup_media 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.
Valid type Values |
Valid path Values |
Specification |
---|---|---|
local_tape |
/dev/rmt/n |
A local tape drive on the system that is being upgraded. path must be the character (raw) device path for the tape drive. n is the number of the tape drive. |
local_diskette |
/dev/rdisketten |
A local diskette drive on the system that is being upgraded. path must be the character (raw) device path for the diskette drive. n is the number of the diskette drive. Diskettes that you use for the backup must be formatted. |
local_filesystem |
/dev/dsk/cwtxdysz /file_system |
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. path can be a block device path for a disk slice. For example, the tx in /dev/dsk/cwtxdysz might not be needed. Or, path can be the absolute path to a file system that is mounted by the /etc/vfstab file. |
remote_filesystem |
host:/file_system |
An NFS file system on a remote system. path must include the name or IP address of the remote system, host, and the absolute path to the NFS file system, file_system. The NFS file system must have read/write access. |
remote_system | user@host:/directory |
A directory on a remote system that can be reached by a remote shell, rsh. The system that is being upgraded must have access to the remote system through the remote system's .rhosts file. path must include the name of the remote system host and the absolute path to the directory directory. If a user login ID user is not specified, root is used by default. |
Examples:
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
boot_device device eeprom |
boot_device designates the device where the JumpStart program is to install the root (/) file system and the system's boot device.
If you do not specify the boot_device keyword in a profile, the following boot_device keyword is specified by default during the installation: boot_device any update.
device – Use one of the following values.
SPARC: cwtxdysz or cxdysz – The disk slice where the JumpStart program places the root (/) file system, for example, c0t0d0s0.
x86: cwtxdy or cxdy – The disk where the JumpStart program places the root (/) file system, for example, c0d0.
existing – The JumpStart program places the root (/) file system on the system's existing boot device.
any – The JumpStart program chooses where to place the root (/) 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.
eeprom – Choose to update or preserve the system's EEPROM.
SPARC: Choose if you want to update or preserve the system's EEPROM to the specified boot device.
x86: You must specify the preserve value.
update – The JumpStart program updates the system's EEPROM to the specified boot device so that the installed system automatically boots from it.
preserve – 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.
SPARC: On SPARC systems, the eeprom value also allows 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.
Example:
boot_device c0t0d0s2 update
boot_device must match any filesys keywords that specify the root (/) file system and the root_device keyword, if specified.
bootenv createbe bename new_BE_name filesystem mountpoint:device:fs_options [filesystem...] |
bootenv createbe enables you to create an empty-and-inactive boot environment at the same time you are installing the operating environment. At the least, you must create the root (/) file system. Although you are creating file systems, they remain empty. This inactive boot environment can later be populated with a Solaris Flash archive. After the boot environment is installed with the archive, it can be activated to become the current operating environment. The following lists the values for bename and filesystem.
bename specifies the name of the new boot environment to be created. new_BE_name 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.
filesystem 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 (/) file system must be defined. File systems can be on the same disk or spread across multiple disks.
mountpoint can be any valid mount point or – (hyphen), indicating a swap slice.
device must be available when the operating environment that is being installed is first booted. The device has no relation to JumpStart special storage devices such as free. The device cannot be a Solaris Volume Manager volume or Veritas Volume Manager volume. device is the name of a disk device, of the form /dev/dsk/cwtxdysz.
fs_options can be one of the following:
ufs, which indicates a UFS file system.
swap, which indicates a swap file system. The swap mount point must be a – (hyphen).
For a profile example and background about using this keyword, see the following references:
For an example of a profile, see Example 23–8.
For background about using Solaris Live Upgrade that creates, upgrades, and activates inactive boot environments, see Chapter 29, Solaris Live Upgrade (Topics).
For background about using a Solaris Flash archive, see Chapter 16, Solaris Flash Installation Feature (Topics).
client_arch karch_value ... |
client_arch specifies that the operating system server is to support a different platform group than the server uses. If you do not specify client_arch 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.
Valid values for karch_value are sun4m, sun4u, and i86pc. For a detailed list of platform names and various systems, see Solaris 9 Sun Hardware Guide.
You can use client_arch only when system_type is specified as server.
client_root root_size |
client_root defines the amount of root space, root_size in Mbytes, to allocate for each client. If you do not specify client_root 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 num_clients keyword to determine how much space to reserve for the /export/root file system.
You can use client_root only when system_type is specified as server.
client_swap swap_size |
client_swap defines the amount of swap space, swap_size in Mbytes, to allocate for each diskless client. If you do not specify client_swap in the profile, 32 Mbytes of swap space is allocated by default.
Example:
client_swap 64
The example specifies that each diskless client is to have a swap space of 64 Mbytes.
You can use client_swap only when system_type is specified as server.
If a profile does not specify the size of swap, the JumpStart program determines the size of the swap space, based on the system's physical memory. Table 28–5 shows how the size of swap is determined during a custom JumpStart installation.
Table 28–5 Determining swap Size
Physical Memory (in Mbytes) |
Swap Space (in Mbytes) |
---|---|
16–64 |
32 |
64–128 |
64 |
128–512 |
128 |
Greater than 512 |
256 |
The JumpStart program makes the size of swap no more than 20 percent of the disk where swap is located, unless the disk contains free space after laying out the other file systems. If free space exists, the JumpStart program allocates the free space to swap, and if possible, allocates the amount that is shown in Table 28–5.
Physical memory plus swap space must total a minimum of 32 Mbytes.
cluster group_name |
cluster designates the software group to add to the system. The group_name for each software group is listed in the following table.
Software Group | group_name |
---|---|
Core System Support Software Group | SUNWCreq |
End User Solaris Software Group | SUNWCuser |
Developer Solaris Software Group | SUNWCprog |
Entire Solaris Software Group | SUNWCall |
Entire Solaris Software Group Plus OEM Support | SUNWCXall |
You can specify only one software group in a profile. The software group must be specified before other cluster and package entries. If you do not specify a software group with cluster in the profile, the end–user software group, SUNWCuser, is installed on the system.
cluster cluster_name add_delete_switch |
cluster (adding or deleting clusters) can be used with both the initial installation and upgrade options.
cluster designates whether a cluster is to be added or deleted from the software group that is to be installed on the system.
cluster_name must be in the form SUNWCname. To view detailed information about clusters and their names, start Admintool on an installed system and choose Software from the Browse menu.
add_delete_switch represents the option add or delete. Use add_delete_switch to indicate whether to add or delete the cluster that is specified. If you do not specify add_delete_switch, add is used by default.
When you use cluster (adding or deleting clusters) during an upgrade, the following conditions apply:
All clusters that are already on the system are automatically upgraded.
If you specify cluster_name add, and cluster_name is not installed on the system, the cluster is installed.
If you specify cluster_name delete, and cluster_name is installed on the system, the package is deleted before the upgrade begins.
dontuse disk_name ... |
By default, the JumpStart program uses all of the operational disks on the system when partitioning default is specified. dontuse designates one or more disks that you do not want the JumpStart program to use. disk_name must be specified in the form cxtydzor cydz, for example, c0t0d0.
You cannot specify the dontuse keyword and the usedisk keyword in the same profile.
fdisk disk_name type size |
fdisk defines how the fdisk partitions are set up on an x86 based system. You can specify fdisk more than once. When fdisk partitions an x86 based system, the following occurs:
All fdisk partitions on the disk are preserved unless you delete the partitions with the fdisk keyword by assigning size the value of delete or 0. Also, all existing fdisk partitions are deleted when size is set to all.
A Solaris fdisk partition that contains a root (/) file system is always designated as the active partition on the disk.
The system boots from the active partition by default.
If the fdisk keyword is not specified in a profile, the following fdisk keyword is used by default during the installation.
fdisk all solaris maxfree
fdisk entries are processed in the order in which the entries are listed in the profile.
disk_name – Use the following values to specify where the fdisk partition is to be created or deleted:
cxtydz or cydz – A specific disk, for example, c0t3d0.
rootdisk – The variable that contains the value of the system's root disk, which is determined by the JumpStart program as described in How the System's Root Disk Is Determined.
all – All the selected disks.
type – Use the following values to specify the type of fdisk partition that is to be created or deleted on the specified disk:
solaris – A Solaris fdisk partition (SUNIXOS fdisk type).
dosprimary – An alias for primary DOS fdisk partitions, not for fdiskpartitions that are extended or reserved for data DOS. When you delete fdisk partitions by assigning size the value delete, dosprimary is an alias for the DOSHUGE, DOSOS12, and DOSOS16 fdisk types. When you create an fdisk partition, dosprimary is an alias for the DOSHUGE fdisk partition.
DDD – An integer fdisk partition. DDD is an integer between 1 and 255 inclusive.
You can specify this value only if size is delete.
0xHH – A hexadecimal fdisk partition. HH is a hexadecimal number between 01 and FF.
You can specify this value only if size is delete.
The following table shows the integer and hexadecimal numbers for some of the fdisk types.
fdisk Type |
DDD |
HH |
---|---|---|
DOSOS12 |
1 |
01 |
PCIXOS |
2 |
02 |
DOSOS16 |
4 |
04 |
EXTDOS |
5 |
05 |
DOSHUGE |
6 |
06 |
DOSDATA |
86 |
56 |
OTHEROS |
98 |
62 |
UNIXOS |
99 |
63 |
size – Use one of the following values:
DDD – An fdisk partition of size DDD in Mbytes is created on the specified disk. DDD must be an integer, and the JumpStart program automatically rounds the number up to the nearest cylinder boundary. Specifying a value of 0 is the same as specifying delete.
all – An fdisk partition is created on the entire disk. All existing fdisk partitions are deleted.
The all value can be specified only if type is solaris.
maxfree – An fdisk partition is created in the largest contiguous free space on the specified disk. If an fdisk partition of the specified type already exists on the disk, the existing fdisk partition is used. A new fdisk partition is not created on the disk.
The disk must contain at least one unused fdisk partition. Also, the disk must have free space or installation fails. The maxfree value can be specified only if type is solaris or dosprimary.
delete – All fdisk partitions of the specified type are deleted on the specified disk.
filesys server:path server_address mount_pt_name [[mount_options]] |
By using filesys 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 filesys more than once.
Example:
filesys sherlock:/export/home/user2 - /home
server: – The name of the server where the remote file system is located, followed by a colon.
path – The remote file system's mount–point name. For example, /usr or /export/home.
server_address – The IP address of the server that is specified in server:path. If a name service is not running on the network, the server_address value can be used to populate the /etc/hosts 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 (-). For example, if you have a name service that is running on the network, you do not need to specify the server's IP address.
mount_pt_name – The name of the mount point on which the remote file system is to be mounted.
mount_options – One or more mount options, which is the same as the -o option of the mount(1M) command. The mount options are added to the /etc/vfstab entry for the specified mount_pt_name.
If you need to specify more than one mount option, the mount options must be separated by commas and no spaces (ro,quotafor example).
filesys slice size [[file_system optional_parameters]] |
By using filesys with the values that are listed, the JumpStart program creates local file systems during the installation. You can specify filesys more than once.
slice – Use one of the following values:
any – The JumpStart program places the file system on any disk.
You cannot specify any when size is existing, all, free, start:size, or ignore.
cwtxdysz or cxdysz – The disk slice where the JumpStart program places the file system, for example, c0t0d0s0 or c0d0s0.
rootdisk.sn – The variable that contains the value for the system's root disk, which is determined by the JumpStart program as described in How the System's Root Disk Is Determined. The sn suffix indicates a specific slice on the disk.
size – Use one of the following values:
num – The size of the file system is set to num in Mbytes.
existing – The current size of the existing file system is used.
When you use the existing value, you can change the name of an existing slice by specifying file_system as a different mount_pt_name.
auto – The size of the file system is automatically determined, depending on the software that is selected.
all – The specified slice uses the entire disk for the file system. When you specify the all value, no other file systems can be placed on the specified disk.
free – The remaining unused space on the disk is used for the file system.
If free is used as the value to filesys, the filesys entry must be the last entry in a profile.
start:size – The file system is explicitly partitioned. start is the cylinder where the slice begins. size is the number of cylinders for the slice.
file_system – The file_system value is optional and used when slice is specified as any or cwtxdysz. If file_system is not specified, unnamed is set by default. If unnamed is set, you cannot specify the optional_parameters value. Use one of the following values:
mount_pt_name – The file system's mount–point name, for example, /var.
swap – The specified slice is used as swap.
overlap – The specified slice 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.
You can specify overlap only when size is existing, all, or start:size.
unnamed – The specified slice is defined as a raw slice, so slice does not have a mount–point name. If you do not specify file_system, unnamed is used by default.
ignore – The specified slice 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 ignore only when partitioning existing is specified.
optional_parameters – Use one of the following values:
preserve – The file system on the specified slice is preserved.
preserve can be specified only when size is existing and slice is cwtxdysz.
mount_options – One or more mount options, which is the same as the -o option of the mount(1M) command. The mount options are added to the /etc/vfstab entry for the specified mount_pt_name.
If you need to specify more than one mount option, the mount options must be separated by commas and no spaces, for example, ro,quota, for example.
forced_deployment |
forced_deployment forces the installation of a Solaris Flash differential archive onto a clone system that is different than the software expects.
If you use forced_deployment, 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.
geo locale |
geo designates the regional locale or locales that you want to install on a system or to add when upgrading a system. Values you can specify for locale are listed in the following table.
Value |
Description |
---|---|
N_Africa |
Northern Africa, including Egypt |
C_America |
Central America, including Costa Rica, El Salvador, Guatemala, Mexico, Nicaragua, Panama |
N_America |
North America, including Canada, United States |
S_America |
South America, including Argentina, Bolivia, Brazil, Chile, Colombia, Ecuador, Paraguay, Peru, Uruguay, Venezuela |
Asia |
Asia, including Japan, Republic of Korea, People's Republic of China, Taiwan, Thailand |
Ausi |
Australasia, including Australia, New Zealand |
C_Europe |
Central Europe, including Austria, Czech Republic, Germany, Hungary, Poland, Slovakia, Switzerland |
E_Europe |
Eastern Europe, including Albania, Bosnia, Bulgaria, Croatia, Estonia, Latvia, Lithuania, Macedonia, Romania, Russia, Serbia, Slovenia, Turkey |
N_Europe |
Northern Europe, including Denmark, Finland, Iceland, Norway, Sweden |
S_Europe |
Southern Europe, including Greece, Italy, Portugal, Spain |
W_Europe |
Western Europe, including Belgium, France, Great Britain, Ireland, Netherlands |
M_East |
Middle East, including Israel |
A complete list of the component locale values that compose each regional locale that is listed previously is presented in Appendix D, Locale Values (Reference).
You can specify a geo keyword for each locale you need to add to a system.
install_type initial_upgrade_flash_switch |
install_type defines whether to erase and install a new Solaris operating environment on a system, upgrade the existing Solaris environment on a system, or install a Solaris Flash archive on the system.
You must specify install_type in a profile, and install_type must be the first profile keyword in every profile.
You must use one of the following options for the initial_upgrade_flash_switch:
initial_install – Specifies to perform an initial installation of the Solaris operating environment
upgrade – Specifies to perform an upgrade of the Solaris operating environment
flash_install – Specifies to install a Solaris Flash archive that overwrites all files
flash_update – Specifies to install a Solaris Flash differential archive that overwrites only the files that are specified
Some profile keywords can only be used with the initial_install option. Some profile keywords can only be used with the upgrade option. Some profile keywords can only be used with the flash_install option.
isa_bits bit_switch |
isa_bits specifies whether 64-bit or 32-bit Solaris 9 packages are to be installed.
bit_switch represents the option 64 or 32, which you use to indicate whether 64-bit or 32-bit Solaris 9 packages are to be installed. If you do not set this keyword in the profile, the JumpStart program installs systems as follows:
64-bit packages on UltraSPARCTM systems
32-bit packages on all other systems
If you use the isa_bits keyword, you must also use the latest check script in the solaris_9/Misc/jumpstart_sample directory on the Solaris 9 Software 1 of 2 CD or on the Solaris 9 DVD.
layout_constraint slice constraint [[minimum_size]] |
You can use layout_constraint only for the upgrade option when you need to reallocate disk space.
layout_constraint designates the constraint auto-layout has on a file system if auto-layout needs to reallocate space during an upgrade because of space problems.
If you do not specify the layout_constraint keyword, the JumpStart program lays out the disk as follows:
File systems that require more space for the upgrade are marked changeable.
File systems that are on the same disk as the file system that requires more space and that are mounted by the /etc/vfstab file are marked changeable.
Remaining file systems are marked fixed because auto-layout cannot change the file systems.
If you specify one or more layout_constraint keywords, the JumpStart program lays out the disk as follows:
File systems that require more space for the upgrade are marked changeable.
File systems for which you specified a layout_constraint keyword are marked with the specified constraint.
The remaining file systems are marked fixed.
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 layout_constraint keyword to change the minimum_size values on file systems that require more space for the upgrade.
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.
slice – slice specifies the file system's disk slice on which to specify the constraint. You must specify the system's disk slice in the form cwtxdyszor cxdysz.
constraint – Use one of the following constraints for the specified file system:
changeable – Auto-layout can move the file system to another location and it can change the file system size. The changeable constraint can only be specified on file systems that are mounted by the /etc/vfstab file. You can change the file system's size by specifying the minimum_size value.
When you mark a file system as changeable and minimum_size 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 minimum_size is specified, any free space that remains, original size minus minimum size, is used for other file systems.
movable – Auto-layout can move the file system to another slice on the same disk or different disk. The file system size remains the same.
available – 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 available constraint can only be specified on file systems that are not mounted by the /etc/vfstab file.
collapse – Auto-layout moves and collapses the specified file system into the parent file system. You can use the collapse option to reduce the number of file systems on a system as part of the upgrade. For example, if a system has the /usr and /usr/share file systems, collapsing the /usr/share file system moves the file system into /usr, the parent file system. You can specify the collapse constraint only on file systems that are mounted by the /etc/vfstab file.
minimum_size – Specifies the size of the file system after auto-layout reallocates space. The minimum_size 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 minimum_size 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.
Examples:
layout_constraint c0t3d0s1 changeable 200 layout_constraint c0t3d0s4 movable layout_constraint c0t3d1s3 available layout_constraint c0t2d0s1 collapse
local_customization local directory |
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 local_customization keyword designates the directory where you have stored these scripts. local directory is the path to the script on the clone system. For information on predeployment and postdeployment scripts, see Creating Customization Scripts.
locale locale_name |
You can use locale with both the initial installation and upgrade options.
locale designates the locale packages you want to install or add when upgrading for the specified locale_name. The locale_name values are the same as those values that are used for the $LANG environment variable. Appendix D, Locale Values (Reference) contains a list of valid locale values.
When you use the local keyword, consider the following:
If you have preconfigured a default locale, the locale is automatically installed. The English language packages are installed by default.
You can specify a locale keyword for each locale you need to add to a system.
no_content_check |
When installing a clone system with a Solaris Flash differential archive, you can use the no_content_check 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 his keyword unless you are sure the clone system is a duplicate of the original master system.
If you use no_content_check, 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.
no_master_check |
When installing a clone system with a Solaris Flash differential archive, you can use the no_master_check 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. For information on installing Solaris Flash differential archives, see To Prepare to Install a Solaris Flash Archive With a Custom JumpStart Installation.
num_clients client_num |
When a server is installed, space is allocated for each diskless client's root (/) and swap file systems. num_clients defines the number of diskless clients, client_num, that a server supports. If you do not specify num_clients in the profile, five diskless clients are allocated by default.
You can use num_clients only when system_type is specified as server.
package package_name [[add_delete_switch]] |
You can use package with both the initial installation and upgrade options.
package designates whether a package is to be added to or deleted from the software group that is to be installed on the system.
You must specify package_name in the form SUNWname. To view detailed information about packages and their names, on an installed system, use the pkginfo -l command.
add_delete_switch represents the option add or delete, which you use to indicate whether to add or delete the specified package. If you do not specify add_delete_switch, add is used by default.
Some packages are required and cannot be deleted. You cannot individually add or delete localization packages by using the package profile keyword. To add localization packages, use the locale profile keyword.
When you use package for an upgrade, the JumpStart program performs the following actions:
All packages already on the system are automatically upgraded.
If you specify package_name add and package_name is not installed on the system, the package is installed.
If you specify package_name delete and package_name is installed on the system, the package is deleted before the upgrade begins.
If you specify package_name delete and package_name 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.
partitioning type |
partitioning defines how the disks are divided into slices for file systems during the installation.
type – Use one of the following values:
default – 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 filesys keywords. rootdisk is selected first. The JumpStart program uses additional disks if the specified software does not fit on rootdisk.
existing – The JumpStart program uses the existing file systems on the system's disks. All file systems except /, /usr, /usr/openwin, /opt, and /var 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.
When you use both the filesys and partitioning existing profile keywords, you must set size size to existing.
explicit – The JumpStart program uses the disks and creates the file systems that are specified by the filesys keywords. If you specify only the root (/) file system with the filesys keyword, all of the Solaris software is installed in the root (/) file system.
If you use the explicit profile value, you must use the filesys keyword to specify the disks to use and file systems to create.
If you do not specify partitioning in the profile, the default type of partitioning is used by default.
root_device slice |
You can use root_device with both the initial installation and upgrade options.
root_device designates the system's root disk. How the System's Root Disk Is Determined contains additional information.
When you are upgrading a system, root_device designates the root (/) file system and the file systems that are mounted by its /etc/vfstab file to be upgraded. You must specify root_device if more than one root (/) file system can be upgraded on a system. You must specify slice in the form cwtxdysz or cxdysz.
Example:
root_device c0t0d0s2
When you use the root_device keyword, consider the following:
If you specify root_device on a system with only one disk, the root_device and the disk must match. Also, any filesys keywords that specify the root (/) file system must match root_device.
If you are upgrading a RAID-1 volume (mirror), the value that is specified for root_device should be one side of the mirror. The other side of the mirror is automatically upgraded.
A system's root disk is the disk on the system that contains the root (/) file system. In a profile, you can use the rootdisk variable in place of a disk name, which the JumpStart program sets to the system's root disk. Table 28–6 describes how the JumpStart program determines the system's root disk for the installation.
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.
Stage |
Action |
---|---|
1 |
If the root_device keyword is specified in the profile, the JumpStart program sets rootdisk to the root device. |
2 |
If rootdisk is not set and the boot_device keyword is specified in the profile, the JumpStart program sets rootdisk to the boot device. |
3 |
If rootdisk is not set and a filesys cwtxdysz size / entry is specified in the profile, the JumpStart program sets rootdisk to the disk that is specified in the entry. |
4 |
If rootdisk is not set and a rootdisk.sn 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 rootdisk to the found disk. |
5 |
If rootdisk is not set and partitioning existing 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 rootdisk to the found disk. |
6 |
If rootdisk is not set, the JumpStart program sets rootdisk to the disk where the root (/) file system is installed. |
system_type type_switch |
system_type defines the type of system on which the Solaris environment is to be installed.
type_switch represents the option standalone or server, which you use to indicate the type of system on which the Solaris software is to be installed. If you do not specify system_type in a profile, standalone is used by default.
usedisk disk_name ... |
By default, the JumpStart program uses all of the operational disks on the system when you specify partitioning default. The usedisk profile keyword designates one or more disks that you want the JumpStart program to use. You must specify disk_name in the form cxtydz or cydz, for example, c0t0d0 or c0d0s0.
If you specify usedisk in a profile, the JumpStart program uses only the disks that you specify after the usedisk keyword.
You cannot specify the usedisk keyword and the dontuse keyword in the same profile.
You can use environment variables in your begin and finish scripts. For example, a begin script might extract the disk size, SI_DISKSIZES, and install or not install particular packages on a system, based on the actual disk size the script extracts.
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 rules file.
For example, information about which operating system is already installed on a system is only available in SI_INSTALLED after the installed keyword is used.
Table 28–7 describes these variables and their values.
Table 28–7 Installation Environment Variables
Environment Variable |
Value |
---|---|
CHECK_INPUT |
The path to the rules file in the JumpStart directory, which is mounted on /tmp/install_config/rules. |
HOME |
The root's home directory during installation, which is /tmp/root. |
PATH |
The shell search path during installation, which is /sbin:/usr/sbin/install.d:/usr:/usr/sbin:/usr/bin. |
SI_ARCH |
The hardware architecture of the install client. The SI_ARCH variable is set when the arch keyword is used in the rules file. |
SI_BEGIN |
The name of the begin script, if one is used. |
SI_CLASS |
The name of the profile that is used to install the install client. |
SI_CONFIG_DIR |
The path to the JumpStart directory, which is mounted on /tmp/install_config. |
SI_CONFIG_FILE |
The path to the rules file in the JumpStart directory, which is mounted on /tmp/install_config/rules. |
SI_CONFIG_PROG |
The rules file. |
SI_CUSTOM_PROBES_FILE |
The custom_probes.ok file, in which you can define your own rule and probe keywords. If you create a custom_probes.ok file, you can use the file to extend the list of default rule keywords, which are described in Rule Keywords and Values. You can also use the file to extend the list of default probe keywords that are described in Probe Keywords and Values. |
SI_DISKLIST |
A comma-separated list of disk names on the install client. The SI_DISKLIST variable is set when the disksize keyword is used and matched in the rules file. The SI_DISKLIST and SI_NUMDISKS variables are used to determine the physical disk to use for the rootdisk. rootdisk is described in How the System's Root Disk Is Determined. |
SI_DISKSIZES |
A comma-separated list of disk sizes on the install client. The SI_DISKSIZES variable is set when the disksize keyword is used and matched in the rules file. |
SI_DOMAINNAME |
The domain name. The SI_DOMAINNAME variable is set when the dommainname keyword is used and matched in the rules file. |
SI_FINISH |
The name of the finish script, if one is used. |
SI_HOSTADDRESS |
The install client's IP address. |
SI_HOSTID |
The install client's Ethernet address. |
SI_HOSTNAME |
The install client's host name. The SI_HOSTNAME variable is set when the hostname keyword is used and matched in the rules file. |
SI_INSTALLED |
The device name of a disk with a specific operating system on the disk, for example, Solaris, SunOS, or System V. The SI_INSTALLED variable is set when the installed keyword is used and matched in the rules file. SI_INST_OS and SI_INST_VER are used to determine the value of SI_INSTALLED. |
SI_INST_OS |
The name of the operating system. SI_INST_OS and SI_INST_VER are used to determine the value of SI_INSTALLED. |
SI_INST_VER |
The version of the operating system. SI_INST_OS and SI_INST_VER are used to determine the value of SI_INSTALLED. |
SI_KARCH |
The install client's kernel architecture. The SI_KARCH variable is set when the karch keyword is used and matched in the rules file. |
SI_MEMSIZE |
The amount of physical memory on the install client. The SI_MEMSIZE variable is set when the memsize keyword is used and matched in the rules file. |
SI_MODEL |
The install client's model name. The SI_MODEL variable is set when the model keyword is used and matched in the rules file. |
SI_NETWORK |
The install client's network number. The SI_NETWORK variable is set when the network keyword is used and matched in the rules file. |
SI_NUMDISKS |
The number of disks on an install client. The SI_NUMDISKS variable is set when the disksize keyword is used and matched in the rules file. The SI_NUMDISKS and SI_DISKLIST variables are used to determine the physical disk to use for the rootdisk. rootdisk is described in How the System's Root Disk Is Determined. |
SI_OSNAME |
The operating system release on the Solaris 9 software image. For example, you can use the SI_OSNAME 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 9 DVD or the Solaris 9 Software 1 of 2 CD image. |
SI_PROFILE |
The path to the profile in the mounted JumpStart directory. The path is /tmp/install_config/profile_name. If you are creating a derived profile, SI_PROFILE is set to the /tmp/install.input file. |
SI_ROOTDISK |
The device name of the disk that is represented by the logical name rootdisk. The SI_ROOTDISK variable is set when the disksize or the installed keyword is set to rootdisk in the rules file. |
SI_ROOTDISKSIZE |
The size of the disk that is represented by the logical name rootdisk. The SI_ROOTDISKSIZE variable is set when the disksize or the installed keyword is set to rootdisk in the rules file. |
SI_SYS_STATE |
The /a/etc/.sysIDtool.state file. You can edit this file in a finish script to prevent the sysidroot program from prompting for a root password before the system reboots. |
SI_TOTALDISK |
The total amount of disk space on the install client. The SI_TOTALDISK variable is set when the totaldisk keyword is used and matched in the rules file. |
SHELL |
The default shell during installation, which is /sbin/sh. |
TERM |
The install client's terminal type. |
TZ |
The default time zone, as specified in the NIS or NIS+ name service. |
Table 28–8 describes each rule keyword and its equivalent probe keyword.
Always place probe keywords at or near the beginning of the rules file.
Rule Keyword |
Equivalent Probe Keyword |
Description of Probe Keyword |
---|---|---|
None |
|
|
Determines the kernel architecture, i386 or SPARC, and sets SI_ARCH. |
||
Returns the size of a system's disks in Mbytes in kernel probe order, c0t3d0s0, c0t3d0s1, c0t4d0s0. disksize sets SI_DISKLIST, SI_DISKSIZES, SI_NUMDISKS, and SI_TOTALDISK. |
||
Returns a system's NIS or NIS+ domain name or blank and sets SI_DOMAINNAME. The domainname keyword returns the output of domainname(1M). |
||
Returns a system's IP address, the first address that is listed in the output of ifconfig(1M) -a that is not lo0, and sets SI_HOSTADDRESS. |
||
Returns a system's host name that is the output from uname(1) -n and sets SI_HOSTNAME. |
||
Returns the version name of the Solaris operating environment that is installed on a system and sets SI_ROOTDISK and SI_INSTALLED. If the JumpStart program finds a Solaris release but is unable to determine the version, the version that is returned is SystemV. |
||
Returns a system's platform group, for example i86pc, sun4m, and sun4, and sets SI_KARCH. For a list of platform names, see Solaris 9 Sun Hardware Platform Guide. |
||
Returns the size of physical memory on a system in Mbytes and sets SI_MEMSIZE. |
||
Returns a system's platform name and sets SI_MODEL. For a list of platform names, see the Solaris 9 Sun Hardware Platform Guide. |
||
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 ifconfig(1M) -a that is not lo0. The network keyword sets SI_NETWORK. |
||
Returns the version and operating system name of the Solaris operating environment that is found on a CD and sets SI_OSNAME. If the JumpStart program finds a Solaris release but is unable to determine the version, the version that is returned is SystemV. |
||
|
Returns the name and size in Mbytes of a system's root disk and sets SI_ROOTDISK. |
|
Returns the total disk space on a system (in Mbytes) and sets SI_TOTALDISK. The total disk space includes all of the operational disks that are attached to a system. |