Cisco Remote Monitoring Suite
Administration Guide
Remote Monitoring Suite (RMS) Release 2.1(0)
July 2005
Corporate Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 526-4100
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn,
and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the
Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Empowering the Internet
Generation, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise,
the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX,
Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, StrataView Plus, TeleRouter, The Fastest Way to Increase Your Internet Quotient,
and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0502R)
Cisco Remote Monitoring Administration Guide
Copyright © 2001-2005, Cisco Systems, Inc.
All rights reserved.
CONTENTS
About This Guide xi
Objective
xi
Audience
xi
Organization
xi
Conventions
xiii
Other Publications
xiii
Obtaining Documentation xiii
Cisco.com xiii
Product Documentation DVD xiv
Ordering Documentation xiv
Documentation Feedback
iv
Cisco Product Security Overview xv
Reporting Security Problems in Cisco Products
xv
Obtaining Technical Assistance xvi
Cisco Technical Support & Documentation Website xvi
Submitting a Service Request xvi
Definitions of Service Request Severity xvii
Obtaining Additional Publications and Information
CHAPTER
1
xvii
Remote Monitoring Suite Overview 1-1
Introduction
1-1
Background Information 1-1
Error Reporting 1-2
Network Considerations
Security
1-7
1-7
Fault Tolerant Functional Architecture
Alarms Database
1-7
1-9
Deployment Considerations 1-12
Distributed Architecture 1-12
Hardware and Software Requirements
CHAPTER
2
1-13
Installing and Configuring the RMS Listener 2-1
Installing the RMS Listener Server
2-3
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
iii
Contents
How to Install the RMS Listener Software
Beeper.flt Modifications
2-3
2-4
Configuring the RMS Listener Server 2-4
Windows 2003 2-4
Windows 2000 2-8
Configuring ICM Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server Using
the TCP/IP Protocol 2-10
Specifying General Listener Configuration 2-10
How to access the general Listener configuration settings 2-10
Duplex Configuration Settings 2-11
Options Settings 2-12
Event Log Entries 2-13
Specifying Listener Customer Configuration 2-13
Adding a New Listener Customer 2-13
Editing Customer Configuration Information 2-13
Deleting a Customer from Listener 2-14
Serial Alarm Feed
CHAPTER
3
2-14
Installing the LGMapper Server 3-1
Overview 3-1
Backwards Compatibility 3-1
LGMapper and LGArchiver Installation Checklist
SQL Server Requirements
3-1
3-2
Installing the LGMapper and LGArchiver Servers
The Installation Process 3-2
Installation Procedure 3-3
3-2
Controlling Access to LGMapper - Populating User Groups 3-5
Windows 2003 3-6
Modifying Launch and Activate Permissions 3-6
Modifying Access Permissions 3-7
Windows 2000 3-8
Examining the General Tab 3-9
Examining the Location Tab 3-10
Examining the Security Tab 3-11
Examining the Identity Tab 3-25
Examining LGArchiver Properties 3-26
Troubleshooting the LGMapper Installation 3-27
Post-Installation Inspection Checklist 3-27
Local Account or User Groups Creation Failures
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
iv
3-28
Contents
DCOMCnfg Registry Settings Failure
Database Creation Failure 3-32
CHAPTER
4
3-32
LGMapperCnfg and LGArchiverCnfg Tools 4-1
LGMapperCnfg Tool 4-1
Overview 4-1
Clients Tab 4-1
Displaying Current Users 4-1
Disabling/Enabling the LGMapper Server
Alarms Database Tab 4-6
Listener Tab 4-8
Log Files Tab 4-9
LGArchiverCnfg Tool 4-10
Overview 4-10
Archiver Database Tab
Listener Tab 4-12
Log Files Tab 4-13
CHAPTER
5
4-2
4-10
LGMapperNM and LGArchiverNM 5-1
LGMapper Node Manager (LGMapperNM) 5-1
Overview 5-1
Starting the LGMapper Node Manager 5-1
Windows 2000 and Windows 2003 5-1
Task Bar Icon 5-3
Menu Options 5-3
Event Log Messages 5-5
LGArchiver Node Manager (LGArchiverNM) 5-5
Overview 5-5
Starting the LGArchiverNM 5-5
Windows 2000 and Windows 2003 5-5
Task Bar Icon 5-7
Menu Options 5-7
Event Log Messages 5-8
CHAPTER
6
Alarms Database Maintenance 6-1
Overview
6-1
Re-Indexing the Alarms Database
6-1
Creating and Cloning Databases 6-1
Manually Creating Databases 6-1
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
v
Contents
SQL Server Security
CHAPTER
7
6-2
LGCnfg Tool 7-1
Overview
7-1
Starting LGCnfg 7-1
Opening a Database
7-1
Using Server-Side Filters 7-3
Customer Instance Filters 7-4
Setting Customer Instance Filters 7-4
Clearing Customer Instance Filters 7-5
Product Filters 7-5
Setting Product Filters in the OID Nodes Tree View 7-5
Clearing Product Filters in the OID Nodes Tree View 7-5
Setting Product Filters in the Objects View 7-5
Clearing Product Filters in the Objects View 7-6
OID Node Filters 7-6
Setting OID Node Filters 7-6
Clearing OID Node Filters 7-6
Class Filters 7-6
Setting Class Filters 7-7
Clearing Class Filters 7-7
Message ID Filters 7-7
Setting Message ID Filters 7-7
Clearing Message ID Filters 7-7
Instance Node Deletion 7-8
Deleting an Instance Node
Creating a New Database
Cloning a Database
7-8
7-8
7-8
Modifying the OID Node Hierarchy and Rules
CHAPTER
8
Installing the AlarmTracker Client 8-1
Overview
8-1
Installing the AlarmTracker Client
Starting the AlarmTracker Client
8-1
8-2
Configuring the AlarmTracker Client
Windows XP 8-5
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
vi
8-5
7-9
Contents
CHAPTER
9
The Exclude Node Feature 9-1
Overview
9-1
Enabling the Exclude Node Feature
CHAPTER
10
9-1
Deployment Issues 10-1
System Specification 10-1
Disk Space Requirements for Alarms Database
CHAPTER
11
Backwards Compatibility Considerations 11-1
Listener and Grid
11-1
LGMapper Server
11-2
AlarmTracker Clients
CHAPTER
12
10-2
11-2
Implementing the IWantHelp Interface 12-1
Overview
12-1
How to Implement IWantHelp 12-2
Interface Definition 12-2
Implementing IWantHelp 12-3
Sample Implementation 12-3
Installation and Setup 12-4
APPENDIX
A
Alarms Database Schema
A-1
Introduction A-1
Table Classes A-1
A Note About Time A-4
Detailed Schema Description
VersionInfo Table A-4
Description A-4
Fields A-5
ProductInfo Table A-6
Description A-6
Fields A-6
Objects Table A-7
Description A-7
Fields A-8
OIDNodes Table A-9
Description A-9
Fields A-10
A-4
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
vii
Contents
Attributes Table A-11
Description A-11
Fields A-12
OIDNodeAttributes Table A-13
Description A-13
Fields A-13
HyperlinkInfo Table A-14
Description A-14
Fields A-14
Rules Table A-15
Description A-15
Fields A-15
Customers Table A-17
Description A-17
Fields A-17
InstanceNodes Table A-17
Description A-17
Fields A-19
Uptime Table A-20
Description A-20
Fields A-20
Alarms Table A-21
Description A-21
Fields A-23
Events Table A-25
Description A-25
Fields A-26
Simples Table A-27
Description A-27
Fields A-28
ObjectState Table A-29
Description A-29
Fields A-29
AlarmsSummaryHour Table A-29
Description A-29
Fields A-31
AlarmsSummaryDay Table A-31
Description A-31
Fields A-33
Filters Table A-34
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
viii
Contents
Description A-34
Fields A-34
FiltersProductSpecific Table
Description A-35
Fields A-35
How Handles Are Used
A-35
A-35
Alarm State Transition Diagram
A-37
INDEX
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
ix
Contents
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
x
About This Guide
Objective
This guide describes the tasks and tools necessary to install, configure, and administer Listener,
LGMapper, and AlarmTracker software.
Note
The AlarmTracker software requires that you also install the Listener and LGMapper
software. If you are not installing the AlarmTracker software, you do not need to read
Chapter 3 and Chapter 4.
Audience
This publication is intended primarily for users who configure and administer Listener, LGMapper, and
AlarmTracker software. The administrator needs a general understanding of call center operations and
management and specific information about the call centers and carrier networks connected to Cisco
ICM software. The administrator also needs a good understanding of Windows 2000 and Windows 2003.
Organization
This guide contains the following chapters.
Chapter
Description
Chapter 1, “Remote
Monitoring Suite
Overview”
Provides a brief description of the utilities you use
to configure and maintain Listener, LGMapper,
and AlarmTracker.
It also provides background information so that
you can understand the security and user rights
issues when these utilities and your configuration
databases work together in a network.
Chapter 2, “Installing
and Configuring the
RMS Listener”
Describes how to install and configure the
Listener software, including how to set up the
processing that occurs when messages arrive at the
Listener.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xi
About This Guide
Organization
Chapter
Description
Chapter 3, “Installing the Explains the process of installing the LGMapper
and the LGArchiver servers. Provides information
LGMapper Server”
on how to use the DCOMCnfg tool and how to
troubleshoot the LGMapper installation.
Chapter 4,
“LGMapperCnfg and
LGArchiverCnfg Tools”
Provides information on how to use the
LGMapperCnfg and the LGMapperCnfg tools.
Chapter 5,
“LGMapperNM and
LGArchiverNM”
Discusses the LGMapper Node Manager
(LGMapperNM) and the LGArchiver Node
Manager (LGArchiverNM).
Chapter 6, “Alarms
Database Maintenance”
Describes maintaining the Alarms Database.
Chapter 7, “LGCnfg
Tool”
Describes how to manage the Alarms Database
using the LGCnfg tool.
Chapter 8, “Installing the Describes how to install the AlarmTracker client
software on your users’ systems.
AlarmTracker Client”
Chapter 9, “The Exclude Describes the Exclude Node feature of the
AlarmTracker Client software.
Node Feature”
Chapter 10,
“Deployment Issues”
Discusses deployment issues.
Chapter 11, “Backwards
Compatibility
Considerations”
Discusses backward compatibility considerations.
Chapter 12,
“Implementing the
IWantHelp Interface”
Describes implementing the IWantHelp interface.
Appendix A, “Alarms
Database Schema”
Provides the Alarms Database schema.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xii
About This Guide
Conventions
Conventions
This manual uses the following conventions.
Format
Example
Boldface type is used for user
Click OK.
entries, keys, buttons, and folder
and submenu names.
Italic type indicates one of the
following:
•
A newly introduced term
•
For emphasis
•
A generic syntax item that
you must replace with a
specific value
•
A title of a publication
An arrow (>) indicates an item
from a pull-down menu.
•
A skill group is a collection of agents
who share similar skills.
•
Do not use the numerical naming
convention that is used in the
predefined templates (for example,
persvc01).
•
IF (condition, true-value,
false-value)
•
For more information, see the Cisco
ICM Software Database Schema
Handbook.
The Save command from the File menu is
referenced as File >Save.
Other Publications
For additional information about Cisco Intelligent Contact Management (ICM) software, see the Cisco
web site listing ICM documentation.
Obtaining Documentation
Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several
ways to obtain technical assistance and other technical resources. These sections explain how to obtain
technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation at this URL:
http://www.cisco.com/techsupport
You can access the Cisco website at this URL:
http://www.cisco.com
You can access international Cisco websites at this URL:
http://www.cisco.com/public/countries_languages.shtml
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xiii
About This Guide
Documentation Feedback
Product Documentation DVD
Cisco documentation and additional literature are available in the Product Documentation DVD package,
which may have shipped with your product. The Product Documentation DVD is updated regularly and
may be more current than printed documentation.
The Product Documentation DVD is a comprehensive library of technical product documentation on
portable media. The DVD enables you to access multiple versions of hardware and software installation,
configuration, and command guides for Cisco products and to view technical documentation in HTML.
With the DVD, you have access to the same documentation that is found on the Cisco website without
being connected to the Internet. Certain products also have .pdf versions of the documentation available.
The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com
users (Cisco direct customers) can order a Product Documentation DVD (product number
DOC-DOCDVD=) from the Ordering tool or Cisco Marketplace.
Cisco Ordering tool:
http://www.cisco.com/en/US/partner/ordering/
Cisco Marketplace:
http://www.cisco.com/go/marketplace/
Ordering Documentation
Beginning June 30, 2005, registered Cisco.com users may order Cisco documentation at the Product
Documentation Store in the Cisco Marketplace at this URL:
http://www.cisco.com/go/marketplace/
Cisco will continue to support documentation orders using the Ordering tool:
•
Registered Cisco.com users (Cisco direct customers) can order documentation from the
Ordering tool:
http://www.cisco.com/en/US/partner/ordering/
•
Instructions for ordering documentation using the Ordering tool are at this URL:
http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm
•
Nonregistered Cisco.com users can order documentation through a local account representative by
calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in
North America, by calling 1 800 553-NETS (6387).
Documentation Feedback
You can rate and provide feedback about Cisco technical documents by completing the online feedback
form that appears with the technical documents on Cisco.com.
You can send comments about Cisco documentation to bug-doc@cisco.com.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xiv
About This Guide
Cisco Product Security Overview
You can submit comments by using the response card (if present) behind the front cover of your
document or by writing to the following address:
Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.
Cisco Product Security Overview
Cisco provides a free online Security Vulnerability Policy portal at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html
From this site, you can perform these tasks:
•
Report security vulnerabilities in Cisco products.
•
Obtain assistance with security incidents that involve Cisco products.
•
Register to receive security information from Cisco.
A current list of security advisories and notices for Cisco products is available at this URL:
http://www.cisco.com/go/psirt
If you prefer to see advisories and notices as they are updated in real time, you can access a Product
Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed from this URL:
http://www.cisco.com/en/US/products/products_psirt_rss_feed.html
Reporting Security Problems in Cisco Products
Cisco is committed to delivering secure products. We test our products internally before we release them,
and we strive to correct all vulnerabilities quickly. If you think that you might have identified a
vulnerability in a Cisco product, contact PSIRT:
•
Emergencies — security-alert@cisco.com
An emergency is either a condition in which a system is under active attack or a condition for which
a severe and urgent security vulnerability should be reported. All other conditions are considered
nonemergencies.
•
Nonemergencies — psirt@cisco.com
In an emergency, you can also reach PSIRT by telephone:
Tip
•
1 877 228-7302
•
1 408 525-6532
We encourage you to use Pretty Good Privacy (PGP) or a compatible product to encrypt any sensitive
information that you send to Cisco. PSIRT can work from encrypted information that is compatible with
PGP versions 2.x through 8.x.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xv
About This Guide
Obtaining Technical Assistance
Never use a revoked or an expired encryption key. The correct public key to use in your correspondence
with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page
at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.htm
The link on this page has the current PGP key ID in use.
Obtaining Technical Assistance
Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco
Technical Support & Documentation website on Cisco.com features extensive online support resources.
In addition, if you have a valid Cisco service contract, Cisco Technical Assistance Center (TAC)
engineers provide telephone support. If you do not have a valid Cisco service contract, contact your
reseller.
Cisco Technical Support & Documentation Website
The Cisco Technical Support & Documentation website provides online documents and tools for
troubleshooting and resolving technical issues with Cisco products and technologies. The website is
available 24 hours a day, at this URL:
http://www.cisco.com/techsupport
Access to all tools on the Cisco Technical Support & Documentation website requires a Cisco.com user
ID and password. If you have a valid service contract but do not have a user ID or password, you can
register at this URL:
http://tools.cisco.com/RPF/register/register.do
Note
Use the Cisco Product Identification (CPI) tool to locate your product serial number before submitting
a web or phone request for service. You can access the CPI tool from the Cisco Technical Support &
Documentation website by clicking the Tools & Resources link under Documentation & Tools. Choose
Cisco Product Identification Tool from the Alphabetical Index drop-down list, or click the Cisco
Product Identification Tool link under Alerts & RMAs. The CPI tool offers three search options: by
product ID or model name; by tree view; or for certain products, by copying and pasting show command
output. Search results show an illustration of your product with the serial number label location
highlighted. Locate the serial number label on your product and record the information before placing a
service call.
Submitting a Service Request
Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3
and S4 service requests are those in which your network is minimally impaired or for which you require
product information.) After you describe your situation, the TAC Service Request Tool provides
recommended solutions. If your issue is not resolved using the recommended resources, your service
request is assigned to a Cisco engineer. The TAC Service Request Tool is located at this URL:
http://www.cisco.com/techsupport/servicerequest
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xvi
About This Guide
Obtaining Additional Publications and Information
For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone.
(S1 or S2 service requests are those in which your production network is down or severely degraded.)
Cisco engineers are assigned immediately to S1 and S2 service requests to help keep your business
operations running smoothly.
To open a service request by telephone, use one of the following numbers:
Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447
For a complete list of Cisco TAC contacts, go to this URL:
http://www.cisco.com/techsupport/contacts
Definitions of Service Request Severity
To ensure that all service requests are reported in a standard format, Cisco has established severity
definitions.
Severity 1 (S1)—Your network is “down,” or there is a critical impact to your business operations. You
and Cisco will commit all necessary resources around the clock to resolve the situation.
Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your
business operation are negatively affected by inadequate performance of Cisco products. You and Cisco
will commit full-time resources during normal business hours to resolve the situation.
Severity 3 (S3)—Operational performance of your network is impaired, but most business operations
remain functional. You and Cisco will commit resources during normal business hours to restore service
to satisfactory levels.
Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or
configuration. There is little or no effect on your business operations.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online
and printed sources.
•
Cisco Marketplace provides a variety of Cisco books, reference guides, documentation, and logo
merchandise. Visit Cisco Marketplace, the company store, at this URL:
http://www.cisco.com/go/marketplace/
•
Cisco Press publishes a wide range of general networking, training and certification titles. Both new
and experienced users will benefit from these publications. For current Cisco Press titles and other
information, go to Cisco Press at this URL:
http://www.ciscopress.com
•
Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and
networking investments. Each quarter, Packet delivers coverage of the latest industry trends,
technology breakthroughs, and Cisco products and solutions, as well as network deployment and
troubleshooting tips, configuration examples, customer case studies, certification and training
information, and links to scores of in-depth online resources. You can access Packet magazine at
this URL:
http://www.cisco.com/packet
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xvii
About This Guide
Obtaining Additional Publications and Information
•
iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies
learn how they can use technology to increase revenue, streamline their business, and expand
services. The publication identifies the challenges facing these companies and the technologies to
help solve them, using real-world case studies and business strategies to help readers make sound
technology investment decisions. You can access iQ Magazine at this URL:
http://www.cisco.com/go/iqmagazine
or view the digital edition at this URL:
http://ciscoiq.texterity.com/ciscoiq/sample/
•
Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering
professionals involved in designing, developing, and operating public and private internets and
intranets. You can access the Internet Protocol Journal at this URL:
http://www.cisco.com/ipj
•
Networking products offered by Cisco Systems, as well as customer support services, can be
obtained at this URL:
http://www.cisco.com/en/US/products/index.html
•
Networking Professionals Connection is an interactive website for networking professionals to share
questions, suggestions, and information about networking products and technologies with Cisco
experts and other networking professionals. Join a discussion at this URL:
http://www.cisco.com/discuss/networking
•
World-class networking training is available from Cisco. You can view current offerings at
this URL:
http://www.cisco.com/en/US/learning/index.html
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
xviii
C H A P T E R
1
Remote Monitoring Suite Overview
Introduction
The Remote Monitoring Suite (RMS) includes the following software components:
•
Listener
•
LGMapper
•
LGArchiver
•
AlarmTracker Client
This chapter provides:
•
Background information so you can understand security and user rights issues when the Remote
Monitoring Suite components and your configuration databases work together in a network.
•
The functional architecture of the Remote Monitoring Suite.
•
A brief description of the components you use to configure and maintain Listener, LGMapper,
LGArchiver, and AlarmTracker Client.
Background Information
The Distributed Diagnostics and Services Network (DDSN) is a support architecture facility that gathers
event and message information from multiple systems at a central point. Service provider personnel can
then monitor this system information, react to urgent problems immediately, and examine a system
activity history to discover chronic problems.
In this scenario, each system runs a facility that detects and reports any unusual conditions or events that
occur.
These events and messages range from informational messages to reports of serious errors. This
information is passed onto a process called the Listener (Figure 1-1).
The Listener typically runs stand-alone at the (network) service provider site. A single Listener can
receive events from multiple systems. Depending on the installation, the systems might connect to the
Listener via a modem and a dial-up connection using the Windows Remote Access Server (RAS) or by
using a direct network connection.
LGMapper is a server that accepts data from the Listener process and maps Listener objects into a
preconfigured object hierarchy. This server also caches managed object attribute data, and updates
connected AlarmTracker Client applications with new event and alarm data. This event mechanism gives
quick notification to network service provider representatives when a problem occurs.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-1
Chapter 1
Remote Monitoring Suite Overview
Background Information
Error Reporting
Figure 1-1 provides an overview of the Remote Monitoring Suite error reporting process.
Figure 1-1
Error Reporting Overview
ICM Customer Side
Logger
CSFS
DTP
RAS or Network Connection
AlarmTracker Client
LGMapper
Server
Listener
AlarmTracker Client
TAC
ISN Customer Side
Via Sockets
ISN
SDDSN
RAS or Network Connection
AlarmTracker Client
LGMapper
Server
AlarmTracker Client
TAC
63914
Listener
ICM, CVP, Cisco Media Blender or other Cisco products send event information to the Listener
application. These products inform the Listener application of any significant errors or unexpected
conditions.
Four processes on the ICM Logger (or SDDSN) handle error reporting. The two processes used for
remote monitoring and are:
•
Customer Support Forwarding Service (CSFS)
– Receives events, filters them, and forwards the events to other processes that request the data.
•
DDSN Transfer Process (DTP)
– Receives data from CSFS
– Transfers the events and export files to the machine running the Listener. The DTP uses either
a dial-up connection and the Remote Access Service (RAS) or a direct network connection. The
Listener stores the events in a customer-specific directory on its machine.
Event messages received by the Listener include information about when and where the error occurred
and the full message as reported on the event feed.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-2
Chapter 1
Remote Monitoring Suite Overview
Background Information
The DTP process keeps EMS events in memory until they are delivered to the Listener. To minimize the
traffic to the Listener, and particularly the number of RAS connections needed over time, messages are
batched together and sent periodically. However, if the DTP process receives a high priority event, it
immediately sends the event to the Listener. If an attempt to establish a RAS connection fails, the DTP
process periodically tries to re-establish the RAS connection.
The DTP process checks to see if there are EMS events to be processed. When there are new events, the
DTP process sends the events to the Listener, establishing a RAS connection if necessary.
Note
You can configure the time interval for the DTP process to check for EMS events; thirty minutes is the
default setting.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-3
Chapter 1
Remote Monitoring Suite Overview
Background Information
Remote Monitoring Suite Functional Architecture
Figure 1-2 illustrates the overall functional architecture of the Remote Monitoring Suite.
Figure 1-2
Remote Monitoring Suite Functional Architecture
Archived
Alarms
DB
LGArchiver
LGArchiverNM
Network
Boundary
Listener
LGMapperNM
AlarmTracker
Client
Alarms
DB
Component Description
The major Remote Monitoring Suite components are discussed in Table 1-1.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-4
AlarmTracker
Client
63915
LGMapper
Chapter 1
Remote Monitoring Suite Overview
Background Information
Table 1-1
Remote Monitoring Suite Component Description
Component
Description
Listener
A Windows service management application that
tracks multiple ICM systems. It serves as a receiver
and message distributor for customer event data.
LGMapper
A central COM server that accepts data from the
Listener and maps the data into a pre-configured object
hierarchy. It also caches managed object attribute data,
responds to poll requests from remote clients for
updated attribute data, and sends event notifications to
clients that represent traps and state changes to
managed objects.
LGMapperNM
A Windows service that controls the lifetime of the
LGMapper COM server. When the LGMapper is
running, it determines the health of the process by
querying the LGMapper for statistics. If it detects that
the LGMapper is not processing data, it stops the
server and restarts it. The user interface provided as
part of the service is also used to disable the
LGMapper for maintenance or other reasons.
Alarms DB
A SQL Server database attached to the LGMapper that
stores configuration and alarm information. The
configuration information contains tables of OID
(ObjectIDentifier) Nodes representing the “class”
definitions, and Rules which define the mapping of a
Listener message to an OID Node and how to specify
the instance of the class to which the object refers. The
mappings are created by the LGCnfg tool. This
database also contains the set of Alarm Objects visible
to LGMapper clients.
LGArchiver
A central COM server that maps Listener events into
the appropriate Alarm Objects and manages the
Archived Alarms DB.
LGArchiverNM
A Windows service that controls the lifetime of the
LGArchiver COM server. When the LGArchiver is
running, it determines the health of the process by
querying the LGArchiver for statistics. If it detects that
the LGArchiver is not processing data, it stops the
server and restarts it.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-5
Chapter 1
Remote Monitoring Suite Overview
Background Information
Table 1-1
Remote Monitoring Suite Component Description (continued)
Component
Description
Archived Alarms DB
A SQL Server database attached to the LGArchiver
that stores configuration and alarm information. The
configuration information contains tables of OID
(ObjectIDentifier) Nodes representing the “class”
definitions, and Rules which define the mapping of a
Listener message to an OID Node and how to specify
the instance of the class to which the object refers. The
mappings are created by the LGCnfg tool. This
database differs from the Alarms Database in that it
does not process deleted base record messages
received from the Listener, and it archives data for a
longer time period. This database is intended as a data
repository for offline trend analysis reports. The
database schema for this database is identical to that of
the Alarms Database.
LGCnfg Tool
A GUI application that creates and manages the
mapping of Listener event objects to LGMapper
Nodes. Mappings are made by defining Rules which
use information contained in the Listener object
message to identify the proper LGMapper Node
instance. Once the Rules are defined, the LGMapper
can apply these Rules at runtime to associate a Listener
Object to a specific node instance and attribute
whenever an event of that type is received in the
Listener event feed stream. This tool compensates for
the incomplete managed object description in the
current stream of information available to Listener.
AlarmTracker Client
The client application that displays customer and node
status.
LGMapper and LGArchiver Differences
LGArchiver operation is very similar to LGMapper operation in that they both connect to Listener as a
client and the both manage databases containing object mapping and Alarm Objects, but their purposes
are quite different.
The LGMapper server is designed to serve multiple AlarmTracker Client applications. It processes
Listener event messages and manages Alarm Objects in the database, and notifies each active
AlarmTracker Client of relevant Listener events. In addition, AlarmTracker Clients make direct queries
against the Alarms Database in order to update their displays. The default value for time history of Alarm
Objects is 7 days (168 hours). Use the LGMapperCnfg tool to change the value. The value depends on
the number of customers and products you need to monitor.
The LGArchiver server, on the other hand, has no clients attached to it. Its primary purpose is to process
Listener events and manage the Archived Alarms Database. It is intended to archive alarms over a longer
period so you can run trend analysis and report against it. For this reason, the default alarms time history
setting for the LGArchiver is 30 days. This value can be changed using the LGArchiverCnfg tool.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-6
Chapter 1
Remote Monitoring Suite Overview
Network Considerations
Samples of web-based reports that can be run against the Archived Alarms Database can be foundon the
Operations Support CD-ROM in the Samples > Reporting subdirectory.
Network Considerations
The system design does not limit LGMappers to a one-to-one relationship with Listener processes. From
the Listener point of view, an LGMapper is a client. Thus, the connection between the Listener and the
LGMapper can cross a network boundary.
There can be no more than two Listener processes. These processes can be distributed in a Local Area
Network (LAN) or at different sites connected by a Wide Area Network (WAN) to achieve fault
tolerance.
The LGMapper processes can also be distributed, but they are not limited to two instances. Judicious
placement of LGMapper servers optimizes the use of network bandwidth. For example, if you plan to
set up a support center at a site that is remote from the Listener locations, it makes sense to place one or
more LGMapper servers in the LAN at the support center so that AlarmTracker Client connections are
always in the LAN. That way, only one or two WAN connections are needed from the LGMapper to the
Listener, rather than co-locating the LGMapper server with the Listener (which would result in having
a WAN connection for each AlarmTracker Client).
Security
RMS does not support the use of the following security features:
•
Windows Firewall on Windows 2003
•
Security Hardening Script from the ICM CD
Fault Tolerant Functional Architecture
Figure 1-3 illustrates the overall functional architecture of the system in the context of operating in a
fault-tolerant environment.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-7
Chapter 1
Remote Monitoring Suite Overview
Fault Tolerant Functional Architecture
Figure 1-3
Fault Tolerant Functional Architecture
Network
Boundary
LGCnfg Tool
Alarms
DB
AlarmTracker
Client
Listener 1
LGMapper 1
AlarmTracker
Client
Listener 2
LGMapper 2
AlarmTracker
Client
AlarmTracker
Client
63916
Alarms
DB
Note the following features in Figure 1-3:
•
Redundant Alarms Databases
– They provide fault tolerance when one of the hosts running a Listener/LGMapper/Alarms
Database is unreachable.
•
Each AlarmTracker Client is capable of communicating with two running LGMapper servers, but to
conserve network bandwidth, only one of the servers is designated as primary (or active).
– If the AlarmTracker Client is connected to the LGMapper servers, the primary LGMapper
server performs all communication between the two processes. In the event of a primary server
failure, the AlarmTracker Client must then switch over to the backup (or standby) server.
Further discussion on the deployment of machines to achieve fault-tolerant performance is found in Fault
Tolerant Considerations, page 1-12.
The LGArchiver Server is not shown in Figure 1-3. There is no fault-tolerant scheme for it. Install the
LGArchiver server on a high-availability server with little or nothing else running on it. Perform
standard SQL Server backups on the database to avoid data loss.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-8
Chapter 1
Remote Monitoring Suite Overview
Alarms Database
Alarms Database
Overview
The Alarms Database used by the LGMapper and LGArchiver is a Microsoft SQL Server database
containing the information needed to map Listener objects to attributes of a node in a hierarchy of
product objects. The database also contains a table of Instance Nodes which is populated by the
LGMapper at runtime. This table is saved between LGMapper sessions and represents actual Instance
Nodes created based on Rules that were successfully applied at runtime. In addition, the Alarms
Database contains a history of alarms objects representing the past and current states of the monitored
product.
Note
The schema of the Alarms Database (see Appendix A, “Alarms Database Schema”) connected to the
LGMapper and the Archived Alarms Database connected to the LGArchiver are identical. Thus, the
discussion of the Alarms Database applies to both databases.
The Remote Monitoring Suite lets you monitor products other than the ICM. During installation, the
Alarms Database is populated with Object Identifier (OID) Nodes and Rules for supporting the Cisco
ICM, CVP, and Cisco Media Blender products. As other products are supported, updates to the tables
that manage this information can be provided as hot fixes.
The Rule Mapping Process
The Alarms Database is installed with a pre-loaded set of OID Nodes and Rules used by the LGMapper
and LGArchiver to map incoming Listener objects to a specific attribute in an Instance Node somewhere
in the hierarchy. In the current release, OID Nodes and Rules are supplied for the Cisco ICM, CVP, and
Cisco Media Blender products. Other products can be added later as hot fixes. This information is stored
in the database in the OID Nodes, Attributes, OIDNodeAttributes, and Rules tables.
As Listener events are received by the LGMapper, it uses the set of Rules to map the object to an attribute
of a particular OID Node. It then uses the Rule contents to determine the Instance Node to which the
object applies. Once the Attribute and Instance Node are determined, the LGMapper updates the Alarms
Database and it updates the state of the affected node. This, in turn, may result in a state change in other
nodes (specifically its parent node) since the Remote Monitoring Suite supports the notion of state roll
up in the node hierarchy.
Use the LGCnfg tool to modify the set of Rules and to create new OID Nodes for products. The LGCnfg
tool can be used to define new products. As previously mentioned, the Alarms Database comes
pre-loaded with the OID Nodes and Rules for ICM and CVP. However, if you are interested in creating
your own object hierarchy, or modifying the existing one, the LGCnfg tool is provided for that purpose.
If you plan to experiment and create your own Rules and/or OID object hierarchy, we strongly suggest
you use the LGCnfg tool to create a new database for this purpose. More information on the use of this
tool is given in the LGCnfg Tool section.
If you detect any Listener object issues that are not mapped (unmapped objects appear in the Unmapped
Objects Node under each customer product instance) or Listener Objects that are mapped to the wrong
Instance Node, contact Cisco Technical Assistance Center (TAC) to report the problem.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-9
Chapter 1
Remote Monitoring Suite Overview
Alarms Database
Instance Nodes
When a Listener event message is processed, it is mapped by a Rule to an attribute of an OID Node. The
Rule, along with the message content, is then used to determine the Instance Node to which it applies.
If this Instance Node does not exist, it is created by the LGMapper software. When it is created, an entry
in the InstanceNodes table is created and an in-memory copy of the node is created in the proper place
in the hierarchy so that its state can be properly tracked. In addition, there is an associated table (the
Customers table) which manages the set of known customers.
When the LGMapper initializes, the full set of Instance Nodes is read from the InstanceNodes table.
Every Alarm Object must be associated with an attribute of an Instance Node. Thus, the Instance Nodes
are persisted from session to session. As time goes on, you may find that you may want to prune this
information as devices are retired or as customers are deleted. The LGCnfg tool is used to delete Instance
Nodes as needed. More information on how to do this is provided in Chapter 7, “LGCnfg Tool”.
Note
It is important to use the LGCnfg tool to modify the database contents and not SQL Server directly. This
is because of the relationships that exist between the tables.
Alarm Objects
One of the most important purposes of the Alarms Database is to manage a set of Alarm Objects. An
Alarm Object is defined as an object that generally indicates some type of failure condition for some
component in a system. Typically, an Alarm Object is created by an event that signals or raises the alarm.
The Alarm Object has a state consisting of the object being raised (down) or cleared (up), and an
Assignment Status indicating the action TAC is taking in response to the alarm. An Alarm Object
consists of one or more Listener Events indicating its state transitions.
Alarm Objects are persisted in two tables in the Alarms Database: the Alarms table (which stores
information about each Alarm Object), and the Events table (which stores information about each Event
that makes up the Alarm Object). In addition, a third table (the Simples table) stores a special kind of
single-state Alarm Object. The Simples tables stores Simple Events from Listener which are considered
to be lower priority events. Since these events are stateless and lower priority, they are separated from
the main Alarms tables.
Another table (the ObjectState table) is used by LGMapper (but not LGArchiver) to store the current
object state of all Listener objects. The ObjectState table contains a cross reference from the Listener
ObjectName (qualified by ProductID and CustomerID) to the current Alarm Object referencing it.
Alarms History
Not only do the LGMapper and LGArchiver maintain the current state of the set of Alarm Objects, they
also maintain an archived history of closed Alarm Objects. A closed Alarm Object is one whose state is
“up” and whose assignment status is “unassigned”.
You can see both closed and open Alarm Objects in the Alarms View display using the AlarmTracker
Client. Select a different filter to view just the open Alarm Objects.
LGMapper and LGArchiver both have a configuration setting called Alarms Objects History which
manages the size of the Alarms Database so that it does not grow unbounded. This setting specifies how
long closed Alarms Objects are maintained in the database before being purged.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-10
Chapter 1
Remote Monitoring Suite Overview
Alarms Database
The Alarms Objects History setting affects only closed Alarms Objects. Open Alarm Objects are never
purged, regardless of how old they are. A closed Alarm Object is subject to being purged when the time
it is closed is older than the value of Alarms Objects History setting. Purging is done when the
LGMapper or the LGArchiver starts up, and at occasional intervals when it is running.
For the LGMapper, the initial default value is 7 days (168 hours). Use the LGMapperCnfg tool to change
this setting if necessary. Since the LGMapper and AlarmTracker Client are considered to be tactical
products, you can determine how long a history you want AlarmTracker Clients to see. The value you
use may affect the response time of the AlarmTracker Clients. The larger the value, the longer it takes
for each database query because the queries are performed against more data, and more data is returned
across the wire in the result set. You must determine what setting is best for you and your environment.
For the LGArchiver, the initial default value is 30 days. LGArchiver real-time performance is less critical
than that of the LGMapper, thus, it is expected that the Alarms Objects History is longer for the
LGArchiver. The value depends solely on how much disk storage you are willing to allocate for the
database. As a guideline, monitoring 160 ICM customers for a 30-day history the database size required
is approximately 1.3GBytes. The database size is directly proportional to the number of customers and
products being monitored. Thus, if your installation is monitoring 40 customers, you could probably set
a 120 day history and end up with a database of approximately the same size.
The following formula can be used to estimate the SQL Server database MDF file size:
[MDF File Size MBytes] = 0.3 X [Number of Customers] X [Time History in Days]
Remember, the database is purged so its size does not grow unbounded. In addition, at startup a check
is made and once-per-week the database is completely re-indexed using the DBCC DBREINDEX T-SQL
command.
Alarms Database Schema
We have already introduced the names of several of the tables maintained in the Alarms Database.
Further documentation on the specific content of all tables in the database can be found in Appendix A
(the Alarms Database Schema Description). This schema information is used to create specific queries
and reports to perform trend analysis on the LGArchiver Alarms Database.
Accessing the LGArchiver Database
The LGArchiver Alarms Database is intended to perform longer-term Alarm archiving than the
LGMapper Alarms Database. The schema is open and allows you to write customized queries and reports
against this database to perform specific analyses or trend reporting.
When accessing the database, keep security in mind. By default, the three LGMapper user groups are
given access to the database. The LGM Readers are given read access only, LGM Users are given
read/write access, and the LGM Administrators group is given administrator rights. Edit this as you see
fit, but, make sure the LGMapper account has administrator rights since the LGArchiver Server runs
under this account and is doing all the database work.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-11
Chapter 1
Remote Monitoring Suite Overview
Deployment Considerations
Deployment Considerations
Fault Tolerant Considerations
Figure 1-3 shows a fault-tolerant deployment of the LGMapper Servers. Each LGMapper Server
connects to a single Listener so you can install an LGMapper Server on the same machine as the Listener.
To achieve LGMapper fault tolerance, you must use at least two machines (four machines if you do not
install LGMapper on the same machine as the Listener).
The LGArchiver is not fault tolerant, therefore, you can install it on any machine that meets the
requirements indicated in the Cisco Intelligent Contact Manager Release 7.0(0) Bill of Materials. For
example, you can install the LGArchiver software on one of the LGMapper machines. If you are
supporting a large number of customers, install the LGArchiver on a separate machine so that the
LGMapper can provide adequate real-time response for AlarmTracker Clients. Because the LGArchiver
is not fault tolerant, schedule database backups to prevent data loss in the event of a system or disk
failure.
Distributed Architecture
The LGMapper is a client of the Listener server. The Listener server can send data to one or more
LGMapper processes. The LGMapper processes can be installed on a single machine or can be installed
on multiple machines on a Wide Area Network (WAN).
The Listener design limits the number of Listener process to two. These processes may be distributed in
a Local Area Network (LAN) or at different sites connected by a Wide Area Network (WAN) to achieve
fault tolerance. In fact, judicious placement of LGMapper Servers can optimize the use of network
bandwidth. For example, to set up a support center at a site that is remote from the Listener locations,
install one or more LGMapper Servers in the LAN at the support center so that AlarmTracker Client
connections are always in the LAN. In this configuration, only one or two WAN connections are needed
from the LGMapper to the Listener. Figure 1-4 shows an example of this type of deployment. If you
install the LGMapper server and Listener server on the same machine, each AlarmTracker Client at a
remote support center would need a WAN connection.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-12
Chapter 1
Remote Monitoring Suite Overview
Hardware and Software Requirements
Figure 1-4
Example Separated Support Center Deployment Strategy
San Jose Support Center
LGMapper 1
AlarmTracker
Clients
LGArchiver
Listener A
LGMapper 2
Brussels Support Center
LGMapper 1
AlarmTracker
Clients
LGArchiver
LGMapper 2
63917
Listener B
Hardware and Software Requirements
SQL Server is an integral part of the Remote Monitoring Suite. SQL Server must be installed on every
machine running the LGMapper or LGArchiver Server.
For complete and current information on the SQL Server, see the Cisco Intelligent Contact Management
Software Release 7.0(0) Bill of Material, which is available at:
http://www.cisco.com/univercd/cc/td/doc/product/icm/index.htm
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-13
Chapter 1
Hardware and Software Requirements
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
1-14
Remote Monitoring Suite Overview
C H A P T E R
2
Installing and Configuring the RMS Listener
This chapter describes how to install and configure the RMS Listener server.
You can set up the processing that occurs when messages arrive at the Listener. This includes specifying
the customer-specific directory in which a customer’s messages are stored and designating which
representatives or administrators are notified of error messages from a given customer or related to a
specific area of the ICM product.
The Listener runs as a service so that it can be set to start automatically when the machine starts. A
network service provider site can have two Listeners. You can install the Listener on two systems
(designate one to be side A and the other to be side B).The Listeners run simultaneously, then
synchronize with each other. This provides a duplexed, fault tolerant system.
You must install the LGMapper/LGArchiver and Listener servers on separate machines.
Note
The AlarmTracker Client software requires that you also install the Listener and LGMapper software.
Note
If you are planning to monitor a product other than the ICM software, you need to install the product
specific update on the Listener machine. When installing the update, do not install it into the same
directory as the Listener. Refer to the product specific documentation for instructions on how to apply
the update.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-1
Chapter 2
Installing and Configuring the RMS Listener
Upgrading an RMS Listener Server That Monitors ICM Dialup
Connections
The RMS 2.1(0) Listener server runs only on Windows 2000 or Windows 2003 Server. The NetBEUI
protocol is not available on the Windows 2003 Server. This means that you can only monitor dialup
customers who are running ICM 5.0 or later and who have configured their loggers to use TCP/IP. To
monitor dialup connections from customers running ICM 4.6.2 or earlier, run the RMS Listener on
Windows 2000 Server and enable the NetBEUI protocol. If you are using a direct network connection,
this is not an issue.
Guidelines
Note
The RMS installation upgrades RMS software from 2.0 or 2.0 SR1 to 2.1.
Upgrade RMS Listener servers that monitor dialup connections from ICM Loggers in the following
sequence:
Step 1
Upgrade RMS Listener servers running Windows 2000 server to RMS release 2.1 before upgrading the
operating system to Windows 2003. For dialup connections, configure Microsoft RAS on the RMS 2.1
Listener server for TCP/IP and NetBEUI protocols. This enables ICM/IPCC 7.0(0) Loggers to dial in to
RMS 2.1 Listener servers. The Cisco Remote Monitoring Administration Guide describes how to install
and configure RMS components. Refer to the ICM Installation Guide for Cisco ICM Enterprise Edition
for instructions on installing ICM/IPCC Logger software.
Step 2
Install new message files on AlarmTracker client machines by running the SDDSN (Standalone
Distributed Diagnostics and Service Network) setup from the latest ICM setup CD. SDDSN is a
sub-component of the ICM system, which provides a mechanism for “phone home” services and
generating SNMP traps. It is intended to be integrated into other products (e.g., Cisco ISN) to provide
event reporting capability. Refer to the Cisco ICM Enterprise Edition Administration Guide for more
information on SDDSN.
Step 3
Upgrade ICM Logger systems that send events to RMS Listener servers using one of the following
methods:
•
Install ICM Logger 7.0 on a Windows 2003 server.
•
Configure ICM Logger 5.0 and 6.0 systems running on Windows 2000 servers to use the TCP/IP
protocol to send events to RMS Listener servers. For instructions, refer to “Configuring ICM
Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server Using the TCP/IP Protocol”
on page 10.
Step 4
Back up the Alarms database, stop the LGMapper and LGArchiver services, and set these services to
either manual or disabled.
Step 5
Upgrade RMS 2.1 Listener servers to Windows 2003 Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-2
Chapter 2
Installing and Configuring the RMS Listener
Installing the RMS Listener Server
Installing the RMS Listener Server
Use the following procedure to install the RMS Listener server.
How to Install the RMS Listener Software
Note
The RMS installation upgrades RMS software from 2.0 or 2.0 SR1 to 2.1.
Note
If the installation detects the Cisco Security Agent (CSA) running on the system, it prompts you to stop
the CSA service, then restart this installation.
Step 1
Run Setup.exe from the Listener directory of the Operations Support CD-ROM.
Step 2
In the Listener Properties dialog box, specify the settings as shown in Table 2-1, then click Next.
Table 2-1
Listener Properties Settings
Property
Settings
Node Manager Properties
Enable Production Mode and Auto
Start at System Startup, unless you are
specifically told otherwise by your
Cisco ICM/NAM support
representative.
Enable duplexed Listener if the
Listener is duplexed.
Side
Indicate if this machine is the Side A or
the Side B Listener. If the Listener is
not duplexed, choose Side A.
Drive
Choose the disk drive on which you
want to install the Listener software.
You must choose a local drive. Setup
installs the Listener files to the /icr
directory on the drive you select.
Language
Specify either American English or
United Kingdom English.
Step 3
In the Check Setup Information dialog box, confirm that the settings you have chosen appear correctly.
If you want to change any settings, click Back. If the settings are correct, click Next to begin copying
the Listener files.
Step 4
When the files are copied successfully, the Setup Complete dialog box appears.
Step 5
If this is the first time that you are installing the Listener, click Finish.
Do not start the Listener until you have configured it. For instructions on configuring the RMS Listener
Server, see “Configuring the RMS Listener Server” on page 4.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-3
Chapter 2
Installing and Configuring the RMS Listener
Beeper.flt Modifications
Beeper.flt Modifications
The beeper.flt file contains configuration information used by the Listener server to send events to a
beeper or pager. If this file exists in ICR\Listener\filters, Setup renames the file to beeper_1.sav. If
beeper_1.sav exists, it renames the file to beeper_2.sav, and so on until beeper_99.sav is created.
If you modified the original beeper.flt file, migrate the changes from the.sav version (the pre-existing
version) of the file to the new beeper.flt file.
Configuring the RMS Listener Server
After installing the RMS Listener server, perform the following configuration tasks:
Note
•
Configure the Listener as a RAS server
•
Define general Listener configuration information
•
Add customer-specific configuration information
You must stop the Listener before editing Listener configuration information. Restart Listener after you
have completed your configuration edits.
Configuring the RMS Listener Server as a RAS Server
Configure the RMS Listener server to act as a remote access server (RAS). A RAS server provides dialup
remote access to clients sending notification events from remote sites. The RMS Listener on Windows
2003 server can monitor dialup connections from ICM Logger clients that run ICM release 5.0, 6.0, and
7.0 and have TCP/IP configured.
To monitor connections from ICM Logger clients running release 4.6.2 or earlier, run the Listener server
on the Windows 2000 server and enable the NetBEUI protocol.
After you configure the RMS Listener server as a RAS server, specify a policy for disconnecting idle
remote connections.
Windows 2003
This section explains how to configure the RMS Listener server as a RAS server on Windows 2003
server.
The Windows 2003 server includes the following protocols for transferring information between a
computer and the network:
•
TCP/IP
•
IPX
•
AppleTalk
The Windows 2003 server does not include the NetBEUI protocol.
This means that the RMS Listener server on Windows 2003 can accept dialup connections only from
ICM Logger clients that meet the following criteria:
•
ICM 5.0, 6.0, or 7.0 software is installed
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-4
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
•
TCP/IP is configured
For instructions on configuring ICM Logger clients for TCP/IP connections, refer to “Configuring ICM
Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server Using the TCP/IP Protocol” on
page 10.
Note
These instructions apply only to customers using the ICM Listener option.
How to Configure the RMS Listener Server as a RAS Server
To configure the RMS Listener server as a RAS server on Windows 2003 Server:
Caution
Consult with your IT department before setting up your Listener server as a RAS device on your
network.
Step 1
On the RMS Listener machine, select Start > Programs > Administrative Tools > Routing and
Remote Access.
Step 2
Right-click the server you want to configure and select Configure and Enable Routing and Remote
Access. The Routing and Remote Access window displays (Figure 2-1).
Figure 2-1
Routing and Remote Access Server Setup Wizard
Step 3
Click Next to start the Routing and Remote Access Server Wizard.
Step 4
Select Remote access (Dialup or VPN), then click Next.
Step 5
Select the Dial-up check box. Leave the VPN check box unchecked. Click Next.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-5
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Step 6
In the IP Address Assignment window, select From a specified range of addresses, then click Next.
Step 7
On the Address Range Assignment window, select the range of IP addresses to assign to remote clients.
If no IP address ranges are available, click New (Figure 2-2).
Figure 2-2
Step 8
Address Range Assignment Window
In the New Address Range dialog box, specify a private range of addresses (for example, 192.168.1.1 to
192.168.1.254), then click OK (Figure 2-3).
The number of IP addresses in the range must equal at least the number of modems on this server plus
an additional address for the host. This range must not be within an address range needed by the host
system or any of the ICM logger systems connecting to this Listener server
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-6
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Figure 2-3
New Address Range Window.
Step 9
When you finished entering the range of IP addresses, click Next.
Step 10
Accept the default settings for the remainder of the wizard.
Step 11
When the wizard is finished, right-click the server entry again and select Properties. The Properties
window displays.
Step 12
Select the General tab.
Step 13
Select the Remote access server check box.
Step 14
Select the IP tab.
Step 15
Select the Enable IP Routing and Allow IP-based remote access and demand-dial connections.
check boxes.
Step 16
Make sure the static address range is correct.
Step 17
Select the Enable Broadcast Name Resolution check box.
Step 18
Accept the defaults for the remaining tabs, then click OK.
Step 19
When the configuration is complete, the RAS services restart.
Note
Do not enable RAS Server capability on the Logger, because this might create a conflict with the ICM
DTP process using the modem.
How to Configure a RAS Policy for Handling Idle Connections
You must configure RAS services on the Listener server before configuring a RAS policy. See “How to
Configure the RMS Listener Server as a RAS Server” on page 9. Configuring a RAS policy to handle
idle connections avoids a potential issue in which the DTP fails to hang up the modem connection and
leaves the modem connected to the Listener.
To configure a RAS policy for handling idle remote connections:
Step 1
On the Listener machine, select Start > Programs > Administrative Tools > Routing and Remote
Access.
Step 2
Double-click the RAS server you want to configure and select Remote Access Policies.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-7
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Step 3
In the right pane, double click Connections to Microsoft Routing and Remote Access Server. The
Connections to Microsoft Routing and Remote Access Server Properties dialog box opens.
Step 4
Select Settings, then select Edit Profile. The Edit Dial-in Profile dialog box opens.
Step 5
Select Dial-in Constraint, select Minutes server can remain idle before it is disconnected
(Idle-Timeout), enter the desired number of minutes (for example, 10), then click OK.
Step 6
Click OK again to close the Connections to Microsoft Routing and Remote Access Server Properties
dialog box.
Windows 2000
This section explains how to configure the RMS Listener server as a RAS server on Windows 2000
Server.
The RMS Listener server on Windows 2000 server can monitor dial-up connections from ICM Logger
clients with the following configurations:
•
ICM release 4.6.2 or earlier using the NetBEUI protocol.
•
ICM release 5.0 or later using either TCP/IP or NetBEUI protocols.
For instructions on configuring ICM Logger clients for TCP/IP connections, refer to “Configuring ICM
Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server Using the TCP/IP Protocol” on
page 10.
Caution
Consult with your IT department before setting up your Listener server as a RAS device on your
network.
How to Install the NetBEUI protocol (Optional)
Step 1
On the Listener machine select Start>Settings>Control Panel>Network and Dialup Connections.
The Network and Dialup connection window opens.
Step 2
Right click on Local Area Connection and select properties.
Step 3
Verify that NetBEUI is installed.
If NetBEUI is listed, continue to “How to Configure the RMS Listener Server as a RAS Server” on
page 9. If NetBEUI is not listed, click Install and following the remaining steps.
Note
NetBEUI does not need to be selected in this screen, this is just done to verify it is installed.
Step 4
Select protocol and click Add.
Step 5
Select NetBEUI protocol and click OK.
Step 6
Insert the Windows 2000 Server disk if prompted.
The NetBEUI protocol is now listed under Local Area Connections.
Step 7
Uncheck NetBEUI for this connection and click Close.
The NetBEUI protocol is now installed.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-8
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
How to Configure the RMS Listener Server as a RAS Server
Step 1
On the RMS Listener machine, select Start > Programs > Administrative Tools > Routing and
Remote Access. The Routing and Remote Access window displays (Figure 2-1).
Step 2
Start the Routing and Remote Access Server Setup Wizard by right-clicking on the server you want to
configure.
Step 3
Select Configure and Enable Routing and Remote Access.
Step 4
Select Remote Access Server (RAS) and click Next.
Step 5
Select Setup and advanced remote access server, then click Next.
Step 6
The Remote Client Protocols windows opens. The TCP/IP and NetBEUI protocols are listed. Select Yes,
all the required protocols are present, then click Next.
Step 7
In the IP Address Assignment window, select From a specified range of addresses, then click Next.
Step 8
On the Address Range Assignment window, select the range of IP addresses to assign to remote clients.
If no IP address ranges are available, click New.
Step 9
In the New Address Range dialog box, specify a private range of addresses (for example, 192.168.1.1 to
192.168.1.254), then click OK (Figure 2-3).
The number of IP addresses in the range must equal at least the number of modems on this server plus
an additional address for the host. This range must not be within an address range needed by the host
system or any of the ICM logger systems connecting to this Listener server
Step 10
Click Next on the remaining dialogs (selecting the default settings) to complete the wizard.
Step 11
When the wizard is finished, right-click on the server entry again and select Properties. The Properties
dialog appears.
Step 12
Select the General tab. Check only the Remote access server check box.
Step 13
Select the IP tab. Select Enable IP Routing and Enable Allow IP-based remote access and
demand-dial connections. Make sure the static address range is correct
Step 14
Select the NetBEUI tab. Use the check box to enable NetBEUI based remote access clients, and select
the This computer only option.
Step 15
Select the AppleTalk tab. Make sure the Enable AppleTalk remote access check box is unchecked.
Step 16
Accept the defaults for the remaining tabs and close the dialog.
When the configuration is complete, the RAS services restart.
How to Configure a RAS Policy for Handling Idle Connections
You must configure RAS services on the Listener server before configuring a RAS policy. For
instructions on configuring RAS services, see “How to Configure the RMS Listener Server as a RAS
Server” on page 9. Configuring a RAS policy to handle idle connections avoids a potential issue in which
the DTP fails to hang up the modem connection and leaves the modem connected to the Listener.
To configure a RAS policy for handling idle remote connections:
Step 1
On the Listener machine, select Start > Programs > Administrative Tools > Routing and Remote
Access.
Step 2
Double-click the RAS server to configure and select Remote Access Policies.
Step 3
In the right pane, double click Connections to Microsoft Routing and Remote Access Server. The
Connections to Microsoft Routing and Remote Access Server Properties dialog box opens.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-9
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Step 4
Select Settings, then select Edit Profile. The Edit Dial-in Profile dialog box opens.
Step 5
Select Dial-in Constraint, select Minutes server can remain idle before it is disconnected
(Idle-Timeout), enter the desired number of minutes (for example, 10), then click OK.
Step 6
Click OK again to close the Connections to Microsoft Routing and Remote Access Server Properties
dialog box.
Configuring ICM Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server Using the
TCP/IP Protocol
Note
ICM 7.0 Loggers use TCP/IP by default. If you are upgrading an ICM Logger from a previous release
to ICM Release 7.0 running on Windows 2000, you should follow this procedure.
How to Configure ICM Release 5.0, 6.0, and 7.0 Loggers to Connect to an RMS Listener Server
Caution
Make sure that the Listener you will be dialing into has enabled IP-based remote access and demand-dial
connections.
Step 1
On the ICM Logger machine, open the.pbk file located in <ICM DRIVE>:\icm\<instance name>\<la or
lb>\ CISCO_DDSN_PHONE_HOME.pbk. For example:
C:\icm\lg5\la\ CISCO_DDSN_PHONE_HOME.pbk
Step 2
Click properties. Select the networking tab.
Step 3
Uncheck NetBEUI. Check TCP/IP.
Step 4
With TCP/IP selected, click properties.
Step 5
Under the general tab, verify that use default gateway on remote network is unchecked.
Step 6
Click OK. Click OK again, then click Close.
Step 7
Restart the logger process.
Specifying General Listener Configuration
General Listener settings apply to all customers across the entire Listener process.
Note
Keep in mind that any settings labeled static will not take effect until you reboot the system. Changes to
all other settings take effect when you click OK.
Use the following procedure to access the general Listener configuration settings.
How to access the general Listener configuration settings
Step 1
Run the listencfg.exe tool in the /icm/bin directory.
The Listener Configuration dialog box opens (Figure 2-4).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-10
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Figure 2-4
Listener Configuration Dialog Box.
Step 2
Select one of the tabs to edit the settings. The following sections describe the settings available in each
tab of the Listener Configuration dialog box.
Step 3
When finished making changes to the settings, click OK.
Duplex Configuration Settings
You can install the Listener on two Network Application Manager stand-along ICM systems by
designating one as side A and the other as side B. In order for Listeners to operate in duplex mode, you
must click Duplex and specify login, system, and domain information about the other Listener in the
Duplex section of the Listener Configuration dialog box.
Table 2-2 describes Listener Duplex settings.
Table 2-2
Listener Duplex Settings
Duplex Settings
Description
User Name (see Note following)
The user name to use when accessing the Listener on the other
machine
Password (see Note following)
The password to use when accessing the Listener on the other
machine
Domain (see Note following)
The domain to use when accessing the Listener on the other
machine
System Name
The system name of the Listener on the other machine
ICM Root
The path where the Listener is installed on the other machine,
for example, C:\icm\listener
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-11
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Note
Set up an account in USRMGR with Administrator privileges, then log in as Administrator.
Options Settings
In the Options section of the Listener Configuration dialog box, you can specify configuration
parameters, such as, timeout and file purging. Table 2-3 describe the Options settings.
Table 2-3
General User Interface Listener Settings
User Interface Setting
Description
Hold Time (minutes)
Interval time in minutes used when
periodic check is done to determine if an
event can be purged from the Listener and
any connected clients.
Threshold Limit
Default number of times an object can
change state, within the time specified by
ThresholdIntervalMinutes, before a page,
Remote Monitoring Suite event, or mail
message is sent to designate the event as a
toggling event.
Threshold Interval (minutes)
The time in minutes within which an object
can change state. This is based on the
number of times specified by the
ThresholdLimit before a page, Remote
Monitoring Suite event, or mail message is
sent to designate the event as a toggling
(constantly changing state) event.
Customer Log File Max Size (kBytes) The maximum disk space size in bytes for
each customer’s logs. Exceeding this limit
results in purging of the oldest files first. A
value of 0 means that no disk space limit is
in effect.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-12
Chapter 2
Installing and Configuring the RMS Listener
Configuring the RMS Listener Server
Event Log Entries
Use the Event Log Entries tab to define events for the Listener to watch for in the local Windows event
log, along with actions to take if these events occur. These events deal primarily with system problems
with modems; therefore, this facility is not relevant to standard NAM operation. Consult your ICM/NAM
support representative before changing the default log entries.
Specifying Listener Customer Configuration
When you run the listencfg.exe tool in the /bin/icm directory, the Listener Configuration dialog box
opens. By default the AALSTN customer is included. The Listener reports notifications of events for all
customers to the AALSTN customer. Use the Listener Configuration dialog box to add a new customer
or edit the configuration of an existing customer.
Adding a New Listener Customer
Use the following procedure to add a new Listener customer.
How to add a new Listener customer
Step 1
In the Listener Configuration dialog box, select the Customers tab.
Step 2
Type the name of the new customer as found in the Cisco ICM Setup (the 5 character instance name).
Step 3
Click OK.
Editing Customer Configuration Information
To display the current configuration information for a Listener customer, select the Customers tab. For
information about each field, see Table 2-4. The Listen Active box is checked by default.
Table 2-4
Listener Customer Configuration Information
Customer Configuration Setting
Description
Drive Letter
Drive letter on local listener where the customer’s default
directory resides
SideA event timeout (minutes)
Time after which the Listener will report a Side A send home
malfunction. (Heartbeat Timeout)
SideB event timeout (minutes)
Time after which the Listener will report a Side B send home
malfunction.
Drive Letter Other Side
The drive letter on the other Listener where the customer’s default
directory resides.
Listen Active
Logically enable/disable monitoring for the customer. This option
is usually enabled.
Enable Thresholds
If selected, enables configured thresholds. If an object exceeds the
configured thresholds, an alarm is generated.
Use the following procedure to edit a customer’s configuration information.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-13
Chapter 2
Installing and Configuring the RMS Listener
Serial Alarm Feed
How to edit customer configuration information
Step 1
Click the customer’s name.
Step 2
Edit the fields that you want to change.
Step 3
Click OK, or if you want to continue making changes to the information of another customer, click
APPLY and select another customer to edit.
Step 4
When you have finished making changes, click OK.
Deleting a Customer from Listener
Use the following procedure to delete a customer from Listener.
How to delete a customer from Listener
Step 1
Select the customer’s name from the list of Customers.
Step 2
Click Delete.
Step 3
Click Yes to confirm that you want to delete the customer.
Step 4
When you have finished making changes, click OK.
Note
You must manually delete the customer from LGMapper using LGCnfg.exe (see Chapter 7).
Serial Alarm Feed
The ICM software provides an optional serial alarm feed that lets you establish your own alarm/event
links to the DDSN. The Serial Alarm Feed process (SERIALFD) uses the Customer Support Forwarding
Service (CSFC) to communicate alarm information to an external system. The Serial Alarm Feed process
receives events and sends alarms in ASCII format to a communications port on the Logger. Once the
SERIALFD process is started, alarm messages are sent to the communications port as they occur.
The Serial Alarm Feed consists of a series of alarm messages that are sent out over a 9600 baud serial
connection. Table 2-5 shows the formats for alarm messages.
Table 2-5
Alarm Message Format
Alarm Message Meaning
Example
Trap Number
6
System Name
GEOXYZRTRB
System Type
2
Process Name
rtr
Trap Severity
6
Date (format: YYYYMMDD)
20000309
Time (format: hh:mm:ss)
16:08:51
Number of Optional Arguments Following
1
1st Optional Argument
pim 1
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-14
Chapter 2
Installing and Configuring the RMS Listener
Serial Alarm Feed
Table 2-5
Alarm Message Format (continued)
Alarm Message Meaning
Example
Description
Restarting process pim1 after having delayed
restart for 60 seconds.
End of message sequence (0xD, 0xA)
[CR][LF]
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-15
Chapter 2
Serial Alarm Feed
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
2-16
Installing and Configuring the RMS Listener
C H A P T E R
3
Installing the LGMapper Server
This chapter how to install and configure the LGMapper Server. The installation of the LGMapper Server
also includes the installation of the LGArchiver Server.
Overview
The LGMapper and LGArchiver servers are COM servers intended to serve multiple distributed
out-of-process clients.
The installation consists of four parts:
•
Verifying that the Microsoft SQL Server is installed on the Server (see SQL Server Requirements,
page 3-2).
•
Running the installation script (see Installing the LGMapper and LGArchiver Servers, page 3-2).
•
Verifying that the installation succeeded (see Controlling Access to LGMapper - Populating User
Groups, page 3-5).
•
Populating User Groups to control access and user rights for the LGMapper and LGArchiver Servers
(see Local Account or User Groups Creation Failures, page 3-28).
Backwards Compatibility
There are significant changes in the overall architecture of the Remote Monitoring Suite as compared to
AlarmTracker release 1.0. However, it is possible to install LGMapper release 2.0 on the same computer
as LGMapper release 1.0. For additional information on this topic, refer to Chapter 11, “Backwards
Compatibility Considerations” before continuing the installation.
LGMapper and LGArchiver Installation Checklist
This checklist describes the tasks required to install the LGMapper and the LGArchiver Servers.
1.
Log on with administrator rights.
2.
Ensure SQL Server is installed on the system (see SQL Server Requirements, page 3-2).
3.
Install the LGMapper and LGArchiver Servers (see Installing the LGMapper and LGArchiver Servers,
page 3-2).
4.
Monitor the installation process (see The Installation Process, page 3-2).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-1
Chapter 3
Installing the LGMapper Server
SQL Server Requirements
5.
Create or modify the default user groups installed to fit within your administrative environment then
populate the user groups with the users you want to have access to the LGMapper Server (see Local
Account or User Groups Creation Failures, page 3-28).
6.
Tune the LGMapper Server environment by using LGMapperCnfg. A critical part of this
configuration is specifying the Listener host for the LGMapper Server to connect to. Refer to
Chapter 4, “LGMapperCnfg and LGArchiverCnfg Tools” for additional information.
7.
Tune the LGArchiver Server environment by using LGArchiverCnfg. A critical part of this
configuration is specifying the Listener host for the LGArchiver Server to connect to. Refer to
Chapter 4, “LGMapperCnfg and LGArchiverCnfg Tools” for additional information.
8.
Test an AlarmTracker Client installation by starting the AlarmTracker Client on one of the Client
systems and verifying the connection to the LGMapper (refer to Starting the AlarmTracker Client,
page 8-2).
9.
Install the AlarmTracker Client on the end user desktops (refer to Installing the AlarmTracker
Client, page 8-1.
SQL Server Requirements
Microsoft SQL Server must be installed on the LGMapper Server computer prior to running the
LGMapper installation program. If SQL Server is not installed, the LGMapper installation will not
proceed. For information about SQL Server requirements, see the Cisco Intelligent Contact Manager
Release 7.0(0) Bill of Materials.
Note
When installing SQL Server, specify a Custom installation and select a binary search order
during the setup.
Installing the LGMapper and LGArchiver Servers
If you are upgrading the LGMapper and LGArchiver servers to Windows 2003 server, back up the
database prior to upgrading the operating system, stop the LGMapper and LGArchiver services, and
either set these services to either manual or disabled prior to the 2003 upgrade.
The Installation Process
During the installation, the following actions occur:
•
Files are copied from the installation source to the destination folders.
•
A local user account LGMapper with Administrator privileges is created. When the LGMapper
Server is launched by remote Client users, this is the account that LGMapper runs under. You can
change this account to another local account or to a domain account using DCOMCnfg (see
Controlling Access to LGMapper - Populating User Groups, page 3-5).
•
Three local user Groups are created (LGM Readers, LGM Users and LGM Administrators).
•
The COM Servers and DLLs are registered.
•
The databases described in the Installation Procedure Step 8 are created.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-2
Chapter 3
Installing the LGMapper Server
Installing the LGMapper and LGArchiver Servers
Note
Due to the installation of shared files, a system reboot may be necessary.
Installation Procedure
Note
The RMS installation upgrades RMS software from 2.0 or 2.0 SR1 to 2.1.
Note
If the installation detects the Cisco Security Agent (CSA) running on the system, it prompts you to stop
stop the CSA service first, then restart this installation.
Note
The LGMapper server installation also includes installation of the LGArchiver server.
Step 1
Log on with administrator rights.
Step 2
Insert the Operations Support CD-ROM into the CD_ROM drive (i.e., drive D).
Step 3
In the Start menu Run command dialog box enter:
D:\Server\Setup.exe, then click OK (Figure 3-1).
Figure 3-1
Starting the LGMapper Server Installation
Step 4
The InstallShield Wizard starts and the InstallShield Wizard Welcome screen opens. Click Next to start
the installation.
Step 5
Select a destination for the files You can accept the default location or, by selecting Browse, you can
either choose a different existing folder or create and choose a new folder. Then click Next to continue.
In the remainder of this guide, the destination folder you select for these files is referred to as the
installation folder
Step 6
Select the default program folder LGMapper2 then click Next to continue.
Step 7
When the files are copied successfully, the Setup Complete dialog box opens.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-3
Chapter 3
Installing the LGMapper Server
Installing the LGMapper and LGArchiver Servers
Step 8
Specify the names of the SQL Server databases created during the installation process. Use the following
default database names (see Figure 3-2):
a.
Note
b.
Note
c.
Note
Figure 3-2
LGAlarms_Template - the default name of a template database used by the LGCnfg tool to create a
new Alarms Database.
You must create this database so do not leave this field blank.
LGMapper_Alarms - the default name of the LGMapper Alarms database.
If you are not using the target computer as a LGMapper Server (i.e., it is an LGArchiver Server
only), leave this field blank.
LGArchiver_Alarms - the default name of the LGArchiver Alarms database.
If you are not using the target computer as a LGArchiver Server (i.e., it is an LGMapper Server
only), leave this field blank.
Specify AlarmTracker Databases
Step 9
Click Next to install the databases.
Messages indicate that each database is being installed.
Step 10
When the Installshield Wizard Complete screen opens, click Finish.
The installation is complete.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-4
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Note
If you are directed to reboot your computer, do so. Do not continue the installation process without
rebooting if directed.
Controlling Access to LGMapper - Populating User Groups
Remote AlarmTracker clients are not authorized to use the LGMapper Server after a default (initial)
installation. Security is usually the largest issue to resolve in order for users to have access to the
LGMapper Server.
Even if you have open security, AlarmTracker clients will not have read/write access to LGMapper
unless special Windows user groups exist for the LGMapper to use. These user groups control the
privileges that an AlarmTracker client user has.
Three types of access to the LGMapper Server are possible:
•
Read-only access. Users can see the object hierarchy and all messages, but they cannot clear, assign,
exclude, or delete alarm objects. Users in this group have db_datareader access to the AlarmTracker
SQL Server Alarms databases.
•
User access. Users can see the object hierarchy and all messages. They can clear, assign and exclude
alarm objects. They can only delete single-state alarm objects. In addition, users in this group have
db_datareader access to the AlarmTracker SQL Server Alarms databases.
•
Administrator access. Users have full control. They can see the object hierarchy and all messages.
They can Clear, Assign and Exclude Alarm objects, and they can delete Listener Base Records. In
addition, users in this group are given db_owner access to the SQL Server Alarms databases.
The LGMapper installation creates the following three local Windows user groups. Assigning
AlarmTracker client users to these groups grants the user access to the LGMapper server:
•
LGM Readers - Users in this group have read-only access to alarm objects
•
LGM Users - Users in this group can perform all operations on alarm objects, except for deleting
Listener Base Records
•
LGM Administrators - Users in group can perform all operations on alarm objects, including
deleting Listener Base Records
It is important to exactly follow this naming convention because these are the group names the
LGMapper Server tries to find when a client connects. If these groups do not exist when you perform the
post-installation checklist, use the Windows 2003 or Windows 2000 Computer Management MMC snap
in to create them.
Whether the groups are local to the machine that the LGMapper is installed on, or a local or global
domain group is up to you and your environment. If all your users and machines are part of a single
domain, you can create these groups as global domain groups. This means you only have to populate the
groups once. If you choose to keep the groups local (maximizing connection performance), you have to
populate these groups for each machine you install the LGMapper on. Remember, while the choice of
global or local groups is yours, the group names are not. The groups must be named as indicated.
If you do not populate these user groups, users will have read-only access (if they can access the
LGMapper Server at all, based on the DCOMCnfg Security settings). The following section discusses
how to accomplish this.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-5
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
DCOMCnfg Tool
DCOMCnfg is a Windows utility used to configure general settings for DCOM and specific settings for
individual DCOM servers. Settings for specific DCOM servers include setting the authentication level,
the location of where the server will run, security settings (such as access and launch permissions),
identity of the account under which the server will run, and the preferred protocols and endpoints for
communication with remote clients.
DCOMCnfg.exe resides in the System32 directory and is a property-page-based GUI application.
Since LGMapper and LGArchiver are DCOM servers, use DCOMCnfg to administer DCOM properties.
This is necessary in order to ensure proper server operation. The following sections detail the steps
necessary to configure the LGMapper and LGArchiver Servers for distributed access to after a successful
installation.
Windows 2003
This section applies to customers running the LGMapper server on Windows 2003 systems.
Modifying Launch and Activate Permissions
Step 1
From the Start menu, select Start > Run.
Step 2
In the Run command dialog box, type dcomcnfg and click OK to open the Component Services window.
DCOMCnfg is a Windows utility used to configure general settings for DCOM and specific settings for
individual DCOM servers.
Step 3
Select Computers > My Computer > DCOMConfig to list DCOM services.
Step 4
Right click on LGMapper2 and select Properties. The LGMapper2 Properties dialog box opens.
Step 5
Under Launch and Activate Permissions, select Customize and then click Edit.
The Launch Permission dialog box opens.
Step 6
Click Add to display Select Users or Groups dialog box (Figure 3-3).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-6
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-3
Select Users or Groups Window.
Step 7
Click Advanced and then Find Now to display users and group. You can type the first letter of the user
or group to narrow the search, for example, “L” lists the LGMapper users and groups.
Step 8
Select the LGM Administrators, the LGM Readers, and the LGM Users groups, then click OK.
Step 9
Click OK to close the Select Users or Groups dialog box.
Step 10
Select the Allow check box for Local Launch, Remote Launch, Local Activation, and Remote
Activation, then click OK.
Modifying Access Permissions
Step 1
From the Start menu, select Start > Run.
Step 2
In the Run command dialog box, type dcomcnfg and click OK to open the Component Services window.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-7
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Step 3
Select Computers > My Computer > DCOMConfig to list DCOM services.
Step 4
Right click on LGMapper2 and select Properties. The LGMapper2 Properties dialog box opens.
Step 5
Under Access Permissions, select Customize and then click Edit. The Access Permission dialog box
opens.
Step 6
Click Add to display Select Users or Groups dialog box.
Step 7
Click Advanced and then Find Now to display users and group. You can type the first letter of the user
or group to narrow the search, for example, “L” lists the LGMapper users and groups.
Step 8
Select the LGM Administrators, the LGM Readers, and the LGM Users groups, then click OK.
Step 9
Click OK to close the Select Users or Groups dialog box.
Step 10
Select the Allow check box for Local Access and Remote Access, then click OK.
Windows 2000
This section applies to customers running the LGMapper server on Windows 2000 systems.
Step 1
In the Start menu Run command dialog, type dcomcnfg and click OK.
DCOMCnfg is a Windows utility used to configure general settings for DCOM and specific settings for
individual DCOM servers.
The Distributed COM Configuration Properties window appears (Figure 3-4). The Applications tab
displays a list of the registered DCOM servers.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-8
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-4
Step 2
Distributed COM Configuration Properties Window
Scroll down to and select LGMapper2 (Figure 3-4). Click Properties.
Note
If you do not see LGMapper2 listed, a serious installation problem occurred and the LGMapper
Server was not properly registered. Manually register the LGMapper Server by opening a DOS
command window, navigating to the Programs > Cisco Systems > LGMapper2 > bin
directory, and running the LGMapper2 /RegServer command.
Examining the General Tab
Step 1
Select the General tab.
Step 2
Make sure the value of Authentication Level is Default.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-9
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-5
LGMapper2 Properties Window - General Tab
Examining the Location Tab
Step 1
Select the Location tab (Figure 3-6).
Step 2
Make sure that only Run application on this computer is checked and all others are unchecked.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-10
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-6
LGMapper2 Properties Window - Location Tab
Examining the Security Tab
Step 1
Select the Security tab.
The LGMapper2 Properties window Security tab displays client access permissions. After installation,
the default settings are Use default access permissions, Use default launch permissions, and Use
custom configuration permissions (Figure 3-7). You must customize the access and/or launch
permissions so that your AlarmTracker users are able to access the LGMapper Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-11
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-7
LGMapper2 Properties Window - Security Tab Default Settings
The Security tab default settings are used when you first started DCOMCnfg.
For your environment, the system default settings are not likely to be sufficient to connect a general set
of users to LGMapper Server. However, even if they are sufficient, you must create and use the three (3)
user groups (LGM Administrators, LGM Readers, and LGM Users) as discussed in the Post-Installation
Inspection Checklist, page 3-27 in order for the users to have proper read/write access to the LGMapper
Server. Since these user groups are already built and populated, use them to specify the access and launch
permissions.
Note
Step 2
Make sure that the LGMapper User is part of the LGMapper Administrators Group.
Modify the access permissions and/or launch permissions as shown in Modifying Access Permissions,
page 3-13 and/or Modifying Launch Permissions, page 3-19.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-12
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Modifying Access Permissions
a.
Check Use custom access permissions to enable the Edit button (Figure 3-8).
Figure 3-8
b.
LGMapper2 Properties - Editing Access Permissions
Click Edit (Figure 3-8).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-13
Chapter 3
Controlling Access to LGMapper - Populating User Groups
The Registry Value Permissions dialog appears (Figure 3-9).
c.
Click Add to add users and/or groups.
Figure 3-9
Registry Value Permissions Dialog Box - Blank
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-14
Installing the LGMapper Server
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
The Add Users and Groups dialog appears (Figure 3-10).
Figure 3-10
d.
Add Users and Groups - Selecting the Local Machine Domain
Set the List Names From field to the local machine domain (i.e. Figure 3-10), the same name as the
machine name).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-15
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
e.
Select the LGM Administrators, the LGM Readers, and the LGM Users user groups (Figure 3-11).
Figure 3-11
f.
Add Users and Groups - Adding User Groups
Click Add (Figure 3-11). Adding all three groups allow all users in these groups access permission
to the LGMapper Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-16
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-12
g.
Add Users and Groups - User Groups Added
When the three (3) user groups appear in the Add Names field, click OK (Figure 3-12).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-17
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
The Registry Value Permissions dialog box appears displaying the user groups and their access
permissions (Figure 3-13).
Figure 3-13
h.
Registry Value Permissions Dialog Box- Completed
Click OK to return to the LGMapper2 Properties window.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-18
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Modifying Launch Permissions
a.
Check Use custom launch permissions to enable the Edit button (Figure 3-14).
Figure 3-14
b.
LGMapper2 Properties - Editing Launch Permissions
Click Edit (Figure 3-14).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-19
Chapter 3
Controlling Access to LGMapper - Populating User Groups
The Registry Value Permissions dialog appears (Figure 3-15).
Figure 3-15
c.
Registry Value Permissions Dialog Box
Click Add to add users and/or groups.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-20
Installing the LGMapper Server
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
The Add Users and Groups dialog appears (Figure 3-16).
Figure 3-16
d.
Add Users and Groups - Selecting the Local Machine Domain
Set the List Names From field to the local machine domain (i.e. Figure 3-16 DOCLAB-NT, the
same name as the machine name).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-21
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
e.
Select the LGM Administrators, the LGM Readers, and the LGM Users user groups (Figure 3-17).
Figure 3-17
f.
Add Users and Groups - Adding User Groups
Click Add (Figure 3-17). Adding all three groups allow all users in these groups launch permission.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-22
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Figure 3-18
g.
Add Users and Groups - User Groups Added
When the three (3) user groups appear in the Add Names field, click OK (Figure 3-18).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-23
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
The Registry Value Permissions dialog appears displaying the user groups and their launch permissions
(Figure 3-19).
Figure 3-19
h.
Registry Value Permissions Dialog Box- Completed
Click OK to return to the LGMapper2 Properties window.
All users in these groups can now launch the LGMapper Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-24
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Examining the Identity Tab
Step 1
Select the Identity tab.
If the LGMapper installation was successful, the Identity page appears as shown in Figure 3-20.
During installation a local user account called LGMapper was created and set as the launching user for
LGMapper. Setting the account as This user is important since you want to assure that only one instance
of the LGMapper is launched for multiple Client invocations.
Figure 3-20
Note
Step 2
LGMapper2 Properties - Identity Tab
You may change the user account the LGMapper Server is launched from. However, it is critical
that the selected user account can Log on and has batch job rights. The user account must be a
member of the LGM Administrators user group.
Click OK to return to the Distributed COM Configuration Properties window.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-25
Chapter 3
Installing the LGMapper Server
Controlling Access to LGMapper - Populating User Groups
Examining LGArchiver Properties
You can also use DCOMCnfg to examine the DCOM settings for the LGArchiver Server. Because the
LGArchiver does not have any clients, you do not have to edit the Access and Launch Permissions as
you did for LGMapper. In fact, the only client LGArchiver has is the LGArchiverNM service which runs
under the SYSTEM account. By default, the SYSTEM account has Launch Permission for all DCOM
servers.
However, if you want to examine the DCOM settings for LGArvhiver, you can follow the same steps as
for the LGMapper (see Controlling Access to LGMapper - Populating User Groups, page 3-5). To do
this, select the LGArchiver Server from the list of applications show in Figure 3-21.
Figure 3-21
Distributed COM Configuration Properties Window
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-26
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
Troubleshooting the LGMapper Installation
If problems occur during the LGMapper and/or LGArchiver Server installations, an error dialog appears
informing you of what actions to take to manually resolve the issue. The Post-Installation Inspection
Checklist, page 3-27 can also be used to help resolve any problems.
Post-Installation Inspection Checklist
Perform the following to ensure a successful installation of the LGMapper Server and the LGArchiver
Server:
•
Ensure the databases have been created by running the SQL Server Enterprise manager
(Start>Programs>Microsoft SQL Server 7.0>Enterprise Manager). Expand the SQL Server
Group, the “Machine Name” (i.e. DOCLAB-NT), and the Databases nodes as in as in Figure 3-22.
Figure 3-22
•
Remote Monitoring Suite SQL Server Databases
Ensure the following four (4) new folders exist under the installation folder (Figure 3-23):
– bin - contains most of the files from the installation are in the bin folder
– log - stores ASCII log files written when the LGMapper and LGArchiver run
– scripts - contains SQL Server script files to create the LGAlarms_Template database
– helpsample - contains an example of how to implement the IWantHelp interface (see
Chapter 12, “Implementing the IWantHelp Interface”).
Figure 3-23
Installation Folder Sub-directories
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-27
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
•
Ensure the log folder (Figure 3-24) includes a log file for each SQL Server database (the
LGAlarms_Template database, the LGMapper_Alarms database, and the LGArchiver_Alarms
database) discussed in the installation procedure. The log files are named utilizing the following
syntax:
– InitDatabase_<DatabaseName>.log where <DatabaseName> is the name specified in the
prompting dialog.
Examine the contents of these files to check for any errors.
Figure 3-24
Log Files
•
Select Start>Programs>LGMapper2. Ensure the LGMapper2 menu option (Figure 3-25) contains
the following applications:
– LGArchiverCnfg
– LGCnfg
– LGMapperCnfg
– Listener Base Records Pruner
Figure 3-25
LGMapper2 Applications
Local Account or User Groups Creation Failures
If the installation process fails to create a local account, or if you decide you want a different account to
run the LGMapper Server, you need to create the account using the User Manager or Domain User
Manager tool.
It is critical that the account created must have the user rights set to “Log on as batch job”. If the account
running the LGMapper does not have these rights, LGMapper Server execution fails because of the way
DCOM Servers are started by the Service Control Manager (SCM) as requested by Remote Procedure
Calls (RPC).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-28
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
Once you have created or identified the user account that you wish to run the LGMapper Server, run
DCOMCnfg (see DCOMCnfg Tool, page 3-6) to set the properties for the LGMapper Server.
Note
If you install the LGMapper Server or the LGArchiver Server on a Primary Domain Controller
(PDC) or Backup Domain Controller (BDC), they are domain accounts and groups.
Windows 2000 and Windows 2003
Figure 3-26
Step 1
Run Start>Programs>Administrative Tools>Computer Management.
Step 2
Expand the Local Users and Groups node.
Step 3
Select the Users folder. The LGMapper user account is displayed in the right column (Figure 3-26).
Displaying the LGMapper User Account in Windows 2000
Step 4
Double-click LGMapper (Figure 3-26). The LGMapper Properties dialog box opens.
Step 5
Select the Members Of tab and double-click on Administrators.
Step 6
Continue at Step 1 of Ensuring LGM Administrators, LGM Readers, and LGM Users Were
Created, page 3-31.
-orStep 1
Under Local Users and Groups, select the Groups folder (Figure 3-27).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-29
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
Step 2
Figure 3-27
In the right column, select the Administrators group (Figure 3-27).
Displaying the Administrators Group in Windows 2000 and Windows 2003
Step 3
Double-click the Administrators group (or right-click and select Properties).
Step 4
Continue at Step 1 of Ensuring LGM Administrators, LGM Readers, and LGM Users Were
Created, page 3-31.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-30
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
Ensuring LGM Administrators, LGM Readers, and LGM Users Were Created
Step 1
Ensure LGMapper is a member of the Administrators group (Figure 3-28).
Figure 3-28
Windows 2000 Administrators Properties Window
Step 2
Select OK to return to the Computer Management window.
Step 3
Ensure Groups is selected.
If the installation process fails to create the three User Groups, or if you decide to use a different model
for creating the User Groups, then you have to use the Windows User Manager or Domain User Manager
to create and populate these groups.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-31
Chapter 3
Installing the LGMapper Server
Troubleshooting the LGMapper Installation
Step 4
Figure 3-29
Ensure three (3) local User Groups (LGM Administrators, LGM Readers and LGM Users) were
created (Figure 3-29). Refer to Local Account or User Groups Creation Failures, page 3-28.
Displaying LGM Administrators, LGM Readers, and LGM Users in Windows 2000 and 2003
DCOMCnfg Registry Settings Failure
If the installation process fails to create a local account, or if it fails to create Registry setting for
DCOMCnfg, use DCOMCnfg to complete the LGMapper Server setup.
If you do not see LGMapper2 listed, a serious installation problem occurred and the LGMapper Server
was not properly registered. Manually register the LGMapper Server by opening a DOS command
window, navigating to the Programs > Cisco Systems > LGMapper2 > bin directory, and running the
LGMapper2 /RegServer command.
If you do not see LGArchiver listed, a serious installation problem occurred and the LGArchiver Server
was not properly registered. Manually register the LGArchiver Server by opening a DOS command
window, navigating to the Programs > Cisco Systems > LGMapper2 > bin directory, and running the
LGArchiver /RegServer command.
Database Creation Failure
If the installation process fails to create the LGAlarms_Template database, you can create these
manually. How this is accomplished is found in Chapter 6, “Alarms Database Maintenance”.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
3-32
C H A P T E R
4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Overview
The LGMapperCnfg tool provides the capability for you to:
•
Enable/disable the LGMapper Server
•
Display the names of the currently connected client(s)
•
Display and edit the configuration options related to the Alarms database
•
Specify the location of the Listener to connect to
•
Select log file options
Start the LGMapperCnfg tool using:
•
Start>Programs>LGMapper2>LGMapperCnfg
•
the LGMapperCnfg.exe executable found in the bin folder under the installation folder.
Since the application is a property-page based GUI application, you can navigate through the tabs to both
view the options and change them.
Clients Tab
The Clients tab (Figure 4-1) shows the current list of connected users and those with active connections
to the LGMapper. It also provides a mechanism to enable/disable the LGMapper Server for maintenance.
Displaying Current Users
The Clients tab (Figure 4-1) contains two list boxes. The Connected list box indicates the user names of
the connected users. The Active Connections list box contains the user names of the active users. Be
aware that not every connection is an active connection. This is because the LGMapper is duplexed and
users may connect to both LGMapper Servers. One of the connections is active (the LGMapper sends
Listener messages to the client), while the other connection is a standby (or backup) connection used in
the event the active connection is lost. Thus, the number of connections is always greater than or equal
to the number of active connections. This display is not dynamic, so to refresh this list, click Refresh.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-1
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Figure 4-1
LGMapper Configuration - Clients Tab
Disabling/Enabling the LGMapper Server
Disable the LGMapper Server if:
•
the machine itself is going down for maintenance
•
the Listener is going down for maintenance
•
to perform maintenance on the Alarms database
Use the Disable Server/Enable Server button (Figure 4-2) to disable the LGMapper Server. The button
label changes based upon the current state of the LGMapper. If the LGMapper Server is enabled, the text
reads Disable Server. If the LGMapper Server is disabled, the text reads Enable Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-2
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Figure 4-2
Clients Tab - Disable Server
Clicking Disable Server pops up the confirmation dialog box as seen in Figure 4-3.
Figure 4-3
Disable Server Confirmation Dialog Box
Enter a reason for disabling the LGMapper Server (if desired) and click OK. The Server attempts a
graceful shutdown and notifies all connected clients that it is disabled and will no longer accept new
connections from Clients. The Clients see a message box telling them the LGMapper is disabled and the
Reason text. Since the Reason information is stored in the Registry, Clients only see this text if the
LGMapper Server machine is actually up and reachable. If it is not, the Client sees a network or RPC
related error message.
When the LGMapper Server is disabled, you see the text you entered in the Reason edit box (Figure 4-4).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-3
Chapter 4
LGMapperCnfg Tool
Figure 4-4
Clients Tab - Reason
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-4
LGMapperCnfg and LGArchiverCnfg Tools
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
To re-enable the LGMapper Server, click Enable Server (Figure 4-5). This provides connecting Clients
immediate access to the LGMapper Server.
Figure 4-5
Clients Tab - Enable Server
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-5
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Alarms Database Tab
The Alarms Database tab (Figure 4-6) provides information about the Alarms database maintained by
the LGMapper. This database maintains configuration and Alarm object information while the
LGMapper Server is running.
Figure 4-6
LGMapper Configuration - Alarms Database Tab
On this tab you can observe/modify the:
•
Database Catalog Name
– the name of the SQL Server database used
•
Alarms Objects History
– the number of hours of cached Alarm object history you want the LGMapper to maintain
– this value controls how long closed Alarm objects (records in the database) are retained in the
Alarms Database before being purged.
Note
•
A higher number means more history is maintained, but it also means that more disk space is
required to store the information. The LGMapper Server occasionally purges the Alarms
database of any closed Alarm object whose closed time falls outside the time history window.
Open Alarm objects are never purged.
Maximum Event Count per Alarm
– limits the total number of events associated with an Alarm by implementing a form of event
suppression, or filtering, to prevent the Alarms database from growing unbounded
This type of suppression is useful for an Alarm that has been excluded for a long time. Such an
Alarm could see the object going up and down a large number of times, especially for an object
that has been excluded for months. This suppression is accomplished by deleting the oldest
events first.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-6
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Note
•
The first event (the event resulting in the creation of the Alarm object) is never deleted until after
the alarm is closed.
Maximum Event Repeat Count
– use to implement a form of event suppression, or filtering, to prevent the Alarms database from
growing unbounded by limiting the number of repeat events for an Alarm
Some Alarms result in an event being phoned home every 5 minutes or so (up to a maximum of
5 phone homes per hour), indicating the Alarm is still down, and results in a large number of
events being associated with the Alarm. There is little additional information contained in these
repeat events.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-7
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Listener Tab
The Listener tab allows you to specify the location of the Listener machine the LGMapper is connected
to.
Note
The installation procedure does not fill in any values on this tab. You must enter the correct information
shown on this page in order for the LGMapper to properly connect to a Listener.
On this tab you can observe/modify the following five (5) fields:
•
Listener Host
– the Listener machine name
•
User Name
– a valid user name on that machine
– Domain_Name/User_Name required if the LGMapper Server and Listener machines are in
different domains
•
Password
– the password for user specified by the User Name
•
Time Zone Offset
– the time zone difference between the location of the Listener machine and the LGMapper
machine (in hours)
i.e., The Listener machine is in San Jose, CA and the LGMapper Server machine is in Lowell,
MA, Since Lowell is three (3) hours ahead of San Jose, you would enter a 3 in this field. This
is because both Listener and LGMapper store times in their local time zone.
•
Use Compression
– If this option is checked, the Listener sends data to the LGMapper in compressed form.
– Use this option only when the network connection between the Listener and LGMapper is very
slow or congested (there are a large number of customers monitored - over 75), or where
network service interruption may be frequent.
– Leave this option unchecked because compressing and decompressing data is a CPU-intensive
process.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-8
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGMapperCnfg Tool
Log Files Tab
The Log Files tab (Figure 4-7) allows you to select the log files to be generated by the LGMapper Server.
Figure 4-7
LGMapper Configuration - Log Files Tab
This tab includes the following fields:
•
Location
– the path to the folder containing the log files (the log folder under the installation folder for the
LGMapper).
•
LGMapper Log File
– select to create a log file containing LGMapper information named LGMapperddmmyy_nn.log,
where ddmmyy is the current date, and nn is a unique number for the file
Note
•
These log files are simple ASCII files and contain information about initialization, connecting
Clients, and any errors that occur. Cisco strongly suggests you use this log file since this is the
only way you can report problems about the LGMapper to Cisco customer support. These
LGMapper Log files are not purged, so periodically delete them.
Configuration Database Transactions Log File
– select to create a log file named LGMDBTrans.log containing information about additions made
to the Configuration database InstanceNodes table when LGMapper is running
Note
This log file is less important than the LGMapper Log and the Listener Messages Log files.
However, when in a “steady state” situation, turn this file on to see if any new Instance nodes are
being added to the database. When selected, data is appended to this log file each time the
LGMapper Server starts up.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-9
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
•
Listener Messages Log File
– select to create an ASCII log of all Listener messages received named LGMapperV5.log (or
LGMapperV4.log if you are connecting with a Release 4 feed from Listener)
Note
See Chapter 11, “Backwards Compatibility Considerations” for information about the
differences between a Release 4 and Release 5 Listener feed.
– overwritten each time you start the LGMapper
– useful if you find a logic error in the Client displays and want Cisco customer support to
investigate
Note
This file can be used to “play back” the full set of events to the Client displays in order to recreate
the sequence of events seen in real time. If you see a problem, copy this file to another file, save
it (remember, the next time LGMapper is restarted, the log file will be overwritten), and notify
Cisco customer support.
LGArchiverCnfg Tool
Overview
The LGArchiverCnfg tool provides the capability for you to:
•
Display and edit the configuration options related to the Archiver database
•
Specify the location of the Listener to connect to
•
Select log file options
Start the LGArchiverCnfg tool using:
•
Start>Programs>LGMapper2>LGArchiverCnfg
•
the LGArchiverCnfg.exe executable found in the bin folder under the installation folder.
Since the application is a property-page based GUI application, you can navigate through the tabs to both
view the options and change them.
Note
To start and stop archiving, use the LGArchiverNM Windows Service (refer to Chapter 5,
“LGMapperNM and LGArchiverNM”).
Archiver Database Tab
The Archiver Database property tab (Figure 4-8) provides information about the Alarms database
maintained by LGArchiver. This database maintains configuration and Alarm object information while
LGArchiver is running.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-10
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
Figure 4-8
LGArchiver Configuration - Archiver Database Tab
You can observe and/or modify four (4) fields on this tab:
•
Database Catalog Name
– the name of the SQL Server database
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-11
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
•
Alarms Objects History
– the number of days of cached Alarm object history you want the LGArchiver to maintain
– controls how long closed Alarm objects (records in the database) are retained in the database
before being purged
Note
•
A higher number means more history is maintained, however, more disk space is required to
store the information. During LGArchiver operation, occasionally purges the Alarms
database of any closed Alarm objects whose closed time fall outside the time history
window. Alarm objects still open are never purged.
Maximum Event Count per Alarm
– used to implement a form of event suppression or filtering to prevent the Alarms database from
growing unbounded
– this value limits the total number of events associated with an Alarm
This type of suppression is useful for an Alarm that has been excluded for a long time. Such an
Alarm could see the object going up and down a large number of times, especially for an object
that has been excluded for months. The suppression is accomplished by deleting the oldest
events first.
Note
•
The first event (the event resulting in the creation of the Alarm object) is never deleted.
Maximum Event Repeat Count
– used to implement a form of event suppression, or filtering, limiting the number of repeat events
for an Alarm and preventing the Alarms database from growing unbounded.
Some Alarms result in an event being phoned home every 5 minutes or so (up to a maximum of
5 phone homes per hour), indicating the Alarm is still down. This could result in a large number
of events associated with the Alarm. There is little additional information contained in these
repeat Events.
Listener Tab
The Listener tab (Figure 4-9) allows you to specify the location of the Listener machine the LGMapper
connects to.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-12
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
Figure 4-9
LGArchiver Configuration - Listener Tab
This tab allows you to observe/modify the following fields:
•
Listener Host
– the Listener machine name
•
User Name
– a valid user name on that machine
– Domain_Name/User_Name required if the LGArchiver Server and Listener machines are in
different domains
•
Password
– the password for user specified by the User Name
•
Time Zone Offset
– the time zone difference between the location of the Listener machine and the LGMapper
machine (in hours)
i.e., The Listener machine is in San Jose, CA and the LGMapper Server machine is in Lowell,
MA, Since Lowell is three (3) hours ahead of San Jose, you would enter a 3 in this field. This
is because both Listener and LGMapper store times in their local time zone.
Log Files Tab
The Log Files tab (Figure 4-10) allows you to select the log files to be generated by the LGArchiver
Server.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-13
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
Figure 4-10
LGArchiver Configuration - Log Files Tab
This tab includes the following fields:
•
Location
– the path to the folder containing the log files (he log folder under the installation folder for the
LGArchiver).
•
LGArchiver Log File
– select to create a log file containing LGMapper information named
LGArchiverddmmmyy_nn.log, where ddmmyy is the current date, and nn is a unique number
for the file
Note
•
These log files are simple ASCII files and contain information about initialization, connecting
Clients, and any errors that occur. Cisco strongly suggests you use this log file since this is the
only way you can report problems about the LGMapper to Cisco customer support. These
LGArchiver Log files are not purged, so periodically delete them.
Configuration Database Transactions Log File
– select to create a log file named LGADBTrans.log containing information about additions made
to the Configuration database InstanceNodes table when LGArchiver is running
Note
•
This log file is less important than the LGArchiver Log and the Listener Messages Log files.
However, when in a “steady state” situation, turn this file on to see if any new Instance nodes are
being added to the database. When selected, data is appended to this log file each time the
LGArchiver Server starts up.
Listener Messages Log File
– select to create a log of all Listener messages received named LGArchiverV5.log (or
LGArchiverV4.log if you are connecting with a Release 4 feed from Listener)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-14
Chapter 4
LGMapperCnfg and LGArchiverCnfg Tools
LGArchiverCnfg Tool
Note
See Chapter 11, “Backwards Compatibility Considerations” for information about the
differences between a Release 4 and Release 5 Listener feed.
– overwritten each time you start the LGArchiver
– useful if you find a logic error in the Client displays and want Cisco customer support to
investigate
This file is used to “play back” the full set of events to the Client displays in order to recreate the
sequence of events seen in real time. If you see a problem, copy this file to another file, save it
(remember, the next time LGArchiver is restarted, the log file will be overwritten), and notify Cisco
customer support.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-15
Chapter 4
LGArchiverCnfg Tool
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
4-16
LGMapperCnfg and LGArchiverCnfg Tools
C H A P T E R
5
LGMapperNM and LGArchiverNM
LGMapper Node Manager (LGMapperNM)
Overview
The LGMapper Node Manager (LGMapperNM) is a Windows Service used to control the lifetime of an
LGMapper Server. The LGMapper Server is a DCOM server which continues running as long as there
is at least one connected client. If all AlarmTracker clients disconnect, the LGMapper Server exits. If
you want the LGMapper Server to run continuously, use the LGMapper Node Manager service to keep
it running. The LGMapperNM also tries to check for proper operation of the LGMapper Server. If
LGMapperNM detects that the server is hung or not operating properly, it attempts to stop the server and
restart it.
Starting the LGMapper Node Manager
Windows 2000 and Windows 2003
Use the Computer Management application to display Windows services.
•
Select Start>Programs>Administrative Tools>Services
or
•
Right-click My Computer and select Manage.
Expand Services and Applications and select Services.
The Services are displayed in the right column of both the Services (Figure 5-1) and Computer
Management (Figure 5-2) windows, respectively.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-1
Chapter 5
LGMapperNM and LGArchiverNM
LGMapper Node Manager (LGMapperNM)
To start the LGMapperNM service:
Figure 5-1
Windows Services Window - Starting LGMapperNM
Step 1
Select the LGMapper service in the right side of the Services window (Figure 5-1).
Step 2
Select the Action menu.
Step 3
Select the Start menu option.
or
Figure 5-2
Windows Computer Management - Starting LGMapperNM
Step 1
Select the LGMapper service in the right side of the Computer Management window(Figure 5-2).
Step 2
Right-click the selected service.
Step 3
Select Start from the pop-up menu.
Close the respective window. A new LGMapper tray icon () appears in the task bar.
You can also configure the LGMapperNM service so that it starts up automatically when the machine
boots. To do this, select the LGMapperNM service, click Properties on the Toolbar, and select
Automatic for the Startup Type.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-2
Chapter 5
LGMapperNM and LGArchiverNM
LGMapper Node Manager (LGMapperNM)
Task Bar Icon
The task bar icon indicates the current status of the LGMapperNM Service. The icons that may be seen
in the task bar are shown in .
Table 5-1
Icon
LGMapperNM Service Task Bar Icons
Definition
The LGMapper is in an unknown state.
The LGMapper is disabled.
The LGMapper is initializing.
The LGMapper is running and processing Listener messages
The LGMapper has been stopped.
An error has occurred causing the LGMapper to exit. Check the
Application Event Log and examine the log files in the LGMapper
log folder to determine why the LGMapper server failed.
Menu Options
Right-clicking on the icon in the task bar brings up a list of menu options to control the operation of the
LGMapper Server.
The following menu options are available:
•
Open LGMapperCnfg…
– launches the LGMapperCnfg tool to set properties for the LGMapper Server
– the default menu option, also launches LGMapperCnfg if you double-click on the tray icon
•
Show Statistics…
– presents a dialog showing statistics for a running LGMapper Server
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-3
Chapter 5
LGMapperNM and LGArchiverNM
LGMapper Node Manager (LGMapperNM)
The following information is displayed when this menu option is selected:
– Listener Messages Processed
- the number of Listener messages processed since the Server started
– Connected Clients
- the number of clients connected to the LGMapper Server
– Active Connections
- the number of active connections to the LGMapper Server
– LGMapper Up Since
- the time the LGMapper Server started
•
LGMapper - Start
– starts Listener message processing on the LGMapper Server
•
LGMapper - Stop
– stops Listener message processing on the LGMapper Server
Warning
Use caution when using this option. Selecting this option forcibly terminates a running LGMapper
Server and disconnects all clients.
•
LGMapper - Disable
– disables the LGMapper Server, enter a reason for disabling the Server
•
LGMapper - Enable
– enables the LGMapper Server when it is disabled.
Note
•
This option does not start the LGMapper Server, it merely allows clients connect again
Hide Tray Icon
– hides the tray icon
Note
•
The tray icon re-appears each time you restart the LGMapperNM Service.
Exit Service
– exits the LGMapperNM Service
Note
If no other clients are connected, the LGMapper Server exits. If other clients are connected, the
LGMapper Server continues to run until there are no more clients connected.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-4
Chapter 5
LGMapperNM and LGArchiverNM
LGArchiver Node Manager (LGArchiverNM)
Event Log Messages
The LGMapperNM logs messages to the system Application log. This log is viewed in the Windows
Event Viewer. Informational messages (such as the time started and stopped) appear, as well as, error
messages. The Source and Category of the events are LGMapperNM for quick identification of
LGMapperNM related events.
LGArchiver Node Manager (LGArchiverNM)
Overview
The LGArchiver Node Manager (LGArchiverNM) is an Windows Service that is used to control the
lifetime of an LGArchiver Server. The LGArchiver Node Manager also checks the proper operation of
the LGArchiver Server. If it detects that the server is hung or not operating properly, it attempts to stop
the server and restart it.
To continuously log messages, make sure the LGArchiverNM Service is running. Configure the Service
to auto start when the system boots via the Service Control panel application.
Starting the LGArchiverNM
Windows 2000 and Windows 2003
On a Windows 2000 machine, the Services are displayed via the Computer Management application.
Two ways to display the Services are to:
•
select Start>Programs>Administrative Tools>Services
or
•
right-click My Computer, select Manage, expand Services and Applications, and select Services.
.The Services are displayed in the right column of both the Services (Figure 5-3) and Computer
Management (Figure 5-4) windows, respectively.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-5
Chapter 5
LGMapperNM and LGArchiverNM
LGArchiver Node Manager (LGArchiverNM)
To start the LGArchiverNM service:
Figure 5-3
Windows Services Window - Starting LGArchiverNM
Step 1
Select the LGArchiver service in the right side of the Services window (Figure 5-3).
Step 2
Select the Action menu.
Step 3
Select the Start menu option.
or
Figure 5-4
Windows Computer Management - Starting LGArchiverNM
Step 1
Select the LGArchiver service in the right side of the Computer Management window(Figure 5-4).
Step 2
Right-click the selected service.
Step 3
Select Start from the pop-up menu.
Close the respective window. A new LGArchiver tray icon () appears in the task bar.
You can also configure the LGArchiverNM service so that it starts up automatically when the machine
boots. To do this, select the LGArchiverNM service, click Properties on the Toolbar, and select
Automatic for the Startup Type.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-6
Chapter 5
LGMapperNM and LGArchiverNM
LGArchiver Node Manager (LGArchiverNM)
Task Bar Icon
The task bar icon indicates the current status of the LGArchiverNM Service. The icons that may be seen
in the task bar are shown in .
Table 5-2
Icon
LGArchiverNM Service Task Bar Icons
Definition
The LGArchiver is in an unknown state.
The LGArchiver is initializing.
The LGArchiver is running and processing Listener messages.
The LGArchiver has been stopped.
An error has occurred causing the LGArchiver to exit. Check the
Application Event Log and examine the log files in the LGMapper
log folder to determine why the LGArchiver server failed.
Menu Options
Right-clicking on the icon in the task bar brings up a list of menu options to control the operation of the
LGMapper Server.
The following menu options are available:
•
Open LGArchiverCnfg…
– launches the LGArchiverCnfg tool to set properties for the LGArchiver Server
•
Show Statistics…
– presents a dialog showing statistics for a running LGArchiver Server
The following information is displayed when this menu option is selected:
– Listener Messages Processed
- the number of Listener messages processed since the Server started
– LGArchiver Up Since
- the time the LGArchiver Server started
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-7
Chapter 5
LGMapperNM and LGArchiverNM
LGArchiver Node Manager (LGArchiverNM)
•
LGArchiver - Start
– starts Listener message processing on the LGArchiver Server
The LGArchiver starts up, goes through its initialization stage (this may take several minutes),
and then begins processing Listener messages.
•
LGArchiver - Stop
– stops Listener message processing on the LGArchiver Server
•
LGArchiver - Exit
– stops Listener message processing on the LGArchiver and exits the LGArchiverNM Service
(the LGArchiver Server also exits)
•
Hide Tray Icon
– hides the tray icon
Note
The tray icon re-appears each time you restart the LGArchiverNM Service.
Event Log Messages
The LGArchiverNM logs messages to the system Application log. This log is viewed in the Windows
Event Viewer. Informational messages (such as the time started and stopped) appear, as well as, error
messages. The Source and Category of the events are LGArchiverNM for quick identification of
LGArchiverNM related events.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
5-8
C H A P T E R
6
Alarms Database Maintenance
Overview
For the most part, the Alarms Database is set up to take care of itself. Database options are set so that its
transaction log file is automatically truncated and shrunk. In addition, database statistics are updated at
LGMapper/LGArchiver startup, and the database is completely re-indexed once per week during a
restart. To perform other maintenance operations, you use SQL Server Enterprise Manager or other
techniques.
Note
The process of completely re-indexing the database is time-consuming. For a 1 GByte database,
re-indexing can take up to 10 minutes, for smaller databases the time required to re-index is less as the
re-indexing time requirement is proportional to the size of the database. Re-indexing is done once per
week at the most, and occurs when the server restarts.
Re-Indexing the Alarms Database
If you want to manually re-index the database, you can use the stored procedure reindex_database to do
this.
Creating and Cloning Databases
The LGCnfg tool is used to create new Alarms databases and to clone existing databases. Additional
information on how to do this is included in Creating a New Database, page 7-8 and Cloning a Database,
page 7-8.
Manually Creating Databases
To assist you in creating a databases manually, we provide SQL scripts in the DBScripts folder created
during the installation process.
If you manually create a new database, you can initialize the database with the proper set of tables, data,
and stored procedures by running the batch file InitDatabase.bat.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
6-1
Chapter 6
Alarms Database Maintenance
Creating and Cloning Databases
The InitDatabase.bat file takes a single command line argument using the name of the database to
populate. Keep in mind that this batch file does not create the SQL Server database for you. You must
first create the SQL database by other means.
As an example, if you created an empty database called LGMapper_Test, you could populate it with the
following command run from the DBScripts folder:
InitDatabase LGMapper_Test
Once the database is created and populated, you make LGMapper use it by running the LGMapperCnfg
tool and selecting it in the Alarms Database tab.
Note
The preferred method of creating new databases is to use the LGCnfg tool as described in Creating a
New Database, page 7-8 and Cloning a Database, page 7-8.
SQL Server Security
During installation, the installer creates three local user groups:
•
LGM Readers
•
LGM Users
•
LGM Administrators
These groups are added to the Login collection in the Security folder seen in the SQL Server Enterprise
Manager. In addition, these groups are added as users to the three (3) databases created during the
installation process. The LGM Readers and LGM Users groups are given the db_datareader role for these
databases so that they can perform queries against the databases, and the LGM Administrators group is
given the db_owner role for these databases.
If you create new databases using either LGCnfg or the SQL scripts provided, these groups are added to
the database Users as part of the creation process.
If you want to give a user access to AlarmTracker, all you need to do is add the user to the appropriate
LGM XXX group.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
6-2
C H A P T E R
7
LGCnfg Tool
Overview
The LGCnfg tool is used to manage the Alarms Databases at your site and provides the following
capabilities:
•
Manage server-side Filters
•
Delete Instance Nodes
•
Create new Configuration Databases
•
Edit existing Configuration Databases
•
Create and edit OID Nodes and Attributes
•
Create and edit Rules for mapping Listener Objects
This section provides a brief overview of the capabilities of the LGCnfg tool.
Starting LGCnfg
To start the LGCnfg tool:
•
Select Start>Programs>LGMapper2>LGCnfg.
- or •
Run LGCnfg2.exe from the bin folder under the installation folder.
Opening a Database
When the LGCnfg starts, it initially has no open Alarms Database.
To open a database, use the File > Open… menu option (Figure 7-1).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-1
Chapter 7
LGCnfg Tool
Starting LGCnfg
Figure 7-1
LGCnfg Tool - Opening an Alarms Database
Initially, the server is set to the local host (i.e., Kevinm-W2K1) as shown in Figure 7-2.
Figure 7-2
Open Database Dialog Box
The Open Database dialog box (Figure 7-2) indicates if there is an Alarms Database configured for the
LGMapper Server and the LGArchiver Server. If none is specified, the option is grayed out.
The Server status is shown to the right of the database name. The status is important because if the
LGMapper Server is enabled, the database is opened as read only (Figure 7-3). If the LGArchiver Server
is running, its database is opened as read only.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-2
Chapter 7
LGCnfg Tool
Using Server-Side Filters
Figure 7-3
Database Opens as Read Only
In order to make changes to a LGMapper database, the LGMapper Server must be disabled. Similarly,
the LGArchiver Server must not be running if you want to make changes to the LGArchiver database.
You can alternatively select a database that is not attached to either the LGMapper Server or the
LGArchiver Server. Attach to a database on a different server by either selecting a database from a
known SQL Server machine from the Server drop down list (or by clicking Other…) and selecting a
different server name (refer to Figure 7-2). When the selection is made, the dialog attempts to refresh
contents of the LGMapper and LGArchiver databases for the new server.
Figure 7-4 shows a sample of the Intelligent Contact Manager (ICM) OID Node hierarchy for an open
database:
Figure 7-4
LGCnfg Showing the ICM OID Hierarchy
Using Server-Side Filters
The LGMapper Server and the LGArchiver Server support the filtering of Listener data in order to
present a subset of information to the attached AlarmTracker clients. The filters are actually applied to
the data before it is updated in the Alarms database so that filtered data is not logged at all.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-3
Chapter 7
LGCnfg Tool
Using Server-Side Filters
The following types of server-side filters can be applied using the LGCnfg tool:
•
Customer Instance filters
– Filters out specific customer instances. This type of filter is useful for a support center that is
responsible for a subset of the customer base tracked by the Listener.
For example, an international company has two customer contact centers, one in San Jose and
one in Brussels.
Assume the customer contact center in San Jose is responsible for monitoring only US-based
customers. In this case, the LGCnfg tool can be used to filter out all non-US customers from the
set of instance nodes.
If the customer contact center in Brussels is responsible for only European-based customers, the
LGCnfg tool can be used to filter out all non-European customers.
•
Product filters
– Filters out specific products. This type of filter is used to segment support groups for different
product support.
For example, one set of LGMapper Servers is dedicated to support for the ICM product, and
another set for the ISN product, etc.
•
OID Node filters
– Filters out specific OID Nodes (and implicitly their children).
For example, a Network Applications Manager (NAM) customer has two customer contact
centers. The first customer contact center supports NICM instances. The second customer
contact center supports individual customers. The OID Node filter is configured on the first
LGMapper Server to filter out specific kinds of OID Nodes (in this case, NICs).
•
Class filters
– Filter out specific Classes for a given product.
•
Message ID filters
– Filters out specific EMS Message IDs for a given product.
These filters are set in the different views that display nodes and objects. Objects filtered out are marked
with a red 'X' in the check box associated with the object.
Caution
When an object filter is set, the LGCnfg tool also deletes all Alarm objects related to the filter setting.
This is one reason why the database cannot be attached to a running instance of LGMapper or
LGArchiver. Be very sure of your selection before you set any filter. A dialog box is always displayed
to confirm any filter setting.
Customer Instance Filters
Setting Customer Instance Filters
Set and clear Customer Instance filters in the Instance Nodes Tree view.
Step 1
Select the customer you want to filter.
Step 2
Select Edit > Filter Out (or right-click and select Filter Out).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-4
Chapter 7
LGCnfg Tool
Using Server-Side Filters
The filter setting takes effect the next time the LGMapper or LGArchiver server is started.
Clearing Customer Instance Filters
Step 1
Select the customer you want to clear.
Step 2
Select Edit > Filter Out (or right-click and select Filter Out).
This toggles the filter setting and resets the filter.
Product Filters
Set and clear Product filters in either the OID Nodes Tree View or the Objects View.
Setting Product Filters in the OID Nodes Tree View
Step 1
Select the Product to filter.
Step 2
Select Edit > Filter Out (or right-click and select Filter Out).
The Product filter setting takes effect the next time the LGMapper or LGArchiver server is started.
Clearing Product Filters in the OID Nodes Tree View
Step 1
Select the Product to clear
Step 2
Select Edit > Filter Out (or right-click and select Filter Out).
This toggles the filter setting and resets the filter.
Setting Product Filters in the Objects View
Step 1
Select any entry containing the product you want to filter.
Step 2
Select Edit->Filter Product Out (or right-click and select Filter Product Out).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-5
Chapter 7
LGCnfg Tool
Using Server-Side Filters
Clearing Product Filters in the Objects View
Step 1
Select any entry containing the Product to clear.
Step 2
Select Edit > Filter Product Out (or right-click and select Filter Product Out).
This toggles the filter setting and resets the filter.
Note
When you filter out a Product, the Product node in the OID Nodes Tree View is marked with a red “X”.
All objects in the Objects View for that product are also marked with a red “X”. In addition, all Instance
Nodes for that product are similarly marked.
OID Node Filters
Setting OID Node Filters
Set and clear OID Node filters in the OID Nodes Tree View.
Step 1
Select the OID Node to filter.
Step 2
Select Edit > Filter Out (or right-click and select Filter Out).
The setting takes effect the next time the LGMapper or LGArchiver server is started.
Clearing OID Node Filters
Step 1
Select the node to clear.
Step 2
Select Edit->Filter Out (or right-click and select Filter Out).
This toggles the filter setting and resets the filter.
Note
When you filter out an OID Node, the node and all of its children are marked with a red 'X'. In addition,
all Instance Nodes that refer to that OID and its children are similarly marked.
Class Filters
Set and clear Class filters in the Objects View.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-6
Chapter 7
LGCnfg Tool
Using Server-Side Filters
Setting Class Filters
Step 1
Select any entry containing the Class to filter.
Step 2
Select Edit > Filter Class Out (or right-click and select Filter Class Out).
Clearing Class Filters
Step 1
Select any entry containing the Class to clear.
Step 2
Select Edit > Filter Class Out (or right-click and select Filter Class Out).
This toggles the filter setting and resets the filter.
Note
When you filter out a Class, all Message IDs associated with that Class are marked with a red “X”.
Message ID Filters
Set and clear Message ID filters in the Objects View.
Setting Message ID Filters
Step 1
Select any entry containing the Message ID to filter.
Step 2
Select Edit > Filter MsgID Out (or right-click and select Filter MsgID Out).
Clearing Message ID Filters
Step 1
Select any entry containing the Message ID to clear.
Step 2
Select Edit > Filter Msg ID Out (or right-click and select Filter Msg ID Out).
This toggles the filter setting and resets the filter.
Caution
Exercise extreme care when filtering on Message IDs. Make sure you filter both the raise and clear
messages, or you could end up in a situation where some Alarms are not being cleared, or some Alarms
are not seen as raised.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-7
Chapter 7
LGCnfg Tool
Instance Node Deletion
Instance Node Deletion
It may be necessary to delete instance nodes. One possible scenario is when you no longer need to
monitor a customer. Another scenario is when certain sub-system instances (such as a PG or a NIC) are
no longer valid. For these situations and others, delete the instance nodes and their children from the
Alarms Database using the LGCnfg tool.
Note
As when filtering, if you delete an Instance Node, all associated Alarm objects for that Instance Node
are also deleted.
Deleting an Instance Node
Step 1
Select the node to delete in the Instance Nodes Tree View.
Step 2
Select Edit > Delete (or the Delete context menu option, or press the Delete key).
Creating a New Database
To create a new, completely empty (no OID Nodes or Rules) database:
Step 1
Select File > New…
Step 2
When prompted provide the Server location and Database Name.
This database can now be used to create new product instances and rules.
Cloning a Database
To clone the currently open database:
Step 1
Select File > Clone Database…
Step 2
When prompted, select the Server location and new Database Name.
Step 3
Select the aspects of the database you want to copy (see Figure 7-5).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-8
Chapter 7
LGCnfg Tool
Modifying the OID Node Hierarchy and Rules
Figure 7-5
Clone Database Options
The Copy Options are as follows:
•
Include OID Nodes, Rules and Objects
– Copy all OID Nodes, Rules and objects to the new database.
•
Include Customer Instances
– Copy all customer instances to the new database.
•
Include Instance Nodes
– Copy all Instance Nodes to the new database.
•
Include Alarms
– Copy all Alarms objects to the new database
Any relevant filter settings are always copied.
The cloned database can now be used to create or edit any aspect of a database. Cloning a database is a
good way to experiment and test out any important changes in a controlled environment before putting
it into a production mode.
Modifying the OID Node Hierarchy and Rules
The Alarms databases created during the installation process contain the proper OID Node hierarchy and
Rule set for use by the LGMapper and its clients. If changes need to be made to the OID hierarchy or the
Rule definitions, contact the Cisco Technical Assistance Center (TAC) for assistance. Proper Rules
definition requires detailed knowledge of Listener message field contents. If you feel the Instance Nodes
are improperly defined, or that objects are mapped to the wrong nodes (or not mapped at all), please
contact the Cisco Technical Assistance Center (TAC).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-9
Chapter 7
Modifying the OID Node Hierarchy and Rules
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
7-10
LGCnfg Tool
C H A P T E R
8
Installing the AlarmTracker Client
Overview
Installation of the AlarmTracker Client software involves running the installation files and starting the
Client.
The AlarmTracker Client uses DCOM to communicate with the LGMapper Server. The code handles the
details of this communication for you.
AlarmTracker uses the SQL Server OLE DB provider to gain direct access to the LGMapper Alarms
Database in order to perform queries and refresh AlarmTracker displays.
Installing the AlarmTracker Client
Step 1
Run Setup.exe from the AlarmTracker Client directory of the Operations Support CD-ROM.
The AlarmTracker Client Installation Wizard starts.
Step 2
Click Next and review information about the installation in the Information window.
Step 3
Click Next and choose a destination to install the client software in the Destination Location window.
Step 4
Select the destination location for the AlarmTracker Client files.
Accept the default location, navigate to another existing location, or create a new location. Throughout
the remainder of this chapter, the selected location will be referred to as the installation folder.
Step 5
Click Next to start installing the AlarmTracker Client files.
When the installation is complete, the COM component registration is finished and the InstallShield
Wizard Complete window appears.
Step 6
Click Finish to exit the InstallShield Wizard.
Note
A system reboot may be required for the registration to take effect. Reboot the system if directed.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-1
Chapter 8
Installing the AlarmTracker Client
Starting the AlarmTracker Client
Starting the AlarmTracker Client
Once installation is complete, start the AlarmTracker Client.
Step 1
Select Start>Programs>AlarmTracker2 (Figure 8-1).
Figure 8-1
Start>Programs>AlarmTracker2
When the AlarmTracker Client starts, it shows the Connect to Servers dialog (Figure 8-2).
Figure 8-2
Connect to LGMapper Servers Dialog Box
This dialog allows you to specify one or two LGMapper Server locations to connect to.Enter the machine
name of, or browse to, the desired LGMapper Server1 and/or LGMapper Server2 name(s). (Refer to
Figure 8-3.)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-2
Chapter 8
Installing the AlarmTracker Client
Starting the AlarmTracker Client
Figure 8-3
Step 2
Connecting to the LGMapper Server(s)
Click Connect (Figure 8-3), the process of connecting to the LGMapper Server begins.The process of
connecting and initializing may take a few minutes. The dialog box expands vertically (Figure 8-4) as
various progress messages appear during the initialization.
Figure 8-4
Connect to Servers Dialog Box Indicating Connection Progress
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-3
Chapter 8
Installing the AlarmTracker Client
Starting the AlarmTracker Client
During the initialization phase:
•
The code creates an instance of the SvrMgrObj on the LGMapper Server which manages the
communication between the LGMapper Server and the AlarmTracker Client
•
If this is the first AlarmTracker Client connecting to the LGMapper Server, the LGMapper Server:
– Initializes its connection with the Listener process
– Initializes its Configuration Database by taking an in-memory snapshot of its contents and
building a local object hierarchy
– Preprocesses any Alarm objects remaining from the previous invocation of LGMapper
– Reads the Listener Base Records
– Builds Alarm objects
– Updates the object hierarchy
•
LGMapper Server takes a snapshot of the full object hierarchy and serializes it across the wire to the
AlarmTracker Client
•
AlarmTracker serializes the object hierarchy from LGMapper Server into its local object hierarchy
•
AlarmTracker Client initializes its displays and begins processing
If the AlarmTracker Client is in a different domain than that of the LGMapper Server, and there is not a
two-way trust relationship between these domains, the following error message may appear:
Failed to open DataSource LGMapper_geonv
Client unable to establish connection
[DBNMPNTW] ConnectionOpen (CreateFile()).
If this occurs, issue a net use command using the following syntax:
> net use \\lgmapperhost password /user:domain\username
where:
Note
•
lgmapperhost is the name of the machine you are trying to connect to (the LGMapper Server
machine)
•
domain\username is the name of a valid account in the domain of the LGMapper Server machine
•
password is the corresponding password for this account
To auto-connect to the LGMapper Server(s) upon starting the AlarmTracker Client, click Auto-Connect
to Servers on Startup (Figure 8-5).
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-4
Chapter 8
Installing the AlarmTracker Client
Configuring the AlarmTracker Client
Figure 8-5
Automatically Connecting to the LGMapper Server(s) at AlarmTracker Client Startup
Configuring the AlarmTracker Client
Windows XP
This section applies to customers running AlarmTracker clients on Windows XP SP2.
Configure the AlarmTracker client to connect to an LGMapper server.
Step 1
From the AlarmTracker client machine Start menu, select Start > Control Panel > Network
Connections.
Step 2
Right click Local Area Connection or the connection used to connect to the LGMapper server and select
Properties.
Step 3
Select the Advanced tab, then select Windows Firewall Settings.
Step 4
Select the Exceptions tab and click Add port.
Step 5
Enter the name dcom and port 135.
Step 6
Make sure TCP is selected and click OK.
Step 7
Click OK on the Firewall Settings dialog box and click OK on the Local Area Connection properties.
Step 8
From the Start menu, select Start > Run.
Step 9
In the Run dialog, enter dcomcnfg and click OK to open the Component Services window.
Step 10
Select Component Services in the left pane and double-click the Computers folder in the right pane.
Step 11
Right click My Computer and select Properties.
Step 12
Select the COM Security tab
In the Launch and Activation Permissions area, you can control the local and remote permissions as well
as the computer-wide limits and defaults. Security Settings provide the ability to specify both local and
remote activation and launch permissions.
Step 13
Under Access Permissions, select Edit Limits and click OK.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-5
Chapter 8
Installing the AlarmTracker Client
Configuring the AlarmTracker Client
Step 14
In the Access Permissions dialog box, select Distributed COM Users and make sure the Allow box is
checked for Local Access and Remote Access, then click OK.
Step 15
Under Launch and Activate Permissions, select Edits Limits and click OK.
Step 16
In the Launch Permissions dialog box, select Distributed COM Users and make sure the Allow boxes
are checked for local and remote activation, then click OK.
Step 17
Restart the AlarmTracker Client.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
8-6
C H A P T E R
9
The Exclude Node Feature
Overview
Initially, the Listener/LGMapper installation sets up the Exclude Node feature so that it is disabled. This
is done to provide backwards compatibility with older Grid clients. The Exclude Node feature is
incompatible with the Grid application, and would create inconsistent views of Alarm objects in Grid if
it were enabled. For this reason, Listener uses a registry setting to determine if the Excluded Node
feature is enabled or not.
When Exclude Node is disabled (the default), Grid clients and AlarmTracker clients can be used
simultaneously. However, when an AlarmTracker user attempts to exclude a node, an error dialog
appears indicating that this feature is not enabled.
When the Exclude Node feature is enabled, Grid clients connect to the Listener, but receive no data other
than Listener heartbeats. An Alarm is also raised in the AALSTN customer node.
Enabling the Exclude Node Feature
To enable the Exclude Node feature in Listener, you must create a registry value as follows:
Key: HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems, Inc.\ICM\Listener
DWORD Value: SupportExcludeNode = 1
If this value is not present, or has a value other than 1, the Exclude Node feature is disabled.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
9-1
Chapter 9
Enabling the Exclude Node Feature
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
9-2
The Exclude Node Feature
C H A P T E R
10
Deployment Issues
System Specification
The processes running as part of the complete Remote Monitoring solution are shown in Figure 10-1.
You can run all these processes on a single machine, but dividing the workload among different machines
optimizes performance.
For hardware and software requirements, refer to the Cisco Intelligent Contact management Software
Release 7.0(0) Bill of Materials.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
10-1
Chapter 10
Deployment Issues
System Specification
Figure 10-1
Remote Monitoring Processes
Archived
Alarms
DB
LGArchiver
LGArchiverNM
Network
Boundary
Listener
LGMapperNM
AlarmTracker
Client
Alarms
DB
AlarmTracker
Client
63995
LGMapper
The LGMapper machine must be fastest machine with the most amount of memory because it must
update the SQL Server database in real time, and it must service potentially tens of AlarmTracker clients
in real time as well.
Disk Space Requirements for Alarms Database
It is also difficult to accurately estimate disk space required. This again depends on the number of
customers and products supported; and for the Alarms Databases, it also depends on the Alarms Objects
History setting in LGMapperCnfg Tool, page 4-1 and LGArchiverCnfg Tool, page 4-10.
Use the following formula as a guideline to estimate the SQL Server database MDF file size:
[MDF File Size MBytes] = 0.3 X [Number of Customers] X [Time History in Days]
Examples:
Monitoring 150 Customers and maintaining a 30-day Alarms Time History results in an MDF file
size of on the order of 1.35 GBytes.
Monitoring 30 Customers and maintaining a 60-day Alarms Time History results in an MDF file size
of about 540 MBytes.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
10-2
Chapter 10
Deployment Issues
System Specification
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
10-3
Chapter 10
System Specification
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
10-4
Deployment Issues
C H A P T E R
11
Backwards Compatibility Considerations
Listener and Grid
If you are upgrading from an existing Listener/Grid solution, there are some compatibility issues that
you should be aware of.
The new Listener can be used with old Grid clients provided the following criteria are met:
•
The Listener's Exclude Node feature is disabled (Enabling the Exclude Node Feature, page 9-1)
•
Update every Grid client's GridPipe.dll with the new GridPipe.dll found in the Listener executable
directory (typically ICR\bin). If this dll file is not updated, the Grid client fails to connect and an
Alarm is raised in the AALSTN customer node.
When upgrading from an existing Listener/Grid solution, you may want to preserve compatibility during
an initial acceptance period.
Once you enable the Exclude Node feature, you can no longer use the Grid clients to monitor Alarm data.
The Grid client can connect to Listener, but receives no data other than Listener heartbeats. An Alarm is
also raised in the AALSTN customer node.
Version 2 of the LGMapper and LGArchiver are designed to work with a 4.6 Listener server. This version
of Listener now supports multiple products. If you choose not to upgrade Listener to a 4.6 Listener, you
can still use the Version 2 LGMapper and LGArchiver by setting a registry key. This key is used by
LGMapper and LGArchiver to request an older feed from Listener that does not support multiple
products. In this case, only the ICM product can be supported.
To use a 4.5 Listener with the LGMapper, create the following registry value:
Key: HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems\LGMapper2
DWORD Value: ListenerClientVersion = 4
Similarly, to use a 4.5 Listener with the LGArchiver, create the following registry value:
Key: HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems\LGArchiver
DWORD Value: ListenerClientVersion = 4
If you fail to set the registry keys and inadvertently connect to a 4.5 Listener, the initialization will abort.
An error message (with an error code of 0x8007000b) is then written to the log file. The error text:
An attempt was made to load a program with an incorrect format.
may be seen for an AlarmTracker Client.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
11-1
Chapter 11
Backwards Compatibility Considerations
LGMapper Server
LGMapper Server
Version 2 of LGMapper has changed considerably from the initial Version 1 release. The biggest change
is the migration to SQL Server from Microsoft Access as the database repository for the configuration
information and Alarms data. Because of this major design change, all Server components have been
renamed and a '2' has been added to each COM object and interface to distinguish it from its Version 1
counterpart.
If you are running the Version 1 LGMapper Server, you must install the Version 2.1 LGMapper Server
on a different machine.
Note
If you are upgrading the LGMapper, ensure no LGMapper Server is currently running.
AlarmTracker Clients
The Version 2 AlarmTracker Client is specifically designed to connect to the Version 2 LGMapper
Server. It is not backward compatible with the Version 1 AlarmTracker client. Therefore, you cannot use
the Version 2 AlarmTracker client to connect to a Version 1 LGMapper Server.
Since the name of the AlarmTracker executable file is still AlarmTracker.exe, to maintain both a Version
1 installation and a Version 2 installation on the same machine, ensure Version 2 AlarmTracker Client
is installed in a different directory than the Version 1 AlarmTracker Client. That way, both versions can
run side by side to perform validation checks.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
11-2
C H A P T E R
12
Implementing the IWantHelp Interface
Overview
The AlarmTracker Client software contains support for an external COM interface called IWantHelp. If
implemented, the IWantHelp interface provides the customer with a hook into building a custom help
and guidance system, and integrating it with AlarmTracker. If the component is properly registered, it is
accessed from the Event Details dialog as a custom button. When clicked, the AlarmTracker code calls
a method in IWantHelp which presents custom help information based on the context of the displayed
event.
A standard implementation is building troubleshooting wizards for specific Alarms via a web-based
solution. When the custom IWantHelp button is clicked, the IWantHelp::OnHelp method is called along
with the AlarmID, Class, MsgID, and MsgText fields of the event. This information is then used to
present a troubleshooting wizard on how to fix a particular problem.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
12-1
Chapter 12
Implementing the IWantHelp Interface
How to Implement IWantHelp
How to Implement IWantHelp
Interface Definition
The IWantHelp interface is defined by the following IDL:
// WantHelp.idl : IDL source for IWantHelp.tlb
//
// This file will be processed by the MIDL tool to
// produce the type library (IWantHelp.tlb)
import "oaidl.idl";
[
uuid(BAA31F1A-1E9F-4876-A99F-E9AF2FEEBBA5),
version(1.0),
helpstring("IWantHelp 1.0 Type Library")
]
library IWantHelpLib
{
importlib("stdole2.tlb");
[
object,
uuid(54D8196C-CDF4-406A-9E65-40B97336137D),
dual,
helpstring("IWantHelp Interface"),
pointer_default(unique)
]
interface IWantHelp : IDispatch
{
[id(1), helpstring("Notification that an Active Connection has been established with an LGMapper
Server")] HRESULT ActiveConnectionEstablished([in] BSTR strHostName, [in] BSTR strCatalog);
[id(2), helpstring("Notification that an Active Connection with an LGMapper Server has been
terminated")] HRESULT ActiveConnectionTerminated();
[id(3), helpstring("Help has been requested by user")] HRESULT OnHelp([in] long nAlarmID, [in] long
nClass, [in] long nMsgID, [in] BSTR strMsgText);
[propget, id(4), helpstring("Button text in AlarmTracker Event Detail dialog")] HRESULT
ButtonText([out, retval] BSTR *pVal);
[propput, id(4), helpstring("Button text in AlarmTracker Event Detail dialog")] HRESULT
ButtonText([in] BSTR newVal);
};
};
This IDL file is named IWantHelp.idl and is included in the bin folder of the LGMapper installation
directory along with its corresponding IWantHelp.tlb file.
The following properties and methods are defined.
Property: ButtonText
Type: BSTR
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
12-2
Chapter 12
Implementing the IWantHelp Interface
How to Implement IWantHelp
Description: Button text displayed in the AlarmTracker Event detail dialog.
Property: ButtonText
Type: BSTR
Description: Button text displayed in the AlarmTracker Event detail dialog.
Method: ActiveConnectionEstablished
Args:
[in] BSTR strHostName - Name of the machine where the SQL Server Alarms database is running.
[in] BSTR strCatalog - Name of the SQL Server Alarms database.
Description: Notification that an Active Connection has been established with an LGMapper Server.
The information in this method can be used if you want to create a connection to the Alarms database
that the AlarmTracker is connected to.
Method: ActiveConnectionTerminated
Args: None
Description: Notification that an Active Connection with an LGMapper Server has been terminated.
Method: OnHelp
Args:
[in] long nAlarmID - AlarmID in the Alarms database of the Event being viewed in the Event Details
dialog.
[in] long nClass - Class of the Event being viewed in the Event Details dialog.
[in] long nMsgID - EMS Message ID of the Event being viewed in the Event Details dialog.
[in] BSTR strMsgText - Message text of the Event being viewed in the Event Details dialog.
Description: Help has been requested by the user. You can implement this method to use the
arguments to present custom context-dependent help information.
Implementing IWantHelp
Implement the IWantHelp interface using any programming language that supports COM (e.g., C++,
Visual Basic, Java). The interface must be implemented as an in-proc COM server.
Once built, the DLL must be copied to all AlarmTracker client machines and registered. More details on
this can be found in Installation and Setup.
Sample Implementation
A sample implementation of the IWantHelp interface is included in the HelpSample directory of the
LGMapper installation directory. This is an C++ ATL implementation which simply displays the
Microsoft home page in a browser window in a separate process.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
12-3
Chapter 12
Implementing the IWantHelp Interface
How to Implement IWantHelp
Installation and Setup
Once you implement your custom implementation, it can be deployed to AlarmTracker Client systems.
Three things need to be done in order for the implementation to be integrated with AlarmTracker:
•
The DLL must be copied to each AlarmTracker Client machine.
The location is not important since it is a COM DLL and the registry contains the right information
on how to load it.
•
The DLL must be properly registered on each AlarmTracker Client machine.
This is done by running RegSvr32 with the full path name of the DLL as an argument.
•
You must add the following registry key to each AlarmTracker Client's machine:
HKEY_LOCAL_MACHINE\SOFTWARE\CiscoSystems\AlarmTracker\ProgIDs
and add the string (REG_SZ) value IWantHelp.
The value of IWantHelp must be the ProgID of the IWantHelp implementation, e.g.,
“HelpSample5.WantHelp”.
When AlarmTracker starts, it looks for this registry value, and, if it exists, the DLL is loaded and used.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
12-4
A P P E N D I X
A
Alarms Database Schema
Introduction
Chapter 1, “Remote Monitoring Suite Overview”, presented an overview of the main tables in the
Alarms Database. This appendix provides the database map (Figure A-1) and describes all of the tables
in the database in greater detail.
Table Classes
There are four classes of tables maintained in the database:
1.
Configuration Tables
•
These tables store information related to products, Rule mapping and nodes.
•
Tables in this class include the following:
– VersionInfo
– ProductInfo
– Objects
– OIDNodes
– Attributes
– OIDNodeAttributes
– HyperlinkInfo
– NodeTypes
– Rules
– Customers
– InstanceNodes
2.
Alarms Tables
•
These tables store information related to the Listener Event stream processed by the LGMapper and
LGArchiver Servers.
•
These tables include:
– Uptime
– Alarms
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-1
Appendix A
Alarms Database Schema
Introduction
– Events
– Simples
– ObjectState
3.
Summary Statistics Tables
•
These tables store summary information collected during continuous monitoring of Listener Events.
•
The information in these tables represent totals or averages of important metrics related to Alarms
and Events.
•
These tables include:
– AlarmsSummaryHour
– AlarmsSummaryDay
4.
Filter Tables
•
These tables store information related to server-side filtering options.
•
These tables include:
– Filters
– FiltersProductSpecific
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-2
Appendix A
Alarms Database Schema
Introduction
Alarms Database Schema Map
AlarmsSummaryDay
PK
CustomerID
PK,FK1 ProductID
PK
Time
AlarmsSummaryHour
PK,FK1 CustomerID
PK,FK2 ProductID
Time
VersionInfo
PK
VersionNumber
Uptime
MasterDB
MasterDBFile
ModifiedTime
ReplicationTime
ReindexTime
AdminLockCount
Samples
NewAlarmCount
ClosedAlarmCount
UnassignedAlarmsAvg
AssignedAlarmsAvg
ExcludedAlarmsAvg
NewAppErrCount
ClosedAppErrCount
UnassignedAppErrsAvg
AssignedAppErrsAvg
ExcludedAppErrsAvg
AlarmEventCount
AppErrCount
SimpleCount
PK
NewAlarmCount
ClosedAlarmCount
UnassignedAlarms
AssignedAlarms
ExcludedAlarms
NewAppErrCount
ClosedAppErrCount
UnassignedAppErrs
AssignedAppErrs
ExcludedAppErrs
AlarmEventCount
AppErrCount
SimpleCount
Time
State
ObjectState
PK
ObjectName
PK,FK1 CustomerID
PK,FK2 ProductID
AlarmID
HyperlinkInfo
Objects
PK,FK1 ProductID
PK
MsgID
I1
PK,I1
CustomerName
Handle
CreationTime
OIDNodes
Rules
InstanceNodes
NodeID
PK
ParentID
Name
ProductID
NodeType
StateRollup
ChildNotifications
HyperlinkNodeID
AttributeCount
Filter
ModifiedTime
ParentHandle
IIDAddress
FK1,I1 CustomerID
FK2
ProductID
NodeName
HyperlinkHandle
FK3,I2 NodeID
ModifiedTime
FK3
I1
Filters
Alarms
PK
CustomerID
ProductInfo
PK
RuleID
ProductID
Class
ModifiedTime
FK1,I2 OIDNodeID
InstanceName
FK2,I4 AttributeID
Comment
FK3
MsgID
SystemType
Side
SystemName
ProcName
EMSParam1
EMSParam2
EMSParam3
EMSParam4
EMSParam5
PK,I1
InstanceName
FormatString
ModifiedTime
ModifiedTime
State
Class
Timeout
Args
AlmArgs
TrapNo
TrapSev
Mnemonic
PK,I1
PK,I3
NodeID
Customers
Handle
ProductID
ProductName
ModifiedTime
ObjectsParseTime
BeeperParseTime
Description
Attributes
PK,I1
OIDNodeAttributes
PK,FK1,I2 NodeID
PK,FK2,I1 AttributeID
ModifiedTime
AttributeID
Name
DataType
Rollup
DefaultValue
ModifiedTime
RealAlarm
ObjectName
OwnerHandle
IIDAddress
FK1,I2
CustomerID
FK4,FK5 ProductID
Excluded
Active
ApplicationError
State
Assigned
AssignedBy
AssignedTo
TicketID
I1
CreationTime
ReceivedTime
CurrentTime
LastEventID
EventRepeatCount
EventCount
FK3
AttributeID
AttributeName
CategoryName
Class
DMPID
FK5
MsgID
ProcessName
SystemName
Side
SingleState
TrapSeverity
SystemType
FK2,I3
Simples
PK
AlarmID
I2
FK1
I2
FK2
ObjectName
OwnerHandle
CustomerID
ProductID
Excluded
State
CreationTime
ReceivedTime
CategoryName
DMPID
MsgID
ProcessName
SystemName
Side
TrapSeverity
SystemType
MsgText
FiltersProductSpecific
I1
PK
PK
FilterField
Criterion
AlarmID
PK
PK
PK
ProductID
FilterField
Criterion
ModifiedTime
ModifiedTime
Events
PK
EventID
PK,FK1,I1 AlarmID
MsgID
MsgType
State
Assigned
Time
ReceivedTime
MsgText
OutcomeText
AssignedBy
63918
Figure A-1
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-3
Appendix A
Alarms Database Schema
Detailed Schema Description
A Note About Time
There are many time fields in tables throughout the database. All times recorded in the database are
stored relative to the time zone of the LGMapper/LGArchiver Server machine. Some times represent the
time the Event actually occurred at the customer site, other times represent the time an Event is received
at the LGMapper, and other times represent the time that an AlarmTracker user assigned an Alarm.
Note
Customers may be located all around the world and when an Event is sent to Listener its Event time is
adjusted to be in the time zone of the Listener. When this Event is sent on to LGMapper, the time may
be further adjusted if the LGMapper time zone is different than that of the Listener.
Detailed Schema Description
VersionInfo Table
Description
The VersionInfo table stores information related to the schema version and relevant times of updates.
This table is updated by the LGCnfg tool and by the LGMapper/LGArchiver Servers.
This table contains only a single row of information.
Note
Column_name
Type
Computed
Length Prec Scale Nullable
Trim
Trailing FixedLen
Blanks NullInSource
VersionNumber
(PK)
int
no
4
no
(n/a)
(n/a)
MasterDB
bit
no
1
no
(n/a)
(n/a)
MasterDBFile
varchar
no
255
yes
yes
no
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
ReplicationTime
datetime
no
8
yes
(n/a)
(n/a)
ReindexTime
datetime
no
8
yes
(n/a)
(n/a)
0
(PK) is used throughout this document to indicate the Primary Key of the table.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-4
10
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
VersionNumber
Alarms database schema version number.
MasterDB
Set to 1 if the database is a Master Database, 0 if it is a Slave Database. Database
replication is not currently implemented in Version 2 of the product.
MasterDBFile
If MasterDB is set to 0, this field contains the location of the Master Database.
Database replication is not currently implemented in Version 2 of the product.
ModifiedTime
The time the configuration information in the database was last changed. Changes
made using LGCnfg to any of the Configuration Tables except for Customers and
InstanceNodes (refer to the Introduction) update this field.
ReplicationTime
The time the database was last replicated. Database replication is not currently
implemented in Version 2 of the product.
ReindexTime
The time of the last full re index using DBCC DBREINDEX.
AdminLocks
The count of Admin locks on the Alarms Database. If an instance of LGCnfg2 has
the database open with read/write access, it will increment this value. When it exits,
it will decrement this value. When LGMapper or LGArchiver starts up, it will check
this field. If it is non-zero, it will fail and exit.
Note
If LGMapper /LGArchiver won’t start and CRulesMgr::InitDatabase
AdminLocks=1. Cannot initialize appears in the LGMapper log file, refer to
Resetting Admin Locks for LGMapper Version 2.0.x (Document ID: 22153)
http://www.cisco.com/warp/public/78/LGMapper_locks.html.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-5
Appendix A
Alarms Database Schema
Detailed Schema Description
ProductInfo Table
Description
This table contains general information about Products supported by the Rule mapping process.
Column_name
Type
Computed
Length Prec Scale Nullable
Trim
Trailing FixedLen
Blanks NullInSource
ProductID (PK)
int
no
4
no
(n/a)
(n/a)
ProductName
varchar
no
64
no
yes
no
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
ObjectsParseTime
datetime
no
8
yes
(n/a)
(n/a)
BeeperParseTime
datetime
no
8
yes
(n/a)
(n/a)
Description
varchar
no
256
yes
yes
no
Column_name
Column Description
ProductID
Product ID. This ProductID field is used as a foreign key in many other tables.
ProductName
Product name.
ModifiedTime
Time this record was last updated.
ObjectsParseTime
Last time the LGCnfg tool updated the Objects table with a new object.flt file.
BeeperParseTime
Last time the LGCnfg tool updated the Objects table with a new beeper.v4 file.
Description
General description of the product.
10
0
Fields
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-6
Appendix A
Alarms Database Schema
Detailed Schema Description
Objects Table
Description
The Objects table stores information about the object.flt and beeper.flt files used at the customer site and
at the Listener site to determine which EMS Events are phoned home to Listener and processed by
Listener.
Information in this table represents the subset of the EMS messages that the Logger tracks.
Information in this table represents the basis for the Rule mapping process.
The contents of this table can be viewed in the Objects View of the LGCnfg tool.
Column_name
Type
Computed
Length Length Scale Nullable
Trim
Trailing FixedLen
Blanks NullInSource
ProductID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
MsgID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
yes
(n/a)
(n/a)
State
int
no
4
10
0
yes
(n/a)
(n/a)
Class
int
no
4
10
0
yes
(n/a)
(n/a)
Timeout
int
no
4
10
0
yes
(n/a)
(n/a)
Args
int
no
4
10
0
yes
(n/a)
(n/a)
AlmArgs
int
no
4
10
0
yes
(n/a)
(n/a)
TrapNo
int
no
4
10
0
yes
(n/a)
(n/a)
TrapSev
int
no
4
10
0
yes
(n/a)
(n/a)
Mnemonic
varchar
no
128
yes
yes
no
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-7
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
ProductID
Product ID.
MsgID
EMS Message ID.
ModifiedTime
Time this record was last updated.
State
A decimal value (0..9) indicating the internal state to use when tracking the object. A
value of 9 indicates the message is a stateless object/alarm.A message with a state
value of 9 is sent as an alarm. A value of 0 indicates it is a “clear” (reset) for the
object. Other events signal a “raise” for the object.
Class
A name which allows grouping of EMS message IDs into logical objects. There is one
Class ID for each kind of object tracked.
Timeout
Currently unused by the CSFS process (processes that receive the alarm feed such as
a process to generate pager notices, would use the time-out value).
Args
An argument string (max of 16 characters) composed of single hex values(0..F)
indicating the arguments from the EMS event that are used internally by the object
tracking process (CSFS) to discriminate the event into a unique object. (E.G. 862)
Currently the following values are used:
9 DMP System ID
8 SystemName
7 ProcessName
6 Side
5..1 EMS Arguments
AlmArgs
An argument string (like Object Argument String above except that 9..6 cannot be
used!!) that is passed to clients receiving a feed from the CSFS process to use for their
own internal processing.
TrapNo
A number which (also defined in the MIB definition) indicates the trap number to use
when forwarding the alarm. This is passed to clients receiving a feed from the CSFS
process when an alarm event is detected.
TrapSev
A decimal value (0..32767) indicating the severity of the alarm. This is passed onto
CSFS clients when an alarm event is detected.
Mnemonic
Description of the event.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-8
Appendix A
Alarms Database Schema
Detailed Schema Description
OIDNodes Table
Description
The OIDNodes table stores information about a generalized hierarchy of objects. This table defines the
basic template object structure for the Rule mapping process to use to create Instance Nodes.
The parent-child relationships are represented in the table by having each record contain a ParentID field
which contains the NodeID of the parent node.
A graphical representation of this table as a tree view can be seen in the OID Nodes Tree View of the
LGCnfg tool.
Column_name
Type
Trim
Trailing FixedLen
Computed Length Prec Scale Nullable Blanks NullInSource
NodeID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ParentID
int
no
4
10
0
no
(n/a)
(n/a)
Name
varchar
no
64
no
yes
no
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
NodeType
int
no
4
10
0
no
(n/a)
(n/a)
StateRollup
bit
no
1
no
(n/a)
(n/a)
ChildNotifications int
no
4
10
0
no
(n/a)
(n/a)
HyperlinkNodeID
int
no
4
10
0
no
(n/a)
(n/a)
AttributeCount
int
no
4
10
0
no
(n/a)
(n/a)
Filter
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime no
8
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-9
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
NodeID
Primary key and unique node identifier. This is an identity column.
ParentID
NodeID of the parent node. The root node has a ParentID of zero.
Name
Node name.
ProductID
Product ID.
NodeType
Node Type.
StateRollup
Defines how the State of this node rolls up to its parent.
The possible values are:
ChildNotifications
•
0 - The State does not roll up to its parent.
•
1 - The State rolls up to its parent.
Defines how State roll up notifications from child nodes are handled.
The possible values are:
•
0 - The node ignores State roll up notifications from its children.
•
1 - The node processes State roll ups in a functional way.
This means that the overall child roll up contribution is computed by ANDing
the individual child node States.
If all nodes are up, the roll up contribution is up
If all nodes are down, the roll up contribution is down.
If at least one of the nodes is down, but not all, the roll up contribution is partial
impaired.
•
2 - The processes State roll ups in a critical path way.
This means that the overall child roll up contribution is computed by ORing the
individual child node States. Thus, the roll up contribution represents the
highest State value of all child nodes that roll up their States.
HyperlinkNodeID
If the node is a Hyperlink node, this field represents the NodeID of the real node
that it refers to.
AttributeCount
Count of the number of Attributes associated with the Node. All nodes must have
a State Attribute so this field will have a minimum value of 1.
Filter
Filter value indicating whether a server-side filter is set for it.
A value of 1 means that the OID Node is being filtered.
A value of 2 means that the OID Node is being filtered as a result of one of its parent
nodes being filtered.
A mask value of 0x10 means that the OID Node is filtered as a result of a ProductID
filter being set.
ModifiedTime
Time this record was last updated.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-10
Appendix A
Alarms Database Schema
Detailed Schema Description
Attributes Table
Description
The Attributes table contains a mapping of an AttirbuteID value to an Attribute name. It also contains
information about the type of Attribute.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
AttributeID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
Name
varchar
no
64
no
yes
no
DataType
smallint
no
2
5
0
no
(n/a)
(n/a)
Rollup
int
no
4
10
0
no
(n/a)
(n/a)
DefaultValue
varchar
no
64
yes
yes
no
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
FixedLen
NullInSource
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-11
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
AttributeID
Primary key and identity column containing the AttributeID.
Name
Attribute name.
DataType
VARTYPE field. See the MicroSoft Visual C++ documentation for the VARIANT
data type for possible values.
Rollup
Indicates how the value of the Attribute contributes to the node's State value.
The possible values are:
•
0 - The Attribute value does not contribute to the State value.
•
1 - The Attribute value is combined with other Attribute values in a functional
way. This means that the overall Attribute contribution is computed by ANDing
the individual Attribute values.
•
2 - The Attribute value is combined with other Attribute values in a critical path
way. This means that the overall Attributes contribution is computed by ORing
the individual Attribute values. Thus, the roll up contribution represents the
highest Attribute value of all Attributes that roll up their values.
DefaultValue
Default value for the Attribute.
ModifiedTime
Time this record was last updated.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-12
Appendix A
Alarms Database Schema
Detailed Schema Description
OIDNodeAttributes Table
Description
The OIDNodeAttributes table contains the mappings of OIDNodes and the Attributes they contain.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
NodeID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
AttributeID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
Column_name
Column Description
NodeID
NodeID in the OIDNodes table.
AttributeID
AttributeID in the Attributes table.
ModifiedTime
Time this record was last updated.
FixedLen
NullInSource
Fields
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-13
Appendix A
Alarms Database Schema
Detailed Schema Description
HyperlinkInfo Table
Description
The HyperlinkInfo table contains information about Hyperlink nodes including information on how to
determine the resulting Instance Node.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
NodeID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
InstanceName
varchar
no
255
no
yes
no
FormatString
varchar
no
255
yes
yes
no
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
Column_name
Column Description
NodeID
NodeID in the OIDNodes table.
InstanceName
A specification of the how the Instance Name will be formed.
FormatString
If the Instance Name includes parameters, this field includes C-style formatting
information.
ModifiedTime
Time this record was last updated.
FixedLen
NullInSource
Fields
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-14
Appendix A
Alarms Database Schema
Detailed Schema Description
Rules Table
Description
The Rules table stores the information that maps a Listener message to a specific Attribute and Instance
Node based on the message content. Each Rule is associated with a particular OID Node in the
OIDNodes table.
The set of Rules defined for each OID Node can be seen visually in the Rules View of the LGCnfg tool.
Each time a different OID Node is selected, the set of Rules for that OID Node is displayed.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
RuleID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
Class
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
OIDNodeID
int
no
4
no
(n/a)
(n/a)
InstanceName
varchar
no
255
no
yes
no
AttributeID
int
no
4
no
(n/a)
(n/a)
Comment
varchar
no
255
yes
yes
no
MsgID
varchar
no
255
yes
yes
no
SystemType
varchar
no
255
yes
yes
no
Side
varchar
no
255
yes
yes
no
SystemName
varchar
no
255
yes
yes
no
ProcName
varchar
no
255
yes
yes
no
EMSParam1
varchar
no
255
yes
yes
no
EMSParam2
varchar
no
255
yes
yes
no
EMSParam3
varchar
no
255
yes
yes
no
EMSParam4
varchar
no
255
yes
yes
no
EMSParam5
varchar
no
255
yes
yes
no
10
10
0
0
FixedLen
NullInSource
Fields
Column_name Column Description
RuleID
Primary key and identity column that identifies the Rule.
ProductID
Product ID.
Class
EMS message Class.
ModifiedTime
Time this record was last updated.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-15
Appendix A
Alarms Database Schema
Detailed Schema Description
Column_name Column Description
OIDNodeID
NodeID in the OIDNodes table associated with this Rule.
InstanceName
Text string that specifies how the Instance Node name is to be determined from
the Listener message content.
AttributeID
AttributeID from the Attributes table associated with this Rule.
Comment
Comment field.
MsgID
EMS Message ID can be used as a criteria to select this Rule for a given
Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression, e.g., =
0xa102c109.
SystemType
System Type can be used as a criteria to select this Rule for a given Listener
message. This field can be NULL or empty if not needed as a criterion. If it is
present, it must be a valid SQL expression, e.g., = 5'.
Side
Duplexed side can be used as a criteria to select this Rule for a given Listener
message. This field can be NULL or empty if not needed as a criterion. If it is
present, it must be a valid SQL expression, e.g., ='A'.
SystemName
System Name can be used as a criteria to select this Rule for a given Listener
message. This field can be NULL or empty if not needed as a criterion. If it is
present, it must be a valid SQL expression, e.g., Like ‘%A’.
ProcName
Process name that can be used as a criteria to select this Rule for a given
Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression, e.g., Like
'%Logger%’.
EMSParam1
EMS message parameter 1 that can be used as a criteria to select this Rule for
a given Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression.
EMSParam2
EMS message parameter 2 that can be used as a criteria to select this Rule for
a given Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression.
EMSParam3
EMS message parameter 3 that can be used as a criteria to select this Rule for
a given Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression.
EMSParam4
EMS message parameter 4 that can be used as a criteria to select this Rule for
a given Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression.
EMSParam5
EMS message parameter 5 that can be used as a criteria to select this Rule for
a given Listener message. This field can be NULL or empty if not needed as a
criterion. If it is present, it must be a valid SQL expression.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-16
Appendix A
Alarms Database Schema
Detailed Schema Description
Customers Table
Description
The Customers table stores specific Customer instance names. Initially, this table is empty and is
populated as the LGMapper/LGArchiver processes Listener messages and encounters new Customers.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
CustomerID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
CustomerName
varchar
no
50
no
yes
no
Handle
int
no
4
no
(n/a)
(n/a)
CreationTime
datetime
no
8
no
(n/a)
(n/a)
Column_name
Column Description
CustomerID
Primary key. Customer ID.
CustomerName
Customer name.
Handle
Unique 32-bit Handle associated with the Customer. The Customer Handle is
determined from the CustomerID via the following C++ expression: Handle =
0x40000000 | (CustomerID << 14)
CreationTime
Time this record was created.
10
0
FixedLen
NullInSource
Fields
InstanceNodes Table
Description
The InstanceNodes table stores the entire known hierarchy of Instance Nodes created by the
LGMapper/LGArchiver at run time. These nodes are created by mapping Listener Events via the Rules
and OIDNodes information to specific Instance Nodes.
The parent-child relationships are represented in the table by having each record contain a ParentHandle
field which contains the Handle of the parent node.
A graphical representation of this table as a tree view can be seen in the Instance Nodes Tree View of
the LGCnfg tool.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-17
Appendix A
Alarms Database Schema
Detailed Schema Description
Column_name
Type
Computed
Length
Prec Scale Nullable
Trim
Trailing
Blanks
Handle (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ParentHandle
int
no
4
10
0
no
(n/a)
(n/a)
IIDAddress
varchar
no
128
no
yes
no
CustomerID
int
no
4
10
0
no
(n/a)
(n/a)
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
NodeName
varchar
no
64
no
yes
no
HyperlinkHandle
int
no
4
10
0
no
(n/a)
(n/a)
NodeID
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-18
FixedLen
NullInSource
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
Handle
Primary key, 32-bit Handle that uniquely defines this node. Handle bits are assigned
in a particular manner as described in How Handles Are Used, page A-35.
ParentHandle
The Handle of the parent node.
IIDAddress
An Instance ID Address string that defines the instance node's place in the object
hierarchy. This IIDAddress is in the form 1.2.4.13 and is unique for all Instance
Nodes. The Root node has IIDAddress 1. First-level child nodes have IIDAddresses
1.1, 1.2, etc. and so on.
CustomerID
Customer ID.
ProductID
Product ID.
NodeName
Node name.
HyperlinkHandle
For Hyperlink nodes, this value is the Handle of the real node to which it refers. For
real nodes, this value is zero.
NodeID
The NodeID in the [OIDNodes] table to which this node refers to.
ModifiedTime
Time this record was last updated.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-19
Appendix A
Alarms Database Schema
Detailed Schema Description
Uptime Table
Description
The Uptime table indicates the times during which the LGMapper/LGArchiver Server is processing
Listener data. The table consists of pairings of Time and State values.
Prec
Scale
Nullable
Trim
Trailing
Blanks
FixedLen
NullInSource
Column_name
Type
Computed
Length
Time (PK)
datetime
no
8
no
(n/a)
(n/a)
State
bit
no
1
no
(n/a)
(n/a)
Column_name
Column Description
Time
Time the LGMapper/LGArchiver started or stopped processing Listener messages.
State
1 - indicates the LGMapper/LGArchiver started processing data.
Fields
0 - indicates the LGMapper/LGArchiver stopped processing data.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-20
Appendix A
Alarms Database Schema
Detailed Schema Description
Alarms Table
Description
The Alarms table is the primary table for storing Alarm object information. A record in the Alarms table
represents an Alarm object.
Records in the associated Events table make up the Events or state transitions for the Alarm object.
Column_name
Type
Computed
Length Prec Scale Nullable
Trim
Trailing FixedLen
Blanks NullInSource
AlarmID (PK)
int
no
4
no
(n/a)
(n/a)
RealAlarm
bit
no
1
no
(n/a)
(n/a)
ObjectName
varchar
no
255
no
yes
no
OwnerHandle
int
no
4
no
(n/a)
(n/a)
IIDAddress
varchar
no
128
no
yes
no
CustomerID
int
no
4
10
0
no
(n/a)
(n/a)
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
Excluded
bit
no
1
no
(n/a)
(n/a)
Active
bit
no
1
no
(n/a)
(n/a)
ApplicationError
bit
no
1
no
(n/a)
(n/a)
State
int
no
4
10
0
no
(n/a)
(n/a)
Assigned
int
no
4
10
0
no
(n/a)
(n/a)
AssignedBy
varchar
no
64
yes
yes
no
AssignedTo
varchar
no
64
yes
yes
no
TicketID
varchar
no
32
yes
yes
no
CreationTime
datetime
no
8
no
(n/a)
(n/a)
ReceivedTime
datetime
no
8
no
(n/a)
(n/a)
CurrentTime
datetime
no
8
no
(n/a)
(n/a)
LastEventID
int
no
4
10
0
no
(n/a)
(n/a)
EventRepeatCount
int
no
4
10
0
no
(n/a)
(n/a)
EventCount
int
no
4
10
0
no
(n/a)
(n/a)
AttributeID
int
no
4
10
0
no
(n/a)
(n/a)
AttributeName
varchar
no
50
yes
yes
no
CategoryName
varchar
no
32
yes
yes
no
Class
int
no
4
10
0
no
(n/a)
(n/a)
DMPID
int
no
4
10
0
no
(n/a)
(n/a)
MsgID
int
no
4
10
0
no
(n/a)
(n/a)
ProcessName
varchar
no
16
yes
yes
no
10
10
0
0
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-21
Appendix A
Alarms Database Schema
Detailed Schema Description
Column_name
Type
Computed
Length Prec Scale Nullable
Trim
Trailing FixedLen
Blanks NullInSource
SystemName
varchar
no
32
yes
yes
no
Side
char
no
1
yes
yes
yes
SingleState
bit
no
1
no
(n/a)
(n/a)
TrapSeverity
int
no
4
10
0
no
(n/a)
(n/a)
SystemType
int
no
4
10
0
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-22
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
AlarmID
Primary key, value that uniquely identifies the Alarm object.
RealAlarm
A flag indicating whether the Alarm object is a “real” Alarm, meaning it was
created as a result of a Listener down Event.
This table also stores Listener Base Record information that merely indicate that an
object is in an up state. These are not considered real Alarms and, thus, have a value
of 0 for this field.
ObjectName
The Listener ObjectName associated with the Alarm.
OwnerHandle
The Handle in the InstanceNodes table which identifies the Instance Node
associated with this Alarm.
IIDAddress
IIDAddress in the InstanceNodes table corresponding to the OwnerHandle of the
Instance Node associated with this Alarm.
CustomerID
Customer ID.
ProductID
Product ID.
Excluded
1 - Alarm is Excluded.
0 - Alarm is not Excluded.
Active
1- Alarm is Active.
0 - Alarm is Inactive.
An Active Alarm is an open Alarm. It is an Alarm that is not in its terminal state.
See Alarm State Transition Diagram for a State transition diagram for an Alarm
object.
ApplicationError
1- Alarm is an Application Error.
0 - Alarm is not an Application Error.
State
State value of the Alarm. The range of State values are shown in Alarm State
Transition Diagram.
Assigned
Assignment Status value of the Alarm. The range of Assigned values are shown in
Alarm State Transition Diagram.
AssignedBy
The user name of the person who assigned, cleared, excluded, deleted an Alarm.
AssignedTo
Text that a user can type in to indicate a person or group responsible for an Alarm.
TicketID
Text field that can be used to associate an Alarm with a trouble ticket reporting
system.
CreationTime
Time the Alarm event condition was raised.
ReceivedTime
Time the database Alarm object was created.
CurrentTime
Time of the last Event record for this Alarm object.
LastEventID
EventID from the Events table of the last Event for this Alarm object.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-23
Appendix A
Alarms Database Schema
Detailed Schema Description
Column_name
Column Description
EventRepeatCount
The number of times a duplicate Event was received for this Alarm object.
The LGMapper/LGArchiver implement a form of Event suppression for Alarm
objects to control the number of Events stored for an Alarm object.
When an Alarm is in a particular state as shown in Alarm State Transition Diagram,
if repeated Events that do not involve a state transition are received, they are
inserted only up to a particular threshold value.
The threshold value (default value = 5) is set by the LGMapperCnfg or
LGArchiverCnfg programs. Once the number of repeat Events exceed this
threshold, they begin to be overwritten to cap the amount of data stored for any
particular Alarm.
This field stores the Event repeat count for the current Alarm state.
EventCount
The total number of Events received for this Alarm.
AttributeID
The AttributeID from the Attributes table associated with this Alarm.
AttributeName
The AttributeName from the Attributes table.
CategoryName
Category Name from the EMS message.
Class
Class from the EMS message.
DMPID
DMP ID from the EMS message.
MsgID
EMS Message ID.
ProcessName
Name of the process that generated the Alarm/Event.
SystemName
System name of the machine that generated the Alarm/Event.
Side
Duplexed side (typically 'A' or 'B') that generated the Alarm/Event.
SingleState
1 - Alarm is a single-state object.
0 - Alarm is not a single-state object.
Some Alarm objects are defined as single-state Alarms. This means that a Clear
Event (see Alarm State Transition Diagram) will never be received for it. An
AlarmTracker user must clear this Alarm manually to close it.
TrapSeverity
SNMP Trap Severity from the EMS message.
SystemType
System Type from the EMS message.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-24
Appendix A
Alarms Database Schema
Detailed Schema Description
Events Table
Description
The Events table is joined to the Alarms by the AlarmID field and represents all Events received for a
particular Alarm object. This table represents all the state transitions of an Alarm object as described in
Alarm State Transition Diagram.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
EventID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
AlarmID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
MsgID
int
no
4
10
0
no
(n/a)
(n/a)
MsgType
int
no
4
10
0
no
(n/a)
(n/a)
State
int
no
4
10
0
yes
(n/a)
(n/a)
Assigned
int
no
4
10
0
yes
(n/a)
(n/a)
Time
datetime
no
8
no
(n/a)
(n/a)
ReceivedTime
datetime
no
8
no
(n/a)
(n/a)
MsgText
varchar
no
255
yes
yes
no
OutcomeText
varchar
no
255
yes
yes
no
AssignedBy
varchar
no
64
yes
yes
no
FixedLen
NullInSource
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-25
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_
name
EventID
Column Description
Sequential EventID for an Alarm object. The initial raise Event for the Alarm will always
be EventID = 1.
Note that due to Event repeat count suppression and total Event count suppression, the
sequence of Events will not always be consecutive, but they will always be in order.
AlarmID
AlarmID from the Alarms table.
MsgID
EMS Message ID for the Event.
MsgType
Message type. The following message types are defined in
Mnemonic -- Value -- Description order:
mtMessage -- 1 -- Customer-generated Listener message
mtHeartbeat -- 2-- Listener Heartbeat message. (Does not appear in Events table).
mtLastBaseRecord -- 3 -- Listener Last Base Record message. (Does not appear in Events
table).
mtWorkingOn -- 4 -- User action message. Indicates a user has assigned or unassigned an
Alarm.
mtExclude -- 5 -- User action message. Indicates a user has excluded or unexcluded an
Alarm.
mtExcludeNode -- 6 -- User action message. Indicates a user has excluded or unexcluded
a Node.
mtClear -- 7 -- User action message. Indicates that a user has cleared an Alarm.
mtDelete -- 8 -- User action message. Indicates that a user has deleted an object.
State
State value of the Event. The range of State values are shown in Alarm State Transition
Diagram.
Assigned
Assignment Status value of the Event. The range of Assigned values are shown in Alarm
State Transition Diagram.
Time
Event time. For a customer-generated Event, this is the time of the Event at the Customer
site adjusted to be in the time zone of the LGMapper/LGArchiver.
For an AlarmTracker user Event, this is the time the user Event was generated.
ReceivedT The time the Event was received at the LGMapper/LGArchiver.
ime
MsgText
Message text.
OutcomeT
ext
Notes entered by AlarmTracker user.
Assigned
By
For a user action message. Indicates the user name of the person who initiated the action.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-26
Appendix A
Alarms Database Schema
Detailed Schema Description
Simples Table
Description
The Simples table stores the set of Simple Events sent by Listener. Simple Events are stateless objects
and are considered to be less important than Alarm objects so they are maintained in a separate table.
Note
Listener purges Simple Events from its in-memory objects and the LGMapper Server also purges Simple
Events to mirror Listener's actions. LGArchiver, on the other hand, does not purge Simple Events based
on Listener commands. Instead, Simple Events are purged from the LGArchiver database based on the
amount of time history is saved in the database. This parameter is configurable from the
LGArchiverCnfg tool.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
AlarmID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ObjectName
varchar
no
255
no
yes
no
OwnerHandle
int
no
4
10
0
no
(n/a)
(n/a)
CustomerID
int
no
4
10
0
no
(n/a)
(n/a)
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
Excluded
bit
no
1
no
(n/a)
(n/a)
State
int
no
4
no
(n/a)
(n/a)
CreationTime
datetime
no
8
no
(n/a)
(n/a)
ReceivedTime
datetime
no
8
no
(n/a)
(n/a)
CategoryName
varchar
no
32
no
yes
no
DMPID
int
no
4
10
0
no
(n/a)
(n/a)
MsgID
int
no
4
10
0
no
(n/a)
(n/a)
ProcessName
varchar
no
16
yes
yes
no
SystemName
varchar
no
32
yes
yes
no
Side
char
no
1
yes
yes
yes
TrapSeverity
int
no
4
10
0
no
(n/a)
(n/a)
SystemType
int
no
4
10
0
no
(n/a)
(n/a)
MsgText
varchar
no
255
no
yes
no
10
0
FixedLen
NullInSource
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-27
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
AlarmID
Primary key, value that uniquely identifies the Alarm object.
ObjectName
The Listener ObjectName associated with the Alarm.
OwnerHandle
The Handle in the InstanceNodes table which identifies the Instance Node associated
with this Alarm.
CustomerID
Customer ID.
ProductID
Product ID.
Excluded
1 - Alarm is Excluded
0 - Alarm is not Excluded.
State
State value of the Alarm. The range of State values are shown in Alarm State
Transition Diagram.
CreationTime
Time the Alarm event condition was raised.
ReceivedTime
Time the database Alarm object was created.
CategoryName
Category Name from the EMS message.
Class
Class from the EMS message.
DMPID
DMP ID from the EMS message.
MsgID
EMS Message ID.
ProcessName
Name of the process that generated the Alarm/Event.
SystemName
System name of the machine that generated the Alarm/Event.
Side
Duplexed side (typically 'A' or 'B') that generated the Alarm/Event.
TrapSeverity
SNMP Trap Severity from the EMS message.
SystemType
System Type from the EMS message.
MsgText
Message text.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-28
Appendix A
Alarms Database Schema
Detailed Schema Description
ObjectState Table
Description
The ObjectState table is used by LGMapper only and maintains a map of Listener ObjectName to the
particular Alarm object (AlarmID) currently associated with it. This table allows the AlarmTracker user
to more easily query the current object state in its Object State View.
Column_name
Type
Prec
Scale
Nullable
Trim
Trailing
Blanks
FixedLen
NullInSource
no
yes
no
Computed
Length
ObjectName (PK) varchar
no
255
CustomerID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
ProductID (PK)
int
no
4
10
0
no
(n/a)
(n/a)
AlarmID
int
no
4
10
0
no
(n/a)
(n/a)
Column_name
Column Description
ObjectName
The Listener ObjectName associated with the Alarm.
CustomerID
Customer ID.
ProductID
Product ID.
AlarmID
Primary key, value that uniquely identifies the Alarm object.
Fields
AlarmsSummaryHour Table
Description
The AlarmsSummaryHour table stores summary counts and statistics across all Customers. This table is
updated hourly. A thirty (30) day history of hourly records are maintained.
Column_name
Type
Trim
Trailing FixedLen
Computed Length Prec Scale Nullable Blanks NullInSource
CustomerID (PK)
int
no
4
Time (PK)
datetime no
8
NewAlarmCount
int
no
4
10
ClosedAlarmCount
int
no
4
UnassignedAlarms
int
no
AssignedAlarms
int
no
10
0
no
(n/a)
(n/a)
no
(n/a)
(n/a)
0
no
(n/a)
(n/a)
10
0
no
(n/a)
(n/a)
4
10
0
no
(n/a)
(n/a)
4
10
0
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-29
Appendix A
Detailed Schema Description
Column_name
Type
Trim
Trailing FixedLen
Computed Length Prec Scale Nullable Blanks NullInSource
ExcludedAlarms
int
no
4
10
0
no
(n/a)
(n/a)
NewAppErrCount
int
no
4
10
0
no
(n/a)
(n/a)
ClosedAppErrCount int
no
4
10
0
no
(n/a)
(n/a)
UnassignedAppErrs int
no
4
10
0
no
(n/a)
(n/a)
AssignedAppErrs
int
no
4
10
0
no
(n/a)
(n/a)
ExcludedAppErrs
int
no
4
10
0
no
(n/a)
(n/a)
AlarmEventCount
int
no
4
10
0
no
(n/a)
(n/a)
AppErrCount
int
no
4
10
0
no
(n/a)
(n/a)
SimpleCount
int
no
4
10
0
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-30
Alarms Database Schema
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
CustomerID
Customer ID.
Time
Time of update.
NewAlarmCount
The number of new Alarms that were raised during this hour.
ClosedAlarmCount
The number of Alarms that were closed (either from a device-generated Clear or a
user-generated Clear Event).
UnassignedAlarms
The number of unassigned Alarm objects that existed at the time of the update.
AssignedAlarms
The number of open and assigned Alarm objects that existed at the time of the
update.
ExcludedAlarms
The number of open and excluded Alarm objects that existed at the time of the
update.
NewAppErrCount
The number of new Application Error objects that were created during this hour.
ClosedAppErrCount
The number of Application Error objects that were closed by user-generated Clear
Events.
UnassignedAppErrs The number of unassigned Application Error objects that existed at the time of the
update.
AssignedAppErrs
The number of open and assigned Application Error objects that existed at the time
of the update.
ExcludedAppErrs
The number of open and excluded Application Error objects that existed at the time
of the update.
AlarmEventCount
The total number of Alarm object Events processed during the hour. This count
does not include Simple Events or Application Error Events.
AppErrCount
The total number of Application Error Events processed during the hour.
SimpleCount
The total number of Simple Events processed during the hour.
AlarmsSummaryDay Table
Description
The AlarmsSummaryDay stores daily summary counts and statistics generated from the
AlarmsSummaryHour table across all Customers. This table is updated daily, it is not purged.
Column_name
Type
Computed Length Prec
Trim
FixedLen
Trailing NullIn
Scale Nullable Blanks Source
CustomerID (PK)
int
no
4
0
Time (PK)
datetime no
8
Samples
int
no
4
10
NewAlarmCount
int
no
4
10
10
no
(n/a)
(n/a)
no
(n/a)
(n/a)
0
no
(n/a)
(n/a)
0
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-31
Appendix A
Detailed Schema Description
Column_name
Type
Computed Length Prec
Trim
FixedLen
Trailing NullIn
Scale Nullable Blanks Source
ClosedAlarmCount
int
no
4
10
0
UnassignedAlarmsAvg float
no
8
53
AssignedAlarmsAvg float
no
8
ExcludedAlarmsAvg float
no
NewAppErrCount
ClosedAppErrCount int
no
(n/a)
NULL no
(n/a)
(n/a)
53
NULL no
(n/a)
(n/a)
8
53
NULL no
(n/a)
(n/a)
int
no
4
10
0
no
(n/a)
no
4
10
0
no
(n/a)
(n/a)
UnassignedAppErrsAvg float no
8
53
NULL no
(n/a)
(n/a)
AssignedAppErrsAvg float
no
8
53
NULL no
(n/a)
(n/a)
ExcludedAppErrsAvg float
no
8
53
NULL no
(n/a)
(n/a)
AlarmEventCount
int
no
4
10
0
no
(n/a)
(n/a)
AppErrCount
int
no
4
10
0
no
(n/a)
(n/a)
SimpleCount
int
no
4
10
0
no
(n/a)
(n/a)
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-32
(n/a)
(n/a)
Alarms Database Schema
Appendix A
Alarms Database Schema
Detailed Schema Description
Fields
Column_name
Column Description
CustomerID
Customer ID.
Time
Time of update.
Samples
The number of samples from the AlarmsSummaryHour table that rolled up into
this entry.
If the LGMapper/LGArchiver is running continuously over the 24-hour period,
this value will be 24.
If the Server is down for a period, this value may be less than 24.
NewAlarmCount
The number of new Alarms that were raised during this day.
ClosedAlarmCount
The number of Alarms that were closed (either from a device-generated Clear
or a user-generated Clear Event).
UnassignedAlarmsAvg
The average number of unassigned Alarm objects over the hourly samples for
that day.
AssignedAlarmsAvg
The average number of open and assigned Alarm objects over the hourly
samples for that day.
ExcludedAlarmsAvg
The average number of open and excluded Alarm objects over the hourly
samples for that day.
NewAppErrCount
The number of new Application Error objects that were created during this day.
ClosedAppErrCount
The number of Application Error objects closed by user-generated Clear
Events.
UnassignedAppErrsAvg The average number of unassigned Application Error objects over the hourly
samples for that day.
AssignedAppErrsAvg
The average number of open and assigned Application Error objects over the
hourly samples for that day.
ExcludedAppErrsAvg
The average number of open and excluded Application Error objects over the
hourly samples for that day.
AlarmEventCount
The total number of Alarm object Events processed during the day. This count
does not include Simple Events or Application Error Events.
AppErrCount
The total number of Application Error Events processed during the day.
SimpleCount
The total number of Simple Events processed during the day.
The five (5) count fields (NewAlarmCount, ClosedAlarmCount, AlarmEventCount, AppErrCount and
SimpleCount) are actually pro-rated values over a 24 hour period based on the number of Samples
recorded. The value stored in one of these fields represents the sum of the hourly count values times the
24 hour pro-rated factor.
e.g.: NewAlarmCount =
(24 / Samples) * SUM (AlarmsSummaryHour.NewAlarmCount)
Note
If Samples = 24, the pro-rated factor is one.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-33
Appendix A
Alarms Database Schema
Detailed Schema Description
Filters Table
Description
The Filters table stores the server-side filter settings for customer filtering and product filtering.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
FilterField
int
no
4
10
0
no
(n/a)
(n/a)
Criterion
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
Fields
Column_name Column Description
FilterField
A value of 1 indicates that this is a Customer filter.
A value of 2 indicates that this is a Product filter.
Criterion
If FilterField = 1, this value is the CustomerID to be filtered out.
If FilterField = 2, this value is the ProductID to be filtered out.
ModifiedTime
Time this record was last updated.
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-34
FixedLen
NullInSource
Appendix A
Alarms Database Schema
How Handles Are Used
FiltersProductSpecific Table
Description
The FiltersProductSpecific table stores the server-side filter settings that are product specific. These
include Class-level and MsgID-level filters.
Column_name
Type
Computed
Length
Prec
Scale
Nullable
Trim
Trailing
Blanks
ProductID
int
no
4
10
0
no
(n/a)
(n/a)
FilterField
int
no
4
10
0
no
(n/a)
(n/a)
Criterion
int
no
4
10
0
no
(n/a)
(n/a)
ModifiedTime
datetime
no
8
no
(n/a)
(n/a)
FixedLen
NullInSource
Fields
Column_name Column Description
ProductID
Product ID.
FilterField
A value of 3 indicates that this is a Class filter.
A value of 4 indicates that this is a MsgID filter.
Criterion
If FilterField = 3, this value is the Class to be filtered out.
If FilterField = 4, this value is the MsgID to be filtered out.
ModifiedTime
Time this record was last updated.
How Handles Are Used
A Handle is a 32-bit value that uniquely identifies a Node in the object hierarchy. Although there are no
formal restrictions on the value of the Handle (other than it be unique across all Nodes), we have decided
to use certain bits to define characteristics about the Node. This section describes how those bit fields
are used.
The following table shows the layout of the 32 bits used in the Handle.
Bits
31
30
29
...
ProductID
24
23
...
14
Customer ID
13
...
0
Object ID
The following table describes the use of the 32 bits used in the Handle
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-35
Appendix A
Alarms Database Schema
How Handles Are Used
Bits
Description
0-13
Used to specify an arbitrary Object ID. This allows for 214-1 = 16,383 objects for each
ProductID.
14-23
Reserved for a Customer ID. This allows for 210=11,024 customers. This Customer ID matches
that used in the Alarms Database. By convention, the Object ID for the Customer Node is 0.
24-29
Reserved for a ProductID. This allows for 26-1 = 63 ProductIDs. This ProductID matches that
used in the Alarms Database. By convention, the ProductID for the Customer Node is 0.
ProductID 1 is assigned to ICM.
30
Reserved. This bit will always be set by applications using these Handles. The root node of a
hierarchy will have only this bit set.
31
The user bit. Use to create new Nodes in your Client code. That is, you are free to create new
LGNode objects and set that bit and not be concerned that the Server may create Node objects
that clash with any that you create.
By convention the Root Node labeled as “Customers” has a Handle = 0x40000000.
As an example of some other Handles, consider a customer with Customer ID = 38. The Customer Node
for this customer is 0x40098000 (0100 0011 0000 1001 1000 0000 0000 0000). The Object IDs and
ProductIDs will be different for all other child Nodes, but bits 14-23 will be the same, and bit 30 will
always be set.
The following macros in Grid2Common.h may be useful when manipulating Handles.
#define DP_CUSTOMERSHANDLE 0x40000000 // Customers RootNode
#define DPM_DPRESERVED 0xff000000
#define DPM_PRODUCTVALUES 0x3f000000 // ProductIDs
#define DPM_CUSTVALUES 0x00ffc000 // CustomerIDs
#define DPM_OBJECTVALUES 0x00003fff // Object values
#define CUSTIDFROMHANDLE(arg) (((arg) & DPM_CUSTVALUES) >> 14)
#define PRODUCTIDFROMHANDLE(arg) ((arg) & DPM_PRODUCTVALUES) >> 24)
#define CUSTHANDLEFROMHANDLE(arg) ((arg) & (DP_CUSTOMERSHANDLE | DPM_CUSTVALUES))
#define UNMAPPEDOBJECTSFROMHANDLE(arg) ((arg) & (DP_CUSTOMERSHANDLE |
DPM_CUSTVALUES)) + 1)
#define ISCUSTOMERHANDLE(arg) \
((((arg) == ((arg) & (DP_CUSTOMERSHANDLE | DPM_CUSTVALUES))) && \
((arg) & DPM_CUSTVALUES)) ? TRUE : FALSE)
#define ISPRODUCTHANDLE(arg) \
((((arg) == ((arg) & (DP_CUSTOMERSHANDLE | DPM_PRODUCTVALUES | DPM_CUSTVALUES)))
\
&& ((arg) & DPM_PRODUCTVALUES)) ? TRUE : FALSE)
#define MAKELGHANDLE(prodID, custID, objID)\
(DP_CUSTOMERSHANDLE | ((prodID) << 24) | ((custID) << 14) | (objID))
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-36
Appendix A
Alarms Database Schema
Alarm State Transition Diagram
Alarm State Transition Diagram
Figure A-2 indicates the possible state transition values for an Alarm object. It shows how an Alarm
object is created and the different state transitions that it can make.
Alarm State Transition Model
Clear
User Clear
Clear
User Clear
Assign
Raise
svDown
asUnassigned
svDown
asUnassigned
Unassigned
svUp
asUnassigned
svUp
asNoAlarms
Raise
Unassigned
Clear
Include
Include
svDown
asExcluded
Exclude
svUp
asExcluded
Raise
63919
Figure A-2
Red (solid) transition arrows indicate state changes as a result of customer-generated Events.
Blue (dashed) transition arrows indicate state changes as a result of customer support-generated Events
(such as Clear, Assign, Exclude).
An Alarm is created when a Listener Raise Event is received at the LGMapper. The initial state of an
Alarm object is Down and Unassigned. Figure A-2, shows two mnemonics that indicate the State
(corresponding to the Alarms.State and Events.State field values) of the Alarms and its Assignment
Status (corresponding to the Alarms.Assigned and Events.Assigned field value).
The following mnemonics for the State values are defined:
svUp
= 0,
svApplicationError
= 1,
svPartialImpaired
= 2,
svDown
= 3,
The following mnemonics for the Assigned values are defined:
asNoAlarms
=0
asUnused
=1
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-37
Appendix A
Alarm State Transition Diagram
asExcluded
=2
asAssigned
=3
asAssignedTimeout
=4
asUnassignedAppErr
=5
asUnassigned
=6
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
A-38
Alarms Database Schema
INDEX
A
B
Access Permissions, LGMapper, Modifying
Active Connections, LGMapperNM Menu
adding a new customer to Listener
Alarm Object
Backwards Compatibility Considerations
3-13
Beeper.flt Modifications
5-4
2-4
2-13
1-10
Alarms Database
11-1
C
1-9
Alarms Database, disk space requirements
10-2
Clients Tab, LGMapper Configuration, Enable Server
Alarms Database, Re-indexing
6-1
Clients Tab, LGMapper Configuration, Reason
Alarms Database Maintenance
6-1
Clients Tab, LGMapper Configuration Dialog
Alarms Database Maintenance Overview
Alarms Database Map
6-1
Cloning a Database
A-3
Alarms DB
Compatibility Considerations, Grid
Compatibility Considerations, Listener
A-29
compression
A-21
AlarmTracker Client
A-1
configuring Listener
1-1, 1-6, 1-7, 1-8
duplex settings
AlarmTracker client, configuring on Windows XP
AlarmTracker Client, Installation overview
8-1
AlarmTracker Clients, compatibility considerations
Applications, LGMapper2
3-28
Archived Alarms Database
Archived Alarms DB
1-6, 1-9
1-6
Archiver Database Tab, LGArchiver Configuration
Dialog 4-10
A-11
audience for this guide
ii-xi
8-5
A-1
2-11
Connected Clients, LGMapperNM Menu
Creating Databases
6-1
Creation Failure, Database
6-1
3-32
Creation Failures, Local Account
Creation Failures, User Groups
2-14
CSFS
1-2
Current Users
5-4
7-8
Creating Databases Manually
CSFC
11-1
2-1
Creating a New Database
11-2
11-2
4-8
Configuration Tables, Table Classes
Alarms Tables, Table Classes
11-2
11-1
Compatibility Considerations, LGMapper Server
A-31
AlarmsSummaryHour Table
Attributes Table
11-1
Compatibility Considerations, AlarmTracker Clients
1-10
AlarmsSummaryDay Table
Alarms Table
4-1
6-1
Compatibility Considerations
1-5
Alarms History
4-4
7-8
Cloning Databases
Alarms Database Tab, LGMapper Configuration
Dialog 4-6
4-5
3-28
3-28
4-1
customer
adding to Listener
2-13
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-1
Index
deleting in Listener
Enable Thresholds setting
2-14
editing configuratinon in Listener
CustomerLog Max setting
Customers Table
2-13
Enabling the Exclude Node Feature
2-13
Enabling the LGMapper Server
2-12
9-1
4-2
End of Message Sequence alarm message format
A-17
Customer Support Forwarding Service
Customer Voice Portal (CVP)
Ensuring LGM Administrators, LGM Readers, and LGM
Users Were Created 3-31
1-2, 2-14
1-9
Error Reporting
1-2
Event Log Message, LGArchiverNM
D
Event Log Messages
Database, Cloning
Events Table
3-32
Databases, Remote Monitoring Suite, SQL
Database Schema, Alarms Database
Date alarm message format
A-25
9-1
Exclude Node Feature, enabling
9-1
Exclude Node Feature, Overview
2-14
9-1
Exit Service, LGMapperNM Menu
3-32
1-2
5-4
F
deleting a customer in Listener
Deployment Considerations
Deployment Issues
2-14
Failure, Creation, Database
1-12
Failures, Creation, Local Account
2-15
Detailed Schema Description, Alarms Database
Disabling the LGMapper Server
Distributed Architecture
Failures, Creation, User Groups
Fault Tolerant Considerations
10-2
FiltersProductSpecific Table
Filters Table
4-1
1-1
3-32
3-28
3-28
1-12
A-35
A-34
Filter Tables, Table Classes
1-12
Distributed Diagnostics and Services Network
domain setting
A-4
4-2
Disk Space Requirements for Alarms Database
Displaying Current Users
3-32
Failure, Registry Settings, DCOMCnfg
10-1
Description alarm message format
A-2
First Optional Argument alarm message format
2-11
Drive Letter Other Side setting
Drive property, Listener
2-13
G
2-3
general configuring, Listener
1-2, 1-3
DTP default setting
2-10
General Tab, LGMapper2 Properties
1-3
duplex configuration settings
Grid, compatibility considerations
2-11
3-9
11-1
H
E
editing customer configuration in Listener
EMS
2-13
Handles, how used
A-35
Hardware Recommendations
1-3
1-13
Hide Tray Icon, LGArchiverNM Menu
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-2
5-8
1-1
DDSN Transfer Process
DTP
5-5
Exclude Node Feature
3-27
A-1
DCOMCnfg Registry Settings Failure
DDSN
5-8
Event Log Messages, LGArchiver Node Manager
7-8
Database Creation Failure
2-15
5-8
2-14
Index
Hide Tray Icon, LGMapperNM Menu
How to Implement IWantHelp
HyperlinkInfo Table
LGArchiver Configuration Dialog, Log Files Tab
5-4
LGArchiver Database - accessing
12-2
1-11
LGArchiver - Exit, LGArchiverNM Menu
A-14
LGArchiver - Installation Checklist
LGArchiverNM
I
ICM
1-5, 5-1, 5-5
LGArchiverNM, Menu Options
Icon, Hide Tray, LGArchiverNM Menu
Icon, Hide Tray, LGMapperNM Menu
Icon, LGARchiverNM Task Bar
Icon, LGMapperNM Task Bar
LGArchiverNM, Starting
5-4
3-25
Implementing the IWantHelp Interface
12-1
3-27
Issues, deployment
LGArchiverNM Menu, LGArchiver - Start
5-8
LGArchiverNM Menu, LGArchiver - Stop
5-8
5-7
5-7
5-5
LGArchiver Node Manager, Menu Options
IWantHelp Interface, Overview
12-2
LGArchiver Properties
12-1
LGArchiver Server
L
Language property, Listener
1-8
5-8
LGArchiver - Stop, LGArchiverNM Menu
5-8
LGMapper
3-28
LGMapper2 Properties - General Tab
4-10
LGMapper - Backwards Compatibility
4-10
LGMapperCnfg Tool
4-1
LGArchiver Configuration Dialog, Archiver Database
Tab 4-10
LGArchiver Configuration Dialog, Listener Tab
4-12
3-31
1-1, 1-5, 1-6, 3-1
LGMapper2 Applications
1-6
5-7
1-6, 7-1
LGM Administrators, Ensuring Creation of
1-11
LGArchiverCnfg Tool, Overview
3-26
LGArchiver - Start, LGArchiverNM Menu
LGCnfg Tool
3-19
1-1, 1-6, 3-1
LGArchiver Alarms Database
5-7
LGArchiver Up Since, LGArchiverNM Menu
2-3
Launch Permissions, LGMapper, Modifying
5-8
LGArchiver Node Manager, Starting on Windows 2000
and Windows 2003 5-5
12-1
IWantHelp Interface, Interface Definition
5-7
5-7
LGArchiver Node Manager, Event Log Messages
12-2
IWantHelp Interface, implementation
LGArchiverCnfg Tools
5-7
LGArchiverNM Menu, Listener Messages Processed
LGArchiver Node Manager
10-1
LGArchiverCnfg Tool
5-8
5-8
LGARchiverNM Task Bar Icon
12-2
12-2
LGArchiverCnfg
5-5
LGArchiverNM Menu, LGArchiver - Exit
LGArchiverNM Menu, Show Statistics
A-17
IWantHelp, How to implement
LGArchiver
5-5
LGArchiverNM Menu, Open LGArchiverCnf
Interface Definition, IWantHelp Interface
IWantHelp.idl
8-1
1-9, 1-10
InstanceNodes Table
5-5
LGArchiverNM Menu, LGArchiver Up Since
2-1, 2-3
Installing the AlarmTracker Client, Overview
Instance Nodes
5-7
LGArchiverNM Menu, Hide Tray Icon
5-3
Installation Folder Sub-directories
5-8
LGArchiverNM, Starting, Windows 2000
5-7
Identity Tab, LGMapper2 Properties
installing Listener
LGArchiverNM, Overview
5-8
5-8
3-1
LGArchiverNM, Event Log Messages
1-9
4-13
3-9
3-1
4-1
LGMapperCnfg Tool, Overview
4-1
LGMapper Configuration Dialog, Alarms Database
Tab 4-6
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-3
Index
LGMapper Configuration Dialog, Clients Tab
LGMapper Configuration Dialog, Listener Tab
general
LGMapper - Installation Procedure
2-14
duplex configuration settings
3-1
2-11
editing customer configuration
3-3
properties settings
LGMapperNM, Menu Options
2-13
2-10
deleting a customer
3-27
1-5, 5-1
LGMapperNM, Starting
1-1, 1-2, 1-3, 1-5, 1-6, 2-1
configuring
3-1
LGMapper - Installation Checklist
3-31
2-13
adding new customer
5-4
LGMapper Installation, Troubleshooting
LGMapperNM
Listener
4-9
5-4
LGMapper - Enable, LGMapperNM Menu
LGMapper - Installation
Listen Actives setting
4-8
LGMapper Configuration Dialog, Log Files Tab
LGMapper - Disable, LGMapperNM Menu
LGM Users, Ensuring Creation of
4-1
2-13
2-3
Listener, compatibility considerations
5-3
Listener - Configuration
5-1
2-4
LGMapperNM, Starting on Windows 2000 and Windows
2003 5-1
Listener - Customer Configuration
LGMapperNM Menu, Active Connections
Listener Events
5-4
LGMapperNM Menu, Connected Clients
LGMapperNM Menu, Exit Service
5-4
LGMapperNM Menu, Hide Tray Icon
LGMapperNM Menu, LGMapper - Enable
LGMapperNM Menu, LGMapper - Stop
5-4
LGMapperNM Menu, LGMapper Up Since
Listener Tab, LGMapper Configuration Dialog
Local Account, Creation Failure
LGMapperNM Menu, Open LGMapperCnfg
LGMapperNM Menu, Show Statistics
5-4
Local Account or User Groups Creation Failures
Log Entries
5-3
5-1
5-3
M
5-1
LGMapper Node Manager, Starting, Windows 2000
LGMapper Server, compatibility considerations
5-1
11-2
4-2
Manually Creating Databases
Map, Alarms Database Schema
6-1
A-3
MDAC Requirement, AlarmTracker Client
4-2
Menu Options, LGArchiverNM
5-4
Menu Options, LGArchiver Node Manager
LGMapper - Stop, LGMapperNM Menu
5-4
Menu Options, LGMapperNM
LGM Readers, Ensuring Creation of
5-4
3-31
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-4
5-5
5-7
5-3
Menu Options, LGMapper Node Manager
Messages, Event Log
8-1
5-7
LGMapper - Start, LGMapperNM Menu
LGMapper Up Since, LGMapperNM Menu
4-8
3-28
2-14
Log Files Tab, LGMapper Configuration Dialog
5-3
LGMapper Node Manager, Starting
4-12
3-10
Log Files Tab, LGArchiver Configuration Dialog
5-1
LGMapper Node Manager, Menu Options
5-4
3-28
Location Tab, LGMapper2 Properties
5-3
LGMapper Node Manager (LGMapperNM)
5-7
Local Account Creation Verification, Windows 2000
Procedure 3-29
5-4
LGMapperNM Menu, Listener Messages Processed
LGMapper Server, Enabling
2-3
Listener Tab, LGArchiver Configuration Dialog
5-4
5-4
LGMapper Server, Disabling
1-10
Listener Messages Processed, LGMapperNM Menu
5-4
LGMapperNM Menu, LGMapper - Start
LGMapperNM Task Bar Icon
2-4
Listener Messages Processed, LGArchiverNM Menu
5-4
LGMapperNM Menu, LGMapper - Disable
LGMapperNM Overview
2-13
Listener - Duplex Configuration Settings
Listener - Installation
5-4
11-1
5-3
4-13
4-9
Index
Messages, LGArchiver Node Manager, Event Log
Modifying Access Permissions, LGMapper
3-13
Modifying Launch Permissions, LGMapper
3-19
Modifying the OID Node Hierarchy and Rules
5-8
7-9
R
RAS
1-1, 1-2, 1-3
Registry Settings, DCOMCnfg, Failure
Re-Indexing the Alarms Database
Remote Access Service
N
6-1
1-2
Remote Monitoring Suite
1-1, 1-2, 1-4
Network Considerations
1-7
Remote Monitoring Suite components
New Database, Creating
7-8
RMS
Node Manager property, Listener
Note About Time
1-9
Rules, Modifying
A-4
Number of Optional Arguments Following alarm message
format 2-14
1-4
1-1
Rule Mapping
2-3
3-32
Rules Table
7-9
A-15
S
O
Security, SQL Server
Objects Table
A-7
ObjectState Table
Security Tab, LGMapper2 Properties
A-29
OIDNodeAttributes Table
Serial Alarm Feed
A-13
OID Node Hierarchy, Modifying
OID Node Hierarchy and Rules
OIDNodes Table
6-2
serial alarm feed
7-9
SERIALFD
A-9
2-14
2-14
2-14
Show Statistics, LGArchiverNM Menu
Open LGArchiverCnfg, LGArchiverNM Menu
Open LGMapperCnfg, LGMapperNM Menu
organization of this guide
2-14
serial alarm feed message formats
7-9
3-11
ii-xi
5-7
5-3
5-7
Show Statistics, LGMapperNM Menu
5-3
SideA event timeout (minutes) setting
2-13
SideBevent timeout (minutes) setting
Side property, Listener
2-13
2-3
SimpleObjectHoldTime Minutes setting
P
Simples Table
password setting
2-11
A-27
Specification, system
Permissions, Access, LGMapper
3-13
SQL Server
Permissions, Launch, LGMapper
3-19
SQL Server Databases
Post-Installation Inspection Checklist
Process Name alarm message format
ProductInfo Table
A-6
2-14
10-1
1-10
3-27
SQL Server Requirements
SQL Server Security
3-2
6-2
Starting the LGArchiverNM
properties
Listener
3-27
5-5
Starting the LGMapper Node Manager
2-3
Properties, LGArchiver
2-12
5-1
Summary Statistics Tables, Table Classes
3-26
SysemNameOtherSide setting
2-11
System Name alarm message format
System Specification
A-2
2-14
10-1
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-5
Index
System Type alarm message format
2-14
U
Upgrading Listener, guidelines
T
Uptime Table
Table, Alarms
Table, AlarmsSummaryDay
A-11
Table, Customers
A-17
Table, Filters
A-34
Table, HyperlinkInfo
A-14
Table, InstanceNodes
A-17
Table, Rules
A-15
A-27
Table, Uptime
A-20
Table, VersionInfo
Table Classes
A-4
A-1
Tables, Alarms
A-1
Tables, Configuration
Tables, Filter
A-13
A-6
Table, Simples
A-1
A-2
Tables, Summary Statistics
A-2
ThresholdIntervalMinutes setting
ThresholdLimit setting
Time, note about
2-12
2-12
A-4
Time alarm message format
2-14
Trap Number alarm message format
2-14
Trap Severity alarm message format
2-14
Troubleshooting the LGMapper Installation
3-27
Cisco Remote Monitoring Administration Guide, Release 2.1(0)
IN-6
A-4
Windows Remote Access Server
A-9
Table, ProductInfo
4-1
W
A-29
Table, OIDNodeAttributes
Table, OIDNodes
2-12
2-11
VersionInfo Table
A-35
A-7
Table, ObjectState
3-28
V
Table, FiltersProductSpecific
Table, Objects
username setting
A-29
Users, Current
Table, Attributes
A-25
User Interface Settings
A-31
Table, AlarmsSummaryHour
Table, Events
A-20
User Groups, Creation Failures
A-21
2-2
1-1