Aperi Home >

Aperi Storage Manager Installation Instructions

Welcome to Aperi Storage Manager (Aperi). Aperi is open-standards-based storage infrastructure software that can centralize, automate, and simplify the management of complex and heterogeneous storage environments. Aperi can help to improve storage capacity utilization, administrative efficiency, and provide users with greater flexibility in the way they manage their storage environments.

Use the following instructions to learn how to install and initially configure Aperi Storage Manager. See the Aperi Storage Manager User's Guide and online help for information about how to use the product once it is installed. You can view Aperi documentation on the following page: http://www.eclipse.org/aperi/documentation/.

Contents

1. Plan the deployment

Aperi Storage Manager is an integrated set of software components that provides end-to-end storage management, from the host and application to the target storage device in a heterogeneous platform environment. These components include the following:

User Interface
The user interface enables you to use Aperi Storage Manager to manage your storage environment.
Data server
This component is the control point for product scheduling functions, configuration, event information, reporting, and GUI support. It coordinates communication and data collection with agents that gather storage demographics and populate the database with results.
Device server
This component discovers and gathers information for storage subsystems and SAN fabrics. It coordinates communication and data collection from agents that probe SAN fabrics.
Agents
Agents gather host, application, and SAN fabric information and send this information to the Data server or Device server.
Database Repository
A single database instance serves as the repository for data collected by agents. The Aperi database repository can run under either of the following relational database systems:
  • Apache Derby
  • DB2 8 for Linux UNIX and Windows.
Report server
This component enables you to use the Report Viewing perspective to generate and view reports with the BIRT reporting engine.
Keep in mind the following strategies when installing these components:

The following figure shows a sample configuration of Aperi Storage Manager components:

2. Check install requirements

Platform/software requirements

Client and Server requirements (recommended)

Agent requirements (recommended)

Administrative group

The Aperi Storage Manager environment supports role-based security. Operating system groups are associated with predefined roles. When a user ID is authenticated to Aperi through the GUI, membership in an operating system group determines the authorization level. By default, Aperi uses the following groups to determine administrative authority:

If these default administrative groups do not match a group in your environment, or you want to use a different group for the Aperi administrator role, you can change the value when you install Aperi or edit the adminGroup parameter in the server.config configuration file after a successful installation. Click here for more information about the adminGroup parameter and server.config configuration file.


3. Plan for the database repository

Use this section to determine what relational database to use as the database repository for Aperi. There are two relational databases available for use with Aperi:

Perform the following steps to download and set up DB2 for use with Aperi Storage Manager:

  1. Download DB2. You can learn more about DB2 and download a trial version here.
  2. Install DB2 using the default settings. Note the db2admin password that you choose during the installation.
  3. Continue to the next section Install Aperi Storage Manager files.

4. Install Aperi Storage Manager files

Install the Aperi Storage Manager files on machines:

Perform the following steps to install the server, agent, or GUI on a machine:

  1. Download the Aperi zip file from the downloads page on the Aperi Web site.

  2. Place the .zip file in the directory where you want to install the directories and files for Aperi.

  3. Use an unzipping tool to unzip the file. If successful, Aperi's runtime directories and files appear in the directory where you unzipped them. The install instructions refer to this directory as [aperi_install_dir]. For example, if you unzipped Aperi's zip file into the c:\bin\aperi folder, whenver [aperi_install_dir] appears in these install instructions it is referring to c:\bin\aperi.

  4. Download the JavaHelp 1.1.3 jar file. This file required by Aperi but not included in the .zip file. To download this file, complete the following steps:
    1. Go to http://java.sun.com/products/javahelp/download_binary.html.
    2. Click the Download button under the JavaHelp 1.1.3 (Zip) section.
    3. Click Accept License Agreement.
    4. Click the down arrow to download the javahelp-1_1_3.zip file.
    5. Unzip the contents of javahelp-1_1_3.zip.
    6. Locate the \jh1.1.3\javahelp\lib\jh.jar file in the directory where you unzipped javahelp-1_1_3.zip.
    7. Copy jh.jar to [aperi_install_dir]\plugins\javax.help_1.0.0
    8. Copy jh.jar to [aperi_install_dir]\gui\plugins\javax.help_1.0.0vUNKNOWN

  5. Download additional third-party files. Depending on your environment, you can download these additional required files manually or use the Aperi Installer to perform the download automatically.

    You must manually download additional third-party files if any of the following is true:

    • You are installing Aperi behind a firewall.
    • You are installing Aperi in an environment where there is no internet connection.
    • You are installing Aperi in an environment where the ability to automate the download of third-party libraries is prohibited.

    If none of the above is true, use the Aperi Installer to automatically download these additional third-party files. Skip this step and go to step 6 if you plan to use the installer to download these additional files.

    If you are manually downloading third-party files for use with Aperi, the rest of this step lists those files, where you download them, and how to install them:
    Package or File to download URL
    Geronimo 1.1 http://www.apache.org/dist/geronimo/1.1/geronimo-tomcat-j2ee-1.1.zip
    iText 1.3 http://downloads.sourceforge.net/itext/itext-1.3.jar?modtime=1112806930&big_mirror=0
    Dojo Toolkit 0.4.2 http://download.dojotoolkit.org/release-0.4.2/dojo-0.4.2p1-ajax.zip

    • Download Geronimo 1.1.
      1. Right-click http://www.apache.org/dist/geronimo/1.1/geronimo-tomcat-j2ee-1.1.zip and select Save Target As...
      2. Save the download (geronimo-tomcat-j2ee-1.1.zip) to a local directory (such as /geronimo-1.1).
      3. Unzip the contents of geronimo-tomcat-j2ee-1.1.zip.

        The file geronimo-j2ee_1.4_spec-1.1.jar is located in the following subdirectory where you unzipped geronimo-tomcat-j2ee-1.1.zip: /[location where you unzipped geronimo-tomcat-j2ee-1.1.zip]/repository/org/apache/geronimo/specs/geronimo-j2ee_1.4_spec/1.1.

      4. Copy geronimo-j2ee_1.4_spec-1.1.jar to [aperi_install_dir]\plugins\javax.j2ee_1.0.0.
      5. Copy geronimo-j2ee_1.4_spec-1.1.jar to [aperi_install_dir]\gui\plugins\javax.j2ee_1.0.0.

    • Download iText 1.3.
      1. Right-click http://downloads.sourceforge.net/itext/itext-1.3.jar?modtime=1112806930&big_mirror=0 and select Save Target As...
      2. Save the download (itext-1.3.jar) to a local directory.
      3. Copy itext-1.3.jar to [aperi_install_dir]\plugins\org.eclipse.aperi.reporting_5.0.0\web\birt-viewer\WEB-INF\lib

    • Download Dojo Toolkit 0.4.2.
      1. Right-click http://download.dojotoolkit.org/release-0.4.2/dojo-0.4.2p1-ajax.zip and select Save Target As...
      2. Save the download (dojo-0.4.2p1-ajax.zip) to a local directory.
      3. Unzip the contents of dojo-0.4.2p1-ajax.zip to a local directory (such as /dojo-0.4.2-ajax).
      4. Create the following directory [aperi_install_dir]\plugins\org.eclipse.aperi.reporting_5.0.0\web\aperi-reports\dojoAjax
      5. Copy the files and directories you unzipped from dojo-0.4.2p1-ajax.zip to [aperi_install_dir]\plugins\org.eclipse.aperi.reporting_5.0.0\web\aperi-reports\dojoAjax.

  6. If you plan to use DB2 as the database repository, continue to the next step. If you plan to use Apache Derby as the database repository, continue to the next section, Install Aperi Storage Manager.
  7. Copy the DB2 JDBC driver into the directory where you unzipped the Aperi Storage Manager files. To do this perform the following steps:
    1. Locate the DB2 JDBC driver that was installed during the DB2 installation. On Windows, check C:\Program Files\IBM\SQLLIB\Java. The filenames are db2jcc.jar and db2jcc_license_cu.jar.
    2. Copy the driver files to the following Aperi directories:
      • [aperi_install_dir]\plugins\org.eclipse.aperi.db_1.0.0
      • [aperi_install_dir]\gui\plugins
    3. Go to [aperi_install_dir]\plugins\org.eclipse.aperi.db_1.0.0\MANIFEST.
    4. Delete MANIFEST.MF.
    5. Rename DB2-MANIFEST.MF to MANIFEST.MF.
  8. Continue to the next section, Install Aperi Storage Manager.

