iPlanet Meta-Directory 5.0 Installation Guide: Chapter 4 Silent Installation

Previous Contents DocHome Next

iPlanet Meta-Directory 5.0 Installation Guide

Chapter 4 Silent Installation

iPlanet Meta-Directory gives the system administrator the option of installing Meta-Directory using a prepared instruction file. This "silent" installation allows the administrator to define the configuration information beforehand and use the file to remotely install the software or duplicate the installation process on a number of machines. This chapter contains the following sections:

The install.inf File

Directives

Creating an install.inf File

Using the install.inf File

Examples of install.inf Files

The install.inf File

The install.inf file is used for the silent installation of Meta-Directory. It is generated during the initial installation of Meta-Directory and can be modified for use during unattended installations. The basic format of the file is this:

[General]
directive= value
directive= value
directive= value
...
[base]
directive= value
directive= value
directive= value
...
[admin]
directive= value
directive= value
directive= value
....

The keywords [General], [base], and [admin] are required. These keywords identify a specific aspect of the installation process. The directives are more specific specifications of each keyword.

Directives

The directives used in install.inf are divided into four types identified by the keywords: [General], [Base], [admin] and [component].

General Directives

General installation directives specify information that will be common to all installations performed.

Table 4-1    [General] Installation Directives

Directive

Description

Components

This required directive specifies which of the following components will be installed:

srvrcore—uninstallation binaries

base—the base installation package

admin—the Administration Server binaries

ServerRoot

This required directive specifies the full path to where the selected Meta-Directory components are installed.

FullMachineName

This directive specifies the fully qualified domain name of the machine on which you are performing the silent installation. If this directive is not present, the Common Install Shell will query the machine for its name.

SuiteSpotUserID

For UNIX^® only, this directive specifies the name of the user under which Meta-Directory will run. The value is set to nobody on Windows NT systems.

SuiteSpotGroup

For UNIX^® only, this directive specifies the name of the group to which the SuiteSpotUserID belongs. The value is set to nobody on Windows NT systems.

ConfigDirectoryLdapURL

This required directive specifies the URL of the directory server used to manage the information and data. The URL is specified in the following format: ldap://<machinename>:<port>/<base DN>

AdminDomain

This directive specifies the administration domain under which this server will be registered.

ConfigDirectoryAdminID

This required directive specifies the user ID that has permission to access the configuration directory and the specified administration domain.

ConfigDirectoryAdminPwd

This required directive specifies the password for the user that has permission to access the configuration directory and the specified administration domain.

UserDirectoryLdapURL

This directive specifies the URL of the directory server in this installation which requires write access to the user directory.

UserDirectoryAdminID

This directive specifies the user ID of the user that has administration privileges to the user directory.

UserDirectoryAdminPwd

This directive specifies the password for the user that has administration privileges to the user directory.

Base Directives

The [base] installation directive determines which of the components needed for the iPlanet consoles will be installed.

Table 4-2    [base] Installation Directive

Directive

Description

Components

The values for this directive are one, two or all three of:

base—the shared libraries used by the iPlanet consoles

base-client—the Java runtime environment used by server consoles

base-jre—the Java runtime environment used by all other consoles

Admin Directives

The [admin] installation directives specify information needed by your administration server to manage the instance that is being installed.

Table 4-3    [admin] Installation Directives

Directive

Description

Components

This directive specifies which of the following admin components will be installed:

admin—installs the Administration Server. You must install the Administration Server in order to install and use other iPlanet servers.

admin-client—installs iPlanet Console. Do not install if you will remotely manage your servers from an instance of iPlanet Console elsewhere on your network.

SysUser

For UNIX^® only, this directive specifies the user for which the Administration Server will run. For default installations, this user must be root.

Port

This directive specifies the port that the Administration Server will use. Note that the Administration Server's host name is given by FullMachineName, one of the general directives.

ServerAdminID

This directive specifies the administration ID that is used to access the Administration Server when the configuration directory is not responding.

ServerAdminPwd

This directive specifies the password for ServerAdminID.

ServerIPAddress

This directive specifies the IP address that the Administration Server will listen to. Use this directive if you are installing on a system with more than one IP address and you do not want to use the first IP address for your Administration Server.

