Download - CA eHealth Integration for Nortel Preside User Guide · Nortel Preside Overview ... data that you need to monitor alarms and outages, generate accounting and billing records, and

CA® eHealth®

Integration for Nortel Preside User Guide r6.1

This documentation and any related computer software help programs (hereinafter referred to as the “Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties.

Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the documentation for their own internal use, and may make one copy of the related software as reasonably required for back-up and disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the product are permitted to have access to such copies.

The right to print copies of the documentation and to make a copy of the related software is limited to the period during which the applicable license for the Product remains in full force and effect. Should the license terminate for any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.

The use of any product referenced in the Documentation is governed by the end user’s applicable license agreement.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Copyright © 2008 CA. All rights reserved.

CA Product References This document references the following CA products:

CA eHealth® (eHealth)

CA eHealth® Integration for Nortel Preside (eHealth - Nortel Preside)

Contact Technical Support For online technical assistance and a complete list of locations, primary service hours, and telephone numbers, contact Technical Support at http://ca.com/support.

http://www.ca.com/support

http://www.ca.com/support

Contents

Chapter 1: Introducing the Integration 7 eHealth Overview.............................................................................. 7 Nortel Preside Overview........................................................................ 7

Multiservice Data Manager (MDM)........................................................... 8 Management Data Provider (MDP) .......................................................... 8 Features of MDP Data Collection ............................................................ 8

eHealth – Nortel Preside Overview .............................................................. 9 How eHealth – Nortel Preside Works ........................................................ 9 eHealth – Nortel Preside License ........................................................... 12 Supported MDP Passport Devices and eHealth Elements ..................................... 12 Statistics Collected from Your MDP System ................................................. 12

Chapter 2: Configuring Nortel Devices 15 How to Configure Nortel Devices............................................................... 15 Nortel System Requirements .................................................................. 16

How to Prepare the MDM System for the Integration ........................................ 16 How to Prepare the MDP System for the Integration......................................... 17

Passport Statistics and Accounting Collection ................................................... 17 Passport Settings for Statistics Data Collection.............................................. 18 Passport Settings for Accounting Data Collection ............................................ 18

Frame Relay and ATM Settings for Accounting Data Collection ................................... 20

Chapter 3: Setting Up the Integration 23 How to Set Up and Install the Integration ...................................................... 23 Setup Checklists.............................................................................. 24 eHealth System Setup Prerequisites ........................................................... 24

Telnet and FTP, Sun/Open SSH Access ..................................................... 24 Required eHealth Installation Information .................................................. 24 Extract Configuration Information from the MDM Database .................................. 25 How Statistics Data Is Collected and Imported .............................................. 25

eHealth – Nortel Preside System Setup Prerequisites............................................ 26 eHealth – Nortel Preside Setup Program........................................................ 27 Run the Setup Program ....................................................................... 27

Change MDM and MDP Settings ............................................................ 28 Change eHealth Settings .................................................................. 29 eHealth Import Polling Interval ............................................................ 30

Contents 5

6 Integration for Nortel Preside User Guide

How to Add a License ......................................................................... 30

Chapter 4: Configuring Nortel Preside Elements in eHealth 31 Configuration Prerequisites.................................................................... 31 How the Configuration Process Works .......................................................... 32 Options for Modifying the Poller Configuration .................................................. 33

nhConfig Command – Updates the Poller Configuration ...................................... 33 Tips for Using nhConfig Arguments......................................................... 35

Element Configuration Tasks .................................................................. 36 Add or Reconfigure Elements .............................................................. 36 Group, Modify, or Exclude Elements........................................................ 37 Create and Schedule a Configuration Job ................................................... 39

Files Used to Configure Elements .............................................................. 40 Element Files................................................................................. 41

Element File Fields ........................................................................ 42 Element Definition Examples .............................................................. 48

Rules Files ................................................................................... 49 Rules File Format ......................................................................... 49 How to Use Rules Files .................................................................... 53

Data Files .................................................................................... 55 Data File Format .......................................................................... 55 Data File Examples........................................................................ 56

Types of eHealth Reports That You Can Run .................................................... 58

Appendix A: Setup Checklists 59 Preside MDM System Checklist ................................................................ 59 Preside MDP System Checklist................................................................. 60 eHealth System Checklist ..................................................................... 62

Index 63

Chapter 1: Introducing the Integration

To understand how eHealth – Nortel Preside works, you must understand the distinctions among the eHealth, Nortel Preside, and eHealth – Nortel Preside products.

This section contains the following topics:

eHealth Overview (see page 7) Nortel Preside Overview (see page 7) eHealth – Nortel Preside Overview (see page 9)

eHealth Overview eHealth does the following:

Discovers devices in your infrastructure using Simple Network Management Protocol (SNMP)

Frequently polls statistics collected by each device’s Management Information Base (MIB)

Collects information from the Nortel Preside and stores it in a database where it is available for reporting.

You can then generate eHealth reports on the behavior of thousands of elements in real time or generate reports on historical information. You generate these reports from the eHealth console or from the eHealth Web interface. You can run automatic, scheduled reports, create your own custom reports, view live data, or perform on-demand queries.

Note: For more information about running reports, see the eHealth Reports User and Administration Guide.

Nortel Preside Overview Nortel Preside consists of two components: the Nortel Preside Multiservice Data Manager (MDM) and the Nortel Preside Management Data Provider (MDP). The MDM element management system and the MDP data collection tool help you manage the performance and configuration of Nortel data devices and switches in your Nortel Network.

Introducing the Integration 7

Nortel Preside Overview

Multiservice Data Manager (MDM)

The Preside Multiservice Data Manager (MDM) is the element management system (EMS) for the Nortel Passport multiservice switch product family (Passport 7000 and 15000 series) and for other Nortel data devices. You configure these devices through Preside Network Configuration System (NCS), an internet protocol (IP) configuration tool.

Management Data Provider (MDP)

The Preside Management Data Provider (MDP) is an MDM value-added tool that you use to collect accounting and statistics data. The MDP and various Preside Performance Reporting tools let you—the service provider—collect the data that you need to monitor alarms and outages, generate accounting and billing records, and deliver trending information. The MDP is the accounting and statistics engine for Passport.

You use the MDP for bulk data collection and processing. The use of bulk data collection reduces performance degradation that results from constant metric polling. The MDP collects metric data from switches by using the bulk File Transfer Protocol (FTP, Sun/Open SSH) utility. It correlates the data to provide historical accounting and statistical records. You can customize the content and format of the records for use by external applications for billing, network management, and planning and analysis.

Features of MDP Data Collection

In addition to reducing network traffic and the time that it takes to collect data, MDP’s bulk statistics data collection provides these other features:

The MDP stores data on an internal disk to prevent continuous drain on Passport resources.

Spooling of data to the Passport internal disk helps ensure that information is generated and maintained even if connectivity to the switch is interrupted.

Redundant MDP hosts help ensure that performance, accounting, and billing records are maintained even if an outage to one host occurs.

The Preside MDP provides the interface between eHealth and the integration module (IM).


eHealth – Nortel Preside Overview

eHealth – Nortel Preside Overview The eHealth - Nortel Preside integration module (eHealth - Nortel Preside) lets you collect configuration information and statistics data from your Nortel devices and use eHealth to generate reports on this information.

How eHealth – Nortel Preside Works

eHealth – Nortel Preside does the following:

Extracts configuration information

eHealth uses the MDM’s embedded programming interface (EPI), Nortel’s application programming interface (API), to extract configuration information from the NRS that resides on the MDM system. (EPIs provide support for application programming interfaces (APIs) and numerous MDM and MDP utilities.) eHealth collects and analyzes data from elements (devices or resources) to generate reports.

Note: eHealth – Nortel Preside is designed to communicate with both the MDM and the MDP. If you are running only the MDM, you must install the MDP to use eHealth – Nortel Preside.

– The MDM maintains a database with configuration information for each network device from which it collects data, and stores this information in configuration data files.

– eHealth – Nortel Preside places a script on the MDM system which enables eHealth to import the elements within the MDM configuration that it supports through the EPI.

– Once the data has been transferred to the eHealth system, the import utility reads the configuration data and creates a DCI file, which stores the information as elements that represent your network devices.

– eHealth then imports the elements that it supports from the DCI file and stores them in the database, where they are available for reporting.



The following graphic illustrates the process by which information is extracted from the NRS and then imported to eHealth.

Collects statistics data

eHealth minimizes the impact on the managed network and MDP servers by importing bulk statistics, rather than polling the network devices directly by using SNMP.

When you use the MDM with the MDP to manage your network and you install eHealth – Nortel Preside, you can collect bulk statistics data from your Nortel Passport switches and run eHealth reports on this data.

– The MDP stores the data that it collects in Bulk Data Format (BDF) files, and stores the format of these files in Record Description Files (RDFs).

– eHealth – Nortel Preside, which resides on the eHealth system, enables the eHealth data collection and conversion utility to extract the BDF and RDF files from the MDP system by using the FTP, Sun/Open SSH utility.

– Each time the utility imports these files, it parses the RDFs and verifies the existence of required fields in the BDF files.

– The utility then converts the BDF files to Database Data Information (DDI) files that eHealth can import.



The following graphic illustrates this data collection process.

eHealth uses the statistics data and configuration information when you generate reports on your Passport elements. You can run eHealth reports on the network devices that you manage with the MDM and the MDP for the following technology types:

Asynchronous transfer mode (ATM)

Frame Relay

Router/Switch

More information:

Extract Configuration Information from the MDM Database (see page 25)



eHealth – Nortel Preside License

If you are using Nortel Preside MDM and MDP and you install eHealth on a system in your infrastructure, you can purchase and install an eHealth – Nortel Preside license.

This license lets you to do the following:

Extract configuration information for your Nortel Preside devices from the Network Reporting System (NRS) on your MDM system.

Collect accounting and statistics data from your Preside MDP system.

Use eHealth as your reporting tool.

Supported MDP Passport Devices and eHealth Elements

eHealth models the devices, from which eHealth – Nortel Preside collects statistics data, after various eHealth ATM, Frame Relay, and Router/Switch elements.

The following table lists the supported MDP Passport devices and the eHealth element types for each.

MDP Passport Device eHealth Element Type

ATM port statistics records ATM Ports

ATM PVPC, SPVP accounting records ATM Paths

ATM PVC, SPVC accounting records ATM Channels

Frame Relay accounting records Frame Relay

Aggregated switch statistics records Router/Switch

Logical processor Router CPU

Statistics Collected from Your MDP System

eHealth – Nortel Preside collects statistics and accounting information from your MDP system. The integration module enables eHealth to import this information from statistics and accounting records files.

eHealth – Nortel Preside imports the following network statistics for ATM Port elements:

Media speed

Media speed out



Available time

Discards in

Discards total

CLP1 discards total

CLP1 discards in

CLP1 cells total

CLP1 cells in

Cells in

Bytes in

Cells total

Bytes total

eHealth – Nortel Preside imports the following network statistics for ATM Path elements:

Media speed

Media speed out

Discards in

Discards out

CLP1 discards total

CLP1 discards in

CLP1 cells total

CLP1 cells in

Cells in

Bytes in

Cells out

Bytes out

eHealth – Nortel Preside imports the following network statistics for ATM PVC elements:

Media speed

Media speed out

Discards in

Discards out

CLP1 discards total




CLP1 discards in

CLP1 cells total

CLP1 cells in

Cells in

Bytes in

Cells out

Bytes out

eHealth – Nortel Preside imports the following network statistics for Router central processing unit (CPU) elements:

CPU utilization %

Memory free

Total number of buffers

Total number of buffers used

eHealth – Nortel Preside imports the following network statistics for Frame Relay elements:

Discards total

Discard eligible frames in

Discard eligible frames out

Discard eligible bytes in

Discard eligible bytes out

Number of frames in

Number of bytes in

Number of frames out

Number of bytes out

Note: During configuration extraction, eHealth determines if you are reporting on your Frame Relay elements in frames or segments. This user-configurable parameter is on each Passport switch (Mod/Vcs/Units Counted). The recommended setting is frames. (The default setting is segments.) If you set the value to segments, the frame values in your eHealth reports appear as segment counts.

Chapter 2: Configuring Nortel Devices


How to Configure Nortel Devices (see page 15) Nortel System Requirements (see page 16) Passport Statistics and Accounting Collection (see page 17) Frame Relay and ATM Settings for Accounting Data Collection (see page 20)

How to Configure Nortel Devices Before you install the eHealth – Nortel Preside integration module, you must configure your Nortel systems and modify settings to collect statistics and accounting data from your Passport devices. Make sure that you satisfy eHealth system requirements (see page 24) and use recommended settings for your MDM and MDP systems to help ensure optimal performance with eHealth – Nortel Preside.

To collect statistics and accounting data from your Passport devices, you must complete the following tasks:

Verify that you meet the MDM System Requirements for Nortel.

Verify that you meet the MDP System Requirements for Nortel.

Enable statistics collection by specifying the Passport Settings for Statistics Data Collection (see page 18).

Enable accounting collection by specifying the Passport Settings for Accounting Data Collection (see page 18) and the Frame Relay and ATM Settings for Accounting Data Collection (see page 20).

We strongly recommend that only qualified Nortel personnel or fully trained eHealth – Nortel Preside customers perform the Nortel configuration procedures.

Note: For more information about setting up the MDM and the MDP for use with the eHealth – Nortel Preside IM, see your Nortel Preside documentation. For questions about Nortel documentation or procedures, contact Nortel Networks Customer Support.

Configuring Nortel Devices 15

Nortel System Requirements

Nortel System Requirements You must install both the Nortel Preside MDM and the MDP on a dedicated UNIX system other than the eHealth system. The MDM and the MDP can reside on different systems.

Although you can use the MDM or the MDP independent of each other, eHealth – Nortel Preside is designed to collect data from Nortel network configurations that are running both the MDM and the MDP.

Note: For information about installing and configuring these products, see your Nortel Preside documentation.

How to Prepare the MDM System for the Integration

Before you can install the integration module, you must do the following for your MDM system:

Install the MagTCL package.

You must install the The MagTCL package on your MDM system.

Populate the NRS database.

You populate the NRS database to provide a static view of your network. The database is not populated by default. We recommend that you schedule times to repopulate the database to keep an accurate view of your network.

Because the NRS is a static view of your Nortel network, eHealth recognizes changes in the network only when the NRS is repopulated.

We recommend that you set up a cron job for repopulation on the MDM system. A cron job is a UNIX process that can be set up to run at a specified time each day. You should also schedule the nhConfig -dciCmd nhPresideGetCfg command on the eHealth system to run when the repopulation concludes.

Upload module service data to the NRS database.

You use the Passport NRS Populator tool to upload module service data through Configuration from the Passport network. The tool then reformats the data according to the Passport RDF files and stores it in the NRS database.

Before you start the NRS Populator tool, you must create a command file of modules to be uploaded.

Note: For more information about the Passport NRS Populator command file and command-line syntax, see your Nortel Preside documentation.


Passport Statistics and Accounting Collection

How to Prepare the MDP System for the Integration

For your MDP, you must do the following:

Install and configure the MDP Server

You must install the MDP server on a dedicated Solaris system and configure it according to Nortel specifications to make sure that the server communicates with the MDP module. The MDP must be set up and configured appropriately to collect and process Passport data.

Configure the MDP File Prober

The MDP File Prober initiates the transfer of Passport accounting and performance data. It can transfer data to the MDP host from a group of up to 60 Passport switches.

Before you configure the File Prober host, you must enable Passport statistics and accounting collection (see page 17) on your Passport switches.

You must configure the MDP File Prober to collect accounting BDF files from your Passport switches once every hour and to collect statistics BDF files once every 15 minutes. You can schedule the File Prober on the MPD system by using a cron job to call the File Prober at regularly scheduled intervals.

Note: For more information about creating a cron job to start the File Prober, see your Nortel Preside documentation.

Passport Statistics and Accounting Collection The procedures for setting up data collection for your Nortel Passport devices are completed on the switch.

Using the recommended settings to enable statistics and accounting collection helps ensure the following:

The MDP collects statistics or accounting information for each element that you want to include in eHealth reports.

The MDP collects at least the minimal set of statistics that eHealth needs to generate complete, accurate, and useful reports.

The MDP settings for the statistics collection period, bucket interval, and purging of old files are appropriate for use with eHealth.

Note: If you do not enable statistics and accounting collection prior to importing configuration information and statistics data, error messages appear in the Import Polling Status window of the eHealth console.



Passport Settings for Statistics Data Collection

Enable statistics collection for all Passport switches on which you plan to report on the following components:

AtmIf

LP

EM

Statistics collection on Passport switches is not enabled by default. If you do not enable statistics collection, eHealth cannot receive data for AtmIf, LP, or EM switches. When you do enable statistics collection, however, eHealth produces 15-minute data granularity for these devices.

To enable statistics data collection, your userId must have a minimum scope of device and a minimum impact of service. In addition, you must perform the procedure in provisioning mode.

At the end of procedures that you perform in provisioning mode, you are instructed to complete the configuration changes. This process consists of activating, confirming, and saving the changes.

Note: For more information about enabling statistics data collection, working in provisioning mode, and activating configuration changes, see your Nortel Passport documentation.

Passport Settings for Accounting Data Collection

Enable accounting data collection for all Passport switches on which you plan to report on the following components:

AtmIf

LP

EM

To collect accounting data from your Passport devices, you must configure the DCS to collect Passport accounting data on the node and configure time-of-day accounting (TODA).

DCS Configuration Requirements

Configuring the DCS to collect Passport accounting data must be performed in provisioning mode.

Note: For information about configuring the DCS and working in provisioning mode, see your Nortel Passport documentation.



TODA Configuration Requirements

Passport accounting records are most often collected on a time-of-day accounting (TODA) schedule. The default interval for accounting data collection is 12 hours. We recommend that you set time-of-day accounting to 1 hour intervals on all switches for which you plan to report on the following components:

VCC

VPC

DLCI

When you set up a TODA schedule, the following rules and restrictions apply:

Entries are limited to 24.

Times can be entered in any order.

Duplicate entries are not permitted.

The collection times are triggered in chronological order.

Entries cannot be less than one hour apart or more than 12 hours apart.

If entries are not made, each connection on the switch starts its own 12-hour accounting timer as time-of-day is not provisioned.

If any valid collection times are provisioned, the TODA method is used in place of the 12-hour accounting.

For accounting management, it is recommended that TODA be set for the same times at each end of the DLCI, Frame Relay, VCC, ATM, and even for the whole network.

If an active CP is not available, data collection does not occur. A CP can become inactive if a hot standby CP switchover occurs just prior to the following events:

TODA changeover

Statistics collection

You should set TODA to 1 hour intervals on all switches in your infrastructure. The procedure for setting up a TODA schedule must be performed in provisioning mode.

Note: For more information about configuring accounting and setting up a TODA schedule, see your Nortel Passport documentation.


Frame Relay and ATM Settings for Accounting Data Collection

The following table provides an example of recommended settings for collection times for network-wide parameters.

Component Attributes Recommended Setting

Example

Collector/accounting CollectionTimes 00:00 01:00 02:00

03:00 04:00 05:00

06:00 07:00 08:00

09:00 10:00 11:00

12:00 13:00 14:00

15:00 16:00 17:00

18:00 19:00 20:00

21:00 22:00 23:00

Set col/acc collection Times ! 00:00 00:01 02:00 03:00 04:00 05:00 06:00 07:00 08:00 09:00 10:00 11:00 12:00 13:00 14:00 15:00 16:00 17:00 18:00 19:00 20:00 21:00 22:00 23:00


We recommend specific Frame Relay and ATM settings for accounting data collection.

Note: For more information about Frame Relay and ATM accounting record generation and collection, see your Nortel Passport documentation.

The following table shows the recommended setting for units counted for network-wide parameters.


Example

ModuleData Vcs

UnitsCounted Frames

Note that VCs reset is required.

Set Mod Vcs UnitsCounted Frames




The following table shows the recommended setting for Frame Relay accounting collection.


Example

Fruni/xxx DNA accountCollection

Bill

Note that VCs reset required.

Set Fruni/x DNA accountCollection Bill

The following table shows the recommended setting for ATM accounting collection.


Example

AtmIf/xx Nacct Provisioned

AccountCollection

Bill Add Atmif/x Nacct

Set Atmif/x Nacct accountCollection Bill

Note: For more information about these settings and procedural information, see your Nortel Preside documentation.

Chapter 3: Setting Up the Integration


How to Set Up and Install the Integration (see page 23) Setup Checklists (see page 24) eHealth System Setup Prerequisites (see page 24) eHealth – Nortel Preside System Setup Prerequisites (see page 26) eHealth – Nortel Preside Setup Program (see page 27) Run the Setup Program (see page 27) How to Add a License (see page 30)

How to Set Up and Install the Integration This process overview assumes that you are already running the Preside MDM and MDP products.

Note: For information about these products, see your Nortel Preside documentation.

To set up and use the eHealth – Nortel Preside integration, you must complete the following tasks:

1. Install eHealth on a dedicated Solaris system.

Note: For more information, see your eHealth Installation Guide.

2. Complete the installation checklists in the appendix.

3. Run the Setup program (see page 27).

4. Start eHealth and license the integration module.

5. Verify that you have configured Passport settings for statistics data collection (see page 18) on the MDP.

6. Import configuration information on your Passport switches from the MDM database and update the eHealth poller configuration, database, and groups.

Setting Up the Integration 23

Setup Checklists

Setup Checklists Setup checklists for the Preside MDM system, Preside MDP system, and eHealth system are available in the appendix. Before installing eHealth – Nortel Preside, complete one checklist for each Nortel Preside host where you plan to install the software. These checklists help you gather the the information that the setup program prompts you for. This information can also be useful for troubleshooting problems that you may encounter after the installation.

eHealth System Setup Prerequisites You must install eHealth Release 5.6.5 or later on a dedicated Solaris system.

Note: For more information, see the eHealth Installation Guide.

Telnet and FTP, Sun/Open SSH Access

The eHealth system must have reliable Telnet and FTP access to the MDP system. eHealth uses Telnet to launch the remote configuration extraction script. The data collection utility uses FTP, Sun/Open SSH to transfer BDF files from the MDP system.

Required eHealth Installation Information

When you install eHealth – Nortel Preside, you are prompted for polling and configuration extraction information for your eHealth system. Before you begin installing the integration module, complete the eHealth System Checklist (see page 62). The completed checklist helps ensure that you will have the appropriate information while performing the installation.


eHealth System Setup Prerequisites

Extract Configuration Information from the MDM Database

After you run the eHealth – Nortel Preside setup program, you must configure your Nortel Preside elements and import configuration information. You can extract configuration information from the MDM as needed or set up a scheduled job through the eHealth console to import data at regular intervals.

To extract the configuration information from the MDM database, specify the nhConfig -dciCmd nhPresideGetCfg command from the eHealth console.

The nhPresideGetCfg command-line utility logs in to the MDM system, locates the configuration information, and transfers it to eHealth.

More information:

Element Configuration Tasks (see page 36)

How Statistics Data Is Collected and Imported

The eHealth data collection and import process runs automatically in the background to import statistics data. (You are not required to run a command.) The eHealth import poller runs a command to import statistics data from the DDI files.

eHealth – Nortel Preside does the following:

Looks in BDF statistics files for lines where only the following appear in the componentName identifying field:

AtmInterface (or atmIf)

LogicalProcessor (or LP)

The following is an example of a componentName for a file for ATM Interface 70:

(EM/WHM_P4_003 AtmInterface/70)

You can determine the timestamp for each file from the timeOfRecord field.

Note: The collection interval for statistics data is 15 minutes.


eHealth – Nortel Preside System Setup Prerequisites

Collects data from accounting records files and from statistics files. Accounting files contain statistics for VCC, VPC, and DLCI elements. The recordIdentifier field in these files is used to map the accounting records.

You can determine the timestamp and interval for Frame Relay call records from the endTime and elaspsedTime fields.

Note: The minimum collection interval for accounting records data is 60 minutes.

More information:

How eHealth – Nortel Preside Works (see page 9)

eHealth – Nortel Preside System Setup Prerequisites The following are required to set up and use the eHealth – Nortel Preside integration module:

eHealth must be installed on a dedicated Solaris system.

Both Preside MDM and MDP must be running on a dedicated system (one other than the eHealth system).

Note: MDM and MDP can reside on different systems. For more information, refer to your Nortel Preside documentation.

eHealth – Nortel cannot be installed on Distributed eHealth Consoles if you are using Distributed eHealth in Release 5.5. The integration module, however, can be installed on Distributed eHealth Systems from which you plan to monitor Passport elements.

Note: For more information about Distributed eHealth Systems, see the Distributed eHealth Administration Guide.

You must obtain and install an authorized eHealth – Nortel Preside license. When the setup program concludes, you must enter your license information to enable eHealth to collect statistics from a Nortel Preside system.

Passport statistics and accounting collection (see page 17) must be enabled for your Passport devices.

Note: For more information about specific system requirements, see the eHealth Integration Modules Release Notes, the eHealth Installation Guide, and the Nortel Preside documentation.

More information:

How to Prepare the MDP System for the Integration (see page 17)

How to Add a License (see page 30)


eHealth – Nortel Preside Setup Program

eHealth – Nortel Preside Setup Program The eHealth – Nortel Preside installation program installs software on the MDM and MDP systems. This software enables eHealth to collect statistics and accounting data for your Passport devices.

You cannot install eHealth – Nortel Preside on Distributed eHealth consoles. You can, however, install eHealth – Nortel Preside on Distributed eHealth systems from which you plan to monitor Passport elements.

Note: For more information about distributed systems, see the Distributed eHealth Administration Guide.

The setup program presents a series of questions, validates your answers, and prompts you to supply a new answer if the one that you provided is invalid.

Default responses that are available for a particular question appear in brackets [ ]. You can press Enter to accept the default response. You can exit the setup program at any time by entering q to quit.

The setup program consists of two parts:

The first portion prompts you for information about the Preside MDM and MDP systems.

The second portion prompts you for information about your eHealth system.

Run the Setup Program You run the eHealth – Nortel Preside setup program from the eHealth system. The program installs software on the MDM and MDP systems. As you perform the setup, refer to the installation checklists that you completed.

To run the eHealth – Nortel Preside setup program

1. Log in to the eHealth system as the eHealth user.

2. Change to the eHealth directory from any terminal window (such as an xterm or Shell Tool window).

3. (Optional) Use one of the following commands to source the appropriate eHealth resource file to set your environment.

Shell Command

Bourne . nethealthrc.sh

C source nethealthrc.csh


Run the Setup Program


Shell Command

Korn . nethealthrc.ksh

Note: If you do not source the resource file, change to the $NH_HOME/bin directory, or specify the full pathname in your eHealth commands.

4. Execute the following command: nhPresideInstall

The installation program describes the installation process.

5. Enter 1 at the prompt to perform a complete installation.

6. Enter the required information at the appropriate prompts about the MDM and MDP systems.

You can accept the default values, or enter other valid values.

7. Enter y (the default value) when the installation program prompts you to continue with the installation.

The program displays the system and location where it will install the eHealth - Nortel Preside integration module.

8. Supply the required information about eHealth polling and configuration extraction.

The installation displays a message indicating that the installation completed successfully.

9. Enter y when the system prompts you to indicate whether or not you would like to restart the servers.

You must restart the servers for the settings to take effect.

The installation program also displays the pathname of the log file that contains a record of the installation. eHealth - Nortel Preside stores a record of each installation session in a log file named $NH_HOME/log/install/installPresiden.log.

n

Represents a variable value that increases by one each time you run the installation program.

Change MDM and MDP Settings

You can update or change settings for the MDM and MDP systems by running the setup program again.

To change MDM settings

1. Run the Setup program (see page 27) and complete steps 1 through 4.

2. Enter 2 at the prompt to choose Specify the section(s) to run.

Run the Setup Program

3. Enter y (the default value) at the prompt to continue with the installation.

4. Specify the updated information at the appropriate prompts for the MDM and MDP systems by using the values on your checklists.

5. Enter y (the default value) at the prompt to confirm the installation of the integration module in the directory that you specified.

6. Enter n at the prompts to change the eHealth settings.

7. Enter y at the prompt to restart the servers.

The settings take effect after you restart the servers.

Change eHealth Settings

You can update or change settings for the eHealth system by running the setup program again. Make a copy of the eHealth checklist, and record the settings that you plan to change.

To change eHealth settings

1. Run the Setup program (see page 27) and complete steps 1 through 4.

2. Enter 2 at the prompt to choose Specify the section(s) to run.

3. Enter n at the prompt to continue with the installation of the integration module.

4. Enter y (the default value) at the prompt to change your eHealth settings.

5. Specify the updated information at the appropriate prompts for the eHealth system by using the values on your checklist.

If you change the eHealth import polling interval (see page 30) setting, refer to this topic for information about this change.

6. Enter y at the prompt to restart the servers.

The settings take effect after you restart the servers.


How to Add a License


eHealth Import Polling Interval

You can change the import polling interval as needed. If you change the interval, two additional polls must occur before eHealth begins polling at the new interval.

For example, assume that you poll every 15 minutes (the default interval), as shown in the following graphic. You then change the polling interval to 45 minutes between the second and third polls (P2 and P3). eHealth polls two more times at the old (15-minute) interval (P3 and P4) before starting to poll at the new (45-minute) interval.

How to Add a License To use eHealth – Nortel Preside, you have to add an eHealth – Nortel Preside license for your eHealth system.

The process for adding licenses is as follows:

When you start eHealth for the first time, you must specify your eHealth, poller, and application licenses.

If you have already been using eHealth, you must specify additional licenses only for eHealth – Nortel Preside.

After you add license information for your eHealth – Nortel Preside system, eHealth does the following:

Updates the console with the appropriate buttons and menu options

Opens one or more polling status windows

Opens the Discover dialog

Note: For more information about adding eHealth and eHealth integration licenses, see the eHealth Administration Guide, eHealth Installation Guide, or eHealth Help.

Before you can use eHealth – Nortel Preside, you must configure your Nortel Preside elements in eHealth.

Chapter 4: Configuring Nortel Preside Elements in eHealth


Configuration Prerequisites (see page 31) How the Configuration Process Works (see page 32) Options for Modifying the Poller Configuration (see page 33) Element Configuration Tasks (see page 36) Files Used to Configure Elements (see page 40) Element Files (see page 41) Rules Files (see page 49) Data Files (see page 55) Types of eHealth Reports That You Can Run (see page 58)

Configuration Prerequisites Before you begin to configure the Nortel Preside elements, make sure that you have done the following:

Configured your MDM and MDP systems.

Enabled Passport settings for statistics data collection (see page 18) on the MDP.

Enabled Passport settings for accounting data collection (see page 18) on the MDP.

Installed and licensed eHealth.

Note: For more information about installing and licensing eHealth, see your eHealth Installation Guide.

Installed and licensed the eHealth – Nortel Preside IM.

More information:

How to Add a License (see page 30)

Configuring Nortel Preside Elements in eHealth 31

How the Configuration Process Works

How the Configuration Process Works The configuration process extracts configuration information from the MDM’s NRS database for ATM, Frame Relay, and Router/Switch elements on Nortel Passport switches. Then it updates the eHealth poller configuration with this information.

Note: For information about the switches that eHealth – Nortel Preside supports, see the eHealth Integration Modules Release Notes.

Each time you run the configuration process, eHealth does the following:

Imports configuration information from the MDM’s NRS database

Creates a DCI file which stores the configuration information for your devices as eHealth elements

Adds interface elements to the eHealth database and poller configuration

Adds a router element for each Passport switch to the eHealth database and poller configuration

Note: You need a Router license to run Router reports.

Updates the eHealth database with information about existing elements

Adds or updates LAN/WAN groups as necessary, if you use rules files

You can schedule the configuration process to update your poller configuration automatically.

More information:

Extract Configuration Information from the MDM Database (see page 25)


Options for Modifying the Poller Configuration

Options for Modifying the Poller Configuration You can modify the poller configuration by using the nhConfig command or the Poller configuration dialog to change the attributes of your Nortel Preside elements.

You can run the nhConfig command either from the command line or as a scheduled job.

The command updates the poller configuration with the information obtained from the MDM’s NRS database. Any changes that you make in the Poller Configuration dialog can be lost if the information that you change differs from the information in the MDM’s NRS database.

When you delete elements from the MDP database, those elements are not removed from the eHealth database. You must delete these elements in the Poller Configuration dialog. When you disable polling for a Nortel Preside element, eHealth does not add imported data for the element to the database.

Note: Do not change the agent type for Nortel Preside elements.

You can access the Poller Configuration dialog by selecting Setup, Poller Configuration from the eHealth console.

The Poller Configuration dialog lets you manually change attributes such as the name and the speed of your Nortel Preside elements and delete elements from the eHealth database.

If you change any attributes other than name and speed, the changes will be overwritten the next time that you import configuration information.

Note: For more information about using the Poller Configuration dialog, see the eHealth Administration Guide.

nhConfig Command – Updates the Poller Configuration

The nhConfig command lets you configure Nortel Preside elements in your eHealth poller configuration. This command has the following syntax: nhConfig [-help] [-rev] [-verbose] [-verify]

-dciCmd nhAnmGetCfg [-dciOut dciOutputFile]

[-dciRule rulesFile [-dataFiles file1.. filen]]

[-dciIn dciInputFile] [-commit {yes|no}]

[-createNew {yes|no}] [-merge {yes|no} ]

-help

Displays the syntax of the nhConfig command.

-rev

Displays the product version.



-verbose

Prints information at each phase of processing.

-verify

Processes input and produces an element file, but does not add the elements to the eHealth database.

If you specify -verify, the command automatically includes -verbose. Specifying -verify also implies setting -commit to no and -createNew to no.

-dciCmd nhAnmGetCfg

Tells nhConfig to use the nhAnmGetCfg command to extract information from an Alcatel 5620 NMS.

-dciOut dciOutputFile

Saves the processed element information in the specified file. Use this argument to create a file from which you can review the configuration information.

-dciRule rulesFile

Specifies the pathname of a rules file that you can use to filter and group elements from the NMS database in the poller configuration.

-dataFiles file1 ... filen

Specifies the pathnames of data files that you can use with the specified rules file to process the configuration information.

-dciIn dciInputFile

Specifies an input file to the nhConfig command. You can use this option as an alternative to the -dciCmd nhAnmGetCfg option for the nhConfig command.

By using the dciOutputFile from a previous run of the nhConfig command as the argument to -dciIn, you can examine the output of a previous configuration extraction without having to repeat the extraction process.

-commit {yes|no}

Specifies whether to commit changes to the eHealth database.

yes

Commits changes to the database. Specifying -commit yes implies setting -merge to yes because it merges element information with elements from the database and saves the results.

no

Produces a change file and does not commit changes to the database.

Default: yes



-createNew {yes|no}

Specifies whether to create new elements in the eHealth database.

yes

Creates new elements in the database.

no

Does not create new elements in the database. Existing elements in the database might be updated.

Default: yes

-merge {yes|no}

Specifies whether to merge the processed element information with elements from the eHealth database.

yes

Merges the element information with elements from the database.

no

Does not merge the element information with elements from the database. If -commit is set to yes, setting -merge to no has no effect.

Default: yes

Tips for Using nhConfig Arguments

The following tips can help you use the nhConfig command more effectively:

You can use the -dciOut argument to create Element Files (see page 41) that you can review for information about each element that was added.

You can use the dciOutputFile from a previous run of the nhConfig command as an argument to the -dciIn command. This approach lets you examine the output of a previous configuration extraction without having to repeat the extraction process.

Note: For more information and examples, see the eHealth Data Integration Guide.

You can use the -verify argument to creates a temporary element file in the $NH_HOME/tmp directory, and the nhConfig command will not update the poller configuration. The command displays the element file name when the processing ends. You can review the element file to determine whether you want to import the elements or use grouping or filtering options.


Element Configuration Tasks

You can use the -dciRule and -dataFiles options to customize the extraction process and to do the following:

– Filter out elements that you do not want to include in your eHealth reports.

– Group elements by name, type, or other criteria.

– Include or exclude (filter) elements on the eHealth system where the nhConfig command runs.

– Change element information.

You can create your own Rules Files (see page 49) and Data Files (see page 55) to customize the extraction process. These files use the element information to perform filtering, grouping, and modifications.

Note: For more information, see the eHealth Data Integration Guide.

Element Configuration Tasks To configure Nortel Preside elements in your eHealth poller configuration, you can do the following:

Add elements or reconfigure existing elements.

Group, modify, or exclude existing elements.

Create and schedule a Nortel Preside configuration job.

More information:

nhConfig Command – Updates the Poller Configuration (see page 33)

Add or Reconfigure Elements

You can add elements to eHealth or reconfigure existing elements by using the nhConfig command to extract configuration information from the MDM’s NRS database.

To add or reconfigure elements


2. Open a terminal window and access the eHealth directory.



3. (Optional) Source the eHealth resource file that is appropriate for your shell environment by using the -dciCmd nhAnmGetCfg or -dciOut dciOutputFile command.

Note: If you do not source the eHealth resource file, change to the $NH_HOME/bin directory or specify that directory in your eHealth commands.

4. Execute the following nhConfig command: nhConfig -dciCmd nhPresideGetCfg

nhPresideGetCfg

Tells nhConfig to extract configuration information for Nortel Preside elements from the MDM’s NRS database.

Group, Modify, or Exclude Elements

You can group, modify, or exclude existing elements from the poller configuration.

To group, modify, and exclude elements



3. (Optional) Source the eHealth resource file that is appropriate for your shell environment by using the -dciCmd nhAnmGetCfg or -dciOut dciOutputFile command.


4. Execute the following nhConfig command: nhConfig -dciCmd nhPresideGetCfg -dciOut dciOutputFile

-dciCmd nhPresideGetCfg

Tells nhConfig to use the nhPresideGetCfg command to extract information about element configuration from the MDM’s NRS database.

-dciOut dciOutputFile

Saves the processed element configuration in the element file specified in dciOutputFile.



5. Examine the dciOutputFile to understand its contents.

In this element file, note patterns that you can use to group, modify, or exclude elements.

For example, note common strings in element names. You might want to group all elements that share a common string. You might want to divide the elements between multiple eHealth systems to exclude elements that you will add to another eHealth system.

6. Create a rules file that specifies the grouping, modifying, or excluding actions.

Note: For more information about creating rules files, see the eHealth Data Integration Guide.

7. Execute the following nhConfig command: nhConfig -dciCmd nhPresideGetCfg -dciRule rulesFile

-dciCmd nhPresideGetCfg

Tells nhConfig to use the nhPresideGetCfg command to extract information from the MDM’s NRS database.

-dciRule rulesFile

Specifies the pathname of a rules file that you created to filter and group elements in the poller configuration.

More information:

Element Files (see page 41)

Files Used to Configure Elements (see page 40)



Create and Schedule a Configuration Job

You can add a scheduled job to regularly extract configuration information from the MDP by using the nhConfig command. The scheduled job updates your poller configuration automatically for changes in the Passport switches.

Use the nhSchedule command to create a new job type and schedule the job. You must enter the nhSchedule command on the command line. You cannot use the eHealth Schedule Jobs dialog to schedule the extraction of configuration information from the MDM database.

Note: For information about the nhSchedule command syntax, see the eHeatlh Administration Guide.

To create and schedule a Nortel Preside configuration job



3. (Optional) Source the eHealth resource file appropriate for your shell environment by using one of the following commands:

Shell Command

Bourne . nethealthrc.sh

C source nethealthrc.csh

Korn . nethealthrc.ksh


4. Create the new job type by entering the nhSchedule command with the appropriate arguments.

Example: The following command creates a job type named Nortel Preside Config that uses 100 percent of the system resources. The job executes the command nhConfig -dciCmd nhPresideGetCfg when it runs. nhSchedule -defineType "Nortel Preside Config"

-load 100 -cmd "nhConfig -dciCmd nhPresideGetCfg"


Files Used to Configure Elements

5. Schedule the job by entering the nhSchedule command with the appropriate arguments.

Example: The following command schedules the Nortel Preside Config job to extract configuration information each day at 12:30 a.m. and update the eHealth poller configuration. The command takes the name of the rules file as an argument. nhSchedule -schedule "Nortel Preside Config"

-time "12:30 AM" -daily yyyyyyy

-args "-dciRule rulesFileName "

These nhSchedule commands are only examples. When scheduling jobs for your environment, specify a time and frequency that correspond to the frequency with which changes are made to the MDM’s NRS database. If you schedule several configuration jobs, schedule enough time between jobs to allow the completion of one job before the next one starts.

The NRS is a static view of your Nortel network. eHealth recognizes changes in the network only when the NRS is repopulated. CA recommends that you set up a cron job for repopulation on the MDM system and that you schedule the nhConfig -dciCmd nhPresideGetCfg command on the eHealth system to run when the repopulation concludes.

Note: For more information about scheduling configuration jobs, see the eHealth Administration Guide or the eHealth Command and Environment Variables Reference Guide.

Files Used to Configure Elements You can generally use the eHealth Edit Groups dialog to group elements. You might, however, prefer to use rules files and data files to group, modify, and exclude elements during the configuration process. Before creating rules files and data files, you should understand the structure of element files.

Element files, rules files, and data files are described as follows:

Element file

Defines each element’s configuration information in ASCII file format.

When you use the nhConfig command with the -dciOut dciOutputFile argument, nhConfig saves the element information in an element file. You can examine the contents of the element file to determine the rules to implement in a rules file.

An element file is also known as a database configuration information (DCI) file.


Element Files

Rules file

Specifies criteria for selecting and using elements in ASCII file format.

For example, a rules file can specify a selection condition (elements that have the text "trunk" in their name) and an action (add the selected elements to the poller configuration).

Data file

Specifies a list of elements in ASCII file format.

You can specify a data file as the selection condition in the rules file.

Element Files Element files (also known as DCI files) are ASCII files that define the configuration information for each element in comma-separated fields. You can create rules files that use these fields to filter elements, modify element information, and group elements during the configuration process. For example, you can create rules files that rename elements to more meaningful names.

When the configuration process extracts the configuration information for Nortel Preside elements, eHealth creates temporary element files. The configuration process deletes these temporary element files after the element information is added to the poller configuration.

Element files consist of element definitions, which contain several fields each. eHealth obtains values for the fields from information in the MDM database. In some cases, the value for a field concatenates values from more than one database entry, with each value separated by a decimal point (.). For example, the element name for a Frame Relay port is constructed from the node (switch) name, slot number, and port number. These values are obtained from a table in the MDP database.


Element Files

Element File Fields

The following is a list of field names in the element file used with eHealth – Nortel Preside. Each field description specifies the information assigned to the field in the MDM’s NRS database.

objId

Specifies a unique symbol for each element definition in the element file.

Type: symbol

name

Specifies the name of the element.

eHealth creates this entry based on one of the following formats:

Switch:

EM/nodeName-ppc-RH

LP:

EM/nodeName-ppc-RH-Lp/n

AtmIf:

EM/nodeName-ppc-RH-AtmIf/n

VCC :

EM/nodeName-ppc-AtmIf/n-Vcc/vpi.vci

VPC:

EM/nodeName-ppc-AtmIf/n-Vpc/vpi

DLCI:

EM/nodeName-ppc-FrUni/n-Dci/n

EM/nodeName-ppc-FrNni/n-Dci/n

n

Specifies the instance of the Lp, AtmIf, FrUni, FrNni, or Dlci respectively.

You might prefer to use rules files to rename the elements before you add them to the poller configuration.

Type: symbol


Element Files

nmsId

Specifies a unique ID for an element provided by the MDM’s NRS database.

This field accelerates eHealth processing. Supply a value for this field to give the element a unique identifier that is independent of its name.

Type: string

Limits: If the value includes spaces, you must enclose it in quotation marks (" "). To modify element attributes by using operations such as merge, you must specify an nmsId value and other attributes such as indexes.

poll [yes|no]

Indicates whether eHealth polls the element.

yes

Enables the importing of data for the element.

no

Disables the importing of data.

Type: symbol

sysDescription

Specifies the system description information, always enclosed in quotation marks.

Type: string

sysName

Specifies the system name information, always enclosed in quotation marks.

Type: string

Example: “ppc-ABBCCDDEE1”

ifDescription

Specifies the interface description, always enclosed in quotation marks.

Type: string

Example: “EM ABBCCDDEE1 - Passport Switch Parent Element”

speedIn

Specifies the incoming speed of the interface in bits per second.

Type: double


Element Files

speedOut

Specifies the outgoing speed of the interface.

Type: double

mibTranslationFile

Specifies the name of the eHealth MIB translation file (MTF) that describes the variables used for this element.

Type: symbol

ipAddr

Specifies the IP address of the element.

Type: ipAddr

Default: 255.255.255.255

Limits: This field is always set to the default.

storeInDb [yes|no]

Specifies whether the element should be included in LAN/WAN reports or only in Router reports.

yes

Includes the element in LAN/WAN reports.

no

Includes the element in Router reports, but you cannot run LAN/WAN reports for this element.

Type: symbol

ifType

Specifies the type of interface element.

This field is for display purposes only. You can specify any text.

Type: string

Example: “EM”, “LP”, “AtmIf”, “Vcc”, “Vpc”, or “Sp”

uniqueDevId

Specifies a value that identifies the element.

The uniqueDevId is equivalent to the Hardware ID setting in the Poller Configuration dialog.

Type: symbol

Example: ABBCCDDEE1


Element Files

index1

Specifies the first index value.

Type: symbol

Limits: This field value is 0.

index2

Specifies an index value assigned by eHealth to uniquely identify this element.

The value for index2 can be any string.

Type: symbol

Default: empty string (" ")

Example: EM/ABBCCDDEE1 could be the value for your Switch, LP, AtmIf, and VCC elements whereas EM/ABBCCDDEE2 could be the value for your VPC elements.

index3



Type: symbol


Limits: This field is blank for switch elements.

Example: Lp/4 could be the value for an LP element, or AtmIf/20 for an AtmIf element.

index4



Type: symbol


Limits: This field is blank for switch, LP, and AtmIf elements.

Example: Vcc/1.408 could be the value for a VCC element, or Vpc/229 for a VPC element, or Dlci/43 for a Dlci element.


Element Files

nmsSource

Specifies the name of the NMS source of this element.

For an individual element, this value takes precedence over the nmsSource value specified in the GlobalInfo section of the DCI file.

Type: symbol

discoverMtf

Specifies the name of the MTF that eHealth uses to discover the element.

This field is for eHealth internal use.

Type: symbol

Limits: This file may not be the same MTF file that eHealth uses to poll the element.

nmsName

Specifies the name of the element at the NMS.

Type: symbol


nmsState

Specifies whether the element exists on the network device and should be polled.

Options are:

Active

Indicates that the element exists on the device and eHealth should poll it. Specify Deleted if the element no longer exists on the device and eHealth should not poll it.

Deleted

Denotes that an element has been deleted from the NMS (or other configuration source) only. This value does not delete an element from the eHealth poller configuration.

Type: symbol

deviceSpeedIn

Specifies the default incoming speed of a device in bits per second.

To obtain the element’s incoming speed from the NMS, specify a value for deviceSpeedIn. This value appears as the default incoming speed for the element in the eHealth poller configuration.

Type: double


Element Files

deviceSpeedOut

Specifies the default outgoing speed of a device in bits per second.

Type: double

To obtain the element’s outgoing speed from the NMS, specify a value for this field. This value appears as the default outgoing speed for the element in the eHealth poller configuration. If you set an outgoing override speed by using the speedOut field, eHealth uses the element’s override speed instead of its default speed to calculate performance. The default leaves the deviceSpeedOut value unchanged.

ifPhysAddress

Specifies the physical address of an interface.


Type: symbol

Limits: You cannot specify the physical address of an interface when you create a DCI file to import configuration information.

ifIpAddress

Specifies the discovered IP address of an interface.


Type: ipAddr

Limits: You cannot specify the discovered IP address of an interface when you create a DCI file to import configuration information.


Element Files

Element Definition Examples

The following examples of Nortel Preside element definitions are formatted for readability. Some of the fields might not have values. A field containing an empty string is shown as a set of empty quotation marks.

Example: Passport Switch

The following is an example of an element definition for a Nortel Passport switch: 1,EM/ABBCCDDEE1-ppc-RH,"ppc-ABBCCDDEE1 EM ABBCCDDEE1",Yes,"Passport

Switch ppc","ppc-ABBCCDDEE1","EM ABBCCDDEE1 - Passport Switch Parent

Element",,,preside-imp-passport-rh-rtr.mtf,255.255.255.255,Yes,"EM",

"ABBCCDDEE1",0,EM/ABBCCDDEE1,,,PresideMDM/MDP,preside-imp-passport-rh-

rtr.mtf,EM/ABBCCDDEE1-ppc-RH,,,,,

Example: Logical Processor

The following is an example of an element definition for a logical processor: 9,EM/ABBCCDDEE1-ppc-RH-Lp/4,"ppc-ABBCCDDEE1 EM ABBCCDDEE1 Lp

4",Yes,"Passport Switch ppc","ppc-ABBCCDDEE1","EM ABBCCDDEE1 Lp 4 -

Passport Switch LogicalProcessor Element Sw Lpt/ATMAPS Shelf

Card/4",,,preside-imp-passport-lp.mtf,255.255.255.255,Yes,"Lp",

"ABBCCDDEE1",0,EM/ABBCCDDEE1,Lp/4,,PresideMDM/MDP,preside-imp-passport-

lp.mtf,EM/ABBCCDDEE1-ppc-RH-Lp/4,,,,,

Example: ATMIF

The following is an example of an element definition for an AtmIf: 17,EM/ABBCCDDEE1-ppc-RH-AtmIf/20,"ppc-ABBCCDDEE1 EM ABBCCDDEE1 AtmIf

20",Yes,"Passport Switch ppc","ppc-ABBCCDDEE1","EM ABBCCDDEE1 AtmIf 20 -

Passport Switch AtmInterface Element Laps/2

Sts/0",,,preside-imp-passport-atm-port.mtf,255.255.255.255,Yes,"AtmIf",

"ABBCCDDEE1",0,EM/ABBCCDDEE1,AtmIf/20,,PresideMDM/MDP,preside-imp-

passport-atm-port.mtf,EM/ABBCCDDEE1-ppc-RH-AtmIf/20,,155200000,

155200000,,

Example: VCC

The following is an example of an element definition for a VCC: 25,EM/ABBCCDDEE1-ppc-AtmIf/20-Vcc/1.408,"ppc-ABBCCDDEE1 EM ABBCCDDEE1

AtmIf 20 Vcc 1.408",Yes,"Passport Switch ppc","ppc-ABBCCDDEE1",

"EM ABBCCDDEE1 AtmIf 20 Vcc 1.408 - Passport Switch Atm

VirtualChannelConnection

Element",155200000,155200000,preside-imp-passport-atm-channel.mtf,

255.255.255.255,Yes,"Vcc","ABBCCDDEE1",0,EM/ABBCCDDEE1,AtmIf/20,Vcc/1.408,

PresideMDM/MDP,preside-imp-passport-atm-channel.mtf,EM/ABBCCDDEE1-ppc-

AtmIf/20-Vcc/1.408,,,,,


Rules Files

Example: VPC

The following is an example of an element definition for a VPC: 71,EM/ABBCCDDEE1-ppc-AtmIf/42-Vpc/229,"ppc-ABBCCDDEE1 EM ABBCCDDEE1 AtmIf

42 Vpc 229",Yes,"Passport Switch ppc","ppc-ABBCCDDEE1","EM ABBCCDDEE1

AtmIf 42 Vpc 229 - Passport Switch Atm VirtualPathConnection

Element",155200000,155200000,preside-imp-passport-atm-path.mtf,255.255.

255.255,Yes,"Vpc","ABBCCDDEE1",0,EM/ABBCCDDEE1,AtmIf/42,Vpc/229,PresideMD

M/MDP,preside-imp-passport-atm-path.mtf,EM/ABBCCDDEE1-ppc-AtmIf/42-Vpc/229,,,,,

Example: DLCI

The following is an example of an element definition for a DLCI: 1595,EM/ABBCCDDEE1-ppc-FrUni/40-Dlci/43,"ppc-ABBCCDDEE1 EM ABBCCDDEE1

FrUni 40 Dlci 43",Yes,"Passport Switch ppc","ppc-ABBCCDDEE1",

"EM ABBCCDDEE1 FrUni 40 Dlci 43 - Passport Switch FrUni DLCI

Element",,,preside-imp-passport-fr-calling-end-segments.mtf,255.255.255.

255,Yes,"Sp","ABBCCDDEE1",0,EM/ABBCCDDEE1,Dna/33331004040000,Dlci/43,

PresideMDM/MDP,preside-imp-passport-fr-calling-end-segments.mtf,EM/ABBCCD

DEE1-ppc-FrUni/40-Dlci/43,,64000,64000,,

Rules Files Rules files are ASCII files that let you to process the extracted element information before eHealth saves the information in the poller configuration.

You can use rules files to do the following:

Group elements

Exclude elements

Change element information, including element names

Rules File Format

Rules files use the following structures to identify and process element information:


Rules Files

Condition Statements

The condition statement specifies how the rules file selects elements to which it should apply the process command. Condition statements have the following format: dataItem comparisonOperator value :

dataItem

Specifies either an element file field name or a data file.

comparisonOperator

Specifies one of the following:

==

Compares the dataItem to the value for an identical match. The character string comparison is case-sensitive.

matches

Compares the value assigned to dataItem to the value assigned to value, which is specified as a UNIX regular expression. The character string comparison is case-sensitive.

value

Specifies a string or symbol value to use with the comparison operator.

Limits: Enclose strings in quotation marks (").

Condition Statement Examples

The following examples show how to use condition statements to select elements.

Example: Select elements that have a name field set to NYC.

Specify the following condition statement: name matches "NYC" :

This statement does not select elements that have a name field set to nyc or Nyc.

Example: Select elements that are all Frame Relay ports.

Specify the following condition statement: ifType == "wan (3,0)" :

You can also combine several condition statements with a logical AND operation.


Rules Files

Example: Select only elements with an IP address of 122.124.15.123 and the text vtk (virtual trunk) in the ifDescription field.

Specify the following condition statement: ipAddr == "122.124.15.123" and name matches "-vtk.*" :

Process Commands

If an element meets the criteria in the condition statement, the rules file applies the specified process commands to the element. Process commands have the following format: processCommand (value);

processCommand

Specifies one of the following:

setGroup

Adds the element to the specified group in the eHealth database.

setElementFieldName

Assigns a value for the specified element field. ElementFieldName is one of the element file field names.

Limits: The field name must begin with a capital letter when used in a process command.

exclude

Does not add the element to the eHealth database and poller configuration.

(value)

Specifies a string or a symbol that you assign in the process command.

Limits: Enclose value with parentheses and enclose strings in quotation marks. The exclude process command does not use the value field.


Rules Files

Process Command Examples

Example: Add any matching elements to the LAN/WAN group named ATM.

Execute the following process command: setGroup ("ATM");

Example: Set the readCommunity field for each matching element to the value test.

Execute the following process command: setReadCommunity ("test");

Example: Filter the matching element.

Execute the following process command: exclude ();

Example: Change several aspects of the matching element.

Execute several process commands, such as the following: setSysContact ("Jane Smith");

setSpeedIn ("64000");

setReadCommunity ("test");

In the preceding example, the process commands tell the nhConfig command to change the sysContact, speedIn, and readCommunity fields to a specified value.

You can specify one or more of these condition statements and process command structures in a rules file.


Rules Files

Example: Add only those elements that use a specific MIB translation file.

Execute a set of process commands, such as the following: mibTranslationFile matches

"preside-imp-fr-port.mtf" :

{

setGroup ("Frame");

}

name matches ".*" :

{

exclude ();

}

In the preceding example, an element is added to the LAN/WAN group named Frame if the value in its mibTranslationFile field is presidecom-imp-fr-port.mtf. Otherwise, the element is not added to the poller configuration and database.

Note: When a rules file has several condition statements, as in the previous example, eHealth stops processing an element after the first match.

How to Use Rules Files

To specify that the configuration process use a rules file, you use the -dciRule argument with the nhConfig command. To obtain element information from the MDM’s NRS database and apply a rules file named trunks.dcr, execute the following: nhConfig -dciCmd nhPresideGetCfg

-dciRule $NH_HOME/modules/preside/trunks.dcr

The .dcr extension is not required, but the names of the sample rules files that eHealth supplies contain the .dcr extension.

You can apply a rules file with the nhConfig command as often as needed, and you can often apply rules files to download and process element information in different ways. For example, you can save the output in an element file by executing the following: nhConfig -dciCmd nhPresideGetCfg

Use the output file as the input to subsequent nhConfig commands and apply the rules file to the commands. Using this method you can do the following:

Examine the output of the configuration process without having to repeat the extraction from the MDM’s NRS database.

Refine the rules file at each step until you are satisfied with how the elements are grouped, filtered, or modified.


Rules Files

To use the output file as input to nhConfig commands and apply the rules file, follow this process:

1. Execute the following command: nhConfig -dciCmd nhPresideGetCfg -dciOut temp.dci

2. Examine the DCI output file (temp.dci) to note patterns that you can use to group, modify, or exclude elements.

3. Create a rules file to group, modify, or exclude the elements.

In this example, the rules file is myRules.dcr in the /usr/files directory.

4. Execute the nhConfig command with arguments by using the output file from the command in Step as the input to this command, and apply the rules file you created: nhConfig -dciIn temp.dci

-dciRule /usr/files/myRules.dcr

-merge no -commit no -dciOut tempOut.dci

This form of the nhConfig command gets the information for the configuration extraction from the temp.dci file instead of from the MDM’s NRS database. Thus, running the nhConfig command with the -dciIn option instead of the -dciCmd nhPresideGetCfg option takes less time because nhConfig does not have to extract information from the database. Specifying the -merge no and -commit no options prevents any permanent changes to the eHealth database at this stage.

5. Examine the output file (tempOut.dci) and refine the rules file as needed.

6. Execute the nhConfig command again by using the same input and output files. nhConfig -dciIn temp.dci


-merge no -commit no -dciOut tempOut.dci

Repeat the command as many times as needed until the rules file works the way that you want it to.

7. Execute the nhConfig command and arguments as follows when the rules file works as you want it to: nhConfig -dciCmd nhPresideGetCfg


This form of the nhConfig command uses the default value (yes) for the -merge and -commit options to merge the processed element information with elements from the eHealth database and commit changes to the database.


Data Files

Data Files Data files are ASCII files that you can use with rules files to process elements before you add them to the poller configuration. Data files are named data n, with n as a value starting at 1 and incrementing for each data file that you create.

You use a data file when you want to group elements according to values for a field in the element files but those values do not share a common set of letters or numbers. For example, if you want to group a set of elements by name but those names have nothing in common, you can use a data file to specify the set of elements and the name of the group to which you want to assign the elements.

Data File Format

Data files have the following format: FT, Map, symbol, ...

FN, Map, fieldname, ...

DS,,Map

value1, ...

value2, ...

DE

FT

Specifies the field types for each value in the field.

Limits: The symbol type specifies a string without spaces. The string type specifies a string that can contain spaces and must be enclosed in quotation marks (" ").

FN

Specifies the field names for each value in the field.

Limits: The field names must be unique. You use the field names to match on the elements defined in the data file.

DS,,Map

Begins the definition section.

You specify the values for each field within the definition section.

DE

Ends the definition section.


Data Files

Data File Examples

In the first two examples, assume you have the following set of element names in your DCI out file: a-b-c-d-112-13-14-15

x-y-z-21-2-3-4

s-t-u-vlink-12

600

Example: Assign all elements to a single group.

1. Create and save a data file named data1 that contains the element names, as shown in the following example: FT, Map, symbol

FN, Map, name

DS,,Map

a-b-c-d-1

12-13-14-15

x-y-z-2

1-2-3-4

s-t-u-v

link-12

600

DE

2. Create in a rules file a condition statement that selects elements based on the values listed in the data file.

Specify data1.name in the value field in the condition statement.

data1

Specifies the name of the data file.

name

Specifies a field in the element file.

The following sample entry for a rules file shows how to select the elements whose name is listed in the data1 file and add those elements to the group named CustomerOne: name == data1.name :

{

setGroup ("CustomerOne");

}


Data Files

Example: Assign elements to different groups.

1. Create and save a data file named data2 that defines the elements and the groups, as shown in the following example: FT, Map, symbol, string

FN, Map, name, groupName

DS,,Map

a-b-c-d-1, "CustomerABC"

12-13-14-15, "Customer123"

x-y-z-2, "CustomerABC"

1-2-3-4, "Customer123"

s-t-u-v, "CustomerABC"

link-12, "Customer123"

600, "Customer123"

DE

2. Create in a rules file a condition statement that selects elements based on the values listed in the data file.

Use the format data2.groupName for the value field in the condition statement.

data2

Specifies the name of the data file.

groupName

Specifies a field in the element file.

The following sample entry for a rules file selects the elements listed in the data file and sorts them into the groups specified in the groupName field of the data file: name == data2.name :

{

setGroup (data2.groupName);

}

Example: Use the nhConfig command to specify the name of the rules file and one or more data files.

Execute the following nhConfig command: nhConfig -dciCmd nhPresideGetCfg


-dataFiles /usr/files/data1


Types of eHealth Reports That You Can Run


Types of eHealth Reports That You Can Run After you configure your Nortel Passport elements in eHealth, you can run eHealth reports on your Nortel Passport Devices. You can run various reports for the following technology types:

ATM

Frame Relay

Router/Switch elements

Note: For more information about eHealth reports, see the eHealth Reports User and Administration Guide and the eHealth Help.

Appendix A: Setup Checklists

During the setup process, you have to provide information about your Nortel Preside and eHealth systems. The setup checklists describe the setup prompts in the order in which they appear. Complete these checklists before running the setup program so that your system information will be available when you run the program.


Preside MDM System Checklist (see page 59) Preside MDP System Checklist (see page 60) eHealth System Checklist (see page 62)

Preside MDM System Checklist Complete the following checklist to record important information about your Preside MDM system.

Note: Fields requiring data can be case-sensitive, so make sure that you record uppercase and lowercase letters accurately.

Description Your System Information

The hostname of the Preside MDM system.

The IP address of the Preside MDM system.

Enter the IP address in dotted notation.

Example: 172.24.xxx.xxx

The user name that eHealth uses to log into the MDM system.

Example: mdpadmin

This user name must provide access to the operating system and, if necessary, to the Preside database.

The password for this user on the MDM system.

Setup Checklists 59

Preside MDP System Checklist



The full pathname of the directory on the Preside MDM system where eHealth – Nortel Preside remote utilities are installed.

Default: /opt/MagellanNMS/eHealth

This software requires less than 60 kilobytes (KB) of disk space.

Preside MDP System Checklist Complete the following checklist to record important information about your Preside MDP system.

Note: Fields requiring data can be case-sensitive, so make sure that you record uppercase and lowercase letters accurately.


The hostname of the Preside MDP system.

The IP address of the Preside MDP system.

Enter the IP address in dotted notation.

Example: 172.24.xxx.xxx

The user name that eHealth uses to log into the MDP system.

This user name must provide access to the operating system and, if necessary, to the Preside database.

The password for this user on the MDP system.

The full path and filename of the accounting RDF file on the Preside MDP system.

Default:

/opt/MagellanMDP/lib/mdp/rdf/pp/ accounting/pp_acc.rdf

Preside MDP System Checklist

Setup Checklists 61


The full path and filename of the statistics RDF file on the Preside MDP system.

Default:

/opt/MagellanMDP/lib/mdp/rdf/pp/ statistics/pp_sta.rdf

The full pathname of the directory on the MDP system where Nortel Preside places the BDF files.

Default:

/opt/MagellanMDP/data/mdp/dump

The configured accounting BDF hexadecimal data delimiter for the Preside MDP system.

Default: 0x7f

Limits: 0x00–0xff

The configured statistics BDF hexadecimal data delimiter for the Preside MDP system.

Default: 0x7f

Limits: 0x00–0xff

The configured BDF naming convention for the Preside MDP system.

Default: nodeName

Limits: nodeName or nodeID

The maximum number of hours that a BDF file can exist (maximum BDF age) while the import module considers it for data backfill.

Do not set this value to one that is larger than the eHealth database rollup time.

Default: 24 hours

Limits: 1–72

eHealth System Checklist



Should eHealth delete BDF files that are older than the maximum BDF age from the Preside MDP system?

Default: No

Limits: Yes or No

The number of polls that should be stored on the MDP system.

Each stored poll may use substantial amounts of disk space.

Default: 5

Limits: 1–5

eHealth System Checklist Complete the following checklist to record important information about polling on your eHealth system.


The eHealth polling interval in minutes. Specify a polling interval that is approximately the same as the rate at which MDP collects data.

Limits: 15, 30, 45, 60, 75, 90, 105, or 120

Default: 15

The maximum time (in minutes) to allow a configuration extraction to complete.

Limits: 1 to 1440

Default: 60

Index

A E adding elements • 36 eHealth - Nortel Preside arguments, used with the nhConfig command •

35 how it works • 9 license, about • 12

AtmIf element definition • 48 statistics collected • 12 eHealth system, changing polling interval • 30 B element definition examples • 48 element files bulk statistics data • 9

about • 41 C defined • 40

sample element definitions • 48 commands

temporary • 35 exclude • 51

elements nhConfig • 33, 36, 53

adding or reconfiguring • 36 nhSvInstall • 27

configuring • 36 process • 51

defining, examples of • 48 set • 51

excluding • 37 setGroup • 51

files used to configure • 40 condition statements

filtering • 51 examples • 50

grouping • 37, 40 format • 50

importing • 36 configuration

modifying • 37 creating and scheduling a configuration job

• 39 polling • 42 rules file processing • 52

prerequisites • 31 examples

process • 32 condition statements • 50

tasks • 36 data files • 56

configuring elements • 40 element definitions • 48

modifying poller configuration • 33 process commands • 52

running nhConfig command • 36 exclude command • 51

steps for • 36 excluding elements • 37

D extraction process customizing • 35

data files • 55 F about • 55

creating lists of elements • 55 files defined • 40

data • 55 examples • 56 element • 41 format • 55 rules • 49 specifying in nhConfig command • 56 used for configuration • 40 defining elements, examples of • 48

G diagrams polling interval • 30

grouping elements • 37, 40 DLCI element definition • 48

Index 63

I import polling

elements • 36 import polling interval, changing • 30 installing, nhSvInstall command • 27

L Logical Processor element definition • 48

M Management Data Provider • 8

changing MDP settings • 28 data collection • 8 how to prepare the MDP system for the

integration • 17 Preside MDP system checklist • 59 supported MDP Passport devices • 12

modifying elements • 37 Multiservice Data Manager • 8

changing MDM settings • 28 preparing the MDM system for the

integration • 16 Preside MDM system checklist • 59

N network statistics, imported by eHealth -

Nortel Preside ATM P • 12 Frame • 12 Route • 12

nhConfig command arguments • 37 basic form • 36 nhAnmGetCfg argument • 36, 37 options and arguments • 33 output file • 37 rules and data files • 56 specifying a rules file • 37 syntax • 33 tips for using arguments • 35 using data files • 56 using rules files • 53

nhSvInstall command • 27

P Passport devices

settings for statistics data collection • 18 statistics and accounting collection • 17

Passport switch element definition • 48 poller configuration

managing • 37 modifying • 33

Poller Configuration dialog box • 33 poller configuration, modifying • 33 polling interval, changing • 30 Preside, about • 7 process commands

examples • 52 format • 51

R reports, types that you can run in eHealth • 58 rules files • 49

combining condition statements • 50 condition statements • 50 defined • 40 exclude command • 51 format • 49 how to use • 53 matching elements • 50 process commands • 51 processing elements • 52 processing operations • 49 setGroup command • 51 setting element fields • 51 specifying with nhConfig • 53

running eHealth reports • 58

S set command • 51 setGroup command • 51 speed, changing in poller configuration • 33

T TODA configuration requirements • 19

U using rules files • 53

V VCC element definition • 48 VPC element definition • 48