5. Install Aperi Storage Manager

Use the Aperi Installer to set up Aperi Storage Manager components on the machine where you unzipped its zip file. The package that you unzipped contains the install program and run-time files for all of Aperi Storage Manager's main components. You do not have to configure all the components on each machine; rather, use the install program to set up only the components that you want to run on a particular machine.

Note: Keep in mind that you must configure the server on one machine, called the "server host". The server host normally also has the agent and GUI configured on it.

5.1 Start the Aperi Storage Manager Installer

  1. Make sure you have a Java Runtime Environment (JRE) from IBM or Sun 1.5 installed on your machine. To check for Java on a machine, start a command prompt window (Start > Programs > Accessories > Command Prompt) and type java -version from a command line.

    If you see text similar to the following then continue to step 2:

    java version "1.5.0_07"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_07-b03)
    Java HotSpot(TM) Client VM (build 1.5.0_07-b03, mixed mode)

    If you see text like the following, download the JRE from the IBM or Sun (http://java.sun.com/j2se/1.5.0/download.jsp) web sites before continuing:

    'java' is not recognized as an internal or external command, operable program or batch file.

  2. Set java into your PATH by typing the following at the command prompt:

    set path=%path%;C:\path_to_java_directory\jdk1.5.0_07\bin

    where     path_to_java_directory represents the directory where the JRE is installed.

    Setting the Java path has two purposes: 1) it is used to run the Aperi installer, and 2 ) it is stored in the startup scripts directory and used to run Aperi. This means that if you later uninstall the Java with this path, you won't be able to start Aperi until you reconfigure it.

    Note: You can also edit the cfgaperi.bat file or the System Path to contain the JRE pathname.

  3. Change to the [aperi_install_dir]\install subdirectory where you unzipped the Aperi Storage Manager files. For example, if you unzipped Aperi's zip file to c:\aperi, you would type cd c:\aperi\install and press Enter.

  4. Type install and press Enter to start the install program. If a security warning appears, click Run to continue.

5.2 Install Aperi Storage Manager

The following window appears when you start the Aperi Storage Manager Installer:

