EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent...

182
EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com EMC ® Smarts ® Adapter for Alcatel-Lucent 5620 SAM EMS Version 2.1 Installation and User’s Guide P/N 300-005-709 REV A04

Transcript of EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent...

Page 1: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® Smarts®

Adapter for Alcatel-Lucent 5620 SAM EMSVersion 2.1

Installation and User’s GuideP/N 300-005-709

REV A04

Page 2: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS Installation and User’s Guide2

Copyright © 2005 - 2008 EMC Corporation. All rights reserved.

Published January, 2008

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

Page 3: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3

Preface.............................................................................................................................. 7

Chapter 1 IntroductionOverview............................................................................................ 14Architecture ....................................................................................... 15

IP Availability Manager/Performance Manager...................17MPLS Manager............................................................................17Network Protocol Manager for BGP........................................17Network Protocol Manager for OSPF......................................18Multicast Manager......................................................................18Adapter Platform........................................................................18

Discovery ........................................................................................... 20Physical and logical discovery..................................................20Event processing .........................................................................21Troubleshooting..........................................................................22

Multi-vendor topology support...................................................... 23Fault tolerance ................................................................................... 25

Chapter 2 System and Software RequirementsRequirements..................................................................................... 28

Operating system requirements ...............................................28Hardware requirements ............................................................28Third-party software ..................................................................28EMC Smarts software.................................................................28

Licensing ............................................................................................ 30

Chapter 3 Installing and Uninstalling the Adapter

Contents

Page 4: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide4

Contents

Installing the Adapter ...................................................................... 32Before installation....................................................................... 32Installation requirements .......................................................... 32Determine the location of the EMC Smarts broker................ 33Detect and stop EMC Smarts programs.................................. 33Backing up your configuration................................................. 37Choose an operating mode for the installation program ..... 38

Installation tasks ............................................................................... 40Mounting the CD-ROM............................................................. 40Inserting the CD-ROM............................................................... 40Downloading the software from Powerlink........................... 40

Performing the installation.............................................................. 42Using wizard mode.................................................................... 42Where to go next......................................................................... 45Using CLI mode.......................................................................... 45Where to go next......................................................................... 46Using unattended (silent) mode............................................... 46

Where to go next ............................................................................... 49Migrating customized files.............................................................. 50Uninstalling the Adapter................................................................. 52

Detect and stop EMC Smarts programs.................................. 53Uninstall using Wizard mode................................................... 53Uninstall using CLI mode ......................................................... 54Uninstall using unattended mode ........................................... 55

Chapter 4 Configuring the Adapter DeploymentConfiguration information .............................................................. 59

Modifying EMC Smarts configuration files............................ 59Summary of configuration tasks .............................................. 59

Configuring the Alcatel-Lucent 5620 SAM-O client.................... 60Configuring the Alcatel-Lucent SAM-O 5.0 client................. 60Configuring the SAM-O 4.0 client............................................ 61

Configuring the Alcatel-Lucent 5620 SAM EMS server.............. 62Enabling the Events policy........................................................ 62Enabling a MIB Administrative State entry............................ 62Setting the appropriate ports for a firewall ............................ 63

Copying required .jar files............................................................... 64Version 4.x ................................................................................... 64Version 5.x ................................................................................... 64

Configuring Adapter communications ......................................... 66Adapter configuration parameters .......................................... 67Generating an MD-5-hashed password .................................. 73

Page 5: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

5EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Contents

Changing the SM_LIBPATH value (Windows platform only) ... 74Configuring JMS alarm processing (ASA-Alarm.conf) ............... 75

Considerations for working with alarms ................................77Aggregating alarms ....................................................................79

Configuring JMS event processing (ASA-Filter.conf) .................. 82Monitored events ........................................................................82JMS message filter.......................................................................82

Troubleshooting excessive message buffering on the EMS......... 84Configuring Domain Managers ...................................................... 85

Configuring the IP Availability Manager................................85Configuring the MPLS Manager...............................................86Configuring the Multicast Manager.........................................86Configuring the Adapter Platform...........................................87Configuring the Global Manager..............................................90

External polling auto-configuration ............................................... 97New polling groups....................................................................97

Replacing existing Domain Manager repositories ....................... 99Rolling the Adapter Log................................................................. 100Considerations for operation with VPLS-mode Multicast........ 101

Recommendations for configuration .....................................102Multicast behavior ....................................................................102

Device filtering ................................................................................ 104Overview of device filtering....................................................104

Chapter 5 Start up and DiscoveryStarting Adapter and Domain Manager services ....................... 108

Starting the Domain Manager services..................................108Stopping a Domain Manager service.....................................109

Initiating discovery ......................................................................... 110Initiating full discovery............................................................110Initiating partial discovery ......................................................110Scheduling a periodic discovery.............................................111

Managing file information ............................................................. 112Reload Adapter Platform files.................................................112Synchronize alarms...................................................................112

Removing an unused JMS durable connection........................... 113Verification steps ............................................................................. 114

Verify the EMC Smarts product status ..................................114Determining the Adapter version ..........................................114

Appendix A Understanding Notification Log EntriesNotification Log entries.................................................................. 116

Page 6: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide6

Contents

Appendix B UNIX Procedures for CD-ROMsMounting the CD-ROM ................................................................. 122

Appendix C Manually Installing the Adapter ServiceManual service installation ........................................................... 124Installing the Adapter service....................................................... 125

Appendix D Mapping of SAM-O Elements to Smarts ObjectsSAM-O element to Smarts object mapping................................. 128

Appendix E Mapping of SAM-O Classes and Smarts ObjectsMapping of SAM-O equipment objects....................................... 136Mapping of SAM-O service objects.............................................. 143Summary of Smarts discovered objects....................................... 157

Appendix F Mapping of SAM-O Objects and Smarts NotificationsElement to notification mapping.................................................. 160

Appendix G Mapping of Administrative and Operational StatusAdministrative and Operational status mapping...................... 168

Appendix H TroubleshootingTroubleshooting 5620 SAM EMS objects ..................................... 170

readRecords.asl ........................................................................ 170soap.asl...................................................................................... 170

Adapter log entries ......................................................................... 173No SAM-O license .................................................................... 173Number of complete s-hook Multicast circuits.................... 173Adapter encountered configured OSPF services................. 174Missing LSPOutSegment......................................................... 174Missing LSP Hop ...................................................................... 174Undefined LSP .......................................................................... 174

Appendix I Understanding the sm_edit Utility

Index.............................................................................................................................. 179

Page 7: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 7

Preface

As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes.

If a product does not function properly or does not function as described in this document, please contact your EMC representative.

This document describes installation and configuration of the EMC® Smarts® Adapter for Alcatel-Lucent 5620 Service Aware Manager Element Management System (SAM EMS). The Adapter supports the EMC Smarts Multiprotocol Label Switching (MPLS) Management Suite, which includes support for Virtual Private LANs (VPLS). In addition, the Adapter supports the EMC Smarts Multicast Manager, Network Protocol Manager (NPM) for Border Gateway Protocol (BGP) and NPM Manager for Open Shortest Path First (OSPF) protocol. The Adapter is designed for use with the Alcatel-Lucent 5620 SAM EMS server version 4.x or 5.x.

AudienceThis document is intended for administrators who are responsible for installing and configuring the Adapter for Alcatel-Lucent 5620 SAM EMS deployment.

It is expected that the person deploying and configuring the Adapter is familiar with the Alcatel-Lucent 5620 SAM EMS.

Page 8: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

8 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Preface

Alcatel-Lucent 5620 SAM EMS Adapter installation directoryIn this document, the term BASEDIR represents the location where EMC Smarts software is installed. This location is:

UNIX:

/opt/InCharge<n>/<product>

Windows:

C:\InCharge<n>\<product>

The <n> represents the software platform version number. The <product> represents the EMC Smarts product. For example, on UNIX operating systems, the EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS is, by default, installed to /opt/InCharge7/ASAM/smarts. Because this document provides directory paths for EMC Smarts products in addition to the Adapter, this location for the Adapter is referred to as ASAM_BASEDIR/smarts.

Note: BASEDIR for the EMC Smarts IP Management Suite; EMC Smarts Service Assurance Management Suite; EMC Smarts MPLS Management Suite; EMC Smarts Network Protocol Management Suite; and EMC Smarts Multicast Manager is /opt/InCharge<n>/<product>.

Optionally, you can specify the root of BASEDIR to be something other than /opt/InCharge<n>/<product>, but you cannot change the <product> location under the root directory.

The EMC Smarts System Administration Guide provides more information about the directory structure of EMC Smarts software.

Related documentationIn addition to this document, EMC Corporation provides a Help system for command line programs as well as product documentation.

Help for command line programsDescriptions of command line programs are available as HTML pages. The index.html file, which provides an index to the various commands, is located in the BASEDIR/smarts/doc/html/usage directory.

Page 9: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 9

Preface

EMC Smarts documentationReaders of this guide may find the following related documentation helpful. It can be found in the BASEDIR/smarts/doc/pdf directory.

Note: These documents are updated periodically. Electronic versions of the updated manuals are available on the Powerlink website:http://Powerlink.EMC.com

◆ EMC Smarts Documentation Catalog

◆ EMC Smarts System Administration Guide

Adapter for Alcatel-Lucent 5620 SAM EMS documentationThe following documentation is available:

◆ EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS Installation and User’s Guide

◆ EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS Release Notes

Suggestions for searching PDF filesYou may search across multiple PDF files using the Adobe Acrobat Reader software.

1. If the documentation is not accessible to all users of the EMC Smarts product suite, copy the contents of the BASEDIR/smarts/doc/pdf directory to a central location, such as a shared drive on your LAN, that operators and others may view.

2. To search throughout the documentation library, open the Acrobat Reader software.

1. Choose Edit > Search, and enter a word or phrase.

2. In the Where would you like to search option, select All PDF Documents in and type the pathname of the location where the PDF documents reside.

If you have more than one EMC Smarts product suite installed, you can set up cross-product document searches by copying files from the BASEDIR/smarts/doc/pdf directory for each product suite into this common documentation directory path.

Conventions used in this documentEMC uses the following conventions for special notices.

Page 10: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

10 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Preface

Note: A note presents information that is important, but not hazard-related.

CAUTION!A caution contains information essential to avoid data loss or damage to the system or equipment.

IMPORTANT!An important notice contains information essential to operation of the software.

Typographical conventionsEMC uses the following type style conventions in this document:

Normal Used in running (nonprocedural) text for:• Names of interface elements (such as names of windows,

dialog boxes, buttons, fields, and menus)• Names of resources, attributes, pools, Boolean expressions,

buttons, DQL statements, keywords, clauses, environment variables, filenames, functions, utilities

• URLs, pathnames, filenames, directory names, computer names, links, groups, service keys, file systems, notifications

Bold: Used in running (nonprocedural) text for:• Names of commands, daemons, options, programs,

processes, services, applications, utilities, kernels, notifications, system call, man pages

Used in procedures for:• Names of interface elements (such as names of windows,

dialog boxes, buttons, fields, and menus)• What user specifically selects, clicks, presses, or types

Italic: Used in all text (including procedures) for:• Full titles of publications referenced in text• Emphasis (for example a new term)• Variables

Courier: Used for:• System output, such as an error message or script • URLs, complete paths, filenames, prompts, and syntax when

shown outside of running text

Courier bold: Used for:• Specific user input (such as commands)

Page 11: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 11

Preface

Pathname conventionsDirectory pathnames are shown with forward slashes (/). Users of the Windows operating systems should substitute back slashes (\) for forward slashes.

Graphical conventionsIf there are figures illustrating consoles in this document, they represent the consoles as they appear in Windows. Under UNIX, the consoles appear with slight differences. For example, in views that display items in a tree hierarchy such as the Topology Browser, a plus sign displays for Windows and an open circle displays for UNIX.

Smarts ManagerUnless otherwise specified, the term Smarts Manager is used to refer to EMC Smarts programs such as Domain Managers, Global Managers, and adapters.

Where to get helpEMC support, product, and licensing information can be obtained as follows.

Product information — For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at:

http://Powerlink.EMC.com

Technical support — For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account.

Courier italic: Used in procedures for:• Variables on command line• User input variables

< > Angle brackets enclose parameter or variable values supplied by the user

[ ] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means “or”

{ } Braces indicate content that you must specify (that is, x or y or z)

... Ellipses indicate nonessential information omitted from the example

Page 12: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

12 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Preface

Page 13: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Introduction 13

1

This guide provides information about the EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS for use with the Alcatel-Lucent 5620 Service Aware Manager (SAM) Element Management System (EMS). In addition, it includes information about installing, configuring, and using the Adapter.

This chapter contains the following information:

◆ Overview.............................................................................................. 14◆ Architecture ......................................................................................... 15◆ Discovery.............................................................................................. 20◆ Multi-vendor topology support........................................................ 23◆ Fault tolerance ..................................................................................... 25

Introduction

Page 14: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

14 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

OverviewThe EMC® Smarts® Adapter for Alcatel-Lucent 5620 SAM EMS supports the following:

◆ Alcatel-Lucent 5620 SAM EMS versions 4.0 and 5.0

◆ Discovery of Alcatel-Lucent 7750 routers and 7450 switches, including both physical and logical discovery

• Instantiation of Layer 2 and Layer 3 topology into the EMC Smarts IP Availability Manager

• Instantiation of MPLS (VPRN, VLL, and VPLS), NPM (BGP and OSPF) topology, into their respective EMC Smarts Domain Managers

• Instantiation of physical and logical topology into the Multicast Manager

◆ Support for the stitching together of the Alcatel-Lucent topology with non-Alcatel-Lucent topology in the Domain Managers. The non-Alcatel-Lucent topology is discovered independently by the IP Availability Manager.

◆ Incremental additions/deletions of physical and logical topology elements

◆ Near real-time processing of Alcatel-Lucent 5620 SAM EMS alarms through the EMC Smarts Adapter Platform

◆ Conversion of alarms into Smarts notifications

◆ Initial synchronization of historical events and ongoing handling of asynchronous events

◆ Status updates based on events received from the Alcatel-Lucent 5620 SAM EMS

Page 15: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Architecture 15

Introduction

ArchitectureThe Adapter provides a link from the Alcatel-Lucent 5620 SAM EMS Service Aware Manager Open Interface (SAM-O) to the following EMC Smarts Domain Managers:

◆ IP Availability Manager

◆ MPLS Manager

◆ Network Protocol Managers (Manager for BGP and Manager for OSPF)

◆ Multicast Manager

Topology queries are sent by XML streams to the EMS, where they are processed. Near real-time events are passed from the EMS by Java Message Service (JMS), also in XML format, to the Adapter. Based on the events, the Adapter creates notifications on the Adapter Platform. The Adapter Platform creates notifications for display in the EMC Smarts Service Assurance Global Console.

Figure 1 on page 16 shows the event, alarm, and notification flow through the Adapter and the EMC Smarts Domain Managers and Adapter Platform.

Note: The Adapter for Alcatel-Lucent 5620 SAM EMS does not communicate directly with network elements; rather, it imports information from the Alcatel-Lucent 5620 SAM EMS server only.

Page 16: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

16 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

Figure 1 Adapter for Alcatel-Lucent 5620 SAM EMS architecture

Adapter Platform

Topology and events

Alarms

Physical topology and non-alarm events

Status subscription

Global Manager

Global Console

Alarm notifications

Topology and eventsTopology and events

Topology and events

Notifications for display

Physical topology and non-alarm events

Status subscription

Topology and events

Multicast Manager IP AM/PM Manager

Physical topology and non-alarm events

Status subscription

Physical topology and non-alarm events

Status subscription

Adapter for Alcatel-Lucent 5620 SAM EMS

Alcatel-Lucent 5620 SAM EMS

Monitoring Server

Analysis Server

Topology Server

MPLS Manager

OSPFBGP

NPM Managers

Page 17: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Architecture 17

Introduction

Note: Generally, the Adapter is not installed on the same host as the Alcatel-Lucent 5620 SAM EMS. Depending on deployment considerations, it may be installed on the same or different host as other EMC Smarts products.

IP Availability Manager/Performance ManagerThe Adapter supports full and incremental discovery of the IP network, importing Layer 2 and Layer 3 topology information from the Alcatel-Lucent 5620 SAM EMS server into the IP Availability Manager.

The Adapter also supports performance status information from the Alcatel-Lucent 5620 SAM EMS server on physical components such as router fans, memory, processors, etc.

In addition, the IP Availability Manager may be configured to perform independent discovery of non-Alcatel-Lucent networks, providing that topology to the Domain Managers, which will create a cross-vendor topology.

MPLS ManagerThe Adapter supports optional full and incremental discovery of the MPLS network, importing MPLS and VPN topology information from the Alcatel-Lucent 5620 SAM EMS server into the EMC Smarts MPLS Manager.

The MPLS Manager manages MPLS networks and VPNs, virtual leased lines (VLLs), virtual private LAN services (VPLS), and generic routing encapsulation (GRE) tunnels configured and provisioned over them. It provides mapping and correlation between the MPLS and the VPN domains, as well as between the MPLS/VPN domains and the underlying transport domain. This is accomplished by means of cross-domain correlation and cross-domain impact analysis.

Network Protocol Manager for BGPThe Adapter supports optional full and incremental discovery of the Border Gateway Protocol (BGP) network, importing BGP topology information from the Alcatel-Lucent 5620 SAM EMS server into the EMC Smarts Network Protocol Manager for BGP.

Page 18: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

18 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

The Network Protocol Manager for BGP diagnoses connectivity failures for the BGP protocol. Network Protocol Manager for BGP, working with the Availability Manager and the imported information for Alcatel devices from the Alcatel-Lucent 5620 SAM EMS server, discovers and monitors network devices running BGP services, diagnoses BGP-related failures, and reports the results of its analysis to the Global Manager. The Network Protocol Manager for BGP also detects common configuration problems that occur when deploying and maintaining the routing infrastructure.

Network Protocol Manager for OSPFThe Adapter supports optional full and incremental discovery of the Open Shortest Path First (OSPF) network, importing OSPF topology information from the Alcatel-Lucent 5620 SAM EMS server into the EMC Smarts Network Protocol Manager for OSPF.

The Network Protocol Manager for OSPF diagnoses connectivity failures for the OSPF protocol. Network Protocol Manager for OSPF, working with the Availability Manager and the imported information for Alcatel devices from the Alcatel-Lucent 5620 SAM EMS server, discovers and monitors network devices running OSPF services, diagnoses OSPF-related failures, and reports the results of its analysis to the Global Manager. The Network Protocol Manager for OSPF also detects common configuration problems that occur when deploying and maintaining the routing infrastructure.

Multicast ManagerThe Adapter supports optional full and incremental discovery of the following IP multicast-related entities:

◆ Internet Group Management Protocol (IGMP)

◆ Protocol Independent Multicast (PIM)

The Adapter imports these elements from the Alcatel Element Management System (EMS), which monitors Alcatel 7750 routers and 7450 switches, into the EMC Smarts Multicast Manager.

Adapter PlatformThe EMC Smarts Adapter Platform imports alarms and event information from the Adapter for Alcatel-Lucent 5620 SAM EMS and

Page 19: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Architecture 19

Introduction

imports network topology information from the IP Availability Manager.

The Adapter reads and processes events, such as additions and deletions of devices, which it exports to the Global Manager. The Adapter supports both initial synchronization of historical events and ongoing handling of asynchronous events. In addition, the Adapter processes alarms and then creates or deletes notifications in the Adapter Platform, which are then forwarded to the Global Manager. Alarms are mapped to notifications for display in the Notification Log of the Global Console. To process an alarm, the Adapter maps the Alarm ID, Type, and Cause parameters to table entries containing text for the notification.

Page 20: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

20 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

DiscoveryThe Adapter for Alcatel-Lucent 5620 SAM EMS does not perform SNMP polling of the network element through a traditional discovery process; rather, the Adapter gets all topology information from the Alcatel-Lucent 5620 SAM EMS database.

The Adapter provides the following discovery options for initiating discovery and ensuring that the topology is correctly maintained:

◆ Full rediscovery—Manually initiated or scheduled rediscovery for all topology elements. This process examines all 5620 SAM physical objects and adds or updates the topology in all appropriate Domain Managers at the same time.

◆ Incremental additions/deletions/changes—The Adapter receives updates to the topology of the Alcatel-Lucent 5620 SAM EMS. Incrementally applied status updates are applied to the appropriate Domain Manager and automatically propagated to other Domain Managers that rely on that information. This is sometimes referred to as incremental discovery.

◆ Partial rediscovery—Manually initiated or scheduled rediscovery for selected topology elements such as a single router and its elements, or Service (logical) items only. This process updates the topology in the appropriate Domain Managers at the same time.

Physical and logical discoveryDiscovery is broken into two phases: physical and logical. There is a direct correlation between Alcatel-Lucent database objects and the EMC Smarts topology elements to which they are mapped. Logical discovery is more complex, because the Adapter for Alcatel-Lucent 5620 SAM EMS must query multiple Alcatel-Lucent database structures in order to determine the logical relationships.

The Adapter for Alcatel-Lucent 5620 SAM EMS discovers the following topology elements:

◆ Physical topology—Routers, Switches, BaseCards, DaughterCards, Chassis, IPs, IPNetworks, NetworkConnections, MACs, and Interfaces

Page 21: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Discovery 21

Introduction

◆ Logical topology:

• IP Availability Manager—NetworkAdapterRedundancyGroups (from Alcatel-Lucent 5620 SAM EMS Link Aggregation Groups)

• MPLS—VPLS, VLLs, GREs, LDPs, VPNs, VRFs, MPLSServices, LSPs, LSPHops, Network Connections, and ForwarderEndpoints

• NPM—Confederation, AutonomousSystem, BGPProtocolEndpoint, BGPSession, BGPService, BGPCluster, OSPFArea, OSPFAreaConfiguration, OSPFService, OSPFNeighborEndpoint, OSPFVirtualNeighborEndpoint, OSPFInterface, OSPFVirtualInterface, NetworkConnections, OSPFNeighborRelationship, OSPFVirtualLink

• Multicast—IGMPInterface, IGMPNetwork, MulticastGroup, MulticastService, MulticastSource, MulticastTree, PIMInterface, PIMStarG, PIMSourceG, PIMHop

The Adapter instantiates physical topology into the IP Availability Manager; and instantiates physical and logical topology into the MPLS Manager, Multicast Manager, and the NPM Managers (BGP and OSPF).

Event processingThe Adapter updates the status of the 5620 SAM EMS elements, based on a filtered set of events received from the 5620 SAM EMS through the SAM-O interface using a JMS connection, and creates Smarts notifications.

For detailed information about the mapping and filtering of 5620 SAM EMS elements to Smarts objects, the following appendices are available:

◆ “Mapping of SAM-O Objects and Smarts Notifications” on page 159

◆ “Mapping of SAM-O Classes and Smarts Objects” on page 135

Page 22: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

22 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

TroubleshootingThe following information is available in “Troubleshooting” on page 169:

