relicore clarity installation guide - oregon dhs ... clarity installation guide configuring the...

Relicore Clarity Installation Guide

Table Of Contents Copyright Notice .............................................................................................................................. 1

Supported Platforms........................................................................................................................ 3

System Requirements for Windows ................................................................................................ 4

Installation Prerequisites on Windows ......................................................................................... 4

Oracle Database Requirements................................................................................................... 4

Oracle Installation on the Relicore Clarity Server ........................................................................ 7

Required Service Packs............................................................................................................... 8

Hardware Requirements on Windows ......................................................................................... 8

Installation Directories on Windows............................................................................................. 9

System Requirements for Solaris .................................................................................................. 10

Installation Prerequisites on Solaris........................................................................................... 10

System Requirements for Solaris .............................................................................................. 12

Oracle Database Requirements................................................................................................. 13

Oracle Installation on the Relicore Clarity Server ...................................................................... 15

Required Solaris Patches .......................................................................................................... 16

Hardware Requirements on Solaris ........................................................................................... 19

Installation Directories on Solaris............................................................................................... 21

System Requirements for Linux .................................................................................................... 22

System and Hardware Requirements on Linux ......................................................................... 22

Installation Prerequisites on Linux ............................................................................................. 22

System Requirements for AIX ....................................................................................................... 23

System and Hardware Requirements on AIX ............................................................................ 23

Installation Prerequisites on AIX................................................................................................ 24

Clarity Server Installation Considerations ..................................................................................... 25

iii


Configuring the Server for HTTPS Protocol .................................................................................. 27

Installing the Clarity Server on Windows....................................................................................... 30

Installing the Clarity Server on Windows in Graphical Mode..................................................... 30

Installing the Clarity Server from the Command Line on Windows ........................................... 35

Starting the Windows Service.................................................................................................... 37

Stopping the Windows Server Service ...................................................................................... 39

Performing Server Maintenance on Windows ........................................................................... 39

Viewing Log File Contents on Windows .................................................................................... 40

Installing the Clarity Server on Solaris........................................................................................... 41

Installing the Clarity Server in Console Mode on Solaris........................................................... 41

Installing the Clarity Server in Graphical Mode Solaris ............................................................. 42

Installing Clarity Server in Unattended Mode on Solaris .......................................................... 48

Starting the Server on Solaris .................................................................................................... 49

Stopping the Server on Solaris .................................................................................................. 50

Performing Server Maintenance on Solaris ............................................................................... 50

Viewing Log File Contents on Solaris ........................................................................................ 51

Clarity Agent Installation Considerations....................................................................................... 52

Windows Agent Installation ........................................................................................................... 53

Installing the Clarity Agent on a Windows System .................................................................... 53

Installing Clarity Agent from the Command Line on Windows................................................... 59

Automatic Agent Activation on Windows ................................................................................... 61

Configuring the Agent Manually on Windows ............................................................................ 63

Starting Windows Agent Service................................................................................................ 64

Starting the Relicore Clarity Agent Windows 2000 or 2003 Service.......................................... 64

Stopping the Windows Agent Service........................................................................................ 65

iv

Table Of Contents

Installing the Clarity Agent on Solaris, Linux and AIX ................................................................... 67

Installing the Clarity Agent on Solaris, Linux or AIX in Graphical Mode.................................... 67

Installing Clarity Agent in Console Mode on Solaris, Linux or AIX ............................................ 73

Installing Clarity Agent in Unattended Mode on Solaris, Linux or AIX....................................... 75

Automatic Agent Activation on Solaris, Linux and AIX .............................................................. 77

Configuring the Agent Manually on Solaris, Linux or AIX.......................................................... 78

Starting the Solaris, Linux or AIX Agent .................................................................................... 79

Stopping the Solaris, Linux or AIX Agent................................................................................... 80

Getting Started with Clarity............................................................................................................ 81

Logging In ...................................................................................................................................... 81

Upgrade Prerequisites................................................................................................................... 83

Clarity Upgrade Considerations..................................................................................................... 83

Upgrading the Clarity Server ......................................................................................................... 85

Upgrading the Clarity Server on Solaris in Console Mode ........................................................ 85

Upgrading the Clarity Server on Solaris in GUI Mode ............................................................... 88

Upgrading the Clarity Server on Windows................................................................................. 93

Upgrading the Clarity Agent .......................................................................................................... 98

About Agent Upgrades............................................................................................................... 98

Managing Upgrade URLs .......................................................................................................... 98

Upgrading a Clarity Agent........................................................................................................ 100

Viewing the Upgrade Log......................................................................................................... 101

Viewing Upgrade Event Status ................................................................................................ 102

Uninstalling on Windows ............................................................................................................. 105

Removing a Clarity Agent from Windows ................................................................................ 105

Removing the Relicore Clarity Server...................................................................................... 105

v


Uninstalling on Solaris ................................................................................................................. 106

Removing an Agent from Solaris ............................................................................................. 106

Removing the Relicore Clarity Server from Solaris ................................................................. 106

Uninstalling on Linux ................................................................................................................... 107

Removing an Agent from Linux................................................................................................ 107

Uninstalling on AIX ...................................................................................................................... 107

Removing an Agent from AIX .................................................................................................. 107

Contacting Relicore ..................................................................................................................... 109

vi

Copyright Notice

Copyright © 2001-2005 Relicore, Inc., Burlington, MA 01803. All Rights Reserved.

Microsoft, Windows 95, Windows 98, Windows 2000, Windows NT, and Microsoft SQL Server™ 2000 are registered trademarks of Microsoft Corporation. Portions Copyright © 1994 by Purdue Research Foundation, West Lafayette, Indiana. Written by Victor Abell. Not derived from licensed software. All Rights Reserved.

Portions of the Software Copyright © 2004 Persistit Corporation. All Rights Reserved.

Portions of the Software Copyright © 1996-2001 by Phaos Technology Corporation. All Rights Reserved.

Portions of the Software Copyright © 2001 by Jason Hunter <[email protected]>. All Rights Reserved.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes code licensed from RSA Data Security.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

All other products and company names may be marks of their respective owners.

Relicore retains all ownership rights to the software program(s) described in this document. Use of this software is governed by the End User Purchase and License Agreement. The software and associated documentation may be used or copied only in strict accordance with the terms of the agreement.

The source code is the confidential and proprietary information of Relicore, Inc. ("Confidential Information"). You shall not disclose such Confidential Information and shall use it only in accordance with the terms of the License Agreement you entered into with Relicore. No title to or ownership of the software described in this document or any of its parts, including patents, copyrights and trade secrets, is transferred to customers. The software and documentation provided with the Relicore software are proprietary. The source code is a trade secret of Relicore. It is against the law to decipher, decompile, or develop source code for the software described in this document, or knowingly allow others to do so.

RELICORE MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

1


PURPOSE, OR NON-INFRINGEMENT. RELICORE SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.

Relicore makes no representations or warranties regarding the contents of this document. Information in this document is subject to change without notice and does not represent a commitment on the part of Relicore. This manual is protected by United States Copyright Law, and may not be copied, reproduced, transmitted or distributed, in whole or in part, without the express prior written permission of Relicore.

2

Installing Relicore Clarity


Supported Platforms

Relicore Clarity product supports the components and platforms that are listed below. Note that platforms are broken down by components of the Clarity product.

Relicore Clarity requires that you install and configure the following components:

Component Platform Agent Solaris 2.9 64-bit, Solaris 2.8 64 bit, Solaris 2.6 32 bit

Windows 2000 Server SP3, SP4 Windows 2000 Advanced Server SP3, SP4 Windows 2003 Server Windows 2003 Advanced Server Linux Redhat 3.0 Advanced Server, Kernel v2.4.21 Linux Redhat Advanced Server 2.1, Kernel v2.4.9e34, 32-bit x686 multi-processor and enterprise SUSE Linux certified on SMP 2.4.21-169 on Intel x86, 32 bit AIX 5.2L, 32 bit and 64 bit and AIX Java 1.4.2 (32 bit only), Maintenance Level 3 with IY56367, IY56982, and IY60105 ARPAs patches or a higher Maintenance Level.

Only Linux kernels and configurations as shipped and installed off the CD are supported.

Windows 2000 Professional and Windows 2000 DataCenter are not supported. Server Microsoft Windows 2000 Server SP4

Microsoft Windows 2003 Enterprise Edition SP1 or Solaris 2.8 64 bit

Database Server

Oracle 9i (9.2), certified on Solaris 2.8 UDB version 8.2, certified on Microsoft Windows 2000 Service Pack 4

Relicore Clarity installs the following third party components: Component Platform Agent Sun Java2 JRE/JDK v1.4.2_021 and Sun JRE v1.3.1_041

AIX JDK/JRE version IBM AIX 1.4.2_00 Because Solaris 2.6 does not support JRE 1.4.2_02, Solaris 2.6 uses JRE 1.3.1_04.

All other platforms use JRE 1.4.2_02. Linux Red Hat 3.0 and Suse Linux 8.0 use JRE 1.4.2_03; Linux Red Hat 2.1 uses JRE 1.4.2.

For AIX Java version 1.4.2 we support Java(TM) 2 Runtime Environment, Standard Edition Classic VM (build 1.4.2, J2RE 1.4.2 IBM AIX build ca1420-20040626 (JIT enabled: jitc))

Server Sun Java2 JDK 1.4.2_02 Tomcat 4.1.29

The Relicore Clarity UI is viewable on the following browsers: Microsoft Internet Explorer 6.0 Service Pack 1 on Windows and Netscape® version 7.1 or later on Windows or Solaris.

3


System Requirements for Windows

Installation Prerequisites on Windows

The server is supported on Windows platforms; the prerequisites for an installation are as follows:

• An administrative user login.

• The appropriate hardware requirements.

• The appropriate Service Pack required for the JDK installation.

• A database server running Oracle 9i or IBM UDB must be set up. For information about UDB setup, refer to the Clarity - DB2-UDB Setup.pdf file located in C:\Program Files\Relicore\server\4.1\web\techpubs. The following information must be known or Oracle:

• Server hostname

• SID

• Database username • Database password

The Oracle username and password must provide permissions to create and write tables.

• The appropriate Oracle database requirements. • A copy of the clarity-server_4.x.xxx.x_Win-x86.exe self-extracting installation kit. • A copy of the clarity-agent_4.x.xxx.x_Win-x86.exe self-extracting installation kit. • If you have the Global Mapper feature enabled, a copy of the clarity-

das_1.0.xxx.x_Win-x86.exe self-extracting installation kit. • If you have the Global Mapper feature enabled, you must synchronize all the clocks on

each Clarity Server in the Domain Group.

Oracle Database Requirements

Relicore Clarity requires an installation of Oracle or UDB. The following are guidelines when using Oracle with Clarity. Although the Oracle database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration will not be supported when Relicore adds multi-Clarity server support. For this reason, Relicore recommends deploying the database on a separate machine.

What Your Database Administrator Needs To Know

Provide the following information to your database administrator. After the Oracle instance is established, the database server needs to be configured as follows:

• An Oracle database with a TCP listener listening

• A schema to own the Clarity objects

• Connect, resource privileges on Clarity schema

For example:

create user RELICORE identified by RELICORE default tablespace USERS temporary tablespace TEMP quota 1000M on USERS; grant connect, resource to RELICORE;

4


• System Privileges:

The Oracle CONNECT role is predefined; it includes the following privileges:

• CREATE SESSION

• ALTER SESSION

• CREATE TABLE

• CREATE VIEW

• CREATE SEQUENCE The Oracle RESOURCE role is also predefined; it includes the privileges listed below:

• CREATE PROCEDURE

• CREATE TRIGGER

• CREATE TYPE

• Quota on Table Spaces: Minimum Default table space:

• POC: > 3GB

• 20 - 150 Agents > 6GB

• 151 - 400 Agents > 16 GB Temporary table space:

• > 200M • Roll Back Segments:

• POC: 1 - 19 Agents > 8 segments, 4M each

• Production: 20 Agents or more > 20 segments, 4M each

What You Need To Know

You will need to ask your database administrator to provide the following information. The Clarity Installer program prompts you to supply these values during the Relicore Clarity server installation.

• Database server name

• Oracle SID

• User ID (schema name)

• Password

• Listener TCP Port

Clarity Database

Although the Oracle database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration will not be supported when Relicore adds multi-Clarity server support. For this reason, Relicore recommends deploying the database on a separate machine.

5


There are two primary requirements for database servers:

CPU/Memory For information on CPU and memory requirements, refer to the Hardware Requirements on Solaris and Hardware Requirements on Windows topics. Disk Given the large quantities of information that the Clarity application can generate, both the size and type (that is, RAID, etc.) of the disk subsystems must be considered as well as the type. In general, the majority of information stored in the database is fairly small with the following exceptions:

• Change tracking information, such as file changes.

• Content tracking information, such as diffs for a file change.

• Attachments added to notes. Ultimately, the required disk space will be a function of how fast events are generated, how many agents are being supported, and how long event information is saved in the system.

Clarity Agents

Disk Configuration Minimum Disk

Space (GB)

Recommended Disk Space

(GB)

RAM

Up to 20 2 SCSI disks. Redo log on one, database files and rollback segments on the other.

7 14 1GB

21 - 150 SCSI based RAID disk array with 4-5 disks.

10 21 1GB

151 - 400

SCSI based 10,000 RPM RAID disk array with 4-5 disks.

20 40 1GB

After the database server is set up, much of the free disk space that remains should be made available for Oracle data storage. Relicore recommends that you configure Clarity tablespace to use all but 1GB of disk space and save the remainder in case rollback segments and/or temp space needs to be enlarged in the future.

The determining factor in database performance is the speed of the disk I/O subsystem. Relicore suggests that the database server be configured with the fastest disk array possible. For example, a SCSI based 10,000 RPM RAID disk array with 4 to 5 disks. Also a 5-disk RAID-5 subsystem utilizing a 64KB stripe size is favored when data integrity is required.

6


Oracle Installation on the Relicore Clarity Server

Relicore recommends that Oracle be installed on a machine other than the machine on which the Relicore Clarity server is installed.

If you choose to install the Oracle database on the same machine as the Relicore Clarity server, Relicore recommends that you observe the steps outlined below during the installation process.

The following steps are an excerpt; they do not correspond to every dialog box that appears in the Oracle installation wizard. Respond to other installation instructions as is appropriate for your environment. Relicore recommends that you review the Oracle Database Requirements.