Note: The install program displays a warning message if you are not running Java 1.5 or higher.

  1. Click Next to start the install process. The License conditions window appears.

  2. Read the Eclipse Public License and click Accept to indicate that you accept the terms of the license and continue to the next step.
    Click Reject if you do not accept the terms and want to exit the installer.

  3. Use the Component Selection window to select the components that you want to install on the current machine.



    Field Name

    Description

    Database

    Select the database that Aperi will use to store the information it gathers:

    • Derby. Select this option to install Apache Derby 10.3.1.4 as the database repository for Aperi.

    • DB2. Select this option if you want to use an existing installation of DB2 as the database repository for Aperi. See the Plan for the database repository section for information about how to install DB2 in your environment.

    • No Database. Select this option if you do not want to install a database on the current machine. For example, you might select this option if you are installing an agent only.


    See the Plan for the database repository section for more information about choosing a database for Aperi.

    Server Select this option if you want to install the server component and Aperi GUI on the current machine. This machine must be able to communicate with the machines where you install the agents. You must install at least one Aperi server in your environment.
    Agent

    Select this option to install an agent on the current machine. Agents enable you to gather host, application, and SAN fabric information and send this information to the server. You must install an agent on every machine that you want to monitor with Aperi.

    Download 3rd Party Components Select this option to automatically download the third-party files and components required by Aperi. If you select this option, the installer will automatically download and install the following files:

    • iText-1.3.jar
    • geronimo-j2ee_1.4_spec-1.1.jar
    • Dojo Toolkit 0.4.2

    If you do not select this option, you must follow the instructions in 4. Install Aperi Storage Manager files to download and install these third-party files manually.

  4. Click Next when you have made your selections. The selections that you made determine what windows will appear during the installation process.

    The following steps provide descriptions of all the windows in the installer, but the order in which those windows appear might be different depending on the components you have selected to install. The value in parentheses ( ) at the beginning of each step indicates the selected component to which that step applies.

  5. (Agent) Use the Agent configuration window to enter information about the agent you want to install on the current machine. If you are configuring the agent, you are asked to supply port value. The agent will open a socket on this port for communication with the server. You may choose any valid port number (0..65535), but make sure to select one that is not already in use. We recommend you accept the default value (9570) unless it is already in use.



    Click Next to continue.

  6. (Server and Agent) Use the Server Configuration window to do the following:

    • (Server install) Configure the Data and Device servers that you want to install.
    • (Agent install) Enter information about an existing server on a remote machine so that the agent you are installing knows how to communicate with that server.

    7. The selections you make are passed both to the server (to configure itself) and to the agent (to configure how the agent talks to the server). If you are just configuring the agent (because the server is on a different machine), you must enter values that match how you configured that server.



    Field Name

    Description

    Server hostname [localhost]

    Enter the name of the machine on which the Aperi server is (or will be) running.

    If you are configuring the server on the current machine, enter that machine's name or accept the default localhost. If you're configuring an agent to talk to a remote server, then enter the name of the remote server's machine.

    The installer supplies the current machine's name as a default (localhost). There are three reasons to override this default:

    • Use localhost as the hostname if you install all Aperi components on a single machine and restrict access so that Aperi components on remote machines cannot connect to this installation. This will prevent the Aperi server and agent from answering the phone for remote connections.
    • If you are configuring an agent or GUI that is remote from its server, you will have to enter the remote server's name here. Enter a name that is resolvable on this host: depending on how your local machine and network are configured, you might be able to use a short name like "server1", or you might need a fully-qualified name like "server1.internal.org".
    • If your machine has multiple network interfaces with different hostnames for each interface and the Aperi Configurator chose the wrong name to use as a default.
    Data server port [9549] Enter the port number that the Data server will use for communication. If you are configuring the server locally, choose any free port; if you're configuring an agent to connect to a remote server, choose the port number you configured for that server.
    Device server port [9549] Enter the port number that the Device server will use for communication. If you are configuring the server locally, choose any free port; if you're configuring an agent to connect to a remote server, choose the port number you configured for that server.
    Administrative group

    Enter an administrative group to determine the authorization level of user IDs that can use Aperi. The Aperi environment supports role-based security. Operating system groups are associated with predefined roles. When a user ID is authenticated to Aperi through the GUI, membership in an operating system group determines the authorization level.

    By default, Aperi uses the following groups to determine administrative authority:

    • Windows: Administrators
    • UNIX/Linux: adm


    If these default administrative groups do not match a group in your environment, or you want to use a different group for the Aperi administrator role, enter that value in this field.

    You can change this value at any time by editing the adminGroup parameter in the server.config configuration file after a successful installation. Click here for more information about the adminGroup parameter and server.config configuration file.

    Report server repository path Enter the full path name of the directory where you want to store information about reports in the report viewer. If the path you enter does not exist it will automatically be created. The default directory is [aperi_install_dir]\reporting eports.

  7. Click Next to continue.

  8. (Derby only) Use the Derby Configuration window to enter information about the Derby database you want to use as the Aperi database repository. See Plan for the database repository for more information about planning for a database repository.


    Field Name

    Description

    Database hostname [localhost]

    Enter the name of the machine on which you want to install the Derby database. The default value localhost represents the current machine.

    Database Port [1527 ] Enter a port that can be used by the database. Ensure that this port is open and not in use.

  9. Click Next to continue.

  10. (DB2 only) Use the DB2 Configuration window to enter information about the existing DB2 database you want to use as the Aperi database repository. See Plan for the database repository for more information about planning for a database repository.


    Field Name

    Description

    DB2 username [db2admin] Enter the user ID that you indicated in Plan for DB2 as the database repository. db2admin is the default user ID with administrative authority that DB2 creates during its installation.

    Password

    Enter the password for the user ID indicated in the DB2 username prompt.

    Port [50000]

    Enter the port number that DB2 will use for communication.

    Driver Name of the JDBC driver that Aperi should use when communicating with DB2.
    DB2 Command Line Processor Path Enter the full path to the DB2 command line processor.

  11. Click Next to continue.

  12. (All components) Use the Installation Progress window to install Aperi.



    Field Name

    Description

    Click Show Details to view a detailed text status of the Aperi components as they are installed. When you click this button, the following tabs appear in the window:

    • Output. Displays the text status of the install process.
    • Errors. Displays any errors that occur during the install. Use this information to help troubleshoot any problems you encounter.


    If you do not select Show Details, the install window displays a tree structure that indicates the component that is currently being installed.

    Click this button to start the install process.


When you click the Install button the Aperi Installer installs the components you selected. During the installation process, the current action of the Aperi Installer is displayed next to the Show Details button. For example:

The installation process includes setting values in properties files as well as generating startup scripts for the various components. The names of the properties files and the startup scripts are displayed for you in the Output tab. Only information about the components you chose to install will appear in the messages. 

Targets:init,configureDerby,configureServer-win,configureAgent-win,download
Buildfile: C:\aperi\install\build.xml

init:


configureServer-win:

configureServer:
     [echo] Configuring the Data server

configureDataServer:
     [echo] Configuring the Data server