◆ Using informational entries in the ASA.log that provide a trail of events reported by the Alcatel-Lucent 5620 SAM EMS or showing progress of a discovery.

◆ Querying the Alcatel-Lucent 5620 SAM EMS database for object data, in the event that the information is not directly available from the EMS user interface.

Page 23: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Multi-vendor topology support 23

Introduction

Multi-vendor topology supportThe Adapter discovers Alcatel-Lucent 7750 and 7450 devices and creates a topology of the network managed by the Alcatel-Lucent 5620 SAM EMS.

Note: It is assumed that each network element is managed by a single Alcatel-Lucent 5620 SAM EMS only.

The Adapter populates Domain Managers such as the MPLS Manager, the NPM Managers, and the Multicast Manager with the topology objects it discovers through the Alcatel-Lucent 5620 SAM EMS. The IP Availability Manager populates the Domain Manager with the topology objects it discovers.

The Domain Managers individually handle post-processing to stitch together the physical and logical topologies from both the EMS and other sources in a heterogeneous network. Figure 2 on page 24 illustrates this architecture. Post-processing creates objects such as a NetworkConnection between an Alcatel-Lucent element and a non-Alcatel-Lucent element.

Page 24: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

24 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

Figure 2 Architecture for multi-vendor topology support

Adapter for Alcatel-Lucent 5620 SAM EMS

Alcatel-Lucent 5620 SAM EMS

Domain ManagersIP, MPLS, NPM, MCAST

Non-Alcatel-Lucent topologySNMP/CLI polling

PushedAlcatel-Lucent

topology

Post-processing forcross-vendor topology stitching

Cisco/Juniper Network Alcatel-Lucent Network

Page 25: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Fault tolerance 25

Introduction

Fault toleranceIf the Alcatel-Lucent 5620 SAM EMS fails over, the Adapter connects to the active EMS.

Page 26: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

26 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Introduction

Page 27: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

System and Software Requirements 27

2

This chapter contains the following information:

◆ Requirements....................................................................................... 28◆ Licensing .............................................................................................. 30

System and SoftwareRequirements

Page 28: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

28 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

System and Software Requirements

Requirements

Operating system requirements

The Alcatel-Lucent 5620 SAM EMS Adapter is supported on the following operating systems:

◆ Solaris 8, 9, and 10

◆ Linux Advanced Server 3 and 4

◆ Windows 2003 Enterprise Edition, SP1 and R2

Hardware requirementsThe Alcatel-Lucent 5620 SAM EMS Adapter requires the following hardware resources:

◆ 512 MB RAM

◆ 200 MB disk space

Third-party software

The Adapter requires the installation of:

◆ Alcatel-Lucent 5620 Service Aware Manager (SAM) EMS server version 4.x or 5.x

Note: The Adapter must be installed on a different host from the Alcatel-Lucent 5620 SAM EMS server.

EMC Smarts softwareThe Adapter requires the installation of:

◆ EMC Smarts IP Management Suite 7.0.2 or above, or 6.5, Service Pack 3 with the latest Rolling Patch applied, including the IP Availability Manager

◆ EMC Smarts Service Assurance Management Suite 7.0.2 or above, or 6.5, Service Pack3 with the latest Rolling Patch applied, including the Global Manager and the Global Console

Page 29: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Requirements 29

System and Software Requirements

Note: If your deployment includes MPLS 2.X, you must use the EMC Smarts Service Assurance Management Suite 7.1.x.

In addition, your deployment may include one or more of the following suites or products that are supported for use with the Adapter:

◆ EMC Smarts MPLS Management Suite 2.0, with Service Pack 1 applied

◆ EMC Smarts Network Protocol Management Suite 2.1

◆ EMC Smarts Multicast Manager 1.1, with Service Pack 1 applied

Ensure that any appropriate Service Pack or Rolling Patch for the suite or product is applied.

IMPORTANT!You must have root or administrative privileges on the local host to perform this installation.

Page 30: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

30 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

System and Software Requirements

LicensingTo use the Alcatel-Lucent 5620 SAM EMS Adapter, the following licenses are required.

EMC CorporationFor the Alcatel-Lucent 5620 SAM EMS Adapter, you must obtain a license.

For each EMC Smarts Domain Manager deployed in your Adapter installation, you must obtain the following licenses:

◆ The regular Domain Manager license

◆ A special ASAM Adapter license to allow access by the Alcatel-Lucent 5620 SAM EMS Adapter

The EMC Smarts System Administration Guide provides information on obtaining and installing licenses.

Alcatel-Lucent CorporationYou must obtain the following licenses:

◆ The Alcatel-Lucent 5620 EMS license

◆ The Alcatel-Lucent 5620 SAM-O license

Page 31: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing and Uninstalling the Adapter 31

3

This chapter contains the following information:

◆ Installing the Adapter ........................................................................ 32◆ Installation tasks.................................................................................. 40◆ Performing the installation................................................................ 42◆ Where to go next ................................................................................. 49◆ Migrating customized files ................................................................ 50◆ Uninstalling the Adapter ................................................................... 52

The basic installation steps are the same for all supported UNIX and Windows platforms.

Installing andUninstalling the

Adapter

Page 32: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

32 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Installing the AdapterThis section describes how to install the Alcatel-Lucent 5620 SAM EMS Adapter.

Note: This version of the Adapter does not support migration or upgrade from previous versions.

Before installationThis section explains the requirements that must be met before installing the adapters.

◆ “Installation requirements” on page 32.

◆ “Determine the location of the EMC Smarts broker” on page 33.

◆ “Detect and stop EMC Smarts programs” on page 33.

◆ “Choose an operating mode for the installation program” on page 38.

Installation requirementsBefore beginning, you must satisfy the following requirements:

◆ Access requirement: The user performing the installation must have administrative privileges. The installation program will halt if the user does not have the appropriate privileges.

◆ JRE requirement: Version 1.5.0_08 or later of the Java Runtime Environment (JRE) must be installed on the system to run the installation program. The installation program attempts to detect that a compatible JRE version has been installed on your system. If necessary, download the required J2SE JRE version:

• Solaris: http://java.sun.com.

• Linux: http://java.sun.com.

• Windows: http://java.sun.com.

If a compatible JRE version is installed and the installation program cannot locate it, you must specify the location when you execute the installation program. Based on the operating mode of the installation program that is used when installing or upgrading the suite, there

Page 33: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing the Adapter 33

Installing and Uninstalling the Adapter

may be additional requirements. These requirements are included in the procedures for the specific modes.

Determine the location of the EMC Smarts broker

You must specify the location of the EMC Smarts broker during installation of the EMC Smarts software. Typically, this location is chosen during the design of the EMC Smarts software deployment and before any installation begins.

Consult with your deployment planner or check the build guide that documents your deployment to determine the name of the host where the broker was installed and the port that the broker uses.

If the location is the same host where you are installing this suite, then the installation program will automatically install the broker if it is not already on the host.

Detect and stop EMC Smarts programsBefore installing or uninstalling your suite, you must stop all EMC Smarts services, EMC Smarts scheduled jobs, and any other process that uses programs or libraries in any EMC Smarts installation area.

WARNING

For new installations or uninstallations on UNIX, do not stop the EMC Smarts service daemon process, sm_serviced. However, when adding new products to an existing installation, you must stop sm_serviced.

When you install or uninstall suites, all EMC Smarts product suites on the same host must be shut down. If the Broker is on the host, it too must be shut down. This will prevent EMC Smarts applications from starting and new connections from being established while the Broker is down. Inform any users who may be affected and, if necessary, schedule the installation or uninstallation for a period of low utilization.

Detecting EMC Smarts programsThe sm_plist utility identifies all EMC Smarts programs that are running for any product suite on your machine. You can use the sm_plist utility whenever you need to identify EMC Smarts programs

Page 34: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

34 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

that are running (for example, before an installation or uninstallation, or applying another SmartPack or Rolling Patch).

To use the utility, invoke it from the BASEDIR/smarts/script directory. The utility displays active programs in a window.

1. Go to the BASEDIR/smarts/script directory.

2. Start the sm_plist utility:

For UNIX, enter

# ./sm_plist.sh BASEDIR2

For Windows, enter

cscript sm_plist.vbs BASEDIR2

Where BASEDIR is the directory where the sm_plist utility is installed and BASEDIR2 represents the location of any EMC Smarts product suite.

Stopping active EMC Smarts programs (UNIX)

1. Stop active EMC Smarts services using the sm_service utility from BASEDIR/smarts/bin:

# ./sm_service stop --all

Note: sm_serviced waits 30 minutes after sending a shutdown request to a process. If the process is still running after 30 minutes, sm_serviced terminates it.

2. Determine if any EMC Smarts services are still running by using the brcontrol utility from BASEDIR/smarts/bin:

# ./brcontrol -b <host>:<port>

Page 35: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing the Adapter 35

Installing and Uninstalling the Adapter

Based on the location of the broker, go to the appropriate step, as indicated in Table 1 on page 35.

3. Stop any EMC Smarts manager that is still running. If the broker is on the host, stop the local broker:

• To stop any manager that is still running, use the dmquit utility from BASEDIR/smarts/bin:

# ./dmquit --server=<servername>

• To stop the local broker from BASEDIR/smarts/bin:

# ./brquit --broker=localhost:<port>

4. Determine if any other EMC Smarts processes are still running and shut the processes down:

• Detect the processes using the following command:

# ps -ef | grep “sm_”

If a list is displayed, note the process ID (pid) of these active EMC Smarts processes.

WARNING

Do not stop or kill the EMC Smarts service daemon process, sm_serviced.

• Shut down these EMC Smarts processes (except sm_serviced) using the following command:

# kill <pid>

Table 1 Next steps for detecting and stopping programs

The broker is on the And this displays. Do this

Same host “Error attaching to broker” message

The EMC Smarts broker is not running. Go to Step 4.

List of servers registered with the broker

• The broker or service daemon did not shut down.• If any servers are still running on the host, these did not shut down.Go to Step 3.

Different host List of servers registered with the broker

• If any servers are still running on the host where you will install the EMC Smarts software, these did not shut down. Go to Step 3.

Page 36: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

36 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Stopping active EMC Smarts programs (Windows)To stop a service from the Windows desktop, use the Microsoft Management Console.

1. Select Settings > Control Panel.

2. At the Control Panel, select Administrative Tools.

3. At the Administrative Tools folder, select Services.

4. At the Services window, locate any running Smarts services. These services start with the words “EMC Smarts,” “InCharge,” or “Smarts.” For each of these services, right-click the service and then select Stop.

Note: Do not stop the broker service.

5. Repeat Step 4 until all Smarts services are stopped.

6. Open a command prompt and determine if any Smarts Managers are running by using the brcontrol utility from BASEDIR\smarts\bin:

brcontrol -b <host>:<port>

7. Stop any Smarts Manager that is still running using the dmquit utility from BASEDIR/smarts/bin:

dmquit --server=<servername>

8. If the broker is installed on the same host, use the brquit utility from BASEDIR/smarts/bin to stop it:

brquit --broker=localhost:<port>

9. Press Ctrl+Alt+Delete. The Windows Security dialog box appears.

10. Click Task Manager. The Windows Task Manager appears.

11. Select the Processes tab.

CAUTION!Allow up to 30 minutes before performing Step 12. Smarts Managers with large topologies can take considerable time to stop while saving the topology to the repository. Stopping processes prematurely may corrupt your repository file.

Page 37: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing the Adapter 37

Installing and Uninstalling the Adapter

12. In the Processes tab, look in the column labeled Image Name for sm_server. For each sm_server, right-click it and then select End Process.

13. In the Processes tab, look for other Image Names that start with sm_, for example, sm_notify, sm_adapter, sm_beacon, etc. For each instance, right-click it and then select End Process.

Note: Do not shutdown any sm_authority or sm_logger processes The sm_authority and sm_logger processes are child processes of a Smarts server. The child processes will stop when the parent process stops.

Backing up your configuration

Back up your current suite configuration, including all customizations, using the smgetinfo utility. This utility collects version information and saves the /conf, /local, /rules, and /setup directories to an archive file.

For all platforms, to collect information about installed products and components, the Perl interpreter (version 5.0 or later) must be installed.

For Windows, WinZip is required. If WinZip is not installed in its default directory, set the variable ZIPPER to point to the WinZip directory.

To run the smgetinfo utility:

1. Ensure that the value for SM_HOME is set to BASEDIR.

2. Go to the BASEDIR/smarts/script directory.

3. Execute the appropriate command:

For UNIX enter

./smgetinfo

or

sh smgetinfo

For Windows enter

smgetinfo.cmd

Page 38: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

38 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

The name and location of the resulting .tar or .zip archive file is displayed.

4. Archive the file for later use, if necessary.

Choose an operating mode for the installation programUse one of the following modes supported by the installation program:

◆ Wizard mode is a Java-based Graphical User Interface (GUI) method.

◆ Command Line Interface (CLI) mode (UNIX only) is a text-based method intended to support systems with non-graphics consoles.

◆ Unattended (Silent) mode reads the selections and settings for the installation from a user-modifiable file, which enables users to easily duplicate the installation on many computer systems.

Use the following decision tree to choose the appropriate mode for the installation program.

Page 39: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing the Adapter 39

Installing and Uninstalling the Adapter

Figure 3 Choose an operating mode for the installation program

Note: On UNIX systems, Wizard mode uses the X Window System to display the installation wizard. The host on which you install the EMC Smarts software and the host where you log on must be configured to run the X Windows System. Before starting the installation program using the Wizard mode, verify that the X Window System is running.

Will the deployment require multiple installations?

No

Yes Use Unattended (Silent) mode

Windows

UNIX

Are all of these available?X Windows displayFixed ports for communication through firewallsSpecial access to production systems

Use the Wizard mode

What is the operating system?

Start

Yes to all

No

Use CLI mode (recommended) or

Unattended (Silent) mode

Use any mode:Wizard mode is recommended

Page 40: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

40 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Installation tasksThe Alcatel-Lucent 5620 SAM EMS Adapter software is available through a software kit, or from the EMC Powerlink website. There is a separate CD or download option for each supported operating system.

Installing the adapter includes the following tasks:

◆ Mount or insert the CD-ROM from the software kit, or download the software from Powerlink.

◆ Perform the installation.

Mounting the CD-ROM

Mount the CD-ROM and change to the CD-ROM directory using established procedures for your environment. The procedure for mounting the CD-ROM differs based on the operating system.

UNIXIf necessary, see Appendix B for typical commands and examples.

Inserting the CD-ROM1. Insert the CD-ROM into the CD-ROM drive. If autoplay is

enabled, the installation program starts automatically using the Wizard mode.

2. If necessary, change the directory to the CD-ROM. Use Windows Explorer to access the CD-ROM drive and locate the /suite directory.

Downloading the software from Powerlink

Note: To access the EMC Powerlink website, you need a Powerlink username and password.

Follow these steps to download the software:

1. In your Web browser, access the Powerlink website:

http://powerlink.EMC.com

Page 41: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installation tasks 41

Installing and Uninstalling the Adapter

2. Enter your Powerlink username and password.

3. On the Powerlink page, select Support.

4. On the Support page, select Downloads and Patches.

5. On the Downloads and Patches page, select Downloads S-Z > Smarts Adapters/ Alcatel 5620 SAM (Service Aware Manager) Adapter.

6. From the Smarts Software Downloads page, select the Alcatel-Lucent 5620 SAM EMS Adapter.

7. Save the file to the ASAM_BASEDIR for the Adapter, typically, /opt/InCharge7/ ASAM.

Page 42: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

42 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Performing the installationTo perform the installation, use the procedure for the installation program mode that you selected:

◆ For Wizard mode, go to “Using wizard mode” on page 42.

◆ For CLI mode, go to “Using CLI mode” on page 45.

◆ For Unattended (Silent) mode, go to “Using unattended (silent) mode” on page 46.

Using wizard modeThe following text explains using the Wizard mode.

Satisfy wizard mode requirements (UNIX Only)On UNIX systems, wizard mode uses the X Window System to display the installation wizard. The host on which you install the EMC Smarts software and the host where you log on must be configured to run the X Window System. Before starting the installation program using the wizard mode, verify that the X Window System is running.

Running wizard mode1. Execute the Setup command from Table 2 on page 43. The

InstallShield wizard dialog box displays and closes. The Shutdown Programs dialog box and the Welcome screen then display.

IMPORTANT!When you insert the installation CD, there may be a delay of several minutes between the InstallShield preparation screen and the EMC® Smarts® splash screen/installation dialogs.

Page 43: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Performing the installation 43

Installing and Uninstalling the Adapter

During this time, the java.exe process is running. Please be patient. Do not eject/reinsert the CD to start a second install process.

2. If you have not already done so, find and stop the active EMC Smarts services. For installations or uninstallations, do not stop the EMC Smarts service daemon process, sm_serviced. However, when adding additional products to an existing installation, you must stop sm_serviced. Click OK in the Warning dialog box when you have stopped all EMC Smarts services.

“Detect and stop EMC Smarts programs” on page 33 describes stopping the active EMC Smarts services.

3. Click Next in the Welcome screen to continue.

Next is disabled if:

• You do not have administrative privileges for the products you are attempting to install. An error message also displays.

• Your system failed the requirements check. If this occurs, review the check results by clicking Get System Information. Then, cancel the installation setup program, and upgrade your system.

4. Read and accept the EMC Corporation end user license agreement and click Next.

5. If the installation program detects an existing installation of the same suite, the Installation Type screen displays.

Select Install the product to a new directory.

Table 2 Setup command syntax for wizard-mode

Operating system Execute:

Solaris # ./setup-ASAM-2_1_0_0-sol.bin

Linux # ./setup-ASAM-2_1_0_0-linux.bin

Windows setup-ASAM-2_1_0_0-win.exe

If the installation program cannot find a suitable JVM (Java Virtual Machine), use the option -is:javahome <local_java_dir> to specify the path to where Java is installed. For example, <local_java_dir> can be:• Windows: C:\Program Files\Java\j2re1.5 • UNIX: /opt/java/j2re1.5

Page 44: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

44 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Note: This screen does not display if you are installing the suite for the first time on the system.

6. Click Next to accept the default installation directory or type your preferred directory and click Next.

The default installation directory is /opt/InCharge7 (on UNIX) orC:\InCharge7 on Windows.

If you specify a directory, be sure to use forward slashes (“/”)for both UNIX and Windows directories. Directory names cannot contain spaces. If the specified directory does not exist, it will be created. If you do not have write privileges, an error message displays.

Note: On the Windows 2003 (Enterprise Edition) platform, EMC Smarts products do not install properly and EMC Smarts services do not start properly when installed to a directory path containing spaces. Therefore, the directory names used in BASEDIR cannot contain spaces.

7. The Services Selection screen displays. Select the products that you wish to install as services and click Next.

Note: There is no Product Selection screen for this product.

Note: When installed as services, EMC Smarts products run when the system is running. If the system is stopped and restarted, the EMC Smarts products restart automatically. EMC Corporation recommends that EMC Smarts products be installed as services whenever possible; however, if you are installing multiple instances of the Adapter on the same host, install the Adapter as a service one time only. If any of the products being installed can be started as services, these products are displayed in the services selection screen.

8. Choose a location to install an EMC Smarts Broker or specify the location of an existing Broker. Click Next to continue.

9. Review the list of products that will be installed and the target installation directory. At the bottom of the list, the total amount of disk space required for the selected products is provided so that you can verify that adequate disk space is available. To install the products, click Next and the Installation Progress screen displays.

Page 45: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Performing the installation 45

Installing and Uninstalling the Adapter

10. Upon completion, the Installation Summary displays informational messages such as successful confirmations, error messages, and warnings. Click Finish to exit the installation. It is not necessary to restart the system after installation.

Investigate any errors or warnings. The log file is a text file with the naming convention Install.<suite>.<productversionNumber>.log. It is located in the ASAM_BASEDIR/smarts/setup/logs directory. If the installation process fails, the log files are located in the /tmp directory.

11. Unmount the CD-ROM after completing the installation. Be sure that no processes are currently accessing the drive.

12. Start and verify the installation of the suite.

13. Remove the CD-ROM after completing the installation. Be sure that no processes are currently accessing the drive.

Where to go next

“Where to go next” on page 49 provides information on what to do after installing the software.

Using CLI mode

CLI mode installation is the text-based method of executing the Installation program. This mode is intended for UNIX platforms with non-graphics consoles. The CLI mode follows the same process as the wizard mode but uses text rather than graphics.

Running CLI modeTo start the CLI mode, execute the Setup command with the -console option as shown in Table 3 on page 45.

Table 3 The setup command syntax for CLI-mode

Operating system Executable

Solaris # ./setup-ASAM-2_1_0_0-sol.bin -console

Linux # ./setup-ASAM-2_1_0_0-linux.bin -console

If the installation program cannot find a suitable JVM (Java Virtual Machine), use the option -is:javahome <local_java_dir> to indicate the path to the Java home directory. For example, <local_java_dir> can be /opt/java/j2re1.5

Page 46: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

46 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

User selections and navigation in CLI modeDuring the installation and uninstallation processes, you are prompted with a series of steps and menus:

◆ For prompts, accept the default value or select another choice. The default values are indicated in brackets. To accept the default value, press Enter. To reply “yes,” enter y or Y; to reply “no,” enter n or N. Do not press Delete; this causes the process to terminate with an error message.

◆ For selections in menus, accept the default selections or type the number of the item and press Enter. The default values are indicated in brackets or as pre-defined selections in menus. An X is used to indicate the selected item. When you are finished making selections, type zero (0) and press Enter.

If you incorrectly type an entry, press 4 to repeat the prompt and select the correct value. Arrow keys and the Backspace key are not supported.

To navigate between each step, use the keys listed in Table 4 on page 46.

Where to go next

“Where to go next” on page 49 provides information on what to do after installing the software.

Using unattended (silent) mode

Unattended mode reads the commands and settings from a user-modifiable file that you create prior to beginning the process.

Table 4 Navigation keys

Key Operation

1 Next, continue to the next step

2 Previous, go back to the previous step

3 Cancel, terminate the program

4 Redisplay, repeat the step

0 Accept the marked ([X]} menu choice

Page 47: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Performing the installation 47

Installing and Uninstalling the Adapter

Manual intervention is not necessary after you execute the setup command.

Modifying the response fileEach suite has a response file located on the CD-ROM in the /utils directory. Its naming convention is <suite>-response.txt.

The response file provides instructions and examples of command line options that are passed to the program in unattended mode. The command line options are organized by process flow. The process flow is almost identical to that of the Wizard mode.

By default, the response file includes settings that support the installation of all products from the CD-ROM and configure the broker location as localhost at port 426. You must edit the response file to change any of these settings: for example, to support Windows operating systems or specify a different broker location.

For unattended operation, modify a response file:

1. Copy the response file from the CD-ROM /utils directory to a directory on your system, for example, the /tmp directory.

2. Using any editor, modify the values for the command line options in the response file:

• Specify the target directory.

