system administration guide -...

SYSTEM A

D

Optima Prime®

Management System

System Administration Guide

Version 12.2x

WESTELL.COM

MIN

ISTRATIO

N G

UID

E

© Westell Technologies
Part # 030-101919 Rev A

WESTELL.COM

Copyright © 2017 by Westell, Inc. All Rights Reserved. Westell, Kentrox, Optima Management System, and Optima Prime 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 Prime Users and Tasks:........................................................................Preface ivDocument Conventions: .................................................................................... Preface vCustomer Assistance:.......................................................................................Preface vii

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

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

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

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

Additional Installation-Related Tasks ......................................................................... 2--7Installing and Administering the Optima License ............................................ 2--7optimainstaller Troubleshooting ...................................................................... 2--8Obtaining Dell System Administration Tools ................................................... 2--8Post-Upgrade Tasks ....................................................................................... 2--9Using Redirect for Optima Client Services ..................................................... 2--9

Migrating Optima 11.50 Servers to Optima Prime .................................................... 2--10Adding and Editing Servers with the Servers User Interface .................................... 2--11

Chapter 3: Optima Prime Server ............................................................. 3-1Overview ..................................................................................................................... 3--2

Page TOC-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideTable of Contents

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

System and Hardware Requirements .........................................................................3--4Server Size ......................................................................................................3--4Basic Hardware Specifications for Optima Servers .........................................3--4

Executing Linux Commands .......................................................................................3--6

Chapter 4: Setting Up the Optima Prime Server ..................................... 4-1Changing the PostgreSQL Database Password .........................................................4--2Setting Up Optima Prime in a Firewalled Environment ...............................................4--3Adding and Editing Systems .......................................................................................4--4Mapping Systems to DMCs .........................................................................................4--6Configuring Default and Maximum Maintenance Mode Duration ................................4--7Configuring and Enabling Trouble Tickets ..................................................................4--8Configuring Encrypted Passwords for Messaging Protocols ....................................4--10

Chapter 5: Optima Prime Server Administration and Process Monitoring 5-1Ongoing Administrative Tasks ....................................................................................5--2

Starting and Stopping the Optima Prime Service ............................................5--2Troubleshooting Using the RHEL Service Configuration Window ...................5--3Using the Optima Network Check Utility .........................................................5--3Using the Optima Config Utility .......................................................................5--4Using the Snapshot Utility ...............................................................................5--5Accessing Logging Files ..................................................................................5--6Backup and Restore ........................................................................................5--7Inventory Importer and Exporter ......................................................................5--8Event Fix Actions Importer ............................................................................5--12Editing the IP Address and/or Hostname ......................................................5--13Administering Measurement Partitions ..........................................................5--13Administering Permissions ............................................................................5--14Configuring Email Notifications .....................................................................5--14Configuring Notifications for Clears and Acknowledgements ........................5--15Adjusting Data Retention Intervals ................................................................5--15Adjusting the Memory Limit for Reports ........................................................5--16Configuration to Show Priority and Outages in Site View .............................5--17Configuration to Directly Connect DAS Site NEs to Optima ..........................5--18Global Event Filtering ....................................................................................5--19Adding and Deleting Help Documents ..........................................................5--23Configuring the Map View .............................................................................5--23Customizing Default User Interface Preferences ..........................................5--26

Process Monitoring ...................................................................................................5--28Optima Server Monitor ..................................................................................5--28Fault Generator .............................................................................................5--30Process Monitoring Log Files ........................................................................5--30

WESTELL.COM

Page TOC-2

1-800-377-8766


Chapter 6: Optima Prime Server Replication .......................................... 6-1Overview .....................................................................................................................6--2Replication Prerequisites .............................................................................................6--3

Assigning a password to postgres ...................................................................6--3Commands Used in Replication ..................................................................................6--4

setupauthorizedkeys ........................................................................................6--4replicationmanager ..........................................................................................6--5optimadaemonregistrar ....................................................................................6--9

Server Replication Procedures ..................................................................................6--11Server Replication Illustrations ......................................................................6--11Setting Up and Enabling Replication .............................................................6--12Promoting the Standby Server when Active Server Fails ..............................6--16In Case of Standby Server Failure ................................................................6--21Reversing Replicated Servers to Original Roles ...........................................6--23Manually Disabling Replication ......................................................................6--24

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

Assigning a Static IP to the LAN 2 Ethernet Interface .................................... A--8Configuring a Static Route to the ReadyNAS 2100 on the Optima Server ... A--10Configuring the iSCSI Target Area on the ReadyNAS 2100 ........................ A--11Identifying the iSCSI Target .......................................................................... A--11Formatting the iSCSI Target Area ................................................................ A--12

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

Internal RD1000 Drive .................................................................................. A--19External RD1000 Drive ................................................................................. A--19

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

Configuring the Mount Point ..................................................................................... A--22Ejecting and Reinserting the Removable DirectAccess Storage Cartridge .............. A--23

WESTELL.COM

1-800-377-8766

Page TOC-3


Appendix B: Updating Westell Remote Devices .....................................B-1Upgrading Westell Remote Software ..........................................................................B--2Installing and Managing Modules ................................................................................B--3

Using the Modulemanager Script ....................................................................B--3

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

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--15Subscribing to NBI JMS Connection .............................................................E--15Extracting Relevant Information from CBEs ..................................................E--17

JMS Message Selectors ...........................................................................................E--21Example JMS Selectors ................................................................................E--21

Event Object Model ...................................................................................................E--22

Appendix F: Red Hat Installation Tasks .................................................. F-1Installing Red Hat ........................................................................................................F--2Updating Red Hat Packages .......................................................................................F--5

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

WESTELL.COM

Page TOC-4

1-800-377-8766


CSV File Columns ......................................................................................................G--4necategory ......................................................................................................G--4ne ....................................................................................................................G--4neaccess ........................................................................................................G--7netype .............................................................................................................G--8netypeaccess ..................................................................................................G--9protocol .........................................................................................................G--10alarm .............................................................................................................G--10alarmtranslation ............................................................................................G--11measurementtemplate ..................................................................................G--11signaldefinition ..............................................................................................G--12signalcategory ..............................................................................................G--14measurement ................................................................................................G--14

XML Import/Export Types .........................................................................................G--15Event Fix Actions Importer CSV Columns ................................................................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--2Optima Server Monitor Events .....................................................................................I--9Remote Product Monitor Events ................................................................................I--10Remote Default Analog Events ..................................................................................I--11IP and Westell Device Alarms ....................................................................................I--12Optima Self-Monitoring Alarms ..................................................................................I--14

Optima System Monitoring .............................................................................I--14Optima Server Resource Monitoring ..............................................................I--15Optima UI to NBI Terminology Mapping .........................................................I--20

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 Prime servers and how to administer Optima Prime client machines. You should have a working knowledge of the following:

Red Hat Enterprise Linux

The PostgreSQL database

Table 1 summarizes the general content of the three Optima Prime 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 Prime Version 12.2x System Administration GuidePreface: About This Document

Table 1 Optima Documentation Content Summary

Document/Part #Primary Target Audience

Primary Tasks/Menus

Optima Prime Management System User/Configuration Guide

Network Operators Primary tasks performed from the following Optima Prime Management System menu items: Configuring the operator’s profile: My

Optima > My Profile Configuring and using Dashboards:

Dashboards Configuring and using Map View: Map

View Configuring and using Event View:

Event View Configuring and using Report View:

Report View Configuring and using Live View: Live

View Configuring Event Filtering and

Mediation Rules: Configuration > Events > Filtering & Mediation

Configuring and Managing Threshold Templates: Configuration > Events > Threshold Templates

Optima Prime Management System User/Configuration Guide

Network Managers Primary tasks performed from the following Optima Prime Management System Configuration menu items: Configuring network elements Configuring notification rules Configuring busy hour templates Configuring measurement templates Configuring and scheduling reports Configuring time templates Managing users and user roles Configuring and scheduling jobs Configuring system preferences Managing servers

WESTELL.COM

Page Preface-ii

1-800-377-8766

Optima Prime Version 12.2x System Administration GuidePreface: About This Document

Optima Prime Management System Administration Guide

System Administrators Overall Optima Prime server functions, including installation, system performance, hardware/software reconfiguration, system startup and shutdown, replication, and backup and restoration of configuration data.Tasks are typically performed from a browser and various command lines, not from the Optima Prime Management System. Certain server management functions are an exception/Configuration > System > Manage Servers.

Table 1 Optima Documentation Content Summary (Continued)

Document/Part #Primary Target Audience

Primary Tasks/Menus

WESTELL.COM

1-800-377-8766

Page Preface-iii

Optima Prime Version 12.2x System Administration GuidePreface: Optima Prime Users and Tasks

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

Network Operators. Network operators are the basic users of Optima Prime. 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 Prime User/Configuration Guide.

Network Managers. Network managers typically use the Optima Prime 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 Prime User/Configuration Guide.

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

WESTELL.COM

Page Preface-iv

1-800-377-8766

Optima Prime Version 12.2x 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 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

1-800-377-8766

Page Preface-v

Optima Prime Version 12.2x System Administration GuidePreface: Document Conventions

Labels This style designates physical components on Westell 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

Page Preface-vi

1-800-377-8766

Optima Prime Version 12.2x 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:30 a.m. to 5 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

1-800-377-8766

Page Preface-vii

mailto:[email protected]

Optima Prime Version 12.2x System Administration GuidePreface: Customer Assistance

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 onlineSupport Portal at:

http://www.westell.com/services-support/supportportal/

(Register for access. Click on “Documentation Library.”)

WESTELL.COM

Page Preface-viii

1-800-377-8766

http://www.westell.com

http://www.westell.com/services-support/supportportal/

CHA

PTER 1

1

Product Overview

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

Guide to this Chapter

Overview of the Optima Prime Management System

Features

Page 1-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideProduct Overview: Overview of the Optima Prime Management System

Overview of the Optima Prime Management SystemOptima Prime 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 Prime 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 Prime Version 12.2x System Administration GuideProduct Overview: Features

FeaturesOptima Prime 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, Site 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, 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 Prime Version 12.2x System Administration GuideProduct Overview: Features

WESTELL.COM

Page 1-4

1-800-377-8766

CHA

PTER 2

2

Installing and Upgrading Optima Prime

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


Performing a Fresh Optima Prime Installation

Additional Installation-Related Tasks

Migrating Optima 11.50 Servers to Optima Prime

Adding and Editing Servers with the Servers User Interface

Page 2-1

WESTELL.COM

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

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

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

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

standalone server functionality.

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

These installation instructions include setting a PostgreSQL database password during installation. To set or change this password after Optima is already installed, refer to Changing the PostgreSQL Database Password on page 4-2.

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

Administering the Optima License on page 2-7)

Optima certificate file (obtain from Westell and proceed as follows)

1. Provide to Westell all IPv4 and IPv6 addresses and the fully qualified domain name of the OMS server. Westell will respond by sending the certificate file for the OMS server.

2.Use sftp/scp to transfer the certificate file to the /tmp folder on the OMS server.

Server ID (the dmc_name value for this DMC server)

System name/names

IP or hostname for OMS

IP or hostname for DMC

SMTP server hostname

Names of adapters running on the pre-12.x Optima version which are desired in the new Optima Prime system.

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

1. Log in as the root user.

WESTELL.COM

Page 2-2

1-800-377-8766


2. Verify the Red Hat version using the following command:

# cat /etc/redhat-release

3. If the Red Hat version is other than 7.3, Optima Prime should not be installed. See Appendix F: Red Hat Installation Tasks for installation details.

4. Execute the following commands to create directories on the server:

# mkdir /var/tmp/oms

# mkdir /var/tmp/dmc

5. Copy the installation files from the Optima distribution disks or transfer them using sftp to the appropriate directories. These shall include the file optimainstaller, which needs to be copied to /var/tmp.

6. Install Optima Prime files by executing the following commands. Use the setdbpassword option to set the database password if desired. If the server is not active in DNS, specify the server’s IP address using the oms-webhost option.

# cd /var/tmp

# chmod +x optimainstaller

# ./optimainstaller --oms-setheap [--oms-webhost=server_ip_address] [--setdbpassword] single

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

./optimainstaller --help

If/when prompted, enter:

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

the new database password.

the dmc_name value for this DMC server

the full, non-relative path of the certificate file in the OMS server. For example:

/tmp/optima_certificate.pem

Notes: Do not use spaces in the DMC server name.

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

To change the database password after installation, refer to Changing the PostgreSQL Database Password on page 4-2.

WESTELL.COM

1-800-377-8766

Page 2-3


7. Install the Optima license using the instructions in Installing and Administering the Optima License on page 2-7.

8. Proceed to Adding and Editing Servers with the Servers User Interface on page 2-11 for instructions on adding DMC servers.

Installing Separate OMS and DMC Servers

Installing an OMSTo install a server with OMS functionality only:


2. Verify the Red Hat version using the following command:

# cat /etc/redhat-release

3. If the Red Hat version is other than 7.3, Optima Prime should not be installed. See Appendix F: Red Hat Installation Tasks for installation details.

4. Execute the following command to create a directory on the server:

# mkdir /var/tmp/oms

5. Copy the installation files from the Optima distribution disks or transfer them using sftp to the appropriate directory. These shall include the file optimainstaller, which needs to be copied to /var/tmp.

6. Install Optima files by executing the following commands. Use the setdbpassword option to set the database password if desired. If the server is not active in DNS, specify the server’s IP address using the oms-webhost option.

# cd /var/tmp


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



If/when prompted, enter:

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

the new database password.

the full, non-relative path of the certificate file in the OMS server. For example:

WESTELL.COM

Page 2-4

1-800-377-8766


/tmp/optima_certificate.pem

Notes: If optimainstaller fails, see section optimainstaller Troubleshooting on

page 2-8.


7. Install the Optima license using the instructions in Installing and Administering the Optima License on page 2-7.

Installing a DMC ServerRepeat this procedure as needed to install multiple DMC servers.

To install a server with DMC functionality only:


2. Execute the following command to create a directory on the server:

# mkdir /var/tmp/dmc

3. Copy the installation files from the Optima distribution disks or transfer them using sftp to the appropriate directory. These shall include the file optimainstaller, which needs to be copied to /var/tmp.

4. Install Optima files by executing the following commands. Use the setdbpassword option to set the database password if desired.

# cd /var/tmp


# ./optimainstaller [--setdbpassword] dmc



When prompted, enter:

the dmc_name value for this DMC server

the IP address or hostname of the OMS

the new database password

Notes: Do not use spaces in the DMC server name.

WESTELL.COM

1-800-377-8766

Page 2-5


Page 2-6

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


After all DMC servers have been installed, log into Optima Prime and access the Servers user interface (Configuration > System > Manage Servers) to add the DMC server name(s) and IP address(es). Refer to Adding and Editing Servers with the Servers User Interface.

WESTELL.COM

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideInstalling and Upgrading Optima Prime: Additional Installation-Related Tasks

Additional Installation-Related Tasks

Installing and Administering the Optima LicenseOptima Prime includes a licensing feature which enforces a maximum number of configured sites. To see how many sites Optima Prime is monitoring versus the maximum number permitted by your license, select System Configuration > System Counts from the Optima Prime GUI. The System Counts dialog box opens, as shown in Figure 2-1.

Figure 2-1 System Counts Dialog Box

Obtaining a License FileIf your OMS server does not already have a license file, you can obtain one from Westell Customer Support. Customer Support will need the server ID 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 Prime.

Installing the License FileTo install the license file:

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

/opt/oms/config/server

2. Restart all processes by executing the following command:

optimacontroller restart

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

WESTELL.COM

1-800-377-8766

Page 2-7


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/log/optimainstaller/logs for details, then:

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

2. Execute the following command:

# 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 or /etc/hosts.

If an IP address or hostname has changed, see Using the Optima Config Utility.

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

# optimacontroller start

Obtaining Dell System Administration ToolsStarting with Optima Prime version 12.00, Optima builds no longer contain a snapshot of Dell system administration tools. If you are running Optima on Dell hardware, refer to the following sections of the Dell System Update web page:

Setup The repository

Installing DSU

Install OMSA

WESTELL.COM

Page 2-8