updateDataServerConfig:
     [echo] Updating the properties file: C:\aperi\install/../datasvr/configuration/server.config
     [copy] Copying 1 file to C:\aperi\datasvr\configuration
     [echo] Updating the file: C:\aperi\install/../datasvr/datasvr.bat
     [copy] Copying 1 file to C:\aperi\datasvr

configureReportServer:
     [echo] Configuring the report server
     [echo] Updating the file: C:\aperi\install/../reporting/reporting.bat
     [echo]  
     [copy] Copying 1 file to C:\aperi
eporting

configureDeviceServer:
     [echo] Configuring the Device Server

updateDeviceServerConfig:
     [echo] "Updating the properties file: C:\aperi\install/../devsvr/configuration/setup.properties
     [copy] Copying 1 file to C:\aperi\devsvr\configuration
     [echo] "Updating the properties file: C:\aperi\install/../devsvr/configuration/tsnmdbparms.properties
     [copy] Copying 1 file to C:\aperi\devsvr\configuration

updateDeviceServerLaunchScript:
     [echo] "Updating the file: C:\aperi\install/devsvr/devsvrbat
     [copy] Copying 1 file to C:\aperi\devsvr
     [echo] "Updating permissions"

updateDataAgentConfig:
     [echo] Updating the properties file: C:\aperi\install/../agent/configuration/agent.config
     [copy] Copying 1 file to C:\aperi\agent\configuration

updateFabricAgentConfig:
     [echo] Updating the properties file: C:\aperi\install/../agent/configuration/setup.properties
     [copy] Copying 1 file to C:\aperi\agent\configuration

updateLaunchScript:
     [echo] Updating the file: C:\aperi\install/agent/agent.bat
     [copy] Copying 1 file to C:\aperi\agent

If you selected to download and install 3rd-party files automatically using the Aperi Installer, that information is also displayed in the Output tab:

download:
[mkdir] Created dir: C:\aperi\plugins\org.eclipse.aperi.reporting_5.0.0\web\birt-viewer\WEB-INF\platform\plugins\com.lowagie.itext\lib
[get] Getting: http://downloads.sourceforge.net/itext/itext-1.3.jar [get]
To: C:\aperi\plugins\org.eclipse.aperi.reporting_5.0.0\web\birt-viewer\WEB-INF\platform\plugins\com.lowagie.itext\lib\itext-1.3.jar ..................................................................................
[mkdir] Created dir: C:\aperi\install emp
[get] Getting: http://www.apache.org/dist/geronimo/1.1/geronimo-tomcat-j2ee-1.1.zip [get]
To: C:\aperi\install emp\geronimo-tomcat-j2ee-1.1.zip .................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................. [get] last modified = Sat Jun 24 10:54:45 CDT 2006
[unzip] Expanding: C:\aperi\install emp\geronimo-tomcat-j2ee-1.1.zip into C:\aperi\plugins\javax.j2ee_1.0.0
[delete] Deleting: C:\aperi\install emp\geronimo-tomcat-j2ee-1.1.zip
[get] Getting: http://download.eclipse.org/tools/orbit/downloads/drops/R200706131308/bundles/org.apache.jasper_5.5.17.v200706111724.jar
[get] To: C:\aperi\plugins\org.apache.jasper_5.5.17.v200706111724.jar .........................................................
[get] Getting: http://download.eclipse.org/tools/orbit/downloads/drops/R200706131308/bundles/javax.servlet_2.4.0.v200706111738.jar
[get] To: C:\aperi\plugins\javax.servlet_2.4.0.v200706111738.jar ........
[get] Getting: http://download.dojotoolkit.org/release-0.4.2/dojo-0.4.2p1-ajax.zip [get]
To: C:\aperi\install emp\dojo-0.4.2p1-ajax.zip .........................................................................................
[get] last modified = Mon May 14 21:01:12 CDT 2007
[unzip] Expanding: C:\aperi\install emp\dojo-0.4.2p1-ajax.zip into C:\aperi\plugins\org.eclipse.aperi.reporting_5.0.0\web\aperi-reports
[move] Moving 1463 files to C:\aperi\plugins\org.eclipse.aperi.reporting_5.0.0\web\aperi-reports\dojoAjax
[delete] Deleting: C:\aperi\install emp\dojo-0.4.2p1-ajax.zip
[get] Getting: http://www.gtlib.gatech.edu/pub/eclipse/eclipse/equinox/drops/S-3.3M6-200703231616/javax.servlet.jsp_2.0.0.v200612120446.jar
[get] To: C:\aperi\plugins\javax.servlet.jsp_2.0.0.v200612120446.jar
........
[get] Getting: http://ftp.osuosl.org/pub/eclipse/eclipse/equinox/drops/S-3.3M7-200705031400/org.apache.commons.el_1.0.0.v200704241052.jar
[get] To: C:\aperi\plugins\org.apache.commons.el_1.0.0.v200704241052.jar
.....

If you selected to install Derby as the database repository, the installer creates the Aperi schema by running the Derby script in the <aperi_install_directory>\db directory. This script creates the schema specified by 'Alter' files in the [aperi_install_directory]\db\schema directory. The output from aperi-schema is displayed for you to inspect. Use this output to determine if the schema was created successfully.

The following example shows a successful database installation:

 configureDerbyFiles:
     [echo] Updating the properties file: C:\aperi\install/../db/aperi-ij.bat
     [copy] Copying 1 file to C:\aperi\db
     [echo] Updating the properties file: C:\aperi\install/../db/derby.bat
     [copy] Copying 1 file to C:\aperi\db
     [echo] Updating the properties file: C:\aperi\install/../db/derbystop.bat
     [copy] Copying 1 file to C:\aperi\db

configureDerbyLoadSchema:
     [echo] Loading the schema
     [echo] Starting Derby
     [echo] Waiting for Derby to start
Waiting a maximum of 60 seconds for Derby to start.
Derby started successfully.
DEBUG SDI calling analyzeParameters
DEBUG SDI thats it for now
DEBUG SDI doInstall begin
DEBUG SDI doInstall 1 calling doRepositorySpace
 ---- 