• Select a directory for the process log file.

• Select the products to install. Ensure that the property value for the product is set to true.

• Select the products to start as services. Ensure that the property value for the product is set to true.

• Specify the location of the Broker.

3. Save the file.

Page 48: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

48 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Running unattended modeExecute the Setup command from a command-line shell using the syntax in Table 5 on page 48.

For example, to start the unattended installation on Solaris when the response file is located in /tmp, execute:

# ./setup-ASAM-2_1_0_0-sol.bin -options /tmp/ALCATEL_SAM_SUITE-response.txt

Table 5 The Setup Command Syntax for Unattended Mode

Operating System Executable

Solaris # ./setup-ASAM-2_1_0_0-sol.bin-options <path>/<suite>-response.txt

Linux # ./setup-ASAM-2_1_0_0-linux.bin -options <path>/<suite>-response.txt

Windows setup-ASAM-2_1_0_0-win.exe -options <path>\<suite>-response.txt

Where: <path> is the fully qualified path to the response file and <suite> is the product suite, for example, NPM, IP, MPLS, or SAM.If the installation program cannot find a suitable JVM (Java Virtual Machine), use the option -is:javahome <local_java_dir> to indicate the path to the Java home directory. For example, /opt/java/j2sdk1.5.0_08.

Page 49: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Where to go next 49

Installing and Uninstalling the Adapter

Where to go nextEMC Smarts recommends installing managers and adapters as services. If you installed the Adapter as a service, you must start them for the first time. These services start automatically upon system reboot, but the following sections describe additional methods to start EMC Smarts services. If you did not install the products as services, you can install them now, as described in “Manually Installing the Adapter Service” on page 123. The EMC Smarts System Administration Guide provides more information.

After installing and starting the services, you verify the installation, as described in “Verify the EMC Smarts product status” on page 114.

EMC Smarts products must be configured before they can perform useful analysis and provide information to operators. To continue deploying the Adapter, perform the following tasks:

1. Configure the Adapter and associated Domain Managers, as described in “Configuring the Adapter Deployment” on page 57.

2. Copy a file from the Alcatel-Lucent 5620 SAM EMS host, as described in “Copying required .jar files” on page 64.

3. Configure security for the Adapter, as described in the EMC Smarts System Administration Guide.

4. Migrate files and parameters from a previous installation, as described in “Migrating customized files” on page 50.

5. Start up the Adapter and the associated Domain Manager services.

6. Manually initiate full discovery, as described in “Start up and Discovery” on page 107.

7. Verify product status, as described in “Verify the EMC Smarts product status” on page 114.

Page 50: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

50 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Migrating customized filesIf the Adapter was previously deployed, migrate customized files in the old (backed-up) /local directory to the new /local directory, as listed below.

1. From the old /local directory, copy the following files in their entirety and paste into the new /local directory:

• ASA-Alarm.conf

• ASA-Filter.conf

• AggregateAlarms.conf

• DevicesNotInEffect.conf

2. From the old emsConfig.import file in the /local directory, copy the following parameters and paste them into the new emsConfig.import file:

• EmsInstance

• AltEmsInstance

• AMServerName

• MPLSServerName

• OIServerName

• BGPServerName

• OSPFServerName

• ASAServerName

• MCASTServerName

• LogLevel

• JmsPort

• AltJmsPort

• ClientId

• JmsUniqueId

• JmsUser

• JmsPassword

• ClearAlarmOnDelete

• ArchiveOnDelete

• DiscoveryOnStartup

Page 51: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Migrating customized files 51

Installing and Uninstalling the Adapter

• DiscoveryOnJmsLoss

• CreateVPLSSAPs

• MulticastQTag

• IESAfterVPLS

3. If any of the following parameters exist in your old version of the emsConfig.import file, copy the parameters and paste them into the new version of the emsConfig.import file:

• ReconfigureDelayTime

• ReconfigureSlidingWindow

• MaximumReconfigureDelayTime

• EMSVersion

Note: The following parameters are no longer in version 2.1: OSPFConfigurationErrorAlarmTimeout, AdapterCompatabilityMode.

Note: The following parameters are new to version 2.1: VPLSRTPrefix,EMSReconnectInterval,MissedKeepAliveMessages,RestartTimeAfterTerminateClient.

Page 52: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

52 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Uninstalling the AdapterThis section describes uninstalling the Alcatel-Lucent 5620 SAM EMS Adapter. After uninstalling, your customized files remain saved in ASAM_BASEDIR/smarts/local.

WARNING

For UNIX only, when uninstalling EMC Smarts suites from the same server, the EMC Smarts suite that was installed first must be uninstalled last.

During the installation of the first EMC Smarts suite, the EMC Smarts Service Database is also installed and the other suites subsequently access it. Uninstalling the suite installed first will also uninstall the Service Database which will disable the sm_service command for those products, prevent their proper operation and uninstallation, and interrupt products running as services.

Perform this check by looking at the value of the SMHOME variable in /etc/init.d/ic-serviced (or /sbin/init.d/ic-serviced for HP-UX). The suite listed in SMHOME is the suite that should be uninstalled last.

WARNING

EMC Smarts product suites use standard installation software to install and uninstall product suites. You must use the uninstaller command for UNIX. For Windows, you must use the Add/Remove Programs to uninstall EMC Smarts software. Failure to use the appropriate method will result in an unstable system and/or inconsistent product directories. Do not manually delete the installed product directories.

The uninstall process is not a rollback! It removes all product suite files, not simply files that changed as a result of a new product installation. If you need a full rollback procedure, contact EMC Smarts technical support.

Page 53: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Uninstalling the Adapter 53

Installing and Uninstalling the Adapter

WARNING

If you install additional services manually by selecting Custom from the Installation Type screen, you can only uninstall those services manually. They do not uninstall when you perfom a standard uninstallation.

Detect and stop EMC Smarts programs

Before uninstalling the Adapter, you must stop all EMC Smarts services, EMC Smarts cron jobs, and any other process that uses programs or libraries in any EMC Smarts installation area, as described in “Detect and stop EMC Smarts programs” on page 33.

Uninstall using Wizard mode

Use Wizard mode to uninstall a complete suite or individual products from the local server.

1. Execute the the following command:

UNIX:

# BASEDIR/_uninst/uninstaller.bin

Windows:

# BASEDIR/_uninst/uninstaller.exe

2. Click Next in the Welcome screen to continue.

3. In the Product Selection screen, click Next to uninstall the entire suite of products (by default, all products are selected) or deselect products that should remain installed.

4. Review the list of products that will be uninstalled and the target installation directory. Once you click Next, you cannot cancel the uninstallation process.

If necessary, click Back to return to the Product Selection screen to revise your selections.

To uninstall the products, click Next; the Uninstallation Progress screen displays.

Page 54: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

54 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

5. Upon completion, the Uninstallation Summary displays informational messages such as successful confirmations, error messages, and warnings. If Next displays, your system needs to be rebooted. Click it and then reboot your system. Otherwise, click Finish to exit the uninstallation.

The log file is a text file with the naming convention Uninstall.<suite>.<productversionNumber>.log. It is located in the BASEDIR/smarts/setup/logs directory. If the uninstallation process fails, the log files are located in the /tmp directory.

6. Examine any remaining directories if you plan to re-install EMC Smarts and save customized files located in the /local directory. Depending upon the suite, some or all of the following subdirectories will remain in the BASEDIR/smarts directory after uninstallation because they contain user-modified files:

• /local

• /bin

• /setup

Uninstall using CLI mode

To uninstall an EMC Smarts product or product suite using CLI-Mode, perform the following procedure:

1. Execute the following command:

# BASEDIR/_uninst/uninstaller.bin -console

During the uninstallation processes, you are prompted with a series of steps and menus. You can either accept the default value or select another choice. The default values are indicated in brackets or as pre-defined selections (check marks) in menus. To accept the default value, press Enter.

When replying to a prompt, you can either accept the default value or select another choice. To reply “yes,” enter y or Y; to reply “no,” enter n or N. Do not press Delete; this causes the process to terminate with an error message.

For selections in menus, you can accept default selections or type the number of the item and press Enter. An X displays next to the item. When you are finished making selections, type zero (0) and press Enter.

Page 55: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Uninstalling the Adapter 55

Installing and Uninstalling the Adapter

If you incorrectly type an entry, press 4 to repeat the prompt and select the correct value. Arrow keys and the Backspace key are not supported.

2. Upon completion, the Uninstallation Summary displays informational messages such as successful confirmations, error messages, and warnings. Press Enter to continue.

3. If necessary, the Installation Program will prompt to restart your computer. Press 1 to restart immediately or press 2 to restart later.

4. If you chose not to restart your computer, press 3 to finish.

5. Examine any remaining directories if you plan to re-install the suite and save customized files located in the /local directory. Depending upon the suite, some or all of the following subdirectories will remain in the BASEDIR/smarts directory after uninstallation because they contain user-modified files:

• /classes

• /local

• /bin

• /setup

6. The installation log file is a text file with the naming convention Uninstall.<suite>.<productversionNumber>.log. It is located in the BASEDIR/smarts/setup/logs directory. If the uninstallation process fails, the log files are located in the /tmp directory.

Uninstall using unattended modeTo uninstall using unattended operation, stop EMC Smarts services including the service for the License Server. Then use the uninstaller.bin command to uninstall the software.

The log files are located in the BASEDIR/smarts/setup/logs directory. If the uninstallation process fails, the log files are located in the /tmp directory. A non-zero status indicates a failure.

To uninstall all of the products for a suite using unattended uninstallation, execute the following command:

▼# BASEDIR/_uninst/uninstaller.bin -silent -G replaceNewerResponse=”Yes to All” ▲

Page 56: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

56 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Installing and Uninstalling the Adapter

Note: ▼ ▲ indicates that this command must be typed as one line.

Page 57: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring the Adapter Deployment 57

4

This chapter explains how to configure the Alcatel-Lucent 5620 SAM EMS Adapter deployment. It includes procedures for configuring a deployment that includes the EMC Smarts MPLS Management Suite, EMC Smarts Network Protocol Management Suite, and EMC Smarts Multicast Manager. Your deployment may include some or all of these suites or products. Please ignore any procedures that do not apply to your deployment. In addition, this chapter contains configuration information for the Alcatel-Lucent SAM-O client and EMS.

◆ Configuration information ................................................................ 59◆ Configuring the Alcatel-Lucent 5620 SAM-O client ...................... 60◆ Configuring the Alcatel-Lucent 5620 SAM EMS server ................ 62◆ Copying required .jar files ................................................................. 64◆ Configuring Adapter communications............................................ 66◆ Changing the SM_LIBPATH value (Windows platform only) ..... 74◆ Configuring JMS alarm processing (ASA-Alarm.conf) ................. 75◆ Configuring JMS event processing (ASA-Filter.conf) .................... 82◆ Troubleshooting excessive message buffering on the EMS .......... 84◆ Configuring Domain Managers ........................................................ 85◆ External polling auto-configuration................................................. 97◆ Replacing existing Domain Manager repositories ......................... 99◆ Rolling the Adapter Log .................................................................. 100◆ Considerations for operation with VPLS-mode Multicast.......... 101◆ Device filtering .................................................................................. 104

Configuring theAdapter Deployment

Page 58: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

58 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Note: You may encounter some new terminology when performing configuration tasks. For example, you may see references to the ASA or ASAM (Alcatel-Lucent 5620 SAM EMS Adapter), SAM (Global Manager), InCharge (EMC Smarts software), SAM-O (Alcatel Service Aware Manager - Open Interface).

Page 59: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuration information 59

Configuring the Adapter Deployment

Configuration informationThis section provides information for configuration tasks.

Modifying EMC Smarts configuration files

To edit EMC Smarts configuration files, use the EMC Smarts sm_edit utility. For example, to open and modify the emsConfig.import file on UNIX, issue the following command from BASEDIR/smarts/bin:

sm_edit conf/alcatel-sam/emsConfig.import

“Understanding the sm_edit Utility” on page 177 describes the EMC Smarts utility for editing local copies of configuration files.

Summary of configuration tasksTo configure the deployment, do the following tasks:

◆ “Configuring the Alcatel-Lucent 5620 SAM-O client” on page 60

◆ “Configuring the Alcatel-Lucent 5620 SAM EMS server” on page 62

◆ “Copying required .jar files” on page 64

◆ “Configuring Adapter communications” on page 66

◆ “Changing the SM_LIBPATH value (Windows platform only)” on page 74

◆ “Configuring JMS alarm processing (ASA-Alarm.conf)” on page 75

◆ “Configuring JMS event processing (ASA-Filter.conf)” on page 82

◆ “Configuring Domain Managers” on page 85

◆ “Replacing existing Domain Manager repositories” on page 99

◆ “Rolling the Adapter Log” on page 100

Page 60: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

60 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Configuring the Alcatel-Lucent 5620 SAM-O clientYou must configure the Alcatel-Lucent 5620 SAM-O client to create a user with the necessary OSS Management permission to allow access to the SAM-O interface by the Adapter. The steps vary for version 5.0 and 4.0.

Note: Your installation must include a license for the Alcatel-Lucent 5620 SAM-O interface in addition to the license for the Alcatel-Lucent 5620 SAM EMS.

Configuring the Alcatel-Lucent SAM-O 5.0 clientIn the Alcatel-Lucent SAM-O client administrative interface, create the following:

◆ Scope of Command profile

◆ User Group

◆ User

1. Log in to the SAM-O client user interface as an administrator.

2. At the main window, select Administration > Security > 5620 SAM User Security.

3. In the User Security - Security Management window, click Create.

4. In the Scope of Command Profile window, select the General tab, and create entries for the following:

– Profile Name (do not use spaces or special characters); in this example, “samprofile”

– Description (optional).5. Select Scope of Command Roles tab.

a. Click Add.

b. In the window, Scope of Command Role(s) - ScopeofCommandProfile, select the Role Name, oss (Oss Management role).

c. Click OK, OK.

Page 61: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring the Alcatel-Lucent 5620 SAM-O client 61

Configuring the Adapter Deployment

6. At the User Security - Security Management window, select the UserGroups tab and create entries for the following:

– User Group (do not use spaces or special characters); in this example, the name is “samusergroup”

– Description (optional)3. Click Select.

4. In the window, Select Scope of Command Profile - UserGroup, select the Profile Name you just created; in this example, the name is “samprofile”.

5. Click OK, OK.

7. At the User Security - Security Management window, select the Users tab.

1. Create entries for the following;

– User Name (do not use spaces or special characters)– Description (optional)– User Password (This required password is used in the

Adapter configuration file, EMSConfig.import, for the parameters, EMSInstance and JmsUser, as described in Table 6 on page 67. One instance is encrypted and the other one not.)

– Confirm Password2. Click Select.

3. In the window, groupName - User, select the User Group you just created; in this example, “samusergroup”.

8. Click OK, OK.

Configuring the SAM-O 4.0 clientAfter logging in as an administrator, create a User Group with the OSS Mgmt Group permission, and then create a User associated with this User Group.

Page 62: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

62 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Configuring the Alcatel-Lucent 5620 SAM EMS serverTo configure the Alcatel-Lucent 5620 SAM EMS server to enable collection of statistics for MPLS root cause analysis, do the following:

◆ Enable the Events policy

◆ Enable a MIB Administrative State entry

◆ Set the appropriate ports for a firewall, if present

Note: This section provides an overview of the procedures to configure the Alcatel-Lucent 5620 SAM EMS server. The Alcatel-Lucent 5620 Service Aware Manager User Guide provides detailed instructions.

Enabling the Events policyEnable the Events policy, allowing the Adapter to collect VRF statistics:

1. At the 5620 SAM EMS GUI, select Tools Menu, and then select Log Records.

2. In the Manage Log Records window, modify the filter to generate a list of statistical data:

a. Specify the Log Class parameter by selecting RouteStats from the pulldown menu of log classes.

b. Specify the Log Type by choosing Log Policy.

c. Click Search. The list of statistics log records for that class appears.

3. Select Events to enable.

Enabling a MIB Administrative State entryEnable collecting of the RoutesInVrf statistics:

1. At the 5620 SAM EMS GUI, select Administration > Poller Policies. The PollerManager (Edit) form appears with the General tab selected.

Page 63: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring the Alcatel-Lucent 5620 SAM EMS server 63

Configuring the Adapter Deployment

2. Modify an existing statistics MIB policy, if necessary:

a. Select the Stats MIB Policies tab.

b. Select the Default Stats Policy, and then click Properties. The StatsPollerPolicy (Edit) window appears.

c. Click MIB Entry Policies.

d. Locate the TIMETRA-VRTR-MIB vRtrStatEntry entries. (You can sort the entries by MIB Name.) Each of these entries should show the value, Up. If any do not, click Properties to change the value.

– In the dialog box that displays, locate the Administrative State pulldown menu, and then select Up for each entry.

– Click OK to save the changes.e. Close the window.

3. Resync all routers. For assistance, check with your Alcatel-Lucent 5620 SAM EMS administrator.

Setting the appropriate ports for a firewallIf there is a firewall between the Alcatel-Lucent 5620 SAM EMS and the Adapter, ensure that the following ports are open:

For the Alcatel-Lucent 5620 SAM EMS 5.0 ◆ TCP 1096~1100

◆ TCP 4444~4447

◆ TCP 8080

◆ TCP 8443

◆ TCP 8093

For the Alcatel-Lucent 5620 SAM EMS 4.0 ◆ TCP 1098~1100

◆ TCP 4444~4445

◆ TCP 8080

◆ TCP 8443

◆ TCP 8093

The EMS planning guide provides more information.

Page 64: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

64 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Copying required .jar filesYour installation requires copies of some .jar files from the Alcatel-Lucent 5620 SAM EMS server and the installation DVD. The requirements vary for Alcatel-Lucent 5620 SAM EMS versions 4.x and 5.x.

Version 4.x

This version requires the jbossall-client.jar file from the Alcatel-Lucent 5620 SAM EMS server.

To get this file, follow these steps.

1. On the Alcatel-Lucent 5620 SAM EMS server, locate the following file:

<Alcatel-Lucent 5620 SAM EMS Install-Dir>/server/nms/jboss/client/ jbossall-client.jar

2. Copy the jbossall-client.jar file and paste it to the Adapter host at:

/ASAM_BASEDIR/smarts/local/classes

Version 5.xThis version requires the jbossall-client.jar file from the Alcatel-Lucent 5620 SAM EMS server. In addition, it requires the samOss.jar file from the Alcatel-Lucent 5620 SAM EMS installation DVD. This file is not part of the SAM EMS installation.

jbossall-client.jar fileCopy as described above.

samOss.jar fileIf you have the installation DVD:

1. Locate the following file:

../5620sam/server/nms/integrations/SAM_O/samOss.jar file

2. Copy the samOss.jar file and paste it to the Adapter host at:

/ASAM_BASEDIR/smarts/local/classes

Page 65: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Copying required .jar files 65

Configuring the Adapter Deployment

Note: If you do not have the installation DVD, contact your Alcatel-Lucent OIPS technical support representative for information on how to obtain the samOSS.jar.

Page 66: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

66 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Configuring Adapter communicationsConfigure the Adapter to use EMC Smarts Domain Managers, along with other parameters that support communications between the Adapter and the Domain Managers.

IMPORTANT!No prior version of EMSConfig.import that may have been previously installed is compatible with this version of the Adapter. You may wish to save the file in another location so you can refer to information such as network addresses.

Edit the newly installed file with the procedure described below.

Note: “Considerations for operation with VPLS-mode Multicast” on page 101 provides important considerations when configuring for a Multicast deployment.

Note: When configuring the Adapter, you must include the MD-5-hashed version of the password for the Alcatel-Lucent 5620 SAM EMS. “Generating an MD-5-hashed password” on page 73 provides instructions.

1. At ASAM_BASEDIR/smarts/bin, issue the following command:

sm_edit conf/alcatel-sam/emsConfig.import

2. Specify values for the parameters listed in Table 6 on page 67, as appropriate for your deployment.

Note: This procedure assumes that you are configuring a deployment that includes the IP Availability Manager, Adapter Platform, MPLS Manager, Multicast Manager, and NPM Managers for BGP and OSPF. The specific configuration parameters that control these options are listed in Table 6 on page 67 and shown in boldface type. They include the following: OIServerName, AMServerName, OSPFServerName, BGPServerName, MCASTServerName, and MPLSServerName. If you wish to leave the Multicast, BGP, or OSPF Managers out of your deployment, configure one or more of these character strings as blank.

3. Save the file.

“Understanding the sm_edit Utility” on page 177 provides more information.

Page 67: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Adapter communications 67

Configuring the Adapter Deployment

Adapter configuration parametersWhen configuring the parameters listed in Table 6 on page 67, you must configure server names for the following:

◆ IP Availability Manager (AMServerName)

◆ Adapter Platform (OIServerName)

◆ Adapter server name (ASAServerName)

The MPLS, Multicast, BGP, and OSPF servers are optional. If the field for an optional server, such as McastServerName, is left empty, the Adapter will run without attempting to access that server.

Table 6 Adapter configuration parameters (1 of 6)

parameter type description values

EmsInstance 4 strings Specifies: • IP address where the

Alcatel-Lucent 5620 SAM EMS server is running

• Alcatel-Lucent 5620 SAM EMS server port number

• user login• user password (must be

MD-5-Hashed)

• An IP address• The port number, usually 8080• The Alcatel-Lucent 5620 SAM EMS

user login name in clear text• The MD-5-hashed version of the

password described in Step 7 of “Configuring the Alcatel-Lucent 5620 SAM-O client” on page 60.

“Generating an MD-5-hashed password” on page 73 provides important instructions.NOTE: This user name must be configured with OSS Management privileges.NOTE: For assistance with Alcatel-Lucent 5620 SAM EMS user names and passwords, consult your Alcatel-Lucent administrator.

Page 68: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

68 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

AltEmsInstance 4 strings For the standby Alcatel-Lucent 5620 SAM EMS server, specifies:• IP address where the

Alcatel-Lucent 5620 SAM EMS server is running

• Alcatel-Lucent 5620 SAM EMS server port number

• user login• user password (must be

MD-5-Hashed)

• An IP address• The port number, usually 8080• The Alcatel-Lucent 5620 SAM EMS

user login name in clear text• The MD-5-hashed version of the

password described in Step 7 of “Configuring the Alcatel-Lucent 5620 SAM-O client” on page 60.

“Generating an MD-5-hashed password” on page 73 provides important instructions.NOTE; If there is no standby Alcatel-Lucent 5620 SAM EMS server, enter the same values as for EmsInstance.NOTE: For assistance with Alcatel-Lucent 5620 SAM EMS user names and passwords, consult your Alcatel administrator.

AMServerName string Name of the EMC Smarts IP Availability Manager server

Default, INCHARGE-AM

OIServerName string Name of the EMC Smarts Adapter Platform Server

Default, INCHARGE-OI

ASAServerName string Name of the EMC Smarts Alcatel-Lucent 5620 SAM EMS Adapter server

