Printable Communications Suite 6 Update 2 Installation Guide

Skip to end of metadata
Go to start of metadata

Sun Java Communications Suite 6 Update 2 Installation Guide

This document contains the following sections:

See also:

Sun Java Communications Suite 6 Update 2 Installation Overview

This document describes how to install specific Communications products on a specific machine (a machine can mean either a computer or a Solaris Zone). It is designed to be a low-level document describing the product installation tasks required for new deployments and upgrades. The following table shows the products that are available in the installer:

Communications Suite 6 Update 2 Products and Components
Product & Version
Sun Convergence 1 Update 2
Messaging Server 7 Update 2 (32-bit/64-bit)
Calendar Server 6.3
Instant Messaging 8 Update 1
Delegated Administrator 7
Communications Express 6.3
Comms DSsetup 6.4
Messaging Server Sun Cluster HA Agent 7.0
Calendar Server Sun Cluster HA Agent
Instant Messaging Sun Cluster HA Agent

The Communications Suite installer does not install the Sun Java System Connector for Microsoft Outlook or Sun Java System Communications Sync, although it will be on the distribution.

This document assumes you have already made your architectural and design decisions: for example, which products you want to install, the number of machines in your deployment, and the number of front-end and back-end servers. If you are still in the planning or evaluating process, see the following documents:

  • You also can use the Communications Suite 6 Update 2 Installation Flowchart to guide you to specific installation scenarios. The flowchart can help in the following ways:
    • Provides a decision tree for installing Communications Suite products and the Sun Java System products that support Communications Suite
    • Directs you to specific sets of installation instructions based on your decisions

The remainder of this document describes the steps for product installation, as follows:

1. Check That Your Platform and Operating System Support Communications Suite.
2. Install the Sun Java System Software Required to Run Communications Suite.
3. Define and Set Up Additional Requirements for Individual Communications Suite Products.
4. Install Communications Suite 6 Update 2 Products.
5. Prepare Directory Server for Communications Suite (run comm_dssetup.pl).
6. Gather Information Needed to Configure Communications Suite Products.
7. Create Initial Configurations for the Individual Communications Suite Products.

1. Check That Your Platform and Operating System Support Communications Suite.

The Sun Java Communications Suite 6 Update 2 runs on SPARC or x86 hardware running Solaris 9 or 10, or Red Hat Linux 3 or 4. The recommended platform is at least Solaris 10 08/07.

For details, see this list of operating system and platform requirements.

In addition, certain Communications Suite products have minimum disk and memory requirements. For details, refer to Memory and Disk Space Requirements for Communications Suite 6 Update 2.

2. Install the Sun Java System Software Required to Run Communications Suite.

The Communications Suite products require other Sun Java System software products to be installed before you install Communications Suite. The dependencies vary among the Communications products, but many have a common set.

Which Products Do You Need?

  • Sun Java System Directory Server Enterprise Edition 5.x or 6.x (6.3 or later is recommended)
  • Web container:
    • Sun Java System Web Server 7.0
    • Sun Java System Application Server 9.1 Update 2

      Download the following version: Application Server 9.1 Update 2 with High Availability Database (HADB) - Zip/File Based. This version provides shared components needed by Application Server and Communications Suite. Note: You can configure this version of Application Server without using the HADB.
  • Sun Java System Access Manager

    Access Manager (AM) is optional for Convergence to support AM authentication and/or AM SSO.

The following table shows the software required by each product.

Software Requirements for Communications Suite 6 Update 2 Products
Communications Suite Product Directory Server Web Container Access Manager
Convergence Yes Application Server 9.1 U2 only Optional. Required only if you want to use Access Manager for authentication and/or SSO.
Messaging Server Yes No Optional
Calendar Server Yes No Optional
Instant Messaging Yes 1 Optional
Delegated Administrator Yes 1 Optional
Communications Express Yes 1 Yes if want use Schema 2. Optional for Schema 1.

1 - Web Server 7.0 update 1, Application Server 8.2P2, or Application Server 9.1 Update 2 (recommended)

For more information about software product dependencies, see Product Version Compatibility.

For products needed to deploy Convergence, see the Product Version Compatibility Requirements for Convergence 1 Update 2.

  • Note: The Communications Suite installer does install Message Queue 4.3, Security NSS, and other shared components.

Where Do You Go to Install the Sun Java System Products?

The Communications Suite installer does not install these software products. To install these products, perform the following steps:

  1. Download the software.
    For links to download sites, go to Get the Software.
  2. Install Application Server 9.1 Update 2 with High Availability Database (HADB) - Zip/File Based.
    This version provides shared components needed by Application Server and Communications Suite. Note: You can configure this version of Application Server without using the HADB.
    Note
    Download the Application Server software zip file from the Communications Suite download site. Do not install the version of Application Server bundled with JES 5 Update 1. That is an older version of Application Server.

    Follow the instructions in the Sun Java System Application Server 9.1 Update 2 Installation Guide. Install Application Server before you install the other Sun Java System products.
    To verify which version of Application Server you have installed, see Verify Application Server Version.

  3. Install Directory Server 6.3 or later.
    Note
    Download Directory Server Enterprise Edition 6.3 (or later) from the Communications Suite download site before you run the JES 5 Update 1 installer. Do not install the Directory Server software bundled with JES 5 Update 1. That is an older version of Directory Server.

    If you already started with an older DSEE version, you can still upgrade to the recommended DSEE 6.3. You must apply an upgrade patch as well as other patches to upgrade to DSEE 6.3.

    For example, if you obtained the native package format of DSEE on the Solaris 10 x86 or SPARC platform, you must start by installing the DSEE 6.2 version bundled with JES 5 Update 1, then upgrade to DSEE 6.3.

    The simplest approach is to download and install the zip file version of DSEE 6.3 directly from the Communications Suite download site.

    To install Directory Server, follow the instructions in the Sun Java System Directory Server Enterprise Edition 6.3 Installation Guide.

  4. Install the following products by running the JES 5 Update 1 installer:

3. Define and Set Up Additional Requirements for Individual Communications Suite Products.

In addition to the generic suite requirements, some products might have specific requirements. For details about individual product requirements, see the Communications Suite 6 Update 2 Release Notes.

Messaging Server

  • You must ensure DNS is running and configured properly. For details, see DNS configuration.
  • Recommended file systems for the message store are listed in Message Store File Systems.
  • Make sure you do not configure conflicting port numbers on a machine when various components are running on a single machine. For a list of port numbers used by Messaging Server, see Default Port Numbers.

Calendar Server

4. Install Communications Suite 6 Update 2 Products.

After the platform and software requirements have been met (as described previously), take these steps:

  1. Download the software.
    To download Communications Suite, including the installer, go to Get the Software.
  2. Run the installer.
    The installer is a single unified utility called commpkg. It installs (but does not configure) the Communications Suite products. commpkg does all the necessary preparation work before installing the product software on the system. Run the following command:
    ./commpkg install

For step-by-step instructions, see To Run the Communications Suite Installer.

For details about other features of the commpkg installer, see the following information:

Note
To install the localization version of Communications Express, you must install a localization patch. For details, see Installing the Localization Version of Communications Express.

Sample Sessions: Running commpkg

The following examples document the output of running commpkg:

5. Prepare Directory Server for Communications Suite (run comm_dssetup.pl).

All Communications Suite components require that you run the comm_dssetup.pl script against Directory Server. For example:

cd INSTALLROOT/dssetup/sbin
./comm_dssetup.pl

For detailed instructions, see the following:

Note
If you install or upgrade Directory Server before you run the Communications Suite installer, the Directory Server installation process places an outdated version of comm_dssetup.pl on your system. You must use the current version of comm_dssetup.pl provided by the Communications Suite installer. However, the Comms Suite installer cannot install a new version with the commpkg install command. Instead, run the commpkg upgrade command to upgrade to the latest version of comm_dssetup.pl. If you install comm_dssetup.pl with the Comms Suite installer before you install Directory Server, you will have the up-to-date version. The DS installation process does not overwrite the latest version.

6. Gather Information Needed to Configure Communications Suite Products.

Before you run a configuration program, you need to gather specific configuration information for each product. Use the following worksheets:

7. Create Initial Configurations for the Individual Communications Suite Products.

For each Communications Suite product, you must run a separate configuration program. Each configuration program creates an initial runtime configuration to make the product operational. The program provides a generic, functional server configuration, which you can refine by making specific configurations and customizations.

