ai_manifest(5) 맨 페이지 - 윈디하나의 솔라나라

분류: 서비스
설명: 맨 페이지 검색 (2016-02-22)
위치: 윈디하나의 솔라나라: ai_manifest(5) 맨 페이지 (처음 오신 분은 윈디하나의 솔라나라 이야기를 읽어주십시오)
윈디하나의 솔라나라 트위터 @solanara

개요

솔라나라에 설명된 어플리케이션에 대해 맨 페이지를 찾아 출력한다.
MAN 페이지에 대한 설명은 윈디하나의 솔라나라: MAN 페이지을 참고하자.
svcadm(8)을 검색하려면 섹션에서 8 을 선택하고, 맨 페이지 이름에 svcadm을 입력하고 검색을 누른다.

ai_manifest(5)

ai_manifest(5) File Formats ai_manifest(5)

NAME
ai_manifest - Automated installation manifest file format

SYNOPSIS
/usr/share/install/ai.dtd.1

DESCRIPTION
Automated Installer (AI) provides a customizable, hands-free installa‐
tion mechanism for Oracle Solaris and uses an XML-based file format as
the description of the installation parameters. This installation para‐
meters file is called an AI manifest. The installation can be cus‐
tomized in various ways such as disk layout and the software to be in‐
stalled on the system.

The AI manifest has the following sections:

o Automated installation settings. Specifies settings used
during the installation.

o Disk layout. Specifies the disk layout for the installation.

o Software. Specifies the software packages to be installed.

o Boot configuration (x86 only). Specifies how to configure
the GRUB boot menu.

o Other configuration. Specifies other configuration compo‐
nents to be installed onto the system.

These sections are described in more detail below.

To create a new AI manifest, use a copy of the template or default man‐
ifest from the relevant install service image. For example, if the in‐
stall service image is located at imagepath, the following files are
available:

imagepath/auto_install/manifest/default.xml

The original default AI manifest for this install service.

imagepath/auto_install/manifest/ai_manifest.xml

An annotated, sample AI manifest with example customizations.

You can use the installadm export command to retrieve a copy of any
manifest that already exists in an install service.

AI manifests are also used for installing non-global zones using the
zoneadm install command. An AI manifest file can be passed to this com‐
mand to customize the zone installation. Only a subset of AI manifest
specifications applies to installing non-global zones. These specifica‐
tions are noted in the sections below.

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.

For more information about install services, AI manifests, and configu‐
ration profiles, see the installadm(8) man page and Automatically In‐
stalling Oracle Solaris 11.4 Systems. For information about the config‐
uration profile file format, see the smf(7) man page.

AUTOMATED INSTALLATION SETTINGS
The ai_instance element has the following attributes:

name

The name of this manifest instance.

http_proxy

The HTTP proxy to use to access remote files during the installa‐
tion. Examples of remote files accessed during installation are
software packages in an Image Packaging System (IPS) package repos‐
itory. The value of http_proxy is an HTTP URI such as
http://myproxy.example.com:8080/.

This attribute is not applicable when installing a non-global zone
and is ignored if provided.

auto_reboot

The flag that specifies whether to automatically reboot after in‐
stallation. The default value of auto_reboot is false. When
auto_reboot is false, the installation waits for manual interven‐
tion to reboot.

When auto_reboot is true, on a successful installation, the machine
automatically reboots into the newly installed boot environment.

This attribute is not applicable when installing a non-global zone
and is ignored if provided.

The following example demonstrates how to use the ai_instance element:

<auto_install>
<ai_instance name='default' auto_reboot='true'
http_proxy='http://myproxy.example.com:8080/'>

</ai_instance>
</auto_install>

DISK LAYOUT
AI enables a range of disk specification, varying from completely auto‐
matic selection of the installation target to fine-grained control of
the disk layout.

The target element specifies the disk layout. The default disk layout
when no target element is specified has the following characteristics:

o The whole of one disk is used to install the Oracle Solaris
OS. This disk is usually the boot disk or first disk.

o For x86 and SPARC with GPT aware firmware, a GPT partition
is allocated that consumes the full disk contents. See the
-B option of the zpool create command in the zpool(8) man
page.

o For SPARC systems that are not capable of using GPT, a sin‐
gle slice 0 that is the full size of the disk is created.

o A single root pool is created that uses either the complete
slice 0 or the complete GPT partition.

o A swap volume and a dump volume are created in the root pool
if space is available.

The target element has the following structure:

<target>

<disk ...>

</disk>

<logical ...>

<zpool ...>

<vdev ...>
</vdev>

<filesystem>
<options>
<option .../>
</options>

<zvol ...>
<options>
<option .../>
</options>
<size val="..."/>
</zvol>

<pool_options>
<option .../>
</pool_options>

<dataset_options>
<option .../>
</dataset_options>

<be>
<options>
<option .../>
</options>
</be>
</zpool>
</logical>
</target>

Child elements of the target element enable you to specify disks and
logical layout.

Disk specifications are not applicable when installing a non-global
zone and are ignored if provided.

Some disk layout elements have a size sub-element. The size element has
the following format:

The start_sector value is a numeric value that specifies the desired
start sector for the new partition or slice. If the start_sector at‐
tribute is omitted, the installer searches for the first location large
enough to contain the specified size.

Values for size are numeric with one of the following suffixes:

o s or sec: sectors

o b: bytes

o k or kb: kilobytes (2^10)

o m or mb: megabytes (2^20)

o g or gb: gigabytes (2^30)

o t or tb: terabytes (2^40)

o p or pb: petabytes (2^50)

o e or eb: exabytes (2^60)

o z or zb: zettabytes (2^70)

The remainder of this section describes the disk and logical elements
in detail.

Installation Location
If you do not specify a location for installing the Oracle Solaris OS
on a client, AI selects a default location for that client.

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 /system/volatile/install_log shows
the details of the disk selection process for that system.