Default, ALCATEL-SAM

MPLSServerName string Name of the EMC Smarts MPLS Manager server

Default, INCHARGE- MPLS-TOPOLOGY

BGPServerName string Name of the EMC Smarts Network Protocol Manager for BGP server

Default, INCHARGE-BGP

OSPFServerName string Name of the EMC Smarts Network Protocol Manager for OSPF server.

Default, INCHARGE-OSPF

MCASTServerName string Name of the EMC Smarts Multicast Manager server

Default, INCHARGE-MCAST

Table 6 Adapter configuration parameters (2 of 6)

parameter type description values

Page 69: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Adapter communications 69

Configuring the Adapter Deployment

LogLevel integer Data logged at this level or more important is kept; other data is discarded.

• Level 1 will log severe messages only.• Level 2 will log warnings and severe

messages.• Level 3 will log informational

messages, warnings, and severe messages.

• Level 7 will log everything (including verbose internal messages).

JmsPort string Indicates the URL:port where the SAM-O accepts requests to monitor asynchronous events

Must be resolvable from the machine where the adapter is running.NOTE: The Alcatel-Lucent 5620 SAM EMS behaves differently based on which JMS Ports are selected. If the 5620 SAM EMS is running in • Standalone mode—Use port 1099.• Redundant mode—Use port 1100. Ensure that you have the correct configuration entries in the emsConfig.import file for JmsPort and AltJmsPort. If necessary, check with your Alcatel-Lucent 5620 SAM EMS administrator to determine the mode.

AltJmsPort string Indicates the URL:port on the standby Alcatel-Lucent 5620 SAM EMS server where the SAM-O accepts requests to monitor asynchronous events.Note that 5620 SAM EMS has specific requirements for running in standalone and “High Availability” modes. Typically, port 1099 is used for standalone and port 1100 is used for High Availability.Be sure to check with your 5620 SAM EMS administrators when setting the value for this field. If it is improperly set, the Adapter will not be able to connect to the alternate 5620 SAM EMS server when a switchover occurs.

Must be resolvable from the machine where the adapter is running.Must be resolvable from the machine where the adapter is running.NOTE: The Alcatel-Lucent 5620 SAM EMS behaves differently based on which JMS Ports are selected. If the 5620 SAM EMS is running in • Standalone mode—Use port 1099.• Redundant mode—Use port 1100. Ensure that you have the correct configuration entries in the emsConfig.import file for JmsPort and AltJmsPort. If necessary, check with your Alcatel-Lucent 5620 SAM EMS administrator to determine the mode.

ClientId string The identifier the Adapter is to use when making XML requests to Alcatel-Lucent 5620 SAM EMS.

Recommended to be of format: smarts@12345

Table 6 Adapter configuration parameters (3 of 6)

parameter type description values

Page 70: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

70 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

JmsUniqueId string For durable JMS connections, this ID identifies the Adapter to the Alcatel-Lucent 5620 SAM EMS server.

Recommended to be of format: smarts@12345NOTE: For non-durable JMS connections, leave this field blank.

JmsUser string JMS connections require valid user names and passwords. This field specifies the user name to be used by the adapter.

Must match the user name configured on the Alcatel-Lucent 5620 SAM EMS server, as provided by your Alcatel administrator. Step 7 of “Configuring the Alcatel-Lucent 5620 SAM-O client” on page 60 provides instructions.NOTE: This user name must be configured with OSS Management privileges.NOTE: For assistance with Alcatel-Lucent 5620 SAM EMS user names and passwords, consult your Alcatel administrator.

JmsPassword string JMS connections require valid user names and passwords. This field specifies the password to be used by the adapter.

Must match the password configured on the Alcatel-Lucent 5620 SAM EMS server, as provided by your Alcatel administrator. Step 7 of “Configuring the Alcatel-Lucent 5620 SAM-O client” on page 60 provides instructions.This must be the clear text version, not the md5-hashed version.NOTE: For assistance with Alcatel-Lucent 5620 SAM EMS user names and passwords, consult your Alcatel administrator.

ClearAlarmOnDelete boolean When SAM-O deletes alarms, this parameter indicates whether the corresponding notifications should be cleared.

TRUE or FALSE. Default is TRUE.NOTE: This parameter is in effect only when ArchiveOnDelete is set to TRUE.

ArchiveOnDelete boolean When SAM-O deletes alarms, this parameter indicates whether the corresponding notifications should be archived.

TRUE or FALSE. Default is TRUE.

Table 6 Adapter configuration parameters (4 of 6)

parameter type description values

Page 71: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Adapter communications 71

Configuring the Adapter Deployment

DiscoveryOnStartup boolean Indicates if a full discovery should be started after the adapter has started and initialized. This should be set to TRUE the first time the adapter is started.

TRUE or FALSEDefault is FALSE.NOTE: Alcatel-Lucent does not recommend that you set this parameter to TRUE. If the parameter is set to TRUE, the Adapter will start a full discovery upon startup. After the repositories are populated by a discovery, you should set this parameter to FALSE for future restarts.

DiscoveryOnJmsLoss boolean Indicates if a full discovery should be started after the Adapter reports JMS events were lost or the adapter server switches between primary and standby.

TRUE or FALSE. Default is TRUE.

MulticastQTag integer This tag enables or disables VPLS-mode Multicast functionality. • If the value is negative, the

functionality is disabled.• If the value is non-negative, the

functionality is enabled. MulticastQTag will look for VPLSs between 7750 and 7450 with this encapsulation value and create PIMInterfaces over the interfaces.

The functionality is disabled by default, with the value set to -1.To enable the functionality, use a value such as 4000.“Considerations for operation with VPLS-mode Multicast” on page 101 provides important information.

IESAfterVPLS boolean When using MulticastQTag, this configuration will determine if the Multicast IES port on the 7750 is the one before (FALSE) or after (TRUE) the VPLS port.

TRUE or FALSE. Default is TRUE“Considerations for operation with VPLS-mode Multicast” on page 101 provides important information.

CreateVPLSSAPs boolean Indicates if Service Access Point objects should be created in EMC Smarts software from Alcatel-Lucent 5620 SAM EMS data. In some applications, the number of Access Points is very great and the benefit of translation is small.

TRUE or FALSE. Default is FALSE.

Table 6 Adapter configuration parameters (5 of 6)

parameter type description values

Page 72: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

72 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

ReconfigureDelayTime integer Determines how long the adapter initially delays before invoking a reconfigureAndWait on a backend EMC Smarts analysis server. Running a reconfiguration too often can cause performance issues on the backend servers. Certain processes inside the adapter require a reconfigure to take place before processes can run.

This time is specified in seconds and defaults to 180 seconds (3 minutes).

ReconfigureSlidingWindow integer Determines how long the adapter waits after ReconfigureDelayTime for a quiet period. This parameter is used to slide the delay forward in tiny increments when topology changes are still rapidly being processed by the adapter.

This time is specified in seconds and defaults to 10 seconds.

MaximumReconfigureDelayTime

integer Determines the maximum delay the adapter will wait before invoking a reconfigureAndWait on a backend EMC Smarts analysis server. This value should be longer or the same as ReconfigureDelayTime.

The time is specified in seconds and defaults to 210 seconds (3.5 minutes).

EMSVersion string Specifies the EMS version 4.0 and 5.0 Default is 5.0

VPLSRTPrefix integer The adapter will use this prefix to create RouteTargets for each VPLS. It is highly recommended this value is chosen such that the resulting RouteTarget, which is formed by combining it with VPLS ServiceId, will not collide with RouteTargets of VPRN VPN.

Default is 9999

EMSReconnectInterval integer Specifies the interval at which the adapter tries to reconnect to the EMS server. This value is in seconds.

Default is 60

MissedKeepAliveMessages integer Specifies the number of consecutive KeepAlive messages that are missed to determine the EMS Connection to have failed.

Default is 3

Table 6 Adapter configuration parameters (6 of 6)

parameter type description values

Page 73: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Adapter communications 73

Configuring the Adapter Deployment

Generating an MD-5-hashed passwordYou must create an MD-5-hashed version of the password for each Alcatel-Lucent 5620 SAM EMS server. Using a clear-text password may suspend the account. To convert a clear-text password string, follow these steps:

1. Open a command tool or shell on the Alcatel-Lucent 5620 SAM EMS server.

2. Go to the <install directory>/nms/bin directory, where <install directory> is the server installation directory.

3. Run the md5hash command, as follows:

md5hash.bash

4. Convert the password, as follows:

mdh5hash <password string>

where <password string> is the password that you want to convert to MD5hash format.

5. Copy and paste the resulting MD5-hashed password string to the password area of the EmsInstance and AltEmsInstance fields of the emsConfig.import file.

Page 74: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

74 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Changing the SM_LIBPATH value (Windows platform only)The Adapter software includes a UNIX-specific default value for the SM_LIBPATH variable in the runcmd_env.sh file. If your deployment is in a UNIX environment, no change is needed.

If your deployment is in a Windows environment, change this value, as follows:

1. At ASAM_BASEDIR\smarts\bin, issue the following command:

sm_edit conf\runcmd_env.sh

2. Change the value for the SM_LIBPATH variable, as follows:

SM_LIBPATH=C:\InCharge7\ASAM\smarts\jre\lib

3. Save the runcmd_env.sh file and close it.

Page 75: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring JMS alarm processing (ASA-Alarm.conf) 75

Configuring the Adapter Deployment

Configuring JMS alarm processing (ASA-Alarm.conf)

IMPORTANT!JMS alarm processing and event processing are handled separately. “Configuring JMS event processing (ASA-Filter.conf)” on page 82 provides event configuration information.

IMPORTANT!“Troubleshooting excessive message buffering on the EMS” on page 84 provides information about diagnosing and remedying JMS communications problems.

You can configure the Adapter to specify mapping of Alcatel-Lucent 5620 SAM EMS alarms to Global Manager notifications. These alarms are received over the JMS interface. Mapping is done in the ASA-Alarm.conf file, which contains default behavior specifications and examples of how to change default behavior for specific alarms.

At a minimum, you should specify values for SEVERITY, DEDUP, EXPIRATION, and NOTARGET times. In addition, if you wish to override the default values for specific alarms, discard an alarm, or have additional text added to the notification, specify those preferences in this file.

Note: Many customers use this mapping to filter out JMS alarms that report conditions that are also detected by EMC Smarts software. To facilitate this, the default configuration file has some annotated suggestions for filtering out such alarms.

Page 76: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

76 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Table 7 on page 76 describes the configurable parameters for this file.

To configure the alarm mapping, follow these steps.

1. At ASAM_BASEDIR/smarts/bin, issue the following command:

sm_edit conf/alcatel-sam/ASA-Alarm.conf

2. Find the section, # Configurations for ASA.

3. Type the new value, as required for your configuration. The following sample shows the section of code.

# Configurations for ASA## Event Active/Inactive - used to disable events, default is ACTIVE# INACTIVE alarm-xx-xx-xx## Event De-duplication - used to block repeat events# DEDUP DEFAULT represents default response# DEDUP alarm-xx-xx-xx represents individual DEDUP value#

Table 7 Alarm processing parameters

Parameter Description Context specifier Allowed values

SEVERITY If Alcatel-Lucent 5620 SAM EMS does not provide a value for SEVERITY for an alarm, the Adapter assigns this default value.

[DEFAULT | alarm-xx-xx-xx] Integer from 1-8. Default is 7.

EXPIRATION Default value for expiration of an alarm.

[DEFAULT | alarm-xx-xx-xx] Integer seconds till expiration. Default is 0

DEDUP If the value is set to ON, the Adapter suppresses repeated notifications.

[DEFAULT | alarm-xx-xx-xx] ONOFF

NOTARGET For notifications not modeled by the Adapter, the expiration time is set to this value.

Not applicable Integer seconds until expiration. Default is 0

INACTIVE The specified alarm is discarded so it is not passed to the Adapter Platform.

[alarm-xx-xx-xx] Not applicable

COMMENT Text string to be added to the notification.

[alarm-xx-xx-xx] Text of comment

Page 77: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring JMS alarm processing (ASA-Alarm.conf) 77

Configuring the Adapter Deployment

# Event Comments - appears at the end of event text# COMMENT alarm-xx-xx-xx "This is a sample comment"## Event Severity - used if actual severity is not included in event# SEVERITY DEFAULT 7 (MAJOR)# SEVERITY alarm-xx-xx-xx 8 (CRITICAL) ## Event Expiration - time in seconds to delete notification after becoming inactive# EXPIRATION DEFAULT 3600 (1 hour)# EXPIRATION alarm-xx-xx-xx 60## NoTarget expiration - expiration time for SAMO alarms without corresponding InCharge objects# NOTARGET 28800##------------------------------------------------------------DEDUPDEFAULT ONSEVERITY DEFAULT 7EXPIRATION EFAULT3600NOTARGET 28800#DEDUPalarm-305-11-90OFFINACTIVEalarm-305-11-90COMMENTalarm-305-11-90 "This is a test event"SEVERITYalarm-305-11-90 8EXPIRATIONalarm-305-11-9014400#INACTIVEalarm-306-1-1#5620Sam severities are translated to InCharge severities as follows:8 -> 17 -> 26 -> 35,4,3,2 -> 41 -> 5

Considerations for working with alarmsThe following are some suggestions for working with Alcatel-Lucent 5620 SAM EMS alarms.

Alarm default expiration timeA default expiration time can be set for all alarms or specific alarms via the adapter alarm configuration file so that the alarm(s) will be cleared in EMC Smarts even if they are not cleared in the

Page 78: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

78 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Alcatel-Lucent 5620 SAM EMS server. If an alarm expiration is set to 0, it will stay in the EMC Smarts Notification Log until a clear is sent by the Alcatel-Lucent 5620 SAM EMS server via the Adapter.

Alarms for objects with no associated repository objectsThe Adapter will send alarms on objects that are not modeled in EMC Smarts repositories. These are referred to as NOTARGET alarms. These too will be placed in the EMC Smarts Notification Log, but they will not be associated with anything in EMC Smarts. The NOTARGET alarms can be identified as alarms with Class names that start with SAMO- in the EMC Smarts Notification Log. The adapter alarm configuration file permits a different default value to be set for NOTARGET alarms than for alarms that have associated objects in EMC Smarts.

Alarms that are set for manual clearingThe adapter is configured by default to assume that operators will manually clear some alarms. Alarms may report unusual conditions but not clear when the conditions are cleared, assuming that an operator will clear the alarm. This is not an optimum condition a user would prefer in the EMC Smarts software environment. Consult the Alcatel-Lucent 5620 SAM EMS training documentation for setting policies consistent with your operation.

Alarm synchronizationRequesting a full discovery automatically synchronizes the alarms in the EMC Smarts Notification Log with the alarms in the Adapter. That is, it removes alarms in EMC Smarts software that are no longer in the Adapter, and it reintroduces alarms that have been removed or are missing from the Adapter.

Note: The Adapter does not reintroduce alarms if the alarm is configured to be INACTIVE. If you change the ASA-Alarm.conf file so that alarms that were previously placed in the Adapter Platform (OI) are now inactive, sychronization will remove them.

In addition, you can manually trigger alarm rediscovery by invoking the alarmRediscover.asl script. The Adapter has some configuration alarms which do not clear when the configuration problem is fixed, so the alarmRediscover.asl script can remove alarms for conditions that no longer apply.

Page 79: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring JMS alarm processing (ASA-Alarm.conf) 79

Configuring the Adapter Deployment

Aggregating alarmsYou can aggregate alarms for convenience. When the Adapter sees one of the aggregating alarms, it creates an aggregated alarm. The notification for the aggregate alarm is formed on the instance that triggered the alarm. The eventName of the notification is the name of the specified aggregate.

Note: The ASA-Alarm.conf file does not recognize wildcard entries for alarms.

To configure aggregate alarms, follow these steps:

1. At ASAM_BASEDIR/smarts/bin, issue the following command:

sm_edit conf/alcatel-sam/AggregateAlarms.conf

2. Edit the alarm, using the following format:

AggregateAlarm { alarm-alarmName-alarmType-alarmProbableCause <another alarm> <another alarm> }

The following is an example AggregateAlarms.conf file:

# This file is where aggregate alarms are configured.# The file syntax is as follows:## aggregate-alarm { alarm1 alarm2 alarm3 }# ^ ^ ^ ^# | \ | /# The aggregate alarm \ | /# created in OI \ | /# \ | /# \ | /# aggregating 5620 alarms### The aggregating alarms can be on multiple lines like so:## aggregate-alarm { # alarm1# alarm2# alarm3# alarm4 }#

Page 80: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

80 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

# The '#' character denotes a commented line. Anything on the# line after the comment is ignored so aggregates can be# created like so:## aggregate-alarm { alarm-1-2-3 # an example 5620 alarm# alarm-2-3-4 # an example 5620 alarm# }## Alarms are of the form alarm-alarmName-alarmType-# alarmProbableCause# They can also be configured without alarmType and/or# alarmProbableCause.# This is useful to aggregate alarms based simply on the# alarmName.

# A test aggregate. Will form if any of the four 5620 test# alarms are seen.# The alarmType and alarmProbableCause are ignored; only the# alarmName is used

5620TestAggregate { alarm-15-- alarm-16--alarm-17-- alarm-18--}

Notes:

An alarm has the format of (literal string), alarm-<alarmName>-<alarmType>-<alarmProbableCause>. Thus an alarm has 3 fields: <alarmName>, <alarmType>, and <alarmProbableCause>. These alarms are mapped from Alcatel's fm.AlarmObject object.

Each alarm contains three field elements, separated by hyphens(-). Use the hyphen (-) as a wildcard on the <alarmType> and <alarmProbableCause> fields, if you wish to match any incoming alarm (for that particular field). To do this, leave that particular field empty in the alarm string.

For example, to aggregate on the Alcatel-Lucent 5620 NMSTestFakeAlarmOne alarm, (alarmName = 15) with a licensingAlarm type (alarmType = 23) and a FakeAlarmOne probable cause(alarmProbableCause = 13), write the alarm as:

alarm-15-23-13

To ignore the type and probable cause fields, write it as alarm-15--

Page 81: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring JMS alarm processing (ASA-Alarm.conf) 81

Configuring the Adapter Deployment

You can use wildcards to aggregate alarms based on any given <alarmType> or <alarmProbableCause>.

◆ To match all types, leave the< alarmType> field blank; for example,

alarm-15--10

◆ To match all causes, leave the leave the <alarmProbableCause> field blank; for example,

alarm-15-10-

◆ To match all types and causes, leave both alarm fields blank; for example,

alarm-15--

You can reload alarms from the AggregateAlarms.conf file without restarting the adapter by running the sm_adapter command.

At ASAM_BASEDIR/smarts/bin, issue the following command:

sm_adapter -s <Adapter Name> alcatel-sam/reloadOI.asl

Page 82: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

82 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Configuring JMS event processing (ASA-Filter.conf)

IMPORTANT!JMS alarm processing and event processing are handled separately. “Configuring JMS alarm processing (ASA-Alarm.conf)” on page 75 provides alarm configuration information.

You can configure the Alcatel-Lucent 5620 SAM EMS Adapter to use either a durable or non-durable JMS connection to monitor Alcatel-Lucent 5620 SAM EMS events through the SAM-O interface. In addition, you can configure the JMS event filter.

Note: This version does not support JMS over SSL.

Monitored events

The following are the types of monitored JMS events:

◆ Object creation—For incremental inventory and alarm posting

◆ Object deletion—For incremental inventory and alarm clearing

◆ Attribute value change—For updating object properties and alarm severities

◆ State change—For monitoring JMS missed events and change of sysPrimaryIp upon which a full discovery will be triggered if configured to do so.

The JMS client subscribes to the following JMS topic: 5620-SAM-topic-xml.

JMS message filter

The Adapter filters out 5620 SAM events so that only relevant JMS messages are queried and sent to the JMS client. The Adapter includes a default file, ASA.conf, which you can modify, as needed for your deployment.

Consult the Alcatel-Lucent 5620 Service Aware Manager Release 5.0 OSS Interface Developer Guide for detailed information about JMS filters.

Page 83: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring JMS event processing (ASA-Filter.conf) 83

Configuring the Adapter Deployment

Default filterThe Adapter provides the following default JMS filter in the ASA.conf file:

This file contains Alcatel events or classes (packageName.ClassName) that will be filtered out from# JMSAlarmPropagationListEventAlarmStatusChangefile.Policyies.Iesies.Siteisis.Siteisis.Interfaceldp.Sessionl2fwd.SiteMvrl2fwd.SiteStpl2fwd.SiteFibl2fwd.CircuitFibl2fwd.AccessInterfaceFibl2fwd.SiteIgmpSnoopingmpls.Tunnelmpls.ActualHopmpls.ActualPathmpls.InSegmentmpls.OutSegmentnetw.TopologyDiscoveryRulenetw.PhysicalInterfaceCtprsvp.Interfacersvp.Sessionrsvp.Interfacesonetequipment.SonetChannelMonitorSpecificssubscr.Sitesvt.TransportConnectionsvt.SdpBindingIgmpSnpgCfgsw.ControlProcessorSoftwaresw.BackupRestoreManagersw.BackupFolderDescriptorvpls.CircuitDhcpRelayCfgDBConnectionStateChangeEventDBProxyStateChangeEvent

Modifying the default JMS filterYou can modify the filter as needed for your deployment; for example, to eliminate raw OSPFInterface alarms, add the following line to the file:

ospf.Interface

Page 84: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

84 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Troubleshooting excessive message buffering on the EMSIf your Adapter deployment is processing events but is buffering JMS messages on the Alcatel-Lucent 5620 SAM EMS, the problem may be a TCP window mismatch between the Adapter system and the EMS server. You may see the following symptoms:

◆ Adapter is processing events and shows little to no queuing

◆ 5620 SAM EMS has a continuously growing JMS buffer

To troubleshoot, first verify that the Adapter system has the same or similar TCP window as the 5620 SAM EMS. If necessary, you can change the settings.

CAUTION!These settings are system wide and take effect immediately. Contact your network engineering organization to determine the best TCP window to use for your particular network.

Procedure for Solaris platformsAs root, issue the following commands to determine your current settings:

ndd –get /dev/tcp tcp_xmit_hiwatndd –get /dev/tcp tcp_recv_hiwat

To change these settings, issue the following commands:

ndd –set /dev/tcp tcp_xmit_hiwat <new value>ndd –set /dev/tcp tcp_revc_hiwat <new value>

Page 85: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 85

Configuring the Adapter Deployment

Configuring Domain ManagersAfter configuring the Adapter, you must perform the following procedures, as required for your deployment:

◆ “Configuring the IP Availability Manager” on page 85

◆ “Configuring the MPLS Manager” on page 86

◆ “Configuring the Multicast Manager” on page 86

◆ “Configuring the Adapter Platform” on page 87

◆ “Configuring the Global Manager” on page 90

