'\" te
.\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
.TH ai_manifest 4 "26 Jun 2012" "SunOS 5.11" "File Formats"
.SH NAME
ai_manifest \- Automated installation manifest file format
.SH SYNOPSIS
.LP
.nf
/usr/share/install/ai.dtd.1
.fi

.SH DESCRIPTION
.sp
.LP
Automated Installer (AI) provides a customizable, hands-free installation mechanism for Oracle Solaris and uses an XML-based file format as the description of the installation parameters. This installation parameters file is called an AI manifest. The installation can be customized in various ways such as disk layout and the software to be installed on the system.
.sp
.LP
The AI manifest has the following sections:
.RS +4
.TP
.ie t \(bu
.el o
Automated installation settings. Specifies settings used during the installation.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Disk layout. Specifies the disk layout for the installation.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Software. Specifies the software packages to be installed.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Boot configuration (x86 only). Specifies how to configure the GRUB boot menu.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Other configuration. Specifies other configuration components to be installed onto the system.
.RE
.sp
.LP
These sections are described in more detail below.
.sp
.LP
To create a new AI manifest, use a copy of the template or default manifest from the relevant install service image. For example, if the install service image is located at \fIimagepath\fR, the following files are available:
.sp
.ne 2
.mk
.na
\fB\fB\fIimagepath\fR/auto_install/manifest/default.xml\fR\fR
.ad
.sp .6
.RS 4n
The original default AI manifest for this install service.
.RE

.sp
.ne 2
.mk
.na
\fB\fB\fIimagepath\fR/auto_install/manifest/ai_manifest.xml\fR\fR
.ad
.sp .6
.RS 4n
An annotated, sample AI manifest with example customizations.
.RE

.sp
.LP
You can use the \fBinstalladm export\fR command to retrieve a copy of any manifest that already exists in an install service.
.sp
.LP
AI manifests are also used for installing non-global zones using the \fBzoneadm install\fR command. An AI manifest file can be passed to this command to customize the zone installation. Only a subset of AI manifest specifications applies to installing non-global zones. These specifications are noted in the sections below.
.sp
.LP
Complementing the AI manifest are Service Management Facility (SMF) configuration profiles. These profiles specify the system configuration for the installed system such as hostname, networking, and root and initial user account settings.
.sp
.LP
For more information about install services, AI manifests, and configuration profiles, see the \fBinstalladm\fR(1M) man page and Part\ III, \fIInstalling Using an Install Server,\fR in \fIInstalling Oracle Solaris 11.1 Systems\fR. For information about the configuration profile file format, see \fBsmf\fR(5).
.SH AUTOMATED INSTALLATION SETTINGS
.sp
.LP
The \fBai_instance\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
The name of this manifest instance.
.RE

.sp
.ne 2
.mk
.na
\fB\fBhttp_proxy\fR\fR
.ad
.sp .6
.RS 4n
The HTTP proxy to use to access remote files during the installation. Examples of remote files accessed during installation are software packages in an Image Packaging System (IPS) package repository. The value of \fBhttp_proxy\fR is an HTTP URI such as \fBhttp://myproxy.mycompany.com:8080/\fR.
.sp
This attribute is not applicable when installing a non-global zone and is ignored if provided.
.RE

.sp
.ne 2
.mk
.na
\fB\fBauto_reboot\fR\fR
.ad
.sp .6
.RS 4n
The flag that specifies whether to automatically reboot after installation. The default value of \fBauto_reboot\fR is \fBfalse\fR. When \fBauto_reboot\fR is \fBfalse\fR, the installation waits for manual intervention to reboot.
.sp
When \fBauto_reboot\fR is \fBtrue\fR, on a successful installation, the machine automatically reboots into the newly installed boot environment.
.sp
This attribute is not applicable when installing a non-global zone and is ignored if provided.
.RE

.sp
.LP
The following example demonstrates how to use the \fBai_instance\fR element:
.sp
.in +2
.nf
<auto_install>
  <ai_instance name='default' auto_reboot='true'
    http_proxy='http://myproxy.mycompany.com:8080/'>
  <!-- target and software sections -->
  </ai_instance>
</auto_install>
.fi
.in -2

.SH DISK LAYOUT
.sp
.LP
AI enables a range of disk specification, varying from completely automatic selection of the installation target to fine-grained control of the disk layout.
.sp
.LP
The \fBtarget\fR element specifies the disk layout. The default disk layout when no \fBtarget\fR element is specified has the following characteristics:
.RS +4
.TP
.ie t \(bu
.el o
The whole of one disk is used to install the Oracle Solaris OS. This disk is usually the boot disk or first disk.
.RE
.RS +4
.TP
.ie t \(bu
.el o
For x86 and SPARC with GPT aware firmware, a GPT partition is allocated that consumes the full disk contents. See the \fB-B\fR option of the \fBzpool create\fR command in the \fBzpool\fR(1M) man page.
.RE
.RS +4
.TP
.ie t \(bu
.el o
For SPARC systems that are not capable of using GPT, a single slice 0 that is the full size of the disk is created.
.RE
.RS +4
.TP
.ie t \(bu
.el o
A single root pool is created that uses either the complete slice 0 or the complete GPT partition.
.RE
.RS +4
.TP
.ie t \(bu
.el o
A swap volume and a dump volume are created in the root pool if space is available.
.RE
.sp
.LP
The \fBtarget\fR element has the following structure:
.sp
.in +2
.nf
<!-- zero or one target element -->
<target>
  <!-- zero or more disk elements -->
  <disk ...>
    <!-- One of the following elements:
             disk_name
             disk_prop
             disk_keyword
             iscsi
         Zero or more of the following elements:
             gpt_partition
             partition
             slice
         gpt_partition can have zero or one size element.
         partition can have zero or one size element
             followed by zero or more slice elements.
         slice can have zero or one size element.
    -->
  </disk>
  <!-- zero or one logical element -->
  <logical ...>
    <!-- zero or more zpool elements -->
    <zpool ...>
      <!-- zero or more vdev elements -->
      <vdev ...>
      </vdev>
      <!-- zero or more filesystem elements
           with zero or one options element
      -->
      <filesystem>
        <options>
          <option .../>
        </options>
      <!-- zero or more zvol elements
           with zero or one options element
           and one size element
      -->
      <zvol ...>
        <options>
          <option .../>
        </options>
        <size val="..."/>
      </zvol>
      <!-- zero or one pool_options element
           with one or more option elements
      -->
      <pool_options>
        <option .../>
      </pool_options>
      <!-- zero or one dataset_options element
           with one or more option elements
      -->
      <dataset_options>
        <option .../>
      </dataset_options>
      <!-- zero or one be element
           with zero or one options elements
      -->
      <be>
        <options>
          <option .../>
        </options>
      </be>
    </zpool>
  </logical>
</target>
.fi
.in -2

.sp
.LP
Child elements of the \fBtarget\fR element enable you to specify disks and logical layout.
.sp
.LP
Disk specifications are not applicable when installing a non-global zone and are ignored if provided.
.sp
.LP
Some disk layout elements have a size sub-element. The \fBsize\fR element has the following format:
.sp
.in +2
.nf
<size val="\fIsize\fR" start_sector="\fIstart_sector\fR"/>
.fi
.in -2

.sp
.LP
The \fIstart_sector\fR value is a numeric value that specifies the desired start sector for the new partition or slice. If the \fIstart_sector\fR attribute is omitted, the installer searches for the first location large enough to contain the specified \fIsize\fR.
.sp
.LP
Values for \fIsize\fR are numeric with one of the following suffixes:
.RS +4
.TP
.ie t \(bu
.el o
\fBs\fR or \fBsec\fR: sectors
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBb\fR: bytes
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBk\fR or \fBkb\fR: kilobytes (2^10)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBm\fR or \fBmb\fR: megabytes (2^20)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBg\fR or \fBgb\fR: gigabytes (2^30)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBt\fR or \fBtb\fR: terabytes (2^40)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBp\fR or \fBpb\fR: petabytes (2^50)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBe\fR or \fBeb\fR: exabytes (2^60)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBz\fR or \fBzb\fR: zettabytes (2^70)
.RE
.sp
.LP
The remainder of this section describes the \fBdisk\fR and \fBlogical\fR elements in detail.
.SS "Installation Location"
.sp
.LP
If you do not specify a location for installing the Oracle Solaris OS on a client, AI selects a default location for that client.
.sp
.LP
The default location for the installation is the first disk found on each client that meets the size requirement. If the size of a disk is greater than or equal to the required size, the installer selects that disk as the installation location. If the size of the disk is less than the required size, the installer checks the next disk. If no disk is found that meets the size requirement, the automated installation fails for that client. The install log at \fB/system/volatile/install_log\fR shows the details of the disk selection process for that system.
.sp
.LP
The \fBdisk\fR section of the \fBtarget\fR section specifies the installation location.
.sp
.LP
Disk specifications are not applicable when installing a non-global zone and are ignored if provided.
.sp
.LP
Disks can be selected using one of the following types of selection criteria:
.RS +4
.TP
.ie t \(bu
.el o
Group 1: Deterministic criteria such as disk name or IP address. Use the \fB<disk_name>\fR sub-element as described in "Target Device Name" below or the \fB<iscsi>\fR sub-element as described in "ISCSI Target Device" below.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Group 2: Nondeterministic criteria such as disk size or vendor. Use the \fB<disk_prop>\fR sub-element as described in "Target Device Properties" below.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Group 3: Keyword criteria such as the \fBboot_disk\fR keyword. Use the \fB<disk_keyword>\fR sub-element as described in "Target Device Keyword" below.
.RE
.sp
.LP
You can specify criteria from only one of these three groups. If you use Group 2 selection criteria, you can specify multiple criteria. For example, you can specify both size and vendor. If you use Group 1 selection criteria, you can specify only one of those criteria.
.SS "Target Device Name"
.sp
.LP
Use the \fBdisk_name\fR element to specify the target device name for a device that is not an iSCSI device. The \fBdisk_name\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
The \fBname\fR attribute specifies the name of the target device.
.RE

.sp
.ne 2
.mk
.na
\fB\fBname_type\fR\fR
.ad
.sp .6
.RS 4n
The \fBname_type\fR attribute specifies the type of the target device name. The \fBname_type\fR attribute can have one of the following values:
.sp
.ne 2
.mk
.na
\fB\fBctd\fR: Controller Target Disk Name\fR
.ad
.sp .6
.RS 4n
This is a CTD name such as \fBc0t0d0\fR or \fBc0t2000002037CD9F72d0\fR. This type of name is commonly seen when running the \fBformat\fR(1M) command.
.sp
.in +2
.nf
<disk_name name="c0t0d0" name_type="ctd"/>
.fi
.in -2

This is the default target device name type if the \fBname_type\fR attribute is omitted.
.RE

.sp
.ne 2
.mk
.na
\fB\fBvolid\fR: Volume Identifier\fR
.ad
.sp .6
.RS 4n
This is the volume identifier as can be set by the \fBformat\fR(1M) command.
.sp
.in +2
.nf
<disk_name name="MY_BOOT_DISK" name_type="volid"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBdevpath\fR: Device Path\fR
.ad
.sp .6
.RS 4n
This is the device path relative to the \fB/devices\fR directory.
.sp
.in +2
.nf
<disk_name
  name="/devices/pci@0,0/pci10de,375@f/pci108e,286@0/disk@0,0"
  name_type="devpath"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBdevid\fR: Device Identifier\fR
.ad
.sp .6
.RS 4n
This is the device identifier as found in the "Device Id" in the output from the \fBiostat\fR(1M) command with the \fB-iEn\fR options.
.sp
.in +2
.nf
<disk_name
  name="id1,sd@TSun_____STK_RAID_INT____F0F0F0"
  name_type="devid"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBreceptacle\fR: Receptacle Identifier\fR
.ad
.sp .6
.RS 4n
This is the receptacle value from a CRO (Chassis, Receptacle, Occupant) configuration as found in the output from the \fBcroinfo\fR(1M) command with the \fB-ocR\fR option.
.sp
.in +2
.nf
<disk_name name="SYS/1" name_type="receptacle"/>
.fi
.in -2

.RE

.RE

.SS "ISCSI Target Device"
.sp
.LP
Use the \fBiscsi\fR element to specify an iSCSI disk as the installation target. The \fBiscsi\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBsource\fR\fR
.ad
.sp .6
.RS 4n
The \fBsource\fR attribute specifies the source of the iSCSI configuration data. The \fBsource\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBmanifest\fR\fR
.ad
.sp .6
.RS 4n
This value refers to this AI manifest. This is the default if no value is specified for the \fBsource\fR attribute.
.sp
When the \fBsource\fR attribute is omitted or the value of the \fBsource\fR attribute is \fBmanifest\fR, the \fBtarget_lun\fR and \fBtarget_ip\fR attributes must be specified.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdhcp\fR\fR
.ad
.sp .6
.RS 4n
This value refers to the use of DHCP where the iSCSI information is sourced by specifying the information in the DHCP \fBrootpath\fR parameter.
.sp
When the value of the \fBsource\fR attribute is \fBdhcp\fR, do not specify any other \fBiscsi\fR attributes.
.sp
.in +2
.nf
<iscsi source="dhcp"/>
.fi
.in -2

.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBtarget_ip\fR\fR
.ad
.sp .6
.RS 4n
The value of this attribute is the IP address of the iSCSI target. The target at this IP address must be online and accessible from this system. This attribute is required.
.sp
.in +2
.nf
<iscsi target_lun="0" target_ip="192.168.1.34"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBtarget_lun\fR\fR
.ad
.sp .6
.RS 4n
If an iSCSI target provides more than one LUN, specify which LUN to use by specifying an integer value for \fBtarget_lun\fR. LUN numbers are indexed from 0. To specify the first LUN, specify a \fBtarget_lun\fR value of 0.
.sp
If only one LUN is provided, this attribute can be omitted. If more than one LUN is provided by the iSCSI target, then this attribute is required.
.RE

.sp
.ne 2
.mk
.na
\fB\fBtarget_name\fR\fR
.ad
.sp .6
.RS 4n
The \fBtarget_name\fR attribute specifies the iSCSI Qualified Name (IQN) or the Extended Unique Identifier (EUI) of the iSCSI target, as shown in the following example:
.sp
.in +2
.nf
iqn.1986-03.com.sun:02:a4a694bc-6de2-ee50-8979-e25ba29acb86
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBtarget_port\fR\fR
.ad
.sp .6
.RS 4n
If not specified, the default \fBtarget_port\fR of 3260 (the iSCSI standard port) is used. This attribute enables you to specify an alternative port number.
.RE

.sp
.ne 2
.mk
.na
\fB\fBinitiator_name\fR\fR
.ad
.sp .6
.RS 4n
The \fBinitiator_name\fR attribute specifies the IQN or the EUI of the iSCSI initiator.
.RE

.sp
.ne 2
.mk
.na
\fBCHAP authentication\fR
.ad
.sp .6
.RS 4n
The following two attributes provide CHAP (Challenge-Handshake Authentication Protocol) authentication:
.sp
.ne 2
.mk
.na
\fB\fBchap_name\fR\fR
.ad
.sp .6
.RS 4n
The \fBchap_name\fR attribute specifies the CHAP username to be used for authentication.
.RE

.sp
.ne 2
.mk
.na
\fB\fBchap_password\fR\fR
.ad
.sp .6
.RS 4n
The \fBchap_password\fR attribute specifies the CHAP password to be used for authentication.
.RE

SPARC clients can optionally set \fBchap-user\fR and \fBchap-password\fR at the Open Boot PROM (\fBok\fR) prompt. For more information, see "iSCSI Boot" in the \fBboot\fR(1M) man page.
.RE

.sp
.LP
The \fBiscsi\fR element does not have an \fBaction\fR attribute. AI uses iSCSI devices but does not operate directly on them.
.sp
.LP
If the \fBtarget_name\fR attribute is not provided, AI uses \fBiscsiadm\fR(1M) in \fBsendtargets\fR mode.
.sp
.LP
If the \fBtarget_name\fR attribute is provided, AI uses static discovery.
.sp
.LP
Given this information, the iSCSI device is made available for installation.
.sp
.LP
Because the network interface for the iSCSI device is configured early in the client boot process, you do not need to configure the \fBnetwork/install\fR service for this interface in any system configuration profile file for this installation.
.SS "Target Device Properties"
.sp
.LP
Use the \fBdisk_prop\fR element to specify properties of the target device. Multiple properties can be specified. AI attempts to find a best match based on the criteria provided.
.sp
.LP
Use attributes of the \fBdisk_prop\fR element to specify the target properties. The \fBdisk_prop\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBdev_type\fR: Device Type\fR
.ad
.sp .6
.RS 4n
The type of the target disk. Possible values include SCSI, ATA, and USB. This value is not case sensitive.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdev_vendor\fR: Device Vendor\fR
.ad
.sp .6
.RS 4n
The vendor as shown by the \fBinquiry\fR menu option of the \fBformat\fR(1M) command.
.sp
.in +2
.nf
<disk_prop dev_vendor="Sun"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBdev_chassis\fR: Device Chassis\fR
.ad
.sp .6
.RS 4n
The chassis value from a CRO (Chassis, Receptacle, Occupant) configuration as found in the output from the \fBcroinfo\fR(1M) command with the \fB-ocA\fR option.
.sp
.in +2
.nf
<disk_prop dev_chassis="SYS"/>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBdev_size\fR: Device Size\fR
.ad
.sp .6
.RS 4n
The minimum size for the disk. The value is a number with a size unit.
.sp
.in +2
.nf
<disk_prop dev_size="100gb"/>
.fi
.in -2

.RE

.sp
.LP
The \fBdisk_prop\fR element allows specification of multiple attributes at the same time to further constrain the disk search. The following example limits the selection of a disk to a Hitachi drive with a size of at least 100 GB.
.sp
.in +2
.nf
<disk_prop dev_vendor="HITACHI" dev_size="100gb"/>
.fi
.in -2

.SS "Target Device Keyword"
.sp
.LP
The \fBdisk_keyword\fR element can be used to specify the system's boot disk as the target disk.
.sp
.in +2
.nf
<disk_keyword key="boot_disk"/>
.fi
.in -2

.sp
.LP
The only value supported for the \fBkey\fR attribute is \fBboot_disk\fR.
.SS "Whole Disk, Partitions, and Slices"
.sp
.LP
The simplest way to lay out a disk is to use the entire disk for installation by setting the \fBwhole_disk\fR attribute to \fBtrue\fR.
.sp
.LP
For more complex disk layouts, you can specify partitions (for x86 systems only) and slices.
.sp
.LP
The \fBdisk\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBwhole_disk\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBwhole_disk\fR is \fBfalse\fR, partitions or slices must be defined. Any existing partitions or slices are retained unless you remove them by specifying the \fBdelete\fR value for the \fBaction\fR attribute of the partition or slice.
.sp
When \fBwhole_disk\fR is \fBtrue\fR, any existing partitions or slices are removed.
.sp
The following example specifies using the entire disk for installation:
.sp
.in +2
.nf
<disk whole_disk="true">
  <disk_name name="c0t0d0" name_type="ctd"/>
</disk>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBin_zpool\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_zpool\fR attribute links this disk to a ZFS pool defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_zpool\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBzpool\fR element.
.sp
If the \fBin_zpool\fR attribute is specified here, then do not specify \fBin_zpool\fR for any subordinate partitions or slices.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_vdev\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_vdev\fR attribute links this disk to a virtual device defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_vdev\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBvdev\fR element.
.sp
If the \fBin_vdev\fR attribute is specified here, then do not specify \fBin_vdev\fR for any subordinate partitions or slices.
.RE

.SS "GPT Partitions"
.sp
.LP
GUID Partition Table partitions are the preferred x86 and SPARC partitioning method. GPT partitions are usable directly by ZFS without requiring slices. The \fBgpt_partition\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
The \fBname\fR attribute is the GPT partition number. Values 0-7 are valid for Oracle Solaris.
.sp
The \fBname\fR attribute is required.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a partition. The \fBcreate\fR action tells the installer to create a partition with the specified name. If a partition with the same name already exists, that existing partition is deleted first.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named partition. If the named partition does not exist, the \fBdelete\fR action is skipped and a warning message is output.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named partition untouched. This action is commonly used if another operating system is installed at another location on the same disk.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBpart_type\fR\fR
.ad
.sp .6
.RS 4n
The \fBpart_type\fR attribute specifies the GUID partition type. The value can be a supported GUID alias, such as \fBsolaris\fR, or an explicit GUID hexadecimal string value.
.sp
The \fBpart_type\fR attribute is required.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_zpool\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_zpool\fR attribute links this partition to a ZFS pool defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_zpool\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBzpool\fR element.
.sp
If the \fBin_zpool\fR attribute is specified, then do not specify \fBin_zpool\fR for the associated \fBdisk\fR element or any subordinate \fBslice\fR elements.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_vdev\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_vdev\fR attribute links this partition to a virtual device defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_vdev\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBvdev\fR element.
.sp
If the \fBin_vdev\fR attribute is specified, then do not specify \fBin_vdev\fR for the associated \fBdisk\fR element or any subordinate \fBslice\fR elements.
.RE

.sp
.LP
GPT partitions can have a \fBsize\fR sub-element to specify the size of the partition. See the beginning of the "Disk Layout" section for details about how to use the \fBsize\fR element. If you specify a size for the partition, the \fBsize\fR sub-element must precede any \fBslice\fR sub-element in the \fBpartition\fR element.
.SS "Legacy Partitions"
.sp
.LP
Legacy \fBfdisk\fR partitions can only be specified when installing to an x86 system. If \fBfdisk\fR partitions are specified for a SPARC system, the installation fails. The \fBpartition\fR element is used for \fBfdisk\fR partitions. The \fBpartition\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
The \fBname\fR attribute is the \fBfdisk\fR partition number. Values 1, 2, 3, and 4 are primary partitions. If one of the primary partitions is an extended partition, values 5 through 32 can be specified for logical partitions.
.sp
The \fBname\fR attribute is required unless the specified \fBaction\fR is \fBuse_existing_solaris2\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a partition. The \fBcreate\fR action tells the installer to create a partition with the specified name. If a partition with the same name already exists, that existing partition is deleted first.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named partition. If the named partition does not exist, the \fBdelete\fR action is skipped and a warning message is output.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named partition untouched. This action is commonly used if another operating system is installed at another location on the same disk.
.RE

.sp
.ne 2
.mk
.na
\fB\fBuse_existing_solaris2\fR\fR
.ad
.sp .6
.RS 4n
The \fBuse_existing_solaris2\fR action tells the installer to use an existing Solaris2 partition. The installer searches for the existing Solaris2 partition.
.sp
When \fBuse_existing_solaris2\fR is specified, the \fBname\fR and \fBpart_type\fR attributes are ignored.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBpart_type\fR\fR
.ad
.sp .6
.RS 4n
The \fBpart_type\fR is the \fBfdisk\fR partition type. The default value is 191, which is the partition type for a Solaris2 partition. See the \fBfdisk\fR(1M) man page for more information about possible partition types.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_zpool\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_zpool\fR attribute links this partition to a ZFS pool defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_zpool\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBzpool\fR element.
.sp
If the \fBin_zpool\fR attribute is specified, then do not specify \fBin_zpool\fR for the associated \fBdisk\fR element or any subordinate \fBslice\fR elements.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_vdev\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_vdev\fR attribute links this partition to a virtual device defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_vdev\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBvdev\fR element.
.sp
If the \fBin_vdev\fR attribute is specified, then do not specify \fBin_vdev\fR for the associated \fBdisk\fR element or any subordinate \fBslice\fR elements.
.RE

.sp
.LP
Partitions can have a \fBsize\fR sub-element to specify the size of the partition. See the beginning of the "Disk Layout" section for details about how to use the \fBsize\fR element. If you specify a size for the partition, the \fBsize\fR sub-element must precede any \fBslice\fR sub-element in the \fBpartition\fR element.
.sp
.LP
The following example creates a 10 GB Solaris2 partition using default attribute values:
.sp
.in +2
.nf
<disk>
  <disk_name name="c0t0d0" name_type="ctd"/>
  <partition name="1">
    <size val="10gb"/>
  </partition>
</disk>
.fi
.in -2

.sp
.LP
If the size is not specified, the size of the parent element is used.
.sp
.LP
The \fBpreserve\fR, \fBdelete\fR, and \fBuse_existing_solaris2\fR actions do not need a \fBsize\fR specification.
.SS "Slices"
.sp
.LP
For an x86 system, slices must be contained within a partition definition.
.sp
.LP
The \fBslice\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
The \fBname\fR attribute is the slice number. The value can be 0 through 7.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a slice. The \fBcreate\fR action tells the installer to create a slice with the specified name. If a slice with the same name already exists, that existing slice is deleted first.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named slice. If the named slice does not exist, the \fBdelete\fR action is skipped and a warning message is output.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named slice untouched. This action is commonly used when data exists from a previous installation.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBis_swap\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBis_swap\fR is \fBfalse\fR, the installer creates a swap volume in the root pool.
.sp
When \fBis_swap\fR is \fBtrue\fR, the named slice is used as a swap device. When \fBis_swap\fR is \fBtrue\fR, do not use the \fBin_zpool\fR or \fBin_vdev\fR attributes.
.RE

.sp
.ne 2
.mk
.na
\fB\fBforce\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR.
.sp
When \fBforce\fR is \fBtrue\fR, the installer ignores any existing slice that might already be in use (for example, a slice that is used in an existing ZFS storage pool) and continues to perform the specified action on the named slice.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_zpool\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_zpool\fR attribute links this slice to a ZFS pool defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_zpool\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBzpool\fR element.
.sp
If the \fBin_zpool\fR attribute is specified, then do not specify \fBin_zpool\fR for the associated \fBpartition\fR or \fBdisk\fR elements.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_vdev\fR\fR
.ad
.sp .6
.RS 4n
The \fBin_vdev\fR attribute links this slice to a virtual device defined in the \fBlogical\fR section of the AI manifest. The value of the \fBin_vdev\fR attribute must match the value of the \fBname\fR attribute of the corresponding \fBvdev\fR element.
.sp
If the \fBin_vdev\fR attribute is specified, then do not specify \fBin_vdev\fR for the associated \fBpartition\fR or \fBdisk\fR elements.
.RE

.sp
.LP
Slices can have a \fBsize\fR sub-element to specify the size of the slice. See the beginning of the "Disk Layout" section for details about how to use the \fBsize\fR element. If the size is not specified, the size of the parent element is used.
.sp
.LP
The following example creates a 20 GB slice using default attribute values and a 4 GB swap slice for a SPARC system:
.sp
.in +2
.nf
<disk>
  <disk_name name="c0t0d0" name_type="ctd"/>
  <slice name="0">
    <size val="20gb"/>
  </slice>
  <slice name="1" is_swap="true">
    <size val="4gb"/>
  </slice>
</disk>
.fi
.in -2

.sp
.LP
The following example is the same example for an x86 system:
.sp
.in +2
.nf
<disk>
  <disk_name name="c0t0d0" name_type="ctd"/>
  <partition name="1">
    <slice name="0">
      <size val="20gb"/>
    </slice>
    <slice name="1" is_swap="true">
      <size val="4gb"/>
    </slice>
  </partition>
</disk>
.fi
.in -2

.SS "Swap and Dump"
.sp
.LP
A swap slice can be explicitly defined by setting the \fBis_swap\fR attribute of the \fBslice\fR element to \fBtrue\fR, as shown in "Slices" above.
.sp
.LP
A volume in a pool can be explicitly defined as a swap volume or a dump volume by setting the \fBuse\fR attribute of the \fBzvol\fR element to \fBswap\fR or \fBdump\fR, as shown in "ZFS Volumes" below.
.sp
.LP
By default, a swap volume and a dump volume are automatically created if space is available.
.sp
.LP
On low memory systems, a swap slice can be preferable to a swap volume since volumes incur a small memory overhead.
.sp
.LP
If you want to explicitly specify swap or dump and do not want swap or dump volumes automatically created, set the following attributes of the \fBlogical\fR element to \fBtrue\fR:
.sp
.ne 2
.mk
.na
\fB\fBnoswap\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBnoswap\fR is \fBfalse\fR, if space allows, the installer automatically creates a swap volume in the root pool.
.sp
When \fBnoswap\fR is \fBtrue\fR, no swap volume is automatically created.
.RE

.sp
.ne 2
.mk
.na
\fB\fBnodump\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBnodump\fR is \fBfalse\fR, if space allows, the installer automatically creates a dump volume in the root pool.
.sp
When \fBnodump\fR is \fBtrue\fR, no dump volume is automatically created.
.RE

.SS "ZFS Storage Pools"
.sp
.LP
Use the \fBlogical\fR section of the \fBtarget\fR section to specify any number of ZFS storage pools.
.sp
.LP
Multiple pools can be defined by using the \fBzpool\fR sub-element of the \fBlogical\fR element. Only one of these pools can be the root pool. The installation fails if multiple root pools are defined.
.sp
.LP
If a \fBzpool\fR element defines a root pool, and no target disks, partitions (GPT or \fBfdisk\fR), or slices are specified in the AI manifest, then the installer selects a target as described in "Installation Location" above. This selection is automatically assigned to the root pool.
.sp
.LP
If target disks, partitions (GPT or \fBfdisk\fR), or slices are specified in the AI manifest, then the \fBzpool\fR must be associated with at least one of these disks, partitions (GPT or \fBfdisk\fR), or slices. To make this association, use the \fBin_zpool\fR attribute of the \fBdisk\fR element, the \fBgpt_partition\fR element, the \fBpartition\fR element, or the \fBslice\fR element.
.sp
.LP
The \fBzpool\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
This is the name of the new pool. This value must be a name that can be passed to the \fBzpool create\fR command.
.sp
This name could be used as the value of an \fBin_zpool\fR attribute of a \fBdisk\fR, \fBgpt_partition\fR, \fBpartition\fR, or \fBslice\fR element to define that disk, GPT partition, \fBfdisk\fR partition, or slice as a constituent device in the \fBzpool\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a \fBzpool\fR. The \fBcreate\fR action tells the installer to create a pool with the specified name.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named pool.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named pool unmodified. This action can be specified only for a non-root pool.
.sp
.LP
The value of the \fBaction\fR attribute must be \fBpreserve\fR in the following cases:
.RS +4
.TP
.ie t \(bu
.el o
The value of the \fBaction\fR attribute of any subordinate \fBfilesystem\fR is \fBpreserve\fR.
.RE
.RS +4
.TP
.ie t \(bu
.el o
The value of the \fBaction\fR attribute of any subordinate \fBzvol\fR is \fBpreserve\fR.
.RE
.RS +4
.TP
.ie t \(bu
.el o
The value of the \fBaction\fR attribute of any subordinate \fBzvol\fR is \fBuse_existing\fR.
.RE
.RE

.sp
.ne 2
.mk
.na
\fB\fBuse_existing\fR\fR
.ad
.sp .6
.RS 4n
The \fBuse_existing\fR action tells the installer to install to the existing root pool. Any existing volumes or file systems (datasets) are retained.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBis_root\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBis_root\fR is \fBfalse\fR, a data pool is defined.
.sp
When \fBis_root\fR is \fBtrue\fR, the new boot environment is created in the named pool.
.RE

.sp
.ne 2
.mk
.na
\fB\fBmountpoint\fR\fR
.ad
.sp .6
.RS 4n
The \fBmountpoint\fR attribute specifies the mount point of the top level file system of the pool. The default mount point is \fB/\fIpoolname\fR\fR. The mount point must be an absolute path.
.RE

.sp
.LP
To set ZFS properties on the new pool, use the \fBpool_options\fR element. Similarly, to set ZFS properties on the automatically created ZFS dataset, use the \fBdataset_options\fR element. Both the \fBpool_options\fR and \fBdataset_options\fR elements have an \fBoption\fR sub-element. Each \fBoption\fR element has a \fBname\fR attribute and a \fBvalue\fR attribute. The properties set with these name/value pairs are subject to the same restrictions that the \fBzpool\fR(1M) command enforces. The following example shows how to set these properties:
.sp
.in +2
.nf
<logical>
  <zpool name="rpool" is_root="true">
    <pool_options>
      <option name="listsnaps" value="on"/>
      <option name="delegation" value="off"/>
    </pool_options>
    <dataset_options>
      <option name="atime" value="on"/>
      <option name="compression" value="on"/>
    </dataset_options>
  </zpool>
</logical>
.fi
.in -2

.sp
.LP
Any number of virtual device redundancy groups (\fBvdev\fR element), ZFS datasets (\fBfilesystem\fR element), or ZFS volumes (\fBzvol\fR element) can be defined for a pool. Boot environments (\fBbe\fR element) can be specified for a pool. The following sections describe the \fBvdev\fR, \fBfilesystem\fR, \fBzvol\fR, and \fBbe\fR elements.
.SS "Virtual Device Redundancy Groups"
.sp
.LP
Use the \fBvdev\fR element to define the size or structure of a \fBzpool\fR. You can specify multiple \fBvdev\fR elements, each with a different redundancy type.
.sp
.LP
If a \fBzpool\fR contains more than one \fBvdev\fR element, then you must use the \fBin_vdev\fR attribute on any \fBdisk\fR, \fBgpt_partition\fR, \fBpartition\fR, or \fBslice\fR elements that are defined with \fBin_zpool\fR attributes.
.sp
.LP
You can omit the \fBin_zpool\fR attribute on a disk, GPT partition, \fBfdisk\fR partition, or slice if the \fBvdev\fR name is unique throughout the AI manifest.
.sp
.LP
If a \fBzpool\fR contains only one \fBvdev\fR element, you can omit the \fBin_vdev\fR attribute on a \fBdisk\fR, \fBgpt_partition\fR, \fBpartition\fR, or \fBslice\fR.
.sp
.LP
The \fBvdev\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
This is the name of the new \fBvdev\fR.
.sp
This name should be used as the value of an \fBin_vdev\fR attribute of a \fBdisk\fR, \fBgpt_partition\fR, \fBpartition\fR, or \fBslice\fR element to define that disk, partition (GPT or \fBfdisk\fR), or slice as a constituent device in the \fBvdev\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBredundancy\fR\fR
.ad
.sp .6
.RS 4n
The \fBredundancy\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBmirror\fR\fR
.ad
.sp .6
.RS 4n
This is the default value. When \fBredundancy\fR is \fBmirror\fR or is not specified, all devices contained are considered to be mirrors of each other.
.RE

.sp
.ne 2
.mk
.na
\fB\fBraidz\fR, \fBraidz1\fR, \fBraidz2\fR, \fBraidz3\fR\fR
.ad
.sp .6
.RS 4n
Devices in a group with one of these values are used to define a RAIDZ grouping.
.RE

.sp
.ne 2
.mk
.na
\fB\fBspare\fR\fR
.ad
.sp .6
.RS 4n
Devices in this group are seen as hot spares in case of failure.
.RE

.sp
.ne 2
.mk
.na
\fB\fBcache\fR\fR
.ad
.sp .6
.RS 4n
Devices in this group provide caching for the pool.
.RE

.sp
.ne 2
.mk
.na
\fB\fBlog\fR, \fBlogmirror\fR\fR
.ad
.sp .6
.RS 4n
Devices in this group are used for logging. If \fBlogmirror\fR is specified, the devices are mirrors.
.RE

.sp
.ne 2
.mk
.na
\fB\fBnone\fR\fR
.ad
.sp .6
.RS 4n
When \fBredundancy\fR is \fBnone\fR, no redundancy is defined. If multiple devices are included in this group, these devices are striped.
.RE

A root pool can be defined as having only one of the following configurations:
.RS +4
.TP
.ie t \(bu
.el o
A \fBredundancy\fR type of \fBnone\fR with one device. Multiple devices are not supported in this configuration.
.RE
.RS +4
.TP
.ie t \(bu
.el o
A \fBredundancy\fR type of \fBmirror\fR with multiple devices.
.RE
.RE

.sp
.LP
To add a device to a \fBvdev\fR, use the \fBin_zpool\fR and \fBin_vdev\fR attributes of a \fBdisk\fR, \fBgpt_partition\fR, \fBpartition\fR, or \fBslice\fR element. The following example specifies a root pool named \fBrpool\fR that is mirrored over two disks:
.sp
.in +2
.nf
<disk whole_disk="true" in_zpool="rpool" in_vdev="mirrored">
  <disk_name name="c0t0d0" name_type="ctd"/>
</disk>
<disk whole_disk="true" in_zpool="rpool" in_vdev="mirrored">
  <disk_name name="c1t0d0" name_type="ctd"/>
</disk>
<logical>
  <zpool name="rpool" is_root="true">
    <vdev name="mirrored" redundancy="mirror"/>
  </zpool>
</logical>
.fi
.in -2

.sp
.LP
You can omit one of the \fBin_zpool\fR or \fBin_vdev\fR attributes if the pool or virtual device they refer to is unambiguous.
.SS "File Systems (Datasets)"
.sp
.LP
Use the \fBfilesystem\fR element to define ZFS file systems or datasets within a ZFS pool.
.sp
.LP
The \fBfilesystem\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
This is the name of the new \fBfilesystem\fR, relative to the \fBzpool\fR. For example, if the \fBfilesystem\fR is named \fBexport\fR within a \fBzpool\fR named \fBrpool\fR, the ZFS dataset name is \fBrpool/export\fR.
.sp
If the \fBin_be\fR attribute of the \fBfilesystem\fR is set to \fBtrue\fR, this name is relative to the root dataset of the boot environment.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a \fBfilesystem\fR. The \fBcreate\fR action tells the installer to create a file system with the specified name.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named file system.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named file system unmodified. If \fBpreserve\fR is specified for the \fBfilesystem\fR, then \fBpreserve\fR should be specified for the associated \fBzpool\fR.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBmountpoint\fR\fR
.ad
.sp .6
.RS 4n
The \fBmountpoint\fR attribute specifies the mount point of the new file system. If a mount point is not specified, the file system inherits the mount point from its parent.
.RE

.sp
.ne 2
.mk
.na
\fB\fBin_be\fR\fR
.ad
.sp .6
.RS 4n
The default value of this attribute is \fBfalse\fR. When \fBin_be\fR is \fBfalse\fR, the new dataset is shared among all boot environments.
.sp
When \fBin_be\fR is \fBtrue\fR, a separate copy of this new dataset is created within each boot environment. When \fBin_be\fR is \fBtrue\fR, the value of the \fBname\fR attribute is relative to the root dataset of the boot environment.
.RE

.sp
.LP
Use the \fBoptions\fR sub-element to set the ZFS dataset properties on a \fBfilesystem\fR. Any editable ZFS file system property can be set. Use of the \fBoptions\fR element for a \fBfilesystem\fR is similar to the use of the \fBdataset_options\fR element for a \fBzpool\fR, as shown in the following example:
.sp
.in +2
.nf
<logical>
  <zpool name="rpool" is_root="true">
    <filesystem name="export">
      <options>
        <option name="compression" value="off"/>
        <option name="dedup" value="on"/>
      <options>
    </filesystem>
  </zpool>
</logical>
.fi
.in -2

.sp
.LP
A child \fBfilesystem\fR inherits any property set on a parent \fBfilesystem\fR unless that property is explicitly set differently. This is the default behavior of ZFS file systems.
.SS "ZFS Volumes"
.sp
.LP
Use the \fBzvol\fR element to define ZFS volumes within a ZFS pool. A \fBzvol\fR is typically used for swap or dump devices, but it can have other uses.
.sp
.LP
The \fBzvol\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.sp .6
.RS 4n
This is the name of the new ZFS volume.
.RE

.sp
.ne 2
.mk
.na
\fB\fBaction\fR\fR
.ad
.sp .6
.RS 4n
The \fBaction\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBcreate\fR\fR
.ad
.sp .6
.RS 4n
This is the default action for a \fBzvol\fR. The \fBcreate\fR action tells the installer to create a ZFS volume with the specified name.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.sp .6
.RS 4n
The \fBdelete\fR action tells the installer to delete the named volume.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpreserve\fR\fR
.ad
.sp .6
.RS 4n
The \fBpreserve\fR action tells the installer to leave the named \fBzvol\fR unmodified. If \fBpreserve\fR is specified for the \fBzvol\fR, then \fBpreserve\fR should be specified for the associated \fBzpool\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBuse_existing\fR\fR
.ad
.sp .6
.RS 4n
If this value is specified for a swap or dump device, the existing volume is reused. If \fBuse_existing\fR is specified for the \fBzvol\fR, then \fBpreserve\fR should be specified for the associated \fBzpool\fR.
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fBuse\fR\fR
.ad
.sp .6
.RS 4n
The \fBuse\fR attribute can have the following values:
.sp
.ne 2
.mk
.na
\fB\fBnone\fR\fR
.ad
.sp .6
.RS 4n
This is the default value. When \fBuse\fR is \fBnone\fR, the \fBzvol\fR is created but not used during the installation.
.RE

.sp
.ne 2
.mk
.na
\fB\fBswap\fR\fR
.ad
.sp .6
.RS 4n
When \fBuse\fR is \fBswap\fR, the \fBzvol\fR is created and used as a swap device. The \fBzvol\fR is also used as a swap device during the installation. The \fBsize\fR sub-element of the \fBzvol\fR element can have the value \fBmax\fR. When the \fBmax\fR keyword is specified, the size of the volume will be 90% of the free space on the pool on which the volume is created. Only one volume on a pool can specify a size of \fBmax\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdump\fR\fR
.ad
.sp .6
.RS 4n
When \fBuse\fR is \fBdump\fR, the \fBzvol\fR is created and used as a dump device. The \fBzvol\fR is also used as a dump device during the installation.
.RE

.RE

.sp
.LP
Use the \fBsize\fR sub-element to specify the size of the volume. See the beginning of the "Disk Layout" section for details about how to use the \fBsize\fR element. If you specify a size for the volume, the \fBsize\fR sub-element must follow any \fBoptions\fR sub-element in the \fBzvol\fR element, as shown in the example below.
.sp
.LP
Use the \fBoptions\fR sub-element to set ZFS volume options on a \fBzvol\fR. Use of the \fBoptions\fR element for a \fBzvol\fR is similar to the use of the \fBdataset_options\fR element for a \fBzpool\fR, as shown in the following example:
.sp
.in +2
.nf
<logical>
  <zpool name="rpool" is_root="true">
    <zvol name="swap">
      <options>
        <option name="compression" value="off"/>
      <options>
      <size val="8gb"/>
    </zvol>
  </zpool>
</logical>
.fi
.in -2

.SS "Boot Environments"
.sp
.LP
Use the \fBbe\fR element to specify how the boot environment is created during the installation.
.sp
.LP
The \fBbe\fR element has one attribute:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.RS 8n
.rt  
This is the name of the new boot environment that is created by the installer. If the \fBbe\fR element is not specified, the default name for this boot environment is \fBsolaris\fR.
.RE

.sp
.LP
The installer makes use of the auto-naming feature provided by the boot environment subsystem. When installing into an existing target area (for example, when installing a zone), a boot environment with the name specified by the \fBbe\fR element \fBname\fR attribute might already exist. If the specified boot environment name already exists, this name is used as a base to generate a new name. For example, if \fBbe\fR is not specified, and a boot environment named \fBsolaris\fR already exists, the new boot environment is named \fBsolaris-\fIn\fR\fR, where \fIn\fR is the first integer in counting order that forms a boot environment name that does not already exist.
.sp
.LP
A boot environment is created as a ZFS dataset and can have ZFS properties set on it. Use the \fBoptions\fR sub-element to set ZFS properties on a boot environment, as shown in the following example:
.sp
.in +2
.nf
<logical>
  <zpool name="rpool" is_root="true">
    <be name="installed_be">
      <options>
        <option name="compression" value="on"/>
        <option name="dedup" value="on"/>
      <options>
    </be>
  </zpool>
</logical>
.fi
.in -2

.SH SOFTWARE
.sp
.LP
The \fBsoftware\fR element specifies software to install. The \fBsoftware\fR section specifies the following information:
.RS +4
.TP
.ie t \(bu
.el o
The type of the software source
.RE
.RS +4
.TP
.ie t \(bu
.el o
The location of the source
.RE
.RS +4
.TP
.ie t \(bu
.el o
The names of software packages to install or uninstall
.RE
.RS +4
.TP
.ie t \(bu
.el o
Optional components of software to install
.RE
.RS +4
.TP
.ie t \(bu
.el o
Image properties
.RE
.RS +4
.TP
.ie t \(bu
.el o
SSL keys and certificates required to access the IPS repository
.RE
.sp
.LP
The \fBsoftware\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.RS 8n
.rt  
This is the name of the \fBsoftware\fR instance. This name must be unique among all \fBsoftware\fR instances in this AI manifest.
.RE

.sp
.ne 2
.mk
.na
\fB\fBtype\fR\fR
.ad
.RS 8n
.rt  
This is the type of the software source.
.sp
.LP
The \fBtype\fR attribute can have one of the following values. The default value if \fBtype\fR is not specified is \fBIPS\fR.
.RS +4
.TP
.ie t \(bu
.el o
\fBIPS\fR: IPS package repository
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBP5I\fR: IPS package file
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBSVR4\fR: SVR4 packages
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fBCPIO\fR: \fBcpio\fR archive
.RE
.RE

.sp
.LP
The \fBsoftware\fR element has the following structure:
.sp
.in +2
.nf
<!-- one or more software elements -->
<software>
  <!-- zero or one destination element
       Only used when type is IPS or P5I.
  -->
  <destination>
    <!-- image properties and
         optional software components
    -->
  </destination>
  <!-- zero or one source element -->
  <source>
    <!-- one or more publisher or dir elements
         IPS, P5I, and SVR4 types:
             one or more publisher/origin elements
         CPIO types: one or more dir elements
        -->
  </source>
  <!-- zero or more software_data elements
       At least one software_data element must have
           an action of install.
       P5I type: zero software_data elements
  -->
  <software_data>
    <!-- one or more name elements -->
    <name>...</name>
  </software_data>
</software>
.fi
.in -2

.SS "IPS Installations"
.sp
.LP
The default installation type if the \fBtype\fR attribute is not specified is \fBIPS\fR.
.sp
.LP
Use the \fBsource\fR element to specify which publishers to use for installing the packages. In the \fBpublisher\fR element, the \fBname\fR attribute is required, and at least one \fBorigin\fR sub-element is required.
.sp
.LP
Multiple publishers can be specified in one \fBsource\fR element. Each publisher must have at least one origin. Each publisher can have multiple origins and mirrors.
.sp
.LP
The order in which publishers are defined in the AI manifest is the order in which the publishers are searched for IPS packages to install and the order in which the publishers are set in the installed image.
.sp
.LP
When installing a non-global zone, the system repository is used by the zone. Any publishers specified in the AI manifest are added in the order in which they appear in the AI manifest, after the publishers provided by the system repository. See the \fBpkg\fR(1) and \fBpkg.sysrepo\fR(1M) man pages for more information about the system repository.
.sp
.LP
The following example specifies multiple publishers, one of which has a mirror as well as an origin:
.sp
.in +2
.nf
<software type="IPS">
  <source>
    <publisher name="solaris">
      <origin name="http://pkg.oracle.com/solaris/release"/>
      <mirror name="http://localpkg.mycompany.com/solaris"/>
    </publisher>
    <publisher name="internal-software">
      <origin name="http://internalsoft.mycompany.com/"/>
    </publisher>
  </source>
</software>
.fi
.in -2

.sp
.LP
Use the \fBsoftware_data\fR element to specify packages to install, reject, avoid, unavoid, or uninstall. The \fBaction\fR attribute of the \fBsoftware_data\fR element can have one of the following values:
.sp
.ne 2
.mk
.na
\fB\fBinstall\fR\fR
.ad
.sp .6
.RS 4n
Installs the IPS packages specified in the \fBname\fR sub-elements. This is the default if the \fBaction\fR attribute is not specified. At least one \fBsoftware_data\fR element must have an \fBaction\fR of \fBinstall\fR.
.sp
By default, the newest version of a named package available from the specified sources and compatible with other packages in the image is installed. To install other versions of a package, use the version string in the package FMRI. For example, \fBpkg:/[email protected]\fR is more precise than \fBpkg:/mypkg\fR. If the specified version is not compatible with other packages in the image, the installation fails. If the specified version is not available from any of the specified sources, the installation fails. Use the keyword \fBlatest\fR (for example, \fBpkg:/mypkg@latest\fR) to install the newest version available from the specified sources that is compatible with other packages in the image.
.sp
Packages specified in \fBname\fR sub-elements might install other packages that are not explicitly named. If one of those packages is a package that you do not want to install, you can specify the name of the package that you do not want to install in a \fBreject\fR sub-element.
.sp
The \fBreject\fR sub-element only applies to the \fBinstall\fR section in which the \fBreject\fR sub-element appears. If a package is the value of a \fBreject\fR sub-element in one \fBinstall\fR section, but is only installed in a different \fBinstall\fR section, then the package is installed and not rejected.
.sp
Rejected packages that are the target of group dependencies are placed on the avoid list. See the \fBavoid\fR action below.
.RE

.sp
.ne 2
.mk
.na
\fB\fBavoid\fR\fR
.ad
.sp .6
.RS 4n
Adds the IPS packages in the \fBname\fR sub-elements to the avoid list.
.sp
Packages on the avoid list are not installed if they are the target of a group dependency.
.sp
Packages on the avoid list are installed if they are the target of a require dependency. If that require dependency is removed (for example, the package that contains the require dependency is uninstalled), the avoided package is uninstalled.
.sp
Only packages that are not currently installed can be avoided. Therefore, \fBavoid\fR sections must come before the \fBinstall\fR sections where you install the packages that have dependencies on the packages you want to avoid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBunavoid\fR\fR
.ad
.sp .6
.RS 4n
Removes the IPS packages in the \fBname\fR sub-elements from the avoid list.
.RE

.sp
.ne 2
.mk
.na
\fB\fBuninstall\fR\fR
.ad
.sp .6
.RS 4n
Removes the IPS packages specified in the \fBname\fR sub-elements. Uninstalled packages that are the target of group dependencies are placed on the avoid list. See the \fBavoid\fR action above.
.RE

.sp
.LP
Any avoid list created during the installation continues to exist in the installed image.
.sp
.LP
The following example illustrates the use of \fBsoftware_data\fR sections with different \fBaction\fR values in a \fBsoftware\fR section of type IPS:
.sp
.in +2
.nf
<software_data action="avoid">
  <name>pkg:/to/avoid</name>
</software_data>
<software_data action="install">
  <name>pkg:/to/install</name>
  <reject>pkg:/to/reject</reject>
</software_data>
<software_data action="uninstall">
  <name>pkg:/unwanted/pkg</name>
</software_data>
.fi
.in -2

.SS "P5I Installations"
.sp
.LP
A \fB\&.p5i\fR file is a file that describes IPS publishers, packages, and possibly mirrors.
.sp
.LP
To specify one or more \fB\&.p5i\fR files to be processed, provide the files as origins in the \fBpublisher\fR element, as shown in the following example:
.sp
.in +2
.nf
<software type="P5I">
  <source>
    <publisher>
      <origin name="/somewhere/image1.p5i"/>
      <origin name="/somewhere/image2.p5i"/>
    </publisher>
  </source>
</software>
.fi
.in -2

.sp
.LP
If this AI manifest does not also have an IPS type software section, make sure your \fB\&.p5i\fR files specify origins.
.sp
.LP
Specification of packages to install is not supported for P5I installations. Therefore, \fBsoftware_data\fR elements are not supported in a \fBsoftware\fR element of type \fBP5I\fR.
.SS "SVR4 Installations"
.sp
.LP
For a SVR4 transfer, a directory containing SVR4 package subdirectories or a SVR4 package datastream file must be specified using a file directory path or a FILE URI. The SVR4 package datastream file can also be specified using an HTTP URI. 
.sp
.in +2
.nf
<software type="SVR4">
  <source>
    <publisher>
      <origin name="/somedir"/>
    </publisher>
  </source>
</software>
.fi
.in -2

.sp
.LP
The \fBsoftware_data\fR element is used to specify the action to be performed. The \fBaction\fR attribute can have one of the following two values:
.sp
.ne 2
.mk
.na
\fB\fBinstall\fR\fR
.ad
.sp .6
.RS 4n
Copies the files from the source to the new boot environment. This is the default if the \fBaction\fR attribute is not specified. At least one \fBsoftware_data\fR element must have an action of install.
.RE

.sp
.ne 2
.mk
.na
\fB\fBuninstall\fR\fR
.ad
.sp .6
.RS 4n
Removes the files from the new boot environment.
.RE

.sp
.LP
For each of these actions, one or more packages can be specified in the \fBname\fR element, as shown in the following example:
.sp
.in +2
.nf
<software type="SVR4">
  <source>
    <publisher>
      <origin name="/somedir"/>
    </publisher>
  </source>
  <software_data> <!-- defaults to install action -->
    <name>ORGpackage1</name>
    <name>ORGpackage2</name>
  </software_data>
  <software_data action="uninstall">
    <name>ORGpackage8</name>
  </software_data>
</software>
.fi
.in -2

.SS "CPIO Installations"
.sp
.LP
For a CPIO transfer, a source directory must be specified. The destination directory is set to the mount point for the new boot environment during the installation.
.sp
.in +2
.nf
<software type="CPIO">
  <source>
    <dir path="/somedir"/>
  </source>
</software>
.fi
.in -2

.sp
.LP
The \fBsoftware_data\fR element is used to specify the action to be performed. The \fBaction\fR attribute can have one of the following values:
.sp
.ne 2
.mk
.na
\fB\fBinstall\fR\fR
.ad
.sp .6
.RS 4n
Copies the files from the source to the new boot environment. This is the default if the \fBaction\fR attribute is not specified. At least one \fBsoftware_data\fR element must have an action of install.
.sp
Use the \fBname\fR element to specify the files or directories to be copied. Paths specified in the \fBname\fR element are relative to the source.
.sp
.in +2
.nf
<software_data>
  <!-- defaults to install action -->
  <name>path/relative/to/source</name>
  <name>another/path/relative/to/source</name>
</software_data>
.fi
.in -2

.RE

.sp
.ne 2
.mk
.na
\fB\fBuninstall\fR\fR
.ad
.sp .6
.RS 4n
Removes files from the new boot environment.
.sp
Use the \fBname\fR element to specify the files or directories to be removed. Paths specified in the \fBname\fR element are relative to the destination.
.sp
.in +2
.nf
<software_data action="uninstall">
  <name>path/relative/to/destination</name>
</software_data>
.fi
.in -2

.RE

.SS "Optional Software Components and Image Properties"
.sp
.LP
Use the \fBdestination\fR element and the \fBimage\fR sub-element to specify the following information:
.RS +4
.TP
.ie t \(bu
.el o
Optional components of software to install
.RE
.RS +4
.TP
.ie t \(bu
.el o
Image properties
.RE
.RS +4
.TP
.ie t \(bu
.el o
SSL keys and certificates
.RE
.sp
.LP
The \fBdestination\fR section only applies to IPS and P5I installation types. A \fBdestination\fR element can have only one \fBimage\fR sub-element.
.SS "SSL Keys and Certificates"
.sp
.LP
Use attributes of the \fBimage\fR element to specify SSL keys and certificates that are required for publishers using client SSL authentication. The key and certificate specified here apply to the first publisher defined in this AI manifest.
.sp
.ne 2
.mk
.na
\fB\fBssl_key\fR\fR
.ad
.sp .6
.RS 4n
This attribute maps to the following \fBpkg\fR command:
.sp
.in +2
.nf
pkg set-publisher -k \fIssl_key\fR
.fi
.in -2

The value of the \fBssl_key\fR attribute is the \fIssl_key\fR. See the \fBpkg\fR(1) man page for more information about the \fBpkg set-publisher\fR command.
.RE

.sp
.ne 2
.mk
.na
\fB\fBssl_cert\fR\fR
.ad
.sp .6
.RS 4n
This attribute maps to the following \fBpkg\fR command:
.sp
.in +2
.nf
pkg set-publisher -c \fIssl_cert\fR
.fi
.in -2

The value of the \fBssl_cert\fR attribute is the \fIssl_cert\fR.
.RE

.SS "Optional Software Components"
.sp
.LP
Use the \fBfacet\fR sub-element of the \fBimage\fR element to specify optional software components to install. Facets are not separate software packages but are optional components of any given software package such as locales, documentation, and development files such as files with debug information. You can save space by specifying that you only want to install one or two languages, for example. See the \fBpkg\fR(1) man page for more information about IPS facets.
.sp
.LP
The \fBfacet\fR element has a boolean \fBset\fR attribute and a value that is the name of an IPS facet.
.sp
.in +2
.nf
<facet set="true|false">\fIfacet_name\fR</facet>
.fi
.in -2

.sp
.LP
The following example specifies that only German and English facets of packages should be installed. The example first specifies that no locales should be installed and then specifies that German and English locales should be installed:
.sp
.in +2
.nf
<destination>
  <image>
    <!-- de-select all locales -->
    <facet set="false">facet.locale.*</facet>
    <!-- specify specific locales to install -->
    <!-- install German and English only -->
    <facet set="true">facet.locale.de</facet>
    <facet set="true">facet.locale.de_DE</facet>
    <facet set="true">facet.locale.en</facet>
    <facet set="true">facet.locale.en_US</facet>
  </image>
</destination>
.fi
.in -2

.SS "Image Properties"
.sp
.LP
Use the \fBproperty\fR sub-element of the \fBimage\fR element to specify IPS image properties for the new image this installation creates.
.sp
.LP
The \fBproperty\fR element has a boolean \fBval\fR attribute and a value that is the name of a property.
.sp
.in +2
.nf
<property val="true|false">\fIproperty_name\fR</property>
.fi
.in -2

.sp
.LP
See the "Image Properties" section of the \fBpkg\fR(1) man page for information about what properties can be set.
.SH BOOT CONFIGURATION (X86 ONLY)
.sp
.LP
The AI manifest can be used to modify how the GRUB boot menu is configured on the installed system.
.sp
.LP
This section is not applicable to zone installations and is ignored when installing a non-global zone.
.sp
.LP
Use the \fBboot_mods\fR element and the \fBboot_entry\fR sub-element to modify the GRUB boot menu.
.sp
.LP
The \fBboot_mods\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBtitle\fR\fR
.ad
.sp .6
.RS 4n
The value of the \fBtitle\fR attribute is the base title of boot entries specified by \fBboot_entry\fR sub-elements of this \fBboot_mods\fR element. This attribute value overrides the name automatically generated from the first line of \fB/etc/release\fR or from the install media.
.RE

.sp
.ne 2
.mk
.na
\fB\fBtimeout\fR\fR
.ad
.sp .6
.RS 4n
The value of the \fBtimeout\fR attribute is the number of seconds to wait before the default \fBboot_entry\fR of this \fBboot_mods\fR element is selected.
.RE

.sp
.LP
Only the \fBtitle\fR attribute can be set on SPARC systems. All other settings in this section are ignored for SPARC systems.
.sp
.LP
Use the \fBboot_entry\fR sub-element to add one or more menu items to the boot menu. These menu items are in addition to any menu items that are automatically generated by the installer.
.sp
.LP
The \fBboot_entry\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBdefault_entry\fR\fR
.ad
.sp .6
.RS 4n
If this boolean value is set to \fBtrue\fR, then this menu item is the default option selected on boot. The default value of this attribute is \fBfalse\fR.
.sp
If multiple \fBboot_entry\fR elements have \fBdefault_entry\fR set to \fBtrue\fR, then the last such entry is the default option selected on boot.
.RE

.sp
.ne 2
.mk
.na
\fB\fBinsert_at\fR\fR
.ad
.sp .6
.RS 4n
This attribute can be set to one of the following two values:
.sp
.ne 2
.mk
.na
\fB\fBend\fR\fR
.ad
.RS 9n
.rt  
Place the entry at the end of the generated boot menu. This is the default placement.
.RE

.sp
.ne 2
.mk
.na
\fB\fBstart\fR\fR
.ad
.RS 9n
.rt  
Place the entry at the beginning of the generated boot menu.
.RE

.RE

.sp
.LP
The \fBboot_entry\fR menu item is then defined by the following sub-elements:
.sp
.ne 2
.mk
.na
\fB\fBtitle_suffix\fR\fR
.ad
.sp .6
.RS 4n
This element is required. This element defines text to be added to the end of the title specified in the \fBboot_mods\fR element.
.RE

.sp
.ne 2
.mk
.na
\fB\fBkernel_args\fR\fR
.ad
.sp .6
.RS 4n
This element is optional. This element is a string of values passed to the kernel by the boot loader.
.RE

.sp
.LP
The following example specifies a boot menu entry named "Boot Testing Default Boot Entry" that is the last entry on the menu and is automatically selected after 20 seconds:
.sp
.in +2
.nf
<boot_mods title="Boot Testing" timeout="20">
  <boot_entry default_entry="true">
    <title_suffix>Default Boot Entry</title_suffix>
  </boot_entry>
</boot_mods>
.fi
.in -2

.SH OTHER CONFIGURATION
.sp
.LP
The \fBconfiguration\fR element supports non-global zone configurations. When installing a global zone system, the zone configurations specified in the AI manifest are used to install non-global zones onto the system after the global zone has been installed.
.sp
.LP
The \fBconfiguration\fR element has the following attributes:
.sp
.ne 2
.mk
.na
\fB\fBtype\fR\fR
.ad
.RS 10n
.rt  
The type of configuration to install. The only type supported by AI is \fBzone\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBname\fR\fR
.ad
.RS 10n
.rt  
A name given to the configuration. This name must be unique across all configuration elements in an AI manifest. For configurations of type \fBzone\fR, this name is also used as the \fBzonename\fR for the zone.
.RE

.sp
.ne 2
.mk
.na
\fB\fBsource\fR\fR
.ad
.RS 10n
.rt  
The location from which AI downloads the configuration file for this configuration element. The value can be an HTTP or FILE URI specification. For configurations of type \fBzone\fR, this value should point to a zone configuration file as produced from the \fBzonecfg export\fR command.
.RE

.sp
.LP
The following specification installs \fBzone1\fR on the installation clients:
.sp
.in +2
.nf
<configuration type="zone" name="zone1"
  source="http://myserver.com/configs/zone1/config"/>
.fi
.in -2

.sp
.LP
For more information about configuring and installing zones, see Chapter 12, \fIInstalling and Configuring Zones,\fR in \fIInstalling Oracle Solaris 11.1 Systems\fR.
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/usr/share/auto_install/manifest/default.xml\fR\fR
.ad
.sp .6
.RS 4n
A default system installation specification with no customizations. This AI manifest is provided on the system for reference only. To create a new AI manifest, use the copy of this file from the relevant install service image. See the "Description" section for information about copying this file from an install service.
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/share/auto_install/manifest/zone_default.xml\fR\fR
.ad
.sp .6
.RS 4n
A default zone installation with no customization. This file is used as the default manifest by the \fBzoneadm install\fR command to install non-global zones.
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/share/auto_install/manifest/ai_manifest.xml\fR\fR
.ad
.sp .6
.RS 4n
A template AI manifest with details commented out. This file provides examples of some customizations that can be performed. This file is provided on the system for reference only. To create a new AI manifest, use the copy of this file from the relevant install service image. See the "Description" section for information about copying this file from an install service.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(1.38i) |cw(4.13i) 
lw(1.38i) |lw(4.13i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
AvailabilityT{
\fBsystem/install/auto-install/auto-install-common\fR
T}
_
Interface StabilityUncommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBpkg\fR(1), \fBbeadm\fR(1M), \fBboot\fR(1M), \fBcroinfo\fR(1M), \fBfdisk\fR(1M), \fBformat\fR(1M), \fBinstalladm\fR(1M), \fBiostat\fR(1M), \fBiscsiadm\fR(1M), \fBpkg.sysrepo\fR(1M), \fBprtconf\fR(1M), \fBzfs\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M), \fBzpool\fR(1M), \fBgrub\fR(5), \fBsmf\fR(5)
.sp
.LP
Part\ III, \fIInstalling Using an Install Server,\fR in \fIInstalling Oracle Solaris 11.1 Systems\fR