The disk section of the target section specifies the installation loca‐
tion.

Disk specifications are not applicable when installing a non-global
zone and are ignored if provided.

Disks can be selected using one of the following types of selection
criteria:

o Group 1: Deterministic criteria such as disk name or IP ad‐
dress. Use the <disk_name> sub-element as described in "Tar‐
get Device Name" below or the <iscsi> sub-element as de‐
scribed in "ISCSI Target Device" below.

o Group 2: Nondeterministic criteria such as disk size or ven‐
dor. Use the <disk_prop> sub-element as described in "Target
Device Properties" below.

o Group 3: Keyword criteria such as the boot_disk keyword. Use
the <disk_keyword> sub-element as described in "Target De‐
vice Keyword" below.

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 se‐
lection criteria, you can specify only one of those criteria.

Target Device Name
Use the disk_name element to specify the target device name for a de‐
vice that is not an iSCSI device. The disk_name element has the follow‐
ing attributes:

name

The name attribute specifies the name of the target device.

name_type

The name_type attribute specifies the type of the target device
name. The name_type attribute can have one of the following values:

ctd: Controller Target Disk Name

This is a CTD name such as c0t0d0 or c0t2000002037CD9F72d0.
This type of name is commonly seen when running the format(8)
command.

<disk_name name="c0t0d0" name_type="ctd"/>

This is the default target device name type if the name_type
attribute is omitted.

volid: Volume Identifier

This is the volume identifier as can be set by the format(8)
command.

<disk_name name="MY_BOOT_DISK" name_type="volid"/>

devpath: Device Path

This is the device path relative to the /devices directory.

<disk_name
name="/pci@0,0/pci10de,375@f/pci108e,286@0/disk@0,0"
name_type="devpath"/>

devid: Device Identifier

This is the device identifier as found in the "Device Id" in
the output from the iostat(8) command with the -iEn options.

<disk_name
name="id1,sd@TSun_____STK_RAID_INT____F0F0F0"
name_type="devid"/>

receptacle: Receptacle Identifier

This is the receptacle value from a CRO (Chassis, Receptacle,
Occupant) configuration as found in the output from the
diskinfo command with the -ocD option. So if the output is:

# diskinfo -ocD
c:occupant-compdev D:devchassis-path
c0t5000CCA032017268d0 /dev/chassis/SYS/HDD0/disk

We can get the disk name from devchassis-path by removing
"/dev/chassis" from the front and "/disk" at the end.

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

For more information, see the diskinfo(8) man page.

ISCSI Target Device
Use the iscsi element to specify an iSCSI disk as the installation tar‐
get. The iscsi element has the following attributes:

source

The source attribute specifies the source of the iSCSI configura‐
tion data. The source attribute can have the following values:

manifest

This value refers to this AI manifest. This is the default if
no value is specified for the source attribute.

When the source attribute is omitted or the value of the source
attribute is manifest, the target_lun and target_ip attributes
must be specified.

dhcp

This value refers to the use of DHCP where the iSCSI informa‐
tion is sourced by specifying the information in the DHCP root‐
path parameter.

When the value of the source attribute is dhcp, do not specify
any other iscsi attributes.

target_ip

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.

target_lun

If an iSCSI target provides more than one LUN, specify which LUN to
use by specifying an integer value for target_lun. LUN numbers are
indexed from 0. To specify the first LUN, specify a target_lun
value of 0.

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.

target_name

The target_name attribute specifies the iSCSI Qualified Name (IQN)
or the Extended Unique Identifier (EUI) of the iSCSI target, as
shown in the following example:

iqn.1986-03.com.sun:02:a4a694bc-6de2-ee50-8979-e25ba29acb86

target_port

If not specified, the default target_port of 3260 (the iSCSI stan‐
dard port) is used. This attribute enables you to specify an alter‐
native port number.

initiator_name

The initiator_name attribute specifies the IQN or the EUI of the
iSCSI initiator.

CHAP authentication

The following two attributes provide CHAP (Challenge-Handshake Au‐
thentication Protocol) authentication:

chap_name

The chap_name attribute specifies the CHAP username to be used
for authentication.

chap_password

The chap_password attribute specifies the CHAP password to be
used for authentication.

SPARC clients can optionally set chap-user and chap-password at the
Open Boot PROM (ok) prompt. For more information, see "iSCSI Boot"
in the boot(8) man page.

The iscsi element does not have an action attribute. AI uses iSCSI de‐
vices but does not operate directly on them.

If the target_name attribute is not provided, AI uses iscsiadm(8) in
sendtargets mode.

If the target_name attribute is provided, AI uses static discovery.

Given this information, the iSCSI device is made available for instal‐
lation.

Because the network interface for the iSCSI device is configured early
in the client boot process, one should not configure a network/install
interface in an SC profile if iSCSI root is used.

Target Device Properties
Use the disk_prop 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.

Use attributes of the disk_prop element to specify the target proper‐
ties. The disk_prop element has the following attributes:

dev_type: Device Type

The type of the target disk. Possible values include SCSI, ATA, and
USB. This value is not case sensitive.

dev_vendor: Device Vendor

The vendor as shown by the inquiry menu option of the format(8)
command.

<disk_prop dev_vendor="Sun"/>

dev_chassis: Device Chassis

The chassis value from a CRO (Chassis, Receptacle, Occupant) con‐
figuration as found in the output from the diskinfo command with
the -ocD option.

# diskinfo -ocD
c:occupant-compdev D:devchassis-path
c0t5000CCA032017268d0 /dev/chassis/SYS/HDD0/disk

We can get the dev_chassis name from devchassis-path by removing
"/dev/chassis" from the front and "/HDD[#]/disk" at the end.

<disk_prop dev_chassis="/SYS"/>