Note: If your new Alcatel-Lucent 5620 SAM EMS Adapter installation is in conjunction with upgrades from previous versions of the IP Availability Manager, NPM Manger for BGP or OSPF, Multicast Manager, or MPLS Manager, you must remove the existing repository in each Domain Manager, and configure the Domain Manager to replace the existing repository with one populated by the Adapter. “Replacing existing Domain Manager repositories” on page 99 provides instructions.

Configuring the IP Availability Manager

Configure the IP Availability Manager to support BGP and OSPF post-processing and topology creation by the NPM Managers.

1. At opt/InCharge7/IP/smarts/bin, issue the following command:

sm_edit conf/discovery/tpmgr-param.conf

2. Locate the parameter, DisableProtocolDiscovery, and set it to FALSE.

3. Save and close the file.

Page 86: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

86 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Configuring the MPLS ManagerConfigure the MPLS Manager to support post-processing of Alcatel-Lucent and non-Alcatel-Lucent topology, and to transfer NetworkConnections from the Adapter.

1. At opt/InCharge7/MPLS/smarts/bin, issue the following command:

sm_edit conf/mpls-t/dxa-am.conf

2. Locate the class statement for NetworkConnection and add the line shown below in bold, as follows:

class NetworkConnection#in Router ConnectedVia#in Switch ConnectedViaattr DisplayNamerel ConnectedTorel ConnectedSystems

3. Save and close the file.

Configuring the Multicast Manager

Note: For Alcatel-only environments, configure the Multicast Manager, as described below. There is no support for the Multicast Manager for mixed-vendor environments.

Configure the Multicast Manager by making changes in the multicast.conf file. Before configuring the Multicast Manager, you may want to consult the “Considerations for operation with VPLS-mode Multicast” on page 101.

Page 87: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 87

Configuring the Adapter Deployment

Configure the multicast.conf file1. At BASEDIR/smarts/bin, issue the following command:

sm_edit conf/mcast/multicast.conf

2. Look for the section, # InChargeDomain::InChargeDomain_INCHARGE-AM {

3. Comment out this section, as shown below.

# InChargeDomain::InChargeDomain_INCHARGE-AM {# Type = "AM"# DomainName = "INCHARGE-AM"# DisplayName = "INCHARGE-AM"# }

4. Set values as shown for the following variables:

• IsEMS = TRUE

• DisableReconfigure=FALSE

5. Restart the Multicast Manager.

Configuring the Adapter PlatformYou configure the Adapter Platform to receive notifications from the Alcatel-Lucent 5620 SAM EMS Adapter in the Domain Section of the Adapter Platform icoi.conf configuration file. The file, which consists of several sections, is located in the BASEDIR/SAM/smarts/conf/icoi directory where BASEDIR represents the installation directory.

This entry ensures that the Notification Log will generate a notification if the connection with the Adapter is lost, and will clear the notification when the connection is reestablished.

Note: You must first copy the dxa-oi-from-asa.conf file from the Adapter installation area and place it into the Adapter Platform. These files might be on different hosts.

Page 88: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

88 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Copying the DXA fileUse this procedure for the Service Assurance Manager version 6.5.3 or 7.1, as appropriate for your deployment.

1. Copy the following file:

ASAM_BASEDIR/smarts/conf/alcatel-sam/dxa-oi-from-asa.conf

2. Paste this file into:

BASEDIR/SAM/smarts/local/conf/icoi

3. Follow the procedure for “Adding a Domain Section to the icoi.conf file (Service Assurance Manager 6.5.3)” on page 88 or “Adding a Domain Section to the icoi-default.xml file (Service Assurance Manager 7.1)” on page 89, as appropriate for your deployment.

Adding a Domain Section to the icoi.conf file (Service Assurance Manager 6.5.3)Use this procedure for an installation that includes Service Assurance Manager 6.5.3.

1. At BASEDIR/smarts/bin (default, /opt/InCharge<n>/SAM/smarts/bin), issue the following command.

sm_edit conf/icoi/icoi.conf

2. Find the DomainType definition in the file and add a DomainType entry for the Alcatel-Lucent 5620 SAM EMS Adapter. The portion of the icoi.conf file relevant to this discussion is shown in the following display.

DomainSection{

DomainType {

ConfFile = "dxa-oi-from-asa.conf"; MinimumCertainty = 0.0; SmoothingInterval = 0; Name = <"ALCATEL-SAM">; }

}

Page 89: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 89

Configuring the Adapter Deployment

3. Set the Name field to the name of your Alcatel-Lucent 5620 SAM EMS Adapter instance.

Name = <"ALCATEL-SAM">;

Where <"ALCATEL-SAM"> is the name used for the instance of Alcatel-Lucent 5620 SAM EMS Adapter in your deployment.

4. Save the icoi.conf file. The modified version of the file is saved to the BASEDIR/smarts/local/conf/icoi directory in the Global Manager installation area.

Adding a Domain Section to the icoi-default.xml file (Service Assurance Manager 7.1)Use this procedure for an installation that includes Service Assurance Manager 7.1.

1. At BASEDIR/smarts/bin, issue the following command:

sm_edit conf/icoi/icoi-default.xml

2. Find the <domaintype> section.

3. This section may not already be present. To enable the Adapter with your deployment, add this section.

<domaintype name=”<Adapter_Name>”dxaConfFile="dxa-oi-from-asa.conf"MinimumCertainty="0.0"SmoothingInterval="0"><description>Type for ASAM Adapter</description><domainname><Adapter_Name></domainname></domaintype>

<domainname=”<Adapter_Name>”domaintypename=”<Adapter_Name>”enable="True"><description>Alcatel SAM Adapter</description></domain>

Where <Adapter_Name> is the name used for the instance of Alcatel-Lucent 5620 SAM EMS Adapter in your deployment; for example, ALCATEL-SAM, as shown below

<domaintype name=”ALCATEL-SAM”dxaConfFile="dxa-oi-from-asa.conf"MinimumCertainty="0.0"SmoothingInterval="0"><description>Type for ASAM Adapter</description>

Page 90: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

90 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

<domainname>ALCATEL-SAM</domainname></domaintype>

<domainname=”ALCATEL-SAM”domaintypename=”ALCATEL-SAM”enable="True"><description>Alcatel SAM Adapter</description></domain>

4. Save the icoi-default.xml file. The modified version of the file is saved to the BASEDIR/smarts/local/conf/icoi directory in the Global Manager installation area.

The EMC Smarts Service Assurance Manager Configuration Guide provides detailed configuration information.

Configuring the Global ManagerConfigure the Global Manager to specify the source Domain Managers. Configuration Instructions vary for version 7.1 and versions 7.0.2 and 6.5.3.

Note: “External polling auto-configuration” on page 97 provides important information about the auto-configuration feature that supports external polling by the Alcatel-Lucent 5620 SAM EMS Adapter for the deployments that include the IP Availability Manager, MPLS Manager, or NPM Managers for BGP and OSPF.

Configuring version 7.11. At BASEDIR/smarts/bin, issue the following command:

sm_edit conf/ics/ics-default.xml

2. Find the <domainconfig> section.

3. For each of the Domain Managers in your deployment, add configuration sections as follows, if they are not already present and enabled. The sample entries use the default server name, and show the “enable” value in bold, where you may need to change the value.

The EMC Smarts Service Assurance Manager Configuration Guide provides detailed configuration information.

Page 91: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 91

Configuring the Adapter Deployment

IP Availability ManagerThis configuration should be present and enabled.

<domaintypename="INCHARGE-AM-SUITE"dxaConfFile="dxa-conn.conf"MinimumCertainty="0.01"SmoothingInterval="65"><description>Type for INCHARGE-AM-SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-AM</domainname></domaintype>

<domainname="INCHARGE-AM"domaintypename="INCHARGE-AM-SUITE"enable="True"><description>AM analysis domain</description></domain>

IP Availability and Performance Manager This configuration should be present but disabled.

<domaintypename="INCHARGE-AM-PM-SUITE"dxaConfFile="dxa-conn-perf.conf"MinimumCertainty="0.01"SmoothingInterval="65"><description>Type for InCharge AM PM SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-AM-PM</domainname></domaintype>

<domainname="INCHARGE-AM-PM"domaintypename="INCHARGE-AM-PM-SUITE"enable="True"><description>AM/PM domain</description></domain>

Page 92: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

92 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Adapter Platform (OI Server) This configuration is disabled by default. To enable it, change the “enable” field in the “domain” section to “True”, as shown below.

<domaintypename="INCHARGE-OI-SUITE"dxaConfFile="dxa-oi.conf"MinimumCertainty="0.24"SmoothingInterval="65"><description>Type for InCharge OI Server</description><hook enable="False">ics/dxa-sample-nl-hook.asl</hook><domainname>INCHARGE-OI</domainname></domaintype>

<domainname="INCHARGE-OI"domaintypename="INCHARGE-OI-SUITE"enable="True"><description>InCharge OI Domain</description></domain>

MPLS Manager This configuration is disabled by default. To enable it, change the “enable” field in the “domaingroup” section to “True”, as shown below.

<domaintypename="INCHARGE-MPLS-ANALYSIS-SUITE"dxaConfFile="dxa-mpls-vpn-ics-analysis.conf"MinimumCertainty="0.01"SmoothingInterval="65"><description>Type for INCHARGE-MPLS-ANALYSIS-SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-MPLS-ANALYSIS</domainname><update update_value="TRUE"></update></domaintype>

<domaintypename="INCHARGE-MPLS-MONITORING-SUITE"dxaConfFile="dxa-mpls-vpn-ics-monitoring.conf"MinimumCertainty="0.01"SmoothingInterval="65"><description>Type for INCHARGE-MPLS-MONITORING-SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-MPLS-MONITORING</domainname><update update_value="TRUE"></update></domaintype>

Page 93: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 93

Configuring the Adapter Deployment

<domaintypename="INCHARGE-MPLS-TOPOLOGY-SUITE"dxaConfFile="dxa-mpls-vpn-ics-topology.conf"MinimumCertainty="0.01"SmoothingInterval="65"><description>Type for INCHARGE-MPLS-TOPOLOGY-SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-MPLS-TOPOLOGY</domainname><update update_value="TRUE"></update></domaintype>

<domaingroupname="INCHARGE-MPLS"enable="True"><description>MPLS Group</description><analysis name="INCHARGE-MPLS-ANALYSIS"></analysis><monitoring name="INCHARGE-MPLS-MONITORING"></monitoring><topology name="INCHARGE-MPLS-TOPOLOGY"></topology></domaingroup>

<domainname="INCHARGE-MPLS-ANALYSIS"domaintypename="INCHARGE-MPLS-ANALYSIS-SUITE"enable="False"><description>MPLS analysis domain</description><group name="INCHARGE-MPLS"><role type="Analysis"></role></group></domain>

<domainname="INCHARGE-MPLS-MONITORING"domaintypename="INCHARGE-MPLS-MONITORING-SUITE"enable="False"><description>MPLS monitoring domain</description><group name="INCHARGE-MPLS"> <role type="Monitoring"></role></group></domain>

<domainname="INCHARGE-MPLS-TOPOLOGY"domaintypename="INCHARGE-MPLS-TOPOLOGY-SUITE"enable="False"><description>MPLS topology domain</description><group name="INCHARGE-MPLS"><role type="Topology"></role></group></domain>

Page 94: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

94 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Multicast ManagerThis section may not already be present. To enable the Multicast Manager for your deployment, add this section.

<domaintypename="INCHARGE-MCAST-SUITE"dxaConfFile="dxa-mcast.conf"MinimumCertainty="0.24"SmoothingInterval="65"><description>Type for INCHARGE-MCAST-SUITE</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-MCAST</domainname></domaintype>

<domainname="INCHARGE-MCAST"domaintypename="INCHARGE-MCAST-SUITE"enable="True"><description>InCharge MCAST Domain</description></domain>

BGP Manager This section may not already be present. To enable the BGP Manager for your deployment, add this section.

<domaintypename="INCHARGE-BGP-SUITE"dxaConfFile="dxa-bgp.conf"MinimumCertainty="0.24"SmoothingInterval="65"><description>Type for BGP Server</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-BGP</domainname></domaintype>

<domainname="INCHARGE-BGP"domaintypename="INCHARGE-BGP-SUITE"enable="True"><description>InCharge BGP Domain</description></domain>

Page 95: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Configuring Domain Managers 95

Configuring the Adapter Deployment

OSPF ManagerThis section may not already be present. To enable the OSPF Manager for your deployment, add this section.

<domaintypename="INCHARGE-OSPF-SUITE"dxaConfFile="dxa-ospf.conf"MinimumCertainty="0.24"SmoothingInterval="65"><description>Type for OSPF Server</description><hook enable="False">ics/dxa-sample-hook.asl</hook><domainname>INCHARGE-OSPF</domainname></domaintype>

<domainname="INCHARGE-OSPF"domaintypename="INCHARGE-OSPF-SUITE"enable="True"><description>InCharge OSPF Domain</description></domain>

Configuring versions 7.0.2 and 6.5.31. At BASEDIR/smarts/bin, issue the following command:

sm_edit conf/ics/ics.conf

2. Find the DomainSection.

3. For each of the Domain Managers in your deployment, uncomment the section. The sample entries use the default server names.

#Availability Manager#DomainSection#{#DomainType#{# ConfFile = "dxa-conn.conf";# MinimumCertainty = 0.01;# SmoothingInterval = 65;# Name = "INCHARGE-AM";# }#}#Adapter Platform#DomainSection#{#DomainType# {# ConfFile = "dxa-oi.conf";# MinimumCertainty = 0.01;# SmoothingInterval = 65;

Page 96: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

96 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

# Name = "INCHARGE-OI";# }#}#MPLS Manager#DomainSection#{#DomainType# {# ConfFile = "dxa-mpls-vpn-ics.conf";# MinimumCertainty = 0.0;# SmoothingInterval = 0;# Name = "INCHARGE-MPLS";# }}#Multicast Manager#DomainSection#{#DomainType# {# ConfFile = "dxa-mcast.conf";# MinimumCertainty = 0.24;# SmoothingInterval = 65;# Name = "INCHARGE-MCAST";# }#}#NPM Manager for BGP#DomainSection#{#DomainType# {# ConfFile = "dxa-bgp.conf";# MinimumCertainty = 0.24;# SmoothingInterval = 65;# Name = "INCHARGE-BGP";# }#}#NPM Manager for OSPFD#omainSection#{#DomainType# {# ConfFile = "dxa-ospf.conf";# MinimumCertainty = 0.24;# SmoothingInterval = 65;# Name = "INCHARGE-OSPF";# }#}

4. Save the file.

Page 97: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

External polling auto-configuration 97

Configuring the Adapter Deployment

External polling auto-configurationThis section describes the auto-configuration feature that supports external polling by the Alcatel-Lucent 5620 SAM EMS Adapter for the Availability Manager, MPLS Manager, and NPM Managers for BGP and OSPF.

The auto-configuration feature creates a new polling group in each Domain Manager, as listed in Table 8 on page 97. Look in the Polling and Thresholds console to verify the presence of these polling groups after installing each suite.

New polling groups

The auto-configuration feature creates new Polling Groups, as listed in Table 8 on page 97. The EMC Smarts IP Availability Manager User’s Guide, EMC Smarts MPLS Manager User’s Guide, EMC Smarts Network Protocol Manager for BGP User’s Guide, and the EMC Smarts Network Protocol Manager for OSPF User’s Guide provide additional information about Polling and Threshold Groups.

Table 8 New polling groups (1 of 2)

Domain Manager New polling group

IP Availability Manager Available under 5620 SAM Managed Systems Polling Groups:This group is listed at higher priority than other polling groups. You can expand the group to see the following Connectivity Polling: External Poller settings: • InstrumentCards parameter (under the Parameters tab) is

set to true.• Initial Status parameter is not initialized (set to

UNKNOWN).

IP AM/PM Available under 5620 SAM Managed Systems Polling Groups:5620 SAM Managed Systems > Settings >• Connectivity Polling - External Poller• Environment Polling - External Poller

Page 98: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

98 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

MPLS Manager Available under ForwarderEndpoint Polling Groups:5620 SAM ForwarderEndpoints > Settings > ForwarderEndpoint Remote Setting

Available under LdpProtocolEndpoint Polling Groups:5620 SAM LdpProtocolEndpoint > Settings > LDP Session Remote Setting

Available under VRFs Polling Groups:5620 SAM VRFs >Settings > VRF Remote Setting

Available under LSPs Polling Groups:5620 SAM LSPs > Settings > LSP Remote Settings

NPM Manager for BGP Available under BGP Polling Groups:5620 SAM BGP >Settings > BGP External Setting

NPM Manager for OSPF Available under OSPF Polling Groups:5620 SAM OSPF >Settings > OSPF External Setting

Table 8 New polling groups (2 of 2)

Domain Manager New polling group

Page 99: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Replacing existing Domain Manager repositories 99

Configuring the Adapter Deployment

Replacing existing Domain Manager repositoriesIf your new Alcatel-Lucent 5620 SAM EMS Adapter installation is in conjunction with upgrades from previous versions of the IP Availability Manager, NPM Manger for BGP or OSPF, Multicast Manager, or MPLS Manager, you must remove the existing repository in each Domain Manager, and configure the Domain Manager to replace the existing repository with one populated by the Adapter.

To do this, start the Adapter and each Domain Manager server with an empty repository by using the --norestore option. For example, to start the Adapter,

sm_service start EMC-Smarts-ALCATEL-SAM --norestore.After all servers are started, perform a full discovery.

CAUTION!This step is required only after installation on those EMC Smarts Domain Managers that will reload with existing repositories. These procedures will override earlier settings so that the new configuration settings are used in each repository.

Page 100: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

100 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Rolling the Adapter LogThe Adapter is run as an EMC Smarts server with its log file being sent to ASAM_BASEDIR/smarts/local/logs/ <Adapter_Name>.log. As with other EMC Smarts Domain Managers, you should configure a cron job to cause the log to be rolled occasionally so it does not consume all disk space. The Managing Log Files chapter in the EMC Smarts System Administration Guide provides more information on rolling log files.

Page 101: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Considerations for operation with VPLS-mode Multicast 101

Configuring the Adapter Deployment

Considerations for operation with VPLS-mode MulticastSome multicast configurations use VPLS and IES services to deliver multicast packets between 7750s and 7450s. To ensure that your deployment of the Alcatel-Lucent 5620 SAM EMS Adapter interprets VPLS information and constructs equivalent multicast objects correctly, you must consider the issues described in this section and configure the Adapter accordingly.

The Adapter recognizes two schemes for building Multicast components from VPLS/IES combinations. These are referred to as the S-Hook and Composite Service schemes. In s-hook VPLS-mode multicast processing in an Alcatel-Lucent 5620 SAM EMS environment, a Layer 2 VPLS is established between an interface on a 7750 router and multiple customer equipment-facing ports on a 7450 switch. The VPLS uses a Label Switched Path (LSP) between the 7750 router and the 7450 switch. On the 7750 router, the Layer 2 port is connected to an Access-configured port that is configured as an IGMPInterface. When IGMP join requests arrive over the Layer 2 port, they are fed into the Access (Service) Interface capable of receiving IGMP requests.

In order to create PIMInterface objects, the Adapter uses the information at the 7750 router's Layer 2 Access Interface, along with the Network Interface used in the LSP to connect to the 7450 switch. Additionally, the 7450 Network Interface that is part of the LSP is made to serve as a PIMInterface. IGMPInterfaces are created and Layered Over the VPLS Access ports on the 7450. Any IGMPNetworks on the 7750 are used to create parallel IGMPNetworks on the 7450. Group information in the 7750 IGMPNetworks is used to create PIMHops and PIMSgEntries connecting the newly-created PIMInterface objects.

In Composite Service VPLS-mode multicast processing, a local VPLS service is created on the 7450, an IES service is created on the 7750, and a Composite Service is created with Spoke Connectors configured between the two. This capability was made possible with 5620 SAM 3.0 and is more efficient in use of hardware. For Composite Service VPLS-mode multicast circuits, the Adapter builds PIM Interfaces on either end of the tunnel connecting the 7750 to the 7450, and creates a PIMHop connecting them for each applicable MulticastGroup.

Page 102: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

102 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Recommendations for configurationThis section discusses recommendations for configuring the MulticastQTag and IESAfterVPLS parameters.

Configuring MulticastQTagThe MulticastQTag parameter enables or disables VPLS-mode multicast functionality.

◆ If the value is negative, the functionality is disabled.

◆ If the value is non-negative, the functionality is enabled. MulticastQTag will look for VPLSs between 7750 and 7450 with this encapsulation value and create PIMInterfaces over the interfaces

The functionality is disabled by default, with the value set to -1.

EMC Corporation recommends that you do not use a value of 0, which would pick up any VPLS with null encapsulation as being MPLS-related. This value corresponds to the encapsulation value that Alcatel 7750 network elements will use to tag multicast VPLSs.

To enable the functionality, use a value such as 4000.

After a discovery completes, the Adapter finds the relevant VPLSs and transforms the multicast objects as described. The Adapter also properly handles incremental discoveries for such configurations.

Configuring IESAfterVPLSFor S-Hook VPLS configuration schemes, the Adapter assumes that the VPLS port is cabled to either the immediately preceding or immediately following port. You must therefore set the Adapter configuration property, IESAfterVPLS, to indicate which convention is followed at the your site.

Multicast behavior

Note: When configuring Multicast objects in the Alcatel-Lucent 5620 SAM EMS user interface (also known as the 5620 SAM client), you should be aware that the Alcatel-Lucent 5620 SAM EMS waits until the next polling cycle to inform OSS clients such as the Adapter that changes have occurred. This period of time is configurable, but is typically 90 minutes to 24 hours.

Page 103: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Considerations for operation with VPLS-mode Multicast 103

Configuring the Adapter Deployment

If you make multicast topology changes to the Alcatel-Lucent 5620 SAM EMS client but they do not appear in the EMC Smarts Multicast Manager, try resynchronizing the IGMP and PIM objects in all the affected routers in Alcatel-Lucent 5620 SAM EMS, as described in “Synchronize alarms” on page 112. This will trigger Alcatel-Lucent 5620 SAM EMS to send changes to all listening OSSs, including the EMC Smarts Domain Managers.

Page 104: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

104 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Device filteringThe Adapter can filter devices from the Alcatel-Lucent 5620 SAM EMS server based on 5620 SAM EMS server site names. Site names appear as the DisplayName property of UnitaryComputerSystems (routers and switches) in the EMC Smarts Global Console.

Note: Setting up device filtering requires use of Adapter Scripting Language (ASL) scripts. The EMC Smarts ASL Reference Guide provides more information on rolling log files.

Overview of device filteringThe Adapter filters devices using regular expressions loaded from ASAM_BASEDIR/smarts/conf/DevicesNotInEffect.conf. Each line of the file represents one regular expression. Lines may begin with a “#” character to denote a comment. Comment lines are ignored when loading the file.

Filtered devices do not appear in InCharge analysis servers and are ignored during 5620 SAM EMS server processing. Filtering reduces the number of objects stored inside EMC Smarts servers and lessens the process load on the Adapter. Filtering is recommended on devices that are in a constant state of flux, where monitoring is not desired.