You will typically want to configure the back-end servers before configuring clients. Client configurations require certain server attributes to be defined.

Delegated Administrator 7:

Run the initial configuration program:

INSTALLROOT/da/sbin/config-commda

For detailed instructions, see Delegated Administrator 7 Initial Configuration.

Messaging Server 7 Update 2:

Run the initial configuration program:

For 32-bit: INSTALLROOT/messaging/sbin/configure

For 64-bit: INSTALLROOT/messaging64/sbin/configure

For detailed instructions, see Messaging Server 7 Update 2 Initial Configuration.

Calendar Server 6.3:

Run the initial configuration program:

For Solaris: INSTALLROOT/calendar/SUNWics5/cal/sbin/csconfigurator.sh

For Linux: INSTALLROOT/calendar/calendar/sbin/csconfigurator.sh

For detailed instructions, see Calendar Server 6.3 Initial Configuration.

Instant Messaging 8 Update 1:

Run the initial configuration program:

INSTALLROOT/im/sbin/configure

For detailed instructions, see Instant Messaging 8 Update 1 Initial Configuration.

Convergence 1 Update 2:

Run the initial configuration program:

INSTALLROOT/iwc/sbin/init-config

For detailed instructions, see Convergence 1 Update 2 Initial Configuration.

Communications Express 6.3:

Run the initial configuration program:

INSTALLROOT/ce/sbin/config-uwc

For detailed instructions, see Communications Express 6.3 Initial Configuration.

Messaging Server Sun Cluster HA Agent 7.0:

Run the initial configuration program:

msg_scha_base/bin/init-config

This command registers the HA agent with the Sun Cluster HA software. Note that you must have the Sun Cluster HA software installed prior to issuing this command.

For more information about configuring the Messaging Server Sun Cluster HA agent, see Configuring Messaging Server for High Availability.

Calendar Server Sun Cluster HA Agent:

Run the initial configuration program:

cs_scha_base/bin/init-config

This command registers the HA agent with the Sun Cluster HA software. Note that you must have the Sun Cluster HA software installed prior to issuing this command.

For more information about configuring the Calendar Server Sun Cluster HA agent, see Configuring Calendar Server Software for High Availability (Failover Service).

Instant Messaging Sun Cluster HA Agent:

Run the initial configuration program:

im_scha_base/bin/init-config

This command registers the HA agent with the Sun Cluster HA software. Note that you must have the Sun Cluster HA software installed prior to issuing this command.

For more information about configuring the Instant Messaging Sun Cluster HA agent, see Configuring Instant Messaging for High Availability.

Uninstalling Communications Suite

To uninstall the Communications Suite products installed on the local machine, run the following command:

cd INSTALLROOT/CommsInstaller/bin
./commpkg uninstall

For detailed instructions, see the following:

Deployment Examples: Installation

To come.

Getting Information About Which Products Are Installed

To determine the Communications Suite software components installed on the machine, run the following command:

./commpkg info --verbose

This command prints product information installed in the INSTALLROOTS. To print information about one product, run this command:

./commpkg info --verbose installroot|product name

For details about the commpkg info command, see the following:

To determine which version of Application Server you have installed, see Verify Application Server Version.

Additional Communications Suite 6 Update 2 Installation Information

The following information is what is linked to in the main body of this Installation Guide. The information is organized alphabetically by title.

Calendar Server Pre-Installation Planning

This article describes considerations you need to think about before installing Calendar Server. It contains the following sections:

Planning for Calendar Server Administrators

Administrators for Calendar Server include:

Calendar Server Administrator (calmaster)

The Calendar Server administrator is a specific user name with its associated password that can manage Calendar Server. For example, a Calendar Server administrator can start and stop Calendar Server services, add and delete users, create and delete calendars, and so on. This user has administrator privileges for Calendar Server but not necessarily for the directory server.

The default user ID for the Calendar Server administrator is calmaster, but you can specify a different user during Calendar Server configuration, if you prefer. After installation you can also specify a different user in the service.admin.calmaster.userid parameter in the ics.conf file.

The user ID you specify for the Calendar Server administrator must be a valid user account in your directory server. If the Calendar Server administrator user account does not exist in the directory server during configuration, the configuration program can create it for you.

See the Sun Java System Calendar Server 6.3 Administration Guide for the complete list of Calendar Server administrator configuration parameters in the ics.conf file.

Calendar Server User and Group

On Solaris OS systems, these special accounts are the user ID and group ID under which Calendar Server runs. Use the default values, icsuser and icsgroup, which are automatically created by the configuration program, if they do not exist. If you prefer, however, you can specify values other thanicsuser and icsgroup when you run the Calendar Server configuration program. These values are stored in the local.serveruid and local.servergid parameters, respectively, in the ics.conf file.

Superuser (root)

On machines running Solaris OS software, you must log in as or become superuser (root) to install Calendar Server. You can also run as superuser to manage Calendar Server using the command-line utilities. For some tasks, however, you should run as icsuser and icsgroup (or the values you have selected) rather than superuser to avoid access problems for Calendar Server files.

Planning for Calendar Server Hosted Domains

Calendar Server supports hosted (or virtual) domains. In a hosted domain installation, each domain shares the same instance of Calendar Server, which enables multiple domains to exist on a single server. Each domain defines a name space within which all users, groups, and resources are unique. Each domain also has a set of attributes and preferences that you specifically set.

To configure hosted domains on a server, you should make these deployment choices:

  • Use Schema 2 only.
  • Install and configure Directory Server.
  • Install and configure a web container:  Application Server or Web Server.
  • Install and configure Access Manager.
  • Install and configure Delegated Administrator as part of the Communications Suite. Use the compkg installer to install Delegated Administrator, Calendar Server, and any other Communications Suite components you require.

For instructions on installing and configuring the components listed above, see the related articles in the Installation Guide.

Next, take the following configuration steps:

Communications Suite Installer: General Syntax and Commands

The Communications Suite installer, commpkg, comprises several commands (verbs) that enable you to install, uninstall, and upgrade Communications Suite products and shared components.

Communications Suite Installer: Syntax

The following syntax applies to the Communications Suite installer in general:

commpkg [general options] verb [verb-specific options]
Communications Suite Installer: General Options

The general options for the installer are:

Option Description
-? or --help Displays Help.
-V or --version Displays the Communications Suite Installer version.
--OSversionOverride Overrides the operating-system version check.
--fixEntsys [y|n] Fix an invalid Sun Java Enterprise System (Java ES) entsys symlink, making the link point to the latest Java version upgraded by commpkg. The Java ES symlink is located in /usr/jdk/entsys-j2se. Choose --fixEntsys y to fix the Java ES symlink to the Java files.
If you do not specify this switch, commpkg prompts you if the symlink is invalid. However, in silent mode, the default is not to fix the symlink (the equivalent of using a value of n). To fix the symlink in silent mode, enter commpkg install --fixEntsys y --silent INPUTFILE on the command-line.
Communications Suite Installer: Verbs

The verb is one of the following:

Verb Description
install Performs Communications Suite installation
uninstall Performs Communications Suite uninstallation
info Displays Communications Suite information
upgrade Performs Communications Suite upgrade
verify Verifies installed products

Communications Suite Installer: Commands

For information about the commpkg commands (verbs) and their options, see

commpkg info Usage

The commpkg info command obtains information about

  • The paths (installroots) where Communication Suite products are installed
  • The products that are installed in those paths

You can also use the command to repair the software list by adding known installroots and deleting bogus installroots in the software list. It is one of the commands available with the Communications Suite installer, commpkg.

Communications Suite Installer Verbs

For information about the commpkg general syntax, other commands and options, see:

commpkg info Syntax

commpkg info [options] [installroot|name]

The installroot|name specifies an installroot or name from the software list. The name is a friendly, shorthand name in the software list that indicates the installroot to use. If you enter a name that does not exist in the software list, an error results. If no installroot or name is specified, the commpkg info command prints information on all the installroots listed in the software list.

If installroot is specified and does not exist in the software list, and is a valid alternate root, the commpkg info command adds the installroot to the software list.

To specify the default root, use "/" or "". The friendly name for the default root is "".

commpkg info Options

The following options are used by the commpkg info command:

commpkg install options Description
-? or --help Displays Help
-V or --version Displays Version of Communications Suite components
--clean Removes entries in the software list when the corresponding products are not actually installed.
If installroot|name is specified, this option removes the entry from the software list.
If no installroot|name is specified, the option removes all entries from the software list.
--listPackages Lists the packages that make up each Communications Suite product, shared component, and OS Auxiliary product. This option also displays the mnemonic for each Communications Suite product or component such as comm_dssetup.pl.

Commpkg Install Usage

The commpkg install command enables you to install the Communications Suite products and shared components. It is one of the commands available with the Communications Suite installer, commpkg.

This command lays down the Communications Suite components' installation bits on your machine, but it does not configure these components. To configure the components after installation, see Initial Configuration.

For information about the commpkg general syntax, other commands and options, see:

Tip
Installing Only Shared Components: To install just the shared components for a component product, launch the Communications Suite installer then prefix your product selection with a tilde (~). For example, to install only the shared components for Messaging Server 32-bit, at the Product Selection prompt, you would type ~1. You can type multiple selections, using a comma to separate your entries.

Commpkg Install Command: Syntax

commpkg install [options] [installroot|name]

Using the installroot|name Command-Line Argument

If you specify installroot|name on the command line, it is equivalent to specifying the --altroot and --installroot options. That is, the command-line argument implies an altroot installation. For example, specifying

commpkg install /opt/sun/comms2

is equivalent to specifying

--altroot --installroot /opt/sun/comms2 

For details about these options, see Commpkg Install Command: Options.

Specifying an installroot of / is same as specifying the default root. It is the same as using neither the --installroot nor the --altroot option, or of not specifying the installaroot|name command-line argument at all.

If you specify the --installroot option in addition to the installroot|name command-line argument, they must match.

Using the name Argument (Instead of installroot)

If you specify the name command-line argument and it exists in the software list, the corresponding installroot is used and --altroot is implied.

If you also specify the --installroot option, it must correspond to the entry in the software list. If you specify name and it does not exist in the software list, it will be added to the software list.

Specifying any name other than "" implies an --altroot. A value for name of "" is reserved for the default root. Therefore, "" cannot be used with --altroot.

Commpkg Install Command: Options

The following options are used by the commpkg install command:

commpkg install options Description
--help or -? Prints help information
--version or -V Prints version information
--excludeOS Do not apply operating system patches during product installation
--excludeSC Do not install, upgrade, or patch any Shared Components
--acceptLicense Accepts the license conditions in the LICENSE.txt file
--altroot [name] Specifies an alternate root directory during a multi-host installation. The INSTALLROOT (the top level installation directory for all products and shared components) will be the alternate root.

If you specify a name, it will be a friendly name associated with the altroot that will be registered in the software list. The name option is supported on Solaris OS only (not on Red Hat Linux).

You can use this option to install multiple instances of Communications Suite products on the same host or Solaris zone. You use this option to perform a side-by-side upgrade of Communications Suite products.|

--distro path Specify the path to packages/patches for the products

Default: Location of commpkg script
--installroot path Specify the path of INSTALLROOT, the top level installation directory for Communications Suite products and shared components.

Default INSTALLROOT on Solaris and Linux: opt/sun/comms

The subdirectories for individual Communications Suite products are installed under the INSTALLROOT. For example, Messaging Server (32-bit) software is installed by default in opt/sun/comms/messaging.
--silent INPUTFILE Run silent installation, taking the inputs from the INPUTFILE and the command line arguments. The command line arguments override entries in the INPUTFILE. Installation proceeds without interactive prompts.

Use --dry-run to test silent installation without actually installing the software.

When running a silent installation, you must use the --acceptLicense option in the command line or set ACCEPTLICENSE=YES in the INPUTFILE.

Specify NONE for INPUTFILE if you want to run in silent mode without using an input file. When you specify NONE, the installation uses default values.

For more information about running a silent installation, see Installing Communications Suite in Silent Mode.
--dry-run or -n Does not install Communications Suite components. Performs checks.
--upgradeSC [y|n] Indicate whether or not to upgrade shared components as required.

Note: If this option is not specified, you will be prompted for each shared component that needs to be upgraded.

Default: n
Caution
Upgrading shared components is irreversible. However, if you do not upgrade required shared components, products might not work as designed.


The --excludeSC flag has precedence over this flag.

--auditDistro Audit the installation distribution to verify that the required patches and packages are present and that the packages have the correct versions. Compares the installed distribution to the product files internal to commpkg.
--pkgOverwrite Overwrite the existing installation package. You might use this option when you are installing a shared component in a global zone where either the shared component does not exist in a global zone, or the shared component exists in the whole root zone. The default is not to override the existing package. In general, shared components should be managed in the global zone.
--components <comp1 comp2 ...> A space delimited set of component products. Each product has mnemonic associated with it. Use commpkg info --listPackages to see the mnemonic for a product. In most shells you need to escape the space between each mnemonic, that is, by adding double quotes around all the components.

Commpkg Uninstall Usage

The commpkg uninstall command enables you to uninstall the Communications Suite products and shared components. It is one of the commands available with the Communications Suite installer, commpkg.

For information about the commpkg general syntax, other commands and options, see:

Uninstalling Communications Suite Components

To uninstall one or more Communications Suite component, change to the INSTALLROOT/CommsInstaller/bin/ directory and run commpkg uninstall.

This command uninstalls the same products that commpkg install installs. However, it does not remove OS patches installed by commpkg install. In addition, it does not remove Shared Components.

Note
A fast way to uninstall a Communications Suite component in an alternate root is to simply remove the entire alternate root.

Commpkg Uninstall Command: Syntax

commpkg uninstall [options] [installroot|name]

If you specify installroot|name on the command line, it is equivalent to specifying the --rootdir option with either the specified installroot or the installroot corresponding to name in the software list. That is, the value must be consistent.

If you specify name, it must exist in the software list. Otherwise, an error is returned immediately. The name is looked up in the software list and is used for the installroot.

Commpkg Uninstall Command: Options

The following options are used by the commpkg uninstall command:

commpkg uninstall options Description
--silent INPUTFILE Runs the uninstaller silently, taking the inputs from the INPUTFILE and the command line arguments. The command line arguments override entries in the INPUTFILE. Uninstallation proceeds without interactive prompts.

Use --dry-run to test silent uninstallation.
--dry-run or -n Does not uninstall the Communications Suite components. Performs checks. Silent uninstallation INPUTFILE is created in /tmp.
--rootdir path This option is deprecated in favor of using the installroot or name command-line argument.
This option specifies the path of rootdir, the alternate root used for multi-installation. Supported on Solaris only.
Unable to render {include} Couldn't find a page to include called: Communications Suite Directory Server Setup Script (commdssetup)

Calendar Server Configuration Script Worksheet

Print and fill out this worksheet to use when responding to the Calendar Server csconfigurator.sh script configuration options.

Option Default Value Fill in Your Site's Value (to Respond to the Script)
LDAP Server Host Name FQDN of your host  
LDAP Server Port 389  
Directory Manager DN cn=Directory Manager  
Directory Manager Password  
Enable Virtual Domains support Checked  
Virtual Domains setting: Default domain your domain  
Calendar Administrator Username calmaster  
Calendar Administrator Password  
Calendar Administrator Email address calmaster@your domain  
Site administrator Yes  
Set up a Front End/Back End deployment Unchecked  
Email Alarms Enabled  
Administrator Email Address calmaster@your domain  
SMTP Host Name your domain  
Service Port 80  
Maximum Sessions 5000  
Maximum Threads 20  
Number of server processes 4  
Runtime User ID icsuser  
Runtime Group ID icsgroup  
Start Calendar Server after Successful Configuration Unchecked  
Start Calendar Serve on System Startup Checked  
Configuration Directory /etc/opt/calendar/SUNWics5/config  
Database Directory /var/opt/calendar/SUNWics5/csdb  
Attachment Store Directory /var/opt/calendar/SUNWics5/astore  
Logs Directory /var/opt/calendar/SUNWics5/logs  
Temporary Files Directory /var/opt/calendar/SUNWics5/tmp  
Enable Archive Checked  
Archive Directory /var/opt/calendar/SUNWics5/csdb/archive  
Enable Hot Backup Checked  
Hot Backup Directory /var/opt/calendar/SUNWics5/csdb/hotbackup  
Keep archives for (in days) Minimum: 3, Maximum: 6  
Keep hot backups for (in days) Minimum: 3, Maximum: 6  
Same as archive checkbox Checked  
Note
Do not change the location or names of the logs and temporary files directories.