1-800-377-8766

https://linux.dell.com/repo/hardware/dsu/

https://linux.dell.com/repo/hardware/dsu/


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

AdaptersTo re-install any adapters used in Optima systems prior to Version 12.x, contact Westell Customer Service. The adapter names will be needed.

Clear Browser CachesAfter a new or updated version of Optima Prime is installed. all Optima Prime users should clear their browser cache to assure the best performance of the newly installed software.

Using Redirect for Optima Client ServicesWestell’s Redirect application provides Optima Prime client functionality for serial-to-IP remote access. Optima Prime clients need to have Redirect installed on their PC to launch applications such as ftp, Telnet, or PuTTy from Optima Prime.

Optima Prime Version 12.2x requires use of Redirect version 4.60. Earlier versions of Optima used Redirect version 4.50.

Refer to the Configuration Guide for your version of Redirect for installation and usage instructions.

WESTELL.COM

1-800-377-8766

Page 2-9

Optima Prime Version 12.2x System Administration GuideInstalling and Upgrading Optima Prime: Migrating Optima 11.50 Servers to Optima Prime

Migrating Optima 11.50 Servers to Optima Prime

Westell has special utilities for migrating data from Optima version 11.50 to a Red Hat 7.x server running Optima Prime 12.00. Westell also can re-install adapters used in Optima versions older than 12.x.

Use of the special utilities is necessary to upgrade from Optima version 11.50 to Optima Prime 12.00. That upgrade is required before Optima Prime Version 12.2x can be installed.

Older Optima installations must be upgraded to Version 11.50 before they can be upgraded to Optima Prime version 12.00.

For more information about the special utilities and the Optima Prime upgrade process, contact Westell Technical Support. Refer to Customer Assistance.

WESTELL.COM

Page 2-10

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideInstalling and Upgrading Optima Prime: Adding and Editing Servers with the Servers User Interface

Adding and Editing Servers with the Servers User InterfaceThe Servers User Interface is accessed from the System category of the Optima Prime Configuration menu. The interface, shown in Figure 2-2 below, performs these key functions:

Registers the DMC’s IP address(es) and faultname with the OMS

Creates a DMC Server element to represent events

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

Figure 2-2 The Servers user interface

The Servers interface performs functions which were performed with the dmcregistrar command prior to the issuance of Optima Prime Version 12.2x. The interface features include:

Add OMS button

This is used to provide the information needed to register the secondary OMS server in a replicated environment. This button is disabled if the OMS server has already been replicated, as shown above in Figure 2-2.

Add DMC button

This is used to provide the information needed to register a new DMC server. This accommodates new DMC server installations and the addition of backup

Click Add button to add server

Click pencil icon to edit server information Click terminal iconto launch SSH access

to server

WESTELL.COM

1-800-377-8766

Page 2-11


DMC servers when enabling replication. The Add DMC dialog box is shown below in Figure 2-3

Columns showing the Replication status and IP Addresses configured for each server.

SSH Launch icons for each IP Address. Clicking the icon resembling a terminal immediately to the left of a server’s Public or Private IP Address will launch an SSH connection to that server.

Edit icons for each server. Clicking the icon resembling a pencil will open the Edit Server dialog box with the editable fields for that server.

Delete icons for each server. Clicking the icon resembling a trash can will delete that server. A confirmation dialog will appear asking the user to confirm the decision to delete the server.

The Replication status column displays the following terms describing each OMS server’s replication status. The column will be blank in the OMS rows if replication has not been configured.

Notes: In a single server installation, the DMC will be added automatically with

private IP address 127.0.0.1. The user needs to edit the OMS server by providing the OMS server’s public IP address. Until this is done, Optima will return an event noting that the OMS server public IP address is missing.

In a single server installation, the DMC will have the same IP address as the OMS.

To Add a DMC Server

Replication Term Description

Active Server is running Optima processes and providing data via PostgreSQL to write-ahead log and database. Standby OMS database in sync with the Active OMS database.

Standby Server is configured to not run the Optima processes, but will receive streamed write-ahead logs and configuration updates to maintain a replicated system in case of failure of the active server.

Failed The OMS servers have been configured for replication, but it is not currently running correctly. In this case, check the events on the “Optima Server System” network elements for details on the error.

WESTELL.COM

Page 2-12

1-800-377-8766


The Servers interface lets users add the information needed to register a new DMC server. This same method is used whether it is a new DMC installation or the addition of a backup duplicate DMC server for replication. Follow these steps:

1. Click the Add DMC button to open the Add DMC dialog box shown in Figure 2-3.

Figure 2-3 The Add DMC dialog box

2. Select the OMS server from which the DMC server will be subtended from the drop-down list in the OMS field.

3. Add the desired DMC server name in the Name field.

4. Add the DMC server ID in the ID field. This needs to be the same as the dmc_name value entered when installing the server using optimainstaller.

Notes: Spacesare not permitted in the server ID name.

In replication, both the active (primary) and standby (secondary) OMS servers have DMC servers with the same ID and Public IP address subtended to them, although they are different DMC servers. The Servers interface will show DMC servers with the same ID and Public IP address subtended to both OMS servers. During replication failover, the DMC servers failover with their OMS server.

5. Add the server’s Private IP address. This is the address that will be used internally for Optima traffic to the server.

6. (Optional but strongly recommended) Add the server’s Public IP address. This is the address that would be used for external access to the server by devices monitored by the server.

Note: Although the Public IP address is optional in the sense that the system will

function without it, Westell recommends that the Public IP address be added at this point in the procedure. Adding the Public IP address at this

WESTELL.COM

1-800-377-8766

Page 2-13


point in the procedure will save time and trouble in case it becomes necessary in the future.

7. Click Save. The server information will be saved.

Once a DMC server’s information is saved as described above, a sphere icon representing the server appears in the Optima Prime Tree display of network elements as shown in Figure 2-4 below.Server status can be assessed at a glance by checking the Tree.

Figure 2-4 Network Element Tree showing DMC added via Server user interface

To Add an OMS ServerThe Add OMS button is only used in one situation: to register a secondary OMS server intended to be used as the standby in replication. Follow these steps:

1. Click the Add OMS button. The Add OMS dialog box opens as shown in Figure 2-5.

Figure 2-5 The Add OMS server dialog box

2. Add the server’s name in the Name field.

3. Add the server’s Public IP address. This is the address that will be used for external access to the server.

4. (Optional but strongly recommended) Add a Private IP address. This would be used internally for Optima traffic to the server.

DMC serveradded byServer user interface

Icon representing

WESTELL.COM

Page 2-14

1-800-377-8766


Note: Although the Private IP address is optional in the sense that the system

will function without it, Westell recommends that the Private IP address be added at this point in the procedure. Doing so will save time and trouble in case it becomes necessary in the future.

5. Click Save. The server information will be saved.

To edit server informationClick the pencil icon next to the server you want to edit. The editable fields including IP addresses will open in an Edit Server dialog box. Make the desired change(s) and click Save. The changes will be saved.

In situations where the server information cannot be edited, the Save button will be disabled.

To delete a serverTo delete a server, click the trash can icon on that server’s line. A confirmation dialog will appear asking the user to confirm the intention to delete.

To Access a Server Via SSHUsers with the Westell Redirect application installed with a program that supports SSH connections can access a server via SSH from the Manage Servers interface. To access a server, click the terminal icon to the left of either the public or private IP address. Redirect will attempt to open an SSH terminal connection to that IP address. The user will need to enter the user name and password for that address. The client computer must be in the same network as the server, or the client computer must be routable to the server IP address, for the SSH connection to function.

Refer as necessary to section Installing and Uninstalling Redirect on page 3-3.

Enabling Replication After Servers are RegisteredRefer to Chapter 6: Optima Prime Server Replication for instructions on enabling replication once all server information has been entered and saved in the Servers interface.

WESTELL.COM

1-800-377-8766

Page 2-15


WESTELL.COM

Page 2-16

1-800-377-8766

CHA

PTER 3

3

Optima Prime Server

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


Overview

System and Hardware Requirements

Executing Linux Commands

Page 3-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideOptima Prime Server: Overview

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

Figure 3-1 Optima Prime Servers

There is only one Optima Prime Management Server (OMS) in an Optima Prime 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 3-2

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideOptima Prime Server: Overview

Optima Prime Management Server (OMS)The OMS interfaces with clients. It does not interface directly with monitored devices. It maintains one database containing:

Performance, fault, and event data (forwarded from the DMC) for all monitored devices in the network.

Element configuration data.

An “Element Inventory” with element configuration information for all monitored devices in the network.

Data & Measurement Collector (DMC)The DMC servers interface with monitored devices. Each DMC, for only those devices it monitors, maintains:

A database containing configuration and status of IP connectivity (SNMP and ICMP), network element inventory, and alarm translation..

Device file backups and restore points.

Note: For more information on restore points, see the Optima Prime

User/Configuration Guide.

WESTELL.COM

1-800-377-8766

Page 3-3

Optima Prime Version 12.2x System Administration GuideOptima Prime Server: System and Hardware Requirements

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

Server SizeWestell recommends the following Dell PowerEdge R730xd servers (210-ADBC) for these respective network sizes:

Note: Contact Westell for sizing recommendations if you use direct-connect network

elements or adapters. Refer to Customer Assistance.

Basic Hardware Specifications for Optima ServersImportant: Contact Westell Customer Service for detailed specifications necessary

to assemble Optima Prime server configurations. Refer to Customer Assistance.

# of Remotes (max)Westell Part Number

OMS Server DMC Server

2500 DELLSVR-LA

2501-5000 DELLSVR-LA DELLSVR-MA

System ComponentsMinimum Requirements


Processor 16 cores 8 cores

RAM 64GB 32GB

Hard Drives 2.4TB 1.2TB

RAID RAID 10 RAID 10

Backup File Storage Westell recommends use of an external storage location for backup files.

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 Prime deployments.

WESTELL.COM

Page 3-4

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideOptima Prime Server: System and Hardware Requirements

Database storage Westell recommends use of an external storage location for the database. Virtual disks are not recommended.

System ComponentsMinimum Requirements


WESTELL.COM

1-800-377-8766

Page 3-5

Optima Prime Version 12.2x System Administration GuideOptima Prime Server: Executing Linux Commands

Executing Linux CommandsInstalling and administering the Optima Prime 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 > Utilities > Terminal

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

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

commands.

WESTELL.COM

Page 3-6

1-800-377-8766

CHA

PTER 4

Setting Up the Optima Prime Server

Depending upon your implementation, several tasks might need to be undertaken when you set up an Optima Prime server the first time. Such tasks are detailed in this chapter.


Changing the PostgreSQL Database Password

Setting Up Optima Prime in a Firewalled Environment

Adding and Editing Systems

Mapping Systems to DMCs

Configuring Default and Maximum Maintenance Mode Duration

Configuring and Enabling Trouble Tickets

Configuring Encrypted Passwords for Messaging Protocols

Page 4-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Changing the PostgreSQL Database Password

Changing the PostgreSQL Database 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 after Optima is installed:

1. Run the following command:

# setoptimadbpassword

2. Enter the new password when prompted:

Enter password: <password>

3. Confirm the new password when prompted:

Confirm password: <password>

4. When prompted to stop Optima to change the database password, enter y for yes.

5. The command line displays messages similar to the following:

To change the PostgreSQL database password during Optima installation, refer to Performing a Fresh Optima Prime Installation.

Changing Optima database password...Optima should be stopped to change the db password, do you want to continue?

(Y/N): y

Stopping all...ALTER ROLE

Starting all...Done changing the database password.

WESTELL.COM

Page 4-2

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Setting Up Optima Prime in a Firewalled Environment

Setting Up Optima Prime 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)

WESTELL.COM

1-800-377-8766

Page 4-3

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Adding and Editing Systems

Adding and Editing SystemsNetwork elements of type System are the highest level in the visible hierarchy shown in the Tree display. After installation, the Tree shows a single Optima Server System containing the OMS server, as shown in Figure 4-1 below. This portion of the Tree is maintained by Optima as it monitors its own OMS and the DMC(s). Customers can edit only the DMC server elements that appear here with the separate Servers dialog (see Adding and Editing Servers with the Servers User Interface on page 2-11).

Figure 4-1 The Optima Server System as it appears upon startup in the Tree

After installation, administrators should add more System NEs to organize the network, as shown in Figure 4-2 below.

Figure 4-2 System NEs System-EST and System-IST added at same hierarchy level as the Optima Server System

Systems are created and edited in Optima the same way as other Network Elements. (Configuration > Network Elements > Manage Elements > Add New. Select Kentrox System from the Type list; that Type adds the required WSystem NE category designation. Refer to Adding a Network Element and related sections of your current Optima Prime User/Configuration Guide.)

These new Systems for managing network elements need to be created before running the dmcsystemmanager utility to map systems to DMC servers.

Before running the dmcsystemmanager utility to map systems, 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 Prime 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 Prime

Created bydefault

System NEsadded byadministratorsto organizethe network

WESTELL.COM

Page 4-4

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Adding and Editing Systems

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 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. All NEs within a system need to be in the same time zone as the System NE. Multiple Systems can be within the same time zone.

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 Prime server and the user wants it to be hosted on a different DMC server, the user can use the dmcsystemmanager 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 Prime GUI to have the correct parent/child relationships.

WESTELL.COM

1-800-377-8766

Page 4-5

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Mapping Systems to DMCs

Mapping Systems to DMCsSystems are mapped to DMC servers by the use of the utility dmcsystemmanager.

dmcsystemmanagerThe dmcsystemmanager utility is available only on the OMS.

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-1 below.

Table 4-1 Optional dmcsystemmanager Arguments

Argument Description

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

-l Lists all DMCs and their system mappings.

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

-u Updates a DMC system mapping. Requires -f.

-f dmc_name Identifies the DMC update.

-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.

WESTELL.COM

Page 4-6

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Configuring Default and Maximum Maintenance Mode Duration

Configuring Default and Maximum Maintenance Mode Duration

Optima Prime’s Schedule NE Maintenance feature comes with factory default settings for a seven-day maintenance mode duration, as shown in Figure 4-3, and a maximum maintenance mode duration of 30 days. These defaults can be adjusted.

Figure 4-3 Schedule Maintenance dialog duration settings

To change the default duration:

In the /opt/oms/config/AFrame/system_configuration.properties file, set property global.ne_maintenance_window_default_duration to the desired number of days.

This example sets the default duration at 45 days:

global.ne_maintenance_window_default_duration=45

To change the default maximum duration:

In the /opt/oms/config/AFrame/system_configuration.properties file, set property global.ne_maintenance_window_max_duration to the desired number of days.

This example sets the maximum duration at 180 days:

global.ne_maintenance_window_max_duration=180

Restart oms-serverd to put the reconfigured default into effect.

Durationsetting

Factory defaultmaximumduration is 30 days

Factory defaultsetting is7 days

WESTELL.COM

1-800-377-8766

Page 4-7

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Configuring and Enabling Trouble Tickets

Configuring and Enabling Trouble TicketsFollow these steps to enable viewing of Trouble Tickets (shown below in Figure 4-4) via a URL:

1. Open /opt/oms/config/AFrame/system_configuration.properties

a.Edit the value of the property global.event.trouble_ticket_interface.enabled, and change it to true.

b.Edit the value of the property global.event.trouble_ticket_interface.urlTemplate. Change it to a template for the URL used for viewing trouble tickets.

Example template:

http://sdmausnoc01/MRcgi/MRlogin.pl?DA={0}DA2

In this example, the {0} indicates the location of the URL where the Ticket Number will be substituted.

c.Restart oms-serverd

2. Edit the /opt/oms/config/dnb/dnb_client.properties and add the appropriate forwarding configuration.

a.Restart oms-dnbd

3. If automatic ticket rules are desired, configure /opt/oms/config/dnb/alarmGroups.properties

a.Restart oms-faultd

b.Restart oms-dnbd

The Create Ticket function is now available for alarms.

WESTELL.COM

Page 4-8

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Configuring and Enabling Trouble Tickets

Figure 4-4 Site View with Trouble Tickets enabled

Additional information for users about the Trouble Ticket feature appears in the Site View Feature Areas section of the Optima Prime Version 12.2x User/Configuration Guide.