The Adapter loads filters from the DevicesNotInEffect.conf file only on Adapter startup. If you wish to change filters during Adapter runtime, you may invoke the following asl rules:

◆ alcatel-sam/showFilters.asl— Print the currently loaded filters in the Adapter.

◆ alcatel-sam/deleteFilters.asl—Delete the filters given from the specified filter frontend. This is usually a file front end loaded with the --file flag passed to sm_adapter. Filters are deleted based on exact string matching.

◆ alcatel-sam/insertFilters.asl—Insert the filters given from the specified filter frontend. This is usually a file front end loaded with the --file flag passed to sm_adapter.

◆ alcatel-sam/clearFilters.asl—Remove all filters in the adapter.

The addition and deletion of filters at runtime will not change what the Adapter is currently filtering on. A full discovery (invoked from

Page 105: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Device filtering 105

Configuring the Adapter Deployment

alcatel-sam/discover.asl) or a router-specific discovery (invoked from ASAM/routerDiscover.asl) is required to reload the Adapter's internal filtering list. A discovery is required because reloading the filter list requires several (potentially long) processes to run in order to clean up (newly) filtered objects that may exist in InCharge servers.

Sample filter procedureThe following sample procedure will perform runtime filtering on CLLI codes, based on the site name. This procedure will filter all routers and switches, where the site name begins with HOUSTX:

1. At ASAM_BASEDIR/smarts/bin, issue the following command to create a configuration file, filters.txt:

sm_edit conf/alcatel-sam/DevicesNotInEffect.conf

2. Edit the empty file to include a single line with the contents, HOUSTX.*

3. Save and close the file.

Note: Regular expressions are powerful ways of specifying how one can match character strings. To specify how to match a character string that starts with HOUSTX, one would add .* (a period followed by an asterisk) which may be slightly different that what you expect from your experience searching for files, where an asterisk is usually sufficient. In regular expressions, HOUSTX* (without the period) would match HOUST, HOUSTX, HOUSTXX, HOUSTXXX, etc. If the HOUSTX.* is specified, the matching character string must have HOUSTX and zero or more of any possible characters.

Page 106: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

106 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Configuring the Adapter Deployment

Page 107: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Start up and Discovery 107

5

This chapter describes how to start the Adapter and associated Domain Managers, verify the product status, and initiate discovery. In addition, it describes options for managing file data. The chapter contains the following information:

◆ “Starting Adapter and Domain Manager services” on page 108◆ “Initiating discovery” on page 110◆ “Managing file information” on page 112◆ “Removing an unused JMS durable connection” on page 113◆ “Verification steps” on page 114

Note: After starting up the Adapter, you must manually initiate full discovery at least one time, as described in “Initiating full discovery” on page 110.

Start up and Discovery

Page 108: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

108 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Start up and Discovery

Starting Adapter and Domain Manager services

Note: If you are starting a Domain Manager for the first time with a fresh installation, you can start the service as described in this section. If you are starting the Domain Manager after it already has a repository, you must remove the repository so the Manager can load a new one.

Note: Use the sm_service command to start and stop Adapter and Domain Manager servers that were installed as services. If you need to install a service manually, “Manually Installing the Adapter Service” on page 123 provides instructions.

Note: Execute the commands listed below from the /bin directory under any of the product paths. For example, you can execute these commands from ASAM_BASEDIR/smarts/bin.

Starting the Domain Manager services

To start the Adapter and Domain Manager servers:

1. If the Broker is not already started, issue the following command:

sm_service start ic-broker

2. To start the IP Availability Manager service, issue the following command:

sm_service start ic-am-server

3. To start the Multicast Manager service, issue the following command:

sm_service start ic-mcast-server

4. The MPLS Manager includes three servers, which are started separately. To start these services, issue the following commands:

sm_service start ic-mpls-topologysm_service start ic-mpls-analysissm_service start ic-mpls-monitoring

5. To start the Network Protocol Manager for BGP service, issue the following command:

sm_service start ic-npm-bgp-server

Page 109: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Starting Adapter and Domain Manager services 109

Start up and Discovery

6. To start the Network Protocol Manager for OSPF service, issue the following command:

sm_service start ic-npm-ospf-server

7. To start the Adapter Platform service, issue the following command:

sm_service start ic-icoi-server

8. To start the Global Manager service, issue the following command:

sm_service start ic-sam-server

9. To start the Alcatel-Lucent 5620 SAM EMS Adapter service, issue the following command:

sm_service start EMC-Smarts-ALCATEL-SAM

Stopping a Domain Manager service

To stop a service, issue the following command:

sm_service stop <server_name>

where, the server name is as listed in “Starting Adapter and Domain Manager services” on page 108. For example,

sm_service stop EMC-Smarts-ALCATEL-SAM

Page 110: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

110 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Start up and Discovery

Initiating discoveryThis section provides commands for initiating full and partial discovery.

Note: Execute these commands from ASAM_BASEDIR/smarts/bin.

Initiating full discovery

After installing, configuring, and starting the Adapter, you can manually initiate full discovery. To start a full discovery, execute the following command:

sm_adapter -s ALCATEL-SAM alcatel-sam/discover.asl

Initiating partial discoveryThis section provides the following options for initiating partial discovery:

◆ Service-only—Discovers all service elements from the Alcatel-Lucent 5620 SAM EMS (does not discover Routers, Switches, Chassis, Cards, Physical Ports, and Channels). If the network is static and you only need to refresh the records for services using it, a service-only discovery would be appropriate and quicker than a full discovery.

◆ Specific domain—Discovers elements from a specific domain, such as MPLS, Multicast or NPM.

◆ Router—Discovers a single Router with the designated IP

◆ Re-read files in the Adapter Platform

Service-only discoveryTo initiate a service-only discovery, issue the following command:

sm_adapter -s ALCATEL-SAM alcatel-sam/serviceDiscover.asl

“Scheduling a periodic discovery” on page 111 provides instructions for scheduling periodic service discovery.

Page 111: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Initiating discovery 111

Start up and Discovery

Discovery of a specific domain You may restrict the discovery to a domain managed by one of the following: MPLS Manager, Multicast Manager, NPM Manager for BGP or OSPF.

Use the -DQUALIFIER parameter, with a value of MPLS, MCAST, or NPM. For example:

▼ sm_adapter -s ALCATEL-SAM -DQUALIFIER=NPM alcatel-sam/serviceDiscover.asl▲

Router-only discovery To initiate a discovery of a single Router, issue the following command, which specifies the router IP address:

▼sm_adapter -s ALCATEL-SAM -DIP=<Router Site ID> alcatel-sam/routerDiscover.asl▲

For example,

▼sm_adapter -s ALCATEL-SAM -DIP=”10.1.1.77” alcatel-sam/routerDiscover.asl▲

Scheduling a periodic discovery

You can use periodic discovery if needed, for example, in a situation if there are problems with the JMS incremental discovery or if the JMS is intentionally disabled. For example, you can schedule periodic service discoveries to avoid using JMS for a rapidly changing topology.

If you wish to schedule periodic discoveries at time with low network usage, you can use the following procedure, which illustrates the command for a periodic service discovery.

1. At /var/spool/cron/crontabs/root, add lines such as the following example for service discovery:

# ASA Adapter# Purpose: Schedule Service Discover at 4am0 0 4 * * * BASEDIR/smarts/bin/sm_adapter -s ALCATEL-SAM asa/serviceDiscover.asl <system_temporary_files_directory>

2. Signal the crontab process to re-read the file:

crontab /var/spool/cron/crontab/root

Page 112: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

112 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Start up and Discovery

Managing file informationYou can manage various aspects of the Adapter files. This section describes how to do the following:

◆ Reload Adapter Platform files

◆ Synchronize alarms between the Alcatel-Lucent 5620 SAM EMS and the Notification Log in the Global Console

Reload Adapter Platform files If you edit the Adapter Platform ASA-Alarm.conf or AggregateAlarms.conf configuration files, you can initiate file reloading without restarting the Adapter. At BASEDIR/smarts/bin, issue the following command:

sm_adapter -s ALCATEL-SAM alcatel-sam/reloadOI.asl

Synchronize alarms

To initiate an alarm rediscovery (synchronization), issue the following command:

sm_adapter -s ALCATEL-SAM/alarmRediscover.asl

This procedure compares alarms in the EMC Smarts Notification Log with those in the Alcatel-Lucent 5620 SAM EMS Adapter and then synchronizes them. The procedure removes alarms from the Notification Log that no longer exist in the Adapter, and adds new alarms to the Notification Log.

Page 113: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Removing an unused JMS durable connection 113

Start up and Discovery

Removing an unused JMS durable connectionThe Adapter is kept informed of changes to the Alcatel network by the Alcatel-Lucent 5620 SAM EMS server. The mechanism by which this is accomplished is called Java Messaging Service (JMS). The Adapter normally connects to the server using “durable” connections. This means that if the Adapter goes down, the server will queue up changes that are taking place and deliver those changes to the Adapter when it reconnects. The Adapter is known to the server by its JmsUniqueId.

The presence of an unused JMS durable connection causes the Alcatel-Lucent 5620 SAM EMS to accumulate transactions that will never be delivered to the Adapter, consuming unnecessary disk space. The durable connections in the Alcatel-Lucent 5620 SAM EMS server are recorded in the 5620sam/server/nms/jboss/server/default/conf/jbossmq-state.xml file. Perform this command to release the server from its “obligation” to store undelivered transaction if you have changed the value of the JmsId parameter in the emsConfig.import file.

Note: To remove an unused JMS durable connection from the 5620 Sam server, use the Alcatel-Lucent 5620 SAM EMS GUI. The Alcatel-Lucent 5620 SAM EMS documentation provides instructions.

Page 114: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

114 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Start up and Discovery

Verification stepsVerify the product status and the Adapter version.

Verify the EMC Smarts product status

You can determine the current state of the products in the suite that register with the broker by issuing the following command:

BASEDIR/smarts/bin/brcontrol

This command displays a list of EMC Smarts Managers and adapters registered with the broker, their states (RUNNING, DEAD, UNKNOWN), process IDs, port numbers, and the last time that their states changed.

Also check any log files for the products. Typically, these log files are in BASEDIR/smarts/local/logs.

Determining the Adapter versionAfter the Adapter is started, the ASA.log file in the ASAM_BASEDIR/smarts/bin path contains a line indicating its version, release, and possibly sub-release, as well as the last date compiled. You can also determine this information without starting the Adapter.

At ASAM_BASEDIR/smarts/bin, issue the following command:

sm_server --version

Page 115: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Understanding Notification Log Entries 115

A

Alarms and events received from the Alcatel-Lucent 5620 SAM EMS are processed by various EMC Smarts Domain Managers (MPLS Manager, Multicast Manager, IP Availability Manager, NPM Manager for BGP, NPM Manager for OSPF) and the Adapter Platform. Root-cause and impact analysis and diagnoses created by these Domain Managers are provided to the operator through the Notification Log of the EMC Smarts Global Console, a component of the Service Assurance Management Suite. This appendix includes the following contents:

◆ Notification Log entries.................................................................... 116

UnderstandingNotification Log Entries

Page 116: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

116 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Understanding Notification Log Entries

Notification Log entriesThe Notification Log includes two general types of entries: event notifications from the Domain Managers and alarm (problem) notifications forwarded from the Alcatel-Lucent 5620 SAM EMS. Table 9 on page 116 describes some of the EMC Smarts notification entries generated by the Domain Managers, their meanings, and possible indicated actions. This table is organized by Element and Notification.

Table 9 Global Console notifications (1 of 4)

Element Notification

Event, problem, or impact Description

BGPSession Disconnected Event This event is based on a BGPSession's two BGPProtocolEndpoints. If neither of the endpoints are administratively down and at least one of them does not have PeerState = ESTABLISHED, then the BGPSession is considered to be Disconnected. An endpoint's PeerState is set from the Alcatel-Lucent 5620 SAM EMS's report of the connectionState of the endpoint (it should show as ESTABLISHED in 5620 SAM). This leads directly to the BGPSession Down problem.

Down Problem Results directly from a BGPSession Disconnected event unless there is another explanation for the Disconnected event.

Card Down Problem Determined when the operational state of a card is CRITICAL (that is, down). The operational state of a card in EMC Smarts is taken from the 5620 SAM’s report of operational state for it, which can include UNKNOWN, OK, and CRITICAL. Note that 5620 SAM reports cards as down (CRITICAL) if the card slot is provisioned but no card is present. Additionally, a Base card being Down will consume DaughterCard Down diagnoses. DaughterCard Down diagnoses will consume physical port Interfaces being Down.

ForwarderEndpoint

Down Problem Indicates that the operational or administrative status of the ForwarderEndpoint is down. This event is implemented only for Juniper devices.

Page 117: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Notification Log entries 117

Understanding Notification Log Entries

IGMPInterface Unreachable Problem Results when the InterfaceStatus of the IGMPInterface is NOTINSERVICE or NOTREADY. Such InterfaceStatus values occur when the 5620 SAM reports that the operational state or administrative state of the IGMPInterface is Down.In the case of IGMPInterfaces that are based on VPLS-mode multicast configurations, these InterfaceStatuses are based on the states of the underlying Interfaces. Note that even when the IGMPInterface is deemed unreachable, specific multicast groups are not shown as impacted.

Interface Down Problem Detected when a Physical Port Interface or a Service Interface has an operational state of DOWN and an administrative state of UP. These are values reported directly by 5620 SAM and inserted by the adapter into IP AM. For Network Interfaces, if they are not Network Connected to other Network Interfaces, the same conditions (Oper Down, Admin Up) will conclude they are Down. The presence of a Network Connection will cause a different diagnosis to be concluded. Note that an Interface Down does not by itself impact objects that use the Interface. For example, OSPF Services will be Impacted if the OSPFInterfaces are Down, not the network or physical interfaces. Presumably if either of the latter were truly Down, the OSPFInterface would also be reported Down by the 5620 SAM.

LSP Impacted Impact LSP impacts may have reported Caused Bys such as Router Down. In the 5620 SAM environment there are scenarios where these Impacts can be notified without Caused By being present. This will happen when the 5620 SAM reports an LSP's operational state to be Down. When this happens, the LSP's IsDownInRemote attribute is set to True. If the user navigates to the LSP in question then it will be IsDownInRemote.

OSPFService ABRNotInBackbone Event By default, NPM Manager for OSPF sends this event to the Notification Log. This event recognizes that there is an OSPFService that is an Area Border Router, it is not in the backbone (area 0.0.0.0), and it has associated OSPFInterfaces.

Table 9 Global Console notifications (2 of 4)

Element Notification

Event, problem, or impact Description

Page 118: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

118 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Understanding Notification Log Entries

PIMInterface PIMInterfaceUnreachable

Problem Results when the InterfaceStatus of the PIMInterface is NOTINSERVICE or NOTREADY. Such InterfaceStatus values occur when the 5620 SAM reports the operational state or administrative state of the PIMInterface is Down. In the case of PIMInterfaces which are based on VPLS-mode multicast configurations, these InterfaceStatuses are based on the states of the underlying Interfaces. Note that even when the PIMInterface is deemed unreachable, specific multicast groups are not shown as impacted.

Router Down Problem A Router Down problem is diagnosed when a router is unresponsive and there is no better explanation. If an Interface outage or SNMPAgent outage might explain the router's being unresponsive, those are concluded.Router Down is a precondition for a number of impacts in various EMC Smarts servers, particularly impacts in the Multicast domain.The diagnosis of Router Down does not eliminate the Interface Down notifications.

Unresponsive Event An Unresponsive event is triggered when a Router's IP Statuses and SnmpManager are all set to Unresponsive. This happens when the Alcatel-Lucent 5620 SAM EMS emits an alarm-243 (SnmpReachabilityProblem) for a given Router.These attributes are reset to OK when the alarm clears.

VPN Impacted Impact VPN impacts may have reported Caused By diagnoses such as Router Down. In the 5620 SAM environment, there are scenarios where these Impacts can notified without Caused By being present. This will happen when 5620 SAM reports an LSP's operational state to be Down. When this happens, the LSP's IsDownInRemote attribute is set to True. However, the user cannot see this relationship from the information in the Notification Log. To find the specific LSP causing the impact, you must navigate through the VPN's VRFs; for each VRF, examine the LSPs it is LayeredOver to see which one of them will be IsDownInRemote.

Table 9 Global Console notifications (3 of 4)

Element Notification

Event, problem, or impact Description

Page 119: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Notification Log entries 119

Understanding Notification Log Entries

VRF Down Problem A VRF is determined to be Down when 1) it is operationally Down, and 2) it is not LayeredOver any Interfaces or if all the Interfaces that it is Layered Over are Down.

Impacted Impact VRF impacts may have reported Caused By diagnoses such as Router Down. In the 5620 SAM environment there are scenarios where these Impacts can notified without Caused By being present. This will happen when 5620 SAM reports an LSP's operational state to be Down. When this happens, the LSP's IsDownInRemote attribute is set to True. However, the user cannot see this relationship from the information in the Notification Log. The solution to this is navigating to the VRF in question and then examining the LSPs it is LayeredOver; one of them will be IsDownInRemote.

NoRoutes Event Event is triggered when the NumberOfRoutes attribute in the VRF is 0. This value is supplied by the 5620 SAM rtr.RouteStats <routesInVrf> attribute. Note that the 5620 SAM will only provide data on the number of routes in a VRF if the VRF’s Route Distinguisher type is set to Type0 or Type1.

WarningThresholdCrossed

Event You can set values in the MPLS Manager for a warning threshold and a max value, as described in the EMC Smarts MPLS Manager User’s Guide. These events are triggered when a VRF's NumberOfRoutes reaches these respective values. As with the NoRoutes event, the NumberOfRoutes is set by the Adapter based on information kept in the 5620 SAM. The 5620 SAM will only track this information for VRFs that are configured to have Route Distinguishers.

MaxRoutesReached Event

Table 9 Global Console notifications (4 of 4)

Element Notification

Event, problem, or impact Description

Page 120: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

120 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Understanding Notification Log Entries

Page 121: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

UNIX Procedures for CD-ROMs 121

B

As a reference, this chapter includes UNIX commands and examples used when installing or upgrading the suite.

◆ Mounting the CD-ROM ............................................................... B-122

UNIX Procedures forCD-ROMs

Page 122: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

122 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

UNIX Procedures for CD-ROMs

Mounting the CD-ROM1. Insert the CD-ROM into the CD-ROM drive.

2. If the CD-ROM is automatically mounted, continue to step 3. Otherwise, select the appropriate mount command as shown in Table 10 on page B-122.

3. Change to the CD-ROM directory by entering the appropriate command from Table 11 on page B-122.

Table 10 Mounting the CD-ROM for UNIX operating systems

Operating System Commands and Examples

Solaris Syntax: # mount -o ro -F hsfs <DEVICE> /mntExample: # mount -o ro -F hsfs /dev/dsk/c0t6d0s0 /mnt

Linux Syntax: # mount <DEVICE>Example: # mount /dev/cdrom /mnt/cdrom

Where <DEVICE> is the mount point for your CD-ROM drive.

Table 11 Changing to the CD-ROM Directory in Unix operating systems

Operating System Command

Solaris If Volume Manager (VM) is running: # cd /cdrom/<suite>_<version>_<build>/suiteIf VM is not running: # cd /mnt/suite

Linux If Automount is running: # cd /cdrom/<suite>_<version>_<build>/suiteIf Automount is not running: # cd /mnt/cdrom/suite

Where: <suite> is the product suite, for example, NPM, IP, MPLS, or SAM.<version> is the release version, for example, 1_1_0 or 6_2_0.<build> is a build number, for example, 6219 or 23922.

Page 123: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Manually Installing the Adapter Service 123

C

This appendix describes manual installation of the Adapter service. It includes the following contents:

◆ Manual service installation.............................................................. 124◆ Installing the Adapter service ......................................................... 125

Manually Installing theAdapter Service

Page 124: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

124 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Manually Installing the Adapter Service

Manual service installationIt is assumed that you have already installed the Alcatel-Lucent 5620 SAM EMS Adapter, as described in “Installing and Uninstalling the Adapter” on page 31.

If you did not install the Adapter as a service when you installed the Adapter, you may install the service manually. Services are programs that, once started, are generally intended to run continuously. Components installed as services can be configured to start automatically upon system reboot. Components not installed as services, such as manual processes or disabled processes, require that you issue commands to start and stop them as necessary.

Typical reasons to install products as services include the following conditions:

◆ During installation, you choose to start the Adapter manually and now want to run it as a service.

◆ Multiple instances of the Adapter running as a service are required. During installation, you can install only a single instance of the Adapter as a service.

To install a product component as a service, enter the appropriate sm_service install command.

For components that are not installed as services, you need to install them either as services (--startmode=runonce) or manual processes (--startmode=manual) with sm_service, and start them as needed with the sm_service start command.

Page 125: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Installing the Adapter service 125

Manually Installing the Adapter Service

Installing the Adapter serviceTo install the service for the Alcatel-Lucent 5620 SAM EMS Adapter service, issue the following command:

▼/opt/InCharge7/ASAM/smarts/bin>./sm_service install--force--unmanaged--startmode=runonce--name=EMC-Smarts-ALCATEL-SAM--description="Alcatel 5620 SAM Adapter"--env=SM_JAVA_ENABLED=YES/opt/InCharge7/ASAM/smarts/bin/sm_server--name=ALCATEL-SAM--config=alcatel-sam--output--ignore-restore-errors▲

Note: ▼▲ Indicates that this command must be typed as one line. Separate each option with a space when typing the command.

Page 126: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

126 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Manually Installing the Adapter Service

Page 127: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O Elements to Smarts Objects 127

D

This appendix includes the following contents:

◆ SAM-O element to Smarts object mapping................................... 128

Mapping of SAM-OElements to Smarts

Objects

Page 128: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

128 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Elements to Smarts Objects

SAM-O element to Smarts object mappingFor each Smarts Domain Manager, Table 12 on page 128 shows how Alcatel-Lucent 5620 SAM-O interface elements are mapped to Smarts objects, and indicates where these objects are displayed.

Table 12 Mapping of SAM-O Elements to Smarts objects (1 of 6)

SMARTS Object SAM-O Class Displayed in Alcatel-Lucent EMS Console

IP AM/PM

AD_PersistentDataSet (MAC-Mapping)

l2fib.FibEntry Manage > FIB Entries

AD_PersistentDataSet (MCastGroup-Mapping)

l2fib.MFibEntry -

Cable equipment.PhysicalLink Manage > Equipment > Physical Link

Card equipment.BaseCardequipment.DaughterCardequipment.ProcessorCard

Manage > Equipment > Card

CardRedundancyGroup equipment.ProcessorCard (one for each pair)

Manage > Equipment > Card > Processor Card

Chassis Derived fromequipment.Card

Number equals to Manage > Equipment > Network Element