config-uwc Script Worksheet

Print and fill out this worksheet to use when responding to the config-uwc script configuration options. You use config-uwc to configure Communications Express.

Option Default Value Fill in Your Site's Value (to Respond to the Script)
Directory to store configuration and data files uwc-deployed-dir i,e /var/opt/sun/comms/ce  
Hostname your hostname  
DNS Domain your DNS domain  
Web Container your web container  
Application Server Installation Directory /opt/SUNWappserver  
Application Server Domain Directory /opt/SUNWappserver/domains/domain1  
Application Server Document Root Directory /opt/SUNWappserver/domains/domain1/docroot  
Server Target Name server  
Virtual Server Identifier server  
HTTP Port 80  
Administration Server Port 8800  
Administrator User ID admin  
Administrator Password  
Secure Administration Server Instance Unchecked  
Web Container User ID your web container user ID  
Web Container Group IP your web container group ID  
URI Path /uwc  
Enable Hosted Domain Support Checked  
URL of Directory Server ldap://your host:389/  
Bind DN cn=Directory Manager  
Password  
DC Tree suffix your suffix  
Default Domain your domain  
Enable Access Manager for Single Sign-On Unchecked  
Webmail Server Host Name FQDN of your host  
Webmail Server Port Number 8990  
Enable login in secure mode Unchecked  
Webmail Server SSL Port Number 8991  
Webmail Admin User ID  
Admin Password  
Calendar Server Hostname FQDN of your host  
Calendar Server Port 9004  
Calendar Admin User ID calmaster  
Calendar Administrator User Password  
URL of PAB Directory Server ldap://FQDN of your host:389/  
Bind As cn=Directory Manager  
Password  

Sun Convergence Configuration Worksheets

Before you configure Convergence, you should gather configuration information.

Worksheet 1-1 lists the configuration options required for Convergence.

Worksheet 1-2 lists the configuration options required by Convergence to be deployed to Sun Java TM System Application Server 9.1 Update 2.

Print and fill out these worksheets to use when responding to the Convergence init-config script configuration options.

Worksheet 1-1. Convergence: Configuration Options
Option Description and Default Value Fill in Your Site's Value (to Respond to the Script)
Configuration Directory Directory to store configuration and data files. Default directory (on Solaris and Linux): /var/opt/sun/comms/iwc. This directory should be different than the iwc-base directory. (On Solaris and Linux, this is /opt/sun/comms/iwc by default).  
Convergence server host name Host name of the machine where the Convergence software is installed. For example: mymachine.  
DNS domain name The DNS domain for the host machine where the Convergence software is installed. For example: siroe.com.  
Convergence URL URL where Convergence will be deployed. Enter the portion of the URI following the host name:port number For example: /iwc.  
Hosted domain support? Select this option only if you have configured hosted domain support for Calendar Server.  
User/Group LDAP URL Enter the Directory Server host and port where the User/Group is located. The URL should be in the format: ldap://LDAP host name with FQDN:LDAP port number. For example: ldap://siroe.com:389  
Bind DN Enter the LDAP DN to be used to bind to the Directory Server managing the User/Group data. This is the User/Group Directory Manager. For example: "cn=Directory Manager".  
Bind password Password for the Bind DN. Use the password defined in Directory Server for the Bind DN.  
DC Tree suffix For Schema 1 configurations, this option specifies the base distinguished name (DN) of the DC Tree root suffix. For Schema 2 configurations, this option specifies the base DN of the root suffix under which the User/Group tree is located. You must enter a value for this option whether you are using Schema 1 or Schema 2. For example: o=isp  
Default domain name When a user logs in to Convergence without including a mail domain component in the user name, this domain is used by default to supply the fully qualified domain name. For example: sesta.com. In this example, if a user logs in as fred, the user name is qualified as fred@sesta.com.  
Webmail host name Host name where Messaging Server is installed. For example: ms.sesta.com.  
Webmail port number Messaging Server HTTP (mshttpd) port number. For example, the default is: 8990.  
Webmail SSL port number Messaging Server SSL port number. Only needed if you enable login in secure mode.  
Webmail Admin user ID and password Messaging Server administrator user ID and password. For example: admin.  
Calendar Server host name Host name where Calendar Server is installed. For example: cs.siroe.com.  
Calendar Server port number Calendar Server HTTP port number. For example: 8004. Default: 80.  
Calendar Server SSL port number Calendar Server SSL port number. Only needed if you enable login in secure mode.  
Calendar Server Admin user ID and password Calendar Server administrator user ID and password. For example: calmaster.  
IM domain name Domain name of the Instant Messaging Server. For example varrius.com.
IM host name Host name where Instant Messaging is installed. For example: im.varrius.com.  
IM port number Instant Messaging HTTP port number. For example: 5269. Default: 5269.  
IM Httpbind Component JID Instant Messaging Server httpbind component jid. For example: httpbind.varrius.com.  
IM Httpbind Component password Instant Messaging Server httpbind component password.  
IM Avatar Component JID Instant Messaging Server avatar component jid. For example: avatar.varrius.com.  
IM Avatar Component password Instant Messaging Server avatar component password.  
Convergence administrator username Administrator username. For example admin.  
Convergence administrator password Administrator password.  
Worksheet 1-2. Sun Java System Application Server 9.1 Update 2 Configuration Options

These are the Application Server-specific options you are asked to enter when you run the Convergence init-config script.

Option Description Fill in Your Site's Value (to Respond to the Script)
Application Server 9.1 installation directory Directory where Application Server is installed. By default, this directory is /opt/SUNWappserver.  
Application Server 9.1 domain directory By default, this directory is /opt/SUNWappserver/domains/domain1.  
Application Server 9.1 document root directory By default, this directory is /opt/SUNWappserver/domains/domain1/docroot  
Application Server 9.1 target name Name of the instance. For example: server.  
Virtual server identifier Name of the Application Server 9.1 virtual server identifier. For example: server.  
Application Server 9.1 server instance HTTP port number HTTP port number for the Application Server server instance (target). Default port number: 8080.  
Administration Server port number Port number for the Administration Server instance for Application Server 9.1. For example: 4848.  
Administrator Server user ID and password. User ID and password for the Administration Server administrator. User ID example: admin  
Secure Administration Server Instance You will need to specify whether the HTTP access to the Administration Server instance is secure (HTTPS) or not (HTTP).
By default, the Secure Administration Server Instance box shown in the Convergence init-config program is checked. If your access is not secure, uncheck the box.
 
Unable to render {include} Couldn't find a page to include called: Configuration Worksheets - Delegated+Administrator

Configuration Worksheets - Instant Messaging

You should gather this information before you begin. You will be prompted for some or all of the information depending on the components you installed.

Print out the following worksheet and write the values for your deployment in the space provided. You can reuse this checklist for multiple installations of Instant Messaging. This table contains passwords and other sensitive information, so you should store this information in a safe place.

(Solaris Only) If you will be configuring High Availability service for Instant Messaging, see Instant Messaging HA Overview for specific information about values you can use for these parameters and additional parameters for your checklist.

Configuration Parameters for Instant Messaging
Parameter Description Your Value
Installation Directory im-svr-baseDirectory in which Instant Messaging is installed. By default, Instant Messaging is installed into the /opt directory as follows:
Solaris and Linux: /opt/sun/comms/im (Solaris Only) If you will be configuring High Availability service for Instant Messaging, see Selecting the Installation Directory (im-svr-base) for information about choosing an installation directory.
 
Instant Messaging Server Domain Name Domain name for the users being served by this server.
Default: None
 
Multiplexor Port Number
(Multiplexor Configuration Only)
The port number on which the Instant Messaging Server listens for incoming requests from Instant Messenger clients.
Default: 5222
 
Multiplexed XMPP Port Port on which the server listens for multiplexor connections
Default: 45222
 
Disable Server Select this option if the instance you installed will act as a multiplexor and not a server. If you select this option, you must provide a value for Remote Instant Messaging Server Host Name.  
Remote Instant Messaging Server Host Name
(Multiplexor Configuration Only)
The host name of the Instant Messaging Server for which this multiplexor routes messages. If the multiplexor and server are installed on the same host, use localhost. (Solaris Only) If you will be configuring High Availability service for Instant Messaging, use the logical host's name.
Dependencies: The Disable Server parameter must be selected, that is, server functionality is disabled.
 