To install Oracle:

1. Launch the Oracle Universal Installer. 2. Select Oracle. 3. In the Type of Installation dialog box, select Custom. 4. In the Available Product Components dialog box, ensure that Oracle HTTP Server is

not selected.

To configure Relicore Oracle database using the Database Configuration Assistant:

1. Select Create a database and click Next. You are prompted to identify the database type.

2. Select Custom and click Next. You are prompted to identify the primary type of application that will be used.

3. Select Multipurpose and click Next. 4. Accept the default value for the currently connected users and click Next.

You are prompted to identify the mode in which you want the database to operate.

5. Select Dedicated Server Mode and click Next. The Optional Features dialog box appears.

Relicore Clarity does not require you to install any optional features.

6. Clear optional features at your discretion and click Next. 7. Provide database information and click Next. 8. Select the defaults until prompted to review the system global area (SGA) parameters. 9. Ensure that SGA sizes are less than physical memory for the machine the on which the

database is installed and click Next. 10. Continue configuring the database as is appropriated for your business needs.

7


Required Service Packs

Sun recommends certain service packs for various members of the Windows OS family to run the JRE/JDK 1.4.1_01 environments. Without the installation of the specified service pack for Windows, the installation will not proceed. The required service pack for this installation is as follows:

Operating System Service Packs Windows 2000 On Server SP4

On Agent SP3, SP4

Hardware Requirements on Windows

Clarity Server

The Clarity server can be deployed on a system running Microsoft Windows 2000 Server or Microsoft Windows 2003 Enterprise Edition SP1. Relicore recommends the following configurations:

• Proof of Concept (PoC) – Single CPU 2.8GHz or higher Intel Xeon or equivalent with at least 1GB of free RAM. The Clarity server will require a minimum of 500MB of free disk space for installation and use.

• Departmental – Dual CPU 2.8GHz or higher Intel Xeon or equivalent with at least 2GB of free RAM. The Relicore Clarity Server requires a minimum of 2G of free disk space for installation and use.

• Enterprise – Quad CPU 2.8GHz or higher Intel Xeon or equivalent with at least 3GB of RAM. The Clarity server will require a minimum of 4GB of free disk space for installation and use. If the Global Mapper option is enabled the system should have at least 4GB of free RAM and 6GB of free disk space for installation and use.

A proof-of-concept (PoC) configuration is an installation in which the Clarity server and database are installed on the same machine. A PoC installation should involve ten (10) agents or fewer.

A departmental configuration is an installation with 400 or fewer agents; an enterprise configuration involves 401 or more agents.

Clarity Agent

The Clarity agent runs on x86-based Windows 2000 and Windows 2003 systems. The agent requires 50MB of free RAM. For agent installation, 300MB of free disk space is required. Each agent requires additional disk space to store copies of files that are being tracked for changes in content. For any file whose content is being tracked for changes, the Clarity Agent needs enough disk space on the agent to hold one prior copy of that file.

Clarity Database

Although the Oracle or IBM UDB database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration is not

8


supported in Enterprise or Global Mapper environments. For this reason, Relicore recommends deploying the database on a separate machine.

There are two requirements you should consider when configuring a database server to support a single Clarity domain:

1. CPU/Memory

• For departmental Clarity installations, a single CPU 2.8GHz or higher Intel Xeon or equivalent class server with 2GB of free RAM (or more) is recommended.

• For enterprise Clarity installations, a dual CPU 2.8GHz or higher Intel Xeon or equivalent class server with 4GB of free RAM (or more) is recommended.

2. Disk IO

• Proper configuration of the disk I/O is essential to ensure that the system works optimally. Refer to the Clarity - DB2 Setup.pdf document for additional information on setting up the Disk I/O sub system.

• When a single database instance is shared between multiple Clarity Servers, the database server's CPU, Memory, and Disk/IO configuration must be scaled accordingly.

Refer to the Oracle Database Requirements for additional information on Oracle setup. Refer to the Clarity - DB2-UDB Setup.pdf file located in C:\Program Files\Relicore\server\4.1\web\techpubs for additional information on UDB setup.

Installation Directories on Windows

The Relicore Clarity Administration Guide refers to the Clarity product by its internal product code name, EMX.

The installation directory structure is as follows:

• {EMX_ROOT}: The top level EMX installation directory, for example C:\Program Files\Relicore\Agent

• {EMX_HOME}: The version specific directory containing the EMX kit. Directories of significance in {EMX_HOME} are as follows:

• {EMX_HOME}/bin: Binaries/scripts

• {EMX_HOME}/config: Configuration files

• {EMX_HOME}/models: Model files

• {EMX_HOME}/data: Managed object state of the product

• {EMX_COMMON}: The common directory, named “common” contains the current state, content tracking files and log file output.

• {EMX_COMMON}/logs: Log file output directory, including the emx-watchdog.out.<#> and emx-watchdog.err.<#> files.

• {EMX_COMMON}/content: Content tracked files

• {EMX_COMMON}/runtime: The Relicore runtime environment, as follows:

• Server: JDK, Tomcat

• Agent: JRE

• {EMX_COMMON}/state: Persistent state of the product.

9


For example, if you were to install the Relicore Clarity agent (although this equally applies to a server) into C:\Program Files\Relicore\Agent, you would see:

Directory Value EMX_ROOT C:\Program Files\Relicore\Agent EMX_HOME C:\Program Files\Relicore\Agent\x.x EMX_COMMON C:\Program Files\Relicore\Agent\common

System Requirements for Solaris

Installation Prerequisites on Solaris

The Relicore Clarity Administration Guide refers to the Relicore Clarity product by its internal product name, EMX respectively.

The Clarity server is supported on Solaris 2.8; the prerequisites for a Solaris installation are as follows:

• Access to a root shell.

• Required patches for the JDK installation.

• If you have the Global Mapper feature enabled, you must synchronize all the clocks on each Clarity Server in the Domain Group.

• A database server running Oracle or IBM UDB must be set up and the following information must be known:

• Server hostname

• SID

• Database username

• Database password The Oracle username and password must provide permissions to satisfy Oracle database requirements.

• A copy of the clarity-server_4.x.xxx.x_SunOS-sparc.bin and clarity-agent_4.x.xxx.x_SunOS-sparc.bin self-extracting installation kits.

• If you have the Global Mapper feature enabled, a copy of the clarity-das_1.x.xxx.x_SunOS-sparc.bin file

The installation kit should be unpacked in the desired installation location, for example, /opt/relicore/emx/<agent|server>; you will need to ensure the kit has execute permissions before running the kit.

Relicore Clarity Server Solaris Service

Under normal use, the Relicore Clarity Server remains running as long as the Solaris system is running. This is accomplished using the following utilities:

10


Script Location Description emx_serverd.sh {EMX_HOME_DIR} Used to actually start and stop the server

process. It takes the following command line arguments:

# ./emx_serverd.sh

Usage: ./emx_serverd.sh { start | stop } S99emx_server /etc/rc2.d Is called by the system when the system

enters run level 2 during startup. It calls emx_serverd.sh start to actually start the server process.

K99emx_server /etc/rc1.d Called by the system when the system enters run level 1 during shutdown. It calls emx_serverd.sh stop to actually stop the server process.

Relicore Clarity Agent Solaris Service

Under normal use, the Relicore Clarity Agent remains running as long as the Solaris system is running. This is accomplished using the following utilities:

Script Location Description emx_agentd.sh {EMX_HOME_DIR} Used to actually start and stop the agent


# ./emx_agentd.sh

Usage: ./emx_agentd.sh { start | stop } S99emx_agent /etc/rc2.d Is called by the system when the system

enters run level 2 during startup. It calls emx_agentd.sh start to actually start the agent process.

K99emx_agent /etc/rc1.d Called by the system when the system enters run level 1 during shutdown. It calls emx_agentd.sh stop to actually stop the agent process.

Use the emx_agentd.sh script to manually start and stop the Relicore Clarity Agent, noting that since the agent runs as root, you need to be using a root shell to run emx_agentd.sh. Do not use the kill(1) command to stop the agent because the agent requires an orderly shutdown in order to flush its state to disk.

The shutdown process might take a few seconds because the agent needs time to disconnect from the server and write its current state to the disk.

11


System Requirements for Solaris

Before installing and using the Relicore Clarity server, Relicore recommends that you check to be certain that the minimum requirements for a Solaris operating system are met.

The requirements for the Solaris operating system for Clarity Agents and Server are defined in the following table.

Solaris Operating System Requirements

SUNWadmc SUNWadmfw SUNWcar SUNWcarx SUNWcsd SUNWcsl SUNWcslx SUNWcsr SUNWcsu SUNWcsxu SUNWesu SUNWkvm SUNWkvmx SUNWlibC SUNWlibCx SUNWlibms SUNWlmsx SUNWloc SUNWlocx SUNWnisu SUNWswmt

System administration core libraries SUNWcar System & Network Administration Framework Core Architecture, (Root) Core Architecture, (Root) (64-bit) Core Solaris Devices Core Solaris, (Shared Libs) Core Solaris, (Shared Libs) (64-bit) Core Solaris, (Root) Core Solaris, (Usr) Core Solaris (Usr) (64-bit) Extended System Utilities Core Architecture, (Kvm) Core Architecture (Kvm) (64-bit) Sun Workshop Compilers Bundled libC Sun WorkShop Bundled 64-bit shared Sun WorkShop Bundled shared libm Sun WorkShop Bundled 64-bit shared libm System Localization System Localization (64-bit) Network Information System, (Usr) - suggested Install and Patch Utilities

12


Oracle Database Requirements

Relicore Clarity requires an installation of Oracle or UDB. The following are guidelines when using Oracle with Clarity. Although the Oracle database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration will not be supported when Relicore adds multi-Clarity server support. For this reason, Relicore recommends deploying the database on a separate machine.

What Your Database Administrator Needs To Know

Provide the following information to your database administrator. After the Oracle instance is established, the database server needs to be configured as follows:

• An Oracle database with a TCP listener listening

• A schema to own the Clarity objects

• Connect, resource privileges on Clarity schema

For example:

create user RELICORE identified by RELICORE default tablespace USERS temporary tablespace TEMP quota 1000M on USERS; grant connect, resource to RELICORE;

• System Privileges:

The Oracle CONNECT role is predefined; it includes the following privileges:

• CREATE SESSION

• ALTER SESSION

• CREATE TABLE

• CREATE VIEW

• CREATE SEQUENCE The Oracle RESOURCE role is also predefined; it includes the privileges listed below:

• CREATE PROCEDURE

• CREATE TRIGGER

• CREATE TYPE

• Quota on Table Spaces: Minimum Default table space:

• POC: > 3GB

• 20 - 150 Agents > 6GB

• 151 - 400 Agents > 16 GB Temporary table space:

• > 200M • Roll Back Segments:

13


• POC: 1 - 19 Agents > 8 segments, 4M each

• Production: 20 Agents or more > 20 segments, 4M each

What You Need To Know

You will need to ask your database administrator to provide the following information. The Clarity Installer program prompts you to supply these values during the Relicore Clarity server installation.

• Database server name

• Oracle SID

• User ID (schema name)

• Password

• Listener TCP Port

Clarity Database

Although the Oracle database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration will not be supported when Relicore adds multi-Clarity server support. For this reason, Relicore recommends deploying the database on a separate machine.

There are two primary requirements for database servers:

CPU/Memory For information on CPU and memory requirements, refer to the Hardware Requirements on Solaris and Hardware Requirements on Windows topics. Disk Given the large quantities of information that the Clarity application can generate, both the size and type (that is, RAID, etc.) of the disk subsystems must be considered as well as the type. In general, the majority of information stored in the database is fairly small with the following exceptions:

• Change tracking information, such as file changes.

• Content tracking information, such as diffs for a file change.

• Attachments added to notes. Ultimately, the required disk space will be a function of how fast events are generated, how many agents are being supported, and how long event information is saved in the system.

14


Clarity Agents

Disk Configuration Minimum Disk

Space (GB)

Recommended Disk Space

(GB)

RAM

Up to 20 2 SCSI disks. Redo log on one, database files and rollback segments on the other.

7 14 1GB

21 - 150 SCSI based RAID disk array with 4-5 disks.

10 21 1GB

151 - 400

SCSI based 10,000 RPM RAID disk array with 4-5 disks.

20 40 1GB

After the database server is set up, much of the free disk space that remains should be made available for Oracle data storage. Relicore recommends that you configure Clarity tablespace to use all but 1GB of disk space and save the remainder in case rollback segments and/or temp space needs to be enlarged in the future.

The determining factor in database performance is the speed of the disk I/O subsystem. Relicore suggests that the database server be configured with the fastest disk array possible. For example, a SCSI based 10,000 RPM RAID disk array with 4 to 5 disks. Also a 5-disk RAID-5 subsystem utilizing a 64KB stripe size is favored when data integrity is required.

Oracle Installation on the Relicore Clarity Server

Relicore recommends that Oracle be installed on a machine other than the machine on which the Relicore Clarity server is installed.

If you choose to install the Oracle database on the same machine as the Relicore Clarity server, Relicore recommends that you observe the steps outlined below during the installation process.

The following steps are an excerpt; they do not correspond to every dialog box that appears in the Oracle installation wizard. Respond to other installation instructions as is appropriate for your environment. Relicore recommends that you review Oracle Database Requirements.

To install Oracle:

1. Launch the Oracle Universal Installer. 2. Select Oracle. 3. In the Type of Installation dialog box, select Custom. 4. In the Available Product Components dialog box, ensure that Oracle HTTP Server is

not selected.

15


To configure Relicore Oracle database using the Database Configuration Assistant:

1. Select Create a database and click Next. You are prompted to identify the database type.

2. Select Custom and click Next. You are prompted to identify the primary type of application that will be used.

3. Select Multipurpose and click Next. 4. Accept the default value for the currently connected users and click Next.

You are prompted to identify the mode in which you want the database to operate.

5. Select Dedicated Server Mode and click Next. The Optional Features dialog box appears.

Relicore Clarity does not require you to install any optional features.

6. Clear optional features at your discretion and click Next. 7. Provide database information and click Next. 8. Select the defaults until prompted to review the system global area (SGA) parameters. 9. Ensure that SGA sizes are less than physical memory for the machine the on which the

database is installed and click Next. 10. Continue configuring the database as is appropriated for your business needs.

Required Solaris Patches