Sites with Trouble Tickets

Clicking Trouble Tickets in Alarms List opens ticket details in new browser

WESTELL.COM

1-800-377-8766

Page 4-9

Optima Prime Version 12.2x System Administration GuideSetting Up the Optima Prime Server: Configuring Encrypted Passwords for Messaging Protocols

Configuring Encrypted Passwords for Messaging ProtocolsOptima enables users to configure encrypted passwords for email and/or messaging application layer protocols SMTP, POP, SMPP, and SNMP, plus the FootPrints trouble-ticketing service. Encryption sets the password to an encoded (non-plain text) value that Optima can use instead of the readable value.

To configure an encrypted password:

1. Execute the following command as the root user:

optimapasswordencrypter

2. The following command response appears. Follow the prompt to select the desired protocol.

3. After entering the selection, the user is prompted to enter and re-enter the password to be encrypted, as shown below.

4. Restart Optima. The encrypted password will be in effect.

Refer to Configuring Email Notifications on page 5-14 for additional information on configuring SMTP email notifications.

# optimapasswordencrypter

Which password would you like to configure?

1) EMAIL_SMTP_PASSWORD2) EMAIL_POP_PASSWORD

3) SMPP_PASSWORD

4) SNMP_AUTH_PASSWORD5) SNMP_PRIV_PASSWORD

6) FOOTPRINTS_PASSWORD

Make a selection (1-6):

Make a selection (1-6): 2

You have selected EMAIL_POP_PASSWORD. Please confirm selection (Y/N): yEnter a password to encrypt:

Please re-enter password:Update complete. Please restart Optima for the changes to take effect.

WESTELL.COM

Page 4-10

1-800-377-8766

CHA

PTER 5

Optima Prime ServerAdministration and Process

Monitoring

This chapter explains ongoing administrative tasks and process monitoring pertaining to the Optima Prime server.


Ongoing Administrative Tasks

Process Monitoring

Page 5-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Administration and Process Monitoring: 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 Prime Service

Troubleshooting Using the RHEL Service Configuration Window

Using the Optima Network Check Utility

Using the Optima Config Utility

Using the Snapshot Utility

Accessing Logging Files

Backup and Restore

Inventory Importer and Exporter

Event Fix Actions Importer

Editing the IP Address and/or Hostname

Administering Permissions

Configuring Email Notifications

Configuring Notifications for Clears and Acknowledgements

Adjusting Data Retention Intervals

Adjusting the Memory Limit for Reports

Configuration to Show Priority and Outages in Site View

Configuration to Directly Connect DAS Site NEs to Optima

Global Event Filtering

Adding and Deleting Help Documents

Configuring the Map View

Starting and Stopping the Optima Prime 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:

# optimacontroller [start | stop | restart]

WESTELL.COM

Page 5-2

1-800-377-8766


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

# optimacontroller status

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:

# optimacontroller --help

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

services are available, especially if the Optima implementation involves many sites and monitored NEs. Users who log into the Optima GUI during this time and query for status of an NE may encounter a Server Error message. If this error occurs shortly after starting an Optima server, the user should wait several minutes, then try the 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 systemctl command. See Red Hat documentation for details.

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

Hostname information

Firewall status

HTTP connectivity

Optima’s SSL certificate

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

# optimanetworkcheck

WESTELL.COM

1-800-377-8766

Page 5-3


Using the Optima Config UtilityThe optimaconfig utility (located in /usr/sbin/) is used to update the server hostname in Optima configuration. It also is used to set the ip address in place of a hostname in NAT setup.

Usage: # optimaconfig [OPTIONS]

Options:

Follow these steps:

1. Before running optimaconfig, remember the settings in the following files by running the following commands:

Note: The third command below, beginning with # grep OPTIMA, needs to be

entered as one line in the CLI. It spans two lines here due to limited space.

# cat /etc/hosts

# cat /etc/sysconfig/network-script/ifcfg-<ifName>

# grep OPTIMA_EXTERNAL_IP

/opt/oms/config/AFrame/optima_web_config.properties

# grep DEFAULT_URL /opt/oms/config/AFrame/Autogen.properties

2. Run the following command to configure a different IP address for Optima configuration:

# optimaconfig -i <IP Address>

The output will display the following:

Option Description

-i IP address. The IP address to be set in Optima configurations in place of hostname. This option should be used in NAT setup. Use only IPv4 address.

-n Hostname. The host name to be set in Optima configurations. If the host same value is not specified, the hostname command output is set.

-h Help. Show this help message and exit.

WESTELL.COM

Page 5-4

1-800-377-8766


3. Verify Optima server configurations:

/etc/hosts remains unchanged

/etc/sysconfig/network-script/ifcfg-<ifName> remains unchanged.

/etc/sysconfig/omsPrefs has the following line:

export JBOSS_WEB_EXTERNAL_HOST="<IP Address>"

/opt/oms/config/AFrame/optima_web_config.properties has the following line:

OPTIMA_EXTERNAL_IP=<IP Address>

/opt/oms/config/AFrame/Autogen.properties has the following line:

DEFAULT_URL=https://<IP Address>/optima/runautogen.im?param_id=

4. Run the following command to configure a different hostname for Optima configuration:

# optimaconfig -n <hostname>

5. Verify Optima server configurations:

/etc/hosts remains unchanged

/etc/sysconfig/network-script/ifcfg-<ifName> remains unchanged.

/etc/sysconfig/omsPrefs has the following line:

export JBOSS_WEB_EXTERNAL_HOST="<hostname>"

/opt/oms/config/AFrame/optima_web_config.properties has the following line:

OPTIMA_EXTERNAL_IP=<hostname>

/opt/oms/config/AFrame/Autogen.properties has the following line:

DEFAULT_URL=https://<hostname>/optima/runautogen.im?param_id=

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. To take a snapshot, execute the following command as root:

# /usr/sbin/optimadiagsnapshot [ -l ]

Changing the Optima environment file...

Changing the JBOSS_WEB_EXTERNAL_HOST value to: “<IP Address>” in

/etc/sysconfig/omsPrefs file.

Successfully changed the /etc/sysconfig/omsPrefs fileChanging the Optima configurations...

Changing the host name in Optima configurations to: <IP Address>.

Successfully changed the Optima configurations.

WESTELL.COM

1-800-377-8766

Page 5-5


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

Accessing Logging FilesTable 5-1 on page 5-6 lists logging files that you may find useful when troubleshooting Optima servers.

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 downloads a Remote configuration

User schedules a job

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

Table 5-1 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

Page 5-6

1-800-377-8766


User manages or unmanages services

User launches an application via Optima

User changes the state of a site

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 Prime provides the optimabackup and optimarestore scripts to back up and restore the Optima Primedatabase and configurations. The optimabackup script saves a snapshot of Optima Prime 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.

WESTELL.COM

1-800-377-8766

Page 5-7


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

# optimabackup [options]

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

Daily BackupThere is a /etc/cron.d/optima file that runs optimabackup that causes an automatic backup of all the OMS and DMI data on a daily basis. By default, the backup runs at 4:00 a.m. daily. This can be changed by modifying the /etc/cron.d/optima file.

Running the Restore ScriptTo run the restore script, enter the following commands as root:

1. Execute the following command to stop Optima Prime processes:

# optimacontroller stop

2. Delete the contents of /u01/pgsqldata directory:

# cd /u01/pgsqldata

# rm -rf*

3. Execute the following commands to start postgres processes:

# optimacontroller start postgresql-9.5

4. Run the restore script:

# optimarestore

Note: To display help, enter -h.

5. Execute the following command to restart Optima processes:


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

Table 5-2 Optional optimabackup Arguments


-h Prints a help message.

WESTELL.COM

Page 5-8

1-800-377-8766


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

older version of Optima to a newer version.

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

protocol

role

signal

signalcategory

signaldefinition

unit

user

vendor

For export types signaldefinition, signal, signalcategory, measurement, user, and userrole, 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

WESTELL.COM

1-800-377-8766

Page 5-9


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.

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

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

Table 5-3 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.

-r, --role, -roles For export_type of role, specifies what roles to export, otherwise ignored. Cannot be used with all.

-u --user, -users, -roles

For export_type of role, specifies what roles to export, otherwise ignored. Cannot be used with all.

WESTELL.COM

Page 5-10

1-800-377-8766


measurement

measurementcategory

measurementtemplate

ne

neaccess

necategory

negroup

nenote

netype

netypeaccess

protocol

role

signal

signalcategory

signaldefinition

unit

user

vendor

For import types signaldefinition, signal, signalcategory, measurement, user, and user role, 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.

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

Table 5-4 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.

WESTELL.COM

1-800-377-8766

Page 5-11


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.

Event Fix Actions ImporterBeginning with Version 11.50, Optima provides Original Equipment Manufacturer’s (OEM) recommended fix actions for alarm situations involving their network elements. These fix actions appear as part of the Event Information Window. Instructions for users appear in the Optima User/Configuration Guide section Fix Actions in the Using the Event View chapter.

These OEM/vendor recommendations appear in CSV files supplied by the respective vendors. An Optima System Administrator needs to run the Event Fix Actions Importer script for the Fix Actions feature to function.

To run the Event Fix Actions Importer script, enter the following command as the optima user:

/usr/sbin/eventfixactionsimporter [action][options]

Actions are explained in Table 5-5.

-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.

Table 5-4 Optional optimainventoryimporter Arguments


Table 5-5 eventfixactionsimporter Action Commands

Action Command Description

-l Imports the fix actions from a csv file

WESTELL.COM

Page 5-12

1-800-377-8766


Optional arguments are explained in Table 5-6.

To see the eventfixactionsimporter csv file columns, refer to Event Fix Actions Importer CSV Columns.

Editing the IP Address and/or HostnameUse the standard Red Hat utilities to change the IP address or hostname. Run the optimaconfig utility to update Optima Prime’s configuration file to match the new values.

See Using the Optima Config Utility on page 5-4

Administering Measurement PartitionsFor efficiency, the collected measurement data is partitioned into database tables by day, and partitions more than 10 days old are compressed into columnar (cstore) format. This partitioning and compressing is handled automatically, but the state of these measurement partitions can be viewed or changed with the measurementpartitioner.sh program.

Note: If it becomes necessary to load (or reload) older measurement data into the

database, the partitions for those days must exist and be in the uncompressed state. This tool can be used to display or reconfigure those partitions.

Modify Partitions:

-P Purges the fix actions for vendor / family / model

Table 5-6 Optional eventfixactionsimporter Arguments


-f <fixactionsfile> The csv file to import the fix actions

-v <vendor> The vendor name for purge

-n <nefamily> The NE family name for purge

-m <model> The model name for purge

-c <class> The event class to be used for new event types imported through fix actions file. Defaults to Alarm

-h Print this message and exit

Table 5-5 eventfixactionsimporter Action Commands

Action Command Description

WESTELL.COM

1-800-377-8766

Page 5-13


/opt/oms/bin/measurementpartitioner.sh [OPTION] -s startDate -e endDate

/opt/oms/bin/measurementpartitioner.sh [OPTION] -s startDate -i interval

OPTION is one of:

-c Create partitions.

-d Delete partitions.

-z Convert partitions to CStore.

-x Convert partitions from CStore.

Parameters are:

startDate: starting date (MM/DD/YYYY)

endDate: ending date (MM/DD/YYYY)

interval: number of days (1..30)

List partitions:

/opt/oms/bin/measurementpartitioner.sh -l

Help:

/opt/oms/bin/measurementpartitioner.sh -h

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

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]"

WESTELL.COM

Page 5-14

1-800-377-8766


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:

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

7. Execute the following command as the root user:

/usr/sbin/optimacontroller restart

Configuring Notifications for Clears and AcknowledgementsBy default, Optima Prime 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 Prime to send notifications for clears and acknowledgements, open the following files:

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

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

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 the following 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)

WESTELL.COM

1-800-377-8766

Page 5-15


CONVERT_MEASUREMENT_AFTER_DAYS controls the age at which raw measurements are compressed to save database space (default 10 days; must be greater than 7 days)

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:

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

5. Execute these commands as the root user:


Adjusting the Memory Limit for ReportsOptima Prime 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.

WESTELL.COM

Page 5-16

1-800-377-8766


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:


Configuration to Show Priority and Outages in Site View

To configure Site View to include the Priority and Outages column displays, a System Administrator needs to modify this configuration file:

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

The following contents need to be added to that file:

priority.enabled=true

priority.types=DAS

priority.type.default=DAS

priority.type.DAS.neCategory=DASRemoteUnit

priority.type.DAS.eventClass=State Transition

priority.type.DAS.upEventName=statusPoint.Availability.Up

priority.type.DAS.outageEventName=statusPoint.Availability.Down

priority.type.DAS.level.1=100




priority.type.DAS.specialModeEnabled=true

WESTELL.COM

1-800-377-8766

Page 5-17


When this is completed successfully and the Optima Prime system is refreshed, the Priority, Outages, and % Outage columns will appear in the Sites List. Without this configuration, those columns do not appear in Site View.

The above DAS.level configuration parameters set the percentages used as criteria for the four priority levels shown in the Priority Key Display (shown below in Figure 5-1), and can be adjusted as desired. For example, to change the Level 1 Priority threshold from 100% outage to 80% outage, change that line to <priority.type.DAS.level.1=80>.

Figure 5-1 Priority Key Display

For additional information about directly connecting NEs, refer to section Configuring a DAS Site to Directly Connect NEs in chapter Configuring Network Elements in the Optima User/Configuration Guide.

Configuration to Directly Connect DAS Site NEs to OptimaOptima Prime provides the capability to monitor Distributed Antenna Systems (DAS) uptime and downtime by component, by carrier, and by site. This is described in the Optima User/Configuration Guide in the chapter Configuring DAS With Carrier Assignments and Uptime Measurements.

In certain situations, it is advantageous to directly connect NEs to Optima without using a Remote device. DAS units, for example, can function effectively as “direct-connect” NEs. These NEs need to be addressed and accessible via the Optima user’s IP network.

The direct connection process is described in the Optima User/Configuration Guide (Version 11.5x or newer) in section Configuring a DAS Site to Directly Connect NEs in the chapter titled “Configuring Network Elements,” and in the chapter titled, “Configuring DAS with Carrier Assignments and Uptime Measurements.”

Modify Configuration File

Before starting to configure a DAS site, assign carriers, or undertake direct connections, a System Administrator needs to modify this configuration file:

WESTELL.COM

Page 5-18

1-800-377-8766


/opt/dmi/ext/module/conf/directconnect.cfg

The following contents need to be added to that file:

<?xml version=’1.0’ encoding=’UTF-8’?>

<!DOCTYPE properties SYSTEM “http://java.sun.com/dtd/properties.dtd”>

<properties>

<entry key=’kitsEnabled’>DASMonitoring</entry>

</properties>

Restart DMI:

optimacontroller restart dmi

When this is completed successfully and the Optima system is refreshed, the network element “DAS” will appear on the Optima Site Configuration menu. If this procedure is not completed successfully, the Site Configuration menu will show no NEs.

Change Available DAS Carriers

To change the carriers available in the Carrier Assignment window, a System Administrator needs to modify this configuration file to add or delete carriers as needed:

/opt/oms/config/AFrame/carriers.properties

The Carrier Assignment window will display the altered menu of carriers when the server is restarted.

Global Event FilteringOptima Prime provides the ability to apply customizable event filtering and mediation rules to all events. These filtering rules apply to all network elements that match the specified criteria.

These Global Event Filters are intended to ease system administration workloads by alleviating the need for site-by-site filter rule-setting or editing with every new site or network element installation. This is especially helpful for systems with large numbers of sites or network elements, and systems experiencing rapid growth.

Unlike the event filtering and mediation rules that Optima Prime users can create and apply site-by-site via the Optima Prime GUI, Global Event Filters work on a system-wide scale. Global Event Filters can be configured for any or all network elements and events. Any event matching the configured NE and event criteria can be dropped or reclassified under a different severity level.

All server configuration to create, modify, and manage Global Event Filters requires a system administrator.

WESTELL.COM

1-800-377-8766

Page 5-19


What Global Event Filtering DoesEach Global Event Filter rule has three components:

Network element matching criteria (optional)

Event matching criteria (optional)

Action to be taken (required)

When a Global Event Filtering rule is enabled, all incoming events’ source network elements will be checked against NE matching criteria. This criteria can include:

Static Network Element fault name

Network element fault name pattern

When a Global Event Filtering rule is enabled, all incoming events’ attributes will be checked against event matching criteria. This criteria can include:

Event Type

Event Class (Alarm, Alert, Call Failure, Drop Call, Outage, and/or State Transition)

Event Short Message

For an event to be considered a match, all configured criteria in a Global Event Filtering rule must match the event attributes. Such a match is needed before the Global Event Filtering rule’s specified action is taken. NE and event criteria are optional components of a global filtering rule. If the rule does not include configured NE and/or event criteria, Global Event Filtering shall consider every event to be a match, and no filtering will take place. For example, if the rule does not specify an event class, events of all classes shall be considered matches -- and other rule criteria will be needed to narrow the scope of events down to just those desired for filtration.

One filter action is required for each Global Event Filtering Rule:

Drop Event (aka Ignore event)

Change event severity

Global Event Filtering rules that change event severity must include the target severity (Unknown, OK, Information, Harmless, Warning, Minor, Major, or Critical).

Global Event Filtering ConfigurationGlobal Event Filter configuration is stored in /opt/oms/config/fault/filter.properties.

All configuration changes require a restart of oms-faultd.

To enable the filter, change filter.enabled=false to filter.enabled=true.

WESTELL.COM

Page 5-20

1-800-377-8766


Action configuration (the action to be taken in response when an event meets the filtering criteria) is added by appending the rule name and properties after filter.rule, as follows:

filter.rule.<rule name>.action=<action>

For example, here is the action command line for a filter rule called CabinetDoor which specifies that any cabinet door events are to be dropped:

filter.rule.CabinetDoor.action=drop

Global filtering criteria are added in command lines specifying Network Element and Event criteria, as follows:

filter.rule.<rule name>.<NE criteria or event criteria>=<criteria>

For example, here are the respective commands setting CabinetDoor criteria that the staticNeFaultName is Site57DoorSensor and the event Class is Alarm:

filter.rule.CabinetDoor.staticNeFaultName=Site57DoorSensor

filter.rule.CabinetDoor.eventClass=Alarm

Some configuration properties allow a comma-separated list of multiple possible criterion matches, and some do not. See the “List Allowed” column in the following Table 5-7:

Table 5-7 Available Global Event Filtering Rule Properties

Property Type

PropertyList allowed

Description

Network Element Criteria

staticNeFaultName no Checks whether the event’s source NE fault name matches

neFaultNameRegex no Checks whether the event’s source NE fault name matches this regular expression

Event Criteria

eventClass yes Checks whether the event’s Class matches any listed Classes

eventType yes Checks whether the event’s Type matches any listed Types

shortMessageContains no Checks whether the event’s short message includes a match

WESTELL.COM

1-800-377-8766

Page 5-21


As rules are defined, they must be added to the comma-separated list on the filter.rules line. This line specifies all enabled rules. By removing a rule from the list, a system administrator can disable a rule without deleting it. For example, the line filter.rules=CabinetDoor,ModuleEvents will enable the rules named CabinetDoor and ModuleEvents. If the system administrator removes ModuleEvents from the line, the CabinetDoor rule would continue to be in effect.

Sample Global Event Filtering ConfigurationsTo enable the filter with multiple rule definitions enabled:

filter.enabled=true

filter.rules=Monitor,SNMPDown,CabinetDoor,Fuel

To define a rule named SNMPDown to drop all ServiceDown alarms containing the message “SNMP is down” for all Network Elements with a fault name ending in “Remote”:

filter.rule.SNMPDown.action=drop

filter.rule.SNMPDown.staticNeFaultName-Remote

filter.rule.SNMPDown.eventClass=Alarm

filter.rule.SNMPDown.eventType=ServiceDown

filter.rule.SNMPDown.shortMessageContains=SNMP is down

To define a rule named Fuel to change the severity to Information for all lowFuel alarms for all Network Elements with a fault name ending in “fuelTank”:

filter.rule.Fuel.action=changeSeverity

filter.rule.Fuel.changeSeverityTo=Information

filter.rule.Fuel.staticNeFaultName=fuelTank

Action

action no Action to be taken in response to events matching rule criteria. Must be either drop or changeSeverity. To use changeSeverity, the changeSeverityTo property also must be configured.

changeSeverityTo no The severity setting to be applied to events matching rule criteria when the rule action is changeSeverity. Must be either Unknown, OK, Information, Harmless, Warning, Minor, Major, or Critical.

Table 5-7 Available Global Event Filtering Rule Properties

Property Type

PropertyList allowed

Description

WESTELL.COM

Page 5-22

1-800-377-8766


filter.rule.Fuel.eventClass=Alarm

filter.rule.Fuel.eventType=LowFuel

To define a rule named Communication to drop all Communication alarms for all Network Elements whose fault names match a regular expression: (In this example, the regular expression will match a fault name that begins with any number of characters and ends with the text “PowerDetection” or “PowerDistribution.”)

filter.rule.Communication.action=drop

filter.rule.Communication.neFaultNameRegex=.*PowerDetection|.*PowerDistribution

filter.rule.Communication.eventClass=Alarm

filter.rule.Communication.eventType=Communication

Note: Global Event Filters do not support alarm debouncing. Use the Event Filtering

and Mediation page in the Optima Prime user interface for alarm debouncing. Refer to the Optima Prime User/Configuration Guide section Adding a New Event Filtering Rule.

Adding and Deleting Help DocumentsOptima Prime System Administrators can post documents accessible to users via the Help menu. These Help Documents can include user guides, reference materials, or any .pdf or .xls documents that would be helpful to system users.

System administrators can load Help Documents to this folder:

/var/opt/oms/documentuploads

Documents loaded in this folder appear on a Documents list when an Optima Prime user selects Help > Documents. Users can open the documents in a browser window or download them.

System Administrators can remove Help Documents from the Documents list by removing them from the folder listed above.

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

You can configure map parameters such as the default map location and zoom threshold by editing the appropriate values for some properties 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.

global.map.zoom-threshold=10

WESTELL.COM

1-800-377-8766

Page 5-23


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

See Table 5-8 below for an explanation of the parameters.

Table 5-8 Map Configuration Parameters

Parameter Description

global.map.zoom-threshold Specifies the zoom level at which the Map View switches from displaying sites (Figure 5-2 on page 5-25) to displaying clusters (Figure 5-3 on page 5-26) when the user zooms out. Valid values are 0 (maximum zoom-out) to 20 (maximum zoom-in). Supported zoom levels vary with map type.

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 Prime User/Configuration 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: roadmap (ROADMAP) satellite (SATELLITE_MAP) hybrid (HYBRID_MAP) terrain (TERRAIN_MAP)

WESTELL.COM

Page 5-24

1-800-377-8766


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


Contact Westell to register your server for map usage. Refer to Customer Assistance.

Figure 5-2 Map View (Site Display Mode)

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

Table 5-8 Map Configuration Parameters (Continued)

Parameter Description

WESTELL.COM

1-800-377-8766

Page 5-25


Figure 5-3 Map View (Region Display Mode)

Customizing Default User Interface PreferencesOptima Prime users can set default values for certain user preferences. These settings will always take precedence, and other default setting changes will not affect them. These are shown in Table 5-9 below:

Table 5-9 Optima Prime User Interface Preference Defaults

PreferenceDefault Value

Description

elementNameReductionEnabled true Reduces network element names when displayed in the context of their parent.

hideBannerEnabled false Hides top Optima Prime banner

siteViewAutoRefreshEnabled false Auto-refreshes Site View

siteViewIncludeAllSitesEnabled false Displays all sites in the Site View Site List regardless of the presence of pending alarms

siteViewStatusPointsEnabled false Includes Status Points in the Site View Alarms grid

WESTELL.COM

Page 5-26

1-800-377-8766


Any of these supported properties can be specified in /opt/oms/config/server/gui.properties. Properties not listed in the file will fall back to the defaults shown in Table 5-9. Changes to these properties will take effect the next time the user logs in.

Property setting must be prepended with gui.defaults.userPrefs, as shown in the following examples.

ExamplesThis changes the default setting to always hide the top Optima Prime banner:

gui.defaults.userPrefs.hideBannerEnabled=true

This will cause the parent NE name to appear with its child NEs in the Tree:

gui.defaults.userPrefs.elementNameReductionEnabled=false

siteViewAlarmGroupingEnabled false Allows user to turn on grouping mode in Site View Alarms grid

Table 5-9 Optima Prime User Interface Preference Defaults

PreferenceDefault Value

Description

WESTELL.COM

1-800-377-8766

Page 5-27

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Administration and Process Monitoring: Process Monitoring

Process MonitoringOptima Prime includes the following self-monitoring daemons:

Optima Server Monitor

Fault Generator

Process Monitoring Log Files

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 Prime on a non-standard server (as identified in System and Hardware Requirements on page 3-4) will not receive Optima Server Monitor events or warnings.

See Obtaining Dell System Administration Tools on page 2-8.

Analog and Discrete ResourcesSome resources (analog) are monitored as to whether their performance levels fall within a normal threshold. These are listed in Table 5-10 on page 5-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 5-11 on page 5-29.

Terms in these tables are explained in Table 5-12 on page 5-29.

WESTELL.COM

Page 5-28

1-800-377-8766


Table 5-10 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 5-11 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

Table 5-12 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).

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.

WESTELL.COM

1-800-377-8766

Page 5-29


Fault GeneratorThe Fault Generator daemon performs out-of-band notifications for Optima Prime system events generated by the Optima Server Monitor daemon. 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 Prime 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.

Process Monitoring Log FilesLog files for process monitoring include:

/var/log/optimaservermonitor/optimaservermonitor.log

/var/log/faultgenerator/faultgend.log

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 5-12 Optima Server Monitor Terms and Descriptions (Continued)

Term Description

WESTELL.COM

Page 5-30

1-800-377-8766

CHA

PTER 6

6

Optima Prime Server Replication

This chapter explains the Optima Prime server replication feature.


Overview

Replication Prerequisites

Commands Used in Replication

Server Replication Procedures

Page 6-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Replication: Overview

OverviewThe Optima Prime Replication feature (also called the Enhanced Disaster Recovery feature) provides a “warm standby” OMS server with a replication of the active OMS server database. The standby server can be promoted promptly to work as the active server in case the active server fails. This can be done much more quickly and easily than the alternative process of restoring a copy of the failed server’s database and configuration files onto a backup server, which can interrupt Optima processes for hours.

Once the demoted server is repaired, the replication feature enables the system administrator to either promote it back to active status (and switch the promoted server back to standby status) or retain it as the new standby server.

The replication feature, introduced with Optima Prime Version 12.20, involves the use of CLI commands new to Optima. It also requires using the Servers User Interface page also introduced with Version 12.20 to manage servers. The Servers User Interface lets users view a server’s Replication status, and eases the process of adding or deleting OMS and/or DMC servers and editing server information.

This document will detail the steps to enable and maintain database and file replication across two database servers.

WESTELL.COM

Page 6-2

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Replication: Replication Prerequisites

Page 6-3

Replication PrerequisitesThe following conditions must exist for the Optima Prime replication feature to be utilized:

Both OMS servers must be running the same rpm build of Optima Prime.

Both OMS servers must be configured with the same Optima database password.

The OMS servers should have IP routes to each other. This could be through an internal IP network.

Both servers must be configured with the same license limits.

If any adapters are in use, each DMC server pair must be configured with the same adapters.

The new Server page in the web user interface must list two OMS servers and two DMC servers for each DMC ID. All servers must be configured with appropriate IP addresses.

The Linux postgres user should have a password configured on both OMS servers.

Authenticated SSH access must function for root and postgres between the two servers. The replicationmanager script will prompt the user with the necessary setupauthorizedkeys commands if this has not been set up.

Because the replicationmanager stops the Optima processes on the OMS, the processes on DMCs should be stopped before running this command. Optima processes should only be started on the DMC servers under the currently active OMS server.

Important: Be sure to stop DMC processes before running the replicationmanager script, as specified in the paragraph above.

Assigning a password to postgresRed Hat Linux does not initially give a password to the postgres user. For the PostgreSQL services to communicate with each other securely for replication, the Linux postgres user needs to be given a password on both servers. The password will be necessary for the setupauthorizedkeys command during the replication enable process.

This can be done by the supervisor:

# passwd postgres

Changing password for user postgres.

New password: <password>

Retype new password: <password>

passwd: all authentication tokens updated successfully.

WESTELL.COM

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Replication: Commands Used in Replication

Commands Used in ReplicationThe following commands are used in conjunction with the replication feature. All are new in Optima Prime Version 12.20, and accommodate replication.

All replication commands are run as user root.

setupauthorizedkeys

DescriptionThis command updates the SSH authorized keys, freeing users from the need to enter a password to connect to a specified authorized address. This is necessary for replication, because users root and postgres must be able to SSH in both directions between the active and standby OMS servers.

SSH authorized keys must be set up for both the root and postgres users on both OMS servers for replication to function. Until all of these keys are set up, running the command replicationmanager enable will generate prompts for each setupauthorizedkeys command that is needed to complete the setup of all of these authorized keys.

Each time the setupauthorizedkeys command is run, a prompt will ask for the target user’s password.

Formats# setupauthorizedkeys [-c] <target_address>

Parameters

ExampleThe following example sets up an authorized key from user root to a server with the IP address 10.34.3.112. The command is followed by the CLI response including the prompt for the target user’s password:

-c Checks to see whether the specified IP address is already set up on the server with an authorized key

target_address IP address of the server being authorized for SSH access without a password

WESTELL.COM

Page 6-4

1-800-377-8766


replicationmanager

DescriptionThis command is the user interface that manages replication processes.

Important: The user must be certain that all replicationmanager commands are run on the correct server.

All DMC services must be stopped when running replicationmanager to change the active database.

Formats# replicationmanager

enablepromoterebuilddisablestatus

Parameters

# setupauthorizedkeys 10.34.3.112

/usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter

out any that are already installed

/usr/bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys

[email protected]’s password:

Number of key(s) added: 1

enable Enables replication from the server on which the command is run to a standby server. This is the replicationmanager command a user runs to first establish replication. The command initiates actions to establish secure SSH connections, set up replication, destroy and rebuild the target standby server database in read-only mode, back up the standby server database, and set up PostgreSQL configuration on the standby server. When the process concludes, the user is informed that the replication setup was completed successfully, the active and standby servers’ databases are functioning, the active server’s processes are enabled, the standby server’s processes are disabled, and all functions are starting.

WESTELL.COM

1-800-377-8766

Page 6-5


Examples: replication enableThe following example shows the replication enable command followed by the CLI response prompting a setupauthorizedkeys command to establish a secure SSH connection between the servers.

To continue replication setup after receiving the response shown above, the user needs to run this setupauthorizedkeys command as the specified user (root@primary-oms) with the specified argument (10.34.59.3). The command will prompt for a password, and will store its authenticated key. After completing this, the user must run the replicationmanager enable command again, and might receive another similar Authenticated ssh not configured message. The user might need to repeat this process several times until all of the SSH connections are set up.

promote Promotes the standby server upon which the command is run to active status by changing the database to read-write and enabling Optima service. This can be run whether or not the other server is available. If the other server remains reachable, the command will attempt to stop and disable the services on the demoted server, and will attempt a database rebuild of the other server. If the other server is not reachable, the command will disable replication between the two servers.

rebuild Resyncs a database on the server upon which the command is run from the server that is currently active. This re-establishes replication in the reverse direction, assigning the repaired server the standby role (read only) and keeping the promoted server in the active role (read-write).

disable Disables the replication setup. Use this command to turn off replication between the servers.

status Reports IP addresses, database state, and process state for replication.

# replicationmanager enableChecking state of servers...

Authenticated ssh not configured for user root from 10.34.3.112 to 10.34.59.3.

As 10.34.3.112, run: /opt/oms/bin/setupauthorizedkeys 10.34.59.3

WESTELL.COM

Page 6-6

1-800-377-8766