For more information, see the diskinfo(8) man page.

dev_size: Device Size

The minimum size for the disk. The value is a number with a size
unit.

<disk_prop dev_size="100gb"/>

The disk_prop element allows specification of multiple attributes at
the same time to further constrain the disk search. The following exam‐
ple limits the selection of a disk to a Hitachi drive with a size of at
least 100 GB.

<disk_prop dev_vendor="HITACHI" dev_size="100gb"/>

Target Device Keyword
The disk_keyword element can be used to specify the system's boot disk
as the target disk.

<disk_keyword key="boot_disk"/>

The only value supported for the key attribute is boot_disk.

Whole Disk, Partitions, and Slices
The simplest way to lay out a disk is to use the entire disk for in‐
stallation by setting the whole_disk attribute to true.

For more complex disk layouts, you can specify partitions (for x86 sys‐
tems only) and slices.

The disk element has the following attributes:

whole_disk

The default value of this attribute is false. When whole_disk is
false, partitions or slices must be defined. Any existing parti‐
tions or slices are retained unless you remove them by specifying
the delete value for the action attribute of the partition or
slice.

When whole_disk is true, any existing partitions or slices are re‐
moved.

The following example specifies using the entire disk for installa‐
tion:

in_zpool

The in_zpool attribute links this disk to a ZFS pool defined in the
logical section of the AI manifest. The value of the in_zpool at‐
tribute must match the value of the name attribute of the corre‐
sponding zpool element.

If the in_zpool attribute is specified here, then do not specify
in_zpool for any subordinate partitions or slices.

in_vdev

The in_vdev attribute links this disk to a virtual device defined
in the logical section of the AI manifest. The value of the in_vdev
attribute must match the value of the name attribute of the corre‐
sponding vdev element.

If the in_vdev attribute is specified here, then do not specify
in_vdev for any subordinate partitions or slices.

GPT Partitions
GUID Partition Table partitions are the preferred x86 and SPARC parti‐
tioning method. GPT partitions are usable directly by ZFS without re‐
quiring slices. The gpt_partition element has the following attributes:

name

The name attribute is the GPT partition number. Values 0-7 are
valid for Oracle Solaris.

The name attribute is required.

action

The action attribute can have the following values:

create

This is the default action for a partition. The create 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.

delete

The delete action tells the installer to delete the named par‐
tition. If the named partition does not exist, the delete ac‐
tion is skipped and a warning message is output.

preserve

The preserve action tells the installer to leave the named par‐
tition untouched. This action is commonly used if another oper‐
ating system is installed at another location on the same disk.

part_type

The part_type attribute specifies the GUID partition type. The
value can be a supported GUID alias, such as solaris, or an ex‐
plicit GUID hexadecimal string value.

The part_type attribute is required.

in_zpool

The in_zpool attribute links this partition to a ZFS pool defined
in the logical section of the AI manifest. The value of the
in_zpool attribute must match the value of the name attribute of
the corresponding zpool element.

If the in_zpool attribute is specified, then do not specify
in_zpool for the associated disk element or any subordinate slice
elements.

in_vdev

The in_vdev attribute links this partition to a virtual device de‐
fined in the logical section of the AI manifest. The value of the
in_vdev attribute must match the value of the name attribute of the
corresponding vdev element.

If the in_vdev attribute is specified, then do not specify in_vdev
for the associated disk element or any subordinate slice elements.

GPT partitions can have a size sub-element to specify the size of the
partition. See the beginning of the "Disk Layout" section for details
about how to use the size element. If you specify a size for the parti‐
tion, the size sub-element must precede any slice sub-element in the
partition element.

Legacy Partitions
Legacy fdisk partitions can only be specified when installing to an x86
system. If fdisk partitions are specified for a SPARC system, the in‐
stallation fails. The partition element is used for fdisk partitions.
The partition element has the following attributes:

name

The name attribute is the fdisk 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.

The name attribute is required unless the specified action is
use_existing_solaris2.

action

The action attribute can have the following values:

create

delete

The delete action tells the installer to delete the named par‐
tition. If the named partition does not exist, the delete ac‐
tion is skipped and a warning message is output.

preserve

The preserve action tells the installer to leave the named par‐
tition untouched. This action is commonly used if another oper‐
ating system is installed at another location on the same disk.

use_existing_solaris2

The use_existing_solaris2 action tells the installer to use an
existing Solaris2 partition. The installer searches for the ex‐
isting Solaris2 partition.

When use_existing_solaris2 is specified, the name and part_type
attributes are ignored.

part_type

The part_type is the fdisk partition type. The default value is
191, which is the partition type for a Solaris2 partition. See the
fdisk(8) man page for more information about possible partition
types.

in_zpool

If the in_zpool attribute is specified, then do not specify
in_zpool for the associated disk element or any subordinate slice
elements.

in_vdev

If the in_vdev attribute is specified, then do not specify in_vdev
for the associated disk element or any subordinate slice elements.

Partitions can have a size sub-element to specify the size of the par‐
tition. See the beginning of the "Disk Layout" section for details
about how to use the size element. If you specify a size for the parti‐
tion, the size sub-element must precede any slice sub-element in the
partition element.

The following example creates a 10 GB Solaris2 partition using default
attribute values:

If the size is not specified, the size of the parent element is used.

The preserve, delete, and use_existing_solaris2 actions do not need a
size specification.

Slices
For an x86 system, slices must be contained within a partition defini‐
tion.

The slice element has the following attributes:

name

The name attribute is the slice number. The value can be 0 through
7.

action

The action attribute can have the following values:

create

This is the default action for a slice. The create 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.

delete

The delete action tells the installer to delete the named
slice. If the named slice does not exist, the delete action is
skipped and a warning message is output.

preserve