At Sun’s recommendation, a number of patches are required to run the JRE/JDK 1.4.2_02 environments on a Solaris (SPARC) system. Without the installation of these patches, the installation process will not proceed.

Obtaining Solaris Patches

Solaris patches can be obtained from Sun’s SunSolve web site at no cost. The URL for the SunSolve site is:

http://java.sun.com/j2se/1.4.2/download.html

Use the showrev -p command to determine which patches are installed on a Solaris system. See showrev(1M).

16


The following patches are for the Relicore Clarity Server on the Solaris 2.8 operating system.

Solaris Patch # Nature of Patch Problem Fixed

According to Sun, the following patches are considered the most important and highly recommended patches that avoid the most critical system, user, or other bugs related to the functionality of the Java platform on the Solaris Operating Environment which have been reported and fixed to date. Other patches or patch sets are provided with the initial installation of the Solaris Operating Environment. Refer to your Solaris product installation documentation to be sure that all the patches required at product installation are already installed. 108652-74 X11 6.4.1: Xsun patch 108921-18 CDE 1.4: dtwm patch 108940-57 Motif 1.2.7 and 2.1.1:

Runtime library patch for Solaris 8

112003-03 SunOS 5.8: Unable to load fontset in 64-bit Solaris 8 iso-1 or iso-15

108773-18 SunOS 5.8: IIIM and X Input & Output Method patch

111310-01 SunOS 5.8: /usr/lib/libdhcpagent.so.1 patch

109147-26 SunOS 5.8: linker patch 111308-04

SunOS 5.8: /usr/lib/libmtmalloc.so.1 patch

112438-02 SunOS 5.8: /kernel/drv/random patch

108434-13 32-Bit Shared library patch for C++


111111-03 SunOS 5.8: /usr/bin/nawk patch

112396-02 SunOS 5.8: /usr/bin/fgrep patch

110386-03 SunOS 5.8: RBAC Feature Patch

111023-02 SunOS 5.8: /kernel/fs/mntfs and /kernel/fs/sparcv9/mntfs patch

108987-13 SunOS 5.8: Patch for patchadd and patchrm

108528-26 SunOS 5.8: kernel update patch

17


108989-02 SunOS 5.8: /usr/kernel/sys/acctctl and /usr/kernel/sys/exacctsys patch

108993-26 SunOS 5.8: LDAP2 client, libc, libthread and libnsl libraries patch

The following patches are for the Relicore Clarity Agent on the Solaris 2.8 operating system.

Solaris Patch # Nature of Patch Problem Fixed

According to Sun, the following patches are considered the most important and highly recommended patches that avoid the most critical system, user, or other bugs related to the functionality of the Java platform on the Solaris Operating Environment which have been reported and fixed to date. Other patches or patch sets are provided with the initial installation of the Solaris Operating Environment. Refer to your Solaris product installation documentation to be sure that all the patches required at product installation are already installed. 109147-26 SunOS 5.8: linker patch 111308-04

SunOS 5.8: /usr/lib/libmtmalloc.so.1 patch



112396-02 SunOS 5.8: /usr/bin/fgrep patch

111023-02 SunOS 5.8: /kernel/fs/mntfs and /kernel/fs/sparcv9/mntfs patch

108528-26 SunOS 5.8: kernel update patch

18


The following patches are for the Relicore Clarity Agent on the Solaris 2.6 operating system.

Solaris Patch # Nature of Patch Problem Fixed 105568-26 or later

SunOS 5.6: /usr/lib/libthread.so.1 patch

Infrequent problem. Hangs forever inside wait(int millis) or Thread.sleep(int millis).

107733-11 or later

SunOS 5.6: Linker patch Problem loading dynamically linked libraries with setuid root.

105210-51 or later

SunOS 5.6:libaio,libc, & watchmalloc patch

Problems related to LibC and watchmalloc.

105181-35 or later

This patch is required. The Relicore driver will not load without this patch.

SunOS 5.6: Kernel update patch

Various kernel problems. Also prerequisite for patches 105210 and 105211.

105591-19 or later

C++ Shared library patch Exception-handling and other errors in libC.

112542-01 fgrep fails with "wordlist to large"

No patches are required for the Relicore Clarity Agent to run on the Solaris 2.9 Operating System.

Hardware Requirements on Solaris

Clarity Server

The Relicore Clarity Server can be deployed on a system running Sun Solaris 2.8. Relicore recommends the following configurations:

• Proof of Concept (PoC) – Single CPU 450MHz or higher UltraSparc II or equivalent with at least 1GB of free RAM. The Clarity server will require a minimum of 500MB of free disk space for installation and use.

• Departmental – Dual CPU 1GHz or higher UltraSparc IIIi or equivalent with at least 2GB of free RAM. The Relicore Clarity Server requires a minimum of 2G of free disk space for installation and use.

• Enterprise – Quad CPU 1GHz or higher UltraSparc IIIi or equivalent with at least 3GB of free RAM. The Clarity server will require a minimum of 4GB of free disk space for installation and use. If Global Mapper is enabled the system should have at least 4GB of free RAM and 6GB of free disk space for installation and use.

19


A proof-of-concept (PoC) configuration is an installation in which the Clarity server and database are installed on the same machine. A PoC installation should involve ten (10) agents or fewer.

A departmental configuration is an installation with 400 or fewer agents; an enterprise configuration involves 401 or more agents.

Clarity Agent

The Clarity agent runs on Solaris 2.6, 2.8, and 2.9 systems. The agent requires 100MB of free RAM. For agent installation, 300MB of free disk space is required. Each agent requires additional disk space to store copies of files that are being tracked for changes in content. For any file whose content is being tracked for changes, Clarity needs enough disk space on the agent to hold one prior copy of that file.

Clarity Database

Although the Oracle or IBM UDB database can be run on the same machine as the Clarity server, doing so reduces the scalability of the Clarity server and this type of configuration is not supported in Enterprise or Global Mapper environments. For this reason, Relicore recommends deploying the database on a separate machine.

There are two requirements you should consider when configuring a database server to support a single Clarity domain:

1. CPU/Memory

• For departmental Clarity installations, a single CPU 1.0GHz or higher UltraSparc IIIi or equivalent with 2GB of free RAM (or more) is recommended.

• For enterprise Clarity installations, a dual CPU 1.0GHz or higher UltraSparc IIIi or equivalent with 4GB of free RAM (or more) is recommended.

2. Disk IO

• Proper configuration of the disk I/O is essential to ensure that the system works optimally. Refer to the Clarity - DB2 Setup.pdf document for additional information on setting up the Disk I/O sub system.

• When a single database instance is shared between multiple Clarity Servers, the database server's CPU, Memory, and Disk/IO configuration must be scaled accordingly.

Refer to Oracle Database Requirements for additional information on Oracle setup. Refer to the Clarity - DB2-UDB Setup.pdf file located in C:\Program Files\Relicore\server\4.1\web\techpubs for additional information on UDB setup.

20


Installation Directories on Solaris

The Relicore Clarity Administration Guide refers to the Clarity product by its internal product code name, EMX.

The installation directory structure is as follows:

• {EMX_ROOT}: The top level EMX installation directory, for example /opt/relicore/emx/agent

• {EMX_HOME}: The version specific directory containing the EMX kit. Directories of significance in {EMX_HOME} are as follows:

• {EMX_HOME}/bin: Binaries/scripts

• {EMX_HOME}/config: Configuration files

• {EMX_HOME}/models: Model files

• {EMX_HOME}/data: managed object state of the product

• {EMX_COMMON}: The common directory, named “common” contains the current state, content tracking files and log file output.

• {EMX_COMMON}/logs: Log file output directory

• {EMX_COMMON}/content: Content tracked files

• {EMX_COMMON}/runtime: The Relicore runtime environment, as follows:

• Server: JDK, Tomcat

• Agent: JRE

• {EMX_COMMON}/state: Persistent state of the product. For example, if you were to install the Relicore Clarity agent (although this equally applies to a server) on a Solaris system into /opt/relicore/emx/agent, you would see:

Directory Value EMX_ROOT opt/relicore/emx/agent EMX_HOME opt/relicore/emx/agent/x.x EMX_COMMON opt/relicore/emx/agent/common

21


System Requirements for Linux

System and Hardware Requirements on Linux

The following are the system requirements on Linux:

• The Relicore Linux agent is supported on: o RedHat Advanced Server 3.0, kernel version 2.4.21 (SMP and Uniprocessor).

The supported RPM version is 4.2. o Redhat Advanced Server 2.1, Kernel v2.4.9e34, 32-bit x686 multi-processor and

enterprise. The supported RPM is 4.0.4. The JVM version is 1.4.2. o SUSE Linux agent is certified on SMP 2.4.21-169 on Intel x86, 32 bit with RPM

3.0.6 o No additional patches are required for a Linux agent. o Custom kernels are not supported. o 64-bit kernels are not supported.

Hardware Requirements

The Clarity Agent runs on x86-based Linux systems running one of the operating systems listed previously. The Agent requires 75MB of free RAM. For agent installation, 300MB of free disk space is required. Each agent requires additional disk space to store copies of files that are being tracked for changes in content. For any file whose content is being tracked for changes, Clarity needs enough disk space on the agent to hold one prior copy of that file.

Installation Prerequisites on Linux

The Relicore Linux agent is supported on Linux RedHat Advanced Server 3.0, kernel version 2.4.21 (SMP and Uniprocessor) and Linux Redhat Advanced Server 2.1, Kernel v2.4.9e34, 32-bit x686 multi-processor and enterprise with JVM version 1.4.2; the Relicore SUSE Linux agent is certified on SMP 2.4.21-169 on Intel x86, 32 bit dual processor. The prerequisites for a Linux installation are as follows:


• Administrator access to the Relicore Clarity interface.

• If manual configuration is chosen, a credentials JAR file must be generated from the Relicore Clarity server user interface for this agent; note that each agent requires a unique credentials JAR file to be created for it.

• If you select database encryption on the Relicore Clarity server installation, be sure to note the password. Otherwise, you will be unable to connect to your Clarity server.

22


You need to copy the clarity-agent_4.x.xxx.x_Linux-i686.bin installation kit file and, if you choose to configure the Relicore Clarity agent manually, a credentials JAR file agentinfo.jar into a temporary directory on your Linux system (that is, /var/tmp). Otherwise, you need to provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity agent.

Relicore Clarity Agent Linux Service



# ./emx_agentd.sh

Usage: ./emx_agentd.sh { start | stop } emx_agent /etc/init.d This script is a multi user mode run level

script. It calls emx_agentd.sh to start and stop the agent process.

System Requirements for AIX

System and Hardware Requirements on AIX

The following are the system requirements on AIX:

• The Relicore agent will support IBM Aix 5.2 L, on the "Power" hardware platform both uniprocessor and multiprocessor configurations of either 32 or 64 bit kernels, Maintenance Level 3 with IY56367, IY56982, and IY60105 ARPAs patches or a higher Maintenance Level. The java platform used will be IBM-s JVM 1.4.2_00, 32 bit only.

• The supported RPM version is 3.0.5 • No additional patches are required for an AIX agent.

Hardware Requirements

The Clarity agent runs on "Power" hardware platform on both uniprocessor and multiprocessor configurations of either 32 or 64 bit kernels. The Agent requires 100MB of free RAM. For agent installation, 300MB of free disk space is required. Each agent requires additional disk space to store copies of files that are being tracked for changes in content. For any file whose content is being tracked for changes, Clarity needs enough disk space on the agent to hold one prior copy of that file.

23


Installation Prerequisites on AIX

The Relicore agent will support IBM Aix 5.2 L, on the "Power" hardware platform both uniprocessor and multiprocessor configurations of either 32 or 64 bit kernels, Maintenance Level 3 with IY56367, IY56982, and IY60105 ARPAs patches or a higher Maintenance Level. The java platform used will be IBM-s JVM 1.4.2_00, 32 bit only. The prerequisites for an AIX installation are as follows:





• The installation will be primarily RPM based, but it will fall back to LPP install if RPM support is not present. In this case, an error message will indicate that uninstall will not be available. To uninstall, the driver will have to be manually removed, and the install root will have to be manually removed (i.e. use rm –rf ).

• Upgrade is not supported with an LPP based install.

You need to copy the clarity-agent_4.x.xxx.x_AIX-powerpc.bin installation kit file and, if you choose to configure the Relicore Clarity agent manually, a credentials JAR file agentinfo.jar into a temporary directory on your Solaris system (that is, /var/tmp). Otherwise, you need to provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity agent.

Relicore Clarity Agent AIX Service



# ./emx_agentd.sh

Usage: ./emx_agentd.sh { start | stop } S99reliagent /etc/rc.d/rc2.d Is called by the system when the system

enters run level 2 during startup. It calls emx_agentd.sh start to actually start the agent process.

k99reliagent /etc/rc.d/rc2.d Called by the system when the system enters run level 2 during shutdown. It calls emx_agentd.sh stop to actually stop the agent process.

24


Installing Relicore Clarity Server

Clarity Server Installation Considerations

Before you deploy Relicore Clarity, Relicore recommends that you review the following list of Clarity server installation considerations. The list is intended to help you define and manage the server installation configurations that, in turn, will enable you to meet your business needs.

Port numbers are divided into three ranges: Well Known Ports, Registered Ports, and Dynamic and/or Private Ports. A list of registered port numbers is available from http://www.iana.org/assignments/port-numbers as of the date of this document.

• What machines do you want to manage.

• What Oracle or UDB database do you plan to use with your Relicore Clarity installation. Should this be an encrypted communication. You can choose to use database encryption when you install the server.

Make note of the database password; it is required for all subsequent agent activations.

• On what machine will the Relicore Clarity server be installed.

• Are there firewall configurations that you must consider.

• Configuring the Server for HTTPS protocol.

• UI Port Configuration. Decide if port 8080 is an acceptable default port for the Relicore UI. If not, you may change this in the .../[Emx_Common]/runtime/Tomcat/4.1/Conf/Server.xml file. (Requires a Clarity Server restart). If you change this port it must be noted and used during all UI connections.

• Server Bootstrap (Agent Activation Port) Configuration. Decide if port 8444 is an acceptable default port for agent activation. If not, you may change this in the .../[Emx_Common]/runtime/Tomcat/4.1/Conf/Server.xml file. (Requires a Relicore Server Restart). If you change this port it must be noted and used during all agent activations. (All documentation references port 8444.)