Enable Email Integration, Enable Email Archiving
(Optional)
If selected, enables Instant Messaging email archiving. Sun Java System Portal Server search-based archiving for Instant Messaging.
Dependencies: SMTP Server such as Sun Java System Messaging Server
Alternatively, you can manually enable Sun Java System Portal Server search-based archiving for Instant Messaging.
Dependencies: Sun Java System Portal Server and Sun Java System Access Manager.
 
LDAP Host Name In a deployment with an LDAP server, the host name of the LDAP server that contains user and group information for Instant Messaging. For example, directory.siroe.com.
Dependencies: LDAP server such as Sun Java System Directory Server.
 
LDAP Port Number In a deployment with an LDAP server, the port number on which the directory server listens for incoming requests. For example, 389
Dependencies: LDAP server such as Sun Java System Directory Server.
 
Bind DN In a deployment with Sun Java System Access Manager, during installation, you must provide the Directory Manager Bind DN and password. This Bind DN is used to update the directory schema with the Instant Messaging and presence service templates and attributes only. This requires Directory Manager access. The Directory Manager Bind DN and password are not saved or used beyond installation and initial configuration.
In a deployment with an LDAP server but without Access Manager, Instant Messaging uses this Bind DN to search users and groups in the directory. Leave this blank if the directory can be searched anonymously. You can change the bind credentials later if required as described in To Configure Bind Credentials for the Instant Messaging Server.
Dependencies: LDAP server such as Sun Java System Directory Server.
 
Bind Password In a deployment with an LDAP server, the Bind DN password.  
SMTP Server Host Name
(Optional)
The host name of the SMTP server used to send email notification of messages to offline users. For example, mail.siroe.com. If the SMTP server does not use port 25, specify the port along with the host name. For example, if the SMTP server uses port 1025:
mail.siroe.com:1025Dependencies: SMTP server such as Sun Java System Messaging Server.
 
Database, Logs, and Runtime Files Pathname The location where the runtime files, database, and logs are stored. Also referred to as im-runtime-base. Runtime files are read, created, and modified by the server during its normal operations. Some examples include log files, and persistent state information tied to client actions such as alert messages, roster information, conferences, news channels, and so on.
If you are configuring High Availability (HA) for Instant Messaging, this path must be globally available. See Chapter 4, Configuring Instant Messaging for High Availability (Solaris Only) for more information about HA.
The configure utility appends a directory (/default) to the path you provide for the runtime files. The name of this directory is the instance to which the runtime files apply. Later, you can create multiple instances of Instant Messaging by creating additional instance directories with different names (for example /secure) and copying over files from the /default instance runtime directory. See Creating Multiple Instances from a Single Instant Messaging Installation for specific instructions.
If you accept the following defaults when you run configure:
Linux: /var/opt/sun/comms/im/
Solaris: /var/opt/SUNWiim/
The configure utility creates the following directories for the runtime files:
Linux: /var/opt/sun/comms/im/default
Solaris: /var/opt/SUNWiim/default
In addition, the following two subdirectories are created under the runtime directory.
The database directory (im-db-base) defaults are as follows:
Linux: /var/opt/sun/comms/im/default/db
Solaris: /var/opt/SUNWiim/default/db
The log directory defaults are as follows:
Linux: /var/opt/sun/comms/im/default/log
Solaris: /var/opt/SUNWiim/default/log
 
Resources, Help Files, and HTTP Gateway Pathname Resource Directory.
The directory in which the resource files, online help, and the XMPP/HTTP Gateway are installed.
If you want to customize the resource files for your deployment, you should run configure utility, customize the files, then redeploy the resource files. You need to run configure first because the configure utility creates some of the index and .jnlp files that you can customize. See Redeploying Resource Files for information.
Default: im-svr-base/html
 
XMPP/HTTP Gateway Deployment Determines whether or not the XMPP/HTTP gateway will be deployed. If you choose to deploy the gateway, the configure utility creates a default gateway configuration file (httpbind.conf) in the default Instant Messaging server instance's im-cfg-base directory if one does not already exist. If httpbind.conf already exists, the configure utility does not alter or overwrite the file.
Default:
True (gateway is deployed)
Note: If you are configuring the Instant Messaging Server to support Convergence, do not enable the XMPP/HTTP Gateway Deployment here. Set this value to false. The XMPP/HTTP Gateway is deployed through the Convergence server; its value is set when you configure Convergence.
 
XMPP/HTTP Gateway URI Defines the URI for the HTTP component of the XMPP/HTTP gateway.
Default:
http://web-svr-host:80/httpbind
 