The preserve action tells the installer to leave the named
slice untouched. This action is commonly used when data exists
from a previous installation.

use_existing

The use_existing action tells the installer to use an existing
slice dimensions (starting sector and size). This differs from the
preserve action in that this may be used as part of a zpool which
would destroy any existing data on that slice.

As with the create action, it is necessary to specify the force op‐
tion as true if the slice is part of an existing zpool.

is_swap

The default value of this attribute is false. When is_swap is
false, the installer creates a swap volume in the root pool.

When is_swap is true, the named slice is used as a swap device.
When is_swap is true, do not use the in_zpool or in_vdev attrib‐
utes.

force

The default value of this attribute is false.

When force is true, 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.

in_zpool

The in_zpool attribute links this slice to a ZFS pool defined in
the logical section of the AI manifest. The value of the in_zpool
attribute must match the value of the name attribute of the corre‐
sponding zpool element.

If the in_zpool attribute is specified, then do not specify
in_zpool for the associated partition or disk elements.

in_vdev

The in_vdev attribute links this slice to a virtual device defined
in the logical section of the AI manifest. The value of the in_vdev
attribute must match the value of the name attribute of the corre‐
sponding vdev element.

If the in_vdev attribute is specified, then do not specify in_vdev
for the associated partition or disk elements.

Slices can have a size sub-element to specify the size of the slice.
See the beginning of the "Disk Layout" section for details about how to
use the size element. If the size is not specified, the size of the
parent element is used.

The following example creates a 20 GB slice using default attribute
values and a 4 GB swap slice for a SPARC system:

The following example is the same example for an x86 system:

Swap and Dump
A swap slice can be explicitly defined by setting the is_swap attribute
of the slice element to true, as shown in "Slices" above.

A volume in a pool can be explicitly defined as a swap volume or a dump
volume by setting the use attribute of the zvol element to swap or
dump, as shown in "ZFS Volumes" below.

By default, a swap volume and a dump volume are automatically created
if space is available.

On low memory systems, a swap slice can be preferable to a swap volume
since volumes incur a small memory overhead.

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
logical element to true:

noswap

The default value of this attribute is false. When noswap is false,
if space allows, the installer automatically creates a swap volume
in the root pool.

When noswap is true, no swap volume is automatically created.

nodump

The default value of this attribute is false. When nodump is false,
if space allows, the installer automatically creates a dump volume
in the root pool.

When nodump is true, no dump volume is automatically created.

ZFS Storage Pools
Use the logical section of the target section to specify any number of
ZFS storage pools.

Multiple pools can be defined by using the zpool sub-element of the
logical element. Only one of these pools can be the root pool. The in‐
stallation fails if multiple root pools are defined.

If a zpool element defines a root pool, and no target disks, partitions
(GPT or fdisk), 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.

If target disks, partitions (GPT or fdisk), or slices are specified in
the AI manifest, then the zpool must be associated with at least one of
these disks, partitions (GPT or fdisk), or slices. To make this associ‐
ation, use the in_zpool attribute of the disk element, the gpt_parti‐
tion element, the partition element, or the slice element.

If the root pool is associated with a target device that is not
bootable by firmware (such as an iSCSI disk over IPoIB), a separate
boot pool is required. If a boot pool is not defined, then the in‐
staller will automatically define a boot pool. If the boot pool is not
associated with any target disks, then the installer will check if the
system has any dedicated boot pool devices and automatically select
them for the boot pool, configuring them with a mirrored redundancy. If
the system does not contain any dedicated boot pool devices, devices
for the boot pool must be defined in the manifest.

The zpool element has the following attributes:

name

This is the name of the new pool. This value must be a name that
can be passed to the zpool create command.

This name could be used as the value of an in_zpool attribute of a
disk, gpt_partition, partition, or slice element to define that
disk, GPT partition, fdisk partition, or slice as a constituent de‐
vice in the zpool.

action

The action attribute can have the following values:

create

This is the default action for a zpool. The create action tells
the installer to create a pool with the specified name.

delete

The delete action tells the installer to delete the named pool.

preserve

The preserve action tells the installer to leave the named pool
unmodified. This action can be specified only for a non-root
pool.

The value of the action attribute must be preserve in the fol‐
lowing cases:

o The value of the action attribute of any subordinate
filesystem is preserve.

o The value of the action attribute of any subordinate
zvol is preserve.

o The value of the action attribute of any subordinate
zvol is use_existing.

use_existing

The use_existing action tells the installer to install to the
existing root pool. Any existing volumes or file systems
(datasets) are retained.

is_root

The default value of this attribute is false. When is_root is true,
the root pool is created in the named pool and the new boot envi‐
ronment is created in this pool.

When is_root is false and is_boot is false, a data pool is defined.

is_boot

The default value of this attribute is false. When is_boot is true,
a boot pool is created in the named pool. Boot pools may not have
any child sub-elements defined, and the mountpoint attribute is ig‐
nored as the boot pool is managed by the system and is not kept
mounted.

When is_boot is false and is_root is false, a data pool is defined.

mountpoint

The mountpoint attribute specifies the mount point of the top level
file system of the pool. The default mount point is /poolname. The
mount point must be an absolute path.

To set ZFS properties on the new pool, use the pool_options element.
Similarly, to set ZFS properties on the automatically created ZFS
dataset, use the dataset_options element. Both the pool_options and
dataset_options elements have an option sub-element. Each option ele‐
ment has a name attribute and a value attribute. The properties set
with these name/value pairs are subject to the same restrictions that
the zpool(8) command enforces. The following example shows how to set
these properties:

Any number of virtual device redundancy groups (vdev element), ZFS
datasets (filesystem element), or ZFS volumes (zvol element) can be de‐
fined for a pool. Boot environments (be element) can be specified for a
pool. The following sections describe the vdev, filesystem, zvol, and
be elements.