Database installation successful.
Aperi Bulk Report Processor: Loader
repository directory = C:\aperi
eporting
eports
zip file             = C:\aperi\install/../reporting/configuration/canned-reports.zip
jdbcDriver           = org.apache.derby.jdbc.ClientDriver
jdbcUrl              = jdbc:derby://localhost:1527/Aperi
jdbcUser             = Aperi 
 ---- 
   The output above should indicate that the schema was created 
   successfully on your system. If there was an error, 
   Aperi will not function correctly. Consult the installation 
   documentation for more information.

Note that Derby stores the database in a subdirectory of the [aperi_install_dir]\db directory. Keep this in mind if you want to back it up, copy it, or delete it. Deleting the database directory is the Derby equivalent of DROP DATABASE. Also, the installer generates derby\aperi-ij.bat, which you can run in a command prompt window to enter interactive SQL statements against the Derby server.

The installer will display a message if the schema already exists. If you wish, you can delete [aperi_install_dir]\db\Aperi and rerun the installer.

Upon completing the configuration of all the selected components, the following message is displayed:

BUILD SUCCESSFUL
Total time: 3 minutes 26 seconds

5.3 (optional) Edit configuration files

Use a text editor to edit configuration files to further customize Aperi Storage Manager according to the standards at your site. These files reside in subdirectories under the [aperi_install_dir] directory. Use the information in the following table to learn about the parameters that you can edit in these configuration files:

Configuration file

Location and parameter descriptions

server.config

Edit this file to configure the Data server in your environment.

Location of file: [aperi_install_dir]\datasvr\configuration\

[controller]

  • name: the name of the Data server (host computer name).
  • port: Port on which the server listens for requests (9549).
  • maxConnections: Maximum number of concurrent sockets that the server will open (500).
  • routerThreads: Number of threads redirect incoming requests to the appropriate service provider (1).
  • serviceThreads: Number of threads to allocate for the Server internal service provider (2).
  • agentErrorLimit: Number of consecutive attempts to reach an agent before the agent is displayed as DOWN. When an agent is in this state, no attempts to connect are made until either the agent contacts the Server or the agent status is manually changed to UP (3).
  • adminGroup: Name of the group a user must be a member of in order to perform administrative functions from the Graphic User Interface. The default administrative groups are:
    • Windows: Administrator
    • UNIX/Linux: adm
    If the default administrative group in this parameter does not match a group in your environment, or you want to use a different group, you can:
    • create a group in your environment that matches the one defined in this parameter
    • change the value in this parameter to match an existing group in your environment
  • commEncrypted: Switch that secures communication between the Server/Agent and the Server/GUI by encrypting the data stream:
    • 0 = Off. Do not encrypt the data stream.
    • 1 = On. Encrypt the data steam.

[logging]

  • logsKept: Number of server logs to keep (5).
  • messagesPerLog: Maximum number of messages in a log, when this number is reached the log is closed and a new log is created (100,000).

[repository]

  • driver: Name of the JDBC driver to use, normally:
    • DB2: com.ibm.db2.jcc.DB2Driver
    • Cloudscape: com.ibm.db2j.jdbc.DB2jDriver
  • url: URL used to connect to the database, normally: "jdbc:db2://machine_name:50000/Aperi".
  • user: User name that Aperi uses to connect to its database repository.
  • schema: Name of the Aperi schema in the database repository.
  • connectionPool: Number of database connections in a pool of reusable open connections (10).

scheduler.config

Edit this file to configure the Data server scheduler in your environment. The scheduler deploys all monitoring activities and controls when monitoring jobs are run by agents.

Location of file: [aperi_install_dir]\datasvr\configuration\

[concurrency]

  • maxSubmitThreads: Number of threads to create that handle the submission of jobs (3).
  • maxCompleteThreads: Maximum Number of threads to create to handle job completions. Initially will create a pool of 1/2 the number that can grow to the maximum (3).

[jobs]

  • minutesAdvanced: Number of minutes in advance of scheduled time to begin the scheduling process. This allows for the overhead time involved in scheduling a job so that the job will actually start close to the scheduled time (1) .

Aperi.config

Edit this file to configure the user interface and how it processes requests.

Location of file: [aperi_install_dir]\datasvr\configuration\

[server]

  • threadPoolSize: Number of initial threads to create for handling requests (3).
  • maxThreads: Maximum number of threads allowed for handling requests (8).
  • pingReceiveTimeout: Number of seconds to wait before indicating that a ping has failed (10).

[gui]

  • threadPoolSize: Number of initial threads to create for handling user interface requests (3).
  • maxThreads: Maximum number of threads allowed for handling user interface requests (10).
  • reportRowLimit: Maximum number of rows that will be sent at a time to the user interface. If this number is exceeded, a More button will be displayed above the table, along with a warning message (5000).
  • keepCachedReport: Number of minutes to retain incomplete reports in the server's tmp directory (120).
nas.config

Location of file: [aperi_install_dir]\datasvr\configuration\

Edit this file to configure Aperi for use with NAS:

  • On each line not beginning with #, the first blank-delimited field must contain the SNMP Enterprise code of a NAS filer that the agent should discover, probe, or scan.
  • The second field contains identifying information about the filer..

Any remote host that cannot be reached by SNMP or whose enterprise code does not match one of these values will be ignored.

agent.config

Edit the agent.config file to configure the agents in your environment. This file appears in the agent install directory on every machine where an agent is installed.

 