Component Directives

The [component] installation directives determine which, if any, of Meta-Directory's components will be installed. Each component is its own directive. They can include all or some of the components in Table 4-4. (For an understanding of how component directives are laid out, see Examples of install.inf Files.)

Table 4-4    [component] Installation Directives

Directive

Description

Components

These keywords specify the Meta-Directory component to be installed and have a value equal to themselves:

[nsperl]                           nsPerl (value includes a version number)

[join]   Join engine

[utc]      Universal connector

[metaconsole]      Meta-Directory console

[ntdc]      Windows NT domain connector

[adc]      Active Directory connector

[dbc]   Database connector

InstallType

This directive specifies the type of installation. The choices are New, Upgrade, Migrate, Extraction or Remove.

InstallUnitAction

This directive specifies the type of installation. The choices are None, Create, Migrate, Repair or Remove.

HaveReached

This directive always has the value True.

Note Disregard the sf. prefix in front of all component directives.

Creating an install.inf File

In order to create an install.inf file on a machine running the Solaris operating system, the installation setup must be executed using the -k command-line option:

setup -k

This installation will create the install.inf file which can be found at:

NETSITE_ROOT/setup/install.inf

Creating an install.inf file on Windows NT

There is only one way to create an install.inf file on Windows NT. You must start with the zipped binary Meta-Directory download. The install.inf file can not be created using the executable binary download.

Download the zipped version of the software.

Decompress the download.

Access the Command Prompt window under Start > Programs.

Execute the setup.exe file by typing setup -k.

Note

Only this procedure will create the install.inf file on Windows NT; starting the installation from the bundled executable binaries does not allow you to run setup -k in the Command Prompt and thus can not create the file.

Using the install.inf File

In order to use the install.inf file to perform installations on a number of machines, you need to make some changes to the file. This section describes these changes and tells you how to use the file for silent installation.

Changes On The install.inf File

Change the FullMachineName directive to the fully-qualified domain name of the new machine on which Meta-Directory will be installed.

Note Be aware that FullMachineName will default to the local host name.

Enter the path to the local machine in the ServerIPAddress directive.

Note iPlanet recommends the use of the ServerIPAddress directive only if you are installing Meta-Directory on a machine with multiple IP addresses.

Check that the installation path being used on the ServerRoot directive is system-appropriate. If you are installing on both Windows NT and UNIX machines, make sure the correct path delimiter is used. You might need to add or remove the Windows NT drive letter designation as appropriate.

UNIX Only: If you are installing more than one instance of Meta-Directory on the same host, check that the ServerRoot directive contains a unique value for each instance.

If you create your install.inf file on a Windows NT machine, then the SuiteSpotUserID and SuiteSpotGroup directives should be set to user nobody. If you subsequently use this file on a UNIX machine, ensure the user and group names chosen are appropriate for the machine. The SuiteSpotUserID and SuiteSpotGroup directives determine what user and group Meta-Directory will run under when installed on a UNIX system.

Caution
Be aware that the install.inf files contain server passwords and should be protected.

Installing with the install.inf File

To install using the install.inf file, run setup with the -s and -f command line options:

setup -sf install.inf

Examples of install.inf Files

This section provides examples of the install.inf files generated after an installation has been performed, one for Solaris and one for Windows NT.

Solaris install.inf File Example

The following is an example of an install.inf file generated during installation of Meta-Directory on a computer running the Solaris operating system.

Code Example 4-1    Solaris install.inf File

[General]

FullMachineName= lostland.red.iplanet.com

SuiteSpotUserID= etsai

SuitespotGroup= staff

ConfigDirectoryAdminID= admin

ConfigDirectoryAdminPwd= admin

ServerRoot= /usr/iPlanet/servers

AdminDomain= iplanet.com

MachineName= lostland

InstallTimeStamp= 20010404204346Z

Components= svrcore,base,admin,nsperl,join,utc,metaconsole,dbc

ConfigDirectoryLdapURL= ldap://lostland.red.iplanet.com:389/

LDAPPort= 389

LDAPHost= lostland.red.iplanet.com