• Server Listen Port for Agent-Initiated Communications. Decide if the Server Listen Activation port 8192 is an acceptable default port for the Clarity Agents to connect to on the Relicore Clarity Server and if not, change the option.

1. From the Relicore Clarity user interface, select Administration > Systems > Server.

2. From the Server summary panel, select the Clarity Server. 3. In the Server detail panel, select the Connection tab. 4. From the toolbar, click Modify. 5. In the Modify Connection dialog box, change the default Listen on Port setting

and then click OK.

25


• DNS Names for Agent Configuration.

Relicore recommends using DNS names because IP addresses change. Decide whether using DNS Names for Agent Connection is acceptable and if not, disable the option.


2. From the Server summary panel, select the Clarity Server. 3. In the Server detail panel, select the Connection tab. 4. From the toolbar, click Modify. 5. In the Modify Connection dialog box, click Use DNS Names to disable the

option and then click Save.

• IP Updating for Agents (default = enabled)

Relicore recommends that IP Updating remain enabled. Periodically, the Relicore Server checks to see if it has any new IP addresses. When new IP addresses are discovered, the server pushes the changes out to Clarity agents that are configured to receive IP address updates. Decide whether IP updating is an acceptable default for your Relicore Server and if not, disable the option.


2. From the Server summary panel, select the Clarity Server. 3. In the Server detail panel, select the Config tab. 4. Scroll to Connection Service, click IP Updating to disable the option, and then

click Save. • Server - Agent Connection Logging

The default is to not report any connection information. Decide whether you want agent connection information written to the Relicore Server Log by default and if yes, change the default.


2. From the Server summary panel, select the Clarity Server. 3. In the Server detail panel, select the Config tab. 4. Scroll to Connection Service. 5. In the Heartbeat level box, type a value and then click Save.

26


• Server – Model Updates to Agents & Agent Restart Time The default is to restart all managed systems with a new model file between 4:00PM and 6:00AM. When an agent receives a new model file from the server, the agent waits (by default) to process the new model based on a server model manager setting. By default all agents are restarted during this time period. Decide whether the Agent restart time is acceptable and if not, change the default.


2. From the Server summary panel, select the Clarity Server. 3. In the Server detail panel, select the Config tab. 4. Scroll to Model Manager Settings, edit the Agent Restart Begin and End Time

and then click Save.

Configuring the Server for HTTPS Protocol

The web site Clarity users access can be configured to be a secure site that uses the Secure Sockets Layer (SSL); an industry standard security technology for creating an encrypted link between a web server and a browser. This link ensures that the web server and browser communicate over a secured connection.

To create an SSL link, the web server requires an SSL Certificate. After the link is established all communication between the web server and browser will remain confidential.

To configure the server for HTTPS protocol:

1. Install Clarity. 2. Execute the following script:

Type: .../server/4.x/bin/emx_serverd.<cmd|sh> configureSSL

3. As the script runs, provide information as summarized in the following table:

27


There are options for configuring certificates. You can choose to configure a self signed Tomcat certificate or install a customer signed certificate.

Do you wish to setup Tomcat HTTPS support? (Y/N)

The port default is 8443. Do one of the following:

• Accept the default port.

• Specify a port of your choice.

If you choose a port <= 1024 on Solaris, you must be installed and running as root to start the server.

Enter the password Tomcat will use to access the key:

Make a note of the password for future reference. You are prompted to provide this password each time you run a keytool command.

Enter the certificate information:

• Country?

• State or Province?

• Locality?

• Organization?

• Organizational Unit?

After you supply this information, the Tomcat/4.1/conf/server.xml file is modified with a new https connector and the information you provided. The Clarity server automatically restarts and you are able to connect to the port you supplied.

To make the certificate unique to the servers, you are prompted to fill in the information normally stored in any certificate. The exception is the common name portion of the certificate, which follows the convention of having the common name match the server's name. This is automatically stored in the certificate. When prompted, you are permitted to leave any or all of these fields blank or provide information at your discretion.

4. Browse to the Clarity UI using https://<host>:<httpsPort> to confirm that the connection is operational.

• If you are not installing a custom certificate, you are finished. The server is now configured for HTTPS protocol.

• If you are installing a custom certificate, proceed to step 5.

28


5. Stop the server:

Solaris Type: <EMX_HOME>/bin/emx_serverd.sh stop Windows Type: <EMX_HOME>\bin\emx_serverd.cmd stop

6. Change directory to:

cd server/common/runtime/Tomcat/4.1

7. Set your path:

Solaris Type: export PATH=../../JDK/1.4/bin:PATH Windows Type: set PATH=..\..\JDK\1.4\bin:%PATH%

8. Run keytool -delete -alias tomcat -keystore tomcat.keystore 9. Run keytool -genkey -keyalg RSA -alias tomcat -keystore tomcat.keystore

Provide answers to the questions as you are prompted.

When you are prompted for first/last name, it is imperative that you provide hostname and that you fill in the complete name of your state or province. Do not use an abbreviation; your signing authority will reject your certificate request and you will have to go back and repeat this step.

It is also important that you set the key and keystore password to be the identical.

10. Run keytool -certreq -alias tomcat -keyalg RSA -file myCertReq.cer -keystore tomcat.keystore.

11. Send (via e-mail, link, or other means) the myCertReq.cer to your signing authority. The signing authority uses this to generate a certificate that you can use as the SSL cert for HTTPS.

12. Place the information returned by your signing authority into a file and name that file signed.cer; this file must reside in the Relicore Tomcat directory.

It is imperative that you leave a carriage return at the end of the last line of the certificate and no more than 1 single line out. If you do leave extra or not enough carriage returns, keytool will determine that the certificate is not a valid X.509 certificate.

13. Obtain the Certificate Authority (CA) certificate from the signing authority, place it in a file, and then name the file ca.cer. Normally, the CA will provide either this—or a link to it—in the e-mail they send with the signed certificate.

29


14. Run keytool -import -trustcacerts -alias root -file ca.cer -keystore tomcat.keystore 15. When prompted to trust this certificate, type yes. 16. Run keytool -import -trustcacerts -alias tomcat -file signed.cer -keystore

tomcat.keystore 17. When prompted to trust this certificate, type yes. 18. Start the server:

Solaris Type: <EMX_HOME>/bin/emx_serverd start Windows Type: <EMX_HOME>\bin\emx_serverd.cmd start

19. Browse to the Clarity UI using https://<host>:<httpsPort> to confirm that the connection is operational.

Installing the Clarity Server on Windows

Installing the Clarity Server on Windows in Graphical Mode

If you are installing from the FTP site, you will need to copy the clarity-server_4.x.xxx.x_Win-x86.exe installation kit file into a temporary directory on your Windows system (e.g. C:\Temp), or otherwise provide network access to the kit prior to installing the Relicore Clarity server.

To install the Relicore Clarity server:

1. Execute the clarity-server_4.x.xxx.x_Win-x86.exe file. The Relicore Clarity Server Setup prepares the InstallShield Wizard. This process takes just a few seconds to prepare before it begins the Relicore Clarity server setup.

30


2. Click Next. The Directory Name dialog box appears.

3. Review the directory settings and click Next.

If you change the default directory, InstallShield prompts you to confirm the new directory.

31


The Installation Features dialog box appears.

4. Review the installation features and total size and click Next. The Setup Status dialog box appears.

When Setup is complete, the Server Database Configuration dialog box appears.

32


5. Provide database setup configuration information in the appropriate box and click Next.

For additional information about database configuration, review the database setup guidelines or contact Relicore Client Services.

Configuration values are described in the table below:

Value Type Description Database Type Type Database type is Oracle or UDB. Database Hostname Hostname Hostname of the database server. Database Port Port Database communications port. Default is 1521 for

Oracle and 50000 for UDB. Database SID/Name String Oracle SID or UDB database name set aside in the

installation on the database server for the Relicore server application (see your DBA).

Database Username Username Username for the database server with appropriate permissions for the specified SID (see your DBA).

Database Password Password Password for the database user.

33


6. Click Next.

Value Type Description DB Encryption Password

Yes/No If selected, indicates that a database encryption password should be used. Supply a password or instruct the system to generate one for you. This password is an additional layer of security between the server and the database.

If you click Generate, make a note of the password for future reference. You must provide this password for agent activations.

SMTP Server for feedback

Hostname Specifies the name of the SMTP server to use for sending feedback mail from the UI.

The Installation Wizard begins installing and configuring the Relicore Clarity Server. This process can take several minutes; there is no status progress indicator.

34


The InstallShield Wizard Completion dialog appears when configuration is complete.

7. Click Finish. 8. Log in to the Relicore Clarity user interface with the URL:

The default URL format is: http://localhost:8080/emx

The Relicore Clarity server ships with a default username and password of admin/admin, it is recommended that you immediately change the password for the admin user.

If the server is configured for HTTPS protocol browse to the Clarity UI using https://<host>:<httpsPort> to confirm that the connection is operational.

If the UI port configuration has changed, browse to the Clarity UI using that port.

Installing the Clarity Server from the Command Line on Windows

A silent—or quiet—installation is one which does not display any indication of its progress.

If you are installing from the FTP site, you will need to copy the clarity-server_4.x.xxx.x_Win-x86c.exe installation kit file into a temporary directory on your Windows system (e.g. C:\Temp), or otherwise provide network access to the kit prior to installing the Relicore Clarity server.

To perform a silent installation of the Clarity Server at the command line:

1. Review the installation prerequisites for Windows.

35


2. From a DOS window, change to the directory that contains the Clarity installation kit and run the -quiet command. For example: <C:\temp\>clarity-server_<4.x.xxx.x_Win-x86c.exe> -quiet


The command line inputs for installing the Clarity Server on Windows are described in the table below.

Command Default Brief Description

-help ? Opens the help screen for the command line arguments relating to the installation of the Windows Clarity Server.

-d destDir C:\Program Files\Relicore\Server

The destination directory for this product. Make sure to "" directories with spaces in the path.

-u When this argument is supplied, the installer forces an upgrade of an existing installation to this version. If a previous install is not found, the installer exits.

This argument can not be specified with any other arguments.

-e When this argument is supplied, the installer automatically generates a database encryption password.

If -e or -p is not specified, no password is required.

-p When this argument is supplied, the installer uses a given string as a database encryption password.

This argument overrides -e if both arguments are specified. If -e or -p is not specified, no password is required.

-s smtpHost

None The name of the SMTP host the server uses for sending feedback mail from the Clarity user interface.

-t dbType Oracle Specifies the manufacturer of the database. (1)=Oracle, (2)=UDB.

-b databaseHost

None Hostname of the database server. There is no default value, a databasehost must be provided.

-o portNumber 1521 (Oracle); 50000 (UDB)

Database communications port.

36


-i Oracle SID/UDB Database Name

None Oracle SID or UDB database name set aside in the installation on the database server for the Relicore server application. For additional information, refer to Oracle Database Requirements or the Clarity - DB2-UDB Setup.pdf file located in C:\Program Files\Relicore\server\4.0\web\techpubs, in the case of UDB. There is no default value, a SID or database name must be provided.

-n dbUserName

None Username for the database server with appropriate permissions for the specified SID (consult your DBA). There is no default value, a dbusername must be provided.

-w dbPassword

None Password for the database user. There is no default value, a dbpassword must be provided.

Starting the Windows Service

The setup process installs the Relicore Clarity Server as a Windows service. When the service is running, the Relicore Clarity Server is also running, by default the service is configured to auto start and stop when the system boots or shuts down. You can change this option in the Windows Control Panel Services section.

Starting and stopping the Relicore Clarity Server service can be done via the Windows Control Panel or by command line scripts part of the Relicore installation.

Starting the Relicore Clarity Server Windows Service

By default, the Relicore Clarity Server service is installed so that it starts and stops automatically. However, it can be started manually if necessary.

To start the service via the Windows Control Panel:

1. From the Start menu, select Settings > Control Panel. 2. Open Administrative Tools and then launch Services.

37


3. Select Relicore Clarity Server and click the Start Service button ( ). To start the server via the command line:

• Run the emx_serverd.cmd script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>\bin\emx_serverd.cmd start

38


Stopping the Windows Server Service

Stopping and starting the Relicore Clarity Server service can be done via the Windows Control Panel or by command line scripts part of the Relicore installation.

By default, the Relicore Clarity Server service is installed so that it starts and stops automatically. However, it can be stopped manually if necessary.

To stop the service via the Windows Control Panel:


3. Select Relicore Clarity Server and click the Stop Service button ( ).

To stop the service via the command line:

• Run the emx_serverd.cmd script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>\bin\emx_serverd.cmd stop

Performing Server Maintenance on Windows

If you want to change port assignments, you might want to familiarize yourself with well-known and registered ports. Refer to http://www.iana.org/assignments/port-numbers for a complete list. Since this is not a Relicore site, it may change without notice.

There are maintenance steps available for the Relicore Clarity server:

Changing the Relicore User Interface Server Port on Windows

The Relicore Clarity server is configured by default to listen for HTTP requests for the UI on port 8080.

39


To modify this port setting:

• Browse to: C:\Program Files\Relicore\Server\common\runtime\Tomcat\4.1\conf • Edit the server.xml file

• Update the definition of the normal HTTP Connector (HttpConnectionHandler) to reflect the desired port.

Changing the Relicore Agent Activation Server Port

The Relicore Clarity server is configured by default to listen for HTTPS requests for Agent Activation on port 8444.


• Browse to: C:\Program Files\Relicore\Server\common\runtime\Tomcat\4.1\conf • Edit the server.xml file

• Update the definition of the Emx Bootstrap HTTPS Connector (HttpConnectionHandler) to reflect the desired port.

This Connector can be identified by finding the Connector with a Parameter entry whose name is “keystoreFile” and whose value contains “config/bootstrap.keystore”.

Viewing Log File Contents on Windows

To view log file contents:

1. Browse to the install directory. 2. Enter the common log directory (from the Relicore Clarity install directory):

Browse to: C:\Program Files\Relicore\Server\common\logs

3. To view the installation log file, open emx-server-install.4.x.log. Relicore Clarity log files are written to this directory, the naming convention is emx-log <#>.log

The emx-watchdog.out.<#> and emx-watchdog.err.<#> files also reside in this directory.

40


Installing the Clarity Server on Solaris

Installing the Clarity Server in Console Mode on Solaris

You need to copy the clarity-server_4.x.xxx.x_SunOS-sparc.bin installation kit file into a temporary directory on your Solaris system (that is. /tmp), or otherwise provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity server.

