Profile Keywords and Values

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.

Profile Keywords at a Glance

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.

Profile Keyword Descriptions and Examples

archive_location Keyword

archive_location retrieval_type location

The values of retrieval_type and location depend on where the Web Start 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.

• NFS Server

• HTTP Server

• Local Tape

• Local Device

• Local File

NFS Server

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

Examples:

archive_location nfs golden:/archives/usrarchive

archive_location nfs://golden/archives/usrarchive

HTTP Server

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

Examples:

archive_location http silver /archives/usrarchive auth basic user1 secret timeout 5

archive_location http silver /archives/usrarchive auth basic user1 secret timeout 5

Local Tape

If the archive is stored on a tape, use the following syntax for the archive_location keyword.

archive_location local_tape device  position

Examples:

archive_location local_tape /dev/rmt/0n 5

archive_location local_tape 0n 5

Local Device

You can retrieve a Web Start Flash archive from a local device if you stored the Web Start 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

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

Local File

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 Web Start 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 

Examples:

archive_location local_file /archives/usrarchive

archive_location local_file /archives/usrarchive

backup_media Profile Keyword

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 a lack of space. If multiple tapes or diskettes are required for the backup, you are prompted to insert tapes or diskettes during the upgrade.

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 Profile Keyword

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.

• IA: 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.

Choose if you want to update or preserve the system's EEPROM to the specified boot device.

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.

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.

client_arch Profile Keyword

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 8 Sun Hardware Guide.

You can use client_arch only when system_type is specified as server.

client_root Profile Keyword

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 Profile Keyword

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, 512 Mbytes of swap space is allocated by default.

Example:

client_swap 512

The example specifies that each diskless client is to have a swap space of 512 Mbytes.

You can use client_swap only when system_type is specified as server.

cluster Profile Keyword (Adding Software Groups)

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.

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 Profile Keyword (Adding or Deleting Clusters)

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 condition 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 Profile Keyword

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 cxtydz or cydz, for example, c0t0d0.

You cannot specify the dontuse keyword and the usedisk keyword in the same profile.

x86: fdisk Profile Keyword

fdisk disk_name type size

fdisk defines how the fdisk partitions are set up on an IA based system. You can specify fdisk more than once. When fdisk partitions an IA 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.

  ---

  x86 only –

  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 fdisk paritions that are extended or reserved for data DOS. When youe 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.

  ---

  x86 only –

  You can specify this value only if size is delete.

  ---

• 0xHH – A hexadecimal fdisk partition. HH is a hexadecimal number between 01 and FF.

  ---

  x86 only –

  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.

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.

  ---

  x86 only –

  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.

  ---

  x86 only –

  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 Profile Keyword (Mounting Remote File Systems)

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,quota, for example).

filesys Profile Keyword (Creating Local File Systems)

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.

  ---

  Note –

  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.

  ---

  Note –

  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.

  ---

  Note –

  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.

  ---

  Note –

  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.

  ---

  Note –

  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.

  ---

  Note –

  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.

  ---

geo Profile Keyword

geo locale

You can use geo with both the initial installation and upgrade options.

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:

A complete list of the component locale values that compose each regional locale that is listed previously is presented in Chapter 38, Locale Values.

You can specify a geo keyword for each locale you need to add to a system.

install_type Profile Keyword

install_type initial_install_upgrade_switch

install_type defines whether to erase and install a new Solaris operating environment on a system or upgrade the existing Solaris environment on a system.

You must specify install_type in a profile, and install_type must be the first profile keyword in every profile.

initial_install_upgrade_switch represents the option initial_install or upgrade, which you use to indicate the type of installation to be performed.

You must specify initial_install_upgrade_switch.

Some profile keywords can only be used with the initial_install option. Some profile keywords can only be used with the upgrade option.

isa_bits Profile Keyword

isa_bits bit_switch

isa_bits specifies whether 64-bit or 32-bit Solaris 8 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 8 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 UltraSPARC^TM 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 8 Software 1 of 2 CD or on the Solaris 8 DVD.

layout_constraint Profile Keyword

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 cwtxdysz or cxdysz.

constraint – Use one 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 c0d0s4 movable

layout_constraint c0t3d1s3 available

layout_constraint c0t2d0s1 collapse

locale Profile Keyword

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. Chapter 38, Locale Values 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.

num_clients Profile Keyword

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 Profile Keyword

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 or Admintool. In Admintool, choose Software from the Browse menu.

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.

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 Profile Keyword

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.

  ---

  Note –

  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.

  ---

  Note –

  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 Profile Keyword

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 mirror, the value specified for root_device should be one side of the mirror. The other side of the mirror is automatically upgraded.

How the System's Root Disk Is Determined

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–4 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.

system_type Profile Keyword

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 Profile Keyword

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.