Virtual Device Redundancy Groups
Use the vdev element to define the size or structure of a zpool. You
can specify multiple vdev elements, each with a different redundancy
type.

If a zpool contains more than one vdev element, then you must use the
in_vdev attribute on any disk, gpt_partition, partition, or slice ele‐
ments that are defined with in_zpool attributes.

You can omit the in_zpool attribute on a disk, GPT partition, fdisk
partition, or slice if the vdev name is unique throughout the AI mani‐
fest.

If a zpool contains only one vdev element, you can omit the in_vdev at‐
tribute on a disk, gpt_partition, partition, or slice.

The vdev element has the following attributes:

name

This is the name of the new vdev.

This name should be used as the value of an in_vdev attribute of a
disk, gpt_partition, partition, or slice element to define that
disk, partition (GPT or fdisk), or slice as a constituent device in
the vdev

redundancy

The redundancy attribute can have the following values:

mirror

This is the default value. When redundancy is mirror or is not
specified, all devices contained are considered to be mirrors
of each other.

raidz, raidz1, raidz2, raidz3

Devices in a group with one of these values are used to define
a RAIDZ grouping.

spare

Devices in this group are seen as hot spares in case of fail‐
ure.

cache

Devices in this group provide caching for the pool.

log, logmirror

Devices in this group are used for logging. If logmirror is
specified, the devices are mirrors.

none

When redundancy is none, no redundancy is defined. If multiple
devices are included in this group, these devices are striped.

A root pool can be defined as having only one of the following con‐
figurations:

o A redundancy type of none with one device. Multiple de‐
vices are not supported in this configuration.

o A redundancy type of mirror with multiple devices.

To add a device to a vdev, use the in_zpool and in_vdev attributes of a
disk, gpt_partition, partition, or slice element. The following example
specifies a root pool named rpool that is mirrored over two disks:

You can omit one of the in_zpool or in_vdev attributes if the pool or
virtual device they refer to is unambiguous.

File Systems (Datasets)
Use the filesystem element to define ZFS file systems or datasets
within a ZFS pool.

The filesystem element has the following attributes:

name

This is the name of the new filesystem, relative to the zpool. For
example, if the filesystem is named export within a zpool named
rpool, the ZFS dataset name is rpool/export.

If the in_be attribute of the filesystem is set to true, this name
is relative to the root dataset of the boot environment.

action

The action attribute can have the following values:

create

This is the default action for a filesystem. The create action
tells the installer to create a file system with the specified
name.

delete

The delete action tells the installer to delete the named file
system.

preserve

The preserve action tells the installer to leave the named file
system unmodified. If preserve is specified for the filesystem,
then preserve should be specified for the associated zpool.

mountpoint

The mountpoint 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.

in_be

The default value of this attribute is false. When in_be is false,
the new dataset is shared among all boot environments.

When in_be is true, a separate copy of this new dataset is created
within each boot environment. When in_be is true, the value of the
name attribute is relative to the root dataset of the boot environ‐
ment.

Use the options sub-element to set the ZFS dataset properties on a
filesystem. Any editable ZFS file system property can be set. Use of
the options element for a filesystem is similar to the use of the
dataset_options element for a zpool, as shown in the following example:

A child filesystem inherits any property set on a parent filesystem un‐
less that property is explicitly set differently. This is the default
behavior of ZFS file systems.

ZFS Volumes
Use the zvol element to define ZFS volumes within a ZFS pool. A zvol is
typically used for swap or dump devices, but it can have other uses.

The zvol element has the following attributes:

name

This is the name of the new ZFS volume.

action

The action attribute can have the following values:

create

This is the default action for a zvol. The create action tells
the installer to create a ZFS volume with the specified name.

delete

The delete action tells the installer to delete the named vol‐
ume.

preserve

The preserve action tells the installer to leave the named zvol
unmodified. If preserve is specified for the zvol, then pre‐
serve should be specified for the associated zpool.

use_existing

If this value is specified for a swap or dump device, the ex‐
isting volume is reused. If use_existing is specified for the
zvol, then preserve should be specified for the associated
zpool.

use

The use attribute can have the following values:

none

This is the default value. When use is none, the zvol is cre‐
ated but not used during the installation.

swap

When use is swap, the zvol is created and used as a swap de‐
vice. The zvol is also used as a swap device during the instal‐
lation. The size sub-element of the zvol element can have the
value max. When the max 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 max.

dump

When use is dump, the zvol is created and used as a dump de‐
vice. The zvol is also used as a dump device during the instal‐
lation.

Use the size sub-element to specify the size of the volume. See the be‐
ginning of the "Disk Layout" section for details about how to use the
size element. If you specify a size for the volume, the size sub-ele‐
ment must follow any options sub-element in the zvol element, as shown
in the example below.

Use the options sub-element to set ZFS volume options on a zvol. Use of
the options element for a zvol is similar to the use of the dataset_op‐
tions element for a zpool, as shown in the following example:

Boot Environments
Use the be element to specify how the boot environment is created dur‐
ing the installation.

The be element has one attribute:

name This is the name of the new boot environment that is created by
the installer. If the be element is not specified, the default
name for this boot environment is solaris.

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 be element name 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 be is not specified, and a
boot environment named solaris already exists, the new boot environment
is named solaris-n, where n is the first integer in counting order that
forms a boot environment name that does not already exist.

A boot environment is created as a ZFS dataset and can have ZFS proper‐
ties set on it. Use the options sub-element to set ZFS properties on a
boot environment, as shown in the following example:

SOFTWARE
The software element specifies software to install. The software sec‐
tion specifies the following information:

o The type of the software source

o The location of the source

o The names of software packages to install or uninstall

o Optional components of software to install

o Image properties

o SSL keys and certificates required to access the IPS reposi‐
tory or unified archive

o Authorization token required to access a unified archive.