AdminGroupDN= cn=Server Group, cn=lostland.red.iplanet.com, ou=iplanet.com,
    o=NetscapeRoot

[admin]

SysUser= root

Port= 6714

ServerIpAddress=

ServerAdminID= admin

ServerAdminPwd= admin

Components= admin,admin-client

[nsperl]

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Components= nsperl544,nsperl553

[join]

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Components= join

[utc]

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Components= utc

[metaconsole]

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Components= metaconsole

[dbc]

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Components= dbc

[base]

Components= base,base-client,base-jre

Windows NT install.inf File Sample

The following is an example of an install.inf file generated during installation of Meta-Directory on a computer running the Windows NT operating system.

Code Example 4-2    Windows NT install.inf File

[General]

AdminDomain= iplanet.com

Components=svrcore,base,admin,nsperl,join,utc,metaconsole,ntdc,adc, dbc

ServerRoot= c:\iPlanet\Servers

ConfigDirectoryLdapURL= ldap://lostland.red.iplanet.com:389/o=NetscapeRoot

ConfigDirectoryAdminID= uid=admin, ou=Administrators, ou=TopologyManagement,
    o=NetscapeRoot

ConfigDirectoryAdminPwd= admin

FullMachineName= bugsland.red.iplanet.com

SuiteSpotUserID= None

SuitespotGroup= None

SelectedComponents=svrcore,base,base-client,base-jre,admin,admin-client,nsperl
    544,nsperl553,join,utc,metaconsole,ntdc,adc,dbc

MachineName= bugsland

InstallTimeStamp= 20010405205612Z

[base]

Components= base,base-client,base-jre

[admin]

Components= admin,admin-client

Port= 6714

SysUser= root

ServerAdminID= uid=admin, ou=Administrators, ou=TopologyManagement,
    o=NetscapeRoot

ServerAdminPwd= admin

[nsperl]

Components= nsperl544,nsperl553

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[join]

Components= join

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[utc]

Components= utc

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[metaconsole]

Components= metaconsole

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[ntdc]

Components= ntdc

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[adc]

Components= adc

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

[dbc]

Components= dbc

sf.InstallUnitAction= Create

sf.HaveReached= True

sf.InstallType= New

Directive	Description
Components	This required directive specifies which of the following components will be installed: srvrcore—uninstallation binaries base—the base installation package admin—the Administration Server binaries
ServerRoot	This required directive specifies the full path to where the selected Meta-Directory components are installed.
FullMachineName	This directive specifies the fully qualified domain name of the machine on which you are performing the silent installation. If this directive is not present, the Common Install Shell will query the machine for its name.
SuiteSpotUserID	For UNIX^® only, this directive specifies the name of the user under which Meta-Directory will run. The value is set to nobody on Windows NT systems.
SuiteSpotGroup	For UNIX^® only, this directive specifies the name of the group to which the SuiteSpotUserID belongs. The value is set to nobody on Windows NT systems.
ConfigDirectoryLdapURL	This required directive specifies the URL of the directory server used to manage the information and data. The URL is specified in the following format: ldap://<machinename>:<port>/<base DN>
AdminDomain	This directive specifies the administration domain under which this server will be registered.
ConfigDirectoryAdminID	This required directive specifies the user ID that has permission to access the configuration directory and the specified administration domain.
ConfigDirectoryAdminPwd	This required directive specifies the password for the user that has permission to access the configuration directory and the specified administration domain.
UserDirectoryLdapURL	This directive specifies the URL of the directory server in this installation which requires write access to the user directory.
UserDirectoryAdminID	This directive specifies the user ID of the user that has administration privileges to the user directory.
UserDirectoryAdminPwd	This directive specifies the password for the user that has administration privileges to the user directory.

Directive	Description
Components	The values for this directive are one, two or all three of: base—the shared libraries used by the iPlanet consoles base-client—the Java runtime environment used by server consoles base-jre—the Java runtime environment used by all other consoles

