Sei sulla pagina 1di 236

VistaLink® 4.

0 for
Alcatel-Lucent
5620 SAM
Installation and Configuration

December 2013
2

Part Number: 34_302_000_40_001

Copyright 2013 InfoVista S.A.


All rights reserved.
InfoVista® and Business Technology Intelligence®, VistaBridge®, VistaCockpit®,
VistaDiscovery®, VistaFoundation®, VistaInsight®, VistaLink®, VistaMart®, Vista
Plug-In®, VistaPortal®, VistaProvisioner®, VistaTroubleshooter®, VistaView®,
VistaWatch®, Accellent®, Vista360® and 5View ™ are registered trademarks or
trademarks of InfoVista S.A. in the United States and/or other countries.
All other trademarks, registered trademarks, product names and company names or
logos mentioned in this guide are the property of their respective owners.
The information contained in this document is the property of InfoVista S.A. No part of
this publication may be reproduced in any form (including photocopying or electronic
storage on any medium) or by any means or used to make any derivative work (such
as translation, transformation or adaptation) without the express written permission of
InfoVista S.A.
The information contained in this document is subject to change without notice and
does not carry any contractual obligation for InfoVista. InfoVista reserves the right to
make changes to any products or services described in this document at any time
without notice. InfoVista shall not be held responsible for the direct or indirect
consequences of the use of the information contained in this document.

web : www.infovista.com
E-mail: support@infovista.com

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide
3

Contents

1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM


About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
What’s new? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Technology overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Architecture and data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Data retrieval modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Data acquisition mechanism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Starting the VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2 Installing VistaLink for Alcatel-Lucent 5620 SAM


Standard installation workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Ensuring installation prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Alcatel-Lucent 5620 SAM requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
VistaFoundation® kit requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Specific Unix requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuring VistaMart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Importing VistaView libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Importing event message formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting up VistaLink data visibility in VistaMart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Installing VistaLink. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Checking directories and files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Installing VistaPortal resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Deploying VistaLink and solution page online help on VistaPortal . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Creating the connection to the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Importing the Page Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Importing users and groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Creating customized users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Filtering user data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Uninstalling VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Contents
4

Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44


What changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Upgrade process overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Ensuring upgrade prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Launching the upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

3 Configuring VistaLink for Alcatel-Lucent 5620 SAM


Using the Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Starting the Configuration Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Setting the VistaMart parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Setting the data retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Setting the SAM connection parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Setting the topology retrieval rules parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Setting the directories and data retention period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Setting the filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Setting the statistics retrieval parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Allocating memory space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Finalizing the configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Changing the default display rates for SAM data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuring discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Enabling discovery of an instance type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Enabling discovery of filtered out instance types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Disabling discovery of an instance type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Disabling discovery of a specific instance type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Configuring instance discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Performing advanced filtering of the topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Filter file structure and elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Creating a filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Configuring logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Managing the VistaLink service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Understanding zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Zone creation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Multiple proxy zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Configuring the sizing of proxy zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Contents
5

Managing VistaMart modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


Required modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Optional modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Starting volume indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Stopping volume indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Backing up and restoring the VistaLink configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM


Customizing your solution: main steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Customization use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Enabling data retrieval for a new OAM probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Enabling specific data retrieval on a optical port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Customizing your instance discovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Topology mapping file name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Topology mapping file structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Topology mapping file elements and attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Enabling the discovery of an instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Creating a topology mapping file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Modifying a topology mapping file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Customizing discovery of SAP instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Defining the statistics classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Protocol template file name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Protocol template structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Protocol template elements and attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Creating a protocol template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Modifying a protocol template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Creating an indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Indicator creation workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Ensuring prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Creating a VistaBridge library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Creating a VistaLink indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Providing a VistaLink formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Verifying the VistaLink formula syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Apply the rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Contents
6

VistaLink formula Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174


Basic parameter syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
For single-value counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
For multi-value counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

5 Troubleshooting VistaLink
Generating a support package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Troubleshooting VistaMart provisioning update failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Troubleshooting missing data in VistaMart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Replaying missing performance data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Replay missing performance data in FindToFile or Find mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Troubleshooting issues when entering a JMS client name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

6 Monitoring VistaLink with VistaCockpit


Starting and stopping VistaLink from VistaCockpit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Displaying the VistaLink status from VistaCockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

A Instance naming and tagging conventions


SAM attribute definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Instance identification syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

B Supported classes and MIB’s


Alcatel-Lucent classes supported by VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Supported MIB’s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
MIB’s to activate when using the default solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
MIB’s to activate when customizing your statistics retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Which MIB for which indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Contents
1 Getting Started with
VistaLink® 4.0 for Alcatel-
Lucent 5620 SAM

This chapter provides an overview of the VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
documentation, of the new features and of the VistaLink process.

 "About this guide" on page 8


 "What’s new?" on page 11
 "Technology overview" on page 12
 "Starting the VistaLink" on page 19

7
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM About this guide 8

About this guide


This section describes the purpose, intended audience and organization of this guide. It also
provides information on related documentation.

Purpose
This VistaLink for Alcatel-Lucent 5620 SAM Installation Guide contains all the necessary
information to install, configure, upgrade and customize a VistaLink for Alcatel-Lucent 5620 SAM.

Intended audience
This guide is intended for operators and engineers in charge of installing, configuring and
customizing the VistaLink for Alcatel-Lucent 5620 SAM.
To use this guide effectively, you need to be familiar with:
• Windows®, Solaris® or Linux® environments

• VistaPortal®, VistaMart® and VistaCockpit®

• Alcatel-Lucent API’s (packages, classes and attributes)

• network-specific features

• Alcatel-Lucent 5620 SAM.

Organization
This table provides an overview and direct access to the information available in this guide:

Section Topics
"Getting Started with Provides an overview of the VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for documentation, its new features and processes.
Alcatel-Lucent 5620
SAM"
"Installing VistaLink Provides the installation workflow and explains how to install, uninstall
for Alcatel-Lucent and upgrade VistaLink for Alcatel-Lucent 5620 SAM.
5620 SAM"
"Configuring Describes how to configure the VistaLink once you have installed
VistaLink for Alcatel- VistaLink® 4.0 for Alcatel-Lucent 5620 SAM. It also describes how to back
Lucent 5620 SAM" up and restore the configuration and manage the VistaLink service.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM About this guide 9

Section Topics
"Customizing your Explains how to customize your VistaLink to be able to discover new
VistaLink for Alcatel- instance types, filter the instance types to discover and create your own
Lucent 5620 SAM" indicators.
"Troubleshooting Indicates how to generate a support package and provides basic
VistaLink" procedures for troubleshooting your VistaLink.
"Monitoring Provides basic steps for monitoring VistaLink from the VistaCockpit
VistaLink with Management Console.
VistaCockpit"
"Instance naming Provides the necessary information to interpret the codification of the
and tagging name and tag (identifier) of each monitored instance.
conventions"
"Supported classes Provides the comprehensive list of Alcatel-Lucent classes and MIB
and MIB’s" variables supported by VistaLink for Alcatel-Lucent 5620 SAM.

Related documentation
VistaLink for Alcatel-Lucent 5620 SAM documentation
Depending on your objectives you can use the following Alcatel-Lucent 5620 SAM documents in
either PDF or HTML format.

Document Purpose
Installation Guide Use the present Installation Guide if you are planning to install, deploy,
upgrade or customize a VistaLink for Alcatel-Lucent 5620 SAM on
Windows, Solaris or Linux platforms. In particular, this guide describes the
Configuration Wizard that you will use each time you need to modify your
VistaLink Setup.
User Guide Use this guide to understand how VistaLink for Alcatel-Lucent 5620 SAM
works and to get VistaPortal page package and indicator descriptions.
The HTML version of the User Guide helps you navigate through the
VistaPortal pages. It provides a detailed description of the available
reports and a definition of the Key Performance Indicators (KPI’s) that are
started for the VistaLink.

Other documents
To perform given tasks described in the VistaLink for Alcatel-Lucent 5620 SAM Installation Guide
or to understand some concepts, you need to refer to the following additional VistaFoundation Kit
documents:
• VistaMart User Guide

• VistaCockpit User Guide

• VistaPortal Author Guide

• VistaPortal User Guide

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM About this guide 10

In some cases, you may also need to refer to the Alcatel-Lucent 5620 SAM documentation.

Accessing the documentation


The <VistaLink Installation Directory>\doc repository gives you access to the complete set of
documentation delivered with VistaLink:
The Installation Guide is available in PDF format and the User Guide is available in PDF and in
HTML format:

To display the... in format... double-click...


Installation Guide PDF \pdf\VistaLink_for_Alcatel_5620_SAM_Installation_Gui
de.pdf
User Guide PDF \pdf\VistaLink_for_SAM_Alcatel_Lucent_5620_User_Guid
e.pdf
HTML \html\help_default.htm

 You can also access the PDF version from the HTML version by clicking the icon at the
top right of any HTML page.

Accessing the online help


The VistaLink graphical user interfaces provide online documentation to help you configure
VistaLink or obtain details on reports and indicators used to monitor your network performance.

From the Configuration Wizard


You can obtain contextual online help on the Configuration Wizard by clicking the Help button on
each panel of the Wizard. These links also provide you access to the entire installation guide in its
HTML version.

From the solution pages on VistaPortal


You can access online help when you navigate through the VistaPortal pages by either clicking the
Help button, the question marks in the displets or the round icons next to the indicator names (for
more information see the VistaLink for Alcatel-Lucent 5620 SAM User Guide)

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM What’s new? 11

What’s new?
This releases includes the following new features:

Enhanced • By using the new VistaLink extensible framework, this version enables
scalability
polling and reporting on:
• more resources
• instance types that you add to your InfoVista solution model.

• Archiving is improved.

• The LogToFile mode now enables retrieving both performance and


accounting statistics data from the Alcatel-Lucent 5620 SAM database.
Multiple acquisition This VistaLink enables defining acquisition rates:
rates • specific to an instance type
• based on SAM server and VistaMart acquisition rates which are
displayed on the Configuration Wizard.
New tagging The tagging convention is now based on a unique identifier that is available
conventions in the SAM server with the objectFullName attribute, except for Service and
Customer objects.
Support for Traffic monitoring on Network Queue Group resources is now available.
Network Queue
Group resources
Support of new This version enables reporting on availability of the Alcatel-Lucent 9500
backhaul devices Microwave device using a new indicator and a new VistaPortal report
SAM 11.0 Support This VistaLink supports Alcatel-Lucent 5620 SAM version 11.0

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 12

Technology overview
The VistaLink for Alcatel-Lucent 5620 SAM is an InfoVista product that enables you to push
statistic and topology data obtained from the Alcatel-Lucent 5620 SAM (Service Aware Manager)
server into VistaMart.
VistaLink monitors the performance, availability and utilization of the various devices managed by
the SAM server.
This section provides an overview of the following topics:
 "Architecture and data flow" on page 12
 "Data retrieval modes" on page 13
 "Data acquisition mechanism" on page 17

Architecture and data flow


Working together, VistaLink and the Alcatel-Lucent 5620 SAM server provide a network
performance monitoring solution that addresses performance issues directly affecting end-user
experience.
The following diagram shows the interaction between the VistaLink, VistaMart and the SAM server
in a typical VistaLink architecture.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 13

VistaLink process
Once VistaLink is installed and connection is established with the SAM server, VistaLink starts
retrieving data from the SAM server. As illustrated in the diagram above, when you launch
VistaLink, it:
1 accesses topology changes on the SAM server via FTP (File Transfer Protocol) following a
SOAP (Simple Object Access Protocol) request.
2 provisions the topology changes into VistaMart.
3 accesses statistics files on the SAM server via FTP following a SOAP request and, in the case of
LogToFile mode (see "Data retrieval modes" on page 13), a JMS (Java Message Service)
notification.
4 parses the statistics files depending on the slots that are started on the VistaMart server and
generates the KPI (Key Performance Indicator) values required for performance management
and imports them into VistaMart.

Configuration Wizard process


At the end of the VistaLink installation process, the configuration wizard starts, and you set up:
• the global VistaLink application parameters

• the SAM server connection parameters

• the data retrieval modes.

Data retrieval modes


VistaLink provides the four following modes to send requests to the SAM server and retrieve data:
• LogToFile mode

• FindToFile mode
• Find mode

• Local mode
All modes are used to retrieve statistics (performance and accounting) data and topology data,
except for the LogToFile Mode which is used only to retrieve statistics data.
This section describes each mode.
To set the data retrieval mode, see "Setting the data retrieval mode" on page 62.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 14

FindToFile mode
In FindToFile data retrieval mode, VistaLink sends SOAP requests to the SAM server. The SAM
server answers to the VistaLink by indicating availability and location of the statistics or topology
XML files each time they are generated by the SAM server. VistaLink then retrieves the XML files
using FTP or SFTP (depending on what you set in sam_cfg.xml). This mode requires that you have
set an FTP server on your Alcatel-Lucent 5620 SAM machine and that you know the SAM output
directory (this is configured when you install your SAM server). The request results are then stored
in the specified data directory.

Topology retrieval workflow


The following diagram illustrates the FindToFile periodic workflow for retrieving topology files:
1 The File retriever function of the Topology processor in the VistaLink sends HTTP XML/SOAP
requests to the SAM server.
2 Upon confirmation from the SAM server of data availability, the Topology processor performs an
FTP request to the SAM server to obtain the XML topology files.
3 The Topology processor then parses and builds the topology.
4 VistaLink provisions VistaMart with the topology by starting the relevant slots in VistaMart then
periodically inserting the topology into VistaMart.

Statistics retrieval workflow


The following diagram illustrates the FindToFile periodic workflow for retrieving statistics files:
1 The File retriever function of the Statistics processor in the VistaLink sends HTTP XML/SOAP
requests to the SAM server.
2 Upon confirmation from the SAM server of data availability, the Statistics processor performs an
FTP request to the SAM server to obtain the XML statistics data files.
3 The Statistics processor then parses and computes the data.
4 VistaLink inserts the statistics data into VistaMart.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 15

LogToFile mode
The LogToFile data retrieval mode maintains up-to-date accounting and performance statistics
export files. In this mode, the SAM server periodically notifies the VistaLink of XML data files
availability and location (possibly on an auxiliary host) via a JMS event service. VistaLink retrieves
the compressed statistics files, formats them and makes them available for processing. InfoVista
recommends using this mode which supports high data collection rates. If you wish to minimize
collection latency and reduce system load, use the LogToFile option.

 The LogToFile mode cannot be used to retrieve topology data.

Statistics retrieval workflow


The following diagram illustrates the LogToFile workflow for retrieving statistics data:
1 The JMS service receives a JMS notification from the SAM server that statistics files are
available.
2 The JMS Service triggers the FTP service.
3 The FTP service sends an FTP request to the SAM server and obtains the statistics files.
4 The FTP Service formats and stores the data on the VistaLink in the data directory.
5 The Statistics processor periodically checks the data directory for new data, then, if new data is
available, it parses and computes the data.
6 VistaLink inserts the data into VistaMart.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 16

Find mode
In Find data retrieval mode, VistaLink sends XML requests to the SAM server. Answers are
delivered as XML/SOAP messages. In this mode, the request results are not stored.

Local mode
In Local data retrieval mode, instead of sending requests to the SAM server, VistaLink retrieves
data from a local directory where it is stored.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 17

Data acquisition mechanism