The software element has the following attributes:

name This is the name of the software instance. This name must be
unique among all software instances in this AI manifest.

type This is the type of the software source.

The type attribute can have one of the following values. The
default value if type is not specified is IPS.

o IPS: IPS package repository

o SVR4: SVR4 packages

o CPIO: cpio archive

o ARCHIVE: Unified Archive

The software element has the following structure:

<software>

<destination>

</destination>

<source>

</source>

<software_data>

<name>...</name>
</software_data>
</software>

IPS Installations
The default installation type if the type attribute is not specified is
IPS.

Use the source element to specify which publishers to use for in‐
stalling the packages. In the publisher element, the name attribute is
required, and at least one origin sub-element is required. Each pub‐
lisher can have multiple origins and mirrors, one credentials sub-ele‐
ment, and multiple cmd_options sub-elements.

Multiple publishers can be specified in one source element. 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.

The cmd_options sub-element of the publisher element specifies an op‐
tions string. This options string is added to the pkg set-publisher
command run on the publisher. This element can be used to set proper‐
ties, attributes, or other options on the publisher. See the pkg(1) man
page for more information about the set-publisher subcommand. Note that
not all options are applicable to be set on publishers in the context
of installation.

The following example specifies a publisher that has two cmd_options to
set the non-sticky attribute on the publisher and to set the signature-
policy property of the publisher to ignore:

<software type="IPS">
<source>
<publisher name="solaris">
<origin name="http://pkg.oracle.com/solaris/release"/>
<mirror name="http://localpkg.example.com/solaris"/>
</publisher>
<publisher name="internal-software">
<origin name="http://internalsoft.example.com/"/>
<cmd_options>--non-sticky</cmd_options>
<cmd_options>--set-property signature-policy=ignore</cmd_options>
</publisher>
</source>
</software>

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 or‐
der in which they appear in the AI manifest, after the publishers pro‐
vided by the system repository. See the pkg(1) and pkg.sysrepo(8) man
pages for more information about the system repository.

The following example specifies multiple publishers, one of which has a
mirror as well as an origin:

Use elements of the publisher element to specify SSL keys, certificates
and CA certificates that are required for publishers using client SSL
authentication. The key, certificate and CA certificate specified here
apply to the publisher defined within the section.

The key element maps to the following pkg command:

pkg set-publisher -k key

The value of the key element is the key. See the pkg(1) man page for
more information about the pkg set-publisher command.

The cert element maps to the following pkg command:

pkg set-publisher -c cert

The value of the cert element is the cert. See the pkg(1) man page for
more information about the pkg set-publisher command.

The cacert element maps to the following pkg command:

pkg set-publisher --approve-ca-cert path_to_CA

The value of the cacert element is the CA certificate that will vali‐
date the certificate issuer. This is element is optional within the
credentials element. If not specified then the CA certificates within
/etc/certs/CA will be used. See the pkg(1) man page for more informa‐
tion about the pkg set-publisher command.

The key, cert, and cacert can be a URI, an inlined file, or a combina‐
tion of URI and inlined file. http, https, and file are supported URI
protocols. The inlined credentials might look like the following:

<software type="IPS">
<source>
<publisher name="solaris">
<origin name="https://pkg.oracle.com/solaris/release"/>
<credentials>
<key>
-----BEGIN RSA PRIVATE KEY-----
MIICXgIBAAKBgQC508UlZ...
...
-----END RSA PRIVATE KEY-----
</key>
<cert>
-----BEGIN CERTIFICATE-----
MIIB+jCCAWMCAQowDQYJK...
...
-----END CERTIFICATE-----
</cert>
</credentials>
</publisher>
</source>
</software>

In the above example the client will use the CA certificates located in
/etc/certs/CA.

Use the software_data element to specify packages to install, reject,
avoid, unavoid, or uninstall. The action attribute of the software_data
element can have one of the following values:

install

Installs the IPS packages specified in the name sub-elements. This
is the default if the action attribute is not specified. At least
one software_data element must have an action of install.

By default, the newest version of a named package available from
the specified sources and compatible with other packages in the im‐
age is installed. To install other versions of a package, use the
version string in the package FMRI. For example,
pkg:/mypkg@0.5.11-0.175.0.0.0.2.1 is more precise than pkg:/mypkg.
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 latest (for example, pkg:/mypkg@latest) to
install the newest version available from the specified sources
that is compatible with other packages in the image.

Packages specified in name sub-elements might install other pack‐
ages 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 reject sub-ele‐
ment.

The reject sub-element only applies to the install section in which
the reject sub-element appears. If a package is the value of a re‐
ject sub-element in one install section, but is only installed in a
different install section, then the package is installed and not
rejected.

Rejected packages that are the target of group dependencies are
placed on the avoid list. See the avoid action below.

avoid

Adds the IPS packages in the name sub-elements to the avoid list.

Packages on the avoid list are not installed if they are the target
of a group dependency.

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 unin‐
stalled), the avoided package is uninstalled.

Only packages that are not currently installed can be avoided.
Therefore, avoid sections must come before the install sections
where you install the packages that have dependencies on the pack‐
ages you want to avoid.

unavoid

Removes the IPS packages in the name sub-elements from the avoid
list.

uninstall

Removes the IPS packages specified in the name sub-elements. Unin‐
stalled packages that are the target of group dependencies are
placed on the avoid list. See the avoid action above.

Any avoid list created during the installation continues to exist in
the installed image.

The following example illustrates the use of software_data sections
with different action values in a software section of type IPS:

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

SVR4 Installations
For a SVR4 transfer, a directory containing SVR4 package subdirectories
or a SVR4 package datastream file must be specified using a file direc‐
tory path or a FILE URI. The SVR4 package datastream file can also be
specified using an HTTP URI.

