'\" te

.\" Copyright (c) 2008, 2012, Oracle and/or its

.\" affiliates. All rights reserved.

.SH NAME

installadm \- Manages automated installations on a network

.SH SYNOPSIS

.LP

.nf

.fi

.LP

.nf

installadm help [\fIsubcommand\fR]

.fi

.LP

.nf

installadm create-service

    [-n|--service \fIsvcname\fR]

    [-t|--aliasof \fIexisting_service\fR]

    [-p|--publisher \fIprefix\fR=\fIorigin\fR]

    [-a|--arch \fIarchitecture\fR]

    [-s|--source \fIFMRI_or_ISO\fR]

    [-b|--boot-args \fIboot_property\fR=\fIvalue\fR,...]

    [-i|--ip-start \fIdhcp_ip_start\fR]

    [-c|--ip-count \fIcount_of_ipaddr\fR]

    [-B|--bootfile-server \fIserver_ipaddr\fR]

    [-d|--imagepath \fIimagepath\fR]

    [-y|--noprompt]

.fi

.LP

.nf

installadm set-service

    -o|--option \fIprop\fR=\fIvalue\fR \fIsvcname\fR

.fi

.LP

.nf

installadm rename-service \fIsvcname\fR \fInewsvcname\fR

.fi

.LP

.nf

installadm enable \fIsvcname\fR

.fi

.LP

.nf

installadm disable \fIsvcname\fR

.fi

.LP

.nf

installadm delete-service

    [-r|--autoremove] [-y|--noprompt] \fIsvcname\fR

.fi

.LP

.nf

installadm list

    [-n|--service \fIsvcname\fR]

    [-c|--client] [-m|--manifest] [-p|--profile]

.fi

.LP

.nf

installadm create-manifest -n|--service \fIsvcname\fR

    -f|--file \fImanifest_or_script_filename\fR

    [-m|--manifest \fImanifest_name\fR]

    [-c|--criteria \fIcriteria\fR=\fIvalue\fR|\fIlist\fR|\fIrange\fR... |

    -C|--criteria-file \fIcriteriafile\fR]

    [-d|--default]

.fi

.LP

.nf

installadm update-manifest -n|--service \fIsvcname\fR

    -f|--file \fImanifest_or_script_filename\fR

    [-m|--manifest \fImanifest_name\fR]

.fi

.LP

.nf

installadm delete-manifest

    -m|--manifest \fImanifest_name\fR

    -n|--service \fIsvcname\fR

.fi

.LP

.nf

installadm create-profile -n|--service \fIsvcname\fR

    -f|--file \fIprofile_filename\fR... 

    [-p|--profile \fIprofile_name\fR]

    [-c|--criteria \fIcriteria\fR=\fIvalue\fR|\fIlist\fR|\fIrange\fR... |

    -C|--criteria-file \fIcriteriafile\fR]

.fi

.LP

.nf

installadm update-profile -n|--service \fIsvcname\fR

    -f|--file \fIprofile_filename\fR

    [-p|--profile \fIprofile_name\fR]

.fi

.LP

.nf

installadm delete-profile -p|--profile \fIprofile_name\fR...

    -n|--service \fIsvcname\fR

.fi

.LP

.nf

installadm export -n|--service \fIsvcname\fR

    -m|--manifest \fImanifest_name\fR...

    -p|--profile \fIprofile_name\fR...

    [-o|--output \fIpathname\fR]

.fi

.LP

.nf

installadm validate -n|--service \fIsvcname\fR

    -P|--profile-file \fIprofile_filename\fR... |

    -p|--profile \fIprofile_name\fR...

.fi

.LP

.nf

installadm set-criteria

    -m|--manifest \fImanifest_name\fR

    -p|--profile \fIprofile_name\fR...

    -n|--service \fIsvcname\fR

    -c|--criteria \fIcriteria\fR=\fIvalue\fR|\fIlist\fR|\fIrange\fR... |

    -C|--criteria-file \fIcriteriafile\fR |

    -a|--append-criteria \fIcriteria\fR=\fIvalue\fR|\fIlist\fR|\fIrange\fR...

.fi

.LP

.nf

installadm create-client

    [-b|--boot-args \fIproperty\fR=\fIvalue\fR,...]

    -e|--macaddr \fImacaddr\fR -n|--service \fIsvcname\fR

.fi

.LP

.nf

installadm delete-client \fImacaddr\fR

.fi

.SH DESCRIPTION

.sp