Directive	Description
Components	This directive specifies which of the following admin components will be installed: admin—installs the Administration Server. You must install the Administration Server in order to install and use other iPlanet servers. admin-client—installs iPlanet Console. Do not install if you will remotely manage your servers from an instance of iPlanet Console elsewhere on your network.
SysUser	For UNIX^® only, this directive specifies the user for which the Administration Server will run. For default installations, this user must be root.
Port	This directive specifies the port that the Administration Server will use. Note that the Administration Server's host name is given by FullMachineName, one of the general directives.
ServerAdminID	This directive specifies the administration ID that is used to access the Administration Server when the configuration directory is not responding.
ServerAdminPwd	This directive specifies the password for ServerAdminID.
ServerIPAddress	This directive specifies the IP address that the Administration Server will listen to. Use this directive if you are installing on a system with more than one IP address and you do not want to use the first IP address for your Administration Server.

Directive	Description
Components	These keywords specify the Meta-Directory component to be installed and have a value equal to themselves: [nsperl] nsPerl (value includes a version number) [join] Join engine [utc] Universal connector [metaconsole] Meta-Directory console [ntdc] Windows NT domain connector [adc] Active Directory connector [dbc] Database connector
InstallType	This directive specifies the type of installation. The choices are New, Upgrade, Migrate, Extraction or Remove.
InstallUnitAction	This directive specifies the type of installation. The choices are None, Create, Migrate, Repair or Remove.
HaveReached	This directive always has the value True.

[General]
FullMachineName= lostland.red.iplanet.com
SuiteSpotUserID= etsai
SuitespotGroup= staff
ConfigDirectoryAdminID= admin
ConfigDirectoryAdminPwd= admin
ServerRoot= /usr/iPlanet/servers
AdminDomain= iplanet.com
MachineName= lostland
InstallTimeStamp= 20010404204346Z
Components= svrcore,base,admin,nsperl,join,utc,metaconsole,dbc
ConfigDirectoryLdapURL= ldap://lostland.red.iplanet.com:389/
LDAPPort= 389
LDAPHost= lostland.red.iplanet.com
AdminGroupDN= cn=Server Group, cn=lostland.red.iplanet.com, ou=iplanet.com, o=NetscapeRoot

[admin]
SysUser= root
Port= 6714
ServerIpAddress=
ServerAdminID= admin
ServerAdminPwd= admin
Components= admin,admin-client

[nsperl]
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New
Components= nsperl544,nsperl553

[join]
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New
Components= join

[utc]
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New
Components= utc

[metaconsole]
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New
Components= metaconsole

[dbc]
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New
Components= dbc

[base]
Components= base,base-client,base-jre

[General]
AdminDomain= iplanet.com
Components=svrcore,base,admin,nsperl,join,utc,metaconsole,ntdc,adc, dbc
ServerRoot= c:\iPlanet\Servers
ConfigDirectoryLdapURL= ldap://lostland.red.iplanet.com:389/o=NetscapeRoot
ConfigDirectoryAdminID= uid=admin, ou=Administrators, ou=TopologyManagement, o=NetscapeRoot
ConfigDirectoryAdminPwd= admin
FullMachineName= bugsland.red.iplanet.com
SuiteSpotUserID= None
SuitespotGroup= None
SelectedComponents=svrcore,base,base-client,base-jre,admin,admin-client,nsperl 544,nsperl553,join,utc,metaconsole,ntdc,adc,dbc
MachineName= bugsland
InstallTimeStamp= 20010405205612Z

[base]
Components= base,base-client,base-jre

[admin]
Components= admin,admin-client
Port= 6714
SysUser= root
ServerAdminID= uid=admin, ou=Administrators, ou=TopologyManagement, o=NetscapeRoot
ServerAdminPwd= admin

[nsperl]
Components= nsperl544,nsperl553
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[join]
Components= join
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[utc]
Components= utc
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[metaconsole]
Components= metaconsole
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[ntdc]
Components= ntdc
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[adc]
Components= adc
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

[dbc]
Components= dbc
sf.InstallUnitAction= Create
sf.HaveReached= True
sf.InstallType= New

Previous Contents DocHome Next
Copyright © 2001 Sun Microsystems, Inc. Some preexisting portions Copyright © 2001 Netscape Communications Corp. All rights reserved.

Last Updated August 03, 2001