Optima Management System System Administration Guide ...support.westell.com/documents/manuals/Optima1130_SysAdmin.pdf · Table 1 summarizes the general content of the three Optima

SYSTEM A

D

Optima Management System

System Administration Guide

Version 11.3x

WESTELL.COM

MIN

ISTRATIO

N G

UID

E

© Westell Technologies
Part # 030-101861

WESTELL.COM

Copyright © 2015 by Westell, Inc. All Rights Reserved. Westell, Kentrox and Optima Management System are registered trademarks of Westell. All other names are trademarks of their respective owners.

Information is correct at time of publication and is subject to change without notice. Contact Westell in Aurora, Illinois, to verify current product information. Westell, Inc. is an Equal Opportunity/Affirmative Action employer.

Westell Inc.750 North Commons Drive

Aurora, IL 60504 USAToll Free: (800) 377-8766

International: +1 (630) 375-4950Fax: +1 (630) 375-4931

TABLE O

F CON

TENTS

Table of Contents

Preface:.......................................................................Preface iAbout This Document:................................................................Preface iOptima Users and Tasks:..........................................................Preface iiiDocument Conventions:........................................................... Preface ivCustomer Assistance: .............................................................. Preface vi

Chapter 1: Product Overview ..............................................1-1Overview of the Optima Management System .................................. 1--2

Benefits ................................................................................. 1--2Features ............................................................................................ 1--3

Chapter 2: Installing and Upgrading Optima ....................... 2-1Performing a Fresh Optima Installation ............................................. 2--2

Installing a Standalone Server .............................................. 2--2Installing Separate OMS and DMC Servers .......................... 2--4

Upgrading to Optima v11.x from Optima v9.00 or later versions ...... 2--7Before Starting ...................................................................... 2--7Upgrading a Standalone Server ............................................ 2--8Upgrading an OMS ................................................................ 2--9Upgrading a DMC Server .................................................... 2--10optimainstaller Troubleshooting .......................................... 2--11Post-Upgrade Tasks ............................................................ 2--12

Upgrading to the latest version of Optima from Optima Versions Older Than v9.00 ...................................................................................... 2--14Installing Optima Patch Files ........................................................... 2--15Adding and Editing Systems ........................................................... 2--18

Page TOC-1

WESTELL.COM

Optima Version 11.2x System Administration GuideTable of Contents

Chapter 3: Optima Client ......................................................................... 3-1System Requirements .................................................................................................3--2Installing and Uninstalling Redirect .............................................................................3--3

Installing Redirect ............................................................................................3--3Uninstalling Redirect .......................................................................................3--3

Chapter 4: Optima Server ....................................................................... 4-1Overview .....................................................................................................................4--2

Optima Management Server (OMS) ................................................................4--3Data & Measurement Collector (DMC) ............................................................4--3

System and Hardware Requirements .........................................................................4--4Server Size ......................................................................................................4--4Hardware Specifications for OMS Servers ......................................................4--4Hardware Specifications for DMC Servers ......................................................4--5

Executing Linux Commands .......................................................................................4--6Initial Setup Administrative Tasks ...............................................................................4--7

Changing the PostgreSQL Password ..............................................................4--7Configuring the System Clock .........................................................................4--8Configuring the Map View ...............................................................................4--8Setting Up Optima in a Firewalled Environment ............................................4--11DMC Registration ..........................................................................................4--11Configuring the User Session Inactivity Timer ..............................................4--13

Ongoing Administrative Tasks ..................................................................................4--14Starting and Stopping the Optima Service ....................................................4--14Troubleshooting Using the RHEL Service Configuration Window .................4--15Configuring Logging Options .........................................................................4--15Using the Optima Network Check Utility .......................................................4--16Using the Snapshot Utility .............................................................................4--16Accessing Logging Files ................................................................................4--16Backup and Restore ......................................................................................4--18Inventory Importer and Exporter ....................................................................4--19Editing the IP Address and/or Hostname ......................................................4--23Administering Licenses .................................................................................4--24Administering Permissions ............................................................................4--24Configuring Email Notifications .....................................................................4--25Configuring Notifications for Clears and Acknowledgements ........................4--25Adjusting Data Retention Intervals ................................................................4--26Adjusting the Memory Limit for Reports ........................................................4--27

Process Monitoring ...................................................................................................4--28Optima Server Monitor ..................................................................................4--28Node Status Poller ........................................................................................4--30Daemon Watcher ..........................................................................................4--31Fault Generator .............................................................................................4--31Process Monitoring Log Files ........................................................................4--32

WESTELL.COM

Page TOC-2

1-800-377-8766


Appendix A: Configuring a Removable Direct Access Storage Device ...A-1Installing Red Hat Patch 007 ...................................................................................... A--3Unmounting the Previous Storage Device ................................................................. A--4Installing RAIDar Software ......................................................................................... A--5Connecting the ReadyNAS 2100 ............................................................................... A--6Configuring the ReadyNAS 2100 ............................................................................... A--7Configuring Static IP Addresses for the ReadyNAS 2100 and Optima Server .......... A--9

Assigning a Static IP to the LAN 2 Ethernet Interface .................................... A--9Configuring a Static Route to the ReadyNAS 2100 on the Optima Server ... A--11Configuring the iSCSI Target Area on the ReadyNAS 2100 ........................ A--12Installing Red Hat Patch 007 ........................................................................ A--12Identifying the iSCSI Target .......................................................................... A--12Formatting the iSCSI Target Area ................................................................ A--13

Configuring the iSCSI Mount Point ........................................................................... A--16Mounting the RealNAS 2100 Without Disk Growth .................................................. A--17Mounting the ReadyNAS 2100 with Disk Growth ..................................................... A--18Configuring a NFS mount point ................................................................................ A--19Dell RD1000 Administration Instructions .................................................................. A--20Determining the Device Name ................................................................................. A--20

Internal RD1000 Drive .................................................................................. A--20External RD1000 Drive ................................................................................. A--20

Repartitioning the Device ......................................................................................... A--21Deleting the Partition and Creating a New Partition ..................................... A--21Formatting the Drive to Use an ext3 Filesystem ........................................... A--23

Configuring the Mount Point ..................................................................................... A--23Ejecting and Reinserting the Removable DAS Cartridge ......................................... A--24

Appendix B: Updating Kentrox Remote Devices .....................................B-1Prerequisites and Assumptions .................................................................................. B--2Upgrading Kentrox Remote Software ......................................................................... B--3Transferring Files to Kentrox Remote ........................................................................ B--4Updating Firmware on Kentrox Remote ..................................................................... B--7Installing Modules on Kentrox Remote Devices ....................................................... B--12

Using the Modulemanager Script ................................................................. B--12

Appendix C: ..................................................... OMS Disaster Recovery C-1Prerequisites and Assumptions .................................................................................. C--2Recovery Procedure ................................................................................................... C--4

WESTELL.COM

1-800-377-8766

Page TOC-3


Appendix D: Dell Remote Access Card (DRAC) Guide ..........................D-1Configuring DRAC Network Settings ......................................................................... D--2Accessing the DRAC Web Interface .......................................................................... D--8Configuring DRAC Users ......................................................................................... D--10Configuring DRAC Services ..................................................................................... D--14

Appendix E: Northbound Interface ..........................................................E-1Introduction .................................................................................................................E--2

NBI Integration Methods ..................................................................................E--3SNMP Integration ........................................................................................................E--4

Configuring Optima to Forward Events as SNMP Notifications ......................E--4Decoding the SNMP Notification .....................................................................E--6

NBI Integration Using JMS ........................................................................................E--14Subscribing to NBI JMS Connection .............................................................E--14Extracting Relevant Information from CBEs ..................................................E--16

JMS Message Selectors ...........................................................................................E--20Example JMS Selectors ................................................................................E--20

Event Object Model ...................................................................................................E--21

Appendix F: Red Hat Installation Tasks .................................................. F-1Installing Red Hat ........................................................................................................F--2Increasing Red Hat Linux Swap Space .......................................................................F--7Installing a Service Pack .............................................................................................F--9

Appendix G: Importer and Exporter File Formats ...................................G-1Export File Format ...................................................................................................... G--2Import File Format ...................................................................................................... G--3CSV File Columns ...................................................................................................... G--4

necategory ...................................................................................................... G--4ne ................................................................................................................... G--4neaccess ........................................................................................................ G--7netype ............................................................................................................. G--8netypeaccess ................................................................................................. G--9user .............................................................................................................. G--10protocol ......................................................................................................... G--11alarm ............................................................................................................ G--11alarmtranslation ............................................................................................ G--11measurementtemplate .................................................................................. G--12

WESTELL.COM

Page TOC-4

1-800-377-8766


signaldefinition ..............................................................................................G--13signalcategory ..............................................................................................G--15measurement ................................................................................................G--15

XML Import/Export Types .........................................................................................G--16

Appendix H: Configuring LDAP User Authentication ...............................H-1Configuring LDAP User Authentication ...................................................................... H--2Creating the Initial User Account (Bootstrapping) ...................................................... H--3Authenticating Via a Simple User Bind ....................................................................... H--4Authenticating Via an Administration User Bind ......................................................... H--6Authenticating Users with MS Active Directory .......................................................... H--8Configuring Optima for LDAP Failover ..................................................................... H--11

Using LDAP DNS Aliases ............................................................................. H--11Using Designated LDAP Servers ................................................................. H--11

Authenticating Against LDAP Over SSL ................................................................... H--12

Appendix I: Event Information Fields, Event Types, and Alarms ............. I-1Event Information Window Fields .................................................................................I--2Kentrox Optima Server Monitor Events ........................................................................I--5Kentrox Remote Product Monitor Events .....................................................................I--6Kentrox Remote Default Analog Events .......................................................................I--7IP and Kentrox Device Alarms .....................................................................................I--8Optima Self-Monitoring Alarms ..................................................................................I--10

Optima System Monitoring .............................................................................I--10Optima Server Resource Monitoring ..............................................................I--11Optima UI to NBI Terminology Mapping .........................................................I--18

Glossary: ..................................................................................... Glossary 1

Index: .................................................................................................Index 1

WESTELL.COM

1-800-377-8766

Page TOC-5


WESTELL.COM

Page TOC-6

1-800-377-8766

PREFACE

Preface

About This Document

This document explains how to administer and operate Optima servers and how to administer Optima client machines. You should have a working knowledge of the following:

Red Hat Enterprise Linux

The PostgreSQL database

Oracle 11g

Table 1 summarizes the general content of the three Optima Management System documents, including the primary target audience and the primary tasks and menus that are covered in each document.

Page Preface-i

WESTELL.COM

Optima Version 11.3x System Administration GuidePreface: About This Document

Table 1 Optima Documentation Content Summary

Document/Part #Primary Target Audience

Primary Tasks/Menus

Optima Management System User/Configuration Guide

Network Operators Primary tasks performed from the following Optima Management System menus: My Optima > My Profile Dashboards Map View Event View Report View Live View Optima Configuration > Event

Configuration > Event Filtering & Mediation

Optima Configuration > Event Configuration > Threshold Templates

Optima Management System User/Configuration Guide

Network Managers Primary tasks performed from the following Optima Management System Optima Configuration menu: Network Configuration Event Correlation Notification Rules Busy Hour Templates Measurement Templates Report Scheduling Time Templates Manage Users Job Scheduling System Preferences

Optima Management System Administration Guide

System Administrators Responsible for overall Optima server functions, including installation, system performance, hardware/software reconfiguration, system startup and shutdown, and backup and restoration of configuration data.Tasks are typically performed from a browser and various command lines, not from the Optima Management System.

WESTELL.COM

Page Preface-ii

1-800-377-8766

Optima Version 11.3x System Administration GuidePreface: Optima Users and Tasks

Optima Users and TasksWhile companies and local policies may vary, there are typically assumed to be three user types for the Optima product:

Network Operators. Network operators are the basic users of Optima. General tasks include using the Graphical User Interface (GUI) to monitor the network and view events in the form of dashboards, maps, event lists and reports. The tasks and supporting information for network operators are addressed in the Optima User/Configuration Guide.

Network Managers. Network managers typically use the Optima GUI to configure system parameters such as sites, network elements, reports, user accounts and notifications.The tasks and supporting information for network managers are addressed in the Optima User/Configuration Guide.

System Administrators. System administrators are typically responsible for overall administration of the Optima server functions, including installation, system performance, hardware/software reconfiguration, system startup and shutdown, and backup and restoration of configuration data. The tasks and supporting information for system administrators are addressed in this document (the Optima System Administration Guide).

WESTELL.COM

1-800-377-8766

Page Preface-iii

Optima Version 11.3x System Administration GuidePreface: Document Conventions

Document ConventionsTable 2 describes the text conventions used in this document.

Table 2 Document Conventions

Convention Meaning

Screen Text, Menu Items, System Prompts, Messages and Reports

This style indicates Westell’s Kentrox configuration screen text, menu items, system prompts, messages, and reports.

Static Command Text In a command statement, this style indicates text that should be entered exactly as shown at a command line.

Variable Command Text

In a command statement, this style indicates user-specified text.

... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times.

[ ]

[ | ]

In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( | ) between them indicate a choice of optional parameters.

{ | } In a command statement, two or more parameters in braces with a vertical bar ( | ) between them indicate a choice of required parameters.

Menus and Menu Commands

This style indicates menu and menu commands. An angle bracket ( > ) separates the menus from the submenus or menu commands. The right arrow also indicates the order in which you should click the menus, submenus, and menu commands.

Dialog Boxes, Tabs, Fields, Check Boxes, and Command Buttons

This style indicates dialog boxes, tabs, fields, check boxes, and command buttons.

Variable Field Text This style indicates variable information you type in a dialog box field.

KEYS Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+).

WESTELL.COM

Page Preface-iv

1-800-377-8766

Optima Version 11.3x System Administration GuidePreface: Document Conventions

Labels This style designates physical components on Kentrox products such as jumpers, switches, and cable connectors.

Note:

Note messages emphasize or supplement important points of the main text.

Important: Important messages provide information that is essential to the completion of a task.

Tip:

Tip messages provide information that assists users in operating equipment more effectively.

Table 2 Document Conventions (Continued)

Convention Meaning

WESTELL.COM

1-800-377-8766

Page Preface-v

Optima Version 11.3x System Administration GuidePreface: Customer Assistance

Customer AssistanceAll customers, partners, and resellers who have a valid Westell Support and Services Agreement have complete access to the technical support resources.

Pre-sales Support

Westell offers pre-sales technical support from 9 a.m. to 5 p.m. Eastern time, Monday - Friday. Representatives are standing by to assist with customer account information and product ordering and answer questions regarding Westell products and solutions.

Phone number: 800-377-8766, option 1

Before you call or email

Before you contact Westell for assistance, please have the following information available:

The versions of hardware and software you are currently running

The error number and exact wording of any messages that appeared on your screen

What happened and what you were doing when the problem occurred

How you tried to solve the problem

Email Technical Support

Email support is available. You may send email at any time during the day; however, responses will be provided only during normal business hours, in accordance with your Service and Support Agreement.

To contact Technical Support, send email to:

[email protected]

Telephone Technical Support

Available to qualified Westell customers or partners who have not been able to resolve their technical issue by using our online services. To qualify for support, you must have a valid Support and Services Agreement.

Phone number: 800-377-8766, option 2

Normal Business Hours: 8 a.m. to 6 p.m. Eastern time

After-Hours Support: Available to qualified customers who are experiencing service-affecting outages that cannot wait until the next business day. To qualify for after-

WESTELL.COM

Page Preface-vi

1-800-377-8766

mailto:[email protected]


hours support, you must have a valid 24x7 Support and Services Agreement. Call the number above, option 2, and follow the prompts for after-hours service.

Product DocumentationYou can also access and view the most current versions of Westell product documentation on our Web site at:

http://www.westell.com

WESTELL.COM

1-800-377-8766

Page Preface-vii

http://www.westell.com


WESTELL.COM

Page Preface-viii

1-800-377-8766

CHA

PTER 1

1

Product Overview

This chapter provides an overview of the Optima Management System software and features.

Guide to this Chapter

Overview of the Optima Management System

Features

Page 1-1

WESTELL.COM

Optima Version 11.3x System Administration GuideProduct Overview: Overview of the Optima Management System

Overview of the Optima Management SystemOptima Site Solutions provide mobile and fixed-line network operators with complete 360 degree views of and control over their network infrastructure sites.

BenefitsThe key benefits for companies utilizing Optima are to:

Gain operational efficiencies by remotely resolving issues

Implement one-time intelligent dispatches to reduce costly truck rolls

Improve site visibility with remote diagnosis and management

Adopt practices that reduce cost and improve mean time to repair (MTTR)

WESTELL.COM

Page 1-2

1-800-377-8766

Optima Version 11.3x System Administration GuideProduct Overview: Features

FeaturesOptima features can be grouped into the following general categories:

Event Management The event management feature captures and records all events at sites, providing the capability to:

View interrelationships between network and physical site elements (tower lights, door alarms, power systems)

View events displayed on dashboards, maps, Event Views, and reports

Set up notifications to alert parties when specific events occur (using, for example, email or SMS)

Performance ManagementThe performance management feature collects key performance indicators. These performance indicators allow you to create dashboards that illustrate overall network performance, as well as to correlate measurements from multiple network elements.

Element Management Element management provides status updates of network elements.

Remote Access Remote access provides access to network elements from anywhere using proprietary third party software or standard packages (Browser, Telnet, ProComm, Kentrox Redirect Profiles).

Site Data CollectionThis feature provides the capability to monitor, collect, and report site data. Reports can be executed on demand or scheduled.

WESTELL.COM

1-800-377-8766

Page 1-3

Optima Version 11.3x System Administration GuideProduct Overview: Features

WESTELL.COM

Page 1-4

1-800-377-8766

CHA

PTER 2

2

Installing and Upgrading Optima

This chapter provides information about installing Optima and upgrading to newer versions of Optima.


Performing a Fresh Optima Installation

Upgrading to Optima v11.x from Optima v9.00 or later versions

Upgrading to the latest version of Optima from Optima Versions Older Than v9.00

Installing Optima Patch Files

Adding and Editing Systems

Page 2-1

WESTELL.COM

Optima Version 11.3x System Administration GuideInstalling and Upgrading Optima: Performing a Fresh Optima Installation

Performing a Fresh Optima InstallationOptima is installed using the optimainstaller utility.

The following sections describe how to install Optima on a server that meets the System and Hardware Requirements on page 4-4 and is running Red Hat Enterprise Linux 5.10.

Notes: See section Overview on page 4-2 for an explanation of OMS, DMC, and

standalone server functionality.

See section Using the Optima Network Check Utility on page 4-16 for more information about this utility.

Information needed before installation: Optima license file (obtain from Westell, as described in section Administering

Licenses on page 4-24)

Server ID

System name/names

IP or hostname for OMS

IP or hostname for DMC

SMTP server hostname

Installing a Standalone ServerTo install Optima on a single server that combines OMS and DMC functionality:

1. Log in as the root user.

2. Verify RHEL version using the following command:

# cat/etc/redhat-release

3. If the Red Hat version is other than 5.10, install Kentrox Red Hat patches as needed. See Appendix F: Red Hat Installation Tasks for installation details.

4. Execute the following commands to create directories on the server, then copy the installation files from the Optima distribution disks to the appropriate directories:

# mkdir /var/tmp/oms

# mkdir /var/tmp/dmc

# mkdir /var/tmp/tools

# mkdir /var/tmp/platform

WESTELL.COM

Page 2-2

1-800-377-8766


5. Copy the installation files from the Optima distribution disks or transfer them using sftp to the appropriate directories.

6. Install Optima files by executing the following commands:

# cd /var/tmp

# chmod +x optimainstaller

# ./optimainstaller single

Tip: The JBOSS_CUSTOMER_NAME value is used in some email notifications and reports. This value can be added to the /etc/sysconfig/omsPrefs file when installation is complete. However, the user can specify it when running the optimainstaller utility by using the following syntax:

./optimainstaller --oms-customername=your_customername single

For information about other available optimainstaller parameters, execute the following command:

./optimainstaller --help

When prompted, enter:

the dmc_name value for this DMC server

the hostname for an SMTP server (used for sending notification messages to users in response to events).

Note: Avoid using spaces in the DMC server name if possible. If the DMC server

name must contain spaces, enclose the value in double quotes.

Note: If optimainstaller fails, see section optimainstaller Troubleshooting on

page 2-11.

7. Install the Optima license file:

Save the license.properties.aes license file (obtained from Westell) to the following directory location:

/opt/oms/config/server

8. Execute the following commands to register the DMC:

# optimanetworkcheck -V

# dmcregistrar -a -f dmc_name -i 127.0.0.1 -s system_map

where dmc_name is the same DMC server ID value specified in step 6, and system_map is one or more system names to map to the DMC. The first system

WESTELL.COM

1-800-377-8766

Page 2-3


listed is considered to be the default system for the DMC. In the following example, SYSTEM1 is the default system for the DMC server DMC1:

# dmcregistrar -a -f DMC1 -i 127.0.0.1 -s SYSTEM1,SYSTEM2,SYSTEM3

Important: Before the user runs the dmcregistrar utility, the user should plan how many System NEs are necessary for their network and how these System NEs should be organized. The user should also be sure all these System NEs have been added to Optima. See section Adding and Editing Systems on page 2-18 for more information about hosting systems on Optima servers.

9. Verify the license value by viewing the Site Counts page (Optima Configuration >System Configuration > System Counts).

Installing Separate OMS and DMC Servers

Installing an OMSTo install a server with OMS functionality only:



# mkdir /var/tmp/oms




4. Install Optima files by executing the following commands. If the server is not active in DNS, specify the server’s IP address using the webhost parameter:

# cd /var/tmp


# ./optimainstaller oms [--oms-webhost=server_ip_address]

If prompted, enter the hostname for an SMTP server (used for sending notification messages to users in response to events).


page 2-11.

5. Install the license file, as described in step 7 of the standalone server section. Then, enter:

WESTELL.COM

Page 2-4

1-800-377-8766



Installing a DMC ServerTo install a server with DMC functionality only:



# mkdir /var/tmp/dmc




4. Install Optima files by executing the following commands:

# cd /var/tmp


# ./optimainstaller dmc

When prompted, enter:

the dmc_name value for this DMC server (if upgrading, this should be the dmcid value from Optima v9.x)

the IP address or hostname of the OMS

the IP address or hostname of the DMC server

Notes: Avoid using spaces in the DMC server name if possible. If the DMC

server name must contain spaces, enclose the value in double quotes.

If optimainstaller fails, see section optimainstaller Troubleshooting on page 2-11.

5. Execute the following commands to register the DMC:


# dmcregistrar -a -f dmc_name -i dmc_IP_address -s system_map

where dmc_name is the same DMC server ID value specified in step 4, and system_map is one or more system names to map to the DMC. The first system listed is considered to be the default system for the DMC. In the following example, SYSTEM1 is the default system for the DMC server DMC1:


WESTELL.COM

1-800-377-8766

Page 2-5


Note: Before running the dmcregistrar utility, the user should plan how many

System NEs are necessary for their network and how these System NEs should be organized. The user should also be sure all these System NEs have been added to Optima. See section Adding and Editing Systems on page 2-18 for more information about hosting systems on Optima servers.

WESTELL.COM

Page 2-6

1-800-377-8766

Optima Version 11.3x System Administration GuideInstalling and Upgrading Optima: Upgrading to Optima v11.x from Optima v9.00 or later versions

Upgrading to Optima v11.x from Optima v9.00 or later versions

These sections describe how to upgrade an existing Optima implementation from version 9.00or later to version 11.x.

Before Starting

Installation MediaUpgrading Optima requires software containing Optima v11.x.

Backing Up DataIt is suggested that users back up data before upgrading. Verify that a valid backup file (from automated nightly backups) is available. If not, execute the following commands as root:

# optimabackup

Note: It is suggested that users back up the /etc/sysconfig/omsPrefs file, or at

least note the configuration values contained therein.

Noting the dmcid ValueNote the dmcid value, as defined in /opt/dmc/conf/dmcid implementation. the user may need to enter this value as the dmc_name value during the Optima installation.

Noting System Names and the DMC IP AddressLog into the Optima GUI and note the names of all systems being monitored by the DMC. In addition, note the IP address of the DMC (if applicable). Execute the following command to remember the DMC ID, DMC IP address, and all monitored systems:

# dmcregistrar -l

See section Adding and Editing Systems on page 2-18 for more information about hosting systems on Optima servers.

Verify RHEL versionExecute the following command:

# cat /etc/redhat-release

If the Red Hat version is other than 5.10, install Kentrox Red Hat patches as needed. See Appendix F: Red Hat Installation Tasks for installation details.

WESTELL.COM

1-800-377-8766

Page 2-7


Noting Adapters with Start-At-Bootup Capability EnabledIf adapters are running on the Optima server and the start-at-bootup option has been enabled, take note of those adapter names by executing the following command as root:

# grep optima-adapter /opt/daemonwatcher/config/daemonwatchercfg.xml

An example output of the previous command is:

<Daemon name=”optima-adapter-AcmeFaultAdapter”/>

In this example output, the actual adapter name is AcmeFaultAdapter and optima-adapter- is a prefix that is automatically added by Optima.

Upgrading a Standalone ServerTo upgrade a single server that combines OMS and DMC functionality from Optima version 9.00or later to version 11.x:


2. If required install the license file, as described in step 7 of the Standalone Server section.

3. Verify the network configuration for the server and Optima daemons:


Note: See section Using the Optima Network Check Utility on page 4-16 for

more information.

4. Execute the following command to shut down Optima processes:

# optimacontroller stop

5. Execute the following commands to create directories on the server, then copy the installation files (from disk or file transfer) to the appropriate directories:

# mkdir /var/upgrade

# mkdir /var/upgrade/oms

# mkdir /var/upgrade/dmc

# mkdir /var/upgrade/tools

# mkdir /var/upgrade/platform

6. Find any unregistered (AutoStart is turned off) adapters by executing the following command:

# adaptermanager -L

7. (optional) Stop the unregistered adapters found in step 6 by executing the following command:

WESTELL.COM

Page 2-8

1-800-377-8766


# /etc/init.d/optima-adapter-instance stop

8. Upgrade Optima by executing the following commands:

# cd /var/upgrade


# ./optimainstaller single

If prompted, enter:

the dmc_name value for this DMC server

the hostname for an SMTP server (used for sending notification messages to users in response to events).


page 2-11.

9. Execute the following command to verify whether or not the DMC register information was lost during the upgrade:

# dmcregistrar –l

Upgrading an OMSTo upgrade an OMS from Optima v9.00or later to v11.x:


2. Execute steps 3 through 4 of the procedure Upgrading a Standalone Server on page 2-8.

3. Execute step 5 of the procedure Upgrading a Standalone Server on page 2-8, but omit the following command:

# mkdir /var/upgrade/dmc

4. Upgrade Optima by executing the following commands. If the server is not active in DNS, specify the server’s IP address using the webhost parameter:

# cd /var/upgrade


# ./optimainstaller oms [--oms-webhost=server_ip_address]

If prompted, enter the hostname for an SMTP server (used for sending notification messages to users in response to events).


page 2-11.