The following example shows the replication enable command followed by the CLI response as replication is set up, including a user prompt.

# replicationmanager enable

Address: 10.34.59.3, Replication not configured, Processes enabledAddress: 10.34.3.112, Replication not configured, Processes enabled

Checking state of servers...

Stopping all...Stopping all...

Starting replication setup from 10.34.59.3 to 10.34.3.112

Remote server (10.34.3.112) is running in read-write mode.Proceeding will destroy and rebuild the database in read-only mode.

Are you sure you want to continue with replication set up (Y/n)?: y

Setting up PostgreSQL replication configuration on local 10.34.59.3Restarting local database

Starting Optima on local 10.34.59.3

Starting all...Users may now use the Optima system on 10.34.59.3 while it backs up to

10.34.3.112

Setting up PostgreSQL replication configuration on server 10.34.3.112transaction log start point: 17/7C000028 on timeline 6

pg_basebackup: starting background WAL receiver

2312067/2312067 kB (100%), 1/1 tablespace transaction log end point: 17/7C2A2270

pg_basebackup: waiting for background process to finish streaming ...

pg_basebackup: base backup completedCreating replication slot on local database

Starting database on 10.34.3.112

Replication is working properly from 10.34.59.3 to 10.34.3.112Replication set up and running successfully

Address: 10.34.59.3, Database is active, Processes enabled

Address: 10.34.3.112, Database is in standby, Processes disabled

WESTELL.COM

1-800-377-8766

Page 6-7


Examples: replication promoteThe following examples show the replicationmanager promote command in the two scenarios when the other server is reachable and not reachable.

Example: replicationmanager statusThe following example shows a response to the replicationmanager status command:

# replicationmanager promoteAddress: 10.34.59.3, Database is active, Processes enabled



Are you sure you want to promote this server (10.34.3.112) (Y/n)?

Starting promotion of on server 10.34.3.112server promoting

Promotion of 10.34.3.112 completed successfully

Stopping all...Starting rebuild of 10.34.59.3 from 10.34.3.112

Restarting active server (10.34.3.112) with archive command enabled

Users may now use the Optima system on 10.34.3.112 while it rebuilds 10.34.59.3Applying pg_rewind on standby server (10.34.59.3).

servers diverged at WAL position 17/90175E10 on timeline 7

rewinding from last common checkpoint at 17/90000028 on timeline 7Done!

Starting standby server (10.34.59.3)

Rebuild of 10.34.59.3 completed successfullyThe demoted server (10.34.59.3) has been rebuilt from this server (10.34.3.112)

and replication has been re-established from 10.34.3.112 to 10.34.59.3.

Address: 10.34.59.3, Database is in standby, Processes disabledAddress: 10.34.3.112, Database is active, Processes enabled

# replicationmanager promote

Address: 10.34.3.112, Database is in standby, Processes disabledAddress: 10.34.59.3, Cannot sshStopping all...The server to be demoted (10.34.59.3) is not reachable,so its services cannot be checked or disabled.Are you sure you want to promote this server (10.34.3.112) (Y/n)? yStarting promotion of on server 10.34.3.112server promotingServer 10.34.59.3 unreachable, cannot disable services.Run 'optimadaemonregistrar disable' on that server (10.34.59.3) as soon as possible.Promotion of 10.34.3.112 completed successfullyDisabling replication on 10.34.3.112.Stopping all...Could not remove replication configuration on unreachable 10.34.59.3.The demoted server (10.34.59.3) is not reachable to re-enable replication.Run 'replicationmanager enable' on THIS server (10.34.3.112) later when the otherserver is back online and ready to receive a complete backup from this server.Starting all...Address: 10.34.3.112, Replication not configured, Processes enabledAddress: 10.34.59.3, Cannot ssh

WESTELL.COM

Page 6-8

1-800-377-8766


Example: replicationmanager disableThe following example shows a response to the replicationmanager disable command:

optimadaemonregistrarThe optimadaemonregistrar command enables or disables Optima services on servers. Its typical uses in the replication environment are to temporarily enable or disable processes in a server under repair to obtain diagnostic information or to prevent users from accessing the wrong server.

Formats# optimadaemonregistrar

enabledisablestatus

Parameters

ExamplesThe following example shows commands and responses when a user checks the status of a server under repair and then enables processes in that server for diagnostic purposes:

# replicationmanager status

Address: 10.34.59.3, Replication not configured, Processes enabled

Address: 10.34.3.112, Replication not configured, Processes disabled

Optima not configured for replication.

# replicationmanager statusAddress: 10.34.59.3, Database is active, Processes enabled


Disabling replication on 10.34.59.3. Stopping all...Disabling replication on 10.34.3.112. Stopping all...


Address: 10.34.3.112, Replication not enabled, Processes disabled

enable Enables Optima processes in a server.

disable Disables Optima processes in a server.

status Displays the status -- enabled or disabled -- of Optima processes in a server.

WESTELL.COM

1-800-377-8766

Page 6-9


Important: Care should be taken when re-enabling processes after replicationmanager has disabled them:

When replication is running, if a user tries to start a standby server, the Optima processes will fail with the error Cannot start service while database is standby. DMC processes should never run while the OMS server they point to is in standby.

When replication is not running, such as after the command replicationmanager disable is executed, the two servers are independent, and both could be started. However, it is very important that all users be directed to the server considered the authority . If activity occurs on both servers, the databases and file systems will diverge, and any changes to the non-authority server will be lost when replication is re-enabled or rebuilt.

# optimadaemonregistrar statusProcesses disabled

# optimadaemonregistrar enable

# optimadaemonregistrar statusProcesses enabled

WESTELL.COM

Page 6-10

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideOptima Prime Server Replication: Server Replication Procedures

Page 6-11

Server Replication ProceduresFollow these procedures for Optima Prime server replication. The examples show replication enabled on the servers with IP addresses 10.34.59.3 (The “Authority” server) and 10.34.3.112. After replication is first enabled, as illustrated in Figure 6-4, the former server’s Replication status will be Active and the latter server’s status will be Standby.

Server Replication IllustrationsThe processes and scenarios involved with OMS server replication are illustrated in Figures interspersed throughout this section. Each figure shows Servers A and B side by side as they transition from one replication state in the top of the figure to the next replication state below. The servers’ roles and processes change as they progress through the different replication states.

In each Figure, the top of each server is labeled with that server’s ID (the red letter) and present role in replication. The server components and processes are explained in the graphic key in Figure 6-1.

Figure 6-1 Key to server illustrations used in this section

The replication steps and processes are illustrated in the following sections:

Setting Up and Enabling Replication

Promoting the Standby Server when Active Server Fails

Promotion Scenario 1: Promote Standby and Rebuild Replication Now

Promotion Scenario 2: Promote Standby and Re-enable Replication Later

In Case of Standby Server Failure

Reversing Replicated Servers to Original Roles

Manually Disabling Replication

DB

Optima

PostgreSQL

WAL

A AuthorityServer ID

Optima Services

PostgreSQL Service

Server Database Write-Ahead Log Files

Red arrowsrepresent normaldata transfers

Red arrows withdashed shafts representdata transmission termination

Present Server Role

(Dashed borderwhen disabled)

WESTELL.COM

1-800-377-8766


Setting Up and Enabling ReplicationThe initial setup and enabling of replication is described below and illustrated in Figure 6-4 on page 6-15. Follow these steps:

1. Before enabling replication, it is advisable to check the servers’ replication status with the command # replicationmanager status. The command can be run on either one of the servers and will report the status of both servers.

In the above example, the command response shows that both servers have IP addresses, processes are enabled, replication is not configured, and Optima is not configured for replication. Those are the conditions needed to initially enable replication.

Tip: While it is possible to use Optima during part of the replication process, it is advisable to undertake this procedure during off hours when there are few users on the system.

2. The next step is to run the replication enable command on the Authority server. The first time replicationmanager runs, the user will be prompted to set up authorized SSH keys with the setupauthorizedkeys command, as shown below:

3. The user might need to run the setupauthorizedkey command multiple times on both servers for both the root and postgres users. The user will be prompted to set up each of the SSH connections depicted by red and green arrows in Figure 6-2 below.

# replicationmanager status

Address: 10.34.59.3, Replication not configured, Processes enabledAddress: 10.34.3.112, Replication not configured, Processes enabled

Optima not configured for replication.

# replicationmanager enable

Checking state of servers...

Authenticated ssh not configured for user root from primary-oms to 10.34.59.3.As root@primary-oms, run: /opt/oms/bin/setupauthorizedkeys 10.34.59.3

WESTELL.COM

Page 6-12

1-800-377-8766


Figure 6-2 Authorized SSH connections required for replication

Each time authorized key is added, the user is prompted to confirm access authorization by entering the password for the target IP address, as shown below:

4. After all of the authorized keys are set up, the replicationmanager enable command will proceed to set up replication. The command line will display response similar to that shown below, including the confirmation prompt following the Starting replication setup message:

# /opt/oms/bin/setupauthorizedkeys 10.34.59.3

/usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter

out any that are already installed/usr/bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are

prompted now it is to install the new keys

[email protected]'s password:

Number of key(s) added: 1

Now try logging into the machine, with: "ssh '10.34.59.3'"

and check to make sure that only the key(s) you wanted were added.

Authenticated ssh successfully configured for user root from primary-oms to

10.34.59.3.

root

postgres

A Active

10.34.59.3

root

postgres

B Standby

10.34.3.112

WESTELL.COM

1-800-377-8766

Page 6-13

mailto:[email protected]'s


Depending on the size of the database being replicated, execution of the replication enable command might require hours to complete. However, users may resume using Optima after receiving the message, ”Users may now use the Optima system on <activeserver> while it backs up to <standby

server>.”

5. The Servers user interface should display the Replication status Active for the server with IP address 10.34.59.3 and Standby for the server with IP address 10.34.3.112. That confirms that replication has been enabled and the active server is being replicated by the standby server. Optima will monitor the state of the replication.

If replication fails, Optima will generate an event on the Optima Server System network element (see Figure 6-3) and the Servers user interface will display “Failed” for the two OMS servers.

# replicationmanager enableAddress: 10.34.59.3, Replication not configured, Processes enabled


Checking state of servers...Stopping all...

Stopping all...

Starting replication setup from 10.34.59.3 to 10.34.3.112Remote server (10.34.3.112) is running in read-write mode.

Proceeding will destroy and rebuild the database in read-only mode.

Are you sure you want to continue with replication set up (Y/n)?: ySetting up PostgreSQL replication configuration on local 10.34.59.3

Restarting local database

Starting Optima on local 10.34.59.3Starting all...

Users may now use the Optima system on 10.34.59.3 while it backs up to

10.34.3.112Setting up PostgreSQL replication configuration on server 10.34.3.112

transaction log start point: 17/7C000028 on timeline 6

pg_basebackup: starting background WAL receiver2312067/2312067 kB (100%), 1/1 tablespace

transaction log end point: 17/7C2A2270

pg_basebackup: waiting for background process to finish streaming ...pg_basebackup: base backup completed

Creating replication slot on local database

Starting database on 10.34.3.112Replication is working properly from 10.34.59.3 to 10.34.3.112

Replication set up and running successfully

Address: 10.34.59.3, Database is active, Processes enabledAddress: 10.34.3.112, Database is in standby, Processes disabled

WESTELL.COM

Page 6-14

1-800-377-8766


Figure 6-3 Replication failure event as presented in an Event Information Window

Figure 6-4 shows servers ready to set up replication on top. When the replication enable command is executed on the Authority server (server A), the processes transition to the “Replication Enabled” state shown below.

Figure 6-4 Enabling replication for OMS servers

DB

Optima

PostgreSQL

WAL DB

PostgreSQL

WAL

DB

PostgreSQL

WAL DB

PostgreSQL

WAL

A Active B Standby Active server:

Standby server:

A Authority B Empty Authority server:

Empty server:

Optima

replicationmanager enablecommand run on Authority server

Optima Optima

Optima processes are running. Servercontains the database to be backedup by the other server.

Empty database or new install orexisting server to be overwritten.

OMS data flows to write-ahead logand database via PostgreSQL.

Database is read-only and Optimaprocesses are disabled. PostgreSQLreceives data from Active server’sWAL files and updates standbyserver’s database.

WESTELL.COM

1-800-377-8766

Page 6-15


Important: When the OMS server replication feature is in use, any upgrades made to one server involved with replication must also be made to the other server. Optima will prevent replication from starting in the event of mismatching server upgrades. Westell recommends this procedure:

1.Disable replication between the two servers.

2.Upgrade Server A or Server B.

3.Upgrade the other server the same as was done with the first server.

4.Enable replication.

Promoting the Standby Server when Active Server FailsWhen replication is enabled and the Active server fails, the Standby server should be promoted to work as the Active server. The services on the DMC server(s) associated with the failed OMS should be stopped as soon as possible, and the services on the DMC server(s) associated with the promoted OMS should be started after the standby server has been promoted.

Users should be directed to use the promoted server. While the promoted server is operating Optima processes, the failed server can be fixed.

In addition to promoting the standby server, the promotion command script also tries to reach the failed active server to re-establish replication in the opposite direction. The success or failure of that process bears upon the system administrator’s subsequent actions.

Follow these steps to promote the Standby server to Active status in the event that the Active server fails.

After the Standby server is promoted, replication can either:

continue because the demoted server could be rebuilt, or

be disabled because the server is unreachable or could not be rebuilt.

When the command rebuilds the demoted server and continues replication after promotion (the first scenario above), the command response resembles the following:

WESTELL.COM

Page 6-16

1-800-377-8766


When the command disables replication after promotion (the second scenario above), the command response resembles the following:

If the promoted server was successful in rebuilding the other server, replication will have been re-established and no other commands need to be run. But if the server that was disabled needs to be taken offline for repair or if the demoted database needs to be re-installed, run the replicationmanager disable command to sever replication, then proceed to the next section to re-enable replication later, This optional step is shown below. The Servers user interface should display the


Address: 10.34.59.3, Database is active, Processes enabled



Are you sure you want to promote this server (10.34.3.112) (Y/n)?

Starting promotion of on server 10.34.3.112server promoting

Promotion of 10.34.3.112 completed successfully

Stopping all...Starting rebuild of 10.34.59.3 from 10.34.3.112

Restarting active server (10.34.3.112) with archive command enabled

Users may now use the Optima system on 10.34.3.112 while it rebuilds 10.34.59.3Applying pg_rewind on standby server (10.34.59.3).

servers diverged at WAL position 17/90175E10 on timeline 7

rewinding from last common checkpoint at 17/90000028 on timeline 7Done!

Starting standby server (10.34.59.3)

Rebuild of 10.34.59.3 completed successfullyThe demoted server (10.34.59.3) has been rebuilt from this server (10.34.3.112)

and replication has been re-established from 10.34.3.112 to 10.34.59.3.

Address: 10.34.59.3, Database is in standby, Processes disabledAddress: 10.34.3.112, Database is active, Processes enabled


Address: 10.34.59.3, Cannot ssh

Address: 10.34.3.112, Database is in standby, Processes disabledStopping all...

The server to be demoted (10.34.59.3) is not reachable,

so its services cannot be checked or disabled.Are you sure you want to promote this server (10.34.3.112) (Y/n)? y

Starting promotion of on server 10.34.3.112

server promotingServer 10.34.59.3 unreachable, cannot disable services.

Run 'optimadaemonregistrar disable' on that server manually.

Promotion of 10.34.3.112 completed successfullyCould not remove replication configuration on unreachable 10.34.59.3.

Disabling replication on 10.34.3.112.

Stopping all...The demoted server (10.34.59.3) is not reachable to re-enable replication.

Run 'replicationmanager enable' on THIS server (10.34.3.112) later when the

otherserver is back online and ready to receive a complete backup from this server.

Address: 10.34.59.3 unauthorized for ssh


WESTELL.COM

1-800-377-8766

Page 6-17


Replication status Active for the server with IP address 10.34.3.112. No status will be shown for the server with IP address 10.34.59.3.

There are two possible outcomes of the promotion process.

Promotion Scenario 1: Promote Standby and Rebuild Replication NowAs the standby server is promoted, the promote command script will attempt to rebuild the database on the failed server if it is still reachable. If the rebuild is successful, replication is re-established with the failed server becoming the standby. This is shown in Figure 6-5.