Review the Relicore Server Installation Considerations before installing the Relicore Clarity server.

Currently, the Clarity server priority in the /etc/init.d/rc?.d directories is 99, which means start it last and stop it first. Refer to the Solaris Administration Guide for updated information.

To install the Clarity Server:

1. Review the Solaris installation prerequisites. 2. Set any execute permissions for the installer kit.

Type: chmod u+x /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin

3. Execute the /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin file. Type: /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin -console

4. As the pkgadd installer runs, you need to provide configuration information. Configuration values are described in the table below:

Value Type Description Install Directory Pathname Installation directory for this Relicore Clarity

server instance. Database Type Type Database type is Oracle or UDB. Database Hostname

Hostname Hostname of the database server.

Database Port Port Database communications port. Default is 1521 for Oracle and 50000 for UDB.

Database SID/Name

String Oracle SID or UDB database name set aside in the installation on the database server for the Relicore server application (see your DBA).

Database Username

Username Username for the database server with appropriate permissions for the specified SID (see your DBA).

Database Password Password Password for the database user. DB Encryption Password

Yes/No If selected, indicates that a database encryption password should be used. Supply a password or instruct the system to generate one for you.

If you choose Generate, make a note of the password for future reference. You must provide this password for Agent activations.

SMTP Server Hostname Specifies the name of the SMTP server to use for sending feedback mail from the UI.

41


When the pkgadd completes, the Relicore Clarity server is now ready for use.

4. Confirm that the server started: Type: ps –e –o pid,fname,args | grep emx or emx_serverd.sh status

Relicore Clarity uses a controller program to monitor its current state, stop it, and restart it if necessary. This program is called Watchdog. If you observe a process listing, you see two EmxWatchdog processes; the controller program and a slave process. Product functionality resides in the slave process.

5. Log into the Relicore Clarity user interface. The default URL format is: http://localhost:8080/emx


If the server is configured for HTTPS protocol, browse to the Clarity UI using https://<host>:<httpsPort> to confirm that the connection is operational.


Installing the Clarity Server in Graphical Mode Solaris

The system you are installing from must have an X Window System to use the graphical wizard based version of the installer. If you do not have this prerequisite, you can install in console mode.

To install the Clarity Server:

1. Review the Solaris installation prerequisites. 2. Set any execute permissions for the installer kit.


3. Execute the /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin file. Type: /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin

42


The Relicore Clarity Server Setup prepares the InstallShield Wizard. This process takes just a few seconds to prepare before it begins the Relicore Clarity server setup.

4. Click Next.

The Directory Name dialog box appears.

5. Review the directory settings and click Next.

43


If you change the default directory, InstallShield prompts you to confirm the new directory.


6. Review the installation features and total size and click Next.

The Setup Status dialog box appears.

44


When Setup is complete, the Server Database Configuration dialog box appears. The default database type is Oracle. If Oracle is not your database type, select IBM DB2/UDB in the Database Type field.

7. Provide database setup configuration information in the appropriate box and click Next.

For additional information about database configuration, review the database setup guidelines or contact Relicore Client Services.

Configuration values are described in the table below:

Value Type Description Database Type Type Database type is Oracle or UDB. Database Hostname Hostname Hostname of the database server. Database Port Port Database communications port. Default is 1521 for

Oracle and 50000 for UDB. Database SID/Name String Oracle SID or UDB database name set aside in the

installation on the database server for the Relicore server application (see your DBA).

Database Username Username Username for the database server with appropriate permissions for the specified SID (see your DBA).

Database Password Password Password for the database user.

45


8. Enter additional database configuration data and click Next.

Value Type Description DB Encryption Password

Yes/No If selected, indicates that a database encryption password should be used. Supply a password or instruct the system to generate one for you. This password is an additional layer of security between the server and the database.

If you click Generate, make a note of the password for future reference. You must provide this password for agent activations.

SMTP Server for feedback

Hostname Specifies the name of the SMTP server to use for sending feedback mail from the UI.

The Installation Wizard begins installing and configuring the Relicore Clarity Server. This process can take several minutes; there is no status progress indicator.

46


The InstallShield Wizard Completion dialog appears when configuration is complete.

9. Click Finish. 10. Log in to the Clarity user interface with the URL:

The default URL format is: http://localhost:8080/emx


If the server is configured for HTTPS protocol, browse to the Clarity UI using https://<host>:<httpsPort> to confirm that the connection is operational.


47


Installing Clarity Server in Unattended Mode on Solaris

An unattended installation is one which does not require user interaction; you will not be prompted for input during the installation process.


To perform an unattended installation of the Clarity Server at the command line:

1. Review the Installation prerequisites for Solaris. 2. Type: chmod u+x /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin. 3. Provide the minimum input that is required for unattended installation:

The order in which you provide input is very important; be certain to follow the format as outlined.

Type: ./clarity-server_4.x.xxx.x_SunOS-sparc.bin -quiet -s smtp.relicore.com -t 1 -b redhook.relicore.com -o 1521 -i clarity -n relicore -w relicore

The command line inputs for an unattended installation of the Clarity Server on Solaris are described in the table below.


-h[elp] ? Prints this help screen.

-d destDir /opt/relicore/emx/server The destination directory for this product.

-u When this argument is supplied, the installer forces an upgrade of an existing installation to this version. If a previous install is not found, the installer exits.

This argument can be used in conjunction with -f. All other arguments are ignored.

-e When this argument is supplied, the installer automatically generates a database encryption password.

If -e or -p is not specified, no password is required.

48


-p dbEncryptionPassword

When this argument is supplied, the installer uses a given string as a database encryption password.

This argument overrides -e if both arguments are specified. If -e or -p is not specified, no password is required.

-s smtpHost None The name of the SMTP host the server uses to sending feedback mail from the Clarity user interface.

-t oracle Specifies the manufacturer of the database. (1)=oracle, (2)=UDB

-b databaseHost None Hostname of the database server.

-o portNumber 1521 (Oracle); 50000 (UDB)

Database communications port.

-i oracle SID/UDB Database name

None Oracle SID or UDB database name set aside in the installation on the database server for the Relicore server application (consult your DBA).

-n dbUserName None Username for the database server with appropriate permissions for the specified SID (see your DBA).

-w dbPassword None Password for the database user. There is no default value, a password must be provided.

-quiet When this argument is supplied, the installer runs in unattended mode. You will not be prompted for input during the installation process.

-f When this argument is supplied, the installer does not perform any system patch checking.

Using this argument can cause the server to operate improperly.

-is:tempdir <tmpdir> /var/tmp A temporary directory to use when extracting the installation files.

Starting the Server on Solaris

To start the server via the command line:

• Run the emx_serverd.sh script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>/bin/emx_serverd.sh start

49


Stopping the Server on Solaris

To stop the server via the command line:

• Run the emx_serverd.sh script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>/bin/emx_serverd.sh stop

Performing Server Maintenance on Solaris

If you want to change port assignments, you might want to familiarize yourself with well-known and registered ports. Refer to http://www.iana.org/assignments/port-numbers for a complete list. Since this is not a Relicore maintained site, it may change without notice.

There are several maintenance steps available for the Clarity server:

Changing the Relicore Clarity User Interface Server Port

The Relicore server is configured by default to listen for HTTP requests for the UI on port 8080.


• Change directory to: {EMX_ROOT}/common/runtime/Tomcat/4.1/conf • Edit the server.xml file

• Update the definition of the normal HTTP Connector (HttpConnectionHandler) to reflect the desired port.

Changing the Clarity Agent Activation Server Port

The Clarity server is configured by default to listen for HTTPS requests for Agent Activation on port 8444.


• Change directory to: {EMX_ROOT}/common/runtime/Tomcat/4.1/conf • Edit the server.xml file

• Update the definition of the Emx Bootstrap HTTPs Connector (HttpConnectionHandler) to reflect the desired port. This Connector can be identified by finding the Connector with a Parameter entry whose name is “keystoreFile” and whose value contains “config/bootstrap.keystore”.

Increasing the Memory Size for a Clarity Server

By default, the Clarity server is configured to use a maximum of 512MB. This configuration is sufficient for larger installations. If you have more memory on your machine, you can increase the maximum memory size. For example, if your machine has 1.5G of memory and is dedicated for

50


the Clarity Server, you might want to increase your maximum memory size to 1200MB. Perform the following procedure to increase the maximum memory size.

To increase memory size:

• In the watchdog.properties file (found in the 4.0\config folder) go to the watchdog.jvm.options line and set the -Xmx512M option to the desired memory size. For example, if you wanted to change the memory size to 1200MB you would change this option to -Xmx1200M.

This change allows the Java Virtual Machine to consume up to 1200MB of memory. When the Clarity server is restarted, these new values will be used.

Setting this parameter larger than the amount of free memory on the system will result in the inability to start the Clarity Server.

Viewing Log File Contents on Solaris

To view log file contents on Solaris:

1. Change directory to the install directory. 2. Enter the common log directory (from the EMX root directory):

Type: cd <EMX_ROOT>\server\common\logs

3. To view the installation log file, open emx-server-install.4.x.log Relicore Clarity log files are written to this directory, the naming convention is emx-log <#>.log

The emx-watchdog.out.<#> and emx-watchdog.err.<#> files also reside in this directory.

You can view Server log files in the Clarity User Interface.

51


Installing Relicore Clarity Agent

Clarity Agent Installation Considerations

You must have must have either Administrator or Power User privileges to install the Relicore Clarity Agent.

Occasionally, the installer for the Clarity Agent fails due to insufficient temporary disk space. When this occurs, the installer displays a message indicating that there was not enough temporary disk space to perform the install. If this happens, you can enter -is:tempdir <dir> on the command line and point it to a directory on a filesystem with at least 150Mb of free space.

After the Relicore Clarity Agent has been installed, it must be configured—or activated—in order for it to function properly.

Decide whether you want to configure the agent automatically or manually.

Automatic or Manual Configuration

Automatic configuration allows a user to install the agent software on the system to be monitored and the user then configures the agent via the Relicore UI. During the automatic configuration the agent connects to the server via the activation port of the server. The default is 8444. Manual configuration allows a user to configure the agent via the Relicore Clarity UI, save all the configuration options to a jar file used during the agent installation. The jar file is password protected and accessed via the agent installation process.

Agent-Initiated vs. Server-Initiated

Agent-initiated communications allow a managed system to initiate all communications to the Clarity server. The default port for this communication is port 8192. If you choose a port other than 8192, it is important to realize this configuration will apply to all other agent initiated systems communicating with the Clarity server. If you believe that each managed system will require a different port configuration, you might consider using Server-Initiated Communications. Server-initiated communications allow the Clarity server to initiate all communications to the selected managed system running a Clarity Agent. The default port configuration for this type of communication is port 8193.


Encrypted vs. Non Encrypted

Agent and Server-initiated communications can be encrypted. This encryption option is available via manual or automatic agent configuration.

Encryption cannot be modified once the agent is activated.

52


Post Agent Installation Considerations

• Model File Updates

Relicore recommends that you accept the default to ensure that Clarity Agents receive new (updated) model files automatically.

The model file will be updated and published via the Relicore Clarity UI; it often includes new applications for discovery and tracking. Decide whether you want Clarity agents to receive published models automatically, and if not, change the default setting.

1. From the Relicore Clarity toolbar, select Administration > Systems > Agents. 2. In the Agent summary panel, select the agent that interests you. 3. On the Agent detail panel toolbar, select Edit Configuration and then click the

General tab. 4. In the Model AutoUpdate Enabled box, click to set the parameter to False. 5. Click OK.

The model autoupdate setting can also be changed by editing a Profile configuration. For additional information refer to the Clarity Online Help.

Windows Agent Installation

Installing the Clarity Agent on a Windows System

The Relicore Clarity agent is supported on Microsoft Windows 2000 and 2003; the prerequisites for a Windows installation are as follows:

• Access to an administrator account on the system the Clarity agent is being installed.


• If manual configuration is chosen, then a credentials JAR file must be generated from the Relicore Clarity server user interface for this agent; note that each agent requires a unique credentials JAR file to be created for it.

If you are installing from the FTP site, you need to copy the clarity-agent_4.x.xxx.x_Win-x86.exe installation kit file into a temporary directory (such as, C:\Temp). Otherwise, you need to provide network access to the kit prior to installing the Relicore Clarity Agent.

To install the Clarity Agent:

1. Insert the Relicore Clarity CD into the CD-ROM drive 2. Double-click on clarity-agent_4.x.xxx.x_Win-x86.exe.

The Relicore Clarity Agent Setup prepares the InstallShield Wizard. This process takes just a few seconds to prepare before it begins the Relicore Clarity agent setup.

53


3. Click Next.

The Directory Name dialog box appears. Relicore Clarity Agent installs in the path shown in the dialog box.

4. Do one of the following:

• Click Next to install the Clarity Agent to the directory shown.

• Click Browse to install to a different directory and then click Next.

54



5. Click Next. The Installation Status Bar appears.

55


When the installation completes, the Agent Activation Preference dialog box appears.

6. Select the Agent Activation method that you prefer and click Next. The activation method you select, determines which InstallShield dialog box appears next.

56


Automatic Agent Activation

a. Provide a hostname and port number for the activation server(s) you are installing. b. Click Add to List. c. Optionally, provide a configuration profile name. By default, Clarity assigns the default configuration profile. d. Click Next.

Manual Agent Activation

a. Provide the name of the credentials JAR file or browse to find the file. Configuring an agent manually requires that you create a credentials JAR file from the Relicore Clarity server user interface.

b. Provide the jar file encryption password that was set when the credentials Jar file was created.

c. Reenter the jar file encryption password for verification.

57


7. Click Next. The InstallShield Wizard displays a message to indicate the agent has been successfully installed.

8. Click Next.

The Relicore Clarity Agent Installer requires a reboot of the Windows system in order for the driver to be loaded at system boot time. This is true for Automatic Agent Activation and Manual Agent Configuration.

58


9. Select when you would like to restart your system:

• Click Yes to restart the system and complete the installation at this time.

• Click No to restart the system at a later time. The Windows machine requires a reboot for the Clarity agent to start.

10. Click Finish.

Installing Clarity Agent from the Command Line on Windows

A quiet—or silent—installation is one which does not display any indication of its progress.

If you are installing from the FTP site, you will need to copy the clarity-agent_4.x.xxx.x_Win-x86c.exe installation kit file into a temporary directory on your Windows system (e.g. C:\Temp), or otherwise provide network access to the kit prior to installing the Relicore Clarity agent.