The software_data element is used to specify the action to be per‐
formed. The action attribute can have one of the following two values:

install

Copies the files from the source to the new boot environment. This
is the default if the action attribute is not specified. At least
one software_data element must have an action of install.

uninstall

Removes the files from the new boot environment.

For each of these actions, one or more packages can be specified in the
name element, as shown in the following example:

<software type="SVR4">
<source>
<publisher>
<origin name="/somedir"/>
</publisher>
</source>
<software_data> 
<name>ORGpackage1</name>
<name>ORGpackage2</name>
</software_data>
<software_data action="uninstall">
<name>ORGpackage8</name>
</software_data>
</software>

CPIO Installations
For a CPIO transfer, a source directory must be specified. The destina‐
tion directory is set to the mount point for the new boot environment
during the installation.

The software_data element is used to specify the action to be per‐
formed. The action attribute can have one of the following values:

install

Copies the files from the source to the new boot environment. This
is the default if the action attribute is not specified. At least
one software_data element must have an action of install.

Use the name element to specify the files or directories to be
copied. Paths specified in the name element are relative to the
source.

<software_data>

<name>path/relative/to/source</name>
<name>another/path/relative/to/source</name>
</software_data>

uninstall

Removes files from the new boot environment.

Use the name element to specify the files or directories to be re‐
moved. Paths specified in the name element are relative to the des‐
tination.

<software_data action="uninstall">
<name>path/relative/to/destination</name>
</software_data>

ARCHIVE Installations
For an ARCHIVE transfer, a source file URI must be specified. The URI
value can be an HTTP, HTTPS, or FILE URI specification.

Use elements of the file element to specify SSL Keys, certificates, and
CA certificates, or an authorization token that are required to access
the unified archive securely.

To access a unified archive requiring SSL client authentication you can
provide key, certificate, and CA certificate within the credentials
sub-element.

Refer to the section on IPS Installations for specific information on
format and accepted values for key, cert, and cacert elements.

To access a unified archive requiring a specific authorization token
you can provide this within the credentials sub-element.

<software type="ARCHIVE">
<source>
<file uri="http://example.com/myarchive.ua"/>
<credentials>
<http_auth_token>my-specifically-granted-auth-token</http_auth_token>
</credentials>
</file>
</source>
</software>

The http_auth_token specified is passed as a X-Auth-Token HTTP header
when the unified archive is accessed.

The software_data element is used to specify the action to be per‐
formed. The action attribname element value must be the name of any one
of the deployable systems contained within the Unified Archive. Each
deployable system name matches the name of a non-global zone or the
global zone.

<software_data action="install">
<name>myzonename</name>
</software_data>

Recovery Unified Archives can only be used for system recovery and do
not allow deployable system selection from within the recovery Unified
Archive.

For Recovery Unified Archives, the name element value must be *.

<software_data action="install">
<name>*</name>
</software_data>

Software Components and Image Properties
Use the destination element and the image sub-element to specify the
following information:

o Optional components of software to install

o Mutually exclusive components of software to install

o Image properties

o SSL keys and certificates

The destination section only applies to IPS installation type. A desti‐
nation element can have only one image sub-element.

SSL Keys and Certificates
Use attributes of the image element to specify SSL keys and certifi‐
cates that are required for publishers using client SSL authentication.
The key and certificate specified here apply to the first publisher de‐
fined in this AI manifest.

ssl_key

This attribute maps to the following pkg command:

pkg set-publisher -k ssl_key

The value of the ssl_key attribute is the ssl_key. See the pkg(1)
man page for more information about the pkg set-publisher command.

ssl_cert

This attribute maps to the following pkg command:

pkg set-publisher -c ssl_cert

The value of the ssl_cert attribute is the ssl_cert.

Optional Software Components
Use the facet sub-element of the image element to specify optional
software components to install. Facets are not separate software pack‐
ages 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 in‐
stall one or two languages, for example. See the pkg(7) man page for
more information about IPS facets.

The facet element has a boolean set attribute and a value that is the
name of an IPS facet.

<facet set="true|false">facet_name</facet>

The following example specifies that only German and English facets of
packages should be installed. The example first specifies that no lo‐
cales should be installed and then specifies that German and English
locales should be installed:

<destination>
<image>

<facet set="false">facet.locale.*</facet>


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

Mutually Exclusive Software Components
Use the variant sub-element of the image element to specify which of
one or more mutually exclusive software components to install. Variants
are not separate software packages but are mutually exclusive compo‐
nents of any given software package, such as debug versus non-debug
versions of files. You can specify that you want to install the debug
versions of files, for example. For more information about IPS vari‐
ants, see the pkg(7) man page. Note that the arch and opensolaris.zone
variants are set implicitly by the installer and will cause an error if
they are specified in the manifest.

The variant element has a name attribute to specify the name of the IPS
variant and a value attribute to specify its value.

The following example specifies that the component of packages with
variant variant.debug.osnet set to true should be installed:

Image Properties
Use the property sub-element of the image element to specify IPS image
properties for the new image this installation creates.

The property element has a string val attribute and a value that is the
name of a property.

<property val="value">property_name</property>

See the "Image Properties" section of the pkg(1) man page for informa‐
tion about what properties can be set.

BOOT CONFIGURATION (X86 ONLY)
The AI manifest can be used to modify how the GRUB boot menu is config‐
ured on the installed system.

This section is not applicable to zone installations and is ignored
when installing a non-global zone.

Use the boot_mods element and the boot_entry sub-element to modify the
GRUB boot menu.

The boot_mods element has the following attributes:

title

The value of the title attribute is the base title of boot entries
specified by boot_entry sub-elements of this boot_mods element.
This attribute value overrides the name automatically generated
from the first line of /etc/release or from the install media.

timeout

The value of the timeout attribute is the number of seconds to wait
before the default boot_entry of this boot_mods element is se‐
lected.