Figure 6-5 Re-enabling a repaired server with the promote command

Note: If the rebuild succeeds but the failed server’s database needs to be wiped or

taken down for an extended period for repairs, the administrator might choose to run the replicationmanager disable command on Server B to switch to Promotion Scenario 2, described in the next section. Also refer to Manually disabling replication between servers on page 6-24.

DB

Optima

PostgreSQL

WAL

DB

Optima

PostgreSQL

WAL

DB

Optima

PostgreSQL

WAL

B Standby

DB

Optima

PostgreSQL

B Active

WAL

A Failed

A Standby

Failed server (A):

Standby server (B):

Active server (B):Optima data flow to

Standby server (A):Receives data from

replicationmanager promotecommand run to re-enable disabled server

formerly failed(now Standby) serverresumes.

Active server’s WALfiles and updatesdatabase. Optimaprocesses disabled.

Broken. Needs to be repaired.

Optima processes disabled andawaiting promotion.

WESTELL.COM

Page 6-18

1-800-377-8766


Promotion Scenario 2: Promote Standby and Re-enable Replication LaterIf the failed server is not reachable from the promoted server, or if the rebuild of the failed server fails, the promote command script will disable replication. This is illustrated in Figure 6-6.

Figure 6-6 Promote command disables replication to unresponsive server

This Scenario 2 requires the complete database backup provided by the replicationmanager enable command when the recovery processes occur. Scenario 2 also applies when the administrator disabled replication after a successful rebuild because Server A required repair.

Follow these steps:

1. Once repairs to Server A are complete, run the command replicationmanager enable on the server intended to become the active server (Server B, in our illustrations).

2. When the enabling process concludes, the Standby server will be a fully functional replication of the Active server. This is shown in Figure 6-7.

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

B StandbyA Failed

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

B Active

WAL

A Failed

Failed server (A):

Standby server (B):

Active server (B):

Failed server (A):

replicationmanager promote commanddisables replication because Server Afails again or cannot be reached

Unresponsive. Remains offline with

WAL

Broken. Needs to be repaired.

Optima processes disabledand awaiting promotion.

Optima data flow to Server A doesnot resume. Optima processescontinue to run and updatedatabase.

no replication.

WESTELL.COM

1-800-377-8766

Page 6-19


Figure 6-7 Enable command restores replication to repaired server

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

B ActiveA Repaired

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

B Active

WAL

A Standby

Repaired server (A):

Active server (B):Optima processes continue to run

replicationmanager enable commandre-enables replication from Server B to Server A

WAL

Active server (B):Optima data flow to formerly failed

Standby server (A):Receives data from Active server’s

Repaired. Ready to return to service.

and update database.

WAL files and updates database.Optima processes disabled.

(now Standby) server resumes.

WESTELL.COM

Page 6-20

1-800-377-8766


In Case of Standby Server FailureWhen replication is enabled and the Standby server fails (Figure 6-8), the Standby server can be rebuilt by running the command replicationmanager rebuild on the Standby server after repairs have been made. The Active server can continue to provide Optima services and store data on its database while the Standby server is rebuilt. When the Standby server goes back into service, replication will be back in operation as shown in the bottom of Figure 6-9.

Figure 6-8 Standby server failure during replication

Follow these steps, illustrated in Figure 6-9:

1. Once the failed Standby server is repaired, run the command replicationmanager rebuild on the Standby server.

2. When the rebuild process is complete, the Standby server will again be a fully functional replication of the active server.

Standby server (B):

DB

PostgreSQL

WAL DB

PostgreSQL

WAL

A Active

Optima Optima

B Standby

Failed. Database no longer receives

DB

PostgreSQL

WAL

A Active

Optima

DB

PostgreSQL

WAL

B Failed

Optima

Active server (A):Optima processes are running. OMS data

Standby server fails and can no longerreceive updates from the Active server

flows to write-ahead logs and databasevia PostgreSQL. WAL files transmissionto Standby server terminated due toStandby server failure.

updates from Active server.

WESTELL.COM

1-800-377-8766

Page 6-21


Figure 6-9 Restoring replication after standby server is repaired

DB

PostgreSQL

WAL

A Active

Optima

DB

PostgreSQL

WAL

B Repaired

Optima

replicationmanager rebuild commandre-enables replication from Server A to Server B

Active server (A):Continues to operate normally.

Standby server (B):Repaired. Ready to return to service.

DB

PostgreSQL

WAL DB

PostgreSQL

WAL

A Active B Standby

Optima OptimaActive server (A):

OMS data flows to write-ahead log

Standby Server (B):Database is read-only and Optima

and database va PostgreSQL.

processes are disabled. PostgreSQLreceives data from active server’s WAL files and updates standbyserver’s database.

WESTELL.COM

Page 6-22

1-800-377-8766


Reversing Replicated Servers to Original RolesAfter a repaired server has been rebuilt or restored using one of the methods described in the preceding two sections, the user can reverse the two servers’ roles to return both of them to their original roles. This option is illustrated in Figure 6-10.

Follow these steps:

1. On the Standby server (originally the Active server), run the command replicationmanager promote.

2. When the promotion process concludes, the two servers’ roles will be reversed, and the original Active server will be the Active server again. The Replication column in the Servers user interface should confirm this.

Figure 6-10 Reversing replication direction between servers (optional)

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

WAL

B ActiveA Standby

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

WAL

B StandbyA Active

Active server (B):Optima data flow to formerly disabled

Standby server (A):Receives data from Active server’s

Standby server (B):Reverts from Active to Standby

Active server (A):

replicationmanager promotecommand run on Standby server to make it Active

Returns to Active status upon

WAL files and updates database. Optima processes disabled.

(now Standby) server has resumed.

command. Optima processes resumerunning and database is updated.

status upon command.

WESTELL.COM

1-800-377-8766

Page 6-23


Manually Disabling ReplicationReplication can be disabled manually at any time to accommodate server repairs or maintenance or to clone a server for testing purposes. This option is illustrated in Figure 6-11. Follow these steps:

1. Identify the server needing repairs or maintenance. If that server is not in the Standby role, follow the steps in Reversing Replicated Servers to Original Roles to assign the Standby role to that server.

2. On either server, run the command replicationmanager disable.

3. When replication is disabled, the Standby server’s Optima processes are disabled and Optima data transmission to the Standby server ceases. Optima processes continue to run and update the database on the Active server.

Figure 6-11 Manually disabling replication between servers

Active server (A):Optima data flows to

Standby server (B):Receives data from Active server’s

Standby server (B):

Active server (A):

replicationmanager disablecommand run on Active server

Optima processes continue to

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

WAL

B StandbyA Active

DB

Optima

PostgreSQL

WAL DB

Optima

PostgreSQL

WAL

B StandbyA Active

Transmission of WAL files from

WAL files and updates database.Optima processes disabled.

Standby server.

run and database continues to be updated.

Active server terminated. Optima processes disabled.Repair or maintenance workcan proceed.

WESTELL.COM

Page 6-24

1-800-377-8766

APPEN

DIX A

Configuring a Removable Direct AccessStorage Device

This appendix provides information on configuring a removable direct access storage 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)

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

Mounting the ReadyNAS 2100 with Disk Growth

Page A-1

WESTELL.COM

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

Configuring a NFS mount point

Dell RD1000 Administration Instructions

WESTELL.COM

Page A-2

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page A-3

Optima Prime Version 12.2x 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

Page A-4

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page A-5

Optima Prime Version 12.2x 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

Page A-6

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page A-7

Optima Prime Version 12.2x 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

Page A-8

1-800-377-8766


2. Enter the admin username and password you configured in section Configuring the ReadyNAS 2100 on page A-6. 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

1-800-377-8766

Page A-9


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

Page A-10

1-800-377-8766


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-6. 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.

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.)

# 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:

WESTELL.COM

1-800-377-8766

Page A-11


# systemctlenable iscsi

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:

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,

WESTELL.COM

Page A-12

1-800-377-8766


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

Command action

e extended

p primary partition (1-4)

p

Partition number (1-4): 1

WESTELL.COM

1-800-377-8766

Page A-13


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

Page A-14

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page A-15

Optima Prime Version 12.2x 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

Page A-16

1-800-377-8766

Optima Prime Version 12.2x 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

In the above command, <mpath1p1> is the multipath device map name.

As root, execute:

# mount /u01/backup

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

WESTELL.COM

1-800-377-8766

Page A-17

Optima Prime Version 12.2x 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 PostgreSQL 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

Page A-18

1-800-377-8766

Optima Prime Version 12.2x 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.


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

1-800-377-8766

Page A-19

Optima Prime Version 12.2x 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

Page A-20

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page A-21

Optima Prime Version 12.2x 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

Page A-22

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideConfiguring a Removable Direct Access Storage Device: Ejecting and Reinserting the Removable DirectAccess Storage 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 DirectAccess Storage Cartridge

If the Eject button on the drive does not work, execute the following command to remove the DirectAccess Storage 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 DirectAccess Storage 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

1-800-377-8766

Page A-23

Optima Prime Version 12.2x System Administration GuideConfiguring a Removable Direct Access Storage Device: Ejecting and Reinserting the Removable DirectAccess Storage Cartridge

WESTELL.COM

Page A-24

1-800-377-8766

APPEN

DIX B

B

Updating Westell Remote Devices

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

Guide to this Appendix

Upgrading Westell Remote Software

Installing and Managing Modules

Page B-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideUpdating Westell Remote Devices: Upgrading Westell Remote Software

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

1. Use the procedure for transferring files (refer to section Transferring Files in your Optima Prime User/Configuration Guide) 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 (refer to section Updating Firmware in your Optima Prime User/Configuration Guide) 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

Page B-2

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideUpdating Westell Remote Devices: Installing and Managing Modules

Installing and Managing Modules

Installing a Module on Optima PrimeTo install modules on Optima Prime:

1. Use sftp/scp to transfer a single Module file or Module bundle into a /tmp directory on the Optima Prime server.

2. Run the modulemanager install script to install the module on the Optima Prime 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.

Installing a Module on a Remote DeviceTo install modules on Westell’s Remote device:

Either:

1. Use sftp to transfer a single Module file or Module bundle into the modules directory on the Remote device.

2. Execute the CLI command exec site install to install the module. For additional information, refer to the Configuring Modules section in your Remote device’s Configuration Guide.

Or:

Use the Optima Prime GUI to deploy modules to Remotes.

Refer to the Configuring Modules chapter in your Remote Configuration Guide for additional details.

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

WESTELL.COM

1-800-377-8766

Page B-3

Optima Prime Version 12.2x System Administration GuideUpdating Westell Remote Devices: Installing and Managing 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

-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

Page B-4

1-800-377-8766

APPEN

DIX C

OMS Disaster Recovery

This appendix provides information on reproducing the data and configuration from a failed OMS to a second, healthy OMS to restore Optima network operation. Use this procedure if the Server Replication feature was not set up, or if a catastrophic failure occurred while using the Server Replication feature.


Prerequisites and Assumptions

Recovery Procedure

Page C-1

WESTELL.COM

Optima Prime Version 12.2x 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 reproduce 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 7 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 (em2) for OMS1 and OMS2. However, on OMS2, the em2 interface should be ifdown so as not to conflict with OMS1.

OMS1 and OMS2 should have the same version and build of the OMS software installed, as described in Performing a Fresh Optima Prime 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

Note: If tree is not available, run yum install tree to install it on the server.

This should return output similar to the following:

/u01/backup/

`-- optima_backup

|-- adapters

| |-- adapter-backup-dmc1.tar.gz

| `-- adapter-backup-dmc1.tar.gz.old

| |-- adapter-backup-dmc2.tar.gz

| `-- adapter-backup-dmc2.tar.gz.old

| |-- ...

| `-- ...

WESTELL.COM

Page C-2

1-800-377-8766

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

| |-- adapter-backup-dmcN.tar.gz

| `-- adapter-backup-dmcN.tar.gz.old

|-- appbackup_full.tar.gz

|-- appbackup_full.tar.gz.old

|-- dmibackup

| |-- aidirector.tgz

| `-- aidirector.tgz.old

`-- pgsql

`-- base.tar.gz

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 Prime Version 12.2x 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 commands on OMS1 to view and remember the network configuration and Optima configuration:

cat /etc/sysconfig/network-scripts/ifcfg-<ifname>

hostname

grep OPTIMA_EXTERNAL_IP /opt/oms/config/AFrame/optima_web_config.properties

grep JBOSS_WEB_EXTERNAL_HOST /etc/sysconfig/omsPrefs

grep DEFAULT_URL /opt/oms/config/AFrame/Autogen.properties

Note: The third command above, starting with grep OPTIMA, spans two lines

because of limited space here but needs to be entered on one line with a space between IP and /opt.

The information and variable values will be required to configure the network interface and Optima on OMS2 in later steps.

2. Verify that OMS2 has network access to all of the DMCs. First get the list of DMC IP addresses by running the following on OMS1:

dmcsystemmanager -l

Then ping each of the listed DMC IP addresses with the following command to verify connectivity:

ping <DMC IP>

Connectivity with the DMC servers is required before proceeding farther in this recovery process.

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

optimacontroller stop

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

optimacontroller stop

5. 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:.

WESTELL.COM

Page C-4

1-800-377-8766


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

6. 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

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

systemctl stop network.service

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.

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

ifup <ifname>

9. Delete the contents under /u01/pgsqldata on OMS2 by running the following command on OMS2:

rm -rf -u01/pgsqldata/*

10. Restore the backup from OMS1 to OMS2 by running the following command on OMS2:

optimarestore

11. Change the IP address on OMS2 primary interface and hostname to make it look like

OMS1 by running the following command on OMS2. Change the values of IPADDR, IPV6ADDR, GATEWAY, IPV6_DEFAULTGW, etc. to the values obtained in step 1.

vim /etc/sysconfig/network-scripts/ifcfg-<ifname>

12. Change the hostname of OMS2 to the hostname of OMS1 by running the following command on OMS2:

hostnamectl set-hostname <hostname obtained in step 1>

13. Restart the network on OMS2 to verify the network configuration is now the same as OMS1:

systemctl restart network.service

ifconfig

hostname

hostname -s

hostname -i

hostname -I

WESTELL.COM

1-800-377-8766

Page C-5


14. Change the Optima configurations on OMS2 so that it will replace OMS1 by running the following command on OMS2:

optimaconfig -n <hostname>

15. Verify the Optima configurations by running the following commands:

grep OPTIMA_EXTERNAL_IP /opt/oms/config/AFrame/optima_web_config.properties

grep JBOSS_WEB_EXTERNAL_HOST /etc/sysconfig/omsPrefs

grep DEFAULT_URL /opt/oms/config/AFrame/Autogen.properties

16. Install the server certificate by running the following commands on OMS2:

optimacertificatemanager -i <server.pem>

optimacertificatemanager -d

Note: The <server.pem> either is obtained from OMS1 or re-generated with the

hostname and IP addresses.

17. Because the license restored from OMS1 is not valid on OMS2, Westell must provide a new license for OMS2. Follow the instructions in section Installing and Administering the Optima License to obtain the OMS2 server ID (serial number).

18. Save the license file (named license.properties.aes) to the following directory location:

/opt/oms/config/server

19. Ensure that Optima is configured as expected on OMS2 by running the following command on OMS2:

optimanetworkcheck

20. On OMS2, ensure that all Optima server processes are restarted on OMS2 by executing the following command on OMS2:

optimacontroller start

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 above Recovery Procedure can be followed to replace OMS2 with OMS1.

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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x System Administration GuideNorthbound Interface: Introduction

Page E-2

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.

Figure E-1 Optima Northbound Interface Architecture

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

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideNorthbound Interface: Introduction

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-15.

WESTELL.COM

1-800-377-8766

Page E-3

Optima Prime Version 12.2x 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 5-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-21 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 InetAddressType, InetAddress FROM INET-ADDRESS-MIB aii FROM AIIDEFS-MIB;

ktxOptimaNorthboundInterface MODULE-IDENTITY LAST-UPDATED "201006071500Z" ORGANIZATION "Westell,Inc." CONTACT-INFO " Engineering MIB Administrator

Postal: Westell,Inc. 750 N. Commons Drive Aurora, IL 60504

WESTELL.COM

Page E-6

1-800-377-8766


Tel: 800/377-8766 E-mail: [email protected]" DESCRIPTION "The MIB module for Optima northbound interface" REVISION "201308301500Z" DESCRIPTION "Updated the ktxNorthBoundEventSourceComponentIpAddress column status to deprecated. Added two new colums: ktxNorthBoundEventSourceInetAddressType and ktxNorthBoundEventSourceInetAddress." 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,

ktxNorthBoundEventSourceInetAddressType, ktxNorthBoundEventSourceInetAddress } 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) }

WESTELL.COM

1-800-377-8766

Page E-7


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, ktxNorthBoundEventSeverity, ktxNorthBoundEventStatus, ktxNorthBoundEventShortMsg, ktxNorthBoundEventMsg, ktxNorthBoundEventClass, ktxNorthBoundEventType, ktxNorthBoundRepeatCount, ktxNorthBoundAckBy, ktxNorthBoundClrBy, ktxNorthBoundEventLastChangedTime,

ktxNorthBoundEventSourceInetAddressType, ktxNorthBoundEventSourceInetAddress } 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 }

WESTELL.COM

Page E-8

1-800-377-8766


ktxNorthBoundEventSeverity OBJECT-TYPE SYNTAX EventSeverityEnum MAX-ACCESS read-only STATUS current DESCRIPTION "The event severity. See EventSeverityEnum" ::= { ktxNorthBoundEvent 2 }

ktxNorthBoundEventStatus OBJECT-TYPE SYNTAX EventStatusEnum MAX-ACCESS read-only STATUS current DESCRIPTION "The event status. See EventStatusEnum" ::= { ktxNorthBoundEvent 3 }

ktxNorthBoundEventMsg OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "This is the event message encoded in UTF-8 character set. This field can be up to 4000 characters in length" ::= { ktxNorthBoundEvent 4 }

ktxNorthBoundEventShortMsg OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The abbreviated event message. It is up to 1024 characters in length" ::= { ktxNorthBoundEvent 5 }

ktxNorthBoundEventCreationTime OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The creation time of the event by the network element recorded with network element's clock " ::= { ktxNorthBoundEvent 6 }

ktxNorthBoundEventSourceComponent OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "This is the network element that is the source of the event" ::= { ktxNorthBoundEvent 7 }

WESTELL.COM

1-800-377-8766

Page E-9


ktxNorthBoundEventSourceComponentIpAddress OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS deprecated DESCRIPTION "This is the IP address of the source component if applicable" ::= { ktxNorthBoundEvent 8 }

ktxNorthBoundEventClass OBJECT-TYPE SYNTAX EventClassEnum MAX-ACCESS read-only STATUS current DESCRIPTION "The class where the event belongs to. See EventClassEnum" ::= { ktxNorthBoundEvent 9 }

ktxNorthBoundEventType OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The event type is a name identifying a specific problem/situation. Ex: GenRun , PortDown" ::= { ktxNorthBoundEvent 10 }

ktxNorthBoundRepeatCount OBJECT-TYPE SYNTAX Integer32 (1..99999) MAX-ACCESS read-only STATUS current DESCRIPTION "The repeat count indicates the number of duplicate events received" ::= { ktxNorthBoundEvent 11 }

ktxNorthBoundAckBy OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The user that acknowledged the event if applicable" ::= { ktxNorthBoundEvent 12 }

ktxNorthBoundClrBy OBJECT-TYPE SYNTAX DisplayString

WESTELL.COM

Page E-10

1-800-377-8766


MAX-ACCESS read-only STATUS current DESCRIPTION "The user that cleared the event if applicable" ::= { ktxNorthBoundEvent 13 }

ktxNorthBoundEventLastChangedTime OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only 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" ::= { ktxNorthBoundEvent 14 }

ktxNorthBoundEventSourceInetAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The event source component IP address type.

unknown(0) -- unspecified type ipv4(1) -- IPv4 address type ipv6(2) -- IPv6 address type" DEFVAL { unknown } ::= { ktxNorthBoundEvent 15 }

ktxNorthBoundEventSourceInetAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The event source component IP address. The type of the address is determined by ktxNorthBoundEventSourceInetAddressType." ::= { ktxNorthBoundEvent 16}

END

The ktxOptimaNorthboundInterface.mib file includes aiidefs.mib. The contents of aiidefs.mib are as follows:

AIIDEFS-MIB DEFINITIONS ::= BEGIN

IMPORTS

WESTELL.COM

1-800-377-8766

Page E-11


MODULE-IDENTITY, enterprises

FROM SNMPv2-SMI;

aii MODULE-IDENTITY

LAST-UPDATED "200205161400Z"

ORGANIZATION "Applied Innovation Inc."

CONTACT-INFO

" Engineering MIB Administrator

Postal: Westell Inc.

750N. Commons Drive

Aurora, IL 60504

Tel: 800/377-8766

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 }

-- 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 }

WESTELL.COM

Page E-12

1-800-377-8766


-- 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 }

-- aiOpenVPN { aii 46 }

-- ktxMeasurement { aii 47 }

-- ktxOptimaNorthboundInterface { aii 48 }

-- ktxModule { aii 49 }

END

The maximum size of ktxNorthBoundEventType, ktxNorthBoundSourceComponent, ktxNorthBoundAckBy and ktxNorthBoundClrBy is 128 characters.

The format of ktxNorthBoundEventCreationTime and ktxNorthBoundEventLastChangedTime is as follows:

yyyy-MM-dd HH:mm:ss.SSS

Where:

yyyy = four-digit year

WESTELL.COM

1-800-377-8766

Page E-13


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 Westell Remote NE, but not for a Site NE.

WESTELL.COM

Page E-14

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page E-15


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

Page E-16

1-800-377-8766


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

1-800-377-8766

Page E-17


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

Page E-18

1-800-377-8766


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

1-800-377-8766

Page E-19



<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

Page E-20

1-800-377-8766

Optima Prime Version 12.2x 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

1-800-377-8766

Page E-21

Optima Prime Version 12.2x 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 Categories

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.Str ing(12 8): ja va. lang.Str ing(12 8): in t

Even tCateg ory

++

nam edescriptio n

: java .lang .String(1 28): java .lang .String(1 28)

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.


Installing Red Hat

Updating Red Hat Packages

Page F-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideRed Hat Installation Tasks: Installing Red Hat

Installing Red HatFollow these steps to install Red Hat 7.

1. Insert disk 1 of RHEL 64bit 7.x.

2. Press Enter for graphical install

3. Press Skip to skip the media test unless you desire to run the test

4. Press Next at the release notes page

5. Select English, then

6. Select U.S. English Keyboard, then Continue

7. You will be presented with the Installation Summary page

8. Verify the Date & Time, Keyboard and Language Support are correct

9. Click the "Installation Destination" option under the System:

a.Verify the correct disk is selected under the Device Selection (The

bottom of the page should say 1 disk selected)

b.Select the disk you wish to use for the installation. A white checkmark

with a black background will appear on the selected disk.

c.Scroll down to Other Storage Options and select I will configure the

partitioning.

d.Leave the "Encrypt my data" option unchecked.

e.Click Done at the top of the page to proceed to Manual partitioning.

f.Select LVM from the dropdown, and click on Click here to create them

automatically.

g.Select * /home * partition, and write down the size of the partition.

h.Click the minus button in the bottom-left to delete the * /home * partition.

i.Select the * / * partition (rhel-root), and change its size to current size +

previous /home partition size. For example, a setup with a 20 GiB *

/home * and a 42 GiB * / * partition becomes just a 62 GiB * / * partition.

j.Ensure the /boot partition is 500MB, which should be the default value.

k.Ensure the /swap partition is the same size as the RAM size, which

should be the default value.

l.Click Done. A summary window pop-up will appear; click Accept

Changes.

WESTELL.COM

Page F-2

1-800-377-8766


10. Click the "Network & Host Name" option under the System:

a.Change the "Host name" field in the bottom left

b.Select "Ethernet" on the left side

c.Turn On the Ethernet connection and click the Configure button in the

bottom right

d.Click on the IPv4 Settings tab

e.Select Manual from the Method combo

f.Click Add to configure an IP address

g.Enter the IP address

h.Enter the Netmask

i.Enter the Gateway

j.Enter the comma delimited DNS Servers

k.Enter the comma delimited Search domains

l.Click Save to save the IP settings

m.Click Done in the "Network & Host Name" page

11. Kdump is an optional feature that you may choose to enable or not.

12. Click the "Software Selection" option

a.Select Server with GUI as the Base Environment. Then, on the right

side, check the boxes next to only the following packages

i. Performance Tools

ii.Development Tools

iii. Network File System Client

b.b.Click Done

13. Click Begin Installation

14. Click the "Root Password" icon to configure the root password

15. Click the “User Creation” icon to add a local user

16. Reboot after installation is complete

17. Click on "License Information" and accept the license agreement and click Done

18. Click on Finish Configuration

19. Select No, I prefer to register at a later time and press Forward

20. In the Welcome screen, Select English (United States) and press Next

WESTELL.COM

1-800-377-8766

Page F-3


21. Select English (US) as the input sources and press Next

22. Select your location and press Next

23. Skip the Online Accounts page and press Next

24. Click Start using Red Hat Enterprise Linux Server to finish the installation

25. Complete all required fields and follow the prompts to complete the registration.

26. Optima installation requires the following packages to be installed or removed by opening an RHEL terminal session with Applications > Terminal and entering the following commands:

a. yum remove java-1.7.0-openjdk-headless java-1.8.0-

openjdk-headless

b. On the OMS only: yum install ksh httpd mod_ssl

28. After the machine is rebooted, verify the /etc/hosts file:

a. From the command line, enter “cat /etc/hosts”. The file should look

similar to this but with the appropriate fully qualified domain name:

# Do not remove the following line, or various programs

# that require network functionality will fail.

127.0.0.1 localhost.localdomain localhost

10.34.3.9 <server_name>.<company_name> <server_name>

b. If the file does not look similar to this, use an editor to make the

appropriate changes.

Make sure your hostname is not on the same line as 127.0.0.1. It must be with your external IP address.

WESTELL.COM

Page F-4

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideRed Hat Installation Tasks: Updating Red Hat Packages

Updating Red Hat PackagesRed Hat periodically updates the packages that comprise the operating system. Westell does not issue these updates as patches because the Red Hat license requires that a server receive those updates directly from Red Hat.

It is not recommended that you update the packages on your server without checking with Westell customer support. When periodic Red Hat updates come out, Westell will verify that they are compatible with Optima Prime.

Once a Red Hat server has been registered, it can be updated by logging in as the root user and running the update command:

# yum update

Respond with y to confirmation prompts.

This command will:

Download the list of known RPMs and their latest version numbers.

Resolve dependencies between the list of RPMs that are installed against the available versions.

Display a list of packages that can be updated, and ask for confirmation.

Download the packages to be updated.

Import the RPM signing keys, and ask for confirmation.

Run a transaction test.

Run a transaction for installing, updating and cleaning up the rpms.

Verify the installation of the rpms

The word Complete! will display after the update has completed. The /etc/redhat-release file will contain the current version of Red Hat.

WESTELL.COM

1-800-377-8766

Page F-5

Optima Prime Version 12.2x System Administration GuideRed Hat Installation Tasks: Updating Red Hat Packages

WESTELL.COM

Page F-6

1-800-377-8766

APPEN

DIX G

G

Importer and Exporter File Formats

This appendix explains the proper formats for optimainventoryimporter, optimainventoryexporter,and eventfixactionsimporter files.


Export File Format

Import File Format

CSV File Columns

XML Import/Export Types

Event Fix Actions Importer CSV Columns

Page G-1

WESTELL.COM

Optima Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 5-8.

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

Table G-2 .csv File Columns - ne Data Type


NE name text Y Y NE Name

WESTELL.COM

Page G-4

1-800-377-8766


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

Power company name

text N N Power company name

Table G-2 .csv File Columns - ne Data Type (Continued)


WESTELL.COM

1-800-377-8766

Page G-5


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 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 Description

NE type vendor text, foreign key validated against existing vendors

Y N Vendor Name

NE type category text, foreign key validated against existing NE categories

Y N Category

Proc name text Y N Default Model 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 port

Default port [TRUE or FALSE]

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


protocol

alarm

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 - protocol Data Type


Protocol name text Y Y Protocol Name

Protocol port number

numeric (with bounds of 1 to 65535)

Y Y Protocol Port

Table G-7 .csv File Columns - alarm Data Type


Alarm name text Y Y Alarm Name

WESTELL.COM

Page G-10

1-800-377-8766


alarmtranslation

measurementtemplate

Table G-8 .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-9 .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

WESTELL.COM

1-800-377-8766

Page G-11


signaldefinition

Type enum [measurement, event count, event duration, aggregated measurement]

Y N Type

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-9 .csv File Columns - measurementtemplate Data Type (Continued)


WESTELL.COM

Page G-12

1-800-377-8766


Table G-10 .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

Signal definition category

text Y N Signal Category Name


WESTELL.COM

1-800-377-8766

Page G-13


signalcategory

measurement

Table G-11 .csv File Columns - signalcategory Data Type


Category name text Y Y Signal Category


Table G-12 .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

Page G-14

1-800-377-8766

Optima Prime Version 12.2x 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 5-8.

WESTELL.COM

1-800-377-8766

Page G-15

Optima Prime Version 12.2x System Administration GuideImporter and Exporter File Formats: Event Fix Actions Importer CSV Columns

Event Fix Actions Importer CSV ColumnsFormats for Event Fix Actions importer files are provided in the table below.

Table G-13 .csv File Columns - eventfixactionsimporter Files

Description Format Required Unique CSV Column Name

Device Vendor Name text Y N Vendor

Device Family Display Name text N N Family

Device Model Name text N N Model

Vendor’s Terminology for Alarm

text Y N Vendor Alarm ID

Optima’s Terminology for Alarm

text Y N Optima Alarm

Person, position, or entity responsible for fix

text N N Fix Agent

Vendor recommendation to address alarm situation

text Y N Fix Action

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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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 Prime Version 12.2x 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

Remote Product Monitor Events

Remote Default Analog Events

IP and Westell Device Alarms

Optima Self-Monitoring Alarms

Page I-1

WESTELL.COM

Optima Prime Version 12.2x 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 and Figure I-2).

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


Figure I-2 Bottom portion of Event Information window with Snooze information

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 or Alert Event indicating an error condition, such as an SNMP trap

WESTELL.COM

1-800-377-8766

Page I-3


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.Snoozed -- Alarm has been placed in Snooze mode.

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.

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.

Snoozed Date and time an alarm is placed in Snooze mode

Table I-1 Event Information Tab Fields (Continued)

Field Description

WESTELL.COM

Page I-4

1-800-377-8766


Snoozed By Name of the person or position who placed the alarm in Snooze mode

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.

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 Provider NE (NE which provided the event to

Optima, often a Remote) Correlation Key (Event identifier consisting of

the event key, the element ID, the element IP address [if applicable], and the alarm name)

Hashcode (Event identifier consisting of the event key, the element ID, the element IP address [if applicable], and the alarm name, used to clear events. The hashcode is sometimes the same as the correlation key)


Field Description

WESTELL.COM

1-800-377-8766

Page I-5


Snoozed Event Information

Details about an event in Snooze status, including: Actual Message (Message that accompanied the

alarm presently in Snooze mode) Actual Long Message (Long message that

accompanied the alarm presently in Snooze mode)

Actual Last Received (Date and time the alarm presently in Snooze mode was last received in its pre-snooze status)

Actual Status (Status of the alarm prior to it being Snoozed)

Actual Severity (Severity of the alarm presently snoozing)

Actual Cleared By (Name of the person or position who cleared the actual alarm -- See description of Cleared by earlier in this table)

Actual Cleared (Date and time the actual alarm was cleared)

Snooze End Time (Date and time when Snooze will end and alarm will revert to its previous status)


Field Description

WESTELL.COM

Page I-6

1-800-377-8766


Figure I-3 Event Information window with Fix Actions fields revealed on the right

Starting with Optima Version 11.50, Event Information windows provide Fix Actions. These are Original Equipment Manufacturers’ (OEM) recommendations for steps to take in the case of an alarm involving a device made by that OEM. The Fix Actions fields are initially concealed, and are revealed by clicking the arrow button on the lower right edge of the Event Information window. See Figure I-3 above, and refer to Event Fix Actions Importer on page 5-12

Table I-2 Fix Actions Information Fields in Event Information Window

Field Description

Fix Agent: (name of agent) The party responsible for undertaking the fix (set by customer)

Remedy from vendor: (name of vendor)

Remedy or remedies recommended by the OEM. (read-only field) If there are no recommendations from the OEM.vendor, this field may be absent. The user can click the information icon to open a separate Vendor Information window where users can keep and edit notes about the vendor.

Remedy for model: (name of model)

Notes about the model added and edited by Optima users with edit-event permission level.

WESTELL.COM

1-800-377-8766

Page I-7


Remedy for family: (name of model family)

Notes about the family (pertaining to the listed vendor only) added and edited by Optima users with edit-event permission level.

Table I-2 Fix Actions Information Fields in Event Information Window

Field Description

WESTELL.COM

Page I-8

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideEvent Information Fields, Event Types, and Alarms: Optima Server Monitor Events

Optima Server Monitor EventsTable I-3 lists the event types that are associated with Westell Optima Server Monitor.

Table I-3 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-9

Optima Prime Version 12.2x System Administration GuideEvent Information Fields, Event Types, and Alarms: Remote Product Monitor Events

Remote Product Monitor EventsTable I-4 lists the event types that are associated with Westell Remote Product Monitor.

Table I-4 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-10

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideEvent Information Fields, Event Types, and Alarms: Remote Default Analog Events

Remote Default Analog EventsTable I-5 lists the default event types that are associated with Westell Remote analog inputs.

Table I-5 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-11

Optima Prime Version 12.2x System Administration GuideEvent Information Fields, Event Types, and Alarms: IP and Westell Device Alarms

IP and Westell Device AlarmsThese alarms are generated for IP and Westell devices. These alarms are always attributes to the NE they were observed upon (the Westell Remote, or IP-enabled device) unless otherwise specified in the notes.

Table I-6 IP and Westell 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 Westell 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 Westell device specific.

restorePointCreated RestorePointEvent None Warning Pending Generated when the latest restore point cannot be verified. This is Westell 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 Westell 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-12

1-800-377-8766

Optima Prime Version 12.2x System Administration GuideEvent Information Fields, Event Types, and Alarms: IP and Westell Device Alarms

nodeRescanFailed discEvent None Critical Pending Generated when device discovery fails.

Long Description: An element discovery has failed.

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-6 IP and Westell Device Alarms (Continued)


Event Severity

Event Status

Generated ByNotes and Descriptions

WESTELL.COM

1-800-377-8766

Page I-13

Optima Prime Version 12.2x 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-7 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-14

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-7 Optima System Monitoring Alarms (Continued)


Event Severity

Event Status

Generated By Notes and Descriptions

Table I-8 Optima Server Resource Monitoring Alarms

Event TypeSub-component

Event Severity

Generated By Long Description

serverResourceError Disk-mountpoint

Warning 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.

serverResourceError Disk-mountpoint

Critical 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.

WESTELL.COM

1-800-377-8766

Page I-15


serverResourceError Memory Warning 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 Memory Critical 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 CPU Warning 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 CPU Critical 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 PID-Process_ID

Warning 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.

serverResourceError PID-Process_ID

Critical 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.

serverResourceError Controller Warning Generated when DELL OMSA monitoring tools alarm on minor disk controller errors.

The resource: Controller- Controller_Id status is: Non-Critical.

serverResourceError Controller Warning Generated when DELL OMSA monitoring tools alarm on minor disk controller errors.

The resource: Controller- Controller_Id status is: Unknown.

serverResourceError Controller Critical Generated when DELL OMSA monitoring tools alarm on critical disk controller errors.

The resource: Controller- Controller_Id had failed with the status: Critical

serverResourceError Controller Critical 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 PDisk Warning Generated when DELL OMSA monitoring tools alarm on minor physical disk errors.

The resource: PDisk- Physical_Disk_Id status is: Non-Critical.

serverResourceError PDisk Warning Generated when DELL OMSA monitoring tools alarm on minor physical disk errors.

The resource: PDisk- Physical_Disk_Id status is: Unknown.

Table I-8 Optima Server Resource Monitoring Alarms (Continued)


Event Severity


WESTELL.COM

Page I-16

1-800-377-8766


serverResourceError PDisk Critical 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 PDisk Critical 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 VDisk Warning Generated when DELL OMSA monitoring tools alarm on minor virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id status is: Non-Critical.

serverResourceError VDisk Warning Generated when DELL OMSA monitoring tools alarm on minor virtual (RAID) disk errors.

The resource: VDisk- Virtual_Disk_Id status is: Unknown.

serverResourceError VDisk Critical 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 VDisk Critical 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 Battery-Battery_ID

Warning Generated when DELL OMSA monitoring tools alarm on minor disk controller battery errors.

The resource: Battery- Battery_Id status is: Non-Critical.


Warning Generated when DELL OMSA monitoring tools alarm on minor disk controller battery errors.

The resource: Battery- Battery_Id status is: Unknown.


Critical 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 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.

serverResourceError Enclosure-Enclosure_ID

Warning Generated when DELL OMSA monitoring tools alarm on minor disk enclosure errors.

The resource: Enclosure- Enclosure_Id status is: Non-Critical.


Warning Generated when DELL OMSA monitoring tools alarm on minor disk enclosure errors.

The resource: Enclosure- Enclosure_Id status is: Unknown.


Critical Generated when DELL OMSA monitoring tools alarm on critical disk enclosure errors.

The resource: Enclosure- Enclosure_Id had failed with the status: Critical.



Event Severity


WESTELL.COM

1-800-377-8766

Page I-17



Critical Generated when DELL OMSA monitoring tools alarm on critical disk enclosure errors.

The resource: Enclosure- Enclosure_Id had failed with the status: Non-recoverable.

serverResourceError Temperature-Temperature_ID

Warning 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.

serverResourceError Temperature-Temperature_ID

Critical 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.

serverResourceError PowerSupply- PowerSupply_ID

Warning Generated when DELL OMSA monitoring tools alarm on minor power supply errors.

The resource: PowerSupply- PowerSupply_Id status is: Non-Critical.


Warning Generated when DELL OMSA monitoring tools alarm on minor power supply errors.

The resource: PowerSupply- PowerSupply_Id status is: Unknown.


Critical Generated when DELL OMSA monitoring tools alarm on critical power supply errors.

The resource: PowerSupply- PowerSupply_Id had failed with the status: Critical.


Critical Generated when DELL OMSA monitoring tools alarm on critical power supply errors.

The resource: PowerSupply- PowerSupply_Id had failed with the status: Non-recoverable.

serverResourceError Fans-Fan_ID Critical 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 Network Interface- NIC_ID

Critical 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.



Event Severity


WESTELL.COM

Page I-18

1-800-377-8766


ProductionImage Remote Major Generated when a restore point notices that a Remote had to boot up to its secondary image

Production software is running on the Secondary image

BootloaderImage Remote Major Generated when a restore point notices that a Remote had to boot up to its secondary image

Bootloader software is running on the Secondary Image

clockCheck Remote Critical (configurable)

Generated when a web service call to a Remote returns an invalid time stamp

Clock is out of tolerance (difference is nn minutes)

clockCheck Remote Critical (configurable)

Generated when retrieval of measurements from a Remote detects file(s) with out of range time stamps

Device has measurement file with bad time stamp. First bad file name is YYYYMMDDHHMMSS.



Event Severity


WESTELL.COM

1-800-377-8766

Page I-19


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-9 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-20

1-800-377-8766


Created ktxNorthBoundEventCreationTime

Last Changed ktxNorthBoundEventLastChangedTime

Table I-9 Optima UI to NBI Terminology Mapping (Continued)

Optima UI Term NBI Term Notes

WESTELL.COM

1-800-377-8766

Page I-21


WESTELL.COM

Page I-22

1-800-377-8766

GLO

SSARY

Glossary

A

acknowledge

Optima command indicating the user has noticed an alarm. When an alarm is acknowledged, the alarm status changes from Pending to Acknowledged.

active

In Optima’s server replication feature, the active OMS server’s database and configuration are replicated in a standby OMS server. The standby server can be promote to active status if the active server fails.

alarm

An event in Optima’s event class Alarm described by a specific alarm name and assigned a specified severity level.

Page Glossary-1

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideGlossary:

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.

C

carriers

Companies or utilities that provide wireless telephone or data services, such as AT&T, Sprint, or Verizon.

clear

Optima command to change the status of a non-module alarm or alert to Cleared, indicating that the alarm or alert is no longer of concern. Cleared events remain in the database for historical analyses and trending purposes for up to six months.

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.

WESTELL.COM

Page Glossary-2

1-800-377-8766


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.

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.

WESTELL.COM

1-800-377-8766

Page Glossary-3


event type

An event type identifies the cause of the generated event.

Event View

A standing display in Optima with a default presentation showing all events occurring in the system in chronological order with the most recent events first. Event view enables Optima users to take multiple actions with respect to events, to open new windows with additional details about events, to search for and display events by NE name, NE Group, or NE Tree branch, and to change the Event View display in various ways.

F

favorite

A configuration of an Optima report or display saved by its owner for possible reuse. A user clicks the My Optima tab and selects My Favorites to open that user’s Favorites list and to open individual favorites for editing or to delete Favorites. Favorite types can include reports, event view reports, maps, or dashboards. Each favorite can be assigned public or private access

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

Page Glossary-4

1-800-377-8766


L

Live View

A standing display in Optima showing current or most recently collected data from a Remote at a site with modules installed, providing a summary of the site’s status. The display contents reflect the applications of the installed modules.

logging file

A logging file is a file that tracks activity for a host resource.

M

Map View

A standing display in Optima showing sites on a map or satellite image.

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.

WESTELL.COM

1-800-377-8766

Page Glossary-5


My Profile

A user’s editable profile displayed via the My Optima tab with fields including the user’s name, default login page, favorite Event View and Map View displays, and Event View display preferences. The My Profile page also has commands enabling users to change passwords and configure applications.

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.

Network Element (NE) Name

This is the name of the Network Element (NE) as it appears in the GUI.

NE Group

An NE 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.

WESTELL.COM

Page Glossary-6

1-800-377-8766


P

profile

A system profile provides Optima Prime 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 HTTPS (HyperText Transfer Protocol Secure), SNMP (Simple Network Management Protocol), SSH (Secure SHell), and SFTP (SSH File Transfer Protocol).

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.

replication

Optima’s Server Replication feature provides a “warm standby” OMS server with a replication of the active OMS server database. The standby server can be promoted to active status in the event of a server failure with no loss of data or configuration.

WESTELL.COM

1-800-377-8766

Page Glossary-7


Report View

Standing display in Optima allowing users to prepare reports pre-configured in modules based upon data from NEs the user selects. For example, a user could generate a battery voltage report for any site outfitted with the Power Module. Report View lets the user select from numerous possible reports and apply them to any site outfitted with the module providing those reports.

Report Wizard

A tool provided in Optima which lets users prepare reports for equipment not associated with modules.

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 Glossary-8

1-800-377-8766


site

A specific location 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). A common example is a cell phone tower.

Site View

A standing display introduced in Optima version 11.40 giving users an immediate view of sites with active alarms and/or network element outages, with several features and tools designed to help users zero in on issues affecting network performance.

SNMP

Simple Network Management Protocol. This is the method by which the Optima server communicates with many network elements.

snooze / unsnooze

Snooze is an Optima command introduced in version 11.50 used to abate the nuisance caused by a bouncing alarm. Users can apply the snooze command to any alarm for a specified time, during which the alarm’s status is shown as “Snoozed.” A snoozing alarm will not accept any state changes, and users will not be able to acknowledge or clear the underlying (or “actual”) alarm. The “Unsnooze” command can be used at any time to return a Snoozed alarm back to its previous status.

standby

In Optima’s server replication feature, the standby OMS server has a replication of the active OMS server database, and can be promote to active status if the active server fails.

WESTELL.COM

1-800-377-8766

Page Glossary-9


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.

W

Write-Ahead Log

In an OMS server, a write-ahead log temporarily holds data from PostgreSQL to transmit it to a database. In Optima’s server replication feature, the data also is transferred to a database on a standby server. Write-ahead logs are also called WAL logs or WAL files.

WESTELL.COM

Page Glossary-10

1-800-377-8766

IND

EX

Index

Click on the page number to jump to the desired topic.

AAdd DMC Server 2-11Add OMS Server 2-11Adding Help Documents 5-23Adding Systems 4-4administrative tasks

ongoing 5-2

Bbackup script 5-7

CConfig Utility 5-4Configuring a NFS mount point A-18configuring users 5-14customer assistance 1-vii

Ddata retention intervals 5-15Database password, setting during installation

2-2Default Maintenance Mode Duration 4-7Default Maximum Maintenance Duration 4-7Deleting Help Documents 5-23Dell RD1000

configuring mount point A-22determining device name A-19formatting A-22repartitioning A-20unmounting A-3

Dell Remote Access Card

configuring users D-10network settings D-2services D-14Web interface D-8

Dell System Administration Tools 2-8diagsnapshot utililty 5-5disaster recovery C-2DMC

installation 2-5overview 3-3

DMCs, mapping systems to 4-6dmcsystemmanager 4-6

EEditing Systems 4-4email notification 5-14Event Filtering, Global 5-19event retention intervals 5-15

FFault Generator 5-30Firewall

ports 4-3

Iinstallation

DMC server 2-5OMS 2-4standalone server 2-2

Installing Red Hat F-2Inventory Exporter

file format G-2

© Westell Technologies

WESTELL.COM

Optima Prime Version 12.2x System Administration GuideIndex: L

Inventory Importerfile format G-3

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

licenseadministration 2-7

Linuxexecuting commands 3-6troubleshooting 5-3

logginglog files 5-6process monitoring 5-30user activity 5-6

MMaintenance Mode Duration 4-7Manage Servers 2-11Map View

configuring 5-23default locations 5-24map type 5-24zoom level 5-25zoom threshold 5-24

Mapping systems to DMCs 4-6measurement retention intervals 5-15memory limit 5-16

OOMS

disaster recovery C-2element inventory database 3-3installation 2-4overview 3-3

Optimabackup 5-7disaster recovery C-2documentation

content summary 1-iiconventions 1-vUser’s Guide 1-ii

permissions 5-14process monitoring 5-28restarting 5-2restore 5-7server diagram 3-2

Server Monitor 5-28server processes 5-2starting 5-2status check 5-3stopping 5-2user types 1-iv

network managers 1-ivnetwork operators 1-ivsystem administrators 1-iv

Optima Config Utility 5-4Optima License 2-7Optima Prime

overview 1-2Optima Prime Server Replication 6-1Optima users, configuring 5-14optimacontroller command 5-2optimainstaller troubleshooting 2-8optimainventoryexporter

file format G-2optimainventoryimporter 5-8

file format G-3optimanetworkcheck utility 5-3

Ppermissions 5-14PostgreSQL database password, setting

during installation 2-2PostgreSQL password 4-2process monitoring

log files 5-30

RRAIDar, installing A-4ReadyNAS 2100

configuring A-6connecting A-5IP address A-8iSCSI A-11

Red Hat installation F-2Red Hat Installation Tasks F-1Red Hat terminal

accessing the CLI 3-6RedHat 7.x F-2removable DAS device

configuring A-1Replication, of OMS server 6-1restore script 5-7

SServer Monitor 5-28Server Replication 6-1Servers Interface 2-11Servers User Interface 2-11Servers, Adding/Editing 2-11snapshot utility 5-5SSL H-12standalone server

installation 2-2overview 3-2

Systems, Adding and Editing 4-4

TTrouble Tickets 4-8

UUpdating Red Hat Packages F-5user audit log 5-6users, configuring 5-14

WESTELL.COM

Page Index-2

1-800-377-8766