Fan (PM only) equipment.FanTray Manage > Equipment > Fan Tray

Page 129: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

SAM-O element to Smarts object mapping 129

Mapping of SAM-O Elements to Smarts Objects

Interface equipment.PhysicalPort Manage > Equipment > Port > Physical Port

rtr.NetworkInterface Manage > Routing Instances > Network Interface

sonetEquipment.Sts1ChannelsonetEquipment.Sts3ChannelsonetEquipment.Sts12ChannelsonetEquipment.Sts48ChannelsonetEquipment.Sts192ChannelsonetEquipment.Tu3Channeltdmequipment.DS0ChannelGrouptdmequipment.DS1E1Channeltdmequipment.DS3E3Channel

Manage > Equipment > Port > Logical Port > Channel, andManage > Equipment > Port > Logical Port > Interface

ies.L3AccessInterfacevprn.L3AccessInterface

Manage > Services > AccessInterface > L3 Access Interface

vll.L2AccessInterfaceapipe.L2AccessInterfaceepipe.L2AccessInterfacefpipe.L2AccessInterfaceipipe.L2AccessInterfacevpls.L2AccessInterface

Manage > Services > AccessInterface > L2 Access Interface

IP - Manage > Routing Instances > IP Addresses, andManage > Routing Instances > Router Site > RoutingInstanceSite > Routing Instance

IPNetwork - -

MAC - -

Memory equipment.FlashMemory Manage > Equipment > Flash Memory

NetworkAdapterRedundancyGroup

lag.Interface Manage > Equipment > Port > Logical Port > Port Group > LAG

NetworkConnection Derived frommpls.CrossConnectospf.Neighborpim.Groupssvt.Tunnel

-

PowerSupply equipment.PowerSupplyTray Manage > Equipment > Power Supply Tray

Table 12 Mapping of SAM-O Elements to Smarts objects (2 of 6)

Page 130: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

130 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Elements to Smarts Objects

Processor equipment.Processor Manage > Equipment > Card > Processor Card, orManage > Equipment > Processor

Router/Switch netw.NetworkElement Managed > Equipment > Network Element

SNMPAgent netw.NetworkElement Managed > Equipment > Network Element

MPLS

Forwarder vll.Siteapipe.Siteepipe.Sitefpipe.Siteipipe.Site

Manage > Services > Site (Service Management) > Site (vll)

vpls.Site Manage > Services > Site (Service Management) > AbstractSite (vpls) > Site (vpls)

ForwarderEndpoint. svt.MeshSdpBindingsvt.SdpBindingsvt.SpokeSdpBinding

Manage > Services > SdpBinding, orManage > MPLS Objects > SdpBinding

LdpAdjacency ldp.TargetedPeer (one for each pair) -

LdpProtocolEndpoint ldp.Interfaceldp.TargetedPeer

Manage > Routing Instances > RouterTerminatingInterface > RouterTerminatingNonIpInterface > LDP Interface, andApplication > Navigation Tree > Network (Expand LDP in each Routing Instance to check the TargetedPeers)

LSP mpls.LspPath Manage > LSPs > Static + Dynamic

LSPHopLSPInSegmentLSPOutSegment

mpls.CrossConnect Manage > MPLS Objects > In Segment, andManage > MPLS Objects > Out Segment

MPLSService Mpls.Interfacevprn.Site

Manage > MPLS Objects > MPLS (Path/Routing Management: MPLS)

PseudoWire Derived fromsvt.MeshSdpBindingsvt.SdpBindingsvt.SpokeSdpBinding

-

Table 12 Mapping of SAM-O Elements to Smarts objects (3 of 6)

Page 131: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

SAM-O element to Smarts object mapping 131

Mapping of SAM-O Elements to Smarts Objects

VPN vll.Vllapipe.Apipeepipe.Epipefpipe.Fpipeipipe.Ipipevpls.Vplsvprn.Site

Manage > Services > Service (Service Management)

VRF vprn.Site Manage > Services > Site (Service Management) > Site (vprn)

BGP

AutonomousSystem Derived from rtr.VirtualRouter

Application > Navigation Tree > Network (For each BGP instance, right click Property and check the “S Properties” tab)

BGPCluster Derived frombgp.Peer

-

BGPProtocolEndpoint bgp.Peer Application > Navigation Tree > Network (Expand to examine all BGP peers in each routing instance)

BGPService rtr.VirtualRouter Manage > Routing Instances > RouterSite > RoutingInstanceSite > Routing Instance (Use filter “BGP Enabled” equal to true)

BGPSession bgp.Peer (One for each pair) Application > Navigation Tree > Network (Expand to examine each pair of BGP peers)

Confederation Derived from rtr.VirtualRouter

-

OSPF

OSPFArea Derived fromospf.AreaSite

Application > Navigation Tree > OSPF (Only those with routing instances created)

OSPFAreaConfiguration ospf.AreaSite Manage > Routing Instances > RouterSite > SubProtocolSite > AreaSite (Routing Management OSPF)

Table 12 Mapping of SAM-O Elements to Smarts objects (4 of 6)

Page 132: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

132 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Elements to Smarts Objects

OSPFInterface ospf.Interface Manage > Routing Instances > RouterTerminatingInterface > RouterTerminatingIpInterface > OSPF Interface (Use filter “Interface Class” equals “Numbered”)

OSPFNeighborEndpoint ospf.Neighbor Application > Navigation Tree > OSPF (Expand all the way to see each resulting Neighbor)

OSPFNeighborRelationship ospf.Neighbor (One for each pair) Application > Navigation Tree > OSPF (Expand all the way to see each pair of Neighbors)

OSPFNetwork - -

OSPFService ospf.Site Manage > Routing Instances > RouterSite > ProtocolSite > OSPF

OSPFVirtualInterface ospf.VirtualLink Application > Navigation Tree > OSPF (Expand to see each VirtualLink)

OSPFVirtualLink ospf.VirtualNeighbor (One for each pair) Application > Navigation Tree > OSPF (Expand to see each pair of VirtualNeighbors)

OSPFVirtualNeighborEndpoint ospf.VirtualNeighbor Application > Navigation Tree > OSPF (Expand to see each resulting VirtualNeighbor)

MCAST

IGMPInterface igmp.Interface Manage > Routing Instances > RouterTerminatingInterface > RouterTerminatingNonIpInterface > IGMP Interface

IGMPNetwork igmp.IfGroup Application > Navigation Tree > Network (For each IGMP Instance, click Property and check the “Multicast Group/Source” tab)

MulticastGroup Derived frompim.RPSet

Application > Navigation Tree > Network (For each PIM Instance, click Property >Groups and check distinct “Group Address”)

MulticastService igmp.Sitepim.Site

Manage > Routing Instances > RouterSite > ProtocolSite > IGMP, orManage > Routing Instances > RouterSite > ProtocolSite > PIM

Table 12 Mapping of SAM-O Elements to Smarts objects (5 of 6)

Page 133: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

SAM-O element to Smarts object mapping 133

Mapping of SAM-O Elements to Smarts Objects

MulticastSource Derived frompim.Group

Application > Navigation Tree > Network (For each IGMP Instance, right click Property > Multicast Group/Source and check all instances with “Source” equal to “.0.0.0”)

MulticastTree - -

PIMHop Derived frompim.Group

-

PIMInterface pim.Interface Manage > Routing Instances > RouterTerminatingInterface > RouterTerminatingNonIpInterface > PIM Interface

PIMSourceG pim.Group (SourceG) Application > Navigation Tree > Network (For each PIM Instance, click Property > Groups and check instances with “Source Type” equal to “SG”)

PIMStarG pim.Group (StarG) Application > Navigation Tree > Network (For each PIM Instance, click Property > Groups and check all with “Source Type” equal to “StarG”)

Table 12 Mapping of SAM-O Elements to Smarts objects (6 of 6)

Page 134: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

134 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Elements to Smarts Objects

Page 135: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O Classes and Smarts Objects 135

E

The Alcatel-Lucent 5620 SAM EMS Adapter uses SOAP/XML over HTTP to perform a full network inventory from the Alcatel-Lucent 5620 SAM-O interface and create the topology., mapping SAM-O objects to Smarts objects. This appendix includes the following information:

◆ Mapping of SAM-O equipment objects ......................................... 136◆ Mapping of SAM-O service objects................................................ 143◆ Summary of Smarts discovered objects ......................................... 157

Mapping of SAM-OClasses and Smarts

Objects

Page 136: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

136 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

Mapping of SAM-O equipment objectsTable 13 on page 136 maps SAM-O equipment classes to Smarts objects.