.LP

The Automated Installer (AI) is used to automate the installation of the Oracle Solaris OS on one or more SPARC and x86 systems over a network.

.sp

.LP

The machine topography necessary to employ AI over the network is to have an install server, a DHCP server (this can be the same system as the install server), and the installation clients. On the install server, install services are set up to contain an AI boot image, which is provided to the clients in order for them to boot over the network, input specifications (AI manifests and derived manifests scripts), one of which will be selected for the client, and Service Management Facility (SMF) configuration profiles, zero or more of which will be selected for the client.

.sp

.LP

The AI boot image content is published as the package \fBinstall-image/solaris-auto-install\fR, and is installed by the \fBcreate-service\fR subcommand. The \fBcreate-service\fR subcommand is also able to accept and unpack an AI ISO file to create the AI boot image.

.sp

.LP

Install services are created with a default AI manifest, but customized manifests or derived manifests scripts (hereafter called "scripts") can be added to an install service by using the \fBcreate-manifest\fR subcommand. See \fIInstalling Oracle Solaris 11 Systems\fR for information about how to create manifests and derived manifests scripts. The \fBcreate-manifest\fR subcommand also allows criteria to be specified, which are used to determine which manifest or script should be selected for an installation client. Criteria already associated with a manifest or script can be modified using the \fBset-criteria\fR subcommand.

.sp

.LP

Manifests can include information such as a target device, partition information, a list of packages, and other parameters. Scripts contain commands that query a running AI client system and build a custom manifest based on the information it finds. When AI is invoked with a script, AI runs that script as its first task, to generate a manifest.

.sp

.LP

When the client boots, a search is initiated for a manifest or script that matches the client's machine criteria. When a matching manifest or script is found, the client is installed with the Oracle Solaris release according to the specifications in the matching manifest file, or to the specifications in the manifest file derived from the matching script. Each client can use only one manifest or script.

.sp

.LP

Each service has one default manifest or script. The default is used when the criteria of no other manifest or script matches the system being installed. Any manifest or script can be designated as the default. Any criteria associated with a default manifest or script become inactive and are not considered during manifest or script selection. If a different manifest or script is later made the default, the criteria of the former default manifest or script become active again. Manifests or scripts with no criteria associated with them can only be used as default manifests or scripts. Manifests or scripts without criteria become inactive when a different manifest or script is designated the default.

.sp

.LP

System configuration profiles are complementary to manifests and scripts in that they also contain specifications for an installation. In particular, profiles are used to specify configuration information such as user name, user password, time zone, host name, and IP address. Profiles can contain variables that are replaced at installation time with appropriate values for the client being installed. In this way, a single profile file can set different configuration parameters on different clients. See the "Examples" section.

.sp

.LP

System configuration profiles are processed by \fBsmf\fR(5) and conform to document format \fBservice_bundle\fR(4). See \fBsysconfig\fR(1M) and Chapter 11, \fIConfiguring the Client System,\fR in \fIInstalling Oracle Solaris 11 Systems\fR for more information about system configuration profiles. Each client can use any number of system configuration profiles. A particular SMF property can be specified no more than once for each client system.

.sp

.LP

If you want a specific client to use a specific install service, you can associate that client with the service by using the \fBcreate-client\fR subcommand. You can also use \fBcreate-client\fR to modify an existing client.

.sp

.LP

The \fBinstalladm\fR utility can be used to accomplish the following tasks:

.RS +4

.TP

