Profile Keyword and Profile Value Descriptions

The following sections describe the profile keywords and profile values that you can use in a profile. Profile keywords and their values are case sensitive.

Table 8-3 provides a quick way to determine which keywords you can use based on your installation scenario. Unless otherwise noted in the profile keyword descriptions, the profile keyword can only be used with the initial installation option.

backup_media Profile Keyword

backup_media type   path

backup_media must be used only with the upgrade option when disk space reallocation is required.

backup_media defines the media that will be used to back up file systems if space needs to be reallocated during an upgrade because of space problems. If multiple tapes or diskettes are required for the backup, you will be 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 installation program will install the root file system and consequently what the system's boot device will be. The eeprom value also enables you to update the system's EEPROM if you change the system's current boot device, so the system can automatically boot from the new boot device (SPARC systems only).

If you don't 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 - Choose what the boot device will be.

• cwtxdysz or cxdysz - The disk slice where the installation program places the root file system, for example, c0t0d0s0. (SPARC based systems only).

• cwtxdy or cxdy - The disk where the installation program places the root file system, for example, c0t0d0. (x86 based systems only).

• existing - The installation program places the root file system on the system's existing boot device.

• any - The installation program chooses where to place the root file system. It will try to use the system's existing boot device; however, it can choose a different boot device if it needs to.

eeprom - Choose if you want to update the system's EEPROM to the specified boot device (SPARC based systems only). For x86 based systems, you must always specify the preserve value.

• update - The installation program updates the system's EEPROM to the specified boot device, so the installed system will automatically boot 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 will have to manually change the system's EEPROM, so it 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[karch_value...]

client_arch defines that the OS server will support a different platform group than it uses. If you do not specify client_arch, any diskless client or Solstice AutoClient system that uses the OS server must have the same platform group as the server. You must specify each platform group that you want the OS server to support.

Valid values for karch_value are sun4d, sun4c, sun4m, sun4u, or i86pc. (See Appendix C, Platform Names and Groups for a detailed list of the platform names of various systems.)

client_arch can be used 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 will automatically allocate 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.

client_root can be used 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, 32 Mbytes of swap space is allocated.

Example:

client_swap 64

The example defines that each diskless client will have a swap space of 64 Mbytes.

client_swap can be used only when system_type is specified as server.

cluster Profile Keyword (Adding Software Groups)

cluster group_name

cluster designates what software group to add to the system. The cluster names for the software groups are:

You can specify only one software group in a profile, and it must be specified before other cluster and package entries. If you do not specify a software group with cluster, the end user software group (SUNWCuser) is installed on the system by default.

cluster Profile Keyword (Adding/Deleting Clusters)

cluster cluster_name [add | delete]

cluster (adding/deleting clusters) can be used with both the initial installation and upgrade options.

cluster designates whether a cluster should be added or deleted from the software group that will be installed on the system. add or delete indicates whether the cluster should be added or deleted. If you do not specify add or delete, add is set by default.

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. Table A-3 and Table A-4 also provide a list of the clusters included in each software group.

For Upgrade:

• All clusters 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 [disk_name...]

dontuse designates one or more disks that you don't want the Solaris installation program to use when partitioning default is specified (by default, the installation program uses all the operational disks on the system). 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.

fdisk Profile Keyword

fdisk disk_name  type  size

fdisk defines how the fdisk partitions are set up on an x86 based system, and you can specify fdisk more than once. This is what happens by default with fdisk partitions on x86 based systems:

• All fdisk partitions on the disk are preserved unless you specifically delete them with the fdisk keyword (if size is delete or 0). Also, all existing fdisk partitions are deleted when size is all.

• A Solaris fdisk partition that contains a root file system is always designated as the active partition on the disk (an x86 based system boots from the active partition by default).

• If no fdisk keyword is specified in a profile, the following fdisk keyword is specified during the installation:

  fdisk all solaris maxfree

• fdisk entries are processed in the order they are listed in the profile.

disk_name - Choose where the fdisk partition will be created or deleted:

• cxtydz or cydz - A specific disk, for example, c0t3d0.

• rootdisk - The variable that contains the value for the system's root disk, which is determined by the Solaris installation program (described on "How the System's Root Disk Is Determined").

• all - All the selected disks.

type - Choose what type of fdisk partition will 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 extended or data DOS fdisk partitions). When deleting fdisk partitions (size is delete), dosprimary is an alias for the DOSHUGE, DOSOS12, and DOSOS16 fdisk types (they are all deleted). When creating an fdisk partition, dosprimary is an alias for the DOSHUGE fdisk partition (a DOSHUGE fdisk partition is created).