5. Perform the steps described in section Post-Upgrade Tasks on page 2-12

WESTELL.COM

1-800-377-8766

Page 2-9


Upgrading a DMC ServerTo upgrade a DMC server from Optima v9.00or later to v11.x:


2. Execute step 3 and 4 of the procedure Upgrading a Standalone Server on page 2-8.

3. Execute step 5 of the procedure Upgrading a Standalone Server on page 2-8, but omit the following command:

# mkdir /var/upgrade/oms

4. Upgrade Optima by executing the following commands:

# cd /var/upgrade


# ./optimainstaller dmc

If prompted, enter:

the dmc_name value for this DMC server (if upgrading, this should be the value already assigned to this DMC)

the IP address or hostname of the OMS

the IP address or hostname of the DMC server

Note: Avoid using spaces in the DMC server name if possible. If the DMC server

name must contain spaces, enclose the value in double quotes.


page 2-11.

5. Execute the following command to verify whether or not the DMC register information was lost during the upgrade:

# dmcregistrar –l

6. If the DMC register information was lost during the upgrade, execute the following command to register the DMC:

dmcregistrar -a -f dmc_name -i dmc_IP_address -s system_map

where dmc_name is the same DMC server ID value specified in step 4, and system_map is one or more system names to map to the DMC. The first system listed is considered to be the default system for the DMC. In the following example, SYSTEM1 is the default system for the DMC server DMC1:


WESTELL.COM

Page 2-10

1-800-377-8766


optimainstaller Troubleshooting

Optima Processes Failed to StopIf Optima processes failed to stop prior to running optimainstaller, this can cause the upgrade to fail. If this problem is suspected:

1. As root, execute the following command to confirm that all optima processes are stopped:

# ps -ef | grep optima

2. If any processes are still running, kill them by executing the following command for each process:

# kill -9 pid

3. Run the installer again:

# ./optimainstaller [ single | oms | dmc ]

DNS or Hostname Problems (Fresh Installation)If optimainstaller fails during a fresh installation, the most likely cause is a DNS or hostname problem. Review /var/lib/OptimaDirector/logs for details, then:

1. Move the file /etc/resolv.conf to /etc/resolv.conf.bak.

2. Execute the following commands:

# optimacontroller start

# su - optima

$ /opt/oms/bin/prefirststart.sh

$ /opt/oms/bin/serverredeploy

$ exit

# /opt/dmi/bin/postInstall

# /opt/dmc/bin/postInstall

# optimacontroller restart

DNS or Hostname Problems (Upgrade)If the upgrade fails due to a DNS or hostname problem, or running out of disk space, the user may be able to solve the problem by editing /etc/resolv.conf, /opt/oracle/product/11.2.0/network/admin/tnsnames.ora, or /etc/hosts.

The user can then finish the installation by restarting Optima services:


After Optima services have started, execute the following commands:

WESTELL.COM

1-800-377-8766

Page 2-11


# su - optima

$ /opt/oms/bin/omsInstall 9.20

$ exit

# /opt/dmi/bin/postInstall

# /opt/dmc/bin/postInstall


Post-Upgrade TasksPerform the following tasks after upgrading Optima server(s) from version 9.00or later to version 11.x.

Editing system_configuration.propertiesEnable HTTPS for Google Maps by removing the pound sign (#) from the start of the https line of code and adding a pound sign to the start of the http line.

When editing is complete in the system_configuration.properties file, execute the following command:

optimacontroller restart

Restoring omsPrefs ValuesCompare the parameters in /etc/sysconfig/omsPrefs to ensure they have not changed (particularly the JBOSS_EMAIL parameters). If the omsPrefs file is edited, execute the following commands to save changes:

su - optima -c '/opt/oms/install/install_config.ksh'

exit


Running Optima Network CheckAs the root user, execute optimanetworkcheck to set values in the /etc/optimanetworkcheck.conf file (see section Using the Optima Network Check Utility on page 4-16).

The following example configures the Ethernet interface eth0 with IP address 10.34.3.35, host name engsystest1, gateway 10.34.3.1, netmask 255.255.255.0, broadcast 10.34.3.255, and domain ai.aiinet.com:

# optimanetworkcheck -S -i eth0 -a 10.34.3.55 -n engsystest1 -g 10.34.3.1 -m 255.255.255.0 -b 10.34.3.255 -d ai.aiinet.com

If these values for this server are unknown, the user can obtain them by executing the following command:

WESTELL.COM

Page 2-12

1-800-377-8766


optimanetworkcheck -V

If this doesn’t return gateway information, the user can find this in the /etc/sysconfig/network file.

Restore Adapters with Start-At-Bootup Capability EnabledFor each adapter name that was noted in Noting Adapters with Start-At-Bootup Capability Enabled on page 2-8, execute the following two commands to toggle the state of this option. The first command will disable the start-at-bootup option and the second command will enable option.

# adaptermanager –a –n <adapter_name>

# adaptermanager –a –n <adapter_name>

WESTELL.COM

1-800-377-8766

Page 2-13

Optima Version 11.3x System Administration GuideInstalling and Upgrading Optima: Upgrading to the latest version of Optima from Optima Versions Older Than v9.00

Upgrading to the latest version of Optima from Optima Versions Older Than v9.00

Westell has a special optimainstaller utility for upgrading Optima versions older than version 9.00. For more information, contact Westell Technical Support. Refer to Customer Assistance.

WESTELL.COM

Page 2-14

1-800-377-8766

Optima Version 11.3x System Administration GuideInstalling and Upgrading Optima: Installing Optima Patch Files

Installing Optima Patch Files

To install an Optima patch1. Obtain patch file and release notes from Westell

2. Print and read release notes

3. Patch installation procedure (each patch will have specific installation requirements and steps based on these procedures; these are detailed in the release notes)

a. Copy the patch file to a new directory on the OMS server

b. Confirm from release notes under which user (root or optima) the installation should be run

c. Verify ownership & read/write permissions of the patch file using the command ls –al while in the new directory added in step a.

d. Revise the ownership & read/write permissions of the patch file as instructed by the release notes using the chown and chmod commands

e. Run the command md5sum –b * to verify the patch file check sum

Note: The release notes provide the correct value to compare to the results of

this command; if the results are different do not proceed as the patch file is corrupted. Delete it, obtain a new copy of the patch file, and restart the procedure)

f. Back up existing file or files as instructed in the release notes to a directory that is not under /opt/oms/lib or /opt/oms/kentroxlib; also avoid /tmp as a backup location

g. Stop Optima using the optimacontroller stop command

h. Overwrite files as instructed in the release notes using the cp –p file_name command

i. Start Optima using the optimacontroller start command

j. Verify update was successful using criteria provided in release notes

Optima patch release note example1. As Optima user, copy the included patch files to a new directory on the oms

server:

com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

WESTELL.COM

1-800-377-8766

Page 2-15


kentrox-optima-presentation-11.10-optima1110b015.ear

2. Verify ownership & read/write permissions of patch files. Run "ls -al" (without the quotes)

a. The owner of both files should be optima:dba. If it is not, run the following:

chown optima:dba

com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

chown optima:dba kentrox-optima-presentation-11.10-optima1110b015.ear

b. The permissions should be -rw-r--r-- for com.kentrox.director.optima.plugins.directorgui-11.1.0.zip. If they are not, run:

chmod 644 com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

c. The permissions should be -rw-rw-r-- for kentrox-optima-presentation-11.10-optima1110b015.ear. If they are not, run:

chmod 664 kentrox-optima-presentation-11.10-optima1110b015.ear

3. From that directory, run "md5sum -b *" (without quotes)

The result should be:

64ebffa32ba87cf48405b9a168d7212e *com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

01ce4bf85382fc43561bb8f23bb9bb59 *kentrox-optima-presentation-11.10-optima1110b015.ear

If the result differ for any of the files, DO NOT proceed with the install, because the patch file is corrupted.

4. Back up the following files to a backup directory that is *not* under /opt/oms/lib or /opt/oms/kentroxlib. Also avoid /tmp as the backup location.

/opt/oms/plugins/com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

/opt/oms/lib/kentrox-optima-presentation-11.10-optima1110b015.ear

WESTELL.COM

Page 2-16

1-800-377-8766


5. As root user, stop all of Optima


6. In the patch directory created in step 1:

Overwrite the existing files with the file from the patch:

cp -p com.kentrox.director.optima.plugins.directorgui-11.1.0.zip /opt/oms/plugins/com.kentrox.director.optima.plugins.directorgui-11.1.0.zip

cp -p kentrox-optima-presentation-11.10-optima1110b015.ear /opt/oms/lib/kentrox-optima-presentation-11.10-optima1110b015.ear

7. As root user, start Optima:


8. After all of Optima has started, do a quick test of the GUI to verify that the patches were applied correctly.

Note: Web browser cache may need cleared.)

a. Go to Event View, right click an Event, and select 'Open NE Tree to Source NE'. The NE Tree should expand to the source NE for the event.

b. Find a Remote in the NE Tree, right click -> View NE Details, and make sure Parent field near the bottom has the correct value, and that all tabs load properly.

WESTELL.COM

1-800-377-8766

Page 2-17

Optima Version 11.3x System Administration GuideInstalling and Upgrading Optima: Adding and Editing Systems

Adding and Editing SystemsNetwork elements of type System are the highest level in the visible hierarchy. By default, there are at least two Systems in an Optima implementation: the Optima Server System (named) and the Entire Network. The user should rename Entire Network to something more meaningful to their network, and add more System NEs to organize the network.

Optima Data and Management Collection (DMC) servers are automatically created as System NEs under the Optima Management Server (OMS). Customers cannot edit these DMC System NEs.

Before running the dmcregistrar utility, it is important that the user decide what System NEs are necessary for their network and how these System NEs should be organized. For example, if an Optima implementation involves one standalone server combining OMS and DMC functionality, the user might be able to organize all the regions and sites under one System NE. If the Optima implementation involves an OMS server and multiple DMC servers, the user will host one or more System NEs on each DMC server.

Keep in mind the following three considerations relating to System NE behavior:

1. When individual user accounts are created, they are explicitly granted or denied access to each System NE, and therefore to all subtended Region, Site, and Data Collection Device NEs.

2. A System and all its subtended NEs must reside on the same DMC server. A DMC may host more than one System NE; however, a System NE cannot reside on more than one DMC.

3. Users can view all System NEs in the Optima Navigation Tree. System NEs appear as the top-level NE in the NE Tree hierarchy.

Note: System NEs are assigned the NE category WSystem. This is helpful to

remember when searching for System NEs, or when creating a new System NE.

If a System NE is hosted on one Optima server and the user wants it to be hosted on a different DMC server, the user can use the dmcregistrar utility to move an entire System and its contents. If the user needs to move any other NEs from one System to another System on a different DMC, then any regions, sites and/or NEs under the original System NE must be recreated under the System NE on the new server. It is possible to use the Inventory Importer/Exporter to move NEs from the old server to the new one; however, these NEs still must be reconfigured in the Optima GUI to have the correct parent/child relationships.

WESTELL.COM

Page 2-18

1-800-377-8766

CHA

PTER 3

3

Optima Client

Westell’s Kentrox Redirect provides Optima client functionality. This chapter provides system requirements and installation information for Redirect.


System Requirements

Installing and Uninstalling Redirect

Page 3-1

WESTELL.COM

Optima Version 11.3x System Administration GuideOptima Client: System Requirements

System RequirementsKentrox Redirect provides Optima client functionality for serial-to-IP remote access. Any customers originally using AIredirect should upgrade to Kentrox Redirect, which provides Optima client functionality.

Redirect requires the following system components:

System Component Minimum Requirements

Operating System Windows XP or Vista

Platform Java 2 Runtime Environment 1.6.x Adobe Flash Player 10 Microsoft Internet Explorer 8.0 A working Internet connection to www.google.com (to

support Map View)

WESTELL.COM

Page 3-2

1-800-377-8766

Optima Version 11.3x System Administration GuideOptima Client: Installing and Uninstalling Redirect

Installing and Uninstalling Redirect

Installing RedirectTo install Redirect:

1. Open Redirect distribution media in a file browser.

2. Locate the setup.exe file, then double-click to launch it. The InstallShield wizard guides you through the installation process.

Notes: A Redirect shortcut icon will appear on your desktop for starting the client.

Uninstalling RedirectTo uninstall Redirect:

1. Open the Control Panel (click Start > Settings > Control Panel).

2. Double-click Add/Remove Programs.

3. In the list of currently installed programs, select Optima.

4. Click Remove. The InstallShield wizard guides you through the rest of the uninstallation process.

WESTELL.COM

1-800-377-8766

Page 3-3

Optima Version 11.3x System Administration GuideOptima Client: Installing and Uninstalling Redirect

WESTELL.COM

Page 3-4

1-800-377-8766

CHA

PTER 4

4

Optima Server

This chapter explains system requirements and administrative tasks pertaining to the Optima server.


Overview

System and Hardware Requirements

Executing Linux Commands

Initial Setup Administrative Tasks

Ongoing Administrative Tasks

Process Monitoring

Page 4-1

WESTELL.COM

Optima Version 11.3x System Administration GuideOptima Server: Overview

OverviewThe Optima server is the interface between the Optima client and the monitored network elements. The server performs database queries and creates responses containing data from the query results.

Figure 4-1 Optima Servers

There is only one Optima Management Server (OMS) in an Optima network. There can be one or more Data & Measurement Collector (DMC) servers, depending on the size of the network. Smaller networks may combine OMS and DMC functionality on the same “standalone” server.

WESTELL.COM

Page 4-2

1-800-377-8766

Optima Version 11.3x System Administration GuideOptima Server: Overview

Optima Management Server (OMS)The OMS interfaces with clients. It does not interface directly with monitored devices. It maintains a database of performance/fault data, signal data, and event data (forwarded from the DMC) for all monitored devices in the network. It also maintains some databases containing element configuration data. Finally, the OMS maintains an “element inventory” database containing an inventory of element configuration information for all monitored devices in the network.

Data & Measurement Collector (DMC)The DMC servers interface with monitored devices. Each DMC maintains databases containing port status, IP status (SNMP and ICMP), file backups, and restore points for the devices it monitors.

Note: For more information on restore points, see the Optima User/Configuration

Guide.

Each DMC server also maintains a “shadow element inventory” database, containing an inventory of element configuration information only for those devices it monitors (not for all devices in the network as the OMS “element inventory” database does).

WESTELL.COM

1-800-377-8766

Page 4-3

Optima Version 11.3x System Administration GuideOptima Server: System and Hardware Requirements

System and Hardware RequirementsWestell supports Optima using the Dell servers specified below. They can be purchased through Westell or directly from Dell.

Server SizeWestell recommends the following Dell PowerEdge R730 servers for these respective network sizes:

Hardware Specifications for OMS Servers

Westell Part Number

# of Sites (max) OMS Server DMC Server

750 DELLSVR-MA

751-2500 DELLSVR-MA DELLSVR-DMC

System Components Minimum Requirements

Base Unit Intel Xeon E5-2630 v3, 2.4GHz, 20M cache, 8.00GT/s QPI, Turbo, HT, 8C/16T (85W) Max Mem 1866MHz

Memory Two 16GB RDIMM, 2133 MT/s, Dual Rank, x4 Data Width

Hard Drives Five 600GB 10K RPM SAS 6Gbps 2.5-in.Hot-plug Hard Drives, 13G

Backup File Storage Optima requires a storage location for backup files. Requirements are NFS-mounted storage with 1000 Mbps ethernet connection and 4TB of storage capacity. Westell offers an optional Netgear ReadyNAS Network Access Storage device to meet this requirement.

Previous Optima systems have included the Dell PowerVault RD1000 for storage. This system offers storage up to 500GB, which is adequate for small to medium Optima deployments.

NIC Broadcom® 5720 QP 1Gb Network Daughter Card

Remote Access iDRAC8 Enterprise integrated Dell Remote Access Controller

Optical Drive DVD-ROM, SATA, Internal

RAID RAID 0 for H330/H730/H730P (1-16 HDDs or SSDs)

Power Dual, Hot-plug, redundant power supply (1+1), 495W

WESTELL.COM

Page 4-4

1-800-377-8766

Optima Version 11.3x System Administration GuideOptima Server: System and Hardware Requirements

Hardware Specifications for DMC Servers

System Components Minimum Requirements

Base Unit Intel Xeon E5-2630 v3, 2.4GHz, 20M cache, 8.00GT/s QPI, Turbo, HT, 8C/16T (85W) Max Mem 1866MHz

Memory 16GB RDIMM, 2133 MT/s, Dual Rank, x4 Data Width

Hard Drives 600GB 10K RPM SAS 6Gbps 2.5-in.Hot-plug Hard Drive, 13G

NIC Broadcom® 5720 QP 1Gb Network Daughter Card

Remote Access iDRAC8 Enterprise integrated Dell Remote Access Controller

DVD-ROM Drive DVD-ROM, SATA, Internal

RAID RAID 0 for H330/H730/H730P (1-16 HDDs or SSDs)

Power Dual, Hot-plug, redundant power supply (1+1), 495W

WESTELL.COM

1-800-377-8766

Page 4-5

Optima Version 11.3x System Administration GuideOptima Server: Executing Linux Commands

Executing Linux CommandsInstalling and administering the Optima server requires you to open the Red Hat terminal command line interface, from which you can execute Linux commands.

There are two ways to open the terminal CLI:

Click Applications > Accessories > Terminal

Right-click the desktop, then click Open Terminal from the context menu

Note: You must open a terminal CLI any time it is necessary to enter Linux

commands.

WESTELL.COM

Page 4-6

1-800-377-8766

Optima Version 11.3x System Administration GuideOptima Server: Initial Setup Administrative Tasks

Initial Setup Administrative TasksDepending on your implementation, several tasks may require completion when you set up an Optima server for the first time. These tasks include:

Changing the PostgreSQL Password

Configuring the System Clock

Configuring the Map View

Setting Up Optima in a Firewalled Environment

DMC Registration

Configuring the User Session Inactivity Timer

Changing the PostgreSQL PasswordWhen it is first installed, Optima uses a standard generic password for the PostgreSQL database. To ensure security, you may wish to change the default password on both the OMS and DMC servers.

To change the PostgreSQL password:

1. Stop all Optima daemons:

# /usr/sbin/optimacontroller stop

2. As root, log into PostgreSQL using the original password oldpassword:

# psql AIdirector dirserver

Password: oldpassword

3. At the Optima prompt, change the password from oldpassword to newpassword:

alter user dirserver with password ‘newpassword’;

4. Log out of PostgreSQL:

\q

5. As root, run the dbconfig utility:

# /usr/bin/dbconfig

6. Enter the default username:

dirserver

7. Enter the password for the default username.

8. Re-enter the password to confirm that it is correct. Optima restarts. The PostgreSQL password has been changed.

WESTELL.COM

1-800-377-8766

Page 4-7


Configuring the System ClockThe system clock should be configured with an NTP server by default. If an NTP server was not provided for initial installation, you can enable NTP using the following steps:

1. Ensure that NTP is available to run by executing the following command:

# /sbin/chkconfig --add ntpd

2. Open the /etc/ntp.conf file.

3. Edit the /etc/ntp.conf file to match the following:

#set the server and fudge options:

server time.nist.gov

fudge time.nist.gov stratum 10

#enable multicastclient

multicastclient # listen on default 224.0.1.1

4. Start the NTP service:

# service ntpd start

Note: Be sure your system clock is accurate. System clock inaccuracies can cause

strange reports and event timestamps. Execute the date command to check your current system clock settings.

Configuring the Map ViewThe Map View is available by clicking Map View in the Optima menu bar. For more information about using the map in the Optima Management System, see chapter Using the Map View in the Optima User/Configuration Guide.

You can configure map parameters such as the default map location and zoom threshold by editing the appropriate code in the system_configuration.properties file, which is located in the opt/oms/config/AFrame directory. A sample system_configuration.properties map configuration is shown below. See Table 4-1 on page 4-9 for an explanation of the parameters.

global.map.zoom-threshold=10

global.map.locations.1.label=Hazlet - NJ

global.map.locations.1.lat=40.427439

global.map.locations.1.lng=-74.18136

global.map.locations.1.mapType=G_NORMAL_MAP

global.map.locations.1.zoom=9

WESTELL.COM

Page 4-8

1-800-377-8766


After you have edited map parameters, restart all server processes:


Table 4-1 Map Configuration Parameters

Parameter Description

global.map.zoom-threshold Specifies the zoom level at which the Map View switches from displaying sites (Figure 4-2 on page 4-10) to displaying clusters (Figure 4-3 on page 4-10) when the user zooms out. Valid values are 0 (maximum zoom-out) to 19 (maximum zoom-in).

global.map.locations.1 Specifies the default location that appears in the Locations list on the Map View Map Options tab. Users can add more locations by adding them as map favorites, as described in the Optima User’s Guide and in the Online Help.

global.map.locations.1.label Specifies a name for the default location. In the example shown above, the default location is labeled Hazlet - NJ.

global.map.locations.1.lat Specifies the GPS latitude coordinate for the default location. Valid values are -90 to 90.

global.map.locations.1.lng Specifies the GPS longitude coordinate for the default location. Valid values are -180 to 180.

global.map.locations.1.mapType Specifies the map type as one of the following: normal (G_NORMAL_MAP) satellite (G_SATELLITE_MAP) hybrid (G_HYBRID_MAP)

global.map.locations.1.zoom Specifies the zoom level when location x is selected. Valid values are 0 to 19.

WESTELL.COM

1-800-377-8766

Page 4-9


Figure 4-2 Map View (Site Display Mode)

Figure 4-3 Map View (Region Display Mode)

WESTELL.COM

Page 4-10

1-800-377-8766


Setting Up Optima in a Firewalled EnvironmentTo use Optima in a firewalled environment, open the following ports:

Port 80 (the Web server port)

Port 443 (the secure HTTP port)

Port 1521 (the ODBC port)

Open Database Connectivity (ODBC) AccessODBC is an application programming interface (API) supported by Optima and its Oracle database system. To use the ODBC interface, you must have ODBC client software installed on your Optima client PC, and your IP network must have port 1521 open. If you need to design an ODBC application that leverages Optima’s collected data, contact Westell Professional Services.

DMC RegistrationBeginning with Optima version 8.0x, DMC servers are registered with the OMS by the use of two utilities: dmcregistrar and dmcsystemmanager.

DMC registration:

registers the DMC’s IP address and faultname with the OMS

creates a DMC Server element to represent events

maps Systems to a DMC (see section b. Find a Remote in the NE Tree, right click -> View NE Details, and make sure Parent field near the bottom has the correct value, and that all tabs load properly. on page 2-17)

adds the DMC to the status poller, which begins ICMP monitoring

dmcregistrarThe dmcregistrar utility is available on a standalone server (OMS and DMC combined) or on a dedicated DMC.

To run the dmcregistrar utility, enter the following command as root:

# dmcregistrar [options]

Optional arguments, or flags, for the dmcregistrar utility are explained in Table 4-2 below.

Table 4-2 Optional dmcregistrar and dmcsystemmanager Arguments

Argument Description

-h Prints a help message with usage statement and examples.

WESTELL.COM

1-800-377-8766

Page 4-11


dmcsystemmanagerThe dmcsystemmanager utility is available only on the OMS. Its functionality and usage are similar to dmcregistrar with one exception: the -a argument is not available, so dmcsystemmanager cannot be used to add DMC system mapping.

To run the dmcsystemmanager utility, enter the following command as root:

# dmcsystemmanager [options]

Optional arguments, or flags, for the dmcsystemmanager utility are explained in Table 4-2 above.

-l Lists all DMCs and their system mappings.

-x Displays list output as raw XML. Requires -l.

-a Adds DMC system mapping. Requires -i, -f, and -s. Not available for dmcsystemmanager.

-u Updates a DMC system mapping (when used with -s) or IP address (when used with -i). Requires -f.

-r Removes DMC system mapping. Requires -f.

-i ip_address Specifies the IP address of the DMC, which will be used by the OMS for status polling.

-f dmc_name Identifies the DMC to add, remove, or update.

-n Enables registration without verifying that the IP address is either reachable by the OMS, or assigned to an interface on the DMC. This flag is intended for use with DMCs that are connected via Network Address Translation (NAT) from the OMS.

-s system_map Specifies a comma-separated list of system names to map to the DMC (for example, SYSTEM1,SYSTEM2,SYSTEM3). The first system listed is considered to be the default system for the DMC.

Table 4-2 Optional dmcregistrar and dmcsystemmanager Arguments (Continued)


WESTELL.COM

Page 4-12

1-800-377-8766


Configuring the User Session Inactivity TimerUse Optima’s user session inactivity timer to automatically log users off an Optima session after a period of inactivity. To configure the user session inactivity timer:

1. In the /opt/oms/config/AFrame/system_configuration.properties file, set property global.idleSessionTimeout to one of the following values:

Any integer 2 to 20 to specify the number of minutes Optima will wait before logging off users from an Optima session due to inactivity.

0 to disable the user session inactivity timer. When the inactivity timer is disabled, user sessions will not expire unless the user logs out.

Note: It is not recommended that the user session inactivity timer be configured

for 1 minute. This time period is too short and will interfere with Optima’s attempts to check the period of inactivity for a user.

2. Execute the following command as the root user:

optimacontroller restart oms-serverd

Note: The user session inactivity timer is a system-wide setting, and it applies to all

Optima users, except those in the NOCEnvironment user group. Users in the NOCEnvironment group are never logged off Optima.

WESTELL.COM

1-800-377-8766

Page 4-13

Optima Version 11.3x System Administration GuideOptima Server: Ongoing Administrative Tasks

Ongoing Administrative TasksSeveral tasks may require completion as part of the ongoing administration of your Optima servers. These tasks include:

Starting and Stopping the Optima Service

Troubleshooting Using the RHEL Service Configuration Window

Configuring Logging Options

Using the Optima Network Check Utility

Using the Snapshot Utility

Accessing Logging Files

Backup and Restore

Inventory Importer and Exporter

Editing the IP Address and/or Hostname

Administering Licenses

Administering Permissions

Configuring Email Notifications

Adjusting Data Retention Intervals

Adjusting the Memory Limit for Reports

Starting and Stopping the Optima ServiceThe Optima service consists of several daemon processes. They are automatically stopped when the server machine is shut down, and automatically started when the server machine is rebooted. You can manually start and stop Optima services by using the optimacontroller utility. Enter this command as the root user to start, stop, or restart all services:

# /usr/sbin/optimacontroller [start | stop | restart]

You can check the status of all Optima services by executing the following command as the root user:

# /usr/sbin/optimacontroller status

WESTELL.COM

Page 4-14

1-800-377-8766


The optimacontroller utility also can be used to start, stop, restart, and check status of individual services. For more information, including a list of individual services, enter:

# /usr/sbin/optimacontroller --help

Note: During server startup, it may take a significant amount of time before all

services are available, especially if your Optima implementation involves many sites and monitored NEs. If you log into the Optima GUI during this time and query for status of an NE, you may encounter a Server Error message. Should you encounter this error shortly after starting an Optima server, wait several minutes, then try your query again.