To perform a quiet installation of the Clarity Agent at the command line:

1. Review the installation prerequisites for Windows. 2. From a DOS window, change to the directory that contains the Clarity installation kit and

run the -quiet command. For example: <C:\temp\>clarity-agent_<4.x.xxx.x_Win-x86c.exe> -quiet


59


The command line inputs for installing the Clarity Agent on Windows are described in the table below.


-help ? Opens the help screen for the command line arguments relating to the installation of the Windows Clarity Agent.

-d destDir C:\Program Files\Relicore The destination directory for this product.

-r When this argument is supplied, the installer performs a rollback to the previous version.

This option cannot be specified with any other options.


Using this argument can cause the agent to operate improperly.

-u When this argument is supplied the installer performs an upgrade of the existing installed version of Clarity to this version.


-R On successful install, this argument reboots the system.

-a activationhost [:port]

8444 The server, and optionally, the port where this agent can be automatically activated. If no port is specified, 8444 is used.

This argument may be entered multiple times, once for each server.

60


-c credentialsFile password

None

The location and encryption password for a credentials file. This argument is not allowed with -a.

This argument requires two values.

-p profilename None The name of the configuration profile this agent should use.

This argument requires that -a be specified, and cannot be specified with -c.

Automatic Agent Activation on Windows

The Relicore Clarity agent installation process initiates the automatic agent activation process. During this process, the agent attempts to connect to a Relicore Clarity server. Once connected, the agent sends a request to the server asking for its configuration information. The automatic agent activation request must be first approved by the Relicore administrator in the Relicore Clarity user interface before an agent receives its configuration information and can start operating.

To approve the automatic agent activation process:

1. Log in to the Relicore Clarity server web interface as admin. 2. On the Relicore Clarity toolbar, click Administration. 3. Select Systems > Activations.

A list of current agents and their activation status appears. If you do not see agent activation requests immediately, refresh this page until your agent requests appear.

4. From the Activate Agent summary panel, select the hostname that interests you. The Activate Agent detail panel appears.

5. Click Activate Agent. The Create Agent dialog box appears.

61


Value Brief Description Hostname Not editable. Server Initiates Communication

Instructs Relicore Clarity server to initiate communication with the agent.

Listen on Port The agent port number that the server will use to communicate with the agent when the Server Initiates Communication option has been selected.

Profile Name The name of the profile that is associated with the agent. Encrypt Communications

Enables SSL when selected.

DB Encryption Password

Optional.

If the Clarity server was installed with DB Encryption Password enabled, you must supply the password.

Group Attributes Optional.

If groups have been created on the Relicore Clarity Server, then you can choose groups that this host should belong to.

5. Verify the information in the Activate Agents detail panel, and click OK. This action sends appropriate credential information to the agent to automatically complete the installation process.

62


Configuring the Agent Manually on Windows

A Clarity agent must be configured, or activated, for it to function correctly after installation. There are two agent configuration methods: manual agent configuration and automatic agent activation.

To configure an agent manually on a Windows system:

1. Log in to the Relicore Clarity server web interface as admin. 2. On the Relicore Clarity toolbar, click Administration > Systems. 3. Select Agents and click Create Agent.

The Create Agent dialog box appears.

4. In the Create Agent dialog box, provide values for the agent in the appropriate boxes. Value Type Brief Description DB Encryption Password

Password Optional.


JAR File Password

Password Password to unencrypt the JAR file.

Server Initiates Communication

Yes/No Specifies that the Relicore Clarity server should initiate communication to the agent rather than vice-versa. This configuration option is useful in firewall or other NAT configurations where the agent is unable to form the connection to the server.

63


IP Address Hostname If Server Initiated Communication is chosen, then this should reflect the IP Address of the agent to which the server should connect.

Listen on Port Port If Server Initiated Communication is chosen, then this specifies the port that the agent should listen on.

Encrypt Communications

Yes/No If chosen, encrypts all communications from the agent to the server via SSL (Secure Sockets Layer).

5. Click OK. The File Download dialog box appears. The server creates a new agent and generates its credentials file in the form of an agentinfo.jar, which is the default name for the credentials JAR file created from the Relicore Clarity Server.

6. Download the agentinfo.jar file through the browser interface. 7. In the Save As dialog box, specify the directory in which the agentinfo.jar file will be

saved.

Make note of this location; you might need to copy the file to the server where you are creating an agent.

8. You will need to provide the credentials jar file and the jar file password when you activate an agent manually during a Clarity Agent install.

Starting Windows Agent Service

The setup process installs the Relicore Clarity Agent as a Windows service. When the service is running, the Relicore Clarity Agent is also running, by default the service is configured to auto start and stop when the system boots or shuts down. You can change this option in the Windows Control Panel Services section.

Starting and stopping the Relicore Clarity Agent service can be done via the Windows Control Panel or by command line scripts that are part of the Relicore installation.

Starting the Relicore Clarity Agent Windows 2000 or 2003 Service

By default, the Relicore Clarity Agent service is installed so that it starts and stops automatically. However, it can be started manually if necessary.

To start the service via the Windows 2000 or 2003 Control Panel:


64


3. Select Relicore Clarity Agent and click the Start Service button ( ).

To start the Relicore Clarity Agent via the command line:

1. Run the emx_agentd.cmd script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>\bin\emx_agentd.cmd start

Stopping the Windows Agent Service

Stopping and starting the Relicore Clarity Agent service can be done via the Windows Control Panel or by command line scripts that are part of the Relicore installation.

By default, the Relicore Clarity Agent service is installed so that it starts and stops automatically. However, it can be stopped manually if necessary.

To stop the service via the Windows Control Panel:

1. From the Start menu, select Settings > Control Panel.

65


2. Open Administrative Tools and then launch Services.

3. Select Relicore Clarity Agent and click the Stop Service button ( ).

To stop the Relicore Clarity Agent via the command line:

1. Run the emx_agentd.cmd script from the {EMX_HOME} directory: Type: <EMX_HOME>\bin\emx_agentd.cmd stop

66


Installing the Clarity Agent on Solaris, Linux and AIX

Installing the Clarity Agent on Solaris, Linux or AIX in Graphical Mode

The Relicore Solaris agent is supported only on Solaris versions 2.6, 2.8, and 2.9; the Relicore Linux agent is supported on Linux RedHat Advanced Server 3.0, kernel version 2.4.21 (SMP and Uniprocessor) and Linux Redhat Advanced Server 2.1, Kernel v2.4.9e34, 32-bit x686 multi-processor and enterprise with JVM version 1.4.2; the Relicore SUSE Linux agent is certified on SMP 2.4.21-169 on Intel x86, 32 bit; the Relicore AIX agent is supported only on 5.2L, 64bit and AIX Java 1.4.2 (32 bit only), with Maintenance Level 3 with IY56367, IY56982, and IY60105 ARPAs patches or a higher Maintenance Level. The prerequisites for a Solaris, Linux or AIX installation are as follows:





• The system you are installing from must have an X Window System to use the graphical wizard based version of the installer. If you do not have this prerequisite, you can install in console mode.

As part of the standard Clarity installation process, the Agent installer includes a set of standard drivers which are compatible with the platform the Agent is being installed on. Standard drivers are created for the most commonly installed Linux kernel versions. Each Linux Agent needs to have a driver that matches its kernel version. If there is not a compatible driver for a particular kernel version an Agent will run in "driverless" mode until the compatible driver is obtained from Relicore. In driverless mode Agents can accept administrative commands but cannot track any real-time data. Linux Agents that are running in driverless mode send requests to the Clarity Server for a "Special Driver" that matches the kernel version. For additional information, refer to Working with Agent Drivers in the online Help.

You need to copy the clarity-agent_4.x.xxx.x_platform.bin installation kit file and, if you choose to configure the Relicore Clarity agent manually, a credentials JAR file agentinfo.jar into a temporary directory on your system (that is, /var/tmp). Otherwise, you need to provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity agent.

67


To install the Clarity Agent:

1. Go to temporary directory and execute the clarity-agent_4.x.x.0_SunOS-sparc.bin file. For Solaris:

Type: ./clarity-agent_4.x.xxx.x_SunOS-sparc.bin

For Linux:

Type: ./clarity-agent_4.x.xxx.x_Linux-i686.bin For AIX:

Type: ./clarity-agent_4.x.xxx.x_Aix-powerpc.bin

The Relicore Clarity Agent Setup prepares the InstallShield Wizard. This process takes just a few seconds to prepare before it begins the Relicore Clarity agent setup.

2. Click Next. The Directory Name dialog box appears. Relicore Clarity Agent installs in the path shown in the dialog box.

68


3. Do one of the following:

• Click Next to install the Clarity Agent to the directory shown.

• Click Browse to install to a different directory and then click Next. The Installation Features dialog box appears.

69


5. Click Next. The Installation Status Bar appears.

When the installation completes, the Agent Activation Preference dialog box appears.

70


6. Select the Agent Activation method that you prefer and click Next. The activation method you select, determines which InstallShield dialog box appears next.

Automatic Agent Activation

a. Provide a hostname and port number for the activation server(s) you are installing. b. Click Add to List. c. Optionally, provide a configuration profile name. By default, Clarity assigns the default configuration profile. d. Click Next.

Manual Agent Activation

a. Provide the name of the credentials JAR file or browse to find the file. Configuring an agent manually requires that you create a craedentials JAR file from the Relicore Clarity server user interface.

b. Provide the jar file encryption password that was set when the credentials Jar file was created.

c. Reenter the jar file encryption password for verification.

71


7. Click Next. The InstallShield Wizard displays a message to indicate the agent has been successfully installed.

8. Click Finish.

72


Installing Clarity Agent in Console Mode on Solaris, Linux or AIX






As part of the standard Clarity installation process, the Agent installer includes a set of standard drivers which are compatible with the platform the Agent is being installed on. Standard drivers are created for the most commonly installed Linux kernel versions. Each Linux Agent needs to have a driver that matches its kernel version. If there is not a compatible driver for a particular kernel version an Agent will run in "driverless" mode until the compatible driver is obtained from Relicore. In driverless mode Agents can accept administrative commands but cannot track any real-time data. Linux Agents that are running in driverless mode send requests to the Clarity Server for a "Special Driver" that matches the kernel version. For additional information, refer to Working with Agent Drivers in the Online Help.

You need to copy the clarity-agent_4.x.xxx.x_platform.bin installation kit file and, if you choose to configure the Relicore Clarity agent manually, a credentials JAR file agentinfo.jar into a temporary directory on your Solaris system (that is, /var/tmp). Otherwise, you need to provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity agent.

To install the Relicore Clarity Agent:

1. Go to temporary directory and execute the clarity-agent_4.x.xxx.x_platform.bin file. For Solaris:

Type: ./clarity-agent_4.x.xxx.x_SunOS-sparc.bin -console

For Linux:

Type: ./clarity-agent_4.x.xxx.x_Linux-i686.bin -console

For AIX:

Type: ./clarity-agent_4.x.xxx.x_Aix-powerpc.bin -console

2. As the Installer runs, you need to provide information as summarized in the following table:

73


Value Type Description Install Directory Pathname Installation directory for this Relicore Clarity agent

instance. Group Group ID Name of the group account that the Relicore Clarity

agent should be installed as. Automatic Configuration

Y/N Specifies if automatic agent activation or manual configuration is to be used. You will be prompted as follows depending on your answer to this question:

• Yes: You are prompted for Activation Server(s)

• No: You are prompted for a credentials JAR file password and filename. Refer to Configuring the Agent Manually.

Activation Server and Port Number

Hostname and Port Number

(optional)

If Automatic Agent Activation option is specified, enter the activation server(s) and port number (optional) for this agent. The default port is 8444 and should be used unless it has been changed on the server's configuration. Example: qa.13.relicore.com:8444

Although you are prompted to enter additional activation servers, multiple servers are not supported in this release.

Configuration Profile Name

Profile Name

Optional parameter. If a valid/existing profile name is entered, then the agent will be assigned that profiles configuration. If left blank, the agent will receive the default profile configuration.

Credentials JAR file password

Password If you answered no to the automatic configuration you will be prompted for a credentials JAR file password.

Credentials JAR filename

Filename If you answered no to the automatic configuration you will be prompted for the location of a credentials JAR file.

The command prompt window will display the following installation output. Installing Emx Watchdog... Starting Emx Watchdog...

Storing Log...

A message similar to the following will display at the end of the installation to indicate success or failure: The InstallShield Wizard has successfully installed Relicore Clarity Agent. Choose Finish to exit the Wizard. Press 3 to Finish or 4 to Redisplay [3]

3. Press 3 to finish the install. 4. Do one of the following:

• If Automatic Configuration was selected, then the agent process is started automatically. Log in to the Relicore Clarity user interface to activate the Relicore Clarity agent.

• If Manual configuration was selected, the Relicore agent is ready for use.

74


Installing Clarity Agent in Unattended Mode on Solaris, Linux or AIX

A quiet—or silent—installation is one which does not display any indication of its progress.






As part of the standard Clarity installation process, the Agent installer includes a set of standard drivers which are compatible with the platform the Agent is being installed on. Standard drivers are created for the most commonly installed Linux kernel versions. Each Linux Agent needs to have a driver that matches its kernel version. If there is not a compatible driver for a particular kernel version an Agent will run in "driverless" mode until the compatible driver is obtained from Relicore. In driverless mode Agents can accept administrative commands but cannot track any real-time data. Linux Agents that are running in driverless mode send requests to the Clarity Server for a "Special Driver" that matches the kernel version. For additional information, refer to Working with Agent Drivers in the Online Help.

You need to copy the clarity-agent_4.x.xxx.x_platform.bin installation kit file and, if you choose to configure the Relicore Clarity Agent manually, a credentials JAR file agentinfo.jar into a temporary directory on your Solaris system (that is, /var/tmp). Otherwise, you need to provide network access (for example, via NFS) to the kit prior to installing the Relicore Clarity agent.

To perform an installation of Clarity Agent in unattended mode:

1. Go to the temporary directory that contains the Clarity installation kit and run the -quiet command. For example: ./Clarity-agent_4.x.xxx.x_platform.bin -quiet


75


The command line inputs for installing the Clarity Agent on Windows are described in the following table:


-help ? Opens the help screen for the command line arguments relating to the installation of the Windows Clarity Agent.

-d destDir /opt/relicore/emx/agent The destination directory for this product.


