add_install_client(1M)
NAME
install_scripts, add_install_client, add_to_install_server,
modify_install_server, rm_install_client,
setup_install_server, check - scripts used to install the
Solaris software
SYNOPSIS
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client [-
i IP_address] [-e Ethernet_address] [ -s server_name : path]
[ -c server_name : path] [ -n [server ] : name_service [ (
netmask]] [ -p server_name : path] [-f boot_file_name]
host_name platform_group
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client -d [-s
server_name:path] [-c server_name:path] [-p
server_name:path] [-t install_boot_image_path] [-f
boot_file_name] platform_name platform_group
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client -d [-s
server_name:path] [-c server_name:path] [-p
server_name:path] [-t install_boot_image_path] [-f
boot_file_name] -e Ethernet_address [-b property=value]
platform_group
cdrom-mnt-pt/Solaris_XX/Tools/add_to_install_server [-s] [-
p product_image_path] install_server_path
cdrom-mnt-pt/Solaris_XX/Tools/jumpstart_sample/check [-
p install_dir_path] [-r rulesfile]
cdrom-mnt-pt/modify_install_server [-p] install_dir_path
installer_miniroot_path
cdrom-mnt-pt/Solaris_XX/Tools/rm_install_client host_name
cdrom-mnt-pt/Solaris_XX/Tools/setup_install_server [-b] [-t
install_boot_image_path] [-w wanboot_image_path]
install_dir_path
DESCRIPTION
These commands are located on slice 0 of the Solaris
Software and Solaris Installer CDs. If the Solaris CD has
been copied to a local disk, cdrom_mnt_pt is the path to the
copied Solaris CD. They can be used for a variety of instal-
lation tasks.
The XX in Solaris_XX is the version number of the Solaris
release being used.
There are three versions of the add_install_client command.
See SYNOPSIS.
Use the following version of the add_install_client command
to add clients for network installation (these commands
update the bootparams(4) file). The add_install_client com-
mand must be run from the install server's Solaris installa-
tion image (a mounted Solaris CD or a Solaris CD copied to
disk) or the boot server's boot directory (if a boot server
is required). The Solaris installation image or the boot
directory must be the same Solaris release that you want
installed on the client.
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client [-
i IP_address] [-e Ethernet_address] [ -s server_name : path]
[ -c server_name : path] [ -n [server ] : name_service [ (
netmask]] [ -p server_name : path] host_name platform_group
Use the following version of the add_install_client command
to add support for instances of a platform within a platform
group to the install server. This group will be booted and
configured using DHCP. The script will perform the necessary
configuration steps on the server, and prints the data that
the user needs to add to the DHCP server for the group.
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client -d [-s
server:path] [-c server:path] [-p server:path] [-t install
boot image path] [-f boot file name] platform_name
platform_group
Use the following version of the add_install_client command
to add a single client to the install server. This client
will be booted and configured using DHCP. The script will
perform the necessary configuration steps on the server, and
will print the data that the user needs to add to the DHCP
server for the client. The -f flag used above needs to be
added to the existing usage as well. -f allows the user to
specify a boot file name to be used for a given client.
cdrom-mnt-pt/Solaris_XX/Tools/add_install_client -d [-s
server_name:path] [-c server_name:path] [-p
server_name:path] [-t install_boot_image_path] [-f
boot_file_name] -e Ethernet_address [-b property=value]
platform_group
Always use the -d option when registering x86 Architecture
Pre-boot eXecution Environment (PXE) clients. These clients
use DHCP for their configuration.
Use add_to_install_server to merge other Solaris CDs with an
existing image on a Net Install Server. Each CD that can be
merged (currently OS CD 2, and the Language CD) has its own
add_to_install_server script. Do not use
add_to_install_server scripts with CDs other than the ones
with which they were delivered.
Use check to validate the rules in a rules file (this is
only necessary if a custom JumpStart installation is being
set up).
Use modify_install_server to replace an existing net install
server's miniroot with a Solaris Installation CD's miniroot.
This will change the net install server's install time user
interface over to the Solaris Installation CD's Web Start
user interface.
An existing install image (created using
setup_install_server) must exist prior to using the
modify_install_server command.
Use rm_install_client to remove clients for network instal-
lation (these commands update the bootparams(4) file).
Use setup_install_server to copy the Solaris CD to a disk
(to set up an install server), to build a WANboot miniroot
image (to set up a WANboot install server), or to copy just
the boot software of the Solaris CD to a disk (to set up a
boot server). An install server is required to install
clients over the network. A boot server is also required for
network installations if the install server and clients to
be installed are on different subnets (the boot server must
be located on the client's subnet).
OPTIONS
The add_install_client supports the following options:
-b property=value
Set a property value in the client specific bootenv.rc
file located on the boot server's TFTP directory,
/tftpboot by default. Use this option to set boot pro-
perties that are specific to this client. You can use
the bootpath property to automate the selection of the
boot device instead of manually using the Device Con-
figuration Assistant. You can use the boot-args pro-
perty to automatically select a jumpstart installa-
tion. See eeprom(1M).
You can only use this option to the x86 client. You
should only use this option in conjunction with the -d
and -e options.
-c server_name:path
This option is required only to specify a JumpStart
directory for a custom JumpStart installation.
server_name is the host name of the server with a
JumpStart directory. path is the absolute path to the
JumpStart directory.
-d Specify as a DHCP client.
-e Ethernet_address
Specify the Ethernet address of the system to be
installed.
-f Specify the boot_file_name of the client to be
installed.
-i IP_address
Specify the IP address of the client to be installed.
-n [server]:name_service[(netmask)]
This option specifies which name service should be
used during system configuration. This sets the ns
keyword in the bootparams(4) file.
name_service
Valid entries are nis, nisplus, and none.
netmask
A series of four numbers separated by periods,
specifying which portion of an IP address is the
network part, and which is the host part.
server
The name of the server or IP address of the
specified name service. If the server specified
is on a different subnet, then the netmask may
be needed to enable the client to contact the
server.
-p server_name:path
This option is the location of the user-defined
sysidcfg file for pre-configuring system or network
information. server_name is either a valid host name
or IP address. path is the absolute path to the
Jumpstart directory.
-s server_name:path
This option is required only when using
add_install_client from a boot server. Specify the
name of the server and the absolute path of the
Solaris installation image that will be used for this
installation. path is either the path to a mounted
Solaris CD or a path to a directory with a copy of the
Solaris CD.
The add_to_install_server command supports the following
options:
-p Specifies the location of the CD (containing the sup-
plemental products) to be copied.
-s Allows users to select from a list only the products
needing installation.
The check command supports the following options:
-p install_dir_path
Validates the rules file by using the check script
from a specified Solaris installation image, instead
of the check script from the system you are using.
install_dir_path is the path to a Solaris installation
image on a local disk or a mounted Solaris CD.
Use this option to run the most recent version of
check if your system is running a previous version of
Solaris.
-r rulesfile
Specifies a rules file other than the one named rules.
Using this option, the validity of a rule can be
tested before integrating it into the rules file.
check will report whether or not the rule is valid,
but it will not create the rules.ok file necessary for
a custom JumpStart installation.
The modify_install_server command supports the following
options:
-p This option preserves the existing images miniroot in
install_dir_path/Solaris_XX/Tools/Boot.orig.
The setup_install_servercommand supports the following
options:
-b This option sets up the server only as a boot server.
-t This option allows an alternate miniroot to be speci-
fied.
-w This option builds a WANboot miniroot image.
OPERANDS
The add_install_client command supports the following
options:
host_name
This is the name of the client to be installed.
platform_group
Vendor-defined grouping of hardware platforms for the
purpose of distributing specific software. Examples of
valid platform groups are:
____________________________________________________________
| System | Platform Group |
| x86 | i86pc |
| Sun Fire 4800 | sun4u |
|_____________________________|_____________________________|
Use the uname(1) command (with the -m option) to
determine a system's platform group.
platform_name
Use the uname(1) command (with the -i option) to
determine a system's platform name.
The following example shows the use of the uname com-
mand to determine the system platform name for an
Ultra 1:
uname -i
The system responds with:
SUNW,Ultra-1
Therefore, the system's platform name is SUNW,Ultra1.
The following command calls add_install_client for
Ultra 1s:
add_install_client -d SUNW,Ultra-1 sun4u
For IA32 platforms, the platform name is always
SUNW.i86pc.
The following command calls add_install_client for
IA32 platforms:
add_install_client -d SUNW.i86pc i86pc
The rm_install_client command supports the following
operands:
host_name
This is the name of the client to be removed.
The setup_install_server command supports the following
operands:
install_dir_path
The absolute path of the directory in which the
Solaris software is to be copied. The directory must
be empty.
wanboot_image_path
The absolute path of the directory in which the file
containing the WANboot miniroot image is to be
created.
EXAMPLES
Example 1: Using add_install_client
The following add_install_client commands add clients for
network installation from a mounted Solaris CD on an install
server on Solaris 9:
example# cd /cdrom/cdrom0/s0/Solaris_9/Tools
example# ./add_install_client system_2/sun4u
Example 2: Using add_install_client
The following add_install_client commands add clients for
network installation from a mounted Solaris CD on an install
server. The -c option specifies a server and path to a
JumpStart directory that has a rules file and a profile file
for performing a custom JumpStart installation. Also, the
Solaris CD has been copied to the /export/install directory
on Solaris 9:
example# cd /export/install/Solaris_9/Tools
example# /add_install_client -c install_server:/jumpstart system_1 i86pc
example# ./add_install_client -c install_server:/jumpstart system_2 i86pc
Example 3: Using add_install_client
The following add_install_client command adds support for a
specific sun4u platform machine (8:0:20:99:88:77) using the
boot file: sun4u.solaris8.
example# add_install_client -d -f sun4u.solaris8 -e 8:0:20:99:88:77 sun4u
Example 4: Using add_install_client
The following add_install_client command adds x86 clients
that use the PXE standard for network booting:
example# add_install_client -d -s svrname:/mnt/export/root SUNW.i86pc i86p
Example 5: Using add_to_install_server
The following add_to_install_server command copies the pack-
ages in all the CD's products directories to an existing
install server on Solaris 9:
example# cd /cdrom/cdrom0/s0
example# ./add_to_install_server /export/Solaris_9
Example 6: Using check
The following check command validates the syntax of the
rules file used for a custom JumpStart installation:
example# cd jumpstart_dir_path
example# ./check -p /cdrom/cdrom0/s0
Example 7: Using modify_install_server
The following modify_install_server command moves the
miniroot created using the above setup_install_server to
Boot.orig and replaces it with the miniroot on the Solaris
Installer CD.
example# cd /cdrom/cdrom0/s0
example# ./modify_install_server -p /export/install /cdrom/cdrom0/s1
Example 8: Using modify_install_server
The following modify_install_server command replaces the
miniroot created using the above setup_install_server with
the miniroot on the Solaris Installer CD.
example# cd /cdrom/cdrom0/s0
example# ./modify_install_server /export/install /cdrom/cdrom0/s1
Example 9: Using rm_install_client
The following rm_install_client commands remove clients for
network installation on Solaris 9:
example# cd /export/install/Solaris_9/Tools
example# ./rm_install_client holmes
example# ./rm_install_client watson
Example 10: Using setup_install_server
The following setup_install_server command copies the
mounted Solaris CD to a directory named /export/install on
the local disk on Solaris 9:
example# cd /cdrom/cdrom0/s0/Solaris_9/Tools
example# ./setup_install_server /export/install
Example 11: Using setup_install_server
The following setup_install_server command copies the boot
software of a mounted Solaris CD to a directory named
/boot_dir on a system that is going to be a boot server for
a subnet on Solaris 9:
example# cd /cdrom/cdrom0/s0/Solaris_9/Tools
example# ./setup_install_server -b /boot_dir
Example 12: Using setup_install_server
By default, setup_install_server will look for an installa-
tion boot directory at the Solaris ../Tools/Boot location of
the mount Solaris distribution disc.
If an alternate boot directory is required, such as one
saved on a > network boot server by way of an earlier
./setup_install_server -b /boot_dir command, the -t option
can be used.
example# cd /cdrom/cdrom0/s0/Solairs_9/Tools
example# ./setup_install_server -t /boot_dir /export/install
Example 13: Using setup_install_server with WANboot Option
The following setup_install_server command creates an image
of the WANboot miniroot file systemand stores it in the file
/wanboot_dir/miniroot.
example# cd /cdrom/cdrom0/s0/Solairs_9/Tools
example# ./setup_install_server -w /wanboot_dir /export/install
Example 14: x86: Specifying a Serial Console to Use During a
Network Installation (CDs)
The following example illustrates how to add an x86 install
client to an install server and specify a serial console to
use during the installation. This example sets up the
install client in the following manner:
o The -d option indicates that the client is set up to
use DHCP to set installation parameters.
o The -e option indicates that this installation occurs
only on the client with the ethernet address
00:07:e9:04:4a:bf.
o The first and second uses of the -b option instruct
the installation program to use the serial port ttya
as an input and an output device.
install server# cd /export/boot/Solaris_9/Tools
install server# ./add_install_client -d -e "00:07:e9:04:4a:bf" \
-b "input-device=ttya" -b "output-device=ttya" \
i86pc
For a complete description of the boot property variables
and values you can use with the -b option, see eeprom(1M).
Example 15: Specifying a Boot Device to Use During a Network
Installation (CDs)
The following example illustrates how to add an x86 install
client to an install server and specify a boot device to use
during the installation. If you specify the boot device when
you set up the install client, you are not prompted for this
information by the Device Configuration Assistant during the
installation.
This example sets up the install client in the following
manner:
o The -d option indicates that the client is set up to
use DHCP to set installation parameters
o The -e option indicates that this installation occurs
only on the client with the ethernet address
00:07:e9:04:4a:bf.
o The first and second uses of the -b option instruct
the installation program to use the serial port ttya
as an input and an output device.
o The third use of the -b option instructs the installa-
tion program to use a specific boot device during the
installation.
o The value of the boot device path varies based on your
hardware..
o The i86pc platform name indicates that the client is
an x86-based system.
install server# cd /export/boot/Solaris_9/Tools
install server# ./add_install_client -d -e "00:07:e9:04:4a:bf" \
-b "input-device=ttya" -b "output-device=ttya" \
-b "bootpath=/pci@0,0/pci108e,16a8@8" i86pc
For a complete description of the boot property variables
and values you can use with the -b option, see eeprom(1M).
EXIT STATUS
The following exit values are returned:
0 Successful completion.
1 An error has occurred.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | Solaris CD |
|_____________________________|_____________________________|
SEE ALSO
uname(1), eeprom(1M), bootparams(4), attributes(5)
Solaris 9 9/04 Installation Guide
Man(1) output converted with
man2html