Troubleshooting Using the RHEL Service Configuration WindowIn addition to entering commands at a shell prompt, you also can start, restart, stop, and check status of the Optima services and daemon processes by using the Service Configuration dialog within Red Hat Enterprise Linux on the OMS or DMC server.

To open the Service Configuration dialog, click System > Administration > Server Settings > Services.

Configuring Logging OptionsOptima includes the following loggable subsystems, called extensions:

com.aiinet.director.ext.alarmtable

com.aiinet.director.ext.conn

com.aiinet.director.ext.ems

com.aiinet.director.ext.filemanager

com.aiinet.director.ext.monitor

com.kentrox.director.ext.collector

com.kentrox.director.ext.configservice

com.kentrox.director.ext.sigmeas

To activate logging and set the logging level for a specific subsystem, add to the end of the file com.aiinet.director.ext or com.kentrox.director.ext:

com.{aiinet | kentrox}.director.ext.extension_name.level=[WARNING|INFO|FINE|FINER|FINEST]

For example, to set logging for the monitor extension to FINE, for the connectivity (conn) extension to FINEST, and the sigmeas extension to FINER, add the following code to the end of the file:

com.aiinet.director.ext.monitor.level=FINE

com.aiinet.director.ext.conn.level=FINEST

WESTELL.COM

1-800-377-8766

Page 4-15


com.kentrox.director.ext.sigmaes.level=FINER

Using the Optima Network Check UtilityThe optimanetworkcheck utility (located in /usr/sbin/) is used to verify and/or update network-related configuration, including:

the IP address for a specified interface, including bonding interfaces

network configuration (gateway, broadcast, netmask

Hostname information

Oracle configuration

Optima’s external host (if applicable), including NAT support

Optima’s SSL certificate

DNS server information

Optima Network Check is run automatically every time optimacontroller is executed. It can be run manually by executing the following command as root:

# /usr/sbin/optimanetworkcheck

There are many optional arguments you can use for configuring network-related parameters. To view these arguments and an example, execute the following command:

# /usr/sbin/optimanetworkcheck -h

Using the Snapshot UtilityThe optimadiagsnapshot utility takes a snapshot of your Optima system’s configuration settings and provides the result in a .tgz file for your review. If you specify the -l option, the current values of several log files will be included in the .tgz file. To take a snapshot, execute the following command as root:

# /usr/sbin/optimadiagsnapshot [ -l ]

By default, the .tgz file is saved to the /var/lib/optima/snapshots directory.

Accessing Logging FilesTable 4-3 on page 4-17 lists logging files that you may find useful when troubleshooting Optima servers.

Logging configuration files can be found in the following locations:

/opt/dmi/conf/logging.properties

/opt/dmc/conf/logging.properties

WESTELL.COM

Page 4-16

1-800-377-8766


User Audit LoggingThe user audit log (found at /var/log/oms/auditlog.csv) logs the following user activities:

User logs in, logs out, or the session expires

User creates, edits, or deletes an NE, NE type, NE category, NE group, user account, measurement template, signal definition, or report

User creates, edits, or deletes attributes, including NE connectivity data, protocols, alarm translations, or measurement translations

User applies a signal via Product Configurator

User downloads a Remote configuration

User schedules a job

User clears or acknowledges all alarms (Clear All, Ack All)

User manages or unmanages services

User launches an application via Optima

User changes the state of a site

Table 4-3 Commonly-Used Logging Files

Log Location Log Description

/var/log/oms/auditlog.csv Tracks user activity. See User Audit Logging.

/var/log/oms/server/inventory.log Maintains system inventory.

/var/log/oms/server/guierror.log Tracks GUI-related errors. For example, if a user encounters an “Internal Server Error” page while using the Optima Management System, an error is logged here.

/var/log/oms/server/error.log Tracks all errors from the application server process.

/var/log/oms/fault/flowcontrol.log Logs the activity of the event storm protection subsystem.

/var/log/dmi/serverDiag0.log Logging for the code in the dmi Httpd daemon.

/var/log/dmc/serverDiag0.log Logging for the code in the dmc Httpd daemon.

WESTELL.COM

1-800-377-8766

Page 4-17


The log file is a comma-separated file (.csv), so it can be opened with a spreadsheet program such as Microsoft Excel. Log entries take the following format:

SortableTime,ReadableTime,SomeUserName,SomeActionName,SomeObjectOfTheAction,SomeDescriptionOfTheAction

The following is an example log entry:

20100719164911,2010-07-19 16:49:11,admin,Logged In,Optima System,The admin user logged in to the Optima GUI

Backup and RestoreOptima provides the optimabackup and optimarestore scripts to back up and restore the OMS and dmi server databases and configurations. The optimabackup script saves a snapshot of Optima configuration data. You use optional arguments to specify whether to back up all data, or a subset of available data. The optimarestore script overwrites the existing configuration with backup data. It accepts optional flags as well, allowing you to specify whether to perform a total or partial restoration.

For customers that do not have an offline backup location, Westell offers an optional NetGear ReadyNAS 2100 drive to store system backups offline from the primary disk storage. See appendix Configuring a Removable Direct Access Storage Device on page A-1 for information on configuring this drive if it is not already configured from the factory.

Notes: The optimarestore script cannot restore data from older versions of

Optima. You must run optimarestore on files from the same Optima version used by optimabackup. Therefore, optimabackup and optimarestore cannot be used to migrate from an older version of Optima to a newer version.

The $OPTIMA_BACKUP_DEST location is specified in the /etc/sysconfig/oms file, and can be overridden by adding OPTIMA_BACKUP_DEST=<newpath> to the /etc/sysconfig/omsPrefs file.

The files /etc/sysconfig/oms, /etc/sysconfig/dmi, and /etc/sysconfig/dmc should not be modified directly. Instead, the env variables contained in those config files can be overwritten by changing the corresponding file: /etc/sysconfig/omsPrefs, /etc/sysconfig/dmiPrefs, and /etc/sysconfig/dmcPrefs.

Running the Backup ScriptTo run the backup script, enter the following command as root:

# /usr/sbin/optimabackup [options]

Optional arguments, or flags, for the optimabackup utility are explained in Table 4-4.

WESTELL.COM

Page 4-18

1-800-377-8766


Daily BackupThere is a symlink under the etc/cron.daily directory to /usr/sbin/optimabackup that causes an automatic backup of all the OMS and DMI data on a daily basis. By default, the backup runs at 4:02 a.m. daily. This can be changed by modifying the etc/cron.daily entry in the etc/crontab file.

Running the Restore Script Without Disk Growth Using ASMTo run the restore script, enter the following command as root:

# /usr/sbin/optimarestore

To display help, enter -h

1. Execute the following command to stop Optima processes:


2. Execute the following commands to start postgress processes:

# optimacontroller start optima-postgresgl

3. Run the restore script:

# optimarestore

4. Execute the following command to restart Optima processes:


Inventory Importer and ExporterOptima includes an Inventory Exporter/Importer tool to simplify the task of exporting data from an Optima implementation into a database, and importing that data into another Optima implementation.

Note: The Inventory Importer and Exporter scripts cannot be used to migrate from an

older version of Optima to a newer version.

Table 4-4 Optional optimabackup Arguments


-h Prints a help message.

-incremental If set, the database backup will be incremental. If not set, the system will automatically perform a full backup on Sunday (can change the day by redefining OPTIMA_DB_BACKUP_LEVEL0_DAY in /etc/sysconfig/omsPrefs) and an incremental backup on all other days of the week

WESTELL.COM

1-800-377-8766

Page 4-19


Running the Inventory Exporter ScriptTo run the Inventory Exporter script, enter the following command as the optima user:

/usr/sbin/optimainventoryexporter [options] -t export_type -f outputfile

export_type must be one of the following:

alarm

alarmtranslation

all

datasource

eventcategory

eventtype

measurement

measurementcategory

measurementtemplate

ne

neaccess

necategory

negroup

nenote

netype

netypeaccess

protocolsignal

signalcategory

signaldefinition

unit

user

vendor

For export types signaldefinition, signal, signalcategory, and measurement, the exported file will be an XML file (.xml). For export type all, the exported file will be a ZIP folder (.zip), with individual export files included inside the ZIP folder. For all other export types, the exported file will be a comma-separated file (.csv).

outputfile specifies the path and name of the file to be exported.

WESTELL.COM

Page 4-20

1-800-377-8766


Optional arguments, or flags, for the optimainventoryexporter command are explained in Table 4-5.

Table 4-5 Optional optimainventoryexporter Arguments


-n, --parent=NEName For export_type of ne, specifies the parent for which all child NEs will be exported. Invalid for other export types.

-s, --system=systemname For export_type of ne, specifies the system for which all member NEs will be exported. Invalid for other export types.

-d or --doc Produces documentation for the specified export type. Other arguments are ignored. Cannot be used with export_type of all.

-h Displays help and a usage statement for the optimainventoryexporter command.

WESTELL.COM

1-800-377-8766

Page 4-21


Running the Inventory Importer ScriptTo run the Inventory Importer script, enter the following command as the optima user:

/usr/sbin/optimainventoryimporter [options] -t import_type -f importfile

import_type must be one of the following:

alarm

alarmtranslation

datasource

eventcategory

eventtype

measurement

measurementcategory

measurementtemplate

ne

neaccess

necategory

negroup

nenote

netype

netypeaccess

protocol

signal

signalcategory

signaldefinition

unit

user

vendor

For import types signaldefinition, signal, signalcategory, and measurement, the expected file type to import will be XML (.xml). For all other export types, the expected file type to import will be a comma-separated file (.csv).

importfile specifies the path and name of the file to import.

WESTELL.COM

Page 4-22

1-800-377-8766


Optional arguments, or flags, for the optimainventoryimporter command are explained in Table 4-6.

Notes: When importing any NEs, you must stop and restart the faultd server

process by executing the following commands root:

optimacontroller stop oms-faultd

optimacontroller start

When importing System NEs, you must restart server processes in order for these NEs to immediately appear in the Optima GUI. To restart the server, execute the following command as root:


IP address information associated with NEs must be imported separately using the netypeaccess import type.

Editing the IP Address and/or HostnameUse the optimanetworkcheck utility to edit the IP address and/or hostname. See section Using the Optima Network Check Utility on page 4-16 for more information.

Table 4-6 Optional optimainventoryimporter Arguments


-p If you specify this option, Optima will import all valid records in a file, omitting those records that are invalid or are duplicates of existing records. You can then check the log to see which records were not imported, make corrections, and reimport the file.

-o Allows overriding of existing records. Supported only for neaccess, netypeaccess, and measurementtemplate import types.

-d or --doc Produces documentation for the specified import type. Other arguments are ignored.

-h Displays help and a usage statement for the optimainventoryimporter command.

WESTELL.COM

1-800-377-8766

Page 4-23


Administering LicensesBeginning with version 8.10, Optima includes a licensing feature which enforces a maximum number of configured sites. To see how many sites Optima is monitoring versus the maximum number permitted by your license, select System Configuration > System Counts from the Optima GUI. The System Counts dialog box opens, as shown in Figure 4-4.

Figure 4-4 System Counts Dialog Box

If your OMS does not already have a license file, you can obtain one from Westell Customer Support. Customer Support will need the server ID for your OMS in order to generate a license file. To obtain the server ID, execute the following command:

# dmidecode -s system-serial-number

Provide Westell the value output from this command.

Westell will return a Site License file (named license.properties.aes) that can be installed on Optima version 8.10. Do not try to install this license file on an Optima OMS running any version prior to 8.10.

To install the license file:

1. Save the license.properties.aes license file to the following directory location:


2. Restart all processes by executing the following command:


3. Verify the license value by viewing the Site Counts page (System Configuration > System Counts).

Administering PermissionsPermissions in Optima are assigned to user groups. See chapter Configuring Users in the Optima User/Configuration Guide.

WESTELL.COM

Page 4-24

1-800-377-8766


Configuring Email NotificationsTo configure email notifications:

1. As the root user, open the /etc/sysconfig/omsPrefs file for editing by executing the following command:

vi omsPrefs

2. Add lines to the omsPrefs file to describe the SMTP server you would like to use. For example:

export EMAIL_SMTP_HOST="mail.westell.com"

export EMAIL_SMTP_AUTH="false"

export EMAIL_SMTP_USER="[email protected]"

3. In addition to the SMTP settings, add the following lines with a valid email address to receive informational and failure notifications.

export JBOSS_EMAIL_INFO_TO="[email protected]"

export JBOSS_EMAIL_FAILURE_TO="[email protected]"

export JBOSS_EMAIL_FROM_ADDRESS="[email protected]"

export EMAIL_REPLY_ADDRESS=""

4. Execute the following command to save the omsPrefs file and exit the vi editor:

:wq

5. Execute the following command as the root user to configure an encrypted email password:

optimapasswordencrypter

Follow the prompts to select a password to configure.

6. If any of the three JBOSS_EMAIL properties listed in Step 3 above are modified, execute the following command:


7. Execute the following command as the root user:

/usr/sbin/optimacontroller restart

Configuring Notifications for Clears and AcknowledgementsBy default, Optima sends notifications for events in the pending state, but does not send notifications for events transitioning to the cleared or acknowledged state.

To configure Optima to send notifications for clears and acknowledgements, open the following files:

/opt/oms/config/fault/fault.properties

/opt/oms/config/fault/fault.properties.template

WESTELL.COM

1-800-377-8766

Page 4-25


Find the following line of code in each file, and replace false with true:

event.processor.global.enableAckClrReply=false

After you have edited these files, restart all server processes:


Note: This feature does not work for SNMP notifications.

Adjusting Data Retention IntervalsThe /etc/sysconfig/oms file contains three variables that control data retention intervals:

MEASUREMENT_RETENTION_DAYS controls raw performance measurement data (default: 90 days)

DSMEASUREMENT_RETENTION_MONTHS control daily/weekly/monthly measurement summary data (default: 120 months)

EVENT_RETENTION_WEEKS controls event data (default: 26 weeks)

You can adjust these intervals by adding statements to the /etc/sysconfig/omsPrefs file, which will override the default values in the /etc/sysconfig/oms file. Follow these steps:

1. As the optima user, open the /etc/sysconfig/omsPrefs file for editing by executing the following command:

vi omsPrefs

2. Add lines to the omsPrefs file. For example, to change the event retention interval from 26 weeks to 40 weeks, add the line:

export EVENT_RETENTION_WEEKS="40"

3. Execute the following command to save the omsPrefs file and exit the vi editor:

:wq

4. Execute these commands as the optima user to push the revised file to all subsystems:


5. Execute these commands as the root user:


WESTELL.COM

Page 4-26

1-800-377-8766


Adjusting the Memory Limit for ReportsOptima has an internal mechanism for protecting the system from running large reports that exceed the memory allocated for the server. The memory required to run each report is computed based on the following parameters:

number of NEs

number of measurements

duration

measurement type

report type

sample time

aggregation method

If a user attempts to run a report that exceeds the memory limit configured for reports, the user will see the error message Cannot run the report, this report can exceed the system limit. In order to execute the report, the report parameters must be modified, or the memory limit for reports can be reconfigured.

You can reconfigure the memory limit for reports by adjusting the REPORTS_MODULE_MAX_HEAP property, which is stored in the /opt/oms/config/AFrame/report.properties file. To edit the memory limit:

1. As the optima user, open the /opt/oms/config/AFrame/report.properties file for editing by executing the following command:

vi report.properties

2. Edit the report.properties file by changing the value of the property REPORTS_MODULE_MAX_HEAP based on the maximum heap size allocated for the application server. This value must be less than the application server max heap size (the value set for the property SERVER_MAX_HEAP in the /etc/sysconfig/oms file).

3. Execute the following command to save the report.properties file and exit the vi editor:

:wq

4. Restart the server by executing the following command:


WESTELL.COM

1-800-377-8766

Page 4-27

Optima Version 11.3x System Administration GuideOptima Server: Process Monitoring

Process MonitoringOptima includes the following self-monitoring daemons:

Optima Server Monitor

Node Status Poller

Daemon Watcher

Fault Generator

Optima Server MonitorOptima Server Monitor is a daemon dedicated to monitoring server conditions, generating logs, and reporting via the Event List. Events from Optima Server Monitor will appear in the Event List as event category ServerMonitor and event type serverResourceError.

Important: Events generated by Optima Server Monitor are cleared automatically from the Event List when the event-generating condition no longer exists, except for the Process Threads resource. You must clear Process Threads events manually. This may be confusing if you fail to clear these events, as new events from a given process ID may be incorrectly correlated with older events from the same process ID.

Optima Server Monitor events are generated by Dell server components and require Dell service documents to troubleshoot and resolve. Westell Support will assist with troubleshooting; however, final resolution usually requires communication with Dell technical support.

Any customer running Optima on a non-standard server (as identified in System and Hardware Requirements on page 4-4) will not receive Optima Server Monitor events or warnings.

Analog and Discrete ResourcesSome resources (analog) are monitored as to whether their performance levels fall within a normal threshold. These are listed in Table 4-7 on page 4-29. Performance thresholds for these resources can be configured by editing the file servermonitorcfg.xml, located in the directory /opt/optimaservermonitor/config.

Other resources (discrete) are monitored for a failing status according to the Dell OpenManageTM tools. These are listed in Table 4-8 on page 4-29.

Terms in these tables are explained in Table 4-9 on page 4-29.

WESTELL.COM

Page 4-28

1-800-377-8766


Table 4-7 Optima Server Monitor - Monitored Analog Resources

Resource Name

Monitor Interval

Warning Thresholds (min/max)

Failure Thresholds (min/max)

Failure Period For Event (seconds)

Memory 900 none/70 none/80 3600

Disk 3600 none/90 none/100 10800

CPU 3 none/70 none/80 3600

Process Threads

900 none/5000 none/10000 none

Temperatures 3600 8/42 3/47 none

Fans 3600 none/none 2025/none none

Table 4-8 Optima Server Monitor - Monitored Discrete Resources

Resource Name Monitor Interval (seconds)

Battery 3600

Controller 3600

Enclosure 3600

VDisk 3600

Connector 3600

PDisk 3600

Power Supplies 3600

Chassis NICs 3600

Table 4-9 Optima Server Monitor Terms and Descriptions

Term Description

Monitor Interval Specifies (in seconds) how frequently a resource is monitored. For example, a Monitor Interval of 900 means the resource is monitored every 900 seconds (fifteen minutes).

WESTELL.COM

1-800-377-8766

Page 4-29


Configuring Chassis NIC StatusFor the monitored discrete resource Chassis NICs, Optima Server Monitor compares the NIC status with the configured expected connection status and generates an event if a status mismatch is discovered. Each NIC index and its expected status need to be configured in the optimaservermonitor configuration file, located in the directory /etc/sysconfig. An entry for each NIC index should be configured in the format nic_index::expected_status.

A sample /etc/sysconfig/optimaservermonitor configuration is shown below.

CHASSIS_NIC_INDEX::EXPECTED_STATUS

0::Connected

1::Disabled

2::Disabled

3::Disabled

Node Status PollerNode Status Poller (NSP) is an OMS-only daemon that polls via ICMP a list of IP addresses. The IP address list is maintained in the registrar_config.xml file, located in the directory /opt/oms/config/registrar.

Warning Thresholds A monitored value below the minimum warning threshold or above the maximum warning threshold will trigger a warning event in the Optima Event List.

Failure Thresholds A monitored value below the minimum failure threshold or above the maximum failure threshold will trigger a failure event in the Optima Event List.

Failure Period For Event Specifies (in seconds) an amount of time to wait before triggering a failure event. For example, a Failure Period for Event of 3600 means the monitored value must be outside the failure threshold for 3600 seconds (one hour) before a failure event is triggered.

If no Failure Period for Event value is specified, a failure event is triggered immediately when the monitored value is outside the failure threshold.

Table 4-9 Optima Server Monitor Terms and Descriptions (Continued)

Term Description

WESTELL.COM

Page 4-30

1-800-377-8766


By default, this list contains all the DMC servers that have been registered. However, Node Status Poller can poll other critical services such as Oracle RAC nodes or LDAP authentication servers. These network devices can be added via the node_status_poller_config.xml file, located in the directory /opt/oms/config/nodestatuspoller.

When the ICMP state of a monitored device changes, Node Status Poller uses the Fault Generator to generate events of category NodeManager and event type nodeDown, which appear in the Event List in the Optima GUI. The severity for the nodeDown event is Critical when the node is unreachable.

Daemon WatcherDaemon Watcher monitors critical software daemons on the OMS or DMC server. The list of monitored daemons is maintained in the file daemonwatcher.cfg, located in the directory /opt/daemonwatcher/config.

Should any of these critical daemons fail, Daemon Watcher uses the Fault Generator to generate a Warning event of category ProcessManager and event type processFailed, which appears in the Event List in the Optima GUI. Daemon Watcher then repeatedly attempts to restart the failed process. If the failed process cannot be restarted, Daemon Watcher stops trying to restart the process and uses the Fault Generator to generate a Process Failure event of Critical severity.

Once the daemon has been restored to a healthy state, all alarms are cleared.

Fault GeneratorThe Fault Generator daemon performs out-of-band notifications for Optima system events generated by the Node Status Poller, Daemon Watcher, and Optima Server Monitor daemons. When network outages occur, the Fault Generator queues up events to the local disk and forwards them when connectivity is restored.

The Fault Generator daemon is used in conjunction with the command line tool /opt/faultgenerator/bin/faultgenerator. The faultgenerator tool communicates with the Fault Generator daemon to send event notifications. The Fault Generator daemon attempts to notify Optima via HTTP. If HTTP is down, faultgenerator caches the event in /var/opt/faultgenerator/events until HTTP communication is restored.

The faultgenerator tool notifies both the local Fault Generator daemon as well as the local syslog facility. The syslog facility can be configured via /opt/faultgenerator/bin/faultgeneratorenv. By default, the facility is local0.

WESTELL.COM

1-800-377-8766

Page 4-31


Process Monitoring Log FilesLog files for process monitoring include:

/var/log/optimaservermonitor/optimaservermonitor.log

/var/log/oms/nodestatuspoller/oms-nodestatuspoller.log

/var/log/daemonwatcher/daemonwatcher.log

/var/log/faultgenerator/faultgend.log

WESTELL.COM

Page 4-32

1-800-377-8766

APPEN

DIX A

Configuring a Removable Direct AccessStorage Device

This appendix provides information on configuring a removable direct access storage (DAS) device to store off-line Optima backup files.

Note: Westell offers an optional Netgear ReadyNAS Network Access

Storage device for storing backup files. Previous systems have included the Dell PowerVault RD1000 device. Administration instructions for that device are included at the end of this appendix.

Guide to this Appendix(Continues on Next Page)

Installing Red Hat Patch 007

Unmounting the Previous Storage Device

Installing RAIDar Software

Connecting the ReadyNAS 2100

Configuring the ReadyNAS 2100

Configuring Static IP Addresses for the ReadyNAS 2100 and Optima Server

Configuring the iSCSI Mount Point

Mounting the RealNAS 2100 Without Disk Growth

Page A-1

WESTELL.COM

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device:

Mounting the ReadyNAS 2100 with Disk Growth

Configuring a NFS mount point

Dell RD1000 Administration Instructions

WESTELL.COM

Page A-2

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Installing Red Hat Patch 007

Installing Red Hat Patch 007Ensure that Red Hat patch007 is installed on the Optima server if the OMS server was initially loaded with RedHat v.5.1. If you are running a version of Optima prior to v8.1x, you will need to install this Red Hat patchset. Consult Westell Customer Support to obtain this software.

WESTELL.COM

1-800-377-8766

Page A-3

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Unmounting the Previous Storage Device

Unmounting the Previous Storage DeviceIf your Optima server already has been configured to use the Dell RD1000 storage device, unmount it by executing the following command:

umount /u01/backup

Next, remove the /u01/backup entry from the file /etc/fstab.

WESTELL.COM

Page A-4

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Installing RAIDar Software

Installing RAIDar SoftwareThe Netgear ReadyNAS 2100 unit includes a resource CD that contains RAIDar utility software. Insert this resource CD in your Optima server. The ReadyNAS 2100 icon appears and a window open showing the ReadyNAS 2100 files. You need to copy the executable file to the Optima server before it will run.

As the root user, open a Terminal Window on the Optima server by right-clicking the desktop. Execute the following commands:

cd /media/ReadyNAS2100/Linux <tab>

(use autofill with tab due to space in filename)

cp setup_Linux.sh /tmp

cd /tmp

chmod +x setup_Linux.sh

. ./setup_Linux.sh

Some messages appear messages on-screen, then a GUI interface launches to prompt you through the installation. Accept all of the default values to install the RAIDar software. The RAIDar icon should now appear on your desktop.

WESTELL.COM

1-800-377-8766

Page A-5

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Connecting the ReadyNAS 2100

Connecting the ReadyNAS 2100Connect the LAN1 ethernet port on the ReadyNAS unit to the network, then turn on the ReadyNAS unit. By default, the ReadyNAS unit will acquire its initial IP address via DHCP from the network's DHCP server.

Note: In order to configure the ReadyNAS unit for the first time, your network must

have a DHCP server. There is no other means of obtaining an initial IP address for the ReadyNAS unit.

WESTELL.COM

Page A-6

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring the ReadyNAS 2100

Configuring the ReadyNAS 2100Important: After connecting the ReadyNAS 2100, pause 3-5 minutes before starting

the RAIDar software or the ReadyNAS 2100 unit will not be discovered.

Perform the following steps to configure the ReadyNAS 2100 unit:

1. From the console, double-click the RAIDar icon.

OR

Execute the following command to run the RAIDar utility software on the Optima server:

/opt/RAIDar/RAIDar

2. The RAIDar utility scans the network for the ReadyNAS 2100 unit, then launches a dialog that displays device information including the IP address. Click Setup.

3. Log into the wizard using the default username admin and default password netgear1.

4. The NetGear ReadyNAS 2100 setup wizard opens. Verify that the button in the lower-left corner of the setup wizard reads Switch to Advanced Control, as shown in Figure A-1. If the button reads Switch to Wizard Mode, click the button to toggle to wizard mode. Click Next.

Figure A-1 ReadyNAS Setup Wizard

WESTELL.COM

1-800-377-8766

Page A-7

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring the ReadyNAS 2100

5. Enter the appropriate time zone, then enable NTP and enter the NTP server details (if necessary). When finished, click Apply, then click Next.

6. Enter the Alert Contact E-mail addresses. Click Apply, then click Next.

7. Click Next to bypass the next two pages (related to Ethernet 1 and Ethernet 2 configuration).

8. Click Next to bypass the Global Settings page.

9. Enter an administrator password and a password recovery question. (The password can be the same as the default if you wish.) Click Apply, then click Next.

10. Click Next to bypass the Security and User Accounts tabs.

11. Click Next to bypass the Standard File Protocols tab.

12. Click Next to bypass the Installed Add-ons page.

13. Click Next to bypass the Share List page.

14. Click Next to bypass the Add Shares tab.

15. Click Next to bypass the registration page. Initial configuration of the ReadyNAS 2100 unit is now complete.

WESTELL.COM

Page A-8

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring Static IP Addresses for the ReadyNAS 2100 and Optima Server

Configuring Static IP Addresses for the ReadyNAS 2100 and Optima Server

To preserve future accessibility via DHCP, leave the LAN 1 ethernet interface on the ReadyNAS 2100 unit as it is currently configured. You will disconnect this interface after the ReadyNAS 2100 configuration is complete.

For performing backups, you will configure a static IP address for the LAN 2 ethernet interface on the ReadyNAS 2100 unit, then use this IP address to mount the ReadyNAS 2100 unit on the Optima server.

There are two network setups possible to allow the ReadyNAS 2100 to perform backups:

Directly connect the ReadyNAS 2100 to the Optima server. (Westell has tested and recommends this option.)

OR

Connect the ReadyNAS 2100 to the network using a Gigabit Ethernet switch. Connecting via a slower switch will significantly slow down the backup performance of the ReadyNAS 2100.

Before you continue configuring the IPs, you need two values:

1. A static IP address to assign to the LAN 2 Ethernet on the NAS. Westell recommends not using an IP address in the same subnet as the Optima server itself. For this example, we will use 192.168.2.2.

2. A static IP address to assign to the Ethernet port to be used on the Optima server. Depending on the Optima server hardware being used, this port will vary. For this example, we will use Eth1 and assign the address of 192.168.2.1.

Assigning a Static IP to the LAN 2 Ethernet Interface1. Open a browser window and navigate to the following address:

https://NAS_DHCP_ip_address/admin

where NAS_DHCP_ip_address is the address assigned via DHCP to the LAN 1 Ethernet interface on the ReadyNAS 2100.

WESTELL.COM

1-800-377-8766

Page A-9


2. Enter the admin username and password you configured in section Configuring the ReadyNAS 2100 on page A-7. The Netgear administration page opens, as shown in Figure A-2.

Figure A-2 Netgear Advanced Control Page

3. In the navigation pane on the left, select Network > Interfaces.

4. Select the Ethernet 2 tab from the top pane.

5. From the IP assignment list, select Use values below.

6. In the IP address field, enter the static IP address of the ReadyNAS 2100 (for example, 192.168.2.2).

7. In the Netmask field, enter an appropriate netmask value (for example, 255.255.255.0).

8. Click Apply.

9. In the navigation pane on the left, select Network > Global Settings.

WESTELL.COM

Page A-10

1-800-377-8766


10. In the Default gateway address field:

If you are directly connecting the ReadyNAS 2100 to the Optima server, enter the static IP address you will assign to the new Ethernet LAN on the Optima server (for example, 192.168.2.1).

If you are connecting the ReadyNAS 2100 to the network via an ethernet switch, enter an appropriate gateway for the network.

11. Enter the DNS settings.

12. Click Apply.

Configuring a Static Route to the ReadyNAS 2100 on the Optima ServerImportant: These procedures are necessary only if you are directly connecting the

ReadyNAS 2100 to the Optima server. It can be skipped if you are connecting the ReadyNAS 2100 via an Ethernet switch.

Connect the LAN 2 ethernet interface on the ReadyNAS 2100 to an available ethernet interface on the Optima server. The Ethernet interface eth4 is used in the examples below because Westell Optima servers are built to use Eth0-Eth3 in their bonded interface configuration. Replace eth4 with the desired interface on your Optima server.

Assigning a Static IP Address to an Ethernet Interface (Eth4) on the Optima ServerEdit the file /etc/sysconfig/network-scripts/ifcfg-eth4 to assign a static IP address to the eth4 interface on the Optima server and enter an appropriate netmask value. For example:

# Broadcom Corporation NetXtreme II BCM5708 Gigabit Ethernet

DEVICE=eth4

BOOTPROTO=static

DHCPCLASS=

HWADDR=00:30:48:56:A6:2E

IPADDR=STATIC_IP_ADDRESS_OF_OPTIMA (for example, 192.168.2.1)

NETMASK=255.255.255.0

ONBOOT=yes

Assigning a Static Route to the ReadyNAS 2100 on the Optima ServerCreate or edit the file /etc/sysconfig/network-scripts/route-eth4 with the appropriate gateway, netmask, and IP address values. For example:

GATEWAY0=STATIC_IP_ADDRESS_OF_OPTIMA_ETH4 (for example, 192.168.2.1)

NETMASK0=255.255.0.0

WESTELL.COM

1-800-377-8766

Page A-11


ADDRESS0=STATIC_IP_ADDRESS_OF_NAS (for example, 192.168.2.2)

Restarting the NetworkOn the Optima server, execute the following commands to restart the network, apply the settings, and ensure the ReadyNAS 2100 can be reached through the static route:

# service network restart

# ping STATIC_IP_ADDRESS_OF_NAS (for example, 192.168.2.2)

Configuring the iSCSI Target Area on the ReadyNAS 2100For optimal performance, we will mount the ReadyNAS 2100 on the Optima server over an iSCSI interface.

To configure an iSCSI target area on the ReadyNAS 2100:

1. Open a browser window and navigate to the following address:

https://NAS_DHCP_ip_address/admin (for example, 10.48.5.8)

where NAS_DHCP_ip_address is the address assigned via DHCP to the LAN 1 Ethernet interface on the ReadyNAS 2100.

2. Enter the admin username and password you configured in section Configuring the ReadyNAS 2100 on page A-7. The Netgear administration page opens.

3. In the navigation pane on the left, select Network > Volumes.

4. Select Volume Settings.

5. On the iSCSI tab, select Enable iSCSI support.

6. On the iSCSI tab, click Create iSCSI Target.

7. Click Apply.

Important: It will take a few hours for the iSCSI target area to be completely created. You can monitor the status of the ReadyNAS 2100 by running /opt/RAIDar/RAIDar. Wait for the disk lights to stop blinking before you proceed.

Installing Red Hat Patch 007Ensure that Red Hat patch007 is installed on the Optima server. For additional information see Installing Red Hat Patch 007 on page A-3.

Identifying the iSCSI TargetAs root, execute the following commands:

# /etc/init.d/iscsi start (Upon running this command, a response including the text “No records found” is normal.)

WESTELL.COM

Page A-12

1-800-377-8766


# iscsiadm -m discovery -t sendtargets -p STATIC_IP_ADDRESS_OF_NAS (for example, 192.168.2.2)

# /etc/init.d/iscsi restart

Also, ensure the iscsi service is turned on at boot time by executing the following command:

# chkconfig iscsi on

You should now see a block device under /dev (for this example, we are using /dev/sdd) if you execute the following command:

# fdisk -l

Or you can execute the following command:

# tail -f /var/log/messages

An example result is shown below:

Sep 27 09:21:48 optima70 kernel: Vendor: LIO-ORG Model: FILEIO Rev: 3.1

Sep 27 09:21:48 optima70 kernel: Type: Direct-Access ANSI SCSI revision: 05

Sep 27 09:21:48 optima70 kernel: SCSI device sdd : 4194304001 512-byte hdwr sectors (2147484 MB)

Sep 27 09:21:48 optima70 kernel: sdd: Write Protect is off

Sep 27 09:21:48 optima70 kernel: SCSI device sdd: drive cache: write through

Sep 27 09:21:48 optima70 kernel: SCSI device sdd: 4194304001 512-byte hdwr sectors (2147484 MB)

Sep 27 09:21:48 optima70 kernel: sdd: Write Protect is off

Sep 27 09:21:48 optima70 kernel: SCSI device sdd: drive cache: write through

Sep 27 09:21:48 optima70 kernel: sdd: unknown partition table

Sep 27 09:21:48 optima70 kernel: sd 9:0:0:0: Attached scsi disk sdd

Sep 27 09:21:48 optima70 kernel: sd 9:0:0:0: Attached scsi generic sg5 type 0

Sep 27 09:21:48 optima70 iscsid: transport class version 2.0-871. iscsid version 2.0-871

Sep 27 09:21:48 optima70 iscsid: iSCSI daemon with pid=21345 started!

Sep 27 09:21:48 optima70 iscsid: connection1:0 is operational now

Formatting the iSCSI Target AreaAs root, execute the following command:

WESTELL.COM

1-800-377-8766

Page A-13


fdisk /dev/sdd (substituting your assigned device name, such as /dev/sdb1)

The fdisk command prompt displays. Enter m to display the fdisk options. Follow the commands within. For example:

The number of cylinders for this disk is set to 261083.

There is nothing wrong with that, but this is larger than 1024,

and could in certain setups cause problems with:

1) software that runs at boot time (e.g., old versions of LILO)