AOL/MSN/Yahoo Gateways Enables you to communicate with external IM servers.
From the configurator panel, choose:
1. Enable Yahoo Gateway: true if you want to enable the gateway on the server.
2. Enable Local Component: true to enable the gateway on the local machine (default port and host name is used). Entering false will allow you to enable it on another machine (need to enter the machine's port and host name).
 
Codebase The URL from which Instant Messenger accesses resources, including the start page for initial downloads of the Instant Messaging client.
The installation program installs the resource files into the following locations:
Solaris and Linux: //opt/sun/comms/im/htmlThe configure utility uses the codebase to determine which web container instance to use. If it succeeds, the configure utility deploys the Instant Messenger resources as a web application in the web container, according to the URL provided. If no supported web container is detected, you will be prompted for a file system location in which to copy or link the resources.
See your web container documentation for more information about deploying resource files as a web application. See Changing the Codebase if you need to modify the location of the resource files after initial configuration.
 

Messaging Server configure Script Worksheet

Print and fill out this worksheet to use when responding to the Messaging Server configure script configuration options.

Option Default Value Fill in Your Site's Value (to Respond to the Script)
Fully Qualified Host Name (FQHN) your host.your domainFor example: myhost.west.sesta.com  
Directory to store Messaging Server configuration and data files /var/msg-svr-base  
System user name that will own the configuration files mailsrv  
System group that will own the configuration files mail  
User/Group Server LDAP ldap://your host:389  
Bind As cn=Directory Manager  
Password -  
Postmaster email address -  
Password for Messaging Server accounts -  
Default email Domain your domain  
Organization DN o=your domain,o=suffix  

Configuring a Host to be Multi-Homed

In a multiple installation of the same Communications Suite product on the same host, the different instances of the product are initially configured to use the same ports. If you run both instances of the product simultaneously, the ports will conflict.

One solution is to use a different IP address for each installation and configure the host to be multi-homed (accepting multiple IP addresses).

To Change the IP Address for Each Installation

Run the ha_ip_config utility. Note that you must configure each installation to use a specific IP address, since the out-of-the-box default is to respond to any IP address (INADDR_ANY).

Note: The ENS service that needs a separate step in order to change the IP address it responds to. A workaround for now is to either disable the ENS server for one of the installations (use local.ens.enable), or to change the port used by the ENS server. If you don't do this, one of the ENS servers will not start up. This may not be a huge issue at this time since the other ENS server will handle requests.

To Configure the Host to be Multi-Homed

My guess is to edit /etc/hosts. For Solaris 10, also edit /etc/inet/ipnodes. Next, plumb the IP addresses to the ethernet addresses by using (ifconfig). This procedure would be similar on Linux systems.

Next, update your naming service (/etc/hosts, /etc/inet/ipnodes, NIS, and/or DNS) to recognize the new IP address.

For more information, see the Solaris 2 FAQ.

To Configure Multiple Addresses Per Interface

Solaris 2.x provides a feature in ifconfig that allows having more than one IP address per interface. This feature is undocumented but prior to Solaris 2.5 but it exists; it is documented in versions 2.5 and later.

Syntax

# This command is only required in later releases
ifconfig IF:N plumb
ifconfig IF:N ip-address up

where "IF" is an interface (for example, le0) and N is a number between 1 and .

To remove the pseudo interface and associated address, perform the following:

ifconfig IF:N 0.0.0.0 down
# In newer release you must use the following command, but
# beware that this unplumbs your real interface on older
# releases, so try the above command first.
ifconfig IF:N unplumb

As with physical interfaces, all you need to do is make the appropriate /etc/hostname.IF:X file.

The maximum number of virtual interfaces, above, is 255 in Solaris releases prior to 2.6. Solaris 2.6 and Solaris 2.5.1 with the Solaris Internet Server Supplement (SISS) allow you to set this value with ndd, up to a hard maximum of 8192.

/usr/sbin/ndd -set /dev/ip ip_addrs_per_if 4000

There is no limit inspired by the code; so if you bring out adb you can increase the maximum even further.

Multi-Home Example

In the following example creates a multi-home on the host myhost.

Begin by creating the new interface:

# ifconfig -a
lo0: flags=2001000849<UP,LOOPBACK,RUNNING,MULTICAST,IPv4,VIRTUAL> mtu 8232 index 1
        inet 127.0.0.1 netmask ff000000
e1000g0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 10.1.110.114 netmask ffffff80 broadcast 10.1.110.127
        ether 0:c:f1:8e:fb:4
# ifconfig  e1000g0:1 plumb
# ifconfig -a
lo0: flags=2001000849<UP,LOOPBACK,RUNNING,MULTICAST,IPv4,VIRTUAL> mtu 8232 index 1
        inet 127.0.0.1 netmask ff000000
e1000g0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 10.1.110.114 netmask ffffff80 broadcast 10.1.110.127
        ether 0:c:f1:8e:fb:4
e1000g0:1: flags=1000842<BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 0.0.0.0 netmask 0
# ifconfig e1000g0:1 10.1.110.16 up

Set the IP address for the Messaging Server on the alternate root (on /var/tmp/altroot/opt/SUNWmsg2 in the following example):

# cd /var/tmp/altroot/opt/SUNWmsg2
# sbin/ha_ip_config

Please specify the IP address assigned to the HA logical host name. Use
dotted decimal form, a.b.c.d

Logical IP address: 10.1.110.16

Please specify the path to the top level directory in which iMS is
installed.

iMS server root: /var/tmp/altroot/opt/SUNWmsg2

The iMS server root directory does not contain any slapd-* subdirectories.
Skipping configuration of LDAP servers.

        Logical IP address: 10.1.110.16
        iMS server root: /var/tmp/altroot/opt/SUNWmsg2

Do you wish to change any of the above choices (yes/no) [no]?

Updating the file /var/tmp/altroot/opt/SUNWmsg2/config/dispatcher.cnf
Updating the file /var/tmp/altroot/opt/SUNWmsg2/config/job_controller.cnf
Setting the service.listenaddr configutil parameter
Setting the service.http.smtphost configutil parameter
Setting the local.watcher.enable configutil parameter
Setting the local.autorestart configutil parameter
Configuration successfully updated

Do the same for the Messaging Server on the default root.

# cd /opt/SUNWmsg
# sbin/ha_ip_config

Please specify the IP address assigned to the HA logical host name. Use
dotted decimal form, a.b.c.d

Logical IP address: 10.1.110.114

Please specify the path to the top level directory in which iMS is
installed.

iMS server root: /opt/SUNWmsg

The iMS server root directory does not contain any slapd-* subdirectories.
Skipping configuration of LDAP servers.

        Logical IP address: 10.1.110.114
        iMS server root: /opt/SUNWmsg

Do you wish to change any of the above choices (yes/no) [no]?

Updating the file /opt/SUNWmsg/config/dispatcher.cnf
Updating the file /opt/SUNWmsg/config/job_controller.cnf
Setting the service.listenaddr configutil parameter
Setting the service.http.smtphost configutil parameter
Setting the local.watcher.enable configutil parameter
Setting the local.autorestart configutil parameter
Configuration successfully updated

Disable the ENS server on one of the installation by setting local.ens.enable to 0:

sbin/configutil -o local.ens.enable -v 0

Configure the netmask and broadcast on the new IP address:

# ifconfig e1000g0:1 down
# ifconfig e1000g0:1 netmask 0xffffff80
# ifconfig e1000g0:1
e1000g0:1: flags=1000842<BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 10.1.110.16 netmask ffffff80 broadcast 10.255.255.255
# ifconfig e1000g0:1 broadcast 10.1.110.127
# ifconfig -a
lo0: flags=2001000849<UP,LOOPBACK,RUNNING,MULTICAST,IPv4,VIRTUAL> mtu 8232 index 1
        inet 127.0.0.1 netmask ff000000
e1000g0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 10.1.110.114 netmask ffffff80 broadcast 10.1.110.127
        ether 0:c:f1:8e:fb:4
e1000g0:1: flags=1000842<BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
        inet 10.1.110.16 netmask ffffff80 broadcast 10.1.110.127
# ifconfig e1000g0:1 up

Edit /etc/hosts to add the new IP address 10.1.110.16 to it:

# cat /etc/hosts
127.0.0.1       localhost
10.1.110.114    myhost.west.sesta.com myhost        loghost
10.1.110.4      elegit.west.sesta.com
# multi-home - second IP address on ethernet port
10.1.110.16     myhost2.west.sesta.com myhost2

Configuring Individual Ports for Multiple Installations of the Same Product on One Host

In a multiple installation of the same Communications Suite product on the same host, the different instances of the product are initially configured to use the same ports. If you run both instances of the product simultaneously, the ports will conflict.

One solution is to configure the individual ports on each installation so that they are different.

For example, for Messaging Server, you need to change the following ports in one instance:

  • SMTP
  • IMAP
  • POP
  • HTTPD
  • ENS
  • job_controller
  • watcher

The ports have SSL versions, too. Also, there may be other ports to use like SMTP SUBMIT.

The best place to look for MTA-related processes is the dispatcher.cnf file. store and mshttpd ports are probably in configutil. MMP ports may be in configutil and/or its configuration files.

In addition, you can identify ports by taking these actions:

  • See Default Port Numbers in the Communications Suite Component Products Release Notes.
  • See "Configuring POP, IMAP, and HTTP Services" in the Messaging Server Administration Guide.
  • You can grep the masterconfig file (lib/config.meta) for "port".
  • Query the following configutil variables as shown in the following table:
Service configutil Variable Default Value
Comments
watcher local.watcher.port 49994  
metermaid metermaid.config.port 63837  
IMAP service.imap.port 143  
IMAP SSL service.imap.sslport 993  
POP service.pop.port 110  
POP over SSL service.pop.sslport 995  
Webmail service.http.port 80  
Webmail SSL service.http.sslport 443  
ens local.store.notifyplugin.ensport 7997  
jmq local.store.notifyplugin.jmqport 7676  
Unable to render {include} Couldn't find a page to include called: Installation Worksheets - Directory+Server

Installing Communications Suite in Silent Mode

If you run the installer in Silent mode, you are running a non-interactive session. The installation inputs are taken from a silent installation file (also known as a state file), from command line arguments, or defaults.

You can use silent mode to install multiple instances of the same software component/configuration without having to manually run an interactive installation for each instance.

To run a silent installation, follow these steps:

1. Run an interactive installation session. (See To Begin Installation.) A state file similar to /var/opt/CommsInstaller/logs/silent_CommsInstaller_20070501135358 is automatically created for every run of the installation.

You can create a silent state file without actually installing the software during the interactive session by using the --dry-run option, then modifying the state file. For example:

# commpkg install --acceptLicense --dry-run 

2. Copy the state file to each host machine and edit the file as needed. See Silent Mode File Format.

3. Run the silent installation on each host. For example:

# commpkg install --acceptLicense --silent <Input File>

where Input File is the path and name of the silent state file. For example: /var/opt/CommsInstaller/logs/silent_CommsInstaller_20070501135358.

For details about the --silent option, see the silent installation usage in commpkg usage.

Note
Command-line arguments override the values and arguments in the state file.

About Upgrading Shared Components
By default, shared components are not upgraded when you run a silent installation. The option to upgrade shared components in the silent state file is automatically disabled. That is, the option is set to UPGRADESC=No. This is true even if you explicitly asked to upgrade shared components when you ran the interactive installation that generated the silent state file. That is, you ran commpkg install --upgradeSC y.

The reason to disable upgrading shared components in the silent state file is this: the other hosts on which you are propagating the installation might have different shared components installed, or different versions of the shared components. These versions might be required for other applications running on the different hosts. Therefore, it is safer not to upgrade the shared components by default.

You can upgrade shared components when you run a silent installation by performing either of the following actions:

  • Use the --upgradeSC y option when you run the silent installation. (The command-line argument overrides the argument in the state file.)
  • Edit the UPGRADESC=No option in the silent state file to: UPGRADESC=Yes.

Silent Mode File Format

The silent mode file (also known as a state file) is formatted like a property file: blank lines begin with a number sign (#) and properties are key/value pairs separated by an equals (=) sign. The following table shows which parameters you can change and provides examples:

Silent Mode File Parameters
Parameter Description Example
VERB Indicates which function to perform.
You can add CLI arguments described in commpkg usage, however the —dry-run argument cannot be added to the install function in the state file.
VERB=install
ALTDISTROPATH Indicates an alternate distro path if —distro is not specified. ALTDISTROPATH=SunOS5.10_i86pc_DBG.OBJ/release
PKGOVERWRITE Overwrites the existing installation packages. PKGOVERWRITE=YES
INSTALLROOT Specifies installation root. INSTALLROOT=/opt/sun/comms
ALTROOT Specifies an alternate root. ALTROOT=yes
EXCLUDEOS Specifies to not upgrade operating system patches. EXCLUDEOS=YES
COMPONENTS Lists the components you want to install. COMPONENTS=MS64 for 64-bit Messaging Server.
COMPONENTS=MS64_L10N for localized 64-bit Messaging Server.
COMPONENTS=MS for 32-bit Messaging Server.
COMPONENTS=MS_L10N for localized 32-bit Messaging Server.
COMPONENTS=CS for Calendar Server.
ACCEPTLICENSE Indicates whether or not to accept license.
This property must be specified either in the state file or as a command line argument.
ACCEPTLICENSE=yes.
UPGRADESC Indicates whether all shared components should or should not be upgraded without prompting. UPGRADESC=no

To display a complete list of the product names (such as MS, MS64, CS) to use with the COMPONENTS property, run the commpkg info --listPackages command. This command displays the mnemonics for each product.

Installing Communications Suite on Solaris Zones

This section explains how to install Communications Suite on Solaris 10 Zones. For an overview of Solaris 10 with Communications Suite, see Overview of Solaris Zones in Sun Java Communications Suite 5 Installation Guide.

This page includes the following topics:

Installing on Solaris 10 Zones: Best Practices

You can install Communications Suite components in the global zone, whole root non-global zones, and sparse non-global zones. Follow these guidelines:

  • Treat the global zone as an "administration zone". Install shared components and OS patches there that will be shared among all zones. But don't install and run products from the global zone.
  • You can have different shared component versions in the whole root non-global zone, but it isn't entirely insulated. If you do a packaging/patch operation in the global zone for a shared component, that operation will be attempted in the whole root zone. So if you really want different shared component versions then an alternate root would be one way to go. Unfortunately, you can't use alternate root for this purpose because of a bug (6548217) in Messaging Server.
  • You could try just having whole root zones and never ever installing and patching shared components in the global zone. I don't know how realistic it is to believe that you'll never have to install or patch a shared component in the global zone. For example, NSS is a shared component, but it is part of Solaris. So to say you'll never install and patch it in the global zone seems unrealistic, especially given it is a security component.
  • In sparse non-global zones, shared components can not be installed into the default root because many of them install into a readonly shared filesystem (/usr). Thus you must run the installer in the global zone to install shared components into the default root. Prepend your selection with ~ in the global zone to install only the dependencies (i.e. shared components). You do not have to install in the global zone first before installing in the sparse zone, the installer will allow you to continue even when you don't install all the dependencies.

Solaris 10 Zones Installation Sequences

This section describes how to install Communications Suite components in the four Solaris 10 Zone scenarios:

  • Global zone with existing non-global zones
  • Global zone with no existing non-global zones
  • Non-global whole root zone
  • Non-global sparse root zone

Global Zone with Existing Non-Global Zones

Note
This Zone scenario is not recommended for Communications Suite implementation. It requires the same version of shared components be running on each zone. Futhermore, the global zone should be reserved for administrative zone support.

If you install Communications Suite components in a global zone with existing non-global zones, you install the appropriate OS patches, shared component patches, and Communications Suite components into the global zone. It will propagate the shared component patches into the non-global zones. To install Communications Suite in a global zone with existing non-global zones:

  1. Follow pre-installation requirements as described in Installation Overview.
  2. Run the installer in the global zone by following the steps in To Begin Installation.

Global Zone with No Existing Non-Global Zones

If you install Messaging Server in a global zone with no existing non-global zones, you need to prepare your installation as if you might add non-global zones in the future. Modifying your deployment at a later time becomes difficult if you don~t plan for this step. To do this, follow the steps in Global zone with existing non-global zones.

Non-Global Whole Root Zone

The non-global whole root zone scenario is the equivalent of installing Messaging Server on a single box with no zones. Simply install Communications Suite as described in To Begin Installation.

Caution
Any operations performed in the global zone (such as installations, uninstallations, and patching) affect the whole root zones.

Non-Global Sparse Root Zone

To install Communications Suite in a non-global sparse root zone, you first need to install/upgrade the applicable OS patches and shared components in the global zone. You are unable to do so in the sparse root zone, because the /usr directory (where the shared components reside) is a read-only directory in the sparse root zone.

  1. Follow pre-installation requirements as described in Installation Overview.
  2. Verify that you are about to install the shared components and OS patches in the global zone and not the sparse root zone.
  3. Run the installer in the global zone and only install/upgrade the OS patches and the Shared Components:

    commpkg install -upgradeSC y
  4. Do not install Communications Suite components in the global zone. To do this, add a ~ (tilde) to the component number you want to install in the sparse zone. For example, if you plan to install Messaging Server in the sparse zone, you select ~3 during the global zone installation. The installer will know to only install dependencies and not the product itself.
  5. Once you have the shared components and OS patches installed, install Communications Suite components in the sparse root zone by following the steps in the To Begin Installation section.

Guidelines for Using SunCluster HA Packages in a Non-Global Zone

Take the following steps to install the Communications Suite 6 Update 1 Sun Cluster HA agent in non-global zones:

  1. Run the Communications Suite command in the global zone only:
    # commpkg install
    

    This command installs the Sun Cluster HA Agent package on global zone and all non-global zones.

    Note
    In case of IM_SCHA, run the command from global and non-global zones.
  2. Run the Sun Cluster HA Agent pre-configuration command in the global zone only:
    # <scha_base>/bin/init-config
    

Performing Multiple Installations with an Alternate Root

The Communications Suite installer allows multiple installations of the same product version on the same machine or Solaris zone by using different INSTALLROOTS. By using the altroot option of the commpkg install command, you can create multiple INSTALLROOTS on the same machine.

This document contains the following sections:

Using Multiple Installations in a Side-by-Side Upgrade Scenario

The multiple-installation feature lets you perform side-by-side upgrades of some Communications Suite products.

In a side-by-side upgrade, the existing software on the host can continue to run while you install the new versions of the products on an alternate root on the same host. This approach minimizes downtime, so that end users can have continuous (or near-continuous) access to their email, calendars, and so on.

Summary of Side-by-Side Upgrade Steps

In a side-by-side upgrade scenario, you perform the following tasks:

  1. Install the new Communications Suite software on the same host as the earlier versions. You can use the commpkg install commands shown in To Install a Communications Suite Product in an Alternate Root.

  2. Configure the new software. Run the configuration script for the product.

  3. Migrate data to the new directories under the alternate root's INSTALLROOT.

  4. Configure alternate ports for the new installation under the alternate root. Alternatively, configure the host as a multi-home. For details, see Running Multiple Installations of the Same Product on One Host - Conflicting Ports.

  5. Test the new software.

  6. Switch end users to the new environment.

For more information about the side-by-side upgrade scenario, see Using the Side-by-Side Strategy to Upgrade Messaging Server.

To Install a Communications Suite Product in an Alternate Root

Install the product in the alternate root with the —altroot option:

  1. Install OS patches and Shared Components in the default INSTALLROOT. See To Begin Installation.

    To install only the shared components, you can run commpkg install without --altroot and select the product you want to install. You select a product by entering the number displayed next to it in the install list. Add a ~ (tilde) in front of the product number.

    For example, if you plan to install Messaging Server in the alternate root, you select ~3 during the default installation. This tells the installer to install the dependencies but not the product itself.

    Note
    OS patches are always applied in the default INSTALLROOT, never in the alternate root.



  2. Install the product in the altroot, as in the following example:

    commpkg install --altroot --installroot /opt/sun/comms2
    



    Be sure to use —installroot with —altroot to specify the alternate root.

    You can also avoid installing the shared components in the altroot by using the --excludeSC option, as in the following example:

    commpkg install --excludeSC --altroot --installroot /opt/sun/comms2
    



    You may create as many alternate roots as you like. However, you should manually keep track of all the alternate roots you have created.

Understanding INSTALLROOT and Altroot

The following concepts define an altroot:

  • An altroot is an alternate root directory.
  • The altroot is used for multiple installations of Communications Suite products on the same host.
  • The default root is the standard root directory, which can be indicated with a /.
  • An altroot implies the existence of a default root.

The following concepts define an INSTALLROOT:

  • An INSTALLROOT is the top-level installation path for the Communications Suite products and shared components.
  • There is an INSTALLROOT (an installation path) for each instance of the installed products. That is, if your system has a default root and an altroot, the default root has one INSTALLROOT, and the altroot must have a different INSTALLROOT.

Now let's put them together:

  • You define an altroot by specifying its INSTALLROOT and using the --altroot option with the commpkg install command.

What's the Default?

If you use the default root and the default INSTALLROOT, the commpkg install command installs products under the following top-level directory:

/opt/sun/comms/

An Example

Now suppose you want to install one instance of the products in /opt/sun/mycompany/comms/; and another instance of the same products in /opt/sun/mycompany/comms2/. You would use the following commands:

For the default root:

commpkg install --installroot /opt/sun/mycompany/comms/

For the altroot:

commpkg install --altroot --installroot /opt/sun/mycompany/comms2/

Running Multiple Installations of the Same Product on One Host: Conflicting Ports

By default, after you initially configure the product on alternate roots, the ports used by the different product installations are the same and thus conflict with each other.

This is not a problem if you install multiple installations of the same product on the same host but only intend to have one instance running at one time. For example, you may perform a side-by-side upgrade scenario in which you plan to stop the old instance before you start the new instance.

However, you may plan to test the new instance while the old instance is still running (and supporting end users). In this scenario, the ports are used simultaneously.

There are two ways to resolve this conflict:

  • Configure individual ports
  • Use a multi-home configuration

These approaches are described in the following sections.

Configuring Individual Ports

See Configuring Individual Ports for Multiple Installations of the Same Product.

Configuring a Host to Be Multi-Homed

See Configuring a Host to be Multi-Homed.

Unable to render {include} Couldn't find a page to include called: Sample Session - Communications Suite 6 Install Using altroot
Unable to render {include} Couldn't find a page to include called: Sample Session - Communications Suite 6 Simple Install and Uninstall
Unable to render {include} Couldn't find a page to include called: Sample Session - Installing Communications Suite 6 on a Solaris Zone

Shared Components Bundled With the Communications Suite Installer

For the list of shared components installed by the Communications Suite installer, run the commpkg info command. See commpkg info Usage for additional information.

Sun Java System Message Queue is automatically installed with the other shared components.

To Run the Communications Suite Installer

  1. Become superuser.
  2. Start the text-based installer by running the commpkg command.
    See commpkg install Usage for more information. Running commpkg creates a log file that records the installation parameters.
  3. Accept the License Agreement.
    If you have already read the agreement in its entirety, you have the option of skipping the agreement and accepting the terms. To accept the terms of the agreement without viewing the entire license agreement, press Enter to continue, then type n to skip reading the agreement, and type yes to accept the terms.
  4. Specify Installation Location where server files will be installed (also known as the INSTALLROOT) or accept the default location.
    Note
    Starting with Communications Suite 6, the default INSTALLROOT has changed from /opt/SUNWmsgsvr to /opt/sun/comms/messaging (for 32-bit installations) and /opt/sun/comms/messaging64 (for 64-bit installations).

    After specifying the INSTALLROOT, notices for operating system and shared components patches appear if previous versions of patches are installed on the machine.

  5. Select the products you want to install.
    The following products are included in this release:
    Messaging Server 7 Update 2
    Messaging Server (64-bit) 7 Update 2
    Comms DSsetup 6.4
    Calendar Server 6.3 (with upgrade patch installed by commpkg)
    Instant Messaging 8 Update 1
    Convergence 1 Update 2
    Delegated Administrator 7 (with upgrade patch installed by commpkg)
    Communications Express 6.3 (with upgrade patch installed by commpkg).
    Messaging Server Sun Cluster HA agent 7.0
    Calendar Server Sun Cluster HA agent 6.3
  6. The installer generates the list of items to install.
    In this step, the installer lists all the products as well as shared components to be installed or upgraded. If items need to be upgraded, the installer gives you the choice to upgrade.
    Caution
    Upgrading shared components is an irreversible process. However, if you do not install the correct version of the shared components, the product might not work as designed. Thus, proceed carefully when installing and upgrading shared components and products.

    Once you determine what products you want to install and upgrade, the installer creates a summary.

  7. The installer prompts you to confirm that you are ready to install.
    Once you specify the components you are installing and upgrading, the installer is ready to install Messaging Server files into INSTALLROOT.
    If everything installs properly, you see All tasks PASSED in the summary panel.
  8. Log files are created.
    Once installation has completed, time-stamped log files are created.
    • To undo your installation, use the undoCommsInstall script, which has a location similar to the following example:/var/opt/CommsInstaller/logs/undoCommsInstall_20090401135358
    • To run silent installation for multiple installations, use the silent installation file, which has a location similar to the following example:/var/opt/CommsInstaller/logs/silent_CommsInstaller_20090401135358
    • The installer creates a log file of the installation process in the /var/opt/CommsInstaller/logs directory, for example:/var/opt/CommsInstaller/logs/CommsInstaller_20090401135358.log
  9. If you want to remove the installation that you just ran, you can undo your installation by running the undoCommsInstall script, for example:
    /var/opt/CommsInstaller/logs/undoCommsInstall_20090401135358
    Undo reverses the specific steps taken during installation. It also undoes shared component installations. If, however, you want to pick and choose specific components to uninstall, use the commpkg uninstall command. See commpkg uninstall Usage for more information. The uninstaller does not uninstall shared components.
  10. The installer creates the following directory layout.
    In the INSTALLROOT (default: /opt/sun/comms), you might see the following directories:
    • CommsInstaller, where a copy of the Installer resides.
      Note
      The log files listed in the previous step are located in the /var/opt/CommsInstaller/log directory. If you install Messaging Server in an alternate root, the logfiles are located in the alternate root~s INSTALLROOT/var/opt/CommsInstaller/log directory.
    • messaging, the 32-bit Messaging Server version
    • messaging64, the 64-bit Messaging Server version

Uninstalling Communications Suite in Silent Mode

If you run the uninstaller in Silent mode, you are running a non-interactive session. The uninstallation inputs are taken from a silent uninstallation file (also known as a state file), from command line arguments, or defaults.

To run a silent uninstallation, follow these steps:

1. Run an interactive uninstallation session.

A state file similar to /var/opt/CommsInstaller/logs/silent_CommsInstaller_20070501135358 is automatically created.

Note
The silent installation and uninstallation files have the same file naming convention. You need to scan the contents of the file to determine if it is an installation or uninstallation silent file.

2. Copy the state file to each host machine and edit the file as needed.

3. Run the silent uninstallation on each host. See usage in commpkg uninstall Usage.

Note
Command-line arguments override the values and arguments in the state file.

The following is a sample uninstall silent file:

# Silent File for CommsInstaller 5.0-1.03}}
# Generated on 20070604120325}}
# verb used to create this silent file
VERB=uninstall
# root directory}}
ROOTDIR=/
# list of components to uninstall (using mnemonics)
COMPONENTS=MS64 MS64_L10N CS CS_L10N
# friendly name for the installroot
INSTALLNAME=

Verify the Version of Application Server

To verify which version of Application Server you have installed, run the following command on the host where you have installed Application Server:

# /opt/SUNWappserver/bin/asadmin version
Version = Sun Java System Application Server 9.1_02

You can obtain other relevant information by running the following commands:

# grep -i admin_profile /opt/SUNWappserver/config/asadminenv.conf
AS_ADMIN_PROFILE=enterprise
# grep -i hadb /opt/SUNWappserver/config/asenv.conf
AS_HADB="/opt/SUNWappserver/hadb/4.4.3-6"
# grep -i jdk /opt/SUNWappserver/config/asenv.conf
AS_JAVA="/opt/SUNWappserver/jdk"
# /opt/SUNWappserver/jdk/bin/java -version
java version "1.6.0_06"
Java(TM) SE Runtime Environment (build 1.6.0_06-b02)
Java HotSpot(TM) Server VM (build 10.0-b22, mixed mode)
Labels:
printable printable Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.