Note: No timeout is implemented.

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (1 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

netw.NetworkElement find - Router/Switch (unless stated otherwise)

- chassisType

- ipAddress

- objectFullName

- siteName

- systemAddress

equipment.BaseCard find siteName Card (unless stated otherwise)

- administrativeState

- equipmentState

- objectFullName

- operationalState

- siteId

- slotId

- specificType

equipment.ControlProcessorequipment.SwitchFrabicProcessor

find siteName Processor

- displayedName

- objectFullName

equipment.DaughterCard find siteName Card

- administrativeState

Page 137: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O equipment objects 137

Mapping of SAM-O Classes and Smarts Objects

- daughterCardSlotId

- equipmentState

- objectFullName

- operationalState

- specificType

equipment.FanTray find siteName Fan

- administrativeState

- deviceState

- fanId

- hwName

- objectFullName

- operationalState

- siteId

equipment.FlashMemory find siteName Memory

- amountUsed

- capacity

- displayedName

- objectFullName

- percentageUsed

equipment.PhysicalLink find siteName Cable

- endpointAPointer

- endpointBPointer

- objectFullName

equipment.PhysicalPort find siteName Interface

- administrativeState

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (2 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 138: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

138 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- cardSlotId

- daughterCardSlotId

- description

- displayedName

- equipmentState

- macAddress

- mtuValue

- operationalState

- portId

- siteId

- specificType

- speed

equipment.PowerSupplyTray find siteName PowerSupply

- acVoltageStatus

- administrativeState

- dcVoltageStatus

- deviceState

- fanId

- hwName

- objectFullName

- operationalState

- powerSupplyId

- powerSupply1Status

- powerSupply2Status

- psTemperatureThreshold

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (3 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 139: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O equipment objects 139

Mapping of SAM-O Classes and Smarts Objects

- temperatureStatus

- siteId

equipment.ProcessorCard find siteName Card

- administrativeState

- displayedName

- equipmentState

- objectFullName

- operationalState

- siteId

- specificType

l2fib.FibEntry find nodeNameterminationTypeserviceType

An entry in AD_PersistentDataSet

- definedPerObjectPointer

- macAddress

- objectFullName

- serviceId

l2fib.MFibEntry find serviceSiteId An entry in AD_PersistentDataSet

- grpAddr

- objectFullName

- portId

- serviceId

lag.Interface find siteName NetworkAdapterRedundancyGroup

- administrativeState

- description

- displayedName

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (4 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 140: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

140 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- objectFullName

- operationalState

- siteId

- siteName

lag.PortTermination find siteName create relationship between NetworkAdapterRedundancyGroup and its Interfaces

- terminatedPortPointer

rtr.NetworkInterface find nodeId Interface

- actualMtu

- administrativeState

- description

- displayedName

- id

- interfaceClass

- nodeId

- nodeName

- objectFullName

- operationalState

- primaryIPv4Address

- primaryIPv4PrefixLength

- resourceState

- terminatedObjectPointer

- terminatedPortClassName

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (5 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 141: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O equipment objects 141

Mapping of SAM-O Classes and Smarts Objects

sonetEquipment.Sts1ChannelsonetEquipment.Sts3ChannelsonetEquipment.Sts12ChannelsonetEquipment.Sts48ChannelsonetEquipment.Sts192ChannelsonetEquipment.Tu3Channel

find siteName Interface

- administrativeState

- cardSlotId

- daughterCardSlotId

- description

- displayedName

- equipmentState

- mtuValue

- objectFullName

- operationalState

- portId

- siteName

- speed

tdmequipment.DS0ChannelGrouptdmequipment.DS1E1Channeltdmequipment.DS3E3Channel

find siteName Interface

- administrativeState

- cardSlotId

- daughterCardSlotId

- description

- displayedName

- equipmentState

- mtuValue

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (6 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 142: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

142 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- objectFullName

- operationalState

- physicalPortId

- siteName

- speed

Table 13 Mapping of SAM-O equipment objects to EMC Smarts objects (7 of 7)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 143: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 143

Mapping of SAM-O Classes and Smarts Objects

Mapping of SAM-O service objectsTable 14 on page 143 lists the SAM-O service objects the Adapter retrieves and the methods used.

Table 14 Mapping of SAM-O service objects to Smarts objects (1 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

bgp.Peer find siteName BGPProtocolEndpointBGPClusterBGPSession

- administrativeState

- clusterId

- connectionState

- localAddress

- localAS

- objectFullName

- peerAddress

- peerAS

- peerType

- siteId

- siteName

ies.L3AccessInterface find nodeNameserviceId

Interface

- actualMtu

- administrativeState

- description

- displayedName

- id

- interfaceClass

- nodeId

Page 144: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

144 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- objectFullName

- operationalState

- primaryIPv4Address

- primaryIPv4PrefixLength

- serviceId

- serviceType

- terminatedObjectPointer

- terminatedPortClassName

igmp.IfGroup find - IGMPNetwork

- group

- objectFullName

- srcAddrOfLastReport

igmp.Interface find nodeName IGMPInterface

- administrativeState

- groupCount

- interfaceId

- nodeName

- objectFullName

- operationalState

- querier

- terminatedObjectPointer

igmp.Site find - MulticastService

- objectFullName

- siteId

- siteName

Table 14 Mapping of SAM-O service objects to Smarts objects (2 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 145: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 145

Mapping of SAM-O Classes and Smarts Objects

ldp.Interface find - LdpProtocolEndpointLdpAdjacency

- keepAliveTimeout

- administrativeState

- nodeId

- portName

- interfaceId

- terminatedPortPointer

- peerAddress

- operationalState

- objectFullName

ldp.TargetedPeer find - LdpProtocolEndpointLdpAdjacency

- keepAliveTimeout

- administrativeStat

- siteId

- interfaceId

- peerAddress

- operationalState

- objectFullName

mpls.CrossConnect find lspPointer LSPHopLSPInSegmentLSPOutSegmentNetworkConnection (derived)

- egressInterfaceId

- egressInterfaceName

- egressInterfacePointer

Table 14 Mapping of SAM-O service objects to Smarts objects (3 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 146: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

146 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- fromSiteId

- ingressInterfaceId

- ingressInterfaceName

- ingressInterfacePointer

- inLabel

- lspId

- lspPointer

- nextHop

- objectFullName

- operationalState

- outLabel

- previousHop

- siteName

- toSiteId

mpls.Interface find - MPLSService

- nodeId

- nodeName

- objectFullName

- terminatedObjectPointer

mpls.LspPath find fromNodeName LSP

- fromNodeId

- fromNodeName

- lspId

- lspName

- objectFullName

Table 14 Mapping of SAM-O service objects to Smarts objects (4 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 147: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 147

Mapping of SAM-O Classes and Smarts Objects

- operationalState

- toNodeId

- toNodeName

ospf.AreaSite find - OSPFAreaOSPFAreaConfiguration

- objectFullName

- name

- areaId

- importAsExtern

- areaSummary

- siteName

ospf.Interface find nodeName OSPFInterface

- objectFullName

- displayedName

- nodeName

- areaId

- interfaceType

- transitDelay

- retransmissionInterval

- helloInterval

- demandProceduresEnabled

- administrativeState

- terminatedObjectPointer

- terminatedObjectName

- operationalState

- nodeId

Table 14 Mapping of SAM-O service objects to Smarts objects (5 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 148: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

148 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- priority

- designatedRouterId

- backupDesignatedRouterId

- authenticationKey

- authenticationType

- routerDeadInterval

ospf.Neighbor find siteName OSPFNeighborEndpoint

- objectFullName

- name

- operationalState

- siteName

- permanence

- helloSuppressed

- neighboringIpAddress

- neighboringRouterId

ospf.Site find - OSPFService

- objectFullName

- siteName

- ospfRouterId

- administrativeState

- isAreaBorderRouter

-isAutonomousSystemBorderRouter

ospf.VirtualLink find siteName OSPFVirtualInterface

- objectFullName

- operationalState

Table 14 Mapping of SAM-O service objects to Smarts objects (6 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 149: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 149

Mapping of SAM-O Classes and Smarts Objects

- localEgressIfIpAddress

- authenticationKey

- authenticationType

- helloInterval

- routerDeadInterval

- retransmissionInterval

- transitDelay

ospf.VirtualNeighbor find siteName OSPFVirtualNeighbor

- helloSuppressed

- ipAddress

- objectFullName

- operationalState

- siteName

- virtualNeighborRouterId

pim.Group find - MulticastSourcePIMSourceGPIMStarG

- groupAddress

- nextHopAddress

- objectFullName

- rpfNbrAddress

- rpfIfIndex

- sourceAddress

- sourceRPAddress

- siteName

pim.Interface find interfaceClass PIMInterface

Table 14 Mapping of SAM-O service objects to Smarts objects (7 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 150: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

150 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- administrativeState

- drIPAddress

- helloInterval

- interfaceId

- nodeId

- nodeName

- objectFullName

- operationalState

- terminatedObjectPointer

pim.Neighbor find - -

- neighboringIpAddress

- objectFullName

pim.RPSet find - MulticastGroup

- objectFullName

- rpGroupIPAddress

- rpGroupMask

pim.Site find -

- objectFullName

- siteId

- siteName

- bsrAddress

- crpAddress

- bsrCandidatePriority

rtr.RouteStats find

Table 14 Mapping of SAM-O service objects to Smarts objects (8 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 151: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 151

Mapping of SAM-O Classes and Smarts Objects

- monitoredObjectPointer

- routesInVrf

- timeCaptured

rtr.VirtualRouter find bgpEnabled AutonomousSystemBGPServiceConfederation

- autonomousSystemNumber

- confederationAutonomousSystemNumber

- objectFullName

- siteName

service.SpokeConnector find firstSvcPointersecondSvcPointer

-

- compositeSvcPointer

- firstSiteId

- firstSvcPointer

- firstTunnelPointer

- secondSiteId

- secondSvcPointer

- secondTunnelPointer

svt.MeshSdpBindingsvt.SdpBindingsvt.SpokeSdpBinding

find fromNodeNameserviceId serviceType

ForwarderEndpoint.

- circuitTransport

- fromNodeId

- fromNodeName

- objectFullName

Table 14 Mapping of SAM-O service objects to Smarts objects (9 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 152: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

152 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- operationalState

- pathId

- pathname

- pathPointer

- returnCircuitPointer

- serviceId

- serviceName

- toNodeId

- toNodeName

- vcId

svt.TransportConnection find fromNodeIdtunnelId

Create relationship between VRF and LSPPIMInterface

- fromNodeName

- resourceId

- resourcePointer

- toNodeId

- toNodeName

svt.Tunnel find underlyingTransport -

- toCtp

- fromCtp

- description

- fromNodeName

- toNodeName

- administrativeState

- operationalState

Table 14 Mapping of SAM-O service objects to Smarts objects (10 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 153: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 153

Mapping of SAM-O Classes and Smarts Objects

- sourceNodeId

- destinationNodeId

- objectFullName

vll.L2AccessInterfaceapipe.L2AccessInterfaceepipe.L2AccessInterfacefpipe.L2AccessInterfaceipipe.L2AccessInterface

find nodeName Interface

- serviceId

- terminatedObjectPointer

- terminatedPortClassName

- nodeId

- displayedName

- actualMtu

- description

- operationalState

- administrativeState

- objectFullName

vll.Siteapipe.Siteepipe.Sitefpipe.Siteipipe.Site

find siteId

- serviceId

- displayedName

- siteId

- operationalState

Table 14 Mapping of SAM-O service objects to Smarts objects (11 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 154: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

154 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- objectFullName

vll.Vllapipe.Apipeepipe.Epipefpipe.Fpipeipipe.Ipipe

find - VPN

- serviceId

- displayedName

- subscriberId

- objectFullName

vpls.L2AccessInterface find outerEncapValueserviceTypenodeNameterminatedPortClassName

Interface

- administrativeState

- nodeId

- nodeName

- objectFullName

- operationalState

- porId

- serviceId

- terminatedObjectPointer

- terminatedPortClassName

vpls.Site find -

- serviceId

- displayedName

- siteId

Table 14 Mapping of SAM-O service objects to Smarts objects (12 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 155: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O service objectsMapping of SAM-O equipment objects 155

Mapping of SAM-O Classes and Smarts Objects

- operationalState

- objectFullName

- nodeId

vpls.Vpls find -

- serviceId

- displayedName

- subscriberId

- objectFullName

vprn.L3AccessInterface find nodeName Interface

- actualMtu

- description

- displayedName

- id

- interfaceClass

- l3InterfaceAdministrativeState

- nodeId

- objectFullName

- operationalState

- primaryIPv4Address

- primaryIPv4PrefixLength

- serviceId

- serviceType

- terminatedObjectPointer

Table 14 Mapping of SAM-O service objects to Smarts objects (13 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 156: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

156 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

- terminatedPortClassName

vprn.Site find siteId VPN / VRF / MPLSService

- objectFullName

- operationalState

- serviceId

- serviceName

- siteId

- subscriberName

Table 14 Mapping of SAM-O service objects to Smarts objects (14 of 14)

SAM-O equipment class SAM-O method SAM-O filter Mapped EMC Smarts object

Page 157: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Summary of Smarts discovered objectsMapping of SAM-O equipment objects 157

Mapping of SAM-O Classes and Smarts Objects

Summary of Smarts discovered objectsTable 15 on page 157 lists the discovered Alcatel-Lucent 5620 SAM EMS inventory objects.

Table 15 Adapter support for 5620 SAM EMS inventory

Inventory Discovered objects

Each network element All SAM-O objects listed in Table 13 on page 136. and Table 14 on page 143

Physical inventory All SAM-O objects listed in Table 13 on page 136

MPLS inventory • apipe.Apipe, apipe.L2AccessInterface, apipe.Site• epipe.Epipe, epipe.L2AccessInterface, epipe.Site• fpipe.Fpipe, fpipe.L2AccessInterface, fpipe.Site• ipipe.Ipipe, ipipe.L2AccessInterface, ipipe.Site• ldpInterface, ldpTargetPeer• mpls.CrossConnect, mpls.Interface, mpls.LspPath• rtr.RouteStats• svt.MeshSdpBinding, svt.SdpBinding, svt.SpokeSdpBinding, svt.TransportConnection• vll.L2AccessInterface, vll.Site, vll.Vll• vpls.L2AccessInterface, vpls.Site, vpls.Vpls• vprn.Site

OSPF inventory • ospfAreaSite• ospfInterface• ospfNeighbor• ospfSite• ospfVirtualLink• ospfVirtualNeighbo

BGP inventory • bgp.Peer• rtr.VirtualRoute

Multicst inventory • igmp.IfGroup, igmp.Interface, igmp.Site• pim.Group, pim.Interface, pim.Neighbor, pim.RPSet• service.SpokeConnector• svt.MeshSdpBinding• vpls.L2AccessInterface

Page 158: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

158 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Classes and Smarts Objects

Page 159: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of SAM-O Objects and Smarts Notifications 159

F

The Alcatel-Lucent 5620 SAM EMS Adapter uses the EMC Smarts patented Codebook Correlation Technology to do root-cause analysis. This analysis is based on many factors in the managed network, including, but not limited to, Operational or Administrative status. However, when the Alcatel-Lucent 5620 SAM EMS server generates either administrativeState or operationalState information for a component, the Adapter stores this information in a repository object. This appendix includes the following contents:

◆ Element to notification mapping .................................................... 160

Mapping of SAM-OObjects and Smarts

Notifications

Page 160: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

160 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Objects and Smarts Notifications

Element to notification mappingTable 16 on page 160 describes how the administrativeState or operationalState information may be mapped to the notifications that are displayed in the Global Console, based on this and other considerations.

Table 16 Mapping of Alcatel-Lucent elements to notifications (1 of 6)

Element Status Description

Router Operational or Administrative

The status indications are ignored by the Adapter.

Card Operational Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 1 maps to UNKNOWN• 2 maps to OK• All others map to CRITICAL.

Administrative Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 2 maps to MANAGED• Any other value maps to UNMANAGED

Processor Card Operational Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 1 (Unknown) is mapped to UNKNOWN• 2 (InService) and 8 (provisioned) is mapped to OK• 3 (OutOfService)• 4 (diagnosing)• 5 (failed)• 6 (booting)• 7 (empty)• 9 (unprovisioned)• 10 (upgrade)• 11 (downgrade)• 12 (inServiceUpgrade)• 13 (inServiceDownGrade)• 14 (resetPending) is mapped to CRITICAL.

Page 161: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Element to notification mapping 161

Mapping of SAM-O Objects and Smarts Notifications

Physical Port Administrative Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 1 maps to UNKNOWN• 2 maps to OK• All others map to DOWN.

OperationalEquipment

This mapping considers Alcatel-Lucent 5620 SAM EMS operationalState and equipmentState, as follows:• If operationalState is 1, or equipmentState is 5, or equipmentState is 13,

then the EMC Smarts operationalStatus is UNKNOWN• If operationalState is 2, then operationalStatus is UP• All other combinations are DOWN

Network Interface Administrative Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 2 maps to UP• 3 maps to DOWN• All others map to UNKNOWN

Operational Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 2 maps to UP• 3 maps to DOWN• All others map to UNKNOWN

Access Interface Administrative Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 1 maps to UP• 2 maps to DOWN• All others map to UNKNOWN

Operational Alcatel-Lucent 5620 SAM EMS status values are mapped as follows:• 1 maps to UP• 2 maps to DOWNAll others map to UNKNOWN

IP N/A The Alcatel-Lucent 5620 SAM EMS does not track IPs as objects with administrative or operational states, so the Adapter sets IPStatus in parallel with the Underlying Interface operationalState. IPs do not have administrativeStatus in EMC Smarts.• If an Interface is DOWN, IPStatus is set to TIMEDOUT• Otherwise, IPStatus is set to OK.

VPN (VPRN) N/A Not used by EMC Smarts software (MPLS Manager).

Table 16 Mapping of Alcatel-Lucent elements to notifications (2 of 6)

Element Status Description

Page 162: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

162 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Objects and Smarts Notifications

mpls.LspPath Operational mpls.LspPath operationalState Set LSP IsDownActive = true if OperationalState of the LSP is 3 or ‘lspDown’Otherwise, set = false.

Link Aggregation Group Administrative Set the AdminStatus of the NetworkAdapterRedundancyGroup’s instrumentation object as follows:• portInService(2) UP• portOutOfService(3) DOWN• others, UNKNOWN

Operational Set the OperStatus of the NetworkAdapterRedundancyGroup’s instrumentation object as follows:• portInService(2) UP• portOutOfService(3) DOWN• portFailed(5) DOWN• others, UNKNOWN

Element Forwarder OperationalState forElementForwarder

Set from svt.SpokeSdpBinding as follows: • [circuitNotReady(8) maps to UNKNOWN• circuitUp(1) maps to UP• All others map to DOWN

Forwarder Endpoint OperationalState forForwarderEndpointStatus

Set from svt.SpokeSdpBinding as follows: • [circuitNotReady(8) maps to UNKNOWN• circuitUp(1) maps to UP• All others map to DOWN

ldp.TargetedPeer Administrative Operational

Set from the LdpProtocolEndpoint's AdminStatus as follows: • 2 maps to ENABLE• 3 maps to DISABLE• 1 maps to UNKNOWN.

Ldp.Interface Administrative Operational

Maps to the LdpProtocolEndpoint's AdminStatus as follows: • 2 maps to ENABLE• 3 maps to DISABLE• 1 maps to UNKNOWN.

BGPProtocolEndpoint PeerAdminStatus

Administrative Set from the 5620 SAM bgp.Peer administrative state as follows:• 0 maps to UNKNOWN• 1 maps to Stop• 2 maps to START

Table 16 Mapping of Alcatel-Lucent elements to notifications (3 of 6)

Element Status Description

Page 163: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Element to notification mapping 163

Mapping of SAM-O Objects and Smarts Notifications

BGPProtocolEndpoint PeerState

Peer connection Set from the 5620 SAM bgp.Peer connection state as follows:• 1 maps to IDLE• 2 maps to CONNECT• 3 maps to ACTIVE• 4 maps to OPENSENT• 5 maps to OPENCONFIRM• 6 maps to ESTABLISHED• Others map to UNKNOWN.

OSPFInterface DiscoveredAdminStatus

Administrative Set from the 5620 SAM ospf.Interface administrative state as follows:• 0 maps to UNKNOWN• 1 maps to ENABLED• 2 maps to DISABLED

OSPFInterface IfState Operational Set from the 5620 SAM ospf.Interface operationalState as follows:• 1 maps to DOWN• 2 maps to LOOPBACK• 3 maps to WAITING• 4 maps to POINT_TO_POINT• 5 maps to DESIGNATED_ROUTER• 6 maps to BACKUP_DESIGNATED_ROUTER• 7 maps to OTHER_DESIGNATED_ROUTER• Anything else maps to UNKNOWN.

OSPFNeighborEndpoint NeighborState

Operational Set from the ospf.Neighbor operational State as follows:• 1 maps to DOWN• 2 maps to ATTEMPT• 3 maps to INIT• 4 maps to TWO_WAY• 5 maps to EXCHANGE_START• 6 maps to ATTEMPT• 7 maps to LOADING• 8 maps to FULL• Anything else maps to UNKNOWN.

OSPFService AdminStatus

Administrative Set from the ospf.Site administrative state as follows:• 0 maps to UNKNOWN• 1 maps to UP• 2 maps to DOWN

Table 16 Mapping of Alcatel-Lucent elements to notifications (4 of 6)

Element Status Description

Page 164: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

164 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Objects and Smarts Notifications

OSPFVirtualInterface Operational IfState is set from the ospf.VirtualLink operational state as follows:• 1 maps to DOWN• 2 maps to LOOPBACK• 3 maps to WAITING• 4 maps to POINT_TO_POINT• 5 maps to DESIGNATED_ROUTER• 6 maps to BACKUP_DESIGNATED_ROUTER• 7 maps to OTHER_DESIGNATED_ROUTER• Anything else maps to UNKNOWN

Table 16 Mapping of Alcatel-Lucent elements to notifications (5 of 6)

Element Status Description

Page 165: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Element to notification mapping 165

Mapping of SAM-O Objects and Smarts Notifications

OSPFVirtualNeighbor NeighborState

Operational Set from the ospf.VirtualNeighbor operational State as follows:• 1 maps to DOWN• 2 maps to ATTEMPT• 3 maps to INIT• 4 maps to TWO_WAY• 5 maps to EXCHANGE_START• 6 maps to ATTEMPT• 7 maps to LOADING• 8 maps to FULL• Anything else maps to UNKNOWN.

PIMInterface Administrative Status Mapping: • If admin UP(2), then if oper UP(2) ==> ACTIVE• If admin UP, then if oper DOWN(3) ==> NOTINSERVICE• If admin UP, then if oper UNKNOWN(1) ==> UNKNOWN

• If admin DOWN(3), then if oper UP ==> NOTREADY • If admin DOWN, then if oper DOWN ==> NOTREADY• If admin DOWN, then if oper UNKNOWN ==> NOTREADY

IGMPInterface Administrative Status Mapping: • If admin UP, then if oper UP ==> ACTIVE• If admin UP, then if oper DOWN ==> NOTINSERVICE• If admin UP, then if oper UNKNOWN ==> UNKNOWN

• If admin DOWN, then if oper UP ==> NOTREADY • If admin DOWN, then if oper DOWN ==> NOTREADY• If admin DOWN, then if oper UNKNOWN ==> NOTREADY

• If admin UNKNOWN, then if oper UP ==> UNKNOWN • If admin UNKNOWN, then if oper DOWN ==> UNKNOWNN• If admin UNKNOWN, then if oper UNKNOWN ==> UNKNOWN

Table 16 Mapping of Alcatel-Lucent elements to notifications (6 of 6)

Element Status Description

Page 166: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

166 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of SAM-O Objects and Smarts Notifications

Page 167: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Mapping of Administrative and Operational Status 167

G

The Alcatel-Lucent 5620 SAM EMS provides administrative and operational status for certain MPLS, BGP, and OSPF entities. This appendix includes the following contents:

◆ Administrative and Operational status mapping ........................ 168

Mapping ofAdministrative andOperational Status

Page 168: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

168 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Mapping of Administrative and Operational Status

Administrative and Operational status mappingThe Adapter maps these states to AdminStatus and OperStatus indications, as shown in the following tables:

◆ Table 17, “MPLS status mapping,”

◆ Table 18, “BGP status mapping,”

◆ Table 19, “OSPF status mapping,”.

Table 17 MPLS status mapping

MPLS Entity Status

Forwarder AdminStatusOperStatus

ForwarderEndpoint AdminStatusOperStatus (= ForwarderEndpointStatus)

LdpProtocolEndpoint AdminStatusOperStatus

LSP AdminStatusOperStatus (=mplsLspState)

VRF AdminStatusOperStatus

Table 18 BGP status mapping

BGP Entity Status

BGPProtocolEndpoint PeerAdminStatusPeerState

Table 19 OSPF status mapping

OSPF Entity Status

OSPFInterface AdminStatusIfState

OSPFVirtualInterface AdminStatusOperStatus

Page 169: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Troubleshooting 169

H

You can troubleshoot by querying the Alcatel-Lucent 5620 SAM EMS database for object data and by looking at log entries.

Note: If you are seeing excessive buffering on the 5620 SAM EMS, use the procedures described in “Troubleshooting excessive message buffering on the EMS” on page 84 to diagnose and remedy the problems.

This appendix includes the following contents:

◆ Troubleshooting 5620 SAM EMS objects ....................................... 170◆ Adapter log entries ........................................................................... 173

Troubleshooting

Page 170: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

170 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Troubleshooting

Troubleshooting 5620 SAM EMS objectsYou can troubleshoot by querying the Alcatel-Lucent 5620 SAM EMS database for object data, in the event that the information is not directly available from the EMS user interface.

To do this, you can run either of the following ASL scripts:

◆ readRecords.asl—Lists all records for a specified object; for example, all routers

◆ soap.asl—Submits an xml query and returns the responses to the standard output (stdout) or a file

readRecords.aslThis script is available for UNIX only. To run this script:

At ASAM_BASEDIR, issue the following command on one line:

▼bin/sm_adapter -s <adapter_name> -Dpkg=<SAM-O class name> alcatel-sam/readRecords.asl▲

For example, to list all of the routers and their properties:

▼bin/sm_adapter -s ALCATEL-SAM -Dpkg=netw.NetworkElement alcatel-sam/readRecords.asl▲

The results will be located in /var/tmp/netw.NetworkElement.xml.

soap.aslThis script supports single or multiple queries in a single call.

To run this script:

At ASAM_BASEDIR, issue the following command on one line:

▼bin/sm_adapter -s <adapter_name> --file=<query file and pathname> alcatel-sam/soap.asl▲

The following examples illustrate single and multiple queries.

Example 1 Example of a single query

bin/sm_adapter -s ALCATEL-SAM --file=find.xml alcatel-sam/soap.asl

Page 171: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Troubleshooting 5620 SAM EMS objects 171

Troubleshooting

The following is a sample find.xml file for a single query (network element).

In this example, the file limits the attribute list to the following, and skips any child objects:

◆ objectFullName

◆ displayedName

<find xmlns="xmlapi_1.0"> <fullClassName>netw.NetworkElement</fullClassName> <resultFilter> <attribute>objectFullName</attribute> <attribute>displayedName</attribute> <children/> </resultFilter></find>

The output will look something like the following example:

Page 172: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

172 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Troubleshooting

Example 2 Example of a multiple queries

The following is a sample find.xml file for multiple queries (network element and equipment card):

<find xmlns="xmlapi_1.0"> <fullClassName>netw.NetworkElement</fullClassName> <resultFilter> <attribute>objectFullName</attribute> <attribute>displayedName</attribute> <children/> </resultFilter></find><find xmlns="xmlapi_1.0"> <fullClassName>equipment.Card</fullClassName> <resultFilter> <attribute>objectFullName</attribute> <attribute>displayedName</attribute> <children/> </resultFilter></find>

Page 173: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Adapter log entries 173

Troubleshooting

Adapter log entriesThe Adapter log file is called the ASA.log. Most entries in the ASA.log are informational, providing a trail of events reported by the Alcatel-Lucent 5620 SAM EMS or showing progress of a discovery. Some common log messages are discussed here.

No SAM-O licenseSEVERE: [Connector] Exception Type:javax.jms.JMSSecurityException SAM-O Access Violation

and/or

SEVERE: [SmTiEventProcessor] Adapter cannot connect to the 5620Sam EMS server<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"><SOAP:Header><header xmlns="xmlapi_1.0"><requestID>smarts@8598</requestID><requestTime>Aug 15, 2007 11:39:21 PM</requestTime><responseTime>Aug 15, 2007 11:39:22 PM</responseTime></header></SOAP:Header><SOAP:Fault><faultcode>SOAP:Client</faultcode><faultstring> security] Users require OSS Management privileges to use SAM-O</faultstring><faultactor>XmlApi</faultactor><detail><requestID>smarts@8598</requestID></detail></SOAP:Fault></SOAP:Envelope>

Explanation: No Alcatel-Lucent 5620 SAM-O license is present on the Adapter system. Please note the lines in bold text for the relevant information.

Number of complete s-hook Multicast circuitsINFO: built N s-hook multicast circuits

Explanation: During a discovery, the Adapter looks for the components that together would comprise a s-hook multicast circuit. This log message reports the number of complete s-hook multicast circuits that were built during the discovery.

Page 174: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

174 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Troubleshooting

Adapter encountered configured OSPF servicesINFO: Not using ospf.Site data for instance svc-mgr:service-8:…

Explanation: During discovery of OSPF objects, the Adapter requests ospf.Site records from the 5620 SAM EMS. Most relate to OSPF capability being enabled at a node, but 5620 SAM EMS occasionally delivers some records for configured services. This log message merely reports the adapter encountering one of these records.

Missing LSPOutSegmentWARNING: Could not find lspOutSegment for LSP:nnnn used in Tunnel: xxxx SvdId: yyyy

Explanation: EMC Smarts needs to relate a VRF to an LSPOutSegment at the site. However, no LSPOutSegment was created during discovery for the Node. To troubleshoot, open the 5620 SAM client, search to find the LSP in question, and look at the Properties under its CrossConnects tab.

Missing LSP HopWARNING: VPLS-mode MCAST LSPHop does not exist for LSP::LSP-10.1.1.101>…

Explanation: As part of looking for s-hook Multicast circuits, the Adapter encountered an LSP between the switch and the router for which the LSPHop did not exist. Most likely the LSP is simply down or misconfigured and that is why the hop cannot be found.

Undefined LSPWARNING: ForwarderEndpoint::FORWARDEREP-svc-mgr… uses MPLS Service tunnel NN from Node 12.34.56.78 but no LSP is defined for this tunnel

Explanation: Smarts MPLS does not model Service tunnels but does model LSPs. If a service that is created in the 5620 SAM EMS uses an MPLS Tunnel that does not have an LSP defined, this log message is generated, as the MPLS ForwarderEndpoint will have nothing to be layered over.

Page 175: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Adapter log entries 175

Troubleshooting

SEVERE: Cannot find outsegment for lsp:nnnnnnnnn

Explanation: During a discovery, the adapter collects Crossconnect information for each LSP. This message is logged when there is no Crossconnect record with a valid NextHop from the source Node of the LSP. To troubleshoot, open the Alcatel-Lucent 5620 SAM EMS client, search to find the LSP in question, and look at the Properties under its CrossConnects tab.

Page 176: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

176 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Troubleshooting

Page 177: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

Understanding the sm_edit Utility 177

I

As part of the EMC Smarts deployment and configuration process, you need to modify certain files. User modifiable files include configuration files, rule set files, templates, and files (such as seed files, and security configuration files) that contain encrypted passwords. Original versions of these files are installed into appropriate subdirectories under the BASEDIR/smarts/ directory.

Original versions of files should not be altered. If a file requires modification, it must be stored as a local copy of the file in BASEDIR/smarts/local or one of its subdirectories.

Example 1 Modify serverConnect.conf

In UNIX:

◆ The original version of the server connect (serverConnect.conf) security configuration file on UNIX is installed to:/opt/InCharge7/SAM/smarts/conf

◆ A modified serverConnect.conf security configuration file on UNIX should be saved to: /opt/InCharge7/SAM/smarts/local/conf

In Windows:

◆ The original version of the server connect (serverConnect.conf) security configuration file on Windows is installed to: C:\InCharge7\SAM\smarts\conf

◆ A modified serverConnect.conf security configuration file on Windows should be saved to: C:\InCharge7\SAM\smarts\local\conf

Understanding thesm_edit Utility

Page 178: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

178 EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Understanding the sm_edit Utility

Smarts software is designed to first search for user modifiable files in BASEDIR/smarts/local or one of its subdirectories. If a modified version of a file is not found in the local area, Smarts software then searches appropriate nonlocal directories.

To facilitate proper file editing, EMC Corporation provides the sm_edit utility with every Smarts product suite. When used to modify an original version of a file, this utility automatically creates a local copy of the file and places it in the appropriate location under BASEDIR/smarts/local. This ensures that the original version of the file remains unchanged. You can invoke sm_edit from the command line. Optionally, you can configure Windows so that sm_edit is automatically invoked when user-modifiable files are double-clicked in Windows Explorer.

To invoke the sm_edit utility from the command line, specify the path and the name of the file to edit under BASEDIR/smarts. If multiple Smarts products are running on the same host, invoke sm_edit from the bin directory of the product suite with the files to edit.

Example 2 Edit a configuration file

To edit the configuration file for connecting to a server (serverConnect.conf), invoke the sm_edit utility as follows:

/opt/InCharge7/SAM/smarts/bin>sm_edit conf/serverConnect.conf

In this example, the sm_edit utility automatically creates a local copy of the serverConnect.conf file in the /opt/InCharge7/SAM/smarts/local/conf directory and opens the file in a text editor. If a local version of the file already exists, the sm_edit utility opens the local version in a text editor. In addition, sm_edit creates any necessary subdirectories.

The EMC Smarts System Administration Guide provides additional information about the sm_edit utility.

Page 179: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 179

AAccess Interface 161Adapter

technical notes 159Alarm

COMMENT 76DEDUP 76EXPIRATION 76INACTIVE 76NOTARGET 76SEVERITY 76

Alarm processing 75, 77alarmRediscover.asl 78Alarms

best practices 77NOTARGET 78rediscovery 78

Alcatel 5620 SAM EMS Open Interface 69AltEmsInstance 68AltJmsPort 69AMInstance 67, 68ArchiveOnDelete 70ASA 67, 68ASA.log entries 173ASA-Alarm.conf 78

BBGPInstance 68BGPProtocolEndpoint

PeerState 163BGPProtocolEndpoint PeerAdminStatus 162BGPSession

Disconnected 116

CCard

Down 116ClearAlarmOnDelete 70clearFilters.asl 104ClientId 69Composite Service scheme 101Configuration 75CreateVPLSSAPs 71Crossconnect 175

DdeleteFilters.asl 104DevicesNotInEffect.conf 104Discovery 20DiscoveryOnJmsLoss 71DiscoveryOnStartup 71DomainType definition 88

EEmsInstance 67

FForwarder Endpoint 162ForwarderStatus 162

HHardware requirements 28

Iics.conf 88, 89

Index

Page 180: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide180

Index

IESAfterVPLS 71IESAfterVPLS parameter 102IGMPInterface 165IGMPInterface IGMPInterfaceUnreachable 117insertFilters.asl 104installation

text-based 45Installation Requirements 32Interface Down 117IP 161IPStatus 161

JJMS durable connection 113JmsPassword 70JmsPort 69JmsUniqueId 70JmsUser 70

LLdp.Interface 162ldp.TargetedPeer

administrative state 162LdpProtocolEndpoint 162Link Aggregation Group 162LogLevel 69LSP 175

Impacted 117LSPOutSegment 174

MMaximumReconfigureDelayTime 72MCASTInstance 68MD-5-hashed password 73mpls.LspPath 162MPLSInstance 68Multicast Manager 18MulticastQTag 71MulticastQTag parameter 102

NNetwork Interface

administrative status 161

OOIInstance 67, 68OSPFInterface

DiscoveredAdminStatus 163IfState 163

OSPFNeighborEndpointNeighborState 163

OSPFServerName 68OSPFService

ABRNotInBackbone 117OSPFService AdminStatus 163OSPFVirtualInterface 164

IfState 164OSPFVirtualNeighbor

NeighborState 165

PPhysical port

administrative status 161PIMInterface 165

PIMInterfaceUnreachable 118PIMInterface object 101Polling Groups 97

BGP 98ForwarderEndpoint 98LdpProtocolEndpoint 98OSPF 98VRFs 98

Processor card operational status 160

RReconfigureDelayTime 72ReconfigureSlidingWindow 72Requirements

Hardware 28Software 30

RouterDown 118

routerDiscover.asl 105

SSAM-O 69, 78Service discovery, scheduling 111serviceDiscover.asl 111S-Hook VPLS scheme 101, 102

Page 181: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

181EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide

Index

showFilters.asl 104Site names 104sm_edit utility 177SM_LIBPATH 74Software requirements 30svt.SpokeSdpBinding 162

VVPN

administrative/operational states 161Impacted 118

VRF 174Down 119

Page 182: EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS ... · EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide 3 Preface

EMC Smarts Adapter for Alcatel-Lucent 5620 SAM EMS 2.1 Installation and User’s Guide182

Index