.ie t \(bu

.el o

Set up install services and aliases

.RE

.RS +4

.TP

.ie t \(bu

.el o

Set up installation images

.RE

.RS +4

.TP

.ie t \(bu

.el o

Set up or delete clients

.RE

.RS +4

.TP

.ie t \(bu

.el o

Add, update, or delete manifests and scripts

.RE

.RS +4

.TP

.ie t \(bu

.el o

Specify or modify criteria for a manifest or script

.RE

.RS +4

.TP

.ie t \(bu

.el o

Export manifests and scripts

.RE

.RS +4

.TP

.ie t \(bu

.el o

Add or delete system configuration profiles

.RE

.RS +4

.TP

.ie t \(bu

.el o

Validate profiles

.RE

.RS +4

.TP

.ie t \(bu

.el o

Specify or modify criteria for profiles

.RE

.RS +4

.TP

.ie t \(bu

.el o

Export profiles

.RE

.RS +4

.TP

.ie t \(bu

.el o

Enable or disable install services

.RE

.RS +4

.TP

.ie t \(bu

.el o

List install services

.RE

.RS +4

.TP

.ie t \(bu

.el o

List clients for an install service

.RE

.RS +4

.TP

.ie t \(bu

.el o

List manifests and scripts for an install service

.RE

.RS +4

.TP

.ie t \(bu

.el o

List profiles for an install service

.RE

.SH INSTALL SERVER CONFIGURATION PROPERTIES

.sp

.LP

The following properties of the \fBsvc:/system/install/server:default\fR SMF service are used to configure the install server.

.sp

.ne 2

.mk

.na

\fB\fBall_services/networks\fR\fR

.ad

.sp .6

.RS 4n

A list of networks in CIDR format (for example, 192.168.56.0/24) to allow or disallow, depending on how the \fBall_services/exclude_networks\fR property is set.

.sp

Use this list of networks to specify which clients this install server serves. By default, the AI install server is configured to serve install clients on all networks that the server is connected to if the server is multihomed.

.RE

.sp

.ne 2

.mk

.na

\fB\fBall_services/exclude_networks\fR\fR

.ad

.sp .6

.RS 4n

A boolean value. If true, exclude networks specified by the \fBall_services/networks\fR property from being served by this install server. If false, include networks specified by the \fBall_services/networks\fR property.

.RE

.sp

.ne 2

.mk

.na

\fB\fBall_services/port\fR\fR

.ad

.sp .6

.RS 4n

Specifies the port that hosts the AI install services web server. By default, the web server is hosted on port 5555.

.sp

If you want to use a different port number from the default, customize the \fBport\fR property before you create any install services.

.RE

.sp

.ne 2

.mk

.na

\fB\fBall_services/default_imagepath_basedir\fR\fR

.ad

.sp .6

.RS 4n

Specifies the default location for images created by the \fBinstalladm create-service\fR command. Images are located at \fBall_services/default_imagepath_basedir/\fIservice_name\fR\fR. The default value of this property is \fB/export/auto_install\fR.

.RE

.SH OPTIONS

.sp

.LP

The \fBinstalladm\fR command has the following option:

.sp

.ne 2

.mk

.na

\fB\fB-h\fR, \fB--help\fR\fR

.ad

.RS 14n

.rt  

Show the usage help message.

.RE

.SH SUB-COMMANDS

.sp

.LP

The \fBinstalladm\fR command has the subcommands listed below. See also the "Examples" section below. 

.sp

.ne 2

.mk

.na

\fB\fBhelp [\fIsubcommand\fR]\fR\fR

.ad

.sp .6

.RS 4n

Displays the syntax for the \fBinstalladm\fR utility.

.sp

.ne 2

.mk

.na

\fB\fB\fIsubcommand\fR\fR\fR

.ad

.RS 14n

.rt  

Displays the syntax for only the specified subcommand.

.RE

.RE

.sp

.ne 2

.mk

.na

\fB\fBcreate-service [\fB-n\fR|\fB--service\fR \fIsvcname\fR] [\fB-t\fR|\fB--aliasof\fR \fIexisting_service\fR] [\fB-p\fR|\fB--publisher\fR \fIprefix\fR=\fIorigin\fR] [\fB-a\fR|\fB--arch\fR \fIarchitecture\fR] [\fB-s\fR|\fB--source\fR \fIFMRI_or_ISO\fR] [\fB-b\fR|\fB--boot-args\fR \fIboot_property\fR=\fIvalue\fR,...] [\fB-i\fR|\fB--ip-start\fR \fIdhcp_ip_start\fR] [\fB-c\fR|\fB--ip-count\fR \fIcount_of_ipaddr\fR] [\fB-B\fR|\fB--bootfile-server\fR \fIserver_ipaddr\fR] [\fB-d\fR|\fB--imagepath\fR \fIimagepath\fR] [\fB-y\fR|\fB--noprompt\fR]\fR\fR

.ad

.sp .6

.RS 4n

This subcommand sets up a network boot image (net image) in the specified \fIimagepath\fR directory, and creates an install service that specifies how a client booted from the net image is installed.

.sp

The AI boot image content is published as the package \fBinstall-image/solaris-auto-install\fR. If the \fB-s\fR option is not specified, that package is installed from the first publisher in the system's publisher preference list that provides an instance of that package. The \fB-s\fR option accepts the \fBpkg\fR specification as a full FMRI or location of an image ISO file. The resulting net image is eventually located in \fIimagepath\fR. The net image enables client installations.

.sp

.LP

Note the following specifications:

.RS +4

.TP

.ie t \(bu

.el o

When the first install service of a given architecture is created on an install server, an alias of that service, \fBdefault-i386\fR or \fBdefault-sparc\fR, is automatically created. This default service is used for all installations to clients of that architecture that were not added to the install server explicitly with the \fBcreate-client\fR subcommand. To change the service aliased by the \fBdefault-\fIarch\fR\fR service, use the \fBset-service\fR subcommand.

.sp

If a \fBdefault-\fIarch\fR\fR alias is changed to a new install service and a local ISC DHCP configuration is found, this default alias bootfile is set as the default DHCP server-wide bootfile for that architecture.

.RE

.RS +4

.TP

.ie t \(bu

.el o

If you want a client to use a different install service than the default for that architecture, you must use the \fBcreate-client\fR subcommand to create a client-specific configuration.

.RE

.RS +4

.TP

.ie t \(bu

.el o

If the \fB-i\fR option and the \fB-c\fR option are used, and a DHCP server is not yet configured, an ISC DHCP server is configured.

.sp

If an ISC DHCP server is already configured, that DHCP server is updated.

.sp

Even when \fB-i\fR and \fB-c\fR arguments are provided and DHCP is configured, no binding exists between the install service being created and the IP range. When \fB-i\fR and \fB-c\fR are passed, the IP range is set up, a new DHCP server is created if needed, and that DHCP server remains up and running for all install services and all clients to use. The network information provided to the DHCP server has no specific bearing on the service being created.

.RE

.RS +4

.TP

.ie t \(bu

.el o

If the IP range requested is not on a subnet that the install server has direct connectivity to and the install server is multihomed, the \fB-B\fR option is used to provide the address of the bootfile server (usually an IP address on this system). This should only be necessary when multiple IP addresses are configured on the install server and DHCP relays are employed. In all other configurations, the software can determine this automatically.

.RE

.sp

.ne 2

.mk

.na

\fB\fB\fB-n\fR|\fB--service\fR \fIsvcname\fR\fR\fR

.ad

.sp .6

.RS 4n

Optional: Uses this install service name instead of a system-generated service name. The \fIsvcname\fR can consist of alphanumeric characters, underscores (\fB_\fR), and hyphens (\fB-\fR). The first character of \fIsvcname\fR cannot be a hyphen.

.sp

If the \fB-n\fR option is not specified, a service name is generated automatically. 

.RE

.sp

.ne 2

.mk

.na

\fB\fB\fB-t\fR|\fB--aliasof\fR \fIexisting_service\fR\fR\fR

.ad

.sp .6

.RS 4n

Optional: This new service is an alternate name for \fIexisting_service\fR. 

.RE

.sp

.ne 2

.mk

.na

\fB\fB\fB-a\fR|\fB--arch\fR \fIarchitecture\fR\fR\fR

.ad

.sp .6

.RS 4n

Optional: Selects a specific variant architecture. Legal values are \fBi386\fR or \fBsparc\fR. If not specified, the variant corresponding to the server's architecture is selected.

.sp

The \fB-a\fR option only applies when the \fB-s\fR argument is a \fBpkg\fR(5) package.

.RE

.sp

.ne 2

.mk

.na

\fB\fB\fB-p\fR|\fB--publisher\fR \fIprefix\fR=\fIorigin\fR\fR\fR

.ad

.sp .6

.RS 4n

Optional: A \fBpkg\fR(5) publisher, in the form \fIprefix\fR=\fIorigin\fR, from which to install the client image.

.sp

If the \fB-p\fR option is not specified, then the first publisher in the system's publisher preference list that provides an instance of the package is used.

.RE

.sp

.ne 2

.mk

.na

\fB\fB\fB-s\fR|\fB--source\fR \fIFMRI_or_ISO\fR\fR\fR

.ad

.sp .6

.RS 4n

Optional: Specifies the data source for the net image. This can be either of:

.RS +4

.TP

.ie t \(bu

.el o

The full FMRI of a \fBpkg\fR(5) package.

.RE

.RS +4

.TP

.ie t \(bu

.el o

The path to an AI ISO image.

.RE

.sp

.LP

If \fB-s\fR is not specified, the \fBinstall-image/solaris-auto-install\fR package used is from either of:

.RS +4

.TP

.ie t \(bu

.el o

The publisher specified with the \fB-p\fR parameter.

.RE