Only the title attribute can be set on SPARC systems. All other set‐
tings in this section are ignored for SPARC systems.

Use the boot_entry 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. The default menu item for the
active BE will not be present if a menu item from boot_entry is
present.

The boot_entry element has the following attributes:

default_entry

If this boolean value is set to true, then this menu item is the
default option selected on boot. The default value of this at‐
tribute is false.

If multiple boot_entry elements have default_entry set to true,
then the last such entry is the default option selected on boot.

insert_at

This attribute can be set to one of the following two values:

end Place the entry at the end of the generated boot menu.
This is the default placement.

start Place the entry at the beginning of the generated boot
menu.

The boot_entry menu item is then defined by the following sub-elements:

title_suffix

This element is required. This element defines text to be added to
the end of the title specified in the boot_mods element.

kernel_args

This element is optional. This element is a string of values passed
to the kernel by the boot loader.

The following example specifies a boot menu entry named "Boot Testing
Default Boot Entry" that is the last entry on the menu and is automati‐
cally selected after 20 seconds:

<boot_mods title="Boot Testing" timeout="20">
<boot_entry default_entry="true">
<title_suffix>Default Boot Entry</title_suffix>
</boot_entry>
</boot_mods>

OTHER CONFIGURATION
The configuration 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.

The configuration element has the following attributes:

type The type of configuration to install. The only type supported
by AI is zone.

name A name given to the configuration. This name must be unique
across all configuration elements in an AI manifest. For con‐
figurations of type zone, this name is also used as the zone‐
name for the zone.

source 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 zone, this
value should point to a zone configuration file as produced
from the zonecfg export command.

The following specification installs zone1 on the installation clients:

The following equivalent specification installs zone1 on the installa‐
tion clients, but uses a Unified Archive containing an archived zone
configuration named myzone:

For more information about configuring and installing zones, see Chap‐
ter 7, Installing and Configuring Zones in Automatically Installing Or‐
acle Solaris 11.4 Systems.

FILES
/usr/share/auto_install/manifest/default.xml

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 rele‐
vant install service image. See the "Description" section for in‐
formation about copying this file from an install service.

/usr/share/auto_install/manifest/zone_default.xml

A default zone installation with no customization. This file is
used as the default manifest by the zoneadm install command to in‐
stall non-global zones.

/usr/share/auto_install/manifest/ai_manifest.xml

A template AI manifest with details commented out. This file pro‐
vides 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.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:

tab() box; cw(1.37i) |cw(4.12i) lw(1.37i) |lw(4.12i) ATTRIBUTE TYPEAT‐
TRIBUTE VALUE _ AvailabilityT{ system/install/auto-install/auto-in‐
stall-common T} _ Interface StabilityCommitted

SEE ALSO
pkg(1), grub(7), pkg(7), smf(7), beadm(8), boot(8), croinfo(8),
fdisk(8), format(8), installadm(8), iostat(8), iscsiadm(8), pkg.sys‐
repo(8), prtconf(8), zfs(8), zoneadm(8), zonecfg(8), zpool(8)

Automatically Installing Oracle Solaris 11.4 Systems

NOTES
If you specify to install the Oracle Solaris OS on a dual-path FC disk
on a SPARC system, the installation fails with the following error:

17:22:08 Error occurred during execution of 'target-selection' checkpoint.
17:22:08 100% None
17:22:09 Failed Checkpoints:
17:22:09
17:22:09 target-selection
17:22:09
17:22:09 Checkpoint execution error:
17:22:09
17:22:09 Unable to locate the disk '[devpath='/pci@0,600000/pci@0/pci@8/pci@0,1/SUNW,emlxs@1,1/fp@0,0/ssd@w20350080e517b4da,6']' on the system.
17:22:09
17:22:09 Automated Installation Failed. See install log at /system/volatile/install_log
Automated Installation failed
Please refer to the /system/volatile/install_log file for details

The workaround for this issue is to disconnect one of the dual-path SAS
JBOD cables.

If the name_type attributes (vol-id and volid) specified by the user
exists on more than one disk on a system being installed, then there is
no guarantee as to which disk will be selected. For example, if a user
has assigned volname of ai-disk to two disks on the system, and speci‐
fied name_type as volid, then there is no guarantee which disk will be
selected.

In the following example, the format command shows two disks available
with a volid of ai-disk.

# format

Searching for disks...done

AVAILABLE DISK SELECTIONS:
0. c1t0d0 <SUN72G cyl 14087 alt 2 hd 24 sec 424>
/pci@780/pci@0/pci@9/scsi@0/sd@0,0
1. c1t1d0 <SUN72G cyl 14087 alt 2 hd 24 sec 424> ai-disk
/pci@780/pci@0/pci@9/scsi@0/sd@1,0
2. c1t2d0 <HITACHI-H101473SCSUN72G-SA23-68.37GB>
/pci@780/pci@0/pci@9/scsi@0/sd@2,0
3. c1t3d0 <HITACHI-H101473SCSUN72G-SA23-68.37GB> ai-disk
/pci@780/pci@0/pci@9/scsi@0/sd@3,0
Specify disk (enter its number):

For example, if the manifest attempts to select the disk via the
name_type ai-disk, the AI Installer will not know which disk to use
and will select one.

There is no guarantee that the first volid labeled ai-disk listed by
format command will be selected.

This condition also occurs, if the name_type is set to wwn and the de‐
vice specified in the manifest are derived from a RAID system. In this
scenario, the WWN exported for all devices from the RAID system may not
be unique.

When using name_type in a manifest, it is important to use a name that
is unique across all the devices being installed.

Oracle Solaris 11.4 14 Dec 2023 ai_manifest(5)

RSS ATOM XHTML 5 CSS3

섹션
맨 페이지 이름
검색(S)