2) booting and partitioning software from other OSs

(e.g., DOS FDISK, OS/2 FDISK)

Command (m for help): m

Command action

a toggle a bootable flag

b edit bsd disklabel

c toggle the dos compatibility flag

d delete a partition

l list known partition types

m print this menu

n add a new partition

o create a new empty DOS partition table

p print the partition table

q quit without saving changes

s create a new empty Sun disklabel

t change a partition's system id

u change display/entry units

v verify the partition table

w write table to disk and exit

x extra functionality (experts only)

Command (m for help): p

Disk /dev/sdd: 2147.4 GB, 2147483648512 bytes

255 heads, 63 sectors/track, 261083 cylinders

Units = cylinders of 16065 * 512 = 8225280 bytes

Command (m for help): n

WESTELL.COM

Page A-14

1-800-377-8766


Command action

e extended

p primary partition (1-4)

p

Partition number (1-4): 1

First cylinder (1-261083, default 1):

Using default value 1

Last cylinder or +size or +sizeM or +sizeK (1-261083, default 261083):



Disk /dev/sdd: 2147.4 GB, 2147483648512 bytes



Device Boot Start End Blocks Id System

/dev/sdd1 1 261083 976760001 83 Linux

Command (m for help): w

The partition table has been altered!

Calling ioctl() to re-read partition table.

Syncing disks.

Next, create an ext2 filesystem on the partition by executing the following command:

Important: This command can take over 45 minutes to finish executing.

mke2fs -m 0 -O dir_index /dev/sdd1

WESTELL.COM

1-800-377-8766

Page A-15

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring the iSCSI Mount Point

Configuring the iSCSI Mount PointEnsure that /u01/backup is unmounted by executing the following command:

# umount /u01/backup

Finally, execute the following commands to mount the device:

mkdir -p /u01/backup

mount /u01/backup

chown optima:dba /u01/backup

mkdir -p /u01/backup/optima_backup

chown optima:dba /u01/backup/optima_backup

Backups will now begin to go to the new ReadyNAS device automatically. If you had previously set up local backups by creating a OPTIMA_LOCAL_BACKUP entry in /etc/sysconfig/dmiPrefs, you should remove this entry now.

WESTELL.COM

Page A-16

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Mounting the RealNAS 2100 Without Disk Growth

Mounting the RealNAS 2100 Without Disk GrowthAdd the following entry to /etc/fstab:

/dev/sdd1 /u01/backup ext2 _netdev 0 0

To mount, execute:

# mount /u01/backup

The RealNAS 2100 is mounted at /u01/backup and can be verified using the

the df or mount commands.

WESTELL.COM

1-800-377-8766

Page A-17

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Mounting the ReadyNAS 2100 with Disk Growth

Mounting the ReadyNAS 2100 with Disk GrowthUse the multipath map name by device mapper to perform the mount of ReadyNAS2100. After the MD3200 is connected and Dell MDSM software is installed, the scsi devices are using the device mapper (multipathd) to map the devices.

For each map, the kernel will still assign a SCSI device name like: sdb, sdc, … sdg, etc. No longer use the /dev/sgd1 (partition) to mount the ReadNAS2100. Instead use the multipath device maps (names) like <mpathxxp1> to mount the ReadNAS2100.

The device map name can be found from /var/log/messages when iscsid starts (/etc/init.d/iscsi start).

In order to mount the ReadNAS2100, the /etc/fstab needs to have a line like:

/dev/mapper/<mpath1p1>/u01/backup ext2 _netdev 0 0

As root, execute:

# mount /u01/backup

The RealNAS 2100 is mounted and can be verified using the #df and #mount commands.

WESTELL.COM

Page A-18

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring a NFS mount point

Configuring a NFS mount pointFor other NAS devices that require a NFS mount, to avoid compatibility problems with Oracle RMAN that Optima uses for database backup two special mount options are required: nolock and noac. /etc/fstab entry for a NFS mount must look like this:

<nas hostname>:<nas path> /u01/backup nfs user,auto,rw,nolock,noac 0 0

WESTELL.COM

1-800-377-8766

Page A-19

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Dell RD1000 Administration Instructions

Dell RD1000 Administration InstructionsInstructions for the Dell RD1000 storage device (available with Optima versions prior to 8.10) are provided below.

Determining the Device NameFirst, identify the location of the removable drive. Secondary drives (SATA and USB disks) are usually mapped to /dev/sdb.

Internal RD1000 DriveIf your implementation uses an internally-mounted RD1000 drive, perform the following steps to determine the device name:

1. If the RD1000 cartridge is inserted, eject it.

2. Execute the following command:

tail -f /var/log/messages

3. Insert the RD1000 cartridge.

4. Obtain the auto-detected device name from the log file.

External RD1000 DriveIf your implementation uses an external USB RD1000 drive, perform the following steps to determine the device name:


tail -f /var/log/messages

2. Plug in the USB jack and turn on the RD1000 drive.

3. Obtain the auto-detected device name from the log file.

Note: You may see an error message indicating that you are unable to mount the

device because it uses a NTFS filesystem. You can ignore this message for now.

We will assume the removable drive is located at /dev/sdb for the purpose of this appendix.

WESTELL.COM

Page A-20

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Repartitioning the Device

Repartitioning the DeviceBy default, the Dell RD1000 is formatted using a NTFS filesystem. In order to use the Dell RD1000 with RHEL, it must be reformatted to use a ext3 filesystem.

Deleting the Partition and Creating a New Partition 1. As root, execute the following command:

fdisk /dev/sdb

2. The fdisk command prompt displays. Enter m to display the fdisk options:

m

3. Execute the commands as shown below:

The number of cylinders for this disk is set to 121601.

There is nothing wrong with that, but this is larger than 1024,

and could in certain setups cause problems with:

1) software that runs at boot time (e.g., old versions of LILO)

2) booting and partitioning software from other OSs

(e.g., DOS FDISK, OS/2 FDISK)

Command (m for help): m

Command action

a toggle a bootable flag

b edit bsd disklabel

c toggle the dos compatibility flag

d delete a partition

l list known partition types

m print this menu

n add a new partition

o create a new empty DOS partition table

p print the partition table

q quit without saving changes

s create a new empty Sun disklabel

t change a partition's system id

u change display/entry units

v verify the partition table

w write table to disk and exit

x extra functionality (experts only)

WESTELL.COM

1-800-377-8766

Page A-21

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Repartitioning the Device


Disk /dev/sdb: 1000.2 GB, 1000204886016 bytes




/dev/sdb1 1 121601 976760001 7 HPFS/NTFS

Command (m for help): d

Selected partition 1






Command (m for help): n

Command action

e extended

p primary partition (1-4)

p

Partition number (1-4): 1

First cylinder (1-121601, default 1):


Last cylinder or +size or +sizeM or +sizeK (1-121601, default 121601):




WESTELL.COM

Page A-22

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Configuring the Mount Point




/dev/sdb1 1 121601 976760001 83 Linux

Command (m for help): w

The partition table has been altered!

Calling ioctl() to re-read partition table.

Syncing disks.

Formatting the Drive to Use an ext3 FilesystemAs root, execute the following command:

/sbin/mkfs.ext3 /dev/sdb1

Note: This operation may take considerable time. Wait until you see the word done

displayed at the end of the text Writing superblocks and filesystem accounting information:

Configuring the Mount Point Optima backs up data to the location referred by the environment variable $OPTIMA_BACKUP_DEST, defined under /opt/oms/environment.sh. The default location is /u01/backup/optima_backup. The following procedure mounts the removable drive at /u01/backup so backups are written to the proper location.

1. Execute the following command to create the mount point if it does not exist and set permissions:

mkdir -p /u01/backup

2. Execute the following command to move or delete the contents of the directory:

rm -rf /u01/backup/*

3. Add the following line to the /etc/fstab file to include the new mount point:

/dev/sdb1 /u01/backup ext3 user,auto,rw 0 0

4. Execute the following command to mount the device:

mount /u01/backup

5. Enter df to verify the drive has been mounted successfully:

WESTELL.COM

1-800-377-8766

Page A-23

Optima Version 11.3x System Administration GuideConfiguring a Removable Direct Access Storage Device: Ejecting and Reinserting the Removable DAS Cartridge

df


mkdir -p /u01/backup/optima_backup


chown optima:dba /u01/backup/optima_backup

You should see a line in the output that shows that /dev/sdb1 is mounted to /u01/backup.

Ejecting and Reinserting the Removable DAS Cartridge If the Eject button on the drive does not work, execute the following command to remove the DAS cartridge:

eject /dev/sdb1

To move or delete the contents of the backup directory, execute the following command:

rm -rf /u01/backup/*

After inserting the DAS cartridge, if the auto mount does not work, execute the following command:

mount /u01/backup

Tip: Enter df to see if the device is mounted.

WESTELL.COM

Page A-24

1-800-377-8766

APPEN

DIX B

B

Updating Kentrox Remote Devices

This appendix provides information about updating the software for Westell’s Kentrox Remote devices on the Optima network.

Guide to this Appendix

Prerequisites and Assumptions

Upgrading Kentrox Remote Software

Transferring Files to Kentrox Remote

Updating Firmware on Kentrox Remote

Installing Modules on Kentrox Remote Devices

Page B-1

WESTELL.COM

Optima Version 11.3x System Administration GuideUpdating Kentrox Remote Devices: Prerequisites and Assumptions

Prerequisites and AssumptionsNTP service is required for accurate event reporting for both Optima and all Optima-managed Kentrox Remote network elements. In addition, trap queueing must be enabled for any Optima-managed Kentrox Remote network elements.

See the Configuration Guide and Command Reference Guide for your specific Remote device for information about the NTP service and the trap queueing feature.

WESTELL.COM

Page B-2

1-800-377-8766

Optima Version 11.3x System Administration GuideUpdating Kentrox Remote Devices: Upgrading Kentrox Remote Software

Upgrading Kentrox Remote SoftwareTo upgrade Kentrox Remote devices on the network to a new software version, perform the following steps.

1. Use the procedure for Transferring Files to Kentrox Remote on page B-4 to:

Transfer the stage 2 bootloader image file (266B2LXXX.img for Remote and 535B2Lxxx.img for RMX-3200) to all Remote devices.

Transfer the Expand D stage 2 bootloader image file (160B2LXXX.img) to all Remote devices with Expand D peripheral units.

Transfer the RME-B64 stage 2 bootloader image file (681B2LXXX.img) to all Remote devices with RME-B64 peripheral units.

Transfer the RME-S8 stage 2 bootloader image file (670B2LXXX.img) to all Remote devices with RME-S8 peripheral units.

2. Use the procedure for Updating Firmware on Kentrox Remote on page B-7 to:

Load the expansion firmware image file (160DEPXXX.img) on all Remote devices with any kind of peripheral unit(s).

Load the Remote firmware image file (266REMXXX.img for Remote, 544REMxx.img for Remote RMM-1400, 535RMXXXX.img for Remote RMX-3200) on all Remote devices.

Note: The upgrade time can be estimated by the entries in the measurement table.

Upgrade Time = RPMs update time + migration time

RPMs upgrade time is between 30 and 45 minutes. Migration time is dependent on how many measurements are in the database. Estimates are given below:

900 million measurements = 22 hours; 700 million measurements = 16 hours; 1 million measurements = 25 minutes

WESTELL.COM

1-800-377-8766

Page B-3

Optima Version 11.3x System Administration GuideUpdating Kentrox Remote Devices: Transferring Files to Kentrox Remote

Transferring Files to Kentrox RemoteYou can schedule an Update Firmware job to transfer .img and .aii files to network elements, and you can schedule an Install Application Package job to install .pkg files. Optima also includes a Transfer File job type to allow you to transfer files of other types to a network element.

To transfer files to a network element:

1. Select Optima Configuration > Job Configuration. The Job Configuration page opens.

2. Select Add > Transfer File to create a new job.

OR

Select a File Transfer job from the list, then click Clone. If you clone an existing job, all parameters for steps 3 through 9 will be pre-selected. Edit these parameters as desired.

3. The Transfer File dialog box opens (see Figure B-1). In the Job name field, a default name for the job appears. You can replace this value if necessary.

Figure B-1 Transfer File Dialog Box

WESTELL.COM

Page B-4

1-800-377-8766


4. Select a start time for the file transfer under Start time:

If you want to transfer the file to the network element(s) immediately, select the When to start: Immediately option.

If you want to specify a date and time to transfer the file, select the Start at (date/time) option, then enter a start date in the Start date field, or click the

button to open a calendar interface to choose a start date. After you have selected the start date, select a start time from the Start time list.

5. Select one or more files to transfer to the network element(s). If the file you want to transfer does not appear in the list or the list is empty as in Figure B-1, click Upload to search your network for the file and copy it to the Optima server. The File upload dialog box will appear as shown in Figure B-2.

Figure B-2 The File upload dialog box

Click Browse to search for files or destinations. Fill in the File and Destination fields and select the desired Transfer mode (ascii or binary). When complete, click Upload.

Notes: To change the destination directory for the file, click Edit in the Transfer

File dialog box, specify the new destination in the Destination field, and change the Transfer mode if needed.

To remove a file from the list in the Transfer File dialog box, select the file, then click Delete.

6. Click Next. The Destination network element(s) list appears.

7. Click Add to select NEs to receive the file transfer. The Select Network Elements for File dialog box opens as shown in Figure B-3.

WESTELL.COM

1-800-377-8766

Page B-5


Figure B-3 Select Network Elements for File Dialog Box

8. In the Search Options area, select search criteria, then click Search. NEs that match your search criteria display in the list at the bottom of the dialog box. For example, Figure B-3 on page B-6 shows all NEs of type Remote in system North America.

Note: To expand the view of the list of NEs, the user can collapse the Search

Options area by clicking the upward-pointing arrow at upper right or the collapse tool on top of the list of NEs. When the Search Options area is collapsed, both those arrows reverse, and clicking either again restores the view of the Search Options area.

9. Select one or more NEs from the list, then click Select. The Select Network Elements for File dialog box closes and the Transfer File dialog box appears with the Destination Network Elements list, now containing the newly selected NEs.

10. Click Finish. The Transfer File dialog box closes and the job appears in the list on the Job Configuration page.

WESTELL.COM

Page B-6

1-800-377-8766

Optima Version 11.3x System Administration GuideUpdating Kentrox Remote Devices: Updating Firmware on Kentrox Remote

Updating Firmware on Kentrox RemoteThe Update Firmware job simplifies uploading of firmware image files, peripheral image files, and bootloader files (.img and .aii) to NEs. To update firmware on an NE:

1. Select Optima Configuration > Job Configuration. The Job Configuration page opens.

2. Select Add > Update Firmware to create a new job.

OR

Select an Update Firmware job from the list, then click Clone. If you clone an existing job, all parameters for steps 3 through 12 will be pre-selected. Edit these parameters as desired.

3. The initial Update Firmware dialog box opens with controls to set download and reboot start and stop times (see Figure B-4). In the Job name field, a default name for the job appears. You can replace this value if necessary.

Figure B-4 The initial Update Firmware dialog box

4. Set the Download start time, Download end time, Reboot start time, and Reboot end time as follows:

To install the firmware update on the network element(s) immediately, in the Download start time area select When to start: Immediately as shown in Figure B-4.

To specify a date and time to install the firmware update, select the Start at (date/time) option in the Download start time area. In this and all other Start

WESTELL.COM

1-800-377-8766

Page B-7


at and Stop at areas of the Update Firmware dialog box, red outlines and exclamation points prompt the user to the next step. Enter a start date in the Start date field or click the calendar icon to choose a start date from a calendar See Figure B-5. After selecting the start date, the user is prompted to select a start time from the Start time drop-down list.

Figure B-5 Download start time area with Start at (date/time) selected, red outline and prompting the user to set the Start date, and the user poised to open the

calendar date selector

Should Optima be unable to download firmware to one or more network elements, the user can choose a time or interval at which Optima will stop trying. In the Download end time area, the user can specify a duration using the Stop after xxx minutes option. The user also can specify a time to stop trying by selecting the Stop at (date/time) option and following the prompts to enter the Stop date and Stop time.

To have the NE(s) reboot as soon as the firmware update is complete, in the Reboot start time area, select When to start: Immediately as shown in Figure B-4.

To specify a date and time for Optima to reboot the NE, in the Reboot start time area, select the Start at (date/time) option, then follow the prompts to enter the Start date and Start time.

Should Optima be unable to reboot a network element, the user can choose a deadline when Optima will stop trying. In the Reboot end time area, the user can specify a duration using the Stop after xxx minutes option. Or the user can specify a time to stop trying by selecting Stop at (date/time) and following the prompts to set the Stop date and Stop time.

5. Click Next. The Update Firmware dialog box opens with a list of firmware files as shown in Figure B-6. Users may resort the file list and/or conceal or restore columns as needed with controls that appear when the cursor hovers over column headers.

WESTELL.COM

Page B-8

1-800-377-8766


Figure B-6 The Update Firmware dialog box listing firmware images available to upload

6. Select one or more firmware image files to install on the network element(s).

Notes: If the image needed for transfer does not appear in the list, click Upload

to search the network for the image file and copy it to the Optima server.

To remove an image file from the list, select the file by clicking the checkbox at left, then click Delete.

If the user selects image files that are incompatible or otherwise unsuited to be transferred in the same update, a warning exclamation point appears at lower right in the dialog box and the Next button appears grayed out. That remains until the selections are changed to be suitable or compatible.

WESTELL.COM

1-800-377-8766

Page B-9


7. Once an image is selected, the optional Only download if existing version is option appears at the bottom of the images list. This option prevents overwriting a preferred firmware image. The user can select equal to, older or equal to, or older than from the drop-down list and enter a version number in the field provided. See Figure B-7

Figure B-7 Update Firmware dialog box with an image selected, the Only download if existing version is option selected, and the user poised to choose the

desired condition

8. Click Next. The next Update Firmware dialog box appears with the Destination network element(s) list as shown in Figure B-8.

Figure B-8 Update Firmware dialog box to select Destination Network Element(s)

WESTELL.COM

Page B-10

1-800-377-8766


9. Click Add to select NEs to receive the file transfer. The Select Network Elements to Update dialog box opens as shown in Figure B-9.

Figure B-9 Select Network Elements to Update Dialog Box

10. In the Search Options area, select search criteria, then click Search. The Reset button allows the user to start over if needed. NEs that match the selected search criteria display in the list at the bottom of the dialog box. The list will contain only those network elements that can accept all the images selected earlier.

11. Select one or more NEs from the list, then click Select. The Select Network Elements to Update dialog box closes and the Update Firmware dialog box with the Destination network element(s) list reappears, now containing the selected NEs.

12. Click Finish. The New Firmware Job dialog box closes and the job appears in the list on the Job Configuration page.

WESTELL.COM

1-800-377-8766

Page B-11

Optima Version 11.3x System Administration GuideUpdating Kentrox Remote Devices: Installing Modules on Kentrox Remote Devices

Installing Modules on Kentrox Remote DevicesTo install modules on Westell’s Kentrox Remote device:

1. Use sftp/scp to transfer a single Module file or Module bundle into a directory on the OMS.

2. Run the modulemanager install script to install the module on the Optima server. The contents of the module are processed and the Module Specification is stored in /var/opt/dmi/modules. See the section Using the Modulemanager Script.

3. Use the Optima GUI to deploy modules to Remotes.

Using the Modulemanager Script To manage modules on the OMS server:

Examples:

modulemanager -i /tmp/mymodules.mod

# Installs the mymodules.mod file

modulemanager -u /tmp/mymodules.mod

# Updates the mymodules.mod file

modulemanager -e Power

# Uninstalls the Power Module

modulemanager -l

# Lists the currently installed Modules

modulemanager -i /tmp/mymodules.mod -f

# Overrides the currently installed Module

# -f option works only with -i option

modulemanager -i /tmp/mymodules.tgz

# Installs the mymodules.tgz bundle

# Bundle file can be either in *.tgz or *.tar.gz format

Options:

-h, --help

show this help message and exit

-i MODULEFILE, --install=MODULEFILE

install a Module from the specified file

-u MODULEFILE, --update=MODULEFILE

updates a Module from the specified file

WESTELL.COM

Page B-12

1-800-377-8766


-e MODULENAME, --uninstall=MODULENAME

uninstalls the specified Module

-l, --list

lists the currently installed Modules

-f, --force

if a Module is already installed, override the existing installation

WESTELL.COM

1-800-377-8766

Page B-13


WESTELL.COM

Page B-14

1-800-377-8766

APPEN

DIX C

OMS Disaster Recovery

This appendix provides information on replicating the data and configuration from a failed OMS to a second, healthy OMS to restore Optima network operation.


Prerequisites and Assumptions

Recovery Procedure

Page C-1

WESTELL.COM

Optima Version 11.3x System Administration GuideOMS Disaster Recovery: Prerequisites and Assumptions

Prerequisites and AssumptionsThis appendix makes repeated references to two OMS-only servers, OMS1 and OMS2:

OMS1 refers to the primary server that has failed.

OMS2 refers to a second, standby server.

The procedure in this appendix describes how to replicate the data and configuration from OMS1 to OMS2, then implement OMS2 as the primary server.

This procedure assumes that OMS1 and OMS2 are identical, except for their IP addresses:

OMS1 and OMS2 should be physically connected to the same switch, with the same subnet.

OMS1 and OMS2 should have Red Hat installed. During installation, be sure to assign different IP addresses to each server for user access.

The IP address used for the DMC private LAN should be configured on the same interface (eth1) for OMS1 and OMS2. However, on OMS2, the eth1 interface should be ifdown so as not to conflict with OMS1.

OMS1 and OMS2 should have the same exact version and build of the OMS software installed, as described in Performing a Fresh Optima Installation on page 2-2. All of the configuration prompted for during the installation must be exactly the same.

This procedure assumes that a successful backup has been taken on OMS1. This can be verified by running the following command as root:

tree /u01/backup

This should return output similar to the following:

/u01/backup/

‘-- optima_backup

+-- adapters

| +-- adapters-backup.tar.gz

| ‘-- adapters-backup.tar.gz.old

+-- appbackup_full.tar.gz

+-- appbackup_full.tar.gz.old

+-- dbback_rman

+-- C-DBID-DATE-SN

+-- dbbackup.DATE.TIME.*.log

+-- OPTIMA_DATE_*.bus

WESTELL.COM

Page C-2

1-800-377-8766

Optima Version 11.3x System Administration GuideOMS Disaster Recovery: Prerequisites and Assumptions

+-- config_files

+-- NN

+-- dmibackup

| +-- AIdirector.pgdmp

| +-- AIdirector.pgdmp.old

| +-- aidirector.tgz

| +-- aidirector.tgz.old

| +-- alarmtable.pgdmp

| +-- alarmtable.pgdmp.old

| +-- measurement.pgdmp

| `-- measurement.pgdmp.old

`-- import.log

Finally, this procedure assumes that one or more DMC-only servers are configured on OMS1.

WESTELL.COM

1-800-377-8766

Page C-3

Optima Version 11.3x System Administration GuideOMS Disaster Recovery: Recovery Procedure

Recovery Procedure

Note: All commands in this procedure should be executed as the root user.

1. Run the following command on OMS1 to view the network configuration (required to configure the network interface on OMS2 in subsequent steps):

optimanetworkcheck

2. On OMS2, make sure all Optima server processes are stopped by executing the following command:

optimacontroller stop

3. On OMS1, stop all Optima server processes by executing the following command:

optimacontroller stop

4. On OMS1, tar the backup directory and copy it to OMS2 by executing the following commands:

tar -czvf /root/backup.tgz -C /u01 backup

scp /root/backup.tgz OMS2_ip_address:.

Note: The resulting backup.tgz file will be very large.

5. On OMS2, untar the backup directory by executing the following commands:

rm -rf /u01/backup

tar --overwrite -xzvf /root/backup.tgz -p --same-owner -C /u01

6. On OMS1, stop the network service by executing the following command:

/etc/init.d/network stop

Note: This will cut off network access to OMS1. However, this is necessary to

ensure that this damaged OMS server (OMS1) doesn't interfere with the new OMS server (OMS2) or DMC server(s). OMS1 should still be accessible through the console to see if its problems can be debugged.

7. On OMS2, execute the following command to start its DMC private interface:

ifup eth1

8. On OMS2, start the optima-postgresql process by executing the following command:

optimacontroller start optima-postgresql

9. Remove redo log on OMS2:

WESTELL.COM

Page C-4

1-800-377-8766


# rm -f /u01/oradata/optima/redo*.log

10. On OMS2, restore the backup data from OMS1 using the procedure described in section Running the Restore Script Without Disk Growth Using ASM on page 4-19.On OMS2, change the IP address and hostname to match OMS1 by executing the following command:

optimanetworkcheck -S -i OMS1_primary_interface_name -a OMS1_ip_address -n OMS1_short_hostname -g OMS1_gateway_address -m OMS1_netmask -b OMS1_broadcast_address -d OMS1_domain_name

At this point OMS2 should be up and running.

Notes: The OMS1 network configuration from step 1 should be used in this

command.

Run the command optimanetworkcheck -h to see script usage examples.

The hostname option used is just for the short hostname (not to be confused with the full hostname with domain).

11. Check /etc/hosts and remove extra lines of OMS2 configuration if they exist in the file.

12. Because the license restored from OMS1 is not valid on OMS2, a new license needs to be generated for OMS2.

To install the license file:

1. Obtain a license file from Westell, as described in section Administering Licenses on page 4-24.

2. Save the license.properties.aes license file to the following directory location:


13. On OMS2, start all Optima server processes by executing the following command:


OMS1 should be repaired (that is, hardware replaced, probably Red Hat reinstalled, and Optima reinstalled) and set up as the new backup OMS for OMS2, being sure to meet all conditions listed in Prerequisites and Assumptions on page C-2. Then, if OMS2 has a problem, the Recovery Procedure on page C-4 can be followed to replace OMS2 with OMS1.

WESTELL.COM

1-800-377-8766

Page C-5


WESTELL.COM

Page C-6

1-800-377-8766

APPEN

DIX D

D

Dell Remote Access Card (DRAC) Guide

This appendix details the turnup procedure for the Dell Remote Access Card (DRAC) on Dell R900, Dell R710 and Dell 2950 servers on which Optima is to be installed.


Configuring DRAC Network Settings

Accessing the DRAC Web Interface

Configuring DRAC Users

Page D-1

WESTELL.COM

Optima Version 11.3x System Administration GuideDell Remote Access Card (DRAC) Guide: Configuring DRAC Network Settings

Configuring DRAC Network Settings

Note: This document details the DRAC turnup procedure for Dell R900, Dell R710 and Dell 2950 servers on which Optima is to be installed. Note that the screenshots in this document were taken from a Dell 2950. The Dell 2950 and R900 include DRAC version 5, while the Dell R710 includes DRAC version 6. There may be some minor discrepancies in the appearance of DRAC version 5 versus DRAC version 6, but functionality is very similar.

To configure initial network parameters:

1. Reboot the server from the server console.

Figure D-1 Server Reboot

2. When the prompt Press <Ctrl-E> for Remote Access Setup within 5 sec appears (as shown in Figure D-1), press Ctrl+E.

WESTELL.COM

Page D-2

1-800-377-8766


3. The Remote Access Configuration Utility interface appears (see Figure D-2). Use the arrow keys to navigate to the NIC Selection menu item.

Figure D-2 Remote Access Configuration Utility

4. Set the NIC Selection menu item as Dedicated to connect to the DRAC through its own RJ45 connector. This is the default configuration for Optima. This connection requires a second cable and Ethernet switch connection.

WESTELL.COM

1-800-377-8766

Page D-3


5. Use the arrow keys to navigate to the LAN Parameters menu item, then press Enter. A menu of LAN parameters opens (see Figure D-3). Configure the following LAN parameters:

IP Address Source is Static (unless the customer wants to use DHCP, which is unusual).

Ethernet IP Address should be in the same network as the server’s IP address.

Subnet Mask should be the same as the server’s subnet mask.

Specify the appropriate Default Gateway.

Do not configure any other LAN parameters.

Figure D-3 LAN Parameters

WESTELL.COM

Page D-4

1-800-377-8766


6. Press Esc to return to the main menu, then use the arrow keys to navigate to the Advanced LAN Parameters menu item, then press Enter. A menu of advanced LAN parameters opens (see Figure D-4).

Figure D-4 Advanced LAN Parameters

WESTELL.COM

1-800-377-8766

Page D-5


Configure the DNS parameters appropriately for the customer network. If you want to register a name for the RAC with the DNS, you can enable registration by selecting the first line titled Register RAC Name, then create the RAC name by selecting the second line titled Register RAC Name. Selecting the second line opens the Current DNS RAC Name dialog box (see Figure D-5).

Figure D-5 Current DNS RAC Name Dialog Box

7. Press Esc to close the Current DNS RAC Name dialog box.

8. Press Esc again to close the menu of advanced LAN parameters.

WESTELL.COM

Page D-6

1-800-377-8766


9. Press Esc a third time to exit the Remote Access Configuration Utility. A dialog box opens (see Figure D-6).

Figure D-6 Saving Changes and Exiting the RAC Utility

10. Select Save Changes and Exit, then press Enter.

WESTELL.COM

1-800-377-8766

Page D-7

Optima Version 11.3x System Administration GuideDell Remote Access Card (DRAC) Guide: Accessing the DRAC Web Interface

Accessing the DRAC Web InterfaceTo access the DRAC web interface, enter the IP address of the DRAC (that is, the Ethernet IP Address value selected in step 5 of section Configuring DRAC Network Settings on page D-2) in the address bar of your Web browser. This provides you with an HTTPS server that you can access securely.

When you navigate to the IP address of the DRAC, the DRAC login page opens (shown in Figure D-7).

Figure D-7 DRAC Web Interface Login Page

WESTELL.COM

Page D-8

1-800-377-8766

Optima Version 11.3x System Administration GuideDell Remote Access Card (DRAC) Guide: Accessing the DRAC Web Interface

Enter the appropriate username and password to open the DRAC Web Interface (shown in Figure D-8).

Notes: The default username is root. The default password is calvin.

The DRAC uses a self-signed certificate, so you may encounter a harmless certificate error warning unless you add the appropriate certificate to your browser store.

Figure D-8 DRAC Web Interface (System Summary Page)

WESTELL.COM

1-800-377-8766

Page D-9

Optima Version 11.3x System Administration GuideDell Remote Access Card (DRAC) Guide: Configuring DRAC Users

Configuring DRAC UsersTo configure DRAC users:

1. Log into the DRAC Web Interface (as described in section Accessing the DRAC Web Interface on page D-8).

2. Select Remote Access in the directory tree at the left, then select the Configuration tab. The Network Configuration page opens (see Figure D-9).

Figure D-9 DRAC Web Interface (Network Configuration Page)

WESTELL.COM

Page D-10

1-800-377-8766


3. Click the Users link at the top of the Configuration tab. The Users page opens (see Figure D-10).

Figure D-10 DRAC Web Interface (Users Page)

WESTELL.COM

1-800-377-8766

Page D-11


4. The User ID column contains numbered links for each user. Click the link for the root user (2 in the example shown in Figure D-10 on page D-11). The User Main Menu page opens (see Figure D-11).

Figure D-11 DRAC Web Interface (User Main Menu Page)

WESTELL.COM

Page D-12

1-800-377-8766


5. Click Next to open the User Configuration page (see Figure D-12).

Figure D-12 DRAC Web Interface (User Configuration Page)

6. In the User Name field, enter admin.

7. Select the Change Password option.

8. In the New Password and Confirm New Password fields, enter admin.

9. Scroll to the bottom of the User Configuration page, then click Apply Changes.

WESTELL.COM

1-800-377-8766

Page D-13

Optima Version 11.3x System Administration GuideDell Remote Access Card (DRAC) Guide: Configuring DRAC Services

Configuring DRAC ServicesTo configure DRAC services:

1. Log into the DRAC Web Interface (as described in section Accessing the DRAC Web Interface on page D-8).

2. Select Remote Access in the directory tree at the left, then select the Configuration tab. The Network Configuration page opens (see Figure D-9 on page D-10).

3. In the row of links at the top of the Configuration tab, select the Services link.

4. Verify the following settings:

The webserver is enabled (should be the default value)

The timeout is 600 seconds (you may need to change this from the default value of 300)

The http port number is 80 (should be the default -- all http requests are redirected to https)

The https port number is 443 (should be the default value)

SSH is enabled

The SSH timeout is 600 seconds

The SSH port number is 22

Telnet is disabled

Remote RACADM is enabled

The SNMP agent is enabled and its community name is public

5. If you made any changes, scroll to the bottom of the page, then click Apply Changes.

WESTELL.COM

Page D-14

1-800-377-8766

APPEN

DIX E

E

Northbound Interface

This appendix describes the structure and use of the Optima Northbound Interface (NBI) feature.

Note: Use of the NBI is a improvement over SNMP-type

notifications. Customers that do not want two events forwarded for each occurrence will need to disable their SNMP forwarding notifications.


Introduction

SNMP Integration

NBI Integration Using JMS

JMS Message Selectors

Event Object Model

Page E-1

WESTELL.COM

Optima Version 11.3x System Administration GuideNorthbound Interface: Introduction

IntroductionThe Northbound Interface (NBI) feature gives the Optima Management System the ability to integrate with OSS and third-party management applications using industry standard protocols. Optima supports only the integration of the fault management subsystem.

The NBI architecture (shown in Figure E-1) is centered on an enterprise message bus. Fault and performance data is published on the message bus at collection time, and every time the data is modified. All clients that subscribe to the message bus will receive copies of the data. There is a default NBI client which has the ability to forward fault data northbound as SNMP v2c traps.

OMS

NBI JMS Bus

OMS-FAULTD OMS-IMPORTD

Eve

nts

Per

f dat

a

EXTERNAL JMSSUBSCRIBER

SNMP Forwarding

Agent

Eve

nts

Even

ts/P

erf.d

ata

EXTERNAL TRAP

RECEIVER

UD

P

DMI JMS Bus

Eve

nts

Per

f dat

a

WESTELL.COM

Page E-2

1-800-377-8766

Optima Version 11.3x System Administration GuideNorthbound Interface: Introduction

Figure E-1 Optima Northbound Interface Architecture

NBI Integration MethodsThere are two methods you can employ to integrate with Optima using NBI.

The first method requires a third-party client to receive and process events that have been forwarded as traps by the NBI SNMP forwarding agent. This method is described in section SNMP Integration on page E-4.

The second method is to write a client that subscribes to a JMS bus and receives the published data. This method is described in section NBI Integration Using JMS on page E-14.

WESTELL.COM

1-800-377-8766

Page E-3

Optima Version 11.3x System Administration GuideNorthbound Interface: SNMP Integration

SNMP IntegrationThe simplest method to integrate a fault manager with Optima is to receive relevant Optima events that have been converted to SNMP v2c notifications.

To receive only the relevant events, a client can be configured to receive only those events that match a set of filter criteria. If no filter is specified, all events will be forwarded.

It is important to note that an event will be forwarded when it is received by Optima, and will be forwarded again every time it is modified. For example, if an event is acknowledged, cleared, or its severity level changes, that event will be published again in its modified form.

The events generated for process failures or server resource errors do not forward the server's IP address in the Source Component Info field. The source ID is forwarded northbound (for example, OMS or DMCx ) and must be used to determine the source of these types of events. See Optima Server Monitor on page 4-28 for examples of these types of events.

Configuring Optima to Forward Events as SNMP NotificationsThe process responsible for forwarding events NBI is called the Data Notification Broker (DNB). The DNB process runs inside the OMS server. It listens for any change in the data and notifies a configurable number of clients, which act as brokers between Optima and a third party data receiver. Each broker runs in its own thread inside the DNB process.

The snmpForward NBI client receives events from the NBI message bus and converts these events into SNMP notifications (traps). Multiple instances of the snmpForward client can be configured, which means Optima can forward events as SNMP notifications to multiple destinations.

To add a new destination for SNMP notifications, a system administrator must perform the following two steps:

1. Editing the dnb_client.properties File

2. Restarting the DNB Process

WESTELL.COM

Page E-4

1-800-377-8766


Editing the dnb_client.properties FileAs the optima user, change the file /opt/oms/config/dnb/dnb_client.properties as follows.

The dnb_client.properties file has the following structure:

client.event_processor.<proc#>.name=<procname>

client.event_processor.<proc#>.type=[snmpForward|debug]

client.event_processor.<proc#>.filter=<message filter>

client.event_processor.<proc#>.config.<prop1>=<value1>

...

client.event_processor.<proc#>.config.<propN>=<valueN>

Each event processor must have its own unique number. These numbers must start from 1 and be sequential. For example:

client.event_processor.1.name=snmpForwardNOC

client.event_processor.1.type=snmpForward

client.event_processor.1.config.snmpVersion=[1|2c|3]

client.event_processor.1.config.uri=snmp://<IPv4 address1> or <[IPv6 address1]>

client.event_processor.1.config.alarmMsgFilter=”<regular expression>”

client.event_processor.1.config.alarmShortMsgFilter=”<regular expression>”

client.event_processor.1.config.sourceComponentTransformer=s/<regular expression 1>/<regular expression 2>/g

client.event_processor.1.config.filter=<filter>

client.event_processor.2.name=snmpForwardOSS1

client.event_processor.2.type=snmpForward

client.event_processor.2.config.uri=snmp://<IPv4 address2> or <[IPv6 address2]>

client.event_processor.2.config.filter=<filter>

client.event_processor.3.name=dbg

client.event_processor.3.type=debug

The snmpForward uri parameter specifies the SNMP destination and has the following syntax:

snmp://[<trap community string>@]<host>[:<port>]

WESTELL.COM

1-800-377-8766

Page E-5


If the trap community string is not specified, by default it will use the value public. If the port is not specified, 161 will be used by default.

The snmpForward filter parameter is a JMS selector string that sets a condition that uses the JMS message attributes. If the condition is met, then the message will be forwarded to the destination. See section JMS Message Selectors on page E-20 for the syntax and available message attributes.

Restarting the DNB ProcessAs the root user, execute the following command:

# /etc/init.d/oms-dnbd restart

After restarting the dnb process, the SNMP client should be able to receive traps. If it does not, try a full system restart or contact Westell Customer Support.

Decoding the SNMP NotificationThe third-party client must implement an SNMP v2c notification receiver. The notification (trap) receiver will then be able to decode the trap using the MIB file ktxOptimaNorthboundInterface.mib.

The contents of ktxOptimaNorthboundInterface.mib are as follows:

OPTIMA-MIB DEFINITIONS ::= BEGIN

IMPORTS

MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,

IpAddress, Integer32

FROM SNMPv2-SMI

DisplayString

FROM SNMPv2-TC

OBJECT-GROUP, NOTIFICATION-GROUP

FROM SNMPv2-CONF

aii

FROM AIIDEFS-MIB;

ktxOptimaNorthboundInterface MODULE-IDENTITY

LAST-UPDATED "201006071500Z"

ORGANIZATION "Kentrox,Inc."

CONTACT-INFO

" Engineering MIB Administrator

Postal: Kentrox,Inc.

5800 Innovation Drive

Dublin, OH 43016

WESTELL.COM

Page E-6

1-800-377-8766


Tel: 614/798-2000

Fax: 614/798-1770

E-mail: [email protected]"

DESCRIPTION "The MIB module for Optima northbound interface"

REVISION "201006071500Z"

DESCRIPTION "The initial revision of this module."

::= { aii 48 }

ktxNorthBoundTrap OBJECT IDENTIFIER ::= { ktxOptimaNorthboundInterface 0 }

ktxNorthBoundEventTrap NOTIFICATION-TYPE

OBJECTS { ktxNorthBoundEventID,

ktxNorthBoundEventCreationTime,

ktxNorthBoundEventSourceComponent,

ktxNorthBoundEventSourceComponentIpAddress,

ktxNorthBoundEventSeverity,

ktxNorthBoundEventStatus,

ktxNorthBoundEventShortMsg,

ktxNorthBoundEventMsg,

ktxNorthBoundEventClass,

ktxNorthBoundEventType,

ktxNorthBoundRepeatCount,

ktxNorthBoundAckBy,

ktxNorthBoundClrBy,

ktxNorthBoundEventLastChangedTime }

STATUS current

DESCRIPTION "Generic Optima Event Trap"

::= { ktxNorthBoundTrap 1 }

EventSeverityEnum ::= INTEGER { unknown(-1), ok(0), information(10), harmless(20), warning(30) , minor(40) , major(50), critical(60) }

EventStatusEnum ::= INTEGER { pending(-2) , acknowledged(-1), cleared(0) }

EventClassEnum ::= INTEGER { alarm(1) , alert(2) , rualert(3) , callfailure(4) , dropcall(5) , outage(6) , internalmalfunction(7) , heartbeat(8) }

ktxNorthBoundEvent OBJECT IDENTIFIER ::= { ktxOptimaNorthboundInterface 1 }

ktxOptimaNorthboundInterfaceObjectGroup OBJECT-GROUP

OBJECTS { ktxNorthBoundEventID,

ktxNorthBoundEventCreationTime,

ktxNorthBoundEventSourceComponent,

ktxNorthBoundEventSourceComponentIpAddress,

WESTELL.COM

1-800-377-8766

Page E-7


ktxNorthBoundEventSeverity,

ktxNorthBoundEventStatus,

ktxNorthBoundEventShortMsg,

ktxNorthBoundEventMsg,

ktxNorthBoundEventClass,

ktxNorthBoundEventType,

ktxNorthBoundRepeatCount,

ktxNorthBoundAckBy,

ktxNorthBoundClrBy,

ktxNorthBoundEventLastChangedTime }

STATUS current

DESCRIPTION

"Collection of objects providing information specific to the events forwarded northbound"

::= { ktxOptimaNorthboundInterface 2 }

ktxOptimaNorthboundInterfaceNotificationGroup NOTIFICATION-GROUP

NOTIFICATIONS { ktxNorthBoundEventTrap }

STATUS current

DESCRIPTION

"The notification which indicate the arrival of a new event or a change in an existing event"

::= { ktxOptimaNorthboundInterface 3}

ktxNorthBoundEventID OBJECT-TYPE

SYNTAX DisplayString

MAX-ACCESS read-only

STATUS current

DESCRIPTION "This is the unique identifier of the event. It contains an unsigned value up to 38 digits in length"

::= { ktxNorthBoundEvent 1 }

ktxNorthBoundEventSeverity OBJECT-TYPE

SYNTAX EventSeverityEnum


STATUS current

DESCRIPTION "The event severity. See EventSeverityEnum"


ktxNorthBoundEventStatus OBJECT-TYPE

SYNTAX EventStatusEnum


STATUS current

DESCRIPTION "The event status. See EventStatusEnum"

WESTELL.COM

Page E-8

1-800-377-8766



ktxNorthBoundEventMsg OBJECT-TYPE



STATUS current

DESCRIPTION "This is the event message encoded in UTF-8 character set. This field can be up to 4000 characters in length"


ktxNorthBoundEventShortMsg OBJECT-TYPE



STATUS current

DESCRIPTION "The abbreviated event message. It is up to 1024 characters in length"


ktxNorthBoundEventCreationTime OBJECT-TYPE



STATUS current

DESCRIPTION "The creation time of the event by the network element recorded with network element's clock "


ktxNorthBoundEventSourceComponent OBJECT-TYPE



STATUS current

DESCRIPTION "This is the network element that is the source of the event"


ktxNorthBoundEventSourceComponentIpAddress OBJECT-TYPE

SYNTAX IpAddress


STATUS current

DESCRIPTION

"This is the IP address of the source component if applicable"


ktxNorthBoundEventClass OBJECT-TYPE

SYNTAX EventClassEnum


STATUS current

WESTELL.COM

1-800-377-8766

Page E-9


DESCRIPTION "The class where the event belongs to. See EventClassEnum"


ktxNorthBoundEventType OBJECT-TYPE



STATUS current

DESCRIPTION "The event type is a name identifying a specific problem/situation. Ex: GenRun , PortDown"


ktxNorthBoundRepeatCount OBJECT-TYPE

SYNTAX Integer32 (1..99999)


STATUS current

DESCRIPTION "The repeat count indicates the number of duplicate events received"


ktxNorthBoundAckBy OBJECT-TYPE



STATUS current

DESCRIPTION "The user that acknowledged the event if applicable"


ktxNorthBoundClrBy OBJECT-TYPE



STATUS current

DESCRIPTION "The user that cleared the event if applicable"


ktxNorthBoundEventLastChangedTime OBJECT-TYPE



STATUS current

DESCRIPTION "The last time when the event has been changed/modified. Time is recording using OMS' clock.

For a new event this field will contain the time of the event reception by the OMS"


WESTELL.COM

Page E-10

1-800-377-8766


END

The ktxOptimaNorthboundInterface.mib file includes aiidefs.mib. The contents of aiidefs.mib are as follows:

AIIDEFS-MIB DEFINITIONS ::= BEGIN

IMPORTS

MODULE-IDENTITY, enterprises

FROM SNMPv2-SMI;

aii MODULE-IDENTITY

LAST-UPDATED "200205161400Z"

ORGANIZATION "Applied Innovation Inc."

CONTACT-INFO

" Engineering MIB Administrator

Postal: Applied Innovation Inc.

5800 Innovation Drive

Dublin, OH 43016-3271

Tel: 614/798-2000

Fax: 614/798-1770

E-mail: [email protected]"

DESCRIPTION

"MIB module for top level AI module."

REVISION "200205161400Z"

DESCRIPTION "The initial revision of this module."

::= { enterprises 539 }

-- Module definitions

-- aiProxy { aii 1 }

-- aiSystemOID { aii 2 }

-- aiHub { aii 3 }

-- aiGroup { aii 4 }

-- aiISISGre { aii 5 }

-- aiManager { aii 6 }

-- aiSoftware { aii 7 }

-- aiSystem { aii 8 }

-- aiCLC { aii 9 }

-- aiSLC { aii 10 }

WESTELL.COM

1-800-377-8766

Page E-11


-- aiSLC1 { aii 11 }

-- aiX1 { aii 12 }

-- obsolete { aii 13 }

-- aiTX1 { aii 14 }

-- aiTTL1 { aii 15 }

-- aiSLC2 { aii 16 }

-- aiEts { aii 17 }

-- aiLpt { aii 18 }

-- aiGasp { aii 19 }

-- aiSpy { aii 20 }

-- aiSLCSysCfg { aii 21 }

-- aiSLCAlias { aii 22 }

-- aiSLCAsync { aii 23 }

-- aiSLCDiscrete { aii 24 }

-- aiPPP { aii 25 }

-- aiTL1SNMP { aii 26 }

-- aiHubport { aii 27 }

-- aiOSITun { aii 28 }

-- aiDot1dBridge { aii 30 }

-- aiPortVlan { aii 29 }

-- aiEtherPort { aii 31 }

-- aiSysCfg { aii 32 }

-- aiLuxConnect { aii 33 }

-- aiSLCAnalog { aii 34 }

-- aiGuardian { aii 35 }

-- aiDialout { aii 36 }

-- aiPortSecurity { aii 37 }

-- aiTidtoMux { aii 38 }

-- aiRosetta { aii 39 }

-- aiEmulatedDevice {aii 40 }

-- aiPeripheral { aii 41 }

-- aiMediation { aii 42 }

-- aiRFMonitor { aii 43 }

-- aiScriptApps { aii 44 }

-- aiPolledMediationFramework { aii 45 }

END

The maximum size of ktxNorthBoundEventType, ktxNorthBoundSourceComponent, ktxNorthBoundAckBy and ktxNorthBoundClrBy is 128 characters.

WESTELL.COM

Page E-12

1-800-377-8766


The format of ktxNorthBoundEventCreationTime and ktxNorthBoundEventLastChangedTime is as follows:

yyyy-MM-dd HH:mm:ss.SSS

Where:

yyyy = four-digit year

MM = two-digit month

dd = two-digit day

HH = two-digit hour in a day (00-23)

mm = two-digit minute in hour (00-59)

ss = two-digit second in minute (00-59)

SSS = three-digit millisecond in second ( 000 – 999 )

ktxNorthBoundEventSourceComponentIpAddress is populated only if the NE is IP-capable. For example, this field will be populated for a Kentrox Remote NE, but not for a Site NE.

WESTELL.COM

1-800-377-8766

Page E-13

Optima Version 11.3x System Administration GuideNorthbound Interface: NBI Integration Using JMS

NBI Integration Using JMSThe other method of integrating with NBI is to receive event information using a persistent or non-persistent JMS connection. All JMS clients will receive a copy of the events in near-real time. A JMS selector can be used to receive only the relevant information.

Optima NBI JMS is implemented using Apache ActiveMQ v5.3.0. The binaries client can be downloaded from the following URL:

http://activemq.apache.org/activemq-530-release.html

The JMS broker listens on port 6118 of the OMS. The fault data is published on the topic fault.cbe.

Events are sent as javax.jms.ObjectMessage objects. Each such message contains as a payload an org.eclipse.hyades.logging.events.cbe.CommonBaseEvent .CommonBaseEvent object ( v1.0.1).

The Common Base Event model is a standard that defines a common representation of events intended for use by enterprise management and business applications. Developed by IBM, it is now part of the Eclipse Test and Performance Tools Platform (TPTP). For more information, visit the following URL:

http://www.eclipse.org/tptp/platform/documents/resources/cbe101spec/CommonBaseEvent_SituationData_V1.0.1.pdf

A persistent (durable) JMS connection is a connection where the JMS server will retain messages if a subscriber is temporary unavailable. The client can temporarily disconnect or be unavailable during a maintenance window, and all events that the NBI publishes during that time will be delivered after the subscriber resumes operation.

Subscribing to NBI JMS ConnectionThe following is an example of code used to create a durable subscription to NBI JMS:

package com.kentrox.optima.dnb.client;

import javax.jms.Connection;

import javax.jms.JMSException;

import javax.jms.Message;

import javax.jms.MessageListener;

import javax.jms.ObjectMessage;

import javax.jms.Session;

import javax.jms.Topic;

import javax.jms.TopicSubscriber;

WESTELL.COM

Page E-14

1-800-377-8766


import junit.framework.TestCase;

import org.apache.activemq.ActiveMQConnectionFactory;

import org.eclipse.hyades.logging.events.cbe.CommonBaseEvent;

import org.eclipse.hyades.logging.events.cbe.util.EventFormatter;

public class NBISubscriberTest extends TestCase

{

private final String messageBrokerUrl = "tcp://<<OMS IPv4>>:6118";

private final String messageTopicName = "fault.cbe";

private final int ackMode = Session.AUTO_ACKNOWLEDGE;

private final boolean transacted = false;

private final String clientID = "NBI";

private final String jmsSelector = "eventClass='Alarm'"; // will only subscribe to alarms

public void testSubscribe() throws JMSException, InterruptedException

{

ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(messageBrokerUrl);

Connection connection;

connection = connectionFactory.createConnection();

connection.setClientID(clientID);

Session session = connection.createSession(transacted, ackMode);

Topic topic = session.createTopic(messageTopicName);

TopicSubscriber consumer = session.createDurableSubscriber(topic , "OSS_Subscriber_1" , jmsSelector ,false );

consumer.setMessageListener(new MessageListener() {

@Override

public void onMessage(Message msg) {

try {

CommonBaseEvent cbe = (CommonBaseEvent) (( ObjectMessage) msg).getObject();

System.out.println( EventFormatter.toCanonicalXMLDocString(cbe));

} catch (JMSException e) {

e.printStackTrace();

}

}

});

connection.start();

WESTELL.COM

1-800-377-8766

Page E-15


Thread.sleep(Long.MAX_VALUE);

}

}

Extracting Relevant Information from CBEsThe CommonBaseEvent object that is received will contain the following fields populated:

Table E-1 Standard CBE Fields

Name Type Description

creationTime DateTime creation time of the event recorded with source NE’s clock

Msg String(4000) The event message (description)

severity Integer 0: Unknown

10: Information MUST be used for cases when the event contains only general information and is not reporting an error.

20: Harmless MUST be used for cases in which the error event has no effect on the normal operation of the resource.

30: Warning MUST be used when it is appropriate to let the user decide if an action is needed in response to the event.

40: Minor MUST be used to indicate that action is needed but the situation is not serious at this time.

50: Major MUST be used to indicate that an immediate action is needed and the scope is broad (perhaps an imminent outage to a critical resource will result).

60: Critical MUST be used to indicate that an error occurred, but it is too late to take remedial action.

sourceComponent String(128) The network element name

sourceComponentId Situation See CBE spec

WESTELL.COM

Page E-16

1-800-377-8766


Table E-2 CBE Attributes


accuser String(128) Optional. Contains the name of the user that acknowledged the event

correlationKey String(256) String used in correlation between events

clrUser String(128) Optional. Contains the name of the user that cleared the event

currentStatus String(12) Allowable values are: "Pending" , "Acknowledged" and "Cleared"

eventClass String Allowable values are: ”Alarm” , “Alert” , “RUAlert” , “Call Failure” , “Drop Call” , “Outage” , “Internal Malfunction” , “Heartbeat”

Type String(128) The event type

firstReceivedTime java.util.Date The time when the event was first received. Recorded with OMS' clock

hashCode String(256) String used to identify duplicate events. There can only be one active event with a particular hashCode. The other will be considered duplicates and repeatCount will be increased.

lastChangedTime java.util.Date The time when the event was last modified. Recorded with OMS' clock

lastReceivedTime java.util.Date The time when a duplicate of the event was last received. Recorded with OMS' clock

originalText String(4000) The original event as it was collected . Device specific

pkID String(38) The event database identifier

repeatCount String(5) The number of duplicates of this events received. 1 means the first event

shortMsg String(1024) The abbreviated version of the event msg

sourceComponentIDInfo String(256) If the NE is IP capable, and IP address will be populated int this field

WESTELL.COM

1-800-377-8766

Page E-17


Tip: To extract an attribute from a CBE, use the getExtendedDataElements() method.

The following is an example of a CBE received from NBI and converted to XML:

<CommonBaseEvent creationTime="2010-11-13T21:31:13.000Z" msg="Humidity Low 0.09 RelHum" severity="50" version="1.0.1">

<extendedDataElements name="pkID" type="string">

<values>430060</values>

</extendedDataElements>

<extendedDataElements name="firstReceivedTime" type="dateTime">

<values>2010-11-13T21:31:14.000Z</values>


<extendedDataElements name="lastReceivedTime" type="dateTime">

<values>2010-11-13T21:31:14.000Z</values>


<extendedDataElements name="lastChangedTime" type="dateTime">

<values>2010-11-13T21:33:30.486Z</values>


<extendedDataElements name="eventClass" type="string">

<values>Alarm</values>


<extendedDataElements name="correlationKey" type="string">

<values>alarmEvent552192.168.105.80Humidity</values>


<extendedDataElements name="hashCode" type="string">

<values>alarmEvent552192.168.105.80Humidity</values>


<extendedDataElements name="shortMsg" type="string">

<values>Humidity Low 0.09 RelHum</values>


<extendedDataElements name="type" type="string">

<values>Humidity</values>


<extendedDataElements name="sourceComponent" type="string">

<values>youshe_gprs_10.39.64.80_vpn</values>


<extendedDataElements name="sourceComponentIDInfo" type="string">

<values>192.168.105.80</values>


<extendedDataElements name="repeatCount" type="string">

<values>0</values>

systemID String(128) The system where sourceComponent belongs

Table E-2 CBE Attributes (Continued)


WESTELL.COM

Page E-18

1-800-377-8766



<extendedDataElements name="originalText" type="string">

<values>Humidity Low 0.09 RelHum</values>


<extendedDataElements name="currentStatus" type="string">

<values>Cleared</values>


<extendedDataElements name="clrUser" type="string">

<values>network</values>


<extendedDataElements name="clearTime" type="dateTime">

<values>2010-11-13T21:33:29.000Z</values>


<sourceComponentId location="OMS" locationType="SystemName"/>

<situation>

</situation>

</CommonBaseEvent>

WESTELL.COM

1-800-377-8766

Page E-19

Optima Version 11.3x System Administration GuideNorthbound Interface: JMS Message Selectors

JMS Message SelectorsA JMS message selector is a string that contains an expression. The syntax of the expression is based on a subset of the SQL92 conditional expression syntax. The message selector in the example selects any event that has an eventClass message property that is set to the value 'Alarm' or 'Outage':

eventClass = 'Alarm' OR eventClass = 'Outage'

A JMS selector can use only message properties in the expression. The following message attributes are available to be used in an expression:

Example JMS SelectorsThe following JMS selector will forward only alarms that have type processfailed:

eventType = 'Alarm.processfailed'

The following JMS selector will forward only Major events from the Power category:

eventSeverity=50 and eventCategory_Power=true

If no event selector is specified, the client will receive all events.

Table E-3 Message Attributes


eventCategory_<CategoryName> Boolean Examples: eventCategory_Power , eventCategory_HVAC

eventClass String(10) Same as eventClass field of the CBE

eventSeverity int Same as eventSeverity field of the CBE

eventType String(128) eventType prefixed by event class. Example: Alarm.GenRun

WESTELL.COM

Page E-20

1-800-377-8766

Optima Version 11.3x System Administration GuideNorthbound Interface: Event Object Model

Event Object ModelAn Optima event belongs to a type. There is a many-many association between types and categories; that is, a type can be part of many categories, and a category can be associated to many types. Also, an Optima event belongs to an event class.

Event types, classes and categories are useful for classifying and filtering events. The event types and categories are specific to the type of Optima deployment.

Figure E-2 Optima Event Object Model

0..1the Even t

0.. 1type

0..*typ es 0.. 1

eventClass

0. .*the Type s

0..*the Categor ies

Event Type

++

+++

na medispl ayNam e

classNa meclassDi sp layNa meclassVa lue

: java.lan g.Strin g: java.lan g.Strin g

: java.lan g.Strin g: java.lan g.Strin g: int

Event

+++++++

+++++++

+++

so urce Compo nentIDIn foso urce SubCom ponen tIDInforeport erComp onent IDInfocrea tionTim epriorit ymsgsh ortMsg

repea tCountso urce Sequen ceNu mberfirstRece ive dTimelastRece ive dTimeackTimeclea rTimelastChang edTime

correlatio nKeyhashCodeorigin alText

: ja va.l ang.Stri ng: ja va.l ang.Stri ng: ja va.l ang.Stri ng: ja va.u til.Date: in t: ja va.l ang.Stri ng: ja va.l ang.Stri ng

: in t: ja va.l ang.Stri ng: ja va.u til.Date: ja va.u til.Date: ja va.u til.Date: ja va.u til.Date: ja va.u til.Date

: ja va.l ang.Stri ng: ja va.l ang.Stri ng: ja va.l ang.Stri ng

EventClass

+++

namedisplayNamevalu e

: ja va. lang.String(12 8): ja va. lang.String(12 8): in t

Even tCateg ory

++

nam edescriptio n

: java .lang .String(1 28): java .lang .String(1 28)

WESTELL.COM

1-800-377-8766

Page E-21

Optima Version 11.3x System Administration GuideNorthbound Interface: Event Object Model

WESTELL.COM

Page E-22

1-800-377-8766

APPEN

DIX F

F

Red Hat Installation Tasks

This appendix provides information on installing Red Hat, increasing swap space, and installing service packs to improve the performance of your Optima server.


Installing Red Hat

Increasing Red Hat Linux Swap Space

Installing a Service Pack

Page F-1

WESTELL.COM

Optima Version 11.3x System Administration GuideRed Hat Installation Tasks: Installing Red Hat

Installing Red Hat1. Power up the server and insert Red Hat disk #1 into the server’s CD/DVD drive

immediately after power-up.

2. From the Red Hat installation screen, press Enter to run Red Hat setup in graphical mode.

3. You are prompted about testing the Red Hat disks. Use arrow keys to select Skip, then press Enter.

4. The Welcome screen displays. Click Next.

5. For language selection, ensure English is highlighted, then click Next.

6. For keyboard configuration, ensure US English is highlighted, then click Next.

7. You are prompted to enter the Red Hat Installation Number. Select Skip, then click OK.

8. Another prompt appears to confirm that you want to skip entering the Red Hat Installation Number. Click Skip.

9. Another screen appears if this is not the initial OS install. Make desired selection and click Next.

10. If the server appears as if there is already an operating system installed in the hard drive, perform the following steps (if necessary):

a. A Warning prompt may appear that says Partition table on device sda was unreadable….Would you like to initialize this drive, erasing ALL DATA? Click Yes.

b. If there is an OS already installed, the server may ask you if you want to overwrite the existing operating system. Choose Yes.

11. The next screen says Installation requires partitioning… Perform the following steps:

a. Click the up/down arrow and select Remove all partitions on selected drives and create default layout from the list.

b. Make sure the checkbox for sda is selected.

c. Review the partition size by selecting the Review or Modify check box, then click Next.

d. You will get a warning that says You have chosen to remove all partitions (ALL DATA). Click Yes.

e. Select LogVol00 (data) and click Edit.

WESTELL.COM

Page F-2

1-800-377-8766


f. Select LogVol00 and click Edit. The original size is approximately 852,008MB. Change the value to 821232, then click OK.

g. Select LogVol01 and click Edit. Change the size of LogVol01 to 32000, then click OK.

h. Select LogVol00 and click Edit. Increase the size to equal the value under the field Max size is xxxMB. Change value to be equal to xxx, then click OK.

Note: You may need to adjust these values to set LogVol01 to be 32GB and

LogVol00 to include whatever space is left over, so that the Free Space is 0%. When you have accomplished this, click OK, then click Next.

i. You are prompted about installing the GRUB boot loader. Accept the defaults and click Next.

12. On the Network Devices screen, make sure eth0 is checked. Highlight eth0 (if it is not already highlighted), then click Edit to the right.

13. The Edit interface dialog opens. Perform the following steps:

a. Select the Manual Configuration option.

b. Set the IP Address and Netmask for interface eth0 to the values specified by the Optima System Customer-Specified Parameters form.

c. Configure interface eth1 with IP address 192.168.1.1/255.255.255.0 if you are installing Red Hat on an OMS. If you are installing Red Hat on a DMC server, configure interface eth1 with IP address 192.168.1.2/255.255.255.0.

d. Deselect the Enable IPv6 support checkbox.

e. Click OK.

14. The Edit interface dialog closes. Back on the main screen, under Hostname, set the hostname to the value specified by the Optima System Customer-Specified Parameters form.

15. Under Miscellaneous Settings:

a. Set the Gateway to the value specified by the Optima System Customer-Specified Parameters form.

b. Set the DNS server to the value specified by the Optima System Customer-Specified Parameters form.

c. Click Next.

16. An Error With Data message appears if the DNS entries are blank. Click Continue.

WESTELL.COM

1-800-377-8766

Page F-3


17. On the next screen, select the appropriate timezone. Uncheck the System clock uses UTC option, then click Next.

18. On the Root Password screen, enter and confirm the root password to the value specified by the Optima System Customer-Specified Parameters form. If no customer-specified parameter is available, enter and confirm optima for the root password. Click Next.

19. On the next screen:

a. Select the Software Development and Web Server checkboxes.

b. Select the Customize Now option.

c. Click Next.

20. On the next screen:

a. In the left pane, click Servers.

b. In the right pane, scroll down and select the checkbox for PostgreSQL Database.

c. Click the Optional Packages button.

21. On the Packages in PostgreSQL Database screen:

a. Select the checkbox for postgresql-jdbc.

b. Scroll down and select the checkbox for postgresql-server (if it is not already selected).

c. Click Close to return to the main screen.

22. In the main screen:

a. In the left pane, click Base System.

b. In the right pane, select the System Tools checkbox.

c. Click Optional Packages.

23. On the Packages in System Tools screen:

a. Scroll down and select the checkbox for net-snmp-libs (if it is not already selected).

b. Select the checkbox for net-snmp-utils.

c. Deselect the checkbox for openldap-clients.

d. Click Close to return to the main screen.

24. In the main screen, click Next.

WESTELL.COM

Page F-4

1-800-377-8766


25. The message Checking dependencies... appears. On the next screen, click Next.

26. The Required Install Media dialog appears. Click Continue.

27. Remove and insert Red Hat disks as prompted by the installation program. When prompted, remove the final disk from the drive, then click Reboot.

28. The server reboots and displays a Welcome screen. Click Forward.

29. The License Agreement screen appears. Select Yes, then click Forward.

30. On the Firewall screen, use the up/down arrows to select Disabled from the list, then click Forward. A Warning dialog appears. Click Yes.

31. On the SELinux screen, use the up/down arrows to select Disabled from the list, then click Forward. A Warning dialog appears. Click Yes.

32. On the Kdump screen, make sure the Enable Kdump option is not selected, then click Forward.

33. On the Date & Time screen, set the appropriate data and timezone. If possible, set up NTP using the following steps:

a. On the Network Time Protocol tab, select Enable Network Time Protocol.

b. Click Add under NTP Servers and enter the customer-provided IP address.

c. Click Forward. A message appears, indicating that the server is checking to see if the NTP server is accessible.

Click Forward.

34. On the Set Up Software Updates screen, select No, then click Forward. A warning dialog appears. Click No Thanks.

35. On the Finish Updates Setup screen, click Forward.

36. On the Create User screen, click Forward. A warning dialog appears. Click Continue.

37. On the Sound Card screen, click Forward.

38. On the Additional CDs screen, click Finish.

39. A dialog appears asking if you want to reboot. Click OK.

40. The server reboots and displays a login screen. Enter the username root and the password you specified in step 17.

Correcting Red Hat Install Program Corruption of /etc/hosts1. Right-click on the desktop, then select Open Terminal.

WESTELL.COM

1-800-377-8766

Page F-5


2. On the terminal, enter cat /etc/hosts. Your hosts file should look like this:

# Do not remove the following line, or various programs

# that require network functionality will fail.

127.0.0.1 optima80 localhost.localdomain localhost

::1 localhost6.localdomain6 localhost6

Use gedit or vi to edit the hosts file to display your IP and hostname. The hosts file will then look like the following example:

# Do not remove the following line, or various programs

# that require network functionality will fail.

127.0.0.1 localhost.localdomain localhost

10.1.2.3 optima80.aiinet.com optima80

Tip: To use gedit, enter gedit /etc/hosts on the terminal. gedit is a simple text editor similar to Windows Notepad.

Installing Red Hat PatchesInstall Red Hat patches using the procedure described in section Installing a Service Pack on page F-9. Check to see which service packs are currently installed, then install newer packs sequentially. The procedure Installing a Service Pack on page F-9 must be executed once for every service pack you need to install.

WESTELL.COM

Page F-6

1-800-377-8766

Optima Version 11.3x System Administration GuideRed Hat Installation Tasks: Increasing Red Hat Linux Swap Space

Increasing Red Hat Linux Swap SpaceImportant: This procedure is necessary only if you are upgrading from an Optima

7.1x implementation.

This section explains how to increase the swap space for an Optima server from 2GB to 32GB. For the purposes of this document, the following is assumed:

LogVol00 is the logical volume for the root partition

LogVol01 is the logical volume for the swap partition

The root partition is 270G

The swap partition is 2G

CAUTION: This is a delicate process, and if done incorrectly may ruin your OS install. If you have any questions or uncertainty, contact Westell Technical Support.

To increase swap space:

1. Insert the RHEL5 Disc 1 CD.

2. Reboot the Dell Server.

3. Press F11 during BIOS setup to access the boot menu.

4. Select Optical Device or IDE CD-ROM Device from the boot menu.

5. At the RHEL5 boot prompt, execute the following command:

linux rescue

6. Select OK on the Choose Language page.

7. Select OK on the Keyboard Type page.

8. Select No on the Setup Networking page.

9. Select Skip on the Rescue page.

10. Wait for the server to boot completely in rescue mode. You will be presented with a sh-3.1# prompt.


lvm lvdisplay

Write down the size of LogVol00 (Size00, most likely 270G) and LogVol01 (Size01, most likely 2G)

12. Execute the following command to make the logical volumes available:

lvm vgchange -a y

WESTELL.COM

1-800-377-8766

Page F-7

Optima Version 11.3x System Administration GuideRed Hat Installation Tasks: Increasing Red Hat Linux Swap Space

13. Execute the following command to check the filesystem on the disk:

e2fsck -f /dev/VolGroup00/LogVol00

Note: The -f flag forces a check even if the filesystem seems clean.

14. Execute the following command to reduce the filesize on the logical volume, freeing up 30G:

resize2fs /dev/VolGroup00/LogVol00 240G

Note: This process can take several minutes to complete.

15. Execute the following command to complete the resizing of the logical volume:

lvm lvreduce -L -30G /dev/VolGroup00/LogVol00

Enter y when the confirmation is displayed.

16. Execute the following command to add the freed 30G to the swap volume:

lvm lvresize /dev/VolGroup00/LogVol01 -L +30G

17. Execute the following command to verify partition sizes:

lvm lvdisplay

18. Execute the following command to format the swap volume for the disk space:

mkswap /dev/VolGroup00/LogVol01

19. Remove the CD.

20. Execute the command exit or press Ctrl+D to reboot the server from the hard drive.

21. Upon successful bootup, ensure your new swap size is correct by executing the following command:

cat /proc/swaps

WESTELL.COM

Page F-8

1-800-377-8766

Optima Version 11.3x System Administration GuideRed Hat Installation Tasks: Installing a Service Pack

Installing a Service PackTo install an Optima service pack:

1. Execute the following command to create the directory /tmp/servicepack on the server:

mkdir -p /tmp/servicepack

2. If necessary, execute the following command to copy the optimapkginstaller.sh file from the distribution media:

cp /DIRECTORY_PATH/optimapkginstaller.sh /tmp/servicepack

3. As root, execute the following command to install the service pack:

/tmp/servicepack/optimapkginstaller.sh PATH_TO_SERVICE_PACK

4. The number of packages to be updated displays. Enter y when you are prompted on whether to continue with the installation (see example below):

100 packages to be updated

Do you wish to update the packages? (y/n) y

5. Execute the following command to see the list of all service packs installed on the machine thus far:

/tmp/servicepack/optimapkginstaller.sh -list

This lists all the service packs installed on the machine in the order of their installation.

Note: This procedure must be repeated for each service pack to be installed.

WESTELL.COM

1-800-377-8766

Page F-9

Optima Version 11.3x System Administration GuideRed Hat Installation Tasks: Installing a Service Pack

WESTELL.COM

Page F-10

1-800-377-8766

APPEN

DIX G

G

Importer and Exporter File Formats

This appendix explains the proper formats for optimainventoryimporter and optimainventoryexporter files.


Export File Format

Import File Format

CSV File Columns

XML Import/Export Types

Page G-1

WESTELL.COM

Optima Version 11.3x System Administration GuideImporter and Exporter File Formats: Export File Format

Export File FormatFiles exported by the optimainventoryexporter script are formatted according to the guidelines in RFC 4140 (see http://www.faqs.org/rfcs/rfc4140.html).

The following rules further define the format for exported files:

1. The first line of the exported file must begin with a pound sign and the date/time that the export was started.

2. The second line of the exported file is the column headers.

3. All other lines will be comma separated value lines.

4. All lines must be ended with cr and lf characters

5. All lines with the first non-whitespace character as a pound sign must be ignored.

6. Multivalue columns must be enclosed in quotation marks.

7. Fields with commas embedded must be enclosed in quotation marks.

WESTELL.COM

Page G-2

1-800-377-8766

Optima Version 11.3x System Administration GuideImporter and Exporter File Formats: Import File Format

Import File FormatFiles imported by the optimainventoryimporter script should be formatted according to the following rules:

1. All lines that are empty, contain only white space, or have a pound sign as the first non-whitespace character will be ignored and considered a comment line.

2. The first non-comment line must be a column header row.

3. All other non-comment lines will be imported lines.

4. All special characters must be escaped (this includes Line Feeds, New Lines & Escape characters):

Commas will be allowed in the value of the column.

Backslash characters must be escaped by double backslash characters.

All multivalue columns (columns that may have a one-to-many relationship with the import type) must be enclosed in quotation marks, and commas will delimit the included values.

5. A line can be terminated by either \n or \r\n.

Tip: When creating an import file, it is suggested that you export a file of the desired type (for example, ne, alarm, etc.) to serve as a template rather than attempting to create an import file from scratch. This will allow you to begin from a properly formatted file.

WESTELL.COM

1-800-377-8766

Page G-3

Optima Version 11.3x System Administration GuideImporter and Exporter File Formats: CSV File Columns

CSV File ColumnsYou can view a list of .csv data fields expected in an import or export file by executing one of the following commands as the optima user:

/usr/sbin/optimainventoryimporter -t import_type -d

or

/usr/sbin/optimainventoryexporter -t export_type -d

For a list of all possible import types and export types, see section Inventory Importer and Exporter on page 4-19.

Formats for some commonly-used individual data types are provided in the tables below.

Note: Effective with Optima Version 11.20, Release is no longer among the .csv file

import or export data types.

necategory

ne

Note: For NEs of type System, the system name, connect point and parent name

columns will be empty.

Table G-1 .csv File Columns - necategory Data Type

Description Format Required UniqueCSV Column Name

Display name text Y N Display Name

NE category name text Y Y Name

Proc name text N N Proc Name

Resource type text enum [Not Specified, Resource, Process, Service]

N N Resource Type

WESTELL.COM

Page G-4

1-800-377-8766


Table G-2 .csv File Columns - ne Data Type


NE name text Y Y NE Name

NE type name text, foreign key validated against existing NE Type Names

Y N NE Type

System name text, foreign key validated against existing NE Type Names

Y N System Name

Fault name text Y Y Fault Name

Config name text Y Y Config Name

Performance name text Y Y Performance Name

Status enum [Active, Discovered, Passive, Deleted]

Y N Status

Parent NE name text, foreign key validated against existing NE names

Y N Parent NE

[True, False]True if inheriting parent facility. The NE facility will be ignored if this is true

text Y N InheritFacility

Latitude float with numeric bounds Y N Latitude

Longitude float with numeric bounds Y N Longitude

Admin contact text, foreign key validated against existing user names

N N Admin Contact

Emergency contact text, foreign key validated against existing user names

N N Emergency Contact

Facility name text N N Facility Name

WESTELL.COM

1-800-377-8766

Page G-5


Power company name

text N N Power company name

Power company phone number

text N N Power company phone

Power company account number

text N N Power company account

Site access info text N N Site access info

Address1 text N N Address1

Address2 text N N Address2

City text N N City

State text, validated against current state list

N N State

Postal code text N N Postal Code

County text N N County

Country text, validated against current country list

N N Country

Location time zone text, UTC offset Y N Location time zone

Comma separated pairs

text, comma separated list key value pairs delineated by equal signs

N N Custom attribute key-value pairs

Table G-2 .csv File Columns - ne Data Type (Continued)


WESTELL.COM

Page G-6

1-800-377-8766


neaccess

Table G-3 .csv File Columns - neaccess Data Type


NE name text Y Y NE Name

IP address text Y N IP Address

Connectivity username

text N N User name

Connectivity password

text, encrypted password N N Password

Connectivity read community string

text N N Read community

Connectivity write community string

text N N Write community

Connectivity SNMP timeout

long N N Timeout

Connectivity SNMP retries

integer N N Retries

Connectivity SNMP version

enum [v1, v2c, v3] N N Version

Protocol name text, foreign key validated against existing protocol names

N N Protocol Name

Protocol access NE name

text, foreign key validated against existing NE names in the same system

N N Access NE Name

Protocol port integer N N Protocol Port

SNMP V3 security name

text N N Security Name

SNMP V3 security level [noauth, auth, auth+priv]

text N N Security Level

WESTELL.COM

1-800-377-8766

Page G-7


netype

SNMP V3 authentication protocol [MD5, SHA-1]

text N N Authentication Protocol

Encrypted SNMP V3 authentication password

text N N Authentication Password

SNMP V3 privacy protocol [AES-128, DES-CBC]

text N N Privacy Protocol

Encrypted SNMP V3 privacy password

text N N Privacy Password

Table G-3 .csv File Columns - neaccess Data Type (Continued)


Table G-4 .csv File Columns - netype Data Type


NE type name text Y Y Name

NE type description text N N Name

NE type vendor text, foreign key validated against existing vendors

Y N Vendor

NE type category text, foreign key validated against existing NE categories

Y N ne category

Proc name text Y N Proc Name

WESTELL.COM

Page G-8

1-800-377-8766


netypeaccess

Note: Multiple protocols can be represented by a comma-separated list containing

the protocol name, protocol port and default port values.

Table G-5 .csv File Columns - netypeaccess Data Type


NE type name text Y Y NE Type Name

IP capable boolean Y N IP Capable

Connectivity read community string

text N N Read community

Connectivity write community string

text N N Write community

Connectivity SNMP timeout

long N N Timeout

Connectivity SNMP retries

integer N N Retries

Connectivity SNMP version

enum [v1, v2c, v3] N N Version

Protocol name text, foreign key validated against existing protocol names

N N Protocol Name

Protocol port integer N N Protocol port

Default port boolean N N isDefault

SNMP V3 security name

text N N Security Name

SNMP V3 security level [noauth, auth, auth+priv]

text N N Security Level

WESTELL.COM

1-800-377-8766

Page G-9


user

SNMP V3 authentication protocol [MD5, SHA-1]

text N N Authentication Protocol

Encrypted SNMP V3 authentication password

text N N Authentication Password

SNMP V3 privacy protocol [AES-128, DES-CBC]

text N N Privacy Protocol

Encrypted SNMP V3 privacy password

text N N Privacy Password

Table G-5 .csv File Columns - netypeaccess Data Type (Continued)


Table G-6 .csv File Columns - user Data Type


User name text (letters, numbers, no spaces)

Y Y User Name

First name text Y N First Name

Last name text Y N Last Name

User group text, foreign key validated against existing user groups

Y N User Group

Password text, clear text password Y N Password

Number of contacts integer Y N Num Contacts

WESTELL.COM

Page G-10

1-800-377-8766


protocol

alarm

alarmtranslation

Comma separated Key-Value pairs for the Contact Type and the Contact Value corresponding to 'Num Contacts'

text Y N Contact Information...

Comma separated list of systems the user has access to

text, comma separated list of system names which are foreign key validated against existing system names

N N Access Systems...

Table G-6 .csv File Columns - user Data Type (Continued)


Table G-7 .csv File Columns - protocol Data Type


Protocol name text Y Y Name

Protocol port number

numeric (with bounds of 1 to 65535)

Y Y Port Number

Table G-8 .csv File Columns - alarm Data Type


Alarm name text Y Y Name

WESTELL.COM

1-800-377-8766

Page G-11


measurementtemplate

Table G-9 .csv File Columns - alarmtranslation Data Type


Input NE name text, foreign key validated against existing NE name

Y N Input NE Name

Output NE name text, foreign key validated against existing NE name

Y N Output NE Name

IP address of input NE name

text, foreign key validated against existing NE IPs

Y N Input NE IP Address

Input alarm name text, foreign key validated against existing alarm names

Y N Input Alarm Name

Output alarm name text, foreign key validated against existing alarm names

Y N Output Alarm Name

Alarm category (as configured on the device)

text Y N Alarm Category

Alarm NE name (as configured on the device)

text Y N Alarm NE name

Table G-10 .csv File Columns - measurementtemplate Data Type


Measurement name text Y N Name

Formula text Y N Formula

Description text N N Description

Sample time in milliseconds

integer N N Default sample time

Type enum [measurement, event count, event duration, aggregated measurement]

Y N Type

WESTELL.COM

Page G-12

1-800-377-8766


signaldefinition

Time aggregation enum [sum, average, dynamic, maximum, minimum]

Y N Time Aggregation

NE aggregation enum [sum, average, dynamic, maximum, minimum]

Y N NE Aggregation

Persist enum [yes, no] Y N Persist

Unit of measurement

text Y N Unit of measurement

Data source type text N N Data Source

Network element type

text, foreign key validated against existing NE type names

Y N NE Type

Optional low band measurement threshold value

float/number N N LowBand

Optional high band measurement threshold value

float/number N N HighBand

Optional comma-separated list of categories

text N N Measurement Categories...

Table G-10 .csv File Columns - measurementtemplate Data Type (Continued)


Table G-11 .csv File Columns - signaldefinition Data Type


Signal definition name

text Y N Signal Name

Signal definition type

enum [discrete, analog, alarm table, calculation]

Y N Signal Type

WESTELL.COM

1-800-377-8766

Page G-13


Signal definition category

text Y N Signal Category Name


Table G-11 .csv File Columns - signaldefinition Data Type (Continued) (Continued)


WESTELL.COM

Page G-14

1-800-377-8766


signalcategory

measurement

Table G-12 .csv File Columns - signalcategory Data Type


Category name text Y Y Signal Category


Table G-13 .csv File Columns - measurement Data Type


Measurement type text Y Y Measurement Type

Proxy element name

text Y N Proxy Element Name

Virtual element name

text Y N Virtual Element Name

Originator text Y N Originator

Collection interval text Y N Collection Interval

Template name text Y N Template Name

Number of attributes text Y N Number Attributes

Attributes text, comma-separated key-value pairs of attributes

N N Attribute

Signal definition names

text, comma-separated list of signal definition names

N N Signal Definition Name

WESTELL.COM

1-800-377-8766

Page G-15

Optima Version 11.3x System Administration GuideImporter and Exporter File Formats: XML Import/Export Types

XML Import/Export TypesThere are six XML-based XML: import /export types:

signal

signal definition

signal category

measurement

NEGroup

NENote

You can view the XML schema and sample XML for a data type in an import or export file by executing one of the following commands as the optima user:

/usr/sbin/optimainventoryimporter -t import_type -d

or

/usr/sbin/optimainventoryexporter -t export_type -d

For a list of all possible import types and export types, see section Inventory Importer and Exporter on page 4-19.

WESTELL.COM

Page G-16

1-800-377-8766

APPEN

DIX H

H

Configuring LDAP User Authentication

This appendix explains how to manage user authentication via Lightweight Directory Access Protocol (LDAP).


Configuring LDAP User Authentication

Creating the Initial User Account (Bootstrapping)

Authenticating Via a Simple User Bind

Authenticating Via an Administration User Bind

Authenticating Users with MS Active Directory

Configuring Optima for LDAP Failover

Authenticating Against LDAP Over SSL

Page H-1

WESTELL.COM

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Configuring LDAP User Authentication

Configuring LDAP User AuthenticationBy default, Optima manages its own user accounts and passwords. As an alternative, you can manage user authentication via LDAP on an external LDAP server from the OMS server.

Optima supports two different authentication methods for user authentication with LDAP: Authenticating Via a Simple User Bind on page H-4 and Authenticating Via an Administration User Bind on page H-6. See these sections for more information on each method.

To configure Optima to use LDAP authentication:

1. As the root user, stop the OMS:


2. Switch to the optima user:

su - optima

3. Edit the /opt/oms/config/common/optimaSecurityProvider.properties file as follows:

Change the value of OPTIMA_MANAGED_PASSWORDS property to false.

Edit the value of the providerClass property to either org.jboss.security.auth.spi.LdapLoginModule (if you choose Authenticating Via a Simple User Bind on page H-4) or org.jboss.security.auth.spi.LdapExtLoginModule (if you choose Authenticating Via an Administration User Bind on page H-6). By default, this property is set to org.jboss.security.auth.spi.LdapExtLoginModule.

Depending on the authentication method you choose, copy the appropriate login configuration text to /opt/oms/config/common/login-config.properties. This text is provided in sections Authenticating Via a Simple User Bind on page H-4 and Authenticating Via an Administration User Bind on page H-6.

To configure Optima to “fall back to” or use local user authentication if the LDAP server is not reachable, change the value of the optima.security.provider.failoverToLocalPasswords property to true.

4. As the root user, start the OMS:


WESTELL.COM

Page H-2

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Creating the Initial User Account (Bootstrapping)

Creating the Initial User Account (Bootstrapping)When using LDAP authentication, a user will be able to log in to Optima only if the username and password can be authenticated against the LDAP database and the user account associated with the username is defined in the Optima server. If the username is not defined in the Optima server, the user will not be allowed to log in to Optima. For this reason, a special procedure is required to create an initial user account. This initial user account can then be used to define other user accounts.

To create an initial user account, execute the defineAdminUser.ksh script located in the /opt/oms/bin/ folder. This script creates a user account without a password and defines the user as a member of the SystemAdmin user group. This user will then be able to log in to Optima (assuming that the user can authenticate against the LDAP server).

The syntax for using this script is as follows:

defineAdminUser username firstname lastname

For example, executing

defineAdminUser ldapadmin LDAP Administrator

creates an administrator user with the username ldapadmin in the Optima database. This user’s first name is set as LDAP and last name as Administrator.

WESTELL.COM

1-800-377-8766

Page H-3

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Via a Simple User Bind

Authenticating Via a Simple User BindWith this method, the user authentication is very straightforward. A user distinguished name, or UserDN, is created by adding principalDNPrefix and principalDNSuffix values to the user’s Optima username:

UserDN = principalDNPrefix + username + principalDNSuffix

These principalDNPrefix and principalDNSuffix values are sourced from the login-config file as described below.

After the Optima username is converted to a UserDN, a bind to the LDAP server takes place using this UserDN and the password entered at the Optima login prompt.

The following configuration changes are required in Optima to use the simple user bind authentication method:

Configure security provider properties. The providerClass property in /opt/oms/config/common/optimaSecurityProvider.properties should be set to org.jboss.security.auth.spi.LdapLoginModule.

Configure login properties. Copy the following text to /opt/oms/config/common/login-config.properties :

# JNDI properties

java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory

# Ldap server URL. Port is implied based on protocol.

# 0Default port for SSL is 636 and for normal connection it is 389

java.naming.provider.url=ldaps://10.0.19.25:636/

# The authentication mechanism to be used. This can be one of the following:

# none - Use no authentication (anonymous)

# simple - Use weak authentication (clear-text password)

# <sasl_mech> - Name of an SASL authentication system

# supported by the LDAP server

java.naming.security.authentication=simple

# A prefix and suffix to add to the username when forming the

# user distinguished name. This is useful if you prompt a user for a username

# and you don't want them to have to enter the fully distinguished name.

# Using this property and principalDNSuffix the userDN will be formed as:

WESTELL.COM

Page H-4

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Via a Simple User Bind

# String userDN = principalDNPrefix + username + principalDNSuffix;

principalDNPrefix=uid=

principalDNSuffix=,o=people,dc=company,dc=com

# The fixed DN of the context to search for user roles. Consider that

# this is not the Distinguished Name of where the actual roles are; rather,

# this is the DN of where the objects containing the user roles are

# (e.g. for active directory, this is the DN where the user account is)

rolesCtxDN=o=people,dc=kentrox,dc=com

# The name of the attribute that in the object containing the user roles that corresponds to the userid. This is used to locate the user roles.

uidAttributeID=userid

# The name of the attribute that contains the role name

roleAttributeID=cn=

WESTELL.COM

1-800-377-8766

Page H-5

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Via an Administration User Bind

Authenticating Via an Administration User BindWith this method, a SystemAdmin user binds to the LDAP server using the bindDN and bindCredential values (configured in the login-config file) and performs a query. This query is used to determine the UserDN for the username provided at the Optima login prompt. Once the UserDN is found, another bind takes place with the found UserDN and the password entered at the login prompt.

The following configuration changes are required in Optima to use this authentication method:

Configure security provider properties. The providerClass property in /opt/oms/config/common/optimaSecurityProvider.properties should be set to org.jboss.security.auth.spi.LdapExtLoginModule.

Configure login properties. Copy the following text to /opt/oms/config/common/login-config.properties :

# JNDI Properties


# Ldap server URL. Port is implied based on protocol.

# Default port for SSL is 636 and for regular connection it is 389








# The DN used to bind against the ldap server for the user and

# roles queries. This is some DN with read/search permissions

# on the baseCtxDN and rolesCtxDN values.

bindDN=cn=ldapadmin,dc=company,dc=com

# The password for the bindDN. This can be encrypted

# if the jaasSecurityDomain is specified.

bindCredential=password

# The fixed DN of the context to start the user search from.

baseCtxDN=o=people,dc=company,dc=com

# A search filter used to locate the context of the user to authenticate.

WESTELL.COM

Page H-6

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Via an Administration User Bind

# The input username/userDN as obtained from the login module callback

# will be substituted into the filter anywhere a "{0}" expression is seen.

# This substitution behavior comes from the standard DirContext.search(

# Name,String, Object{FOOTNOTE DEF },SearchControls cons) method.

# An common example search filter is "(uid)".=

baseFilter=(uid={0})





rolesCtxDN=o=people,dc=company,dc=com

# A search filter used to locate the roles associated with the

# authenticated user.The input username/userDN as obtained from the

# login module callback will be substituted into the filter anywhere

# a "{0}" expression is seen. The authenticated userDN will be substituted into

# the filter anywhere a "{1}" is seen. An example search filter that matches

# on the input username is: "(member={0})". An alternative that matches

# on the authenticated userDN is: "(member={1})".

roleFilter=(member={1})

WESTELL.COM

1-800-377-8766

Page H-7

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Users with MS Active Directory

Authenticating Users with MS Active DirectoryAs a special case of Authenticating Via an Administration User Bind on page H-6, you can authenticate Optima users with Active Directory on Microsoft Windows Server 2003. To do this, copy the following text to /opt/oms/config/common/login-config.properties:

#Sample login-config for authentication with Active Directory over SSL

#using the authentication method B (i.e. Administration user bind)

#JNDI properties


# Active Directory URL. Port is implied based on protocol.

# Default port for SSL is 636 and for regular connection it is 389








# The DN used to bind against the ldap server for the user and

# roles queries. This is some DN with read/search permissions

# on the baseCtxDN and rolesCtxDN values.

bindDN=cn=kentrox1,cn=Users,dc=kentroxtest,dc=com

# The password for the bindDN. This can be encrypted if the jaasSecurityDomain is specified.

bindCredential=password

# baseCtxDN : The fixed DN of the context to start the user search from.

baseCtxDN=cn=Users,dc=kentroxtest,dc=com

# A search filter used to locate the context of the user to authenticate.

# The input username/userDN as obtained from the login module callback

# will be substituted into the filter anywhere a "{0}" expression is seen.

WESTELL.COM

Page H-8

1-800-377-8766


# This substitution behavior comes from the standard DirContext.search(

# Name, String, Object{FOOTNOTE DEF }, SearchControls cons) method.

# A common example search filter is "(uid=)".

baseFilter=(sAMAccountName={0})





rolesCtxDN=cn=Users,dc=kentroxtest,dc=com

# A search filter used to locate the roles associated with the

# authenticated user. The input username/userDN as obtained from the

# login module callback will be substituted into the filter anywhere

# a "{0}" expression is seen. The authenticated userDN will be substituted into

# the filter anywhere a "{1}" is seen. An example search filter that matches

# on the input username is: "(member={0})". An alternative that matches

# on the authenticated userDN is: "(member={1})".

roleFilter=(sAMAccountName={0})

# A flag indicating whether the user's role attribute contains the

# fully distinguished name of a role object, or the users's role attribute

# contains the role name. If false, the role name is taken from the value of

# the user's role attribute. If true, the role attribute represents the

# distinguished name of a role object. The role name is taken from the

# value of the `roleNameAttributeId` attribute of the corresponding object.

# In Microsoft Active Directory, role (group) attributes in the user object are

WESTELL.COM

1-800-377-8766

Page H-9


# stored as DNs to role objects instead of as simple names, in which case, this

# property should be set to true. The default value of this property is false.

roleAttributeIsDN=true

# The name of the attribute of the role object which corresponds

# to the name of the role. If the `roleAttributeIsDN` property is set to true,

# this property is used to find the role object's name attribute.

# If the `roleAttributeIsDN` property is set to false, this property is ignored.

roleNameAttributeID=cn

# How deep the role search will go below a given matching context.

# Disable with 0, which is the default.

roleRecursion=-1

# Sets the search scope to one of the strings. The default is SUBTREE_SCOPE.

# OBJECT_SCOPE : only search the named roles context.

# ONELEVEL_SCOPE : search directly under the named roles context.

# SUBTREE_SCOPE : If the roles context is not a DirContext, search

# only the object. If the roles context is a DirContext, search the

# subtree rooted at the named object, including the named object itself.

searchScope=ONELEVEL_SCOPE

WESTELL.COM

Page H-10

1-800-377-8766

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Configuring Optima for LDAP Failover

Configuring Optima for LDAP Failover LDAP failover can be set up Using LDAP DNS Aliases or Using Designated LDAP Servers. In case of SSL connections, all the LDAP server's certificates should be in the keystore directory.

Using LDAP DNS AliasesWhen using LDAP DNS aliases, both the primary and secondary LDAP servers will have the same DNS alias configured. The DNS alias is re-directed to a secondary LDAP server whenever the primary LDAP server becomes unavailable. In this scenario, identifying the switchover is outside the scope of Optima functionality and use of aliases depends on the network and CA infrastructure.

To support LDAP failover through DNS aliases in Optima, DNS aliases needed to be configured using the URL of the LDAP server instead of the hostname or IP addresses in the login configuration file. The value of the property java.naming.provider.url in /opt/oms/config/common/login-config.properties should be configured in the following format:

java.naming.provider.url=ldaps://LDAP_Server_DNS_Alias:LDAP-Port/

For example:

java.naming.provider.url=ldaps://ktxengldap.ai.aiinet.com:636/

configures ktxengldap.ai.aiinet.com as the DNS alias for primary and secondary LDAP servers.

Note: Changes to the configuration file /opt/oms/config/common/login-

config.properties do not require restarting any process/service.

Using Designated LDAP ServersWhen using designated servers, specific primary and secondary LDAP servers should be available to support LDAP failover. In this scenario, the application detects the failure of the primary server and switches to a secondary server. A space-separated list of LDAP server URLs needs to be configured in Optima to support this. The value of the property java.naming.provider.url in /opt/oms/config/common/login-config.properties should be configured in the following format:

java.naming.provider.url=ldaps://Primary_Server_IP/Hostname:Port ldaps://Secondary_Server_IP/Hostname:Port

For example:

java.naming.provider.url=ldaps://10.34.3.220:636/ ldaps://10.0.19.25:636/

configures 10.34.3.220 as the IP of primary LDAP server and 10.0.19.25 as the IP of the secondary LDAP server.

WESTELL.COM

1-800-377-8766

Page H-11

Optima Version 11.3x System Administration GuideConfiguring LDAP User Authentication: Authenticating Against LDAP Over SSL

Authenticating Against LDAP Over SSL Optima supports authentication of users against LDAP over SSL and validates the SSL connection. To configure Optima to authenticate against LDAP over SSL:

enable this in Optima, on the OMS server

1. As the root user, stop the OMS:


2. Switch to the optima user:

su - optima

3. Edit the /opt/oms/config/common/login-config.properties file as follows. Make sure that ldaps is used and the SSL port is specified in the LDAP server URL for the value of the property java.naming.provider.url. It should be configured in following format:

java.naming.provider.url=ldaps://LDAP_Server_IP:SSL_Port/

For example: java.naming.provider.url=ldaps://10.0.19.25:636/

Note: Steps 4, 5, and 6 set up LDAP authentication and verify that your server is

identified properly.

4. Generate a new keystore or update the existing keystore using the following command:

${JAVA_HOME}/bin/keytool -import -file <servercertificate[.der|.pem]> -keystore keystore_file_path

Enter a password and declare it as a trusted certificate. For example:

${JAVA_HOME}/bin/keytool -import -file server.pem -keystore /opt/oms/config/keystore/ldapcerts.jks

5. Copy the generated/updated keystore file to /opt/oms/config/keystore.

6. Configure keystore details. Set the properties javax.net.ssl.trustStore, javax.net.ssl.trustStoreType and javax.net.ssl.trustStorePassword under the Properties section in /opt/oms/config/jboss/properties-service.xml. These properties should be configured in following format:

<attribute name="Properties">

javax.net.ssl.trustStore=Keystore_Path

javax.net.ssl.trustStoreType=Keystore_Type

javax.net.ssl.trustStorePassword=Keystore_Password

</attribute>

For example:

WESTELL.COM

Page H-12

1-800-377-8766


<attribute name="Properties">

javax.net.ssl.trustStore=/opt/oms/config/keystore/ldap.truststore

javax.net.ssl.trustStoreType=pkcs12

javax.net.ssl.trustStorePassword=changeit

</attribute>

7. Redeploy the Optima web application:

$ opt/oms/bin/serverredeploy

8. As the root user, restart Optima:


WESTELL.COM

1-800-377-8766

Page H-13


WESTELL.COM

Page H-14

1-800-377-8766

APPEN

DIX I

IEvent Information Fields, Event Types,

and Alarms

This appendix explains the data fields on the Event Information Window and lists Optima event types. It also provides a list of alarms generated by Optima.


Event Information Window Fields

Kentrox Optima Server Monitor Events

Kentrox Remote Product Monitor Events

Kentrox Remote Default Analog Events

IP and Kentrox Device Alarms

Optima Self-Monitoring Alarms

Page I-1

WESTELL.COM

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: Event Information Window Fields

Event Information Window FieldsYou can view associated event attributes from the Event List by clicking the information icon to the left of the event that you want to view. The Event Information window appears (shown in Figure I-1).

Event Information window fields are explained in Table I-1 on page I-3

Figure I-1 Event Information window

WESTELL.COM

Page I-2

1-800-377-8766


Table I-1 Event Information Tab Fields

Field Description

NE Fault Name of the NE sending the event.

Site Name of the site where the event occurred.

Alarm Event indicating an error condition, such as an SNMP trap

Severity Severity level of the alarm. Possible values and their color codes:

Status Status associated with the event. Possible values:Pending -- Event is received.Acknowledged -- Message escalation stops.Cleared -- Event is removed from default Event View and message escalation stops. Be default, the event will remain in the database for 26 weeks.

Acknowledged Date and time event was acknowledged. This appears only when the event has been acknowledged.

Ack. by Optima User ID if the event is manually acknowledged. This appears only if the event has been acknowledged.

Cleared Date and time event was cleared (Timestamp in SNMP trap from NE. If the timestamp is absent, this will be the same value as Last Received.). This appears only when the event has been cleared.

WESTELL.COM

1-800-377-8766

Page I-3


Cleared By User: username (if user manually clears the alarm)

System: network (if NE sends trap for cleared alarm condition)

Process: autoclear (if Optima cleared the alarm according to a configured rule)

This appears only when the event has been cleared.

First Received Date and time the event was first received

Last Received Date and time the event was last received (Optima timestamp upon receipt of last related event -- possibly clear or repeat)

Repeat Count Number of times this event has been received

Message Brief description of event.

Long Message More detailed description of event.

Remote Attributes The Model, Firmware Version, and IP Address of the Remote event source. These appear only when the event source is a Remote.

Advanced Information Contents of this field vary by application. It can include, for example:

ID (the unique Optima-assigned number for each event)

Created (Date and time event was created) Last Changed (Date and time event last

changed) Trouble Ticket ID Correlation Key Hashcode

Table I-1 Event Information Tab Fields (Continued)

Field Description

WESTELL.COM

Page I-4

1-800-377-8766

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: Kentrox Optima Server Monitor Events

Kentrox Optima Server Monitor EventsTable I-2 lists the event types that are associated with Kentrox Optima Server Monitor.

Table I-2 Kentrox Optima Server Monitor Events

Event Type Description

Alarm.processfailed Optima internal process failure alarm

Alarm.processwarning Optima internal process warning alarm

Alarm.serverresourceerror Optima server hardware alarm

Alarm.importfailed Optima import of inventory file alarm

WESTELL.COM

1-800-377-8766

Page I-5

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: Kentrox Remote Product Monitor Events

Kentrox Remote Product Monitor EventsTable I-3 lists the event types that are associated with Kentrox Remote Product Monitor.

Table I-3 Kentrox Remote Product Monitor Events

Event Type Description

Alarm.intfDown Product interface down

Alarm.intfUp Product interface up

Alarm.nodeDown Product down

Alarm.nodeUp Product up

Alarm.portDisabled Product port disabled by configuration

Alarm.portDown Product port down

Alarm.portUp Product port up

Alarm.portUnmanaged Product port unmanaged by configuration

Alarm.restorePointCreated Product software restore point creation alarm

Alarm.restorePointUpdated Product software restore point update alarm

Alarm.alarmDeleted Product alarm deleted in configuration

Alarm.alarmUnmanaged Product alarm unmanaged in configuration

Alarm.nodeRescanFailed Product discovery failed

Alarm.nodeDiscSucceeded Product discovery succeeded

Alarm.MODEM Product modem on WAN in alarm

Alarm.moduleEvent Product module in alarm

Alarm.OPENVPN Product VPN on WAN in alarm

Alarm.DEVICE_UNREACHABLE Monitored NE is no longer connected to Product

Alarm.datacollectionfailed Product measurement collection alarm

WESTELL.COM

Page I-6

1-800-377-8766

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: Kentrox Remote Default Analog Events

Kentrox Remote Default Analog EventsTable I-4 lists the default event types that are associated with Kentrox Remote analog inputs.

Table I-4 Kentrox Remote Default Analog Events

Event Type

Alarm.Temperature_Onboard_anX_Y

Alarm.Humidity_Onboard_anX_Y

Alarm.PowerA_48V

Alarm.PowerB_48V

Alarm.Power_24V

WESTELL.COM

1-800-377-8766

Page I-7

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: IP and Kentrox Device Alarms

IP and Kentrox Device AlarmsThese alarms are generated for IP and Kentrox devices. These alarms are always attributes to the NE they were observed upon (the Kentrox Remote, or IP-enabled device) unless otherwise specified in the notes.

Table I-5 IP and Kentrox Device Alarms

Event Type Event CategorySub-component

Event Severity

Event Status

Generated ByNotes and Descriptions

restorePointCreated RestorePointEvent None Critical Pending Generated when a restore point for a device fails. This is Kentrox device specific.

Long Description: All child status(es) are abnormal.Short Description: Restore point incomplete.

restorePointCreated RestorePointEvent None N/A Cleared Generated when a restore point for a device succeeds. This is Kentrox device specific.

restorePointCreated RestorePointEvent None Warning Pending Generated when the latest restore point cannot be verified. This is Kentrox device specific.

Long Description: One child status is abnormal.Short Description: Restore point incomplete.

restorePointCreated RestorePointEvent None N/A Cleared Generated when the latest restore point has been verified. This is Kentrox device specific.

intfUp intfEvent None N/A Cleared Generated when an interface is up.

Clears an intfDown.

intfDown intfEvent None Major Pending Generated when an interface is down.

Long Description: Interface IP_address is down.Short Description: Interface is down.

nodeUp nodeEvent None N/A Cleared Generated when the first interface on a device comes up.

Clears a nodeDown. This is in lieu of an intfUp.

nodeDown nodeEvent None Critical Pending Generated when the last known interface on a device goes down.

Long Description: All interfaces on element element_name are down.Short Description: Element is down.

nodeDiscSucceeded discEvent None N/A Cleared Generated when a device is discovered.

Clears a nodeRescanFailed event.

nodeRescanSucceeded

discEvent None N/A Cleared Generated when a device is discovered.

Clears a nodeRescanFailed event.

WESTELL.COM

Page I-8

1-800-377-8766

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: IP and Kentrox Device Alarms

nodeRescanFailed discEvent None Critical Pending Generated when device discovery fails.

Long Description: An element discovery has failed.

portUp portEvent None N/A Cleared Generated when device polling determines a port is up.

Clears a portDown event.

portUnmanaged portEvent None N/A Cleared Generated when a port is administratively unmanaged.


portDisabled portEvent None N/A Cleared Generated when device polling determines a port is disabled.


portDown portEvent None Critical Pending Generated when device polling determines a port is down.

Long Description: Status changed to Critical as result of an SNMP poll.Short Description: port_id is down.

alarmCleared alarmEvent None N/A Cleared Generated by SNMP polling success.

Clears an alarm event.

alarm alarmEvent None Critical Pending Generated by SNMP polling failure.

A SNMP alarm was identified on interface IP_address.

alarmCleared alarmEvent None N/A Cleared Generated by ICMP polling success.

Clears an alarm event.

alarm alarmEvent None Critical Pending Generated by ICMP polling failure.

A ICMP alarm was identified on interface IP_address.

Table I-5 IP and Kentrox Device Alarms (Continued)


Event Severity

Event Status

Generated ByNotes and Descriptions

WESTELL.COM

1-800-377-8766

Page I-9

Optima Version 11.3x System Administration GuideEvent Information Fields, Event Types, and Alarms: Optima Self-Monitoring Alarms

Optima Self-Monitoring Alarms

Optima System MonitoringThese alarms are generated for Optima self-monitoring subsystems and processes. Unless otherwise specified in the notes, these events are always attributed to the server they were observed upon.

Table I-6 Optima System Monitoring Alarms


Event Severity

Event Status

Generated By Notes and Descriptions

nodeDown nodeEvent DMC_server_ID

Critical Pending Generated when ICMP polling from the OMS to a DMC fails.

Attributed to the OMS.Long Description: Destination address unreachable.

nodeDown nodeEvent DMC_server_ID

N/A Cleared Generated when ICMP polling from the OMS to a DMC succeeds (upon successful poll).

Attributed to the OMS.Long Description: Destination address unreachable.

processFailed ProcessManager Name_of_the_process

Minor Pending Generated when a core Optima daemon stops unexpectedly.

Long Description: Name_of_process not running.


Critical Pending Generated once max number of restart attempts has been reached and process cannot be brought up.

Long Description: Name_of_process has exceeded the maximum number of restarts and requires administrator action.


N/A Cleared Cleared when that process is started successfully (after time given to ensure it has quiesced).

Long Description: Name_of_process running.

processFailed ProcessManager optimabackup Critical Pending Generated when a backup failed to perform for any reason.

Attributed to the OMS.Long Description:Backup failed. See /var/log/dmi/optimabackup.log for more details.Short Description: Backup failed.

processFailed ProcessManager optimabackup N/A Cleared Cleared when a backup is taken successfully.

Attributed to the OMS.

importfailed CronJob impReport Minor Pending Generated when measurements aren’t imported.

Attributed to the OMS.Long Description: Refer to /opt/oms/tmp/impReport.log for more details.Short Description: Import Alert.

WESTELL.COM

Page I-10

1-800-377-8766


Optima Server Resource MonitoringThese alarms are generated for monitoring the local server. All alarms are attributed to the appropriate server (OMS or DMC). Typically, events with a severity of Cleared will never have their descriptions displayed. Optima keeps the correlating pending event’s description for historical purposes. This is the behavior in both the NBI and the Optima GUI. The one exception to this is server resource monitoring events. Optima (GUI & NBI) treats these events the same way; however, these events are also sent to syslogd. When sent to syslogd, the cleared descriptions are displayed.

The subcomponent becomes the most important detail generated to isolate and distinguish the problem resource.

importfailed CronJob impReport N/A Cleared Generated when measurements are processed.

dataCollectionFailed ProcessManager tableCheck Major Pending Generated when measurements aren’t properly processed.

Attributed to the OMS.Long Description:Data not processed for more than Number_of_hours h. Short Description: MEASUREMENT ALERT.

dataCollectionFailed ProcessManager tableCheck N/A Cleared Generated when measurements are properly processed.

processwarning adapter adapterInstanceID.etl Generated by adapters for runtime errors during extraction, transformation and loading (ETL).

Long Description:Various messages, Adapter.

processwarning adapter adapterInstanceID.etl Generated by adapters for errors during collection.

Long Description:Various messages, Adapter.

Table I-6 Optima System Monitoring Alarms (Continued)


Event Severity

Event Status

Generated By Notes and Descriptions

Table I-7 Optima Server Resource Monitoring Alarms


Event Severity

Event Status

Generated By Long Description

serverResourceError ServerMonitor Disk-mountpoint

Warning Pending Generated when the free disk space is lower than its user configured warning threshold.

The resource: Disk- mountpoint usage has exceeded the warning threshold limit. Total percentage of disk used is: percent used.

WESTELL.COM

1-800-377-8766

Page I-11



Critical Pending Generated when the free disk space is lower than its user configured minimum threshold .

The resource: Disk- mountpoint usage has exceeded the maximum failure threshold. Total percentage of disk used is: percent used.


N/A Cleared Generated when the free disk space is within user configured thresholds.

The resource: Disk- mountpoint usage is within the threshold limit.

serverResourceError ServerMonitor Memory Warning Pending Generated when the free memory is lower than its user configured warning threshold.

The resource: Memory usage has exceeded the threshold warning limit. Current usage percentage is: percent used.

serverResourceError ServerMonitor Memory Critical Pending Generated when the free memory is lower than its user configured minimum threshold.

The resource: Memory usage has exceeded the threshold limit. Current usage percentage is: percent used.

serverResourceError ServerMonitor Memory N/A Cleared Generated when the free memory is within user configured thresholds.

The resource: Memory usage is within the threshold limit.

serverResourceError ServerMonitor CPU Warning Pending Generated when the CPU usage is greater than its user configured warning threshold.

The resource: CPU usage has exceeded the threshold warning limit. Current usage percentage is: percent used.

serverResourceError ServerMonitor CPU Critical Pending Generated when the CPU usage is greater than its user configured maximum threshold.

The resource: CPU usage has exceeded the threshold limit. Current usage percentage is: percent used.

serverResourceError ServerMonitor CPU N/A Cleared Generated when the CPU usage is within user configured thresholds.

The resource: CPU usage is within the threshold limit.

serverResourceError ServerMonitor PID-Process_ID

Warning Pending Generated when a particular PID has exceeded the warning user configured threshold of allowed threads.

Process with the pid: Process_ID has exceeded the warning threshold limit. Current thread count is: Number_of_Threads.

Table I-7 Optima Server Resource Monitoring Alarms (Continued)


Event Severity

Event Status


WESTELL.COM

Page I-12

1-800-377-8766



Critical Pending Generated when a particular PID has exceeded the maximum user configured threshold of allowed threads. This alarm is never cleared, as the process has been forcefully stopped.

Process with the pid: Process_ID has exceeded the maximum failure threshold for thread count. Current thread count is: Number_of_Threads. Killed the process for having too many threads.


N/A Cleared This alarm is generated when a particular PID is within the user configured threshold of allowed threads.

The resource: ProcessThreads usage is within the threshold limit for the PID: Process_ID.

serverResourceError ServerMonitor Controller Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk controller errors.

The resource: Controller- Controller_Id status is: Non-Critical.

serverResourceError ServerMonitor Controller Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk controller errors.

The resource: Controller- Controller_Id status is: Unknown.

serverResourceError ServerMonitor Controller Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk controller errors.

The resource: Controller- Controller_Id had failed with the status: Critical

serverResourceError ServerMonitor Controller Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk controller errors.

The resource: Controller- Controller_Id had failed with the status: Non-recoverable.

serverResourceError ServerMonitor Controller N/A Cleared Generated when DELL OMSA monitoring tools report normal disk controller.

The resource: Controller- Controller_Id status is: Ok.

serverResourceError ServerMonitor PDisk Warning Pending Generated when DELL OMSA monitoring tools alarm on minor physical disk errors.

The resource: PDisk- Physical_Disk_Id status is: Non-Critical.



Event Severity

Event Status


WESTELL.COM

1-800-377-8766

Page I-13


serverResourceError ServerMonitor PDisk Warning Pending Generated when DELL OMSA monitoring tools alarm on minor physical disk errors.

The resource: PDisk- Physical_Disk_Id status is: Unknown.

serverResourceError ServerMonitor PDisk Critical Pending Generated when DELL OMSA monitoring tools alarm on critical physical disk errors.

The resource: PDisk- Physical_Disk_Id had failed with the status: Critical.

serverResourceError ServerMonitor PDisk Critical Pending Generated when DELL OMSA monitoring tools alarm on critical physical disk errors.

The resource: PDisk- Physical_Disk_Id had failed with the status: Non-recoverable.

serverResourceError ServerMonitor PDisk N/A Cleared Generated when DELL OMSA monitoring tools report normal physical disk.

The resource: PDisk Physical_Disk_Id status is: Ok.

serverResourceError ServerMonitor VDisk Warning Pending Generated when DELL OMSA monitoring tools alarm on minor virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id status is: Non-Critical.

serverResourceError ServerMonitor VDisk Warning Pending Generated when DELL OMSA monitoring tools alarm on minor virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id status is: Unknown.

serverResourceError ServerMonitor VDisk Critical Pending Generated when DELL OMSA monitoring tools alarm on critical virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id had failed with the status: Critical.

serverResourceError ServerMonitor VDisk Critical Pending Generated when DELL OMSA monitoring tools alarm on critical virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id had failed with the status: Non-recoverable.

serverResourceError ServerMonitor VDisk N/A Cleared Generated when DELL OMSA monitoring tools report normal virtual (RAID) disk.

The resource: VDisk- Virtual_Disk_Id status is: Ok



Event Severity

Event Status


WESTELL.COM

Page I-14

1-800-377-8766


serverResourceError ServerMonitor Battery-Battery_ID

Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk controller battery errors.

The resource: Battery- Battery_Id status is: Non-Critical.


Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk controller battery errors.

The resource: Battery- Battery_Id status is: Unknown.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk controller battery errors.

The resource: Battery- Battery_Id had failed with the status: Critical.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk controller battery errors.

The resource: Battery- Battery_Id had failed with the status: Non-recoverable.


N/A Cleared Generated when DELL OMSA monitoring tools report normal disk controller battery.

The resource: Battery- Battery_Id status is: Ok.

serverResourceError ServerMonitor Enclosure-Enclosure_ID

Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk enclosure errors.

The resource: Enclosure- Enclosure_Id status is: Non-Critical.


Warning Pending Generated when DELL OMSA monitoring tools alarm on minor disk enclosure errors.

The resource: Enclosure- Enclosure_Id status is: Unknown.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk enclosure errors.

The resource: Enclosure- Enclosure_Id had failed with the status: Critical.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical disk enclosure errors.

The resource: Enclosure- Enclosure_Id had failed with the status: Non-recoverable.



Event Severity

Event Status


WESTELL.COM

1-800-377-8766

Page I-15



N/A Cleared Generated when DELL OMSA monitoring tools report normal disk enclosure.

The resource: Enclosure- Enclosure_Id status is: Ok.

serverResourceError ServerMonitor Temperature-Temperature_ID

Warning Pending Generated when the system temperature reported by DELL OMSA monitoring tools is not within the configured warning thresholds (8°C-42°C). The ID is an identifier from the Dell OMSA tool. Multiple temperatures may be measured depending on the server.

The resource: Temperature- Temperature_ID has crossed the warning threshold limit. Current reading is: Temperature C.


Critical Pending Generated when the system temperature reported by DELL OMSA monitoring tools is not within the configured failure thresholds (3°C-47°C). The ID is an identifier from the Dell OMSA tool. Multiple temperatures may be measured depending on the server.

The resource: Temperature- Temperature_ID has crossed the failure threshold limit. Current reading is: Temperature C.


N/A Cleared Generated when the system temperature reported by DELL OMSA monitoring tools is within the configured failure thresholds. The ID is an identifier from the Dell OMSA tool. Multiple temperatures may be measured depending on the server.

The resource: Temperature- Temperature_ID reading is within the threshold limit.

serverResourceError ServerMonitor PowerSupply- PowerSupply_ID

Warning Pending Generated when DELL OMSA monitoring tools alarm on minor power supply errors.

The resource: PowerSupply- PowerSupply_Id status is: Non-Critical.



Event Severity

Event Status


WESTELL.COM

Page I-16

1-800-377-8766



Warning Pending Generated when DELL OMSA monitoring tools alarm on minor power supply errors.

The resource: PowerSupply- PowerSupply_Id status is: Unknown.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical power supply errors.

The resource: PowerSupply- PowerSupply_Id had failed with the status: Critical.


Critical Pending Generated when DELL OMSA monitoring tools alarm on critical power supply errors.

The resource: PowerSupply- PowerSupply_Id had failed with the status: Non-recoverable.


N/A Cleared Generated when DELL OMSA monitoring tools report normal power supply.

The resource: PowerSupply- PowerSupply_Id status is: Ok

serverResourceError ServerMonitor Fans-Fan_ID Critical Pending Generated when the on board fans RPM reported by DELL OMSA monitoring tools is lower than the configured failure thresholds (2025 RPM).

The resource: Fans- Fan_ID has crossed the failure threshold limit. Current reading is: Fan_RPM .

serverResourceError ServerMonitor Fans-Fan_ID N/A Cleared Generated when the on board fans RPM reported by DELL OMSA monitoring tools is within the configured thresholds.

The resource: Fans- Fan_ID reading is within the threshold limit.

serverResourceError ServerMonitor Network Interface- NIC_ID

Critical Pending Generated when expected (user configured) physical status is different than current state, or if a NIC has an internal fault.

The resource: Network Interface- NIC_ID has failed with the status: Current status.

serverResourceError ServerMonitor Network Interface- NIC_ID

N/A Cleared Generated when expected (user configured) physical status matches the current state.

The resource: Network Interface- NIC_ID status is Current status.



Event Severity

Event Status


WESTELL.COM

1-800-377-8766

Page I-17


Optima UI to NBI Terminology MappingThe NBI utilized in Optima 8.1x and above uses terminology that differs from the terminology used in the Optima user interface; specifically, the varbinds contained within the ktxNorthBoundEventTrap trap. The table below describes this mapping.

Table I-8 Optima UI to NBI Terminology Mapping

Optima UI Term NBI Term Notes

Event id ktxNorthBoundEventID This field should be utilized to correlate a PENDING event with a CLEARED event. Event B clears pending event A if it has the same event id and its status is CLEARED.

Event Class ktxNorthBoundEventClass

Event Type ktxNorthBoundEventType

Event Severity ktxNorthBoundEventSeverity

Event Status ktxNorthBoundEventStatus

Long Description ktxNorthBoundEventMsg

Short Description ktxNorthBoundEventShortMsg

In the event list, this is called "Description", this is the “Long Description” column above or “Short Description” where noted.

Source component ktxNorthBoundEventSourceComponent

This is the source NEs config name.

Source component info

ktxNorthBoundEventSourceComponentIpAddress

This is the source NEs IP address if available.

Repeat count ktxNorthBoundRepeatCount

Acknowledged by ktxNorthBoundAckBy

Cleared by ktxNorthBoundClrBy

WESTELL.COM

Page I-18

1-800-377-8766


Created ktxNorthBoundEventCreationTime

Last Changed ktxNorthBoundEventLastChangedTime

Table I-8 Optima UI to NBI Terminology Mapping (Continued)

Optima UI Term NBI Term Notes

WESTELL.COM

1-800-377-8766

Page I-19


WESTELL.COM

Page I-20

1-800-377-8766

GLO

SSARY

Glossary

A

application

A tool by which a user can access a network element. An internet browser is an example of an application.

B

bit error ratio (BER)

The number of bits, elements, characters, or blocks incorrectly received to the total number of bits, elements, characters, or blocks sent during a specified time interval.

Page J-1

WESTELL.COM

Optima Version 11.3x System Administration Guide:

C

cron

Cron is a Linux utility that is used to automate tasks. Cron is driven by a crontab, a configuration file that specifies shell commands to run periodically on a given schedule.

D

dashboardA

A GUI concept permitting the visualization of selected information and presented on a single common display element. In Optima, the dashboard consists of a multi-window view of reports, event lists and element selection components.

data source

A data source is an object that represents the actual source of performance data for a measurement. Consider an example in which a Remote monitors the temperature of a generator. This might be configured in Optima as a measurement/signal template called Temperature whose data source is Remote associated with an NE of type Generator. This template and data source could be applied to any Remote in the Optima network that monitors a similar generator.

E

element

A constituent part of a network. An element might be in the form of a Remote, CrossPATH, or another product.

WESTELL.COM

Page J-2

1-800-377-8766


event

An event is an incident that is triggered by an external or internal event. An event can be anything from a discrete input opening or closing, a serial controller going up or down, a TCP connection request, or a power supply failure.

event originator

An event originator is the system component that generates an event.

event type

An event type identifies the cause of the generated event.

F

filter

Filters are used to provide advanced management capabilities for events. The goal is to prevent specific events from being reported as alarms or alerts.

I

ICMP

Internet Control Message Protocol (ICMP) is a Layer 3 protocol that allows routers to send error and control messages about packet processing on IP networks.

WESTELL.COM

1-800-377-8766

Page J-3


L

logging file

A logging file is a file that tracks activity for a host resource.

M

measurement

A value collected from a device on the network, such as a Remote.

model

A specific type of network element. Models are assigned to network elements.

MTTR (Mean Time To Repair)

Mean Time To Repair is the average time required to return a failed device or system to service.

N

network element (NE)

Optima considers each subdivision of the network - and even the network itself - to be a network element. Thus, an individual device is a network element, and it might be part of a cell site that is also considered by Optima to be a network element. Optima network elements are organized into a hierarchy of NE categories. From top to bottom, these categories include Root, System, Region, Site, and Data Collection Device.

WESTELL.COM

Page J-4

1-800-377-8766


Network Element (NE) Name

This is the name of the Network Element (NE) as it appears in the GUI.

NE Selection Group

An NE selection group is a list of network elements that you can create to use later in a report, events list or dashboard. NE selection groups can be public (accessible by everyone) or private (accessible only by the creator).

notification

A notification is a message Optima sends to one or more users in response to an event. Optima can send messages in many formats, such as SMTP, SMS, or FTP.

P

Product Configurator

An Optima interface that is used to configure site parameters, alarm points, and backhaul configurations for Kentrox Remote devices and their associate expansion peripherals, apply these configuration changes, and copy configurations from one Remote to another.

profile

A system profile provides Optima users with a means of customizing items such as event lists, reports, and dashboards to meet their specific needs. A profile is managed through the Optima My Profile menu.

protocol

A protocol represents the type of communication between an application and a network element. Common protocols include HTTP (HyperText Transfer Protocol), FTP (File Transfer Protocol), and SNMP (Simple Network Management Protocol).

WESTELL.COM

1-800-377-8766

Page J-5


PuTTY

PuTTY is a terminal emulator application which can act as a client for the SSH, Telnet, rlogin, and raw TCP computing protocols.

R

region

A container of sites and/or network elements. Region relationships are established by users.

restore point

A collection of software configuration settings, taken from a network element at a given point in time. Optima offers the ability to restore software configuration points from the Software Restore List.

S

server certificate

A unique digital identification that forms the basis of a web server’s SSL security features.

signal

An alarm, analog or control data point from a Remote or other device. Signals are assigned to models. For consistency through the customer’s network on reports and dashboards, users must use signal names when configuring alarm, analog and control assignments.

WESTELL.COM

Page J-6

1-800-377-8766


site

A specific region that contains network elements with attributes: name, address, GPS coordinates, etc. A site contains zero or more network elements with a common location (coordinate pair).

SNMP

Simple Network Management Protocol. This is the method by which the Optima server communicates with many network elements.

T

trap

A programmatic mechanism by which a device in the network (such as a Remote) automatically alerts Optima of an event.

Tree View

A list of regions, sites and/or network elements arranged in a nested list based on parent/child relationships that are configured by the users. This is typically a geographical arrangement.

U

User Access Matrix

An Optima interface that displays all preconfigured user groups, as well as the permissions associated with each user group. You should consult the User Access Matrix to help you assign user group membership for a new user account.

WESTELL.COM

1-800-377-8766

Page J-7


WESTELL.COM

Page J-8

1-800-377-8766

IND

EX

. . . . . . Index

Aadministrative tasks

initial setup 4-7ongoing 4-14

Bbackup script 4-18

Cchassis NIC status 4-30client

installation 3-3system requirements 3-2uninstallation 3-3

clock 4-8Configuring a NFS mount point A-19customer assistance 1-vi

DDaemon Watcher 4-31data retention intervals 4-26Dell RD1000

configuring mount point A-23determining device name A-20formatting A-23repartitioning A-21unmounting A-4

Dell Remote Access Cardconfiguring users D-10network settings D-2services D-14Web interface D-8

directordiagsnapshot utililty 4-16

disaster recovery C-2DMC

installation 2-5overview 4-3registration 4-11shadow element inventory database 4-3upgrading

v8.0x to v8.1x 2-10dmcregistrar 4-11dmcsystemmanager 4-12

Eemail notification 4-25event retention intervals 4-26

FFault Generator 4-31Firewall

ODBC 4-11ports 4-11

Hhostname 4-23

Iinstallation

client 3-3DMC server 2-5OMS 2-4standalone server 2-2

Installing Optima Patch Files 2-15Inventory Exporter 4-19

© Westell Technologies

WESTELL.COM


file format G-2Inventory Importer 4-19

file format G-3IP address 4-23

LLDAP user authentication

administration user bind H-6bootstrapping H-3configuring H-2configuring LDAP failover H-11creating initial user account H-3designated LDAP servers H-11DNS aliases H-11over SSL H-12overview H-2simple user bind H-4using MS Active Directory H-8

Linuxexecuting commands 4-6troubleshooting 4-15

loggingconfiguring levels 4-15log files 4-16process monitoring 4-32user activity 4-17

MMap View

configuring 4-8default locations 4-9map type 4-9zoom level 4-9zoom threshold 4-9

measurement retention intervals 4-26memory limit 4-27

Nnetwork element

updating firmware B-7NIC status 4-30Node Status Poller 4-30

OODBC 4-11OMS

disaster recovery C-2element inventory database 4-3installation 2-4overview 4-3upgrading

v8.0x to v8.1x 2-9Optima

backup 4-18disaster recovery C-2documentation

content summary 1-iiconventions 1-ivUser’s Guide 1-ii

hostname 4-23IP address 4-23overview 1-2permissions 4-24process monitoring 4-28restarting 4-14restore 4-18server diagram 4-2Server Monitor 4-28server processes 4-14starting 4-14status check 4-14stopping 4-14user types 1-iii

network managers 1-iiinetwork operators 1-iiisystem administrators 1-iii

optimacontroller command 4-14optimainventoryexporter 4-19

file format G-2optimainventoryimporter 4-19

file format G-3optimanetworkcheck utility 4-16

Ppermissions 4-24PostgreSQL password 4-7process monitoring 4-28

log files 4-32

RRAIDar, installing A-5ReadyNAS 2100

configuring A-7connecting A-6IP address A-9iSCSI A-12

Red Hat terminalaccessing the CLI 4-6

removable DAS deviceconfiguring A-1

reportsmemory limit 4-27

restore script 4-18

SServer Monitor 4-28

chassis NIC status 4-30service packs,installing F-9snapshot utility 4-16SSL H-12standalone server

installation 2-2overview 4-2

upgrading 2-8swap space,configuring F-7system clock 4-8system requirements

client 3-2

Uuninstallation

client 3-3upgrading

from v8.0x to v8.1x 2-7user audit log 4-17

WESTELL.COM

Page Index-2

1-800-377-8766

Optima Management System System Administration Guide ...support.westell.com/documents/manuals/Optima1130_SysAdmin.pdf · Table 1 summarizes the general content of the three Optima

Documents