JumpStart Keywords for a ZFS Root (/) File System (Reference)

This section provides descriptions of some of the ZFS specific keywords that you can use in a JumpStart profile. The keywords described in this section are either used differently from their usage in a UFS profile or used only in a ZFS profile.

• For a quick reference guide to UFS and ZFS profile keywords, see Profile Keywords Quick Reference.

• The following keywords can be used in a ZFS profile. The usage is the same for both UFS and ZFS profiles. For descriptions of these keywords, see Profile Keyword Descriptions and Examples.

  • boot_device

  • cluster

  • dontuse

  • fdisk

  • filesys (mounting remote file systems)

  • geo

  • locale

  • package

  • usedisk

bootenv Profile Keyword (ZFS and UFS)

The bootenv keyword identifies boot environment characteristics. A boot environment is created by default during installation with the pool keyword. If you use the bootenv keyword with the installbe option, you can name the new boot environment and create a /var dataset within the boot environment.

This keyword can be used in a profile for installing a UFS file system or a ZFS root pool.

• In a UFS file system, this keyword is used for creating an empty boot environment for the future installation of a flash archive. For more information, see bootenv Profile Keyword (UFS and ZFS).

• For a ZFS root pool, the bootenv keyword changes the characteristics of the default boot environment that is created at install time. This boot environment is a copy of the root file system that you are installing.

  The bootenv keyword can be used with the installbe, bename, and dataset options. These options name the boot environment and create a separate /var dataset.

  bootenv installbe bename BE-name [dataset mount-point]

installbe

Changes the characteristics of the default boot environment that is created during the installation.

bename BE-name

Specifies the name of the new boot environment to be created. The 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.

dataset mount-point

Use the optional dataset keyword to identify a /var dataset that is separate from the ROOT dataset. The mount-point value is limited to /var. For example, a bootenv syntax line for separate /var dataset would be similar to the following:

bootenv installbe bename zfsroot dataset /var

For more information about upgrading and activating a boot environment, see Chapter 10, Live Upgrade and ZFS (Overview), in Oracle Solaris 10 1/13 Installation Guide: Live Upgrade and Upgrade Planning.

install_type Keyword (ZFS and UFS)

The install_type keyword is required in every profile. For a UFS installation, several options are available. The only option available for a ZFS installation is the initial_install keyword. This option installs a new Oracle Solaris OS on a system. The profile syntax is as follows:

install_type initial_install

The following UFS options are not available for a ZFS installation:

• upgrade - You can use Live Upgrade only to upgrade ZFS root pool. See Chapter 10, Live Upgrade and ZFS (Overview), in Oracle Solaris 10 1/13 Installation Guide: Live Upgrade and Upgrade Planning.

• flash_install - A flash archive cannot be installed.

• flash_update - A flash archive cannot be installed.

pool Profile Keyword (ZFS Only)

The pool keyword defines the new root pool to be created. The pool is then installed with a software group specified with the cluster keyword. All of the options shown in the syntax are needed for creating a new root pool.

pool poolname poolsize swapsize dumpsize vdevlist

poolname

Specifies the name of the new pool to be created. A new pool is created with the specified poolsize and with the specified devices, vdevlist.

poolsize

Size of the new pool to be created. You can either specify a size or use the auto option to allocate the largest possible pool size given the constraints, such as size of the disks and preserved slices.

---

Note - The meaning of auto for the poolsize keyword is different from the filesys keyword use of auto in a UFS file system. In ZFS, the size of the disk is checked to verify that the minimum size can be accommodated. If the minimize size is available, the largest possible pool size is allocated given the constraints, such as size of the disks and preserved slices.

---

swapsize

Size of the swap volume (zvol) to be created within a new root pool. You can either provide a size or use the auto option to cause the swap area to be automatically sized. The default size is half the size of physical memory, but no less than 512 MB and no greater than 2 GB.

dumpsize

Size of the dump volume to be created within a new pool. You can either provide a size or use the auto option to specify the default dump size.

vdevlist

One or more devices used to create the pool.

Devices in the vdevlist must be slices for the root pool. Slice names should be provided in the form cwtxdysz.

---

Note - The format of the vdevlist is the same as the format of the zpool create command.

---

Acceptable values for this option are:

A single device name

For example, c0t0d0s0

mirror [device-names|any]

mirror specifies the mirroring of the disk with either specified device names or the keyword any, which enables the installer to select a suitable device.

At this time, only mirrored configurations are supported when multiple devices are specified. You can mirror as many as disks you like, but the size of the pool created is determined by the smallest of the specified disks. For more information about creating mirrored storage pools, see Mirrored Storage Pool Configuration in Oracle Solaris ZFS Administration Guide.

any

Enables the installer to select a suitable device.

root_device Profile Keyword (ZFS and UFS)

root_device cwtxdysz

root_device specifies the device to be used for the root pool. The root_device keyword determines where the operating system is installed. This keyword is used the same in both ZFS and a UFS file system with some limitations. For the ZFS root pool, the root device is limited to a single system. This keyword is not useful for mirrored pools.