Using this argument can cause the agent to operate improperly.

-u When this argument is supplied the installer performs an upgrade of the existing installed version of Clarity to this version.


-a activationhost [:port]

8444 The server, and optionally, the port where this agent can be automatically activated. If no port is specified, 8444 is used.

This argument may be entered multiple times, once for each server.

Multiple servers are not supported in this release.

-c credentialsFile password

None

The location and encryption password for a credentials file. This argument is not allowed with -a.

This argument requires two values.

-p profilename None The name of the configuration profile this agent should use.

This argument requires that -a be specified, and cannot be specified with -c.

76


Automatic Agent Activation on Solaris, Linux and AIX

The Relicore Clarity agent installation process initiates the automatic agent activation process. During this process, the agent attempts to connect to a Relicore Clarity server. Once connected, the agent sends a request to the server asking for its configuration information. The automatic agent activation request must be first approved by the Relicore administrator in the Relicore Clarity user interface before an agent receives its configuration information and can start operating.

To approve the automatic agent activation process:

1. Log in to the Relicore Clarity server web interface as admin. 2. On the Relicore Clarity toolbar, click Administration. 3. Select Activations.

A list of current agents and their activation status appears. If you do not see agent activation requests immediately, refresh this page until your agent requests appear.

4. From the Activate Agent summary panel, select the hostname that interests you. The Activate Agent detail panel appears.

5. Click Activate Agent. The Create Agent dialog box appears.

Value Brief Description Hostname Not editable. Server Initiates Communication

Instructs Relicore Clarity server to initiate communication with the agent.

Listen on Port The agent port number that the server will use to communicate with the agent when the Server Initiates Communication option has been selected.

Profile Name The name of the profile that is associated with the agent. Encrypt Communications

Enables SSL when selected.

77


DB Encryption Password

Optional.


Group Attributes Optional.

If groups have been created on the Relicore Clarity Server, then you can choose groups that this host should belong to.

5. Verify the information in the Activate Agents detail panel, and click OK. This action sends appropriate credential information to the agent to automatically complete the installation process.

Configuring the Agent Manually on Solaris, Linux or AIX

A Clarity agent must be configured, or activated, for it to function correctly after installation. There are two agent configuration methods: manual agent configuration and automatic agent activation.

To configure an agent manually on a Windows system:

1. Log in to the Relicore Clarity server web interface as admin. 2. On the Relicore Clarity toolbar, click Administration > Systems. 3. Select Agents and click Create Agent.

The Create Agent dialog box appears.

4. In the Create Agent dialog box, provide values for the agent in the appropriate boxes.

78


Value Type Brief Description DB Encryption Password

Password Optional.


JAR File Password

Password Password to unencrypt the JAR file.

Server Initiates Communication

Yes/No Specifies that the Relicore Clarity server should initiate communication to the agent rather than vice-versa. This configuration option is useful in firewall or other NAT configurations where the agent is unable to form the connection to the server.

IP Address Hostname If Server Initiated Communication is chosen, then this should reflect the IP Address of the agent to which the server should connect.

Listen on Port Port If Server Initiated Communication is chosen, then this specifies the port that the agent should listen on.

Encrypt Communications

Yes/No If chosen, encrypts all communications from the agent to the server via SSL (Secure Sockets Layer).

5. Click OK. The File Download dialog box appears. The server creates a new agent and generates its credentials file in the form of an agentinfo.jar, which is the default name for the credentials JAR file created from the Relicore Clarity Server.

6. Download the agentinfo.jar file through the browser interface. 7. In the Save As dialog box, specify the directory in which the agentinfo.jar file will be

saved.

Make note of this location; you might need to copy the file to the server where you are creating an agent.

8. You will need to provide the credentials jar file and the jar file password when you activate an Agent manually during Clarity Agent install.

Starting the Solaris, Linux or AIX Agent

To start the Clarity Agent via the command line:

1. Run the emx_agentd.sh script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>/bin/emx_agentd.sh start

79


Stopping the Solaris, Linux or AIX Agent

To stop the Clarity Agent via the command line:

1. Run the emx_agentd.sh script from the <EMX_HOME>/bin directory: Type: <EMX_HOME>/bin/emx_agentd.sh stop

80

Getting Started

Getting Started with Clarity

The Relicore Clarity server must be installed and configured before you can use the Relicore Clarity web interface to view managed systems.

1. Log in to Relicore. 2. Enable Radius. Refer to the Clarity online Help for additional information. 3. Install the Relicore Clarity Agent:

Windows

• Automatic Agent Activation

• Configuring the Agent Manually Solaris

• Automatic Agent Activation

• Configuring the Agent Manually 4. Customize your view preferences. Refer to the Clarity online Help for additional

information. 5. Create new Relicore Clarity users. Refer to the Clarity online Help for additional

information. Your user profile determines whether you have access privileges to the full feature set or access to a subset of the available features.

Logging In

Relicore recommends that you add a new administrative user with an appropriate user name and a more secure password, and then remove the admin/admin user. Click the Administration button to perform this function. Click Help to view the Relicore Clarity Administration Guide.

To log into the Relicore Clarity Server:

1. Ensure that the server is running and then point your browser at: http://server_name:port Where server_name and port are the hostname and port address configured for your Relicore Clarity server. By default, the port number is 8080. Refer to the Server Maintenance section for instructions about changing the port address.

• Server Maintenance on Windows

• Server Maintenance on Solaris

For example, if your server is named relsvr1, type: http://relsvr1.lab.com:8080 The Relicore Clarity Login page appears.

81


3. Log into the system using your username/password (see the system administrator if necessary). Upon initial installation of the Relicore Clarity server, there is a single authorized user:

• username: admin

• password: admin

4. Click Login. Relicore Clarity takes a moment to authenticate your username and password.

If you have RADIUS software, you must configure it to accept authentication requests from the Relicore Clarity server. Refer to the Clarity online Help for additional information.

The Relicore Clarity web interface appears.

Your permissions (as defined in your role) and initial screen settings, determine which toolbars appear in the Relicore Clarity user interface. For example, one user might see the Servers and the Applications panels by default, while another user might only see the Servers panel.

What you do next will depend on the type of user you are: an administrator, guest, or a user.

82

Upgrading Relicore Clarity

Upgrade Prerequisites

The Relicore Clarity 4.1 product includes an upgrade kit for existing 4.0 agents. The Clarity 4.1 server is supported on Windows 2000 and 2003 and Solaris 2.8. The prerequisites for upgrading Relicore Clarity are as follows:

Upgrade Prerequisites

• An upgrade plan—inclusive of an upgraded model file and your private model files—developed in conjunction with Relicore Client Services.

• The Clarity server 4.1 installation package.

• An upgrade.jar file for each Clarity Agent 4.0 operating system supported. o For 4.0 to 4.1 and 4.1 to 4.x upgrades:

o clarity-agent_4.x.xxx.x_Win-x86.jar o clarity-agent_4.x.xxx.x_SunOS-sparc.jar o clarity-agent_4.x.xxx.x_Linux-i686.jar o clarity-agent_4.x.xxx.x_AIX-powerpc.jar

• Access to a web server—the Clarity UI server or another web server that you designate—that Clarity agents can access.

Upgrading Clarity agents requires access to a web server; it can be either the Clarity UI Server or a different web server.

To upgrade to Clarity 4.1, you need to perform the following tasks:

1. Upgrade the Clarity Server to 4.1. For additional information, refer to Upgrading the Clarity Server on Windows or Upgrading the Clarity Server on Solaris.

2. Upgrade the Clarity server model file to run the new 4.1 model file. If you have created a custom 4.0 model contact Relicore Client Services for assistance.

3. Upgrade the 4.0 Clarity agents using the Agent Upgrades user interface. For additional information, refer to About Agent Upgrades.

Clarity Upgrade Considerations

The Clarity Upgrade process supports connectivity between 4.0 agents and the 4.1 server. The Clarity upgrade process will convert your existing data to a 4.1 format to ensure that no existing agent data is lost.

Relicore recommends that you review the following list of upgrade considerations before attempting to upgrade your Clarity software. The list is intended to help you define and manage the upgrade process.

• If the model file of your 4.0 installation contains any custom models, you need to contact Relicore Client Services. A Client Service professional will assist you in assessing your environment to develop a plan for server and agent upgrades.

83


If you have 4.0 Clarity agents configured to run on a private model file, your agent will upgrade and continue to run with that private model file. However, you should plan to have this private model file upgraded via Relicore Client Services prior to your scheduled update.

Private models must be compliant with the 4.1 Clarity release. This is an important step as the manual upgrade of the model is required for Clarity 4.1 functionality to work properly.

• During the upgrade process your Clarity Server will download a large jar file to each of your agents. Part of the upgrade process involves configuring your server with upgrade URLs from which the agents download the upgrade jar files. You can use the Web Server provided with Clarity for this purpose, or use another Web Server of your choice. A thoughtful upgrade plan will ensure that the Clarity Server is able to manage the number of jar files that are downloaded at one time.

• When performing an upgrade within 4.1 we recommend that you remove all Special Drivers from the Server prior to performing the upgrade. Once the Server upgrade is complete, import the latest versions of the Special Drivers to the Clarity Server. By default, the Special Drivers are located in /opt/relicore/emx/server/4.1/drivers on Solaris and c:/program files/relicore/server/4.1/drivers on windows.

• When you upgrade Clarity agents, agent upgrade status displays in the Administration Agent Upgrades user interface.

• Windows agents require rebooting during the upgrade process. It is important that these agents be rebooted immediately upon completion of the upgrade. If reboot is not performed promptly, there is a negative impact on agent functionality.

• After performing an upgrade, users attempting to view agent information can experience a non responsive UI. Each attempt for information returns a java script console error. Changing your browser cache settings to check for new variations of stored pages on "every visit to the page" (Internet Explorer) or "every time I view the page" (Netscape) fixes the problem. You can reach this setting in Internet Explorer through Tools > Internet Options > General tab > Temporary Internet Files > Settings. You can reach this setting in Netscape through Advanced Options > Cache settings.

• Ensure that you have the correct Oracle Database Requirements if you are using Oracle as your database server. Review the UDB database requirements in the Clarity - DB2-UDB Setup.pdf file located in C:\Program Files\Relicore\server\4.1\web\techpubs directory.

84


Upgrading the Clarity Server

Upgrading the Clarity Server on Solaris in Console Mode

It is imperative that you contact Relicore Client Services to schedule an upgrade from one version of Clarity to the next. A Client Service professional will assist you in assessing your environment and developing a plan for Clarity server and agent upgrades. In addition, it will be necessary for you to send your 4.0 model files to Client Services so that they can be manually upgraded to the 4.1 format.

A thoughtful upgrade plan will help to ensure that your agent(s) have full use of Relicore 4.1 functionality and that all pre-existing private models remain intact. When you are in receipt of your upgraded model file you are ready to perform the upgrade.

Relicore also suggests that you review the upgrade prerequisites as well as the list of Clarity upgrade considerations.

To upgrade the Clarity server on Solaris:

1. Log in as root. 2. Set any execute permissions for the installer kit.


3. Execute the /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin file. Type: /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin -console

After executing the previous command, the InstallShield Wizard starts running in the console. As part of the upgrade process, you will be presented with a series of questions you need to respond to for the installation to continue. Much like a GUI install is divided into "screens" which each have a distinct task, this installer separates tasks with a dashed line. To move to the next task in the install, you need to answer the question the installer is posing by entering a number which indicates your action to the installer. The choices are 1 for Next, 3 to Cancel or 4 to Redisplay. Most of the steps have a default choice of 1 (for Next - to continue with the installation). The default choice is enclosed in brackets []. If you want to enter the default choice, simply press Enter.

4. The Installer shows informational text indicating that Relicore Clarity will be installed on your computer. Press Enter to continue.

5. The Installer checks to verify that a previous version of Relicore Clarity is installed on the machine. Press Enter to continue.

6. The Installer provides information on:

• The location that Relicore Clarity will be upgraded to: /opt/relicore/emx • The features that will be included: Clarity Server, Clarity Common Files, and

Clarity Software • The total size: 166.5 MB

Press Enter to continue.

85


The install process may take a significant amount of time. DO NOT CANCEL the installation procedure before it is complete. Canceling the installation before it finishes will cause Clarity to function improperly.

7. The install process begins. You will see a status line indicating the installer's progress. The following graphic is an example for reference. The install is complete when the status line reaches 100%.

|-----------|-----------|-----------|------------|

0% 25% 50% 75% 100%

||||||||||||||||||||||||||||||||||||||||||||||||||

8. Close any open browser sessions and then restart your browser. 9. Log in to Relicore Clarity. 10. From the Clarity toolbar, select Administration > Systems > Server. 11. From the Server summary panel, select the Clarity Server. 12. From the Server detail panel, click the General tab.

The Clarity server version number appears; verify that it is upgraded.

Custom models must be compliant with the latest Clarity release. This is an important step as the manual upgrade of the model is required for new functionality to work properly.

13. After the Clarity server is upgraded, import the upgraded model file that you received from Relicore Client Services.

Upgrading Clarity agents requires access to a web server; it can be either the Clarity UI Server or a different web server. Relicore recommends using a web server other than the Relicore Web Server.

14. Configure your server for Upgrade Urls for each supported Clarity agent platform. If you are using the Relicore Web Server which is installed with the Clarity Server, the following steps apply. Under the Relicore UI server, create a directory to copy the jar files to.

If you are not using the Relicore Web Server, proceed with the following steps and substitute the information particular to your Web Server.

• Log onto the box as root. • Change directory to the upgraded installation of the Relicore Clarity server:

Type: cd /opt/relicore/emx/server/4.x/web

This example uses the default installation directory. If you have chosen a different installation directory, enter that directory instead.

86


• Create a directory for the agents to access during upgrade. Type: mkdir upgrade

• Copy the jar files into the newly created directory.

For 4.0 to 4.1 and 4.1 to 4.x upgrades:

Type:

cp clarity-agent_4.x.xxx.x_Win-x86.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_SunOS-sparc.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_Linux-i686.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_AIX-powerpc.jar /opt/relicore/emx/server/4.1/web/upgrade


15. Launch your web browser to verify access to the upgrade URL. For the previous example, the URL would be:

• http://<servername>:8080/emx/upgrade

The servername= Relicore Clarity Server Name

16. Provide the upgrade URLs from which the Clarity agent(s) will access the upgrade jar files. For additional information, refer to Managing Upgrade URLs.

