Getting Started

Prerequisites

RapidOSS is a Java application and requires JRE version 6 to be installed.

32-bit JRE is bundled with the windows release.

• Make sure that the JAVA_HOME environment variable points to the path where you have installed Java on unix platform.

Download and Installation

Download RapidOSS for your platform (windows or unix) from the Downloads page and unzip in a directory of you choice.

Due to the 260 character file path limitation in Windows, make sure that you do not select a folder deep in the hierarchy while unzipping. You can unzip directly in C:, or in a subfolder under C: to be safe.

All files will be unzipped into the RapidServer directory which will be referred to as RS_HOME. That is, if you have unzipped into /opt, then RS_HOME is /opt/RapidServer.

Unix

Create and set your RS_HOME environment variable (i.e. /opt/RapidServer)

Windows 32 bit

RapidOSS can be installed as a Windows service. Go to the RapidSuite (RS_HOME/RapidSuite) directory and execute rs.exe -install. For example:
C:\MyPrograms\RapidServer\RapidSuite> rs.exe -install (install RapidOSS as a windows service)

Windows 64 bit

Just use rs_64.exe executable file instead of rs.exe file for your service operations.

RapidOSS is distributed with 32-bit JRE under RS_HOME/jre directory. The rs_64.exe executable file looks RS_HOME/jre directory first to find the JVM, if it cannot, it looks the environment variable JAVA_HOME next. So you have to replace the RS_HOME/jre directory with your 64-bit JRE, or delete the directory and define your JAVA_HOME environment variable to point the 64-bit JDK or JRE

JVM Configuration Parameters

RapidOSS is a java application running inside a JVM (Java Virtual Machine). The JVM configuration parameters are used when the server is starting up. JVM configuration is performed in different files depending on the platform

Unix

Edit the RS_HOME/RapidSuite/rs.sh file. Configuration parameters are added to the line that starts the server.

Web Server Port

Default value is 12222. Change the port in the following line:

JAVA_OPTS=" -Dserver.port=12222 $JAVA_OPTS"

Web Server Https Port

Https is disabled by default. Enable by adding the following system property to the system configuration parameters:

JAVA_OPTS=" -Dserver.https.port=12223 $JAVA_OPTS"

Java Memory Allocation

Default value is 512Mb. Change the size in the following line:

JAVA_OPTS=" -Xmx512m $JAVA_OPTS"

Windows

Edit the RS_HOME/RapidSuite/rs.vmoptions or RS_HOME/RapidSuite/rs_64.vmoptions file depending on your system type. Each configuration parameter is added as a separate line.

Web Server Port

-Dserver.port=12222

Web Server Https Port

 -Dserver.https.port=12223

Java Memory Allocation

-Xmx512m

Starting RapidOSS

Unix

Go to the RapidSuite directory (RS_HOME/RapidSuite) and make the rs.sh shell script executable. chmod +x rs.sh

Run the following command to start the RapidOSS server: /opt/RapidServer/RapidSuite> ./rs.sh -start

-stop will argument stops the server and -status argument shows the status of the server.

Windows

Go to Windows services and start "iFountain RapidOSS " service. Alternatively, the service can be started from the command line C:\MyPrograms\RapidServer\RapidSuite> rs.exe -start

It takes a while for the RapidOSS application to start up, please be patient. It compiles and deploys the model during restart and application reload to support dynamic extensibility. You can check the RapidServerOut.log for the line: "Server running. Browse to http://localhost:12222/RapidSuite" to make sure that application is ready to be used.

See Starting Over if you want to remove existing data and start RapidOSS fresh.

RapidOSS Operations Console

You can access the default Operations Console at http://localhost:12222/RapidSuite. Please replace localhost with appropriate host name.

Default administrative userid/password is: rsadmin/changeme

Very briefly, this tool allows you to search devices and events (active and historical) by using Google-like easy search queries and allows you to save these queries, grouped by query categories. Here are the pre-defined tabs in the default UI:

• Events tab: to display/search active events in grid view
• Event Search tab: to display/search active events as a list
• Historical Events tab: to display/search historical events
• Inventory tab: to display/search network devices
• Maps tab: to display the inventory objects and their relations in a map view
• Notifications tab: to define rules to get notified via email when certain actions happen on certain events

RapidOSS installation comes with sample data that can be imported so that you can experience the Operations Console right away. Simply go to the Scripts tab at the Admin UI (http://localhost:12222/RapidSuite/admin.gsp) and run the importSampleRiData script.

Saving a query is easy; simply type your query into the search field and after reviewing the results in the grid, click on the "Save Query" link and choose a name and group for the query to be filed under. The Map tab allows you to save the maps in the Saved Maps tree.

The search results are displayed in a list of rows with property names and their values. You can adjust the height of each row (how many lines you want the results to be displayed per row).

New search queries and groups can be created from he two icons in the Saved Queries pane on the left hand side.

In the search results list, each row, potentially spanning multiple lines, will show property names and their values, represented with an icon on the left of the row (colored for notifications based on severity). Click on the icon and you will get a list of actions that can be taken on the notification or topology object. Also, you may have noticed drop down menu icons (little triangles) next to each property. These will allow you to refine your query based on the selected property values or sort the results depending on your selection.

One of the most useful features of the search list component is the ability to refine the searches by simply clicking on property links. This will modify the search criteria by adding an AND condition based on the property and its value selected. Since AND is the default boolean operator, it is omitted. OR (uppercase) can also be used as a boolean operator. The last boolean operator is NOT. Select "except" from the drop down menu of any field to search for items that does NOT match the value selected. Check Search Syntax document for more information on writing search queries.

Search list and grid components allows copying and pasting data. Simply select data from grid or list (along with Shift key if using FireFox) and copy.

All UI components have Configure and Update icons at the upper right corner. Configure will open up a configuration dialog which will allow you to configure settings that applies to the particular tab. Update will refresh the data displayed in the tab.

Server Log Files

RapidOSS log files can be found in the RS_HOME/RapidSuite/logs directory. The following log files are created automatically by the application.

• RapidServer.log
  The main server log file. The scripts can write into this log file.
• RapidServerOut.log
  Messages written to standard output are written to this log file.
• RapidServerErr.log
  Messages written to standard error are written to this log file.

Log level for these files can be changed by editing the RS_HOME/RapidSuite/grails-app/conf/Config.groovy. Following lines are where the levels are set:

// log4j configuration
log4j {
        ...

        models="info,modelsLog"

        grails="warn,rapidServerLog"
        StackTrace="warn,errorLog"
        ...
}

This file is only processed when the server is starting, therefore the server needs to be started for any changes to become active.

The log level can also be set at runtime programatically with the help of a script. Get the logger you want to set the level (Logger.getRootLogger() or Logger.getLogger("models") and set its level by calling the setLevel method on it.

Administrative User Interface

You can access to the administrative UI at http://localhost:12222/RapidSuite/admin.gsp

Default administrative userid/password is: rsadmin/changeme

This is where RapidOSS is configured by the administrator. Standard Admin UI tabs include:

• Scripts: Execute defined script or define new scripts (OnDemand/Scheduled/Listening)
• Reload: Reload the web UI when the changes are view only, or reload the operations of any modeled class when the operations change.
• Users: User maintenance
• Groups: Group maintenance
• Database: Configure connection to databases
• SNMP: Configure connection for SNMP trap processing

In addition to the standard tabs listed above, a tab for each integration plugin (Smarts, Netcool, APG, etc.) may be added to the Admin UI, depending on the installed plugins.