Location of file: [aperi_install_dir]\agent\configuration\

  • messagesPerLog: Maximum number of messages in a log, when this number is reached the log is closed and a new log is created (100,000).
  • serverPort: Port on which the Data server listens for requests (9549).
  • logFilesKept: Number of agent logs to keep (5).
  • uptimePoll: How often (in seconds) should agent check to ensure it is up (20).
  • sendFailWait: How many seconds to wait before attempting to resend a message to the server (30).
  • agentPort: Port on which the agent listens for requests (9550).
  • maxBacklog: Maximum number of uncompleted jobs to allow in the agent. Any requests for additional jobs to be run will result in an error (500).
  • honorSentScripts: If this parameter is set to '1', 't', 'T', 'y', or 'Y', the agent can run scripts sent from server. Otherwise, only existing scripts in the agent's scripts directory can be run.
  • agent.port: the port on which the agent listens for requests.
  • installLocation: The directory where Aperi is installed.
  • maxIdleThreads: Maximum number of idle threads to retain for reuse by future jobs (10).
  • serverHost: Host computer on which the Data server resides.

6. Start Aperi Storage Manager

This section describes how to start Aperi Storage Manager's user interface, server, and agent components. Make sure you have run the Aperi Installer before performing the steps in this section.

6.1 Start the Aperi Storage Manager Server, Agent, Report server, Report server, and Database Repository

Perform the following steps to start the Aperi components at the same time.

Note: You can also use the steps described here to start up an agent or server on a machine where other Aperi Storage Manager are not installed. For example, you can perform these steps to start up an agent on a machine where only an agent is installed.

  1. Start a command line session on the machine where Aperi Storage Manager components are installed.
  2. Change to the directory where you unzipped Aperi Storage Manager by typing cd [aperi_install_dir]. For example, if you installed Aperi to c:\aperi, type cd c:\aperi and press Enter.
  3. Type the following in the command line and press Enter:
    • Windows: aperi
    • Linux: ./aperi

    The aperi script was created during the install process and saved to the top level of the Aperi Storage Manager installation directory. When you run the aperi script, the following components will be started (under Windows, each component will be started in its own command line session that appears on top of the main command line session):
    1. Apache Derby (this step is not run if you are using DB2 for the repository)
    2. Device server
    3. Data server
    4. local agent
    5. report server
    A prompt will appear in the main command line session after each component is started. Components not installed on the machine where you run the startup will be skipped.
  4. Press any key in the main command line session after each component starts. Note that on Windows the command line sessions for each started component will appear on top of the main command line session. You must switch focus back to main command line session after each component starts before you press a key to start the next component.

Alternatively, perform the following steps to start the components individually instead of at the same time.

  1. Start a command line session on the machine where an Aperi Storage Manager component is installed. You must start a separate command-line session for each component you want to start.
  2. Change to the directory where you unzipped Aperi Storage Manager. For example: c:\aperi
  3. Perform the following from different command line sessions depending on what components you want to start:

    • To start the database repository (Derby): Change to the [aperi_install_dir]\derby directory, type derby.bat, and press Enter.
    • To start the database repository (DB2): Use the DB2 Control Center.
    • To start the Device server: Change to the [aperi_install_dir]\devsvr directory, type devsvr.bat, and press Enter.
    • To start the Data server: Change to the [aperi_install_dir]\datasvr directory, type datasvr.bat, and press Enter.
    • To start the local agent: Change to the [aperi_install_dir]\agent directory, type agent.bat, and press Enter.
    • To start the report server: Change to the [aperi_install_dir] eporting directory, type reporting.bat, and press Enter.

6.2 Start the Aperi Storage Manager User Interface

Perform the following steps to start the Aperi Storage Manager user interface. You must start up the other components first as described in Starting the Aperi Storage Manager Server, Agent, Report server, and Database Repository before you can use the user interface. To start the user interface:

  1. Start a command line session on the machine where you want to start the user interface.
  2. Change to the directory where you unzipped Aperi Storage Manager. For example: c:\aperi
  3. Change to the \gui directory.
  4. Type AperiRcpGui in the command line and press Enter.

7. Shut Down Aperi Storage Manager

To shut down an Aperi Storage Manager component you can:

We recommend shutting down components in the following order:

  1. user interface
  2. report server
  3. local agent
  4. Device server
  5. Data server
  6. database repository (Apache Derby or DB2)

8. Uninstall Aperi Storage Manager

To uninstall Aperi:

  1. Shut down any Aperi components that are running. See Shut Down Aperi Storage Manager for instructions on how to shut down Aperi components.
  2. Delete the Aperi installation directory.

9. Perform post-installation configuration

After you have installed Aperi, you must configure your system to get the information you want. This section provides information about the agents required, the jobs that must be run, and the alerts you can set.

9.1 Overview

To enable data gathering from the devices and servers that will be managed and monitored, different configuration steps are required to enable these different functions in Aperi. Aperi uses four different types of agents to gather data about the devices and servers that will be managed and monitored. Different combinations of these agents are required to effectively enable the functions of Data Manager, Fabric Manager, Disk Manager, and Tape Manager. In addition to these manager functions, the topology viewer is greatly affected by the proper discovery of all the managed entities in the management scope of Aperi.

The agents are:

Aperi uses data collection jobs to provide information about your environment. The types of data collection jobs are:

You can define alerts so that Aperi notifies you when a specified event occurs. Such events are the triggering conditions for the alert. The specific triggering conditions that you can use to define an alert depend on the sort of storage resource that you are monitoring. The alerts you can define are:

Once you have defined alerts, you can choose to be notified through different methods:

9.2 Using the Configuration Utility

Use the Configuration Utility tool in the Aperi GUI as a teaching tool to help guide you through the steps and prerequisite steps required to configure Aperi for your environment:

All of the main Aperi functions shown in the Configuration Utility exist separately within the Aperi GUI. However, the Configuration Utility provides a single point of access for new users to work with these functions. It also provides information that can help you decide what agents you need and which jobs to run to get the information you want about your storage environment. For example, it provides links into the Aperi GUI to display reports, add agents, create jobs, and create alerts.

To access and use the Configuration Utility:

  1. Start Aperi.
  2. Click Aperi Storage Manager > Configuration Utility. The Configuration Utility window appears in the right pane. You can access different pages within the Configuration Utility depending on what information you want to view, collect, and configure:

9.2.1 Managing Aperi agents and servers on the Services page

Click the Services tab to manage your servers and agents. Use this page to view a list of the Data server, Device server, Data agents, CIM agents, in-band Fabric agents, and out-of-band Fabric agents. You can use these lists to view detailed information about servers and agents, start agents, check agents (to make sure they are up and are the most current version), and run discovery jobs.

9.2.2 Manging storage asset (computers, filesystems, etc.) on the Data Manager page

Click the Data Manager tab to perform the following tasks:

Task Description
Data Agents
View information about Data agents Show detailed information about Data agents, check Data agents to make sure they are up and are the most current version, and start Data agents.

Ping

Collect availability information about storage assets

 Run pings to collect information about the availability of storage assets monitored by Aperi in your environment.
  • Click Show Ping Job Details to display information about the latest ping job.
  • Click Run Default Ping Now to run a ping using the default settings. A pop-up window informs you that the job has been submitted. Click OK. The TPCUser.Default ping job status panel is displayed when the ping job is completed.
  • Click Create Ping to create and run a new ping job
Collect availability information about storage assets Run pings to collect information about the availability of storage assets monitored by Aperi in your environment.
  • Click Show Ping Job Details to display information about the latest ping job.
  • Click Run Default Ping Now to run a ping using the default settings. A pop-up window informs you that the job has been submitted. Click OK. The TPCUser.Default ping job status panel is displayed when the ping job is completed.
  • Click Create Ping to create and run a ping job with settings that you define.
Display availability reports Use Availability reports to view the information collected by pings, both from a network point of view and from a computer up-time perspective. This enables you to see what percentage of the time the storage in your enterprise (or on particular server or group of servers), is off-network due to network problems or perhaps is unavailable due to system downtime.
  • Click Show Storage Availability System Report to generate and view the pre-defined Storage Availibility system report.
  • Click Define Storage Availability Report customize and generate an availability report.
Computer Probes
Collect detailed information about storage assets

Run probes to collect detailed information about computers.

  • Click Probe Default Computer Group Now to create and run a probe job against the computers in the default computer monitoring group. A pop-up window prompts you for a job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The probe job status panel is displayed when the job is completed.
  • Click Create Probe to create and run a probe job with settings that you define.
  • Click Computers Topology to display the computers topology.
Display computer asset reports

Click Show Computer Asset Report to view the information collected by probes. While running probes, Aperi itemizes the information about your computers and builds a hardware inventory of your storage assets.
Alerting
Create and view alerts

Define alerts to notify when you when certain conditions on a computer or filesystem occur. Use logs to view information that is triggered by alerts.

  • Click Computer Alert to create a computer alert.
  • Click Filesystem Alert to create a filesystem alert.
  • Click Computer Alerts to view the computer alerts that have been triggered.
  • Click Filesystem Alerts to view the filesystem alerts that have been triggered.

9.2.3 Managing storage subsystems and CIMOMs on the Disk Manager page

Use this page to view the storage subsystems managed by Aperi. Click the Disk Manager tab to perform the following tasks:

Task Description
Storage Subsystems
View information about storage subsystems

View information about the storage subsystems that have been discovered through a CIMOM discovery. If a storage subsystem is not shown in the table, the CIM agent for that subsystem needs to be added and a CIMOM discovery needs to be run.

  • Click Show Storage Subsystem Details to generate and view a report about the selected storage subsystem.
  • Click Show Storage Subsystem Asset Report to view the information collected by probes. While running probes, Aperi itemizes the information about your storage subsystems and builds a hardware inventory of your storage assets.
  • Click Storage Topology to display the storage subsystems topology.

CIMOM Discovery

Locate CIMOMs in your envionment

View information about the CIM agents discovered by Aperi. CIM agents are required for the storage subsystems to be discovered. A CIMOM discovery finds all the devices managed by the known CIM agents and gathers basic information about these devices. A CIM agent managing the storage subsystem and CIMOM discovery are required to discover storage subsystems in the environment.

  • Click Run CIMOM Discovery Now to create a CIMOM discovery job using all of the defined CIM agents. The job is run immediately. When you run the job, a pop-up window prompts you for the job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The results are displayed when the job has completed.
  • Click Edit CIMOM Discovery to edit the CIMOM discovery job information.
Storage Subsystem Probes
Collect detailed information about storage assets

Run probes to collect detailed information about storage subsystems.

  • Click Probe Default Storage Subsystem Group Now to create and run a probe job against the storage subsystems in the default storage subsystem monitoring group. A pop-up window prompts you for a job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The probe job status panel is displayed when the job is completed.
  • Click Create Probe to create and run a probe job with settings that you define.
Alerting
Create and view alerts

Define alerts to notify when you when certain conditions on a computer or filesystem occur. Use logs to view information that is triggered by alerts.

  • Click Storage Subsystem Alert to create a storage subsystem alert.
  • Click Storage Subsystem Alerts to view the storage subsystem alerts that have been triggered.

9.2.4 Managing fabrics and CIMOMs on the Fabric Manager page

Use this page to view the fabrics and switches managed by Aperi, discover fabrics, CIMOMs, and out-or-band Fabric agents, and run probes to collect information about fabrics. Fabric zoning functions require a switch within that fabric to either have an in-band agent or an out-of-band agent. The agents for the switch must have been discovered by Aperi and a probe run for the fabric.

Click the Fabric Manager tab to perform the following tasks:

Task Description
Fabrics
Configure and view information about fabrics
  • Click Zoning Configuration to configure the selected fabric.
  • Click Show SAN Assets (ALL) System Report to generate and view a pre-defined system report that shows detailed information about monitored fabrics.
  • Click Fabrics Topology to display the fabrics topology.

Switches

View information about switches

  • Click Show SAN Assets (Switches) System Report to generate and view a pre-defined system report that provides information about switches in your SAN (including switch ID, type, manufacturer, WWN, location, and other details).
  • Click Switches Topology to display the switches topology.