17. Upgrade your Agents.

87


Upgrading the Clarity Server on Solaris in GUI Mode

It is imperative that you contact Relicore Client Services to schedule an upgrade from one version of Clarity to the next. A Client Service professional will assist you in assessing your environment and developing a plan for Clarity server and agent upgrades. In addition, it will be necessary for you to send your 4.0 model files to Client Services so that they can be manually upgraded to the 4.1 format.



The system you are installing from must have an X Window System to use the graphical wizard based version of the installer. If you do not have this prerequisite, you can install in console mode.

To upgrade the Clarity server on Solaris in GUI mode:

1. Log in as root on the machine where the Relicore Clarity server is installed. 2. Set any execute permissions for the installer kit.


3. Execute the /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin file. Type: /tmp/clarity-server_4.x.xxx.x_SunOS-sparc.bin

The InstallShield Wizard appears.

88


4. Click Next.

5. Click Next.

89


6. Click Next.

InstallShield stops EmxWatchdog and displays a progress bar to indicate the status of the upgrade.

90


7. Click Finish.

8. Close any open browser sessions and then restart your browser. 9. Log in to Relicore Clarity. 10. From the Clarity toolbar, select Administration > Systems > Server. 11. From the Server summary panel, select the Clarity Server. 12. From the Server detail panel, click the General tab.


91


Custom models must be compliant with the latest Clarity release. This is an important step as the manual upgrade of the model is required for new functionality to work properly.

13. After the Clarity server is upgraded, import the upgraded model file that you received from Relicore Client Services.

Upgrading Clarity agents requires access to a web server; it can be either the Clarity UI Server or a different web server. Relicore recommends using a web server other than the Relicore Web Server.

14. Configure your server for Upgrade Urls for each supported Clarity agent platform. If you are using the Relicore Web Server which is installed with the Clarity Server, the following steps apply. Under the Relicore UI server, create a directory to copy the jar files to.

If you are not using the Relicore Web Server, proceed with the following steps and substitute the information particular to your Web Server.

• Log onto the box as root. • Change directory to the upgraded installation of the Relicore Clarity server:

Type: cd /opt/relicore/emx/server/4.1/web


• Create a directory for the agents to access during upgrade. Type: mkdir upgrade

• Copy the jar files into the newly created directory.

For 4.0 to 4.1 and 4.1 to 4.x upgrades:

Type:

cp clarity-agent_4.x.xxx.x_Win-x86.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_SunOS-sparc.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_Linux-i686.jar /opt/relicore/emx/server/4.1/web/upgrade

cp clarity-agent_4.x.xxx.x_AIX-powerpc.jar /opt/relicore/emx/server/4.1/web/upgrade


92


15. Launch your web browser to verify access to the upgrade URL. For the previous example, the URL would be:

• http://<servername>:8080/emx/upgrade

The servername= Relicore Clarity Server Name

16. Provide the upgrade URLs from which the Clarity agent(s) will access the upgrade jar files. For additional information, refer to Managing Upgrade URLs.

17. Upgrade your agents.

Upgrading the Clarity Server on Windows

It is imperative that you contact Relicore Client Services to schedule a Clarity upgrade. A Client Service professional will assist you in assessing your environment and developing a plan for Clarity server and agent upgrades. In addition, it will be necessary for you to send your 4.0 model files to Client Services so that they can be manually upgraded to the 4.1 format.



To upgrade the Clarity server on Windows:

1. Log in as administrator of the machine where the Relicore Clarity server is installed. 2. Copy the 4.1 Relicore Server Installer into a temporary folder on the server.

3. Double click clarity-server_4.x.xxx.x_Win-x86.exe to launch the installer. The InstallShield Wizard appears.

93


4. Click Next.

5. Click Next.

94


6. Click Next. InstallShield stops EmxWatchdog and displays a progress bar to indicate the status of the upgrade.

95


7. Click Finish. 8. Close any open browser sessions and then restart your browser. 9. Log in to Relicore Clarity. 10. From the Clarity toolbar, select Administration > Systems > Server. 11. From the Server summary panel, select the Clarity server. 12. From the Server detail panel, click the General tab.


96


Custom models must be compliant with the 4.1 Clarity release. This is an important step as the manual upgrade of the model is required for new functionality of 4.1 to work properly.

12. After the server is upgraded, import your upgraded model file that you received from Relicore Client Services.

Upgrading Clarity agents requires access to a web server; it can be either the Clarity UIServer or a different web server. Relicore recommends using a web server other than the Relicore Web Server.

13. Configure your server for Upgrade Urls for each supported Clarity agent platform.

a. Navigate to the default installation directory for the 4.1 server. b. Create a new directory under the default installation directory to copy the upgrade jar files into. For example, you could create a new "upgrade" folder with the following path:

C:\Program Files\Relicore\server\4.1\web\upgrade

c. Copy the following jar files into the new directory. For 4.0 to 4.1 and 4.1 to 4.x upgrades:

clarity-agent_4.x.xxx.x_Win-x86.jar clarity-agent_4.x.xxx.x_SunOS-sparc.jar clarity-agent_4.x.xxx.x_Linux-i686.jar clarity-agent_4.x.xxx.x_AIX-powerpc.jar

Agents generate informational alerts while the upgrade is in progress. 18. Use your web browser to verify access to the upgrade URLs contained in the directory.

For example:

• http://<servername>:8080\emx\upgrade The servername= Relicore Clarity Server Name

18. Provide upgrade URLs from which the Clarity agent(s) will access the upgrade jar files. For additional information, refer to Managing Upgrade URLs.

Agents generate informational alerts while the upgrade is in progress..


97


Upgrading the Clarity Agent

About Agent Upgrades

Your user profile must contain the server-update privilege for you to be able to view agent upgrade status or perform tasks associated with an agent upgrade.

The Agent Upgrade feature enables you to upgrade Clarity agents while preserving any/all existing private model files.

The upgraded Clarity server model file is only available to upgraded Clarity agents. In other words, if you have upgraded the Clarity server and then publish a new model file, only the Clarity agents that have been upgraded will receive the upgraded model file.

Note: Before you begin the agent upgrade process, you must have completed the entire server upgrade process. Part of the server upgrade process includes setting up the upgrade URL and copying the upgrade jar files to that URL so that the agents can access it during the agent upgrade process. For additional information, refer to the Windows and Solaris server upgrade topics.

To upgrade agents, you need to perform the following tasks:

1. Set up and manage the upgrade URLs from which the upgrade jar files are downloaded during the agent upgrade process.


You can access information about the progress of the upgrade by:

• Viewing the upgrade log • Viewing the upgrade event status

Managing Upgrade URLs

The Upgrade URLs listed in the Manage URLs dialog box are those that are currently in use. You can add new Upgrade URLs to this dialog and then use the Move buttons to rearrange the order in which agents attempt to download the upgrade jar files. Before you add the URLs to this dialog, you need to have completed your Clarity Server upgrade, during which you create the URLs and place the upgrade jar files in that URL directory.

To manage Upgrade URLs:

1. From the Relicore Clarity toolbar, click Administration.

The Administration panel appears.

2. Select Systems > Agent Upgrades. 3. From the Agent Upgrade summary panel toolbar, click Manage URLS.

The Manage URLs dialog box appears.

98


4. Add a new Upgrade URL:

• In the URL box, provide a new Upgrade URL from which the upgrade jars will be downloaded. This URL should be one that you created during the Server Upgrade process.

• In the Description box, provide text that best describes the new URL and click Add.

The URL is not case-sensitive, however it must always be unique and begin with http:// or https://.

5. Rearrange the order of Upgrade URLs:

• From the Upgrade URLs box, select a Upgrade URL.

• Click the Move Up and/or Move Down buttons to rearrange the order in which Upgrade URLs appear.

Clarity agents attempt to download jar files in the order specified in this list.

6. Remove URLs that are no longer needed. • From the Upgrade URLs box, select the Upgrade URL(s) you want to discard

and click Remove. 7. Click OK.

99


Upgrading a Clarity Agent

To upgrade a Clarity agent:

1. Upgrade your Windows, Solaris (console mode), or Solaris (GUI mode) Clarity Server. Your Clarity Server must be upgraded before you can upgrade your agents.

2. On the Relicore Clarity toolbar, click Administration. The Administration panel appears.

3. Select Systems > Agent Upgrades. 4. From the Agent Upgrades summary panel toolbar, select Upgrade.

The Upgrade Agents dialog appears.

5. In the Operation box, select an upgrade operation:

• Download - This option only downloads the jar file(s); no upgrade is performed.

• Upgrade - This option only upgrades the agent(s); the jar files need to have been downloaded already for this option to be successful.

• Download and Upgrade - This option downloads the jar files and performs the upgrade.

6. In the URL (optional) box,

• Click to select a single upgrade URL. or

• Accept the default and use all of the upgrade URLs that appear in the list.

7. In the Agents box, expand the Agents tree and select the agent(s) that interests you. The agent(s) you select appear in the Available Agents box.

8. From the Available Agents box, select an agent(s) for upgrade.

• Click Add--> to specify agent(s) one by one.

• Click Add All--> to specify all available agents.

100


9. Click OK.

The Status of Upgrade Requests window appears.

10. Click OK. 11. The Agent immediately begins processing the requested steps. 12. To view the progress of the Agent upgrades, you can view the upgrade event status.

Viewing the Upgrade Log

To view the upgrade log:

1. From the Relicore Clarity toolbar, click Administration. The Administration panel appears.

2. Select Systems > Agent Upgrades. 3. From the Agent Upgrades summary panel, select the agent that interests you. 4. From the Agent Upgrade detail panel toolbar, click View Upgrade Log.

The Upgrade Log appears.

101


5. Click OK.

Viewing Upgrade Event Status

To view the upgrade event status:

1. From the Relicore Clarity toolbar, click Administration. 2. Select Systems > Agent Upgrades.

102


3. From the Agent Upgrades summary panel, select the agent that interests you. 4. From the Agent Upgrade detail panel, click the Status Details tab.

Upgrade Event Status displays on the Status Details tab.

Although the Details column is usually empty, it is used to display messages from the agent as it progresses through the upgrade process.

103

Uninstalling Relicore Clarity

Uninstalling on Windows

Removing a Clarity Agent from Windows

To remove the Relicore Clarity agent:

1. From the Windows Start menu, select Settings > Control Panel. 2. Double-click Add/Remove Programs. 3. Select Relicore Clarity Agent. 4. Click Change/Remove.

The InstallShield Wizard Uninstaller starts. 5. Click Next. 6. The uninstaller displays information about the item being removed. Click Next. 7. The uninstaller informs you that the removal was successful. Click Next. 8. You must restart your computer to complete the uninstall. Select Yes, restart my

computer to restart immediately or No, I will restart my computer at a later time to restart later.

9. Click Finish. When you remove an agent, information about the agent no longer appears in the Relicore

Clarity web interface. If there are active dependencies to the agent machine, the dependencies appear in the same way that an unknown server appears.

If you choose to activate the agent at a later date, Relicore Clarity does not recall any data that was collected previously.

Removing the Relicore Clarity Server

To remove the Relicore Clarity Server:

1. From the Windows Start menu, select Settings > Control Panel. 2. Double click Add/Remove Programs. 3. Select Relicore Clarity Server. 4. Click Change/Remove.

The InstallShield Wizard Uninstaller starts. 5. Click Next. 6. The uninstaller displays information about the item being removed. Click Next. 7. The uninstaller informs you that the removal was successful. Click Finish to complete the

uninstall.

105


Uninstalling on Solaris

Removing an Agent from Solaris


1. You must be logged into a root shell. 2. Use the pkgrm tool to remove the Clarity agent.

Type: pkgrm RELIagent

If the Relicore Clarity Agent is running, it is stopped before being removed.

When you remove an agent, information about the agent no longer appears in the Relicore Clarity web interface. If there are active dependencies to the agent machine, the dependencies appear in the same way that an unknown server appears.


On rare occasions, the uninstaller may not be able to completely remove the Clarity agent kernel driver. The driver would remain dormant and would not affect system performance. After a reboot of the system, the driver will be removed completely.

Removing the Relicore Clarity Server from Solaris

To remove the Relicore Clarity Server:

1. You must be logged into a root shell. 2. Use the pkgrm tool to remove the Relicore Clarity Server.

Type: pkgrm RELIserver

If the Relicore Clarity server is running, it is stopped before being removed.

106

Uninstalling Relicore Clarity

Uninstalling on Linux

Removing an Agent from Linux


1. You must be logged into a root shell. 2. Use the rpm erase command to remove the Clarity agent.

Type: rpm -e reliagent

If the Relicore Clarity Agent is running, it is stopped before being removed.




Uninstalling on AIX

Removing an Agent from AIX


1. You must be logged into a root shell. 2. Use the rpm erase command to remove the Clarity agent.

Type: rpm -e reliagent

If the Relicore Clarity Agent is running, it is stopped before being removed. The installation will be primarily RPM based, but it will fall back to LPP install if RPM support is not present. In this case, an error message will indicate that uninstall will not be available. To uninstall, the driver will have to be manually removed, and the install root will have to be manually removed (i.e. use rm –rf ).




107

Contacting Relicore

Contacting Relicore

Headquarters

Relicore, Inc. One Burlington Woods Burlington, MA 01803 Phone: 781.229.1122 Fax: 781.229.2323

Website: www.relicore.com

Customer Support

If you have any questions about your Relicore software or documentation contact the Relicore Customer Support Center by telephone, fax, or electronic mail.

The hours for the Relicore Customer Support are Monday through Friday, 9:00 AM to 8:00 PM, EST.

Customer Support Contact Information

Phone 866-881-8822

Fax 781-229-2323

E-mail [email protected]

Website www.relicore.com

Professional Services

If your enterprise requires custom services, please contact Relicore's Professional Services department. The department can be reached by telephone, fax, or electronic mail.

The hours for the Relicore Customer Support are Monday through Friday, 9:00 AM to 8:00 PM, EST.

Professional Services Contact Information

Phone 781.229.1122

Fax 781.229.2323

E-mail [email protected]

Website www.relicore.com

109


We'd Like to Hear From You

Please let us know about your experience using Relicore Clarity. We encourage you to send feedback and suggestions after considering these questions.

• Did you have trouble finding anything?

• What other information would have been helpful?

• Was any information inaccurate?

110

relicore clarity installation guide - oregon dhs ... clarity installation guide configuring the...

Documents