During data acquisition, for each instance VistaLink associates the indicator values with a
timestamp. Timestamping is based on devices instead of classes. The objective is to be able to
discriminate two devices of the same class which are polled at different times.
Each instance/indicator ‘last run’ timestamp is stored in the data/LastRun.xml file. At each
acquisition cycle, VistaLink refers to this file to determine precisely the starting point of the polling
and therefore the number of points to poll from the SAM server according to the acquisition rate.
However, if VistaLink has not performed any data acquisition for several cycles, attempting to
recover a large backlog of data may lead to congestion. In order to prevent such issues, you need
to set the History (minutes) parameter in the Configuration Wizard (see "Setting the statistics
retrieval parameters" on page 83) which defines the maximum period during which the data is
saved (data maximum history).
1 When you launch the script for the first time, since there is no ‘last run’ timestamp stored yet,
VistaLink refers to the History (minutes) value (120 minutes by default) to determine the number
of points to poll, according to the acquisition rate.

2 At each subsequent polling, VistaLink compares the data maximum history duration to the time
elapsed between the current timestamp (now) and the ‘last run’ timestamp stored in the
LastRun.csv file:
• If the elapsed time is smaller than the History (minutes) parameter value, VistaLink refers to
the ‘last run’ timestamp and polls all the points available from that time, as illustrated below.
There is no loss of data.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Technology overview 18

• If the elapsed time is larger than the History (minutes) parameter value, VistaLink ignores
the ‘last run’ timestamp and polls only the points made available during the Data Maximum
History period, as illustrated below. All the points beyond the data maximum history value are
lost.

Determining the appropriate data maximum history value


On the one hand, the unique History (minutes) parameter that you set in VistaLink addresses all
types of instances, regardless of the various vistas. On the other hand, the SAM Server holds the
data during individual Retention times, set for each different class of device.
For a given class, all sourced data older than its retention time are no longer available. Therefore,
carefully determine the data maximum history as a function of the retention times: it is useless to
set a data maximum history higher than the retention times set at the SAM Server level.
Refer to "Setting the statistics retrieval parameters" on page 83 for setting the appropriate data
maximum history value using the History (minutes) parameter.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Starting the VistaLink 19

Starting the VistaLink


You install VistaLink using a graphic installer (see "Installing VistaLink for Alcatel-Lucent 5620
SAM" on page 20).
VistaLink starts automatically once you have installed and configured it appropriately (see
"Configuring VistaLink for Alcatel-Lucent 5620 SAM" on page 54).
VistaLink comes with default topology mapping and protocol template files that you can customize,
especially if you need to discover new instance types (see "Customizing your VistaLink for Alcatel-
Lucent 5620 SAM" on page 114).
You can create your own indicators to suit your reporting needs. For general information and
procedure specific to VistaLink, see "Creating an indicator" on page 162.
To display and create reports on data retrieved with your VistaLink see the VistaLink for Alcatel-
Lucent 5620 SAM User Guide.

Installation and Configuration Guide - Chapter 1 Getting Started with VistaLink® 4.0 for Alcatel-Lucent 5620 SAM
2 Installing VistaLink for
Alcatel-Lucent 5620 SAM

This chapter provides the standard installation workflow and explains how to install, uninstall and
upgrade VistaLink for Alcatel-Lucent 5620 SAM.

 "Standard installation workflow" on page 21


 "Ensuring installation prerequisites" on page 22
 "Configuring VistaMart" on page 25
 "Installing VistaLink" on page 28
 "Checking directories and files" on page 31
 "Installing VistaPortal resources" on page 32
 "Uninstalling VistaLink" on page 43
 "Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM" on page 44

20
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Standard installation workflow 21

Standard installation workflow


To install VistaLink for Alcatel-Lucent 5620 SAM for the first time perform the following steps in the
order indicated:

To perform step... see...


1 "Ensuring installation prerequisites" on page 22
2 "Configuring VistaMart" on page 25
3 "Installing VistaLink" on page 28
4 "Checking directories and files" on page 31
5 "Installing VistaPortal resources" on page 32

Once the installation is completed successfully, VistaLink starts retrieving data from the Alcatel-
Lucent 5620 SAM server then automatically pushes data into VistaMart.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Ensuring installation prerequisites 22

Ensuring installation prerequisites


Refer to the Readme file for more details on the products versions, recommended hardware, and
supported platforms.
Before installing VistaLink, make sure that you meet the following requirements:
 "Alcatel-Lucent 5620 SAM requirements" on page 22
 "VistaFoundation® kit requirements" on page 23
 "Specific Unix requirements" on page 24

Alcatel-Lucent 5620 SAM requirements


Before installing VistaLink for Alcatel-Lucent 5620 SAM, ensure the following requirements on the
Alcatel-Lucent 5620 SAM server:

SAM user requirements


Create a SAM user with OSS (Operation Support System) Management permission that:
• is different from the existing admin user

• has read and write rights to access FTP files and delete processed files.
In the case remote file compression is to be activated from the VistaLink Configuration Wizard,
create a Unix user with SSH (Secured SHell) permissions and rights to create files in the Alcatel-
Lucent 5620 SAM data directories.

Accounting configuration requirements


Configure Accounting in a 3-step process:
• Specify the file policy, which determines how often log files of collected statistics counters are
collected and managed.
• Specify the accounting policy, which determines the types of statistics collected on per-usage
and per-service bases (by default only CompleteIngressEgressOctetsPackets is supported).
• Apply the accounting policy to the services at the Access Interface level.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Ensuring installation prerequisites 23

SNMP polling and MIB requirements


Make sure that SNMP polling is activated and required MIB’s are enabled:
• By default SNMP polling is not active. SNMP is required to retrieve most performance statistics.
If for a given instance type no statistics are available, you may need to create the corresponding
MIB policy to enable collection of the required statistics.
• According to the indicators you need, check that all the corresponding MIB’s are activated.
Refer to "Which MIB for which indicators" on page 220.

Auxiliary server requirements


• If using an auxiliary server on the SAM server, note its hostname and credentials.
Refer to the Alcatel-Lucent 5620 Service Aware Manager User Guide for details on:
• creating users

• configuring accounting

• enabling the MIB’s and activating SNMP polling.

VistaFoundation® kit requirements


Before installing VistaLink for Alcatel-Lucent 5620 SAM, ensure the following VistaFoundation Kit
requirements:
• See the Readme file for information on supported versions and platforms.

• Make sure the VistaFoundation products are installed in the following order:

Installation InfoVista Product


order
1 VistaCockpit
2 VistaMart Oracle database
3 VistaMart Server
4 VistaPortal

• Make sure VistaMart, VistaPortal and database services are up and running.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Ensuring installation prerequisites 24

Specific Unix requirements


 Otherwise specified, this guide uses Unix to address both Solaris and Linux environments.
To install and execute VistaLink in a Unix environment you need to use specific users and groups
as listed below. Before you start the installation on Unix, make sure those users and groups
already exist.

Unix specific users and groups


You always perform the installation and configuration of VistaLink as the root user.
The table below describes the role of each user and the group to which this user must belong.

User... performs the following... and must belong to


group...
root installation of VistaLink n/a
execution of Configuration Wizard
installation of hotfixes
infovista execution of VistaLink services (daemons) infovista (primary
group)

infovista user
• The infovista user is automatically configured so that it cannot be used for login except from
root for installation and configuration purposes. Do not modify the infovista user. So not set any
password.
• The VistaLink installation script automatically checks if the infovista user and the infovista
group already exist. If they are not found, the script creates them automatically.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring VistaMart 25

Configuring VistaMart
This section describes the following configuration procedures you need to perform from the
VistaMart Inventory Manager:
 "Importing VistaView libraries" on page 25
 "Importing event message formats" on page 26
 "Setting up VistaLink data visibility in VistaMart" on page 27

Importing VistaView libraries


The following procedure explains how to import SAM libraries (VistaViews). This configuration
prepares VistaMart for future provisioning.

 Import VistaView libraries


1 Run the VistaMart Inventory Manager to connect to your VistaMart repository.
2 From the File menu, select Manage Libraries.
The Library Management window opens.

3 Click (Set the repository of Libraries).


4 From the <VistaLink Installation Directory>\vviews\Install folder, select the
SAM40_Basic_VV_Package.zip and click Set Repository.
The new libraries appear in bold in the main window.

5 Make sure the libraries in bold are selected and click (Import).
6 When the process is completed, in the Message box click OK.
7 Click Close.
8 Repeat procedure from step 3 for the following VistaView packages, depending on your case:
• <VistaLink Installation Directory>\vviews\patches\<build_number>-vviews.zip,
whether you are installing for the first time or upgrading your solution
• <VistaLink Installation Directory>\vviews\Upgrade\SAM40_Upgrade_VV_Package.zip, only
in the case of an upgrade.
9 Close the Library Management window.
10 In VistaMart Inventory Manager, click the Model tab.
The VistaView libraries appear under the VistaMart and VistaBridge libraries nodes.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring VistaMart 26

Importing event message formats


In order to get explicit messages when the system raises an event, you must load an XML file that
contains the message format.

 Import event message formats


1 Run the VistaMart Inventory Manager to connect to your VistaMart repository.
2 From the File menu, select Manage Event Target.
3 Select the Filters tab.
4 At the bottom of this window, click Import.
5 In the Import an XML file window, browse to <VistaLink Installation
Directory>\vviews\config\Infovista_VM_-_Event_Conf.xml file.
6 Click Import.
7 In the Successful operation message box, click OK.
In the Filters tab of the Event Target Management window the list of filters is updated.

8 In the Targets tab, select the VistaMart target and click Edit.
The Target edition dialog box opens.
9 In the Filterset drop-down list, select Infovista Solution and click OK.
10 In the Event Target Management window, click Save then Close.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring VistaMart 27

Setting up VistaLink data visibility in VistaMart


You need to make sure that the display rate that corresponds to the data acquisition rate into
VistaMart is set as Available for Reports in VistaMart. If it is not set, you will not be able to see the
corresponding data points in VistaPortal reports.

 Set up VistaLink data visibility in VistaMart


1 From the VistaMart Inventory Manager, select the Config tab.
2 Expand the Global Configuration node.
3 Click Data Lifetime.
4 On the right panel, select the row of the display rate you need to set.
5 Select the Available for Reports check box on the bottom-right panel.

6 Close the Inventory Manager.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaLink 28

Installing VistaLink
This section addresses the installation of VistaLink® 4.0 for Alcatel-Lucent 5620 SAM in the
following environments:
• Windows

• Solaris

• Linux Red Hat


With respect to Solaris and Linux, both Operating Systems are referred to as Unix for any specific
instructions in this installation guide.
During this step you launch the VistaLink installation wizard which ends by automatically starting
the VistaLink Configuration Wizard. The installation is complete only once you have successfully
configured VistaLink using the Configuration Wizard.

Prerequisites
• You have ensured installation prerequisites (see "Ensuring installation prerequisites" on
page 22).
• You have configured VistaMart and imported the VistaViews library packages (see "Configuring
VistaMart" on page 25).

 Install VistaLink
1 In the VistaLink installation package:

for ... perform...


Windows double-click cdrom\Disk1\InstData\Windows\VM\setup.exe
Unix 1 Locate setup.sh.
2 To provide the executable permission for the file, execute command
chmod a+x setup.sh
3 Run ./setup.sh.

The Installation Wizard starts.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaLink 29

2 Follow the instructions on screen.


The installation process unrolls as follows:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaLink 30

Dialog box Action


Introduction Exit all programs prior to installation and click Next.
License Agreement Select “I accept the terms of the License Agreement” and click Next.
Setup Readme File 1 Click Open in web browser to view the Readme file in a browser.
2 Click Next.
Setup parameters Define where you want to install VistaLink and click Next.
The default path choice is:
• For Windows: C:\Program Files (x86)\Infovista

• For Unix: /opt/InfoVista


You have two options:
• Click Choose to change the path.

• Click Restore Default Folder to reset the path to the default directory.

 The VistaLinks/SAM subdirectory is automatically created at


your choice location.
Pre-installation 1 Verify that all parameters are correct. Click Previous if you want to
summary change the parameters.
2 Click Install to copy files to disk, or click Cancel to cancel the
installation and then Quit to confirm you want to cancel.
Installing The installer copies the files to disk
Install Complete Click Done when the installation is complete.
The Configuration Wizard starts.

3 Check that the VistaLinks\SAM directory is now available at your choice location. By default:
• For Windows: C:\Program Files (x86)\Infovista\VistaLinks\SAM
• For Unix: /opt/InfoVista/VistaLinks/SAM
For details on the contents of the installation directory, see "Checking directories and files" on
page 31.
4 Use the Configuration Wizard to prepare your VistaLink for Alcatel-Lucent 5620 SAM
configuration (see "Using the Configuration Wizard" on page 55).

 The Configuration Wizard sets up the VistaLink applications and services that interact with
the SAM server and the VistaMart repository. Being part of the whole installation package, it
is launched automatically as soon as the installer has completed its tasks. At that time,
parameters shared by the connected applications are passed from the installer to the
Configuration Wizard, thereby ensuring that you are not prompted twice for identical data.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Checking directories and files 31

Checking directories and files


The Vistalink for Alcatel-Lucent 5620 SAM installation directory is structured as any other
VistaLink, except for the sam specific sub-directory.
In the VistaLink installation directory, open VistaLinks\SAM and ensure it contains at least the
following directories to which you may need access during installation and configuration
procedures:

Directory Description
bin Contains VistaLink scripts, including the support package generation tool
and the Configuration Wizard.
config Contains VistaLink properties files.
doc Contains HTML and PDF folders where you find the:
• the PDF version of both VistaLink Installation and User guides

• the HTML version of the VistaLink Installation and Configuration Guide.


log Contains log files that are created when the respective functionality starts.
portal Contains the zip files that store VistaPortal report templates, page
packages and users, as well as the OLH (OnLine Help).
sam Contains the following directories:
• cache, which keeps track of the timestamps of the latest collected data.

• config, which contains the customized protocol templates and discovery


files
• data, which temporarily contains the data files generated with the scripts

• done, used for archiving the statistics and topology files from the SAM
Server once they have been processed
• ini, which contains the default protocol templates and discovery files.

 Do not modify files inside the ini folder.


uninst Contains standard uninstallation elements.
vistacockpit Contains information for the support package generation tool and for
VistaCockpit.
vviews Contains the VistaMart libraries and VistaMart event configuration files.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 32

Installing VistaPortal resources


This section addresses the installation of the VistaLink for Alcatel-Lucent 5620 SAM page
structure, report templates, users and solution page online help on your VistaPortal server.
You may perform these steps before or after configuring VistaLink ("Configuring VistaLink for
Alcatel-Lucent 5620 SAM" on page 54).
This section describes:
 "Deploying VistaLink and solution page online help on VistaPortal" on page 32
 "Creating the connection to the database" on page 33
 "Importing the Page Packages" on page 35
 "Importing users and groups" on page 37
 "Creating customized users" on page 39
 "Filtering user data" on page 40

Deploying VistaLink and solution page online help


on VistaPortal
Perform this procedure to make the VistaLink for Alcatel-Lucent 5620 SAM specific content
available in the VistaPortal installation directory.

Prerequisite
You have installed the VistaLink (see "Installing VistaLink" on page 28).

 Deploy VistaLink and solution page online help on VistaPortal


1 Close all your applications.
2 From <VistaLink Installation Directory>\portal directory, copy the
sAM40_portal_SAM40.zip and the SAM40_OLH.zip files to your VistaPortal server machine at the
root of the VistaPortal installation directory. If you are using Unix, perform this procedure as user
root.
3 Unzip SAM40_portal_SAM40.zip directly under the VistaPortal installation directory.
4 Make sure the following directories now exist:
• <VistaPortal Installation Directory>\reporting\templates\report\InfoVista\SAM40 and
contains the report templates for VistaLink for Alcatel-Lucent 5620 SAM

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 33

• <VistaPortal Installation Directory>\reporting\SAM40 and contains


InfoVista_SAM_Solutions_Page_Packages.xml and
InfoVista_SAM_Solutions_Users_Groups.xml
5 Unzip SAM40_OLH.zip, which is the online help package, in the VistaPortal installation directory
at the root of the VistaPortal installation directory. If you are using Unix, perform this procedure
as user root.
6 Make sure the SAM40 folder is now available under <VistaPortal Installation
Directory>\site\rubrics\help\user.
7 To check if the online help is deployed, log on to VistaPortal using a SAM user login and click
the Help button at the top right of the VistaPortal interface.

The HTML version of the Alcatel-Lucent 5620 SAM User Guide opens.
You can now log into your VistaPortal Management Console home page and perform the following
steps:
 "Creating the connection to the database" on page 33
 "Importing the Page Packages" on page 35
 "Importing users and groups" on page 37

Creating the connection to the database


For the VistaPortal reports to display data from the VistaMart database, you need to connect
VistaPortal to the VistaMart database.

Prerequisite
You have deployed the VistaLink on VistaPortal (see "Deploying VistaLink and solution page online
help on VistaPortal" on page 32).

 Create the connection to your VistaMart database


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the left-hand pane, expand the Configuration node and select VistaMart Database
Connections.
3 On the Create new connection panel, if your VistaMart database is not present, click Add and
enter:

Name Description
Label The name to display in the lists of VistaMart databases in the
displets. This field is optional. If you leave it blank, the Hostname is
used in the displet lists.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 34

Name Description
Host The host name of the VistaMart Oracle database you want to connect
to. This field is mandatory.
Note: If necessary, you can specify hostname:port to connect to a VM
server with a port other than 1521.
Database SID The name of the VistaMart database. This corresponds to the
database IVDB. This field is mandatory.
Database type Select the default option: ORACLE
User A valid operator user for the host. This field is mandatory. The user
and password were set in VistaMart when the database was created;
the VistaMart administrator can provide a valid viewer user for the
database to use in this field.
Password Password for the login name

4 Click Test to test the connection to VistaMart database.


5 If the test is successful, click Save to make the new connection, or Cancel to ignore the entries
and return to the list of connections.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 35

Importing the Page Packages


Perform the following procedure to make the VistaLink for Alcatel-Lucent 5620 SAM solution pages
available from VistaPortal.

Prerequisite
You have deployed the VistaLink on VistaPortal (see "Deploying VistaLink and solution page online
help on VistaPortal" on page 32).

 Import VistaLink for Alcatel-Lucent 5620 SAM Page Packages


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the tree view pane, click the node Page Packages.
3 At the right of the page, click Import.
The Import Portal Using Page Packages window appears.
4 In the Input File field, click Browse to select the file that contains the VistaLink for Alcatel-
Lucent 5620 SAM Page Packages: <VistaPortal Installation
Directory>\reporting\SAM40\InfoVista_SAM_Solutions_Page_Packages.xml.
This file contains the VistaPortal Page Packages and pages.
5 Make sure that the first four options are not selected.
6 Select the last option Replace VistaMart database(s) of input file with.
This option allows you to define which VistaMart repository will be used as the data source.
7 Select the VistaMart repository you require from the drop-down list.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 36

8 Click Import.
A message indicates that the import was successful.
9 Click Close.
10 Verify that the following Page Packages and related pages were correctly imported.

 Refer to the VistaLink for Alcatel-Lucent 5620 SAM User Guide for a description of each page
package.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 37

Importing users and groups


Perform the following procedure to import VistaLink for Alcatel-Lucent 5620 SAM specific users
and groups to VistaPortal.

Prerequisite
You have deployed the VistaLink on VistaPortal (see "Deploying VistaLink and solution page online
help on VistaPortal" on page 32).

 Import the VistaPortal users and groups


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the tree pane, click All.
3 At the right of the page, click Import.
The Import Portal Using All window appears.
4 In the Input File field, enter the path to the file that contains the VistaLink for Alcatel-Lucent
5620 SAM users and groups: <VistaPortal Installation
Directory>\reporting\SAM40\InfoVista_SAM_Solutions_Users_Groups.xml.
5 Make sure that the first three options are not selected.
6 Select the last option Replace VistaMart database(s) of input file with.
This option allows you to define which VistaMart repository will be used as to handle the users
and groups.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 38

7 Select the repository you require from the drop-down list.

8 Click Import.
9 Click Close.
10 Verify that the SAM users groups were correctly imported:

11 Connect to the VistaPortal login page and use the default user name and password:

User groups Default user name/password


Customer Users SAMCustomer/[blank] (no password)
Engineer Users SAMEngineer/[blank] (no password)
Manager Users SAMManager/[blank] (no password)

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 39

Creating customized users


The following procedure applies only to the creation of a customized user in an existing SAM Users
Group.

Prerequisites
You have imported the VistaLink for Alcatel-Lucent 5620 SAM solution pages, users and groups
into VistaPortal (see "Importing the Page Packages" on page 35 and "Importing users and groups"
on page 37).

 Create a customized SAM user in VistaPortal


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the tree view expand All > InfoVista Solutions User Groups > SAM Users Groups.

3 Select the User group you wan to add a user to (for example, Customer Users).
4 In the Users tab of the chosen user group page, click Add.
The Add New User window appears.
5 Add a login for the new user. The other fields are optional.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 40

6 Click Save.
The Users tab of the chosen user group page refreshes with the new user.

7 Log on to VistaPortal using the new user’s credentials.


Because the user was created within one of the existing user groups, the user inherits all of the
pages associated with that user group. If you create a new subgroup and add your new user to this
user group, the user inherits any pages to which you subscribed;. If you did not subscribe to any
pages for the new subgroup, the user inherits nothing and must manually add them.

 For information on creating a customized user not linked to an existing Users Group or
creating a new subgroup, refer to chapter Managing Users and Subgroups of the VistaPortal
Author Guide.

Filtering user data


Once you have created a user, you may want to filter data in the reports so as to display only the
data relevant to that user. This ensures that the customer only sees instances belonging to his
monitored infrastructure. This is especially true if you created a user in the Customer Users SAM
User Groups
To filter data, you must set a variable for the customer name.

Prerequisites
You have created users in VistaPortal (see "Creating customized users" on page 39).

 Set a customer name


1 Log on to VistaPortal as an administrator.
2 Go to All > SAM Users Groups > Customer Users.
3 Click the desired user.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 41

4 Click the Variables tab.

5 On the Var_Customer row, click the Edit button.


6 Enter the desired variable value (Example: Ford).

7 Click Save.
Once you have saved the variable and re-run a report in VistaPortal, the report for the customer
user displays only the designated customer.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installing VistaPortal resources 42

The following example displays the report before and after filtering:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Uninstalling VistaLink 43

Uninstalling VistaLink
Use the following procedures to uninstall your VistaLink either from a Windows or a Unix platform.

Prerequisites
• If you want to save your configuration as well as data before you uninstall your VistaLink back
up the following directories from your VistaLink installation directory:
• config
• sam, with all its sub-directories.
• Stop the VistaLink service.

 Uninstall VistaLink on Windows


1 From the <VistaLink Installation Directory>\uninst\launcher folder, launch uninstall.exe.
The uninstaller window appears.
2 Click Uninstall to uninstall VistaLink.
3 Click Done to complete the uninstallation.
4 Delete the SAM repository.

 Uninstall VistaLink on Unix


1 From a Unix Terminal, run command:
<VistaLink Installation Directory>/uninst/launcher/uninstall
The uninstaller window appears.
2 Click Uninstall.
3 Click Done to complete the uninstallation.
4 Delete the SAM repository.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 44

Upgrading to VistaLink® 4.0 for Alcatel-


Lucent 5620 SAM
During an upgrade to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM, VistaLink updates the VistaMart
database with possible zone name and instance tag changes by performing an instance migration.
See the following topics:
 "What changes" on page 44
 "Upgrade process overview" on page 45
 "Ensuring upgrade prerequisites" on page 46
 "Launching the upgrade" on page 49

What changes
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM is based on a VistaLink extensible framework and
provides many customization features. As a server component, VistaLink now handles task
scheduling autonomously without VistaCockpit. It uses topology mapping files that you can
customize for each instance type and supports many more classes. Therefore the mapping and
general VistaLink configuration files of your previous version are no longer applicable.

Configuration files
After its upgrade, the VistaLink will no longer use the following files:
• general VistaLink configuration files:
• sam_cfg.xml (in its previous format)
• sam_global.xml
• mapping files:
• samTopoMapping.xml
• samMapping.xml
• samStatAddMapping_Advmodule.xml
• samStatAddMapping.xml

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 45

VistaCockpit workflows
• VistaLink no longer requires setting workflows in VistaCockpit.

VistaMart zones
• VistaLink automatically creates and names four different zones in VistaMart during its
configuration.
• The upgrade transfers the resources to the new zones if the zone names change during the
upgrade.
• Former zones are preserved and left either empty or with instances that could not be migrated.

Tagging and naming conventions


• Naming conventions have not changed except for a few instance types (see appendix "Instance
naming and tagging conventions" on page 198). For these instance types you need to change
the names manually.
• Most tagging conventions have changed. The upgrade process automatically modifies the tag of
each instance except for instances whose names have also changed. In these exceptional cases
you need to change the tags manually.

Upgrade process overview


The VistaLink upgrade process uses the instance names to migrate them to the new mapping files,
provided that:
• each instance has a unique name

• the instance name has not changed from one version to another

• the instance still exists in the new topology.


When you launch the upgrade, the system performs the following steps. It:
1 Queries the former mapping files that contain the default as well as the customized indicators.
2 Generates the Custom_KPIs.csv which contains all the former customized indicators with a
suggestions for new formulas that take into account Alcatel-Lucent 5620 SAM and VistaLink
updates.

 You can find this file under <New VistaLink installation


directory>\VL_SAM_Upgrade_Output\KpiGeneratedFiles folder.
3 Queries the old VistaMart database and generates the SAM_OLD_Instances.csv that contains the
instance tags and names of all former SAM related instances.
4 Retrieves the new SAM topology and generates the SAM_4_0_Instances.csv that contains the
instance tags and names of all new SAM related instances.
5 Compares SAM_OLD_Instances.csv with SAM_4_0_Instances.csv to analyze which instances may
or may not be migrated. As a result, it:
• Generates the Instance_Tag_Updates.csv that contains all the names of the instances that
can be migrated and maps their tags in both former and new VistaLink versions.
• Creates the following error files that discriminate the instances that cannot be migrated:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 46

File.. includes...
OLD_Instances_Not_ the instances that are part of the previous topology that were not
Found_In_4_0.csv discovered in the new SAM server topology
4_0_New_Instances. the instances discovered in the new SAM server topology that were not
csv part of the previous topology and therefore do not need to be migrated
OLD_Duplicate_Inst all the instances (mainly service instances) from the previous VistaMart
ances.csv database that have multiple names and therefore cannot be matched by
their names
4_0_Duplicate_Inst all the instances from the SAM server topology that have multiple names
ances.csv and therefore cannot be matched by their names

 You can find all these files under <NewVistaLink installation


directory>\VL_SAM_Upgrade_Output\topologyGeneratedFiles folder.

Ensuring upgrade prerequisites


Before upgrading you must perform the following important tasks:
• Make sure that you are using the required VistaFoundation and mandatory hotfixes as specified
in the Readme file.
• Stop and kill the VistaLink for SAM workflows scheduled in VistaCockpit (see the VistaCockpit
User Guide).
• If the previous VistaLink is installed on Windows, close the command prompt window that is
running the JMS availability process (availability_launch.bat).
• Back up the VistaLink configuration files (see following section ‘Backing up the configuration
files’).
• If you are about to install the new VistaLink on a machine different from the one the previous
VistaLink was running on, uninstall the previous VistaLink.
• Back up the VistaMart database that contains the data collected with the previous VistaLink
version and the VistaViews (see the VistaMart Administration Guide).
• Delete or unsubscribe your VistaPortal Solution page users:

If... then...
you want to keep the users you created with unsubscribe all the users from the previous
your previous version Page Packages (see following section
‘Unsubscribing the previous VistaLink for SAM
Users‘)
you do not need to keep the users you delete the user groups (see following section
created with your previous version ‘Deleting the previous VistaLink for SAM Users’)

• Download and unzip your new VistaLink installation package.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 47

Backing up the configuration files


The configuration files are in <VistaLink Installation Directory>\bin and include the following
files:
• sam_cfg.xml

• sam_global.bat(sh)

• sam_global.xml

• samTopoMapping.xml

• samMapping.xml

• samStatAddMapping_Advmodule.xml

• samStatAddMapping.xml
Copy these files and any other configuration files you have possibly customized for the previous
VistaLink version to a temporary directory to keep a backup of your previous configuration
parameters. If you are installing the new VistaLink version on a different machine make sure to
copy these files to the new machine.

Unsubscribing the previous VistaLink for SAM Users


If you want to keep the users you created with your previous version you need to unsubscribe them
from the previous Page Packages:

 Unsubscribe the previous VistaLink for SAM Users


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the tree view expand All > InfoVista Solutions User Groups and select SAM Users Groups:

3 In the right-hand pane, in the Subscriptions tab, unsubscribe all the users from the
SAM31_Customer page package by clicking :

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 48

4 In the tree view, expand SAM Users Groups and select Customer Users.
5 In the right-hand pane, click the Subscriptions tab.
6 Unsubscribe all the users that belong to the Customer Users group from the SAM31 Customer
page package by clicking .
7 Repeat procedure similarly from step 4 for Engineers Users and Manager Users.

Deleting the previous VistaLink for SAM Users


If you do not need to keep the users you created with your previous version, use the following
procedure to delete the users.

 Delete the previous VistaLink for SAM Users


1 Connect to the VistaPortal Management Console and enter your administrator login and
password.
2 In the tree view expand All and select InfoVista Solutions User Groups.

3 In the right-hand pane, click the Subgroups tab.


4 Click that corresponds to SAM_Users_Group:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 49

All the users that are part of the SAM Users Group are now deleted.

Launching the upgrade


You basically perform the VistaLink upgrade installation like for a standard installation. The
upgrade process starts during the configuration phase. Make sure to import the new solution model
VistaViews (libraries) at the very beginning of the configuration phase and before the upgrade
wizard starts.

! The upgrade process updates the topology and the VistaViews in your VistaMart database.
VistaMart database updates cannot be undone. Make sure you have backed up your
VistaMart database before launching the upgrade.

Prerequisite
 See "Ensuring upgrade prerequisites" on page 46

 Launching the upgrade


1 Stop the VistaLink service (see "Managing the VistaLink service" on page 102).
2 Import the following VistaView library packages from the vviews folder of your unzipped
VistaLink installation package into VistaMart (see "Importing VistaView libraries" on page 25):
• Install\SAM40_Basic_VV_Package.zip
• Upgrade\SAM40_Upgrade_VV_Package.zip
• patches\<build_number>-vviews.zip
3 Perform a standard installation (see "Installing VistaLink" on page 28).

 The Welcome panel of the installation wizard should indicate that a previous version
has been detected and will be upgraded.
4 When the Configuration Wizard starts, set the parameters as needed in the VistaMart
Connection panel and click Next.
If VistaLink detects the existence of former SAM data in the VistaMart database, the Upgrade
Wizard starts.
5 Depending on the case:
• If you have launched the installation on the machine where the previous VistaLink is installed,
read the welcome panel of the upgrade wizard and click Proceed. The Upgrade Wizard
automatically retrieves the pre-existing configuration files in the former VistaLink installation
directory.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 50

• If you have launched the installation on a different machine, the following welcome panel
appears: click ... to browse to the location on your machine where you copied the
configuration files from the former machine and click Proceed.

The Configuration Files Analysis panel opens and indicates the results of the configuration
parameters and mapping files analysis.
For example:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 51

6 Depending on the operating system of your new VistaLink platform, and if the Upgrade process
has detected customized KPI’s in your previous configuration, you can obtain formula
suggestions for those KPI’s either by:
• browsing to the <New VistaLink installation
directory>\VL_SAM_Upgrade_Output\KpiGeneratedFiles and opening the Custom_KPIs.csv
• or, if available, clicking View Configuration Analysis, which takes you directly to the folder
that contains the file.
7 Click Next.
The Topology Analysis panel opens and indicates the percentage of instances that can be
migrated and why the other instances cannot be migrated.
For example:

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 52

8 Depending on the operating system of your new VistaLink platform, you can obtain details on the
instances that cannot be migrated either by:
• browsing to the <New VistaLink installation
directory>\VL_SAM_Upgrade_Output\topologyGeneratedFiles folder.
• or, if available, clicking View Topology Analysis, which takes you directly to the folder that
contains the files.
For information on the files provided under <New VistaLink installation
directory>\VL_SAM_Upgrade_Output\topologyGeneratedFiles see "Upgrade process overview"
on page 45.
9 Click Next.
The Upgrade Process Information box opens and possibly reminds the percentage of instances
that cannot be migrated and that the migration process cannot be undone.

! Make sure you have backed up your VistaMart database.


For example:

10 To migrate the instances and finalize the upgrade, click Proceed.


The upgrade process starts upgrading the tag and zone for each instance that can be migrated.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Upgrading to VistaLink® 4.0 for Alcatel-Lucent 5620 SAM 53

A status window displays the step by step progress of the migration.


11 When the migration is finished, close the window.
A history of the migration is available in the log files.

 For the instances that were not migrated due to a name change issue, you may modify
their name manually directly from your VistaMart Inventory Manager (see your
VistaMart User Guide). For those that encounter a tag change issue, in order to ensure
data continuity, you have to request help from your InfoVista support.

Installation and Configuration Guide - Chapter 2 Installing VistaLink for Alcatel-Lucent 5620 SAM
3 Configuring VistaLink for
Alcatel-Lucent 5620 SAM

This chapter describes how to use the Configuration wizard which is launched automatically by the
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM installer. It also describes how to start it later in order
to modify the initial configuration.
This chapter also provides advanced configuration procedures that you can perform after running
the Configuration Wizard.

 "Using the Configuration Wizard" on page 55


 "Changing the default display rates for SAM data" on page 88
 "Configuring discovery" on page 91
 "Performing advanced filtering of the topology" on page 95
 "Configuring logs" on page 101
 "Managing the VistaLink service" on page 102
 "Understanding zones" on page 103
 "Configuring the sizing of proxy zones" on page 106
 "Managing VistaMart modules" on page 107
 "Backing up and restoring the VistaLink configuration" on page 113

54
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 55

Using the Configuration Wizard


The Configuration Wizard enables you to set up the VistaLink application and services that interact
with the SAM server and the VistaMart repository, using a graphical interface. Being part of the
whole installation package, it is launched automatically as soon as the graphical installer has
completed its tasks. At that time, parameters shared by the connected applications are passed
from the installer to the Configuration Wizard, thereby ensuring that you are not prompted twice for
identical data. However, you can run the wizard later to modify the configuration of previously
installed components.
The configuration process is platform-independent and applies the same way to all working
environments.The Help button in each screen enables you to access the contextual documentation
that assists you with the configuration process.

 A web browser is required to access the help pages from the Configuration Wizard.
Whether the configuration starts automatically following the VistaLink for Alcatel-Lucent SAM
installation or whenever you decide to run it, you are guided to perform tasks in a given order:

To perform the tasks of see...


configuration wizard panel...
VistaMart "Setting the VistaMart parameters" on page 58
Retrieval Mode "Setting the data retrieval mode" on page 62
SAM Connection "Setting the SAM connection parameters" on page 64
Retrieval Rules "Setting the topology retrieval rules parameters" on page 75
Directories "Setting the directories and data retention period" on page 78
Filters "Setting the filters" on page 81
Statistics Retrieval "Setting the statistics retrieval parameters" on page 83
Memory "Allocating memory space" on page 86

Your configuration is saved only if you validate it in the last Finish panel (see "Finalizing the
configuration" on page 87).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 56

Starting the Configuration Wizard


Use this procedure if you need to modify the configuration settings once the VistaLink is already
installed.

Prerequisite
You have installed the VistaLink (see "Installing VistaLink for Alcatel-Lucent 5620 SAM" on
page 20).

 Start the Configuration Wizard


Depending on the platform on which VistaLink is running:

On... perform...
Windows either from the:
• the Start menu, select All Programs > InfoVista > VistaLink SAM
Configuration Wizard, or
• the <VistaLink Installation Directory>\bin directory, run
sam_config.exe.
Unix 1 Log in as the root user.
2 Go to the bin directory using command cd /opt/InfoVista/
VistaLinks/SAM/bin.
3 Run the ./sam_config.sh command.

The VistaMart Connection panel of the VistaLink Configuration Wizard opens:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 57

4 When you use the Configuration Wizard for the first time, enter each panel in sequence. If you
need to modify a given configuration panel, click Next until you reach it.
5 To obtain online help on a given panel, click Help.
6 To set parameters:

on configuration wizard see...


panel...
VistaMart "Setting the VistaMart parameters" on page 58
Retrieval Mode "Setting the data retrieval mode" on page 62
SAM Connection "Setting the SAM connection parameters" on page 64
Retrieval Rules "Setting the topology retrieval rules parameters" on page 75
Directories "Setting the directories and data retention period" on page 78
Filters "Setting the filters" on page 81
Statistics Retrieval "Setting the statistics retrieval parameters" on page 83
Memory "Allocating memory space" on page 86

7 Once you have finished your settings, click Next until you reach the final panel.
8 Click Finish.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 58

Setting the VistaMart parameters


This panel lets you identify the VistaMart used to provision the topology and to store the
performance and statistics data. It also enables you to modify the default names of the zone set
and zones into which VistaLink will provision the instances.
The setting are stored in the <VistaLink Installation Directory>\config\Commons-
config.properties file.
For details on the zone generation process, see "Understanding zones" on page 103.

Prerequisites
The VistaMart panel of the VistaLink configuration wizard is open.

 Set the VistaMart parameters

 If you use VistaInsight for Networks, you can use its parameters for configuring VistaMart
here, including host, user, password, etc.
1 Set the following parameters:

For parameter... enter...


Server Host the name or the IP address of the machine that hosts the VistaMart
Application and Computation services.
Specify the port number if different from 11080 in the associated Port
field (default value = 11080).
Database Host the host name of the VistaMart Oracle database you want to connect to.
Specify the number of port used to connect to a VistaMart server if
different from 1521 in the associated Port field (default value = 1521).

 This field is optional, except in case of an upgrade.


Database SID the name of the VistaMart database.

 This field is optional and associated with the Database Host


field.
Operator User the VistaMart repository user identifier.
Name
This is the operator user identification.
Refer to the VistaMart Inventory Manager User Guide for more
information on the different types of users.
Operator Password the VistaMart repository user password.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 59

For parameter... enter...


Zone Set the zone set defined in VistaMart (default value = Default).
The zone set will automatically include the following zone types
dedicated to SAM in VistaMart:
• Groups

• Devices

• Performance

• Accounting
SAM Groups the name of the zone designed to contain the group instances such as
Services and Customers.
(default value = SAM_GROUPS)
SAM Devices the name of the zone designed to contain the monitored devices
(routers, Microwave and LAN switches)
(default value = SAM_DEVICES)
SAM Performance the generic name of the zones designed to contain the monitored proxy
instances such as interfaces, cards, LAGs, SAM SAP’s, etc.
(default value = SAM_PERFORMANCE)
VistaLink may create several zones of this type depending on the
number of discovered proxies.
The size of this zone is constrained by a configurable threshold. To
configure the maximum number of instances to provision into the zones
dedicated to proxies (see "Understanding zones" on page 103).
SAM Accounting the generic name of the zones designed to contain the monitored proxy
instances such as OAM probes, SAP and network queues, etc.
(default value = SAM_ACCOUNTING)
VistaLink may create several zones of this type depending on the
number of discovered proxies.
The size of this zone is constrained by a configurable threshold. To
configure the maximum number of instances to provision into the zones
dedicated to proxies (see "Understanding zones" on page 103).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 60

For example:

2 Click Next.
The Test Panel window opens to indicate the status of the:
• Application Services Connection test
• SAM VistaViews Test
• VistaMart Zone Test
• Database Connection test

If a status is red, select a test to get details on the test results at the bottom of the window.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 61

For example:

3 Click Close.
4 If necessary, correct your VistaMart connection parameters or install the VistaViews if required
and click Next again.
The Configuration Wizard proceeds to the Retrieval Mode panel.

Next step
See "Setting the data retrieval mode" on page 62.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 62

Setting the data retrieval mode


VistaLink provides the four following modes to send requests to the SAM server and retrieve data:
• LogToFile mode

• FindToFile mode

• Find mode

• Local mode
All modes are used to retrieve statistics (performance and accounting) data and topology data,
except for the LogToFile Mode which is used only to retrieve statistics data. For more information
of the retrieval modes, see "Data retrieval modes" on page 13.
The following procedure enables you to specify the data retrieval modes.

Prerequisites
The Retrieval Mode panel of the VistaLink configuration wizard is open.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 63

 Set the retrieval mode


1 Select either one of the following radio buttons:

Select... to...
LogToFile Mode retrieve XML statistics data files upon notification from the SAM server,
format them and make them available for periodic insertion into
VistaMart.

 The LogToFile mode is used only for statistics data retrieval.


When this mode is selected, VistaLink uses the FindToFile
mode to retrieve topology data from the SAM server.
FindToFile Mode send XML requests to the SAM server, obtain statistics or topology data
in XML files via FTP from the SAM server then store the files in the Data
directory.
Find Mode send SOAP requests for statistics or topology data to the SAM server
and obtain information in XML/SOAP messages without storing data.
Local Mode retrieve statistics or topology data from a local directory where it is
stored.

2 Click Next.
The Configuration Wizard proceeds to the SAM Connection panel.

Next step
See "Setting the SAM connection parameters" on page 64.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 64

Setting the SAM connection parameters


The SAM connection panel enables you to define the parameters to connect to the Alcatel-Lucent
5620 SAM servers using FTP (File Transfer Protocol), JMS (Java Message Service), and possibly
an SSH (Secure SHell) connection. It consists of several tab panels.
From this panel, if activity switch is enabled on the SAM server, you have to set up redundant
connections to the primary and backup servers. In this case, VistaLink can dynamically obtain data
from the active SAM server.
You first set the host connection parameters for the primary then for the backup server. You then
sequentially set the FTP, SSH and JMS connection parameters.

Setting the SAM host parameters


Use this procedure to define the primary and the backup SAM servers.

Prerequisites
The SAM Connection panel of the VistaLink configuration wizard is open.

 Set the host parameters


1 Select the Primary SAM Server tab.
2 If you have a backup host server, select the Define Backup Host checkbox.
The Backup SAM Server tab appears.
3 Select the SAM-O tab of the Primary SAM Server.
4 Set the following parameters:

For parameter... enter...


Host the IP address or hostname of the machine hosting the primary SAM
server.
The Configuration Wizard sets the Port field automatically according to
the Protocol setting and the type of server. The Port field indicates the
port number used on the SAM server for receiving SOAP requests.
Protocol http or https connection protocol from the drop-down list.
User Name the user login name providing access to the primary SAM server that
VistaLink sources its data from.
Password the associated password.
You may directly enter an encrypted password.
If you enter a password a password already encrypted using an
MD5Hash tool command, select the MD5 checkbox.

 If you do not enter an encrypted password, VistaLink will


automatically encrypt your password with an MD5 Hash tool
for its SOAP requests to the SAM server, even if MD5 is
unchecked.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 65

For parameter... enter...


Key Store the KeyStore file, only if you have selected the HTTPS protocol:
1 Click ...
2 Browse to the folder where the KeyStore file is stored.
3 Select the file.
4 Click Select.
The filename is added to the Keystore field.

 To use https, you must create a KeyStore file using the Java
key tool (see the java web site at http://java.sun.com) and
configure the SAM server. This tag refers to the certificate file
(.keystore file): enter the path to the .keystore file.
KeyStore password the password associated with the KeyStore file.
Connection Time the waiting period in seconds after which an HTTP or HTTPS connection
Out (seconds) is no longer attempted.
After attempting to connect to the SAM server, VistaLink waits for the
SAM server to reply then stops attempting to connect if unsuccessful
after the specified period.
Data Time Out the network time out in seconds.
(seconds)
When VistaLink has not received any data from the primary server for the
specified time period, due to any network connection issue, then
VistaLink connects to the backup server. If the backup server does not
answer after the specified time period, the process stops.
For example:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 66

5 If available, select the Backup SAM Server tab and in Host, enter the IP address or the name of
the backup server.
All other parameters are identical to those of the primary server. For example:
.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 67

Setting the SAM FTP parameters


Use this procedure to define the parameters to connect to the SAM server via FTP (File Transfer
Protocol). If the VistaLink fails to connect to the primary FTP host, the secondary host takes over
as primary.

 The FTP parameters are not used if you are in Find mode.

Prerequisites
The SAM Connection panel of the VistaLink configuration wizard is open.

 Set the FTP parameters


1 Select the Primary SAM Server tab.
2 Select the FTP tab.
The Host field is grayed and includes the name or IP address of the machine that hosts the
primary SAM server.
3 Set the following parameters:

For parameter... enter...


Port port number used for FTP connections
Protocol FTP or SFTP (Secure FTP) depending on the type of protocol mode you
want to use.
User Name FTP user login

 In order to remove files from the SAM Server, the FTP user
defined in the Configuration Wizard, must have Delete File
rights.

 You can use the default SAM_admin user.


Password FTP user password
FTP Directory FTP directory path where the data files are stored on the SAM primary
server
Maximum the maximum number of concurrent authorized FTP connections to the
Connections FTP server.

4 To activate the FTP passive mode, select the Passive Mode checkbox.
5 To use the same Connection Time Out (Seconds) and Data Time Out (Seconds) settings
defined for SAM-O in the previous tab, select Use timeouts defined for SAM-O.
For example:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 68

6 If available, select the Backup SAM Server tab and repeat procedure from step 2 to set the
parameters for the backup SAM server.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 69

Setting the SAM SSH parameters


The SSH feature enables you to control and compress the SAM-generated statistical files before
transferring them to VistaLink. VistaLink then decompresses this file before pushing the statistics
to VistaMart.

 The SSH parameters are not used if you are in LogToFile or Find mode.

Prerequisites
The SAM Connection panel of the VistaLink configuration wizard is open.

 Set the SSH parameters


1 Select the Primary SAM Server tab.
2 Select the SSH tab.
The parameter fields are grayed and inactive if Activate Remote File Compression is not
selected.
3 To enable compression of the SAM-generated statistical files before transferring them to
VistaLink, select Activate Remote File Compression.
4 Select your setting mode:
.

To use... then...
the same settings as for FTP connections select Same Settings as FTP.
different settings make sure Same Settings as FTP is not
selected.

5 Depending on your selection, set the following parameters, as available:

For parameter... enter...


Host IP address or hostname of the machine hosting either the primary or the
backup SAM server
Port port number used for SSH connections
User SSH connection user login

 In order to remove files from the SAM Server, the SSH user
defined in the Configuration Wizard, must have delete file
rights.

 You can use the default SAM_admin user.


Password SSH user password
Maximum the maximum number of authorized SSH connection attempts before
Connections VistaLink abandons trying to connect to the SSH server

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 70

For example:

6 If available, select the Backup SAM Server tab and repeat procedure from step 2 to set the
parameters for the backup SAM server.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 71

Setting the JMS parameters


VistaLink uses the SAM Server JMS services for collecting statistics when you set the LogToFile
mode and for monitoring the device availability.
A JMS client controls which event messages it receives by subscribing to the appropriate JMS
topics and filtering the events. A JMS subscription must include a filter that defines the types of
events to be received by the JMS Client for a given group of users.
The JMS tab panel of the SAM Connection panel enables you to set up a single connection to the
JMS Client and to define a JMS subscription. It lets you define the configuration of the JMS
process, including the group of users via a Client Id that can retrieve the XML files that belong to a
given topic.

About SSL
When you enable SSL (Secure Socket Layer), the Alcatel-Lucent 5620 SAM-OSS clients can
receive JMS XML messages securely by encrypting them through SSL. The SSL Certificate is
configured on the Alcatel-Lucent 5620 SAM server.
You must also configure the following client components:
• SSL KeyStore file on the OSS client

• Java to use the KeyStore file on the OSS client


When you disable SSL, JMS XML messages are not encrypted.

Prerequisites
The SAM Connection panel of the VistaLink configuration wizard is open.

 Set the JMS parameters


1 Select the Primary SAM Server tab.
2 Select the JMS tab.
3 To enable message encryption through SSL, select Enable SSL.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 72

4 Set the following parameters:

For parameter... enter...


Port the port number used for JMS connections to the host server.
• 1099 is the default port to connect to the host in a standalone
configuration
• 1100 is the default port to connect to the host in a redundant
configuration
Client id the JMS Client user identification to set as required in the Alcatel-Lucent
5620 SAM documentation regarding Event monitoring using JMS.
A notification message is sent to each client that registers for statistics
every time an export file is created that is related to that client.
Default value is infovista_<hostname>@1
Topic the scope of the pushed xml files:
• 5620-SAM-topic-xml: to subscribe to all events, such as object
creation and deletion. This topic publishes all events with no
dependency on other topics.
• 5620-SAM-topic-xml-general: to subscribe to all events, such as
object creation and deletion. This topic contains objects that do not
fall into the fault, file or statistic topics.
• 5620-SAM-topic-xml-file: to subscribe to FindToFile events.

• 5620-SAM-topic-xml-fault: to subscribe to fault events.

• 5620-SAM-topic-xml-stats: to subscribe to events related to statistics


collection.
Maximum inactivity the period in minutes VistaLink waits for a JMS events before
(Minutes) considering that the connection with the SAM server is down and
attempting to restart it.
Time Out (Seconds) the period in seconds after which a JMS connection attempt stops.
Interval (Seconds) the period in seconds that separates each connection attempt with the
SAM server in case of connection failure.

5 To define the user for the JMS connection:

If you want to use... then...


the same user you defined for SAM-O select Use SAM-O user.
If you had entered an encrypted password for
the SAM-O user, enter the same password for
the JMS connection.
a user different from the one you defined for enter:
SAM-O • User: the JMS connection user login
• Password: the JMS Client password

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 73

For example:

6 If available, select the Backup SAM Server tab and repeat procedure from step 2 to set the
parameters for the backup SAM server.
7 Click Next.
At this time, VistaLink checks the configured connections then returns the check results. The
Test Panel window opens to indicate the status of the SAM-O, FTP and JMS primary and backup
servers, as applicable:

 In the case of a redundant connection, the status of the non active server is red:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 74

8 If a connection status test is red:


• Select the given test to display details on the connection status.
A message indicates the issue. For example:

• Click Close. An error message is displayed.


• Click OK.
• Correct the connection parameters in the relevant tab panel.
• Click Next to test the connections again.
9 When the test status is green for all the connections of the active server, click Close.
• If the case of a standalone connection the Configuration Wizard proceeds on to the Topology
Retrieval Rules panel.
• In the case of a redundant connection where the test returns red status for the backup server,
a message box appears and offers you to check the parameters or to proceed: click
Continue. The Configuration Wizard proceeds to the next panel.

Next step
See "Setting the topology retrieval rules parameters" on page 75.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 75

Setting the topology retrieval rules parameters


This panel enables you to define the method to retrieve SAP Queues, Network Queues, SDP
endpoints, OAM test probes, ACL filters, MPLS LSP filters, QoS ports and various types of
interface instances. You can choose, for given instance types to retrieve topology and statistics
data, only statistics or not to discover them at all.
Depending on the instance type, the changes made to the default settings are saved either under
<VistaLink Installation Directory>\sam\config\filters either under:
• the wizardFilters folder, in a specific filter xml file, or

• the soapRequestFilters folder, in the wizardDefinedTopoFilters.xml file.


To discover and provision given instances, use the Filters panel (see "Setting the filters" on
page 81).
To fine-tune the type of data to discover, and to provision to VistaMart, you may create specific
filters (see "Performing advanced filtering of the topology" on page 95).

About ACL filters


An ACL (Access Control List), also known as a filter policy, is a template applied to a service or
port to control ingress or egress network traffic based on MAC matching criteria. Filters are applied
to services to examine packets that enter or exit a SAP or network interface. An ACL filter policy
can be used on multiple interfaces. The same filter can apply to ingress and egress traffic.
The Alcatel-Lucent 5620 SAM-O XML interface uses the ACL filter package to configure the MAC
filters.
The ACL MAC filter controls network traffic into or out of an interface or circuit based on MAC
matching criteria.

Prerequisites
The Topology Retrieval Rule panel of the VistaLink configuration wizard is open.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 76

 Set topology retrieval rules


1 Set the following parameters:

For parameter... select...


SAM SAP Queues one of the following radio buttons to retrieve or not SAP queues (topology
data file only):
• All to retrieve all SAP queues

• Statistics Only to retrieve only SAP queues with statistics.

 The Statistics Only radio button is disabled in Local data


retrieval mode.
• None not to retrieve any SAP queues.
SAM Network one of the following radio buttons to retrieve network queues (topology
Queues data file only):
• All to retrieve all network queues

• Statistics Only to retrieve only network queues with statistics

 The Statistics Only radio button is disabled in Local data


retrieval mode.
• None not to retrieve any network queue
SAM SDP one of the following radio buttons to retrieve SDP endpoints (topology data
Endpoint file only):
• All to retrieve all SDP’s

• Statistics Only to retrieve only SDP’s with statistics

 The Statistics Only radio button is disabled in Local data


retrieval mode.
• None not to retrieve any SDP
OAM Tests the All checkbox, if you want to retrieve topology data on all OAM probe
instances
MPLS LSPs the All checkbox, if you want to retrieve topology data on MPLS LSP
instances
QoS Ports the All checkbox, if you want to retrieve topology data on QoS ports
ACL Filters the All checkbox, if you want to use ACL filter policy

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 77

For parameter... select...


Physical Ports • the Include Down Interfaces checkbox, if you want to discover and get
statistics on up and down interfaces, and/or
• the Include LinkUp Interfaces checkbox, if you want to discover and get
statistics on interfaces with status Up and LinkUp.
The ports concern the following interfaces:
• LAG LAN interfaces

• SAM interfaces

• WAN interfaces:
• MLPPP
• T1 Interface
• PortTerminationChannelInterface
• SonetChannelInterface
• DS0ChannelInstances
Channel the All checkbox, if you want to retrieve DSO channel groups, Port
Interfaces Termination Channel interfaces and Sonet channel interfaces
T1 Interfaces the All checkbox, if you want to retrieve T1 interfaces
Network Queue the All checkbox, if you want to retrieve Network Queue Groups
Groups

2 Click Next.
The Configuration Wizard proceeds to the Directories panel.

Next step
See "Setting the directories and data retention period" on page 78.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 78

Setting the directories and data retention period


VistaLink for Alcatel-Lucent 5620 SAM stores data in various directories depending on the type of
data and the data retrieval mode.
During the retrieval process, whether in local data retrieval mode or not, the VistaLink temporarily
stores inventory and statistics files retrieved from the SAM server in the sam\data directory.
Once VistaLink has finished processing the data from the data directory, it stores the data in the
sam\done directory.
Both data and done directories include at least the following directories:
• stat, for statistical data

• topo, for topology data.


topo and stat directories are empty when you install VistaLink. If you delete them, they are
automatically created after the first script execution.
You can define data and done directories other than the defaults. This is useful if your operation
generates substantial amounts of data and you need directories capable of handling large data
volumes.

Data directory
The data directory contains the statistics and topology files received from the SAM server. This
directory stores the results coming from the latest execution.

Done directory
The done directory contains the three following subdirectories:
• stat stores compressed XML files that contain the results of requests for the statistics data, in
subdirectories sorted by date and time.
• topo stores compressed XML files that contain the results of requests for the topology data, in
subdirectories sorted by date and time.
This done directory is used by InfoVista Support team because it is a backup of requests between
VistaLink and SAM. You must use the FindToFile or LogToFile data retrieval modes to store the
request results. You can decide the retention period for which you want to keep the XML files in
topo and stat using the Topology History (Days) and Statistical History (Days) from the
Directories panel of the VistaLink configuration wizard.
• wizard, stores for debugging purposes, the acquisition rates requested from the SAM server in
Find mode.

 For more information about the VistaLink directories, see "Checking directories and files"
on page 31

Prerequisites
The Directories panel of the VistaLink configuration wizard is open.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 79

 Set the directories


1 Set the following parameters:

For parameter... enter...


Processing Buffer the path to the data directory that contains the generated data files, or
click ... to browse to the directory.
Default path is <VistaLink Installation Directory>\sam\data
Done Directory the path to the archive directory, that is, the directory where the
processed data is stored, or click ... to browse to the directory.
Default path is <VistaLink Installation Directory>\sam\done
Topology History the number of days you wish to save archived topology data under
(Days) <VistaLink Installation Directory>\sam\done\topo
Statistical History the number of days you wish to save archived statistical data under
(Days) <VistaLink Installation Directory>\sam\done\stat
Topology Directory the path to the data directories that will store topology data in local data
retrieval mode only, or click ... to browse to the directory.
Stats Directory the path to the data directories that will store statistical data in local data
retrieval mode only, or click ... to browse to the directory.

For example:

2 Click Next.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 80

The Configuration Wizard proceeds to the Filters panel.

Next step
See "Setting the filters" on page 81.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 81

Setting the filters


Setting the filter parameters using the configuration wizard lets you define which particular
instances VistaLink will extract data for from the SAM server. For example, for routers, if you set
the option as Include Only and enter the router sim_81, VistaLink only retrieves the data related to
the router sim_81 and its interfaces.
The settings are saved either under <VistaLink Installation
Directory>\sam\config\filters\wizardFilters folder in a specific filter xml file.

Prerequisite
The Filters panel of the VistaLink configuration wizard is open.

 Set the filter parameters


1 In each Device, Service and Customer tab:

select either... to retrieve data from...


Include All all devices, services or
customers on the SAM server
Include From given instances specified in a Click ... to browse to and select the file.
File csv or text file
 Make sure that the instances to
filter are separated with a
comma or a new line in the csv
or text file.
Include Only given instances specified in the Type the instance names, using a
field comma or a new line as separator.

For example in the Service tab:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 82

2 If you want to apply the filter you defined for customers to routers, in the Customer tab, select
Apply customer filters to Routers.

 This option is active only if you selected Include Only for Customers and provided a
list of customers to monitor exclusively.
For example:

3 Click Next.
The Acquisition Rates Information dialog box opens to inform of the successful acquisition
rates retrieval or not.
4 Click OK.
5 If the Acquisition Rates Information dialog box indicated that acquisition rates are missing then
you need to import the VistaViews provided in your VistaLink Installation Directory (see
"Importing VistaView libraries" on page 25.)
6 Click Next.
The Configuration Wizard proceeds to the Statistics Retrieval panel.

Next step
See "Setting the statistics retrieval parameters" on page 83.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 83

Setting the statistics retrieval parameters


Using the Statistics retrieval panel of the Configuration Wizard, you configure the SAM data
acquisition rate to provision the VistaMart repository with data statistics according to your needs,
and the maximum data history duration as well as the auxiliary server possibly used in LogToFile
data retrieval mode. For a description of the data acquisition mechanism, see "Data acquisition
mechanism" on page 17.
By default, the acquisition rate set per vista is that defined on the SAM server. InfoVista
recommends you to set the data acquisition rate for a given vista at least equal to the acquisition
rate set at SAM server level. By default, the global variable that defines the display rate in
VistaMart is set to 15 minutes. You can modify the global variable value (see section "Changing the
default display rates for SAM data" on page 88), or set a specific acquisition rate per vista in
VistaMart using the following procedure.
When the LogToFile request method is set, the SAM server periodically generates a data file and
makes it available at a given location, possibly on an auxiliary server. In the case of an auxiliary
server, the SAM server sends a notification to the VistaLink to indicate the availability and IP
address of the auxiliary server. The following procedure enables you to declare as many auxiliary
servers as necessary and to configure, for each server, the FTP connection parameters.

Prerequisites
• The Statistics Retrieval panel of the VistaLink configuration wizard is open.

• You have imported the libraries into VistaMart (see "Importing VistaView libraries" on page 25)

 Set the statistics retrieval parameters


1 In the History (Minutes) field, enter the maximum time in minutes for which polled data is saved
(default value is 120).
This parameter is used to determine, based on the acquisition rate, how many points VistaLink
will poll the first time for each instance, and up to which timestamp in the past it will attempt to
recover data in case it has performed any data acquisition for several cycles.
See "Data acquisition mechanism" on page 17 for more details on this parameter.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 84

2 To include data flagged with the “suspect” attribute set to true, select the Accept Suspect Data
checkbox.

! At this stage, if a value is higher in the SAM Acquisition column than in the VistaMart
Insertion column for a given Vista and you click Next to move to next panel, a warning
message appears and the corresponding row is highlighted red. The message warns
you that with the chosen settings, VistaLink is actually inserting data into VistaMart
more often than it is acquiring it from the SAM server. You are recommended to set
each insertion rate to be equal to the corresponding acquisition rates before
continuing.
3 To modify an acquisition rate for a given instance type, select any cell on the corresponding row
and click Edit.
The Acquisition Rate Detail Panel opens.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 85

4 Select the appropriate acquisition rate from the VistaMart Insertion drop-down menu.

5 Click OK.

 The modified rows remain highlighted until you click Next.


6 If you are using the LogToFile mode to retrieve statistics from the auxiliary server the SAM
server sends the data to, click Add to set an auxiliary FTP server.
The Auxiliary Server FTP Settings dialog box opens.
7 In the Auxiliary Server FTP Settings dialog box, set the following parameters:

For parameter... enter...


Host the IP address or hostname of the machine hosting the auxiliary FTP
server to use to store statistics retrieved using LogToFile mode
User Name FTP user login name on this FTP auxiliary server
Password FTP user password on this FTP auxiliary server
Directory FTP directory path where the data files are stored on the auxiliary FTP
server

8 Click OK.
The dialog box closes.
9 Repeat steps 6 to 8 to add another auxiliary server, if needed.
10 To delete an auxiliary server, select the server and click Delete, then Yes.
11 Click Next.
The Configuration Wizard proceeds to the Memory panel.

Next step
See "Allocating memory space" on page 86.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 86

Allocating memory space


The configuration wizard enables you to adjust the memory allocated to:
• the statistics process

• the process which exports the topology from the SAM server
The memory VistaLink requires depends on the topology managed by the SAM Server. The more
instances you intend to monitor, the more you must increase the memory size.
The memory you set here does not take into account the following processes:
• The JMS service used to monitor the device availability and to collect accounting statistics.

• Temperature statistics generation (additional statistics).

• Topology provisioning, that is, importing the topology into VistaMart.

Prerequisite
The Memory panel of the VistaLink configuration wizard is open.

 Adjust the allocated memory


1 Enter the amount of memory you want to allocate to VistaLink by sliding the cursor along the
Memory bar.

2 Click Next.
The Finish panel opens. You can now finalize the configuration.

Next step
See "Finalizing the configuration" on page 87.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Using the Configuration Wizard 87

Finalizing the configuration


Any configuration you performed on any of the panels of the Configuration Wizard is not saved as
long as you have not validate it on the Finish panel.

Prerequisite
The Finish panel is open and prompts you to confirm the entire set of parameters.

 Finalize the configuration


1 Click Finish.
The actual configuration process starts. A File Write Information box appears to confirm the
completion of the configuration process.
2 Click OK.
3 On Unix, login as root and execute setprivs.sh script located in the <VistaLink Installation
Directory>/bin.
This script grants the users of the infovista group the necessary execute/write/read rights on the
directories and files set by the installer and configuration wizard.

Next steps
You can now perform the optional configuration tasks according to your needs:
• "Changing the default display rates for SAM data" on page 88

• "Enabling discovery of an instance type" on page 91

• "Configuring logs" on page 101

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Changing the default display rates for SAM data 88

Changing the default display rates for


SAM data
By default, the display rate set per Vista is the acquisition rate defined on the SAM server. You can
set a different display rate used by VistaLink to push data in VistaMart for each type of device
(vista) from the VistaLink Configuration Wizard (see "Setting the statistics retrieval parameters" on
page 83.)
If you want to push data with different display rates without starting the Configuration Wizard, you
may define other values directly from the VistaMart Inventory Manager, by means of Global
Variables specific to each Vista.
Following are the Vistas and associated display rate global variables available for each supported
default instance type:

Instance type Vistas VistaLink Minimum Rate Global Variables


Interface SAM Interface SAM.Interface VistaLink Minimum Rate
LAN Switch LAN Switch SAM.LAN Switch VistaLink Minimum Rate
MPLS Interface MPLS Interface SAM.MPLS Interface VistaLink Minimum Rate
MPLS LSP MPLS LSP SAM.MPLS LSP VistaLink Minimum Rate
Microwave Microwave SAM.Microwave VistaLink Minimum Rate
Network Queue SAM Network SAM.Network Queue VistaLink Minimum Rate
Queue
OAM OAM Tests SAM.OAM VistaLink Minimum Rate
Qos Port Queue QoS Port SAM.QoS Port VistaLink Minimum Rate
Router Router SAM.Router VistaLink Minimum Rate
SAP SAM SAP SAM.SAP VistaLink Minimum Rate
SAM SAP Queue SAM SAP Queue SAM.SAP Queue VistaLink Minimum Rate
Egress
SAM SAP Queue SAM.SAP Queue VistaLink Minimum Rate
Ingress

SDP SAM SDP Endpoint SAM.SDP VistaLink Minimum Rate


Service SAM Service SAM.Service VistaLink Minimum Rate
Component

! InfoVista strongly recommends you define display rates at least equal to the acquisition
rates set at SAM server level. By default, the global variables that define the display rates
for each Vista in VistaMart are all set to 15 minutes.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Changing the default display rates for SAM data 89

Prerequisites
• VistaLink is installed (see "Installing VistaLink" on page 28).

• You have imported the VistaView libraries into VistaMart (see "Importing VistaView libraries" on
page 25).
• You have successfully configured VistaLink using the Configuration Wizard (see "Using the
Configuration Wizard" on page 55).

 Change the default display rates for SAM data


1 Open the VistaMart Inventory Manager.
2 Browse to Model tab and expand the VistaMart Libraries > Infovista SAM VM.
3 Select Global Variables.
The list of global variables available for the various Vistas specific to VistaLink for Alcatel-
Lucent 5620 SAM appears on the right:

4 On the right panel, click the row that corresponds to the global variable you want to modify.
5 Enter the value according to your needs in the Value field on the bottom-right panel and press
Enter.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Changing the default display rates for SAM data 90

6 Click Global Variables on the left to refresh the displayed values.

7 Repeat steps 2 to 6 for each global variable you want to modify.


8 Close the Inventory Manager.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring discovery 91

Configuring discovery
By default, VistaLink discovers most types of instances. To enable or disable the discovery of given
instance types and instances, see the following sections:
 "Enabling discovery of an instance type" on page 91
 "Enabling discovery of filtered out instance types" on page 92
 "Disabling discovery of an instance type" on page 93
 "Disabling discovery of a specific instance type" on page 94
 "Configuring instance discovery" on page 94

Enabling discovery of an instance type


The following table guides you to the methods to use depending on the instance type you want
VistaLink to discover:

To enable the discovery of... see...


• SAM SAP Queues "Setting the topology retrieval rules
parameters" on page 75, which you perform
• SAM Network Queues from the Configuration Wizard
• SAM SDP Endpoints

• OAM Tests

• MPLS LSP’s

• QoS Ports

• ACL Filters

• Physical Ports

• Channel Interfaces

• T1 Interfaces

• AA Groups "Enabling discovery of filtered out instance


types" on page 92
• AA Partitions

• MS-ISA Cards

• IOM Cards

• CFM Maintenance Associations

• Ethernet Cards

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring discovery 92

To enable the discovery of... see...


other instance types "Customizing your instance discovery" on
page 124

Enabling discovery of filtered out instance types


By default, VistaLink does not discover the following instance types:
• AA Group

• AA Partition

• MS-ISA Card

• IOM Card

• CFM Maintenance Association

• Ethernet Card
To enable the discovery of one or several of these instance types, you need to deactivate the filter
applied to these instance types during SOAP requests to the SAM server. You do so by modifying
the wizardDefinedTopoFilters.xml file manually using the following procedure:

Prerequisites
• VistaLink is installed (see "Installing VistaLink" on page 28).

• You have successfully configured VistaLink using the Configuration Wizard (see "Using the
Configuration Wizard" on page 55).

 Enable discovery of filtered out instance types


1 Using your favorite xml editor, open the <VistaLink Installation
Directory>\sam\config\filters\soapRequestFilters\wizardDefinedTopoSoapFilters.xml file.
2 In the filteredOutInstances block remove the instance types that you wish to discover.

 Make sure to use commas to separate the instance types that you do not want to
discover.
Example To enable AA Partition and AA Group discovery, edit:

by removing AA Partition and AA Group:

3 Save and close the file.


4 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring discovery 93

Disabling discovery of an instance type


By default, VistaLink discovers all instance types for which a topology mapping file is available
either in the <VistaLink Installation Directory>\sam\ini\samTopoMapping or in the <VistaLink
Installation Directory>\sam\config\samTopoMapping folder, except for the following instance
types, which are filtered out by default:
• AA Group

• AA Partition

• MS-ISA Card

• IOM Card

• CFM Maintenance Association

• Ethernet Card
If you want to prevent the VistaLink from discovering a given instance type during the SOAP
requests to the SAM server, perform the appropriate procedures indicated in following table,
depending on the instance type:

To disable the discovery of... see...


• SAM SAP Queues "Setting the data retrieval mode" on page 62
to perform from the Configuration Wizard
• SAM Network Queues

• SAM SDP Endpoints

• OAM Tests

• MPLS LSP’s

• QoS Ports

• ACL Filters

• Physical Ports

• Channel Interfaces

• T1 Interfaces
other instance types "Disabling discovery of a specific instance
type" on page 94

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring discovery 94

Disabling discovery of a specific instance type


In the case you want to disable the discovery of instance types that you cannot manage from the
Configuration Wizard, you need to filter them out from the SOAP request using the
wizardDefinedTopoFilters.xml file.
For example, among the WAN interfaces, you may want to avoid discovering one of the following
WAN interface types:
• MLPPP

• PortTerminationChannelInterface

• SonetChannelInterface

• DS0ChannelInstances
You can do so using the following procedure by adding the interface type name to the
wizardDefinedTopoFilters.xml file.

Prerequisites
• VistaLink is installed (see "Installing VistaLink" on page 28).

• You have successfully configured VistaLink using the Configuration Wizard (see "Using the
Configuration Wizard" on page 55).

 Disable discovery of a specific instance type


1 Using your favorite xml editor, open the <VistaLink Installation
Directory>\sam\config\filters\soapRequestFilters\wizardDefinedTopoFilters.xml file.
2 In the filteredOutInstances block add the instance types that you do not wish to discover.

 Make sure to use commas to separate the instance types that you do not want to
discover.
3 Save and close the file.
4 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).

Configuring instance discovery


You can also fine-tune the discovery of your topology by applying filters at instance level.
The following table guides you to the methods to use depending on the data you want to provision
into VistaMart for given instances:

To discover ... see...


given device, customer or service instances "Setting the filters" on page 81
given vistas based on fine criteria "Performing advanced filtering of the
topology" on page 95

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 95

Performing advanced filtering of the


topology
The Configuration Wizard already enables you to perform filtering based on some instance types
(see "Setting the topology retrieval rules parameters" on page 75) and on given instances (see
"Setting the filters" on page 81)
To filter your topology based on finer criteria such as properties and set of instances for a given
vista, you can create your own xml filter files. Using these filter files, VistaLink parses the
discovered instances for any conditions that you set for a given vista and provisions VistaMart with
only the required data.
You can apply filters to any Vista managed by VistaLink by creating one or several xml filter files
per Vista.
Once you have selected the Vista on which you want to apply your filter, you can then filter
according to property, tag or name.
This section provides the following topics:
• "Filter file structure and elements" on page 95

• "Creating a filter" on page 100

Filter file structure and elements


This section describes the blocks, elements and attributes that you are allowed to use to create
your filter files.
The high level filter XML file structure contains the following blocks:

vista block
The vista block defines the vista to which the filter applies. It occurs only once in the file. The
conditions element may embed several conditions elements.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 96

conditions block
The conditions block requires the following attribute:

Attribute... defines... Mandatory/


Optional
type the filtering condition operators which Mandatory
can take either one of the following
values:
• and

• And

• or

• Or

• not

• Not

The conditions block may include the following elements:

Element... defines... Mandatory/ Number of


Optional occurrences for
a given
conditions
element
conditions the filtering criteria. Mandatory Multiple
It uses attribute type which can take
either one of the following values:
• and

• And

• or

• Or

• not

• Not

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 97

Element... defines... Mandatory/ Number of


Optional occurrences for
a given
conditions
element
matches a matching regular expression. Optional Multiple
It contains the value element and either
one of the following elements:
• property

• tag

• name

• fileValue (CSV files only)


equals a condition equal to the required value. Optional Multiple
It contains the value element and either
one of the following elements:
• property

• tag

• name

• fileValue (CSV files only)


in a condition available in a list. Optional Multiple
It contains the value element and either
one of the following elements:
• property
• tag

• name

• fileValue (CSV files only)

fileValue element
Use the fileValue element to filter instances and data based on a CSV file. The fileValue
element may include the following elements:

Element... defines... Mandatory/ Number of


Optional occurrences for
a given
conditions
element
fileName the full path to the CSV file. Mandatory Multiple

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 98

Element... defines... Mandatory/ Number of


Optional occurrences for
a given
conditions
element
separator what type of separator to consider in the Mandatory Multiple
CSV file.
value the column in the CSV file where the Mandatory Multiple
condition is to be found.
It contains the following element:
• column, which specifies the column
number (0 value corresponds to the
first column of the file)

Examples
• The following filter enables you to provision only the SAM SAP Queue Ingress instances whose
Customer ID property is CUST1:

• The following filter enables you to provision only the Router instances whose tags are either
equal to 3145836 or to 3145737.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 99

• The following filter enables you to provision only the SAM SAP instances with property values:
• instanceType equal to SAP
• hasSapQueue different from false

• The following filter specifies that you want to provision only instances which are in the
myFilterFile.csv file based on the value in column 1 (second column).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Performing advanced filtering of the topology 100

Creating a filter
If you want to provision VistaMart with only a set of instances that conform to set criteria, you need
to create a filter for each concerned instance type and set of instances.

 Create a filter
1 In <VistaLink Installation Directory>\sam\config\filters, create an xml file using your
favorite xml editor.

 You can name the file as you feel appropriate based on the filter criteria.
2 In the file, create a Filter block.
3 In the Filter block, create a vista element.
4 In the vista element, enter the name of the concerned vista as named in VistaMart.
5 In the Filter block, create a conditions elements with attributes and elements according to
your needs (see "Filter file structure and elements" on page 95).
6 Save and close the file.

 Keep all customized filters in the config\filters folder, as subsequent VistaLink


upgrades automatically overwrite the filters in ini\filters.
7 If running on Unix relaunch script bin/setprivs.sh.
8 Restart VistaLink (see "Managing the VistaLink service" on page 102).

 Modify existing filters


1 For a given instance type or vista, if a filter xml file already exists copy it from
<VistaLink Installation Directory>\sam\ini\filters
to
<VistaLink Installation Directory>\sam\config\filters
2 In the config\filters folder open the filter xml file with your favorite xml editor and set your
filter according to your needs (see "Filter file structure and elements" on page 95).
3 Save and close the file.

 Keep all customized filters in the config\filters folder, as subsequent VistaLink


upgrades automatically overwrite the filters in ini\filters.
4 On Unix, relaunch script bin/setprivs.sh.
5 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring logs 101

Configuring logs
Log files are saved to the VistaLink Installation Directory in the log directory.
The following sections provide configuration tips that apply to VistaLink log files.

Prerequisite
VistaLink is installed (see "Installing VistaLink" on page 28).

Setting log level


The VistaLink log application provides the five following increasingly detailed log levels:
1 Fatal
2 Error
3 Warn
4 Info
5 Debug
For example, if you want to log all events from Debug to Fatal, you set the log level to Debug. If you
want to log only Fatal events, set the log level to Fatal. InfoVista recommends setting the log level
to Warn in order to log Fatal, Error and Warning events.
To set the logger level for the application, locate the log4j.properties file under the <VistaLink
Installation Directory>\config directory and edit the level for log4j.rootLogger.
Example log4j.rootLogger=WARN, C

Setting log file roll-up rules


To set log file roll-up rules, locate the log4j.properties file under the <VistaLink Installation
Directory>\config directory and edit the following parameters:
• log4j.appender.C.MaxBackupIndex=10
to update the maximum number of log files in the log directory
• log4j.appender.C.MaxFileSize=2000KB
to update the maximum log file size. Above this size, a new log file is created.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing the VistaLink service 102

Managing the VistaLink service


After completion of the Configuration Wizard, when you click the Finish button, the InfoVista
VistaLink for SAM service is launched automatically. You can check the service status, and, if
necessary, manually start or stop this service.
You can manage the VistaLink for SAM service either remotely from the VistaCockpit Management
Console (see "Monitoring VistaLink with VistaCockpit" on page 195) or using the following
procedures from the VistaLink platform.

Managing the service in Windows environment


To check the service status on Windows, and/or manually start or stop this service, use the
Windows Services manager.

Managing the service in Unix environment


On Unix, you can check the service status, and, if necessary, manually start or stop this service
using the following procedures:

 Check the service status


1 Open a Unix Terminal.
2 Run command:
/etc/init.d/SamVistaLink status

 Stop the service


1 Open a a Unix Terminal.
2 Run command:
/etc/init.d/SamVistaLink stop
The service stops.

 Start the service


1 Open a a Unix Terminal.
2 Run command:
/etc/init.d/SamVistaLink start
The service starts.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Understanding zones 103

Understanding zones
VistaLink provisions the topology it discovers into VistaMart into a specific repository organized in
zones within a zone set.
Once VistaLink for Alcatel-Lucent 5620 SAM starts provisioning VistaMart, it automatically creates
the zone set and the zones in VistaMart. Following are the default names of the zones:
• SAM_GROUPS

• SAM_DEVICES

• SAM_PERFORMANCE

• SAM_ACCOUNTING
This section describes the zone creation process, the zone naming and how to modify the
threshold that constrains the number of instances that VistaLink can provision into the zones
dedicated to proxies.
 "Zone creation process" on page 103
 "Multiple proxy zones" on page 105

Zone creation process


The first time VistaLink runs, it polls the SAM server and analyzes the topology results. In this
process, it automatically creates multiple zones for the server connection you have set up using
the Configuration Wizard procedure (see "Setting the VistaMart parameters" on page 58).
It first creates a zone for all the groups it has discovered (of type Groups), then a zone for the
basics (of type Devices) and finally zones for their proxies depending on basic device type
(Performance and Accounting):

VistaLink uses zone of to provision VistaMart...


type...
Groups with group instances:
• services

• customers
Devices with basics:
• Microwave devices

• LAN switches

• routers

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Understanding zones 104

VistaLink uses zone of to provision VistaMart...


type...
Performance with the following proxies:
• T1 Interface • IOM Card

• SonetChannelInterface • Interface

• SAM SDP Endpoint • Ethernet Card

• QoS Port • DS0ChannelInstances

• PortTerminationChannelInterf • CFM Maintenance


ace Association
• NetworkQueueGroup • AA Partition

• MS-ISA Card • AA Group

• MPLS LSP • ACL Filter Policy

• MLPPP • SAM SAP

• LAG
Accounting with the following proxies:
• OAM probes • Sub MPLS LSP (MPLS LSP
Ingress)
• SAM SAP queues
• Sub SDP.
• SAM Network queues

All the proxies of a given basic are provisioned into the same zone. The size of the zones
dedicated to proxies is constrained by a configurable threshold (sam.vm.zone.split.threshold)
applied to the number of proxy instances to be provisioned. Once the threshold is crossed,
VistaLinks creates a new Performance type or Accounting type zone, depending on discovered
proxy type, with suffix -2. Each time the threshold is crossed a new zone is created and the suffix
is incremented by 1.
Following is an example of zones with customized names that VistaLink created in the VistaMart
Inventory Manager as a result of topology discovery and update:

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Understanding zones 105

Multiple proxy zones


Once the Device type zone is created, the Performance and Accounting type zones are
automatically created and provisioned with the proxies of the discovered basics, depending on
their type. VistaLink provisions them with proxies up to a limited number of instances. A new zone
is automatically created each time a new basic is discovered and the total number of proxy
instances provisioned in the previously created proxy zone has crossed the
sam.vm.zone.split.threshold threshold (default = 100 000 instances). The size of the zone is
flexible because all the proxies of a given basic instances have to be grouped together in the same
zone. To modify the threshold value, see "Configuring the sizing of proxy zones" on page 106.
Example
VistaLink discovers basic1, basic2, basic3 and basic4 and their proxies. It then provisions the
SAM_DEVICES zone in sequential order with basic1, basic2, basic3 and basic4.
In parallel, it provisions SAM_PERFORMANCE with the proxies in sequential order as follows:
1 30 000 proxies for basic1
2 30 000 proxies for basic2
3 30 000 proxies for basic3
4 20 000 proxies for basic4
Just before basic4 is provisioned into VistaMart, the number of instances in the
SAM_PERFORMANCE zone sums up to 90 000 proxies, that is, below the 100 000 threshold
value. Therefore, the basic4 proxies can be provisioned to the same zone even if provisioning
basic4 proxies adds 20 000 to the SAM_PERFORMANCE zone which ends up including 110 000
instances. However, the proxies of the next discovered basic that would need to be provisioned to
a type SAM_PERFORMANCE zone will be provisioned to a new zone named
SAM_PERFORMANCE-2.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Configuring the sizing of proxy zones 106

Configuring the sizing of proxy zones


If you need to modify the capacity of the zones dedicated to proxies, you need to modify the
threshold that constrains the number of instances that VistaLink can provision into the
Performance and Accounting type zones using the following procedure:

 Configure sizing of proxy zones


1 Using your favorite text editor, open the <VistaLink Installation Directory>\config\SAM-
Pollers.properties file.
2 Replace the value assigned to sam.vm.zone.split.threshold parameter with the new one.
3 Save and close the file.
4 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).
5 Once VistaLink has started obtaining data from the SAM server, verify from the VistaMart
Inventory Manager that it has created zones in VistaMart (to view zones, see the VistaMart User
Guide).

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 107

Managing VistaMart modules


Each page package works in conjunction with a specific set of VistaMart modules which must be
activated for their related indicators to start. This section lists the default modules, the ones
required to start specific optional indicators. It also describes how to start and stop volume
indicators.
 "Required modules" on page 107
 "Optional modules" on page 108
 "Starting volume indicators" on page 110
 "Stopping volume indicators" on page 111

Required modules
The following SAM specific modules and all their related indicators are started by default:
Module
• SAM Basic

• SAM Capacity Planning

• SAM Customization

• SAM Distribution

• SAM Exception Capacity Planning Event

• SAM Exception Service Level Event

• SAM Exception TCA Event

• SAM SAP

• SAM SAP Capacity Planning

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 108

Optional modules
To start indicators on volume type data, you need to start the following modules which are not
started by default:

Modules Related indicators


SAM MPLS LSP Alcatel - sam - Lsp Traffic Egress IN (Bytes Volume)
Analysis
Alcatel - sam - Lsp Traffic Egress OUT (Bytes Volume)
Alcatel - sam - Lsp Traffic Ingress IN (Bytes Volume)
Alcatel - sam - Lsp Traffic Ingress OUT (Bytes Volume)
SAM Network Queue Alcatel - sam - NetQueueEgrForwardedHighProfOctets (Bytes Volume)
Analysis
Alcatel - sam - NetQueueEgrDroppedHighProfOctets (Bytes Volume)
Alcatel - sam - NetQueueEgrForwardedLowProfOctets (Bytes Volume)
Alcatel - sam - NetQueueEgrDroppedLowProfOctets (Bytes Volume)
Alcatel - sam - NetQueueIngForwardedHighProfOctets (Bytes Volume)
Alcatel - sam - NetQueueIngDroppedHighProfOctets (Bytes Volume)
Alcatel - sam - NetQueueIngForwardedLowProfOctets (Bytes Volume)
Alcatel - sam - NetQueueIngDroppedLowProfOctets (Bytes Volume)
Alcatel - sam - NetQueueGpEgressForwardedHighProfOctets (Bytes
Volume)
Alcatel - sam - NetQueueGpEgressDroppedHighProfOctets (Bytes
Volume)
Alcatel - sam - NetQueueGpEgressForwardedLowProfOctets (Bytes
Volume)
Alcatel - sam - NetQueueGpEgressDroppedLowProfOctets (Bytes
Volume)

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 109

Modules Related indicators


SAM Interface Alcatel - sam - Broadcast Packets IN (/s)
Analysis
Alcatel - sam - Broadcast Packets OUT (/s)
Alcatel - sam - Multicast Packets IN (/s)
Alcatel - sam - Multicast Packets OUT (/s)
Alcatel - sam - NUnicast Packets IN
Alcatel - sam - NUnicast Packets IN (/s)
Alcatel - sam - NUnicast Packets OUT
Alcatel - sam - NUnicast Packets OUT (/s)
Alcatel - sam - Unicast Packets IN (/s)
Alcatel - sam - Unicast Packets OUT (/s)
Interface - OctetsIN
Interface - OctetsOUT
Interface - BroadcastPacketsIN
Interface - BroadcastPacketsOUT
Interface - DiscardedPackets IN (/s)
Interface - DiscardedPackets OUT (/s)
Interface - MulticastPacketsIN
Interface - MulticastPacketsOUT
Interface - PacketsDiscardedIN
Interface - PacketsDiscardedOUT
Interface - UnicastPacketsIN
Interface - UnicastPacketsOUT
SAM SAP Queue Alcatel - sam - QueueIngOfferedLoPrio (Bytes Volume)
Analysis
Alcatel - sam - QueueIngDroppedLoPrio (Bytes Volume)
Alcatel - sam - QueueIngForwardedHiPrio (Bytes Volume)
Alcatel - sam - QueueIngOfferedHiPrio (Bytes Volume)
Alcatel - sam - QueueIngOfferedTotal (Bytes Volume)
Alcatel - sam - QueueIngForwardedLoPrio (Bytes Volume)
Alcatel - sam - QueueIngDroppedHiPrio (Bytes Volume)
Alcatel - sam - QueueEgrDroppedLoPrio (Bytes Volume)
Alcatel - sam - QueueEgrForwardedHiPrio (Bytes Volume)
Alcatel - sam - QueueEgrForwardedLoPrio (Bytes Volume)
Alcatel - sam - QueueEgrDroppedHiPrio (Bytes Volume)

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 110

Starting volume indicators


Volume indicators are not started by default. If you want to obtain volume data on instances you
need to start the following specific VistaMart modules depending on the statistics you need:

To start volume indicators on... start module...


Network Queues SAM Network Queue Analysis Activation
Module
SAP Queues SAM SAP Queue Analysis Activation Module
Interfaces SAM Interface Analysis Activation Module
MPLS LSP’s SAM MPLS LSP Analysis Activation Module

 Start volume indicators


1 From the VistaMart Inventory Manager, select the Model tab.
2 Expand the VistaMart Libraries > InfoVista SAM VM > Modules node.
3 Select the module that corresponds to the volume indicators you want to start.
4 On the right panel, select the User Scope field.
5 Click the drop-down arrow, select Global and press Enter.
For example:

6 Repeat procedure from step 3 for all the modules you want to start.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 111

7 Apply rules:
• From the Provisioning menu, select Test & Apply Rules.
• In the right-hand panel, select the zone where you want to apply the rules.

• Click the Apply Rules icon at the top right of the panel.
• Click yes in the Apply Rules dialog box.
• In the VistaMart provisioning window, once the process is successfully completed, click
Close.
8 Exit the VistaMart Inventory Manager.

Stopping volume indicators


If you need to stop volume indicators for sizing purposes you need to stop specific VistaMart
modules using the following procedure:

 Stop volume indicators


1 From the VistaMart Inventory Manager, select the Model tab.
2 Expand the VistaMart Libraries > InfoVista SAM VM > Modules node.
3 Select the module that corresponds to the indicators you want to stop.
4 On the right panel, select the User Scope field.
5 Click the drop-down arrow, select Rules and press Enter.

6 Repeat procedure from step 3 for all the modules you want to stop.
7 Apply rules:
• From the Provisioning menu, select Test & Apply Rules.
• In the right-hand panel, select the zone where you want to apply the rules.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Managing VistaMart modules 112

• Click the Apply Rules icon at the top right of the panel.
• Click yes in the Apply Rules dialog box.
• In the VistaMart provisioning window, once the process is successfully completed, click
Close.
8 Exit the VistaMart Inventory Manager.

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Backing up and restoring the VistaLink configuration 113

Backing up and restoring the VistaLink


configuration
InfoVista strongly recommends that you back up your configuration files in case you need to
upgrade, reinstall the VistaLink and/or restore its configuration.

Backing up the VistaLink configuration


To back up the VistaLink configuration, save the content of the following folders to a safe location:
• <VistaLink Installation Directory>\config

• <VistaLink Installation Directory>\sam without the done and ini folders.

Restoring the VistaLink configuration


To restore a VistaLink configuration, copy the backed up files back to their respective location
under:
• <VistaLink Installation Directory>\config

• <VistaLink Installation Directory>\sam

Installation and Configuration Guide - Chapter 3 Configuring VistaLink for Alcatel-Lucent 5620 SAM
4 Customizing your
VistaLink for Alcatel-Lucent
5620 SAM

This chapter explains how to customize your VistaLink to be able to:


• modify the type of data to retrieve from the instances

• discover and retrieve data from new instance types

• create your own indicators

• filter discovered instance types.

 "Customizing your solution: main steps" on page 115


 "Customization use cases" on page 117
 "Customizing your instance discovery" on page 124
 "Defining the statistics classes" on page 147
 "Creating an indicator" on page 162
 "VistaLink formula Syntax" on page 174

114
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your solution: main steps 115

Customizing your solution: main steps


The VistaLink for Alcatel-Lucent 5620 SAM performance solution comes with a model and
configuration files that enable discovering a set of typical instance types, with given properties to
retrieve data from given statistics Classes.
However, you may want to either discover new instance types or modify the way available instance
types are discovered. You may also want to modify the types of statistics that are retrieved from the
instances.

Case 1: you want to retrieve data from a new instance type


If you need to retrieve data from an instance type that is not provided in the InfoVista solution,
observe the following workflow:
1 Possibly modify the solution model:

If... then...
the VistaLink solution model does not provide create the Vista (see the VistaMart User
the Vista that corresponds to your new Guide).
instance type
the appropriate Vista exists but you want to be add the missing properties to the existing
able to retrieve properties not available in the Vista (see the VistaMart User Guide).
Vista

2 Create the topology mapping file for the new instance type (see "Creating a topology mapping
file" on page 142)
3 Define the statistics class for the new instance type (see "Creating a protocol template" on
page 160)
4 If necessary, create indicators (see "Creating an indicator" on page 162).

! Be sure to keep track of instance types you add, as you are solely responsible for managing
customized protocol template xml files.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your solution: main steps 116

Case 2: you want to modify the data to retrieve from an


existing instance type
If you need to modify the type of data to retrieve from an instance type available in the InfoVista
solution, observe the following workflow:
1 If needed, add the missing properties to the existing Vista (see the VistaMart User Guide).
2 If you want to discover additional properties or remove some for the given instance type, modify
the associated topology mapping file (see "Modifying a topology mapping file" on page 143)
3 If you want to define a new statistics class for the instance type (see "Modifying a protocol
template" on page 161)
4 If necessary, create additional indicators (see "Creating an indicator" on page 162).

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 117

Customization use cases


This section describes how to handle the following use cases:
 "Enabling data retrieval for a new OAM probe" on page 117
 "Enabling specific data retrieval on a optical port" on page 122

Enabling data retrieval for a new OAM probe


By default, VistaLink for Alcatel-Lucent 5620 SAM does not support the
ethernetoam.CfmTwoWaySlm topology and the ethernetoam.CfmTwoWaySlmResult statistics
classes.
This use case describes what to do if you want to be able to discover and retrieve data from a
Layer 2 OAM probe to which the ethernetoam.CfmTwoWaySlm and
ethernetoam.CfmTwoWaySlmResult classes apply.
For this use case you do not need to modify the solution model and create a new vista. The new
probe can benefit from the indicators, properties and rules of the OAM Layer 2 Vista. You need first
to create a new topology mapping file based on an existing OAM Layer 2 default topology mapping
file and to customize the OAMS default protocol template.

Prerequisites
• You have installed the VistaLink (see "Installing VistaLink for Alcatel-Lucent 5620 SAM" on
page 20).
• You have a good understanding of the structure and content of the topology mapping files (see
"Topology mapping file structure" on page 126 and "Topology mapping file elements and
attributes" on page 127).
• You have analyzed the content of the default topology mapping files available for the various
OAM probes in <VistaLink Installation Directory>\sam\ini\samTopoMappings.
• You have used your Alcatel-Lucent 5620 SAM API to identify the discovery classes and
properties available for the new OAM probe.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 118

 Create the specific topology mapping file


1 In <VistaLink Installation Directory>\sam\ini\samTopoMappings, among the OAM probe
topology mapping files, identify those that are OAM Layer 2:
• OAM_MAC_330.xml
• OAM_MEFMAC_340.xml

 For this use case, you can base the new topology mapping file on either one of these
two files. This example, uses OAM_MAC_330.xml.
2 Duplicate the OAM_MAC_330.xml topology mapping file to the <VistaLink Installation
Directory>\sam\config\samTopoMappings folder.
3 Rename the duplicated file appropriately, using syntax instanceType_integer.xml (see
"Topology mapping file name" on page 125).
Example: OAM_CFM_TWO_WAY_SML_335.xml
4 Open the file using your favorite xml editor.
5 Modify elements as follows:

In element... change... to...


instance info OAM MAC OAM CFM TWO WAY SLM
discoveryClasses > service.MacPing ethernetoam.CfmTwoWaySlm
discoveryClass > className
instanceProperties > OAM MAC OAM CFM TWO WAY SLM
properties > localProperty

6 Remove elements as follows:

From element... remove...


discoveryClasses > specificProperties all the properties element except the reference
element that defines a correlationAttribute
for routers.
discoveryClasses the hardcodedDiscoveryClass element.
instanceProperties > properties fixed value element for Capabilities property
with MacPing value

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 119

7 Add the following properties elements that define the instance name and the instance tag to the
instanceProperties element:

8 To enable retrieval of the Alcatel-Lucent mepTargetMacAddr attribute value, map this attribute to
either existing VistaMart properties or to properties you have specifically created in VistaMart (to
create properties, see the VistaMart User Guide). You do so by adding simpleAssignment
property elements to the existing properties element.
Example

where VistaMart properties targetMacAddress and Location are already part of the InfoVista
Model.
9 To associate a specific protocol value with the OAM CFM Two Way Slm instance type, add a
fixedValue property element (for example, TwoWay) to the existing properties element.

where VistaMart property Protocol is already part of the InfoVista Model.


Following is the resulting file:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 120

10 Save and close the file.


11 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
12 Restart VistaLink (see "Managing the VistaLink service" on page 102).
The VistaLink can now discover the instances of this new OAM Layer 2 probe. To retrieve statistics
you need to modify the OAMS.xml protocol template:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 121

 Customize the OAMS protocol template


1 In <VistaLink Installation Directory>\sam\ini\protocolTemplates, duplicate the OAMS.xml
file to the <VistaLink Installation Directory>\sam\config\protocolTemplates folder.
2 Open the file using your favorite xml editor.
3 In the polledClases element of the tableInfoList block, add a new statClass element
including a calculatedColumn and javaScript elements with:
• attribute name = “ethernetoam.CfmTwoWaySlmResult”
• element javaScript defines the instance tag as defined in the corresponding topology
mapping file, with Id being replaced by testId.

4 Save and close the file.


5 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
6 Restart VistaLink (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 122

Enabling specific data retrieval on a optical port


This use case describes what to do if you want to be able to discover and retrieve energy and
power levels from an optical port. This data is provided by the following two Alcatel-Lucent
attributes:
• tmnxDDMTxOutputPower, which monitors the energy and power level of the optical port on the
transmission side
• tmnxDDMRxOpticalPower, which monitors the energy and power level of the optical port on the
reception side.
Basically an optical port acts as a proxy of a physical port which is a proxy of a router, a LAN
switch or a Microwave device. A port is discovered as an interface. To retrieve data specific to an
optical port you need to add, to the default interface_140.xml topology mapping file, specific
properties that belong to the equipment.DigitalDiagnosticMonitoring topology class.
The equipment.DigitalDiagnosticMonitoring topology class is a child class of the
equipment.PhysicalPort class which is one of the discovered classes for interfaces. By default,
VistaLink for Alcatel-Lucent 5620 SAM does not support the
equipment.DigitalDiagnosticMonitoring topology class. Therefore you need to declare this
class as a child class to the equipment.PhysicalPort class as a reference property in the
interface_140.xml topology mapping file.
For this use case you do not need to modify any protocol template. However you need to create
new properties in VistaMart and modify the interface_140.xml topology mapping file.

Prerequisites
• You have installed the VistaLink (see "Installing VistaLink for Alcatel-Lucent 5620 SAM" on
page 20).
• You have a good understanding of the structure and content of the topology mapping files (see
"Topology mapping file structure" on page 126 and "Topology mapping file elements and
attributes" on page 127).
• You have analyzed the content of the default interface_140.xml topology mapping files
available in <VistaLink Installation Directory>\sam\ini\samTopoMappings.
• You have used your Alcatel-Lucent 5620 SAM API to identify the discovery classes and
properties available related to optical ports.
• You have created two new properties in VistaMart in the LAN Interface vista (see the VistaMart
User Guide) that correspond to the tmnxDDMTxOutputPower and tmnxDDMRxOpticalPower Alcatel-
Lucent properties. Note their respective WID values. This use case uses the following
correspondences:

Alcatel-Lucent attribute VistaMart properties


tmnxDDMTxOutputPower Optical Port Power Out
tmnxDDMRxOpticalPower Optical Port Power In

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customization use cases 123

 Modify the topology mapping file


1 Duplicate the interface_140.xml topology mapping file from <VistaLink Installation
Directory>\sam\ini\samTopoMappings to the <VistaLink Installation
Directory>\sam\config\samTopoMappings.
2 Open the file using your favorite xml editor.
3 Delete the existing properties elements from the specificProperties block associated with
each declared class and from the instanceProperties block.
4 Add a child reference to the equipment.DigitalDiagnosticMonitoring class:
• In the discoveryClasses block, in the discoveryClass element of the
equipment.PhysicalPort class, in the specificProperties block, add a properties element.
• In the properties element, add a reference property with referenceType set to ChildClass
and className set to equipment.DigitalDiagnosticMonitoring.

5 Define the new properties:


• In the specificProperties block of the equipment.PhysicalPort discoveryClass element, add
a properties element with two simpleAssignment sub-elements.
• In each simpleAssignment sub-element, declare the correspondence between the Alcatel-
Lucent attributes and the VistaMart properties:

6 Save and close the file.


7 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
8 Restart VistaLink (see "Managing the VistaLink service" on page 102).

 For this use case you do not need to modify or create any protocol template.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 124

Customizing your instance discovery


VistaLink connects to the Alcatel-Lucent 5620 SAM server using topology mapping XML files.
VistaLink then uses these files to identify what type of topology information to retrieve from the
SAM server on a given instance type. Based on these files, the SAM server returns topology files
to the VistaLink which forwards them to the VistaMart Application Services to provision VistaMart
with the topology.
Your InfoVista solution comes with a set of default topology mapping files for a choice of instance
types. You can use those files as such or modify them if needed. If you want to discover a new
instance type, you first need to create its corresponding topology mapping file.

! Be aware that a VistaLink upgrade deletes the topology mapping files stored in the ini
folder but saves those stored in the config folder. If you edit sample discovery files,
InfoVista recommends that you place your customized files in the <VistaLink Installation
Directory>\sam\config\samTopoMappings folder.
This section describes the topology mapping file name, structure and content, as well as how to
create or modify a topology mapping file:
• "Topology mapping file name" on page 125

• "Topology mapping file structure" on page 126

• "Topology mapping file elements and attributes" on page 127

• "Enabling the discovery of an instance" on page 142

• "Creating a topology mapping file" on page 142

• "Modifying a topology mapping file" on page 143

• "Customizing discovery of SAP instances" on page 146

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 125

Topology mapping file name


The topology mapping filenames should be structured as InstanceType_integer.xml.
Examples
• Microwave_30.xml

• Router_40.xml
The numeric suffix defines the order in which VistaLink will process the files in the discovery
folder.
Example
A router must be processed before its proxies, because logically its cards and interfaces can exist
only after the router has been set up. It also must be discovered before the subnet it belongs to.
In such a case, the respective xml files would appear in the discovery folder in the following order:
• Router_40.xml

• MPLSInterface_50.xml

• Ethernet_Card_80.xml

• Interface_140.xml
By naming your initial files with multiple of 10 integers you will be later able to add new topology
mapping files using intermediate integers.
Example MyNewMicrowave_35.xml

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 126

Topology mapping file structure


The high level structure of a topology mapping file is:

Example Following is a partially collapsed view of the default Microwave topology mapping file
delivered with the VistaLink for Alcatel-Lucent 5620 SAM.

InfoVista recommends using only one instance block per topology mapping file. The block
elements and how you edit them are described in detail in the following sections.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 127

Topology mapping file elements and attributes


You edit specific elements in a topology mapping file to define what information VistaLink needs to
retrieve for each instance of a given instance type, and how to handle the discovered instance
once it is discovered.
When you edit the topology mapping file you:
• specify the instance type you want to describe

• define the instances as proxy or basic resources

• specify the zone in which to provision the discovered instances

• specify the discovery classe(s) for the instance type

• set specific properties to be retrieved for the instance

• specify which Vista(s) the discovered resource will be related to.


This section describes in detail the tags you can edit.
The following sections describe only the elements and attributes you can use when customizing
the topology mapping files.

instanceInfo element
The instanceInfo element specifies the instance to be discovered. It is a mandatory element and
can be used only once in the file. It contains the name of the instance which can be user defined.
Its attributes provide the instanceType parameter value and indicate whether the instance is a
proxy or a basic.

Attribute... defines... Mandatory/


Optional
isProxy as a false/true boolean attribute, whether Mandatory
or not the instance is a proxy or a basic.
• true: the instance is a proxy

• false: the instance is a basic


statInstanceType the instance type parameter value used Mandatory
for both statistics and topology data

Examples
• <instanceInfo isProxy=”false” statInstanceType=”Microwave”>Microwave</instanceInfo>

• <instanceInfo isProxy=”false” statInstanceType=”Interface”>T1 Interface</


instanceInfo>

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 128

provisioningZone element
The provisioningZone element defines whether or not the instance is to be provisioned into
VistaMart, and in which VistaMart zone it should be provisioned. This element can have only the
following values:

Use element value... for...


SAM_DEVICES provisioning the monitored devices (routers, Microwave and LAN
switches)
SAM_PERFORMANCE provisioning the monitored proxy instances such as interfaces,
cards, LAGs, SAM SAPs, etc.)
SAM_ACCOUNTING provisioning the monitored proxy instances such as OAM probes,
SAP and network queues, etc.)
SAM_GROUPS provisioning group instances, such as customer and service
instances
N/A preventing the instance from being provisioned into VistaMart

Examples
• <provisioningZone>SAM_PERFORMANCE</provisioningZone>

• <provisioningZone>N/A</provisioningZone>

discoveryClasses block
The discoveryClasses block lists and specifies, in separate discoveryClass elements, all the
topology classes that are required for the instance to be discovered.
At least one discoveryClass element is mandatory in the discoveryClasses block.
In the default templates, the discoveryClasses block can also contain hardCodedDiscoveryClass
element. This element is used when some of the properties cannot be set using the topology
mapping file. In this case, discovery of the classes cannot be directly done using the topology
mapping files and a hard coded class that includes all elements required for the discovery is
defined.

 Do not use hardCodedDiscoveryClass element when customizing a topology mapping file.


When a particular type of instance is discovered from multiple classes then some of its properties
may depend on attributes specific to a particular class. In this case, you need to declare these
properties in the discoveryClass element within the specificProperties element. The
specificProperties element includes the properties that have to be set depending on a discovery
class. You need to make sure that naming and tagging in the topology mapping file and in the
protocol template are the same so that the tag created during topology and statistics data retrieval
are identical. Reconciliating instance tagging for topology and statistics data retrieval may require
using a combination of attributes and properties from relevant statistics classes.
Each discoveryClass element contains the following sub-elements:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 129

Element... defines... Mandatory/ Number of


Optional occurrences
className the name of the required class. Mandatory Single
alarmName the name of the alarm associated with Optional Single
the class
instanceTag the instance tag that is used in VistaMart Mandatory Single
for that instance.
This tag is objectFullName.
basicCorrelation the basic instance in the case the Optional Multiple
discovered instance is a proxy.
This element uses attribute basicType
which defines the instance type of the
basic.
It contains the correlationAttribute
sub-element whose mandatory attributes
are the following:
• matchFromAttribute, which defines
the reference instance
• matchToAttribute, which defines the
current instance
polledClasses the discovery sub-classes that have to Optional Single
be present in the response to the
discovery request.
It contains at least one className sub-
element which defines a discovery sub-
class.
In case no polled class is defined, then
the main discovery class is entirely
considered in the response. If polled
classes are defined, then only the
selected sub-classes are considered in
the response.
discriminatingAtt a condition for discovering instances Optional Multiple
ribute using the following sub-elements:
• attributeName, which defines the
name of attribute to use for
discovering the instances
• includedValues, which indicates the
attribute values to consider.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 130

Element... defines... Mandatory/ Number of


Optional occurrences
specificPropertie the properties that need to be set for an Optional Single
s instance from a given discovery class.
The specificProperties element
contains at least one properties
element.
The properties defined here are to be
used only for instance name
reconciliation purpose between topology
and statistics data. They provide filtering
and name management information.
For the possible content of the
properties element see section
‘properties element’ hereafter.
specificVistas the list of vistas associated with a given Optional Single
instance on the basis of a discovery
class.
It contains the vistaList element.
For the possible content of the vistaList
element see section ‘vistaList block’
hereafter.
Example
The following elements are part of the discoveryClasses block of the SDP_260.xml default topology
mapping file delivered with your VistaLink.

In this example:
• svt.SdpBinding is the SDP instance main discovery class.

• objectFullName is the attribute used in the new instance tagging convention.

• basicType=”Router” indicates that SDP instances are proxies of routers.

• the correlation with the router is based on the siteName property of the router and the node
name of the instance.
• the svt.SpokeSdpBinding and svt.MeshSdpBinding discovery sub-classes are the only sub-
classes required in the response.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 131

• SDPInstanceDiscoverer is the name of the hard coded discovery class to use when the main
class cannot be directly discovered.

instanceProperties block
The instanceProperties block lists and specifies all the properties that need to be set for the
instance to be discovered. These properties are common to all of the discovery classes.
The instanceProperties block contains at least one properties element. In the default templates, it
can also contain a hardCodedPropertyAssignerClass element. The
hardCodedPropertyAssignerClass element is used when some of the properties cannot be set
using the topology mapping file. In this case, you need to set the properties using hard coded
property assigner classes.

 Do not use hardCodedPropertyAssignerClass element when customizing a topology mapping


file.
See sections ‘properties element’ hereafter.

properties element
The properties element is used in the specificProperties element of the discoveryClass
element and in the instanceProperties block. Each properties element can contain one or
several sub-elements.
Not all the following properties sub-elements are required but you have to organize them in the
following order:
1 reference
2 localProperty
3 simpleAssignment
4 booleanMapping
5 fixedValue
6 configuredProperty
7 calculatedProperty
8 conditionalProperty

! The reading of the topology mapping file returns an error if the properties are not defined in
the proper order. Make sure to observe the order.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 132

reference sub-element
The reference sub-element is optional. It defines the name of the class or instance which serves
as a reference to set the value of a property or an attribute.
Each reference sub-element contains at least one of the following sub-element:

Sub-element... defines... Mandatory/ Number of


Optional occurrences for
a given reference
element
correlationAttrib the relation with the reference. Optional Multiple
ute
Its mandatory attributes are the
following:
• matchFromAttribute, which defines
the reference instance or class
• matchToAttribute, which defines the
current instance

Each reference sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
referenceType what type of object is used as a Mandatory
reference.
Its possible values are:
• Instance

• SamClass
• BasicInstance

• ChildClass
className the name of the class, in case the Optional
reference is a class.
instanceType the name of the instance, in case the Optional
reference is an instance.

Example

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 133

localProperty sub-element
The localProperty sub-element is optional. It defines the properties that may be required for
internal usage but do not need to be provisioned to VistaMart.
Each localProperty sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
property the name of the property Mandatory
attribute the name of the attribute from the Optional
discovery class that is used for setting
the property value.
fixedValue a fixed value to set for the property. Optional
multiValued possible values to set for the property. Optional
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache
requestFromSam as a false/true boolean attribute, whether Optional
or not the attribute value is to be
requested from the SAM server:

Example In this example from the default Microwave topology mapping file, the localProperty
elements are used to:
• assign value Microwave to the instanceType property

• assign the value of the siteName attribute to the instanceName property

• assign the value of the siteName attribute to the siteName property

• assign the value of the objectFullName attribute to the objectFullName property and populate
the value in the topology cache.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 134

simpleAssignment sub-element
The simpleAssignment sub-element is optional. It is used to set the property value based on the
value of a given attribute of the class.
Each simpleAssignment sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
vista the name of the vista from which the Mandatory
property comes.
property the name of the VistaMart property to be Mandatory
set.
wid the WID of the VistaMart property. Mandatory
attribute the attribute of the class used to set the Mandatory
property value.
default the default value of the property. Optional
multiValued possible values to set for the property. Optional
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache
requestFromSam as a false/true boolean attribute, whether Optional
or not the attribute value is to be
requested from the SAM server:

Example
In the first simpleAssignment element of the following example, the VistaMart property IP from the
IpNode vista takes the value of the ipAddress attribute of the class.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 135

booleanMapping sub-element
The booleanMapping sub-element is optional. It is used to define a property value based on a the
false/true condition of a given class attribute.
Each booleanMapping sub-element contains at least one of the following sub-element:

Sub-element... defines... Mandatory/ Number of


Optional occurrences for
a given
booleanMapping
element
trueValue the value to set when a given attribute is Mandatory Multiple
true.
Its mandatory attribute is the following:
• mappedValue, which defines the
property value to set when a given
attribute is true.

Each booleanMapping sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
vista the name of the vista from which the Mandatory
property comes.
property the name of the VistaMart property to be Mandatory
set.
wid the WID of the VistaMart property. Mandatory
attribute the attribute of the class that governs the Mandatory
true/false condition of the property
setting.
multiValued possible values to set for the property. Optional
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache
requestFromSam as a false/true boolean attribute, whether Optional
or not the attribute value is to be
requested from the SAM server:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 136

Example
The following booleanMapping elements define the values of the Capabilities property from the
Common vista to set depending on the true/false value of a given attribute. For example, in the first
element, if attribute bgpEnabled is true, then the Capabilities property value is set to BGP.

fixedValue sub-element
The fixedValue sub-element is optional. It is used to set the property value based on a hard coded
value.
Each fixedValue sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
vista the name of the vista from which the Mandatory
property comes.
property the name of the VistaMart property to be Mandatory
set.
wid the WID of the VistaMart property. Mandatory
value the hard coded value to set for the Mandatory
property.
multiValued possible values to set for the property. Optional
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache

Example
In the following example, fixed values are defined for three different VistaMart properties:
• value Alcatel is set for the Agent Vendor property of the SnmpNode vista

• value SAM is set for the Capabilities property of the Common vista

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 137

• value 161 is set for the port property of the SnmpNode vista

configuredProperty sub-element
The configuredProperty sub-element is optional. It is used to set a VistaMart property value
according to the value set for the corresponding attribute in the SAM-Poller.properties file, in
<VistaLink Installation Directory>\SAM\config.
Each configuredProperty sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
vista the name of the vista from which the Mandatory
property comes.
property the name of the VistaMart property to be Mandatory
set.
wid the WID of the VistaMart property. Mandatory
attribute the attribute of the class used to set the Mandatory
property value.
multiValued possible values to set for the property. Optional
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache

Example
In the following example, the VistaMart property defined as VL Identifier obtains its value (SAM)
from that assigned to its attribute vlIdentifier in the <VistaLink Installation
Di.rectory>\SAM\config\SAM-Poller.properties file, on line
sam.configuredProperty.vlIdentifier=SAM.
Property VL Identifier is part of the VL Device vista and its WID is
217744A047C811DFA3650019B912D35C.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 138

calculatedProperty sub-element
The calculatedProperty sub-element is optional. It is used to set the property value calculated
using a Java script.
Each calculatedProperty sub-element contains at least one of the following sub-elements:

Sub-element... defines... Mandatory/ Number of


Optional occurrences for
a given
calculatedPropert
y element
javaScript the Java script expression on the basis Mandatory Single
of which the property is calculated.
propertyInfo the required property information using Mandatory Single
the attributes defined in the following
table

Each propertyInfo sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
vista the name of the vista from which the Optional
property comes.
name the name of the property to be set. Mandatory
type whether the property is to be used locally Mandatory
or to be provisioned into VistaMart using
one of the following values:
• local
• topology
wid the WID of the VistaMart property. Optional
Used only in the case the property is
provisioned into VistaMart.
persistent as a false/true boolean attribute, whether Optional
or not the property is to be populated in
the topology cache:
• true: the property is to be populated
in the cache
• false: the property is not populated in
the cache

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 139

Example
In the following example, the value of the Interface Speed property from the Interface vista is
calculated from the formula indicated in the javaScript element and provisioned to VistaMart.

conditionalProperty sub-element
The conditionalProperty sub-element is optional. It is used to set the property value based on a
condition.
Each conditionalProperty sub-element contains at least one of the following sub-elements:

Sub-element... defines... Mandatory/ Number of


Optional occurrences for
a given
conditionalProper
ty element
conditionalAttrib the attribute that governs the conditions. Mandatory Single
ute
It has the following attribute:
• requestFromSam, which determines, as
a false/true boolean, whether or not
the conditional attribute needs to be
requested from the SAM server.
condition the value of the attribute which defines Mandatory Multiple
the condition for which a given property
is set.
This element uses the following
elements to define the properties that
apply depending on the condition:
• localProperty

• simpleAssignment

• booleanMapping

• fixedValue

• calculatedProperty
Set those elements as described in their
respective sections.
The condition element has the following
attributes:
• attributeValue

• isRegExp
default the default property that is used when Optional Single
the conditions do not apply.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 140

Each condition sub-element may have the following attributes:

Attribute... defines... Mandatory/


Optional
attributeValue the value of the attribute which defines Mandatory
the condition for which a given property
is set
isRegExp the regular expression that can be Optional
matched for the value.

Example
The following conditionalProperty block defines the properties to set in the case the value of
attribute mode is either access, network or hybrid. In these 3 cases, the value of the VistaMart
property Role from the SAM interface vista is set respectively to Access, Network and Hybrid. If
none of these three conditions are met then the mode attribute of the class is used to set the
property value.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 141

vistaList block
The vistaList block is mandatory. It contains the list of vistas to set for the instance.
Each vistaList sub-element contains at least one of the following sub-element:

Sub-element... defines... Mandatory/ Number of


Optional occurrences for
a given vistaList
element
reference the reference of the instance in case Optional Single
there is any.
Its mandatory attributes are the
following:
• matchFromAttribute, which defines
the reference instance or class
• matchToAttribute, which defines the
current instance
vista a vista. Mandatory Multiple
Its mandatory attributes are the
following:
• name, which defines the name of the
vista
• wid, which defines the WID of the
vista

Example
The following vistaList block from the default Interface topology mapping file indicates that the
SAM interface Name and VL Device vistas need to be set for the Interface instances.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 142

Enabling the discovery of an instance


To enable the discovery of an instance, make sure that the topology mapping file that corresponds
to its instance type is available either in the <VistaLink Installation
Directory>\sam\ini\samTopoMapping or in the <VistaLink Installation
Directory>\sam\config\samTopoMapping folder. If the mapping file is not directly under the
samTopoMapping folder, also look for the topology mapping file inside the folder that corresponds to
the version of your SAM server (sam8, sam9, sam11).

 By default no sam10 folder is available under the samTopoMapping directory. In the case of a
SAM 10 server, VistaLink takes into account the mapping files available directly under
samTopoMapping and under the sam9 folder.
If no topology mapping file is available for this instance type you need to create one from an
existing topology mapping file (see "Creating a topology mapping file" on page 142).

Creating a topology mapping file


To be able to discover an instance type or an Alcatel-Lucent class for which no default topology
mapping file is available directly under <VistaLink Installation
Directory>\sam\ini\samTopoMappings or in the sam<xx> folder specific to your SAM server
version, you need to create a specific topology mapping file.

Prerequisites
• You have installed the VistaLink (see "Installing VistaLink for Alcatel-Lucent 5620 SAM" on
page 20).
• You have a good understanding of the content of the topology mapping files (see "Topology
mapping file structure" on page 126 and "Topology mapping file elements and attributes" on
page 127).
• You have used your Alcatel-Lucent 5620 SAM API to identify the discovery classes and
properties available for the given instance type.
• You have created the necessary properties and vista, if applicable, in VistaMart (see the
VistaMart User Guide).

 Create a topology mapping file


1 In <VistaLink Installation Directory>\sam\ini\samTopoMappings, duplicate the topology
mapping file which is closest to your needs for the desired resource type to the <VistaLink
Installation Directory>\sam\config\samTopoMappings or <VistaLink Installation
Directory>\sam\config\samTopoMappings\sam<xx> folder.

 In the case of a SAM 10 server, you may create a sam10 folder under <VistaLink
Installation Directory>\sam\config\samTopoMappings where to store your customized
mapping files.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 143

! Be aware that a VistaLink upgrade deletes the topology mapping files stored in the ini
folder but saves those stored in the config folder.
2 Rename the duplicated file appropriately, using syntax instanceType_integer.xml (see
"Topology mapping file name" on page 125).
3 Open the file using your favorite xml editor.
4 Carefully modify the various elements and attributes according to your needs (see "Topology
mapping file elements and attributes" on page 127).
5 Save and close the file.
6 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
7 Restart VistaLink (see "Managing the VistaLink service" on page 102).

Modifying a topology mapping file


For a given instance type for which a default topology mapping file is available, to:
• add new properties and vistas

• modify properties and vistas

• customize the naming and tagging of the instances


you just need to edit the default topology mapping files.

! The structure of the customized mapping file should be same as the original mapping file. It
should contain all the blocks existing in the original mapping file.
You can modify only the content of the properties, specificVista and vistaList blocks.
Only the properties that need to be customized or added should be present in the custom
topology mapping file.
If you need to declare a new topology class then you need to create a new topology mapping
file (see "Creating a topology mapping file" on page 142).
The VistaLink first analyzes the topology mapping files of the <VistaLink Installation
Directory>\sam\ini\samTopoMappings then those available in <VistaLink Installation
Directory>\sam\config\samTopoMapping. If it finds two files with the same name in both folders, it
analyzes the delta between the two files and takes into account the changes (modified or added
properties, added vistas) made in the config folder and merges them with the information that was
not changed in the original files of the ini folder.
To modify a topology mapping file, perform the following procedures, depending on your needs,
then activate the topology mapping file as indicated.

Prerequisites
• You have a good understanding of the content of the topology mapping files (see "Topology
mapping file structure" on page 126).
• Use your Alcatel-Lucent 5620 SAM API to identify the discovery classes and properties
available for the given instance type.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 144

• From <VistaLink Installation Directory>\sam\ini\samTopoMappings, duplicate the topology


mapping file you want to edit to <VistaLink Installation
Directory>\sam\config\samTopoMappings folder.

! Be aware that a VistaLink upgrade deletes the topology mapping files stored in the ini
folder but saves those stored in the config folder.
• Open the file using your favorite xml editor and:
• delete all the properties elements within the possibly existing specificProperties and
instanceProperties blocks, except the ones that contain the properties you plan to modify.
• within the properties elements that remain, delete all the properties except those you plan to
modify.

 Deleting the properties from the customized topology mapping files does not affect
the discovery of these properties. They still will be discovered as specified in the
topology mapping files stored in the ini folder.

 Modify an existing property


Within the properties element that contains the property, modify the property according to your
needs (see section ‘properties element’ in "Topology mapping file elements and attributes" on
page 127).

 Add one or several properties


1 Create a new properties element in the:
• specificProperties element of a discoveryClass element if the new property is specific to
the given discovery class, or
• instanceProperties element if the new property is common to all discovery classes, for the
given instance.
2 Within the properties element, make sure to add the different property sub-elements, when
needed, in the following required order:
1 - reference
2 - localProperty
3 - simpleAssignment
4 - booleanMapping
5 - fixedValue
6 - configuredProperty
7 - calculatedProperty
8 - conditionalProperty
3 Make sure that the VistaMart properties you add exist in VistaMart or create them first (see the
VistaMart User Guide).
4 Use a reference element whenever the property to be set is based on another instance or class.
5 If the new property is associated with a vista that is not declared in the topology mapping file,
add a vista element to the:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 145

• vistaList element of the specificVistas block, if the property is specific to the given
discovery class
• vistaList block of the file, if the property is common to all discovery classes for the given
instance.

 Make sure the vista exists in VistaMart or create it first (see the VistaMart User Guide).
For details and examples on each element and attribute, see "Topology mapping file elements
and attributes" on page 127, and especially the ‘properties element’ section.

 Customize the instance name


1 Create a new properties element in the:
• specificProperties element of a discoveryClass element if the new property is specific to
the given discovery class, or
• instanceProperties element if the new property is common to all discovery classes, for the
given instance.
2 Within the properties element, if you need to define the instance name:
• as a local property, add a localProperty element. For example:

• from multiple attributes, add a JavaScript element. For example:

 Customize the instance tag


1 Create a new properties element in the:
• specificProperties element of a discoveryClass element if the new property is specific to
the given discovery class, or
• instanceProperties element if the new property is common to all discovery classes, for the
given instance.
2 Within the properties element, if you need to define the instance tag:
• as a local property, add a localProperty element. For example:

• from multiple attributes, add a JavaScript element. For example:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Customizing your instance discovery 146

 Activate the custom topology mapping file


1 Save under <VistaLink Installation Directory>\sam\config\samTopoMappings and close the
modified file.
2 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
3 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).

Customizing discovery of SAP instances


By default, VistaLink discovers SAP instances based on their operationalState attribute value. If
you need to discover SAP instances based on their administrativeState attribute value, perform
the following procedure:

Prerequisites
• VistaLink is installed (see "Installing VistaLink" on page 28).

• You have successfully configured VistaLink using the Configuration Wizard (see "Using the
Configuration Wizard" on page 55).

 Customize discovery of SAP instances


1 Duplicate the <VistaLink Installation Directory>\sam\ini\samTopoMapping\SAP_240.xml file
to the VistaLink Installation Directory>\sam\config\samTopoMapping folder.
2 Using your favorite xml editor, open the <VistaLink Installation
Directory>\sam\config\samTopoMapping\SAP_240.xml file.
3 Go to the instanceProperties block and find the properties element that declares
localProperty sapState:
By default, the local property sapState is set using attribute operationalState in the
instanceProperties block:

4 To set this property using the administrativeState attribute, replace the operationalState
attribute value with administrativeState:

5 Save and close the file.


6 On a Unix platform, relaunch script <VistaLink Installation Directory>/bin/setprivs.sh.
7 Restart the VistaLink service (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 147

Defining the statistics classes


Alcatel-Lucent 5620 SAM server organizes statistics data using statistics classes. VistaLink uses
protocol templates to define from which statistics class to retrieve statistics data for a given
instance.
Your installation package provides a set of default protocol templates for given instance types.
Following are the default instanceType values and associated instance type and Vistas:

Instance type instanceType values Vistas


Interface Interface SAM Interface
LAN Switch Lan Switch LAN Switch
Microwave Microwave Microwave
MPLS LSP MPLS LSP MPLS LSP
Network Queue Group NetworkQueueGroup SAM Network Queue
OAM OAM Tests OAM Tests
QoS Port Queue Qos Port QoS Port
Router Router Router
SAM Network Queue SAM Network Queue SAM Network Queue
SAM SAP Queue SAM SAP Queue SAM SAP Queue Egress
SAM SAP Queue Ingress
SAP SAM SAP SAM SAP
SDP SAM SDP Endpoint SAM SDP Endpoint
Service SERVICE Service

The default protocol templates are located in folder:


<VistaLink Installation Directory>\sam\ini\protocolTemplates
When you add new instance type to your performance solution you need define its statistics class
by creating the corresponding protocol template file. You may also modify the protocol template
files.

! Be aware that a VistaLink upgrade deletes the protocol templates stored in the ini folder but
saves those stored in the config folder. If you edit sample protocol template files, InfoVista
recommends that you place your customized files in the <VistaLink Installation
Directory>\sam\config\protocolTemplates folder.
This section describes the blocks, elements and attributes of a template and how to create or
modify protocol templates:
 "Protocol template file name" on page 148
 "Protocol template structure" on page 148

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 148

 "Protocol template elements and attributes" on page 149


 "Creating a protocol template" on page 160
 "Modifying a protocol template" on page 161

Protocol template file name


There is no requirement for the file name syntax.
InfoVista recommends you to structure the file name based on the instance type name, without
using spaces, hyphens or underscores.
Example LanSwitch.xml

Protocol template structure


Protocol template files hold the connection properties and the Class (Alcatel-Lucent statistics
table) information for a given instance type. They contain the following information:
• the instance type for which the protocol template defines Classes within the instanceType tag

• the connection parameters that determine the SAM Host to which requests are to be made

• the table list which contains information regarding the different Class tables from which
indicators are to be calculated.
For example, the Microwave.xml file provides default connection properties and Class information
for the Microwave device:

where:
• instanceType defines the type of instance the protocol template applies to

• connectionProperty defines the connection properties used to connect to the SAM server

• tableInfoList defines all the Class tables that are referred to in the formulas of the indicators
related to the instance type.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 149

Protocol template elements and attributes


This section describes the elements and attributes you can use when customizing your protocol
templates. Avoid customizing the elements and attributes that you see in the default templates and
that are not described here.
You edit specific tags in a protocol template file to define from which statistics class table VistaLink
needs to retrieve data for a given instance type.
When you edit you:
• specify the instance type

• set specific statistics class table properties for the resource.

instanceType block
The instanceType block defines the type of instance the protocol template applies to.
It is a mandatory element and can be used only once in the file.

! You need to make sure that the instance type you are using is defined in the topology with
the same instanceType name.
Example

connectionProperty block
The connectionProperty block defines the connection properties used to connect to the SAM
server.
It is a mandatory element and can be used only once in the file. By default it defines the property of
the InfoVista Solution Model to use to identify the VistaLink server in VistaMart. You may need to
modify this property when you customize your topology.
It includes the following elements:

Element... defines... Mandatory/ Number of


Optional occurrences
name the name of the property. Mandatory Single
wid the VistaMart WID of the property. Mandatory Single
vista the Vista to which the property Mandatory Single
belongs to.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 150

Example

tableInfoList block
The tableInfoList block defines all the statistics class tables that are referred to in the formulas of
the indicators related to the instance type.
It is a mandatory element and can be used only once in the file.
It contains one or several tableInfo elements.
Each tableInfo element defines a particular class and contains specific attributes and elements.
Following are descriptions of the tableInfo element possible attributes:

Attribute... defines... Mandatory Type Default


/Optional value
name the name of the Class (Alcatel-Lucent Mandatory String
statistics table), as used in the indicator
formulas in VistaMart.
arrayAggregation whether or not array aggregation is Optional Boolean False
required for the table.
This occurs when multiple values of an
attribute is required to calculate
different indicators.
spatialAggregation whether or not spatial aggregation is Mandatory Boolean
required for the table.
This occurs when a table includes
several indicator values for a given
instance and timestamp and you need
to calculate the mean, maximum,
minimum, count or sum of those
indicator values.
availabilityTable whether or not the table contains Optional Boolean False
indicators on the instance availability.
statAdditional whether or not the table contains Optional Boolean False
additional statistics.
Additional statistics are statistics
calculated from Alcatel-Lucent classes
that are not timestamped. They are
mainly statistics calculated from
topology classes, such as temperature,
number of OSPF routes and number of
interfaces on a device.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 151

Attribute... defines... Mandatory Type Default


/Optional value
cliTable whether or not the statistics will be Optional Boolean False
retrieved as strings using a CLI
(Command Line Interface) table.

Following are descriptions of the tableInfo possible main elements:

Element... defines... Mandatory/ Number of


Optional occurrences
availabilityAlarm the number of the alarm related to the Optional, Single
availability of the instance. used only for
the Service
instance type
and with
availability
Table
attribute
samStatsClass the SAM statistic class used for the Mandatory Single
instance type. This class can vary
depending on conditions defined in sub-
elements.
It includes either one of the following
elements:
• conditionalStatClass

• simpleStatClass
polledClasses with details the SAM statistic classes Optional Single
that have to be present in the response
to the statistics request.
In case no polled class is defined, then
the main statistics class is entirely
considered in the response. If polled
classes are defined, then only the
selected sub-classes are considered in
the response.
The polledClasses element contains
the statClass element.
evaluationCondition the possible condition required for Optional Single
given statistics to be discovered.
If the condition doesn’t apply, the data
block that corresponds to the statistics
table is discarded.
This element contains the javaScript
element.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 152

Element... defines... Mandatory/ Number of


Optional occurrences
cliInfo the information required in the case the Mandatory Single per CLI
statistics table is a CLI table. only in the table
This information enables sending a CLI case of a CLI
request to the SAM server and defines table
the format of the expected reply.
In contains the following elements:
• command

• parserClass

• columnInfo

• instanceIdentifier
countColumn the VistaLink statistic counter of a given Optional Single
type.
It is required in case of specific
indicators such as NumberOfPorts.
It contains the following elements:
• difColumn

• calculatedType
logToFileInfo the minimum SAM server version for Mandatory Single
which LogToFile requests can be sent, for classes
in the case LogToFile was selected as requested in
the statistics retrieval mode. LogToFile
For other versions, FindToFile requests mode
are used.
It may contain the following elements:
• minimumSamVersion

• logToFileRequestType (for OAM


protocol template only)
tagColumn the name of the column to be used as Mandatory Single
tag in VistaMart.
timestampColumn the name of the column which is to be Mandatory Single
used as the timestamp column in
VistaMart.
It is not required when statAdditional
and Availability are set to True: in
this case the value from this column is
not read.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 153

Element... defines... Mandatory/ Number of


Optional occurrences
proxyId in case of statsAdditional element Optional Single
only, the name of the proxyId column to
be used to calculate indicators using
VistaLink statistics counters.
calculatedColumn columns calculated from values Optional Single
received from the SAM server and
using hard coded string values and
existing attributes from the class table.
It contains the difColumn attribute and
the javascript element.
customExtractionRate in case of statsAdditional element Optional Single
only, the value to use for the data
extraction rate.
To use for Routers only with value DR,
which refers to the default Display Rate
value for the given table
Examples
• The following example from the default LanSwitch.xml protocol template lists two different
statistics class tables.

• The following example shows a tableInfo element from the default oams.xml protocol template:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 154

This default template enables to retrieve data from OAM’s in LogToFile mode.
The following logToFileRequestType element is used for OAM protocol templates only and
requires value registerSasLogToFile whenever the VistaLink retrieves data in LogToFile mode.

samStatsClass element
The samStatsClass element defines the SAM statistic class used for the instance type. This class
can vary depending on conditions defined in sub-elements. It is a complex mandatory element that
includes optional and mandatory elements and attributes.
For availability type statistics, the value of the statClass attribute is equal to statClass.
Following are the elements that can be part of the samStatsClass element:

Element... defines... Mandatory/ Number of


Optional occurrences
simpleStatClass the SAM statistic class to use Optional if Single
regardless of any condition. conditional
Contains the statClass attribute. StatClass is
used
otherwise
mandatory
conditionalStatClass the SAM statistic class to use Optional if Single
depending on a simpleStatC
conditionalAttribute. lass is used
otherwise
mandatory

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 155

Element... defines... Mandatory/ Number of


Optional occurrences
condition the condition in which a SAM statistic Mandatory in Multiple
class is used. the case of
Included in conditionalStatsClass conditional
StatsClass
It contains the following attributes:
• attributeValue

• statClass

Following are the attributes that can be part of the samStatsClass element:

Attribute... defines... Mandatory/


Optional
conditionalAttribute the attribute that determines the Mandatory in
statistic class to poll. the case of
conditional
StatsClass
attributeValue the condition associated with a given Mandatory in
SAM statistic class. the case of
Contains the statClass attribute. conditional
StatsClass
statClass the SAM statistic class to use whether Mandatory
conditionally or unconditionally.

Examples

polledClasses elements and attributes


The polledClasses element defines with details the SAM statistic classes that the VistaLink will
consider in the response from the SAM server.
It is a complex optional element that includes optional and mandatory elements and attributes.
Following are the elements that are part of the polledClasses element:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 156

Element... defines... Mandatory/ Number of


Optional occurrences
statClass a statistic class, using attribute name Mandatory in Multiple
and element calculatedColumn. case of
polledClass
es
calculatedColumn the VistaLink statistics counter whose Optional Single per
value is to be calculated by the statClass
JavaScript.
It contains the difColumn attribute and
the javascript element.
javascript the script code to use for the given Mandatory Single
difColumn.

Following are the attributes that are part of the polledClasses element:

Attribute... defines... Mandatory/


Optional
name the name of the statistics class. Mandatory
difColumn the name of the VistaLink statistics Mandatory
counter whose value is to be calculated
using the JavaScript.

Example

evaluationCondition element and attribute


The evaluationCondition defines the possible condition required for given statistics to be
retrieved. If the condition doesn’t apply, the data block that corresponds to the statistics table is
discarded.
It is a complex optional element that includes a mandatory element.
Following is the element that is part of the evaluationCondition element:

Element... defines... Mandatory/ Number of


Optional occurrences
javaScript the script code used to set a condition Mandatory if Single
for enabling the statistics data retrieval. evaluationC
It can contain the logOnError attribute. ondition is
used

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 157

Following is the optional attribute of the javaScript element:

Attribute... defines... Mandatory/ Number of


Optional occurrences
logOnError the reason, as a string, why the Java Optional Single
Script did not apply.

Examples
• evaluationCondition element without the logOnError attribute:

• evaluationCondition element with a logOnError attribute:

cliInfo elements and attributes


The cliInfo element defines the information required in the case the statistics table is a CLI
(Command Line Interface) table.
This information enables sending a CLI request to the SAM server and defines the format of the
expected reply.
It is a complex optional element that includes optional and mandatory elements and attributes.
Following are the elements that are part of the cliInfo element:

Element... defines... Mandatory/ Number of


Optional occurrences
command the command to execute on the SAM Mandatory Single
server.
parserClass the name of the parser class required Mandatory Single
to parse the response from the SAM
server.
columnInfo the table column that contains the Mandatory Multiple
values to poll.
It contains the columnName attribute and
the following elements:
• attributeName

• header
attributeName the name of the attribute present in the Mandatory Single
CLI response to be used in the
calculation of the column value.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 158

Element... defines... Mandatory/ Number of


Optional occurrences
header the header expected in the CLI Mandatory Single
response from the SAM server.
instanceIdentifier the attribute name for the class that Mandatory Single
needs to be used as identifier for the
instance.
Following is the attribute that is part of the columnInfo element:

Attribute... defines... Mandatory/


Optional
columnName the name of the statistics class. Mandatory

Example

countColumn attributes
The countColumn element defines the counter of a given type for a given VistaLink statistics
counter.
It is required in case of specific indicators such as NumberOfPorts.
It is a complex optional element that includes mandatory attributes.
Following are the attributes that are part of the countColumn element:

Attribute... defines... Mandatory/


Optional
difColumn the name of the VistaLink statistics Mandatory
counter whose value needs to be
calculated.
calculatedType the calculated type used to calculate Mandatory
the NumberOfPorts value.

Example

logToFileInfo elements
The logToFileInfo element defines LogToFile specific information.
It is a complex element that includes the following mandatory and optional elements:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 159

Element... defines... Mandatory/ Number of


Optional occurrences
minimumSamVersion the minimum SAM server version for Mandatory Single
which LogToFile requests can be sent,
in the case LogToFile was selected as
the statistics retrieval mode.
For earlier versions, FindToFile
requests are used.
logToFileRequestType a specific LogToFile mode for OAM Optional Single
protocol template only

Example

calculatedColumns elements and attributes


The calculatedColumns element defines columns calculated from values received from the SAM
server and using hard coded string values and existing attributes from table.
It is a complex element that includes mandatory elements and attributes.
Following are the elements that are part of the calculatedColumns element:

Element... defines... Mandatory/ Number of


Optional occurrences
calculatedColumn the VistaLink statistics counter whose Mandatory Multiple
value is to be calculated by the
JavaScript.
It contains the difColumn attribute and
the javascript element.
javascript the script code to use for the given Mandatory Single
difColumn.

Following are the attribute that is part of the calculatedColumn element:

Attribute... defines... Mandatory/


Optional
difColumn the name of the VistaLink statistics Mandatory
counter whose value is to be calculated
using the Java Script.

Example

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 160

Creating a protocol template


If you have added a new instance type to your solution, you need to define the type of statistics
data to retrieve for it in a specific protocol template file.

Prerequisites
• You have enabled the discovery of this instance type (see "Enabling the discovery of an
instance" on page 142).
• You have a good understanding of the content of the protocol template files (see "Protocol
template structure" on page 148 and "Protocol template elements and attributes" on page 149).
• You know from which type of table the VistaLink will retrieve data for the given instance type.

• You know what statistic classes are used to retrieve the data for this instance type.

 Create a protocol template


1 In <VistaLink Installation Directory>\sam\ini\protocolTemplate, duplicate the protocol
template which is closest to your needs for the desired instance type to <VistaLink
Installation Directory>\sam\config\protocolTemplate folder.

! Be aware that a VistaLink upgrade deletes the protocol template files stored in the ini
folder but saves those stored in the config folder.
2 In <VistaLink Installation Directory>\sam\config\protocolTemplate, rename it
appropriately, based on the new instance type name (see "Protocol template file name" on
page 148).
3 Open the file using your favorite xml editor.
4 Modify the instanceType and the tableInfoList blocks appropriately (see "Protocol template
elements and attributes" on page 149).
5 Save and close the file.
6 If running on Solaris/Linux: relaunch script bin/setprivs.sh.
7 Restart VistaLink (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Defining the statistics classes 161

Modifying a protocol template


You can change details concerning the data to retrieve on a given instance type by modifying its
protocol template.

Prerequisites
• You have a good understanding of the content of the protocol template files (see "Protocol
template structure" on page 148).
• You know from which type of table the VistaLink will retrieve the data for this instance type.

• You know what statistic classes are used to retrieve the data for this instance type.

 Modify a protocol template


1 In <VistaLink Installation Directory>\sam\ini\protocolTemplate, duplicate the protocol
template which is closest to your needs for the desired instance type to <VistaLink
Installation Directory>\sam\config\protocolTemplate folder.

! Be aware that a VistaLink upgrade deletes the protocol template files stored in the ini
folder but saves those stored in the config folder.
2 In <VistaLink Installation Directory>\sam\config\protocolTemplate, open the file using
your favorite xml editor.
3 Modify the tableInfoList blocks appropriately (see "Protocol template structure" on page 148).
4 Save and close the file.
5 If running on Solaris/Linux: relaunch script bin/setprivs.sh.
6 Restart VistaLink (see "Managing the VistaLink service" on page 102).

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 162

Creating an indicator
You can create your own indicators to suit your reporting needs, as explained in the following
sections.
You can get data from a specific database and integrate this data into the VistaFoundation for
customized reporting.
You do this by adding your own indicators to a set of existing indicators.
There are two levels of customization. You can:
• create a new data indicator, or

• create a new display indicator sourced by data indicators.


These two indicator types are explained in "Data indicators versus Display indicators" on page 164.
To understand the different steps involved in indicator creation, see "Overview" on page 162.
To get started, see "Indicator creation workflow" on page 166.

Overview
This section provides basic information to enable you better to understand the different steps
involved in indicator creation.

Principles
You create your own indicators in your own libraries. You create these libraries for the specific
purpose of containing your indicators. Using your own libraries enables you to keep your
customized reporting whenever the out-of-the-box standard and/or ad hoc model(s) are overwritten
when VistaMart is upgraded.
InfoVista strongly recommends that you have a solid understanding of VistaMart principles before
you begin the example workflow.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 163

Rules
Generic rules are available in the SAM Customization module to start your indicator slots, meaning
that you may not need to create a rule if these generic rules meet your needs. Following is the list
of rules predefined for given resources:

Before you start to create an indicator, you should therefore verify that a rule exists for the
indicator you are about to create. If none is available, you need to create your own rule. This is
explained in "Apply the rules" on page 173 at the end of the section "Customizing your solution:
main steps" on page 115.

Instance types and formulas


VistaLink for Alcatel-Lucent 5620 SAM supports a variety of statistics classes which address a
group of measurements designed for a specific function within a given device, such as a Router.
When you create your own indicator, in order to get the data you want, you specify in the
indicator’s formula the required class(es) and the respective counter(s).
Formulas are explained and examples are provided in "VistaLink formula Syntax" on page 174.

Which guide explains what


Before you begin creating your own indicators, familiarize yourself with these guides. They provide
the information you need for the indicator creation process.
• VistaLink for Alcatel-Lucent 5620 SAM Installation Guide
• The tools: This guide - the one you are reading now - explains the tools that are required
when you create customized indicators. It lists tables, correct syntax, permissible formula
operators, and gives examples.
• The procedure: This guide also provides the step-by-step procedures you perform to create
your customized indicators.
The detailed steps you perform are provided in "Customizing your solution: main steps" on
page 115.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 164

• VistaMart User Guide


The background information: The VistaMart User Guide provides in-depth information on
VistaMart principles. Because you create your own indicators using the VistaMart Inventory
Manager, you should have a thorough understanding of fundamental VistaMart principles before
you begin creating your indicators. Keep this guide available as a reference.

Data indicators versus Display indicators


As the names imply, display indicators are what you see whereas data indicators are what you
source:
• Data indicators represent a range of similar indicators whose respective values are sourced or
calculated differently. When one of these data Indicators satisfies predefined conditions,
VistaMart associates it with a display indicator.
• Display Indicators can have a range of data indicators associated with them. For each data
indicator, you define the conditions that must be satisfied so that VistaMart associates it with
specific display indicator and ignores the other ones. Doing so gives you the following
advantages:
• Display indicators can be dissociated from any aspects of data acquisition or data calculation,
since only the data indicators address these factors. This dissociation provides significant
support flexibility.
• You use display indicators as “generic” indicators to extract data from the VistaMart database
to feed a single VistaPortal report. This means you do not need to design multiple reports that
each address a dedicated data indicator.
You can create display indicators as “generic” indicators that are sourced from specific data
indicators which reside in your VistaBridge Libraries according to the conditions you set, even if
the data indicators are from different vendors or for different types of resources. Such linked
display/data indicators are already supplied in your solution.

Multi-formula display indicators and Resolvers


When your set up a display indicator from several data indicators, you need to create a multi-
formula display indicator. You do this by creating resolvers that you attach to the indicator.
The following screenshots of the VistaMart Inventory Manager shows the resolvers associated with
display indicator AnyVendor - Net Device Mean of Temperature (°C) and how they determine the
formula to use depending on polled resource.
In this case the formula differs for LAN switches and routers using the following data indicators:
• Alcatel - sam - LAN Switch - Mean of Temperature (°C)

• Alcatel - sam - Net Device Mean of Temperature (°C)

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 165

This advanced function requires creating a syntactically-correct expression for each resolver you
add.
Creating multi-formula indicators, resolvers and their expressions are explained in detail in the
VistaMart User Guide, section ’Designing a multi-formula Display Indicator’. Before you put
together your own multi-formula indicators, InfoVista strongly recommends that you thoroughly
read this and related sections in the VistaMart User Guide.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 166

Indicator creation workflow


The procedures in the following sections explain how to create an indicator and then start the new
slot.
You must create your indicator in a VistaBridge library that is not part of the InfoVista Model. You
can create several indicators in the same library.
To create your own indicators, you perform the steps listed in the overview table below, from the
VistaMart Inventory Manager.
InfoVista strongly recommends that you refer to the respective VistaMart sections listed in the
following table before you begin.

To perform step... see...


1 Ensure prerequisites • "Ensuring prerequisites" on page 166

2 Create a VistaBridge library • "Creating a VistaBridge library" on page 167


in VistaMart under the
’VistaBridge Libraries’ node. • VistaMart User Guide, section ’Creating a VistaBridge
Library’
3 Create your custom indicator • "Creating a VistaLink indicator" on page 168
in the new VistaBridge Library
• VistaMart User Guide, section ’Creating indicators’

4 Create the formula to apply to • "Providing a VistaLink formula" on page 170


your indicator
• VistaMart User Guide, section ’Writing formulas using the
formula editor’ and subsequent sections
5 Verify the formula syntax • "Verifying the VistaLink formula syntax" on page 172
6 Apply rules to start your • "Apply the rules" on page 173
indicator
• VistaMart User Guide, section ’Working with Modules and
Rules’

InfoVista strongly recommends that you refer to the VistaMart User Guide, section “Working with
Modules and Rules”, for in-depth information about rules.

Ensuring prerequisites
Using existing rules eliminates the need to write your own rules. However, be aware that these
rules are subject to change, and may not be available for all the indicators your want to add.
Before you start, verify that a generic rule exists for the indicator you are about to create. If no rule
exists for your indicator, you must create a rule to start the indicator slot. In this case, refer to the
procedure "Apply the rules" on page 173.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 167

Creating a VistaBridge library


Use this procedure to create your own VistaBridge library for your custom indicators.

 Create a library
1 In the VistaMart Inventory Manager, click the Model tab.
2 Right-click the VistaBridge Libraries node and select New Library.
The New VistaBridge Libraries dialog box appears.
3 Enter a name for the new library (example: MyVistaBridgeLibrary) and an optional description.

4 Click Finish.
Your new library appears in the left- and right-hand panes:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 168

Creating a VistaLink indicator


Prerequisite
You have created a VistaBridge library for your indicator(s).

 Create an indicator
1 In the VistaMart Inventory Manager, click the Model tab.
2 Under VistaBridge Libraries, expand the library you created for the indicator.
3 Right-click the Indicators node, and select New Indicator.
The New Indicators dialog box appears.
4 Type a name for the new indicator (example: MyVistaBridgeIndicator), then enter at least:
• Vista: select the appropriate vista name (example: Interface)
• Library: select the library to which it belongs (example: MyVistaBridgeLibrary)
• Vendor: select the appropriate vendor (example: Alcatel)
• Capability: select BasePI_Bridge.
• Solution: select SAM.
• User Field: type SAM Customization and press Enter, to start the rules associated with
indicators customized for SAM.

 The SAM Customization module automatically associates the rules that provide the
relevant Acquisition and Display Rates to the indicator.

 Depending on indicator, you may need to enter other fields, such as Unit. You can
enter the formula at this stage or later.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 169

5 Click Next.
The Resolver creation dialog box appear.
If you are creating a multi-formula indicator, enter the names of all the possible source indicators
(for example, depending on vendor).
6 Click Finish.
Your new indicator appears in the right-hand pane:

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 170

Providing a VistaLink formula


Use this procedure if you have not already entered any formula when you created your VistaLink
indicator.
Refer to the appropriate Class table for the list of counters specific to the concerned device in your
Alcatel-Lucent 5620 SAM documentation.
Refer to "VistaLink formula Syntax" on page 174 for details on formulas.
For details on the formula editor, refer also to the VistaMart User Guide, section “Writing formulas
using the formula editor”.

Prerequisite
You have already created an indicator without entering its formula.

 Provide a VistaLink formula


1 In the VistaMart Inventory Manager, click the Model tab.
2 Under VistaBridge Libraries, expand the library where you created the indicator and select the
Indicators node.

3 Click your indicator in the right-hand pane, then click the Indicator formula ellipsis button .
The Formula Editor appears.
4 Enter the formula required to get the values you want (see "VistaLink formula Syntax" on
page 174).
For example: delta(SAPQueueIngressStats.lowOctetsOffered).....

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 171

5 Click OK.
The formula appears in your new indicator:

Your indicator is ready.


6 Export your new library:
• Expand the VistaBridge Libraries node.
• Right-click your new library and select Export Library ...
• Browse to the folder where you want to store your customized libraries and click Export.
The library is now available as an XML file under the folder you chose.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 172

Verifying the VistaLink formula syntax


VistaMart does not check your VistaLink formulas for correct syntax. Once you have created a
VistaLink indicator with its formula you need to verify that your formula syntax is correct using the
VistaLink formula checker delivered with your VistaLink.

Prerequisite
You have exported the VistaBridge Library where you created the indicator.

 Verify VistaLink formula syntax


1 Go to the VistaLink installation directory and open the bin directory.
2 Run formulachk.exe.
The formula checker interface appears:

3 Click Add to add the library which contains your indicator. You can add more than one library.
4 Click Start checking to check the validity of the indicator(s).
5 The results appear in the Result pane.
You can save the results by clicking Export result. The file is saved to the bin directory.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Creating an indicator 173

Apply the rules


Once you have created the VistaLink indicators, you need to start the relevant slots for the
VistaLink to start retrieving the required data and generate the indicators. The VistaLink solution
comes with a default set of rules.
If no rule is available for your custom indicator, you need to create a rule in order to start the
indicator slot as explained in this procedure. To create a rule, see the VistaMart User Guide.

Prerequisites
• You have created your indicators using the SAM Customization module (see "Creating a
VistaLink indicator" on page 168).
• You have verified that the formula syntax of the new indicators is correct.

 Apply the rules


1 In the VistaMart Inventory Manager, in the Provisioning menu select Test & Apply Rules...
The Apply/Test rules panel appears.
2 Select the zone Default [Default] and click the ’Test Rules’ button at the upper right.
3 On success, apply your new rule by clicking the ’Apply Rules’ button .

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 174

VistaLink formula Syntax


When creating your customized indicator, you can use several possible syntaxes in your indicator
formulas to retrieve counter values, from one or several given statistics tables in performance files,
called Classes.
The formulas can use one or multiple parameters consisting of a ClassName and a CounterName,
where ClassName specifies the Class table used for the statistics, and CounterName the name of the
counter (or column) in the table.
VistaLink can handle single-value and multiple-value counters. Therefore, parameters may be
single- or multiple valued.
This section addresses the following topics:
 "Basic parameter syntax" on page 175
 "For single-value counters" on page 178
 "For multi-value counters" on page 178
 "Operators" on page 180
 "Examples" on page 186

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 175

Basic parameter syntax


Operators and formulas handle variable combinations that consist of a pair of ClassName and
CounterName. You can express these pairs using the two following syntaxes:

Syntax 1: ClassName.CounterName
Syntax 1 based on the ClassName.CounterName structure is the preferred syntax, unless operations
involve several counters of the same Class table.
You have four different ways of using this syntax:

Syntax Description
ClassName.CounterName Basic syntax that applies either with a single value counter
or in the case the parameter considers all values in a
multiple value counter.
ClassName.CounterName[index] Basic syntax that applies in the case the parameter
considers only given values in a multiple value counter.
Use a comma to separate the index values when
addressing several rows in the counter.
For more information on using indexes, see section "For
multi-value counters" on page 178
ClassName.COLUMN[“CounterName”] Syntax to use:
• with a single value counter or in the case the parameter
considers all values in a multiple value counter, and
• when the counter name includes a special character - for
example, dot (’ . ’), which is normally used as a
separator.
With COLUMN[“CounterName”] the formula parser does not
take the special character included in the counter name into
account and finds the actual counter.
ClassName.COLUMN[“CounterName”][ Syntax to use:
index] • in the case the parameter considers only given values in
a multiple value counter, and
• when the counter name includes a special character - for
example, dot (’ . ’), which is normally used as a
separator.
With COLUMN[“CounterName”] the formula parser does not
take the special character included in the counter name into
account and finds the actual counter.
For more information on using indexes, see section "For
multi-value counters" on page 178

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 176

Examples
• class0.counter1

• class0.counter1[3]

• class0.counter1[0,3]

• class1.counter[“A.B”]

• class1.counter[“A.B”][1]

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 177

Syntax 2: CounterName from ClassName


Syntax 2 based on the CounterName from ClassName structure is recommended for operations that
involve several counters of the same class table. It enables you to specify the class only once in a
formula that addresses several counters that are part of the same class.

 When performing an operation on two counters, make sure to enclose the counter names in
parentheses, else ClassName applies only to the first element in the string preceding ’from’.
Example (counter1 + counter2 + counter3) from class1
You have four different ways of using this syntax:

Syntax Description
CounterName from ClassName Basic syntax that applies either with a single value counter
or in the case the parameter considers all values in a
multiple value counter.
CounterName[index] from Basic syntax that applies in the case the parameter
ClassName considers only given values in a multiple value counter.
Use a comma to separate the index values when
addressing several rows in the counter.
For more information on using indexes, see section "For
multi-value counters" on page 178
COLUMN[“CounterName”] from Syntax to use:
ClassName • with a single value counter or in the case the parameter
considers all values in a multiple value counter, and
• when the counter name includes a special character - for
example, dot (’ . ’), which is normally used as a
separator.
With COLUMN[“CounterName”] the formula parser does not
take the special character included in the counter name into
account and finds the actual counter.
COLUMN[“CounterName”][index] Syntax to use:
from ClassName • in the case the parameter considers only given values in
a multiple value counter, and
• when the counter name includes a special character - for
example, dot (’ . ’), which is normally used as a
separator.
With COLUMN[“CounterName”] the formula parser does not
take the special character included in the counter name into
account and finds the actual counter.
For more information on using indexes, see section "For
multi-value counters" on page 178

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 178

Examples
• counter1 from class0

• counter1[3] from class0

• counter1[0,3] from class0

• COLUMN[“A.B”] from class1

• COLUMN[“A.B”][1] from class1

For single-value counters


You can use Syntax 1 and Syntax 2 in cases where counter values are single numeric values.
Example The following table is an example where each counter provides a single value for a
given timestamp.

Timestamp Tag counter1 counter2 .....


10:00 instance1 5 20 .....
10:15 instance1 10 15 .....
10:30 instance1 20 20 .....
..... ..... ..... ..... .....

For multi-value counters


Some statistics files may have counters that contain multiple values (arrays).
You can use Syntax 1 and Syntax 2 in cases where counters may provide multiple values per
timestamp.
You enable VistaLink to handle such counters by entering an index number in your formula which
represents the sequential position of a value in the array. The index number always starts with ’0’.
You may either choose to consider all the values of the counter or a single value:
• If you want to consider all the values use the counter name without using brackets.

• If you want to consider only a given value, specify, in brackets, the index which corresponds to
the value position in the array.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 179

Example Assume you want to address the multi-value counter1 in class0


where values in counter1 are 5, 10, 20,15 for the 10:00 timestamp, as illustrated in the
following table.
If you want to retrieve the first and fourth values of counter1 from class0, your formula
would be:
(counter1[0] + counter1[3]) from class0
where index [0] = 5, and index [3] = 15
And the formula would return 20.
class0:

Timestamp Tag counter1 counter2 .....


10:00 instance1 5 20 .....
10:00 instance1 10 15 .....
10:00 instance1 20 20 .....
10:00 instance1 15 15 .....
10:15 instance1 5 10 .....
10:15 instance1 30 40 .....
..... ..... ..... ..... .....

For this example you can use both available syntaxes:


Syntax 1: class1.counter1[0] + class1.counter1[3]
Syntax 2: (counter1[0] + counter1[3]) from class1

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 180

Operators
The following arithmetic, aggregation and miscellaneous operators are supported.
These operators support either single-value or multiple-value parameters, and/or multiple
parameters.

 Operators are not case-sensitive. For example, isnull and isNull are both valid.

Using multiple parameters with an operator


You can use operators with multiple parameters as long as each parameter returns a single value
and not an array of values.
Examples
• max(Class1.Counter1,Class1.Counter2)

• max((Counter1,Counter2) from Class1)

Arithmetic operators
Arithmetic operators support multiple and single value parameters. However you can use them in
indicator formulas with multiple value parameters only with aggregation operators listed in the next
section.

Operators Function
+ Addition
Adds the values of two or more expressions.
Example (counter1 + counter2) from Class1
- Subtraction
Subtracts the values of two expressions.
Example (counter1 - counter2) from Class1
/ Division
Divides the values of two expressions.
Example (Counter1 - Counter2) from Class1
* Multiplication
Multiplies the values of two expressions.
Example (Counter1 * Counter2) from Class1

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 181

Aggregation operators
The aggregation operators described in this section all apply to multiple-value parameters. They
can also involve multiple parameters except for count(). Examples used in the operator
descriptions are based on sample class1 and class2 available at the end of the following table.

Operators Functions
sum(expression_1,... Summation
expression_n) or Performs spatial aggregation by adding values for a given timestamp.
sum(expression)
1 Adds the multiple values of a given counter for a given timestamp.
Example Using counter1 from class1 for the 10:00 timestamp with
formula:
sum(counter1) from class1
the returned value would be ‘15’ (10 + 5 = 15).
2 Adds single-value counters for a given timestamp.
Example Using counter1 and counter2 from class2 for the 10:15
timestamp with formula:
sum(counter1,counter2) from class2
the returned value would be ‘25’ (15 + 10 = 25)
mean(expression_1,..., Average
expression_n) or Performs spatial aggregation by averaging multiple values for a given
mean(expression) timestamp.
1 Averages the multiple values of a given counter for a given
timestamp.
Example Using counter1 from class1 for the 10:00 timestamp with
formula:
mean(counter1) from class01
the returned value would be ‘7.5’ ((10 + 5) / 2 = 7.5)
2 Averages a set of single-value counters for a given timestamp.
Example Using counter1 and counter2 from class2 for the 10:15
timestamp with formula:
mean(counter1,counter2) from class2
the returned value would be ‘12.5’ ((15 + 10)/2 = 12.5)

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 182

Operators Functions
min(expression_1,..., Minimum
expression_n) or Performs spatial aggregation by retaining the minimum value for a single
min(expression) timestamp.
1 Returns the smallest value of the multiple values of a given counter
for a given timestamp.
Example Using counter1 from class1 for the 10:00 timestamp with
formula:
min(counter1) from class01
the returned value would be ‘5’
2 Returns the smallest value between single-value counters for a given
timestamp.
Example Using counter1 and counter2 from class2 for the 10:15
timestamp with formula:
min(counter1,counter2) from class2
the returned value would be ‘10’

max(expression_1,..., Maximum
expression_n) or Performs spatial aggregation by retaining the maximum value for a given
max(expression) timestamp.
1 Returns the largest value of the multiple values of a given counter for
a given timestamp.
Example Using counter1 from class1 for the 10:00 timestamp with
formula:
max(counter1) from class01
the returned value would be ‘10’
2 Returns the largest value between single-value counters for a given
timestamp.
Example Using counter1 and counter2 from class2 for the 10:15
timestamp with formula:
max(counter1,counter2) from class2
the returned value would be ‘15’
count(expression) Returns the number of values available in a multiple-value counter for a
given timestamp.
Example Using counter2 from class1 for the 10:00 timestamp with
formula:
count(counter2) from class1
the returned value would be ‘2’

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 183

• Sample class featuring multi-value counters: class1

Timestamp Tag counter1 counter2 .....


10:00 instance1 10 20 .....
10:00 instance1 5 15 .....
10:15 instance1 5 10 .....
10:15 instance1 30 40 .....
..... ..... ..... ..... .....

• Sample class featuring single-value counters: class2

Timestamp Tag counter1 counter2 .....


10:00 instance1 10 0 .....
10:15 instance1 15 10 .....
..... ..... ..... ..... .....

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 184

Miscellaneous operators
The operators described in this section handle only one single-value parameter, except for
isNull() which uses two single-value parameters.
Examples used in the operator descriptions are based on sample class2 available at the end of
the following table.

Operator Function
delta(expression) Computes the delta by subtracting the previous value from the
current value.
Example Using counter1 from class2 for the 10:15 timestamp
with formula:
delta(counter1) from class2
the returned value would be ‘5’ (15 - 10 = 5).
deltaBySec(expression) Divides the difference between counter values by the number of
seconds between the respective timestamps.
This operator is generally applied to bandwidth indicator
measurements and gives a useful picture of the difference in data
volume between given points in time.
Example Using counter1 from class2 for the 10:15 timestamp
with formula:
deltaBySec(counter1) from class2
the resulting value would be 5 / 900 = 0.0055, where
900 = 15 minutes is the timestamp difference in
seconds between 10:00 and 10:15, and 5 is the delta
between the counter1 values between those two
timestamps.
isNull(expression1, Removes an undefined value from a expression for a given
expression2) timestamp and replaces it with another to avoid an undefined or
invalid result.
This operator is typically used with a mean or division operator if
the expression1 evaluation is in error. In this case isNull provides
a replacement value to the undefined value with expression2.

 Note: ‘null’ means that there is no counter value, not that


the value is 0.
Example Calculating the ratio between counter1 and counter2,
at 10:00 when counter2 = 0, using formula:
isNull(counter1/counter2,0) from class2
would return 0.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 185

Operator Function
displayRate() Returns the display rate in seconds of the slot whose value is
inserted into VistaMart for a given timestamp. This operator does
not take any parameter.
Example Dividing the sum of counter1 and counter2 from class2
at 10:15 for a 15-minute display rate (900 seconds) with
formula:
(counter1 + counter2)/displayRate()
would return ‘0.03’ (25/900)
property(‘property_name’) Retrieves a property value for a given timestamp.
Example property(‘Interface Speed’) would return the speed
measured on the interface at the given timestamp.

• Sample class featuring single-value counters: class2

Timestamp Tag counter1 counter2 .....


10:00 instance1 10 0 .....
10:15 instance1 15 10 .....
..... ..... ..... ..... .....

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM VistaLink formula Syntax 186

Examples
This section provides various indicator examples using actual Alcatel-Lucent 5620 SAM counters
and classes:
• Microwave_Availability.availability or availability from Microwave_Availability
where Microwave_Availability is the Class table where the indicator is found and
availability is the counter in the table that returns the required value.
• Indicator Alcatel - sam - Submitted Traffic (bps) uses formula:
QosPortQueueStats.qoSQueueStatsBytesDropped * 8 +
QosPortQueueStats.qoSQueueStatsBytesSent * 8
but can also use formula:
(qoSQueueStatsBytesDropped * 8 + qoSQueueStatsBytesSent * 8) from QosPortQueueStats
• Indicator Alcatel - sam - Interface Error IN (%) uses formula:
100 * delta(InterfaceStats.receivedBadPackets)/
(delta(InterfaceStats.receivedBadPackets) +
delta(InterfaceStats.receivedUnicastPackets)
+delta(InterfaceAdditionalStats.receivedBroadcastPackets +
InterfaceAdditionalStats.receivedMulticastPackets)+delta(InterfaceStats.receivedPacke
tsDiscarded))
• delta(SAPQueueIngressStats.outOfProfileOctetsForwarded) returns the difference between
the number of ingress forwarded octets, out of profile, on the SAP queue, between two points in
time.
• deltaBySec(SAPQueueIngressStats.inProfileOctetsForwarded) returns the difference between
the number of ingress forwarded octets, in profile, on the SAP queue, between two points in time
over the number of seconds elapsed between the two measurements.
• Using formula:
100 * 8 * isNull(deltaBySec( SAPQueueIngressStats.inProfileOctetsForwarded) /
property('Used Cir'), 0),
indicator Alcatel - sam - QueueIngLoadIN_CIR returns 0 when the
deltaBySec(SAPQueueIngressStats.inProfileOctetsForwarded) / property('Used Cir') value
is invalid. This happens when value property('Used Cir') is not defined.

Installation and Configuration Guide - Chapter 4 Customizing your VistaLink for Alcatel-Lucent 5620 SAM
5 Troubleshooting VistaLink

This chapter indicates how to generate a support package and provides basic procedures for
troubleshooting your VistaLink for Alcatel-Lucent 5620 SAM.

 "Generating a support package" on page 188


 "Troubleshooting VistaMart provisioning update failure" on page 189
 "Troubleshooting missing data in VistaMart" on page 190
 "Replaying missing performance data" on page 191
 "Troubleshooting issues when entering a JMS client name" on page 193

187
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Generating a support package 188

Generating a support package


To provide InfoVista support with information on your system for troubleshooting purposes you
need to generate a support package and store it as a zip file.

 InfoVista strongly recommends to generate your VistaLink support package from the
VistaCockpit Management Console (see section ‘Working with VistaCockpit’, ‘Sending
information to InfoVista Support’ in the VistaCockpit User Guide).
If VistaCockpit or its agent is not available, you can use the following procedures from the
VistaLink platform:

 Generate a support package on Windows


To execute the support package, run command:
<VistaLink Installation Directory>\bin\supportpackage.exe -o out_dir
where out_dir is the location where the zipped support package file is stored, for example:
c:\supp_package
Any error in the command is reported in the log file.
The support package is generated in the specified directory.

 Generate a support package on Unix


To execute the support package, run the following command as an infovista user:
<VistaLink Installation Directory>/bin/supportpackage.sh -o out_dir
where out_dir is the location where the zipped support package file is stored, for example:
/opt/supp_package
Any error in the command is reported in the log file.
The support package is generated in the specified directory.

 Ensure your command arguments are between quotes when the directory names contain
spaces.

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Troubleshooting VistaMart provisioning update failure 189

Troubleshooting VistaMart provisioning


update failure
If the topology is not updated in VistaMart, open the vistaLinkServer.log in the <VistaLink
Installation Directory>\log folder and go through the error messages.

VM Provisioning aborted when more than 20% of instances


should be updated

Message <date and time> INFO [DefaultQuartzScheduler_Worker-2 ]


provisioningCoreLogger - ERROR : 11 removed instances(TTL activated or
change to archived state)
This represents more than 20% of instance(s) in the zone: VMProvisioning
aborted
<date and time> INFO [DefaultQuartzScheduler_Worker-2 ]
provisioningCoreLogger - VistaMart provisioning ended.
<date and time> ERROR [DefaultQuartzScheduler_Worker-2 ]
provisioningCoreLogger - VistaMartProvisioner :: Exception when
performing provisioning.
Issue The topology is not updated in the given zone because VistaLink is implementing a
protection to prevent from accidental removal of instances from the topology when
provisioning VistaMart.
This happens when VistaMart provisioning would erase more than 20% of the total
number of instances in the given zone. In this case, VistaLinks suspects a possible
configuration issue on the Alcatel-Lucent 5620 SAM server or the VistaLink side and
cancels the provisioning.
Solution If you need to update more than 20% of the topology, modify the threshold as follows:
1 Using your favorite text editor, open the <VistaLink Installation
Directory>\config\SAM-Poller.properties file.
2 Change value of parameter sam.vm.instance.deleted.threshold expressed as a
percentage.
3 Save and close the file.
4 Restart VistaLink (see "Managing services" on page 44).

! Make sure to revert the setting to the default value when using the VistaLink in regular
production mode in order to protect your topology data from accidental overwriting.

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Troubleshooting missing data in VistaMart 190

Troubleshooting missing data in


VistaMart
VistaLink normally pushes data into VistaMart as soon as it starts collecting data.
If no zone, besides the default one, is created in VistaMart, this means that no data has been
pushed.
In this case, open the vistaLinkServer.log in the <VistaLink Installation Directory>\log
folder and go through the error messages.

Firewall issue

Message Successfully Connected to SAM FTP server


Error while downloading file from server <FTP SAM server IP
address>
FileName <topology or statistics xml filename>, FTP server failed
to download file. <topology or statistics xml filename>.zip
Issue The connection with the SAM FTP server is OK but your firewall is
preventing VistaLink from pushing data from the SAM FTP server into
VistaMart.
Solution 1 Start the VistaLink Configuration Wizard.
2 Click Next until you reach the SAM Connection panel.
3 Click the FTP tab.
4 Select the Passive Mode checkbox to enable the VistaLink to determine
the FTP port number to use.
5 Click Next until you reach the Finish panel.
6 Click Finish.
7 Wait for the VistaLink to restart.
8 When data starts appearing in the <VistaLink Installation
directory>\sam\done, open the VistaMart Inventory Manager.
9 In the Browser view, check for the presence of the VistaLink specific:
• zones (SAM_GROUPS, SAM_DEVICES, SAM_ACCOUNTING and
SAM_PERFORMANCE).
• vistas and associated instances under the Vista node.

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Replaying missing performance data 191

Replaying missing performance data


You can recover data that was retrieved in:
• FindToFile and Find mode using the lastRun_15m.csv file present under <VistaLink
Installation Directory>\SAM\sam\data directory (see "Replay missing performance data in
FindToFile or Find mode" on page 191).
• LogToFile mode, automatically, every time VistaLink is started.

Replay missing performance data in FindToFile or


Find mode
Use the following procedure to recover missing data that has been retrieved in FindToFile or Find
mode.

 Replay missing performance data in FindToFile or Find mode


1 From the VistaMart Inventory Manager, identify the time period and timestamp for which data is
missing.
If data is missing for more than one timestamp, note the earliest timestamp which will be the one
from which you will replay data.
2 Stop the VistaLink service (see "Managing the VistaLink service" on page 102).
3 Using the Configuration Wizard, set the History (Minutes) parameter from the Statistics
Retrieval panel to a value that is higher than the period to recover (see "Setting the statistics
retrieval parameters" on page 83) but lower than the retention time because the SAM Server
does not keep statistics beyond the retention time.
To check the retention times defined for each statistics class, see the
StatClassRetentionTimes.csv file under <VistaLink Installation Directory>\SAM\sam\data.

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Replaying missing performance data 192

4 Browse to <VistaLink Installation Directory>\sam\data and open the lastRun_15m.csv and/


or the lastRun_global.csv file.
For example:

5 In the TimestampOfReference column, set the time from which you want to replay the data in
microseconds.

 Make sure to set a value within the retention time period because the SAM Server
does not keep statistics beyond the retention time.
6 Save and close the file.
7 Restart the VistaLink service.
8 After a while, check if the missing data is now present in the VistaMart Inventory Manager.

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Troubleshooting issues when entering a JMS client name 193

Troubleshooting issues when entering a


JMS client name
If you are not getting JMS events, check for JMS related errors in the vistaLinkServer.log in the
<VistaLink Installation Directory>\log folder.

Case 1: Wrong authentication

Message javax.jms.JMSSecurityException: User infovista is NOT


authenticated
Issue You have provided a wrong JMS Password: you will not be able to connect
to the SAM Server using JMS.
Solution Enter a valid password for JMS using the Configuration Wizard (see
"Setting the SAM connection parameters" on page 64) and try connecting
again to the SAM Server.

 Use the VistaLink Configuration Wizard to set and check the connection from the SAM
Connection panel.

Case 2: JMS Client already in use

Message WARN [pool-7-thread-1 ] samCoreLogger - Error in connecting to JMS


server : jnp://jmsServerIpAddress, Primary SAM
Server(samServerIpAddress). javax.jms.IllegalStateException:
Cannot create a subscriber on the durable subscription since it
already has subscriber(s)
Issue The JMS Client connection is already used by someone else and still
active. You will not be able to connect to the SAM Server using these JMS
connection credentials.
Solution Enter unused JMS Client credentials using the Configuration Wizard (see
"Setting the SAM connection parameters" on page 64).

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Troubleshooting issues when entering a JMS client name 194

 Use the VistaLink Configuration Wizard to set and check the connection from the SAM
Connection panel.

Case 3: Maximum connection limit exceeded

Message [SamJmsListener] [2012-04-06 17:28:17,988] - INFO - Connection


created for user: infovista
[SamJmsListener] [2012-04-06 17:28:17,992] - DEBUG - Using client
id: SAMAVAIL@1
[SamJmsListener] [2012-04-06 17:28:18,004] - WARN - JMS error:
5620 SAM-O Maximum Connected Clients
[SamJmsListener] [2012-04-06 17:28:18,005] - INFO - Disconnecting
JMS
Issue Maximum number of JMS Clients that can be connected simultaneously to
the SAM server is exceeded: you will not be able to connect to the SAM
Server using JMS.
Solution Disconnect unused JMS Client sessions from the SAM server (see the
SAM server documentation).

Installation and Configuration Guide - Chapter 5 Troubleshooting VistaLink


6 Monitoring VistaLink with
VistaCockpit

Provided that a VistaCockpit agent is available on the VistaLink platform, you can start, stop and
monitor VistaLink from the VistaCockpit Management Console.
This chapter describes how you can manage your VistaLink for Alcatel-Lucent 5620 SAM from
VistaCockpit.

 "Starting and stopping VistaLink from VistaCockpit" on page 196


 "Displaying the VistaLink status from VistaCockpit" on page 197

195
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Starting and stopping VistaLink from VistaCockpit 196

Starting and stopping VistaLink from


VistaCockpit
If a VistaCockpit agent is available on the VistaLink platform, you can start and stop VistaLink from
the VistaCockpit Management Console.

Prerequisite
A VistaCockpit Management Console session is started.

 Start or stop VistaLink


1 In the browser pane of the VistaCockpit Management Console, click the Hosts tab.
2 Expand the host node.
3 Right-click the VistaLink for SAM node and, depending on the initial state of the VistaLink select
either:
• Administration > Stop VistaLink for SAM
After a short while, the color of the General Status bar in the right-hand pane changes to red.
• Administration > Start VistaLink for SAM.
After a while, the color of the General Status bar in the right-hand pane changes to green.
For example:

See section ‘Working with VistaCockpit’, ‘Executing actions remotely’ in the VistaCockpit User
Guide for the detailed procedures.

Installation and Configuration Guide - Chapter 6 Monitoring VistaLink with VistaCockpit


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Displaying the VistaLink status from VistaCockpit 197

Displaying the VistaLink status from


VistaCockpit
To view the VistaLink status from the VistaCockpit Management Console, use the following
procedure:

 Display VistaLink status


1 In the browser pane of the VistaCockpit Management Console, click the Hosts tab.
2 Expand the host node.
3 Click the VistaLink for SAM node.
4 In the right pane, click the Status tab.
The color of the General Status bar on the left indicates the present status and the one on the
right provides a history for the last 3 days. You can zoom in the status bar to obtain details on
events and tasks at a given time.
For more information, see section ‘Viewing product status’ in the ‘Monitoring InfoVista Products’
of the VistaCockpit User Guide.

Installation and Configuration Guide - Chapter 6 Monitoring VistaLink with VistaCockpit


A Instance naming and
tagging conventions

The name and tag (unique identifier) of each monitored instance are based upon the standard
Alcatel-Lucent 5620 SAM attributes. This appendix provides the necessary information to interpret
the codification.

 "SAM attribute definitions" on page 199


 "Instance identification syntax" on page 201

198
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM SAM attribute definitions 199

SAM attribute definitions


This table lists all the Alcatel-Lucent 5620 SAM attribute names used to set up the instance names
(identifiers), with their respective definitions.

SAM attributes Definition


siteName Name of the device.
displayedName Name of the interface.
nodeName Name of the node.
fromNodeName Source node name.
toNodeName Destination node name.
serviceName Service name.
serviceId Unique service identifier.
portName Port number.
outerEncapValue The provisioned outer encap value. This value is propagated into:
terminatedPortOuterEncapValue.
innerEncapValue The provisioned inner encap value. This value is propagated into:
terminatedPortInnerEncapValue.
pathId Path ID of the Service Delivery Protocol.
testTargetType Specifies the target type of the LSP ping test. The target can be:
• An lsp target. The targeted test will run against a specific LSP. The
minimum packet size is 98.
• An lspPath target. The targeted test will run against the specified path
in an LSP. The lspPath parameter is mandatory when type is lspPath.
The minimum packet size is 98.
• A router target requires the ldpPrefix and ldpPrefixLen parameters to
be configured. The targeted test will run on a router (specified in
mplsSite) and attempts a LSP ping to a destination router(s) specified
in the ldpPrefix and ldpPrefixLen. The minimum packet size is 84.
lspName Name extracted from the LSP.
cosNumber COS (Class Of Service) number, extracted from the attributes
qosPortCOSnMinBW / qosPortCOSnMinBW (where n in the range [0 to 7]).
queueId Unique network queue identifier.
forwardingClass Forwarding class the ping test uses.
profile Profile value used with the forwarding class specified in forwardingClass.
testedObject The managed object that is tested.

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM SAM attribute definitions 200

SAM attributes Definition


sourceIPAddress The IPv4 or IPv6 address used as the source to perform the VPRN
(Virtual Private Routed Network) ping test.
targetIPAddress The IPv4 or IPv6 address used as the destination to perform the VPRN
ping test.
objectFullName Full name of the addressed object.

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 201

Instance identification syntax


The tagging convention is based on the assumption that the Alcatel-Lucent 5620 SAM uses a
single identifier per object, except for the Service and Customer objects. The name consists of one
or several Alcatel-Lucent attributes (see "SAM attribute definitions" on page 199).

Instance name and tag syntax


The following table shows the name and tag (identifier) syntax of each instance, according to the
vista it belongs to, as it appears in VistaMart Inventory Manager.

Object type Label Syntax


AA Group Name <siteName>:<ObjectFullName>
Example sim110:network:10.120.242.110:aagroup-77
Tag <ObjectFullName>
Example network:10.120.242.110:aagroup-77
AA Partition Name <siteName>:<ObjectFullName>
Example sim110:network:10.120.242.110:aagroup-77:aaPart-1869
Tag <ObjectFullName>
Example network:10.120.242.110:aagroup-77:aaPart-1869
ACL Filter Name <siteName>:<displayedName>:<containingPolicyDisplayedName>:<name
Entry >
Example sim110:Filter Entry # 1:MAC Filter-1:entry-1
Tag <ObjectFullName>
Example network:10.120.242.110:MAC Filter:1:entry-1
ACL Filter Name <siteName>:<displayedName>:<id>
Policy
Example sim110:MAC Filter-1:1
Tag <ObjectFullName>
Example network:10.120.242.110:MAC Filter:1
CFM Name <siteName>_ma-<ObjectFullName>
Maintenance
Example sim110_ma-sas:CCTest-1:site-10.120.242.110
Association
Tag <ObjectFullName>
Example sas:CCTest-1:site-10.120.242.110

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 202

Object type Label Syntax


Customer Name <CustomerName>
Example Ford
Tag CUSTOMER_<CustomerName>
Example CUSTOMER_Ford
Ethernet Name <siteName>:EthernetCard:slot-<slotID>mda-<daughterCardSlotId>
Card
Example sim_112:EthernetCard:slot-2mda-1
Tag <ObjectFullName>
Example network:10.120.242.112:shelf-1:cardSlot-
2:card:daughterCardSlot-1:daughterCard
Interface: Name <DsoSiteName>:<displayedName>
DS0 Channel,
Example sim110:Channel 2/1/1.ds0Grp-1.1.1
Sonet
Channel, Tag <ObjectFullName>
T1, Port
Example network:10.120.242.110:shelf-1:cardSlot-
Termination,
2:card:daughterCardSlot-1:daughterCard:port-1:sts1-
MLPP
1:ds3e3-1:ds1e1-1:ds0Grp-1
IOM Card Name <siteName>:iom:<ObjectFullName>
Example sim110:iom:shelf-1:cardSlot-1
Tag <ObjectFullName>
Example network:10.120.242.110:shelf-1:cardSlot-1:card
LAG Name <siteName>:lag:<name>
Interface
Example sim24:lag:interface-1
Tag <ObjectFullName>
Example network:38.120.242.24:lag:interface-1
LAN Switch Name <siteName>
Example sim110
Tag <siteName>
Example sim110
LAN Name <siteName>:<displayedName>
Interface
Example omni111:Port 1/10
Tag <ObjectFullName>
Example network:38.120.168.16:shelf-1:cardSlot-1:card:port-10

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 203

Object type Label Syntax


Microwave Name <siteName>
Example sim112
Tag <siteName>
Example sim112
MLPP Name <siteName>:<displayedName>:<bundleId>
Interface
Example sim110:APS Bundle-92:92
Tag <ObjectFullName>
Example network:10.120.242.110:shelf-1:bundle-92
MPLS Name <nodeName>:<displayedName>
Interface
Example sim24:to80
Tag <ObjectFullName>
Example network:38.120.242.24:router-1:mpls:interface-2
MPLS LSP Name <fromNodeName>:<displayedName>-LSP
Egress
Example sim110:lsp-80-82-LSP
Tag <ObjectFullName>
Example lsp:from-10.120.242.110-id-1
Sub MPLS Name <fromNodeName>:<displayedName>:<forwardingClass>-LSP
LSP Egress
Example sim110:lsp-80-82-af-LSP
Tag <ObjectFullName>-<forwardingClass>
Example lsp:from-10.120.242.110-id-1-af
MPLS LSP Name <siteName (SenderRouter)>:<siteName>:<lspName>-LSP
Ingress
Example sim110:sim112:lsp-80-82-LSP
Tag <ObjectFullName>
Example network:10.120.242.112:router-1:mpls:IngStatsPolicy-
lsp-80-82-sender-10.120.242.110
Sub MPLS Name <siteName
LSP Ingress (SenderRouter)>:<siteName>:<lspName>:<forwardingClass>-LSP
Example sim110:sim112:lsp-80-82-af-LSP
Tag <ObjectFullName>-<forwardingClass>
Example network:10.120.242.112:router-1:mpls:IngStatsPolicy-
lsp-80-82-sender-10.120.242.110-af

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 204

Object type Label Syntax


MS-ISA Card Name <siteName>:MS-ISA:slot-<slotID>mda-<daughterCardSlotId>
Example sim110:MS-ISA:slot-1mda-2
Tag <ObjectFullName>
Example network:10.120.242.110:shelf-1:cardSlot-
1:card:daughterCardSlot-2:daughterCard
QoS Port Name <ObjectFullName>:QoSPort-<cosNumber>
Example network:38.120.168.16:shelf-1:cardSlot-1:card:port-
19:QoSPort-1
Tag <ObjectFullName>:<cosNumber>
Example network:38.120.168.16:shelf-1:cardSlot-1:card:port-
19:1
Router Name <siteName>
Example sim110
Tag <siteName>
Example sim110
SAM Network Name <siteName>:<portName>:<queueId>:<displayedName>:<type>
Queue
where <type> is either Ingress or Egress
Example sim112:1/1/1:10:N/A:Ingress
Tag <siteName>:<portName>:<queueId>:<type>
Example sim112:1/1/1:10:Ingress
SAM Network Name The name and identifier syntaxes of the SAM Network Queue Group
Queue Group instances are a function of the network interface syntax.
<ObjectFullName>:<queueName>
Example 10.120.242.112:shelf-1:cardSlot-
1:card:daughterCardSlot-1:daughterCard:port-
2:NEgrQGroup-Template Egress Queue Group:queue-1
Tag <ObjectFullName>:<queueID>
Example network:10.120.242.112:shelf-1:cardSlot-
1:card:daughterCardSlot-1:daughterCard:port-
2:NEgrQGroup-Template Egress Queue Group:1

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 205

Object type Label Syntax


SAM SAP Name The name and identifier syntaxes of the SAM SAP instances are a
function of the access interface syntax.
<nodeName>:<serviceName>:<serviceId>:<portName>:<outerEncapValue
>:<innerEncapValue>
Example sim110:EPIPE 1:1:Port 1/1/4:3:0
Tag <ObjectFullName>
Example svc-mgr:service-1:10.120.242.110:interface-1/1/4-
inner-tag-0-outer-tag-3
SAM SAP Name <sapInstanceName>:<sapQueueDisplayedName>:<type>
Queue
where <type> is Ingress or Egress.
Ingress or
Egress Example sim110:EPIPE 1:1:Port 1/1/4:3:0:queue-11:Ingress
Tag <ObjectFullName>:queue-<Id>:<type>
Example svc-mgr:service-1:10.120.242.110:interface-1/1/4-
inner-tag-0-outer-tag-3:queue-11:Ingress
SAM SDP Name <fromNodeName>:<toNodeName>:<serviceName>:<serviceId>:<pathId>-
Endpoint SDP
Example sim110:sim112:EPIPE 1:1:229-SDP
Tag <ObjectFullName>
Example svc-mgr:service-1:10.120.242.110:circuit-229-2
Service Name <serviceName>
Example VPLS 202
Tag Service_InfoVista_<serviceName>
Example Service_InfoVista_VPLS 202

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 206

OAM instance name and tag syntax


The following table shows the name and tag (identifier) syntax of each OAM instance, according to
the test type, as it appears in VistaMart Inventory Manager.

Object Object Label Syntax


type type

OAM Mac ping Name <testTargetType>:<siteName>:<sapServiceName>:<id>


Layer2
Example vplsSite:sim_B:VPLS 5440:16
OAM
Tag <testedObject>:<fromNodeId>:<id>-mac
Example svc-mgr:service-5304:10.1.202.21:10.1.202.21:16-
mac
Mef Mac Name <testTargetType>:<siteName>:<sapServiceName>:<id>-mefmac
ping
Example vplsSite:sim_B:VPLS 1323:12-mefmac
Tag <testedObject>:<fromNodeId>:<sapServiceName>:<id>-mefmac
Example svc-mgr:service-1323:10.1.202.21:10.1.202.21:12-
mefmac
Y-1731 Name <ObjectFullName>
probe
Example network:10.120.242.110:sas:cfm-oneWayDlyTest-
2:scheduled-result-admin-1306351502381
Tag <ObjectFullName>
Example network:10.120.242.110:sas:cfm-oneWayDlyTest-
2:scheduled-result-admin-1306351502381

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 207

Object Object Label Syntax


type type
OAM Cpe ping Name <testedObject>:<fromNodeId>:<targetIpAddress>:<sapServiceN
Layer3 ame>:<id>-cpe
OAM
Example svc-mgr:service-
3:10.120.242.110:10.120.242.110:138.120.242.110:
VPLS 10:1-cpe
Tag <testedObject>:<sourceIpAddress>:<targetIpAddress>:<servic
eId>:<id>-cpe
Example svc-mgr:service-
3:10.120.242.110:138.120.242.111:138.120.242.110
:10:1-cpe
Icmp ping Name <testedObject>:<fromNodeId>:<targetIpAddress>:<id>-icmp
Example network:10.1.202.62:10.1.202.62:10.1.202.21:1-
icmp
Tag <testedObject>:<fromNodeId>:<targetIpAddress>:<id>-icmp
Example network:10.1.202.62:10.1.202.62:10.1.202.21:1-
icmp
Site ping Name <testedObject>:<targetIpAddress>:<sapServiceName>:<id>-
site
Example network:10.1.202.21:10.1.202.24:VPRN 101:25-site
Tag <testedObject>:<fromNodeId>:<targetIpAddress>:<id>-site
Example network:10.1.202.21:10.1.202.21:10.1.202.24:101:25
-site

Vccv ping Name <testedObject>:<sapServiceName>:<id>-vccv


Example svc-mgr:service-1:10.120.242.110:circuit-229-
2:EPIPE 2:5-vccv
Tag <fromNodeId>:<sapServiceId>:<id>-vccv
Example 10.120.242.110:2:5-vccv
Vprn ping Name <testedObject>:<siteName>:<targetIpAddress>:<sapServiceNam
e>:<id>
Example svc-mgr:serv-36:10.1.20.24:sim_C:7.7.9.1:VPRN
11:26
Tag <testedObject>:<sourceIpAddress>:<targetIpAddress>:<servic
eId>:<id>-vprn
Example svc-mgr:serv-
36:10.1.20.24:7.7.9.3:7.7.9.1:11:26-vprn

Installation and Configuration Guide - Appendix A


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Instance identification syntax 208

Object Object Label Syntax


type type
OAM lspPing Name <testTargetType>:<rtrName>:<lspName>:<forwardingClass>:<pr
LSP ofile>:<id>
Example lsp:sim110:lsp-80-82:be:out:1
Tag <testedObject>:<fromNodeId>:<forwardingClass>:<profile>:<i
d>
Example lsp:from-10.120.242.110-id-
1:10.120.242.110:be:out:1
OAM CfmTwo Name <ObjectFullName>
Tests WayDelayT
Example network:10.120.242.112:sas:cfm-twoWayDlyTest-1
est
Tag <ObjectFullName>
Example network:10.120.242.112:sas:cfm-twoWayDlyTest-1
CfmOne Name <ObjectFullName>
WayDelayT
Example network:10.120.242.112:sas:cfm-oneWayDlyTest-1
est
Tag <ObjectFullName>
Example network:10.120.242.112:sas:cfm-oneWayDlyTest-1
Mtu ping Name <testedObject>:<fromNodeId>:<id>-mtu
Example serviceTunnel:from-10.1.202.24-id-
3:10.1.202.24:1-mtu
Tag <testedObject>:<fromNodeId>:<id>-mtu
Example serviceTunnel:from-10.1.202.24-id-
3:10.1.202.24:1-mtu
Tunnel Name <testedObject>:<fromNodeId>:<id>-tunnel
ping
Example serviceTunnel:from-10.1.202.151-id-
9:10.1.202.151:1-tunnel
Tag <testedObject>:<fromNodeId>:<id>-tunnel
Example serviceTunnel:from-10.1.202.151-id-
9:10.1.202.151:1-tunnel

Installation and Configuration Guide - Appendix A


B Supported classes and
MIB’s

This appendix provides the comprehensive list of Alcatel-Lucent classes and MIB variables
supported by VistaLink for Alcatel-Lucent 5620 SAM.

 "Alcatel-Lucent classes supported by VistaLink" on page 210


 "Supported MIB’s" on page 214

209
VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Alcatel-Lucent classes supported by VistaLink 210

Alcatel-Lucent classes supported by


VistaLink
Not all Alcatel-Lucent statistics classes are supported for all topology classes. The following tables
list the statistics classes with their associated topology classes which are effectively supported by
VistaLink for Alcatel-Lucent 5620 SAM.
According to Alcatel-Lucent terminology, each class is paired with the package it comes from.

Both equipment.InterfaceStatsLogRecord and equipment.InterfaceAdditionalStatsLogRecord,


which are supplied with the equipment package, are only supported for the following topology
classes:
• equipment.PhysicalPort (part of equipment package)

• lag.Interface (part of lag package)

• bundle.Interface (part of bundle package)

Classes integrated by default


The following classes are all supported by default per given object type in the present version of
the VistaLink for Alcatel-Lucent 5620 SAM.

Object type Topology package.class Statistics package.class


LAN Interface Ethernet: equipment.InterfaceAdditionalStatsLogRecord
(on supported • equipment.PhysicalPort equipment.InterfaceStatsLogRecord
routers,
Microwave and LAG:
Omniswitch) • Lag.Interface

• lag.PortTermination
MPLS Interface mpls.Interface mpls.MplsInterfaceStatsLogRecord
MPLS LSP Mpls.lsp Mpls.LspStatsLogRecord
OAM Layer 2 ethernetoam.CfmOneWayD ethernetoam.CfmOneWayDelayTestResult
elayTest
ethernetoam.CfmTwoWayDelayTestResult
ethernetoam.MaintAssociati
on
mpls.LspPing Mpls.lspPingResult
Service.MacPing Service.MacPingResult
Service.MefMacPing Service.MefMacPingResult

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Alcatel-Lucent classes supported by VistaLink 211

Object type Topology package.class Statistics package.class


OAM Layer 3 Icmp.IcmpPing Icmp.IcmpPingResult
Service.CpePing Service.CpePingResult
Service.SitePing Service.SitePingResult
Svt.VccvPing Svt.VccvPingResult
vprn.VprnPing vprn.VprnPingResult
OAM Tests Svt.MtuPing Svt.MtuPingResult
Svt.TunnelPing Svt.TunnelPingResult
QoS Port equipment.PhysicalPort equipment.QosPortQueueStatsLogRecord
aosqos.QoSPort
Router rtr.VirtualRouter equipment.AllocatedMemoryStatsLogRecord
netw.NetworkElement equipment.AvailableMemoryStatsLogRecord
equipment.SystemCpuStatsLogRecord
equipment.SystemMemoryStatsLogRecord
rtr.RouteStatsLogRecord
SAM Network equipment.PhysicalPort service.CombinedNetworkEgressOctetsLogRec
Queue ord
service.CombinedNetworkIngressOctetsLogRec
ord
SAM SAP Queue service.L2AccessInterface service.CompleteServiceIngressPacketOctetsL
ogRecord
service.L3AcessInterface
service.CompleteServiceEgressPacketOctetsLo
gRecord
SAM SDP svt.SdpBinding svt.SdpBindingBaseStatsLogRecord
Endpoint
Service.CombinedSdpEgressPacketOctetsLogR
ecord
service.CombinedSdpIngressPacketOctetsLogR
ecord
WAN Interface Bundle and MLPP: equipment.InterfaceAdditionalStatsLogRecord
• bundle.Interface equipment.InterfaceStatsLogRecord
• bundle.PortTermination
Channel:
• tdmequipment.DS0Channe
lGroup
• tdmequipment.DS1E1Chan
nelGroup

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Alcatel-Lucent classes supported by VistaLink 212

Classes from previous versions


The following classes that were available in previous versions of the VistaLink for Alcatel-Lucent
5620 SAM are still supported.

Vista Topology package.class Statistics package.class


Interface equipment.PhysicalPort ethernetequipment.Dot3StatsLogRecord
(ethernet)
ethernetequipment.EthernetStatsLogRecord
Interface (sonet) equipment.PhysicalPort sonetequipment.SonetFarEndLineIntervalStatsL
ogRecord
sonetequipment.SonetFarEndPathCurrentStats
LogRecord
sonetequipment.SonetLineCurrentStatsLogRec
ord
sonetequipment.SonetPathCurrentStatsLogRec
ord
sonetequipment.SonetSectionCurrentStatsLogR
ecord
MPLS LSP mpls.lsp service.CombinedMplsLspEgressLogRecord
Egress
MPLS LSP mpls.lsp service.CombinedMplsLspIngressLogRecord
Ingress
OAM Layer 2 ethernetoam.MaintAssociati ethernetoam.CfmOneWayDelayTestResult
on
ethernetoam.CfmTwoWayDelayTestResult
Router rtr.VirtualRouter equipment.DeviceHealthStats
netw.NetworkElement
SAM SAP Queue service.L2AccessInterface service.CombinedServiceIngressOctetsLogRec
Ingress ord
service.L3AcessInterface
service.CombinedServiceIngressPacketOctetsL
ogRecord
service.CompactServiceIngressOctetsLogRecor
d
service.ServiceIngressOctetsLogRecord
service.ServiceIngressPacketsOctetsLogRecor
d
SAM SAP Queue service.L2AccessInterface service.CombinedServiceEgressOctetsLogReco
Egress rd
service.L3AcessInterface
service.ServiceEgressOctetsLogRecord
service.ServiceEgressPacketsOctetsLogRecord

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Alcatel-Lucent classes supported by VistaLink 213

Vista Topology package.class Statistics package.class


SAM Network equipment.PhysicalPort service.NetworkEgressOctetsLogRecord
Queue
service.NetworkEgressPacketsLogRecord
service.NetworkIngressOctetsLogRecord
service.NetworkIngressPacketsLogRecord
SAM SDP svt.SdpBinding svt.SdpBindingBaseStatsLogRecord
Endpoint

Supported equipment
The following classes of statistics, when associated with both rtr.VirtualRouter and
netw.NetworkElement classes of topology,
• equipment.SystemCpuStatsLogRecord

• equipment.SystemMemoryStatsLogRecord

• equipment.AllocatedMemoryStatsLogRecord

• equipment.AvailableMemoryStatsLogRecord
all address the following Alcatel-Lucent equipment:
• Alcatel-Lucent OmniSwitches (all OS6xxxx and OS9xxxx versions)

• Alcatel-Lucent 7210 SAS 2.0

• Alcatel-Lucent 7210 SAS M (supported for all versions)

• Alcatel-Lucent 7210 SAS D (supported for all versions)

• Alcatel-Lucent 7210 SAS E (supported for all versions)


• Alcatel-Lucent 7250 SAS X (supported for all versions)

• Alcatel-Lucent 7250 SAS ES/ESA (supported for all versions)

• Alcatel-Lucent 7450 ESS (supported for all versions)

• Alcatel-Lucent 7750 SR (supported for all versions)

• Alcatel-Lucent 7710 SR (supported for all versions)

• Alcatel-Lucent 7710 SR MG (supported for all versions)

• Alcatel-Lucent 7705 SAR (supported for all versions)

• Alcatel-Lucent 9500 MPR (supported for all versions)

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 214

Supported MIB’s
This section lists the MIB’s you must activate depending on the indicators you need:
 "MIB’s to activate when using the default solution" on page 214
 "MIB’s to activate when customizing your statistics retrieval" on page 217
 "Which MIB for which indicators" on page 220

MIB’s to activate when using the default solution


The following MIB’s must be activated on the Alcatel-Lucent 5620 SAM server in order to retrieve
all of the KPI’s available in the default VistaViews of your InfoVista solution. For each Alcatel-
Lucent product, the MIB entry name corresponds to the name of the MIB in the SAM server.

 15 minutes is set as a default polling interval in VistaMart for each MIB.

Product name and version MIB name MIB entry name


Alcatel-ESS-7450 HC-RMON-MIB mediaIndependentEntry
(5.0.0, 5.0.4, 6.0.0, 7.0.0)
IF-MIB ifEntry
ifXEntry
RMON-MIB etherStatsEntry
TIMETRA-MPLS-MIB vRtrMplsIfStatEntry
vRtrMplsLspStatEntry
TIMETRA-OSPF-NG-MIB tmnxOspfAreaEntry
TIMETRA-SERV-MIB sdpBindBaseStatsEntry
TIMETRA-SYSTEM-MIB sgiCpuUsage
sgiMemoryAvailable
sgiMemoryPoolAllocated
sgiMemoryUsed
TIMETRA-VRTR-MIB vRtrStatEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 215

Product name and version MIB name MIB entry name


Alcatel-SAR-7705 (1.0.0) HC-RMON-MIB mediaIndependentEntry
IF-MIB ifEntry
ifXEntry
RMON-MIB etherStatsEntry
TIMETRA-MPLS-MIB vRtrMplsIfStatEntry
vRtrMplsLspStatEntry
TIMETRA-SDP-MIB sdpBindBaseStatsEntry
TIMETRA-SYSTEM-MIB sgiCpuUsage
sgiMemoryAvailable
sgiMemoryPoolAllocated
sgiMemoryUsed
TIMETRA-VRTR-MIB vRtrStatEntry
Alcatel-SAR-7705 (2.0.0) HC-RMON-MIB mediaIndependentEntry
IF-MIB ifEntry
ifXEntry
RMON-MIB etherStatsEntry
TIMETRA-MPLS-MIB vRtrMplsIfStatEntry
vRtrMplsLspStatEntry
TIMETRA-OSPF-NG-MIB tmnxOspfAreaEntry
TIMETRA-SERV-MIB sdpBindBaseStatsEntry
TIMETRA-SYSTEM-MIB sgiCpuUsage
sgiMemoryAvailable
sgiMemoryPoolAllocated
sgiMemoryUsed
TIMETRA-VRTR-MIB vRtrStatEntry

Alcatel-SAS-7250 (2.0.0) and IF-MIB ifEntry


Alcatel-SAS-7250ES (2.0.0, 3.0.0)
ifXEntry
RMON-MIB etherStatsEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 216

Product name and version MIB name MIB entry name


Alcatel-SAS-E-7210 (1.0.0) HC-RMON-MIB mediaIndependentEntry
IF-MIB ifEntry
ifXEntry
RMON-MIB etherStatsEntry
TIMETRA-SYSTEM-MIB sgiCpuUsage
sgiMemoryAvailable
sgiMemoryPoolAllocated
sgiMemoryUsed
TIMETRA-VRTR-MIB vRtrStatEntry
Alcatel-SR-7710 (5.0.0, 5.0.4, 6.0.0, BGP4-MIB bgpPeerEntry
7.0.0)
HC-RMON-MIB mediaIndependentEntry
and
Alcatel-SR-7750 (5.0.0, 5.0.4, 6.0.0, IF-MIB ifEntry
7.0.0) ifXEntry
RMON-MIB etherStatsEntry
TIMETRA-MPLS-MIB vRtrMplsIfStatEntry
vRtrMplsLspStatEntry
TIMETRA-OSPF-NG-MIB tmnxOspfAreaEntry
TIMETRA-SERV-MIB sdpBindBaseStatsEntry
TIMETRA-SYSTEM-MIB sgiCpuUsage
sgiMemoryAvailable
sgiMemoryPoolAllocated
sgiMemoryUsed
TIMETRA-VRTR-MIB vRtrStatEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 217

MIB’s to activate when customizing your statistics


retrieval
The following MIB’s in the SAM server must be activated when you customize your statistics
retrieval.

Product name MIB name MIB entry name


Alcatel-7701 (1.0.0 and 2.0.0) EtherLike-MIB dot3StatsEntry
Alcatel-7701 ( 3.0.0) EtherLike-MIB dot3StatsEntry
SONET-MIB sonetFarEndLineCurrentEntry
sonetFarEndLineIntervalEntry
sonetLineCurrentEntry
sonetLineIntervalEntry
sonetSectionCurrentEntry
sonetSectionIntervalEntry

Alcatel-AOS-6400 (6.3.3) EtherLike-MIB dot3StatsEntry


Alcatel-AOS-6850 (6.3.1) EtherLike-MIB dot3StatsEntry
Alcatel-AOS-6855 (6.3.2) EtherLike-MIB dot3StatsEntry
Alcatel-AOS-9600 (6.3.1) EtherLike-MIB dot3StatsEntry
Alcatel-AOS-9700 (6.3.1) EtherLike-MIB dot3StatsEntry
Alcatel-AOS-9800 (6.3.1) EtherLike-MIB dot3StatsEntry
Alcatel-ESS-7450 EtherLike-MIB dot3StatsEntry
(5.0.0, 5.0.4, 6.0.0, 7.0.0)
SONET-MIB sonetFarEndLineCurrentEntry
sonetFarEndLineIntervalEntry
sonetFarEndPathCurrentEntry
sonetFarEndPathIntervalEntry
sonetLineCurrentEntry
sonetLineIntervalEntry
sonetPathCurrentEntry
sonetPathIntervalEntry
sonetSectionCurrentEntry
sonetSectionIntervalEntry
TIMETRA-LDP-MIB vRtrLdpIfStatsEntry
TIMETRA-SERV-MIB svcTlsInfoEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 218

Product name MIB name MIB entry name


Alcatel-SAR-7705 (1.0.0) EtherLike-MIB dot3StatsEntry
TIMETRA-LDP-MIB vRtrLdpIfStatsEntry

Alcatel-SAR-7705 (2.0.0) EtherLike-MIB dot3StatsEntry


SONET-MIB sonetFarEndLineCurrentEntry
sonetFarEndLineIntervalEntry
sonetFarEndPathCurrentEntry
sonetFarEndPathIntervalEntry
sonetLineCurrentEntry
sonetLineIntervalEntry
sonetPathCurrentEntry
sonetPathIntervalEntry
sonetSectionCurrentEntry
sonetSectionIntervalEntry
TIMETRA-LDP-MIB vRtrLdpIfStatsEntry
Alcatel-SAS-E-7210 (1.0.0) EtherLike-MIB dot3StatsEntry
TIMETRA-SERV-MIB svcTlsInfoEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 219

Product name MIB name MIB entry name


Alcatel-SR-7710 EtherLike-MIB dot3StatsEntry
(5.0.0, 5.0.4, 6.0.0, 7.0.0)
SONET-MIB sonetFarEndLineCurrentEntry
and
SR-7750 sonetFarEndLineIntervalEntry
(5.0.0, 5.0.4, 6.0.0, 7.0.0) sonetFarEndPathCurrentEntry
sonetFarEndPathIntervalEntry
sonetFarEndVTCurrentEntry
sonetFarEndVTIntervalEntry
sonetLineCurrentEntry
sonetLineIntervalEntry
sonetPathCurrentEntry
sonetPathIntervalEntry
sonetSectionCurrentEntry
sonetSectionIntervalEntry
sonetVTCurrentEntry
sonetVTIntervalEntry
TIMETRA-LDP-MIB vRtrLdpIfStatsEntry
TIMETRA-SERV-MIB svcTlsInfoEntry

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 220

Which MIB for which indicators


The following tables provide, per object type, the list of available indicators according to the MIB
you activate and used attribute.

Routers
MIB: TIMETRA-SYSTEM-MIB.sgiCpuUsage

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
systemCpuUsage sgiCpuUsage AnyVendor - 00 Net Network Device
Device CPU
Utilization (%) - BPI

MIB: TIMETRA-SYSTEM-MIB.sgiMemoryUsed

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
systemMemoryUsage sgiMemoryUsed Alcatel - sam - Router
Memory Utilization
allocatedMemory sgiMemoryPool Alcatel - sam - Router
Allocated Memory Allocated
availableMemory sgiMemory Available Alcatel - sam - Router
Memory Available

MIB: TIMETRA-VRTR-MIB.vRtrStatTable

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
bgpActiveRoutes vRtrBGPActiveRoutes Alcatel - sam - Router
vRtrBGPActiveRoute
s
ospfActiveRoutes vRtrOSPFActiveRoutes Alcatel - sam - Router
vRtrOSPFActiveRout
es
staticActiveRoutes vRtrStaticActiveRoutes Alcatel - sam - Router
vRtrStaticActiveRout
es
ripActiveRoutes vRtrRIPActiveRoutes Alcatel - sam - Router
vRtrvRtrRIPActiveRo
utes

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 221

MIB: ALCATEL-IND1-HEALTH-MIB. healthModuleEntry

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
cpuLatest cpuLatest Alcatel - sam - LAN LAN Switch
Switch - CPU
Utilization (%)
memoryLatest memoryLatest Alcatel - sam - LAN LAN Switch
Switch - Memory
Utilization (%)
temperatureLatest temperatureLatest Alcatel - sam - LAN LAN Switch
Switch - Mean of
Temperature

LAN/WAN Interfaces
MIB: IF-MIB.ifXTable

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
receivedBroadcastPack ifHCInBroadcastPkts AnyVendor - Interface
ets Interface Error IN (%)
- BPI
Interface -
BroadcastPacketsIN
receivedMulticastPacke ifHCInMulticastPkts AnyVendor - Interface
ts Interface Error IN (%)
- BPI
Interface -
MulticastPacketsIN
receivedUnicastPacket ifHCInUcastPkts AnyVendor - Interface
s Interface Error IN (%)
- BPI
Interface -
UnicastPacketsIN
transmittedBroadcastP ifHCOutBroadcastPkts AnyVendor - Interface
ackets Interface Error OUT
(%) - BPI
Interface -
BroadcastPacketsOU
T

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 222

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
transmittedMulticastPa ifHCOutMulticastPkts AnyVendor - Interface
ckets Interface Error OUT
(%) - BPI
Interface -
MulticastPacketsOut
transmittedUnicastPack ifHCOutUcastPkts AnyVendor - Interface
ets Interface Error OUT
(%) - BPI
Interface -
UnicastPacketsOut
receivedTotalOctets ifHCInOctets AnyVendor - Interface
Interface Utilization
IN (%) - BPI
Interface - OctetsIN
transmittedTotalOctets ifHCOutOctets AnyVendor - Interface
Interface Utilization
OUT (%) - BPI
Interface -
OctetsOUT

MPLS interfaces
MIB: TIMETRA-MPLS-MIB.vRtrMplsIfStatTable

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
receiveOctets vRtrMplsIfRxOctetCoun mplsif - MPLS Interface
t receiveOctets/s
receivePackets vRtrMplsIfRxPktCount mplsif - MPLS Interface
receivePackets/s
transmitOctets vRtrMplsIfTxOctetCoun mplsif - MPLS Interface
t transmitOctets/s
transmitPackets vRtrMplsIfTxPktCount mplsif - MPLS Interface
transmitOctets/s

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 223

MPLS LSPs
MIB: TIMETRA-MPLS-MIB.vRtrMplsLspStatTable

Alcatel-Lucent OID’s InfoVista indicators Vista


attributes
timeSinceLastUpStat vRtrMplsLspTimeUp Alcatel - sam - MPLS LSP
e LspTimeSinceLastUpS
tate
transitions vRtrMplsLspTransition Alcatel - sam - Lsp MPLS LSP
s Transitions Count (b)

QoSPort (OmniSwitch)
MIB: ALCATEL-IND1-QOS-MIB.alaQoSQueueStatsTable

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
qoSQueueStatsBytesSe qoSQueueStatsBytesSen Alcatel - sam - QoS Interface
nt t Transmitted
traffic (bps)
Alcatel - sam -
Submitted
Traffic (bps)
qoSQueueStatsBytesDro qoSQueueStatsBytesDro Alcatel - sam - QoS Interface
pped pped Dropped Traffic
(bps)
Alcatel - sam -
Submitted
Traffic (bps)

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 224

Service
MIB: TIMETRA-SERV-MIBSapIngQosQueueStatsEntry

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
inProfileOctetsForward sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
ed ForwardedInProfOctets QueueIngForwardedI Ingress
HiPrio (bps)
Alcatel - sam -
QueueIngForwardedI
HiPrio (Bytes
Volume)
outOfProfileOctetsForw sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
arded ForwardedOutProfOcte QueueIngForwarded Ingress
ts LoPrio (bps)
Alcatel - sam -
QueueIngForwarded
LoPrio (Bytes
Volume)
lowOctetsDropped sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
DroppedLoPrioOctets QueueIngDroppedLo Ingress
Prio (bps)
Alcatel - sam -
QueueIngDroppedLo
Prio (Bytes Volume)
highOctetsDropped sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
DroppedHiPrioOctets QueueIngDroppedHi Ingress
Prio (bps)
Alcatel - sam -
QueueIngDroppedHi
Prio (Bytes Volume)
highOctetsOffered sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
OfferedHiPrioOctets QueueIngOfferedHiP Ingress
rio (bps)
Alcatel - sam -
QueueIngOfferedHiP
rio (Bytes Volume)
lowOctetsOffered sapIngQosQueueStats Alcatel - sam - SAM SAP Queue
OfferedLoPrioOctets QueueIngOfferedLoP Ingress
rio (bps)
Alcatel - sam -
QueueIngOfferedLoP
rio (Bytes Volume)

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 225

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
inProfileOctetsForward sapEgrQosQueueStats Alcatel - sam - SAM SAP Queue
ed ForwardedInProfOctets QueueEgrForwarded Egress
HiPrio (bps)
Alcatel - sam -
QueueEgrForwarded
HiPrio (Bytes
Volume)
outOfProfileOctetsForw sapEgrQosQueueStats Alcatel - sam - SAM SAP Queue
arded ForwardedOutProfOcte QueueEgrForwarded Egress
ts LoPrio (bps)
Alcatel - sam -
QueueEgrForwarded
LoPrio (Bytes
Volume)
inProfileOctetsDropped sapEgrQosQueueStats Alcatel - sam - SAM SAP Queue
DroppedInProfOctets QueueEgrDroppedHi Egress
Prio (bps)
Alcatel - sam -
QueueEgrDroppedHi
Prio (Bytes Volume)
outOfProfileOctetsDrop sapEgrQosQueueStats Alcatel - sam - SAM SAP Queue
ped DroppedOutProfOctets QueueEgrDroppedLo Egress
Prio (bps)
Alcatel - sam -
QueueEgrDroppedLo
Prio (Bytes Volume)

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 226

SAM SDP
MIB: TIMETRA-SERV-MIB.sdpBindBaseStatsEntry

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
egressForwardedOctet sdpBindBaseStatsEgre Alcatel - sam - SAM SDP Endpoint
s ssForwardedOctets SdpEgressForwarded
Octets/s
egressForwardedPacke sdpBindBaseStatsEgre Alcatel - sam - SAM SDP Endpoint
ts ssForwardedPackets SdpEgressForwarded
Packets/s
ingressDroppedPacket sdpBindBaseStatsIngre Alcatel - sam - SAM SDP Endpoint
s ssDroppedPackets SdpIngressDroppedP
ackets/s
ingressForwardedPack sdpBindBaseStatsIngre Alcatel - sam - SAM SDP Endpoint
ets ssForwardedPackets SdpIngressForwarde
dPackets/s

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 227

OAM
All following indicators are available through the TIMETRA-OAM-TEST-
MIB.tmnxOamPingResultsTable MIB. They are listed according to the selected statistics package
and class, and used attributes.

mpls.LspPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

vprn.VprnPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 228

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

service.MacPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 229

svt.VccvPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

icmp.IcmpPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 230

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

mpls.LspPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators

service.SitePingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

service.CpePingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 231

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

svt.TunnelPingResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
packetsLost tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeFailures OamNumberOfPacke
tLost
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent

Installation and Configuration Guide - Appendix B


VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Supported MIB’s 232

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time

ethernetoam.CfmOneWayDelayTestResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
mepDelay mepDelay AnyVendor - End-to-End
Response Time
(ms) - BPI
mepDelayVariation mepDelayVariation AnyVendor - Jitter Streaming Oriented
- BPI

ethernetoam.CfmTwoWayDelayTestResult

Alcatel-Lucent OID’s InfoVista Vista


attributes indicators
averageRoundTripTime tmnxOamPingResultsA AnyVendor - End-to-End
verageRtt Response Time (ms)
- BPI
maximumRoundTripTim ttmnxOamPingResults Alcatel - sam - OAM Tests
e MaxRtt OamMaximumRTT
minimumRoundTripTim tmnxOamPingResultsM Alcatel - sam - OAM Tests
e inRtt OamMinimumRTT
roundTripJitter tmnxOamPingResultsR AnyVendor - Jitter - Streaming Oriented
tJitter BPI
lossPercentage tmnxOamPingResultsR AnyVendor - Packet Streaming Oriented
ttSumOfSquares Loss - BPI
lastGoodPacketTime tmnxOamPingResultsL Alcatel - sam - OAM Tests
astGoodProbe OamLastGoodPacket
Time
averageOneWayTime averageOneWayTime AnyVendor - OWD - Streaming Oriented
BPI
packetTimeout tmnxOamPingResultsP Alcatel - sam - OAM Tests
robeTimeouts OampacketTimeout
packetsSent tmnxOamPingResultsS Alcatel - sam - OAM Tests
entProbes OampacketsSent

Installation and Configuration Guide - Appendix B


233

Index
VistaMart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
A VistaPortal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
accounting configuration . . . . . . . . . . . . . . . . . . . . . . . . creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
acquisition rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, 83 indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Alcatel-Lucent 5620 SAM . . . . . . . . . . . . . . . . . . . . . . . customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuration requirements . . . . . . . . . . . . . . . . . . . 22 filtering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . customized indicators . . . . . . . . . . . . . . . . . . . . . . . . . .
definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 creating a rule for . . . . . . . . . . . . . . . . . . . . . . . . . 173
auxiliary server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . providing a rule for . . . . . . . . . . . . . . . . . . . . . . . . 170
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 customizing solution . . . . . . . . . . . . . . . . . . . . . . . . . . .
main steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
B
D
backing up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . 47 data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backing up configuration . . . . . . . . . . . . . . . . . . . . . . . 113 missing, replaying . . . . . . . . . . . . . . . . . . . . . . . . . 191
missing, troubleshooting . . . . . . . . . . . . . . . . . . . . 190
data acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
C data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210, 212 data indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 data lifetime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
classes,statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . data maximum history . . . . . . . . . . . . . . . . . . . . . . . . . . 17
defining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 data retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
backing up and restoring. . . . . . . . . . . . . . . . . . . . 113 data visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . setting up in VistaMart. . . . . . . . . . . . . . . . . . . . . . . 27
backing up. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 VistaLink installation . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuration wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
acquisition rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 topology mapping filename . . . . . . . . . . . . . . . . . . 125
filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 display indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
instance selection . . . . . . . . . . . . . . . . . . . . . . . . . . 75 display rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
memory space . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 changing default value for SAM data . . . . . . . . . . . 88
retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
SAM FTP parameters . . . . . . . . . . . . . . . . . . . . . . . 67 E
SAM host parameters . . . . . . . . . . . . . . . . . . . . . . . 64
SAM SSH parameters. . . . . . . . . . . . . . . . . . . . . . . 69 enabling instance discovery . . . . . . . . . . . . . . . . . . . . . 142
starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 event message formats . . . . . . . . . . . . . . . . . . . . . . . . .
VistaMart parameters . . . . . . . . . . . . . . . . . . . . . . . 58 importing into VistaMart . . . . . . . . . . . . . . . . . . . . . 26
configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Index
234

vista. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
F
filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
J
filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JMS Client connection . . . . . . . . . . . . . . . . . . . . . . . . .
user data in reports . . . . . . . . . . . . . . . . . . . . . . . . . 40 troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Find mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 L
description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 LAN interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
FindToFile mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 importing into VistaMart . . . . . . . . . . . . . . . . . . . . . 25
description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Local mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
formula syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . configuring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
verifying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 configuring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 LogToFile mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 configuring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
H LSP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

history parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
M
I Managing VistaMart modules. . . . . . . . . . . . . . . . . . . . 107
memory space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
event message formats. . . . . . . . . . . . . . . . . . . . . . 26 requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
page packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
VistaPortal users and groups . . . . . . . . . . . . . . . . . 37 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
indicator formula syntax . . . . . . . . . . . . . . . . . . . . . . . . default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
verifying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 managing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . optional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
related modules . . . . . . . . . . . . . . . . . . . . . . . . . . 108 starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 stopping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
stopping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Modules, optional . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . related indicators. . . . . . . . . . . . . . . . . . . . . . . . . . 108
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 MPLS interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
data vs display . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 MPLS LSP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
installation directories. . . . . . . . . . . . . . . . . . . . . . . . . . . 31
installation prerequisites . . . . . . . . . . . . . . . . . . . . . . . .
SAM server requirements . . . . . . . . . . . . . . . . . . . . 22 N
installing VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 O
instance discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . .
OAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
enabling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
OmniSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
instance selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
filtering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
instance type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Index
235

online help, solution pages . . . . . . . . . . . . . . . . . . . . . . SAM SDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226


installing on VistaPortal. . . . . . . . . . . . . . . . . . . . . . 32 SAM SSH parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 69
SAM user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
P SAM_ACCOUNTING . . . . . . . . . . . . . . . . . . . . . . . . . .
page packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . configuring size . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SAM_DEVICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 SAM_GROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 SAM_PERFORMANCE. . . . . . . . . . . . . . . . . . . . . . . . .
protocol template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . configuring size . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
elements and attributes. . . . . . . . . . . . . . . . . . . . . 149 Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
modifying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 managing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 SNMP polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Q Configuration Wizard. . . . . . . . . . . . . . . . . . . . . . . . 56
QoSPOrt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 starting VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
from VistaCockpit . . . . . . . . . . . . . . . . . . . . . . . . . 196
starting VistaLink service . . . . . . . . . . . . . . . . . . . . . . . 102
R Starting volume indicators . . . . . . . . . . . . . . . . . . . . . . 108
statistics classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
defining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
accounting configuration . . . . . . . . . . . . . . . . . . . . . 22
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
auxiliary server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
displaying from VistaCockpit . . . . . . . . . . . . . . . . . 197
SAM user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
stopping VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNMP polling and MIB . . . . . . . . . . . . . . . . . . . . . . 23
from VistaCockpit . . . . . . . . . . . . . . . . . . . . . . . . . 196
Unix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
stopping VistaLink service . . . . . . . . . . . . . . . . . . . . . . 102
VistaFoundation . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Stopping volume indicators . . . . . . . . . . . . . . . . . . . . . 111
restoring configuration . . . . . . . . . . . . . . . . . . . . . . . . . 113
support package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Retrieval mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
generating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
supported equipment . . . . . . . . . . . . . . . . . . . . . . . . . . 213
retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
retrieval rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 T
routers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 tagging conventions . . . . . . . . . . . . . . . . . . . . . . . . . . .
types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
topology mapping file . . . . . . . . . . . . . . . . . . . . . . . . . .
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
S elements and attributes. . . . . . . . . . . . . . . . . . . . . 127
filename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
SAM attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
modifying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
SAM data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
changing display rate . . . . . . . . . . . . . . . . . . . . . . . 88
JMS Client connection . . . . . . . . . . . . . . . . . . . . . 193
SAM FTP parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 67
missing data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
SAM host parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 64

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Index
236

upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
U VistaLink architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
uninstalling VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 VistaLink data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VistaLink indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Unix users and groups . . . . . . . . . . . . . . . . . . . . . . . . . . 24 VistaLink service . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . managing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . 44 VistaMart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
launching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 configuring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
tagging and naming conventions . . . . . . . . . . . . . . 45 VistaMart database . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VistaCockpit workflows . . . . . . . . . . . . . . . . . . . . . . 45 creating connection . . . . . . . . . . . . . . . . . . . . . . . . . 33
VistaMart zones . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 VistaMart zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
upgrade wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 VistaPortal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
upgrading VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 configuring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . creating connection to database . . . . . . . . . . . . . . . 33
SAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 deploying VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . 32
user data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VistaPortal page packages . . . . . . . . . . . . . . . . . . . . . .
filtering in reports . . . . . . . . . . . . . . . . . . . . . . . . . . 40 importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VistaPortal users . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
creating on VistaPortal . . . . . . . . . . . . . . . . . . . . . . 39 importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
importing into VistaPortal . . . . . . . . . . . . . . . . . . . . 37 VistaViews libraries . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 importing into VistaMart . . . . . . . . . . . . . . . . . . . . . 25
Volume indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
related modules. . . . . . . . . . . . . . . . . . . . . . . . . . . 108
V starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . stopping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
LAN interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
MPLS interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 W
MPLS LSP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
OAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 WAN interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
QoSPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
router. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
SAM SDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
WAN interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
X,Y,Z
VistaBridge library . . . . . . . . . . . . . . . . . . . . . . . . . . . . zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 configuring proxy zone size. . . . . . . . . . . . . . . . . . 103
VistaCockpit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . proxies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
displaying status from . . . . . . . . . . . . . . . . . . . . . . 197
starting or stopping VistaLink from . . . . . . . . . . . . 196
VistaCockpit workflows . . . . . . . . . . . . . . . . . . . . . . . . .
upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
VistaFoundation kit . . . . . . . . . . . . . . . . . . . . . . . . . . . .
requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
VistaLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
backing up and restoring configuration . . . . . . . . . 113
deploying on VistaPortal . . . . . . . . . . . . . . . . . . . . . 32
managing service . . . . . . . . . . . . . . . . . . . . . . . . . 102
uninstalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

VistaLink® 4.0 for Alcatel-Lucent 5620 SAM Installation and Configuration Guide Index

Potrebbero piacerti anche