'\" te

.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

.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

The name of this manifest instance.

.RE

.sp

.ne 2

.mk

.na

\fB\fBhttp_proxy\fR\fR

.ad

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

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>

</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>

</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

The \fBname\fR attribute specifies the name of the target device.

.RE

.sp

.ne 2

.mk

.na

\fB\fBname_type\fR\fR

.ad

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

.sp

.in +2

.nf

<disk_name name="SYS/1" name_type="receptacle"/>

.fi

.in -2

.RE