CIMOM Discovery

Locate CIMOMs in your envionment

View information about the CIM agents discovered by Aperi.

  • Click Run CIMOM Discovery Now to create a CIMOM discovery job using all of the defined CIM agents. The job is run immediately. When you run the job, a pop-up window prompts you for the job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The results are displayed when the job has completed.
  • Click Edit CIMOM Discovery to edit the CIMOM discovery job information.

Out of Band Fabric Discovery

Locate CIMOMs in your envionment

View information about the CIM agents discovered by Aperi.

  • Click Run Out of Band Discovery Now to create an out of band discovery job using all of the defined out-of-band agents The job is run immediately. When you run the job, a pop-up window prompts you for the job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The results are displayed when the job has completed.
  • Click Edit CIMOM Discovery to edit the discovery job information.
Inband Fabric Discovery
View information about Inband Fabric Agents View information about the Inband Fabric agents that are required for zone configuration. Aperi automatically runs a discovery job when it detects that an Inband Fabric agent has come online. See the Services page for more information about the servers and agents.
Fabric Probes
Collect detailed information about fabrics

Run probes to collect detailed information about fabrics. collect fabrics topology and zoning information, as well as basic information about the devices attached to the fabric.

  • Click Probe Default Fabric Group Now to create and run a probe job against the fabrics in the default computer monitoring group. A pop-up window prompts you for a job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The probe job status panel is displayed when the job is completed.
  • Click Create Probe to create and run a probe job with settings that you define.
Alerting
Create and view alerts

Define alerts to notify when you when certain conditions on a fabric, switch, or endpoint device occur. Use logs to view information that is triggered by alerts.

  • Create Alert Definitions:
  • View Alert Logs:
    • Click Fabric Alerts to view the fabric alerts that have been triggered.
    • Click Switch Alerts to view the switch alerts that have been triggered.
    • Click Endpoint Device Alerts to view the endpoint device alerts that have been triggered.

9.2.5 Managing tape librabries and CIMOMs on the Tape Manager page

Use this page to view the tape libraries managed by Aperi, discover CIMOMs, and run probes against tape libraries. A CIMOM discovery job and a tape library probe job are required before Aperi can monitor your tape libraries. If you do not see a tape library listed in the table, you need to run a CIMOM discovery job for the tape libraries.

Click the Tape Manager tab to perform the following tasks:

Task Description
Tape Libraries
View information about tape libraries

View information about the tape libraries that have been discovered through a CIMOM discovery. If a tape library is not shown in the table, you must run a CIMOM discovery job and a tape library probe job.

  • Click Show Tape Library Details to generate and view a report about the selected storage subsystem.
  • Click Storage Topology to display the tape library topology.

CIMOM Discovery

Locate CIMOMs in your envionment

View information about the CIM agents discovered by Aperi. CIM agents are required for the tape libraries to be discovered. A CIMOM discovery finds all the devices managed by the known CIM agents and gathers basic information about these devices.

  • Click Run CIMOM Discovery Now to create a CIMOM discovery job using all of the defined CIM agents. The job is run immediately. When you run the job, a pop-up window prompts you for the job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The results are displayed when the job has completed.
  • Click Edit CIMOM Discovery to edit the CIMOM discovery job information.
Tape Library Probes
Collect detailed information about storage assets

Run probes to collect detailed information about tape libraries.

  • Click Probe Default Tape Library Group Now to create and run a probe job against the tape libraries in the default tape library monitoring group. A pop-up window prompts you for a job name. Enter a job name and click OK. A pop-up window informs you that the job has been submitted. Click OK. The probe job status panel is displayed when the job is completed.

    Note: A warning message is displayed notifying you that this is not recommended when there are several tape libraries known to the system and they are all listed in the default group. If you have a lot of tape libraries, this could take a long time to probe.

  • Click Create Probe to create and run a probe job with settings that you define.


10. Grant local administrative privileges to a domain account

For Windows users, the user account which the Data server runs under requires local administrative rights. Because these rights are not necessarily guaranteed for domain users in a Windows domain environment, this topic provides information on how to grant local administrative rights for domain users. Using this procedure, you do not have to manually process each machine in the domain.

To use Group Policy to grant local administrative privileges to a domain account, complete the following steps:

  1. On the domain controller, go to Administrative Tools > Active Directory Users and Computers (you must be running with Domain Administrator privileges).
  2. Right-click on the Organizational Unit (OU) upon which you want to apply the Group Policy. Click Properties.
  3. The Group Policy Properties panel is displayed. Select the Group Policy tab and click New to create a new Group Policy.
  4. Designate a name for the new Group Policy. Select the new Group Policy and click Edit.
  5. The Group Policy Object Editor panel is displayed. Go to New Group Policy Object > Computer Configuration > Windows Settings > Security Settings > Restricted Groups. Right-click on Restricted Groups. Click Add Group.
  6. For example, name the new group "Administrators." Under "Properties", add the user "Administrator", and the domain accounts or groups upon which you want the Group Policy in effect for. For example, you can add "APERI apeadmin", "APERI apegroup", and "APERI\TestGroup". Click OK.
  7. Add these user rights to the domain account:
    • Act as part of the operating system
    • Log on as a service
    In the Group Policy Object Editor, go to New Group Policy Object > Computer Configuration > Windows Settings > Security Settings > Local Policies > User Rights Assignments. In the right pane, select "Log on as a service" and double-click. Add the domain user for whom you are granting the user right for and click OK. Repeat this step for "Act as part of the operating system."
  8. The group policy is now enforced for the Organizational Unit to include the domain accounts and groups specified under the local Administrators group on each computer in the Organizational Unit. In addition, the domain user has been granted the necessary rights. To verify this, log into a domain computer and open the Computer Management console. Select Groups, double-click on the Administrators group, and verify the membership of the domain users.

Notices

Aperi Storage Manager (C) Copyright IBM Corp. 2007. All Rights Reserved
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.