• DDD - An integer fdisk partition. DDD is an integer number (valid values are 1 through 255).

  ---

  Note -

  This value can be specified only if size is delete.

  ---

• 0xHH - A hexadecimal fdisk partition. HH is a hexadecimal number (valid values are 01 through FF).

  ---

  Note -

  This value can be specified only if size is delete.

  ---

The following table shows the integer and hexadecimal numbers for some of the fdisk types:

size - Choose one of the following:

• DDD - An fdisk partition of size DDD (in Mbytes) is created on the specified disk. DDD must be an integer number, and the Solaris installation program automatically rounds the number up to the nearest cylinder boundary. If 0 is specified, it is the same as specifying delete.

• all - An fdisk partition is created on the entire disk (all existing fdisk partitions will be deleted).

  ---

  Note -

  This 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).

  ---

  Note -

  There must be at least one unused fdisk partition on the disk and the disk must have free space or the installation will fail. This 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]

This instance of filesys sets up the installed system to automatically mount remote file systems when it 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 resides (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 specified in server:path. If you don't have a name service running on the network, this value can be used to populate the /etc/hosts file with the server's host name and IP address. If you don't want to specify the server's IP address (if you have a name service running on the network), you must specify a minus sign (-).

mount_pt_name - The name of the mount point that the remote file system will be mounted on.

mount_options - One or more mount options (-o option of the mount(1M) command) that 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

filesys Profile Keyword (Creating Local File Systems)

filesys slice  size  [file_system]  [optional_parameters]

This instance of filesys creates local file systems during the installation. You can specify filesys more than once.

slice - Choose one of the following:

• any - The Solaris installation program places the file system on any disk.

  ---

  Note -

  any cannot be specified when size is existing, all, free, start:size, or ignore.

  ---

• cwtxdysz or cxdysz - The disk slice where the Solaris installation program places the file system, for example, c0t0d0s0.

• rootdisk.sn - The variable that contains the value for the system's root disk, which is determined by the Solaris installation program (described on "How the System's Root Disk Is Determined"). The sn suffix indicates a specific slice on the disk.

size - Choose one of the following:

• 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 using this value, you can change the name of an existing slice by specifying file_system as a different mount_pt_name.

  ---

• auto - The size the file system is automatically determined depending on the selected software.

• all - The specified slice uses the entire disk for the file system. When you specify this value, no other file systems can reside 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, it must be the last filesys 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 - You can use this optional value when slice is specified as any or cwtxdysz. If file_system is not specified, unnamed is set by default, but then you can't specify the optional_parameters value. Choose one of the following:

• 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 (VTOC value is V_BACKUP). By default, slice 2 is an overlap slice that is a representation of the whole disk.

  ---

  Note -

  overlap can be specified only when size is existing, all, or start:size.

  ---

• unnamed - The specified slice is defined as a raw slice, so slice will not have a mount point name. If file_system is not specified, unnamed is set by default.

• ignore - The specified slice is not used or recognized by the Solaris installation program. This can be used to ignore a file system on a disk during an installation, so the Solaris installation program can create a new file system on the same disk with the same name. ignore can be used only when partitioning existing is specified.

optional_parameters - Choose one of the following:

• 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 (-o option of the mount(1M) command) that 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

  ---

install_type Profile Keyword

install_type initial_install | upgrade

install_type defines whether to perform the initial installation option or upgrade option on the system.

install_type must be the first profile keyword in every profile.

Some profile keywords can only be used with the initial_install option, and this also applies to the upgrade option.

layout_constraint Profile Keyword

layout_constraint slice constraint [minimum_size]

layout constraint can be used only for the upgrade option when disk space reallocation is required.

layout_constraint designates the constraint auto-layout has on a file system if it needs to reallocate space during an upgrade because of space problems.

If you don't specify the layout_constraint keyword, the:

• File systems requiring more space for the upgrade are marked changeable

• File systems on the same disk as the file system requiring more space (mounted by the /etc/vfstab file) are marked changeable

• Remaining file systems are marked fixed (auto-layout can't change them)

If you specify one or more layout_constraint keywords, the

• File systems requiring more space for the upgrade are marked changeable

• File systems for which you specified a layout_constraint keyword are marked with the specified constraint

• Remaining file systems are marked fixed

Even though you can't change the constraint on file systems requiring more space for the upgrade (they must be marked changeable), you can use layout_constraint on those file systems to change their minimum_size values.

To help auto-layout reallocate space, select more file systems to be changeable or moveable, especially those that reside on the same disks as the file systems that require more space for the upgrade.

slice - This is the file system's disk slice on which to specify the constraint. It must be specified in the form cwtxdysz or cxdysz.

constraint - Choose one the following constraints for the specified file system.

• changeable - Auto-layout can move the file system to another location and it can change its size. This 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 will be set to 10% greater than the minimum size required. For example, if the minimum size for a file system is 100 Mbytes, the changed size would be 110 Mbytes. If minimum_size is specified, any free space left (original size minus minimum size) will be used for other file systems.

• movable - Auto-layout can move the file system to another slice (on the same disk or different disk) and its size stays the same.

• available - Auto-layout can use all of the space on the file system to reallocate space. All the data in the file system will be lost. This constraint can only be specified on file systems that are not mounted by the /etc/vfstab file.

• collapse - Auto-layout will move (collapse) the specified file system into its parent file system. This can be used to reduce the number of file systems on a system as part of the upgrade. For example, if the system has the /usr and /usr/openwin file systems, collapsing the /usr/openwin file system would move it into /usr (its parent). This constraint can only be specified on file systems that are mounted by the /etc/vfstab file.

• minimum_size - This value specifies the size that you want the file system to be when auto-layout reallocates space (it basically lets you change the size of a file system). The size of the file system may end up being more if unallocated space is added to it, but the size will never be less than the value you specify. You can use this optional 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 its existing contents.

Examples:

layout_constraint c0t3d0s1 changeable 200

layout_constraint c0d0s4 movable

layout_constraint c0t3d1s3 availiable

layout_constraint c0t2d0s1 collapse

locale locale_name Profile Keyword

locale locale_name

locale can be used with both the initial installation and upgrade options.

locale designates which language or locale packages should be installed (or added for upgrade) for the specified locale_name. The locale_name values are the same used for the $LANG environment variable. See Appendix E, Language and Locale Values for a list of valid language and locale values.

If you've preconfigured a default language or locale, it is automatically installed. The English language packages are installed by default.

You can specify a locale keyword for each language or 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 will support. If you do not specify num_clients, five diskless clients are allocated.

num_clients can be used only when system_type is specified as server.

package Profile Keyword

package package_name [add | delete]

package can be used with both the initial installation and upgrade options.

package designates whether a package should be added to or deleted from the software group that will be installed on the system. add or delete indicates whether the package should be added or deleted. If you do not specify add | delete, add is set by default.

package_name must be in the form SUNWname. Use the pkginfo -l command or Admintool (choose Software from the Browse menu) on an installed system to view detailed information about packages and their names. Table A-3 and Table A-4 also provide a list of the packages included in each software group.

For Upgrade:

• 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 prevented from being installed if it is part of a cluster that is designated to be installed.

partitioning Profile Keyword

partitioning default | existing | explicit

partitioning defines how the disks are divided into slices for file systems during the installation. If you do not specify partitioning, default is set.

default - The Solaris installation program selects the disks and creates the file systems on which to install the specified software, except for any file systems specified by the filesys keyword. rootdisk is selected first; additional disks are used if the specified software does not fit on rootdisk.

existing - The Solaris installation program uses the existing file systems on the system's disks. All file systems except /, /usr, /usr/openwin, /opt, and /var are preserved. The installation program uses the last mount point field from the file system superblock to determine which file system mount point the slice represents.

When specifying the filesys profile keyword with partitioning existing, size must be existing.

explicit - The Solaris installation program uses the disks and creates the file systems specified by the filesys keywords. If you specify only the root (/) file system with the filesys keyword, all the Solaris software will be installed in the root file system.

When you use the explicit profile value, you must use the filesys profile keyword to specify which disks to use and what file systems to create.

root_device Profile Keyword

root_device slice

root_device can be used with both the initial installation and upgrade options.

root_device designates the system's root disk. See "How the System's Root Disk Is Determined" for more information.

For Upgrade:

root_device designates the root file system (and the file systems 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. slice must be specified in the form cwtxdysz or cxdysz.

Example:

root_device c0t0d0s2

If you specify root_device on a system with only one disk (not required), the root_device and the disk must match. Also, any filesys keywords that specify the root file system must match root_device.

system_type Program Keyword

system_type standalone | server

system_type defines the type of system being installed. If you do not specify system_type in a profile, standalone is set by default.

usedisk Profile Keyword

usedisk disk_name [disk_name...]

usedisk designates one or more disks that you want the Solaris installation program to use when partitioning default is specified (by default, the installation program uses all the operational disks on the system). disk_name must be specified in the form cxtydz or cydz, for example, c0t0d0.

If you specify the usedisk profile keyword in a profile, the Solaris installation program will only use the disks that you specify with the usedisk profile keyword.

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